diff --git a/_plotly_future_/__init__.py b/_plotly_future_/__init__.py index f3cc263c507..8b4b558d993 100644 --- a/_plotly_future_/__init__.py +++ b/_plotly_future_/__init__.py @@ -1,3 +1,6 @@ +import warnings +import functools + _future_flags = set() @@ -6,3 +9,49 @@ def _assert_plotly_not_imported(): if 'plotly' in sys.modules: raise ImportError("""\ The _plotly_future_ module must be imported before the plotly module""") + + +warnings.filterwarnings( + 'default', + '.*?is deprecated, please use chart_studio*', + DeprecationWarning +) + + +def _chart_studio_warning(submodule): + if 'extract_chart_studio' in _future_flags: + warnings.warn( + 'The plotly.{submodule} module is deprecated, ' + 'please use chart_studio.{submodule} instead' + .format(submodule=submodule), + DeprecationWarning, + stacklevel=2) + + +def _chart_studio_deprecation(fn): + + fn_name = fn.__name__ + fn_module = fn.__module__ + plotly_name = '.'.join( + ['plotly'] + fn_module.split('.')[1:] + [fn_name]) + chart_studio_name = '.'.join( + ['chart_studio'] + fn_module.split('.')[1:] + [fn_name]) + + msg = """\ +{plotly_name} is deprecated, please use {chart_studio_name}\ +""".format(plotly_name=plotly_name, chart_studio_name=chart_studio_name) + + @functools.wraps(fn) + def wrapper(*args, **kwargs): + if 'extract_chart_studio' in _future_flags: + warnings.warn( + msg, + DeprecationWarning, + stacklevel=2) + + return fn(*args, **kwargs) + + return wrapper + + +__all__ = ['_future_flags', '_chart_studio_warning'] diff --git a/_plotly_future_/extract_chart_studio.py b/_plotly_future_/extract_chart_studio.py new file mode 100644 index 00000000000..a3de7eca345 --- /dev/null +++ b/_plotly_future_/extract_chart_studio.py @@ -0,0 +1,5 @@ +from __future__ import absolute_import +from _plotly_future_ import _future_flags, _assert_plotly_not_imported + +_assert_plotly_not_imported() +_future_flags.add('extract_chart_studio') diff --git a/_plotly_future_/remove_deprecations.py b/_plotly_future_/remove_deprecations.py new file mode 100644 index 00000000000..3e47048038d --- /dev/null +++ b/_plotly_future_/remove_deprecations.py @@ -0,0 +1,5 @@ +from __future__ import absolute_import +from _plotly_future_ import _future_flags, _assert_plotly_not_imported + +_assert_plotly_not_imported() +_future_flags.add('remove_deprecations') diff --git a/_plotly_future_/v4.py b/_plotly_future_/v4.py index fdbad2b012c..7e5c023a720 100644 --- a/_plotly_future_/v4.py +++ b/_plotly_future_/v4.py @@ -1,2 +1,4 @@ from __future__ import absolute_import -from _plotly_future_ import renderer_defaults, template_defaults +from _plotly_future_ import ( + renderer_defaults, template_defaults, extract_chart_studio, + remove_deprecations) diff --git a/_plotly_utils/basevalidators.py b/_plotly_utils/basevalidators.py index db6d4e4d4a4..c1f0d193341 100644 --- a/_plotly_utils/basevalidators.py +++ b/_plotly_utils/basevalidators.py @@ -1,33 +1,18 @@ +from __future__ import absolute_import + import base64 import numbers import textwrap import uuid from importlib import import_module import copy - import io from copy import deepcopy - import re - -# Optional imports -# ---------------- import sys from six import string_types -np = None -pd = None - -try: - np = import_module('numpy') - - try: - pd = import_module('pandas') - except ImportError: - pass - -except ImportError: - pass +from _plotly_utils.optional_imports import get_module # back-port of fullmatch from Py3.4+ @@ -50,6 +35,8 @@ def to_scalar_or_list(v): # Python native scalar type ('float' in the example above). # We explicitly check if is has the 'item' method, which conventionally # converts these types to native scalars. + np = get_module('numpy') + pd = get_module('pandas') if np and np.isscalar(v) and hasattr(v, 'item'): return v.item() if isinstance(v, (list, tuple)): @@ -86,7 +73,8 @@ def copy_to_readonly_numpy_array(v, kind=None, force_numeric=False): np.ndarray Numpy array with the 'WRITEABLE' flag set to False """ - + np = get_module('numpy') + pd = get_module('pandas') assert np is not None # ### Process kind ### @@ -175,7 +163,9 @@ def is_numpy_convertable(v): def is_homogeneous_array(v): """ Return whether a value is considered to be a homogeneous array - """ + """ + np = get_module('numpy') + pd = get_module('pandas') if ((np and isinstance(v, np.ndarray) or (pd and isinstance(v, (pd.Series, pd.Index))))): return True @@ -616,7 +606,7 @@ def description(self): as a plotly.grid_objs.Column object""".format(plotly_name=self.plotly_name)) def validate_coerce(self, v): - from plotly.grid_objs import Column + from chart_studio.grid_objs import Column if v is None: # Pass None through pass @@ -704,7 +694,7 @@ def validate_coerce(self, v): # Pass None through pass elif self.array_ok and is_homogeneous_array(v): - + np = get_module('numpy') try: v_array = copy_to_readonly_numpy_array(v, force_numeric=True) except (ValueError, TypeError, OverflowError): @@ -825,7 +815,7 @@ def validate_coerce(self, v): # Pass None through pass elif self.array_ok and is_homogeneous_array(v): - + np = get_module('numpy') v_array = copy_to_readonly_numpy_array(v, kind=('i', 'u'), force_numeric=True) @@ -964,6 +954,8 @@ def validate_coerce(self, v): self.raise_invalid_elements(invalid_els) if is_homogeneous_array(v): + np = get_module('numpy') + # If not strict, let numpy cast elements to strings v = copy_to_readonly_numpy_array(v, kind='U') diff --git a/_plotly_utils/exceptions.py b/_plotly_utils/exceptions.py new file mode 100644 index 00000000000..11a19a5c7c6 --- /dev/null +++ b/_plotly_utils/exceptions.py @@ -0,0 +1,82 @@ +class PlotlyError(Exception): + pass + + +class PlotlyEmptyDataError(PlotlyError): + pass + + +class PlotlyGraphObjectError(PlotlyError): + def __init__(self, message='', path=(), notes=()): + """ + General graph object error for validation failures. + + :param (str|unicode) message: The error message. + :param (iterable) path: A path pointing to the error. + :param notes: Add additional notes, but keep default exception message. + + """ + self.message = message + self.plain_message = message # for backwards compat + self.path = list(path) + self.notes = notes + super(PlotlyGraphObjectError, self).__init__(message) + + def __str__(self): + """This is called by Python to present the error message.""" + format_dict = { + 'message': self.message, + 'path': '[' + ']['.join(repr(k) for k in self.path) + ']', + 'notes': '\n'.join(self.notes) + } + return ('{message}\n\nPath To Error: {path}\n\n{notes}' + .format(**format_dict)) + + +class PlotlyDictKeyError(PlotlyGraphObjectError): + def __init__(self, obj, path, notes=()): + """See PlotlyGraphObjectError.__init__ for param docs.""" + format_dict = {'attribute': path[-1], 'object_name': obj._name} + message = ("'{attribute}' is not allowed in '{object_name}'" + .format(**format_dict)) + notes = [obj.help(return_help=True)] + list(notes) + super(PlotlyDictKeyError, self).__init__( + message=message, path=path, notes=notes + ) + + +class PlotlyDictValueError(PlotlyGraphObjectError): + def __init__(self, obj, path, notes=()): + """See PlotlyGraphObjectError.__init__ for param docs.""" + format_dict = {'attribute': path[-1], 'object_name': obj._name} + message = ("'{attribute}' has invalid value inside '{object_name}'" + .format(**format_dict)) + notes = [obj.help(path[-1], return_help=True)] + list(notes) + super(PlotlyDictValueError, self).__init__( + message=message, notes=notes, path=path + ) + + +class PlotlyListEntryError(PlotlyGraphObjectError): + def __init__(self, obj, path, notes=()): + """See PlotlyGraphObjectError.__init__ for param docs.""" + format_dict = {'index': path[-1], 'object_name': obj._name} + message = ("Invalid entry found in '{object_name}' at index, '{index}'" + .format(**format_dict)) + notes = [obj.help(return_help=True)] + list(notes) + super(PlotlyListEntryError, self).__init__( + message=message, path=path, notes=notes + ) + + +class PlotlyDataTypeError(PlotlyGraphObjectError): + def __init__(self, obj, path, notes=()): + """See PlotlyGraphObjectError.__init__ for param docs.""" + format_dict = {'index': path[-1], 'object_name': obj._name} + message = ("Invalid entry found in '{object_name}' at index, '{index}'" + .format(**format_dict)) + note = "It's invalid because it doesn't contain a valid 'type' value." + notes = [note] + list(notes) + super(PlotlyDataTypeError, self).__init__( + message=message, path=path, notes=notes + ) \ No newline at end of file diff --git a/_plotly_utils/files.py b/_plotly_utils/files.py new file mode 100644 index 00000000000..f77f277adaf --- /dev/null +++ b/_plotly_utils/files.py @@ -0,0 +1,36 @@ +import os + +PLOTLY_DIR = os.environ.get("PLOTLY_DIR", + os.path.join(os.path.expanduser("~"), ".plotly")) +TEST_FILE = os.path.join(PLOTLY_DIR, ".permission_test") + + +def _permissions(): + try: + if not os.path.exists(PLOTLY_DIR): + try: + os.mkdir(PLOTLY_DIR) + except Exception: + # in case of race + if not os.path.isdir(PLOTLY_DIR): + raise + with open(TEST_FILE, 'w') as f: + f.write('testing\n') + try: + os.remove(TEST_FILE) + except Exception: + pass + return True + except Exception: # Do not trap KeyboardInterrupt. + return False + + +_file_permissions = None + + +def ensure_writable_plotly_dir(): + # Cache permissions status + global _file_permissions + if _file_permissions is None: + _file_permissions = _permissions() + return _file_permissions diff --git a/_plotly_utils/optional_imports.py b/_plotly_utils/optional_imports.py new file mode 100644 index 00000000000..7f49d1fe26f --- /dev/null +++ b/_plotly_utils/optional_imports.py @@ -0,0 +1,31 @@ +""" +Stand-alone module to provide information about whether optional deps exist. + +""" +from __future__ import absolute_import + +from importlib import import_module +import logging + +logger = logging.getLogger(__name__) +_not_importable = set() + + +def get_module(name): + """ + Return module or None. Absolute import is required. + + :param (str) name: Dot-separated module path. E.g., 'scipy.stats'. + :raise: (ImportError) Only when exc_msg is defined. + :return: (module|None) If import succeeds, the module will be returned. + + """ + if name not in _not_importable: + try: + return import_module(name) + except ImportError: + _not_importable.add(name) + except Exception as e: + _not_importable.add(name) + msg = "Error importing optional module {}".format(name) + logger.exception(msg) diff --git a/_plotly_utils/utils.py b/_plotly_utils/utils.py new file mode 100644 index 00000000000..ab5d03653af --- /dev/null +++ b/_plotly_utils/utils.py @@ -0,0 +1,244 @@ +import datetime +import decimal +import json as _json +import sys + +import pytz + +from _plotly_utils.optional_imports import get_module + + +PY36_OR_LATER = ( + sys.version_info.major == 3 and sys.version_info.minor >= 6 +) + + +class PlotlyJSONEncoder(_json.JSONEncoder): + """ + Meant to be passed as the `cls` kwarg to json.dumps(obj, cls=..) + + See PlotlyJSONEncoder.default for more implementation information. + + Additionally, this encoder overrides nan functionality so that 'Inf', + 'NaN' and '-Inf' encode to 'null'. Which is stricter JSON than the Python + version. + + """ + + def coerce_to_strict(self, const): + """ + This is used to ultimately *encode* into strict JSON, see `encode` + + """ + # before python 2.7, 'true', 'false', 'null', were include here. + if const in ('Infinity', '-Infinity', 'NaN'): + return None + else: + return const + + def encode(self, o): + """ + Load and then dump the result using parse_constant kwarg + + Note that setting invalid separators will cause a failure at this step. + + """ + + # this will raise errors in a normal-expected way + encoded_o = super(PlotlyJSONEncoder, self).encode(o) + + # now: + # 1. `loads` to switch Infinity, -Infinity, NaN to None + # 2. `dumps` again so you get 'null' instead of extended JSON + try: + new_o = _json.loads(encoded_o, + parse_constant=self.coerce_to_strict) + except ValueError: + + # invalid separators will fail here. raise a helpful exception + raise ValueError( + "Encoding into strict JSON failed. Did you set the separators " + "valid JSON separators?" + ) + else: + return _json.dumps(new_o, sort_keys=self.sort_keys, + indent=self.indent, + separators=(self.item_separator, + self.key_separator)) + + def default(self, obj): + """ + Accept an object (of unknown type) and try to encode with priority: + 1. builtin: user-defined objects + 2. sage: sage math cloud + 3. pandas: dataframes/series + 4. numpy: ndarrays + 5. datetime: time/datetime objects + + Each method throws a NotEncoded exception if it fails. + + The default method will only get hit if the object is not a type that + is naturally encoded by json: + + Normal objects: + dict object + list, tuple array + str, unicode string + int, long, float number + True true + False false + None null + + Extended objects: + float('nan') 'NaN' + float('infinity') 'Infinity' + float('-infinity') '-Infinity' + + Therefore, we only anticipate either unknown iterables or values here. + + """ + # TODO: The ordering if these methods is *very* important. Is this OK? + encoding_methods = ( + self.encode_as_plotly, + self.encode_as_sage, + self.encode_as_numpy, + self.encode_as_pandas, + self.encode_as_datetime, + self.encode_as_date, + self.encode_as_list, # because some values have `tolist` do last. + self.encode_as_decimal + ) + for encoding_method in encoding_methods: + try: + return encoding_method(obj) + except NotEncodable: + pass + return _json.JSONEncoder.default(self, obj) + + @staticmethod + def encode_as_plotly(obj): + """Attempt to use a builtin `to_plotly_json` method.""" + try: + return obj.to_plotly_json() + except AttributeError: + raise NotEncodable + + @staticmethod + def encode_as_list(obj): + """Attempt to use `tolist` method to convert to normal Python list.""" + if hasattr(obj, 'tolist'): + return obj.tolist() + else: + raise NotEncodable + + @staticmethod + def encode_as_sage(obj): + """Attempt to convert sage.all.RR to floats and sage.all.ZZ to ints""" + sage_all = get_module('sage.all') + if not sage_all: + raise NotEncodable + + if obj in sage_all.RR: + return float(obj) + elif obj in sage_all.ZZ: + return int(obj) + else: + raise NotEncodable + + @staticmethod + def encode_as_pandas(obj): + """Attempt to convert pandas.NaT""" + pandas = get_module('pandas') + if not pandas: + raise NotEncodable + + if obj is pandas.NaT: + return None + else: + raise NotEncodable + + @staticmethod + def encode_as_numpy(obj): + """Attempt to convert numpy.ma.core.masked""" + numpy = get_module('numpy') + if not numpy: + raise NotEncodable + + if obj is numpy.ma.core.masked: + return float('nan') + else: + raise NotEncodable + + @staticmethod + def encode_as_datetime(obj): + """Attempt to convert to utc-iso time string using datetime methods.""" + # Since PY36, isoformat() converts UTC + # datetime.datetime objs to UTC T04:00:00 + if not (PY36_OR_LATER and (isinstance(obj, datetime.datetime) and + obj.tzinfo is None)): + try: + obj = obj.astimezone(pytz.utc) + except ValueError: + # we'll get a value error if trying to convert with naive datetime + pass + except TypeError: + # pandas throws a typeerror here instead of a value error, it's OK + pass + except AttributeError: + # we'll get an attribute error if astimezone DNE + raise NotEncodable + + # now we need to get a nicely formatted time string + try: + time_string = obj.isoformat() + except AttributeError: + raise NotEncodable + else: + return iso_to_plotly_time_string(time_string) + + @staticmethod + def encode_as_date(obj): + """Attempt to convert to utc-iso time string using date methods.""" + try: + time_string = obj.isoformat() + except AttributeError: + raise NotEncodable + else: + return iso_to_plotly_time_string(time_string) + + @staticmethod + def encode_as_decimal(obj): + """Attempt to encode decimal by converting it to float""" + if isinstance(obj, decimal.Decimal): + return float(obj) + else: + raise NotEncodable + + +class NotEncodable(Exception): + pass + + +def iso_to_plotly_time_string(iso_string): + """Remove timezone info and replace 'T' delimeter with ' ' (ws).""" + # make sure we don't send timezone info to plotly + if (iso_string.split('-')[:3] is '00:00') or\ + (iso_string.split('+')[0] is '00:00'): + raise Exception("Plotly won't accept timestrings with timezone info.\n" + "All timestrings are assumed to be in UTC.") + + iso_string = iso_string.replace('-00:00', '').replace('+00:00', '') + + if iso_string.endswith('T00:00:00'): + return iso_string.replace('T00:00:00', '') + else: + return iso_string.replace('T', ' ') + + +def template_doc(**names): + def _decorator(func): + if sys.version[:3] != '3.2': + if func.__doc__ is not None: + func.__doc__ = func.__doc__.format(**names) + return func + return _decorator diff --git a/chart_studio/__init__.py b/chart_studio/__init__.py new file mode 100644 index 00000000000..c1adbe629b9 --- /dev/null +++ b/chart_studio/__init__.py @@ -0,0 +1,2 @@ +from __future__ import absolute_import +from chart_studio import (plotly, dashboard_objs, grid_objs, session) diff --git a/chart_studio/api/__init__.py b/chart_studio/api/__init__.py new file mode 100644 index 00000000000..eb018c3ff09 --- /dev/null +++ b/chart_studio/api/__init__.py @@ -0,0 +1 @@ +from . import utils diff --git a/chart_studio/api/utils.py b/chart_studio/api/utils.py new file mode 100644 index 00000000000..d9d1d21f504 --- /dev/null +++ b/chart_studio/api/utils.py @@ -0,0 +1,41 @@ +from base64 import b64encode + +from requests.compat import builtin_str, is_py2 + + +def _to_native_string(string, encoding): + if isinstance(string, builtin_str): + return string + if is_py2: + return string.encode(encoding) + return string.decode(encoding) + + +def to_native_utf8_string(string): + return _to_native_string(string, 'utf-8') + + +def to_native_ascii_string(string): + return _to_native_string(string, 'ascii') + + +def basic_auth(username, password): + """ + Creates the basic auth value to be used in an authorization header. + + This is mostly copied from the requests library. + + :param (str) username: A Plotly username. + :param (str) password: The password for the given Plotly username. + :returns: (str) An 'authorization' header for use in a request header. + + """ + if isinstance(username, str): + username = username.encode('latin1') + + if isinstance(password, str): + password = password.encode('latin1') + + return 'Basic ' + to_native_ascii_string( + b64encode(b':'.join((username, password))).strip() + ) diff --git a/chart_studio/api/v1/__init__.py b/chart_studio/api/v1/__init__.py new file mode 100644 index 00000000000..05fbba4143a --- /dev/null +++ b/chart_studio/api/v1/__init__.py @@ -0,0 +1,3 @@ +from __future__ import absolute_import + +from chart_studio.api.v1.clientresp import clientresp diff --git a/plotly/api/v1/clientresp.py b/chart_studio/api/v1/clientresp.py similarity index 83% rename from plotly/api/v1/clientresp.py rename to chart_studio/api/v1/clientresp.py index d27fc5e8121..dd933e7fd9b 100644 --- a/plotly/api/v1/clientresp.py +++ b/chart_studio/api/v1/clientresp.py @@ -5,8 +5,10 @@ from requests.compat import json as _json -from plotly import config, utils, version -from plotly.api.v1.utils import request + +from _plotly_utils.utils import PlotlyJSONEncoder +from chart_studio import config, utils +from chart_studio.api.v1.utils import request def clientresp(data, **kwargs): @@ -19,10 +21,12 @@ def clientresp(data, **kwargs): :param (list) data: The data array from a figure. """ + from plotly import version + creds = config.get_credentials() cfg = config.get_config() - dumps_kwargs = {'sort_keys': True, 'cls': utils.PlotlyJSONEncoder} + dumps_kwargs = {'sort_keys': True, 'cls': PlotlyJSONEncoder} payload = { 'platform': 'python', 'version': version.stable_semver(), diff --git a/chart_studio/api/v1/utils.py b/chart_studio/api/v1/utils.py new file mode 100644 index 00000000000..d0c40263a17 --- /dev/null +++ b/chart_studio/api/v1/utils.py @@ -0,0 +1,93 @@ +from __future__ import absolute_import + +import requests +from requests.exceptions import RequestException +from retrying import retry + +import _plotly_utils.exceptions +from chart_studio import config, exceptions +from chart_studio.api.utils import basic_auth +from chart_studio.api.v2.utils import should_retry + + +def validate_response(response): + """ + Raise a helpful PlotlyRequestError for failed requests. + + :param (requests.Response) response: A Response object from an api request. + :raises: (PlotlyRequestError) If the request failed for any reason. + :returns: (None) + + """ + content = response.content + status_code = response.status_code + try: + parsed_content = response.json() + except ValueError: + message = content if content else 'No Content' + raise exceptions.PlotlyRequestError(message, status_code, content) + + message = '' + if isinstance(parsed_content, dict): + error = parsed_content.get('error') + if error: + message = error + else: + if response.ok: + return + if not message: + message = content if content else 'No Content' + + raise exceptions.PlotlyRequestError(message, status_code, content) + + +def get_headers(): + """ + Using session credentials/config, get headers for a v1 API request. + + Users may have their own proxy layer and so we free up the `authorization` + header for this purpose (instead adding the user authorization in a new + `plotly-authorization` header). See pull #239. + + :returns: (dict) Headers to add to a requests.request call. + + """ + headers = {} + creds = config.get_credentials() + proxy_auth = basic_auth(creds['proxy_username'], creds['proxy_password']) + + if config.get_config()['plotly_proxy_authorization']: + headers['authorization'] = proxy_auth + + return headers + + +@retry(wait_exponential_multiplier=1000, wait_exponential_max=16000, + stop_max_delay=180000, retry_on_exception=should_retry) +def request(method, url, **kwargs): + """ + Central place to make any v1 api request. + + :param (str) method: The request method ('get', 'put', 'delete', ...). + :param (str) url: The full api url to make the request to. + :param kwargs: These are passed along to requests. + :return: (requests.Response) The response directly from requests. + + """ + if kwargs.get('json', None) is not None: + # See chart_studio.api.v2.utils.request for examples on how to do this. + raise _plotly_utils.exceptions.PlotlyError( + 'V1 API does not handle arbitrary json.') + kwargs['headers'] = dict(kwargs.get('headers', {}), **get_headers()) + kwargs['verify'] = config.get_config()['plotly_ssl_verification'] + try: + response = requests.request(method, url, **kwargs) + except RequestException as e: + # The message can be an exception. E.g., MaxRetryError. + message = str(getattr(e, 'message', 'No message')) + response = getattr(e, 'response', None) + status_code = response.status_code if response else None + content = response.content if response else 'No content' + raise exceptions.PlotlyRequestError(message, status_code, content) + validate_response(response) + return response diff --git a/chart_studio/api/v2/__init__.py b/chart_studio/api/v2/__init__.py new file mode 100644 index 00000000000..c248f72543d --- /dev/null +++ b/chart_studio/api/v2/__init__.py @@ -0,0 +1,5 @@ +from __future__ import absolute_import + +from chart_studio.api.v2 import (dash_apps, dashboards, files, folders, grids, + images, plot_schema, plots, + spectacle_presentations, users) diff --git a/plotly/api/v2/dash_apps.py b/chart_studio/api/v2/dash_apps.py similarity index 90% rename from plotly/api/v2/dash_apps.py rename to chart_studio/api/v2/dash_apps.py index e38848b53ae..c46ec3ff69e 100644 --- a/plotly/api/v2/dash_apps.py +++ b/chart_studio/api/v2/dash_apps.py @@ -3,7 +3,7 @@ """ from __future__ import absolute_import -from plotly.api.v2.utils import build_url, request +from chart_studio.api.v2.utils import build_url, request RESOURCE = 'dash-apps' diff --git a/plotly/api/v2/dashboards.py b/chart_studio/api/v2/dashboards.py similarity index 93% rename from plotly/api/v2/dashboards.py rename to chart_studio/api/v2/dashboards.py index c9aecf3e4a5..60c4e0dd898 100644 --- a/plotly/api/v2/dashboards.py +++ b/chart_studio/api/v2/dashboards.py @@ -6,7 +6,7 @@ """ from __future__ import absolute_import -from plotly.api.v2.utils import build_url, request +from chart_studio.api.v2.utils import build_url, request RESOURCE = 'dashboards' diff --git a/chart_studio/api/v2/files.py b/chart_studio/api/v2/files.py new file mode 100644 index 00000000000..1e250158f66 --- /dev/null +++ b/chart_studio/api/v2/files.py @@ -0,0 +1,85 @@ +"""Interface to Plotly's /v2/files endpoints.""" +from __future__ import absolute_import + +from chart_studio.api.v2.utils import build_url, make_params, request + +RESOURCE = 'files' + + +def retrieve(fid, share_key=None): + """ + Retrieve a general file from Plotly. + + :param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`. + :param (str) share_key: The secret key granting 'read' access if private. + :returns: (requests.Response) Returns response directly from requests. + + """ + url = build_url(RESOURCE, id=fid) + params = make_params(share_key=share_key) + return request('get', url, params=params) + + +def update(fid, body): + """ + Update a general file from Plotly. + + :param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`. + :param (dict) body: A mapping of body param names to values. + :returns: (requests.Response) Returns response directly from requests. + + """ + url = build_url(RESOURCE, id=fid) + return request('put', url, json=body) + + +def trash(fid): + """ + Soft-delete a general file from Plotly. (Can be undone with 'restore'). + + :param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`. + :returns: (requests.Response) Returns response directly from requests. + + """ + url = build_url(RESOURCE, id=fid, route='trash') + return request('post', url) + + +def restore(fid): + """ + Restore a trashed, general file from Plotly. See 'trash'. + + :param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`. + :returns: (requests.Response) Returns response directly from requests. + + """ + url = build_url(RESOURCE, id=fid, route='restore') + return request('post', url) + + +def permanent_delete(fid): + """ + Permanently delete a trashed, general file from Plotly. See 'trash'. + + :param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`. + :returns: (requests.Response) Returns response directly from requests. + + """ + url = build_url(RESOURCE, id=fid, route='permanent_delete') + return request('delete', url) + + +def lookup(path, parent=None, user=None, exists=None): + """ + Retrieve a general file from Plotly without needing a fid. + + :param (str) path: The '/'-delimited path specifying the file location. + :param (int) parent: Parent id, an integer, which the path is relative to. + :param (str) user: The username to target files for. Defaults to requestor. + :param (bool) exists: If True, don't return the full file, just a flag. + :returns: (requests.Response) Returns response directly from requests. + + """ + url = build_url(RESOURCE, route='lookup') + params = make_params(path=path, parent=parent, user=user, exists=exists) + return request('get', url, params=params) diff --git a/plotly/api/v2/folders.py b/chart_studio/api/v2/folders.py similarity index 97% rename from plotly/api/v2/folders.py rename to chart_studio/api/v2/folders.py index 2dcf84670e7..81d72466ca1 100644 --- a/plotly/api/v2/folders.py +++ b/chart_studio/api/v2/folders.py @@ -1,7 +1,7 @@ """Interface to Plotly's /v2/folders endpoints.""" from __future__ import absolute_import -from plotly.api.v2.utils import build_url, make_params, request +from chart_studio.api.v2.utils import build_url, make_params, request RESOURCE = 'folders' diff --git a/plotly/api/v2/grids.py b/chart_studio/api/v2/grids.py similarity index 98% rename from plotly/api/v2/grids.py rename to chart_studio/api/v2/grids.py index 144ec3bd23f..726419a9b3d 100644 --- a/plotly/api/v2/grids.py +++ b/chart_studio/api/v2/grids.py @@ -1,7 +1,7 @@ """Interface to Plotly's /v2/grids endpoints.""" from __future__ import absolute_import -from plotly.api.v2.utils import build_url, make_params, request +from chart_studio.api.v2.utils import build_url, make_params, request RESOURCE = 'grids' diff --git a/plotly/api/v2/images.py b/chart_studio/api/v2/images.py similarity index 88% rename from plotly/api/v2/images.py rename to chart_studio/api/v2/images.py index 4c9d1816081..c6f7ea1a781 100644 --- a/plotly/api/v2/images.py +++ b/chart_studio/api/v2/images.py @@ -1,7 +1,7 @@ """Interface to Plotly's /v2/images endpoints.""" from __future__ import absolute_import -from plotly.api.v2.utils import build_url, request +from chart_studio.api.v2.utils import build_url, request RESOURCE = 'images' diff --git a/plotly/api/v2/plot_schema.py b/chart_studio/api/v2/plot_schema.py similarity index 88% rename from plotly/api/v2/plot_schema.py rename to chart_studio/api/v2/plot_schema.py index 4edbc0a707b..9b9a7ea7edf 100644 --- a/plotly/api/v2/plot_schema.py +++ b/chart_studio/api/v2/plot_schema.py @@ -1,7 +1,7 @@ """Interface to Plotly's /v2/plot-schema endpoints.""" from __future__ import absolute_import -from plotly.api.v2.utils import build_url, make_params, request +from chart_studio.api.v2.utils import build_url, make_params, request RESOURCE = 'plot-schema' diff --git a/plotly/api/v2/plots.py b/chart_studio/api/v2/plots.py similarity index 98% rename from plotly/api/v2/plots.py rename to chart_studio/api/v2/plots.py index da9f2d9e395..d33c01b7068 100644 --- a/plotly/api/v2/plots.py +++ b/chart_studio/api/v2/plots.py @@ -1,7 +1,7 @@ """Interface to Plotly's /v2/plots endpoints.""" from __future__ import absolute_import -from plotly.api.v2.utils import build_url, make_params, request +from chart_studio.api.v2.utils import build_url, make_params, request RESOURCE = 'plots' diff --git a/plotly/api/v2/spectacle_presentations.py b/chart_studio/api/v2/spectacle_presentations.py similarity index 92% rename from plotly/api/v2/spectacle_presentations.py rename to chart_studio/api/v2/spectacle_presentations.py index e34cf972bd1..343809d4586 100644 --- a/plotly/api/v2/spectacle_presentations.py +++ b/chart_studio/api/v2/spectacle_presentations.py @@ -3,7 +3,7 @@ """ from __future__ import absolute_import -from plotly.api.v2.utils import build_url, request +from chart_studio.api.v2.utils import build_url, request RESOURCE = 'spectacle-presentations' diff --git a/plotly/api/v2/users.py b/chart_studio/api/v2/users.py similarity index 86% rename from plotly/api/v2/users.py rename to chart_studio/api/v2/users.py index cdfaf51c488..b9300c2107e 100644 --- a/plotly/api/v2/users.py +++ b/chart_studio/api/v2/users.py @@ -1,7 +1,7 @@ """Interface to Plotly's /v2/files endpoints.""" from __future__ import absolute_import -from plotly.api.v2.utils import build_url, request +from chart_studio.api.v2.utils import build_url, request RESOURCE = 'users' diff --git a/chart_studio/api/v2/utils.py b/chart_studio/api/v2/utils.py new file mode 100644 index 00000000000..ec9a4201b39 --- /dev/null +++ b/chart_studio/api/v2/utils.py @@ -0,0 +1,173 @@ +from __future__ import absolute_import + +import requests +from requests.compat import json as _json +from requests.exceptions import RequestException +from retrying import retry + +import _plotly_utils.exceptions +from chart_studio import config, exceptions +from chart_studio.api.utils import basic_auth +from _plotly_utils.utils import PlotlyJSONEncoder + + +def make_params(**kwargs): + """ + Helper to create a params dict, skipping undefined entries. + + :returns: (dict) A params dict to pass to `request`. + + """ + return {k: v for k, v in kwargs.items() if v is not None} + + +def build_url(resource, id='', route=''): + """ + Create a url for a request on a V2 resource. + + :param (str) resource: E.g., 'files', 'plots', 'grids', etc. + :param (str) id: The unique identifier for the resource. + :param (str) route: Detail/list route. E.g., 'restore', 'lookup', etc. + :return: (str) The url. + + """ + base = config.get_config()['plotly_api_domain'] + formatter = {'base': base, 'resource': resource, 'id': id, 'route': route} + + # Add path to base url depending on the input params. Note that `route` + # can refer to a 'list' or a 'detail' route. Since it cannot refer to + # both at the same time, it's overloaded in this function. + if id: + if route: + url = '{base}/v2/{resource}/{id}/{route}'.format(**formatter) + else: + url = '{base}/v2/{resource}/{id}'.format(**formatter) + else: + if route: + url = '{base}/v2/{resource}/{route}'.format(**formatter) + else: + url = '{base}/v2/{resource}'.format(**formatter) + + return url + + +def validate_response(response): + """ + Raise a helpful PlotlyRequestError for failed requests. + + :param (requests.Response) response: A Response object from an api request. + :raises: (PlotlyRequestError) If the request failed for any reason. + :returns: (None) + + """ + if response.ok: + return + + content = response.content + status_code = response.status_code + try: + parsed_content = response.json() + except ValueError: + message = content if content else 'No Content' + raise exceptions.PlotlyRequestError(message, status_code, content) + + message = '' + if isinstance(parsed_content, dict): + errors = parsed_content.get('errors', []) + messages = [error.get('message') for error in errors] + message = '\n'.join([msg for msg in messages if msg]) + if not message: + message = content if content else 'No Content' + + raise exceptions.PlotlyRequestError(message, status_code, content) + + +def get_headers(): + """ + Using session credentials/config, get headers for a V2 API request. + + Users may have their own proxy layer and so we free up the `authorization` + header for this purpose (instead adding the user authorization in a new + `plotly-authorization` header). See pull #239. + + :returns: (dict) Headers to add to a requests.request call. + + """ + from plotly import version + creds = config.get_credentials() + + headers = { + 'plotly-client-platform': 'python {}'.format(version.stable_semver()), + 'content-type': 'application/json' + } + + plotly_auth = basic_auth(creds['username'], creds['api_key']) + proxy_auth = basic_auth(creds['proxy_username'], creds['proxy_password']) + + if config.get_config()['plotly_proxy_authorization']: + headers['authorization'] = proxy_auth + if creds['username'] and creds['api_key']: + headers['plotly-authorization'] = plotly_auth + else: + if creds['username'] and creds['api_key']: + headers['authorization'] = plotly_auth + + return headers + + +def should_retry(exception): + if isinstance(exception, exceptions.PlotlyRequestError): + if (isinstance(exception.status_code, int) and + (500 <= exception.status_code < 600 or exception.status_code == 429)): + # Retry on 5XX and 429 (image export throttling) errors. + return True + elif 'Uh oh, an error occurred' in exception.message: + return True + + return False + + +@retry(wait_exponential_multiplier=1000, wait_exponential_max=16000, + stop_max_delay=180000, retry_on_exception=should_retry) +def request(method, url, **kwargs): + """ + Central place to make any api v2 api request. + + :param (str) method: The request method ('get', 'put', 'delete', ...). + :param (str) url: The full api url to make the request to. + :param kwargs: These are passed along (but possibly mutated) to requests. + :return: (requests.Response) The response directly from requests. + + """ + kwargs['headers'] = dict(kwargs.get('headers', {}), **get_headers()) + + # Change boolean params to lowercase strings. E.g., `True` --> `'true'`. + # Just change the value so that requests handles query string creation. + if isinstance(kwargs.get('params'), dict): + kwargs['params'] = kwargs['params'].copy() + for key in kwargs['params']: + if isinstance(kwargs['params'][key], bool): + kwargs['params'][key] = _json.dumps(kwargs['params'][key]) + + # We have a special json encoding class for non-native objects. + if kwargs.get('json') is not None: + if kwargs.get('data'): + raise _plotly_utils.exceptions.PlotlyError( + 'Cannot supply data and json kwargs.') + kwargs['data'] = _json.dumps(kwargs.pop('json'), sort_keys=True, + cls=PlotlyJSONEncoder) + + # The config file determines whether reuqests should *verify*. + kwargs['verify'] = config.get_config()['plotly_ssl_verification'] + + try: + response = requests.request(method, url, **kwargs) + except RequestException as e: + # The message can be an exception. E.g., MaxRetryError. + message = str(getattr(e, 'message', 'No message')) + response = getattr(e, 'response', None) + status_code = response.status_code if response else None + content = response.content if response else 'No content' + raise exceptions.PlotlyRequestError(message, status_code, content) + validate_response(response) + return response diff --git a/chart_studio/config.py b/chart_studio/config.py new file mode 100644 index 00000000000..5cb2b30ad48 --- /dev/null +++ b/chart_studio/config.py @@ -0,0 +1,35 @@ +""" +Merges and prioritizes file/session config and credentials. + +This is promoted to its own module to simplify imports. + +""" +from __future__ import absolute_import + +from chart_studio import session, tools + + +def get_credentials(): + """Returns the credentials that will be sent to plotly.""" + credentials = tools.get_credentials_file() + session_credentials = session.get_session_credentials() + for credentials_key in credentials: + + # checking for not false, but truthy value here is the desired behavior + session_value = session_credentials.get(credentials_key) + if session_value is False or session_value: + credentials[credentials_key] = session_value + return credentials + + +def get_config(): + """Returns either module config or file config.""" + config = tools.get_config_file() + session_config = session.get_session_config() + for config_key in config: + + # checking for not false, but truthy value here is the desired behavior + session_value = session_config.get(config_key) + if session_value is False or session_value: + config[config_key] = session_value + return config diff --git a/plotly/dashboard_objs/__init__.py b/chart_studio/dashboard_objs/__init__.py similarity index 100% rename from plotly/dashboard_objs/__init__.py rename to chart_studio/dashboard_objs/__init__.py diff --git a/chart_studio/dashboard_objs/dashboard_objs.py b/chart_studio/dashboard_objs/dashboard_objs.py new file mode 100644 index 00000000000..13ef7032e00 --- /dev/null +++ b/chart_studio/dashboard_objs/dashboard_objs.py @@ -0,0 +1,629 @@ +""" +dashboard_objs +========== + +A module for creating and manipulating dashboard content. You can create +a Dashboard object, insert boxes, swap boxes, remove a box and get an HTML +preview of the Dashboard. +``` +""" + +import pprint + +import _plotly_utils.exceptions +from _plotly_utils import optional_imports +from chart_studio import exceptions + +IPython = optional_imports.get_module('IPython') + +# default parameters for HTML preview +MASTER_WIDTH = 500 +MASTER_HEIGHT = 500 +FONT_SIZE = 9 + + +ID_NOT_VALID_MESSAGE = ( + "Your box_id must be a number in your dashboard. To view a " + "representation of your dashboard run get_preview()." +) + + +def _empty_box(): + empty_box = { + 'type': 'box', + 'boxType': 'empty' + } + return empty_box + + +def _box(fileId='', shareKey=None, title=''): + box = { + 'type': 'box', + 'boxType': 'plot', + 'fileId': fileId, + 'shareKey': shareKey, + 'title': title + } + return box + +def _container(box_1=None, box_2=None, + size=50, sizeUnit='%', + direction='vertical'): + if box_1 is None: + box_1 = _empty_box() + if box_2 is None: + box_2 = _empty_box() + + container = { + 'type': 'split', + 'size': size, + 'sizeUnit': sizeUnit, + 'direction': direction, + 'first': box_1, + 'second': box_2 + } + + return container + +dashboard_html = (""" + + + + + + + + + + +""".format(width=MASTER_WIDTH, height=MASTER_HEIGHT)) + + +def _draw_line_through_box(dashboard_html, top_left_x, top_left_y, box_w, + box_h, is_horizontal, direction, fill_percent=50): + if is_horizontal: + new_top_left_x = top_left_x + box_w * (fill_percent / 100.) + new_top_left_y = top_left_y + new_box_w = 1 + new_box_h = box_h + else: + new_top_left_x = top_left_x + new_top_left_y = top_left_y + box_h * (fill_percent / 100.) + new_box_w = box_w + new_box_h = 1 + + html_box = """ + context.beginPath(); + context.rect({top_left_x}, {top_left_y}, {box_w}, {box_h}); + context.lineWidth = 1; + context.strokeStyle = 'black'; + context.stroke(); + """.format(top_left_x=new_top_left_x, top_left_y=new_top_left_y, + box_w=new_box_w, box_h=new_box_h) + + index_for_new_box = dashboard_html.find('') - 1 + dashboard_html = (dashboard_html[:index_for_new_box] + html_box + + dashboard_html[index_for_new_box:]) + return dashboard_html + + +def _add_html_text(dashboard_html, text, top_left_x, top_left_y, box_w, + box_h): + html_text = """ + context.font = '{}pt Times New Roman'; + context.textAlign = 'center'; + context.fillText({}, {} + 0.5*{}, {} + 0.5*{}); + """.format(FONT_SIZE, text, top_left_x, box_w, top_left_y, box_h) + + index_to_add_text = dashboard_html.find('') - 1 + dashboard_html = (dashboard_html[:index_to_add_text] + html_text + + dashboard_html[index_to_add_text:]) + return dashboard_html + + +class Dashboard(dict): + """ + Dashboard class for creating interactive dashboard objects. + + Dashboards are dicts that contain boxes which hold plot information. + These boxes can be arranged in various ways. The most basic form of + a box is: + + ``` + { + 'type': 'box', + 'boxType': 'plot' + } + ``` + + where 'fileId' can be set to the 'username:#' of your plot. The other + parameters a box takes are `shareKey` (default is None) and `title` + (default is ''). + + `.get_preview()` should be called quite regularly to get an HTML + representation of the dashboard in which the boxes in the HTML + are labelled with on-the-fly-generated numbers or box ids which + change after each modification to the dashboard. + + `.get_box()` returns the box located in the dashboard by calling + its box id as displayed via `.get_preview()`. + + Example 1: Create a simple Dashboard object + ``` + import plotly.dashboard_objs as dashboard + + box_a = { + 'type': 'box', + 'boxType': 'plot', + 'fileId': 'username:some#', + 'title': 'box a' + } + + box_b = { + 'type': 'box', + 'boxType': 'plot', + 'fileId': 'username:some#', + 'title': 'box b' + } + + box_c = { + 'type': 'box', + 'boxType': 'plot', + 'fileId': 'username:some#', + 'title': 'box c' + } + + my_dboard = dashboard.Dashboard() + my_dboard.insert(box_a) + # my_dboard.get_preview() + my_dboard.insert(box_b, 'above', 1) + # my_dboard.get_preview() + my_dboard.insert(box_c, 'left', 2) + # my_dboard.get_preview() + my_dboard.swap(1, 2) + # my_dboard.get_preview() + my_dboard.remove(1) + # my_dboard.get_preview() + ``` + + Example 2: 4 vertical boxes of equal height + ``` + import plotly.dashboard_objs as dashboard + + box_a = { + 'type': 'box', + 'boxType': 'plot', + 'fileId': 'username:some#', + 'title': 'box a' + } + + my_dboard = dashboard.Dashboard() + my_dboard.insert(box_a) + my_dboard.insert(box_a, 'below', 1) + my_dboard.insert(box_a, 'below', 1) + my_dboard.insert(box_a, 'below', 3) + # my_dboard.get_preview() + ``` + """ + def __init__(self, content=None): + if content is None: + content = {} + + if not content: + self['layout'] = None + self['version'] = 2 + self['settings'] = {} + else: + self['layout'] = content['layout'] + self['version'] = content['version'] + self['settings'] = content['settings'] + + def _compute_box_ids(self): + from plotly.utils import node_generator + + box_ids_to_path = {} + all_nodes = list(node_generator(self['layout'])) + all_nodes.sort(key=lambda x: x[1]) + for node in all_nodes: + if (node[1] != () and node[0]['type'] == 'box' + and node[0]['boxType'] != 'empty'): + try: + max_id = max(box_ids_to_path.keys()) + except ValueError: + max_id = 0 + box_ids_to_path[max_id + 1] = node[1] + + return box_ids_to_path + + def _insert(self, box_or_container, path): + if any(first_second not in ['first', 'second'] + for first_second in path): + raise _plotly_utils.exceptions.PlotlyError( + "Invalid path. Your 'path' list must only contain " + "the strings 'first' and 'second'." + ) + + if 'first' in self['layout']: + loc_in_dashboard = self['layout'] + for index, first_second in enumerate(path): + if index != len(path) - 1: + loc_in_dashboard = loc_in_dashboard[first_second] + else: + loc_in_dashboard[first_second] = box_or_container + + else: + self['layout'] = box_or_container + + def _make_all_nodes_and_paths(self): + from plotly.utils import node_generator + + all_nodes = list(node_generator(self['layout'])) + all_nodes.sort(key=lambda x: x[1]) + + # remove path 'second' as it's always an empty box + all_paths = [] + for node in all_nodes: + all_paths.append(node[1]) + path_second = ('second',) + if path_second in all_paths: + all_paths.remove(path_second) + return all_nodes, all_paths + + def _path_to_box(self, path): + loc_in_dashboard = self['layout'] + for first_second in path: + loc_in_dashboard = loc_in_dashboard[first_second] + return loc_in_dashboard + + def _set_dashboard_size(self): + # set dashboard size to keep consistent with GUI + num_of_boxes = len(self._compute_box_ids()) + if num_of_boxes == 0: + pass + elif num_of_boxes == 1: + self['layout']['size'] = 800 + self['layout']['sizeUnit'] = 'px' + elif num_of_boxes == 2: + self['layout']['size'] = 1500 + self['layout']['sizeUnit'] = 'px' + else: + self['layout']['size'] = 1500 + 350 * (num_of_boxes - 2) + self['layout']['sizeUnit'] = 'px' + + def get_box(self, box_id): + """Returns box from box_id number.""" + box_ids_to_path = self._compute_box_ids() + loc_in_dashboard = self['layout'] + + if box_id not in box_ids_to_path.keys(): + raise _plotly_utils.exceptions.PlotlyError(ID_NOT_VALID_MESSAGE) + for first_second in box_ids_to_path[box_id]: + loc_in_dashboard = loc_in_dashboard[first_second] + return loc_in_dashboard + + def get_preview(self): + """ + Returns JSON or HTML respresentation of the dashboard. + + If IPython is not imported, returns a pretty print of the dashboard + dict. Otherwise, returns an IPython.core.display.HTML display of the + dashboard. + + The algorithm used to build the HTML preview involves going through + the paths of the node generator of the dashboard. The paths of the + dashboard are sequenced through from shorter to longer and whether + it's a box or container that lies at the end of the path determines + the action. + + If it's a container, draw a line in the figure to divide the current + box into two and store the specs of the resulting two boxes. If the + path points to a terminal box (often containing a plot), then draw + the box id in the center of the box. + + It's important to note that these box ids are generated on-the-fly and + they do not necessarily stay assigned to the boxes they were once + assigned to. + """ + if IPython is None: + pprint.pprint(self) + return + + elif self['layout'] is None: + return IPython.display.HTML(dashboard_html) + + top_left_x = 0 + top_left_y = 0 + box_w = MASTER_WIDTH + box_h = MASTER_HEIGHT + html_figure = dashboard_html + box_ids_to_path = self._compute_box_ids() + # used to store info about box dimensions + path_to_box_specs = {} + first_box_specs = { + 'top_left_x': top_left_x, + 'top_left_y': top_left_y, + 'box_w': box_w, + 'box_h': box_h + } + # uses tuples to store paths as for hashable keys + path_to_box_specs[('first',)] = first_box_specs + + # generate all paths + all_nodes, all_paths = self._make_all_nodes_and_paths() + + max_path_len = max(len(path) for path in all_paths) + for path_len in range(1, max_path_len + 1): + for path in [path for path in all_paths if len(path) == path_len]: + current_box_specs = path_to_box_specs[path] + + if self._path_to_box(path)['type'] == 'split': + fill_percent = self._path_to_box(path)['size'] + direction = self._path_to_box(path)['direction'] + is_horizontal = (direction == 'horizontal') + + top_left_x = current_box_specs['top_left_x'] + top_left_y = current_box_specs['top_left_y'] + box_w = current_box_specs['box_w'] + box_h = current_box_specs['box_h'] + + html_figure = _draw_line_through_box( + html_figure, top_left_x, top_left_y, box_w, box_h, + is_horizontal=is_horizontal, direction=direction, + fill_percent=fill_percent + ) + + # determine the specs for resulting two box split + if is_horizontal: + new_top_left_x = top_left_x + new_top_left_y = top_left_y + new_box_w = box_w * (fill_percent / 100.) + new_box_h = box_h + + new_top_left_x_2 = top_left_x + new_box_w + new_top_left_y_2 = top_left_y + new_box_w_2 = box_w * ((100 - fill_percent) / 100.) + new_box_h_2 = box_h + else: + new_top_left_x = top_left_x + new_top_left_y = top_left_y + new_box_w = box_w + new_box_h = box_h * (fill_percent / 100.) + + new_top_left_x_2 = top_left_x + new_top_left_y_2 = (top_left_y + + box_h * (fill_percent / 100.)) + new_box_w_2 = box_w + new_box_h_2 = box_h * ((100 - fill_percent) / 100.) + + first_box_specs = { + 'top_left_x': top_left_x, + 'top_left_y': top_left_y, + 'box_w': new_box_w, + 'box_h': new_box_h + } + second_box_specs = { + 'top_left_x': new_top_left_x_2, + 'top_left_y': new_top_left_y_2, + 'box_w': new_box_w_2, + 'box_h': new_box_h_2 + } + + path_to_box_specs[path + ('first',)] = first_box_specs + path_to_box_specs[path + ('second',)] = second_box_specs + + elif self._path_to_box(path)['type'] == 'box': + for box_id in box_ids_to_path: + if box_ids_to_path[box_id] == path: + number = box_id + html_figure = _add_html_text( + html_figure, number, + path_to_box_specs[path]['top_left_x'], + path_to_box_specs[path]['top_left_y'], + path_to_box_specs[path]['box_w'], + path_to_box_specs[path]['box_h'], + ) + + # display HTML representation + return IPython.display.HTML(html_figure) + + def insert(self, box, side='above', box_id=None, fill_percent=50): + """ + Insert a box into your dashboard layout. + + :param (dict) box: the box you are inserting into the dashboard. + :param (str) side: specifies where your new box is going to be placed + relative to the given 'box_id'. Valid values are 'above', 'below', + 'left', and 'right'. + :param (int) box_id: the box id which is used as a reference for the + insertion of the new box. Box ids are memoryless numbers that are + generated on-the-fly and assigned to boxes in the layout each time + .get_preview() is run. + :param (float) fill_percent: specifies the percentage of the container + box from the given 'side' that the new box occupies. For example + if you apply the method\n + .insert(box=new_box, box_id=2, side='left', fill_percent=20)\n + to a dashboard object, a new box is inserted 20% from the left + side of the box with id #2. Run .get_preview() to see the box ids + assigned to each box in the dashboard layout. + Default = 50 + Example: + ``` + import plotly.dashboard_objs as dashboard + + box_a = { + 'type': 'box', + 'boxType': 'plot', + 'fileId': 'username:some#', + 'title': 'box a' + } + + my_dboard = dashboard.Dashboard() + my_dboard.insert(box_a) + my_dboard.insert(box_a, 'left', 1) + my_dboard.insert(box_a, 'below', 2) + my_dboard.insert(box_a, 'right', 3) + my_dboard.insert(box_a, 'above', 4, fill_percent=20) + + my_dboard.get_preview() + ``` + """ + box_ids_to_path = self._compute_box_ids() + + # doesn't need box_id or side specified for first box + if self['layout'] is None: + self['layout'] = _container( + box, _empty_box(), size=MASTER_HEIGHT, sizeUnit='px' + ) + else: + if box_id is None: + raise _plotly_utils.exceptions.PlotlyError( + "Make sure the box_id is specfied if there is at least " + "one box in your dashboard." + ) + if box_id not in box_ids_to_path: + raise _plotly_utils.exceptions.PlotlyError(ID_NOT_VALID_MESSAGE) + + if fill_percent < 0 or fill_percent > 100: + raise _plotly_utils.exceptions.PlotlyError( + 'fill_percent must be a number between 0 and 100 ' + 'inclusive' + ) + if side == 'above': + old_box = self.get_box(box_id) + self._insert( + _container(box, old_box, direction='vertical', + size=fill_percent), + box_ids_to_path[box_id] + ) + elif side == 'below': + old_box = self.get_box(box_id) + self._insert( + _container(old_box, box, direction='vertical', + size=100 - fill_percent), + box_ids_to_path[box_id] + ) + elif side == 'left': + old_box = self.get_box(box_id) + self._insert( + _container(box, old_box, direction='horizontal', + size=fill_percent), + box_ids_to_path[box_id] + ) + elif side == 'right': + old_box = self.get_box(box_id) + self._insert( + _container(old_box, box, direction='horizontal', + size =100 - fill_percent), + box_ids_to_path[box_id] + ) + else: + raise _plotly_utils.exceptions.PlotlyError( + "If there is at least one box in your dashboard, you " + "must specify a valid side value. You must choose from " + "'above', 'below', 'left', and 'right'." + ) + + self._set_dashboard_size() + + def remove(self, box_id): + """ + Remove a box from the dashboard by its box_id. + + Example: + ``` + import plotly.dashboard_objs as dashboard + + box_a = { + 'type': 'box', + 'boxType': 'plot', + 'fileId': 'username:some#', + 'title': 'box a' + } + + my_dboard = dashboard.Dashboard() + my_dboard.insert(box_a) + my_dboard.remove(1) + my_dboard.get_preview() + ``` + """ + box_ids_to_path = self._compute_box_ids() + if box_id not in box_ids_to_path: + raise _plotly_utils.exceptions.PlotlyError(ID_NOT_VALID_MESSAGE) + + path = box_ids_to_path[box_id] + if path != ('first',): + container_for_box_id = self._path_to_box(path[:-1]) + if path[-1] == 'first': + adjacent_path = 'second' + elif path[-1] == 'second': + adjacent_path = 'first' + adjacent_box = container_for_box_id[adjacent_path] + + self._insert(adjacent_box, path[:-1]) + else: + self['layout'] = None + + self._set_dashboard_size() + + def swap(self, box_id_1, box_id_2): + """ + Swap two boxes with their specified ids. + + Example: + ``` + import plotly.dashboard_objs as dashboard + + box_a = { + 'type': 'box', + 'boxType': 'plot', + 'fileId': 'username:first#', + 'title': 'box a' + } + + box_b = { + 'type': 'box', + 'boxType': 'plot', + 'fileId': 'username:second#', + 'title': 'box b' + } + + my_dboard = dashboard.Dashboard() + my_dboard.insert(box_a) + my_dboard.insert(box_b, 'above', 1) + + # check box at box id 1 + box_at_1 = my_dboard.get_box(1) + print(box_at_1) + + my_dboard.swap(1, 2) + + box_after_swap = my_dboard.get_box(1) + print(box_after_swap) + ``` + """ + box_ids_to_path = self._compute_box_ids() + box_a = self.get_box(box_id_1) + box_b = self.get_box(box_id_2) + + box_a_path = box_ids_to_path[box_id_1] + box_b_path = box_ids_to_path[box_id_2] + + for pairs in [(box_a_path, box_b), (box_b_path, box_a)]: + loc_in_dashboard = self['layout'] + for first_second in pairs[0][:-1]: + loc_in_dashboard = loc_in_dashboard[first_second] + loc_in_dashboard[pairs[0][-1]] = pairs[1] diff --git a/chart_studio/exceptions.py b/chart_studio/exceptions.py new file mode 100644 index 00000000000..fa5054b86b3 --- /dev/null +++ b/chart_studio/exceptions.py @@ -0,0 +1,91 @@ +""" +exceptions +========== + +A module that contains plotly's exception hierarchy. + +""" +from __future__ import absolute_import + +from chart_studio.api.utils import to_native_utf8_string + + +# Base Plotly Error +from _plotly_utils.exceptions import PlotlyError + + +class InputError(PlotlyError): + pass + + +class PlotlyRequestError(PlotlyError): + """General API error. Raised for *all* failed requests.""" + + def __init__(self, message, status_code, content): + self.message = to_native_utf8_string(message) + self.status_code = status_code + self.content = content + + def __str__(self): + return self.message + + +# Grid Errors +COLUMN_NOT_YET_UPLOADED_MESSAGE = ( + "Hm... it looks like your column '{column_name}' hasn't " + "been uploaded to Plotly yet. You need to upload your " + "column to Plotly before you can assign it to '{reference}'.\n" + "To upload, try `plotly.plotly.grid_objs.upload` or " + "`plotly.plotly.grid_objs.append_column`.\n" + "Questions? chris@plot.ly" +) + +NON_UNIQUE_COLUMN_MESSAGE = ( + "Yikes, plotly grids currently " + "can't have duplicate column names. Rename " + "the column \"{0}\" and try again." +) + +# Local Config Errors +class PlotlyLocalError(PlotlyError): + pass + + +class PlotlyLocalCredentialsError(PlotlyLocalError): + def __init__(self): + message = ( + "\n" + "Couldn't find a 'username', 'api-key' pair for you on your local " + "machine. To sign in temporarily (until you stop running Python), " + "run:\n" + ">>> import plotly.plotly as py\n" + ">>> py.sign_in('username', 'api_key')\n\n" + "Even better, save your credentials permanently using the 'tools' " + "module:\n" + ">>> import plotly.tools as tls\n" + ">>> tls.set_credentials_file(username='username', " + "api_key='api-key')\n\n" + "For more help, see https://plot.ly/python.\n" + ) + super(PlotlyLocalCredentialsError, self).__init__(message) + + +# Server Errors +class PlotlyServerError(PlotlyError): + pass + + +class PlotlyConnectionError(PlotlyServerError): + pass + + +class PlotlyCredentialError(PlotlyServerError): + pass + + +class PlotlyAccountError(PlotlyServerError): + pass + + +class PlotlyRateLimitError(PlotlyServerError): + pass diff --git a/chart_studio/files.py b/chart_studio/files.py new file mode 100644 index 00000000000..19fe98ea5cf --- /dev/null +++ b/chart_studio/files.py @@ -0,0 +1,24 @@ +from __future__ import absolute_import + +import os + +# file structure +from _plotly_utils.files import PLOTLY_DIR + +CREDENTIALS_FILE = os.path.join(PLOTLY_DIR, ".credentials") +CONFIG_FILE = os.path.join(PLOTLY_DIR, ".config") + +# this sets both the DEFAULTS and the TYPES for these files +FILE_CONTENT = {CREDENTIALS_FILE: {'username': '', + 'api_key': '', + 'proxy_username': '', + 'proxy_password': '', + 'stream_ids': []}, + CONFIG_FILE: {'plotly_domain': 'https://plot.ly', + 'plotly_streaming_domain': 'stream.plot.ly', + 'plotly_api_domain': 'https://api.plot.ly', + 'plotly_ssl_verification': True, + 'plotly_proxy_authorization': False, + 'world_readable': True, + 'sharing': 'public', + 'auto_open': True}} diff --git a/chart_studio/grid_objs/__init__.py b/chart_studio/grid_objs/__init__.py new file mode 100644 index 00000000000..ae484f25e17 --- /dev/null +++ b/chart_studio/grid_objs/__init__.py @@ -0,0 +1,8 @@ +"""" +grid_objs +========= + +""" +from __future__ import absolute_import + +from chart_studio.grid_objs.grid_objs import Grid, Column diff --git a/chart_studio/grid_objs/grid_objs.py b/chart_studio/grid_objs/grid_objs.py new file mode 100644 index 00000000000..414d9800d2e --- /dev/null +++ b/chart_studio/grid_objs/grid_objs.py @@ -0,0 +1,299 @@ +""" +grid_objs +========= + +""" +from __future__ import absolute_import + +import _plotly_utils.exceptions + +try: + from collections.abc import MutableSequence +except ImportError: + from collections import MutableSequence + +from requests.compat import json as _json + +from _plotly_utils.optional_imports import get_module +from chart_studio import utils, exceptions + +__all__ = None + + +class Column(object): + """ + Columns make up Plotly Grids and can be the source of + data for Plotly Graphs. + They have a name and an array of data. + They can be uploaded to Plotly with the `plotly.plotly.grid_ops` + class. + + Usage example 1: Upload a set of columns as a grid to Plotly + ``` + from plotly.grid_objs import Grid, Column + import plotly.plotly as py + column_1 = Column([1, 2, 3], 'time') + column_2 = Column([4, 2, 5], 'voltage') + grid = Grid([column_1, column_2]) + py.grid_ops.upload(grid, 'time vs voltage') + ``` + + Usage example 2: Make a graph based with data that is sourced + from a newly uploaded Plotly columns + ``` + import plotly.plotly as py + from plotly.grid_objs import Grid, Column + from plotly.graph_objs import Scatter + # Upload a grid + column_1 = Column([1, 2, 3], 'time') + column_2 = Column([4, 2, 5], 'voltage') + grid = Grid([column_1, column_2]) + py.grid_ops.upload(grid, 'time vs voltage') + + # Build a Plotly graph object sourced from the + # grid's columns + trace = Scatter(xsrc=grid[0], ysrc=grid[1]) + py.plot([trace], filename='graph from grid') + ``` + """ + def __init__(self, data, name): + """ + Initialize a Plotly column with `data` and `name`. + `data` is an array of strings, numbers, or dates. + `name` is the name of the column as it will apppear + in the Plotly grid. Names must be unique to a grid. + """ + + # TODO: data type checking + self.data = data + # TODO: name type checking + self.name = name + + self.id = '' + + def __str__(self): + max_chars = 10 + jdata = _json.dumps(self.data, cls=utils.PlotlyJSONEncoder) + if len(jdata) > max_chars: + data_string = jdata[:max_chars] + "...]" + else: + data_string = jdata + string = '' + return string.format(name=self.name, data=data_string, id=self.id) + + def __repr__(self): + return 'Column("{0}", {1})'.format(self.data, self.name) + + def to_plotly_json(self): + return {'name': self.name, 'data': self.data} + + +class Grid(MutableSequence): + """ + Grid is Plotly's Python representation of Plotly Grids. + Plotly Grids are tabular data made up of columns. They can be + uploaded, appended to, and can source the data for Plotly + graphs. + + A plotly.grid_objs.Grid object is essentially a list. + + Usage example 1: Upload a set of columns as a grid to Plotly + ``` + from plotly.grid_objs import Grid, Column + import plotly.plotly as py + column_1 = Column([1, 2, 3], 'time') + column_2 = Column([4, 2, 5], 'voltage') + grid = Grid([column_1, column_2]) + py.grid_ops.upload(grid, 'time vs voltage') + ``` + + Usage example 2: Make a graph based with data that is sourced + from a newly uploaded Plotly columns + ``` + import plotly.plotly as py + from plotly.grid_objs import Grid, Column + from plotly.graph_objs import Scatter + # Upload a grid + column_1 = Column([1, 2, 3], 'time') + column_2 = Column([4, 2, 5], 'voltage') + grid = Grid([column_1, column_2]) + py.grid_ops.upload(grid, 'time vs voltage') + + # Build a Plotly graph object sourced from the + # grid's columns + trace = Scatter(xsrc=grid[0], ysrc=grid[1]) + py.plot([trace], filename='graph from grid') + ``` + """ + def __init__(self, columns_or_json, fid=None): + """ + Initialize a grid with an iterable of `plotly.grid_objs.Column` + objects or a json/dict describing a grid. See second usage example + below for the necessary structure of the dict. + + :param (str|bool) fid: should not be accessible to users. Default + is 'None' but if a grid is retrieved via `py.get_grid()` then the + retrieved grid response will contain the fid which will be + necessary to set `self.id` and `self._columns.id` below. + + Example from iterable of columns: + ``` + column_1 = Column([1, 2, 3], 'time') + column_2 = Column([4, 2, 5], 'voltage') + grid = Grid([column_1, column_2]) + ``` + Example from json grid + ``` + grid_json = { + 'cols': { + 'time': {'data': [1, 2, 3], 'order': 0, 'uid': '4cd7fc'}, + 'voltage': {'data': [4, 2, 5], 'order': 1, 'uid': u'2744be'} + } + } + grid = Grid(grid_json) + ``` + """ + # TODO: verify that columns are actually columns + pd = get_module('pandas') + if pd and isinstance(columns_or_json, pd.DataFrame): + duplicate_name = utils.get_first_duplicate(columns_or_json.columns) + if duplicate_name: + err = exceptions.NON_UNIQUE_COLUMN_MESSAGE.format(duplicate_name) + raise exceptions.InputError(err) + + # create columns from dataframe + all_columns = [] + for name in columns_or_json.columns: + all_columns.append(Column(columns_or_json[name].tolist(), name)) + self._columns = all_columns + self.id = '' + + elif isinstance(columns_or_json, dict): + # check that fid is entered + if fid is None: + raise _plotly_utils.exceptions.PlotlyError( + "If you are manually converting a raw json/dict grid " + "into a Grid instance, you must ensure that 'fid' is " + "set to your file ID. This looks like 'username:187'." + ) + + self.id = fid + + # check if 'cols' is a root key + if 'cols' not in columns_or_json: + raise _plotly_utils.exceptions.PlotlyError( + "'cols' must be a root key in your json grid." + ) + + # check if 'data', 'order' and 'uid' are not in columns + grid_col_keys = ['data', 'order', 'uid'] + + for column_name in columns_or_json['cols']: + for key in grid_col_keys: + if key not in columns_or_json['cols'][column_name]: + raise _plotly_utils.exceptions.PlotlyError( + "Each column name of your dictionary must have " + "'data', 'order' and 'uid' as keys." + ) + # collect and sort all orders in case orders do not start + # at zero or there are jump discontinuities between them + all_orders = [] + for column_name in columns_or_json['cols'].keys(): + all_orders.append(columns_or_json['cols'][column_name]['order']) + all_orders.sort() + + # put columns in order in a list + ordered_columns = [] + for order in all_orders: + for column_name in columns_or_json['cols'].keys(): + if columns_or_json['cols'][column_name]['order'] == order: + break + + ordered_columns.append(Column( + columns_or_json['cols'][column_name]['data'], + column_name) + ) + self._columns = ordered_columns + + # fill in column_ids + for column in self: + column.id = self.id + ':' + columns_or_json['cols'][column.name]['uid'] + + else: + column_names = [column.name for column in columns_or_json] + duplicate_name = utils.get_first_duplicate(column_names) + if duplicate_name: + err = exceptions.NON_UNIQUE_COLUMN_MESSAGE.format(duplicate_name) + raise exceptions.InputError(err) + + self._columns = list(columns_or_json) + self.id = '' + + def __repr__(self): + return self._columns.__repr__() + + def __getitem__(self, index): + return self._columns[index] + + def __setitem__(self, index, column): + self._validate_insertion(column) + return self._columns.__setitem__(index, column) + + def __delitem__(self, index): + del self._columns[index] + + def __len__(self): + return len(self._columns) + + def insert(self, index, column): + self._validate_insertion(column) + self._columns.insert(index, column) + + def _validate_insertion(self, column): + """ + Raise an error if we're gonna add a duplicate column name + """ + existing_column_names = [col.name for col in self._columns] + if column.name in existing_column_names: + err = exceptions.NON_UNIQUE_COLUMN_MESSAGE.format(column.name) + raise exceptions.InputError(err) + + def _to_plotly_grid_json(self): + grid_json = {'cols': {}} + for column_index, column in enumerate(self): + grid_json['cols'][column.name] = { + 'data': column.data, + 'order': column_index + } + return grid_json + + def get_column(self, column_name): + """ Return the first column with name `column_name`. + If no column with `column_name` exists in this grid, return None. + """ + for column in self._columns: + if column.name == column_name: + return column + + def get_column_reference(self, column_name): + """ + Returns the column reference of given column in the grid by its name. + + Raises an error if the column name is not in the grid. Otherwise, + returns the fid:uid pair, which may be the empty string. + """ + column_id = None + for column in self._columns: + if column.name == column_name: + column_id = column.id + break + + if column_id is None: + col_names = [] + for column in self._columns: + col_names.append(column.name) + raise _plotly_utils.exceptions.PlotlyError( + "Whoops, that column name doesn't match any of the column " + "names in your grid. You must pick from {cols}".format(cols=col_names) + ) + return column_id diff --git a/chart_studio/plotly/__init__.py b/chart_studio/plotly/__init__.py new file mode 100644 index 00000000000..2415356cfc8 --- /dev/null +++ b/chart_studio/plotly/__init__.py @@ -0,0 +1,31 @@ +""" +plotly +====== + +This module defines functionality that requires interaction between your +local machine and Plotly. Almost all functionality used here will require a +verifiable account (username/api-key pair) and a network connection. + +""" +from . plotly import ( + sign_in, + update_plot_options, + get_credentials, + iplot, + plot, + iplot_mpl, + plot_mpl, + get_figure, + Stream, + image, + grid_ops, + meta_ops, + file_ops, + get_config, + get_grid, + dashboard_ops, + presentation_ops, + create_animations, + icreate_animations, + parse_grid_id_args +) diff --git a/plotly/plotly/chunked_requests/__init__.py b/chart_studio/plotly/chunked_requests/__init__.py similarity index 100% rename from plotly/plotly/chunked_requests/__init__.py rename to chart_studio/plotly/chunked_requests/__init__.py diff --git a/plotly/plotly/chunked_requests/chunked_request.py b/chart_studio/plotly/chunked_requests/chunked_request.py similarity index 99% rename from plotly/plotly/chunked_requests/chunked_request.py rename to chart_studio/plotly/chunked_requests/chunked_request.py index 4f8d325edb3..5f39704c720 100644 --- a/plotly/plotly/chunked_requests/chunked_request.py +++ b/chart_studio/plotly/chunked_requests/chunked_request.py @@ -6,7 +6,7 @@ from six.moves import http_client from six.moves.urllib.parse import urlparse, unquote -from plotly.api import utils +from chart_studio.api import utils class Stream: diff --git a/plotly/plotly/plotly.py b/chart_studio/plotly/plotly.py similarity index 96% rename from plotly/plotly/plotly.py rename to chart_studio/plotly/plotly.py index 1227a98651e..763c431985f 100644 --- a/plotly/plotly/plotly.py +++ b/chart_studio/plotly/plotly.py @@ -21,7 +21,6 @@ import json import os import time -import uuid import warnings import webbrowser @@ -29,20 +28,19 @@ import six.moves from requests.compat import json as _json +import _plotly_utils.utils +import _plotly_utils.exceptions from _plotly_utils.basevalidators import CompoundValidator, is_array -from plotly import exceptions, files, session, tools, utils -from plotly.api import v1, v2 -from plotly.basedatatypes import BaseTraceType, BaseFigure, BaseLayoutType -from plotly.plotly import chunked_requests +from _plotly_utils.utils import PlotlyJSONEncoder -from plotly.graph_objs import Figure - -from plotly.grid_objs import Grid -from plotly.dashboard_objs import dashboard_objs as dashboard +from chart_studio import files, session, tools, utils, exceptions +from chart_studio.api import v1, v2 +from chart_studio.plotly import chunked_requests +from chart_studio.grid_objs import Grid +from chart_studio.dashboard_objs import dashboard_objs as dashboard # This is imported like this for backwards compat. Careful if changing. -from plotly.config import get_config, get_credentials - +from chart_studio.config import get_config, get_credentials __all__ = None @@ -73,7 +71,7 @@ def sign_in(username, api_key, **kwargs): # with the given, username, api_key, and plotly_api_domain. v2.users.current() except exceptions.PlotlyRequestError: - raise exceptions.PlotlyError('Sign in failed.') + raise _plotly_utils.exceptions.PlotlyError('Sign in failed.') update_plot_options = session.update_session_plot_options @@ -155,6 +153,7 @@ def iplot(figure_or_data, **plot_options): world_readable (default=True) -- Deprecated: use "sharing". Make this figure private/public """ + from plotly.basedatatypes import BaseFigure, BaseLayoutType if 'auto_open' not in plot_options: plot_options['auto_open'] = False url = plot(figure_or_data, **plot_options) @@ -222,7 +221,8 @@ def plot(figure_or_data, validate=True, **plot_options): Make this figure private/public """ - figure = tools.return_figure_from_figure_or_data(figure_or_data, validate) + import plotly.tools + figure = plotly.tools.return_figure_from_figure_or_data(figure_or_data, validate) for entry in figure['data']: if ('type' in entry) and (entry['type'] == 'scattergl'): continue @@ -251,7 +251,7 @@ def plot(figure_or_data, validate=True, **plot_options): plot_options = _plot_option_logic(plot_options) - fig = tools._replace_newline(figure) # does not mutate figure + fig = plotly.tools._replace_newline(figure) # does not mutate figure data = fig.get('data', []) plot_options['layout'] = fig.get('layout', {}) response = v1.clientresp(data, **plot_options) @@ -291,11 +291,12 @@ def iplot_mpl(fig, resize=True, strip_style=False, update=None, plot_options -- run help(plotly.plotly.iplot) """ - fig = tools.mpl_to_plotly(fig, resize=resize, strip_style=strip_style) + import plotly.tools + fig = plotly.tools.mpl_to_plotly(fig, resize=resize, strip_style=strip_style) if update and isinstance(update, dict): fig.update(update) elif update is not None: - raise exceptions.PlotlyGraphObjectError( + raise _plotly_utils.exceptions.PlotlyGraphObjectError( "'update' must be dictionary-like and a valid plotly Figure " "object. Run 'help(plotly.graph_objs.Figure)' for more info." ) @@ -323,11 +324,12 @@ def plot_mpl(fig, resize=True, strip_style=False, update=None, **plot_options): plot_options -- run help(plotly.plotly.plot) """ - fig = tools.mpl_to_plotly(fig, resize=resize, strip_style=strip_style) + import plotly.tools + fig = plotly.tools.mpl_to_plotly(fig, resize=resize, strip_style=strip_style) if update and isinstance(update, dict): fig.update(update) elif update is not None: - raise exceptions.PlotlyGraphObjectError( + raise _plotly_utils.exceptions.PlotlyGraphObjectError( "'update' must be dictionary-like and a valid plotly Figure " "object. Run 'help(plotly.graph_objs.Figure)' for more info." ) @@ -442,11 +444,12 @@ def get_figure(file_owner_or_url, file_id=None, raw=False): Run `help(plotly.graph_objs.Figure)` for a list of valid properties. """ + import plotly.tools plotly_rest_url = get_config()['plotly_domain'] if file_id is None: # assume we're using a url url = file_owner_or_url if url[:len(plotly_rest_url)] != plotly_rest_url: - raise exceptions.PlotlyError( + raise _plotly_utils.exceptions.PlotlyError( "Because you didn't supply a 'file_id' in the call, " "we're assuming you're trying to snag a figure from a url. " "You supplied the url, '{0}', we expected it to start with " @@ -461,14 +464,14 @@ def get_figure(file_owner_or_url, file_id=None, raw=False): try: int(file_id) except ValueError: - raise exceptions.PlotlyError( + raise _plotly_utils.exceptions.PlotlyError( "The 'file_id' argument was not able to be converted into an " "integer number. Make sure that the positional 'file_id' argument " "is a number that can be converted into an integer or a string " "that can be converted into an integer." ) if int(file_id) < 0: - raise exceptions.PlotlyError( + raise _plotly_utils.exceptions.PlotlyError( "The 'file_id' argument must be a non-negative number." ) @@ -515,10 +518,10 @@ def get_figure(file_owner_or_url, file_id=None, raw=False): if raw: return figure - return tools.get_graph_obj(figure, obj_type='Figure') + return plotly.tools.get_graph_obj(figure, obj_type='Figure') -@utils.template_doc(**tools.get_config_file()) +@_plotly_utils.utils.template_doc(**tools.get_config_file()) class Stream: """ Interface to Plotly's real-time graphing API. @@ -555,7 +558,7 @@ class Stream: HTTP_PORT = 80 HTTPS_PORT = 443 - @utils.template_doc(**tools.get_config_file()) + @_plotly_utils.utils.template_doc(**tools.get_config_file()) def __init__(self, stream_id): """ Initialize a Stream object with your unique stream_id. @@ -607,7 +610,7 @@ def heartbeat(self, reconnect_on=(200, '', 408, 502)): try: self._stream.write('\n', reconnect_on=reconnect_on) except AttributeError: - raise exceptions.PlotlyError( + raise _plotly_utils.exceptions.PlotlyError( "Stream has not been opened yet, " "cannot write to a closed connection. " "Call `open()` on the stream to open the stream." @@ -677,6 +680,7 @@ def write(self, trace, layout=None, """ # Convert trace objects to dictionaries + from plotly.basedatatypes import BaseTraceType if isinstance(trace, BaseTraceType): stream_object = trace.to_plotly_json() else: @@ -689,13 +693,13 @@ def write(self, trace, layout=None, stream_object.update(dict(layout=layout)) # TODO: allow string version of this? - jdata = _json.dumps(stream_object, cls=utils.PlotlyJSONEncoder) + jdata = _json.dumps(stream_object, cls=PlotlyJSONEncoder) jdata += "\n" try: self._stream.write(jdata, reconnect_on=reconnect_on) except AttributeError: - raise exceptions.PlotlyError( + raise _plotly_utils.exceptions.PlotlyError( "Stream has not been opened yet, " "cannot write to a closed connection. " "Call `open()` on the stream to open the stream.") @@ -712,7 +716,7 @@ def close(self): try: self._stream.close() except AttributeError: - raise exceptions.PlotlyError("Stream has not been opened yet.") + raise _plotly_utils.exceptions.PlotlyError("Stream has not been opened yet.") class image: @@ -745,10 +749,11 @@ def get(figure_or_data, format='png', width=None, height=None, scale=None): """ # TODO: format is a built-in name... we shouldn't really use it - figure = tools.return_figure_from_figure_or_data(figure_or_data, True) + import plotly.tools + figure = plotly.tools.return_figure_from_figure_or_data(figure_or_data, True) if format not in ['png', 'svg', 'jpeg', 'pdf', 'emf']: - raise exceptions.PlotlyError( + raise _plotly_utils.exceptions.PlotlyError( "Invalid format. This version of your Plotly-Python " "package currently only supports png, svg, jpeg, and pdf. " "Learn more about image exporting, and the currently " @@ -759,7 +764,7 @@ def get(figure_or_data, format='png', width=None, height=None, scale=None): try: scale = float(scale) except: - raise exceptions.PlotlyError( + raise _plotly_utils.exceptions.PlotlyError( "Invalid scale parameter. Scale must be a number." ) @@ -808,7 +813,7 @@ def ishow(cls, figure_or_data, format='png', width=None, height=None, py.image.ishow(fig, 'png', scale=3) """ if format == 'pdf': - raise exceptions.PlotlyError( + raise _plotly_utils.exceptions.PlotlyError( "Aw, snap! " "It's not currently possible to embed a pdf into " "an IPython notebook. You can save the pdf " @@ -945,7 +950,7 @@ def _fill_in_response_column_ids(cls, request_columns, def ensure_uploaded(fid): if fid: return - raise exceptions.PlotlyError( + raise _plotly_utils.exceptions.PlotlyError( 'This operation requires that the grid has already been uploaded ' 'to Plotly. Try `uploading` first.' ) @@ -1119,7 +1124,7 @@ def append_columns(cls, columns, grid=None, grid_url=None): # This is sorta gross, we need to double-encode this. body = { - 'cols': _json.dumps(columns, cls=utils.PlotlyJSONEncoder) + 'cols': _json.dumps(columns, cls=PlotlyJSONEncoder) } fid = grid_id response = v2.grids.col_create(fid, body) @@ -1369,7 +1374,7 @@ def add_share_key_to_url(plot_url, attempt=0): if not share_key_enabled: attempt += 1 if attempt == 50: - raise exceptions.PlotlyError( + raise _plotly_utils.exceptions.PlotlyError( "The sharekey could not be enabled at this time so the graph " "is saved as private. Try again to save as 'secret' later." ) @@ -1380,7 +1385,8 @@ def add_share_key_to_url(plot_url, attempt=0): def _send_to_plotly(figure, **plot_options): - fig = tools._replace_newline(figure) # does not mutate figure + import plotly.tools + fig = plotly.tools._replace_newline(figure) # does not mutate figure data = fig.get('data', []) response = v1.clientresp(data, **plot_options) @@ -1447,7 +1453,7 @@ def _create_or_update(data, filetype): fid = matching_file['fid'] res = api_module.update(fid, data) else: - raise exceptions.PlotlyError(""" + raise _plotly_utils.exceptions.PlotlyError(""" '{filename}' is already a {other_filetype} in your account. While you can overwrite {filetype}s with the same name, you can't overwrite files with a different type. Try deleting '{filename}' in your account or @@ -1642,7 +1648,7 @@ def upload(cls, presentation, filename, sharing='public', auto_open=True): elif sharing in ['private', 'secret']: world_readable = False else: - raise exceptions.PlotlyError( + raise _plotly_utils.exceptions.PlotlyError( SHARING_ERROR_MSG ) data = { @@ -1686,7 +1692,7 @@ def _extract_grid_graph_obj(obj_dict, reference_obj, grid, path): Function modifies obj_dict and grid in-place """ - from plotly.grid_objs import Column + from chart_studio.grid_objs import Column for prop in list(obj_dict.keys()): propsrc = '{}src'.format(prop) @@ -1745,6 +1751,8 @@ def _extract_grid_from_fig_like(fig, grid=None, path=''): Columns are named with the path the corresponding data array (e.g. 'data.0.marker.size') """ + from plotly.basedatatypes import BaseFigure + from plotly.graph_objs import Figure if grid is None: # If not grid, this is top-level call so deep copy figure @@ -1800,6 +1808,7 @@ def _set_grid_column_references(figure, grid): None Function modifies figure in-place """ + from plotly.basedatatypes import BaseFigure for col in grid: prop_path = BaseFigure._str_to_dict_path(col.name) prop_parent = figure @@ -2009,7 +2018,7 @@ def create_animations(figure, filename=None, sharing='public', auto_open=True): payload['world_readable'] = False payload['share_key_enabled'] = True else: - raise exceptions.PlotlyError( + raise _plotly_utils.exceptions.PlotlyError( SHARING_ERROR_MSG ) @@ -2052,6 +2061,7 @@ def icreate_animations(figure, filename=None, sharing='public', auto_open=False) This function is based off `plotly.plotly.iplot`. See `plotly.plotly. create_animations` Doc String for param descriptions. """ + from plotly.basedatatypes import BaseFigure, BaseLayoutType url = create_animations(figure, filename, sharing, auto_open) if isinstance(figure, dict): diff --git a/plotly/presentation_objs/__init__.py b/chart_studio/presentation_objs/__init__.py similarity index 100% rename from plotly/presentation_objs/__init__.py rename to chart_studio/presentation_objs/__init__.py diff --git a/chart_studio/presentation_objs/presentation_objs.py b/chart_studio/presentation_objs/presentation_objs.py new file mode 100644 index 00000000000..699f6996121 --- /dev/null +++ b/chart_studio/presentation_objs/presentation_objs.py @@ -0,0 +1,1177 @@ +""" +dashboard_objs +========== + +A module for creating and manipulating spectacle-presentation dashboards. +""" + +import copy +import random +import re +import string +import warnings + +import _plotly_utils.exceptions +from chart_studio import exceptions +from chart_studio.config import get_config + +HEIGHT = 700.0 +WIDTH = 1000.0 + +CODEPANE_THEMES = ['tomorrow', 'tomorrowNight'] + +VALID_LANGUAGES = ['cpp', 'cs', 'css', 'fsharp', 'go', 'haskell', 'java', + 'javascript', 'jsx', 'julia', 'xml', 'matlab', 'php', + 'python', 'r', 'ruby', 'scala', 'sql', 'yaml'] + +VALID_TRANSITIONS = ['slide', 'zoom', 'fade', 'spin'] + +PRES_THEMES = ['moods', 'martik'] + +VALID_GROUPTYPES = [ + 'leftgroup_v', 'rightgroup_v', 'middle', 'checkerboard_topleft', + 'checkerboard_topright' +] + +fontWeight_dict = { + 'Thin': {'fontWeight': 100}, + 'Thin Italic': {'fontWeight': 100, 'fontStyle': 'italic'}, + 'Light': {'fontWeight': 300}, + 'Light Italic': {'fontWeight': 300, 'fontStyle': 'italic'}, + 'Regular': {'fontWeight': 400}, + 'Regular Italic': {'fontWeight': 400, 'fontStyle': 'italic'}, + 'Medium': {'fontWeight': 500}, + 'Medium Italic': {'fontWeight': 500, 'fontStyle': 'italic'}, + 'Bold': {'fontWeight': 700}, + 'Bold Italic': {'fontWeight': 700, 'fontStyle': 'italic'}, + 'Black': {'fontWeight': 900}, + 'Black Italic': {'fontWeight': 900, 'fontStyle': 'italic'}, +} + + +def list_of_options(iterable, conj='and', period=True): + """ + Returns an English listing of objects seperated by commas ',' + + For example, ['foo', 'bar', 'baz'] becomes 'foo, bar and baz' + if the conjunction 'and' is selected. + """ + if len(iterable) < 2: + raise _plotly_utils.exceptions.PlotlyError( + 'Your list or tuple must contain at least 2 items.' + ) + template = (len(iterable) - 2)*'{}, ' + '{} ' + conj + ' {}' + period*'.' + return template.format(*iterable) + + +# Error Messages +STYLE_ERROR = "Your presentation style must be {}".format( + list_of_options(PRES_THEMES, conj='or', period=True) +) + +CODE_ENV_ERROR = ( + "If you are putting a block of code into your markdown " + "presentation, make sure your denote the start and end " + "of the code environment with the '```' characters. For " + "example, your markdown string would include something " + "like:\n\n```python\nx = 2\ny = 1\nprint x\n```\n\n" + "Notice how the language that you want the code to be " + "displayed in is immediately to the right of first " + "entering '```', i.e. '```python'." +) + +LANG_ERROR = ( + "The language of your code block should be " + "clearly indicated after the first ``` that " + "begins the code block. The valid languages to " + "choose from are" + list_of_options( + VALID_LANGUAGES + ) +) + + +def _generate_id(size): + letters_and_numbers = string.ascii_letters + for num in range(10): + letters_and_numbers += str(num) + letters_and_numbers += str(num) + id_str = '' + for _ in range(size): + id_str += random.choice(list(letters_and_numbers)) + + return id_str + + +paragraph_styles = { + 'Body': { + 'color': '#3d3d3d', + 'fontFamily': 'Open Sans', + 'fontSize': 11, + 'fontStyle': 'normal', + 'fontWeight': 400, + 'lineHeight': 'normal', + 'minWidth': 20, + 'opacity': 1, + 'textAlign': 'center', + 'textDecoration': 'none', + 'wordBreak': 'break-word' + }, + 'Body Small': { + 'color': '#3d3d3d', + 'fontFamily': 'Open Sans', + 'fontSize': 10, + 'fontStyle': 'normal', + 'fontWeight': 400, + 'lineHeight': 'normal', + 'minWidth': 20, + 'opacity': 1, + 'textAlign': 'center', + 'textDecoration': 'none' + }, + 'Caption': { + 'color': '#3d3d3d', + 'fontFamily': 'Open Sans', + 'fontSize': 11, + 'fontStyle': 'italic', + 'fontWeight': 400, + 'lineHeight': 'normal', + 'minWidth': 20, + 'opacity': 1, + 'textAlign': 'center', + 'textDecoration': 'none' + }, + 'Heading 1': { + 'color': '#3d3d3d', + 'fontFamily': 'Open Sans', + 'fontSize': 26, + 'fontStyle': 'normal', + 'fontWeight': 400, + 'lineHeight': 'normal', + 'minWidth': 20, + 'opacity': 1, + 'textAlign': 'center', + 'textDecoration': 'none', + }, + 'Heading 2': { + 'color': '#3d3d3d', + 'fontFamily': 'Open Sans', + 'fontSize': 20, + 'fontStyle': 'normal', + 'fontWeight': 400, + 'lineHeight': 'normal', + 'minWidth': 20, + 'opacity': 1, + 'textAlign': 'center', + 'textDecoration': 'none' + }, + 'Heading 3': { + 'color': '#3d3d3d', + 'fontFamily': 'Open Sans', + 'fontSize': 11, + 'fontStyle': 'normal', + 'fontWeight': 700, + 'lineHeight': 'normal', + 'minWidth': 20, + 'opacity': 1, + 'textAlign': 'center', + 'textDecoration': 'none' + } +} + + +def _empty_slide(transition, id): + empty_slide = {'children': [], + 'id': id, + 'props': {'style': {}, 'transition': transition}} + return empty_slide + + +def _box(boxtype, text_or_url, left, top, height, width, id, props_attr, + style_attr, paragraphStyle): + children_list = [] + fontFamily = "Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace" + if boxtype == 'Text': + children_list = text_or_url.split('\n') + + props = { + 'isQuote': False, + 'listType': None, + 'paragraphStyle': paragraphStyle, + 'size': 4, + 'style': copy.deepcopy(paragraph_styles[paragraphStyle]) + } + + props['style'].update( + {'height': height, + 'left': left, + 'top': top, + 'width': width, + 'position': 'absolute'} + ) + + elif boxtype == 'Image': + # height, width are set to default 512 + # as set by the Presentation Editor + props = { + 'height': 512, + 'imageName': None, + 'src': text_or_url, + 'style': {'height': height, + 'left': left, + 'opacity': 1, + 'position': 'absolute', + 'top': top, + 'width': width}, + 'width': 512 + } + elif boxtype == 'Plotly': + if '?share_key' in text_or_url: + src = text_or_url + else: + src = text_or_url + '.embed?link=false' + props = { + 'frameBorder': 0, + 'scrolling': 'no', + 'src': src, + 'style': {'height': height, + 'left': left, + 'position': 'absolute', + 'top': top, + 'width': width} + } + elif boxtype == 'CodePane': + props = { + 'language': 'python', + 'source': text_or_url, + 'style': {'fontFamily': fontFamily, + 'fontSize': 13, + 'height': height, + 'left': left, + 'margin': 0, + 'position': 'absolute', + 'textAlign': 'left', + 'top': top, + 'width': width}, + 'theme': 'tomorrowNight' + } + + # update props and style attributes + for item in props_attr.items(): + props[item[0]] = item[1] + for item in style_attr.items(): + props['style'][item[0]] = item[1] + + child = { + 'children': children_list, + 'id': id, + 'props': props, + 'type': boxtype + } + + if boxtype == 'Text': + child['defaultHeight'] = 36 + child['defaultWidth'] = 52 + child['resizeVertical'] = False + if boxtype == 'CodePane': + child['defaultText'] = 'Code' + + return child + + +def _percentage_to_pixel(value, side): + if side == 'left': + return WIDTH * (0.01 * value) + elif side == 'top': + return HEIGHT * (0.01 * value) + elif side == 'height': + return HEIGHT * (0.01 * value) + elif side == 'width': + return WIDTH * (0.01 * value) + + +def _return_box_position(left, top, height, width): + values_dict = { + 'left': left, + 'top': top, + 'height': height, + 'width': width, + } + for key in iter(values_dict): + if isinstance(values_dict[key], str): + var = float(values_dict[key][: -2]) + else: + var = _percentage_to_pixel(values_dict[key], key) + values_dict[key] = var + + return (values_dict['left'], values_dict['top'], + values_dict['height'], values_dict['width']) + + +def _remove_extra_whitespace_from_line(line): + line = line.lstrip() + line = line.rstrip() + return line + + +def _list_of_slides(markdown_string): + if not markdown_string.endswith('\n---\n'): + markdown_string += '\n---\n' + + text_blocks = re.split('\n-{2,}\n', markdown_string) + + list_of_slides = [] + for text in text_blocks: + if not all(char in ['\n', '-', ' '] for char in text): + list_of_slides.append(text) + + if '\n-\n' in markdown_string: + msg = ("You have at least one '-' by itself on its own line in your " + "markdown string. If you are trying to denote a new slide, " + "make sure that the line has 3 '-'s like this: \n\n---\n\n" + "A new slide will NOT be created here.") + warnings.warn(msg) + + return list_of_slides + + +def _top_spec_for_text_at_bottom(text_block, width_per, per_from_bottom=0, + min_top=30): + # This function ensures that if there is a large block of + # text in your slide it will not overflow off the bottom + # of the slide. + # The input for this function are a block of text and the + # params that define where it will be placed in the slide. + # The function makes some calculations and will output a + # 'top' value (i.e. the left, top, height, width css params) + # so that the text block will come down to some specified + # distance from the bottom of the page. + + # TODO: customize this function for different fonts/sizes + max_lines = 37 + one_char_percent_width = 0.764 + chars_in_full_line = width_per / one_char_percent_width + + num_of_lines = 0 + char_group = 0 + for char in text_block: + if char == '\n': + num_of_lines += 1 + char_group = 0 + else: + if char_group >= chars_in_full_line: + char_group = 0 + num_of_lines += 1 + else: + char_group += 1 + + num_of_lines += 1 + top_frac = (max_lines - num_of_lines) / float(max_lines) + top = top_frac * 100 - per_from_bottom + + # to be safe + return max(top, min_top) + + +def _box_specs_gen(num_of_boxes, grouptype='leftgroup_v', width_range=50, + height_range=50, margin=2, betw_boxes=4, middle_center=50): + # the (left, top, width, height) specs + # are added to specs_for_boxes + specs_for_boxes = [] + if num_of_boxes == 1 and grouptype in ['leftgroup_v', 'rightgroup_v']: + if grouptype == 'rightgroup_v': + left_shift = (100 - width_range) + else: + left_shift = 0 + + box_spec = ( + left_shift + (margin / WIDTH) * 100, + (margin / HEIGHT) * 100, + 100 - (2 * margin / HEIGHT * 100), + width_range - (2 * margin / WIDTH) * 100 + ) + specs_for_boxes.append(box_spec) + + elif num_of_boxes > 1 and grouptype in ['leftgroup_v', 'rightgroup_v']: + if grouptype == 'rightgroup_v': + left_shift = (100 - width_range) + else: + left_shift = 0 + + if num_of_boxes % 2 == 0: + box_width_px = 0.5 * ( + (float(width_range)/100) * WIDTH - 2 * margin - betw_boxes + ) + box_width = (box_width_px / WIDTH) * 100 + + height = (200.0 / (num_of_boxes * HEIGHT)) * ( + HEIGHT - (num_of_boxes / 2 - 1) * betw_boxes - 2 * margin + ) + + left1 = left_shift + (margin / WIDTH) * 100 + left2 = left_shift + ( + ((margin + betw_boxes) / WIDTH) * 100 + box_width + ) + for left in [left1, left2]: + for j in range(int(num_of_boxes / 2)): + top = (margin * 100 / HEIGHT) + j * ( + height + (betw_boxes * 100 / HEIGHT) + ) + specs = ( + left, + top, + height, + box_width + ) + specs_for_boxes.append(specs) + + if num_of_boxes % 2 == 1: + width = width_range - (200 * margin) / WIDTH + height = (100.0 / (num_of_boxes * HEIGHT)) * ( + HEIGHT - (num_of_boxes - 1) * betw_boxes - 2 * margin + ) + left = left_shift + (margin / WIDTH) * 100 + for j in range(num_of_boxes): + top = (margin / HEIGHT) * 100 + j * ( + height + (betw_boxes / HEIGHT) * 100 + ) + specs = ( + left, + top, + height, + width + ) + specs_for_boxes.append(specs) + + elif grouptype == 'middle': + top = float(middle_center - (height_range / 2)) + height = height_range + width = (1 / float(num_of_boxes)) * ( + width_range - (num_of_boxes - 1) * (100*betw_boxes/WIDTH) + ) + for j in range(num_of_boxes): + left = ((100 - float(width_range)) / 2) + j * ( + width + (betw_boxes / WIDTH) * 100 + ) + specs = (left, top, height, width) + specs_for_boxes.append(specs) + + elif 'checkerboard' in grouptype and num_of_boxes == 2: + if grouptype == 'checkerboard_topleft': + for j in range(2): + left = j * 50 + top = j * 50 + height = 50 + width = 50 + specs = ( + left, + top, + height, + width + ) + specs_for_boxes.append(specs) + else: + for j in range(2): + left = 50 * (1 - j) + top = j * 50 + height = 50 + width = 50 + specs = ( + left, + top, + height, + width + ) + specs_for_boxes.append(specs) + return specs_for_boxes + + +def _return_layout_specs(num_of_boxes, url_lines, title_lines, text_block, + code_blocks, slide_num, style): + # returns specs of the form (left, top, height, width) + code_theme = 'tomorrowNight' + if style == 'martik': + specs_for_boxes = [] + margin = 18 # in pxs + + # set Headings styles + paragraph_styles['Heading 1'].update( + {'color': '#0D0A1E', + 'fontFamily': 'Raleway', + 'fontSize': 55, + 'fontWeight': fontWeight_dict['Bold']['fontWeight']} + ) + + paragraph_styles['Heading 2'] = copy.deepcopy( + paragraph_styles['Heading 1'] + ) + paragraph_styles['Heading 2'].update({'fontSize': 36}) + paragraph_styles['Heading 3'] = copy.deepcopy( + paragraph_styles['Heading 1'] + ) + paragraph_styles['Heading 3'].update({'fontSize': 30}) + + # set Body style + paragraph_styles['Body'].update( + {'color': '#96969C', + 'fontFamily': 'Roboto', + 'fontSize': 16, + 'fontWeight': fontWeight_dict['Regular']['fontWeight']} + ) + + bkgd_color = '#F4FAFB' + title_font_color = '#0D0A1E' + text_font_color = '#96969C' + if num_of_boxes == 0 and slide_num == 0: + text_textAlign = 'center' + else: + text_textAlign = 'left' + if num_of_boxes == 0: + specs_for_title = (0, 50, 20, 100) + specs_for_text = (15, 60, 50, 70) + + bkgd_color = '#0D0A1E' + title_font_color = '#F4FAFB' + text_font_color = '#F4FAFB' + elif num_of_boxes == 1: + if code_blocks != [] or (url_lines != [] and + get_config()['plotly_domain'] in + url_lines[0]): + if code_blocks != []: + w_range = 40 + else: + w_range = 60 + text_top = _top_spec_for_text_at_bottom( + text_block, 80, + per_from_bottom=(margin / HEIGHT) * 100 + ) + specs_for_title = (0, 3, 20, 100) + specs_for_text = (10, text_top, 30, 80) + specs_for_boxes = _box_specs_gen( + num_of_boxes, grouptype='middle', width_range=w_range, + height_range=60, margin=margin, betw_boxes=4 + ) + bkgd_color = '#0D0A1E' + title_font_color = '#F4FAFB' + text_font_color = '#F4FAFB' + code_theme = 'tomorrow' + elif title_lines == [] and text_block == '': + specs_for_title = (0, 50, 20, 100) + specs_for_text = (15, 60, 50, 70) + specs_for_boxes = _box_specs_gen( + num_of_boxes, grouptype='middle', width_range=50, + height_range=80, margin=0, betw_boxes=0 + ) + else: + title_text_width = 40 - (margin / WIDTH) * 100 + + text_top = _top_spec_for_text_at_bottom( + text_block, title_text_width, + per_from_bottom=(margin / HEIGHT) * 100 + ) + specs_for_title = (60, 3, 20, 40) + specs_for_text = (60, text_top, 1, title_text_width) + specs_for_boxes = _box_specs_gen( + num_of_boxes, grouptype='leftgroup_v', width_range=60, + margin=margin, betw_boxes=4 + ) + bkgd_color = '#0D0A1E' + title_font_color = '#F4FAFB' + text_font_color = '#F4FAFB' + elif num_of_boxes == 2 and url_lines != []: + text_top = _top_spec_for_text_at_bottom( + text_block, 46, per_from_bottom=(margin / HEIGHT) * 100, + min_top=50 + ) + specs_for_title = (0, 3, 20, 50) + specs_for_text = (52, text_top, 40, 46) + specs_for_boxes = _box_specs_gen( + num_of_boxes, grouptype='checkerboard_topright' + ) + elif num_of_boxes >= 2 and url_lines == []: + text_top = _top_spec_for_text_at_bottom( + text_block, 92, per_from_bottom=(margin / HEIGHT) * 100, + min_top=15 + ) + if num_of_boxes == 2: + betw_boxes = 90 + else: + betw_boxes = 10 + specs_for_title = (0, 3, 20, 100) + specs_for_text = (4, text_top, 1, 92) + specs_for_boxes = _box_specs_gen( + num_of_boxes, grouptype='middle', width_range=92, + height_range=60, margin=margin, betw_boxes=betw_boxes + ) + code_theme = 'tomorrow' + else: + text_top = _top_spec_for_text_at_bottom( + text_block, 40 - (margin / WIDTH) * 100, + per_from_bottom=(margin / HEIGHT) * 100 + ) + specs_for_title = (0, 3, 20, 40 - (margin / WIDTH) * 100) + specs_for_text = ( + (margin / WIDTH) * 100, text_top, 50, + 40 - (margin / WIDTH) * 100 + ) + specs_for_boxes = _box_specs_gen( + num_of_boxes, grouptype='rightgroup_v', width_range=60, + margin=margin, betw_boxes=4 + ) + + elif style == 'moods': + specs_for_boxes = [] + margin = 18 + code_theme = 'tomorrowNight' + + # set Headings styles + paragraph_styles['Heading 1'].update( + {'color': '#000016', + 'fontFamily': 'Roboto', + 'fontSize': 55, + 'fontWeight': fontWeight_dict['Black']['fontWeight']} + ) + + paragraph_styles['Heading 2'] = copy.deepcopy( + paragraph_styles['Heading 1'] + ) + paragraph_styles['Heading 2'].update({'fontSize': 36}) + paragraph_styles['Heading 3'] = copy.deepcopy( + paragraph_styles['Heading 1'] + ) + paragraph_styles['Heading 3'].update({'fontSize': 30}) + + # set Body style + paragraph_styles['Body'].update( + {'color': '#000016', + 'fontFamily': 'Roboto', + 'fontSize': 16, + 'fontWeight': fontWeight_dict['Thin']['fontWeight']} + ) + + bkgd_color = '#FFFFFF' + title_font_color = None + text_font_color = None + if num_of_boxes == 0 and slide_num == 0: + text_textAlign = 'center' + else: + text_textAlign = 'left' + if num_of_boxes == 0: + if slide_num == 0 or text_block == '': + bkgd_color = '#F7F7F7' + specs_for_title = (0, 50, 20, 100) + specs_for_text = (15, 60, 50, 70) + else: + bkgd_color = '#F7F7F7' + text_top = _top_spec_for_text_at_bottom( + text_block, width_per=90, + per_from_bottom=(margin / HEIGHT) * 100, + min_top=20 + ) + specs_for_title = (0, 2, 20, 100) + specs_for_text = (5, text_top, 50, 90) + + elif num_of_boxes == 1: + if code_blocks != []: + # code + if text_block == '': + margin = 5 + specs_for_title = (0, 3, 20, 100) + specs_for_text = (0, 0, 0, 0) + top = 12 + specs_for_boxes = [ + (margin, top, 100 - top - margin, 100 - 2 * margin) + ] + + elif slide_num % 2 == 0: + # middle center + width_per = 90 + height_range = 60 + text_top = _top_spec_for_text_at_bottom( + text_block, width_per=width_per, + per_from_bottom=(margin / HEIGHT) * 100, + min_top=100 - height_range / 2. + ) + specs_for_boxes = _box_specs_gen( + num_of_boxes, grouptype='middle', + width_range=50, height_range=60, margin=margin, + ) + specs_for_title = (0, 3, 20, 100) + specs_for_text = ( + 5, text_top, 2, width_per + ) + else: + # right + width_per = 50 + text_top = _top_spec_for_text_at_bottom( + text_block, width_per=width_per, + per_from_bottom=(margin / HEIGHT) * 100, + min_top=30 + ) + specs_for_boxes = _box_specs_gen( + num_of_boxes, grouptype='rightgroup_v', + width_range=50, margin=40, + ) + specs_for_title = (0, 3, 20, 50) + specs_for_text = ( + 2, text_top, 2, width_per - 2 + ) + elif (url_lines != [] and + get_config()['plotly_domain'] in url_lines[0]): + # url + if slide_num % 2 == 0: + # top half + width_per = 95 + text_top = _top_spec_for_text_at_bottom( + text_block, width_per=width_per, + per_from_bottom=(margin / HEIGHT) * 100, + min_top=60 + ) + specs_for_boxes = _box_specs_gen( + num_of_boxes, grouptype='middle', + width_range=100, height_range=60, + middle_center=30 + ) + specs_for_title = (0, 60, 20, 100) + specs_for_text = ( + 2.5, text_top, 2, width_per + ) + else: + # middle across + width_per = 95 + text_top = _top_spec_for_text_at_bottom( + text_block, width_per=width_per, + per_from_bottom=(margin / HEIGHT) * 100, + min_top=60 + ) + specs_for_boxes = _box_specs_gen( + num_of_boxes, grouptype='middle', + width_range=100, height_range=60 + ) + specs_for_title = (0, 3, 20, 100) + specs_for_text = ( + 2.5, text_top, 2, width_per + ) + else: + # image + if slide_num % 2 == 0: + # right + width_per = 50 + text_top = _top_spec_for_text_at_bottom( + text_block, width_per=width_per, + per_from_bottom=(margin / HEIGHT) * 100, + min_top=30 + ) + specs_for_boxes = _box_specs_gen( + num_of_boxes, grouptype='rightgroup_v', + width_range=50, margin=0, + ) + specs_for_title = (0, 3, 20, 50) + specs_for_text = ( + 2, text_top, 2, width_per - 2 + ) + else: + # left + width_per = 50 + text_top = _top_spec_for_text_at_bottom( + text_block, width_per=width_per, + per_from_bottom=(margin / HEIGHT) * 100, + min_top=30 + ) + specs_for_boxes = _box_specs_gen( + num_of_boxes, grouptype='leftgroup_v', + width_range=50, margin=0, + ) + specs_for_title = (50, 3, 20, 50) + specs_for_text = ( + 52, text_top, 2, width_per - 2 + ) + elif num_of_boxes == 2: + # right stack + width_per = 50 + text_top = _top_spec_for_text_at_bottom( + text_block, width_per=width_per, + per_from_bottom=(margin / HEIGHT) * 100, + min_top=30 + ) + specs_for_boxes = [(50, 0, 50, 50), (50, 50, 50, 50)] + specs_for_title = (0, 3, 20, 50) + specs_for_text = ( + 2, text_top, 2, width_per - 2 + ) + elif num_of_boxes == 3: + # middle top + width_per = 95 + text_top = _top_spec_for_text_at_bottom( + text_block, width_per=width_per, + per_from_bottom=(margin / HEIGHT) * 100, + min_top=40 + ) + specs_for_boxes = _box_specs_gen( + num_of_boxes, grouptype='middle', + width_range=100, height_range=40, middle_center=30 + ) + specs_for_title = (0, 0, 20, 100) + specs_for_text = ( + 2.5, text_top, 2, width_per + ) + else: + # right stack + width_per = 40 + text_top = _top_spec_for_text_at_bottom( + text_block, width_per=width_per, + per_from_bottom=(margin / HEIGHT) * 100, + min_top=30 + ) + specs_for_boxes = _box_specs_gen( + num_of_boxes, grouptype='rightgroup_v', + width_range=60, margin=0, + ) + specs_for_title = (0, 3, 20, 40) + specs_for_text = ( + 2, text_top, 2, width_per - 2 + ) + + # set text style attributes + title_style_attr = {} + text_style_attr = {'textAlign': text_textAlign} + + if text_font_color: + text_style_attr['color'] = text_font_color + if title_font_color: + title_style_attr['color'] = title_font_color + + return (specs_for_boxes, specs_for_title, specs_for_text, bkgd_color, + title_style_attr, text_style_attr, code_theme) + + +def _url_parens_contained(url_name, line): + return line.startswith(url_name + '(') and line.endswith(')') + + +class Presentation(dict): + """ + The Presentation class for creating spectacle-presentations. + + The Presentations API is a means for creating JSON blobs which are then + converted Spectacle Presentations. To use the API you only need to define + a block string and define your slides using markdown. Then you can upload + your presentation to the Plotly Server. + + Rules for your presentation string: + - use '---' to denote a slide break. + - headers work as per usual, where if '#' is used before a line of text + then it is interpretted as a header. Only the first header in a slide is + displayed on the slide. There are only 3 heading sizes: #, ## and ###. + 4 or more hashes will be interpretted as ###. + - you can set the type of slide transition you want by writing a line that + starts with 'transition: ' before your first header line in the slide, + and write the types of transition you want after. Your transition to + choose from are 'slide', 'zoom', 'fade' and 'spin'. + - to insert a Plotly chart into your slide, write a line that has the form + Plotly(url) with your url pointing to your chart. Note that it is + STRONGLY advised that your chart has fig['layout']['autosize'] = True. + - to insert an image from the web, write a line with the form Image(url) + - to insert a block of text, begin with a line that denotes the code + envoronment '```lang' where lang is a valid programming language. To find + the valid languages run:\n + 'plotly.presentation_objs.presentation_objs.VALID_LANGUAGES'\n + To end the code block environment, + write a single '```' line. All Plotly(url) and Image(url) lines will NOT + be interpretted as a Plotly or Image url if they are in the code block. + + :param (str) markdown_string: the block string that denotes the slides, + slide properties, and images to be placed in the presentation. If + 'markdown_string' is set to 'None', the JSON for a presentation with + one empty slide will be created. + :param (str) style: the theme that the presentation will take on. The + themes that are available now are 'martik' and 'moods'. + Default = 'moods'. + :param (bool) imgStretch: if set to False, all images in the presentation + will not have heights and widths that will not exceed the parent + container they belong to. In other words, images will keep their + original aspect ratios. + Default = True. + + For examples see the documentation:\n + https://plot.ly/python/presentations-api/ + """ + def __init__(self, markdown_string=None, style='moods', imgStretch=True): + self['presentation'] = { + 'slides': [], + 'slidePreviews': [None for _ in range(496)], + 'version': '0.1.3', + 'paragraphStyles': paragraph_styles + } + + if markdown_string: + if style not in PRES_THEMES: + raise _plotly_utils.exceptions.PlotlyError( + "Your presentation style must be {}".format( + list_of_options(PRES_THEMES, conj='or', period=True) + ) + ) + self._markdown_to_presentation(markdown_string, style, imgStretch) + else: + self._add_empty_slide() + + def _markdown_to_presentation(self, markdown_string, style, imgStretch): + list_of_slides = _list_of_slides(markdown_string) + + for slide_num, slide in enumerate(list_of_slides): + lines_in_slide = slide.split('\n') + title_lines = [] + + # validate blocks of code + if slide.count('```') % 2 != 0: + raise _plotly_utils.exceptions.PlotlyError(CODE_ENV_ERROR) + + # find code blocks + code_indices = [] + code_blocks = [] + wdw_size = len('```') + for j in range(len(slide)): + if slide[j:j+wdw_size] == '```': + code_indices.append(j) + + for k in range(int(len(code_indices) / 2)): + code_blocks.append( + slide[code_indices[2 * k]:code_indices[(2 * k) + 1]] + ) + + lang_and_code_tuples = [] + for code_block in code_blocks: + # validate code blocks + code_by_lines = code_block.split('\n') + language = _remove_extra_whitespace_from_line( + code_by_lines[0][3:] + ).lower() + if language == '' or language not in VALID_LANGUAGES: + raise _plotly_utils.exceptions.PlotlyError( + "The language of your code block should be " + "clearly indicated after the first ``` that " + "begins the code block. The valid languages to " + "choose from are" + list_of_options( + VALID_LANGUAGES + ) + ) + lang_and_code_tuples.append( + (language, '\n'.join(code_by_lines[1:])) + ) + + # collect text, code and urls + title_lines = [] + url_lines = [] + text_lines = [] + inCode = False + + for line in lines_in_slide: + # inCode handling + if line[:3] == '```' and len(line) > 3: + inCode = True + if line == '```': + inCode = False + + if not inCode and line != '```': + if len(line) > 0 and line[0] == '#': + title_lines.append(line) + elif (_url_parens_contained('Plotly', line) or + _url_parens_contained('Image', line)): + if (line.startswith('Plotly(') and + get_config()['plotly_domain'] not in line): + raise _plotly_utils.exceptions.PlotlyError( + "You are attempting to insert a Plotly Chart " + "in your slide but your url does not have " + "your plotly domain '{}' in it.".format( + get_config()['plotly_domain'] + ) + ) + url_lines.append(line) + else: + # find and set transition properties + trans = 'transition:' + if line.startswith(trans) and title_lines == []: + slide_trans = line[len(trans):] + slide_trans = _remove_extra_whitespace_from_line( + slide_trans + ) + slide_transition_list = [] + for key in VALID_TRANSITIONS: + if key in slide_trans: + slide_transition_list.append(key) + + if slide_transition_list == []: + slide_transition_list.append('slide') + self._set_transition( + slide_transition_list, slide_num + ) + + else: + text_lines.append(line) + + # make text block + for i in range(2): + try: + while text_lines[-i] == '': + text_lines.pop(-i) + except IndexError: + pass + + text_block = '\n'.join(text_lines) + num_of_boxes = len(url_lines) + len(lang_and_code_tuples) + + (specs_for_boxes, specs_for_title, specs_for_text, bkgd_color, + title_style_attr, text_style_attr, + code_theme) = _return_layout_specs( + num_of_boxes, url_lines, title_lines, text_block, code_blocks, + slide_num, style + ) + + # background color + self._color_background(bkgd_color, slide_num) + + # insert title, text, code, and images + if len(title_lines) > 0: + # clean titles + title = title_lines[0] + num_hashes = 0 + while title[0] == '#': + title = title[1:] + num_hashes += 1 + title = _remove_extra_whitespace_from_line(title) + + self._insert( + box='Text', text_or_url=title, + left=specs_for_title[0], top=specs_for_title[1], + height=specs_for_title[2], width=specs_for_title[3], + slide=slide_num, style_attr=title_style_attr, + paragraphStyle='Heading 1'.format( + min(num_hashes, 3) + ) + ) + + # text + if len(text_lines) > 0: + self._insert( + box='Text', text_or_url=text_block, + left=specs_for_text[0], top=specs_for_text[1], + height=specs_for_text[2], width=specs_for_text[3], + slide=slide_num, style_attr=text_style_attr, + paragraphStyle='Body' + ) + + url_and_code_blocks = list(url_lines + lang_and_code_tuples) + for k, specs in enumerate(specs_for_boxes): + url_or_code = url_and_code_blocks[k] + if isinstance(url_or_code, tuple): + # code + language = url_or_code[0] + code = url_or_code[1] + box_name = 'CodePane' + + # code style + props_attr = {} + props_attr['language'] = language + props_attr['theme'] = code_theme + + self._insert(box=box_name, text_or_url=code, + left=specs[0], top=specs[1], + height=specs[2], width=specs[3], + slide=slide_num, props_attr=props_attr) + else: + # url + if get_config()['plotly_domain'] in url_or_code: + box_name = 'Plotly' + else: + box_name = 'Image' + url = url_or_code[len(box_name) + 1: -1] + + self._insert(box=box_name, text_or_url=url, + left=specs[0], top=specs[1], + height=specs[2], width=specs[3], + slide=slide_num) + + if not imgStretch: + for s, slide in enumerate(self['presentation']['slides']): + for c, child in enumerate(slide['children']): + if child['type'] in ['Image', 'Plotly']: + deep_child = child['props']['style'] + width = deep_child['width'] + height = deep_child['height'] + + if width >= height: + deep_child['max-width'] = deep_child.pop('width') + else: + deep_child['max-height'] = deep_child.pop('height') + + def _add_empty_slide(self): + self['presentation']['slides'].append( + _empty_slide(['slide'], _generate_id(9)) + ) + + def _add_missing_slides(self, slide): + # add slides if desired slide number isn't in the presentation + try: + self['presentation']['slides'][slide]['children'] + except IndexError: + num_of_slides = len(self['presentation']['slides']) + for _ in range(slide - num_of_slides + 1): + self._add_empty_slide() + + def _insert(self, box, text_or_url, left, top, height, width, slide=0, + props_attr={}, style_attr={}, paragraphStyle=None): + self._add_missing_slides(slide) + + left, top, height, width = _return_box_position(left, top, height, + width) + new_id = _generate_id(9) + child = _box(box, text_or_url, left, top, height, width, new_id, + props_attr, style_attr, paragraphStyle) + + self['presentation']['slides'][slide]['children'].append(child) + + def _color_background(self, color, slide): + self._add_missing_slides(slide) + + loc = self['presentation']['slides'][slide] + loc['props']['style']['backgroundColor'] = color + + def _background_image(self, url, slide, bkrd_image_dict): + self._add_missing_slides(slide) + + loc = self['presentation']['slides'][slide]['props'] + + # default settings + size = 'stretch' + repeat = 'no-repeat' + + if 'background-size:' in bkrd_image_dict: + size = bkrd_image_dict['background-size:'] + if 'background-repeat:' in bkrd_image_dict: + repeat = bkrd_image_dict['background-repeat:'] + + if size == 'stretch': + backgroundSize = '100% 100%' + elif size == 'original': + backgroundSize = 'auto' + elif size == 'contain': + backgroundSize = 'contain' + elif size == 'cover': + backgroundSize = 'cover' + + style = { + 'backgroundImage': 'url({})'.format(url), + 'backgroundPosition': 'center center', + 'backgroundRepeat': repeat, + 'backgroundSize': backgroundSize + } + + for item in style.items(): + loc['style'].setdefault(item[0], item[1]) + + loc['backgroundImageSrc'] = url + loc['backgroundImageName'] = None + + def _set_transition(self, transition, slide): + self._add_missing_slides(slide) + loc = self['presentation']['slides'][slide]['props'] + loc['transition'] = transition diff --git a/chart_studio/session.py b/chart_studio/session.py new file mode 100644 index 00000000000..2397bbcac8a --- /dev/null +++ b/chart_studio/session.py @@ -0,0 +1,159 @@ +""" +The session module handles the user's current credentials, config and plot opts + +This allows users to dynamically change which plotly domain they're using, +which user they're signed in as, and plotting defaults. + +""" +from __future__ import absolute_import + +import copy + +import six + +import _plotly_utils.exceptions + + +_session = { + 'credentials': {}, + 'config': {}, + 'plot_options': {} +} + +CREDENTIALS_KEYS = { + 'username': six.string_types, + 'api_key': six.string_types, + 'proxy_username': six.string_types, + 'proxy_password': six.string_types, + 'stream_ids': list +} + +CONFIG_KEYS = { + 'plotly_domain': six.string_types, + 'plotly_streaming_domain': six.string_types, + 'plotly_api_domain': six.string_types, + 'plotly_ssl_verification': bool, + 'plotly_proxy_authorization': bool, + 'world_readable': bool, + 'auto_open': bool, + 'sharing': six.string_types +} + +PLOT_OPTIONS = { + 'filename': six.string_types, + 'fileopt': six.string_types, + 'validate': bool, + 'world_readable': bool, + 'auto_open': bool, + 'sharing': six.string_types +} + +SHARING_OPTIONS = ['public', 'private', 'secret'] + + +def sign_in(username, api_key, **kwargs): + """ + Set set session credentials and config (not saved to file). + + If unspecified, credentials and config are searched for in `.plotly` dir. + + :param (str) username: The username you'd use to sign in to Plotly + :param (str) api_key: The api key associated with above username + :param (list|optional) stream_ids: Stream tokens for above credentials + :param (str|optional) proxy_username: The un associated with with your Proxy + :param (str|optional) proxy_password: The pw associated with your Proxy un + + :param (str|optional) plotly_domain: + :param (str|optional) plotly_streaming_domain: + :param (str|optional) plotly_api_domain: + :param (bool|optional) plotly_ssl_verification: + :param (bool|optional) plotly_proxy_authorization: + :param (bool|optional) world_readable: + + """ + # TODO: verify these _credentials with plotly + + # kwargs will contain all our info + kwargs.update(username=username, api_key=api_key) + + # raise error if key isn't valid anywhere + for key in kwargs: + if key not in CREDENTIALS_KEYS and key not in CONFIG_KEYS: + raise _plotly_utils.exceptions.PlotlyError( + "{} is not a valid config or credentials key".format(key) + ) + + # add credentials, raise error if type is wrong. + for key in CREDENTIALS_KEYS: + if key in kwargs: + if not isinstance(kwargs[key], CREDENTIALS_KEYS[key]): + raise _plotly_utils.exceptions.PlotlyError( + "{} must be of type '{}'" + .format(key, CREDENTIALS_KEYS[key]) + ) + _session['credentials'][key] = kwargs[key] + + # add config, raise error if type is wrong. + for key in CONFIG_KEYS: + if key in kwargs: + if not isinstance(kwargs[key], CONFIG_KEYS[key]): + raise _plotly_utils.exceptions.PlotlyError("{} must be of type '{}'" + .format(key, CONFIG_KEYS[key])) + _session['config'][key] = kwargs.get(key) + + # add plot options, raise error if type is wrong. + for key in PLOT_OPTIONS: + if key in kwargs: + if not isinstance(kwargs[key], CONFIG_KEYS[key]): + raise _plotly_utils.exceptions.PlotlyError("{} must be of type '{}'" + .format(key, CONFIG_KEYS[key])) + _session['plot_options'][key] = kwargs.get(key) + + +def update_session_plot_options(**kwargs): + """ + Update the _session plot_options + + :param (str|optional) filename: What the file will be named in Plotly + :param (str|optional) fileopt: 'overwrite', 'append', 'new', or 'extend' + :param (bool|optional) world_readable: Make public or private. + :param (dict|optional) sharing: 'public', 'private', 'secret' + :param (bool|optional) auto_open: For `plot`, open in new browser tab? + :param (bool|optional) validate: Error locally if data doesn't pass? + + """ + # raise exception if key is invalid or value is the wrong type + for key in kwargs: + if key not in PLOT_OPTIONS: + raise _plotly_utils.exceptions.PlotlyError( + "{} is not a valid config or plot option key".format(key) + ) + if not isinstance(kwargs[key], PLOT_OPTIONS[key]): + raise _plotly_utils.exceptions.PlotlyError("{} must be of type '{}'" + .format(key, PLOT_OPTIONS[key])) + + # raise exception if sharing is invalid + if (key == 'sharing' and not (kwargs[key] in SHARING_OPTIONS)): + raise _plotly_utils.exceptions.PlotlyError("'{0}' must be of either '{1}', '{2}'" + " or '{3}'" + .format(key, *SHARING_OPTIONS)) + + # update local _session dict with new plot options + _session['plot_options'].update(kwargs) + + +def get_session_plot_options(): + """ Returns a copy of the user supplied plot options. + Use `update_plot_options()` to change. + """ + return copy.deepcopy(_session['plot_options']) + + +def get_session_config(): + """Returns either module config or file config.""" + return copy.deepcopy(_session['config']) + + +def get_session_credentials(): + """Returns the credentials that will be sent to plotly.""" + return copy.deepcopy(_session['credentials']) diff --git a/chart_studio/tests/__init__.py b/chart_studio/tests/__init__.py new file mode 100644 index 00000000000..950eaad7d6f --- /dev/null +++ b/chart_studio/tests/__init__.py @@ -0,0 +1,6 @@ +try: + # Set matplotlib backend once here + import matplotlib + matplotlib.use('Agg') +except: + pass diff --git a/chart_studio/tests/test_core/__init__.py b/chart_studio/tests/test_core/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_core/test_tools/__init__.py b/chart_studio/tests/test_core/test_tools/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_core/test_tools/test_configuration.py b/chart_studio/tests/test_core/test_tools/test_configuration.py new file mode 100644 index 00000000000..9215b008e47 --- /dev/null +++ b/chart_studio/tests/test_core/test_tools/test_configuration.py @@ -0,0 +1,16 @@ +from __future__ import absolute_import + +from unittest import TestCase + +from chart_studio.files import CONFIG_FILE, FILE_CONTENT +from chart_studio.tools import get_config_defaults + + +class TestGetConfigDefaults(TestCase): + + def test_config_dict_is_equivalent_copy(self): + + original = FILE_CONTENT[CONFIG_FILE] + copy = get_config_defaults() + self.assertIsNot(copy, original) + self.assertEqual(copy, original) diff --git a/chart_studio/tests/test_core/test_tools/test_file_tools.py b/chart_studio/tests/test_core/test_tools/test_file_tools.py new file mode 100644 index 00000000000..3f5549625ca --- /dev/null +++ b/chart_studio/tests/test_core/test_tools/test_file_tools.py @@ -0,0 +1,105 @@ +from chart_studio import tools +from chart_studio.tests.utils import PlotlyTestCase + +import warnings + + +class FileToolsTest(PlotlyTestCase): + + def test_set_config_file_all_entries(self): + + # Check set_config and get_config return the same values + + domain, streaming_domain, api, sharing = ('this', 'thing', + 'that', 'private') + ssl_verify, proxy_auth, world_readable, auto_open = (True, True, + False, False) + tools.set_config_file(plotly_domain=domain, + plotly_streaming_domain=streaming_domain, + plotly_api_domain=api, + plotly_ssl_verification=ssl_verify, + plotly_proxy_authorization=proxy_auth, + world_readable=world_readable, + auto_open=auto_open) + config = tools.get_config_file() + self.assertEqual(config['plotly_domain'], domain) + self.assertEqual(config['plotly_streaming_domain'], streaming_domain) + self.assertEqual(config['plotly_api_domain'], api) + self.assertEqual(config['plotly_ssl_verification'], ssl_verify) + self.assertEqual(config['plotly_proxy_authorization'], proxy_auth) + self.assertEqual(config['world_readable'], world_readable) + self.assertEqual(config['sharing'], sharing) + self.assertEqual(config['auto_open'], auto_open) + tools.reset_config_file() + + def test_set_config_file_two_entries(self): + + # Check set_config and get_config given only two entries return the + # same values + + domain, streaming_domain = 'this', 'thing' + tools.set_config_file(plotly_domain=domain, + plotly_streaming_domain=streaming_domain) + config = tools.get_config_file() + self.assertEqual(config['plotly_domain'], domain) + self.assertEqual(config['plotly_streaming_domain'], streaming_domain) + tools.reset_config_file() + + def test_set_config_file_world_readable(self): + + # Return TypeError when world_readable type is not a bool + + kwargs = {'world_readable': 'True'} + self.assertRaises(TypeError, tools.set_config_file, **kwargs) + + def test_set_config_expected_warning_msg(self): + + # Check that UserWarning is being called with http plotly_domain + + with warnings.catch_warnings(record=True) as w: + warnings.simplefilter("always") + kwargs = {'plotly_domain': 'http://www.foo-bar.com'} + tools.set_config_file(**kwargs) + assert len(w) == 1 + assert issubclass(w[-1].category, UserWarning) + assert "plotly_domain" in str(w[-1].message) + + + def test_set_config_no_warning_msg_if_plotly_domain_is_https(self): + + # Check that no UserWarning is being called with https plotly_domain + + with warnings.catch_warnings(record=True) as w: + warnings.simplefilter("always") + kwargs = {'plotly_domain': 'https://www.foo-bar.com'} + tools.set_config_file(**kwargs) + assert len(w) == 0 + + + def test_reset_config_file(self): + + # Check reset_config and get_config return the same values + + tools.reset_config_file() + config = tools.get_config_file() + self.assertEqual(config['plotly_domain'], 'https://plot.ly') + self.assertEqual(config['plotly_streaming_domain'], 'stream.plot.ly') + + def test_get_credentials_file(self): + + # Check get_credentials returns all the keys + + original_creds = tools.get_credentials_file() + expected = ['username', 'stream_ids', 'api_key', 'proxy_username', + 'proxy_password'] + self.assertTrue(all(x in original_creds for x in expected)) + + def test_reset_credentials_file(self): + + # Check get_cred return all the keys + + tools.reset_credentials_file() + reset_creds = tools.get_credentials_file() + expected = ['username', 'stream_ids', 'api_key', 'proxy_username', + 'proxy_password'] + self.assertTrue(all(x in reset_creds for x in expected)) diff --git a/chart_studio/tests/test_core/test_tools/test_get_embed.py b/chart_studio/tests/test_core/test_tools/test_get_embed.py new file mode 100644 index 00000000000..7b49365e54f --- /dev/null +++ b/chart_studio/tests/test_core/test_tools/test_get_embed.py @@ -0,0 +1,45 @@ +from __future__ import absolute_import + +from unittest import TestCase + +from nose.tools import raises + +import chart_studio.tools as tls +from _plotly_utils.exceptions import PlotlyError + + +def test_get_valid_embed(): + url = 'https://plot.ly/~PlotBot/82/' + tls.get_embed(url) + + +@raises(PlotlyError) +def test_get_invalid_embed(): + url = 'https://plot.ly/~PlotBot/a/' + tls.get_embed(url) + + +class TestGetEmbed(TestCase): + + def test_get_embed_url_with_share_key(self): + + # Check the embed url for url with share_key included + + get_embed_return = tls.get_embed('https://plot.ly/~neda/6572' + + '?share_key=AH4MyPlyDyDWYA2cM2kj2m') + expected_get_embed = ("").format(plotly_rest_url="https://" + + "plot.ly", + file_owner="neda", + file_id="6572", + share_key="AH4MyPlyDyDWYA2" + + "cM2kj2m", + iframe_height=525, + iframe_width="100%") + self.assertEqual(get_embed_return, expected_get_embed) diff --git a/chart_studio/tests/test_optional/__init__.py b/chart_studio/tests/test_optional/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_optional/test_grid/__init__.py b/chart_studio/tests/test_optional/test_grid/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_optional/test_grid/test_grid.py b/chart_studio/tests/test_optional/test_grid/test_grid.py new file mode 100644 index 00000000000..aaf48967843 --- /dev/null +++ b/chart_studio/tests/test_optional/test_grid/test_grid.py @@ -0,0 +1,32 @@ +""" +test_grid: +========== + +A module intended for use with Nose. + +""" +from __future__ import absolute_import + +from unittest import TestCase + +from chart_studio.exceptions import InputError +from chart_studio.grid_objs import Grid + +import pandas as pd + + +class TestDataframeToGrid(TestCase): + + # Test duplicate columns + def test_duplicate_columns(self): + df = pd.DataFrame([[1, 'a'], [2, 'b']], + columns=['col_1', 'col_1']) + + expected_message = ( + "Yikes, plotly grids currently " + "can't have duplicate column names. Rename " + "the column \"{}\" and try again.".format('col_1') + ) + + with self.assertRaisesRegexp(InputError, expected_message): + Grid(df) diff --git a/chart_studio/tests/test_optional/test_ipython/__init__.py b/chart_studio/tests/test_optional/test_ipython/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_optional/test_ipython/test_widgets.py b/chart_studio/tests/test_optional/test_ipython/test_widgets.py new file mode 100644 index 00000000000..8cd365d1e49 --- /dev/null +++ b/chart_studio/tests/test_optional/test_ipython/test_widgets.py @@ -0,0 +1,14 @@ +""" +Module for testing IPython widgets + +""" +from __future__ import absolute_import + +from unittest import TestCase + +from chart_studio.widgets import GraphWidget + +class TestWidgets(TestCase): + + def test_instantiate_graph_widget(self): + widget = GraphWidget diff --git a/chart_studio/tests/test_optional/test_matplotlylib/__init__.py b/chart_studio/tests/test_optional/test_matplotlylib/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_optional/test_matplotlylib/test_plot_mpl.py b/chart_studio/tests/test_optional/test_matplotlylib/test_plot_mpl.py new file mode 100644 index 00000000000..83732461ba9 --- /dev/null +++ b/chart_studio/tests/test_optional/test_matplotlylib/test_plot_mpl.py @@ -0,0 +1,55 @@ +""" +test_plot_mpl: +============== + +A module intended for use with Nose. + +""" +from __future__ import absolute_import + +from nose.plugins.attrib import attr +from nose.tools import raises + +import _plotly_utils.exceptions +from plotly import optional_imports +from chart_studio.plotly import plotly as py +from unittest import TestCase + +matplotlylib = optional_imports.get_module('plotly.matplotlylib') + +if matplotlylib: + import matplotlib.pyplot as plt + + +@attr('matplotlib') +class PlotMPLTest(TestCase): + def setUp(self): + py.sign_in('PlotlyImageTest', '786r5mecv0', + plotly_domain='https://plot.ly') + + @raises(_plotly_utils.exceptions.PlotlyGraphObjectError) + def test_update_type_error(self): + fig, ax = plt.subplots() + ax.plot([1, 2, 3]) + update = [] + py.plot_mpl(fig, update=update, filename="nosetests", auto_open=False) + + @raises(KeyError) + def test_update_validation_error(self): + fig, ax = plt.subplots() + ax.plot([1, 2, 3]) + update = {'invalid': 'anything'} + py.plot_mpl(fig, update=update, filename="nosetests", auto_open=False) + + @attr('slow') + def test_update(self): + fig, ax = plt.subplots() + ax.plot([1, 2, 3]) + title = 'new title' + update = {'layout': {'title': title}} + url = py.plot_mpl(fig, update=update, filename="nosetests", + auto_open=False) + un = url.replace("https://plot.ly/~", "").split('/')[0] + fid = url.replace("https://plot.ly/~", "").split('/')[1] + pfig = py.get_figure(un, fid) + assert pfig['layout']['title']['text'] == title diff --git a/chart_studio/tests/test_optional/test_utils/__init__.py b/chart_studio/tests/test_optional/test_utils/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_optional/test_utils/test_utils.py b/chart_studio/tests/test_optional/test_utils/test_utils.py new file mode 100644 index 00000000000..49e16cadc16 --- /dev/null +++ b/chart_studio/tests/test_optional/test_utils/test_utils.py @@ -0,0 +1,25 @@ +import json as _json + +import _plotly_utils.utils +from chart_studio.grid_objs import Column +from plotly import utils +from plotly.tests.test_optional.test_utils.test_utils import numeric_list, \ + mixed_list, np_list + + +def test_column_json_encoding(): + columns = [ + Column(numeric_list, 'col 1'), + Column(mixed_list, 'col 2'), + Column(np_list, 'col 3') + ] + json_columns = _json.dumps( + columns, cls=_plotly_utils.utils.PlotlyJSONEncoder, sort_keys=True + ) + assert('[{"data": [1, 2, 3], "name": "col 1"}, ' + '{"data": [1, "A", "2014-01-05", ' + '"2014-01-05 01:01:01", ' + '"2014-01-05 01:01:01.000001"], ' + '"name": "col 2"}, ' + '{"data": [1, 2, 3, null, null, null, ' + '"2014-01-05"], "name": "col 3"}]' == json_columns) \ No newline at end of file diff --git a/chart_studio/tests/test_plot_ly/__init__.py b/chart_studio/tests/test_plot_ly/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_plot_ly/test_api/__init__.py b/chart_studio/tests/test_plot_ly/test_api/__init__.py new file mode 100644 index 00000000000..5a2ce755612 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_api/__init__.py @@ -0,0 +1,66 @@ +from __future__ import absolute_import + +from requests import Response + +from chart_studio.session import sign_in +from chart_studio.tests.utils import PlotlyTestCase + +import sys + +# import from mock +if sys.version_info.major == 3 and sys.version_info.minor >= 3: + from unittest.mock import patch +else: + from mock import patch + + +class PlotlyApiTestCase(PlotlyTestCase): + + def mock(self, path_string): + patcher = patch(path_string) + new_mock = patcher.start() + self.addCleanup(patcher.stop) + return new_mock + + def setUp(self): + + super(PlotlyApiTestCase, self).setUp() + + self.username = 'foo' + self.api_key = 'bar' + + self.proxy_username = 'cnet' + self.proxy_password = 'hoopla' + self.stream_ids = ['heyThere'] + + self.plotly_api_domain = 'https://api.do.not.exist' + self.plotly_domain = 'https://who.am.i' + self.plotly_proxy_authorization = False + self.plotly_streaming_domain = 'stream.does.not.exist' + self.plotly_ssl_verification = True + + sign_in( + username=self.username, + api_key=self.api_key, + proxy_username=self.proxy_username, + proxy_password=self.proxy_password, + stream_ids=self.stream_ids, + plotly_domain=self.plotly_domain, + plotly_api_domain=self.plotly_api_domain, + plotly_streaming_domain=self.plotly_streaming_domain, + plotly_proxy_authorization=self.plotly_proxy_authorization, + plotly_ssl_verification=self.plotly_ssl_verification + ) + + def to_bytes(self, string): + try: + return string.encode('utf-8') + except AttributeError: + return string + + def get_response(self, content=b'', status_code=200): + response = Response() + response.status_code = status_code + response._content = content + response.encoding = 'utf-8' + return response diff --git a/chart_studio/tests/test_plot_ly/test_api/test_v1/__init__.py b/chart_studio/tests/test_plot_ly/test_api/test_v1/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_plot_ly/test_api/test_v1/test_clientresp.py b/chart_studio/tests/test_plot_ly/test_api/test_v1/test_clientresp.py new file mode 100644 index 00000000000..2ce3fe66df2 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_api/test_v1/test_clientresp.py @@ -0,0 +1,62 @@ +from __future__ import absolute_import + +from plotly import version +from chart_studio.api.v1 import clientresp +from chart_studio.tests.test_plot_ly.test_api import PlotlyApiTestCase + + +class Duck(object): + def to_plotly_json(self): + return 'what else floats?' + + +class ClientrespTest(PlotlyApiTestCase): + + def setUp(self): + super(ClientrespTest, self).setUp() + + # Mock the actual api call, we don't want to do network tests here. + self.request_mock = self.mock('chart_studio.api.v1.utils.requests.request') + self.request_mock.return_value = self.get_response(b'{}', 200) + + # Mock the validation function since we can test that elsewhere. + self.mock('chart_studio.api.v1.utils.validate_response') + + def test_data_only(self): + data = [{'y': [3, 5], 'name': Duck()}] + clientresp(data) + assert self.request_mock.call_count == 1 + + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'post') + self.assertEqual(url, '{}/clientresp'.format(self.plotly_domain)) + expected_data = ({ + 'origin': 'plot', + 'args': '[{"name": "what else floats?", "y": [3, 5]}]', + 'platform': 'python', 'version': version.stable_semver(), 'key': 'bar', + 'kwargs': '{}', 'un': 'foo' + }) + self.assertEqual(kwargs['data'], expected_data) + self.assertTrue(kwargs['verify']) + self.assertEqual(kwargs['headers'], {}) + + def test_data_and_kwargs(self): + data = [{'y': [3, 5], 'name': Duck()}] + clientresp_kwargs = {'layout': {'title': 'mah plot'}, 'filename': 'ok'} + clientresp(data, **clientresp_kwargs) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'post') + self.assertEqual(url, '{}/clientresp'.format(self.plotly_domain)) + expected_data = ({ + 'origin': 'plot', + 'args': '[{"name": "what else floats?", "y": [3, 5]}]', + 'platform': 'python', 'version': version.stable_semver(), 'key': 'bar', + 'kwargs': '{"filename": "ok", "layout": {"title": "mah plot"}}', + 'un': 'foo' + }) + self.assertEqual(kwargs['data'], expected_data) + self.assertTrue(kwargs['verify']) + self.assertEqual(kwargs['headers'], {}) diff --git a/chart_studio/tests/test_plot_ly/test_api/test_v1/test_utils.py b/chart_studio/tests/test_plot_ly/test_api/test_v1/test_utils.py new file mode 100644 index 00000000000..8d599f973d6 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_api/test_v1/test_utils.py @@ -0,0 +1,181 @@ +from __future__ import absolute_import + +from requests import Response +from requests.compat import json as _json +from requests.exceptions import ConnectionError + +from chart_studio.api.utils import to_native_utf8_string +from chart_studio.api.v1 import utils +from chart_studio.exceptions import PlotlyRequestError +from _plotly_utils.exceptions import PlotlyError +from chart_studio.session import sign_in +from chart_studio.tests.test_plot_ly.test_api import PlotlyApiTestCase +from chart_studio.tests.utils import PlotlyTestCase + +import sys + +# import from mock, MagicMock +if sys.version_info.major == 3 and sys.version_info.minor >= 3: + from unittest.mock import MagicMock, patch +else: + from mock import patch, MagicMock + + +class ValidateResponseTest(PlotlyApiTestCase): + + def test_validate_ok(self): + try: + utils.validate_response(self.get_response(content=b'{}')) + except PlotlyRequestError: + self.fail('Expected this to pass!') + + def test_validate_not_ok(self): + bad_status_codes = (400, 404, 500) + for bad_status_code in bad_status_codes: + response = self.get_response(content=b'{}', + status_code=bad_status_code) + self.assertRaises(PlotlyRequestError, utils.validate_response, + response) + + def test_validate_no_content(self): + + # We shouldn't flake if the response has no content. + + response = self.get_response(content=b'', status_code=200) + try: + utils.validate_response(response) + except PlotlyRequestError as e: + self.assertEqual(e.message, 'No Content') + self.assertEqual(e.status_code, 200) + self.assertEqual(e.content, b'') + else: + self.fail('Expected this to raise!') + + def test_validate_non_json_content(self): + response = self.get_response(content=b'foobar', status_code=200) + try: + utils.validate_response(response) + except PlotlyRequestError as e: + self.assertEqual(e.message, 'foobar') + self.assertEqual(e.status_code, 200) + self.assertEqual(e.content, b'foobar') + else: + self.fail('Expected this to raise!') + + def test_validate_json_content_array(self): + content = self.to_bytes(_json.dumps([1, 2, 3])) + response = self.get_response(content=content, status_code=200) + try: + utils.validate_response(response) + except PlotlyRequestError as e: + self.assertEqual(e.message, to_native_utf8_string(content)) + self.assertEqual(e.status_code, 200) + self.assertEqual(e.content, content) + else: + self.fail('Expected this to raise!') + + def test_validate_json_content_dict_no_error(self): + content = self.to_bytes(_json.dumps({'foo': 'bar'})) + response = self.get_response(content=content, status_code=400) + try: + utils.validate_response(response) + except PlotlyRequestError as e: + self.assertEqual(e.message, to_native_utf8_string(content)) + self.assertEqual(e.status_code, 400) + self.assertEqual(e.content, content) + else: + self.fail('Expected this to raise!') + + def test_validate_json_content_dict_error_empty(self): + content = self.to_bytes(_json.dumps({'error': ''})) + response = self.get_response(content=content, status_code=200) + try: + utils.validate_response(response) + except PlotlyRequestError: + self.fail('Expected this not to raise!') + + def test_validate_json_content_dict_one_error_ok(self): + content = self.to_bytes(_json.dumps({'error': 'not ok!'})) + response = self.get_response(content=content, status_code=200) + try: + utils.validate_response(response) + except PlotlyRequestError as e: + self.assertEqual(e.message, 'not ok!') + self.assertEqual(e.status_code, 200) + self.assertEqual(e.content, content) + else: + self.fail('Expected this to raise!') + + +class GetHeadersTest(PlotlyTestCase): + + def setUp(self): + super(GetHeadersTest, self).setUp() + self.domain = 'https://foo.bar' + self.username = 'hodor' + self.api_key = 'secret' + sign_in(self.username, self.api_key, proxy_username='kleen-kanteen', + proxy_password='hydrated', plotly_proxy_authorization=False) + + def test_normal_auth(self): + headers = utils.get_headers() + expected_headers = {} + self.assertEqual(headers, expected_headers) + + def test_proxy_auth(self): + sign_in(self.username, self.api_key, plotly_proxy_authorization=True) + headers = utils.get_headers() + expected_headers = { + 'authorization': 'Basic a2xlZW4ta2FudGVlbjpoeWRyYXRlZA==' + } + self.assertEqual(headers, expected_headers) + + +class RequestTest(PlotlyTestCase): + + def setUp(self): + super(RequestTest, self).setUp() + self.domain = 'https://foo.bar' + self.username = 'hodor' + self.api_key = 'secret' + sign_in(self.username, self.api_key, proxy_username='kleen-kanteen', + proxy_password='hydrated', plotly_proxy_authorization=False) + + # Mock the actual api call, we don't want to do network tests here. + patcher = patch('chart_studio.api.v1.utils.requests.request') + self.request_mock = patcher.start() + self.addCleanup(patcher.stop) + self.request_mock.return_value = MagicMock(Response) + + # Mock the validation function since we test that elsewhere. + patcher = patch('chart_studio.api.v1.utils.validate_response') + self.validate_response_mock = patcher.start() + self.addCleanup(patcher.stop) + + self.method = 'get' + self.url = 'https://foo.bar.does.not.exist.anywhere' + + def test_request_with_json(self): + + # You can pass along non-native objects in the `json` kwarg for a + # requests.request, however, V1 packs up json objects a little + # differently, so we don't allow such requests. + + self.assertRaises(PlotlyError, utils.request, self.method, + self.url, json={}) + + def test_request_with_ConnectionError(self): + + # requests can flake out and not return a response object, we want to + # make sure we remain consistent with our errors. + + self.request_mock.side_effect = ConnectionError() + self.assertRaises(PlotlyRequestError, utils.request, self.method, + self.url) + + def test_request_validate_response(self): + + # Finally, we check details elsewhere, but make sure we do validate. + + utils.request(self.method, self.url) + assert self.validate_response_mock.call_count == 1 diff --git a/chart_studio/tests/test_plot_ly/test_api/test_v2/__init__.py b/chart_studio/tests/test_plot_ly/test_api/test_v2/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_plot_ly/test_api/test_v2/test_files.py b/chart_studio/tests/test_plot_ly/test_api/test_v2/test_files.py new file mode 100644 index 00000000000..e911af4cbc9 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_api/test_v2/test_files.py @@ -0,0 +1,104 @@ +from __future__ import absolute_import + +from chart_studio.api.v2 import files +from chart_studio.tests.test_plot_ly.test_api import PlotlyApiTestCase + + +class FilesTest(PlotlyApiTestCase): + + def setUp(self): + super(FilesTest, self).setUp() + + # Mock the actual api call, we don't want to do network tests here. + self.request_mock = self.mock('chart_studio.api.v2.utils.requests.request') + self.request_mock.return_value = self.get_response() + + # Mock the validation function since we can test that elsewhere. + self.mock('chart_studio.api.v2.utils.validate_response') + + def test_retrieve(self): + files.retrieve('hodor:88') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'get') + self.assertEqual( + url, '{}/v2/files/hodor:88'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['params'], {}) + + def test_retrieve_share_key(self): + files.retrieve('hodor:88', share_key='foobar') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'get') + self.assertEqual( + url, '{}/v2/files/hodor:88'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['params'], {'share_key': 'foobar'}) + + def test_update(self): + new_filename = '..zzZ ..zzZ' + files.update('hodor:88', body={'filename': new_filename}) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'put') + self.assertEqual( + url, '{}/v2/files/hodor:88'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['data'], + '{{"filename": "{}"}}'.format(new_filename)) + + def test_trash(self): + files.trash('hodor:88') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'post') + self.assertEqual( + url, '{}/v2/files/hodor:88/trash'.format(self.plotly_api_domain) + ) + + def test_restore(self): + files.restore('hodor:88') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'post') + self.assertEqual( + url, '{}/v2/files/hodor:88/restore'.format(self.plotly_api_domain) + ) + + def test_permanent_delete(self): + files.permanent_delete('hodor:88') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'delete') + self.assertEqual( + url, + '{}/v2/files/hodor:88/permanent_delete' + .format(self.plotly_api_domain) + ) + + def test_lookup(self): + + # requests does urlencode, so don't worry about the `' '` character! + + path = '/mah plot' + parent = 43 + user = 'someone' + exists = True + files.lookup(path=path, parent=parent, user=user, exists=exists) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + expected_params = {'path': path, 'parent': parent, 'exists': 'true', + 'user': user} + self.assertEqual(method, 'get') + self.assertEqual( + url, '{}/v2/files/lookup'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['params'], expected_params) diff --git a/chart_studio/tests/test_plot_ly/test_api/test_v2/test_folders.py b/chart_studio/tests/test_plot_ly/test_api/test_v2/test_folders.py new file mode 100644 index 00000000000..0d0780f2b22 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_api/test_v2/test_folders.py @@ -0,0 +1,114 @@ +from __future__ import absolute_import + +from chart_studio.api.v2 import folders +from chart_studio.tests.test_plot_ly.test_api import PlotlyApiTestCase + + +class FoldersTest(PlotlyApiTestCase): + + def setUp(self): + super(FoldersTest, self).setUp() + + # Mock the actual api call, we don't want to do network tests here. + self.request_mock = self.mock('chart_studio.api.v2.utils.requests.request') + self.request_mock.return_value = self.get_response() + + # Mock the validation function since we can test that elsewhere. + self.mock('chart_studio.api.v2.utils.validate_response') + + def test_create(self): + path = '/foo/man/bar/' + folders.create({'path': path}) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'post') + self.assertEqual(url, '{}/v2/folders'.format(self.plotly_api_domain)) + self.assertEqual(kwargs['data'], '{{"path": "{}"}}'.format(path)) + + def test_retrieve(self): + folders.retrieve('hodor:88') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'get') + self.assertEqual( + url, '{}/v2/folders/hodor:88'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['params'], {}) + + def test_retrieve_share_key(self): + folders.retrieve('hodor:88', share_key='foobar') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'get') + self.assertEqual( + url, '{}/v2/folders/hodor:88'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['params'], {'share_key': 'foobar'}) + + def test_update(self): + new_filename = '..zzZ ..zzZ' + folders.update('hodor:88', body={'filename': new_filename}) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'put') + self.assertEqual( + url, '{}/v2/folders/hodor:88'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['data'], + '{{"filename": "{}"}}'.format(new_filename)) + + def test_trash(self): + folders.trash('hodor:88') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'post') + self.assertEqual( + url, '{}/v2/folders/hodor:88/trash'.format(self.plotly_api_domain) + ) + + def test_restore(self): + folders.restore('hodor:88') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'post') + self.assertEqual( + url, '{}/v2/folders/hodor:88/restore'.format(self.plotly_api_domain) + ) + + def test_permanent_delete(self): + folders.permanent_delete('hodor:88') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'delete') + self.assertEqual( + url, + '{}/v2/folders/hodor:88/permanent_delete' + .format(self.plotly_api_domain) + ) + + def test_lookup(self): + + # requests does urlencode, so don't worry about the `' '` character! + + path = '/mah folder' + parent = 43 + user = 'someone' + exists = True + folders.lookup(path=path, parent=parent, user=user, exists=exists) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + expected_params = {'path': path, 'parent': parent, 'exists': 'true', + 'user': user} + self.assertEqual(method, 'get') + self.assertEqual( + url, '{}/v2/folders/lookup'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['params'], expected_params) diff --git a/chart_studio/tests/test_plot_ly/test_api/test_v2/test_grids.py b/chart_studio/tests/test_plot_ly/test_api/test_v2/test_grids.py new file mode 100644 index 00000000000..32e3ea3cfe1 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_api/test_v2/test_grids.py @@ -0,0 +1,185 @@ +from __future__ import absolute_import + +from requests.compat import json as _json + +from chart_studio.api.v2 import grids +from chart_studio.tests.test_plot_ly.test_api import PlotlyApiTestCase + + +class GridsTest(PlotlyApiTestCase): + + def setUp(self): + super(GridsTest, self).setUp() + + # Mock the actual api call, we don't want to do network tests here. + self.request_mock = self.mock('chart_studio.api.v2.utils.requests.request') + self.request_mock.return_value = self.get_response() + + # Mock the validation function since we can test that elsewhere. + self.mock('chart_studio.api.v2.utils.validate_response') + + def test_create(self): + filename = 'a grid' + grids.create({'filename': filename}) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'post') + self.assertEqual(url, '{}/v2/grids'.format(self.plotly_api_domain)) + self.assertEqual( + kwargs['data'], '{{"filename": "{}"}}'.format(filename) + ) + + def test_retrieve(self): + grids.retrieve('hodor:88') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'get') + self.assertEqual( + url, '{}/v2/grids/hodor:88'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['params'], {}) + + def test_retrieve_share_key(self): + grids.retrieve('hodor:88', share_key='foobar') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'get') + self.assertEqual( + url, '{}/v2/grids/hodor:88'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['params'], {'share_key': 'foobar'}) + + def test_update(self): + new_filename = '..zzZ ..zzZ' + grids.update('hodor:88', body={'filename': new_filename}) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'put') + self.assertEqual( + url, '{}/v2/grids/hodor:88'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['data'], + '{{"filename": "{}"}}'.format(new_filename)) + + def test_trash(self): + grids.trash('hodor:88') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'post') + self.assertEqual( + url, '{}/v2/grids/hodor:88/trash'.format(self.plotly_api_domain) + ) + + def test_restore(self): + grids.restore('hodor:88') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'post') + self.assertEqual( + url, '{}/v2/grids/hodor:88/restore'.format(self.plotly_api_domain) + ) + + def test_permanent_delete(self): + grids.permanent_delete('hodor:88') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'delete') + self.assertEqual( + url, + '{}/v2/grids/hodor:88/permanent_delete' + .format(self.plotly_api_domain) + ) + + def test_lookup(self): + + # requests does urlencode, so don't worry about the `' '` character! + + path = '/mah grid' + parent = 43 + user = 'someone' + exists = True + grids.lookup(path=path, parent=parent, user=user, exists=exists) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + expected_params = {'path': path, 'parent': parent, 'exists': 'true', + 'user': user} + self.assertEqual(method, 'get') + self.assertEqual( + url, '{}/v2/grids/lookup'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['params'], expected_params) + + def test_col_create(self): + cols = [ + {'name': 'foo', 'data': [1, 2, 3]}, + {'name': 'bar', 'data': ['b', 'a', 'r']}, + ] + body = {'cols': _json.dumps(cols, sort_keys=True)} + grids.col_create('hodor:88', body) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'post') + self.assertEqual( + url, '{}/v2/grids/hodor:88/col'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['data'], _json.dumps(body, sort_keys=True)) + + def test_col_retrieve(self): + grids.col_retrieve('hodor:88', 'aaaaaa,bbbbbb') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'get') + self.assertEqual( + url, '{}/v2/grids/hodor:88/col'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['params'], {'uid': 'aaaaaa,bbbbbb'}) + + def test_col_update(self): + cols = [ + {'name': 'foo', 'data': [1, 2, 3]}, + {'name': 'bar', 'data': ['b', 'a', 'r']}, + ] + body = {'cols': _json.dumps(cols, sort_keys=True)} + grids.col_update('hodor:88', 'aaaaaa,bbbbbb', body) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'put') + self.assertEqual( + url, '{}/v2/grids/hodor:88/col'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['params'], {'uid': 'aaaaaa,bbbbbb'}) + self.assertEqual(kwargs['data'], _json.dumps(body, sort_keys=True)) + + def test_col_delete(self): + grids.col_delete('hodor:88', 'aaaaaa,bbbbbb') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'delete') + self.assertEqual( + url, '{}/v2/grids/hodor:88/col'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['params'], {'uid': 'aaaaaa,bbbbbb'}) + + def test_row(self): + body = {'rows': [[1, 'A'], [2, 'B']]} + grids.row('hodor:88', body) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'post') + self.assertEqual( + url, '{}/v2/grids/hodor:88/row'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['data'], _json.dumps(body, sort_keys=True)) diff --git a/chart_studio/tests/test_plot_ly/test_api/test_v2/test_images.py b/chart_studio/tests/test_plot_ly/test_api/test_v2/test_images.py new file mode 100644 index 00000000000..5830a36ed2b --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_api/test_v2/test_images.py @@ -0,0 +1,41 @@ +from __future__ import absolute_import + +from requests.compat import json as _json + +from chart_studio.api.v2 import images +from chart_studio.tests.test_plot_ly.test_api import PlotlyApiTestCase + + +class ImagesTest(PlotlyApiTestCase): + + def setUp(self): + super(ImagesTest, self).setUp() + + # Mock the actual api call, we don't want to do network tests here. + self.request_mock = self.mock('chart_studio.api.v2.utils.requests.request') + self.request_mock.return_value = self.get_response() + + # Mock the validation function since we can test that elsewhere. + self.mock('chart_studio.api.v2.utils.validate_response') + + def test_create(self): + + body = { + "figure": { + "data": [{"y": [10, 10, 2, 20]}], + "layout": {"width": 700} + }, + "width": 1000, + "height": 500, + "format": "png", + "scale": 4, + "encoded": False + } + + images.create(body) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'post') + self.assertEqual(url, '{}/v2/images'.format(self.plotly_api_domain)) + self.assertEqual(kwargs['data'], _json.dumps(body, sort_keys=True)) diff --git a/chart_studio/tests/test_plot_ly/test_api/test_v2/test_plot_schema.py b/chart_studio/tests/test_plot_ly/test_api/test_v2/test_plot_schema.py new file mode 100644 index 00000000000..e79798c504c --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_api/test_v2/test_plot_schema.py @@ -0,0 +1,30 @@ +from __future__ import absolute_import + +from chart_studio.api.v2 import plot_schema +from chart_studio.tests.test_plot_ly.test_api import PlotlyApiTestCase + + +class PlotSchemaTest(PlotlyApiTestCase): + + def setUp(self): + super(PlotSchemaTest, self).setUp() + + # Mock the actual api call, we don't want to do network tests here. + self.request_mock = self.mock('chart_studio.api.v2.utils.requests.request') + self.request_mock.return_value = self.get_response() + + # Mock the validation function since we can test that elsewhere. + self.mock('chart_studio.api.v2.utils.validate_response') + + def test_retrieve(self): + + plot_schema.retrieve('some-hash', timeout=400) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'get') + self.assertEqual( + url, '{}/v2/plot-schema'.format(self.plotly_api_domain) + ) + self.assertTrue(kwargs['timeout']) + self.assertEqual(kwargs['params'], {'sha1': 'some-hash'}) diff --git a/chart_studio/tests/test_plot_ly/test_api/test_v2/test_plots.py b/chart_studio/tests/test_plot_ly/test_api/test_v2/test_plots.py new file mode 100644 index 00000000000..ed4157226f1 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_api/test_v2/test_plots.py @@ -0,0 +1,116 @@ +from __future__ import absolute_import + +from chart_studio.api.v2 import plots +from chart_studio.tests.test_plot_ly.test_api import PlotlyApiTestCase + + +class PlotsTest(PlotlyApiTestCase): + + def setUp(self): + super(PlotsTest, self).setUp() + + # Mock the actual api call, we don't want to do network tests here. + self.request_mock = self.mock('chart_studio.api.v2.utils.requests.request') + self.request_mock.return_value = self.get_response() + + # Mock the validation function since we can test that elsewhere. + self.mock('chart_studio.api.v2.utils.validate_response') + + def test_create(self): + filename = 'a plot' + plots.create({'filename': filename}) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'post') + self.assertEqual(url, '{}/v2/plots'.format(self.plotly_api_domain)) + self.assertEqual( + kwargs['data'], '{{"filename": "{}"}}'.format(filename) + ) + + def test_retrieve(self): + plots.retrieve('hodor:88') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'get') + self.assertEqual( + url, '{}/v2/plots/hodor:88'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['params'], {}) + + def test_retrieve_share_key(self): + plots.retrieve('hodor:88', share_key='foobar') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'get') + self.assertEqual( + url, '{}/v2/plots/hodor:88'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['params'], {'share_key': 'foobar'}) + + def test_update(self): + new_filename = '..zzZ ..zzZ' + plots.update('hodor:88', body={'filename': new_filename}) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'put') + self.assertEqual( + url, '{}/v2/plots/hodor:88'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['data'], + '{{"filename": "{}"}}'.format(new_filename)) + + def test_trash(self): + plots.trash('hodor:88') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'post') + self.assertEqual( + url, '{}/v2/plots/hodor:88/trash'.format(self.plotly_api_domain) + ) + + def test_restore(self): + plots.restore('hodor:88') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'post') + self.assertEqual( + url, '{}/v2/plots/hodor:88/restore'.format(self.plotly_api_domain) + ) + + def test_permanent_delete(self): + plots.permanent_delete('hodor:88') + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'delete') + self.assertEqual( + url, + '{}/v2/plots/hodor:88/permanent_delete' + .format(self.plotly_api_domain) + ) + + def test_lookup(self): + + # requests does urlencode, so don't worry about the `' '` character! + + path = '/mah plot' + parent = 43 + user = 'someone' + exists = True + plots.lookup(path=path, parent=parent, user=user, exists=exists) + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + expected_params = {'path': path, 'parent': parent, 'exists': 'true', + 'user': user} + self.assertEqual(method, 'get') + self.assertEqual( + url, '{}/v2/plots/lookup'.format(self.plotly_api_domain) + ) + self.assertEqual(kwargs['params'], expected_params) diff --git a/chart_studio/tests/test_plot_ly/test_api/test_v2/test_users.py b/chart_studio/tests/test_plot_ly/test_api/test_v2/test_users.py new file mode 100644 index 00000000000..5e787424437 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_api/test_v2/test_users.py @@ -0,0 +1,28 @@ +from __future__ import absolute_import + +from chart_studio.api.v2 import users +from chart_studio.tests.test_plot_ly.test_api import PlotlyApiTestCase + + +class UsersTest(PlotlyApiTestCase): + + def setUp(self): + super(UsersTest, self).setUp() + + # Mock the actual api call, we don't want to do network tests here. + self.request_mock = self.mock('chart_studio.api.v2.utils.requests.request') + self.request_mock.return_value = self.get_response() + + # Mock the validation function since we can test that elsewhere. + self.mock('chart_studio.api.v2.utils.validate_response') + + def test_current(self): + users.current() + assert self.request_mock.call_count == 1 + args, kwargs = self.request_mock.call_args + method, url = args + self.assertEqual(method, 'get') + self.assertEqual( + url, '{}/v2/users/current'.format(self.plotly_api_domain) + ) + self.assertNotIn('params', kwargs) diff --git a/chart_studio/tests/test_plot_ly/test_api/test_v2/test_utils.py b/chart_studio/tests/test_plot_ly/test_api/test_v2/test_utils.py new file mode 100644 index 00000000000..7ae1143cd41 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_api/test_v2/test_utils.py @@ -0,0 +1,252 @@ +from __future__ import absolute_import + +from requests.compat import json as _json +from requests.exceptions import ConnectionError + +from plotly import version +from chart_studio.api.utils import to_native_utf8_string +from chart_studio.api.v2 import utils +from chart_studio.exceptions import PlotlyRequestError +from chart_studio.session import sign_in +from chart_studio.tests.test_plot_ly.test_api import PlotlyApiTestCase + + +class MakeParamsTest(PlotlyApiTestCase): + + def test_make_params(self): + params = utils.make_params(foo='FOO', bar=None) + self.assertEqual(params, {'foo': 'FOO'}) + + def test_make_params_empty(self): + params = utils.make_params(foo=None, bar=None) + self.assertEqual(params, {}) + + +class BuildUrlTest(PlotlyApiTestCase): + + def test_build_url(self): + url = utils.build_url('cats') + self.assertEqual(url, '{}/v2/cats'.format(self.plotly_api_domain)) + + def test_build_url_id(self): + url = utils.build_url('cats', id='MsKitty') + self.assertEqual( + url, '{}/v2/cats/MsKitty'.format(self.plotly_api_domain) + ) + + def test_build_url_route(self): + url = utils.build_url('cats', route='about') + self.assertEqual( + url, '{}/v2/cats/about'.format(self.plotly_api_domain) + ) + + def test_build_url_id_route(self): + url = utils.build_url('cats', id='MsKitty', route='de-claw') + self.assertEqual( + url, '{}/v2/cats/MsKitty/de-claw'.format(self.plotly_api_domain) + ) + + +class ValidateResponseTest(PlotlyApiTestCase): + + def test_validate_ok(self): + try: + utils.validate_response(self.get_response()) + except PlotlyRequestError: + self.fail('Expected this to pass!') + + def test_validate_not_ok(self): + bad_status_codes = (400, 404, 500) + for bad_status_code in bad_status_codes: + response = self.get_response(status_code=bad_status_code) + self.assertRaises(PlotlyRequestError, utils.validate_response, + response) + + def test_validate_no_content(self): + + # We shouldn't flake if the response has no content. + + response = self.get_response(content=b'', status_code=400) + try: + utils.validate_response(response) + except PlotlyRequestError as e: + self.assertEqual(e.message, u'No Content') + self.assertEqual(e.status_code, 400) + self.assertEqual(e.content.decode('utf-8'), u'') + else: + self.fail('Expected this to raise!') + + def test_validate_non_json_content(self): + response = self.get_response(content=b'foobar', status_code=400) + try: + utils.validate_response(response) + except PlotlyRequestError as e: + self.assertEqual(e.message, 'foobar') + self.assertEqual(e.status_code, 400) + self.assertEqual(e.content, b'foobar') + else: + self.fail('Expected this to raise!') + + def test_validate_json_content_array(self): + content = self.to_bytes(_json.dumps([1, 2, 3])) + response = self.get_response(content=content, status_code=400) + try: + utils.validate_response(response) + except PlotlyRequestError as e: + self.assertEqual(e.message, to_native_utf8_string(content)) + self.assertEqual(e.status_code, 400) + self.assertEqual(e.content, content) + else: + self.fail('Expected this to raise!') + + def test_validate_json_content_dict_no_errors(self): + content = self.to_bytes(_json.dumps({'foo': 'bar'})) + response = self.get_response(content=content, status_code=400) + try: + utils.validate_response(response) + except PlotlyRequestError as e: + self.assertEqual(e.message, to_native_utf8_string(content)) + self.assertEqual(e.status_code, 400) + self.assertEqual(e.content, content) + else: + self.fail('Expected this to raise!') + + def test_validate_json_content_dict_one_error_bad(self): + content = self.to_bytes(_json.dumps({'errors': [{}]})) + response = self.get_response(content=content, status_code=400) + try: + utils.validate_response(response) + except PlotlyRequestError as e: + self.assertEqual(e.message, to_native_utf8_string(content)) + self.assertEqual(e.status_code, 400) + self.assertEqual(e.content, content) + else: + self.fail('Expected this to raise!') + + content = self.to_bytes(_json.dumps({'errors': [{'message': ''}]})) + response = self.get_response(content=content, status_code=400) + try: + utils.validate_response(response) + except PlotlyRequestError as e: + self.assertEqual(e.message, to_native_utf8_string(content)) + self.assertEqual(e.status_code, 400) + self.assertEqual(e.content, content) + else: + self.fail('Expected this to raise!') + + def test_validate_json_content_dict_one_error_ok(self): + content = self.to_bytes(_json.dumps( + {'errors': [{'message': 'not ok!'}]})) + response = self.get_response(content=content, status_code=400) + try: + utils.validate_response(response) + except PlotlyRequestError as e: + self.assertEqual(e.message, 'not ok!') + self.assertEqual(e.status_code, 400) + self.assertEqual(e.content, content) + else: + self.fail('Expected this to raise!') + + def test_validate_json_content_dict_multiple_errors(self): + content = self.to_bytes(_json.dumps({'errors': [ + {'message': 'not ok!'}, {'message': 'bad job...'} + ]})) + response = self.get_response(content=content, status_code=400) + try: + utils.validate_response(response) + except PlotlyRequestError as e: + self.assertEqual(e.message, 'not ok!\nbad job...') + self.assertEqual(e.status_code, 400) + self.assertEqual(e.content, content) + else: + self.fail('Expected this to raise!') + + +class GetHeadersTest(PlotlyApiTestCase): + + def test_normal_auth(self): + headers = utils.get_headers() + expected_headers = { + 'plotly-client-platform': 'python {}'.format(version.stable_semver()), + 'authorization': 'Basic Zm9vOmJhcg==', + 'content-type': 'application/json' + } + self.assertEqual(headers, expected_headers) + + def test_proxy_auth(self): + sign_in(self.username, self.api_key, plotly_proxy_authorization=True) + headers = utils.get_headers() + expected_headers = { + 'plotly-client-platform': 'python {}'.format(version.stable_semver()), + 'authorization': 'Basic Y25ldDpob29wbGE=', + 'plotly-authorization': 'Basic Zm9vOmJhcg==', + 'content-type': 'application/json' + } + self.assertEqual(headers, expected_headers) + + +class RequestTest(PlotlyApiTestCase): + + def setUp(self): + super(RequestTest, self).setUp() + + # Mock the actual api call, we don't want to do network tests here. + self.request_mock = self.mock('chart_studio.api.v2.utils.requests.request') + self.request_mock.return_value = self.get_response() + + # Mock the validation function since we can test that elsewhere. + self.validate_response_mock = self.mock( + 'chart_studio.api.v2.utils.validate_response') + + self.method = 'get' + self.url = 'https://foo.bar.does.not.exist.anywhere' + + def test_request_with_params(self): + + # urlencode transforms `True` --> `'True'`, which isn't super helpful, + # Our backend accepts the JS `true`, so we want `True` --> `'true'`. + + params = {'foo': True, 'bar': 'True', 'baz': False, 'zap': 0} + utils.request(self.method, self.url, params=params) + args, kwargs = self.request_mock.call_args + method, url = args + expected_params = {'foo': 'true', 'bar': 'True', 'baz': 'false', + 'zap': 0} + self.assertEqual(method, self.method) + self.assertEqual(url, self.url) + self.assertEqual(kwargs['params'], expected_params) + + def test_request_with_non_native_objects(self): + + # We always send along json, but it may contain non-native objects like + # a pandas array or a Column reference. Make sure that's handled in one + # central place. + + class Duck(object): + def to_plotly_json(self): + return 'what else floats?' + + utils.request(self.method, self.url, json={'foo': [Duck(), Duck()]}) + args, kwargs = self.request_mock.call_args + method, url = args + expected_data = '{"foo": ["what else floats?", "what else floats?"]}' + self.assertEqual(method, self.method) + self.assertEqual(url, self.url) + self.assertEqual(kwargs['data'], expected_data) + self.assertNotIn('json', kwargs) + + def test_request_with_ConnectionError(self): + + # requests can flake out and not return a response object, we want to + # make sure we remain consistent with our errors. + + self.request_mock.side_effect = ConnectionError() + self.assertRaises(PlotlyRequestError, utils.request, self.method, + self.url) + + def test_request_validate_response(self): + + # Finally, we check details elsewhere, but make sure we do validate. + + utils.request(self.method, self.url) + assert self.request_mock.call_count == 1 diff --git a/chart_studio/tests/test_plot_ly/test_dashboard/__init__.py b/chart_studio/tests/test_plot_ly/test_dashboard/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_plot_ly/test_dashboard/test_dashboard.py b/chart_studio/tests/test_plot_ly/test_dashboard/test_dashboard.py new file mode 100644 index 00000000000..184f788b1fe --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_dashboard/test_dashboard.py @@ -0,0 +1,141 @@ +""" +test_dashboard: +========== + +A module intended for use with Nose. + +""" +from __future__ import absolute_import + +from unittest import TestCase +from _plotly_utils.exceptions import PlotlyError +import chart_studio.dashboard_objs.dashboard_objs as dashboard + + +class TestDashboard(TestCase): + + def test_invalid_path(self): + + my_box = { + 'type': 'box', + 'boxType': 'plot', + 'fileId': 'AdamKulidjian:327', + 'shareKey': None, + 'title': 'box 1' + } + dash = dashboard.Dashboard() + + message = ( + "Invalid path. Your 'path' list must only contain " + "the strings 'first' and 'second'." + ) + + self.assertRaisesRegexp(PlotlyError, message, + dash._insert, my_box, 'third') + + def test_box_id_none(self): + + my_box = { + 'type': 'box', + 'boxType': 'plot', + 'fileId': 'AdamKulidjian:327', + 'shareKey': None, + 'title': 'box 1' + } + + dash = dashboard.Dashboard() + dash.insert(my_box, 'above', None) + + message = ( + "Make sure the box_id is specfied if there is at least " + "one box in your dashboard." + ) + + self.assertRaisesRegexp(PlotlyError, message, dash.insert, + my_box, 'above', None) + + def test_id_not_valid(self): + my_box = { + 'type': 'box', + 'boxType': 'plot', + 'fileId': 'AdamKulidjian:327', + 'shareKey': None, + 'title': 'box 1' + } + + message = ( + "Your box_id must be a number in your dashboard. To view a " + "representation of your dashboard run get_preview()." + ) + + dash = dashboard.Dashboard() + dash.insert(my_box, 'above', 1) + + # insert box + self.assertRaisesRegexp(PlotlyError, message, dash.insert, my_box, + 'above', 0) + # get box by id + self.assertRaisesRegexp(PlotlyError, message, dash.get_box, 0) + + # remove box + self.assertRaisesRegexp(PlotlyError, message, dash.remove, 0) + + def test_invalid_side(self): + my_box = { + 'type': 'box', + 'boxType': 'plot', + 'fileId': 'AdamKulidjian:327', + 'shareKey': None, + 'title': 'box 1' + } + + message = ( + "If there is at least one box in your dashboard, you " + "must specify a valid side value. You must choose from " + "'above', 'below', 'left', and 'right'." + ) + + dash = dashboard.Dashboard() + dash.insert(my_box, 'above', 0) + + self.assertRaisesRegexp(PlotlyError, message, dash.insert, + my_box, 'somewhere', 1) + + def test_dashboard_dict(self): + my_box = { + 'type': 'box', + 'boxType': 'plot', + 'fileId': 'AdamKulidjian:327', + 'shareKey': None, + 'title': 'box 1' + } + + dash = dashboard.Dashboard() + dash.insert(my_box) + dash.insert(my_box, 'above', 1) + + expected_dashboard = { + 'layout': {'direction': 'vertical', + 'first': {'direction': 'vertical', + 'first': {'boxType': 'plot', + 'fileId': 'AdamKulidjian:327', + 'shareKey': None, + 'title': 'box 1', + 'type': 'box'}, + 'second': {'boxType': 'plot', + 'fileId': 'AdamKulidjian:327', + 'shareKey': None, + 'title': 'box 1', + 'type': 'box'}, + 'size': 50, + 'sizeUnit': '%', + 'type': 'split'}, + 'second': {'boxType': 'empty', 'type': 'box'}, + 'size': 1500, + 'sizeUnit': 'px', + 'type': 'split'}, + 'settings': {}, + 'version': 2 + } + + self.assertEqual(dash['layout'], expected_dashboard['layout']) diff --git a/chart_studio/tests/test_plot_ly/test_file/__init__.py b/chart_studio/tests/test_plot_ly/test_file/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_plot_ly/test_file/test_file.py b/chart_studio/tests/test_plot_ly/test_file/test_file.py new file mode 100644 index 00000000000..c46383d0119 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_file/test_file.py @@ -0,0 +1,55 @@ +""" +test_meta: +========== + +A module intended for use with Nose. + +""" +import random +import string + +from nose.plugins.attrib import attr + +from chart_studio import plotly as py +from chart_studio.exceptions import PlotlyRequestError +from chart_studio.tests.utils import PlotlyTestCase + + +@attr('slow') +class FolderAPITestCase(PlotlyTestCase): + + def setUp(self): + super(FolderAPITestCase, self).setUp() + py.sign_in('PythonTest', 'xnyU0DEwvAQQCwHVseIL') + + def _random_filename(self): + choice_chars = string.ascii_letters + string.digits + random_chars = [random.choice(choice_chars) for _ in range(10)] + unique_filename = 'Valid Folder ' + ''.join(random_chars) + return unique_filename + + def test_create_folder(self): + try: + py.file_ops.mkdirs(self._random_filename()) + except PlotlyRequestError as e: + self.fail('Expected this *not* to fail! Status: {}' + .format(e.status_code)) + + def test_create_nested_folders(self): + first_folder = self._random_filename() + nested_folder = '{0}/{1}'.format(first_folder, self._random_filename()) + try: + py.file_ops.mkdirs(nested_folder) + except PlotlyRequestError as e: + self.fail('Expected this *not* to fail! Status: {}' + .format(e.status_code)) + + def test_duplicate_folders(self): + first_folder = self._random_filename() + py.file_ops.mkdirs(first_folder) + try: + py.file_ops.mkdirs(first_folder) + except PlotlyRequestError as e: + pass + else: + self.fail('Expected this to fail!') diff --git a/chart_studio/tests/test_plot_ly/test_get_figure/__init__.py b/chart_studio/tests/test_plot_ly/test_get_figure/__init__.py new file mode 100644 index 00000000000..1118eb01e82 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_get_figure/__init__.py @@ -0,0 +1,5 @@ +import warnings + + +def setup_package(): + warnings.filterwarnings('ignore') diff --git a/chart_studio/tests/test_plot_ly/test_get_figure/test_get_figure.py b/chart_studio/tests/test_plot_ly/test_get_figure/test_get_figure.py new file mode 100644 index 00000000000..b23288b8b4d --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_get_figure/test_get_figure.py @@ -0,0 +1,110 @@ +""" +test_get_figure: +================= + +A module intended for use with Nose. + +""" +from __future__ import absolute_import + +from unittest import skipIf + +import six +from nose.plugins.attrib import attr + +import _plotly_utils.exceptions +from chart_studio import exceptions +from chart_studio.plotly import plotly as py +from chart_studio.tests.utils import PlotlyTestCase + + +def is_trivial(obj): + if isinstance(obj, (dict, list)): + if len(obj): + if isinstance(obj, dict): + tests = (is_trivial(obj[key]) for key in obj) + return all(tests) + elif isinstance(obj, list): + tests = (is_trivial(entry) for entry in obj) + return all(tests) + else: + return False + else: + return True + elif obj is None: + return True + else: + return False + + +class GetFigureTest(PlotlyTestCase): + + @attr('slow') + def test_get_figure(self): + un = 'PlotlyImageTest' + ak = '786r5mecv0' + file_id = 13183 + py.sign_in(un, ak) + py.get_figure('PlotlyImageTest', str(file_id)) + + @attr('slow') + def test_get_figure_with_url(self): + un = 'PlotlyImageTest' + ak = '786r5mecv0' + url = "https://plot.ly/~PlotlyImageTest/13183/" + py.sign_in(un, ak) + py.get_figure(url) + + def test_get_figure_invalid_1(self): + un = 'PlotlyImageTest' + ak = '786r5mecv0' + url = "https://plot.ly/~PlotlyImageTest/a/" + py.sign_in(un, ak) + with self.assertRaises(exceptions.PlotlyError): + py.get_figure(url) + + @attr('slow') + def test_get_figure_invalid_2(self): + un = 'PlotlyImageTest' + ak = '786r5mecv0' + url = "https://plot.ly/~PlotlyImageTest/-1/" + py.sign_in(un, ak) + with self.assertRaises(exceptions.PlotlyError): + py.get_figure(url) + + # demonstrates error if fig has invalid parts + def test_get_figure_invalid_3(self): + un = 'PlotlyImageTest' + ak = '786r5mecv0' + url = "https://plot.ly/~PlotlyImageTest/2/" + py.sign_in(un, ak) + with self.assertRaises(ValueError): + py.get_figure(url) + + @attr('slow') + def test_get_figure_does_not_exist(self): + un = 'PlotlyImageTest' + ak = '786r5mecv0' + url = "https://plot.ly/~PlotlyImageTest/1000000000/" + py.sign_in(un, ak) + with self.assertRaises(_plotly_utils.exceptions.PlotlyError): + py.get_figure(url) + + @attr('slow') + def test_get_figure_raw(self): + un = 'PlotlyImageTest' + ak = '786r5mecv0' + file_id = 2 + py.sign_in(un, ak) + py.get_figure('PlotlyImageTest', str(file_id), raw=True) + + +class TestBytesVStrings(PlotlyTestCase): + + @skipIf(not six.PY3, 'Decoding and missing escapes only seen in PY3') + def test_proper_escaping(self): + un = 'PlotlyImageTest' + ak = '786r5mecv0' + url = "https://plot.ly/~PlotlyImageTest/13185/" + py.sign_in(un, ak) + py.get_figure(url) diff --git a/chart_studio/tests/test_plot_ly/test_get_requests/__init__.py b/chart_studio/tests/test_plot_ly/test_get_requests/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_plot_ly/test_get_requests/test_get_requests.py b/chart_studio/tests/test_plot_ly/test_get_requests/test_get_requests.py new file mode 100644 index 00000000000..7ca4d607b59 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_get_requests/test_get_requests.py @@ -0,0 +1,142 @@ +""" +test_get_requests: +================== + +A module intended for use with Nose. + +""" +import copy + +import requests +import six +from nose.plugins.attrib import attr +from requests.compat import json as _json + +from chart_studio.tests.utils import PlotlyTestCase + +default_headers = {'plotly-username': '', + 'plotly-apikey': '', + 'plotly-version': '2.0', + 'plotly-platform': 'pythonz'} + +server = "https://plot.ly" + + +class GetRequestsTest(PlotlyTestCase): + + @attr('slow') + def test_user_does_not_exist(self): + username = 'user_does_not_exist' + api_key = 'invalid-apikey' + file_owner = 'get_test_user' + file_id = 0 + hd = copy.copy(default_headers) + hd['plotly-username'] = username + hd['plotly-apikey'] = api_key + resource = "/apigetfile/{0}/{1}/".format(file_owner, file_id) + response = requests.get(server + resource, headers=hd) + if six.PY3: + content = _json.loads(response.content.decode('unicode_escape')) + else: + content = _json.loads(response.content) + error_message = ("Aw, snap! We don't have an account for {0}. Want to " + "try again? Sign in is not case sensitive." + .format(username)) + self.assertEqual(response.status_code, 404) + self.assertEqual(content['error'], error_message) + + @attr('slow') + def test_file_does_not_exist(self): + username = 'PlotlyImageTest' + api_key = '786r5mecv0' + file_owner = 'get_test_user' + file_id = 1000 + hd = copy.copy(default_headers) + hd['plotly-username'] = username + hd['plotly-apikey'] = api_key + resource = "/apigetfile/{0}/{1}/".format(file_owner, file_id) + response = requests.get(server + resource, headers=hd) + if six.PY3: + content = _json.loads(response.content.decode('unicode_escape')) + else: + content = _json.loads(response.content) + error_message = ("Aw, snap! It looks like this file does " + "not exist. Want to try again?") + self.assertEqual(response.status_code, 404) + self.assertEqual(content['error'], error_message) + + @attr('slow') + def test_wrong_api_key(self): # TODO: does this test the right thing? + username = 'PlotlyImageTest' + api_key = 'invalid-apikey' + file_owner = 'get_test_user' + file_id = 0 + hd = copy.copy(default_headers) + hd['plotly-username'] = username + hd['plotly-apikey'] = api_key + resource = "/apigetfile/{0}/{1}/".format(file_owner, file_id) + response = requests.get(server + resource, headers=hd) + self.assertEqual(response.status_code, 401) + # TODO: check error message? + + # Locked File + # TODO + + @attr('slow') + def test_private_permission_defined(self): + username = 'PlotlyImageTest' + api_key = '786r5mecv0' + file_owner = 'get_test_user' + file_id = 1 # 1 is a private file + hd = copy.copy(default_headers) + hd['plotly-username'] = username + hd['plotly-apikey'] = api_key + resource = "/apigetfile/{0}/{1}/".format(file_owner, file_id) + response = requests.get(server + resource, headers=hd) + if six.PY3: + content = _json.loads(response.content.decode('unicode_escape')) + else: + content = _json.loads(response.content) + self.assertEqual(response.status_code, 403) + + # Private File that is shared + # TODO + + @attr('slow') + def test_missing_headers(self): + file_owner = 'get_test_user' + file_id = 0 + resource = "/apigetfile/{0}/{1}/".format(file_owner, file_id) + headers = list(default_headers.keys()) + for header in headers: + hd = copy.copy(default_headers) + del hd[header] + response = requests.get(server + resource, headers=hd) + if six.PY3: + content = _json.loads(response.content.decode('unicode_escape')) + else: + content = _json.loads(response.content) + self.assertEqual(response.status_code, 422) + + @attr('slow') + def test_valid_request(self): + username = 'PlotlyImageTest' + api_key = '786r5mecv0' + file_owner = 'get_test_user' + file_id = 0 + hd = copy.copy(default_headers) + hd['plotly-username'] = username + hd['plotly-apikey'] = api_key + resource = "/apigetfile/{0}/{1}/".format(file_owner, file_id) + response = requests.get(server + resource, headers=hd) + if six.PY3: + content = _json.loads(response.content.decode('unicode_escape')) + else: + content = _json.loads(response.content) + self.assertEqual(response.status_code, 200) + # content = _json.loads(res.content) + # response_payload = content['payload'] + # figure = response_payload['figure'] + # if figure['data'][0]['x'] != [u'1', u'2', u'3']: + # print('ERROR') + # return res diff --git a/chart_studio/tests/test_plot_ly/test_grid/__init__.py b/chart_studio/tests/test_plot_ly/test_grid/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_plot_ly/test_grid/test_grid.py b/chart_studio/tests/test_plot_ly/test_grid/test_grid.py new file mode 100644 index 00000000000..601c02ed2e2 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_grid/test_grid.py @@ -0,0 +1,184 @@ +""" +test_grid: +========== + +A module intended for use with Nose. + +""" +from __future__ import absolute_import + +import random +import string +from unittest import skip + +from nose.plugins.attrib import attr + +from chart_studio import plotly as py +from chart_studio.exceptions import InputError, PlotlyRequestError +from _plotly_utils.exceptions import PlotlyError +from plotly.graph_objs import Scatter +from chart_studio.grid_objs import Column, Grid +from chart_studio.plotly import parse_grid_id_args +from chart_studio.tests.utils import PlotlyTestCase + + +def random_filename(): + choice_chars = string.ascii_letters + string.digits + random_chars = [random.choice(choice_chars) for _ in range(10)] + unique_filename = 'Valid Grid ' + ''.join(random_chars) + return unique_filename + + +class GridTest(PlotlyTestCase): + + # Test grid args + _grid_id = 'chris:3043' + _grid = Grid([]) + _grid.id = _grid_id + _grid_url = 'https://plot.ly/~chris/3043/my-grid' + + def setUp(self): + super(GridTest, self).setUp() + py.sign_in('PythonTest', 'xnyU0DEwvAQQCwHVseIL') + + def get_grid(self): + c1 = Column([1, 2, 3, 4], 'first column') + c2 = Column(['a', 'b', 'c', 'd'], 'second column') + g = Grid([c1, c2]) + return g + + def upload_and_return_grid(self): + g = self.get_grid() + unique_filename = random_filename() + py.grid_ops.upload(g, unique_filename, auto_open=False) + return g + + # Nominal usage + @attr('slow') + def test_grid_upload(self): + self.upload_and_return_grid() + + @attr('slow') + def test_grid_upload_in_new_folder(self): + g = self.get_grid() + path = ( + 'new folder: {0}/grid in folder {1}' + .format(random_filename(), random_filename()) + ) + py.grid_ops.upload(g, path, auto_open=False) + + @attr('slow') + def test_grid_upload_in_existing_folder(self): + g = self.get_grid() + folder = random_filename() + filename = random_filename() + py.file_ops.mkdirs(folder) + path = ( + 'existing folder: {0}/grid in folder {1}' + .format(folder, filename) + ) + py.grid_ops.upload(g, path, auto_open=False) + + @attr('slow') + def test_column_append(self): + g = self.upload_and_return_grid() + new_col = Column([1, 5, 3], 'new col') + py.grid_ops.append_columns([new_col], grid=g) + + @attr('slow') + def test_row_append(self): + g = self.upload_and_return_grid() + new_rows = [[1, 2], [10, 20]] + py.grid_ops.append_rows(new_rows, grid=g) + + @attr('slow') + def test_plot_from_grid(self): + g = self.upload_and_return_grid() + url = py.plot([Scatter(xsrc=g[0].id, ysrc=g[1].id)], + auto_open=False, filename='plot from grid') + return url, g + + @attr('slow') + def test_get_figure_from_references(self): + url, g = self.test_plot_from_grid() + fig = py.get_figure(url) + data = fig['data'] + trace = data[0] + assert(tuple(g[0].data) == tuple(trace['x'])) + assert(tuple(g[1].data) == tuple(trace['y'])) + + def test_grid_id_args(self): + self.assertEqual(parse_grid_id_args(self._grid, None), + parse_grid_id_args(None, self._grid_url)) + + def test_no_grid_id_args(self): + with self.assertRaises(InputError): + parse_grid_id_args(None, None) + + def test_overspecified_grid_args(self): + with self.assertRaises(InputError): + parse_grid_id_args(self._grid, self._grid_url) + + # not broken anymore since plotly 3.0.0 + # def test_scatter_from_non_uploaded_grid(self): + # c1 = Column([1, 2, 3, 4], 'first column') + # c2 = Column(['a', 'b', 'c', 'd'], 'second column') + # g = Grid([c1, c2]) + # with self.assertRaises(ValueError): + # Scatter(xsrc=g[0], ysrc=g[1]) + + def test_column_append_of_non_uploaded_grid(self): + c1 = Column([1, 2, 3, 4], 'first column') + c2 = Column(['a', 'b', 'c', 'd'], 'second column') + g = Grid([c1]) + with self.assertRaises(PlotlyError): + py.grid_ops.append_columns([c2], grid=g) + + def test_row_append_of_non_uploaded_grid(self): + c1 = Column([1, 2, 3, 4], 'first column') + rows = [[1], [2]] + g = Grid([c1]) + with self.assertRaises(PlotlyError): + py.grid_ops.append_rows(rows, grid=g) + + # Input Errors + @attr('slow') + def test_unequal_length_rows(self): + g = self.upload_and_return_grid() + rows = [[1, 2], ['to', 'many', 'cells']] + with self.assertRaises(InputError): + py.grid_ops.append_rows(rows, grid=g) + + # Test duplicate columns + def test_duplicate_columns(self): + c1 = Column([1, 2, 3, 4], 'first column') + c2 = Column(['a', 'b', 'c', 'd'], 'first column') + with self.assertRaises(InputError): + Grid([c1, c2]) + + # Test delete + @attr('slow') + def test_delete_grid(self): + g = self.get_grid() + fn = random_filename() + py.grid_ops.upload(g, fn, auto_open=False) + py.grid_ops.delete(g) + py.grid_ops.upload(g, fn, auto_open=False) + + # Plotly failures + @skip('adding this for now so test_file_tools pass, more info' + + 'https://github.com/plotly/python-api/issues/262') + def test_duplicate_filenames(self): + c1 = Column([1, 2, 3, 4], 'first column') + g = Grid([c1]) + + random_chars = [random.choice(string.ascii_uppercase) + for _ in range(5)] + unique_filename = 'Valid Grid ' + ''.join(random_chars) + py.grid_ops.upload(g, unique_filename, auto_open=False) + try: + py.grid_ops.upload(g, unique_filename, auto_open=False) + except PlotlyRequestError as e: + pass + else: + self.fail('Expected this to fail!') diff --git a/chart_studio/tests/test_plot_ly/test_image/__init__.py b/chart_studio/tests/test_plot_ly/test_image/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_plot_ly/test_image/test_image.py b/chart_studio/tests/test_plot_ly/test_image/test_image.py new file mode 100644 index 00000000000..4c74bc753a3 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_image/test_image.py @@ -0,0 +1,77 @@ +from __future__ import absolute_import + +import imghdr +import tempfile +import os +import itertools +import warnings + +from nose.plugins.attrib import attr + +import _plotly_utils.exceptions +from chart_studio.plotly import plotly as py +from chart_studio.tests.utils import PlotlyTestCase + + +@attr('slow') +class TestImage(PlotlyTestCase): + + def setUp(self): + super(TestImage, self).setUp() + py.sign_in('PlotlyImageTest', '786r5mecv0') + self.data = [{'x': [1, 2, 3], 'y': [3, 1, 6]}] + + +def _generate_image_get_returns_valid_image_test(image_format, + width, height, scale): + def test(self): + # TODO: better understand why this intermittently fails. See #649 + num_attempts = 5 + for i in range(num_attempts): + if i > 0: + warnings.warn('image test intermittently failed, retrying...') + try: + image = py.image.get(self.data, image_format, width, height, + scale) + if image_format in ['png', 'jpeg']: + assert imghdr.what('', image) == image_format + return + except (KeyError, _plotly_utils.exceptions.PlotlyError): + if i == num_attempts - 1: + raise + + return test + + +def _generate_image_save_as_saves_valid_image(image_format, + width, height, scale): + def _test(self): + f, filename = tempfile.mkstemp('.{}'.format(image_format)) + py.image.save_as(self.data, filename, format=image_format, + width=width, height=height, scale=scale) + if image_format in ['png', 'jpeg']: + assert imghdr.what(filename) == image_format + else: + assert os.path.getsize(filename) > 0 + + os.remove(filename) + + return _test + +kwargs = { + 'format': ['png', 'jpeg', 'pdf', 'svg', 'emf'], + 'width': [None, 300], + 'height': [None, 300], + 'scale': [None, 5] +} + +for args in itertools.product(kwargs['format'], kwargs['width'], + kwargs['height'], kwargs['scale']): + for test_generator in [_generate_image_get_returns_valid_image_test, + _generate_image_save_as_saves_valid_image]: + + _test = test_generator(*args) + arg_string = ', '.join([str(a) for a in args]) + test_name = test_generator.__name__.replace('_generate', 'test') + test_name += '({})'.format(arg_string) + setattr(TestImage, test_name, _test) diff --git a/chart_studio/tests/test_plot_ly/test_meta/__init__.py b/chart_studio/tests/test_plot_ly/test_meta/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_plot_ly/test_meta/test_meta.py b/chart_studio/tests/test_plot_ly/test_meta/test_meta.py new file mode 100644 index 00000000000..3c8010dded2 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_meta/test_meta.py @@ -0,0 +1,63 @@ +""" +test_meta: +========== + +A module intended for use with Nose. + +""" +from __future__ import absolute_import + +import random +import string + +from nose.plugins.attrib import attr +from unittest import skip + +from chart_studio import plotly as py +from chart_studio.exceptions import PlotlyRequestError +from chart_studio.grid_objs import Column, Grid +from chart_studio.tests.utils import PlotlyTestCase + + +class MetaTest(PlotlyTestCase): + + _grid = grid = Grid([Column([1, 2, 3, 4], 'first column')]) + _meta = {"settings": {"scope1": {"model": "Unicorn Finder", "voltage": 4}}} + + def setUp(self): + super(MetaTest, self).setUp() + py.sign_in('PythonTest', 'xnyU0DEwvAQQCwHVseIL') + + def random_filename(self): + random_chars = [random.choice(string.ascii_uppercase) for _ in range(5)] + unique_filename = 'Valid Grid with Meta '+''.join(random_chars) + return unique_filename + + @attr('slow') + def test_upload_meta(self): + unique_filename = self.random_filename() + grid_url = py.grid_ops.upload(self._grid, unique_filename, + auto_open=False) + + # Add some Metadata to that grid + py.meta_ops.upload(self._meta, grid_url=grid_url) + + @attr('slow') + def test_upload_meta_with_grid(self): + c1 = Column([1, 2, 3, 4], 'first column') + Grid([c1]) + + unique_filename = self.random_filename() + + py.grid_ops.upload( + self._grid, + unique_filename, + meta=self._meta, + auto_open=False) + + @skip('adding this for now so test_file_tools pass, more info' + + 'https://github.com/plotly/python-api/issues/263') + def test_metadata_to_nonexistent_grid(self): + non_exist_meta_url = 'https://local.plot.ly/~GridTest/999999999' + with self.assertRaises(PlotlyRequestError): + py.meta_ops.upload(self._meta, grid_url=non_exist_meta_url) diff --git a/chart_studio/tests/test_plot_ly/test_plotly/__init__.py b/chart_studio/tests/test_plot_ly/test_plotly/__init__.py new file mode 100644 index 00000000000..1118eb01e82 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_plotly/__init__.py @@ -0,0 +1,5 @@ +import warnings + + +def setup_package(): + warnings.filterwarnings('ignore') diff --git a/chart_studio/tests/test_plot_ly/test_plotly/test_credentials.py b/chart_studio/tests/test_plot_ly/test_plotly/test_credentials.py new file mode 100644 index 00000000000..628b047d373 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_plotly/test_credentials.py @@ -0,0 +1,93 @@ +from __future__ import absolute_import + +import _plotly_utils.exceptions +from chart_studio import plotly as py, exceptions +import chart_studio.session as session +import chart_studio.tools as tls +from chart_studio.tests.utils import PlotlyTestCase + +import sys + +# import from mock +if sys.version_info.major == 3 and sys.version_info.minor >= 3: + from unittest.mock import patch +else: + from mock import patch + + +class TestSignIn(PlotlyTestCase): + + def setUp(self): + super(TestSignIn, self).setUp() + patcher = patch('chart_studio.api.v2.users.current') + self.users_current_mock = patcher.start() + self.addCleanup(patcher.stop) + + def test_get_credentials(self): + session_credentials = session.get_session_credentials() + if 'username' in session_credentials: + del session._session['credentials']['username'] + if 'api_key' in session_credentials: + del session._session['credentials']['api_key'] + creds = py.get_credentials() + file_creds = tls.get_credentials_file() + self.assertEqual(creds, file_creds) + + def test_sign_in(self): + un = 'anyone' + ak = 'something' + # TODO, add this! + # si = ['this', 'and-this'] + py.sign_in(un, ak) + creds = py.get_credentials() + self.assertEqual(creds['username'], un) + self.assertEqual(creds['api_key'], ak) + # TODO, and check it! + # assert creds['stream_ids'] == si + + def test_get_config(self): + plotly_domain = 'test domain' + plotly_streaming_domain = 'test streaming domain' + config1 = py.get_config() + session._session['config']['plotly_domain'] = plotly_domain + config2 = py.get_config() + session._session['config']['plotly_streaming_domain'] = ( + plotly_streaming_domain + ) + config3 = py.get_config() + self.assertEqual(config2['plotly_domain'], plotly_domain) + self.assertNotEqual( + config2['plotly_streaming_domain'], plotly_streaming_domain + ) + self.assertEqual( + config3['plotly_streaming_domain'], plotly_streaming_domain + ) + + def test_sign_in_with_config(self): + username = 'place holder' + api_key = 'place holder' + plotly_domain = 'test domain' + plotly_streaming_domain = 'test streaming domain' + plotly_ssl_verification = False + py.sign_in( + username, + api_key, + plotly_domain=plotly_domain, + plotly_streaming_domain=plotly_streaming_domain, + plotly_ssl_verification=plotly_ssl_verification + ) + config = py.get_config() + self.assertEqual(config['plotly_domain'], plotly_domain) + self.assertEqual( + config['plotly_streaming_domain'], plotly_streaming_domain + ) + self.assertEqual( + config['plotly_ssl_verification'], plotly_ssl_verification + ) + + def test_sign_in_cannot_validate(self): + self.users_current_mock.side_effect = exceptions.PlotlyRequestError( + 'msg', 400, 'foobar' + ) + with self.assertRaisesRegexp(_plotly_utils.exceptions.PlotlyError, 'Sign in failed'): + py.sign_in('foo', 'bar') diff --git a/chart_studio/tests/test_plot_ly/test_plotly/test_plot.py b/chart_studio/tests/test_plot_ly/test_plotly/test_plot.py new file mode 100644 index 00000000000..fe6915cbc5d --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_plotly/test_plot.py @@ -0,0 +1,441 @@ +""" +test_plot: +========== + +A module intended for use with Nose. + +""" +from __future__ import absolute_import + +import requests +import six +import sys +from requests.compat import json as _json +import warnings + +from nose.plugins.attrib import attr + +import chart_studio.tools as tls +import plotly.tools +from chart_studio import session +from chart_studio.tests.utils import PlotlyTestCase +from chart_studio.plotly import plotly as py +from _plotly_utils.exceptions import PlotlyError, PlotlyEmptyDataError +from chart_studio.files import CONFIG_FILE + + +# import from mock +if sys.version_info.major == 3 and sys.version_info.minor >= 3: + from unittest.mock import patch +else: + from mock import patch + + +class TestPlot(PlotlyTestCase): + + def setUp(self): + super(TestPlot, self).setUp() + py.sign_in('PlotlyImageTest', '786r5mecv0') + self.simple_figure = {'data': [{'x': [1, 2, 3], 'y': [2, 1, 2]}]} + + @attr('slow') + def test_plot_valid(self): + fig = { + 'data': [ + { + 'x': (1, 2, 3), + 'y': (2, 1, 2) + } + ], + 'layout': {'title': {'text': 'simple'}} + } + url = py.plot(fig, auto_open=False, filename='plot_valid') + saved_fig = py.get_figure(url) + self.assertEqual(saved_fig['data'][0]['x'], fig['data'][0]['x']) + self.assertEqual(saved_fig['data'][0]['y'], fig['data'][0]['y']) + self.assertEqual(saved_fig['layout']['title']['text'], + fig['layout']['title']['text']) + + def test_plot_invalid(self): + fig = { + 'data': [ + { + 'x': [1, 2, 3], + 'y': [2, 1, 2], + 'z': [3, 4, 1] + } + ] + } + with self.assertRaises(ValueError): + py.plot(fig, auto_open=False, filename='plot_invalid') + + def test_plot_invalid_args_1(self): + with self.assertRaises(TypeError): + py.plot(x=[1, 2, 3], y=[2, 1, 2], auto_open=False, + filename='plot_invalid') + + def test_plot_invalid_args_2(self): + with self.assertRaises(ValueError): + py.plot([1, 2, 3], [2, 1, 2], auto_open=False, + filename='plot_invalid') + + def test_plot_empty_data(self): + self.assertRaises(PlotlyEmptyDataError, py.plot, [], + filename='plot_invalid') + + def test_plot_sharing_invalid_argument(self): + + # Raise an error if sharing argument is incorrect + # correct arguments {'public, 'private', 'secret'} + + kwargs = {'filename': 'invalid-sharing-argument', + 'sharing': 'privste'} + + with self.assertRaisesRegexp( + PlotlyError, + "The 'sharing' argument only accepts"): + py.plot(self.simple_figure, **kwargs) + + def test_plot_world_readable_sharing_conflict_1(self): + + # Raise an error if world_readable=False but sharing='public' + + kwargs = {'filename': 'invalid-privacy-setting', + 'world_readable': False, + 'sharing': 'public'} + + with self.assertRaisesRegexp( + PlotlyError, + 'setting your plot privacy to both public and private.'): + py.plot(self.simple_figure, **kwargs) + + def test_plot_world_readable_sharing_conflict_2(self): + + # Raise an error if world_readable=True but sharing='secret' + + kwargs = {'filename': 'invalid-privacy-setting', + 'world_readable': True, + 'sharing': 'secret'} + + with self.assertRaisesRegexp( + PlotlyError, + 'setting your plot privacy to both public and private.'): + py.plot(self.simple_figure, **kwargs) + + def test_plot_option_logic_only_world_readable_given(self): + + # If sharing is not given and world_readable=False, + # sharing should be set to private + + kwargs = {'filename': 'test', + 'auto_open': True, + 'fileopt': 'overwrite', + 'validate': True, + 'world_readable': False} + + plot_option_logic = py._plot_option_logic(kwargs) + + expected_plot_option_logic = {'filename': 'test', + 'auto_open': True, + 'fileopt': 'overwrite', + 'validate': True, + 'world_readable': False, + 'sharing': 'private'} + self.assertEqual(plot_option_logic, expected_plot_option_logic) + + def test_plot_option_logic_only_sharing_given(self): + + # If world_readable is not given and sharing ='private', + # world_readable should be set to False + + kwargs = {'filename': 'test', + 'auto_open': True, + 'fileopt': 'overwrite', + 'validate': True, + 'sharing': 'private'} + + plot_option_logic = py._plot_option_logic(kwargs) + + expected_plot_option_logic = {'filename': 'test', + 'auto_open': True, + 'fileopt': 'overwrite', + 'validate': True, + 'world_readable': False, + 'sharing': 'private'} + self.assertEqual(plot_option_logic, expected_plot_option_logic) + + def test_plot_option_fileopt_deprecations(self): + + # Make sure DeprecationWarnings aren't filtered out by nose + warnings.filterwarnings('default', category=DeprecationWarning) + + # If filename is not given and fileopt is not 'new', + # raise a deprecation warning + kwargs = {'auto_open': True, + 'fileopt': 'overwrite', + 'validate': True, + 'sharing': 'private'} + + with warnings.catch_warnings(record=True) as w: + plot_option_logic = py._plot_option_logic(kwargs) + assert w[0].category == DeprecationWarning + + expected_plot_option_logic = {'filename': 'plot from API', + 'auto_open': True, + 'fileopt': 'overwrite', + 'validate': True, + 'world_readable': False, + 'sharing': 'private'} + self.assertEqual(plot_option_logic, expected_plot_option_logic) + + # If filename is given and fileopt is not 'overwrite', + # raise a depreacation warning + kwargs = {'filename': 'test', + 'auto_open': True, + 'fileopt': 'append', + 'validate': True, + 'sharing': 'private'} + + with warnings.catch_warnings(record=True) as w: + plot_option_logic = py._plot_option_logic(kwargs) + assert w[0].category == DeprecationWarning + + expected_plot_option_logic = {'filename': 'test', + 'auto_open': True, + 'fileopt': 'append', + 'validate': True, + 'world_readable': False, + 'sharing': 'private'} + self.assertEqual(plot_option_logic, expected_plot_option_logic) + + @attr('slow') + def test_plot_url_given_sharing_key(self): + + # Give share_key is requested, the retun url should contain + # the share_key + + validate = True + fig = plotly.tools.return_figure_from_figure_or_data(self.simple_figure, + validate) + kwargs = {'filename': 'is_share_key_included', + 'fileopt': 'overwrite', + 'world_readable': False, + 'sharing': 'secret'} + response = py._send_to_plotly(fig, **kwargs) + plot_url = response['url'] + + self.assertTrue('share_key=' in plot_url) + + @attr('slow') + def test_plot_url_response_given_sharing_key(self): + + # Given share_key is requested, get request of the url should + # be 200 + + kwargs = {'filename': 'is_share_key_included', + 'fileopt': 'overwrite', + 'auto_open': False, + 'world_readable': False, + 'sharing': 'secret'} + + plot_url = py.plot(self.simple_figure, **kwargs) + # shareplot basically always gives a 200 if even if permission denied + # embedplot returns an actual 404 + embed_url = plot_url.split('?')[0] + '.embed?' + plot_url.split('?')[1] + response = requests.get(embed_url) + + self.assertEqual(response.status_code, 200) + + @attr('slow') + def test_private_plot_response_with_and_without_share_key(self): + + # The json file of the private plot should be 404 and once + # share_key is added it should be 200 + + kwargs = {'filename': 'is_share_key_included', + 'fileopt': 'overwrite', + 'world_readable': False, + 'sharing': 'private'} + + private_plot_url = py._send_to_plotly(self.simple_figure, + **kwargs)['url'] + private_plot_response = requests.get(private_plot_url + ".json") + + # The json file of the private plot should be 404 + self.assertEqual(private_plot_response.status_code, 404) + + secret_plot_url = py.add_share_key_to_url(private_plot_url) + urlsplit = six.moves.urllib.parse.urlparse(secret_plot_url) + secret_plot_json_file = six.moves.urllib.parse.urljoin( + urlsplit.geturl(), "?.json" + urlsplit.query) + secret_plot_response = requests.get(secret_plot_json_file) + + # The json file of the secret plot should be 200 + self.assertTrue(secret_plot_response.status_code, 200) + + +class TestPlotOptionLogic(PlotlyTestCase): + conflicting_option_set = ( + {'world_readable': True, 'sharing': 'secret'}, + {'world_readable': True, 'sharing': 'private'}, + {'world_readable': False, 'sharing': 'public'} + ) + + def setUp(self): + super(TestPlotOptionLogic, self).setUp() + + # Make sure we don't hit sign-in validation failures. + patcher = patch('chart_studio.api.v2.users.current') + self.users_current_mock = patcher.start() + self.addCleanup(patcher.stop) + + # Some tests specifically check how *file-level* plot options alter + # plot option logic. In order not to re-write that, we simply clear the + # *session* information since it would take precedent. The _session is + # set when you `sign_in`. + session._session['plot_options'].clear() + + def test_default_options(self): + options = py._plot_option_logic({}) + config_options = tls.get_config_file() + for key in options: + if key != 'fileopt' and key in config_options: + self.assertEqual(options[key], config_options[key]) + + def test_conflicting_plot_options_in_plot_option_logic(self): + for plot_options in self.conflicting_option_set: + self.assertRaises(PlotlyError, py._plot_option_logic, + plot_options) + + def test_set_config_updates_plot_options(self): + original_config = tls.get_config_file() + new_options = { + 'world_readable': not original_config['world_readable'], + 'auto_open': not original_config['auto_open'], + 'sharing': ('public' if original_config['world_readable'] is False + else 'secret') + } + tls.set_config_file(**new_options) + options = py._plot_option_logic({}) + for key in new_options: + self.assertEqual(new_options[key], options[key]) + + +def generate_conflicting_plot_options_in_signin(): + """sign_in overrides the default plot options. + conflicting options aren't raised until plot or iplot is called, + through _plot_option_logic + """ + def gen_test(plot_options): + def test(self): + py.sign_in('username', 'key', **plot_options) + self.assertRaises(PlotlyError, py._plot_option_logic, {}) + return test + + for i, plot_options in enumerate(TestPlotOptionLogic.conflicting_option_set): + setattr(TestPlotOptionLogic, + 'test_conflicting_plot_options_in_signin_{}'.format(i), + gen_test(plot_options)) +generate_conflicting_plot_options_in_signin() + + +def generate_conflicting_plot_options_in_tools_dot_set_config(): + """tls.set_config overrides the default plot options. + conflicting options are actually raised when the options are saved, + because we push out default arguments for folks, and we don't want to + require users to specify both world_readable and secret *and* we don't + want to raise an error if they specified only one of these options + and didn't know that a default option was being saved for them. + """ + def gen_test(plot_options): + def test(self): + self.assertRaises(PlotlyError, tls.set_config_file, + **plot_options) + return test + + for i, plot_options in enumerate(TestPlotOptionLogic.conflicting_option_set): + setattr(TestPlotOptionLogic, + 'test_conflicting_plot_options_in_' + 'tools_dot_set_config{}'.format(i), + gen_test(plot_options)) +generate_conflicting_plot_options_in_tools_dot_set_config() + + +def generate_conflicting_plot_options_with_json_writes_of_config(): + """ if the user wrote their own options in the config file, + then we'll raise the error when the call plot or iplot through + _plot_option_logic + """ + def gen_test(plot_options): + def test(self): + config = _json.load(open(CONFIG_FILE)) + with open(CONFIG_FILE, 'w') as f: + config.update(plot_options) + f.write(_json.dumps(config)) + self.assertRaises(PlotlyError, py._plot_option_logic, {}) + return test + + for i, plot_options in enumerate(TestPlotOptionLogic.conflicting_option_set): + setattr(TestPlotOptionLogic, + 'test_conflicting_plot_options_with_' + 'json_writes_of_config{}'.format(i), + gen_test(plot_options)) +generate_conflicting_plot_options_with_json_writes_of_config() + + +def generate_private_sharing_and_public_world_readable_precedence(): + """ Test that call signature arguments applied through _plot_option_logic + overwrite options supplied through py.sign_in which overwrite options + set through tls.set_config + """ + plot_option_sets = ( + { + 'parent': {'world_readable': True, 'auto_open': False}, + 'child': {'sharing': 'secret', 'auto_open': True}, + 'expected_output': {'world_readable': False, + 'sharing': 'secret', + 'auto_open': True} + }, + { + 'parent': {'world_readable': True, 'auto_open': True}, + 'child': {'sharing': 'private', 'auto_open': False}, + 'expected_output': {'world_readable': False, + 'sharing': 'private', + 'auto_open': False} + }, + { + 'parent': {'world_readable': False, 'auto_open': False}, + 'child': {'sharing': 'public', 'auto_open': True}, + 'expected_output': {'world_readable': True, + 'sharing': 'public', + 'auto_open': True} + } + ) + + def gen_test_signin(plot_options): + def test(self): + py.sign_in('username', 'key', **plot_options['parent']) + options = py._plot_option_logic(plot_options['child']) + for option, value in plot_options['expected_output'].items(): + self.assertEqual(options[option], value) + return test + + def gen_test_config(plot_options): + def test(self): + tls.set_config(**plot_options['parent']) + options = py._plot_option_logic(plot_options['child']) + for option, value in plot_options['expected_output'].items(): + self.assertEqual(options[option], value) + + for i, plot_options in enumerate(plot_option_sets): + setattr(TestPlotOptionLogic, + 'test_private_sharing_and_public_' + 'world_readable_precedence_signin{}'.format(i), + gen_test_signin(plot_options)) + + setattr(TestPlotOptionLogic, + 'test_private_sharing_and_public_' + 'world_readable_precedence_config{}'.format(i), + gen_test_config(plot_options)) + +generate_private_sharing_and_public_world_readable_precedence() diff --git a/chart_studio/tests/test_plot_ly/test_session/__init__.py b/chart_studio/tests/test_plot_ly/test_session/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_plot_ly/test_session/test_session.py b/chart_studio/tests/test_plot_ly/test_session/test_session.py new file mode 100644 index 00000000000..ae1c6a67c57 --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_session/test_session.py @@ -0,0 +1,34 @@ +from __future__ import absolute_import + +from chart_studio.tests.utils import PlotlyTestCase + +from chart_studio import session +from chart_studio.session import update_session_plot_options, SHARING_OPTIONS +from _plotly_utils.exceptions import PlotlyError + + +class TestSession(PlotlyTestCase): + + def setUp(self): + super(TestSession, self).setUp() + session._session['plot_options'].clear() + + def test_update_session_plot_options_invalid_sharing_argument(self): + + # Return PlotlyError when sharing arguement is not + # 'public', 'private' or 'secret' + + kwargs = {'sharing': 'priva'} + self.assertRaises(PlotlyError, update_session_plot_options, **kwargs) + + def test_update_session_plot_options_valid_sharing_argument(self): + + # _session['plot_options'] should contain sharing key after + # update_session_plot_options is called by correct arguments + # 'public, 'private' or 'secret' + from chart_studio.session import _session + for key in SHARING_OPTIONS: + kwargs = {'sharing': key} + update_session_plot_options(**kwargs) + + self.assertEqual(_session['plot_options'], kwargs) diff --git a/chart_studio/tests/test_plot_ly/test_spectacle_presentation/__init__.py b/chart_studio/tests/test_plot_ly/test_spectacle_presentation/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_plot_ly/test_spectacle_presentation/test_spectacle_presentation.py b/chart_studio/tests/test_plot_ly/test_spectacle_presentation/test_spectacle_presentation.py new file mode 100644 index 00000000000..b1f9431783c --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_spectacle_presentation/test_spectacle_presentation.py @@ -0,0 +1,363 @@ +""" +test_spectacle_presentation: +========== + +A module intended for use with Nose. + +""" +from __future__ import absolute_import + +from unittest import TestCase +from _plotly_utils.exceptions import PlotlyError +import chart_studio +import chart_studio.presentation_objs as pres + + +class TestPresentation(TestCase): + + def test_invalid_style(self): + markdown_string = """ + # one slide + """ + + self.assertRaisesRegexp( + PlotlyError, chart_studio.presentation_objs.presentation_objs.STYLE_ERROR, + pres.Presentation, markdown_string, style='foo' + ) + + def test_open_code_block(self): + markdown_string = """ + # one slide + + ```python + x = 2 + 2 + print x + """ + + self.assertRaisesRegexp( + PlotlyError, chart_studio.presentation_objs.presentation_objs.CODE_ENV_ERROR, + pres.Presentation, markdown_string, style='moods' + ) + + def test_invalid_code_language(self): + markdown_string = """ + ```foo + x = 2 + 2 + print x + ``` + """ + + self.assertRaisesRegexp( + PlotlyError, chart_studio.presentation_objs.presentation_objs.LANG_ERROR, pres.Presentation, + markdown_string, style='moods' + ) + + def test_expected_pres(self): + markdown_string = "# title\n---\ntransition: zoom, fade, fade\n# Colors\nColors are everywhere around us.\nPlotly(https://plot.ly/~AdamKulidjian/3564/)\nImage(https://raw.githubusercontent.com/jackparmer/gradient-backgrounds/master/moods1.png)\n```python\nx=1\n```\n---\nPlotly(https://plot.ly/~AdamKulidjian/3564/)\nPlotly(https://plot.ly/~AdamKulidjian/3564/)\nPlotly(https://plot.ly/~AdamKulidjian/3564/)\nPlotly(https://plot.ly/~AdamKulidjian/3564/)\nPlotly(https://plot.ly/~AdamKulidjian/3564/)\nPlotly(https://plot.ly/~AdamKulidjian/3564/)\nPlotly(https://plot.ly/~AdamKulidjian/3564/)\n---\n" + + my_pres = pres.Presentation( + markdown_string, style='moods', imgStretch=True + ) + + exp_pres = {'presentation': {'paragraphStyles': {'Body': {'color': '#000016', + 'fontFamily': 'Roboto', + 'fontSize': 16, + 'fontStyle': 'normal', + 'fontWeight': 100, + 'lineHeight': 'normal', + 'minWidth': 20, + 'opacity': 1, + 'textAlign': 'center', + 'textDecoration': 'none', + 'wordBreak': 'break-word'}, + 'Body Small': {'color': '#3d3d3d', + 'fontFamily': 'Open Sans', + 'fontSize': 10, + 'fontStyle': 'normal', + 'fontWeight': 400, + 'lineHeight': 'normal', + 'minWidth': 20, + 'opacity': 1, + 'textAlign': 'center', + 'textDecoration': 'none'}, + 'Caption': {'color': '#3d3d3d', + 'fontFamily': 'Open Sans', + 'fontSize': 11, + 'fontStyle': 'italic', + 'fontWeight': 400, + 'lineHeight': 'normal', + 'minWidth': 20, + 'opacity': 1, + 'textAlign': 'center', + 'textDecoration': 'none'}, + 'Heading 1': {'color': '#000016', + 'fontFamily': 'Roboto', + 'fontSize': 55, + 'fontStyle': 'normal', + 'fontWeight': 900, + 'lineHeight': 'normal', + 'minWidth': 20, + 'opacity': 1, + 'textAlign': 'center', + 'textDecoration': 'none'}, + 'Heading 2': {'color': '#000016', + 'fontFamily': 'Roboto', + 'fontSize': 36, + 'fontStyle': 'normal', + 'fontWeight': 900, + 'lineHeight': 'normal', + 'minWidth': 20, + 'opacity': 1, + 'textAlign': 'center', + 'textDecoration': 'none'}, + 'Heading 3': {'color': '#000016', + 'fontFamily': 'Roboto', + 'fontSize': 30, + 'fontStyle': 'normal', + 'fontWeight': 900, + 'lineHeight': 'normal', + 'minWidth': 20, + 'opacity': 1, + 'textAlign': 'center', + 'textDecoration': 'none'}}, + 'slidePreviews': [None for _ in range(496)], + 'slides': [{'children': [{'children': ['title'], + 'defaultHeight': 36, + 'defaultWidth': 52, + 'id': 'CfaAzcSZE', + 'props': {'isQuote': False, + 'listType': None, + 'paragraphStyle': 'Heading 1', + 'size': 4, + 'style': {'color': '#000016', + 'fontFamily': 'Roboto', + 'fontSize': 55, + 'fontStyle': 'normal', + 'fontWeight': 900, + 'height': 140.0, + 'left': 0.0, + 'lineHeight': 'normal', + 'minWidth': 20, + 'opacity': 1, + 'position': 'absolute', + 'textAlign': 'center', + 'textDecoration': 'none', + 'top': 350.0, + 'width': 1000.0}}, + 'resizeVertical': False, + 'type': 'Text'}], + 'id': 'ibvfOQeNy', + 'props': {'style': {'backgroundColor': '#F7F7F7'}, + 'transition': ['slide']}}, + {'children': [{'children': ['Colors'], + 'defaultHeight': 36, + 'defaultWidth': 52, + 'id': 'YcGQJ21AY', + 'props': {'isQuote': False, + 'listType': None, + 'paragraphStyle': 'Heading 1', + 'size': 4, + 'style': {'color': '#000016', + 'fontFamily': 'Roboto', + 'fontSize': 55, + 'fontStyle': 'normal', + 'fontWeight': 900, + 'height': 140.0, + 'left': 0.0, + 'lineHeight': 'normal', + 'minWidth': 20, + 'opacity': 1, + 'position': 'absolute', + 'textAlign': 'center', + 'textDecoration': 'none', + 'top': 0.0, + 'width': 1000.0}}, + 'resizeVertical': False, + 'type': 'Text'}, + {'children': ['Colors are everywhere around us.'], + 'defaultHeight': 36, + 'defaultWidth': 52, + 'id': 'G0tcGP89U', + 'props': {'isQuote': False, + 'listType': None, + 'paragraphStyle': 'Body', + 'size': 4, + 'style': {'color': '#000016', + 'fontFamily': 'Roboto', + 'fontSize': 16, + 'fontStyle': 'normal', + 'fontWeight': 100, + 'height': 14.0, + 'left': 25.0, + 'lineHeight': 'normal', + 'minWidth': 20, + 'opacity': 1, + 'position': 'absolute', + 'textAlign': 'left', + 'textDecoration': 'none', + 'top': 663.0810810810812, + 'width': 950.0000000000001, + 'wordBreak': 'break-word'}}, + 'resizeVertical': False, + 'type': 'Text'}, + {'children': [], + 'id': 'c4scRvuIe', + 'props': {'frameBorder': 0, + 'scrolling': 'no', + 'src': 'https://plot.ly/~AdamKulidjian/3564/.embed?link=false', + 'style': {'height': 280.0, + 'left': 0.0, + 'position': 'absolute', + 'top': 70.0, + 'width': 330.66666666666663}}, + 'type': 'Plotly'}, + {'children': [], + 'id': 'yScDKejKG', + 'props': {'height': 512, + 'imageName': None, + 'src': 'https://raw.githubusercontent.com/jackparmer/gradient-backgrounds/master/moods1.png', + 'style': {'height': 280.0, + 'left': 334.66666666666663, + 'opacity': 1, + 'position': 'absolute', + 'top': 70.0, + 'width': 330.66666666666663}, + 'width': 512}, + 'type': 'Image'}, + {'children': [], + 'defaultText': 'Code', + 'id': 'fuUrIyVrv', + 'props': {'language': 'python', + 'source': 'x=1\n', + 'style': {'fontFamily': "Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace", + 'fontSize': 13, + 'height': 280.0, + 'left': 669.3333333333333, + 'margin': 0, + 'position': 'absolute', + 'textAlign': 'left', + 'top': 70.0, + 'width': 330.66666666666663}, + 'theme': 'tomorrowNight'}, + 'type': 'CodePane'}], + 'id': '7eG6TvKqU', + 'props': {'style': {'backgroundColor': '#FFFFFF'}, + 'transition': ['zoom', 'fade']}}, + {'children': [{'children': [], + 'id': '83EtFjFKM', + 'props': {'frameBorder': 0, + 'scrolling': 'no', + 'src': 'https://plot.ly/~AdamKulidjian/3564/.embed?link=false', + 'style': {'height': 96.57142857142857, + 'left': 400.0, + 'position': 'absolute', + 'top': 0.0, + 'width': 600.0}}, + 'type': 'Plotly'}, + {'children': [], + 'id': 'V9vJYk8bF', + 'props': {'frameBorder': 0, + 'scrolling': 'no', + 'src': 'https://plot.ly/~AdamKulidjian/3564/.embed?link=false', + 'style': {'height': 96.57142857142857, + 'left': 400.0, + 'position': 'absolute', + 'top': 100.57142857142856, + 'width': 600.0}}, + 'type': 'Plotly'}, + {'children': [], + 'id': 'DzCfXMyhv', + 'props': {'frameBorder': 0, + 'scrolling': 'no', + 'src': 'https://plot.ly/~AdamKulidjian/3564/.embed?link=false', + 'style': {'height': 96.57142857142857, + 'left': 400.0, + 'position': 'absolute', + 'top': 201.1428571428571, + 'width': 600.0}}, + 'type': 'Plotly'}, + {'children': [], + 'id': 'YFf7M2BON', + 'props': {'frameBorder': 0, + 'scrolling': 'no', + 'src': 'https://plot.ly/~AdamKulidjian/3564/.embed?link=false', + 'style': {'height': 96.57142857142857, + 'left': 400.0, + 'position': 'absolute', + 'top': 301.71428571428567, + 'width': 600.0}}, + 'type': 'Plotly'}, + {'children': [], + 'id': 'CARvApdzw', + 'props': {'frameBorder': 0, + 'scrolling': 'no', + 'src': 'https://plot.ly/~AdamKulidjian/3564/.embed?link=false', + 'style': {'height': 96.57142857142857, + 'left': 400.0, + 'position': 'absolute', + 'top': 402.2857142857142, + 'width': 600.0}}, + 'type': 'Plotly'}, + {'children': [], + 'id': '194ZxaSko', + 'props': {'frameBorder': 0, + 'scrolling': 'no', + 'src': 'https://plot.ly/~AdamKulidjian/3564/.embed?link=false', + 'style': {'height': 96.57142857142857, + 'left': 400.0, + 'position': 'absolute', + 'top': 502.85714285714283, + 'width': 600.0}}, + 'type': 'Plotly'}, + {'children': [], + 'id': 'SOwRH1rLV', + 'props': {'frameBorder': 0, + 'scrolling': 'no', + 'src': 'https://plot.ly/~AdamKulidjian/3564/.embed?link=false', + 'style': {'height': 96.57142857142857, + 'left': 400.0, + 'position': 'absolute', + 'top': 603.4285714285713, + 'width': 600.0}}, + 'type': 'Plotly'}], + 'id': 'S6VmZlI5Q', + 'props': {'style': {'backgroundColor': '#FFFFFF'}, + 'transition': ['slide']}}], + 'version': '0.1.3'}} + + for k in ['version', 'paragraphStyles', 'slidePreviews']: + self.assertEqual( + my_pres['presentation'][k], + exp_pres['presentation'][k] + ) + + self.assertEqual( + len(my_pres['presentation']['slides']), + len(exp_pres['presentation']['slides']) + ) + + for slide_idx in range(len(my_pres['presentation']['slides'])): + childs = my_pres['presentation']['slides'][slide_idx]['children'] + # transitions and background color + self.assertEqual( + my_pres['presentation']['slides'][slide_idx]['props'], + exp_pres['presentation']['slides'][slide_idx]['props'] + ) + for child_idx in range(len(childs)): + # check urls + if (my_pres['presentation']['slides'][slide_idx]['children'] + [child_idx]['type'] in ['Image', 'Plotly']): + self.assertEqual( + (my_pres['presentation']['slides'][slide_idx] + ['children'][child_idx]['props']), + (exp_pres['presentation']['slides'][slide_idx] + ['children'][child_idx]['props']) + ) + + # styles in children + self.assertEqual( + (my_pres['presentation']['slides'][slide_idx] + ['children'][child_idx]['props']), + (exp_pres['presentation']['slides'][slide_idx] + ['children'][child_idx]['props']) + ) diff --git a/chart_studio/tests/test_plot_ly/test_stream/__init__.py b/chart_studio/tests/test_plot_ly/test_stream/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/chart_studio/tests/test_plot_ly/test_stream/test_stream.py b/chart_studio/tests/test_plot_ly/test_stream/test_stream.py new file mode 100644 index 00000000000..7d7aac7670a --- /dev/null +++ b/chart_studio/tests/test_plot_ly/test_stream/test_stream.py @@ -0,0 +1,166 @@ +""" +Streaming tests. + +""" +from __future__ import absolute_import + +import time + +from nose.plugins.attrib import attr + +from chart_studio import plotly as py +from plotly.graph_objs import (Layout, Scatter, Stream) +from chart_studio.tests.utils import PlotlyTestCase + +un = 'PythonAPI' +ak = 'ubpiol2cve' +tk = 'vaia8trjjb' +config = {'plotly_domain': 'https://plot.ly', + 'plotly_streaming_domain': 'stream.plot.ly', + 'plotly_api_domain': 'https://api.plot.ly', + 'plotly_ssl_verification': False} + + +class TestStreaming(PlotlyTestCase): + + def setUp(self): + super(TestStreaming, self).setUp() + py.sign_in(un, ak, **config) + + #@attr('slow') + def test_initialize_stream_plot(self): + py.sign_in(un, ak) + stream = Stream(token=tk, maxpoints=50) + url = py.plot([Scatter(x=[], y=[], mode='markers', stream=stream)], + auto_open=False, + world_readable=True, + filename='stream-test') + assert url == 'https://plot.ly/~PythonAPI/461' + time.sleep(.5) + + @attr('slow') + def test_stream_single_points(self): + py.sign_in(un, ak) + stream = Stream(token=tk, maxpoints=50) + res = py.plot([Scatter(x=[], y=[], mode='markers', stream=stream)], + auto_open=False, + world_readable=True, + filename='stream-test') + time.sleep(.5) + my_stream = py.Stream(tk) + my_stream.open() + my_stream.write(Scatter(x=[1], y=[10])) + time.sleep(.5) + my_stream.close() + + @attr('slow') + def test_stream_multiple_points(self): + py.sign_in(un, ak) + stream = Stream(token=tk, maxpoints=50) + url = py.plot([Scatter(x=[], y=[], mode='markers', stream=stream)], + auto_open=False, + world_readable=True, + filename='stream-test') + time.sleep(.5) + my_stream = py.Stream(tk) + my_stream.open() + my_stream.write(Scatter(x=[1, 2, 3, 4], y=[2, 1, 2, 5])) + time.sleep(.5) + my_stream.close() + + @attr('slow') + def test_stream_layout(self): + py.sign_in(un, ak) + stream = Stream(token=tk, maxpoints=50) + url = py.plot([Scatter(x=[], y=[], mode='markers', stream=stream)], + auto_open=False, + world_readable=True, + filename='stream-test') + time.sleep(.5) + title_0 = "some title i picked first" + title_1 = "this other title i picked second" + my_stream = py.Stream(tk) + my_stream.open() + my_stream.write(Scatter(x=[1], y=[10]), layout=Layout(title=title_0)) + time.sleep(.5) + my_stream.close() + my_stream.open() + my_stream.write(Scatter(x=[1], y=[10]), layout=Layout(title=title_1)) + my_stream.close() + + @attr('slow') + def test_stream_unstreamable(self): + + # even though `name` isn't streamable, we don't validate it --> pass + + py.sign_in(un, ak) + my_stream = py.Stream(tk) + my_stream.open() + my_stream.write(Scatter(x=[1], y=[10], name='nope')) + my_stream.close() + + def test_stream_no_scheme(self): + + # If no scheme is used in the plotly_streaming_domain, port 80 + # should be used for streaming and ssl_enabled should be False + + py.sign_in(un, ak, **{'plotly_streaming_domain': 'stream.plot.ly'}) + my_stream = py.Stream(tk) + expected_streaming_specs = { + 'server': 'stream.plot.ly', + 'port': 80, + 'ssl_enabled': False, + 'ssl_verification_enabled': False, + 'headers': { + 'Host': 'stream.plot.ly', + 'plotly-streamtoken': tk + } + } + actual_streaming_specs = my_stream.get_streaming_specs() + self.assertEqual(expected_streaming_specs, actual_streaming_specs) + + def test_stream_http(self): + + # If the http scheme is used in the plotly_streaming_domain, port 80 + # should be used for streaming and ssl_enabled should be False + + py.sign_in(un, ak, + **{'plotly_streaming_domain': 'http://stream.plot.ly'}) + my_stream = py.Stream(tk) + expected_streaming_specs = { + 'server': 'stream.plot.ly', + 'port': 80, + 'ssl_enabled': False, + 'ssl_verification_enabled': False, + 'headers': { + 'Host': 'stream.plot.ly', + 'plotly-streamtoken': tk + } + } + actual_streaming_specs = my_stream.get_streaming_specs() + self.assertEqual(expected_streaming_specs, actual_streaming_specs) + + def test_stream_https(self): + + # If the https scheme is used in the plotly_streaming_domain, port 443 + # should be used for streaming, ssl_enabled should be True, + # and ssl_verification_enabled should equal plotly_ssl_verification + + ssl_stream_config = { + 'plotly_streaming_domain': 'https://stream.plot.ly', + 'plotly_ssl_verification': True + } + py.sign_in(un, ak, **ssl_stream_config) + my_stream = py.Stream(tk) + expected_streaming_specs = { + 'server': 'stream.plot.ly', + 'port': 443, + 'ssl_enabled': True, + 'ssl_verification_enabled': True, + 'headers': { + 'Host': 'stream.plot.ly', + 'plotly-streamtoken': tk + } + } + actual_streaming_specs = my_stream.get_streaming_specs() + self.assertEqual(expected_streaming_specs, actual_streaming_specs) diff --git a/chart_studio/tests/utils.py b/chart_studio/tests/utils.py new file mode 100644 index 00000000000..b840cc3699f --- /dev/null +++ b/chart_studio/tests/utils.py @@ -0,0 +1,52 @@ +import copy +from unittest import TestCase + +from chart_studio import session, files, utils +from plotly.files import ensure_writable_plotly_dir + +class PlotlyTestCase(TestCase): + + # parent test case to assist with clean up of local credentials/config + + def __init__(self, *args, **kwargs): + self._credentials = None + self._config = None + self._graph_reference = None + self._session = None + super(PlotlyTestCase, self).__init__(*args, **kwargs) + + @classmethod + def setUpClass(cls): + session._session = { + 'credentials': {}, + 'config': {}, + 'plot_options': {} + } + + def setUp(self): + self.stash_session() + self.stash_files() + defaults = dict(files.FILE_CONTENT[files.CREDENTIALS_FILE], + **files.FILE_CONTENT[files.CONFIG_FILE]) + session.sign_in(**defaults) + + def tearDown(self): + self.restore_files() + self.restore_session() + + def stash_files(self): + self._credentials = utils.load_json_dict(files.CREDENTIALS_FILE) + self._config = utils.load_json_dict(files.CONFIG_FILE) + + def restore_files(self): + if self._credentials and ensure_writable_plotly_dir(): + utils.save_json_dict(files.CREDENTIALS_FILE, self._credentials) + if self._config and ensure_writable_plotly_dir(): + utils.save_json_dict(files.CONFIG_FILE, self._config) + + def stash_session(self): + self._session = copy.deepcopy(session._session) + + def restore_session(self): + session._session.clear() # clear and update to preserve references. + session._session.update(self._session) \ No newline at end of file diff --git a/chart_studio/tools.py b/chart_studio/tools.py new file mode 100644 index 00000000000..d04a23c3ea1 --- /dev/null +++ b/chart_studio/tools.py @@ -0,0 +1,399 @@ +# -*- coding: utf-8 -*- + +""" +tools +===== + +Functions that USERS will possibly want access to. + +""" +from __future__ import absolute_import + +import warnings + +import six +import copy + +from _plotly_utils import optional_imports +import _plotly_utils.exceptions +from _plotly_utils.files import ensure_writable_plotly_dir + +from chart_studio import session, utils +from chart_studio.files import CONFIG_FILE, CREDENTIALS_FILE, FILE_CONTENT + +ipython_core_display = optional_imports.get_module('IPython.core.display') +sage_salvus = optional_imports.get_module('sage_salvus') + + +def get_config_defaults(): + """ + Convenience function to check current settings against defaults. + + Example: + + if plotly_domain != get_config_defaults()['plotly_domain']: + # do something + + """ + return dict(FILE_CONTENT[CONFIG_FILE]) # performs a shallow copy + + +def ensure_local_plotly_files(): + """Ensure that filesystem is setup/filled out in a valid way. + If the config or credential files aren't filled out, then write them + to the disk. + """ + if ensure_writable_plotly_dir(): + for fn in [CREDENTIALS_FILE, CONFIG_FILE]: + utils.ensure_file_exists(fn) + contents = utils.load_json_dict(fn) + contents_orig = contents.copy() + for key, val in list(FILE_CONTENT[fn].items()): + # TODO: removed type checking below, may want to revisit + if key not in contents: + contents[key] = val + contents_keys = list(contents.keys()) + for key in contents_keys: + if key not in FILE_CONTENT[fn]: + del contents[key] + # save only if contents has changed. + # This is to avoid .credentials or .config file to be overwritten randomly, + # which we constantly keep experiencing + # (sync issues? the file might be locked for writing by other process in file._permissions) + if contents_orig.keys() != contents.keys(): + utils.save_json_dict(fn, contents) + + else: + warnings.warn("Looks like you don't have 'read-write' permission to " + "your 'home' ('~') directory or to our '~/.plotly' " + "directory. That means plotly's python api can't setup " + "local configuration files. No problem though! You'll " + "just have to sign-in using 'plotly.plotly.sign_in()'. " + "For help with that: 'help(plotly.plotly.sign_in)'." + "\nQuestions? Visit https://support.plot.ly") + + +### credentials tools ### + +def set_credentials_file(username=None, + api_key=None, + stream_ids=None, + proxy_username=None, + proxy_password=None): + """Set the keyword-value pairs in `~/.plotly_credentials`. + + :param (str) username: The username you'd use to sign in to Plotly + :param (str) api_key: The api key associated with above username + :param (list) stream_ids: Stream tokens for above credentials + :param (str) proxy_username: The un associated with with your Proxy + :param (str) proxy_password: The pw associated with your Proxy un + + """ + if not ensure_writable_plotly_dir(): + raise _plotly_utils.exceptions.PlotlyError("You don't have proper file permissions " + "to run this function.") + ensure_local_plotly_files() # make sure what's there is OK + credentials = get_credentials_file() + if isinstance(username, six.string_types): + credentials['username'] = username + if isinstance(api_key, six.string_types): + credentials['api_key'] = api_key + if isinstance(proxy_username, six.string_types): + credentials['proxy_username'] = proxy_username + if isinstance(proxy_password, six.string_types): + credentials['proxy_password'] = proxy_password + if isinstance(stream_ids, (list, tuple)): + credentials['stream_ids'] = stream_ids + utils.save_json_dict(CREDENTIALS_FILE, credentials) + ensure_local_plotly_files() # make sure what we just put there is OK + + +def get_credentials_file(*args): + """Return specified args from `~/.plotly_credentials`. as dict. + + Returns all if no arguments are specified. + + Example: + get_credentials_file('username') + + """ + # Read credentials from file if possible + credentials = utils.load_json_dict(CREDENTIALS_FILE, *args) + if not credentials: + # Credentials could not be read, use defaults + credentials = copy.copy(FILE_CONTENT[CREDENTIALS_FILE]) + + return credentials + + +def reset_credentials_file(): + ensure_local_plotly_files() # make sure what's there is OK + utils.save_json_dict(CREDENTIALS_FILE, {}) + ensure_local_plotly_files() # put the defaults back + + +### config tools ### + +def set_config_file(plotly_domain=None, + plotly_streaming_domain=None, + plotly_api_domain=None, + plotly_ssl_verification=None, + plotly_proxy_authorization=None, + world_readable=None, + sharing=None, + auto_open=None): + """Set the keyword-value pairs in `~/.plotly/.config`. + + :param (str) plotly_domain: ex - https://plot.ly + :param (str) plotly_streaming_domain: ex - stream.plot.ly + :param (str) plotly_api_domain: ex - https://api.plot.ly + :param (bool) plotly_ssl_verification: True = verify, False = don't verify + :param (bool) plotly_proxy_authorization: True = use plotly proxy auth creds + :param (bool) world_readable: True = public, False = private + + """ + if not ensure_writable_plotly_dir(): + raise _plotly_utils.exceptions.PlotlyError("You don't have proper file permissions " + "to run this function.") + ensure_local_plotly_files() # make sure what's there is OK + utils.validate_world_readable_and_sharing_settings({ + 'sharing': sharing, 'world_readable': world_readable}) + + settings = get_config_file() + if isinstance(plotly_domain, six.string_types): + settings['plotly_domain'] = plotly_domain + elif plotly_domain is not None: + raise TypeError('plotly_domain should be a string') + if isinstance(plotly_streaming_domain, six.string_types): + settings['plotly_streaming_domain'] = plotly_streaming_domain + elif plotly_streaming_domain is not None: + raise TypeError('plotly_streaming_domain should be a string') + if isinstance(plotly_api_domain, six.string_types): + settings['plotly_api_domain'] = plotly_api_domain + elif plotly_api_domain is not None: + raise TypeError('plotly_api_domain should be a string') + if isinstance(plotly_ssl_verification, (six.string_types, bool)): + settings['plotly_ssl_verification'] = plotly_ssl_verification + elif plotly_ssl_verification is not None: + raise TypeError('plotly_ssl_verification should be a boolean') + if isinstance(plotly_proxy_authorization, (six.string_types, bool)): + settings['plotly_proxy_authorization'] = plotly_proxy_authorization + elif plotly_proxy_authorization is not None: + raise TypeError('plotly_proxy_authorization should be a boolean') + if isinstance(auto_open, bool): + settings['auto_open'] = auto_open + elif auto_open is not None: + raise TypeError('auto_open should be a boolean') + + # validate plotly_domain and plotly_api_domain + utils.validate_plotly_domains( + {'plotly_domain': plotly_domain, 'plotly_api_domain': plotly_api_domain} + ) + + if isinstance(world_readable, bool): + settings['world_readable'] = world_readable + settings.pop('sharing') + elif world_readable is not None: + raise TypeError('Input should be a boolean') + if isinstance(sharing, six.string_types): + settings['sharing'] = sharing + elif sharing is not None: + raise TypeError('sharing should be a string') + utils.set_sharing_and_world_readable(settings) + + utils.save_json_dict(CONFIG_FILE, settings) + ensure_local_plotly_files() # make sure what we just put there is OK + + +def get_config_file(*args): + """Return specified args from `~/.plotly/.config`. as tuple. + + Returns all if no arguments are specified. + + Example: + get_config_file('plotly_domain') + + """ + # Read config from file if possible + config = utils.load_json_dict(CONFIG_FILE, *args) + if not config: + # Config could not be read, use defaults + config = copy.copy(FILE_CONTENT[CONFIG_FILE]) + + return config + + +def reset_config_file(): + ensure_local_plotly_files() # make sure what's there is OK + f = open(CONFIG_FILE, 'w') + f.close() + ensure_local_plotly_files() # put the defaults back + + +### embed tools ### + +def get_embed(file_owner_or_url, file_id=None, width="100%", height=525): + """Returns HTML code to embed figure on a webpage as an ").format( + plotly_rest_url=plotly_rest_url, + file_owner=file_owner, file_id=file_id, + iframe_height=height, iframe_width=width) + else: + s = ("").format( + plotly_rest_url=plotly_rest_url, + file_owner=file_owner, file_id=file_id, share_key=share_key, + iframe_height=height, iframe_width=width) + + return s + + +def embed(file_owner_or_url, file_id=None, width="100%", height=525): + """Embeds existing Plotly figure in IPython Notebook + + Plotly uniquely identifies figures with a 'file_owner'/'file_id' pair. + Since each file is given a corresponding unique url, you may also simply + pass a valid plotly url as the first argument. + + Note, if you're using a file_owner string as the first argument, you MUST + specify a `file_id` keyword argument. Else, if you're using a url string + as the first argument, you MUST NOT specify a `file_id` keyword argument, + or file_id must be set to Python's None value. + + Positional arguments: + file_owner_or_url (string) -- a valid plotly username OR a valid plotly url + + Keyword arguments: + file_id (default=None) -- an int or string that can be converted to int + if you're using a url, don't fill this in! + width (default="100%") -- an int or string corresp. to width of the figure + height (default="525") -- same as width but corresp. to the height of the + figure + + """ + try: + s = get_embed(file_owner_or_url, file_id=file_id, width=width, + height=height) + + # see if we are in the SageMath Cloud + if sage_salvus: + return sage_salvus.html(s, hide=False) + except: + pass + if ipython_core_display: + if file_id: + plotly_domain = ( + session.get_session_config().get('plotly_domain') or + get_config_file()['plotly_domain'] + ) + url = "{plotly_domain}/~{un}/{fid}".format( + plotly_domain=plotly_domain, + un=file_owner_or_url, + fid=file_id) + else: + url = file_owner_or_url + return PlotlyDisplay(url, width, height) + else: + if (get_config_defaults()['plotly_domain'] + != session.get_session_config()['plotly_domain']): + feedback_contact = 'Visit support.plot.ly' + else: + + # different domain likely means enterprise + feedback_contact = 'Contact your On-Premise account executive' + + warnings.warn( + "Looks like you're not using IPython or Sage to embed this " + "plot. If you just want the *embed code*,\ntry using " + "`get_embed()` instead." + '\nQuestions? {}'.format(feedback_contact)) + + +### graph_objs related tools ### +if ipython_core_display: + class PlotlyDisplay(ipython_core_display.HTML): + """An IPython display object for use with plotly urls + + PlotlyDisplay objects should be instantiated with a url for a plot. + IPython will *choose* the proper display representation from any + Python object, and using provided methods if they exist. By defining + the following, if an HTML display is unusable, the PlotlyDisplay + object can provide alternate representations. + + """ + def __init__(self, url, width, height): + self.resource = url + self.embed_code = get_embed(url, width=width, height=height) + super(PlotlyDisplay, self).__init__(data=self.embed_code) + + def _repr_html_(self): + return self.embed_code \ No newline at end of file diff --git a/chart_studio/utils.py b/chart_studio/utils.py new file mode 100644 index 00000000000..a8e90fda3c3 --- /dev/null +++ b/chart_studio/utils.py @@ -0,0 +1,172 @@ +""" +utils +===== + +Low-level functionality NOT intended for users to EVER use. + +""" +from __future__ import absolute_import + +import os.path +import re +import threading +import warnings + +from requests.compat import json as _json + +from _plotly_utils.exceptions import PlotlyError +from _plotly_utils.optional_imports import get_module + +# Optional imports, may be None for users that only use our core functionality. +numpy = get_module('numpy') +pandas = get_module('pandas') +sage_all = get_module('sage.all') + + +### incase people are using threading, we lock file reads +lock = threading.Lock() + + + +http_msg = ( + "The plotly_domain and plotly_api_domain of your config file must start " + "with 'https', not 'http'. If you are not using On-Premise then run the " + "following code to ensure your plotly_domain and plotly_api_domain start " + "with 'https':\n\n\n" + "import plotly\n" + "plotly.tools.set_config_file(\n" + " plotly_domain='https://plot.ly',\n" + " plotly_api_domain='https://api.plot.ly'\n" + ")\n\n\n" + "If you are using On-Premise then you will need to use your company's " + "domain and api_domain urls:\n\n\n" + "import plotly\n" + "plotly.tools.set_config_file(\n" + " plotly_domain='https://plotly.your-company.com',\n" + " plotly_api_domain='https://plotly.your-company.com'\n" + ")\n\n\n" + "Make sure to replace `your-company.com` with the URL of your Plotly " + "On-Premise server.\nSee " + "https://plot.ly/python/getting-started/#special-instructions-for-plotly-onpremise-users " + "for more help with getting started with On-Premise." +) + + +### general file setup tools ### + +def load_json_dict(filename, *args): + """Checks if file exists. Returns {} if something fails.""" + data = {} + if os.path.exists(filename): + lock.acquire() + with open(filename, "r") as f: + try: + data = _json.load(f) + if not isinstance(data, dict): + data = {} + except: + data = {} # TODO: issue a warning and bubble it up + lock.release() + if args: + return {key: data[key] for key in args if key in data} + return data + + +def save_json_dict(filename, json_dict): + """Save json to file. Error if path DNE, not a dict, or invalid json.""" + if isinstance(json_dict, dict): + # this will raise a TypeError if something goes wrong + json_string = _json.dumps(json_dict, indent=4) + lock.acquire() + with open(filename, "w") as f: + f.write(json_string) + lock.release() + else: + raise TypeError("json_dict was not a dictionary. not saving.") + + +def ensure_file_exists(filename): + """Given a valid filename, make sure it exists (will create if DNE).""" + if not os.path.exists(filename): + head, tail = os.path.split(filename) + ensure_dir_exists(head) + with open(filename, 'w') as f: + pass # just create the file + + +def ensure_dir_exists(directory): + """Given a valid directory path, make sure it exists.""" + if dir: + if not os.path.isdir(directory): + os.makedirs(directory) + + +def get_first_duplicate(items): + seen = set() + for item in items: + if item not in seen: + seen.add(item) + else: + return item + return None + + +### source key +def is_source_key(key): + src_regex = re.compile(r'.+src$') + if src_regex.match(key) is not None: + return True + else: + return False + + +### validation +def validate_world_readable_and_sharing_settings(option_set): + if ('world_readable' in option_set and + option_set['world_readable'] is True and + 'sharing' in option_set and + option_set['sharing'] is not None and + option_set['sharing'] != 'public'): + raise PlotlyError( + "Looks like you are setting your plot privacy to both " + "public and private.\n If you set world_readable as True, " + "sharing can only be set to 'public'") + elif ('world_readable' in option_set and + option_set['world_readable'] is False and + 'sharing' in option_set and + option_set['sharing'] == 'public'): + raise PlotlyError( + "Looks like you are setting your plot privacy to both " + "public and private.\n If you set world_readable as " + "False, sharing can only be set to 'private' or 'secret'") + elif ('sharing' in option_set and + option_set['sharing'] not in ['public', 'private', 'secret', None]): + raise PlotlyError( + "The 'sharing' argument only accepts one of the following " + "strings:\n'public' -- for public plots\n" + "'private' -- for private plots\n" + "'secret' -- for private plots that can be shared with a " + "secret url" + ) + + +def validate_plotly_domains(option_set): + domains_not_none = [] + for d in ['plotly_domain', 'plotly_api_domain']: + if d in option_set and option_set[d]: + domains_not_none.append(option_set[d]) + + if not all(d.lower().startswith('https') for d in domains_not_none): + warnings.warn(http_msg, category=UserWarning) + + +def set_sharing_and_world_readable(option_set): + if 'world_readable' in option_set and 'sharing' not in option_set: + option_set['sharing'] = ( + 'public' if option_set['world_readable'] else 'private') + + elif 'sharing' in option_set and 'world_readable' not in option_set: + if option_set['sharing'] == 'public': + option_set['world_readable'] = True + else: + option_set['world_readable'] = False diff --git a/chart_studio/widgets/__init__.py b/chart_studio/widgets/__init__.py new file mode 100644 index 00000000000..f1a63808df9 --- /dev/null +++ b/chart_studio/widgets/__init__.py @@ -0,0 +1,3 @@ +from __future__ import absolute_import + +from chart_studio.widgets.graph_widget import GraphWidget diff --git a/plotly/widgets/graph_widget.py b/chart_studio/widgets/graph_widget.py similarity index 99% rename from plotly/widgets/graph_widget.py rename to chart_studio/widgets/graph_widget.py index d514c63a18b..4ead8a9abaa 100644 --- a/plotly/widgets/graph_widget.py +++ b/chart_studio/widgets/graph_widget.py @@ -13,8 +13,8 @@ from traitlets import Unicode from IPython.display import Javascript, display -import plotly.plotly.plotly as py -from plotly import utils, tools +import plotly.tools +from chart_studio import plotly as py, tools, utils from plotly.graph_objs import Figure # Load JS widget code @@ -320,8 +320,8 @@ def plot(self, figure_or_data, validate=True): if figure_or_data == {} or figure_or_data == Figure(): validate = False - figure = tools.return_figure_from_figure_or_data(figure_or_data, - validate) + figure = plotly.tools.return_figure_from_figure_or_data(figure_or_data, + validate) message = { 'task': 'newPlot', 'data': figure.get('data', []), diff --git a/codegen/__init__.py b/codegen/__init__.py index 556073aca42..42577fcfdbe 100644 --- a/codegen/__init__.py +++ b/codegen/__init__.py @@ -189,27 +189,6 @@ def perform_codegen(): layout_validator, frame_validator) - # Write validator __init__.py files - # --------------------------------- - # ### Write __init__.py files for each validator package ### - path_to_validator_import_info = {} - for node in all_datatype_nodes: - if node.is_mapped: - continue - key = node.parent_path_parts - path_to_validator_import_info.setdefault(key, []).append( - (f"._{node.name_property}", node.name_validator_class) - ) - - # Add Data validator - root_validator_pairs = path_to_validator_import_info[()] - root_validator_pairs.append(('._data', 'DataValidator')) - - # Output validator __init__.py files - validators_pkg = opath.join(outdir, 'validators') - for path_parts, import_pairs in path_to_validator_import_info.items(): - write_init_py(validators_pkg, path_parts, import_pairs) - # Write datatype __init__.py files # -------------------------------- # ### Build mapping from parent package to datatype class ### @@ -217,11 +196,6 @@ def perform_codegen(): for node in all_compound_nodes: key = node.parent_path_parts - # class import - path_to_datatype_import_info.setdefault(key, []).append( - (f"._{node.name_undercase}", node.name_datatype_class) - ) - # submodule import if node.child_compound_datatypes: diff --git a/codegen/datatypes.py b/codegen/datatypes.py index dd3896f221f..8fd52d305ac 100644 --- a/codegen/datatypes.py +++ b/codegen/datatypes.py @@ -92,16 +92,16 @@ def build_datatype_py(node): # Imports # ------- buffer.write( - f'from plotly.basedatatypes import {node.name_base_datatype}\n') + f'from plotly.basedatatypes ' + f'import {node.name_base_datatype} as _{node.name_base_datatype}\n') buffer.write( - f'import copy\n') - + f'import copy as _copy\n') # Write class definition # ---------------------- buffer.write(f""" -class {datatype_class}({node.name_base_datatype}):\n""") +class {datatype_class}(_{node.name_base_datatype}):\n""") # ### Property definitions ### child_datatype_nodes = node.child_datatypes @@ -235,7 +235,7 @@ def __init__(self""") elif isinstance(arg, self.__class__): arg = arg.to_plotly_json() elif isinstance(arg, dict): - arg = copy.copy(arg) + arg = _copy.copy(arg) else: raise ValueError(\"\"\"\\ The first argument to the {class_name} @@ -311,7 +311,7 @@ def __init__(self""") # Reset skip_invalid # ------------------ self._skip_invalid = False - """) +""") # Return source string # -------------------- @@ -484,13 +484,18 @@ def write_datatype_py(outdir, node): ------- None """ + + # Build file path + # --------------- + filepath = opath.join(outdir, 'graph_objs', + *node.parent_path_parts, + '__init__.py') + # Generate source code # -------------------- datatype_source = build_datatype_py(node) # Write file # ---------- - filepath = opath.join(outdir, 'graph_objs', - *node.parent_path_parts, - '_' + node.name_undercase + '.py') - format_and_write_source_py(datatype_source, filepath) + + format_and_write_source_py(datatype_source, filepath, leading_newlines=2) diff --git a/codegen/utils.py b/codegen/utils.py index 1e78ef1b543..9bd241239c2 100644 --- a/codegen/utils.py +++ b/codegen/utils.py @@ -32,7 +32,7 @@ def format_source(input_source): return formatted_source -def format_and_write_source_py(py_source, filepath): +def format_and_write_source_py(py_source, filepath, leading_newlines=0): """ Format Python source code and write to a file, creating parent directories as needed. @@ -62,7 +62,8 @@ def format_and_write_source_py(py_source, filepath): # Write file # ---------- - with open(filepath, 'wt') as f: + formatted_source = '\n' * leading_newlines + formatted_source + with open(filepath, 'at') as f: f.write(formatted_source) @@ -130,7 +131,8 @@ def write_init_py(pkg_root, path_parts, import_pairs): # Write file # ---------- filepath = opath.join(pkg_root, *path_parts, '__init__.py') - format_and_write_source_py(init_source, filepath) + format_and_write_source_py( + init_source, filepath, leading_newlines=2) def format_description(desc): diff --git a/codegen/validators.py b/codegen/validators.py index 32c118666f2..47c8d10f972 100644 --- a/codegen/validators.py +++ b/codegen/validators.py @@ -68,7 +68,6 @@ def __init__(self, plotly_name={params['plotly_name']}, buffer.write(f""", **kwargs""") - buffer.write(')') # ### Return buffer's string ### @@ -105,9 +104,9 @@ def write_validator_py(outdir, # ---------- filepath = opath.join(outdir, 'validators', *node.parent_path_parts, - '_' + node.name_property + '.py') + '__init__.py') - format_and_write_source_py(validator_source, filepath) + format_and_write_source_py(validator_source, filepath, leading_newlines=2) def build_data_validator_params(base_trace_node: TraceNode): @@ -248,5 +247,5 @@ def write_data_validator_py(outdir, base_trace_node: TraceNode): # Write file # ---------- - filepath = opath.join(outdir, 'validators', '_data.py') - format_and_write_source_py(source, filepath) \ No newline at end of file + filepath = opath.join(outdir, 'validators', '__init__.py') + format_and_write_source_py(source, filepath, leading_newlines=2) diff --git a/plotly/__init__.py b/plotly/__init__.py index b9c0170d694..3f6a372f5ab 100644 --- a/plotly/__init__.py +++ b/plotly/__init__.py @@ -27,15 +27,27 @@ """ from __future__ import absolute_import +from _plotly_future_ import _future_flags + +from plotly import ( + graph_objs, + tools, + utils, + offline, + colors, + io +) -from plotly import (plotly, dashboard_objs, graph_objs, grid_objs, tools, - utils, session, offline, colors, io) from plotly.version import __version__ -from _plotly_future_ import _future_flags -from ._version import get_versions -__version__ = get_versions()['version'] -del get_versions +if ('extract_chart_studio' not in _future_flags + and 'remove_deprecations' not in _future_flags): + from plotly import ( + plotly, + dashboard_objs, + grid_objs, + session) + # Set default template here to make sure import process is complete if 'template_defaults' in _future_flags: diff --git a/plotly/api/utils.py b/plotly/api/utils.py index d9d1d21f504..29f1d3f6d0c 100644 --- a/plotly/api/utils.py +++ b/plotly/api/utils.py @@ -1,41 +1,4 @@ -from base64 import b64encode - -from requests.compat import builtin_str, is_py2 - - -def _to_native_string(string, encoding): - if isinstance(string, builtin_str): - return string - if is_py2: - return string.encode(encoding) - return string.decode(encoding) - - -def to_native_utf8_string(string): - return _to_native_string(string, 'utf-8') - - -def to_native_ascii_string(string): - return _to_native_string(string, 'ascii') - - -def basic_auth(username, password): - """ - Creates the basic auth value to be used in an authorization header. - - This is mostly copied from the requests library. - - :param (str) username: A Plotly username. - :param (str) password: The password for the given Plotly username. - :returns: (str) An 'authorization' header for use in a request header. - - """ - if isinstance(username, str): - username = username.encode('latin1') - - if isinstance(password, str): - password = password.encode('latin1') - - return 'Basic ' + to_native_ascii_string( - b64encode(b':'.join((username, password))).strip() - ) +# Deprecations +from _plotly_future_ import _future_flags +if 'remove_deprecations' not in _future_flags: + from chart_studio.api.utils import * diff --git a/plotly/api/v1.py b/plotly/api/v1.py new file mode 100644 index 00000000000..7d91adb2eec --- /dev/null +++ b/plotly/api/v1.py @@ -0,0 +1,9 @@ +from __future__ import absolute_import + +from _plotly_future_ import _future_flags + + +if 'remove_deprecations' not in _future_flags: + from _plotly_future_ import _chart_studio_warning + _chart_studio_warning('api.v1') + from chart_studio.api.v1 import * diff --git a/plotly/api/v1/__init__.py b/plotly/api/v1/__init__.py deleted file mode 100644 index a43ff61f4c8..00000000000 --- a/plotly/api/v1/__init__.py +++ /dev/null @@ -1,3 +0,0 @@ -from __future__ import absolute_import - -from plotly.api.v1.clientresp import clientresp diff --git a/plotly/api/v1/utils.py b/plotly/api/v1/utils.py deleted file mode 100644 index 24d827b7b79..00000000000 --- a/plotly/api/v1/utils.py +++ /dev/null @@ -1,91 +0,0 @@ -from __future__ import absolute_import - -import requests -from requests.exceptions import RequestException -from retrying import retry - -from plotly import config, exceptions -from plotly.api.utils import basic_auth -from plotly.api.v2.utils import should_retry - - -def validate_response(response): - """ - Raise a helpful PlotlyRequestError for failed requests. - - :param (requests.Response) response: A Response object from an api request. - :raises: (PlotlyRequestError) If the request failed for any reason. - :returns: (None) - - """ - content = response.content - status_code = response.status_code - try: - parsed_content = response.json() - except ValueError: - message = content if content else 'No Content' - raise exceptions.PlotlyRequestError(message, status_code, content) - - message = '' - if isinstance(parsed_content, dict): - error = parsed_content.get('error') - if error: - message = error - else: - if response.ok: - return - if not message: - message = content if content else 'No Content' - - raise exceptions.PlotlyRequestError(message, status_code, content) - - -def get_headers(): - """ - Using session credentials/config, get headers for a v1 API request. - - Users may have their own proxy layer and so we free up the `authorization` - header for this purpose (instead adding the user authorization in a new - `plotly-authorization` header). See pull #239. - - :returns: (dict) Headers to add to a requests.request call. - - """ - headers = {} - creds = config.get_credentials() - proxy_auth = basic_auth(creds['proxy_username'], creds['proxy_password']) - - if config.get_config()['plotly_proxy_authorization']: - headers['authorization'] = proxy_auth - - return headers - - -@retry(wait_exponential_multiplier=1000, wait_exponential_max=16000, - stop_max_delay=180000, retry_on_exception=should_retry) -def request(method, url, **kwargs): - """ - Central place to make any v1 api request. - - :param (str) method: The request method ('get', 'put', 'delete', ...). - :param (str) url: The full api url to make the request to. - :param kwargs: These are passed along to requests. - :return: (requests.Response) The response directly from requests. - - """ - if kwargs.get('json', None) is not None: - # See plotly.api.v2.utils.request for examples on how to do this. - raise exceptions.PlotlyError('V1 API does not handle arbitrary json.') - kwargs['headers'] = dict(kwargs.get('headers', {}), **get_headers()) - kwargs['verify'] = config.get_config()['plotly_ssl_verification'] - try: - response = requests.request(method, url, **kwargs) - except RequestException as e: - # The message can be an exception. E.g., MaxRetryError. - message = str(getattr(e, 'message', 'No message')) - response = getattr(e, 'response', None) - status_code = response.status_code if response else None - content = response.content if response else 'No content' - raise exceptions.PlotlyRequestError(message, status_code, content) - validate_response(response) - return response diff --git a/plotly/api/v2.py b/plotly/api/v2.py new file mode 100644 index 00000000000..82851d4b5ff --- /dev/null +++ b/plotly/api/v2.py @@ -0,0 +1,9 @@ +from __future__ import absolute_import + +from _plotly_future_ import _future_flags + + +if 'remove_deprecations' not in _future_flags: + from _plotly_future_ import _chart_studio_warning + _chart_studio_warning('api.v2') + from chart_studio.api.v2 import * \ No newline at end of file diff --git a/plotly/api/v2/__init__.py b/plotly/api/v2/__init__.py deleted file mode 100644 index 14ee754200b..00000000000 --- a/plotly/api/v2/__init__.py +++ /dev/null @@ -1,5 +0,0 @@ -from __future__ import absolute_import - -from plotly.api.v2 import (dash_apps, dashboards, files, folders, grids, - images, plot_schema, plots, spectacle_presentations, - users) diff --git a/plotly/api/v2/files.py b/plotly/api/v2/files.py deleted file mode 100644 index 650ab48fc85..00000000000 --- a/plotly/api/v2/files.py +++ /dev/null @@ -1,85 +0,0 @@ -"""Interface to Plotly's /v2/files endpoints.""" -from __future__ import absolute_import - -from plotly.api.v2.utils import build_url, make_params, request - -RESOURCE = 'files' - - -def retrieve(fid, share_key=None): - """ - Retrieve a general file from Plotly. - - :param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`. - :param (str) share_key: The secret key granting 'read' access if private. - :returns: (requests.Response) Returns response directly from requests. - - """ - url = build_url(RESOURCE, id=fid) - params = make_params(share_key=share_key) - return request('get', url, params=params) - - -def update(fid, body): - """ - Update a general file from Plotly. - - :param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`. - :param (dict) body: A mapping of body param names to values. - :returns: (requests.Response) Returns response directly from requests. - - """ - url = build_url(RESOURCE, id=fid) - return request('put', url, json=body) - - -def trash(fid): - """ - Soft-delete a general file from Plotly. (Can be undone with 'restore'). - - :param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`. - :returns: (requests.Response) Returns response directly from requests. - - """ - url = build_url(RESOURCE, id=fid, route='trash') - return request('post', url) - - -def restore(fid): - """ - Restore a trashed, general file from Plotly. See 'trash'. - - :param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`. - :returns: (requests.Response) Returns response directly from requests. - - """ - url = build_url(RESOURCE, id=fid, route='restore') - return request('post', url) - - -def permanent_delete(fid): - """ - Permanently delete a trashed, general file from Plotly. See 'trash'. - - :param (str) fid: The `{username}:{idlocal}` identifier. E.g. `foo:88`. - :returns: (requests.Response) Returns response directly from requests. - - """ - url = build_url(RESOURCE, id=fid, route='permanent_delete') - return request('delete', url) - - -def lookup(path, parent=None, user=None, exists=None): - """ - Retrieve a general file from Plotly without needing a fid. - - :param (str) path: The '/'-delimited path specifying the file location. - :param (int) parent: Parent id, an integer, which the path is relative to. - :param (str) user: The username to target files for. Defaults to requestor. - :param (bool) exists: If True, don't return the full file, just a flag. - :returns: (requests.Response) Returns response directly from requests. - - """ - url = build_url(RESOURCE, route='lookup') - params = make_params(path=path, parent=parent, user=user, exists=exists) - return request('get', url, params=params) diff --git a/plotly/api/v2/utils.py b/plotly/api/v2/utils.py deleted file mode 100644 index 13d4aa86fc2..00000000000 --- a/plotly/api/v2/utils.py +++ /dev/null @@ -1,168 +0,0 @@ -from __future__ import absolute_import - -import requests -from requests.compat import json as _json -from requests.exceptions import RequestException -from retrying import retry -from plotly import config, exceptions, version, utils -from plotly.api.utils import basic_auth - - -def make_params(**kwargs): - """ - Helper to create a params dict, skipping undefined entries. - - :returns: (dict) A params dict to pass to `request`. - - """ - return {k: v for k, v in kwargs.items() if v is not None} - - -def build_url(resource, id='', route=''): - """ - Create a url for a request on a V2 resource. - - :param (str) resource: E.g., 'files', 'plots', 'grids', etc. - :param (str) id: The unique identifier for the resource. - :param (str) route: Detail/list route. E.g., 'restore', 'lookup', etc. - :return: (str) The url. - - """ - base = config.get_config()['plotly_api_domain'] - formatter = {'base': base, 'resource': resource, 'id': id, 'route': route} - - # Add path to base url depending on the input params. Note that `route` - # can refer to a 'list' or a 'detail' route. Since it cannot refer to - # both at the same time, it's overloaded in this function. - if id: - if route: - url = '{base}/v2/{resource}/{id}/{route}'.format(**formatter) - else: - url = '{base}/v2/{resource}/{id}'.format(**formatter) - else: - if route: - url = '{base}/v2/{resource}/{route}'.format(**formatter) - else: - url = '{base}/v2/{resource}'.format(**formatter) - - return url - - -def validate_response(response): - """ - Raise a helpful PlotlyRequestError for failed requests. - - :param (requests.Response) response: A Response object from an api request. - :raises: (PlotlyRequestError) If the request failed for any reason. - :returns: (None) - - """ - if response.ok: - return - - content = response.content - status_code = response.status_code - try: - parsed_content = response.json() - except ValueError: - message = content if content else 'No Content' - raise exceptions.PlotlyRequestError(message, status_code, content) - - message = '' - if isinstance(parsed_content, dict): - errors = parsed_content.get('errors', []) - messages = [error.get('message') for error in errors] - message = '\n'.join([msg for msg in messages if msg]) - if not message: - message = content if content else 'No Content' - - raise exceptions.PlotlyRequestError(message, status_code, content) - - -def get_headers(): - """ - Using session credentials/config, get headers for a V2 API request. - - Users may have their own proxy layer and so we free up the `authorization` - header for this purpose (instead adding the user authorization in a new - `plotly-authorization` header). See pull #239. - - :returns: (dict) Headers to add to a requests.request call. - - """ - creds = config.get_credentials() - - headers = { - 'plotly-client-platform': 'python {}'.format(version.stable_semver()), - 'content-type': 'application/json' - } - - plotly_auth = basic_auth(creds['username'], creds['api_key']) - proxy_auth = basic_auth(creds['proxy_username'], creds['proxy_password']) - - if config.get_config()['plotly_proxy_authorization']: - headers['authorization'] = proxy_auth - if creds['username'] and creds['api_key']: - headers['plotly-authorization'] = plotly_auth - else: - if creds['username'] and creds['api_key']: - headers['authorization'] = plotly_auth - - return headers - - -def should_retry(exception): - if isinstance(exception, exceptions.PlotlyRequestError): - if (isinstance(exception.status_code, int) and - (500 <= exception.status_code < 600 or exception.status_code == 429)): - # Retry on 5XX and 429 (image export throttling) errors. - return True - elif 'Uh oh, an error occurred' in exception.message: - return True - - return False - - -@retry(wait_exponential_multiplier=1000, wait_exponential_max=16000, - stop_max_delay=180000, retry_on_exception=should_retry) -def request(method, url, **kwargs): - """ - Central place to make any api v2 api request. - - :param (str) method: The request method ('get', 'put', 'delete', ...). - :param (str) url: The full api url to make the request to. - :param kwargs: These are passed along (but possibly mutated) to requests. - :return: (requests.Response) The response directly from requests. - - """ - kwargs['headers'] = dict(kwargs.get('headers', {}), **get_headers()) - - # Change boolean params to lowercase strings. E.g., `True` --> `'true'`. - # Just change the value so that requests handles query string creation. - if isinstance(kwargs.get('params'), dict): - kwargs['params'] = kwargs['params'].copy() - for key in kwargs['params']: - if isinstance(kwargs['params'][key], bool): - kwargs['params'][key] = _json.dumps(kwargs['params'][key]) - - # We have a special json encoding class for non-native objects. - if kwargs.get('json') is not None: - if kwargs.get('data'): - raise exceptions.PlotlyError('Cannot supply data and json kwargs.') - kwargs['data'] = _json.dumps(kwargs.pop('json'), sort_keys=True, - cls=utils.PlotlyJSONEncoder) - - # The config file determines whether reuqests should *verify*. - kwargs['verify'] = config.get_config()['plotly_ssl_verification'] - - try: - response = requests.request(method, url, **kwargs) - except RequestException as e: - # The message can be an exception. E.g., MaxRetryError. - message = str(getattr(e, 'message', 'No message')) - response = getattr(e, 'response', None) - status_code = response.status_code if response else None - content = response.content if response else 'No content' - raise exceptions.PlotlyRequestError(message, status_code, content) - validate_response(response) - return response diff --git a/plotly/basedatatypes.py b/plotly/basedatatypes.py index b4b78881735..c043e1d7ba6 100644 --- a/plotly/basedatatypes.py +++ b/plotly/basedatatypes.py @@ -8,26 +8,18 @@ import warnings from contextlib import contextmanager from copy import deepcopy, copy -from pprint import PrettyPrinter -from plotly.offline.offline import _get_jconfig from .optional_imports import get_module -from . import offline as pyo from _plotly_utils.basevalidators import ( CompoundValidator, CompoundArrayValidator, BaseDataValidator, BaseValidator, LiteralValidator ) from . import animation -from .callbacks import (Points, BoxSelector, LassoSelector, - InputDeviceState) -from .utils import ElidedPrettyPrinter +from .callbacks import (Points, InputDeviceState) +from plotly.utils import ElidedPrettyPrinter from .validators import (DataValidator, LayoutValidator, FramesValidator) -# Optional imports -# ---------------- -np = get_module('numpy') - # Create Undefined sentinel value # - Setting a property to None removes any existing value # - Setting a property to Undefined leaves existing value unmodified @@ -201,6 +193,7 @@ class is a subclass of both BaseFigure and widgets.DOMWidget. # arbitrary config options like in plotly.offline.plot/iplot. But # this will require a fair amount of testing to determine which # options are compatible with FigureWidget. + from plotly.offline.offline import _get_jconfig self._config = _get_jconfig(None) # Frames @@ -3502,6 +3495,7 @@ def _vals_equal(v1, v2): bool True if v1 and v2 are equal, False otherwise """ + np = get_module('numpy') if (np is not None and (isinstance(v1, np.ndarray) or isinstance(v2, np.ndarray))): return np.array_equal(v1, v2) diff --git a/plotly/callbacks.py b/plotly/callbacks.py index bd99e68cc2b..5f92938d2cf 100644 --- a/plotly/callbacks.py +++ b/plotly/callbacks.py @@ -1,4 +1,5 @@ -from .utils import _list_repr_elided +from __future__ import absolute_import +from plotly.utils import _list_repr_elided class InputDeviceState: diff --git a/plotly/config.py b/plotly/config.py index dc1b8e28654..ca1c72c1f6b 100644 --- a/plotly/config.py +++ b/plotly/config.py @@ -1,35 +1,5 @@ -""" -Merges and prioritizes file/session config and credentials. - -This is promoted to its own module to simplify imports. - -""" from __future__ import absolute_import -from plotly import session, tools - - -def get_credentials(): - """Returns the credentials that will be sent to plotly.""" - credentials = tools.get_credentials_file() - session_credentials = session.get_session_credentials() - for credentials_key in credentials: - - # checking for not false, but truthy value here is the desired behavior - session_value = session_credentials.get(credentials_key) - if session_value is False or session_value: - credentials[credentials_key] = session_value - return credentials - - -def get_config(): - """Returns either module config or file config.""" - config = tools.get_config_file() - session_config = session.get_session_config() - for config_key in config: - - # checking for not false, but truthy value here is the desired behavior - session_value = session_config.get(config_key) - if session_value is False or session_value: - config[config_key] = session_value - return config +from _plotly_future_ import _chart_studio_warning +_chart_studio_warning('config') +from chart_studio.config import * diff --git a/plotly/dashboard_objs.py b/plotly/dashboard_objs.py new file mode 100644 index 00000000000..c060c9978cf --- /dev/null +++ b/plotly/dashboard_objs.py @@ -0,0 +1,9 @@ +from __future__ import absolute_import + +from _plotly_future_ import _future_flags + + +if 'remove_deprecations' not in _future_flags: + from _plotly_future_ import _chart_studio_warning + _chart_studio_warning('dashboard_objs') + from chart_studio.dashboard_objs import * diff --git a/plotly/dashboard_objs/dashboard_objs.py b/plotly/dashboard_objs/dashboard_objs.py deleted file mode 100644 index 9b6c3c84672..00000000000 --- a/plotly/dashboard_objs/dashboard_objs.py +++ /dev/null @@ -1,624 +0,0 @@ -""" -dashboard_objs -========== - -A module for creating and manipulating dashboard content. You can create -a Dashboard object, insert boxes, swap boxes, remove a box and get an HTML -preview of the Dashboard. -``` -""" - -import pprint - -from plotly import exceptions, optional_imports -from plotly.utils import node_generator - -IPython = optional_imports.get_module('IPython') - -# default parameters for HTML preview -MASTER_WIDTH = 500 -MASTER_HEIGHT = 500 -FONT_SIZE = 9 - - -ID_NOT_VALID_MESSAGE = ( - "Your box_id must be a number in your dashboard. To view a " - "representation of your dashboard run get_preview()." -) - - -def _empty_box(): - empty_box = { - 'type': 'box', - 'boxType': 'empty' - } - return empty_box - - -def _box(fileId='', shareKey=None, title=''): - box = { - 'type': 'box', - 'boxType': 'plot', - 'fileId': fileId, - 'shareKey': shareKey, - 'title': title - } - return box - -def _container(box_1=None, box_2=None, - size=50, sizeUnit='%', - direction='vertical'): - if box_1 is None: - box_1 = _empty_box() - if box_2 is None: - box_2 = _empty_box() - - container = { - 'type': 'split', - 'size': size, - 'sizeUnit': sizeUnit, - 'direction': direction, - 'first': box_1, - 'second': box_2 - } - - return container - -dashboard_html = (""" - - - - - - - - - - -""".format(width=MASTER_WIDTH, height=MASTER_HEIGHT)) - - -def _draw_line_through_box(dashboard_html, top_left_x, top_left_y, box_w, - box_h, is_horizontal, direction, fill_percent=50): - if is_horizontal: - new_top_left_x = top_left_x + box_w * (fill_percent / 100.) - new_top_left_y = top_left_y - new_box_w = 1 - new_box_h = box_h - else: - new_top_left_x = top_left_x - new_top_left_y = top_left_y + box_h * (fill_percent / 100.) - new_box_w = box_w - new_box_h = 1 - - html_box = """ - context.beginPath(); - context.rect({top_left_x}, {top_left_y}, {box_w}, {box_h}); - context.lineWidth = 1; - context.strokeStyle = 'black'; - context.stroke(); - """.format(top_left_x=new_top_left_x, top_left_y=new_top_left_y, - box_w=new_box_w, box_h=new_box_h) - - index_for_new_box = dashboard_html.find('') - 1 - dashboard_html = (dashboard_html[:index_for_new_box] + html_box + - dashboard_html[index_for_new_box:]) - return dashboard_html - - -def _add_html_text(dashboard_html, text, top_left_x, top_left_y, box_w, - box_h): - html_text = """ - context.font = '{}pt Times New Roman'; - context.textAlign = 'center'; - context.fillText({}, {} + 0.5*{}, {} + 0.5*{}); - """.format(FONT_SIZE, text, top_left_x, box_w, top_left_y, box_h) - - index_to_add_text = dashboard_html.find('') - 1 - dashboard_html = (dashboard_html[:index_to_add_text] + html_text + - dashboard_html[index_to_add_text:]) - return dashboard_html - - -class Dashboard(dict): - """ - Dashboard class for creating interactive dashboard objects. - - Dashboards are dicts that contain boxes which hold plot information. - These boxes can be arranged in various ways. The most basic form of - a box is: - - ``` - { - 'type': 'box', - 'boxType': 'plot' - } - ``` - - where 'fileId' can be set to the 'username:#' of your plot. The other - parameters a box takes are `shareKey` (default is None) and `title` - (default is ''). - - `.get_preview()` should be called quite regularly to get an HTML - representation of the dashboard in which the boxes in the HTML - are labelled with on-the-fly-generated numbers or box ids which - change after each modification to the dashboard. - - `.get_box()` returns the box located in the dashboard by calling - its box id as displayed via `.get_preview()`. - - Example 1: Create a simple Dashboard object - ``` - import plotly.dashboard_objs as dashboard - - box_a = { - 'type': 'box', - 'boxType': 'plot', - 'fileId': 'username:some#', - 'title': 'box a' - } - - box_b = { - 'type': 'box', - 'boxType': 'plot', - 'fileId': 'username:some#', - 'title': 'box b' - } - - box_c = { - 'type': 'box', - 'boxType': 'plot', - 'fileId': 'username:some#', - 'title': 'box c' - } - - my_dboard = dashboard.Dashboard() - my_dboard.insert(box_a) - # my_dboard.get_preview() - my_dboard.insert(box_b, 'above', 1) - # my_dboard.get_preview() - my_dboard.insert(box_c, 'left', 2) - # my_dboard.get_preview() - my_dboard.swap(1, 2) - # my_dboard.get_preview() - my_dboard.remove(1) - # my_dboard.get_preview() - ``` - - Example 2: 4 vertical boxes of equal height - ``` - import plotly.dashboard_objs as dashboard - - box_a = { - 'type': 'box', - 'boxType': 'plot', - 'fileId': 'username:some#', - 'title': 'box a' - } - - my_dboard = dashboard.Dashboard() - my_dboard.insert(box_a) - my_dboard.insert(box_a, 'below', 1) - my_dboard.insert(box_a, 'below', 1) - my_dboard.insert(box_a, 'below', 3) - # my_dboard.get_preview() - ``` - """ - def __init__(self, content=None): - if content is None: - content = {} - - if not content: - self['layout'] = None - self['version'] = 2 - self['settings'] = {} - else: - self['layout'] = content['layout'] - self['version'] = content['version'] - self['settings'] = content['settings'] - - def _compute_box_ids(self): - box_ids_to_path = {} - all_nodes = list(node_generator(self['layout'])) - all_nodes.sort(key=lambda x: x[1]) - for node in all_nodes: - if (node[1] != () and node[0]['type'] == 'box' - and node[0]['boxType'] != 'empty'): - try: - max_id = max(box_ids_to_path.keys()) - except ValueError: - max_id = 0 - box_ids_to_path[max_id + 1] = node[1] - - return box_ids_to_path - - def _insert(self, box_or_container, path): - if any(first_second not in ['first', 'second'] - for first_second in path): - raise exceptions.PlotlyError( - "Invalid path. Your 'path' list must only contain " - "the strings 'first' and 'second'." - ) - - if 'first' in self['layout']: - loc_in_dashboard = self['layout'] - for index, first_second in enumerate(path): - if index != len(path) - 1: - loc_in_dashboard = loc_in_dashboard[first_second] - else: - loc_in_dashboard[first_second] = box_or_container - - else: - self['layout'] = box_or_container - - def _make_all_nodes_and_paths(self): - all_nodes = list(node_generator(self['layout'])) - all_nodes.sort(key=lambda x: x[1]) - - # remove path 'second' as it's always an empty box - all_paths = [] - for node in all_nodes: - all_paths.append(node[1]) - path_second = ('second',) - if path_second in all_paths: - all_paths.remove(path_second) - return all_nodes, all_paths - - def _path_to_box(self, path): - loc_in_dashboard = self['layout'] - for first_second in path: - loc_in_dashboard = loc_in_dashboard[first_second] - return loc_in_dashboard - - def _set_dashboard_size(self): - # set dashboard size to keep consistent with GUI - num_of_boxes = len(self._compute_box_ids()) - if num_of_boxes == 0: - pass - elif num_of_boxes == 1: - self['layout']['size'] = 800 - self['layout']['sizeUnit'] = 'px' - elif num_of_boxes == 2: - self['layout']['size'] = 1500 - self['layout']['sizeUnit'] = 'px' - else: - self['layout']['size'] = 1500 + 350 * (num_of_boxes - 2) - self['layout']['sizeUnit'] = 'px' - - def get_box(self, box_id): - """Returns box from box_id number.""" - box_ids_to_path = self._compute_box_ids() - loc_in_dashboard = self['layout'] - - if box_id not in box_ids_to_path.keys(): - raise exceptions.PlotlyError(ID_NOT_VALID_MESSAGE) - for first_second in box_ids_to_path[box_id]: - loc_in_dashboard = loc_in_dashboard[first_second] - return loc_in_dashboard - - def get_preview(self): - """ - Returns JSON or HTML respresentation of the dashboard. - - If IPython is not imported, returns a pretty print of the dashboard - dict. Otherwise, returns an IPython.core.display.HTML display of the - dashboard. - - The algorithm used to build the HTML preview involves going through - the paths of the node generator of the dashboard. The paths of the - dashboard are sequenced through from shorter to longer and whether - it's a box or container that lies at the end of the path determines - the action. - - If it's a container, draw a line in the figure to divide the current - box into two and store the specs of the resulting two boxes. If the - path points to a terminal box (often containing a plot), then draw - the box id in the center of the box. - - It's important to note that these box ids are generated on-the-fly and - they do not necessarily stay assigned to the boxes they were once - assigned to. - """ - if IPython is None: - pprint.pprint(self) - return - - elif self['layout'] is None: - return IPython.display.HTML(dashboard_html) - - top_left_x = 0 - top_left_y = 0 - box_w = MASTER_WIDTH - box_h = MASTER_HEIGHT - html_figure = dashboard_html - box_ids_to_path = self._compute_box_ids() - # used to store info about box dimensions - path_to_box_specs = {} - first_box_specs = { - 'top_left_x': top_left_x, - 'top_left_y': top_left_y, - 'box_w': box_w, - 'box_h': box_h - } - # uses tuples to store paths as for hashable keys - path_to_box_specs[('first',)] = first_box_specs - - # generate all paths - all_nodes, all_paths = self._make_all_nodes_and_paths() - - max_path_len = max(len(path) for path in all_paths) - for path_len in range(1, max_path_len + 1): - for path in [path for path in all_paths if len(path) == path_len]: - current_box_specs = path_to_box_specs[path] - - if self._path_to_box(path)['type'] == 'split': - fill_percent = self._path_to_box(path)['size'] - direction = self._path_to_box(path)['direction'] - is_horizontal = (direction == 'horizontal') - - top_left_x = current_box_specs['top_left_x'] - top_left_y = current_box_specs['top_left_y'] - box_w = current_box_specs['box_w'] - box_h = current_box_specs['box_h'] - - html_figure = _draw_line_through_box( - html_figure, top_left_x, top_left_y, box_w, box_h, - is_horizontal=is_horizontal, direction=direction, - fill_percent=fill_percent - ) - - # determine the specs for resulting two box split - if is_horizontal: - new_top_left_x = top_left_x - new_top_left_y = top_left_y - new_box_w = box_w * (fill_percent / 100.) - new_box_h = box_h - - new_top_left_x_2 = top_left_x + new_box_w - new_top_left_y_2 = top_left_y - new_box_w_2 = box_w * ((100 - fill_percent) / 100.) - new_box_h_2 = box_h - else: - new_top_left_x = top_left_x - new_top_left_y = top_left_y - new_box_w = box_w - new_box_h = box_h * (fill_percent / 100.) - - new_top_left_x_2 = top_left_x - new_top_left_y_2 = (top_left_y + - box_h * (fill_percent / 100.)) - new_box_w_2 = box_w - new_box_h_2 = box_h * ((100 - fill_percent) / 100.) - - first_box_specs = { - 'top_left_x': top_left_x, - 'top_left_y': top_left_y, - 'box_w': new_box_w, - 'box_h': new_box_h - } - second_box_specs = { - 'top_left_x': new_top_left_x_2, - 'top_left_y': new_top_left_y_2, - 'box_w': new_box_w_2, - 'box_h': new_box_h_2 - } - - path_to_box_specs[path + ('first',)] = first_box_specs - path_to_box_specs[path + ('second',)] = second_box_specs - - elif self._path_to_box(path)['type'] == 'box': - for box_id in box_ids_to_path: - if box_ids_to_path[box_id] == path: - number = box_id - html_figure = _add_html_text( - html_figure, number, - path_to_box_specs[path]['top_left_x'], - path_to_box_specs[path]['top_left_y'], - path_to_box_specs[path]['box_w'], - path_to_box_specs[path]['box_h'], - ) - - # display HTML representation - return IPython.display.HTML(html_figure) - - def insert(self, box, side='above', box_id=None, fill_percent=50): - """ - Insert a box into your dashboard layout. - - :param (dict) box: the box you are inserting into the dashboard. - :param (str) side: specifies where your new box is going to be placed - relative to the given 'box_id'. Valid values are 'above', 'below', - 'left', and 'right'. - :param (int) box_id: the box id which is used as a reference for the - insertion of the new box. Box ids are memoryless numbers that are - generated on-the-fly and assigned to boxes in the layout each time - .get_preview() is run. - :param (float) fill_percent: specifies the percentage of the container - box from the given 'side' that the new box occupies. For example - if you apply the method\n - .insert(box=new_box, box_id=2, side='left', fill_percent=20)\n - to a dashboard object, a new box is inserted 20% from the left - side of the box with id #2. Run .get_preview() to see the box ids - assigned to each box in the dashboard layout. - Default = 50 - Example: - ``` - import plotly.dashboard_objs as dashboard - - box_a = { - 'type': 'box', - 'boxType': 'plot', - 'fileId': 'username:some#', - 'title': 'box a' - } - - my_dboard = dashboard.Dashboard() - my_dboard.insert(box_a) - my_dboard.insert(box_a, 'left', 1) - my_dboard.insert(box_a, 'below', 2) - my_dboard.insert(box_a, 'right', 3) - my_dboard.insert(box_a, 'above', 4, fill_percent=20) - - my_dboard.get_preview() - ``` - """ - box_ids_to_path = self._compute_box_ids() - - # doesn't need box_id or side specified for first box - if self['layout'] is None: - self['layout'] = _container( - box, _empty_box(), size=MASTER_HEIGHT, sizeUnit='px' - ) - else: - if box_id is None: - raise exceptions.PlotlyError( - "Make sure the box_id is specfied if there is at least " - "one box in your dashboard." - ) - if box_id not in box_ids_to_path: - raise exceptions.PlotlyError(ID_NOT_VALID_MESSAGE) - - if fill_percent < 0 or fill_percent > 100: - raise exceptions.PlotlyError( - 'fill_percent must be a number between 0 and 100 ' - 'inclusive' - ) - if side == 'above': - old_box = self.get_box(box_id) - self._insert( - _container(box, old_box, direction='vertical', - size=fill_percent), - box_ids_to_path[box_id] - ) - elif side == 'below': - old_box = self.get_box(box_id) - self._insert( - _container(old_box, box, direction='vertical', - size=100 - fill_percent), - box_ids_to_path[box_id] - ) - elif side == 'left': - old_box = self.get_box(box_id) - self._insert( - _container(box, old_box, direction='horizontal', - size=fill_percent), - box_ids_to_path[box_id] - ) - elif side == 'right': - old_box = self.get_box(box_id) - self._insert( - _container(old_box, box, direction='horizontal', - size =100 - fill_percent), - box_ids_to_path[box_id] - ) - else: - raise exceptions.PlotlyError( - "If there is at least one box in your dashboard, you " - "must specify a valid side value. You must choose from " - "'above', 'below', 'left', and 'right'." - ) - - self._set_dashboard_size() - - def remove(self, box_id): - """ - Remove a box from the dashboard by its box_id. - - Example: - ``` - import plotly.dashboard_objs as dashboard - - box_a = { - 'type': 'box', - 'boxType': 'plot', - 'fileId': 'username:some#', - 'title': 'box a' - } - - my_dboard = dashboard.Dashboard() - my_dboard.insert(box_a) - my_dboard.remove(1) - my_dboard.get_preview() - ``` - """ - box_ids_to_path = self._compute_box_ids() - if box_id not in box_ids_to_path: - raise exceptions.PlotlyError(ID_NOT_VALID_MESSAGE) - - path = box_ids_to_path[box_id] - if path != ('first',): - container_for_box_id = self._path_to_box(path[:-1]) - if path[-1] == 'first': - adjacent_path = 'second' - elif path[-1] == 'second': - adjacent_path = 'first' - adjacent_box = container_for_box_id[adjacent_path] - - self._insert(adjacent_box, path[:-1]) - else: - self['layout'] = None - - self._set_dashboard_size() - - def swap(self, box_id_1, box_id_2): - """ - Swap two boxes with their specified ids. - - Example: - ``` - import plotly.dashboard_objs as dashboard - - box_a = { - 'type': 'box', - 'boxType': 'plot', - 'fileId': 'username:first#', - 'title': 'box a' - } - - box_b = { - 'type': 'box', - 'boxType': 'plot', - 'fileId': 'username:second#', - 'title': 'box b' - } - - my_dboard = dashboard.Dashboard() - my_dboard.insert(box_a) - my_dboard.insert(box_b, 'above', 1) - - # check box at box id 1 - box_at_1 = my_dboard.get_box(1) - print(box_at_1) - - my_dboard.swap(1, 2) - - box_after_swap = my_dboard.get_box(1) - print(box_after_swap) - ``` - """ - box_ids_to_path = self._compute_box_ids() - box_a = self.get_box(box_id_1) - box_b = self.get_box(box_id_2) - - box_a_path = box_ids_to_path[box_id_1] - box_b_path = box_ids_to_path[box_id_2] - - for pairs in [(box_a_path, box_b), (box_b_path, box_a)]: - loc_in_dashboard = self['layout'] - for first_second in pairs[0][:-1]: - loc_in_dashboard = loc_in_dashboard[first_second] - loc_in_dashboard[pairs[0][-1]] = pairs[1] diff --git a/plotly/exceptions.py b/plotly/exceptions.py index e4f84e70dd4..9c2ee01c258 100644 --- a/plotly/exceptions.py +++ b/plotly/exceptions.py @@ -1,174 +1,6 @@ -""" -exceptions -========== +from _plotly_utils.exceptions import * -A module that contains plotly's exception hierarchy. - -""" -from __future__ import absolute_import - -from plotly.api.utils import to_native_utf8_string - - -# Base Plotly Error -class PlotlyError(Exception): - pass - - -class InputError(PlotlyError): - pass - - -class PlotlyRequestError(PlotlyError): - """General API error. Raised for *all* failed requests.""" - - def __init__(self, message, status_code, content): - self.message = to_native_utf8_string(message) - self.status_code = status_code - self.content = content - - def __str__(self): - return self.message - - -# Grid Errors -COLUMN_NOT_YET_UPLOADED_MESSAGE = ( - "Hm... it looks like your column '{column_name}' hasn't " - "been uploaded to Plotly yet. You need to upload your " - "column to Plotly before you can assign it to '{reference}'.\n" - "To upload, try `plotly.plotly.grid_objs.upload` or " - "`plotly.plotly.grid_objs.append_column`.\n" - "Questions? chris@plot.ly" -) - -NON_UNIQUE_COLUMN_MESSAGE = ( - "Yikes, plotly grids currently " - "can't have duplicate column names. Rename " - "the column \"{0}\" and try again." -) - - -class PlotlyEmptyDataError(PlotlyError): - pass - - -# Graph Objects Errors -class PlotlyGraphObjectError(PlotlyError): - def __init__(self, message='', path=(), notes=()): - """ - General graph object error for validation failures. - - :param (str|unicode) message: The error message. - :param (iterable) path: A path pointing to the error. - :param notes: Add additional notes, but keep default exception message. - - """ - self.message = message - self.plain_message = message # for backwards compat - self.path = list(path) - self.notes = notes - super(PlotlyGraphObjectError, self).__init__(message) - - def __str__(self): - """This is called by Python to present the error message.""" - format_dict = { - 'message': self.message, - 'path': '[' + ']['.join(repr(k) for k in self.path) + ']', - 'notes': '\n'.join(self.notes) - } - return ('{message}\n\nPath To Error: {path}\n\n{notes}' - .format(**format_dict)) - - -class PlotlyDictKeyError(PlotlyGraphObjectError): - def __init__(self, obj, path, notes=()): - """See PlotlyGraphObjectError.__init__ for param docs.""" - format_dict = {'attribute': path[-1], 'object_name': obj._name} - message = ("'{attribute}' is not allowed in '{object_name}'" - .format(**format_dict)) - notes = [obj.help(return_help=True)] + list(notes) - super(PlotlyDictKeyError, self).__init__( - message=message, path=path, notes=notes - ) - - -class PlotlyDictValueError(PlotlyGraphObjectError): - def __init__(self, obj, path, notes=()): - """See PlotlyGraphObjectError.__init__ for param docs.""" - format_dict = {'attribute': path[-1], 'object_name': obj._name} - message = ("'{attribute}' has invalid value inside '{object_name}'" - .format(**format_dict)) - notes = [obj.help(path[-1], return_help=True)] + list(notes) - super(PlotlyDictValueError, self).__init__( - message=message, notes=notes, path=path - ) - - -class PlotlyListEntryError(PlotlyGraphObjectError): - def __init__(self, obj, path, notes=()): - """See PlotlyGraphObjectError.__init__ for param docs.""" - format_dict = {'index': path[-1], 'object_name': obj._name} - message = ("Invalid entry found in '{object_name}' at index, '{index}'" - .format(**format_dict)) - notes = [obj.help(return_help=True)] + list(notes) - super(PlotlyListEntryError, self).__init__( - message=message, path=path, notes=notes - ) - - -class PlotlyDataTypeError(PlotlyGraphObjectError): - def __init__(self, obj, path, notes=()): - """See PlotlyGraphObjectError.__init__ for param docs.""" - format_dict = {'index': path[-1], 'object_name': obj._name} - message = ("Invalid entry found in '{object_name}' at index, '{index}'" - .format(**format_dict)) - note = "It's invalid because it doesn't contain a valid 'type' value." - notes = [note] + list(notes) - super(PlotlyDataTypeError, self).__init__( - message=message, path=path, notes=notes - ) - - -# Local Config Errors -class PlotlyLocalError(PlotlyError): - pass - - -class PlotlyLocalCredentialsError(PlotlyLocalError): - def __init__(self): - message = ( - "\n" - "Couldn't find a 'username', 'api-key' pair for you on your local " - "machine. To sign in temporarily (until you stop running Python), " - "run:\n" - ">>> import plotly.plotly as py\n" - ">>> py.sign_in('username', 'api_key')\n\n" - "Even better, save your credentials permanently using the 'tools' " - "module:\n" - ">>> import plotly.tools as tls\n" - ">>> tls.set_credentials_file(username='username', " - "api_key='api-key')\n\n" - "For more help, see https://plot.ly/python.\n" - ) - super(PlotlyLocalCredentialsError, self).__init__(message) - - -# Server Errors -class PlotlyServerError(PlotlyError): - pass - - -class PlotlyConnectionError(PlotlyServerError): - pass - - -class PlotlyCredentialError(PlotlyServerError): - pass - - -class PlotlyAccountError(PlotlyServerError): - pass - - -class PlotlyRateLimitError(PlotlyServerError): - pass +# Deprecations +from _plotly_future_ import _future_flags +if 'remove_deprecations' not in _future_flags: + from chart_studio.exceptions import * diff --git a/plotly/figure_factory/_2d_density.py b/plotly/figure_factory/_2d_density.py index 34f7a95900b..585942b8f1a 100644 --- a/plotly/figure_factory/_2d_density.py +++ b/plotly/figure_factory/_2d_density.py @@ -2,9 +2,9 @@ from numbers import Number -from plotly import exceptions +import plotly.exceptions + import plotly.colors as clrs -from plotly.figure_factory import utils from plotly.graph_objs import graph_objs @@ -91,13 +91,13 @@ def create_2d_density(x, y, colorscale='Earth', ncontours=20, # validate x and y are filled with numbers only for array in [x, y]: if not all(isinstance(element, Number) for element in array): - raise exceptions.PlotlyError( + raise plotly.exceptions.PlotlyError( "All elements of your 'x' and 'y' lists must be numbers." ) # validate x and y are the same length if len(x) != len(y): - raise exceptions.PlotlyError( + raise plotly.exceptions.PlotlyError( "Both lists 'x' and 'y' must be the same length." ) diff --git a/plotly/figure_factory/_bullet.py b/plotly/figure_factory/_bullet.py index f37b0f0e3f4..9ef776cde76 100644 --- a/plotly/figure_factory/_bullet.py +++ b/plotly/figure_factory/_bullet.py @@ -252,7 +252,7 @@ def create_bullet(data, markers=None, measures=None, ranges=None, """ # validate df if not pd: - raise exceptions.ImportError( + raise ImportError( "'pandas' must be installed for this figure factory." ) diff --git a/plotly/figure_factory/_county_choropleth.py b/plotly/figure_factory/_county_choropleth.py index 4e0f33462da..684c7147743 100644 --- a/plotly/figure_factory/_county_choropleth.py +++ b/plotly/figure_factory/_county_choropleth.py @@ -1,8 +1,3 @@ -from plotly import exceptions, optional_imports -import plotly.colors as clrs - -from plotly.figure_factory import utils - import io import numpy as np import os @@ -12,6 +7,11 @@ from math import log, floor from numbers import Number +from plotly import optional_imports +import plotly.colors as clrs +from plotly.figure_factory import utils +from plotly.exceptions import PlotlyError + pd.options.mode.chained_assignment = None shapely = optional_imports.get_module('shapely') @@ -606,7 +606,7 @@ def create_choropleth(fips, values, scope=['usa'], binning_endpoints=None, centroid_marker.update({'opacity': 1}) if len(fips) != len(values): - raise exceptions.PlotlyError( + raise PlotlyError( 'fips and values must be the same length' ) @@ -634,7 +634,7 @@ def create_choropleth(fips, values, scope=['usa'], binning_endpoints=None, if same_sets and no_duplicates: LEVELS = order else: - raise exceptions.PlotlyError( + raise PlotlyError( 'if you are using a custom order of unique values from ' 'your color column, you must: have all the unique values ' 'in your order and have no duplicate items' @@ -682,7 +682,7 @@ def create_choropleth(fips, values, scope=['usa'], binning_endpoints=None, colorscale.append(int_rgb) if len(colorscale) < len(LEVELS): - raise exceptions.PlotlyError( + raise PlotlyError( "You have {} LEVELS. Your number of colors in 'colorscale' must " "be at least the number of LEVELS: {}. If you are " "using 'binning_endpoints' then 'colorscale' must have at " @@ -697,7 +697,7 @@ def create_choropleth(fips, values, scope=['usa'], binning_endpoints=None, # scope if isinstance(scope, str): - raise exceptions.PlotlyError( + raise PlotlyError( "'scope' must be a list/tuple/sequence" ) diff --git a/plotly/figure_factory/_facet_grid.py b/plotly/figure_factory/_facet_grid.py index 5ac1a260045..f1a73a2c4f6 100644 --- a/plotly/figure_factory/_facet_grid.py +++ b/plotly/figure_factory/_facet_grid.py @@ -769,7 +769,7 @@ def create_facet_grid(df, x=None, y=None, facet_row=None, facet_col=None, ``` """ if not pd: - raise exceptions.ImportError( + raise ImportError( "'pandas' must be installed for this figure_factory." ) diff --git a/plotly/figure_factory/_quiver.py b/plotly/figure_factory/_quiver.py index ef9d00e80dd..4031c27b94f 100644 --- a/plotly/figure_factory/_quiver.py +++ b/plotly/figure_factory/_quiver.py @@ -119,8 +119,8 @@ def create_quiver(x, y, u, v, scale=.1, arrow_scale=.3, quiver_obj = _Quiver(x, y, u, v, scale, arrow_scale, angle, scaleratio) barb_x, barb_y = quiver_obj.get_barbs() - arrow_x, arrow_y = quiver_obj.get_quiver_arrows() - + arrow_x, arrow_y = quiver_obj.get_quiver_arrows() + quiver_plot = graph_objs.Scatter(x=barb_x + arrow_x, y=barb_y + arrow_y, mode='lines', **kwargs) diff --git a/plotly/figure_factory/_violin.py b/plotly/figure_factory/_violin.py index 9aaf74f8628..20aa5c18305 100644 --- a/plotly/figure_factory/_violin.py +++ b/plotly/figure_factory/_violin.py @@ -4,7 +4,6 @@ from plotly import exceptions, optional_imports import plotly.colors as clrs -from plotly.figure_factory import utils from plotly.graph_objs import graph_objs from plotly.tools import make_subplots diff --git a/plotly/files.py b/plotly/files.py index 661382bc576..453d17a3f29 100644 --- a/plotly/files.py +++ b/plotly/files.py @@ -1,55 +1,6 @@ -import os +from _plotly_utils.files import * -# file structure -PLOTLY_DIR = os.environ.get("PLOTLY_DIR", - os.path.join(os.path.expanduser("~"), ".plotly")) - -CREDENTIALS_FILE = os.path.join(PLOTLY_DIR, ".credentials") -CONFIG_FILE = os.path.join(PLOTLY_DIR, ".config") -TEST_FILE = os.path.join(PLOTLY_DIR, ".permission_test") - -# this sets both the DEFAULTS and the TYPES for these files -FILE_CONTENT = {CREDENTIALS_FILE: {'username': '', - 'api_key': '', - 'proxy_username': '', - 'proxy_password': '', - 'stream_ids': []}, - CONFIG_FILE: {'plotly_domain': 'https://plot.ly', - 'plotly_streaming_domain': 'stream.plot.ly', - 'plotly_api_domain': 'https://api.plot.ly', - 'plotly_ssl_verification': True, - 'plotly_proxy_authorization': False, - 'world_readable': True, - 'sharing': 'public', - 'auto_open': True}} - - -def _permissions(): - try: - if not os.path.exists(PLOTLY_DIR): - try: - os.mkdir(PLOTLY_DIR) - except Exception: - # in case of race - if not os.path.isdir(PLOTLY_DIR): - raise - with open(TEST_FILE, 'w') as f: - f.write('testing\n') - try: - os.remove(TEST_FILE) - except Exception: - pass - return True - except Exception: # Do not trap KeyboardInterrupt. - return False - - -_file_permissions = None - - -def ensure_writable_plotly_dir(): - # Cache permissions status - global _file_permissions - if _file_permissions is None: - _file_permissions = _permissions() - return _file_permissions +# Deprecations +from _plotly_future_ import _future_flags +if 'remove_deprecations' not in _future_flags: + from chart_studio.files import * diff --git a/plotly/graph_objs/__init__.py b/plotly/graph_objs/__init__.py index 0f56dfcf515..48b44c38a3c 100644 --- a/plotly/graph_objs/__init__.py +++ b/plotly/graph_objs/__init__.py @@ -1,80 +1,74052 @@ -from ._violin import Violin + + +from plotly.basedatatypes import BaseLayoutType as _BaseLayoutType +import copy as _copy + + +class Layout(_BaseLayoutType): + + # angularaxis + # ----------- + @property + def angularaxis(self): + """ + The 'angularaxis' property is an instance of AngularAxis + that may be specified as: + - An instance of 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. + endpadding + Legacy polar charts are deprecated! Please + switch to "polar" subplots. + range + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Defines the start + and end point of this angular axis. + showline + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Determines whether + or not the line bounding this angular axis will + be shown on the figure. + showticklabels + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Determines whether + or not the angular axis ticks will feature tick + labels. + tickcolor + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the color of + the tick lines on this angular axis. + ticklen + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the length of + the tick lines on this angular axis. + tickorientation + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the + orientation (from the paper perspective) of the + angular axis tick labels. + ticksuffix + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the length of + the tick lines on this angular axis. + visible + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Determines whether + or not this axis will be visible. + + Returns + ------- + plotly.graph_objs.layout.AngularAxis + """ + return self['angularaxis'] + + @angularaxis.setter + def angularaxis(self, val): + self['angularaxis'] = val + + # annotations + # ----------- + @property + def annotations(self): + """ + The 'annotations' property is a tuple of instances of + Annotation that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.Annotation + - A list or tuple of dicts of string/value properties that + will be passed to the Annotation constructor + + Supported dict properties: + + align + Sets the horizontal alignment of the `text` + within the box. Has an effect only if `text` + spans more two or more lines (i.e. `text` + contains one or more
HTML tags) or if an + explicit width is set to override the text + width. + arrowcolor + Sets the color of the annotation arrow. + arrowhead + Sets the end annotation arrow head style. + arrowside + Sets the annotation arrow head position. + arrowsize + Sets the size of the end annotation arrow head, + relative to `arrowwidth`. A value of 1 + (default) gives a head about 3x as wide as the + line. + arrowwidth + Sets the width (in px) of annotation arrow + line. + ax + Sets the x component of the arrow tail about + the arrow head. If `axref` is `pixel`, a + positive (negative) component corresponds to + an arrow pointing from right to left (left to + right). If `axref` is an axis, this is an + absolute value on that axis, like `x`, NOT a + relative value. + axref + Indicates in what terms the tail of the + annotation (ax,ay) is specified. If `pixel`, + `ax` is a relative offset in pixels from `x`. + If set to an x axis id (e.g. "x" or "x2"), `ax` + is specified in the same terms as that axis. + This is useful for trendline annotations which + should continue to indicate the correct trend + when zoomed. + ay + Sets the y component of the arrow tail about + the arrow head. If `ayref` is `pixel`, a + positive (negative) component corresponds to + an arrow pointing from bottom to top (top to + bottom). If `ayref` is an axis, this is an + absolute value on that axis, like `y`, NOT a + relative value. + ayref + Indicates in what terms the tail of the + annotation (ax,ay) is specified. If `pixel`, + `ay` is a relative offset in pixels from `y`. + If set to a y axis id (e.g. "y" or "y2"), `ay` + is specified in the same terms as that axis. + This is useful for trendline annotations which + should continue to indicate the correct trend + when zoomed. + bgcolor + Sets the background color of the annotation. + bordercolor + Sets the color of the border enclosing the + annotation `text`. + borderpad + Sets the padding (in px) between the `text` and + the enclosing border. + borderwidth + Sets the width (in px) of the border enclosing + the annotation `text`. + captureevents + Determines whether the annotation text box + captures mouse move and click events, or allows + those events to pass through to data points in + the plot that may be behind the annotation. By + default `captureevents` is False unless + `hovertext` is provided. If you use the event + `plotly_clickannotation` without `hovertext` + you must explicitly enable `captureevents`. + clicktoshow + Makes this annotation respond to clicks on the + plot. If you click a data point that exactly + matches the `x` and `y` values of this + annotation, and it is hidden (visible: false), + it will appear. In "onoff" mode, you must click + the same point again to make it disappear, so + if you click multiple points, you can show + multiple annotations. In "onout" mode, a click + anywhere else in the plot (on another data + point or not) will hide this annotation. If you + need to show/hide this annotation in response + to different `x` or `y` values, you can set + `xclick` and/or `yclick`. This is useful for + example to label the side of a bar. To label + markers though, `standoff` is preferred over + `xclick` and `yclick`. + font + Sets the annotation text font. + height + Sets an explicit height for the text box. null + (default) lets the text set the box height. + Taller text will be clipped. + hoverlabel + plotly.graph_objs.layout.annotation.Hoverlabel + instance or dict with compatible properties + hovertext + Sets text to appear when hovering over this + annotation. If omitted or blank, no hover label + will appear. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + opacity + Sets the opacity of the annotation (text + + arrow). + showarrow + Determines whether or not the annotation is + drawn with an arrow. If True, `text` is placed + near the arrow's tail. If False, `text` lines + up with the `x` and `y` provided. + standoff + Sets a distance, in pixels, to move the end + arrowhead away from the position it is pointing + at, for example to point at the edge of a + marker independent of zoom. Note that this + shortens the arrow from the `ax` / `ay` vector, + in contrast to `xshift` / `yshift` which moves + everything by this amount. + startarrowhead + Sets the start annotation arrow head style. + startarrowsize + Sets the size of the start annotation arrow + head, relative to `arrowwidth`. A value of 1 + (default) gives a head about 3x as wide as the + line. + startstandoff + Sets a distance, in pixels, to move the start + arrowhead away from the position it is pointing + at, for example to point at the edge of a + marker independent of zoom. Note that this + shortens the arrow from the `ax` / `ay` vector, + in contrast to `xshift` / `yshift` which moves + everything by this amount. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + text + Sets the text associated with this annotation. + Plotly uses a subset of HTML tags to do things + like newline (
), bold (), italics + (), hyperlinks (). + Tags , , are also + supported. + textangle + Sets the angle at which the `text` is drawn + with respect to the horizontal. + valign + Sets the vertical alignment of the `text` + within the box. Has an effect only if an + explicit height is set to override the text + height. + visible + Determines whether or not this annotation is + visible. + width + Sets an explicit width for the text box. null + (default) lets the text set the box width. + Wider text will be clipped. There is no + automatic wrapping; use
to start a new + line. + x + Sets the annotation's x position. If the axis + `type` is "log", then you must take the log of + your desired range. If the axis `type` is + "date", it should be date strings, like date + data, though Date objects and unix milliseconds + will be accepted and converted to strings. If + the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order + it appears. + xanchor + Sets the text box's horizontal position anchor + This anchor binds the `x` position to the + "left", "center" or "right" of the annotation. + For example, if `x` is set to 1, `xref` to + "paper" and `xanchor` to "right" then the + right-most portion of the annotation lines up + with the right-most edge of the plotting area. + If "auto", the anchor is equivalent to "center" + for data-referenced annotations or if there is + an arrow, whereas for paper-referenced with no + arrow, the anchor picked corresponds to the + closest side. + xclick + Toggle this annotation when clicking a data + point whose `x` value is `xclick` rather than + the annotation's `x` value. + xref + Sets the annotation's x coordinate axis. If set + to an x axis id (e.g. "x" or "x2"), the `x` + position refers to an x coordinate If set to + "paper", the `x` position refers to the + distance from the left side of the plotting + area in normalized coordinates where 0 (1) + corresponds to the left (right) side. + xshift + Shifts the position of the whole annotation and + arrow to the right (positive) or left + (negative) by this many pixels. + y + Sets the annotation's y position. If the axis + `type` is "log", then you must take the log of + your desired range. If the axis `type` is + "date", it should be date strings, like date + data, though Date objects and unix milliseconds + will be accepted and converted to strings. If + the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order + it appears. + yanchor + Sets the text box's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the annotation. + For example, if `y` is set to 1, `yref` to + "paper" and `yanchor` to "top" then the top- + most portion of the annotation lines up with + the top-most edge of the plotting area. If + "auto", the anchor is equivalent to "middle" + for data-referenced annotations or if there is + an arrow, whereas for paper-referenced with no + arrow, the anchor picked corresponds to the + closest side. + yclick + Toggle this annotation when clicking a data + point whose `y` value is `yclick` rather than + the annotation's `y` value. + yref + Sets the annotation's y coordinate axis. If set + to an y axis id (e.g. "y" or "y2"), the `y` + position refers to an y coordinate If set to + "paper", the `y` position refers to the + distance from the bottom of the plotting area + in normalized coordinates where 0 (1) + corresponds to the bottom (top). + yshift + Shifts the position of the whole annotation and + arrow up (positive) or down (negative) by this + many pixels. + + Returns + ------- + tuple[plotly.graph_objs.layout.Annotation] + """ + return self['annotations'] + + @annotations.setter + def annotations(self, val): + self['annotations'] = val + + # annotationdefaults + # ------------------ + @property + 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 plotly.graph_objs.layout.Annotation + - A dict of string/value properties that will be passed + to the Annotation constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.layout.Annotation + """ + return self['annotationdefaults'] + + @annotationdefaults.setter + def annotationdefaults(self, val): + self['annotationdefaults'] = val + + # autosize + # -------- + @property + def autosize(self): + """ + Determines whether or not a layout width or height that has + been left undefined by the user is initialized on each + relayout. Note that, regardless of this attribute, an undefined + layout width or height is always initialized on the first call + to plot. + + The 'autosize' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autosize'] + + @autosize.setter + def autosize(self, val): + self['autosize'] = val + + # bargap + # ------ + @property + 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] + + Returns + ------- + int|float + """ + return self['bargap'] + + @bargap.setter + def bargap(self, val): + self['bargap'] = val + + # bargroupgap + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['bargroupgap'] + + @bargroupgap.setter + def bargroupgap(self, val): + self['bargroupgap'] = val + + # barmode + # ------- + @property + def barmode(self): + """ + Determines how bars at the same location coordinate are + displayed on the graph. With "stack", the bars are stacked on + top of one another With "relative", the bars are stacked on top + of one another, with negative values below the axis, positive + values above With "group", the bars are plotted next to one + another centered around the shared location. With "overlay", + the bars are plotted over one another, you might need to an + "opacity" to see multiple bars. + + The 'barmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['stack', 'group', 'overlay', 'relative'] + + Returns + ------- + Any + """ + return self['barmode'] + + @barmode.setter + def barmode(self, val): + self['barmode'] = val + + # barnorm + # ------- + @property + def barnorm(self): + """ + Sets the normalization for bar traces on the graph. With + "fraction", the value of each bar is divided by the sum of all + values at that location coordinate. "percent" is the same but + multiplied by 100 to show percentages. + + The 'barnorm' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', 'fraction', 'percent'] + + Returns + ------- + Any + """ + return self['barnorm'] + + @barnorm.setter + def barnorm(self, val): + self['barnorm'] = val + + # boxgap + # ------ + @property + 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] + + Returns + ------- + int|float + """ + return self['boxgap'] + + @boxgap.setter + def boxgap(self, val): + self['boxgap'] = val + + # boxgroupgap + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['boxgroupgap'] + + @boxgroupgap.setter + def boxgroupgap(self, val): + self['boxgroupgap'] = val + + # boxmode + # ------- + @property + def boxmode(self): + """ + Determines how boxes at the same location coordinate are + displayed on the graph. If "group", the boxes are plotted next + to one another centered around the shared location. If + "overlay", the boxes are plotted over one another, you might + need to set "opacity" to see them multiple boxes. Has no effect + on traces that have "width" set. + + The 'boxmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['group', 'overlay'] + + Returns + ------- + Any + """ + return self['boxmode'] + + @boxmode.setter + def boxmode(self, val): + self['boxmode'] = val + + # calendar + # -------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['calendar'] + + @calendar.setter + def calendar(self, val): + self['calendar'] = val + + # clickmode + # --------- + @property + def clickmode(self): + """ + Determines the mode of single click interactions. "event" is + the default value and emits the `plotly_click` event. In + addition this mode emits the `plotly_selected` event in drag + modes "lasso" and "select", but with no event data attached + (kept for compatibility reasons). The "select" flag enables + selecting single data points via click. This mode also supports + persistent selections, meaning that pressing Shift while + clicking, adds to / subtracts from an existing selection. + "select" with `hovermode`: "x" can be confusing, consider + explicitly setting `hovermode`: "closest" when using this + feature. Selection events are sent accordingly as long as + "event" flag is set as well. When the "event" flag is missing, + `plotly_click` and `plotly_selected` events are not fired. + + The 'clickmode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['event', 'select'] joined with '+' characters + (e.g. 'event+select') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self['clickmode'] + + @clickmode.setter + def clickmode(self, val): + self['clickmode'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + The 'colorscale' property is an instance of Colorscale + that may be specified as: + - An instance of plotly.graph_objs.layout.Colorscale + - A dict of string/value properties that will be passed + to the Colorscale constructor + + Supported dict properties: + + diverging + Sets the default diverging colorscale. Note + that `autocolorscale` must be true for this + attribute to work. + sequential + Sets the default sequential colorscale for + positive values. Note that `autocolorscale` + must be true for this attribute to work. + sequentialminus + Sets the default sequential colorscale for + negative values. Note that `autocolorscale` + must be true for this attribute to work. + + Returns + ------- + plotly.graph_objs.layout.Colorscale + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorway + # -------- + @property + 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 + + Returns + ------- + list + """ + return self['colorway'] + + @colorway.setter + def colorway(self, val): + self['colorway'] = val + + # datarevision + # ------------ + @property + def datarevision(self): + """ + If provided, a changed value tells `Plotly.react` that one or + more data arrays has changed. This way you can modify arrays + in-place rather than making a complete new copy for an + incremental change. If NOT provided, `Plotly.react` assumes + that data arrays are being treated as immutable, thus any data + array with a different identity from its predecessor contains + new data. + + The 'datarevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['datarevision'] + + @datarevision.setter + def datarevision(self, val): + self['datarevision'] = val + + # direction + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['direction'] + + @direction.setter + def direction(self, val): + self['direction'] = val + + # dragmode + # -------- + @property + 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', 'orbit', 'turntable', + False] + + Returns + ------- + Any + """ + return self['dragmode'] + + @dragmode.setter + def dragmode(self, val): + self['dragmode'] = val + + # editrevision + # ------------ + @property + 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 + ------- + Any + """ + return self['editrevision'] + + @editrevision.setter + def editrevision(self, val): + self['editrevision'] = val + + # extendpiecolors + # --------------- + @property + def extendpiecolors(self): + """ + If `true`, the pie slice colors (whether given by `piecolorway` + or inherited from `colorway`) will be extended to three times + its original length by first repeating every color 20% lighter + then each color 20% darker. This is intended to reduce the + likelihood of reusing the same color when you have many slices, + but you can set `false` to disable. Colors provided in the + trace, using `marker.colors`, are never extended. + + The 'extendpiecolors' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['extendpiecolors'] + + @extendpiecolors.setter + def extendpiecolors(self, val): + self['extendpiecolors'] = val + + # font + # ---- + @property + 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 plotly.graph_objs.layout.Font + - A dict of string/value properties that will be passed + to the Font constructor + + Supported dict properties: + + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # geo + # --- + @property + def geo(self): + """ + The 'geo' property is an instance of Geo + that may be specified as: + - An instance of 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 + plotly.graph_objs.layout.geo.Center instance or + dict with compatible properties + coastlinecolor + Sets the coastline color. + coastlinewidth + Sets the coastline stroke width (in px). + countrycolor + Sets line color of the country boundaries. + countrywidth + Sets line width (in px) of the country + boundaries. + domain + plotly.graph_objs.layout.geo.Domain instance or + dict with compatible properties + framecolor + Sets the color the frame. + framewidth + Sets the stroke width (in px) of the frame. + lakecolor + Sets the color of the lakes. + landcolor + Sets the land mass color. + lataxis + plotly.graph_objs.layout.geo.Lataxis instance + or dict with compatible properties + lonaxis + plotly.graph_objs.layout.geo.Lonaxis instance + or dict with compatible properties + oceancolor + Sets the ocean color + projection + plotly.graph_objs.layout.geo.Projection + instance or dict with compatible properties + resolution + Sets the resolution of the base layers. The + values have units of km/mm e.g. 110 corresponds + to a scale ratio of 1:110,000,000. + rivercolor + Sets color of the rivers. + riverwidth + Sets the stroke width (in px) of the rivers. + scope + Set the scope of the map. + showcoastlines + Sets whether or not the coastlines are drawn. + showcountries + Sets whether or not country boundaries are + drawn. + showframe + Sets whether or not a frame is drawn around the + map. + showlakes + Sets whether or not lakes are drawn. + showland + Sets whether or not land masses are filled in + color. + showocean + Sets whether or not oceans are filled in color. + showrivers + Sets whether or not rivers are drawn. + showsubunits + Sets whether or not boundaries of subunits + within countries (e.g. states, provinces) are + drawn. + subunitcolor + Sets the color of the subunits boundaries. + subunitwidth + Sets the stroke width (in px) of the subunits + boundaries. + uirevision + Controls persistence of user-driven changes in + the view (projection and center). Defaults to + `layout.uirevision`. + + Returns + ------- + plotly.graph_objs.layout.Geo + """ + return self['geo'] + + @geo.setter + def geo(self, val): + self['geo'] = val + + # grid + # ---- + @property + def grid(self): + """ + The 'grid' property is an instance of Grid + that may be specified as: + - An instance of plotly.graph_objs.layout.Grid + - A dict of string/value properties that will be passed + to the Grid constructor + + Supported dict properties: + + columns + The number of columns in the grid. If you + provide a 2D `subplots` array, the length of + its longest row is used as the default. If you + give an `xaxes` array, its length is used as + the default. But it's also possible to have a + different length, if you want to leave a row at + the end for non-cartesian subplots. + domain + plotly.graph_objs.layout.grid.Domain instance + or dict with compatible properties + pattern + If no `subplots`, `xaxes`, or `yaxes` are given + but we do have `rows` and `columns`, we can + generate defaults using consecutive axis IDs, + in two ways: "coupled" gives one x axis per + column and one y axis per row. "independent" + uses a new xy pair for each cell, left-to-right + across each row then iterating rows according + to `roworder`. + roworder + Is the first row the top or the bottom? Note + that columns are always enumerated from left to + right. + rows + The number of rows in the grid. If you provide + a 2D `subplots` array or a `yaxes` array, its + length is used as the default. But it's also + possible to have a different length, if you + want to leave a row at the end for non- + cartesian subplots. + subplots + Used for freeform grids, where some axes may be + shared across subplots but others are not. Each + entry should be a cartesian subplot id, like + "xy" or "x3y2", or "" to leave that cell empty. + You may reuse x axes within the same column, + and y axes within the same row. Non-cartesian + subplots and traces that support `domain` can + place themselves in this grid separately using + the `gridcell` attribute. + xaxes + Used with `yaxes` when the x and y axes are + shared across columns and rows. Each entry + should be an x axis id like "x", "x2", etc., or + "" to not put an x axis in that column. Entries + other than "" must be unique. Ignored if + `subplots` is present. If missing but `yaxes` + is present, will generate consecutive IDs. + xgap + Horizontal space between grid cells, expressed + as a fraction of the total width available to + one cell. Defaults to 0.1 for coupled-axes + grids and 0.2 for independent grids. + xside + Sets where the x axis labels and titles go. + "bottom" means the very bottom of the grid. + "bottom plot" is the lowest plot that each x + axis is used in. "top" and "top plot" are + similar. + yaxes + Used with `yaxes` when the x and y axes are + shared across columns and rows. Each entry + should be an y axis id like "y", "y2", etc., or + "" to not put a y axis in that row. Entries + other than "" must be unique. Ignored if + `subplots` is present. If missing but `xaxes` + is present, will generate consecutive IDs. + ygap + Vertical space between grid cells, expressed as + a fraction of the total height available to one + cell. Defaults to 0.1 for coupled-axes grids + and 0.3 for independent grids. + yside + Sets where the y axis labels and titles go. + "left" means the very left edge of the grid. + *left plot* is the leftmost plot that each y + axis is used in. "right" and *right plot* are + similar. + + Returns + ------- + plotly.graph_objs.layout.Grid + """ + return self['grid'] + + @grid.setter + def grid(self, val): + self['grid'] = val + + # height + # ------ + @property + 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] + + Returns + ------- + int|float + """ + return self['height'] + + @height.setter + def height(self, val): + self['height'] = val + + # hiddenlabels + # ------------ + @property + def hiddenlabels(self): + """ + The 'hiddenlabels' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['hiddenlabels'] + + @hiddenlabels.setter + def hiddenlabels(self, val): + self['hiddenlabels'] = val + + # hiddenlabelssrc + # --------------- + @property + def hiddenlabelssrc(self): + """ + Sets the source reference on plot.ly for hiddenlabels . + + The 'hiddenlabelssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hiddenlabelssrc'] + + @hiddenlabelssrc.setter + def hiddenlabelssrc(self, val): + self['hiddenlabelssrc'] = val + + # hidesources + # ----------- + @property + def hidesources(self): + """ + Determines whether or not a text link citing the data source is + placed at the bottom-right cored of the figure. Has only an + effect only on graphs that have been generated via forked + graphs from the plotly service (at https://plot.ly or on- + premise). + + The 'hidesources' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['hidesources'] + + @hidesources.setter + def hidesources(self, val): + self['hidesources'] = val + + # hoverdistance + # ------------- + @property + def hoverdistance(self): + """ + Sets the default distance (in pixels) to look for data to add + hover labels (-1 means no cutoff, 0 means no looking for data). + This is only a real distance for hovering on point-like + objects, like scatter points. For area-like objects (bars, + scatter fills, etc) hovering is on inside the area and off + outside, but these objects will not supersede hover on point- + like objects in case of conflict. + + The 'hoverdistance' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + + Returns + ------- + int + """ + return self['hoverdistance'] + + @hoverdistance.setter + def hoverdistance(self, val): + self['hoverdistance'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.layout.Hoverlabel + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Supported dict properties: + + bgcolor + Sets the background color of all hover labels + on graph + bordercolor + Sets the border color of all hover labels on + graph. + font + Sets the default hover label font used by all + traces on the graph. + namelength + Sets the default length (in number of + characters) of the trace name in the hover + labels for all traces. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 + characters, and an integer >3 will show the + whole name if it is less than that many + characters, but if it is longer, will truncate + to `namelength - 3` characters and add an + ellipsis. + + Returns + ------- + plotly.graph_objs.layout.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovermode + # --------- + @property + def hovermode(self): + """ + Determines the mode of hover interactions. If `clickmode` + includes the "select" flag, `hovermode` defaults to "closest". + If `clickmode` lacks the "select" flag, it defaults to "x" or + "y" (depending on the trace's `orientation` value) for plots + based on cartesian coordinates. For anything else the default + value is "closest". + + The 'hovermode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['x', 'y', 'closest', False] + + Returns + ------- + Any + """ + return self['hovermode'] + + @hovermode.setter + def hovermode(self, val): + self['hovermode'] = val + + # images + # ------ + @property + def images(self): + """ + The 'images' property is a tuple of instances of + Image that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.Image + - A list or tuple of dicts of string/value properties that + will be passed to the Image constructor + + Supported dict properties: + + layer + Specifies whether images are drawn below or + above traces. When `xref` and `yref` are both + set to `paper`, image is drawn below the entire + plot area. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + opacity + Sets the opacity of the image. + sizex + Sets the image container size horizontally. The + image will be sized based on the `position` + value. When `xref` is set to `paper`, units are + sized relative to the plot width. + sizey + Sets the image container size vertically. The + image will be sized based on the `position` + value. When `yref` is set to `paper`, units are + sized relative to the plot height. + sizing + Specifies which dimension of the image to + constrain. + source + Specifies the URL of the image to be used. The + URL must be accessible from the domain where + the plot code is run, and can be either + relative or absolute. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + visible + Determines whether or not this image is + visible. + x + Sets the image's x position. When `xref` is set + to `paper`, units are sized relative to the + plot height. See `xref` for more info + xanchor + Sets the anchor for the x position + xref + Sets the images's x coordinate axis. If set to + a x axis id (e.g. "x" or "x2"), the `x` + position refers to an x data coordinate If set + to "paper", the `x` position refers to the + distance from the left of plot in normalized + coordinates where 0 (1) corresponds to the left + (right). + y + Sets the image's y position. When `yref` is set + to `paper`, units are sized relative to the + plot height. See `yref` for more info + yanchor + Sets the anchor for the y position. + yref + Sets the images's y coordinate axis. If set to + a y axis id (e.g. "y" or "y2"), the `y` + position refers to a y data coordinate. If set + to "paper", the `y` position refers to the + distance from the bottom of the plot in + normalized coordinates where 0 (1) corresponds + to the bottom (top). + + Returns + ------- + tuple[plotly.graph_objs.layout.Image] + """ + return self['images'] + + @images.setter + def images(self, val): + self['images'] = val + + # imagedefaults + # ------------- + @property + 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 plotly.graph_objs.layout.Image + - A dict of string/value properties that will be passed + to the Image constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.layout.Image + """ + return self['imagedefaults'] + + @imagedefaults.setter + def imagedefaults(self, val): + self['imagedefaults'] = val + + # legend + # ------ + @property + def legend(self): + """ + The 'legend' property is an instance of Legend + that may be specified as: + - An instance of 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. + bordercolor + Sets the color of the border enclosing the + legend. + borderwidth + Sets the width (in px) of the border enclosing + the legend. + font + Sets the font used to text the legend items. + orientation + Sets the orientation of the legend. + tracegroupgap + Sets the amount of vertical space (in px) + between legend groups. + traceorder + Determines the order at which the legend items + are displayed. If "normal", the items are + displayed top-to-bottom in the same order as + the input data. If "reversed", the items are + displayed in the opposite order as "normal". If + "grouped", the items are displayed in groups + (when a trace `legendgroup` is provided). if + "grouped+reversed", the items are displayed in + the opposite order as "grouped". + uirevision + Controls persistence of legend-driven changes + in trace and pie label visibility. Defaults to + `layout.uirevision`. + valign + Sets the vertical alignment of the symbols with + respect to their associated text. + x + Sets the x position (in normalized coordinates) + of the legend. + xanchor + Sets the legend's horizontal position anchor. + This anchor binds the `x` position to the + "left", "center" or "right" of the legend. + y + Sets the y position (in normalized coordinates) + of the legend. + yanchor + Sets the legend's vertical position anchor This + anchor binds the `y` position to the "top", + "middle" or "bottom" of the legend. + + Returns + ------- + plotly.graph_objs.layout.Legend + """ + return self['legend'] + + @legend.setter + def legend(self, val): + self['legend'] = val + + # mapbox + # ------ + @property + def mapbox(self): + """ + The 'mapbox' property is an instance of Mapbox + that may be specified as: + - An instance of plotly.graph_objs.layout.Mapbox + - A dict of string/value properties that will be passed + to the Mapbox constructor + + Supported dict properties: + + accesstoken + Sets the mapbox access token to be used for + this mapbox map. Alternatively, the mapbox + access token can be set in the configuration + options under `mapboxAccessToken`. + bearing + Sets the bearing angle of the map in degrees + counter-clockwise from North (mapbox.bearing). + center + plotly.graph_objs.layout.mapbox.Center instance + or dict with compatible properties + domain + plotly.graph_objs.layout.mapbox.Domain instance + or dict with compatible properties + layers + plotly.graph_objs.layout.mapbox.Layer instance + or dict with compatible properties + layerdefaults + When used in a template (as + layout.template.layout.mapbox.layerdefaults), + sets the default property values to use for + elements of layout.mapbox.layers + pitch + Sets the pitch angle of the map (in degrees, + where 0 means perpendicular to the surface of + the map) (mapbox.pitch). + style + Sets the Mapbox map style. Either input one of + the default Mapbox style names or the URL to a + custom style or a valid Mapbox style JSON. + uirevision + Controls persistence of user-driven changes in + the view: `center`, `zoom`, `bearing`, `pitch`. + Defaults to `layout.uirevision`. + zoom + Sets the zoom level of the map (mapbox.zoom). + + Returns + ------- + plotly.graph_objs.layout.Mapbox + """ + return self['mapbox'] + + @mapbox.setter + def mapbox(self, val): + self['mapbox'] = val + + # margin + # ------ + @property + def margin(self): + """ + The 'margin' property is an instance of Margin + that may be specified as: + - An instance of plotly.graph_objs.layout.Margin + - A dict of string/value properties that will be passed + to the Margin constructor + + Supported dict properties: + + autoexpand + + b + Sets the bottom margin (in px). + l + Sets the left margin (in px). + pad + Sets the amount of padding (in px) between the + plotting area and the axis lines + r + Sets the right margin (in px). + t + Sets the top margin (in px). + + Returns + ------- + plotly.graph_objs.layout.Margin + """ + return self['margin'] + + @margin.setter + def margin(self, val): + self['margin'] = val + + # meta + # ---- + @property + def meta(self): + """ + Assigns extra meta information that can be used in various + `text` attributes. Attributes such as the graph, axis and + colorbar `title.text`, annotation `text` `trace.name` in legend + items, `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. One can access `meta` fields using + template strings: `%{meta[i]}` where `i` is the index of the + `meta` item in question. + + The 'meta' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['meta'] + + @meta.setter + def meta(self, val): + self['meta'] = val + + # metasrc + # ------- + @property + def metasrc(self): + """ + Sets the source reference on plot.ly for meta . + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['metasrc'] + + @metasrc.setter + def metasrc(self, val): + self['metasrc'] = val + + # modebar + # ------- + @property + def modebar(self): + """ + The 'modebar' property is an instance of Modebar + that may be specified as: + - An instance of 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. + bgcolor + Sets the background color of the modebar. + color + Sets the color of the icons in the modebar. + orientation + Sets the orientation of the modebar. + uirevision + Controls persistence of user-driven changes + related to the modebar, including `hovermode`, + `dragmode`, and `showspikes` at both the root + level and inside subplots. Defaults to + `layout.uirevision`. + + Returns + ------- + plotly.graph_objs.layout.Modebar + """ + return self['modebar'] + + @modebar.setter + def modebar(self, val): + self['modebar'] = val + + # orientation + # ----------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['orientation'] + + @orientation.setter + def orientation(self, val): + self['orientation'] = val + + # paper_bgcolor + # ------------- + @property + def paper_bgcolor(self): + """ + Sets the color of paper where the graph is drawn. + + The 'paper_bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['paper_bgcolor'] + + @paper_bgcolor.setter + def paper_bgcolor(self, val): + self['paper_bgcolor'] = val + + # piecolorway + # ----------- + @property + def piecolorway(self): + """ + Sets the default pie slice colors. Defaults to the main + `colorway` used for trace colors. If you specify a new list + here it can still be extended with lighter and darker colors, + see `extendpiecolors`. + + The 'piecolorway' property is a colorlist that may be specified + as a tuple, list, one-dimensional numpy array, or pandas Series of valid + color strings + + Returns + ------- + list + """ + return self['piecolorway'] + + @piecolorway.setter + def piecolorway(self, val): + self['piecolorway'] = val + + # plot_bgcolor + # ------------ + @property + def plot_bgcolor(self): + """ + Sets the color of plotting area in-between x and y axes. + + The 'plot_bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['plot_bgcolor'] + + @plot_bgcolor.setter + def plot_bgcolor(self, val): + self['plot_bgcolor'] = val + + # polar + # ----- + @property + def polar(self): + """ + The 'polar' property is an instance of Polar + that may be specified as: + - An instance of plotly.graph_objs.layout.Polar + - A dict of string/value properties that will be passed + to the Polar constructor + + Supported dict properties: + + angularaxis + plotly.graph_objs.layout.polar.AngularAxis + instance or dict with compatible properties + bargap + Sets the gap between bars of adjacent location + coordinates. Values are unitless, they + represent fractions of the minimum difference + in bar positions in the data. + barmode + Determines how bars at the same location + coordinate are displayed on the graph. With + "stack", the bars are stacked on top of one + another With "overlay", the bars are plotted + over one another, you might need to an + "opacity" to see multiple bars. + bgcolor + Set the background color of the subplot + domain + plotly.graph_objs.layout.polar.Domain instance + or dict with compatible properties + gridshape + Determines if the radial axis grid lines and + angular axis line are drawn as "circular" + sectors or as "linear" (polygon) sectors. Has + an effect only when the angular axis has `type` + "category". Note that `radialaxis.angle` is + snapped to the angle of the closest vertex when + `gridshape` is "circular" (so that radial axis + scale is the same as the data scale). + hole + Sets the fraction of the radius to cut out of + the polar subplot. + radialaxis + plotly.graph_objs.layout.polar.RadialAxis + instance or dict with compatible properties + sector + Sets angular span of this polar subplot with + two angles (in degrees). Sector are assumed to + be spanned in the counterclockwise direction + with 0 corresponding to rightmost limit of the + polar subplot. + uirevision + Controls persistence of user-driven changes in + axis attributes, if not overridden in the + individual axes. Defaults to + `layout.uirevision`. + + Returns + ------- + plotly.graph_objs.layout.Polar + """ + return self['polar'] + + @polar.setter + def polar(self, val): + self['polar'] = val + + # radialaxis + # ---------- + @property + def radialaxis(self): + """ + The 'radialaxis' property is an instance of RadialAxis + that may be specified as: + - An instance of 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. + endpadding + Legacy polar charts are deprecated! Please + switch to "polar" subplots. + orientation + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the + orientation (an angle with respect to the + origin) of the radial axis. + range + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Defines the start + and end point of this radial axis. + showline + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Determines whether + or not the line bounding this radial axis will + be shown on the figure. + showticklabels + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Determines whether + or not the radial axis ticks will feature tick + labels. + tickcolor + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the color of + the tick lines on this radial axis. + ticklen + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the length of + the tick lines on this radial axis. + tickorientation + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the + orientation (from the paper perspective) of the + radial axis tick labels. + ticksuffix + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the length of + the tick lines on this radial axis. + visible + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Determines whether + or not this axis will be visible. + + Returns + ------- + plotly.graph_objs.layout.RadialAxis + """ + return self['radialaxis'] + + @radialaxis.setter + def radialaxis(self, val): + self['radialaxis'] = val + + # scene + # ----- + @property + def scene(self): + """ + The 'scene' property is an instance of Scene + that may be specified as: + - An instance of plotly.graph_objs.layout.Scene + - A dict of string/value properties that will be passed + to the Scene constructor + + Supported dict properties: + + annotations + plotly.graph_objs.layout.scene.Annotation + instance or dict with compatible properties + annotationdefaults + When used in a template (as layout.template.lay + out.scene.annotationdefaults), sets the default + property values to use for elements of + layout.scene.annotations + aspectmode + If "cube", this scene's axes are drawn as a + cube, regardless of the axes' ranges. If + "data", this scene's axes are drawn in + proportion with the axes' ranges. If "manual", + this scene's axes are drawn in proportion with + the input of "aspectratio" (the default + behavior if "aspectratio" is provided). If + "auto", this scene's axes are drawn using the + results of "data" except when one axis is more + than four times the size of the two others, + where in that case the results of "cube" are + used. + aspectratio + Sets this scene's axis aspectratio. + bgcolor + + camera + plotly.graph_objs.layout.scene.Camera instance + or dict with compatible properties + domain + plotly.graph_objs.layout.scene.Domain instance + or dict with compatible properties + dragmode + Determines the mode of drag interactions for + this scene. + hovermode + Determines the mode of hover interactions for + this scene. + uirevision + Controls persistence of user-driven changes in + camera attributes. Defaults to + `layout.uirevision`. + xaxis + plotly.graph_objs.layout.scene.XAxis instance + or dict with compatible properties + yaxis + plotly.graph_objs.layout.scene.YAxis instance + or dict with compatible properties + zaxis + plotly.graph_objs.layout.scene.ZAxis instance + or dict with compatible properties + + Returns + ------- + plotly.graph_objs.layout.Scene + """ + return self['scene'] + + @scene.setter + def scene(self, val): + self['scene'] = val + + # selectdirection + # --------------- + @property + def selectdirection(self): + """ + When "dragmode" is set to "select", this limits the selection + of the drag to horizontal, vertical or diagonal. "h" only + allows horizontal selection, "v" only vertical, "d" only + diagonal and "any" sets no limit. + + The 'selectdirection' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v', 'd', 'any'] + + Returns + ------- + Any + """ + return self['selectdirection'] + + @selectdirection.setter + def selectdirection(self, val): + self['selectdirection'] = val + + # selectionrevision + # ----------------- + @property + def selectionrevision(self): + """ + Controls persistence of user-driven changes in selected points + from all traces. + + The 'selectionrevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectionrevision'] + + @selectionrevision.setter + def selectionrevision(self, val): + self['selectionrevision'] = val + + # separators + # ---------- + @property + def separators(self): + """ + Sets the decimal and thousand separators. For example, *. * + puts a '.' before decimals and a space between thousands. In + English locales, dflt is ".," but other locales may alter this + default. + + The 'separators' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['separators'] + + @separators.setter + def separators(self, val): + self['separators'] = val + + # shapes + # ------ + @property + def shapes(self): + """ + The 'shapes' property is a tuple of instances of + Shape that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.Shape + - A list or tuple of dicts of string/value properties that + will be passed to the Shape constructor + + Supported dict properties: + + fillcolor + Sets the color filling the shape's interior. + layer + Specifies whether shapes are drawn below or + above traces. + line + plotly.graph_objs.layout.shape.Line instance or + dict with compatible properties + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + opacity + Sets the opacity of the shape. + path + For `type` "path" - a valid SVG path with the + pixel values replaced by data values in + `xsizemode`/`ysizemode` being "scaled" and + taken unmodified as pixels relative to + `xanchor` and `yanchor` in case of "pixel" size + mode. There are a few restrictions / quirks + only absolute instructions, not relative. So + the allowed segments are: M, L, H, V, Q, C, T, + S, and Z arcs (A) are not allowed because + radius rx and ry are relative. In the future we + could consider supporting relative commands, + but we would have to decide on how to handle + date and log axes. Note that even as is, Q and + C Bezier paths that are smooth on linear axes + may not be smooth on log, and vice versa. no + chained "polybezier" commands - specify the + segment type for each one. On category axes, + values are numbers scaled to the serial numbers + of categories because using the categories + themselves there would be no way to describe + fractional positions On data axes: because + space and T are both normal components of path + strings, we can't use either to separate date + from time parts. Therefore we'll use underscore + for this purpose: 2015-02-21_13:45:56.789 + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + type + Specifies the shape type to be drawn. If + "line", a line is drawn from (`x0`,`y0`) to + (`x1`,`y1`) with respect to the axes' sizing + mode. If "circle", a circle is drawn from + ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius + (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 + -`y0`)|) with respect to the axes' sizing mode. + If "rect", a rectangle is drawn linking + (`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`), + (`x0`,`y1`), (`x0`,`y0`) with respect to the + axes' sizing mode. If "path", draw a custom SVG + path using `path`. with respect to the axes' + sizing mode. + visible + Determines whether or not this shape is + visible. + x0 + Sets the shape's starting x position. See + `type` and `xsizemode` for more info. + x1 + Sets the shape's end x position. See `type` and + `xsizemode` for more info. + xanchor + Only relevant in conjunction with `xsizemode` + set to "pixel". Specifies the anchor point on + the x axis to which `x0`, `x1` and x + coordinates within `path` are relative to. E.g. + useful to attach a pixel sized shape to a + certain data value. No effect when `xsizemode` + not set to "pixel". + xref + Sets the shape's x coordinate axis. If set to + an x axis id (e.g. "x" or "x2"), the `x` + position refers to an x coordinate. If set to + "paper", the `x` position refers to the + distance from the left side of the plotting + area in normalized coordinates where 0 (1) + corresponds to the left (right) side. If the + axis `type` is "log", then you must take the + log of your desired range. If the axis `type` + is "date", then you must convert the date to + unix time in milliseconds. + xsizemode + Sets the shapes's sizing mode along the x axis. + If set to "scaled", `x0`, `x1` and x + coordinates within `path` refer to data values + on the x axis or a fraction of the plot area's + width (`xref` set to "paper"). If set to + "pixel", `xanchor` specifies the x position in + terms of data or plot fraction but `x0`, `x1` + and x coordinates within `path` are pixels + relative to `xanchor`. This way, the shape can + have a fixed width while maintaining a position + relative to data or plot fraction. + y0 + Sets the shape's starting y position. See + `type` and `ysizemode` for more info. + y1 + Sets the shape's end y position. See `type` and + `ysizemode` for more info. + yanchor + Only relevant in conjunction with `ysizemode` + set to "pixel". Specifies the anchor point on + the y axis to which `y0`, `y1` and y + coordinates within `path` are relative to. E.g. + useful to attach a pixel sized shape to a + certain data value. No effect when `ysizemode` + not set to "pixel". + yref + Sets the annotation's y coordinate axis. If set + to an y axis id (e.g. "y" or "y2"), the `y` + position refers to an y coordinate If set to + "paper", the `y` position refers to the + distance from the bottom of the plotting area + in normalized coordinates where 0 (1) + corresponds to the bottom (top). + ysizemode + Sets the shapes's sizing mode along the y axis. + If set to "scaled", `y0`, `y1` and y + coordinates within `path` refer to data values + on the y axis or a fraction of the plot area's + height (`yref` set to "paper"). If set to + "pixel", `yanchor` specifies the y position in + terms of data or plot fraction but `y0`, `y1` + and y coordinates within `path` are pixels + relative to `yanchor`. This way, the shape can + have a fixed height while maintaining a + position relative to data or plot fraction. + + Returns + ------- + tuple[plotly.graph_objs.layout.Shape] + """ + return self['shapes'] + + @shapes.setter + def shapes(self, val): + self['shapes'] = val + + # shapedefaults + # ------------- + @property + 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 plotly.graph_objs.layout.Shape + - A dict of string/value properties that will be passed + to the Shape constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.layout.Shape + """ + return self['shapedefaults'] + + @shapedefaults.setter + def shapedefaults(self, val): + self['shapedefaults'] = val + + # showlegend + # ---------- + @property + def showlegend(self): + """ + Determines whether or not a legend is drawn. Default is `true` + if there is a trace to show and any of these: a) Two or more + traces would by default be shown in the legend. b) One pie + trace is shown in the legend. c) One trace is explicitly given + with `showlegend: true`. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # sliders + # ------- + @property + def sliders(self): + """ + The 'sliders' property is a tuple of instances of + Slider that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.Slider + - A list or tuple of dicts of string/value properties that + will be passed to the Slider constructor + + Supported dict properties: + + active + Determines which button (by index starting from + 0) is considered active. + activebgcolor + Sets the background color of the slider grip + while dragging. + bgcolor + Sets the background color of the slider. + bordercolor + Sets the color of the border enclosing the + slider. + borderwidth + Sets the width (in px) of the border enclosing + the slider. + currentvalue + plotly.graph_objs.layout.slider.Currentvalue + instance or dict with compatible properties + font + Sets the font of the slider step labels. + len + Sets the length of the slider This measure + excludes the padding of both ends. That is, the + slider's length is this length minus the + padding on both ends. + lenmode + Determines whether this slider length is set in + units of plot "fraction" or in *pixels. Use + `len` to set the value. + minorticklen + Sets the length in pixels of minor step tick + marks + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + pad + Set the padding of the slider component along + each side. + steps + plotly.graph_objs.layout.slider.Step instance + or dict with compatible properties + stepdefaults + When used in a template (as + layout.template.layout.slider.stepdefaults), + sets the default property values to use for + elements of layout.slider.steps + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + tickcolor + Sets the color of the border enclosing the + slider. + ticklen + Sets the length in pixels of step tick marks + tickwidth + Sets the tick width (in px). + transition + plotly.graph_objs.layout.slider.Transition + instance or dict with compatible properties + visible + Determines whether or not the slider is + visible. + x + Sets the x position (in normalized coordinates) + of the slider. + xanchor + Sets the slider's horizontal position anchor. + This anchor binds the `x` position to the + "left", "center" or "right" of the range + selector. + y + Sets the y position (in normalized coordinates) + of the slider. + yanchor + Sets the slider's vertical position anchor This + anchor binds the `y` position to the "top", + "middle" or "bottom" of the range selector. + + Returns + ------- + tuple[plotly.graph_objs.layout.Slider] + """ + return self['sliders'] + + @sliders.setter + def sliders(self, val): + self['sliders'] = val + + # sliderdefaults + # -------------- + @property + 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 plotly.graph_objs.layout.Slider + - A dict of string/value properties that will be passed + to the Slider constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.layout.Slider + """ + return self['sliderdefaults'] + + @sliderdefaults.setter + def sliderdefaults(self, val): + self['sliderdefaults'] = val + + # spikedistance + # ------------- + @property + def spikedistance(self): + """ + Sets the default distance (in pixels) to look for data to draw + spikelines to (-1 means no cutoff, 0 means no looking for + data). As with hoverdistance, distance does not apply to area- + like objects. In addition, some objects can be hovered on but + will not generate spikelines, such as scatter fills. + + The 'spikedistance' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + + Returns + ------- + int + """ + return self['spikedistance'] + + @spikedistance.setter + def spikedistance(self, val): + self['spikedistance'] = val + + # template + # -------- + @property + def template(self): + """ + Default attributes to be applied to the plot. This should be a + dict with format: `{'layout': layoutTemplate, 'data': + {trace_type: [traceTemplate, ...], ...}}` where + `layoutTemplate` is a dict matching the structure of + `figure.layout` and `traceTemplate` is a dict matching the + structure of the trace with type `trace_type` (e.g. 'scatter'). + Alternatively, this may be specified as an instance of + plotly.graph_objs.layout.Template. Trace templates are applied + cyclically to traces of each type. Container arrays (eg + `annotations`) have special handling: An object ending in + `defaults` (eg `annotationdefaults`) is applied to each array + item. But if an item has a `templateitemname` key we look in + the template array for an item with matching `name` and apply + that instead. If no matching `name` is found we mark the item + invisible. Any named template item not referenced is appended + to the end of the array, so this can be used to add a watermark + annotation or a logo image, for example. To omit one of these + items on the plot, make an item with matching + `templateitemname` and `visible: false`. + + The 'template' property is an instance of Template + that may be specified as: + - An instance of plotly.graph_objs.layout.Template + - A dict of string/value properties that will be passed + to the Template constructor + + Supported dict properties: + + data + plotly.graph_objs.layout.template.Data instance + or dict with compatible properties + layout + plotly.graph_objs.layout.template.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) + - A string containing multiple registered template names, joined on '+' + characters (e.g. 'template1+template2'). In this case the resulting + template is computed by merging together the collection of registered + templates + + Returns + ------- + plotly.graph_objs.layout.Template + """ + return self['template'] + + @template.setter + def template(self, val): + self['template'] = val + + # ternary + # ------- + @property + def ternary(self): + """ + The 'ternary' property is an instance of Ternary + that may be specified as: + - An instance of plotly.graph_objs.layout.Ternary + - A dict of string/value properties that will be passed + to the Ternary constructor + + Supported dict properties: + + aaxis + plotly.graph_objs.layout.ternary.Aaxis instance + or dict with compatible properties + baxis + plotly.graph_objs.layout.ternary.Baxis instance + or dict with compatible properties + bgcolor + Set the background color of the subplot + caxis + plotly.graph_objs.layout.ternary.Caxis instance + or dict with compatible properties + domain + plotly.graph_objs.layout.ternary.Domain + instance or dict with compatible properties + sum + The number each triplet should sum to, and the + maximum range of each axis + uirevision + Controls persistence of user-driven changes in + axis `min` and `title`, if not overridden in + the individual axes. Defaults to + `layout.uirevision`. + + Returns + ------- + plotly.graph_objs.layout.Ternary + """ + return self['ternary'] + + @ternary.setter + def ternary(self, val): + self['ternary'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + `titlefont` attribute. + pad + Sets the padding of the title. Each padding + value only applies when the corresponding + `xanchor`/`yanchor` value is set accordingly. + E.g. for left padding to take effect, `xanchor` + must be set to "left". The same rule applies if + `xanchor`/`yanchor` is determined + automatically. Padding is muted if the + respective anchor value is "middle*/*center". + text + Sets the plot's title. Note that before the + existence of `title.text`, the title's contents + used to be defined as the `title` attribute + itself. This behavior has been deprecated. + x + Sets the x position with respect to `xref` in + normalized coordinates from 0 (left) to 1 + (right). + xanchor + Sets the title's horizontal alignment with + respect to its x position. "left" means that + the title starts at x, "right" means that the + title ends at x and "center" means that the + title's center is at x. "auto" divides `xref` + by three and calculates the `xanchor` value + automatically based on the value of `x`. + xref + Sets the container `x` refers to. "container" + spans the entire `width` of the plot. "paper" + refers to the width of the plotting area only. + y + Sets the y position with respect to `yref` in + normalized coordinates from 0 (bottom) to 1 + (top). "auto" places the baseline of the title + onto the vertical center of the top margin. + yanchor + Sets the title's vertical alignment with + respect to its y position. "top" means that the + title's cap line is at y, "bottom" means that + the title's baseline is at y and "middle" means + that the title's midline is at y. "auto" + divides `yref` by three and calculates the + `yanchor` value automatically based on the + value of `y`. + yref + Sets the container `y` refers to. "container" + spans the entire `height` of the plot. "paper" + refers to the height of the plotting area only. + + Returns + ------- + plotly.graph_objs.layout.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 plotly.graph_objs.layout.title.Font + - A dict of string/value properties that will be passed + to the Font constructor + + Supported dict properties: + + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # transition + # ---------- + @property + 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 plotly.graph_objs.layout.Transition + - A dict of string/value properties that will be passed + to the Transition constructor + + Supported dict properties: + + duration + The duration of the transition, in + milliseconds. If equal to zero, updates are + synchronous. + easing + The easing function used for the transition + ordering + Determines whether the figure's layout or + traces smoothly transitions during updates that + make both traces and layout change. + + Returns + ------- + plotly.graph_objs.layout.Transition + """ + return self['transition'] + + @transition.setter + def transition(self, val): + self['transition'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Used to allow user interactions with the plot to persist after + `Plotly.react` calls that are unaware of these interactions. If + `uirevision` is omitted, or if it is given and it changed from + the previous `Plotly.react` call, the exact new figure is used. + If `uirevision` is truthy and did NOT change, any attribute + that has been affected by user interactions and did not receive + a different value in the new figure will keep the interaction + value. `layout.uirevision` attribute serves as the default for + `uirevision` attributes in various sub-containers. For finer + control you can set these sub-attributes directly. For example, + if your app separately controls the data on the x and y axes + you might set `xaxis.uirevision=*time*` and + `yaxis.uirevision=*cost*`. Then if only the y data is changed, + you can update `yaxis.uirevision=*quantity*` and the y axis + range will reset but the x axis range will retain any user- + driven zoom. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # updatemenus + # ----------- + @property + def updatemenus(self): + """ + The 'updatemenus' property is a tuple of instances of + Updatemenu that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.Updatemenu + - A list or tuple of dicts of string/value properties that + will be passed to the Updatemenu constructor + + Supported dict properties: + + active + Determines which button (by index starting from + 0) is considered active. + bgcolor + Sets the background color of the update menu + buttons. + bordercolor + Sets the color of the border enclosing the + update menu. + borderwidth + Sets the width (in px) of the border enclosing + the update menu. + buttons + plotly.graph_objs.layout.updatemenu.Button + instance or dict with compatible properties + buttondefaults + When used in a template (as layout.template.lay + out.updatemenu.buttondefaults), sets the + default property values to use for elements of + layout.updatemenu.buttons + direction + Determines the direction in which the buttons + are laid out, whether in a dropdown menu or a + row/column of buttons. For `left` and `up`, the + buttons will still appear in left-to-right or + top-to-bottom order respectively. + font + Sets the font of the update menu button text. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + pad + Sets the padding around the buttons or dropdown + menu. + showactive + Highlights active dropdown item or active + button if true. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + type + Determines whether the buttons are accessible + via a dropdown menu or whether the buttons are + stacked horizontally or vertically + visible + Determines whether or not the update menu is + visible. + x + Sets the x position (in normalized coordinates) + of the update menu. + xanchor + Sets the update menu's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the range + selector. + y + Sets the y position (in normalized coordinates) + of the update menu. + yanchor + Sets the update menu's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the range + selector. + + Returns + ------- + tuple[plotly.graph_objs.layout.Updatemenu] + """ + return self['updatemenus'] + + @updatemenus.setter + def updatemenus(self, val): + self['updatemenus'] = val + + # updatemenudefaults + # ------------------ + @property + 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 plotly.graph_objs.layout.Updatemenu + - A dict of string/value properties that will be passed + to the Updatemenu constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.layout.Updatemenu + """ + return self['updatemenudefaults'] + + @updatemenudefaults.setter + def updatemenudefaults(self, val): + self['updatemenudefaults'] = val + + # violingap + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['violingap'] + + @violingap.setter + def violingap(self, val): + self['violingap'] = val + + # violingroupgap + # -------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['violingroupgap'] + + @violingroupgap.setter + def violingroupgap(self, val): + self['violingroupgap'] = val + + # violinmode + # ---------- + @property + def violinmode(self): + """ + Determines how violins at the same location coordinate are + displayed on the graph. If "group", the violins are plotted + next to one another centered around the shared location. If + "overlay", the violins are plotted over one another, you might + need to set "opacity" to see them multiple violins. Has no + effect on traces that have "width" set. + + The 'violinmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['group', 'overlay'] + + Returns + ------- + Any + """ + return self['violinmode'] + + @violinmode.setter + def violinmode(self, val): + self['violinmode'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + The 'xaxis' property is an instance of XAxis + that may be specified as: + - An instance of plotly.graph_objs.layout.XAxis + - A dict of string/value properties that will be passed + to the XAxis constructor + + Supported dict properties: + + anchor + If set to an opposite-letter axis id (e.g. + `x2`, `y`), this axis is bound to the + corresponding opposite-letter axis. If set to + "free", this axis' position is determined by + `position`. + automargin + Determines whether long tick labels + automatically grow the figure margins. + autorange + Determines whether or not the range of this + axis is computed in relation to the input data. + See `rangemode` for more info. If `range` is + provided, then `autorange` is set to False. + calendar + Sets the calendar system to use for `range` and + `tick0` if this is a date axis. This does not + set the calendar for interpreting data on this + axis, that's specified in the trace or via the + global `layout.calendar` + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + constrain + If this axis needs to be compressed (either due + to its own `scaleanchor` and `scaleratio` or + those of the other axis), determines how that + happens: by increasing the "range" (default), + or by decreasing the "domain". + constraintoward + If this axis needs to be compressed (either due + to its own `scaleanchor` and `scaleratio` or + those of the other axis), determines which + direction we push the originally specified plot + area. Options are "left", "center" (default), + and "right" for x axes, and "top", "middle" + (default), and "bottom" for y axes. + dividercolor + Sets the color of the dividers Only has an + effect on "multicategory" axes. + dividerwidth + Sets the width (in px) of the dividers Only has + an effect on "multicategory" axes. + domain + Sets the domain of this axis (in plot + fraction). + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom- + able. If true, then zoom is disabled. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + layer + Sets the layer on which this axis is displayed. + If *above traces*, this axis is displayed above + all the subplot's traces If *below traces*, + this axis is displayed below all the subplot's + traces, but above the grid lines. Useful when + used together with scatter-like traces with + `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + matches + If set to another axis id (e.g. `x2`, `y`), the + range of this axis will match the range of the + corresponding axis in data-coordinates space. + Moreover, matching axes share auto-range + values, category lists and histogram auto-bins. + Note that setting axes simultaneously in both a + `scaleanchor` and a `matches` constraint is + currently forbidden. Moreover, note that + matching axes must have the same `type`. + mirror + Determines if the axis lines or/and ticks are + mirrored to the opposite side of the plotting + area. If True, the axis lines are mirrored. If + "ticks", the axis lines and ticks are mirrored. + If False, mirroring is disable. If "all", axis + lines are mirrored on all shared-axes subplots. + If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + overlaying + If set a same-letter axis id, this axis is + overlaid on top of the corresponding same- + letter axis, with traces and axes visible for + both axes. If False, this axis does not overlay + any same-letter axes. In this case, for axes + with overlapping domains only the highest- + numbered axis will be visible. + position + Sets the position of this axis in the plotting + space (in normalized coordinates). Only has an + effect if `anchor` is set to "free". + range + Sets the range of this axis. If the axis `type` + is "log", then you must take the log of your + desired range (e.g. to set the range from 1 to + 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, + like date data, though Date objects and unix + milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it + should be numbers, using the scale where each + category is assigned a serial number from zero + in the order it appears. + rangemode + If "normal", the range is computed in relation + to the extrema of the input data. If *tozero*`, + the range extends to 0, regardless of the input + data If "nonnegative", the range is non- + negative, regardless of the input data. Applies + only to linear axes. + rangeselector + plotly.graph_objs.layout.xaxis.Rangeselector + instance or dict with compatible properties + rangeslider + plotly.graph_objs.layout.xaxis.Rangeslider + instance or dict with compatible properties + scaleanchor + If set to another axis id (e.g. `x2`, `y`), the + range of this axis changes together with the + range of the corresponding axis such that the + scale of pixels per unit is in a constant + ratio. Both axes are still zoomable, but when + you zoom one, the other will zoom the same + amount, keeping a fixed midpoint. `constrain` + and `constraintoward` determine how we enforce + the constraint. You can chain these, ie `yaxis: + {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` + but you can only link axes of the same `type`. + The linked axis can have the opposite letter + (to constrain the aspect ratio) or the same + letter (to match scales across subplots). Loops + (`yaxis: {scaleanchor: *x*}, xaxis: + {scaleanchor: *y*}` or longer) are redundant + and the last constraint encountered will be + ignored to avoid possible inconsistent + constraints via `scaleratio`. Note that setting + axes simultaneously in both a `scaleanchor` and + a `matches` constraint is currently forbidden. + scaleratio + If this axis is linked to another by + `scaleanchor`, this determines the pixel to + unit scale ratio. For example, if this value is + 10, then every unit on this axis spans 10 times + the number of pixels as a unit on the linked + axis. Use this for example to create an + elevation profile where the vertical scale is + exaggerated a fixed amount with respect to the + horizontal. + separatethousands + If "true", even 4-digit integers are separated + showdividers + Determines whether or not a dividers are drawn + between the category levels of this axis. Only + has an effect on "multicategory" axes. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showspikes + Determines whether or not spikes (aka + droplines) are drawn for this axis. Note: This + only takes affect when hovermode = closest + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines whether a x (y) axis is positioned + at the "bottom" ("left") or "top" ("right") of + the plotting area. + spikecolor + Sets the spike color. If undefined, will use + the series color + spikedash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + spikemode + Determines the drawing mode for the spike line + If "toaxis", the line is drawn from the data + point to the axis the series is plotted on. If + "across", the line is drawn across the entire + plot area, and supercedes "toaxis". If + "marker", then a marker dot is drawn on the + axis the series is plotted on + spikesnap + Determines whether spikelines are stuck to the + cursor or to the closest datapoints. + spikethickness + Sets the width (in px) of the zero line. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.xaxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.xaxis.tickformatstopdefaults), sets the + default property values to use for elements of + layout.xaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + tickson + Determines where ticks and grid lines are drawn + with respect to their corresponding tick + labels. Only has an effect for axes of `type` + "category" or "multicategory". When set to + "boundaries", ticks and grid lines are drawn + half a category to the left/bottom of labels. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.xaxis.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use layout.xaxis.title.font + instead. Sets this axis' title font. Note that + the title's font used to be customized by the + now deprecated `titlefont` attribute. + type + Sets the axis type. By default, plotly attempts + to determined the axis type by looking into the + data of the traces that referenced the axis in + question. + uirevision + Controls persistence of user-driven changes in + axis `range`, `autorange`, and `title` if in + `editable: true` configuration. Defaults to + `layout.uirevision`. + visible + A single toggle to hide the axis while + preserving interaction like dragging. Default + is true when a cheater plot is present on the + axis, otherwise false + zeroline + Determines whether or not a line is drawn at + along the 0 value of this axis. If True, the + zero line is drawn on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + + Returns + ------- + plotly.graph_objs.layout.XAxis + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + The 'yaxis' property is an instance of YAxis + that may be specified as: + - An instance of plotly.graph_objs.layout.YAxis + - A dict of string/value properties that will be passed + to the YAxis constructor + + Supported dict properties: + + anchor + If set to an opposite-letter axis id (e.g. + `x2`, `y`), this axis is bound to the + corresponding opposite-letter axis. If set to + "free", this axis' position is determined by + `position`. + automargin + Determines whether long tick labels + automatically grow the figure margins. + autorange + Determines whether or not the range of this + axis is computed in relation to the input data. + See `rangemode` for more info. If `range` is + provided, then `autorange` is set to False. + calendar + Sets the calendar system to use for `range` and + `tick0` if this is a date axis. This does not + set the calendar for interpreting data on this + axis, that's specified in the trace or via the + global `layout.calendar` + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + constrain + If this axis needs to be compressed (either due + to its own `scaleanchor` and `scaleratio` or + those of the other axis), determines how that + happens: by increasing the "range" (default), + or by decreasing the "domain". + constraintoward + If this axis needs to be compressed (either due + to its own `scaleanchor` and `scaleratio` or + those of the other axis), determines which + direction we push the originally specified plot + area. Options are "left", "center" (default), + and "right" for x axes, and "top", "middle" + (default), and "bottom" for y axes. + dividercolor + Sets the color of the dividers Only has an + effect on "multicategory" axes. + dividerwidth + Sets the width (in px) of the dividers Only has + an effect on "multicategory" axes. + domain + Sets the domain of this axis (in plot + fraction). + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom- + able. If true, then zoom is disabled. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + layer + Sets the layer on which this axis is displayed. + If *above traces*, this axis is displayed above + all the subplot's traces If *below traces*, + this axis is displayed below all the subplot's + traces, but above the grid lines. Useful when + used together with scatter-like traces with + `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + matches + If set to another axis id (e.g. `x2`, `y`), the + range of this axis will match the range of the + corresponding axis in data-coordinates space. + Moreover, matching axes share auto-range + values, category lists and histogram auto-bins. + Note that setting axes simultaneously in both a + `scaleanchor` and a `matches` constraint is + currently forbidden. Moreover, note that + matching axes must have the same `type`. + mirror + Determines if the axis lines or/and ticks are + mirrored to the opposite side of the plotting + area. If True, the axis lines are mirrored. If + "ticks", the axis lines and ticks are mirrored. + If False, mirroring is disable. If "all", axis + lines are mirrored on all shared-axes subplots. + If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + overlaying + If set a same-letter axis id, this axis is + overlaid on top of the corresponding same- + letter axis, with traces and axes visible for + both axes. If False, this axis does not overlay + any same-letter axes. In this case, for axes + with overlapping domains only the highest- + numbered axis will be visible. + position + Sets the position of this axis in the plotting + space (in normalized coordinates). Only has an + effect if `anchor` is set to "free". + range + Sets the range of this axis. If the axis `type` + is "log", then you must take the log of your + desired range (e.g. to set the range from 1 to + 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, + like date data, though Date objects and unix + milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it + should be numbers, using the scale where each + category is assigned a serial number from zero + in the order it appears. + rangemode + If "normal", the range is computed in relation + to the extrema of the input data. If *tozero*`, + the range extends to 0, regardless of the input + data If "nonnegative", the range is non- + negative, regardless of the input data. Applies + only to linear axes. + scaleanchor + If set to another axis id (e.g. `x2`, `y`), the + range of this axis changes together with the + range of the corresponding axis such that the + scale of pixels per unit is in a constant + ratio. Both axes are still zoomable, but when + you zoom one, the other will zoom the same + amount, keeping a fixed midpoint. `constrain` + and `constraintoward` determine how we enforce + the constraint. You can chain these, ie `yaxis: + {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` + but you can only link axes of the same `type`. + The linked axis can have the opposite letter + (to constrain the aspect ratio) or the same + letter (to match scales across subplots). Loops + (`yaxis: {scaleanchor: *x*}, xaxis: + {scaleanchor: *y*}` or longer) are redundant + and the last constraint encountered will be + ignored to avoid possible inconsistent + constraints via `scaleratio`. Note that setting + axes simultaneously in both a `scaleanchor` and + a `matches` constraint is currently forbidden. + scaleratio + If this axis is linked to another by + `scaleanchor`, this determines the pixel to + unit scale ratio. For example, if this value is + 10, then every unit on this axis spans 10 times + the number of pixels as a unit on the linked + axis. Use this for example to create an + elevation profile where the vertical scale is + exaggerated a fixed amount with respect to the + horizontal. + separatethousands + If "true", even 4-digit integers are separated + showdividers + Determines whether or not a dividers are drawn + between the category levels of this axis. Only + has an effect on "multicategory" axes. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showspikes + Determines whether or not spikes (aka + droplines) are drawn for this axis. Note: This + only takes affect when hovermode = closest + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines whether a x (y) axis is positioned + at the "bottom" ("left") or "top" ("right") of + the plotting area. + spikecolor + Sets the spike color. If undefined, will use + the series color + spikedash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + spikemode + Determines the drawing mode for the spike line + If "toaxis", the line is drawn from the data + point to the axis the series is plotted on. If + "across", the line is drawn across the entire + plot area, and supercedes "toaxis". If + "marker", then a marker dot is drawn on the + axis the series is plotted on + spikesnap + Determines whether spikelines are stuck to the + cursor or to the closest datapoints. + spikethickness + Sets the width (in px) of the zero line. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.yaxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.yaxis.tickformatstopdefaults), sets the + default property values to use for elements of + layout.yaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + tickson + Determines where ticks and grid lines are drawn + with respect to their corresponding tick + labels. Only has an effect for axes of `type` + "category" or "multicategory". When set to + "boundaries", ticks and grid lines are drawn + half a category to the left/bottom of labels. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.yaxis.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use layout.yaxis.title.font + instead. Sets this axis' title font. Note that + the title's font used to be customized by the + now deprecated `titlefont` attribute. + type + Sets the axis type. By default, plotly attempts + to determined the axis type by looking into the + data of the traces that referenced the axis in + question. + uirevision + Controls persistence of user-driven changes in + axis `range`, `autorange`, and `title` if in + `editable: true` configuration. Defaults to + `layout.uirevision`. + visible + A single toggle to hide the axis while + preserving interaction like dragging. Default + is true when a cheater plot is present on the + axis, otherwise false + zeroline + Determines whether or not a line is drawn at + along the 0 value of this axis. If True, the + zero line is drawn on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + + Returns + ------- + plotly.graph_objs.layout.YAxis + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + angularaxis + plotly.graph_objs.layout.AngularAxis instance or dict + with compatible properties + annotations + plotly.graph_objs.layout.Annotation instance or dict + with compatible properties + annotationdefaults + When used in a template (as + layout.template.layout.annotationdefaults), sets the + default property values to use for elements of + layout.annotations + autosize + Determines whether or not a layout width or height that + has been left undefined by the user is initialized on + each relayout. Note that, regardless of this attribute, + an undefined layout width or height is always + initialized on the first call to plot. + bargap + Sets the gap (in plot fraction) between bars of + adjacent location coordinates. + bargroupgap + Sets the gap (in plot fraction) between bars of the + same location coordinate. + barmode + Determines how bars at the same location coordinate are + displayed on the graph. With "stack", the bars are + stacked on top of one another With "relative", the bars + are stacked on top of one another, with negative values + below the axis, positive values above With "group", the + bars are plotted next to one another centered around + the shared location. With "overlay", the bars are + plotted over one another, you might need to an + "opacity" to see multiple bars. + barnorm + Sets the normalization for bar traces on the graph. + With "fraction", the value of each bar is divided by + the sum of all values at that location coordinate. + "percent" is the same but multiplied by 100 to show + percentages. + boxgap + Sets the gap (in plot fraction) between boxes of + adjacent location coordinates. Has no effect on traces + that have "width" set. + boxgroupgap + Sets the gap (in plot fraction) between boxes of the + same location coordinate. Has no effect on traces that + have "width" set. + boxmode + Determines how boxes at the same location coordinate + are displayed on the graph. If "group", the boxes are + plotted next to one another centered around the shared + location. If "overlay", the boxes are plotted over one + another, you might need to set "opacity" to see them + multiple boxes. Has no effect on traces that have + "width" set. + calendar + Sets the default calendar system to use for + interpreting and displaying dates throughout the plot. + clickmode + Determines the mode of single click interactions. + "event" is the default value and emits the + `plotly_click` event. In addition this mode emits the + `plotly_selected` event in drag modes "lasso" and + "select", but with no event data attached (kept for + compatibility reasons). The "select" flag enables + selecting single data points via click. This mode also + supports persistent selections, meaning that pressing + Shift while clicking, adds to / subtracts from an + existing selection. "select" with `hovermode`: "x" can + be confusing, consider explicitly setting `hovermode`: + "closest" when using this feature. Selection events are + sent accordingly as long as "event" flag is set as + well. When the "event" flag is missing, `plotly_click` + and `plotly_selected` events are not fired. + colorscale + plotly.graph_objs.layout.Colorscale instance or dict + with compatible properties + colorway + Sets the default trace colors. + datarevision + If provided, a changed value tells `Plotly.react` that + one or more data arrays has changed. This way you can + modify arrays in-place rather than making a complete + new copy for an incremental change. If NOT provided, + `Plotly.react` assumes that data arrays are being + treated as immutable, thus any data array with a + different identity from its predecessor contains new + data. + direction + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the direction corresponding to + positive angles in legacy polar charts. + dragmode + Determines the mode of drag interactions. "select" and + "lasso" apply only to scatter traces with markers or + text. "orbit" and "turntable" apply only to 3D scenes. + editrevision + Controls persistence of user-driven changes in + `editable: true` configuration, other than trace names + and axis titles. Defaults to `layout.uirevision`. + extendpiecolors + If `true`, the pie slice colors (whether given by + `piecolorway` or inherited from `colorway`) will be + extended to three times its original length by first + repeating every color 20% lighter then each color 20% + darker. This is intended to reduce the likelihood of + reusing the same color when you have many slices, but + you can set `false` to disable. Colors provided in the + trace, using `marker.colors`, are never extended. + font + Sets the global font. Note that fonts used in traces + and other layout components inherit from the global + font. + geo + plotly.graph_objs.layout.Geo instance or dict with + compatible properties + grid + plotly.graph_objs.layout.Grid instance or dict with + compatible properties + height + Sets the plot's height (in px). + hiddenlabels + + hiddenlabelssrc + Sets the source reference on plot.ly for hiddenlabels + . + hidesources + Determines whether or not a text link citing the data + source is placed at the bottom-right cored of the + figure. Has only an effect only on graphs that have + been generated via forked graphs from the plotly + service (at https://plot.ly or on-premise). + hoverdistance + Sets the default distance (in pixels) to look for data + to add hover labels (-1 means no cutoff, 0 means no + looking for data). This is only a real distance for + hovering on point-like objects, like scatter points. + For area-like objects (bars, scatter fills, etc) + hovering is on inside the area and off outside, but + these objects will not supersede hover on point-like + objects in case of conflict. + hoverlabel + plotly.graph_objs.layout.Hoverlabel instance or dict + with compatible properties + hovermode + Determines the mode of hover interactions. If + `clickmode` includes the "select" flag, `hovermode` + defaults to "closest". If `clickmode` lacks the + "select" flag, it defaults to "x" or "y" (depending on + the trace's `orientation` value) for plots based on + cartesian coordinates. For anything else the default + value is "closest". + images + plotly.graph_objs.layout.Image instance or dict with + compatible properties + imagedefaults + When used in a template (as + layout.template.layout.imagedefaults), sets the default + property values to use for elements of layout.images + legend + plotly.graph_objs.layout.Legend instance or dict with + compatible properties + mapbox + plotly.graph_objs.layout.Mapbox instance or dict with + compatible properties + margin + plotly.graph_objs.layout.Margin instance or dict with + compatible properties + meta + Assigns extra meta information that can be used in + various `text` attributes. Attributes such as the + graph, axis and colorbar `title.text`, annotation + `text` `trace.name` in legend items, `rangeselector`, + `updatemenues` and `sliders` `label` text all support + `meta`. One can access `meta` fields using template + strings: `%{meta[i]}` where `i` is the index of the + `meta` item in question. + metasrc + Sets the source reference on plot.ly for meta . + modebar + plotly.graph_objs.layout.Modebar instance or dict with + compatible properties + orientation + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Rotates the entire polar by the given + angle in legacy polar charts. + paper_bgcolor + Sets the color of paper where the graph is drawn. + piecolorway + Sets the default pie slice colors. Defaults to the main + `colorway` used for trace colors. If you specify a new + list here it can still be extended with lighter and + darker colors, see `extendpiecolors`. + plot_bgcolor + Sets the color of plotting area in-between x and y + axes. + polar + plotly.graph_objs.layout.Polar instance or dict with + compatible properties + radialaxis + plotly.graph_objs.layout.RadialAxis instance or dict + with compatible properties + scene + plotly.graph_objs.layout.Scene instance or dict with + compatible properties + selectdirection + When "dragmode" is set to "select", this limits the + selection of the drag to horizontal, vertical or + diagonal. "h" only allows horizontal selection, "v" + only vertical, "d" only diagonal and "any" sets no + limit. + selectionrevision + Controls persistence of user-driven changes in selected + points from all traces. + separators + Sets the decimal and thousand separators. For example, + *. * puts a '.' before decimals and a space between + thousands. In English locales, dflt is ".," but other + locales may alter this default. + shapes + plotly.graph_objs.layout.Shape instance or dict with + compatible properties + shapedefaults + When used in a template (as + layout.template.layout.shapedefaults), sets the default + property values to use for elements of layout.shapes + showlegend + Determines whether or not a legend is drawn. Default is + `true` if there is a trace to show and any of these: a) + Two or more traces would by default be shown in the + legend. b) One pie trace is shown in the legend. c) One + trace is explicitly given with `showlegend: true`. + sliders + plotly.graph_objs.layout.Slider instance or dict with + compatible properties + sliderdefaults + When used in a template (as + layout.template.layout.sliderdefaults), sets the + default property values to use for elements of + layout.sliders + spikedistance + Sets the default distance (in pixels) to look for data + to draw spikelines to (-1 means no cutoff, 0 means no + looking for data). As with hoverdistance, distance does + not apply to area-like objects. In addition, some + objects can be hovered on but will not generate + spikelines, such as scatter fills. + template + Default attributes to be applied to the plot. This + should be a dict with format: `{'layout': + layoutTemplate, 'data': {trace_type: [traceTemplate, + ...], ...}}` where `layoutTemplate` is a dict matching + the structure of `figure.layout` and `traceTemplate` is + a dict matching the structure of the trace with type + `trace_type` (e.g. 'scatter'). Alternatively, this may + be specified as an instance of + plotly.graph_objs.layout.Template. Trace templates are + applied cyclically to traces of each type. Container + arrays (eg `annotations`) have special handling: An + object ending in `defaults` (eg `annotationdefaults`) + is applied to each array item. But if an item has a + `templateitemname` key we look in the template array + for an item with matching `name` and apply that + instead. If no matching `name` is found we mark the + item invisible. Any named template item not referenced + is appended to the end of the array, so this can be + used to add a watermark annotation or a logo image, for + example. To omit one of these items on the plot, make + an item with matching `templateitemname` and `visible: + false`. + ternary + plotly.graph_objs.layout.Ternary instance or dict with + compatible properties + title + plotly.graph_objs.layout.Title instance or dict with + compatible properties + titlefont + Deprecated: Please use layout.title.font instead. Sets + the title font. Note that the title's font used to be + customized by the now deprecated `titlefont` attribute. + transition + Sets transition options used during Plotly.react + updates. + uirevision + Used to allow user interactions with the plot to + persist after `Plotly.react` calls that are unaware of + these interactions. If `uirevision` is omitted, or if + it is given and it changed from the previous + `Plotly.react` call, the exact new figure is used. If + `uirevision` is truthy and did NOT change, any + attribute that has been affected by user interactions + and did not receive a different value in the new figure + will keep the interaction value. `layout.uirevision` + attribute serves as the default for `uirevision` + attributes in various sub-containers. For finer control + you can set these sub-attributes directly. For example, + if your app separately controls the data on the x and y + axes you might set `xaxis.uirevision=*time*` and + `yaxis.uirevision=*cost*`. Then if only the y data is + changed, you can update `yaxis.uirevision=*quantity*` + and the y axis range will reset but the x axis range + will retain any user-driven zoom. + updatemenus + plotly.graph_objs.layout.Updatemenu instance or dict + with compatible properties + updatemenudefaults + When used in a template (as + layout.template.layout.updatemenudefaults), sets the + default property values to use for elements of + layout.updatemenus + violingap + Sets the gap (in plot fraction) between violins of + adjacent location coordinates. Has no effect on traces + that have "width" set. + violingroupgap + Sets the gap (in plot fraction) between violins of the + same location coordinate. Has no effect on traces that + have "width" set. + violinmode + Determines how violins at the same location coordinate + are displayed on the graph. If "group", the violins are + plotted next to one another centered around the shared + location. If "overlay", the violins are plotted over + one another, you might need to set "opacity" to see + them multiple violins. Has no effect on traces that + have "width" set. + width + Sets the plot's width (in px). + xaxis + plotly.graph_objs.layout.XAxis instance or dict with + compatible properties + yaxis + plotly.graph_objs.layout.YAxis instance or dict with + compatible properties + """ + + _mapped_properties = {'titlefont': ('title', 'font')} + + def __init__( + self, + arg=None, + angularaxis=None, + annotations=None, + annotationdefaults=None, + autosize=None, + bargap=None, + bargroupgap=None, + barmode=None, + barnorm=None, + boxgap=None, + boxgroupgap=None, + boxmode=None, + calendar=None, + clickmode=None, + colorscale=None, + colorway=None, + datarevision=None, + direction=None, + dragmode=None, + editrevision=None, + extendpiecolors=None, + font=None, + geo=None, + grid=None, + height=None, + hiddenlabels=None, + hiddenlabelssrc=None, + hidesources=None, + hoverdistance=None, + hoverlabel=None, + hovermode=None, + images=None, + imagedefaults=None, + legend=None, + mapbox=None, + margin=None, + meta=None, + metasrc=None, + modebar=None, + orientation=None, + paper_bgcolor=None, + piecolorway=None, + plot_bgcolor=None, + polar=None, + radialaxis=None, + scene=None, + selectdirection=None, + selectionrevision=None, + separators=None, + shapes=None, + shapedefaults=None, + showlegend=None, + sliders=None, + sliderdefaults=None, + spikedistance=None, + template=None, + ternary=None, + title=None, + titlefont=None, + transition=None, + uirevision=None, + updatemenus=None, + updatemenudefaults=None, + violingap=None, + violingroupgap=None, + violinmode=None, + width=None, + xaxis=None, + yaxis=None, + **kwargs + ): + """ + Construct a new Layout object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Layout + angularaxis + plotly.graph_objs.layout.AngularAxis instance or dict + with compatible properties + annotations + plotly.graph_objs.layout.Annotation instance or dict + with compatible properties + annotationdefaults + When used in a template (as + layout.template.layout.annotationdefaults), sets the + default property values to use for elements of + layout.annotations + autosize + Determines whether or not a layout width or height that + has been left undefined by the user is initialized on + each relayout. Note that, regardless of this attribute, + an undefined layout width or height is always + initialized on the first call to plot. + bargap + Sets the gap (in plot fraction) between bars of + adjacent location coordinates. + bargroupgap + Sets the gap (in plot fraction) between bars of the + same location coordinate. + barmode + Determines how bars at the same location coordinate are + displayed on the graph. With "stack", the bars are + stacked on top of one another With "relative", the bars + are stacked on top of one another, with negative values + below the axis, positive values above With "group", the + bars are plotted next to one another centered around + the shared location. With "overlay", the bars are + plotted over one another, you might need to an + "opacity" to see multiple bars. + barnorm + Sets the normalization for bar traces on the graph. + With "fraction", the value of each bar is divided by + the sum of all values at that location coordinate. + "percent" is the same but multiplied by 100 to show + percentages. + boxgap + Sets the gap (in plot fraction) between boxes of + adjacent location coordinates. Has no effect on traces + that have "width" set. + boxgroupgap + Sets the gap (in plot fraction) between boxes of the + same location coordinate. Has no effect on traces that + have "width" set. + boxmode + Determines how boxes at the same location coordinate + are displayed on the graph. If "group", the boxes are + plotted next to one another centered around the shared + location. If "overlay", the boxes are plotted over one + another, you might need to set "opacity" to see them + multiple boxes. Has no effect on traces that have + "width" set. + calendar + Sets the default calendar system to use for + interpreting and displaying dates throughout the plot. + clickmode + Determines the mode of single click interactions. + "event" is the default value and emits the + `plotly_click` event. In addition this mode emits the + `plotly_selected` event in drag modes "lasso" and + "select", but with no event data attached (kept for + compatibility reasons). The "select" flag enables + selecting single data points via click. This mode also + supports persistent selections, meaning that pressing + Shift while clicking, adds to / subtracts from an + existing selection. "select" with `hovermode`: "x" can + be confusing, consider explicitly setting `hovermode`: + "closest" when using this feature. Selection events are + sent accordingly as long as "event" flag is set as + well. When the "event" flag is missing, `plotly_click` + and `plotly_selected` events are not fired. + colorscale + plotly.graph_objs.layout.Colorscale instance or dict + with compatible properties + colorway + Sets the default trace colors. + datarevision + If provided, a changed value tells `Plotly.react` that + one or more data arrays has changed. This way you can + modify arrays in-place rather than making a complete + new copy for an incremental change. If NOT provided, + `Plotly.react` assumes that data arrays are being + treated as immutable, thus any data array with a + different identity from its predecessor contains new + data. + direction + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the direction corresponding to + positive angles in legacy polar charts. + dragmode + Determines the mode of drag interactions. "select" and + "lasso" apply only to scatter traces with markers or + text. "orbit" and "turntable" apply only to 3D scenes. + editrevision + Controls persistence of user-driven changes in + `editable: true` configuration, other than trace names + and axis titles. Defaults to `layout.uirevision`. + extendpiecolors + If `true`, the pie slice colors (whether given by + `piecolorway` or inherited from `colorway`) will be + extended to three times its original length by first + repeating every color 20% lighter then each color 20% + darker. This is intended to reduce the likelihood of + reusing the same color when you have many slices, but + you can set `false` to disable. Colors provided in the + trace, using `marker.colors`, are never extended. + font + Sets the global font. Note that fonts used in traces + and other layout components inherit from the global + font. + geo + plotly.graph_objs.layout.Geo instance or dict with + compatible properties + grid + plotly.graph_objs.layout.Grid instance or dict with + compatible properties + height + Sets the plot's height (in px). + hiddenlabels + + hiddenlabelssrc + Sets the source reference on plot.ly for hiddenlabels + . + hidesources + Determines whether or not a text link citing the data + source is placed at the bottom-right cored of the + figure. Has only an effect only on graphs that have + been generated via forked graphs from the plotly + service (at https://plot.ly or on-premise). + hoverdistance + Sets the default distance (in pixels) to look for data + to add hover labels (-1 means no cutoff, 0 means no + looking for data). This is only a real distance for + hovering on point-like objects, like scatter points. + For area-like objects (bars, scatter fills, etc) + hovering is on inside the area and off outside, but + these objects will not supersede hover on point-like + objects in case of conflict. + hoverlabel + plotly.graph_objs.layout.Hoverlabel instance or dict + with compatible properties + hovermode + Determines the mode of hover interactions. If + `clickmode` includes the "select" flag, `hovermode` + defaults to "closest". If `clickmode` lacks the + "select" flag, it defaults to "x" or "y" (depending on + the trace's `orientation` value) for plots based on + cartesian coordinates. For anything else the default + value is "closest". + images + plotly.graph_objs.layout.Image instance or dict with + compatible properties + imagedefaults + When used in a template (as + layout.template.layout.imagedefaults), sets the default + property values to use for elements of layout.images + legend + plotly.graph_objs.layout.Legend instance or dict with + compatible properties + mapbox + plotly.graph_objs.layout.Mapbox instance or dict with + compatible properties + margin + plotly.graph_objs.layout.Margin instance or dict with + compatible properties + meta + Assigns extra meta information that can be used in + various `text` attributes. Attributes such as the + graph, axis and colorbar `title.text`, annotation + `text` `trace.name` in legend items, `rangeselector`, + `updatemenues` and `sliders` `label` text all support + `meta`. One can access `meta` fields using template + strings: `%{meta[i]}` where `i` is the index of the + `meta` item in question. + metasrc + Sets the source reference on plot.ly for meta . + modebar + plotly.graph_objs.layout.Modebar instance or dict with + compatible properties + orientation + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Rotates the entire polar by the given + angle in legacy polar charts. + paper_bgcolor + Sets the color of paper where the graph is drawn. + piecolorway + Sets the default pie slice colors. Defaults to the main + `colorway` used for trace colors. If you specify a new + list here it can still be extended with lighter and + darker colors, see `extendpiecolors`. + plot_bgcolor + Sets the color of plotting area in-between x and y + axes. + polar + plotly.graph_objs.layout.Polar instance or dict with + compatible properties + radialaxis + plotly.graph_objs.layout.RadialAxis instance or dict + with compatible properties + scene + plotly.graph_objs.layout.Scene instance or dict with + compatible properties + selectdirection + When "dragmode" is set to "select", this limits the + selection of the drag to horizontal, vertical or + diagonal. "h" only allows horizontal selection, "v" + only vertical, "d" only diagonal and "any" sets no + limit. + selectionrevision + Controls persistence of user-driven changes in selected + points from all traces. + separators + Sets the decimal and thousand separators. For example, + *. * puts a '.' before decimals and a space between + thousands. In English locales, dflt is ".," but other + locales may alter this default. + shapes + plotly.graph_objs.layout.Shape instance or dict with + compatible properties + shapedefaults + When used in a template (as + layout.template.layout.shapedefaults), sets the default + property values to use for elements of layout.shapes + showlegend + Determines whether or not a legend is drawn. Default is + `true` if there is a trace to show and any of these: a) + Two or more traces would by default be shown in the + legend. b) One pie trace is shown in the legend. c) One + trace is explicitly given with `showlegend: true`. + sliders + plotly.graph_objs.layout.Slider instance or dict with + compatible properties + sliderdefaults + When used in a template (as + layout.template.layout.sliderdefaults), sets the + default property values to use for elements of + layout.sliders + spikedistance + Sets the default distance (in pixels) to look for data + to draw spikelines to (-1 means no cutoff, 0 means no + looking for data). As with hoverdistance, distance does + not apply to area-like objects. In addition, some + objects can be hovered on but will not generate + spikelines, such as scatter fills. + template + Default attributes to be applied to the plot. This + should be a dict with format: `{'layout': + layoutTemplate, 'data': {trace_type: [traceTemplate, + ...], ...}}` where `layoutTemplate` is a dict matching + the structure of `figure.layout` and `traceTemplate` is + a dict matching the structure of the trace with type + `trace_type` (e.g. 'scatter'). Alternatively, this may + be specified as an instance of + plotly.graph_objs.layout.Template. Trace templates are + applied cyclically to traces of each type. Container + arrays (eg `annotations`) have special handling: An + object ending in `defaults` (eg `annotationdefaults`) + is applied to each array item. But if an item has a + `templateitemname` key we look in the template array + for an item with matching `name` and apply that + instead. If no matching `name` is found we mark the + item invisible. Any named template item not referenced + is appended to the end of the array, so this can be + used to add a watermark annotation or a logo image, for + example. To omit one of these items on the plot, make + an item with matching `templateitemname` and `visible: + false`. + ternary + plotly.graph_objs.layout.Ternary instance or dict with + compatible properties + title + plotly.graph_objs.layout.Title instance or dict with + compatible properties + titlefont + Deprecated: Please use layout.title.font instead. Sets + the title font. Note that the title's font used to be + customized by the now deprecated `titlefont` attribute. + transition + Sets transition options used during Plotly.react + updates. + uirevision + Used to allow user interactions with the plot to + persist after `Plotly.react` calls that are unaware of + these interactions. If `uirevision` is omitted, or if + it is given and it changed from the previous + `Plotly.react` call, the exact new figure is used. If + `uirevision` is truthy and did NOT change, any + attribute that has been affected by user interactions + and did not receive a different value in the new figure + will keep the interaction value. `layout.uirevision` + attribute serves as the default for `uirevision` + attributes in various sub-containers. For finer control + you can set these sub-attributes directly. For example, + if your app separately controls the data on the x and y + axes you might set `xaxis.uirevision=*time*` and + `yaxis.uirevision=*cost*`. Then if only the y data is + changed, you can update `yaxis.uirevision=*quantity*` + and the y axis range will reset but the x axis range + will retain any user-driven zoom. + updatemenus + plotly.graph_objs.layout.Updatemenu instance or dict + with compatible properties + updatemenudefaults + When used in a template (as + layout.template.layout.updatemenudefaults), sets the + default property values to use for elements of + layout.updatemenus + violingap + Sets the gap (in plot fraction) between violins of + adjacent location coordinates. Has no effect on traces + that have "width" set. + violingroupgap + Sets the gap (in plot fraction) between violins of the + same location coordinate. Has no effect on traces that + have "width" set. + violinmode + Determines how violins at the same location coordinate + are displayed on the graph. If "group", the violins are + plotted next to one another centered around the shared + location. If "overlay", the violins are plotted over + one another, you might need to set "opacity" to see + them multiple violins. Has no effect on traces that + have "width" set. + width + Sets the plot's width (in px). + xaxis + plotly.graph_objs.layout.XAxis instance or dict with + compatible properties + yaxis + plotly.graph_objs.layout.YAxis instance or dict with + compatible properties + + Returns + ------- + Layout + """ + super(Layout, self).__init__('layout') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Layout +constructor must be a dict or +an instance of plotly.graph_objs.Layout""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (layout as v_layout) + + # Initialize validators + # --------------------- + self._validators['angularaxis'] = v_layout.AngularAxisValidator() + self._validators['annotations'] = v_layout.AnnotationsValidator() + self._validators['annotationdefaults'] = v_layout.AnnotationValidator() + self._validators['autosize'] = v_layout.AutosizeValidator() + self._validators['bargap'] = v_layout.BargapValidator() + self._validators['bargroupgap'] = v_layout.BargroupgapValidator() + self._validators['barmode'] = v_layout.BarmodeValidator() + self._validators['barnorm'] = v_layout.BarnormValidator() + self._validators['boxgap'] = v_layout.BoxgapValidator() + self._validators['boxgroupgap'] = v_layout.BoxgroupgapValidator() + self._validators['boxmode'] = v_layout.BoxmodeValidator() + self._validators['calendar'] = v_layout.CalendarValidator() + self._validators['clickmode'] = v_layout.ClickmodeValidator() + self._validators['colorscale'] = v_layout.ColorscaleValidator() + self._validators['colorway'] = v_layout.ColorwayValidator() + self._validators['datarevision'] = v_layout.DatarevisionValidator() + self._validators['direction'] = v_layout.DirectionValidator() + self._validators['dragmode'] = v_layout.DragmodeValidator() + self._validators['editrevision'] = v_layout.EditrevisionValidator() + self._validators['extendpiecolors' + ] = v_layout.ExtendpiecolorsValidator() + self._validators['font'] = v_layout.FontValidator() + self._validators['geo'] = v_layout.GeoValidator() + self._validators['grid'] = v_layout.GridValidator() + self._validators['height'] = v_layout.HeightValidator() + self._validators['hiddenlabels'] = v_layout.HiddenlabelsValidator() + self._validators['hiddenlabelssrc' + ] = v_layout.HiddenlabelssrcValidator() + self._validators['hidesources'] = v_layout.HidesourcesValidator() + self._validators['hoverdistance'] = v_layout.HoverdistanceValidator() + self._validators['hoverlabel'] = v_layout.HoverlabelValidator() + self._validators['hovermode'] = v_layout.HovermodeValidator() + self._validators['images'] = v_layout.ImagesValidator() + self._validators['imagedefaults'] = v_layout.ImageValidator() + self._validators['legend'] = v_layout.LegendValidator() + self._validators['mapbox'] = v_layout.MapboxValidator() + self._validators['margin'] = v_layout.MarginValidator() + self._validators['meta'] = v_layout.MetaValidator() + self._validators['metasrc'] = v_layout.MetasrcValidator() + self._validators['modebar'] = v_layout.ModebarValidator() + self._validators['orientation'] = v_layout.OrientationValidator() + self._validators['paper_bgcolor'] = v_layout.PaperBgcolorValidator() + self._validators['piecolorway'] = v_layout.PiecolorwayValidator() + self._validators['plot_bgcolor'] = v_layout.PlotBgcolorValidator() + self._validators['polar'] = v_layout.PolarValidator() + self._validators['radialaxis'] = v_layout.RadialAxisValidator() + self._validators['scene'] = v_layout.SceneValidator() + self._validators['selectdirection' + ] = v_layout.SelectdirectionValidator() + self._validators['selectionrevision' + ] = v_layout.SelectionrevisionValidator() + self._validators['separators'] = v_layout.SeparatorsValidator() + self._validators['shapes'] = v_layout.ShapesValidator() + self._validators['shapedefaults'] = v_layout.ShapeValidator() + self._validators['showlegend'] = v_layout.ShowlegendValidator() + self._validators['sliders'] = v_layout.SlidersValidator() + self._validators['sliderdefaults'] = v_layout.SliderValidator() + self._validators['spikedistance'] = v_layout.SpikedistanceValidator() + self._validators['template'] = v_layout.TemplateValidator() + self._validators['ternary'] = v_layout.TernaryValidator() + self._validators['title'] = v_layout.TitleValidator() + self._validators['transition'] = v_layout.TransitionValidator() + self._validators['uirevision'] = v_layout.UirevisionValidator() + self._validators['updatemenus'] = v_layout.UpdatemenusValidator() + self._validators['updatemenudefaults'] = v_layout.UpdatemenuValidator() + self._validators['violingap'] = v_layout.ViolingapValidator() + self._validators['violingroupgap'] = v_layout.ViolingroupgapValidator() + self._validators['violinmode'] = v_layout.ViolinmodeValidator() + self._validators['width'] = v_layout.WidthValidator() + self._validators['xaxis'] = v_layout.XAxisValidator() + self._validators['yaxis'] = v_layout.YAxisValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('angularaxis', None) + self['angularaxis'] = angularaxis if angularaxis is not None else _v + _v = arg.pop('annotations', None) + self['annotations'] = annotations if annotations is not None else _v + _v = arg.pop('annotationdefaults', None) + self['annotationdefaults' + ] = annotationdefaults if annotationdefaults is not None else _v + _v = arg.pop('autosize', None) + self['autosize'] = autosize if autosize is not None else _v + _v = arg.pop('bargap', None) + self['bargap'] = bargap if bargap is not None else _v + _v = arg.pop('bargroupgap', None) + self['bargroupgap'] = bargroupgap if bargroupgap is not None else _v + _v = arg.pop('barmode', None) + self['barmode'] = barmode if barmode is not None else _v + _v = arg.pop('barnorm', None) + self['barnorm'] = barnorm if barnorm is not None else _v + _v = arg.pop('boxgap', None) + self['boxgap'] = boxgap if boxgap is not None else _v + _v = arg.pop('boxgroupgap', None) + self['boxgroupgap'] = boxgroupgap if boxgroupgap is not None else _v + _v = arg.pop('boxmode', None) + self['boxmode'] = boxmode if boxmode is not None else _v + _v = arg.pop('calendar', None) + self['calendar'] = calendar if calendar is not None else _v + _v = arg.pop('clickmode', None) + self['clickmode'] = clickmode if clickmode is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorway', None) + self['colorway'] = colorway if colorway is not None else _v + _v = arg.pop('datarevision', None) + self['datarevision'] = datarevision if datarevision is not None else _v + _v = arg.pop('direction', None) + self['direction'] = direction if direction is not None else _v + _v = arg.pop('dragmode', None) + self['dragmode'] = dragmode if dragmode is not None else _v + _v = arg.pop('editrevision', None) + self['editrevision'] = editrevision if editrevision is not None else _v + _v = arg.pop('extendpiecolors', None) + self['extendpiecolors' + ] = extendpiecolors if extendpiecolors is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('geo', None) + self['geo'] = geo if geo is not None else _v + _v = arg.pop('grid', None) + self['grid'] = grid if grid is not None else _v + _v = arg.pop('height', None) + self['height'] = height if height is not None else _v + _v = arg.pop('hiddenlabels', None) + self['hiddenlabels'] = hiddenlabels if hiddenlabels is not None else _v + _v = arg.pop('hiddenlabelssrc', None) + self['hiddenlabelssrc' + ] = hiddenlabelssrc if hiddenlabelssrc is not None else _v + _v = arg.pop('hidesources', None) + self['hidesources'] = hidesources if hidesources is not None else _v + _v = arg.pop('hoverdistance', None) + self['hoverdistance' + ] = hoverdistance if hoverdistance is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovermode', None) + self['hovermode'] = hovermode if hovermode is not None else _v + _v = arg.pop('images', None) + self['images'] = images if images is not None else _v + _v = arg.pop('imagedefaults', None) + self['imagedefaults' + ] = imagedefaults if imagedefaults is not None else _v + _v = arg.pop('legend', None) + self['legend'] = legend if legend is not None else _v + _v = arg.pop('mapbox', None) + self['mapbox'] = mapbox if mapbox is not None else _v + _v = arg.pop('margin', None) + self['margin'] = margin if margin is not None else _v + _v = arg.pop('meta', None) + self['meta'] = meta if meta is not None else _v + _v = arg.pop('metasrc', None) + self['metasrc'] = metasrc if metasrc is not None else _v + _v = arg.pop('modebar', None) + self['modebar'] = modebar if modebar is not None else _v + _v = arg.pop('orientation', None) + self['orientation'] = orientation if orientation is not None else _v + _v = arg.pop('paper_bgcolor', None) + self['paper_bgcolor' + ] = paper_bgcolor if paper_bgcolor is not None else _v + _v = arg.pop('piecolorway', None) + self['piecolorway'] = piecolorway if piecolorway is not None else _v + _v = arg.pop('plot_bgcolor', None) + self['plot_bgcolor'] = plot_bgcolor if plot_bgcolor is not None else _v + _v = arg.pop('polar', None) + self['polar'] = polar if polar is not None else _v + _v = arg.pop('radialaxis', None) + self['radialaxis'] = radialaxis if radialaxis is not None else _v + _v = arg.pop('scene', None) + self['scene'] = scene if scene is not None else _v + _v = arg.pop('selectdirection', None) + self['selectdirection' + ] = selectdirection if selectdirection is not None else _v + _v = arg.pop('selectionrevision', None) + self['selectionrevision' + ] = selectionrevision if selectionrevision is not None else _v + _v = arg.pop('separators', None) + self['separators'] = separators if separators is not None else _v + _v = arg.pop('shapes', None) + self['shapes'] = shapes if shapes is not None else _v + _v = arg.pop('shapedefaults', None) + self['shapedefaults' + ] = shapedefaults if shapedefaults is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('sliders', None) + self['sliders'] = sliders if sliders is not None else _v + _v = arg.pop('sliderdefaults', None) + self['sliderdefaults' + ] = sliderdefaults if sliderdefaults is not None else _v + _v = arg.pop('spikedistance', None) + self['spikedistance' + ] = spikedistance if spikedistance is not None else _v + _v = arg.pop('template', None) + _v = template if template is not None else _v + if _v is not None: + self['template'] = _v + _v = arg.pop('ternary', None) + self['ternary'] = ternary if ternary is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('transition', None) + self['transition'] = transition if transition is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('updatemenus', None) + self['updatemenus'] = updatemenus if updatemenus is not None else _v + _v = arg.pop('updatemenudefaults', None) + self['updatemenudefaults' + ] = updatemenudefaults if updatemenudefaults is not None else _v + _v = arg.pop('violingap', None) + self['violingap'] = violingap if violingap is not None else _v + _v = arg.pop('violingroupgap', None) + self['violingroupgap' + ] = violingroupgap if violingroupgap is not None else _v + _v = arg.pop('violinmode', None) + self['violinmode'] = violinmode if violinmode is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Violin(_BaseTraceType): + + # alignmentgroup + # -------------- + @property + 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 + + Returns + ------- + str + """ + return self['alignmentgroup'] + + @alignmentgroup.setter + def alignmentgroup(self, val): + self['alignmentgroup'] = val + + # bandwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['bandwidth'] + + @bandwidth.setter + def bandwidth(self, val): + self['bandwidth'] = val + + # box + # --- + @property + def box(self): + """ + The 'box' property is an instance of Box + that may be specified as: + - An instance of 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 + plotly.graph_objs.violin.box.Line instance or + dict with compatible properties + visible + Determines if an miniature box plot is drawn + inside the violins. + width + Sets the width of the inner box plots relative + to the violins' width. For example, with 1, the + inner box plots are as wide as the violins. + + Returns + ------- + plotly.graph_objs.violin.Box + """ + return self['box'] + + @box.setter + def box(self, val): + self['box'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # fillcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['fillcolor'] + + @fillcolor.setter + def fillcolor(self, val): + self['fillcolor'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.violin.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.violin.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hoveron + # ------- + @property + 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 + (e.g. 'violins+points') + OR exactly one of ['all'] (e.g. 'all') + + Returns + ------- + Any + """ + return self['hoveron'] + + @hoveron.setter + def hoveron(self, val): + self['hoveron'] = val + + # hovertext + # --------- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # jitter + # ------ + @property + def jitter(self): + """ + Sets the amount of jitter in the sample points drawn. If 0, the + sample points align along the distribution axis. If 1, the + sample points are drawn in a random jitter of width equal to + the width of the violins. + + The 'jitter' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self['jitter'] + + @jitter.setter + def jitter(self, val): + self['jitter'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of plotly.graph_objs.violin.Line + - A dict of string/value properties that will be passed + to the Line constructor + + Supported dict properties: + + color + Sets the color of line bounding the violin(s). + width + Sets the width (in px) of line bounding the + violin(s). + + Returns + ------- + plotly.graph_objs.violin.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + line + plotly.graph_objs.violin.marker.Line instance + or dict with compatible properties + opacity + Sets the marker opacity. + outliercolor + Sets the color of the outlier sample points. + size + Sets the marker size (in px). + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + + Returns + ------- + plotly.graph_objs.violin.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # meanline + # -------- + @property + def meanline(self): + """ + The 'meanline' property is an instance of Meanline + that may be specified as: + - An instance of plotly.graph_objs.violin.Meanline + - A dict of string/value properties that will be passed + to the Meanline constructor + + Supported dict properties: + + color + Sets the mean line color. + visible + Determines if a line corresponding to the + sample's mean is shown inside the violins. If + `box.visible` is turned on, the mean line is + drawn inside the inner box. Otherwise, the mean + line is drawn from one side of the violin to + other. + width + Sets the mean line width. + + Returns + ------- + plotly.graph_objs.violin.Meanline + """ + return self['meanline'] + + @meanline.setter + def meanline(self, val): + self['meanline'] = val + + # name + # ---- + @property + def name(self): + """ + Sets the trace name. The trace name appear as the legend item + and on hover. For box traces, the name will also be used for + the position coordinate, if `x` and `x0` (`y` and `y0` if + horizontal) are missing and the position axis is categorical + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # offsetgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['offsetgroup'] + + @offsetgroup.setter + def offsetgroup(self, val): + self['offsetgroup'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # orientation + # ----------- + @property + 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'] + + Returns + ------- + Any + """ + return self['orientation'] + + @orientation.setter + def orientation(self, val): + self['orientation'] = val + + # pointpos + # -------- + @property + def pointpos(self): + """ + Sets the position of the sample points in relation to the + violins. If 0, the sample points are places over the center of + the violins. Positive (negative) values correspond to positions + to the right (left) for vertical violins and above (below) for + horizontal violins. + + The 'pointpos' property is a number and may be specified as: + - An int or float in the interval [-2, 2] + + Returns + ------- + int|float + """ + return self['pointpos'] + + @pointpos.setter + def pointpos(self, val): + self['pointpos'] = val + + # points + # ------ + @property + def points(self): + """ + If "outliers", only the sample points lying outside the + whiskers are shown If "suspectedoutliers", the outlier points + are shown and points either less than 4*Q1-3*Q3 or greater than + 4*Q3-3*Q1 are highlighted (see `outliercolor`) If "all", all + sample points are shown If False, only the violins are shown + with no sample points + + The 'points' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'outliers', 'suspectedoutliers', False] + + Returns + ------- + Any + """ + return self['points'] + + @points.setter + def points(self, val): + self['points'] = val + + # scalegroup + # ---------- + @property + def scalegroup(self): + """ + If there are multiple violins that should be sized according to + to some metric (see `scalemode`), link them by providing a non- + empty group id here shared by every trace in the same group. + + The 'scalegroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['scalegroup'] + + @scalegroup.setter + def scalegroup(self, val): + self['scalegroup'] = val + + # scalemode + # --------- + @property + def scalemode(self): + """ + Sets the metric by which the width of each violin is + determined."width" means each violin has the same (max) + width*count* means the violins are scaled by the number of + sample points makingup each violin. + + The 'scalemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['width', 'count'] + + Returns + ------- + Any + """ + return self['scalemode'] + + @scalemode.setter + def scalemode(self, val): + self['scalemode'] = val + + # selected + # -------- + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of plotly.graph_objs.violin.Selected + - A dict of string/value properties that will be passed + to the Selected constructor + + Supported dict properties: + + marker + plotly.graph_objs.violin.selected.Marker + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.violin.Selected + """ + return self['selected'] + + @selected.setter + def selected(self, val): + self['selected'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # side + # ---- + @property + def side(self): + """ + Determines on which side of the position value the density + function making up one half of a violin is plotted. Useful when + comparing two violin traces under "overlay" mode, where one + trace has `side` set to "positive" and the other to "negative". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['both', 'positive', 'negative'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # span + # ---- + @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 + + Returns + ------- + list + """ + return self['span'] + + @span.setter + def span(self, val): + self['span'] = val + + # spanmode + # -------- + @property + def spanmode(self): + """ + Sets the method by which the span in data space where the + density function will be computed. "soft" means the span goes + from the sample's minimum value minus two bandwidths to the + sample's maximum value plus two bandwidths. "hard" means the + span goes from the sample's minimum to its maximum value. For + custom span settings, use mode "manual" and fill in the `span` + attribute. + + The 'spanmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['soft', 'hard', 'manual'] + + Returns + ------- + Any + """ + return self['spanmode'] + + @spanmode.setter + def spanmode(self, val): + self['spanmode'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.violin.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.violin.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + def text(self): + """ + Sets the text elements associated with each sample value. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # unselected + # ---------- + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of plotly.graph_objs.violin.Unselected + - A dict of string/value properties that will be passed + to the Unselected constructor + + Supported dict properties: + + marker + plotly.graph_objs.violin.unselected.Marker + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.violin.Unselected + """ + return self['unselected'] + + @unselected.setter + def unselected(self, val): + self['unselected'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # x0 + # -- + @property + def x0(self): + """ + Sets the x coordinate of the box. See overview for more info. + + The 'x0' property accepts values of any type + + Returns + ------- + Any + """ + return self['x0'] + + @x0.setter + def x0(self, val): + self['x0'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # y0 + # -- + @property + def y0(self): + """ + Sets the y coordinate of the box. See overview for more info. + + The 'y0' property accepts values of any type + + Returns + ------- + Any + """ + return self['y0'] + + @y0.setter + def y0(self, val): + self['y0'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + alignmentgroup + Set several traces linked to the same position axis or + matching axes to the same alignmentgroup. This controls + whether bars compute their positional range dependently + or independently. + bandwidth + Sets the bandwidth used to compute the kernel density + estimate. By default, the bandwidth is determined by + Silverman's rule of thumb. + box + plotly.graph_objs.violin.Box instance or dict with + compatible properties + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.violin.Hoverlabel instance or dict + with compatible properties + hoveron + Do the hover effects highlight individual violins or + sample points or the kernel density estimate or any + combination of them? + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + jitter + Sets the amount of jitter in the sample points drawn. + If 0, the sample points align along the distribution + axis. If 1, the sample points are drawn in a random + jitter of width equal to the width of the violins. + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.violin.Line instance or dict with + compatible properties + marker + plotly.graph_objs.violin.Marker instance or dict with + compatible properties + meanline + plotly.graph_objs.violin.Meanline instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. For box traces, the name will + also be used for the position coordinate, if `x` and + `x0` (`y` and `y0` if horizontal) are missing and the + position axis is categorical + offsetgroup + Set several traces linked to the same position axis or + matching axes to the same offsetgroup where bars of the + same position coordinate will line up. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the violin(s). If "v" ("h"), + the distribution is visualized along the vertical + (horizontal). + pointpos + Sets the position of the sample points in relation to + the violins. If 0, the sample points are places over + the center of the violins. Positive (negative) values + correspond to positions to the right (left) for + vertical violins and above (below) for horizontal + violins. + points + If "outliers", only the sample points lying outside the + whiskers are shown If "suspectedoutliers", the outlier + points are shown and points either less than 4*Q1-3*Q3 + or greater than 4*Q3-3*Q1 are highlighted (see + `outliercolor`) If "all", all sample points are shown + If False, only the violins are shown with no sample + points + scalegroup + If there are multiple violins that should be sized + according to to some metric (see `scalemode`), link + them by providing a non-empty group id here shared by + every trace in the same group. + scalemode + Sets the metric by which the width of each violin is + determined."width" means each violin has the same (max) + width*count* means the violins are scaled by the number + of sample points makingup each violin. + selected + plotly.graph_objs.violin.Selected instance or dict with + compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + side + Determines on which side of the position value the + density function making up one half of a violin is + plotted. Useful when comparing two violin traces under + "overlay" mode, where one trace has `side` set to + "positive" and the other to "negative". + span + Sets the span in data space for which the density + function will be computed. Has an effect only when + `spanmode` is set to "manual". + spanmode + Sets the method by which the span in data space where + the density function will be computed. "soft" means the + span goes from the sample's minimum value minus two + bandwidths to the sample's maximum value plus two + bandwidths. "hard" means the span goes from the + sample's minimum to its maximum value. For custom span + settings, use mode "manual" and fill in the `span` + attribute. + stream + plotly.graph_objs.violin.Stream instance or dict with + compatible properties + text + Sets the text elements associated with each sample + value. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.violin.Unselected instance or dict + with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + width + Sets the width of the violin in data coordinates. If 0 + (default value) the width is automatically selected + based on the positions of other violin traces in the + same subplot. + x + Sets the x sample data or coordinates. See overview for + more info. + x0 + Sets the x coordinate of the box. See overview for more + info. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y sample data or coordinates. See overview for + more info. + y0 + Sets the y coordinate of the box. See overview for more + info. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ysrc + Sets the source reference on plot.ly for y . + """ + + def __init__( + self, + arg=None, + alignmentgroup=None, + bandwidth=None, + box=None, + customdata=None, + customdatasrc=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + jitter=None, + legendgroup=None, + line=None, + marker=None, + meanline=None, + name=None, + offsetgroup=None, + opacity=None, + orientation=None, + pointpos=None, + points=None, + scalegroup=None, + scalemode=None, + selected=None, + selectedpoints=None, + showlegend=None, + side=None, + span=None, + spanmode=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + width=None, + x=None, + x0=None, + xaxis=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ysrc=None, + **kwargs + ): + """ + Construct a new Violin object + + In vertical (horizontal) violin plots, statistics are computed + using `y` (`x`) values. By supplying an `x` (`y`) array, one + violin per distinct x (y) value is drawn If no `x` (`y`) list + is provided, a single violin is drawn. That violin position is + then positioned with with `name` or with `x0` (`y0`) if + provided. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Violin + alignmentgroup + Set several traces linked to the same position axis or + matching axes to the same alignmentgroup. This controls + whether bars compute their positional range dependently + or independently. + bandwidth + Sets the bandwidth used to compute the kernel density + estimate. By default, the bandwidth is determined by + Silverman's rule of thumb. + box + plotly.graph_objs.violin.Box instance or dict with + compatible properties + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.violin.Hoverlabel instance or dict + with compatible properties + hoveron + Do the hover effects highlight individual violins or + sample points or the kernel density estimate or any + combination of them? + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + jitter + Sets the amount of jitter in the sample points drawn. + If 0, the sample points align along the distribution + axis. If 1, the sample points are drawn in a random + jitter of width equal to the width of the violins. + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.violin.Line instance or dict with + compatible properties + marker + plotly.graph_objs.violin.Marker instance or dict with + compatible properties + meanline + plotly.graph_objs.violin.Meanline instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. For box traces, the name will + also be used for the position coordinate, if `x` and + `x0` (`y` and `y0` if horizontal) are missing and the + position axis is categorical + offsetgroup + Set several traces linked to the same position axis or + matching axes to the same offsetgroup where bars of the + same position coordinate will line up. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the violin(s). If "v" ("h"), + the distribution is visualized along the vertical + (horizontal). + pointpos + Sets the position of the sample points in relation to + the violins. If 0, the sample points are places over + the center of the violins. Positive (negative) values + correspond to positions to the right (left) for + vertical violins and above (below) for horizontal + violins. + points + If "outliers", only the sample points lying outside the + whiskers are shown If "suspectedoutliers", the outlier + points are shown and points either less than 4*Q1-3*Q3 + or greater than 4*Q3-3*Q1 are highlighted (see + `outliercolor`) If "all", all sample points are shown + If False, only the violins are shown with no sample + points + scalegroup + If there are multiple violins that should be sized + according to to some metric (see `scalemode`), link + them by providing a non-empty group id here shared by + every trace in the same group. + scalemode + Sets the metric by which the width of each violin is + determined."width" means each violin has the same (max) + width*count* means the violins are scaled by the number + of sample points makingup each violin. + selected + plotly.graph_objs.violin.Selected instance or dict with + compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + side + Determines on which side of the position value the + density function making up one half of a violin is + plotted. Useful when comparing two violin traces under + "overlay" mode, where one trace has `side` set to + "positive" and the other to "negative". + span + Sets the span in data space for which the density + function will be computed. Has an effect only when + `spanmode` is set to "manual". + spanmode + Sets the method by which the span in data space where + the density function will be computed. "soft" means the + span goes from the sample's minimum value minus two + bandwidths to the sample's maximum value plus two + bandwidths. "hard" means the span goes from the + sample's minimum to its maximum value. For custom span + settings, use mode "manual" and fill in the `span` + attribute. + stream + plotly.graph_objs.violin.Stream instance or dict with + compatible properties + text + Sets the text elements associated with each sample + value. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.violin.Unselected instance or dict + with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + width + Sets the width of the violin in data coordinates. If 0 + (default value) the width is automatically selected + based on the positions of other violin traces in the + same subplot. + x + Sets the x sample data or coordinates. See overview for + more info. + x0 + Sets the x coordinate of the box. See overview for more + info. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y sample data or coordinates. See overview for + more info. + y0 + Sets the y coordinate of the box. See overview for more + info. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ysrc + Sets the source reference on plot.ly for y . + + Returns + ------- + Violin + """ + super(Violin, self).__init__('violin') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Violin +constructor must be a dict or +an instance of plotly.graph_objs.Violin""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (violin as v_violin) + + # Initialize validators + # --------------------- + self._validators['alignmentgroup'] = v_violin.AlignmentgroupValidator() + self._validators['bandwidth'] = v_violin.BandwidthValidator() + self._validators['box'] = v_violin.BoxValidator() + self._validators['customdata'] = v_violin.CustomdataValidator() + self._validators['customdatasrc'] = v_violin.CustomdatasrcValidator() + self._validators['fillcolor'] = v_violin.FillcolorValidator() + self._validators['hoverinfo'] = v_violin.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_violin.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_violin.HoverlabelValidator() + self._validators['hoveron'] = v_violin.HoveronValidator() + self._validators['hovertext'] = v_violin.HovertextValidator() + self._validators['hovertextsrc'] = v_violin.HovertextsrcValidator() + self._validators['ids'] = v_violin.IdsValidator() + self._validators['idssrc'] = v_violin.IdssrcValidator() + self._validators['jitter'] = v_violin.JitterValidator() + self._validators['legendgroup'] = v_violin.LegendgroupValidator() + self._validators['line'] = v_violin.LineValidator() + self._validators['marker'] = v_violin.MarkerValidator() + self._validators['meanline'] = v_violin.MeanlineValidator() + self._validators['name'] = v_violin.NameValidator() + self._validators['offsetgroup'] = v_violin.OffsetgroupValidator() + self._validators['opacity'] = v_violin.OpacityValidator() + self._validators['orientation'] = v_violin.OrientationValidator() + self._validators['pointpos'] = v_violin.PointposValidator() + self._validators['points'] = v_violin.PointsValidator() + self._validators['scalegroup'] = v_violin.ScalegroupValidator() + self._validators['scalemode'] = v_violin.ScalemodeValidator() + self._validators['selected'] = v_violin.SelectedValidator() + self._validators['selectedpoints'] = v_violin.SelectedpointsValidator() + self._validators['showlegend'] = v_violin.ShowlegendValidator() + self._validators['side'] = v_violin.SideValidator() + self._validators['span'] = v_violin.SpanValidator() + self._validators['spanmode'] = v_violin.SpanmodeValidator() + self._validators['stream'] = v_violin.StreamValidator() + self._validators['text'] = v_violin.TextValidator() + self._validators['textsrc'] = v_violin.TextsrcValidator() + self._validators['uid'] = v_violin.UidValidator() + self._validators['uirevision'] = v_violin.UirevisionValidator() + self._validators['unselected'] = v_violin.UnselectedValidator() + self._validators['visible'] = v_violin.VisibleValidator() + self._validators['width'] = v_violin.WidthValidator() + self._validators['x'] = v_violin.XValidator() + self._validators['x0'] = v_violin.X0Validator() + self._validators['xaxis'] = v_violin.XAxisValidator() + self._validators['xsrc'] = v_violin.XsrcValidator() + self._validators['y'] = v_violin.YValidator() + self._validators['y0'] = v_violin.Y0Validator() + self._validators['yaxis'] = v_violin.YAxisValidator() + self._validators['ysrc'] = v_violin.YsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('alignmentgroup', None) + self['alignmentgroup' + ] = alignmentgroup if alignmentgroup is not None else _v + _v = arg.pop('bandwidth', None) + self['bandwidth'] = bandwidth if bandwidth is not None else _v + _v = arg.pop('box', None) + self['box'] = box if box is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('fillcolor', None) + self['fillcolor'] = fillcolor if fillcolor is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hoveron', None) + self['hoveron'] = hoveron if hoveron is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('jitter', None) + self['jitter'] = jitter if jitter is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('meanline', None) + self['meanline'] = meanline if meanline is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('offsetgroup', None) + self['offsetgroup'] = offsetgroup if offsetgroup is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('orientation', None) + self['orientation'] = orientation if orientation is not None else _v + _v = arg.pop('pointpos', None) + self['pointpos'] = pointpos if pointpos is not None else _v + _v = arg.pop('points', None) + self['points'] = points if points is not None else _v + _v = arg.pop('scalegroup', None) + self['scalegroup'] = scalegroup if scalegroup is not None else _v + _v = arg.pop('scalemode', None) + self['scalemode'] = scalemode if scalemode is not None else _v + _v = arg.pop('selected', None) + self['selected'] = selected if selected is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('span', None) + self['span'] = span if span is not None else _v + _v = arg.pop('spanmode', None) + self['spanmode'] = spanmode if spanmode is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('unselected', None) + self['unselected'] = unselected if unselected is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('x0', None) + self['x0'] = x0 if x0 is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('y0', None) + self['y0'] = y0 if y0 is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'violin' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='violin', val='violin' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Table(_BaseTraceType): + + # cells + # ----- + @property + def cells(self): + """ + The 'cells' property is an instance of Cells + that may be specified as: + - An instance of plotly.graph_objs.table.Cells + - A dict of string/value properties that will be passed + to the Cells constructor + + Supported dict properties: + + align + Sets the horizontal alignment of the `text` + within the box. Has an effect only if `text` + spans more two or more lines (i.e. `text` + contains one or more
HTML tags) or if an + explicit width is set to override the text + width. + alignsrc + Sets the source reference on plot.ly for align + . + fill + plotly.graph_objs.table.cells.Fill instance or + dict with compatible properties + font + plotly.graph_objs.table.cells.Font instance or + dict with compatible properties + format + Sets the cell value formatting rule using d3 + formatting mini-language which is similar to + those of Python. See https://github.com/d3/d3-f + ormat/blob/master/README.md#locale_format + formatsrc + Sets the source reference on plot.ly for + format . + height + The height of cells. + line + plotly.graph_objs.table.cells.Line instance or + dict with compatible properties + prefix + Prefix for cell values. + prefixsrc + Sets the source reference on plot.ly for + prefix . + suffix + Suffix for cell values. + suffixsrc + Sets the source reference on plot.ly for + suffix . + values + Cell values. `values[m][n]` represents the + value of the `n`th point in column `m`, + therefore the `values[m]` vector length for all + columns must be the same (longer vectors will + be truncated). Each value must be a finite + number or a string. + valuessrc + Sets the source reference on plot.ly for + values . + + Returns + ------- + plotly.graph_objs.table.Cells + """ + return self['cells'] + + @cells.setter + def cells(self, val): + self['cells'] = val + + # columnorder + # ----------- + @property + def columnorder(self): + """ + Specifies the rendered order of the data columns; for example, + a value `2` at position `0` means that column index `0` in the + data will be rendered as the third column, as columns have an + index base of zero. + + The 'columnorder' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['columnorder'] + + @columnorder.setter + def columnorder(self, val): + self['columnorder'] = val + + # columnordersrc + # -------------- + @property + def columnordersrc(self): + """ + Sets the source reference on plot.ly for columnorder . + + The 'columnordersrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['columnordersrc'] + + @columnordersrc.setter + def columnordersrc(self, val): + self['columnordersrc'] = val + + # columnwidth + # ----------- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['columnwidth'] + + @columnwidth.setter + def columnwidth(self, val): + self['columnwidth'] = val + + # columnwidthsrc + # -------------- + @property + def columnwidthsrc(self): + """ + Sets the source reference on plot.ly for columnwidth . + + The 'columnwidthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['columnwidthsrc'] + + @columnwidthsrc.setter + def columnwidthsrc(self, val): + self['columnwidthsrc'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # domain + # ------ + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of plotly.graph_objs.table.Domain + - A dict of string/value properties that will be passed + to the Domain constructor + + Supported dict properties: + + column + If there is a layout grid, use the domain for + this column in the grid for this table trace . + row + If there is a layout grid, use the domain for + this row in the grid for this table trace . + x + Sets the horizontal domain of this table trace + (in plot fraction). + y + Sets the vertical domain of this table trace + (in plot fraction). + + Returns + ------- + plotly.graph_objs.table.Domain + """ + return self['domain'] + + @domain.setter + def domain(self, val): + self['domain'] = val + + # header + # ------ + @property + def header(self): + """ + The 'header' property is an instance of Header + that may be specified as: + - An instance of plotly.graph_objs.table.Header + - A dict of string/value properties that will be passed + to the Header constructor + + Supported dict properties: + + align + Sets the horizontal alignment of the `text` + within the box. Has an effect only if `text` + spans more two or more lines (i.e. `text` + contains one or more
HTML tags) or if an + explicit width is set to override the text + width. + alignsrc + Sets the source reference on plot.ly for align + . + fill + plotly.graph_objs.table.header.Fill instance or + dict with compatible properties + font + plotly.graph_objs.table.header.Font instance or + dict with compatible properties + format + Sets the cell value formatting rule using d3 + formatting mini-language which is similar to + those of Python. See https://github.com/d3/d3-f + ormat/blob/master/README.md#locale_format + formatsrc + Sets the source reference on plot.ly for + format . + height + The height of cells. + line + plotly.graph_objs.table.header.Line instance or + dict with compatible properties + prefix + Prefix for cell values. + prefixsrc + Sets the source reference on plot.ly for + prefix . + suffix + Suffix for cell values. + suffixsrc + Sets the source reference on plot.ly for + suffix . + values + Header cell values. `values[m][n]` represents + the value of the `n`th point in column `m`, + therefore the `values[m]` vector length for all + columns must be the same (longer vectors will + be truncated). Each value must be a finite + number or a string. + valuessrc + Sets the source reference on plot.ly for + values . + + Returns + ------- + plotly.graph_objs.table.Header + """ + return self['header'] + + @header.setter + def header(self, val): + self['header'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.table.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.table.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.table.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.table.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + cells + plotly.graph_objs.table.Cells instance or dict with + compatible properties + columnorder + Specifies the rendered order of the data columns; for + example, a value `2` at position `0` means that column + index `0` in the data will be rendered as the third + column, as columns have an index base of zero. + columnordersrc + Sets the source reference on plot.ly for columnorder . + columnwidth + The width of columns expressed as a ratio. Columns fill + the available width in proportion of their specified + column widths. + columnwidthsrc + Sets the source reference on plot.ly for columnwidth . + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + domain + plotly.graph_objs.table.Domain instance or dict with + compatible properties + header + plotly.graph_objs.table.Header instance or dict with + compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.table.Hoverlabel instance or dict + with compatible properties + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.table.Stream instance or dict with + compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + """ + + def __init__( + self, + arg=None, + cells=None, + columnorder=None, + columnordersrc=None, + columnwidth=None, + columnwidthsrc=None, + customdata=None, + customdatasrc=None, + domain=None, + header=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + ids=None, + idssrc=None, + legendgroup=None, + name=None, + opacity=None, + selectedpoints=None, + showlegend=None, + stream=None, + uid=None, + uirevision=None, + visible=None, + **kwargs + ): + """ + Construct a new Table object + + Table view for detailed data viewing. The data are arranged in + a grid of rows and columns. Most styling can be specified for + columns, rows or individual cells. Table is using a column- + major order, ie. the grid is represented as a vector of column + vectors. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Table + cells + plotly.graph_objs.table.Cells instance or dict with + compatible properties + columnorder + Specifies the rendered order of the data columns; for + example, a value `2` at position `0` means that column + index `0` in the data will be rendered as the third + column, as columns have an index base of zero. + columnordersrc + Sets the source reference on plot.ly for columnorder . + columnwidth + The width of columns expressed as a ratio. Columns fill + the available width in proportion of their specified + column widths. + columnwidthsrc + Sets the source reference on plot.ly for columnwidth . + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + domain + plotly.graph_objs.table.Domain instance or dict with + compatible properties + header + plotly.graph_objs.table.Header instance or dict with + compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.table.Hoverlabel instance or dict + with compatible properties + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.table.Stream instance or dict with + compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + + Returns + ------- + Table + """ + super(Table, self).__init__('table') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Table +constructor must be a dict or +an instance of plotly.graph_objs.Table""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (table as v_table) + + # Initialize validators + # --------------------- + self._validators['cells'] = v_table.CellsValidator() + self._validators['columnorder'] = v_table.ColumnorderValidator() + self._validators['columnordersrc'] = v_table.ColumnordersrcValidator() + self._validators['columnwidth'] = v_table.ColumnwidthValidator() + self._validators['columnwidthsrc'] = v_table.ColumnwidthsrcValidator() + self._validators['customdata'] = v_table.CustomdataValidator() + self._validators['customdatasrc'] = v_table.CustomdatasrcValidator() + self._validators['domain'] = v_table.DomainValidator() + self._validators['header'] = v_table.HeaderValidator() + self._validators['hoverinfo'] = v_table.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_table.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_table.HoverlabelValidator() + self._validators['ids'] = v_table.IdsValidator() + self._validators['idssrc'] = v_table.IdssrcValidator() + self._validators['legendgroup'] = v_table.LegendgroupValidator() + self._validators['name'] = v_table.NameValidator() + self._validators['opacity'] = v_table.OpacityValidator() + self._validators['selectedpoints'] = v_table.SelectedpointsValidator() + self._validators['showlegend'] = v_table.ShowlegendValidator() + self._validators['stream'] = v_table.StreamValidator() + self._validators['uid'] = v_table.UidValidator() + self._validators['uirevision'] = v_table.UirevisionValidator() + self._validators['visible'] = v_table.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('cells', None) + self['cells'] = cells if cells is not None else _v + _v = arg.pop('columnorder', None) + self['columnorder'] = columnorder if columnorder is not None else _v + _v = arg.pop('columnordersrc', None) + self['columnordersrc' + ] = columnordersrc if columnordersrc is not None else _v + _v = arg.pop('columnwidth', None) + self['columnwidth'] = columnwidth if columnwidth is not None else _v + _v = arg.pop('columnwidthsrc', None) + self['columnwidthsrc' + ] = columnwidthsrc if columnwidthsrc is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('domain', None) + self['domain'] = domain if domain is not None else _v + _v = arg.pop('header', None) + self['header'] = header if header is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'table' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='table', val='table' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Surface(_BaseTraceType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here z or surfacecolor) or the + bounds set in `cmin` and `cmax` Defaults to `false` when + `cmin` and `cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + 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 z or surfacecolor. Has no effect when `cauto` is + `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of plotly.graph_objs.surface.ColorBar + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Supported dict properties: + + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.surface.colorbar.Tickformatst + op instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.surface.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of surface.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.surface.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + surface.colorbar.title.font instead. Sets this + color bar's title font. Note that the title's + font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use + surface.colorbar.title.side instead. Determines + the location of color bar's title with respect + to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.surface.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. The colorscale must be an array containing + arrays mapping a normalized value to an rgb, rgba, hex, hsl, + hsv, or named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # contours + # -------- + @property + def contours(self): + """ + The 'contours' property is an instance of Contours + that may be specified as: + - An instance of plotly.graph_objs.surface.Contours + - A dict of string/value properties that will be passed + to the Contours constructor + + Supported dict properties: + + x + plotly.graph_objs.surface.contours.X instance + or dict with compatible properties + y + plotly.graph_objs.surface.contours.Y instance + or dict with compatible properties + z + plotly.graph_objs.surface.contours.Z instance + or dict with compatible properties + + Returns + ------- + plotly.graph_objs.surface.Contours + """ + return self['contours'] + + @contours.setter + def contours(self, val): + self['contours'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # hidesurface + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['hidesurface'] + + @hidesurface.setter + def hidesurface(self, val): + self['hidesurface'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.surface.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.surface.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # lighting + # -------- + @property + def lighting(self): + """ + The 'lighting' property is an instance of Lighting + that may be specified as: + - An instance of plotly.graph_objs.surface.Lighting + - A dict of string/value properties that will be passed + to the Lighting constructor + + Supported dict properties: + + ambient + Ambient light increases overall color + visibility but can wash out the image. + diffuse + Represents the extent that incident rays are + reflected in a range of angles. + fresnel + Represents the reflectance as a dependency of + the viewing angle; e.g. paper is reflective + when viewing it from the edge of the paper + (almost 90 degrees), causing shine. + roughness + Alters specular reflection; the rougher the + surface, the wider and less contrasty the + shine. + specular + Represents the level that incident rays are + reflected in a single direction, causing shine. + + Returns + ------- + plotly.graph_objs.surface.Lighting + """ + return self['lighting'] + + @lighting.setter + def lighting(self, val): + self['lighting'] = val + + # lightposition + # ------------- + @property + def lightposition(self): + """ + The 'lightposition' property is an instance of Lightposition + that may be specified as: + - An instance of plotly.graph_objs.surface.Lightposition + - A dict of string/value properties that will be passed + to the Lightposition constructor + + Supported dict properties: + + x + Numeric vector, representing the X coordinate + for each vertex. + y + Numeric vector, representing the Y coordinate + for each vertex. + z + Numeric vector, representing the Z coordinate + for each vertex. + + Returns + ------- + plotly.graph_objs.surface.Lightposition + """ + return self['lightposition'] + + @lightposition.setter + def lightposition(self, val): + self['lightposition'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + def opacity(self): + """ + Sets the opacity of the surface. Please note that in the case + of using high `opacity` values for example a value greater than + or equal to 0.5 on two surfaces (and 0.25 with four surfaces), + an overlay of multiple transparent surfaces may not perfectly + be sorted in depth by the webgl API. This behavior may be + improved in the near future and is subject to change. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # reversescale + # ------------ + @property + 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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # scene + # ----- + @property + def scene(self): + """ + Sets a reference between this trace's 3D coordinate system and + a 3D scene. If "scene" (the default value), the (x,y,z) + coordinates refer to `layout.scene`. If "scene2", the (x,y,z) + coordinates refer to `layout.scene2`, and so on. + + The 'scene' property is an identifier of a particular + subplot, of type 'scene', that may be specified as the string 'scene' + optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + + Returns + ------- + str + """ + return self['scene'] + + @scene.setter + def scene(self, val): + self['scene'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.surface.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.surface.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # surfacecolor + # ------------ + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['surfacecolor'] + + @surfacecolor.setter + def surfacecolor(self, val): + self['surfacecolor'] = val + + # surfacecolorsrc + # --------------- + @property + def surfacecolorsrc(self): + """ + Sets the source reference on plot.ly for surfacecolor . + + The 'surfacecolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['surfacecolorsrc'] + + @surfacecolorsrc.setter + def surfacecolorsrc(self, val): + self['surfacecolorsrc'] = val + + # text + # ---- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['xcalendar'] + + @xcalendar.setter + def xcalendar(self, val): + self['xcalendar'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # ycalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['ycalendar'] + + @ycalendar.setter + def ycalendar(self, val): + self['ycalendar'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # z + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # zcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['zcalendar'] + + @zcalendar.setter + def zcalendar(self, val): + self['zcalendar'] = val + + # zsrc + # ---- + @property + def zsrc(self): + """ + Sets the source reference on plot.ly for z . + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['zsrc'] + + @zsrc.setter + def zsrc(self, val): + self['zsrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here z or surfacecolor) + or the bounds set in `cmin` and `cmax` Defaults to + `false` when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as z or surfacecolor and if set, + `cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as z or surfacecolor. + Has no effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as z or surfacecolor and if set, + `cmax` must be set as well. + colorbar + plotly.graph_objs.surface.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + contours + plotly.graph_objs.surface.Contours instance or dict + with compatible properties + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + hidesurface + Determines whether or not a surface is drawn. For + example, set `hidesurface` to False `contours.x.show` + to True and `contours.y.show` to True to draw a wire + frame plot. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.surface.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + lighting + plotly.graph_objs.surface.Lighting instance or dict + with compatible properties + lightposition + plotly.graph_objs.surface.Lightposition instance or + dict with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.surface.Stream instance or dict with + compatible properties + surfacecolor + Sets the surface color values, used for setting a color + scale independent of `z`. + surfacecolorsrc + Sets the source reference on plot.ly for surfacecolor + . + text + Sets the text elements associated with each z value. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates. + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the z coordinates. + zcalendar + Sets the calendar system to use with `z` date data. + zsrc + Sets the source reference on plot.ly for z . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + colorbar=None, + colorscale=None, + contours=None, + customdata=None, + customdatasrc=None, + hidesurface=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legendgroup=None, + lighting=None, + lightposition=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + selectedpoints=None, + showlegend=None, + showscale=None, + stream=None, + surfacecolor=None, + surfacecolorsrc=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xcalendar=None, + xsrc=None, + y=None, + ycalendar=None, + ysrc=None, + z=None, + zcalendar=None, + zsrc=None, + **kwargs + ): + """ + Construct a new Surface object + + The data the describes the coordinates of the surface is set in + `z`. Data in `z` should be a 2D list. Coordinates in `x` and + `y` can either be 1D lists or 2D lists (e.g. to graph + parametric surfaces). If not provided in `x` and `y`, the x and + y coordinates are assumed to be linear starting at 0 with a + unit step. The color scale corresponds to the `z` values by + default. For custom color scales, use `surfacecolor` which + should be a 2D list, where its bounds can be controlled using + `cmin` and `cmax`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Surface + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here z or surfacecolor) + or the bounds set in `cmin` and `cmax` Defaults to + `false` when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as z or surfacecolor and if set, + `cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as z or surfacecolor. + Has no effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as z or surfacecolor and if set, + `cmax` must be set as well. + colorbar + plotly.graph_objs.surface.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + contours + plotly.graph_objs.surface.Contours instance or dict + with compatible properties + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + hidesurface + Determines whether or not a surface is drawn. For + example, set `hidesurface` to False `contours.x.show` + to True and `contours.y.show` to True to draw a wire + frame plot. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.surface.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + lighting + plotly.graph_objs.surface.Lighting instance or dict + with compatible properties + lightposition + plotly.graph_objs.surface.Lightposition instance or + dict with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.surface.Stream instance or dict with + compatible properties + surfacecolor + Sets the surface color values, used for setting a color + scale independent of `z`. + surfacecolorsrc + Sets the source reference on plot.ly for surfacecolor + . + text + Sets the text elements associated with each z value. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates. + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the z coordinates. + zcalendar + Sets the calendar system to use with `z` date data. + zsrc + Sets the source reference on plot.ly for z . + + Returns + ------- + Surface + """ + super(Surface, self).__init__('surface') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Surface +constructor must be a dict or +an instance of plotly.graph_objs.Surface""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (surface as v_surface) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_surface.AutocolorscaleValidator( + ) + self._validators['cauto'] = v_surface.CautoValidator() + self._validators['cmax'] = v_surface.CmaxValidator() + self._validators['cmid'] = v_surface.CmidValidator() + self._validators['cmin'] = v_surface.CminValidator() + self._validators['colorbar'] = v_surface.ColorBarValidator() + self._validators['colorscale'] = v_surface.ColorscaleValidator() + self._validators['contours'] = v_surface.ContoursValidator() + self._validators['customdata'] = v_surface.CustomdataValidator() + self._validators['customdatasrc'] = v_surface.CustomdatasrcValidator() + self._validators['hidesurface'] = v_surface.HidesurfaceValidator() + self._validators['hoverinfo'] = v_surface.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_surface.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_surface.HoverlabelValidator() + self._validators['hovertemplate'] = v_surface.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_surface.HovertemplatesrcValidator() + self._validators['hovertext'] = v_surface.HovertextValidator() + self._validators['hovertextsrc'] = v_surface.HovertextsrcValidator() + self._validators['ids'] = v_surface.IdsValidator() + self._validators['idssrc'] = v_surface.IdssrcValidator() + self._validators['legendgroup'] = v_surface.LegendgroupValidator() + self._validators['lighting'] = v_surface.LightingValidator() + self._validators['lightposition'] = v_surface.LightpositionValidator() + self._validators['name'] = v_surface.NameValidator() + self._validators['opacity'] = v_surface.OpacityValidator() + self._validators['reversescale'] = v_surface.ReversescaleValidator() + self._validators['scene'] = v_surface.SceneValidator() + self._validators['selectedpoints'] = v_surface.SelectedpointsValidator( + ) + self._validators['showlegend'] = v_surface.ShowlegendValidator() + self._validators['showscale'] = v_surface.ShowscaleValidator() + self._validators['stream'] = v_surface.StreamValidator() + self._validators['surfacecolor'] = v_surface.SurfacecolorValidator() + self._validators['surfacecolorsrc' + ] = v_surface.SurfacecolorsrcValidator() + self._validators['text'] = v_surface.TextValidator() + self._validators['textsrc'] = v_surface.TextsrcValidator() + self._validators['uid'] = v_surface.UidValidator() + self._validators['uirevision'] = v_surface.UirevisionValidator() + self._validators['visible'] = v_surface.VisibleValidator() + self._validators['x'] = v_surface.XValidator() + self._validators['xcalendar'] = v_surface.XcalendarValidator() + self._validators['xsrc'] = v_surface.XsrcValidator() + self._validators['y'] = v_surface.YValidator() + self._validators['ycalendar'] = v_surface.YcalendarValidator() + self._validators['ysrc'] = v_surface.YsrcValidator() + self._validators['z'] = v_surface.ZValidator() + self._validators['zcalendar'] = v_surface.ZcalendarValidator() + self._validators['zsrc'] = v_surface.ZsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('contours', None) + self['contours'] = contours if contours is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('hidesurface', None) + self['hidesurface'] = hidesurface if hidesurface is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('lighting', None) + self['lighting'] = lighting if lighting is not None else _v + _v = arg.pop('lightposition', None) + self['lightposition' + ] = lightposition if lightposition is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('scene', None) + self['scene'] = scene if scene is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('surfacecolor', None) + self['surfacecolor'] = surfacecolor if surfacecolor is not None else _v + _v = arg.pop('surfacecolorsrc', None) + self['surfacecolorsrc' + ] = surfacecolorsrc if surfacecolorsrc is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xcalendar', None) + self['xcalendar'] = xcalendar if xcalendar is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('ycalendar', None) + self['ycalendar'] = ycalendar if ycalendar is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + _v = arg.pop('zcalendar', None) + self['zcalendar'] = zcalendar if zcalendar is not None else _v + _v = arg.pop('zsrc', None) + self['zsrc'] = zsrc if zsrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'surface' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='surface', val='surface' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Streamtube(_BaseTraceType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here u/v/w norm) or the bounds set + in `cmin` and `cmax` Defaults to `false` when `cmin` and + `cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + 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 u/v/w norm. Has no effect when `cauto` is + `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of plotly.graph_objs.streamtube.ColorBar + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Supported dict properties: + + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.streamtube.colorbar.Tickforma + tstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.streamtube.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of streamtube.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.streamtube.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + streamtube.colorbar.title.font instead. Sets + this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + streamtube.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.streamtube.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. The colorscale must be an array containing + arrays mapping a normalized value to an rgb, rgba, hex, hsl, + hsv, or named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.streamtube.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.streamtube.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + variables `tubex`, `tubey`, `tubez`, `tubeu`, `tubev`, `tubew`, + `norm` and `divergence`. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + 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 + + Returns + ------- + str + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # lighting + # -------- + @property + def lighting(self): + """ + The 'lighting' property is an instance of Lighting + that may be specified as: + - An instance of plotly.graph_objs.streamtube.Lighting + - A dict of string/value properties that will be passed + to the Lighting constructor + + Supported dict properties: + + ambient + Ambient light increases overall color + visibility but can wash out the image. + diffuse + Represents the extent that incident rays are + reflected in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids + math issues arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of + the viewing angle; e.g. paper is reflective + when viewing it from the edge of the paper + (almost 90 degrees), causing shine. + roughness + Alters specular reflection; the rougher the + surface, the wider and less contrasty the + shine. + specular + Represents the level that incident rays are + reflected in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids + math issues arising from degenerate geometry. + + Returns + ------- + plotly.graph_objs.streamtube.Lighting + """ + return self['lighting'] + + @lighting.setter + def lighting(self, val): + self['lighting'] = val + + # lightposition + # ------------- + @property + def lightposition(self): + """ + The 'lightposition' property is an instance of Lightposition + that may be specified as: + - An instance of plotly.graph_objs.streamtube.Lightposition + - A dict of string/value properties that will be passed + to the Lightposition constructor + + Supported dict properties: + + x + Numeric vector, representing the X coordinate + for each vertex. + y + Numeric vector, representing the Y coordinate + for each vertex. + z + Numeric vector, representing the Z coordinate + for each vertex. + + Returns + ------- + plotly.graph_objs.streamtube.Lightposition + """ + return self['lightposition'] + + @lightposition.setter + def lightposition(self, val): + self['lightposition'] = val + + # maxdisplayed + # ------------ + @property + 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] + + Returns + ------- + int + """ + return self['maxdisplayed'] + + @maxdisplayed.setter + def maxdisplayed(self, val): + self['maxdisplayed'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + def opacity(self): + """ + Sets the opacity of the surface. Please note that in the case + of using high `opacity` values for example a value greater than + or equal to 0.5 on two surfaces (and 0.25 with four surfaces), + an overlay of multiple transparent surfaces may not perfectly + be sorted in depth by the webgl API. This behavior may be + improved in the near future and is subject to change. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # reversescale + # ------------ + @property + 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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # scene + # ----- + @property + def scene(self): + """ + Sets a reference between this trace's 3D coordinate system and + a 3D scene. If "scene" (the default value), the (x,y,z) + coordinates refer to `layout.scene`. If "scene2", the (x,y,z) + coordinates refer to `layout.scene2`, and so on. + + The 'scene' property is an identifier of a particular + subplot, of type 'scene', that may be specified as the string 'scene' + optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + + Returns + ------- + str + """ + return self['scene'] + + @scene.setter + def scene(self, val): + self['scene'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # sizeref + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['sizeref'] + + @sizeref.setter + def sizeref(self, val): + self['sizeref'] = val + + # starts + # ------ + @property + def starts(self): + """ + The 'starts' property is an instance of Starts + that may be specified as: + - An instance of plotly.graph_objs.streamtube.Starts + - A dict of string/value properties that will be passed + to the Starts constructor + + Supported dict properties: + + x + Sets the x components of the starting position + of the streamtubes + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y components of the starting position + of the streamtubes + ysrc + Sets the source reference on plot.ly for y . + z + Sets the z components of the starting position + of the streamtubes + zsrc + Sets the source reference on plot.ly for z . + + Returns + ------- + plotly.graph_objs.streamtube.Starts + """ + return self['starts'] + + @starts.setter + def starts(self, val): + self['starts'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.streamtube.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.streamtube.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + def text(self): + """ + Sets a text element associated with this trace. If trace + `hoverinfo` contains a "text" flag, this text element will be + seen in all hover labels. Note that streamtube traces do not + support array `text` values. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # u + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['u'] + + @u.setter + def u(self, val): + self['u'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # usrc + # ---- + @property + def usrc(self): + """ + Sets the source reference on plot.ly for u . + + The 'usrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['usrc'] + + @usrc.setter + def usrc(self, val): + self['usrc'] = val + + # v + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['v'] + + @v.setter + def v(self, val): + self['v'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # vsrc + # ---- + @property + def vsrc(self): + """ + Sets the source reference on plot.ly for v . + + The 'vsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['vsrc'] + + @vsrc.setter + def vsrc(self, val): + self['vsrc'] = val + + # w + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['w'] + + @w.setter + def w(self, val): + self['w'] = val + + # wsrc + # ---- + @property + def wsrc(self): + """ + Sets the source reference on plot.ly for w . + + The 'wsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['wsrc'] + + @wsrc.setter + def wsrc(self, val): + self['wsrc'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # z + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # zsrc + # ---- + @property + def zsrc(self): + """ + Sets the source reference on plot.ly for z . + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['zsrc'] + + @zsrc.setter + def zsrc(self, val): + self['zsrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here u/v/w norm) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as u/v/w norm. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmax` + must be set as well. + colorbar + plotly.graph_objs.streamtube.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.streamtube.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variables `tubex`, `tubey`, `tubez`, + `tubeu`, `tubev`, `tubew`, `norm` and `divergence`. + Anything contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + lighting + plotly.graph_objs.streamtube.Lighting instance or dict + with compatible properties + lightposition + plotly.graph_objs.streamtube.Lightposition instance or + dict with compatible properties + maxdisplayed + The maximum number of displayed segments in a + streamtube. + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + sizeref + The scaling factor for the streamtubes. The default is + 1, which avoids two max divergence tubes from touching + at adjacent starting positions. + starts + plotly.graph_objs.streamtube.Starts instance or dict + with compatible properties + stream + plotly.graph_objs.streamtube.Stream instance or dict + with compatible properties + text + Sets a text element associated with this trace. If + trace `hoverinfo` contains a "text" flag, this text + element will be seen in all hover labels. Note that + streamtube traces do not support array `text` values. + u + Sets the x components of the vector field. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + usrc + Sets the source reference on plot.ly for u . + v + Sets the y components of the vector field. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + vsrc + Sets the source reference on plot.ly for v . + w + Sets the z components of the vector field. + wsrc + Sets the source reference on plot.ly for w . + x + Sets the x coordinates of the vector field. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates of the vector field. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the z coordinates of the vector field. + zsrc + Sets the source reference on plot.ly for z . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + ids=None, + idssrc=None, + legendgroup=None, + lighting=None, + lightposition=None, + maxdisplayed=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + selectedpoints=None, + showlegend=None, + showscale=None, + sizeref=None, + starts=None, + stream=None, + text=None, + u=None, + uid=None, + uirevision=None, + usrc=None, + v=None, + visible=None, + vsrc=None, + w=None, + wsrc=None, + x=None, + xsrc=None, + y=None, + ysrc=None, + z=None, + zsrc=None, + **kwargs + ): + """ + Construct a new Streamtube object + + Use a streamtube trace to visualize flow in a vector field. + Specify a vector field using 6 1D arrays of equal length, 3 + position arrays `x`, `y` and `z` and 3 vector component arrays + `u`, `v`, and `w`. By default, the tubes' starting positions + will be cut from the vector field's x-z plane at its minimum y + value. To specify your own starting position, use attributes + `starts.x`, `starts.y` and `starts.z`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Streamtube + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here u/v/w norm) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as u/v/w norm. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmax` + must be set as well. + colorbar + plotly.graph_objs.streamtube.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.streamtube.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variables `tubex`, `tubey`, `tubez`, + `tubeu`, `tubev`, `tubew`, `norm` and `divergence`. + Anything contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + lighting + plotly.graph_objs.streamtube.Lighting instance or dict + with compatible properties + lightposition + plotly.graph_objs.streamtube.Lightposition instance or + dict with compatible properties + maxdisplayed + The maximum number of displayed segments in a + streamtube. + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + sizeref + The scaling factor for the streamtubes. The default is + 1, which avoids two max divergence tubes from touching + at adjacent starting positions. + starts + plotly.graph_objs.streamtube.Starts instance or dict + with compatible properties + stream + plotly.graph_objs.streamtube.Stream instance or dict + with compatible properties + text + Sets a text element associated with this trace. If + trace `hoverinfo` contains a "text" flag, this text + element will be seen in all hover labels. Note that + streamtube traces do not support array `text` values. + u + Sets the x components of the vector field. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + usrc + Sets the source reference on plot.ly for u . + v + Sets the y components of the vector field. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + vsrc + Sets the source reference on plot.ly for v . + w + Sets the z components of the vector field. + wsrc + Sets the source reference on plot.ly for w . + x + Sets the x coordinates of the vector field. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates of the vector field. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the z coordinates of the vector field. + zsrc + Sets the source reference on plot.ly for z . + + Returns + ------- + Streamtube + """ + super(Streamtube, self).__init__('streamtube') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Streamtube +constructor must be a dict or +an instance of plotly.graph_objs.Streamtube""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (streamtube as v_streamtube) + + # Initialize validators + # --------------------- + self._validators['autocolorscale' + ] = v_streamtube.AutocolorscaleValidator() + self._validators['cauto'] = v_streamtube.CautoValidator() + self._validators['cmax'] = v_streamtube.CmaxValidator() + self._validators['cmid'] = v_streamtube.CmidValidator() + self._validators['cmin'] = v_streamtube.CminValidator() + self._validators['colorbar'] = v_streamtube.ColorBarValidator() + self._validators['colorscale'] = v_streamtube.ColorscaleValidator() + self._validators['customdata'] = v_streamtube.CustomdataValidator() + self._validators['customdatasrc' + ] = v_streamtube.CustomdatasrcValidator() + self._validators['hoverinfo'] = v_streamtube.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_streamtube.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_streamtube.HoverlabelValidator() + self._validators['hovertemplate' + ] = v_streamtube.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_streamtube.HovertemplatesrcValidator() + self._validators['hovertext'] = v_streamtube.HovertextValidator() + self._validators['ids'] = v_streamtube.IdsValidator() + self._validators['idssrc'] = v_streamtube.IdssrcValidator() + self._validators['legendgroup'] = v_streamtube.LegendgroupValidator() + self._validators['lighting'] = v_streamtube.LightingValidator() + self._validators['lightposition' + ] = v_streamtube.LightpositionValidator() + self._validators['maxdisplayed'] = v_streamtube.MaxdisplayedValidator() + self._validators['name'] = v_streamtube.NameValidator() + self._validators['opacity'] = v_streamtube.OpacityValidator() + self._validators['reversescale'] = v_streamtube.ReversescaleValidator() + self._validators['scene'] = v_streamtube.SceneValidator() + self._validators['selectedpoints' + ] = v_streamtube.SelectedpointsValidator() + self._validators['showlegend'] = v_streamtube.ShowlegendValidator() + self._validators['showscale'] = v_streamtube.ShowscaleValidator() + self._validators['sizeref'] = v_streamtube.SizerefValidator() + self._validators['starts'] = v_streamtube.StartsValidator() + self._validators['stream'] = v_streamtube.StreamValidator() + self._validators['text'] = v_streamtube.TextValidator() + self._validators['u'] = v_streamtube.UValidator() + self._validators['uid'] = v_streamtube.UidValidator() + self._validators['uirevision'] = v_streamtube.UirevisionValidator() + self._validators['usrc'] = v_streamtube.UsrcValidator() + self._validators['v'] = v_streamtube.VValidator() + self._validators['visible'] = v_streamtube.VisibleValidator() + self._validators['vsrc'] = v_streamtube.VsrcValidator() + self._validators['w'] = v_streamtube.WValidator() + self._validators['wsrc'] = v_streamtube.WsrcValidator() + self._validators['x'] = v_streamtube.XValidator() + self._validators['xsrc'] = v_streamtube.XsrcValidator() + self._validators['y'] = v_streamtube.YValidator() + self._validators['ysrc'] = v_streamtube.YsrcValidator() + self._validators['z'] = v_streamtube.ZValidator() + self._validators['zsrc'] = v_streamtube.ZsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('lighting', None) + self['lighting'] = lighting if lighting is not None else _v + _v = arg.pop('lightposition', None) + self['lightposition' + ] = lightposition if lightposition is not None else _v + _v = arg.pop('maxdisplayed', None) + self['maxdisplayed'] = maxdisplayed if maxdisplayed is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('scene', None) + self['scene'] = scene if scene is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('sizeref', None) + self['sizeref'] = sizeref if sizeref is not None else _v + _v = arg.pop('starts', None) + self['starts'] = starts if starts is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('u', None) + self['u'] = u if u is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('usrc', None) + self['usrc'] = usrc if usrc is not None else _v + _v = arg.pop('v', None) + self['v'] = v if v is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('vsrc', None) + self['vsrc'] = vsrc if vsrc is not None else _v + _v = arg.pop('w', None) + self['w'] = w if w is not None else _v + _v = arg.pop('wsrc', None) + self['wsrc'] = wsrc if wsrc is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + _v = arg.pop('zsrc', None) + self['zsrc'] = zsrc if zsrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'streamtube' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='streamtube', val='streamtube' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Splom(_BaseTraceType): + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # diagonal + # -------- + @property + def diagonal(self): + """ + The 'diagonal' property is an instance of Diagonal + that may be specified as: + - An instance of plotly.graph_objs.splom.Diagonal + - A dict of string/value properties that will be passed + to the Diagonal constructor + + Supported dict properties: + + visible + Determines whether or not subplots on the + diagonal are displayed. + + Returns + ------- + plotly.graph_objs.splom.Diagonal + """ + return self['diagonal'] + + @diagonal.setter + def diagonal(self, val): + self['diagonal'] = val + + # dimensions + # ---------- + @property + def dimensions(self): + """ + The 'dimensions' property is a tuple of instances of + Dimension that may be specified as: + - A list or tuple of instances of plotly.graph_objs.splom.Dimension + - A list or tuple of dicts of string/value properties that + will be passed to the Dimension constructor + + Supported dict properties: + + axis + plotly.graph_objs.splom.dimension.Axis instance + or dict with compatible properties + label + Sets the label corresponding to this splom + dimension. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + values + Sets the dimension values to be plotted. + valuessrc + Sets the source reference on plot.ly for + values . + visible + Determines whether or not this dimension is + shown on the graph. Note that even visible + false dimension contribute to the default grid + generate by this splom trace. + + Returns + ------- + tuple[plotly.graph_objs.splom.Dimension] + """ + return self['dimensions'] + + @dimensions.setter + def dimensions(self, val): + self['dimensions'] = val + + # dimensiondefaults + # ----------------- + @property + 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 plotly.graph_objs.splom.Dimension + - A dict of string/value properties that will be passed + to the Dimension constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.splom.Dimension + """ + return self['dimensiondefaults'] + + @dimensiondefaults.setter + def dimensiondefaults(self, val): + self['dimensiondefaults'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.splom.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.splom.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.splom.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + line + plotly.graph_objs.splom.marker.Line instance or + dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . + + Returns + ------- + plotly.graph_objs.splom.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # selected + # -------- + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of plotly.graph_objs.splom.Selected + - A dict of string/value properties that will be passed + to the Selected constructor + + Supported dict properties: + + marker + plotly.graph_objs.splom.selected.Marker + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.splom.Selected + """ + return self['selected'] + + @selected.setter + def selected(self, val): + self['selected'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # showlowerhalf + # ------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlowerhalf'] + + @showlowerhalf.setter + def showlowerhalf(self, val): + self['showlowerhalf'] = val + + # showupperhalf + # ------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showupperhalf'] + + @showupperhalf.setter + def showupperhalf(self, val): + self['showupperhalf'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.splom.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.splom.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + def text(self): + """ + Sets text elements associated with each (x,y) pair to appear on + hover. If a single string, the same string appears over all the + data points. If an array of string, the items are mapped in + order to the this trace's (x,y) coordinates. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # unselected + # ---------- + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of plotly.graph_objs.splom.Unselected + - A dict of string/value properties that will be passed + to the Unselected constructor + + Supported dict properties: + + marker + plotly.graph_objs.splom.unselected.Marker + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.splom.Unselected + """ + return self['unselected'] + + @unselected.setter + def unselected(self, val): + self['unselected'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # xaxes + # ----- + @property + def xaxes(self): + """ + Sets the list of x axes corresponding to dimensions of this + splom trace. By default, a splom will match the first N xaxes + where N is the number of input dimensions. Note that, in case + where `diagonal.visible` is false and `showupperhalf` or + `showlowerhalf` is false, this splom trace will generate one + less x-axis and one less y-axis. + + The 'xaxes' property is an info array that may be specified as: + * a list of elements where: + The 'xaxes[i]' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + list + """ + return self['xaxes'] + + @xaxes.setter + def xaxes(self, val): + self['xaxes'] = val + + # yaxes + # ----- + @property + def yaxes(self): + """ + Sets the list of y axes corresponding to dimensions of this + splom trace. By default, a splom will match the first N yaxes + where N is the number of input dimensions. Note that, in case + where `diagonal.visible` is false and `showupperhalf` or + `showlowerhalf` is false, this splom trace will generate one + less x-axis and one less y-axis. + + The 'yaxes' property is an info array that may be specified as: + * a list of elements where: + The 'yaxes[i]' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + list + """ + return self['yaxes'] + + @yaxes.setter + def yaxes(self, val): + self['yaxes'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + diagonal + plotly.graph_objs.splom.Diagonal instance or dict with + compatible properties + dimensions + plotly.graph_objs.splom.Dimension instance or dict with + compatible properties + dimensiondefaults + When used in a template (as + layout.template.data.splom.dimensiondefaults), sets the + default property values to use for elements of + splom.dimensions + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.splom.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + marker + plotly.graph_objs.splom.Marker instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.splom.Selected instance or dict with + compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showlowerhalf + Determines whether or not subplots on the lower half + from the diagonal are displayed. + showupperhalf + Determines whether or not subplots on the upper half + from the diagonal are displayed. + stream + plotly.graph_objs.splom.Stream instance or dict with + compatible properties + text + Sets text elements associated with each (x,y) pair to + appear on hover. If a single string, the same string + appears over all the data points. If an array of + string, the items are mapped in order to the this + trace's (x,y) coordinates. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.splom.Unselected instance or dict + with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + xaxes + Sets the list of x axes corresponding to dimensions of + this splom trace. By default, a splom will match the + first N xaxes where N is the number of input + dimensions. Note that, in case where `diagonal.visible` + is false and `showupperhalf` or `showlowerhalf` is + false, this splom trace will generate one less x-axis + and one less y-axis. + yaxes + Sets the list of y axes corresponding to dimensions of + this splom trace. By default, a splom will match the + first N yaxes where N is the number of input + dimensions. Note that, in case where `diagonal.visible` + is false and `showupperhalf` or `showlowerhalf` is + false, this splom trace will generate one less x-axis + and one less y-axis. + """ + + def __init__( + self, + arg=None, + customdata=None, + customdatasrc=None, + diagonal=None, + dimensions=None, + dimensiondefaults=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legendgroup=None, + marker=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + showlowerhalf=None, + showupperhalf=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + xaxes=None, + yaxes=None, + **kwargs + ): + """ + Construct a new Splom object + + Splom traces generate scatter plot matrix visualizations. Each + splom `dimensions` items correspond to a generated axis. Values + for each of those dimensions are set in `dimensions[i].values`. + Splom traces support all `scattergl` marker style attributes. + Specify `layout.grid` attributes and/or layout x-axis and + y-axis attributes for more control over the axis positioning + and style. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Splom + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + diagonal + plotly.graph_objs.splom.Diagonal instance or dict with + compatible properties + dimensions + plotly.graph_objs.splom.Dimension instance or dict with + compatible properties + dimensiondefaults + When used in a template (as + layout.template.data.splom.dimensiondefaults), sets the + default property values to use for elements of + splom.dimensions + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.splom.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + marker + plotly.graph_objs.splom.Marker instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.splom.Selected instance or dict with + compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showlowerhalf + Determines whether or not subplots on the lower half + from the diagonal are displayed. + showupperhalf + Determines whether or not subplots on the upper half + from the diagonal are displayed. + stream + plotly.graph_objs.splom.Stream instance or dict with + compatible properties + text + Sets text elements associated with each (x,y) pair to + appear on hover. If a single string, the same string + appears over all the data points. If an array of + string, the items are mapped in order to the this + trace's (x,y) coordinates. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.splom.Unselected instance or dict + with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + xaxes + Sets the list of x axes corresponding to dimensions of + this splom trace. By default, a splom will match the + first N xaxes where N is the number of input + dimensions. Note that, in case where `diagonal.visible` + is false and `showupperhalf` or `showlowerhalf` is + false, this splom trace will generate one less x-axis + and one less y-axis. + yaxes + Sets the list of y axes corresponding to dimensions of + this splom trace. By default, a splom will match the + first N yaxes where N is the number of input + dimensions. Note that, in case where `diagonal.visible` + is false and `showupperhalf` or `showlowerhalf` is + false, this splom trace will generate one less x-axis + and one less y-axis. + + Returns + ------- + Splom + """ + super(Splom, self).__init__('splom') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Splom +constructor must be a dict or +an instance of plotly.graph_objs.Splom""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (splom as v_splom) + + # Initialize validators + # --------------------- + self._validators['customdata'] = v_splom.CustomdataValidator() + self._validators['customdatasrc'] = v_splom.CustomdatasrcValidator() + self._validators['diagonal'] = v_splom.DiagonalValidator() + self._validators['dimensions'] = v_splom.DimensionsValidator() + self._validators['dimensiondefaults'] = v_splom.DimensionValidator() + self._validators['hoverinfo'] = v_splom.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_splom.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_splom.HoverlabelValidator() + self._validators['hovertemplate'] = v_splom.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_splom.HovertemplatesrcValidator() + self._validators['hovertext'] = v_splom.HovertextValidator() + self._validators['hovertextsrc'] = v_splom.HovertextsrcValidator() + self._validators['ids'] = v_splom.IdsValidator() + self._validators['idssrc'] = v_splom.IdssrcValidator() + self._validators['legendgroup'] = v_splom.LegendgroupValidator() + self._validators['marker'] = v_splom.MarkerValidator() + self._validators['name'] = v_splom.NameValidator() + self._validators['opacity'] = v_splom.OpacityValidator() + self._validators['selected'] = v_splom.SelectedValidator() + self._validators['selectedpoints'] = v_splom.SelectedpointsValidator() + self._validators['showlegend'] = v_splom.ShowlegendValidator() + self._validators['showlowerhalf'] = v_splom.ShowlowerhalfValidator() + self._validators['showupperhalf'] = v_splom.ShowupperhalfValidator() + self._validators['stream'] = v_splom.StreamValidator() + self._validators['text'] = v_splom.TextValidator() + self._validators['textsrc'] = v_splom.TextsrcValidator() + self._validators['uid'] = v_splom.UidValidator() + self._validators['uirevision'] = v_splom.UirevisionValidator() + self._validators['unselected'] = v_splom.UnselectedValidator() + self._validators['visible'] = v_splom.VisibleValidator() + self._validators['xaxes'] = v_splom.XaxesValidator() + self._validators['yaxes'] = v_splom.YaxesValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('diagonal', None) + self['diagonal'] = diagonal if diagonal is not None else _v + _v = arg.pop('dimensions', None) + self['dimensions'] = dimensions if dimensions is not None else _v + _v = arg.pop('dimensiondefaults', None) + self['dimensiondefaults' + ] = dimensiondefaults if dimensiondefaults is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('selected', None) + self['selected'] = selected if selected is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('showlowerhalf', None) + self['showlowerhalf' + ] = showlowerhalf if showlowerhalf is not None else _v + _v = arg.pop('showupperhalf', None) + self['showupperhalf' + ] = showupperhalf if showupperhalf is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('unselected', None) + self['unselected'] = unselected if unselected is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('xaxes', None) + self['xaxes'] = xaxes if xaxes is not None else _v + _v = arg.pop('yaxes', None) + self['yaxes'] = yaxes if yaxes is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'splom' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='splom', val='splom' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scatterternary(_BaseTraceType): + + # a + # - + @property + def a(self): + """ + Sets the quantity of component `a` in each data point. If `a`, + `b`, and `c` are all provided, they need not be normalized, + only the relative values matter. If only two arrays are + provided they must be normalized to match `ternary.sum`. + + The 'a' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['a'] + + @a.setter + def a(self, val): + self['a'] = val + + # asrc + # ---- + @property + def asrc(self): + """ + Sets the source reference on plot.ly for a . + + The 'asrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['asrc'] + + @asrc.setter + def asrc(self, val): + self['asrc'] = val + + # b + # - + @property + def b(self): + """ + Sets the quantity of component `a` in each data point. If `a`, + `b`, and `c` are all provided, they need not be normalized, + only the relative values matter. If only two arrays are + provided they must be normalized to match `ternary.sum`. + + The 'b' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['b'] + + @b.setter + def b(self, val): + self['b'] = val + + # bsrc + # ---- + @property + def bsrc(self): + """ + Sets the source reference on plot.ly for b . + + The 'bsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bsrc'] + + @bsrc.setter + def bsrc(self, val): + self['bsrc'] = val + + # c + # - + @property + def c(self): + """ + Sets the quantity of component `a` in each data point. If `a`, + `b`, and `c` are all provided, they need not be normalized, + only the relative values matter. If only two arrays are + provided they must be normalized to match `ternary.sum`. + + The 'c' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['c'] + + @c.setter + def c(self, val): + self['c'] = val + + # cliponaxis + # ---------- + @property + def cliponaxis(self): + """ + Determines whether or not markers and text nodes are clipped + about the subplot axes. To show markers and text nodes above + axis lines and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + + The 'cliponaxis' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cliponaxis'] + + @cliponaxis.setter + def cliponaxis(self, val): + self['cliponaxis'] = val + + # connectgaps + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['connectgaps'] + + @connectgaps.setter + def connectgaps(self, val): + self['connectgaps'] = val + + # csrc + # ---- + @property + def csrc(self): + """ + Sets the source reference on plot.ly for c . + + The 'csrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['csrc'] + + @csrc.setter + def csrc(self, val): + self['csrc'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # fill + # ---- + @property + def fill(self): + """ + Sets the area to fill with a solid color. Use with `fillcolor` + if not "none". scatterternary has a subset of the options + available to scatter. "toself" connects the endpoints of the + trace (or each segment of the trace if it has gaps) into a + closed shape. "tonext" fills the space between two traces if + one completely encloses the other (eg consecutive contour + lines), and behaves like "toself" if there is no trace before + it. "tonext" should not be used if one trace does not enclose + the other. + + The 'fill' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'toself', 'tonext'] + + Returns + ------- + Any + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # fillcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['fillcolor'] + + @fillcolor.setter + def fillcolor(self, val): + self['fillcolor'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'a+b') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.scatterternary.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.scatterternary.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hoveron + # ------- + @property + def hoveron(self): + """ + Do the hover effects highlight individual points (markers or + line points) or do they highlight filled regions? If the fill + is "toself" or "tonext" and there are no markers or text, then + the default is "fills", otherwise it is "points". + + The 'hoveron' property is a flaglist and may be specified + as a string containing: + - Any combination of ['points', 'fills'] joined with '+' characters + (e.g. 'points+fills') + + Returns + ------- + Any + """ + return self['hoveron'] + + @hoveron.setter + def hoveron(self, val): + self['hoveron'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + def hovertext(self): + """ + Sets hover text elements associated with each (a,b,c) point. If + a single string, the same string appears over all the data + points. If an array of strings, the items are mapped in order + to the the data points in (a,b,c). To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the + lines are drawn using spline interpolation. The + other available values correspond to step-wise + line shapes. + smoothing + Has an effect only if `shape` is set to + "spline" Sets the amount of smoothing. 0 + corresponds to no smoothing (equivalent to a + "linear" shape). + width + Sets the line width (in px). + + Returns + ------- + plotly.graph_objs.scatterternary.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scatterternary.marker.ColorBa + r instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + gradient + plotly.graph_objs.scatterternary.marker.Gradien + t instance or dict with compatible properties + line + plotly.graph_objs.scatterternary.marker.Line + instance or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on + the graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . + + Returns + ------- + plotly.graph_objs.scatterternary.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # mode + # ---- + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. If there are less than 20 points and the trace is not + stacked then the default is "lines+markers". Otherwise, + "lines". + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self['mode'] + + @mode.setter + def mode(self, val): + self['mode'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # selected + # -------- + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of plotly.graph_objs.scatterternary.Selected + - A dict of string/value properties that will be passed + to the Selected constructor + + Supported dict properties: + + marker + plotly.graph_objs.scatterternary.selected.Marke + r instance or dict with compatible properties + textfont + plotly.graph_objs.scatterternary.selected.Textf + ont instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.scatterternary.Selected + """ + return self['selected'] + + @selected.setter + def selected(self, val): + self['selected'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.scatterternary.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.scatterternary.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # subplot + # ------- + @property + def subplot(self): + """ + Sets a reference between this trace's data coordinates and a + ternary subplot. If "ternary" (the default value), the data + refer to `layout.ternary`. If "ternary2", the data refer to + `layout.ternary2`, and so on. + + The 'subplot' property is an identifier of a particular + subplot, of type 'ternary', that may be specified as the string 'ternary' + optionally followed by an integer >= 1 + (e.g. 'ternary', 'ternary1', 'ternary2', 'ternary3', etc.) + + Returns + ------- + str + """ + return self['subplot'] + + @subplot.setter + def subplot(self, val): + self['subplot'] = val + + # sum + # --- + @property + def sum(self): + """ + The number each triplet should sum to, if only two of `a`, `b`, + and `c` are provided. This overrides `ternary.sum` to + normalize this specific trace, but does not affect the values + displayed on the axes. 0 (or missing) means to use + ternary.sum + + The 'sum' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self['sum'] + + @sum.setter + def sum(self, val): + self['sum'] = val + + # text + # ---- + @property + def text(self): + """ + Sets text elements associated with each (a,b,c) point. If a + single string, the same string appears over all the data + points. If an array of strings, the items are mapped in order + to the the data points in (a,b,c). If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, these + elements will be seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scatterternary.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # textposition + # ------------ + @property + 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', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['textposition'] + + @textposition.setter + def textposition(self, val): + self['textposition'] = val + + # textpositionsrc + # --------------- + @property + def textpositionsrc(self): + """ + Sets the source reference on plot.ly for textposition . + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textpositionsrc'] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self['textpositionsrc'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # unselected + # ---------- + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of plotly.graph_objs.scatterternary.Unselected + - A dict of string/value properties that will be passed + to the Unselected constructor + + Supported dict properties: + + marker + plotly.graph_objs.scatterternary.unselected.Mar + ker instance or dict with compatible properties + textfont + plotly.graph_objs.scatterternary.unselected.Tex + tfont instance or dict with compatible + properties + + Returns + ------- + plotly.graph_objs.scatterternary.Unselected + """ + return self['unselected'] + + @unselected.setter + def unselected(self, val): + self['unselected'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + a + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + asrc + Sets the source reference on plot.ly for a . + b + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + bsrc + Sets the source reference on plot.ly for b . + c + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + csrc + Sets the source reference on plot.ly for c . + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterternary has a subset + of the options available to scatter. "toself" connects + the endpoints of the trace (or each segment of the + trace if it has gaps) into a closed shape. "tonext" + fills the space between two traces if one completely + encloses the other (eg consecutive contour lines), and + behaves like "toself" if there is no trace before it. + "tonext" should not be used if one trace does not + enclose the other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scatterternary.Hoverlabel instance or + dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (a,b,c) + point. If a single string, the same string appears over + all the data points. If an array of strings, the items + are mapped in order to the the data points in (a,b,c). + To be seen, trace `hoverinfo` must contain a "text" + flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scatterternary.Line instance or dict + with compatible properties + marker + plotly.graph_objs.scatterternary.Marker instance or + dict with compatible properties + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.scatterternary.Selected instance or + dict with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.scatterternary.Stream instance or + dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a ternary subplot. If "ternary" (the default + value), the data refer to `layout.ternary`. If + "ternary2", the data refer to `layout.ternary2`, and so + on. + sum + The number each triplet should sum to, if only two of + `a`, `b`, and `c` are provided. This overrides + `ternary.sum` to normalize this specific trace, but + does not affect the values displayed on the axes. 0 (or + missing) means to use ternary.sum + text + Sets text elements associated with each (a,b,c) point. + If a single string, the same string appears over all + the data points. If an array of strings, the items are + mapped in order to the the data points in (a,b,c). If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.scatterternary.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + """ + + def __init__( + self, + arg=None, + a=None, + asrc=None, + b=None, + bsrc=None, + c=None, + cliponaxis=None, + connectgaps=None, + csrc=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legendgroup=None, + line=None, + marker=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + sum=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + **kwargs + ): + """ + Construct a new Scatterternary object + + Provides similar functionality to the "scatter" type but on a + ternary phase diagram. The data is provided by at least two + arrays out of `a`, `b`, `c` triplets. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Scatterternary + a + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + asrc + Sets the source reference on plot.ly for a . + b + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + bsrc + Sets the source reference on plot.ly for b . + c + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + csrc + Sets the source reference on plot.ly for c . + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterternary has a subset + of the options available to scatter. "toself" connects + the endpoints of the trace (or each segment of the + trace if it has gaps) into a closed shape. "tonext" + fills the space between two traces if one completely + encloses the other (eg consecutive contour lines), and + behaves like "toself" if there is no trace before it. + "tonext" should not be used if one trace does not + enclose the other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scatterternary.Hoverlabel instance or + dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (a,b,c) + point. If a single string, the same string appears over + all the data points. If an array of strings, the items + are mapped in order to the the data points in (a,b,c). + To be seen, trace `hoverinfo` must contain a "text" + flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scatterternary.Line instance or dict + with compatible properties + marker + plotly.graph_objs.scatterternary.Marker instance or + dict with compatible properties + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.scatterternary.Selected instance or + dict with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.scatterternary.Stream instance or + dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a ternary subplot. If "ternary" (the default + value), the data refer to `layout.ternary`. If + "ternary2", the data refer to `layout.ternary2`, and so + on. + sum + The number each triplet should sum to, if only two of + `a`, `b`, and `c` are provided. This overrides + `ternary.sum` to normalize this specific trace, but + does not affect the values displayed on the axes. 0 (or + missing) means to use ternary.sum + text + Sets text elements associated with each (a,b,c) point. + If a single string, the same string appears over all + the data points. If an array of strings, the items are + mapped in order to the the data points in (a,b,c). If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.scatterternary.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + + Returns + ------- + Scatterternary + """ + super(Scatterternary, self).__init__('scatterternary') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Scatterternary +constructor must be a dict or +an instance of plotly.graph_objs.Scatterternary""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (scatterternary as v_scatterternary) + + # Initialize validators + # --------------------- + self._validators['a'] = v_scatterternary.AValidator() + self._validators['asrc'] = v_scatterternary.AsrcValidator() + self._validators['b'] = v_scatterternary.BValidator() + self._validators['bsrc'] = v_scatterternary.BsrcValidator() + self._validators['c'] = v_scatterternary.CValidator() + self._validators['cliponaxis'] = v_scatterternary.CliponaxisValidator() + self._validators['connectgaps' + ] = v_scatterternary.ConnectgapsValidator() + self._validators['csrc'] = v_scatterternary.CsrcValidator() + self._validators['customdata'] = v_scatterternary.CustomdataValidator() + self._validators['customdatasrc' + ] = v_scatterternary.CustomdatasrcValidator() + self._validators['fill'] = v_scatterternary.FillValidator() + self._validators['fillcolor'] = v_scatterternary.FillcolorValidator() + self._validators['hoverinfo'] = v_scatterternary.HoverinfoValidator() + self._validators['hoverinfosrc' + ] = v_scatterternary.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_scatterternary.HoverlabelValidator() + self._validators['hoveron'] = v_scatterternary.HoveronValidator() + self._validators['hovertemplate' + ] = v_scatterternary.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_scatterternary.HovertemplatesrcValidator() + self._validators['hovertext'] = v_scatterternary.HovertextValidator() + self._validators['hovertextsrc' + ] = v_scatterternary.HovertextsrcValidator() + self._validators['ids'] = v_scatterternary.IdsValidator() + self._validators['idssrc'] = v_scatterternary.IdssrcValidator() + self._validators['legendgroup' + ] = v_scatterternary.LegendgroupValidator() + self._validators['line'] = v_scatterternary.LineValidator() + self._validators['marker'] = v_scatterternary.MarkerValidator() + self._validators['mode'] = v_scatterternary.ModeValidator() + self._validators['name'] = v_scatterternary.NameValidator() + self._validators['opacity'] = v_scatterternary.OpacityValidator() + self._validators['selected'] = v_scatterternary.SelectedValidator() + self._validators['selectedpoints' + ] = v_scatterternary.SelectedpointsValidator() + self._validators['showlegend'] = v_scatterternary.ShowlegendValidator() + self._validators['stream'] = v_scatterternary.StreamValidator() + self._validators['subplot'] = v_scatterternary.SubplotValidator() + self._validators['sum'] = v_scatterternary.SumValidator() + self._validators['text'] = v_scatterternary.TextValidator() + self._validators['textfont'] = v_scatterternary.TextfontValidator() + self._validators['textposition' + ] = v_scatterternary.TextpositionValidator() + self._validators['textpositionsrc' + ] = v_scatterternary.TextpositionsrcValidator() + self._validators['textsrc'] = v_scatterternary.TextsrcValidator() + self._validators['uid'] = v_scatterternary.UidValidator() + self._validators['uirevision'] = v_scatterternary.UirevisionValidator() + self._validators['unselected'] = v_scatterternary.UnselectedValidator() + self._validators['visible'] = v_scatterternary.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('a', None) + self['a'] = a if a is not None else _v + _v = arg.pop('asrc', None) + self['asrc'] = asrc if asrc is not None else _v + _v = arg.pop('b', None) + self['b'] = b if b is not None else _v + _v = arg.pop('bsrc', None) + self['bsrc'] = bsrc if bsrc is not None else _v + _v = arg.pop('c', None) + self['c'] = c if c is not None else _v + _v = arg.pop('cliponaxis', None) + self['cliponaxis'] = cliponaxis if cliponaxis is not None else _v + _v = arg.pop('connectgaps', None) + self['connectgaps'] = connectgaps if connectgaps is not None else _v + _v = arg.pop('csrc', None) + self['csrc'] = csrc if csrc is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('fillcolor', None) + self['fillcolor'] = fillcolor if fillcolor is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hoveron', None) + self['hoveron'] = hoveron if hoveron is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('mode', None) + self['mode'] = mode if mode is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('selected', None) + self['selected'] = selected if selected is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('subplot', None) + self['subplot'] = subplot if subplot is not None else _v + _v = arg.pop('sum', None) + self['sum'] = sum if sum is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + _v = arg.pop('textposition', None) + self['textposition'] = textposition if textposition is not None else _v + _v = arg.pop('textpositionsrc', None) + self['textpositionsrc' + ] = textpositionsrc if textpositionsrc is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('unselected', None) + self['unselected'] = unselected if unselected is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'scatterternary' + self._validators['type'] = LiteralValidator( + plotly_name='type', + parent_name='scatterternary', + val='scatterternary' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scatterpolargl(_BaseTraceType): + + # connectgaps + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['connectgaps'] + + @connectgaps.setter + def connectgaps(self, val): + self['connectgaps'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # dr + # -- + @property + def dr(self): + """ + Sets the r coordinate step. + + The 'dr' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['dr'] + + @dr.setter + def dr(self, val): + self['dr'] = val + + # dtheta + # ------ + @property + 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 + + Returns + ------- + int|float + """ + return self['dtheta'] + + @dtheta.setter + def dtheta(self, val): + self['dtheta'] = val + + # fill + # ---- + @property + def fill(self): + """ + Sets the area to fill with a solid color. Defaults to "none" + unless this trace is stacked, then it gets "tonexty" + ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` + if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 + respectively. "tonextx" and "tonexty" fill between the + endpoints of this trace and the endpoints of the trace before + it, connecting those endpoints with straight lines (to make a + stacked area graph); if there is no trace before it, they + behave like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if it has + gaps) into a closed shape. "tonext" fills the space between two + traces if one completely encloses the other (eg consecutive + contour lines), and behaves like "toself" if there is no trace + before it. "tonext" should not be used if one trace does not + enclose the other. Traces in a `stackgroup` will only fill to + (or be filled to) other traces in the same group. With multiple + `stackgroup`s or some traces stacked and some not, if fill- + linked traces are not already consecutive, the later ones will + be pushed down in the drawing order. + + The 'fill' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', + 'toself', 'tonext'] + + Returns + ------- + Any + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # fillcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['fillcolor'] + + @fillcolor.setter + def fillcolor(self, val): + self['fillcolor'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'r+theta') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.scatterpolargl.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.scatterpolargl.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + def hovertext(self): + """ + Sets hover text elements associated with each (x,y) pair. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of plotly.graph_objs.scatterpolargl.Line + - A dict of string/value properties that will be passed + to the Line constructor + + Supported dict properties: + + color + Sets the line color. + dash + Sets the style of the lines. + shape + Determines the line shape. The values + correspond to step-wise line shapes. + width + Sets the line width (in px). + + Returns + ------- + plotly.graph_objs.scatterpolargl.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scatterpolargl.marker.ColorBa + r instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + line + plotly.graph_objs.scatterpolargl.marker.Line + instance or dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . + + Returns + ------- + plotly.graph_objs.scatterpolargl.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # mode + # ---- + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. If there are less than 20 points and the trace is not + stacked then the default is "lines+markers". Otherwise, + "lines". + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self['mode'] + + @mode.setter + def mode(self, val): + self['mode'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # r + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['r'] + + @r.setter + def r(self, val): + self['r'] = val + + # r0 + # -- + @property + 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 + ------- + Any + """ + return self['r0'] + + @r0.setter + def r0(self, val): + self['r0'] = val + + # rsrc + # ---- + @property + def rsrc(self): + """ + Sets the source reference on plot.ly for r . + + The 'rsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['rsrc'] + + @rsrc.setter + def rsrc(self, val): + self['rsrc'] = val + + # selected + # -------- + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of plotly.graph_objs.scatterpolargl.Selected + - A dict of string/value properties that will be passed + to the Selected constructor + + Supported dict properties: + + marker + plotly.graph_objs.scatterpolargl.selected.Marke + r instance or dict with compatible properties + textfont + plotly.graph_objs.scatterpolargl.selected.Textf + ont instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.scatterpolargl.Selected + """ + return self['selected'] + + @selected.setter + def selected(self, val): + self['selected'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.scatterpolargl.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.scatterpolargl.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # subplot + # ------- + @property + def subplot(self): + """ + Sets a reference between this trace's data coordinates and a + polar subplot. If "polar" (the default value), the data refer + to `layout.polar`. If "polar2", the data refer to + `layout.polar2`, and so on. + + The 'subplot' property is an identifier of a particular + subplot, of type 'polar', that may be specified as the string 'polar' + optionally followed by an integer >= 1 + (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) + + Returns + ------- + str + """ + return self['subplot'] + + @subplot.setter + def subplot(self, val): + self['subplot'] = val + + # text + # ---- + @property + def text(self): + """ + Sets text elements associated with each (x,y) pair. If a single + string, the same string appears over all the data points. If an + array of string, the items are mapped in order to the this + trace's (x,y) coordinates. If trace `hoverinfo` contains a + "text" flag and "hovertext" is not set, these elements will be + seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scatterpolargl.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # textposition + # ------------ + @property + 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', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['textposition'] + + @textposition.setter + def textposition(self, val): + self['textposition'] = val + + # textpositionsrc + # --------------- + @property + def textpositionsrc(self): + """ + Sets the source reference on plot.ly for textposition . + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textpositionsrc'] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self['textpositionsrc'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # theta + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['theta'] + + @theta.setter + def theta(self, val): + self['theta'] = val + + # theta0 + # ------ + @property + 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 + ------- + Any + """ + return self['theta0'] + + @theta0.setter + def theta0(self, val): + self['theta0'] = val + + # thetasrc + # -------- + @property + def thetasrc(self): + """ + Sets the source reference on plot.ly for theta . + + The 'thetasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['thetasrc'] + + @thetasrc.setter + def thetasrc(self, val): + self['thetasrc'] = val + + # thetaunit + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thetaunit'] + + @thetaunit.setter + def thetaunit(self, val): + self['thetaunit'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # unselected + # ---------- + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of plotly.graph_objs.scatterpolargl.Unselected + - A dict of string/value properties that will be passed + to the Unselected constructor + + Supported dict properties: + + marker + plotly.graph_objs.scatterpolargl.unselected.Mar + ker instance or dict with compatible properties + textfont + plotly.graph_objs.scatterpolargl.unselected.Tex + tfont instance or dict with compatible + properties + + Returns + ------- + plotly.graph_objs.scatterpolargl.Unselected + """ + return self['unselected'] + + @unselected.setter + def unselected(self, val): + self['unselected'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scatterpolargl.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scatterpolargl.Line instance or dict + with compatible properties + marker + plotly.graph_objs.scatterpolargl.Marker instance or + dict with compatible properties + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on plot.ly for r . + selected + plotly.graph_objs.scatterpolargl.Selected instance or + dict with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.scatterpolargl.Stream instance or + dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on plot.ly for theta . + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.scatterpolargl.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + """ + + def __init__( + self, + arg=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + dr=None, + dtheta=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legendgroup=None, + line=None, + marker=None, + mode=None, + name=None, + opacity=None, + r=None, + r0=None, + rsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + theta=None, + theta0=None, + thetasrc=None, + thetaunit=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + **kwargs + ): + """ + Construct a new Scatterpolargl object + + The scatterpolargl trace type encompasses line charts, scatter + charts, and bubble charts in polar coordinates using the WebGL + plotting engine. The data visualized as scatter point or lines + is set in `r` (radial) and `theta` (angular) coordinates Bubble + charts are achieved by setting `marker.size` and/or + `marker.color` to numerical arrays. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Scatterpolargl + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scatterpolargl.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scatterpolargl.Line instance or dict + with compatible properties + marker + plotly.graph_objs.scatterpolargl.Marker instance or + dict with compatible properties + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on plot.ly for r . + selected + plotly.graph_objs.scatterpolargl.Selected instance or + dict with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.scatterpolargl.Stream instance or + dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on plot.ly for theta . + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.scatterpolargl.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + + Returns + ------- + Scatterpolargl + """ + super(Scatterpolargl, self).__init__('scatterpolargl') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Scatterpolargl +constructor must be a dict or +an instance of plotly.graph_objs.Scatterpolargl""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (scatterpolargl as v_scatterpolargl) + + # Initialize validators + # --------------------- + self._validators['connectgaps' + ] = v_scatterpolargl.ConnectgapsValidator() + self._validators['customdata'] = v_scatterpolargl.CustomdataValidator() + self._validators['customdatasrc' + ] = v_scatterpolargl.CustomdatasrcValidator() + self._validators['dr'] = v_scatterpolargl.DrValidator() + self._validators['dtheta'] = v_scatterpolargl.DthetaValidator() + self._validators['fill'] = v_scatterpolargl.FillValidator() + self._validators['fillcolor'] = v_scatterpolargl.FillcolorValidator() + self._validators['hoverinfo'] = v_scatterpolargl.HoverinfoValidator() + self._validators['hoverinfosrc' + ] = v_scatterpolargl.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_scatterpolargl.HoverlabelValidator() + self._validators['hovertemplate' + ] = v_scatterpolargl.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_scatterpolargl.HovertemplatesrcValidator() + self._validators['hovertext'] = v_scatterpolargl.HovertextValidator() + self._validators['hovertextsrc' + ] = v_scatterpolargl.HovertextsrcValidator() + self._validators['ids'] = v_scatterpolargl.IdsValidator() + self._validators['idssrc'] = v_scatterpolargl.IdssrcValidator() + self._validators['legendgroup' + ] = v_scatterpolargl.LegendgroupValidator() + self._validators['line'] = v_scatterpolargl.LineValidator() + self._validators['marker'] = v_scatterpolargl.MarkerValidator() + self._validators['mode'] = v_scatterpolargl.ModeValidator() + self._validators['name'] = v_scatterpolargl.NameValidator() + self._validators['opacity'] = v_scatterpolargl.OpacityValidator() + self._validators['r'] = v_scatterpolargl.RValidator() + self._validators['r0'] = v_scatterpolargl.R0Validator() + self._validators['rsrc'] = v_scatterpolargl.RsrcValidator() + self._validators['selected'] = v_scatterpolargl.SelectedValidator() + self._validators['selectedpoints' + ] = v_scatterpolargl.SelectedpointsValidator() + self._validators['showlegend'] = v_scatterpolargl.ShowlegendValidator() + self._validators['stream'] = v_scatterpolargl.StreamValidator() + self._validators['subplot'] = v_scatterpolargl.SubplotValidator() + self._validators['text'] = v_scatterpolargl.TextValidator() + self._validators['textfont'] = v_scatterpolargl.TextfontValidator() + self._validators['textposition' + ] = v_scatterpolargl.TextpositionValidator() + self._validators['textpositionsrc' + ] = v_scatterpolargl.TextpositionsrcValidator() + self._validators['textsrc'] = v_scatterpolargl.TextsrcValidator() + self._validators['theta'] = v_scatterpolargl.ThetaValidator() + self._validators['theta0'] = v_scatterpolargl.Theta0Validator() + self._validators['thetasrc'] = v_scatterpolargl.ThetasrcValidator() + self._validators['thetaunit'] = v_scatterpolargl.ThetaunitValidator() + self._validators['uid'] = v_scatterpolargl.UidValidator() + self._validators['uirevision'] = v_scatterpolargl.UirevisionValidator() + self._validators['unselected'] = v_scatterpolargl.UnselectedValidator() + self._validators['visible'] = v_scatterpolargl.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('connectgaps', None) + self['connectgaps'] = connectgaps if connectgaps is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('dr', None) + self['dr'] = dr if dr is not None else _v + _v = arg.pop('dtheta', None) + self['dtheta'] = dtheta if dtheta is not None else _v + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('fillcolor', None) + self['fillcolor'] = fillcolor if fillcolor is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('mode', None) + self['mode'] = mode if mode is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('r', None) + self['r'] = r if r is not None else _v + _v = arg.pop('r0', None) + self['r0'] = r0 if r0 is not None else _v + _v = arg.pop('rsrc', None) + self['rsrc'] = rsrc if rsrc is not None else _v + _v = arg.pop('selected', None) + self['selected'] = selected if selected is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('subplot', None) + self['subplot'] = subplot if subplot is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + _v = arg.pop('textposition', None) + self['textposition'] = textposition if textposition is not None else _v + _v = arg.pop('textpositionsrc', None) + self['textpositionsrc' + ] = textpositionsrc if textpositionsrc is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('theta', None) + self['theta'] = theta if theta is not None else _v + _v = arg.pop('theta0', None) + self['theta0'] = theta0 if theta0 is not None else _v + _v = arg.pop('thetasrc', None) + self['thetasrc'] = thetasrc if thetasrc is not None else _v + _v = arg.pop('thetaunit', None) + self['thetaunit'] = thetaunit if thetaunit is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('unselected', None) + self['unselected'] = unselected if unselected is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'scatterpolargl' + self._validators['type'] = LiteralValidator( + plotly_name='type', + parent_name='scatterpolargl', + val='scatterpolargl' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scatterpolar(_BaseTraceType): + + # cliponaxis + # ---------- + @property + def cliponaxis(self): + """ + Determines whether or not markers and text nodes are clipped + about the subplot axes. To show markers and text nodes above + axis lines and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + + The 'cliponaxis' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cliponaxis'] + + @cliponaxis.setter + def cliponaxis(self, val): + self['cliponaxis'] = val + + # connectgaps + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['connectgaps'] + + @connectgaps.setter + def connectgaps(self, val): + self['connectgaps'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # dr + # -- + @property + def dr(self): + """ + Sets the r coordinate step. + + The 'dr' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['dr'] + + @dr.setter + def dr(self, val): + self['dr'] = val + + # dtheta + # ------ + @property + 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 + + Returns + ------- + int|float + """ + return self['dtheta'] + + @dtheta.setter + def dtheta(self, val): + self['dtheta'] = val + + # fill + # ---- + @property + def fill(self): + """ + Sets the area to fill with a solid color. Use with `fillcolor` + if not "none". scatterpolar has a subset of the options + available to scatter. "toself" connects the endpoints of the + trace (or each segment of the trace if it has gaps) into a + closed shape. "tonext" fills the space between two traces if + one completely encloses the other (eg consecutive contour + lines), and behaves like "toself" if there is no trace before + it. "tonext" should not be used if one trace does not enclose + the other. + + The 'fill' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'toself', 'tonext'] + + Returns + ------- + Any + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # fillcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['fillcolor'] + + @fillcolor.setter + def fillcolor(self, val): + self['fillcolor'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'r+theta') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.scatterpolar.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.scatterpolar.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hoveron + # ------- + @property + def hoveron(self): + """ + Do the hover effects highlight individual points (markers or + line points) or do they highlight filled regions? If the fill + is "toself" or "tonext" and there are no markers or text, then + the default is "fills", otherwise it is "points". + + The 'hoveron' property is a flaglist and may be specified + as a string containing: + - Any combination of ['points', 'fills'] joined with '+' characters + (e.g. 'points+fills') + + Returns + ------- + Any + """ + return self['hoveron'] + + @hoveron.setter + def hoveron(self, val): + self['hoveron'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + def hovertext(self): + """ + Sets hover text elements associated with each (x,y) pair. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the + lines are drawn using spline interpolation. The + other available values correspond to step-wise + line shapes. + smoothing + Has an effect only if `shape` is set to + "spline" Sets the amount of smoothing. 0 + corresponds to no smoothing (equivalent to a + "linear" shape). + width + Sets the line width (in px). + + Returns + ------- + plotly.graph_objs.scatterpolar.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scatterpolar.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + gradient + plotly.graph_objs.scatterpolar.marker.Gradient + instance or dict with compatible properties + line + plotly.graph_objs.scatterpolar.marker.Line + instance or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on + the graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . + + Returns + ------- + plotly.graph_objs.scatterpolar.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # mode + # ---- + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. If there are less than 20 points and the trace is not + stacked then the default is "lines+markers". Otherwise, + "lines". + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self['mode'] + + @mode.setter + def mode(self, val): + self['mode'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # r + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['r'] + + @r.setter + def r(self, val): + self['r'] = val + + # r0 + # -- + @property + 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 + ------- + Any + """ + return self['r0'] + + @r0.setter + def r0(self, val): + self['r0'] = val + + # rsrc + # ---- + @property + def rsrc(self): + """ + Sets the source reference on plot.ly for r . + + The 'rsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['rsrc'] + + @rsrc.setter + def rsrc(self, val): + self['rsrc'] = val + + # selected + # -------- + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of plotly.graph_objs.scatterpolar.Selected + - A dict of string/value properties that will be passed + to the Selected constructor + + Supported dict properties: + + marker + plotly.graph_objs.scatterpolar.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scatterpolar.selected.Textfon + t instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.scatterpolar.Selected + """ + return self['selected'] + + @selected.setter + def selected(self, val): + self['selected'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.scatterpolar.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.scatterpolar.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # subplot + # ------- + @property + def subplot(self): + """ + Sets a reference between this trace's data coordinates and a + polar subplot. If "polar" (the default value), the data refer + to `layout.polar`. If "polar2", the data refer to + `layout.polar2`, and so on. + + The 'subplot' property is an identifier of a particular + subplot, of type 'polar', that may be specified as the string 'polar' + optionally followed by an integer >= 1 + (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) + + Returns + ------- + str + """ + return self['subplot'] + + @subplot.setter + def subplot(self, val): + self['subplot'] = val + + # text + # ---- + @property + def text(self): + """ + Sets text elements associated with each (x,y) pair. If a single + string, the same string appears over all the data points. If an + array of string, the items are mapped in order to the this + trace's (x,y) coordinates. If trace `hoverinfo` contains a + "text" flag and "hovertext" is not set, these elements will be + seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scatterpolar.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # textposition + # ------------ + @property + 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', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['textposition'] + + @textposition.setter + def textposition(self, val): + self['textposition'] = val + + # textpositionsrc + # --------------- + @property + def textpositionsrc(self): + """ + Sets the source reference on plot.ly for textposition . + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textpositionsrc'] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self['textpositionsrc'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # theta + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['theta'] + + @theta.setter + def theta(self, val): + self['theta'] = val + + # theta0 + # ------ + @property + 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 + ------- + Any + """ + return self['theta0'] + + @theta0.setter + def theta0(self, val): + self['theta0'] = val + + # thetasrc + # -------- + @property + def thetasrc(self): + """ + Sets the source reference on plot.ly for theta . + + The 'thetasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['thetasrc'] + + @thetasrc.setter + def thetasrc(self, val): + self['thetasrc'] = val + + # thetaunit + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thetaunit'] + + @thetaunit.setter + def thetaunit(self, val): + self['thetaunit'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # unselected + # ---------- + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of plotly.graph_objs.scatterpolar.Unselected + - A dict of string/value properties that will be passed + to the Unselected constructor + + Supported dict properties: + + marker + plotly.graph_objs.scatterpolar.unselected.Marke + r instance or dict with compatible properties + textfont + plotly.graph_objs.scatterpolar.unselected.Textf + ont instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.scatterpolar.Unselected + """ + return self['unselected'] + + @unselected.setter + def unselected(self, val): + self['unselected'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterpolar has a subset of + the options available to scatter. "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scatterpolar.Hoverlabel instance or + dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scatterpolar.Line instance or dict + with compatible properties + marker + plotly.graph_objs.scatterpolar.Marker instance or dict + with compatible properties + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on plot.ly for r . + selected + plotly.graph_objs.scatterpolar.Selected instance or + dict with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.scatterpolar.Stream instance or dict + with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on plot.ly for theta . + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.scatterpolar.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + """ + + def __init__( + self, + arg=None, + cliponaxis=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + dr=None, + dtheta=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legendgroup=None, + line=None, + marker=None, + mode=None, + name=None, + opacity=None, + r=None, + r0=None, + rsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + theta=None, + theta0=None, + thetasrc=None, + thetaunit=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + **kwargs + ): + """ + Construct a new Scatterpolar object + + The scatterpolar trace type encompasses line charts, scatter + charts, text charts, and bubble charts in polar coordinates. + The data visualized as scatter point or lines is set in `r` + (radial) and `theta` (angular) coordinates Text (appearing + either on the chart or on hover only) is via `text`. Bubble + charts are achieved by setting `marker.size` and/or + `marker.color` to numerical arrays. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Scatterpolar + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterpolar has a subset of + the options available to scatter. "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scatterpolar.Hoverlabel instance or + dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scatterpolar.Line instance or dict + with compatible properties + marker + plotly.graph_objs.scatterpolar.Marker instance or dict + with compatible properties + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on plot.ly for r . + selected + plotly.graph_objs.scatterpolar.Selected instance or + dict with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.scatterpolar.Stream instance or dict + with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on plot.ly for theta . + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.scatterpolar.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + + Returns + ------- + Scatterpolar + """ + super(Scatterpolar, self).__init__('scatterpolar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Scatterpolar +constructor must be a dict or +an instance of plotly.graph_objs.Scatterpolar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (scatterpolar as v_scatterpolar) + + # Initialize validators + # --------------------- + self._validators['cliponaxis'] = v_scatterpolar.CliponaxisValidator() + self._validators['connectgaps'] = v_scatterpolar.ConnectgapsValidator() + self._validators['customdata'] = v_scatterpolar.CustomdataValidator() + self._validators['customdatasrc' + ] = v_scatterpolar.CustomdatasrcValidator() + self._validators['dr'] = v_scatterpolar.DrValidator() + self._validators['dtheta'] = v_scatterpolar.DthetaValidator() + self._validators['fill'] = v_scatterpolar.FillValidator() + self._validators['fillcolor'] = v_scatterpolar.FillcolorValidator() + self._validators['hoverinfo'] = v_scatterpolar.HoverinfoValidator() + self._validators['hoverinfosrc' + ] = v_scatterpolar.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_scatterpolar.HoverlabelValidator() + self._validators['hoveron'] = v_scatterpolar.HoveronValidator() + self._validators['hovertemplate' + ] = v_scatterpolar.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_scatterpolar.HovertemplatesrcValidator() + self._validators['hovertext'] = v_scatterpolar.HovertextValidator() + self._validators['hovertextsrc' + ] = v_scatterpolar.HovertextsrcValidator() + self._validators['ids'] = v_scatterpolar.IdsValidator() + self._validators['idssrc'] = v_scatterpolar.IdssrcValidator() + self._validators['legendgroup'] = v_scatterpolar.LegendgroupValidator() + self._validators['line'] = v_scatterpolar.LineValidator() + self._validators['marker'] = v_scatterpolar.MarkerValidator() + self._validators['mode'] = v_scatterpolar.ModeValidator() + self._validators['name'] = v_scatterpolar.NameValidator() + self._validators['opacity'] = v_scatterpolar.OpacityValidator() + self._validators['r'] = v_scatterpolar.RValidator() + self._validators['r0'] = v_scatterpolar.R0Validator() + self._validators['rsrc'] = v_scatterpolar.RsrcValidator() + self._validators['selected'] = v_scatterpolar.SelectedValidator() + self._validators['selectedpoints' + ] = v_scatterpolar.SelectedpointsValidator() + self._validators['showlegend'] = v_scatterpolar.ShowlegendValidator() + self._validators['stream'] = v_scatterpolar.StreamValidator() + self._validators['subplot'] = v_scatterpolar.SubplotValidator() + self._validators['text'] = v_scatterpolar.TextValidator() + self._validators['textfont'] = v_scatterpolar.TextfontValidator() + self._validators['textposition' + ] = v_scatterpolar.TextpositionValidator() + self._validators['textpositionsrc' + ] = v_scatterpolar.TextpositionsrcValidator() + self._validators['textsrc'] = v_scatterpolar.TextsrcValidator() + self._validators['theta'] = v_scatterpolar.ThetaValidator() + self._validators['theta0'] = v_scatterpolar.Theta0Validator() + self._validators['thetasrc'] = v_scatterpolar.ThetasrcValidator() + self._validators['thetaunit'] = v_scatterpolar.ThetaunitValidator() + self._validators['uid'] = v_scatterpolar.UidValidator() + self._validators['uirevision'] = v_scatterpolar.UirevisionValidator() + self._validators['unselected'] = v_scatterpolar.UnselectedValidator() + self._validators['visible'] = v_scatterpolar.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('cliponaxis', None) + self['cliponaxis'] = cliponaxis if cliponaxis is not None else _v + _v = arg.pop('connectgaps', None) + self['connectgaps'] = connectgaps if connectgaps is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('dr', None) + self['dr'] = dr if dr is not None else _v + _v = arg.pop('dtheta', None) + self['dtheta'] = dtheta if dtheta is not None else _v + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('fillcolor', None) + self['fillcolor'] = fillcolor if fillcolor is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hoveron', None) + self['hoveron'] = hoveron if hoveron is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('mode', None) + self['mode'] = mode if mode is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('r', None) + self['r'] = r if r is not None else _v + _v = arg.pop('r0', None) + self['r0'] = r0 if r0 is not None else _v + _v = arg.pop('rsrc', None) + self['rsrc'] = rsrc if rsrc is not None else _v + _v = arg.pop('selected', None) + self['selected'] = selected if selected is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('subplot', None) + self['subplot'] = subplot if subplot is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + _v = arg.pop('textposition', None) + self['textposition'] = textposition if textposition is not None else _v + _v = arg.pop('textpositionsrc', None) + self['textpositionsrc' + ] = textpositionsrc if textpositionsrc is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('theta', None) + self['theta'] = theta if theta is not None else _v + _v = arg.pop('theta0', None) + self['theta0'] = theta0 if theta0 is not None else _v + _v = arg.pop('thetasrc', None) + self['thetasrc'] = thetasrc if thetasrc is not None else _v + _v = arg.pop('thetaunit', None) + self['thetaunit'] = thetaunit if thetaunit is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('unselected', None) + self['unselected'] = unselected if unselected is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'scatterpolar' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='scatterpolar', val='scatterpolar' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scattermapbox(_BaseTraceType): + + # connectgaps + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['connectgaps'] + + @connectgaps.setter + def connectgaps(self, val): + self['connectgaps'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # fill + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # fillcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['fillcolor'] + + @fillcolor.setter + def fillcolor(self, val): + self['fillcolor'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'lon+lat') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.scattermapbox.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.scattermapbox.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + def hovertext(self): + """ + Sets hover text elements associated with each (lon,lat) pair If + a single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (lon,lat) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # lat + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['lat'] + + @lat.setter + def lat(self, val): + self['lat'] = val + + # latsrc + # ------ + @property + def latsrc(self): + """ + Sets the source reference on plot.ly for lat . + + The 'latsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['latsrc'] + + @latsrc.setter + def latsrc(self, val): + self['latsrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of plotly.graph_objs.scattermapbox.Line + - A dict of string/value properties that will be passed + to the Line constructor + + Supported dict properties: + + color + Sets the line color. + width + Sets the line width (in px). + + Returns + ------- + plotly.graph_objs.scattermapbox.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # lon + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['lon'] + + @lon.setter + def lon(self, val): + self['lon'] = val + + # lonsrc + # ------ + @property + def lonsrc(self): + """ + Sets the source reference on plot.ly for lon . + + The 'lonsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['lonsrc'] + + @lonsrc.setter + def lonsrc(self, val): + self['lonsrc'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of plotly.graph_objs.scattermapbox.Marker + - A dict of string/value properties that will be passed + to the Marker constructor + + Supported dict properties: + + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scattermapbox.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol. Full list: + https://www.mapbox.com/maki-icons/ Note that + the array `marker.color` and `marker.size` are + only available for "circle" symbols. + symbolsrc + Sets the source reference on plot.ly for + symbol . + + Returns + ------- + plotly.graph_objs.scattermapbox.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # mode + # ---- + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self['mode'] + + @mode.setter + def mode(self, val): + self['mode'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # selected + # -------- + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of plotly.graph_objs.scattermapbox.Selected + - A dict of string/value properties that will be passed + to the Selected constructor + + Supported dict properties: + + marker + plotly.graph_objs.scattermapbox.selected.Marker + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.scattermapbox.Selected + """ + return self['selected'] + + @selected.setter + def selected(self, val): + self['selected'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.scattermapbox.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.scattermapbox.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # subplot + # ------- + @property + def subplot(self): + """ + Sets a reference between this trace's data coordinates and a + mapbox subplot. If "mapbox" (the default value), the data refer + to `layout.mapbox`. If "mapbox2", the data refer to + `layout.mapbox2`, and so on. + + The 'subplot' property is an identifier of a particular + subplot, of type 'mapbox', that may be specified as the string 'mapbox' + optionally followed by an integer >= 1 + (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.) + + Returns + ------- + str + """ + return self['subplot'] + + @subplot.setter + def subplot(self, val): + self['subplot'] = val + + # text + # ---- + @property + def text(self): + """ + Sets text elements associated with each (lon,lat) pair If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (lon,lat) coordinates. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, these + elements will be seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textfont + # -------- + @property + 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 plotly.graph_objs.scattermapbox.Textfont + - A dict of string/value properties that will be passed + to the Textfont constructor + + Supported dict properties: + + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scattermapbox.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # textposition + # ------------ + @property + 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', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + + Returns + ------- + Any + """ + return self['textposition'] + + @textposition.setter + def textposition(self, val): + self['textposition'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # unselected + # ---------- + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of plotly.graph_objs.scattermapbox.Unselected + - A dict of string/value properties that will be passed + to the Unselected constructor + + Supported dict properties: + + marker + plotly.graph_objs.scattermapbox.unselected.Mark + er instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.scattermapbox.Unselected + """ + return self['unselected'] + + @unselected.setter + def unselected(self, val): + self['unselected'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scattermapbox.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on plot.ly for lat . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scattermapbox.Line instance or dict + with compatible properties + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on plot.ly for lon . + marker + plotly.graph_objs.scattermapbox.Marker instance or dict + with compatible properties + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.scattermapbox.Selected instance or + dict with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.scattermapbox.Stream instance or dict + with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a mapbox subplot. If "mapbox" (the default value), + the data refer to `layout.mapbox`. If "mapbox2", the + data refer to `layout.mapbox2`, and so on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the icon text font (color=mapbox.layer.paint.text- + color, size=mapbox.layer.layout.text-size). Has an + effect only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.scattermapbox.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + """ + + def __init__( + self, + arg=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legendgroup=None, + line=None, + lon=None, + lonsrc=None, + marker=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + **kwargs + ): + """ + 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`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Scattermapbox + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scattermapbox.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on plot.ly for lat . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scattermapbox.Line instance or dict + with compatible properties + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on plot.ly for lon . + marker + plotly.graph_objs.scattermapbox.Marker instance or dict + with compatible properties + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.scattermapbox.Selected instance or + dict with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.scattermapbox.Stream instance or dict + with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a mapbox subplot. If "mapbox" (the default value), + the data refer to `layout.mapbox`. If "mapbox2", the + data refer to `layout.mapbox2`, and so on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the icon text font (color=mapbox.layer.paint.text- + color, size=mapbox.layer.layout.text-size). Has an + effect only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.scattermapbox.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + + Returns + ------- + Scattermapbox + """ + super(Scattermapbox, self).__init__('scattermapbox') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Scattermapbox +constructor must be a dict or +an instance of plotly.graph_objs.Scattermapbox""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (scattermapbox as v_scattermapbox) + + # Initialize validators + # --------------------- + self._validators['connectgaps'] = v_scattermapbox.ConnectgapsValidator( + ) + self._validators['customdata'] = v_scattermapbox.CustomdataValidator() + self._validators['customdatasrc' + ] = v_scattermapbox.CustomdatasrcValidator() + self._validators['fill'] = v_scattermapbox.FillValidator() + self._validators['fillcolor'] = v_scattermapbox.FillcolorValidator() + self._validators['hoverinfo'] = v_scattermapbox.HoverinfoValidator() + self._validators['hoverinfosrc' + ] = v_scattermapbox.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_scattermapbox.HoverlabelValidator() + self._validators['hovertemplate' + ] = v_scattermapbox.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_scattermapbox.HovertemplatesrcValidator() + self._validators['hovertext'] = v_scattermapbox.HovertextValidator() + self._validators['hovertextsrc' + ] = v_scattermapbox.HovertextsrcValidator() + self._validators['ids'] = v_scattermapbox.IdsValidator() + self._validators['idssrc'] = v_scattermapbox.IdssrcValidator() + self._validators['lat'] = v_scattermapbox.LatValidator() + self._validators['latsrc'] = v_scattermapbox.LatsrcValidator() + self._validators['legendgroup'] = v_scattermapbox.LegendgroupValidator( + ) + self._validators['line'] = v_scattermapbox.LineValidator() + self._validators['lon'] = v_scattermapbox.LonValidator() + self._validators['lonsrc'] = v_scattermapbox.LonsrcValidator() + self._validators['marker'] = v_scattermapbox.MarkerValidator() + self._validators['mode'] = v_scattermapbox.ModeValidator() + self._validators['name'] = v_scattermapbox.NameValidator() + self._validators['opacity'] = v_scattermapbox.OpacityValidator() + self._validators['selected'] = v_scattermapbox.SelectedValidator() + self._validators['selectedpoints' + ] = v_scattermapbox.SelectedpointsValidator() + self._validators['showlegend'] = v_scattermapbox.ShowlegendValidator() + self._validators['stream'] = v_scattermapbox.StreamValidator() + self._validators['subplot'] = v_scattermapbox.SubplotValidator() + self._validators['text'] = v_scattermapbox.TextValidator() + self._validators['textfont'] = v_scattermapbox.TextfontValidator() + self._validators['textposition' + ] = v_scattermapbox.TextpositionValidator() + self._validators['textsrc'] = v_scattermapbox.TextsrcValidator() + self._validators['uid'] = v_scattermapbox.UidValidator() + self._validators['uirevision'] = v_scattermapbox.UirevisionValidator() + self._validators['unselected'] = v_scattermapbox.UnselectedValidator() + self._validators['visible'] = v_scattermapbox.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('connectgaps', None) + self['connectgaps'] = connectgaps if connectgaps is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('fillcolor', None) + self['fillcolor'] = fillcolor if fillcolor is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('lat', None) + self['lat'] = lat if lat is not None else _v + _v = arg.pop('latsrc', None) + self['latsrc'] = latsrc if latsrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('lon', None) + self['lon'] = lon if lon is not None else _v + _v = arg.pop('lonsrc', None) + self['lonsrc'] = lonsrc if lonsrc is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('mode', None) + self['mode'] = mode if mode is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('selected', None) + self['selected'] = selected if selected is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('subplot', None) + self['subplot'] = subplot if subplot is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + _v = arg.pop('textposition', None) + self['textposition'] = textposition if textposition is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('unselected', None) + self['unselected'] = unselected if unselected is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'scattermapbox' + self._validators['type'] = LiteralValidator( + plotly_name='type', + parent_name='scattermapbox', + val='scattermapbox' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scattergl(_BaseTraceType): + + # connectgaps + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['connectgaps'] + + @connectgaps.setter + def connectgaps(self, val): + self['connectgaps'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # dx + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['dx'] + + @dx.setter + def dx(self, val): + self['dx'] = val + + # dy + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['dy'] + + @dy.setter + def dy(self, val): + self['dy'] = val + + # error_x + # ------- + @property + def error_x(self): + """ + The 'error_x' property is an instance of ErrorX + that may be specified as: + - An instance of plotly.graph_objs.scattergl.ErrorX + - A dict of string/value properties that will be passed + to the ErrorX constructor + + Supported dict properties: + + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. + + Returns + ------- + plotly.graph_objs.scattergl.ErrorX + """ + return self['error_x'] + + @error_x.setter + def error_x(self, val): + self['error_x'] = val + + # error_y + # ------- + @property + def error_y(self): + """ + The 'error_y' property is an instance of ErrorY + that may be specified as: + - An instance of plotly.graph_objs.scattergl.ErrorY + - A dict of string/value properties that will be passed + to the ErrorY constructor + + Supported dict properties: + + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. + + Returns + ------- + plotly.graph_objs.scattergl.ErrorY + """ + return self['error_y'] + + @error_y.setter + def error_y(self, val): + self['error_y'] = val + + # fill + # ---- + @property + def fill(self): + """ + Sets the area to fill with a solid color. Defaults to "none" + unless this trace is stacked, then it gets "tonexty" + ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` + if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 + respectively. "tonextx" and "tonexty" fill between the + endpoints of this trace and the endpoints of the trace before + it, connecting those endpoints with straight lines (to make a + stacked area graph); if there is no trace before it, they + behave like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if it has + gaps) into a closed shape. "tonext" fills the space between two + traces if one completely encloses the other (eg consecutive + contour lines), and behaves like "toself" if there is no trace + before it. "tonext" should not be used if one trace does not + enclose the other. Traces in a `stackgroup` will only fill to + (or be filled to) other traces in the same group. With multiple + `stackgroup`s or some traces stacked and some not, if fill- + linked traces are not already consecutive, the later ones will + be pushed down in the drawing order. + + The 'fill' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', + 'toself', 'tonext'] + + Returns + ------- + Any + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # fillcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['fillcolor'] + + @fillcolor.setter + def fillcolor(self, val): + self['fillcolor'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.scattergl.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.scattergl.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + def hovertext(self): + """ + Sets hover text elements associated with each (x,y) pair. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of plotly.graph_objs.scattergl.Line + - A dict of string/value properties that will be passed + to the Line constructor + + Supported dict properties: + + color + Sets the line color. + dash + Sets the style of the lines. + shape + Determines the line shape. The values + correspond to step-wise line shapes. + width + Sets the line width (in px). + + Returns + ------- + plotly.graph_objs.scattergl.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scattergl.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + line + plotly.graph_objs.scattergl.marker.Line + instance or dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . + + Returns + ------- + plotly.graph_objs.scattergl.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # mode + # ---- + @property + 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 + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self['mode'] + + @mode.setter + def mode(self, val): + self['mode'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # selected + # -------- + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of plotly.graph_objs.scattergl.Selected + - A dict of string/value properties that will be passed + to the Selected constructor + + Supported dict properties: + + marker + plotly.graph_objs.scattergl.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scattergl.selected.Textfont + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.scattergl.Selected + """ + return self['selected'] + + @selected.setter + def selected(self, val): + self['selected'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.scattergl.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.scattergl.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + def text(self): + """ + Sets text elements associated with each (x,y) pair. If a single + string, the same string appears over all the data points. If an + array of string, the items are mapped in order to the this + trace's (x,y) coordinates. If trace `hoverinfo` contains a + "text" flag and "hovertext" is not set, these elements will be + seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scattergl.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # textposition + # ------------ + @property + 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', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['textposition'] + + @textposition.setter + def textposition(self, val): + self['textposition'] = val + + # textpositionsrc + # --------------- + @property + def textpositionsrc(self): + """ + Sets the source reference on plot.ly for textposition . + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textpositionsrc'] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self['textpositionsrc'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # unselected + # ---------- + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of plotly.graph_objs.scattergl.Unselected + - A dict of string/value properties that will be passed + to the Unselected constructor + + Supported dict properties: + + marker + plotly.graph_objs.scattergl.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scattergl.unselected.Textfont + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.scattergl.Unselected + """ + return self['unselected'] + + @unselected.setter + def unselected(self, val): + self['unselected'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # x0 + # -- + @property + 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 + ------- + Any + """ + return self['x0'] + + @x0.setter + def x0(self, val): + self['x0'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # xcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['xcalendar'] + + @xcalendar.setter + def xcalendar(self, val): + self['xcalendar'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # y0 + # -- + @property + 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 + ------- + Any + """ + return self['y0'] + + @y0.setter + def y0(self, val): + self['y0'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # ycalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['ycalendar'] + + @ycalendar.setter + def ycalendar(self, val): + self['ycalendar'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + plotly.graph_objs.scattergl.ErrorX instance or dict + with compatible properties + error_y + plotly.graph_objs.scattergl.ErrorY instance or dict + with compatible properties + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scattergl.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scattergl.Line instance or dict with + compatible properties + marker + plotly.graph_objs.scattergl.Marker instance or dict + with compatible properties + mode + Determines the drawing mode for this scatter trace. + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.scattergl.Selected instance or dict + with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.scattergl.Stream instance or dict + with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.scattergl.Unselected instance or dict + with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + """ + + def __init__( + self, + arg=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + error_x=None, + error_y=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legendgroup=None, + line=None, + marker=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + ysrc=None, + **kwargs + ): + """ + Construct a new Scattergl object + + The data visualized as scatter point or lines is set in `x` and + `y` using the WebGL plotting engine. Bubble charts are achieved + by setting `marker.size` and/or `marker.color` to a numerical + arrays. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Scattergl + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + plotly.graph_objs.scattergl.ErrorX instance or dict + with compatible properties + error_y + plotly.graph_objs.scattergl.ErrorY instance or dict + with compatible properties + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scattergl.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scattergl.Line instance or dict with + compatible properties + marker + plotly.graph_objs.scattergl.Marker instance or dict + with compatible properties + mode + Determines the drawing mode for this scatter trace. + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.scattergl.Selected instance or dict + with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.scattergl.Stream instance or dict + with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.scattergl.Unselected instance or dict + with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + + Returns + ------- + Scattergl + """ + super(Scattergl, self).__init__('scattergl') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Scattergl +constructor must be a dict or +an instance of plotly.graph_objs.Scattergl""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (scattergl as v_scattergl) + + # Initialize validators + # --------------------- + self._validators['connectgaps'] = v_scattergl.ConnectgapsValidator() + self._validators['customdata'] = v_scattergl.CustomdataValidator() + self._validators['customdatasrc'] = v_scattergl.CustomdatasrcValidator( + ) + self._validators['dx'] = v_scattergl.DxValidator() + self._validators['dy'] = v_scattergl.DyValidator() + self._validators['error_x'] = v_scattergl.ErrorXValidator() + self._validators['error_y'] = v_scattergl.ErrorYValidator() + self._validators['fill'] = v_scattergl.FillValidator() + self._validators['fillcolor'] = v_scattergl.FillcolorValidator() + self._validators['hoverinfo'] = v_scattergl.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_scattergl.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_scattergl.HoverlabelValidator() + self._validators['hovertemplate'] = v_scattergl.HovertemplateValidator( + ) + self._validators['hovertemplatesrc' + ] = v_scattergl.HovertemplatesrcValidator() + self._validators['hovertext'] = v_scattergl.HovertextValidator() + self._validators['hovertextsrc'] = v_scattergl.HovertextsrcValidator() + self._validators['ids'] = v_scattergl.IdsValidator() + self._validators['idssrc'] = v_scattergl.IdssrcValidator() + self._validators['legendgroup'] = v_scattergl.LegendgroupValidator() + self._validators['line'] = v_scattergl.LineValidator() + self._validators['marker'] = v_scattergl.MarkerValidator() + self._validators['mode'] = v_scattergl.ModeValidator() + self._validators['name'] = v_scattergl.NameValidator() + self._validators['opacity'] = v_scattergl.OpacityValidator() + self._validators['selected'] = v_scattergl.SelectedValidator() + self._validators['selectedpoints' + ] = v_scattergl.SelectedpointsValidator() + self._validators['showlegend'] = v_scattergl.ShowlegendValidator() + self._validators['stream'] = v_scattergl.StreamValidator() + self._validators['text'] = v_scattergl.TextValidator() + self._validators['textfont'] = v_scattergl.TextfontValidator() + self._validators['textposition'] = v_scattergl.TextpositionValidator() + self._validators['textpositionsrc' + ] = v_scattergl.TextpositionsrcValidator() + self._validators['textsrc'] = v_scattergl.TextsrcValidator() + self._validators['uid'] = v_scattergl.UidValidator() + self._validators['uirevision'] = v_scattergl.UirevisionValidator() + self._validators['unselected'] = v_scattergl.UnselectedValidator() + self._validators['visible'] = v_scattergl.VisibleValidator() + self._validators['x'] = v_scattergl.XValidator() + self._validators['x0'] = v_scattergl.X0Validator() + self._validators['xaxis'] = v_scattergl.XAxisValidator() + self._validators['xcalendar'] = v_scattergl.XcalendarValidator() + self._validators['xsrc'] = v_scattergl.XsrcValidator() + self._validators['y'] = v_scattergl.YValidator() + self._validators['y0'] = v_scattergl.Y0Validator() + self._validators['yaxis'] = v_scattergl.YAxisValidator() + self._validators['ycalendar'] = v_scattergl.YcalendarValidator() + self._validators['ysrc'] = v_scattergl.YsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('connectgaps', None) + self['connectgaps'] = connectgaps if connectgaps is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('dx', None) + self['dx'] = dx if dx is not None else _v + _v = arg.pop('dy', None) + self['dy'] = dy if dy is not None else _v + _v = arg.pop('error_x', None) + self['error_x'] = error_x if error_x is not None else _v + _v = arg.pop('error_y', None) + self['error_y'] = error_y if error_y is not None else _v + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('fillcolor', None) + self['fillcolor'] = fillcolor if fillcolor is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('mode', None) + self['mode'] = mode if mode is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('selected', None) + self['selected'] = selected if selected is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + _v = arg.pop('textposition', None) + self['textposition'] = textposition if textposition is not None else _v + _v = arg.pop('textpositionsrc', None) + self['textpositionsrc' + ] = textpositionsrc if textpositionsrc is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('unselected', None) + self['unselected'] = unselected if unselected is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('x0', None) + self['x0'] = x0 if x0 is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('xcalendar', None) + self['xcalendar'] = xcalendar if xcalendar is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('y0', None) + self['y0'] = y0 if y0 is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + _v = arg.pop('ycalendar', None) + self['ycalendar'] = ycalendar if ycalendar is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'scattergl' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='scattergl', val='scattergl' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scattergeo(_BaseTraceType): + + # connectgaps + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['connectgaps'] + + @connectgaps.setter + def connectgaps(self, val): + self['connectgaps'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # fill + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # fillcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['fillcolor'] + + @fillcolor.setter + def fillcolor(self, val): + self['fillcolor'] = val + + # geo + # --- + @property + def geo(self): + """ + Sets a reference between this trace's geospatial coordinates + and a geographic map. If "geo" (the default value), the + geospatial coordinates refer to `layout.geo`. If "geo2", the + geospatial coordinates refer to `layout.geo2`, and so on. + + The 'geo' property is an identifier of a particular + subplot, of type 'geo', that may be specified as the string 'geo' + optionally followed by an integer >= 1 + (e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.) + + Returns + ------- + str + """ + return self['geo'] + + @geo.setter + def geo(self, val): + self['geo'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'lon+lat') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.scattergeo.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.scattergeo.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + def hovertext(self): + """ + Sets hover text elements associated with each (lon,lat) pair or + item in `locations`. If a single string, the same string + appears over all the data points. If an array of string, the + items are mapped in order to the this trace's (lon,lat) or + `locations` coordinates. To be seen, trace `hoverinfo` must + contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # lat + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['lat'] + + @lat.setter + def lat(self, val): + self['lat'] = val + + # latsrc + # ------ + @property + def latsrc(self): + """ + Sets the source reference on plot.ly for lat . + + The 'latsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['latsrc'] + + @latsrc.setter + def latsrc(self, val): + self['latsrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of plotly.graph_objs.scattergeo.Line + - A dict of string/value properties that will be passed + to the Line constructor + + Supported dict properties: + + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + plotly.graph_objs.scattergeo.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # locationmode + # ------------ + @property + def locationmode(self): + """ + Determines the set of locations used to match entries in + `locations` to regions on the map. + + The 'locationmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['ISO-3', 'USA-states', 'country names'] + + Returns + ------- + Any + """ + return self['locationmode'] + + @locationmode.setter + def locationmode(self, val): + self['locationmode'] = val + + # locations + # --------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['locations'] + + @locations.setter + def locations(self, val): + self['locations'] = val + + # locationssrc + # ------------ + @property + def locationssrc(self): + """ + Sets the source reference on plot.ly for locations . + + The 'locationssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['locationssrc'] + + @locationssrc.setter + def locationssrc(self, val): + self['locationssrc'] = val + + # lon + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['lon'] + + @lon.setter + def lon(self, val): + self['lon'] = val + + # lonsrc + # ------ + @property + def lonsrc(self): + """ + Sets the source reference on plot.ly for lon . + + The 'lonsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['lonsrc'] + + @lonsrc.setter + def lonsrc(self, val): + self['lonsrc'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scattergeo.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + gradient + plotly.graph_objs.scattergeo.marker.Gradient + instance or dict with compatible properties + line + plotly.graph_objs.scattergeo.marker.Line + instance or dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . + + Returns + ------- + plotly.graph_objs.scattergeo.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # mode + # ---- + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. If there are less than 20 points and the trace is not + stacked then the default is "lines+markers". Otherwise, + "lines". + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self['mode'] + + @mode.setter + def mode(self, val): + self['mode'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # selected + # -------- + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of plotly.graph_objs.scattergeo.Selected + - A dict of string/value properties that will be passed + to the Selected constructor + + Supported dict properties: + + marker + plotly.graph_objs.scattergeo.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scattergeo.selected.Textfont + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.scattergeo.Selected + """ + return self['selected'] + + @selected.setter + def selected(self, val): + self['selected'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.scattergeo.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.scattergeo.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + def text(self): + """ + Sets text elements associated with each (lon,lat) pair or item + in `locations`. If a single string, the same string appears + over all the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) or `locations` + coordinates. If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in the + hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scattergeo.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # textposition + # ------------ + @property + 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', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['textposition'] + + @textposition.setter + def textposition(self, val): + self['textposition'] = val + + # textpositionsrc + # --------------- + @property + def textpositionsrc(self): + """ + Sets the source reference on plot.ly for textposition . + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textpositionsrc'] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self['textpositionsrc'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # unselected + # ---------- + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of plotly.graph_objs.scattergeo.Unselected + - A dict of string/value properties that will be passed + to the Unselected constructor + + Supported dict properties: + + marker + plotly.graph_objs.scattergeo.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scattergeo.unselected.Textfon + t instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.scattergeo.Unselected + """ + return self['unselected'] + + @unselected.setter + def unselected(self, val): + self['unselected'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + geo + Sets a reference between this trace's geospatial + coordinates and a geographic map. If "geo" (the default + value), the geospatial coordinates refer to + `layout.geo`. If "geo2", the geospatial coordinates + refer to `layout.geo2`, and so on. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scattergeo.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (lon,lat) + pair or item in `locations`. If a single string, the + same string appears over all the data points. If an + array of string, the items are mapped in order to the + this trace's (lon,lat) or `locations` coordinates. To + be seen, trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on plot.ly for lat . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scattergeo.Line instance or dict with + compatible properties + locationmode + Determines the set of locations used to match entries + in `locations` to regions on the map. + locations + Sets the coordinates via location IDs or names. + Coordinates correspond to the centroid of each location + given. See `locationmode` for more info. + locationssrc + Sets the source reference on plot.ly for locations . + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on plot.ly for lon . + marker + plotly.graph_objs.scattergeo.Marker instance or dict + with compatible properties + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.scattergeo.Selected instance or dict + with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.scattergeo.Stream instance or dict + with compatible properties + text + Sets text elements associated with each (lon,lat) pair + or item in `locations`. If a single string, the same + string appears over all the data points. If an array of + string, the items are mapped in order to the this + trace's (lon,lat) or `locations` coordinates. If trace + `hoverinfo` contains a "text" flag and "hovertext" is + not set, these elements will be seen in the hover + labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.scattergeo.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + """ + + def __init__( + self, + arg=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + geo=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legendgroup=None, + line=None, + locationmode=None, + locations=None, + locationssrc=None, + lon=None, + lonsrc=None, + marker=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + **kwargs + ): + """ + Construct a new Scattergeo object + + The data visualized as scatter point or lines on a geographic + map is provided either by longitude/latitude pairs in `lon` and + `lat` respectively or by geographic location IDs or names in + `locations`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Scattergeo + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + geo + Sets a reference between this trace's geospatial + coordinates and a geographic map. If "geo" (the default + value), the geospatial coordinates refer to + `layout.geo`. If "geo2", the geospatial coordinates + refer to `layout.geo2`, and so on. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scattergeo.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (lon,lat) + pair or item in `locations`. If a single string, the + same string appears over all the data points. If an + array of string, the items are mapped in order to the + this trace's (lon,lat) or `locations` coordinates. To + be seen, trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on plot.ly for lat . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scattergeo.Line instance or dict with + compatible properties + locationmode + Determines the set of locations used to match entries + in `locations` to regions on the map. + locations + Sets the coordinates via location IDs or names. + Coordinates correspond to the centroid of each location + given. See `locationmode` for more info. + locationssrc + Sets the source reference on plot.ly for locations . + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on plot.ly for lon . + marker + plotly.graph_objs.scattergeo.Marker instance or dict + with compatible properties + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.scattergeo.Selected instance or dict + with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.scattergeo.Stream instance or dict + with compatible properties + text + Sets text elements associated with each (lon,lat) pair + or item in `locations`. If a single string, the same + string appears over all the data points. If an array of + string, the items are mapped in order to the this + trace's (lon,lat) or `locations` coordinates. If trace + `hoverinfo` contains a "text" flag and "hovertext" is + not set, these elements will be seen in the hover + labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.scattergeo.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + + Returns + ------- + Scattergeo + """ + super(Scattergeo, self).__init__('scattergeo') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Scattergeo +constructor must be a dict or +an instance of plotly.graph_objs.Scattergeo""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (scattergeo as v_scattergeo) + + # Initialize validators + # --------------------- + self._validators['connectgaps'] = v_scattergeo.ConnectgapsValidator() + self._validators['customdata'] = v_scattergeo.CustomdataValidator() + self._validators['customdatasrc' + ] = v_scattergeo.CustomdatasrcValidator() + self._validators['fill'] = v_scattergeo.FillValidator() + self._validators['fillcolor'] = v_scattergeo.FillcolorValidator() + self._validators['geo'] = v_scattergeo.GeoValidator() + self._validators['hoverinfo'] = v_scattergeo.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_scattergeo.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_scattergeo.HoverlabelValidator() + self._validators['hovertemplate' + ] = v_scattergeo.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_scattergeo.HovertemplatesrcValidator() + self._validators['hovertext'] = v_scattergeo.HovertextValidator() + self._validators['hovertextsrc'] = v_scattergeo.HovertextsrcValidator() + self._validators['ids'] = v_scattergeo.IdsValidator() + self._validators['idssrc'] = v_scattergeo.IdssrcValidator() + self._validators['lat'] = v_scattergeo.LatValidator() + self._validators['latsrc'] = v_scattergeo.LatsrcValidator() + self._validators['legendgroup'] = v_scattergeo.LegendgroupValidator() + self._validators['line'] = v_scattergeo.LineValidator() + self._validators['locationmode'] = v_scattergeo.LocationmodeValidator() + self._validators['locations'] = v_scattergeo.LocationsValidator() + self._validators['locationssrc'] = v_scattergeo.LocationssrcValidator() + self._validators['lon'] = v_scattergeo.LonValidator() + self._validators['lonsrc'] = v_scattergeo.LonsrcValidator() + self._validators['marker'] = v_scattergeo.MarkerValidator() + self._validators['mode'] = v_scattergeo.ModeValidator() + self._validators['name'] = v_scattergeo.NameValidator() + self._validators['opacity'] = v_scattergeo.OpacityValidator() + self._validators['selected'] = v_scattergeo.SelectedValidator() + self._validators['selectedpoints' + ] = v_scattergeo.SelectedpointsValidator() + self._validators['showlegend'] = v_scattergeo.ShowlegendValidator() + self._validators['stream'] = v_scattergeo.StreamValidator() + self._validators['text'] = v_scattergeo.TextValidator() + self._validators['textfont'] = v_scattergeo.TextfontValidator() + self._validators['textposition'] = v_scattergeo.TextpositionValidator() + self._validators['textpositionsrc' + ] = v_scattergeo.TextpositionsrcValidator() + self._validators['textsrc'] = v_scattergeo.TextsrcValidator() + self._validators['uid'] = v_scattergeo.UidValidator() + self._validators['uirevision'] = v_scattergeo.UirevisionValidator() + self._validators['unselected'] = v_scattergeo.UnselectedValidator() + self._validators['visible'] = v_scattergeo.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('connectgaps', None) + self['connectgaps'] = connectgaps if connectgaps is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('fillcolor', None) + self['fillcolor'] = fillcolor if fillcolor is not None else _v + _v = arg.pop('geo', None) + self['geo'] = geo if geo is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('lat', None) + self['lat'] = lat if lat is not None else _v + _v = arg.pop('latsrc', None) + self['latsrc'] = latsrc if latsrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('locationmode', None) + self['locationmode'] = locationmode if locationmode is not None else _v + _v = arg.pop('locations', None) + self['locations'] = locations if locations is not None else _v + _v = arg.pop('locationssrc', None) + self['locationssrc'] = locationssrc if locationssrc is not None else _v + _v = arg.pop('lon', None) + self['lon'] = lon if lon is not None else _v + _v = arg.pop('lonsrc', None) + self['lonsrc'] = lonsrc if lonsrc is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('mode', None) + self['mode'] = mode if mode is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('selected', None) + self['selected'] = selected if selected is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + _v = arg.pop('textposition', None) + self['textposition'] = textposition if textposition is not None else _v + _v = arg.pop('textpositionsrc', None) + self['textpositionsrc' + ] = textpositionsrc if textpositionsrc is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('unselected', None) + self['unselected'] = unselected if unselected is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'scattergeo' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='scattergeo', val='scattergeo' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scattercarpet(_BaseTraceType): + + # a + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['a'] + + @a.setter + def a(self, val): + self['a'] = val + + # asrc + # ---- + @property + def asrc(self): + """ + Sets the source reference on plot.ly for a . + + The 'asrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['asrc'] + + @asrc.setter + def asrc(self, val): + self['asrc'] = val + + # b + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['b'] + + @b.setter + def b(self, val): + self['b'] = val + + # bsrc + # ---- + @property + def bsrc(self): + """ + Sets the source reference on plot.ly for b . + + The 'bsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bsrc'] + + @bsrc.setter + def bsrc(self, val): + self['bsrc'] = val + + # carpet + # ------ + @property + def carpet(self): + """ + An identifier for this carpet, so that `scattercarpet` and + `scattercontour` traces can specify a carpet plot on which they + lie + + The 'carpet' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['carpet'] + + @carpet.setter + def carpet(self, val): + self['carpet'] = val + + # connectgaps + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['connectgaps'] + + @connectgaps.setter + def connectgaps(self, val): + self['connectgaps'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # fill + # ---- + @property + def fill(self): + """ + Sets the area to fill with a solid color. Use with `fillcolor` + if not "none". scatterternary has a subset of the options + available to scatter. "toself" connects the endpoints of the + trace (or each segment of the trace if it has gaps) into a + closed shape. "tonext" fills the space between two traces if + one completely encloses the other (eg consecutive contour + lines), and behaves like "toself" if there is no trace before + it. "tonext" should not be used if one trace does not enclose + the other. + + The 'fill' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'toself', 'tonext'] + + Returns + ------- + Any + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # fillcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['fillcolor'] + + @fillcolor.setter + def fillcolor(self, val): + self['fillcolor'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'a+b') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.scattercarpet.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.scattercarpet.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hoveron + # ------- + @property + def hoveron(self): + """ + Do the hover effects highlight individual points (markers or + line points) or do they highlight filled regions? If the fill + is "toself" or "tonext" and there are no markers or text, then + the default is "fills", otherwise it is "points". + + The 'hoveron' property is a flaglist and may be specified + as a string containing: + - Any combination of ['points', 'fills'] joined with '+' characters + (e.g. 'points+fills') + + Returns + ------- + Any + """ + return self['hoveron'] + + @hoveron.setter + def hoveron(self, val): + self['hoveron'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + def hovertext(self): + """ + Sets hover text elements associated with each (a,b) point. If a + single string, the same string appears over all the data + points. If an array of strings, the items are mapped in order + to the the data points in (a,b). To be seen, trace `hoverinfo` + must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the + lines are drawn using spline interpolation. The + other available values correspond to step-wise + line shapes. + smoothing + Has an effect only if `shape` is set to + "spline" Sets the amount of smoothing. 0 + corresponds to no smoothing (equivalent to a + "linear" shape). + width + Sets the line width (in px). + + Returns + ------- + plotly.graph_objs.scattercarpet.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scattercarpet.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + gradient + plotly.graph_objs.scattercarpet.marker.Gradient + instance or dict with compatible properties + line + plotly.graph_objs.scattercarpet.marker.Line + instance or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on + the graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . + + Returns + ------- + plotly.graph_objs.scattercarpet.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # mode + # ---- + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. If there are less than 20 points and the trace is not + stacked then the default is "lines+markers". Otherwise, + "lines". + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self['mode'] + + @mode.setter + def mode(self, val): + self['mode'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # selected + # -------- + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of plotly.graph_objs.scattercarpet.Selected + - A dict of string/value properties that will be passed + to the Selected constructor + + Supported dict properties: + + marker + plotly.graph_objs.scattercarpet.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scattercarpet.selected.Textfo + nt instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.scattercarpet.Selected + """ + return self['selected'] + + @selected.setter + def selected(self, val): + self['selected'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.scattercarpet.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.scattercarpet.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + def text(self): + """ + Sets text elements associated with each (a,b) point. If a + single string, the same string appears over all the data + points. If an array of strings, the items are mapped in order + to the the data points in (a,b). If trace `hoverinfo` contains + a "text" flag and "hovertext" is not set, these elements will + be seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scattercarpet.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # textposition + # ------------ + @property + 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', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['textposition'] + + @textposition.setter + def textposition(self, val): + self['textposition'] = val + + # textpositionsrc + # --------------- + @property + def textpositionsrc(self): + """ + Sets the source reference on plot.ly for textposition . + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textpositionsrc'] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self['textpositionsrc'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # unselected + # ---------- + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of plotly.graph_objs.scattercarpet.Unselected + - A dict of string/value properties that will be passed + to the Unselected constructor + + Supported dict properties: + + marker + plotly.graph_objs.scattercarpet.unselected.Mark + er instance or dict with compatible properties + textfont + plotly.graph_objs.scattercarpet.unselected.Text + font instance or dict with compatible + properties + + Returns + ------- + plotly.graph_objs.scattercarpet.Unselected + """ + return self['unselected'] + + @unselected.setter + def unselected(self, val): + self['unselected'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + a + Sets the a-axis coordinates. + asrc + Sets the source reference on plot.ly for a . + b + Sets the b-axis coordinates. + bsrc + Sets the source reference on plot.ly for b . + carpet + An identifier for this carpet, so that `scattercarpet` + and `scattercontour` traces can specify a carpet plot + on which they lie + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterternary has a subset + of the options available to scatter. "toself" connects + the endpoints of the trace (or each segment of the + trace if it has gaps) into a closed shape. "tonext" + fills the space between two traces if one completely + encloses the other (eg consecutive contour lines), and + behaves like "toself" if there is no trace before it. + "tonext" should not be used if one trace does not + enclose the other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scattercarpet.Hoverlabel instance or + dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (a,b) + point. If a single string, the same string appears over + all the data points. If an array of strings, the items + are mapped in order to the the data points in (a,b). To + be seen, trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scattercarpet.Line instance or dict + with compatible properties + marker + plotly.graph_objs.scattercarpet.Marker instance or dict + with compatible properties + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.scattercarpet.Selected instance or + dict with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.scattercarpet.Stream instance or dict + with compatible properties + text + Sets text elements associated with each (a,b) point. If + a single string, the same string appears over all the + data points. If an array of strings, the items are + mapped in order to the the data points in (a,b). If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.scattercarpet.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + """ + + def __init__( + self, + arg=None, + a=None, + asrc=None, + b=None, + bsrc=None, + carpet=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legendgroup=None, + line=None, + marker=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + xaxis=None, + yaxis=None, + **kwargs + ): + """ + Construct a new Scattercarpet object + + Plots a scatter trace on either the first carpet axis or the + carpet axis with a matching `carpet` attribute. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Scattercarpet + a + Sets the a-axis coordinates. + asrc + Sets the source reference on plot.ly for a . + b + Sets the b-axis coordinates. + bsrc + Sets the source reference on plot.ly for b . + carpet + An identifier for this carpet, so that `scattercarpet` + and `scattercontour` traces can specify a carpet plot + on which they lie + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterternary has a subset + of the options available to scatter. "toself" connects + the endpoints of the trace (or each segment of the + trace if it has gaps) into a closed shape. "tonext" + fills the space between two traces if one completely + encloses the other (eg consecutive contour lines), and + behaves like "toself" if there is no trace before it. + "tonext" should not be used if one trace does not + enclose the other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scattercarpet.Hoverlabel instance or + dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (a,b) + point. If a single string, the same string appears over + all the data points. If an array of strings, the items + are mapped in order to the the data points in (a,b). To + be seen, trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scattercarpet.Line instance or dict + with compatible properties + marker + plotly.graph_objs.scattercarpet.Marker instance or dict + with compatible properties + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.scattercarpet.Selected instance or + dict with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.scattercarpet.Stream instance or dict + with compatible properties + text + Sets text elements associated with each (a,b) point. If + a single string, the same string appears over all the + data points. If an array of strings, the items are + mapped in order to the the data points in (a,b). If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.scattercarpet.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + + Returns + ------- + Scattercarpet + """ + super(Scattercarpet, self).__init__('scattercarpet') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Scattercarpet +constructor must be a dict or +an instance of plotly.graph_objs.Scattercarpet""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (scattercarpet as v_scattercarpet) + + # Initialize validators + # --------------------- + self._validators['a'] = v_scattercarpet.AValidator() + self._validators['asrc'] = v_scattercarpet.AsrcValidator() + self._validators['b'] = v_scattercarpet.BValidator() + self._validators['bsrc'] = v_scattercarpet.BsrcValidator() + self._validators['carpet'] = v_scattercarpet.CarpetValidator() + self._validators['connectgaps'] = v_scattercarpet.ConnectgapsValidator( + ) + self._validators['customdata'] = v_scattercarpet.CustomdataValidator() + self._validators['customdatasrc' + ] = v_scattercarpet.CustomdatasrcValidator() + self._validators['fill'] = v_scattercarpet.FillValidator() + self._validators['fillcolor'] = v_scattercarpet.FillcolorValidator() + self._validators['hoverinfo'] = v_scattercarpet.HoverinfoValidator() + self._validators['hoverinfosrc' + ] = v_scattercarpet.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_scattercarpet.HoverlabelValidator() + self._validators['hoveron'] = v_scattercarpet.HoveronValidator() + self._validators['hovertemplate' + ] = v_scattercarpet.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_scattercarpet.HovertemplatesrcValidator() + self._validators['hovertext'] = v_scattercarpet.HovertextValidator() + self._validators['hovertextsrc' + ] = v_scattercarpet.HovertextsrcValidator() + self._validators['ids'] = v_scattercarpet.IdsValidator() + self._validators['idssrc'] = v_scattercarpet.IdssrcValidator() + self._validators['legendgroup'] = v_scattercarpet.LegendgroupValidator( + ) + self._validators['line'] = v_scattercarpet.LineValidator() + self._validators['marker'] = v_scattercarpet.MarkerValidator() + self._validators['mode'] = v_scattercarpet.ModeValidator() + self._validators['name'] = v_scattercarpet.NameValidator() + self._validators['opacity'] = v_scattercarpet.OpacityValidator() + self._validators['selected'] = v_scattercarpet.SelectedValidator() + self._validators['selectedpoints' + ] = v_scattercarpet.SelectedpointsValidator() + self._validators['showlegend'] = v_scattercarpet.ShowlegendValidator() + self._validators['stream'] = v_scattercarpet.StreamValidator() + self._validators['text'] = v_scattercarpet.TextValidator() + self._validators['textfont'] = v_scattercarpet.TextfontValidator() + self._validators['textposition' + ] = v_scattercarpet.TextpositionValidator() + self._validators['textpositionsrc' + ] = v_scattercarpet.TextpositionsrcValidator() + self._validators['textsrc'] = v_scattercarpet.TextsrcValidator() + self._validators['uid'] = v_scattercarpet.UidValidator() + self._validators['uirevision'] = v_scattercarpet.UirevisionValidator() + self._validators['unselected'] = v_scattercarpet.UnselectedValidator() + self._validators['visible'] = v_scattercarpet.VisibleValidator() + self._validators['xaxis'] = v_scattercarpet.XAxisValidator() + self._validators['yaxis'] = v_scattercarpet.YAxisValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('a', None) + self['a'] = a if a is not None else _v + _v = arg.pop('asrc', None) + self['asrc'] = asrc if asrc is not None else _v + _v = arg.pop('b', None) + self['b'] = b if b is not None else _v + _v = arg.pop('bsrc', None) + self['bsrc'] = bsrc if bsrc is not None else _v + _v = arg.pop('carpet', None) + self['carpet'] = carpet if carpet is not None else _v + _v = arg.pop('connectgaps', None) + self['connectgaps'] = connectgaps if connectgaps is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('fillcolor', None) + self['fillcolor'] = fillcolor if fillcolor is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hoveron', None) + self['hoveron'] = hoveron if hoveron is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('mode', None) + self['mode'] = mode if mode is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('selected', None) + self['selected'] = selected if selected is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + _v = arg.pop('textposition', None) + self['textposition'] = textposition if textposition is not None else _v + _v = arg.pop('textpositionsrc', None) + self['textpositionsrc' + ] = textpositionsrc if textpositionsrc is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('unselected', None) + self['unselected'] = unselected if unselected is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'scattercarpet' + self._validators['type'] = LiteralValidator( + plotly_name='type', + parent_name='scattercarpet', + val='scattercarpet' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scatter3d(_BaseTraceType): + + # connectgaps + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['connectgaps'] + + @connectgaps.setter + def connectgaps(self, val): + self['connectgaps'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # error_x + # ------- + @property + def error_x(self): + """ + The 'error_x' property is an instance of ErrorX + that may be specified as: + - An instance of plotly.graph_objs.scatter3d.ErrorX + - A dict of string/value properties that will be passed + to the ErrorX constructor + + Supported dict properties: + + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + copy_zstyle + + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. + + Returns + ------- + plotly.graph_objs.scatter3d.ErrorX + """ + return self['error_x'] + + @error_x.setter + def error_x(self, val): + self['error_x'] = val + + # error_y + # ------- + @property + def error_y(self): + """ + The 'error_y' property is an instance of ErrorY + that may be specified as: + - An instance of plotly.graph_objs.scatter3d.ErrorY + - A dict of string/value properties that will be passed + to the ErrorY constructor + + Supported dict properties: + + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + copy_zstyle + + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. + + Returns + ------- + plotly.graph_objs.scatter3d.ErrorY + """ + return self['error_y'] + + @error_y.setter + def error_y(self, val): + self['error_y'] = val + + # error_z + # ------- + @property + def error_z(self): + """ + The 'error_z' property is an instance of ErrorZ + that may be specified as: + - An instance of plotly.graph_objs.scatter3d.ErrorZ + - A dict of string/value properties that will be passed + to the ErrorZ constructor + + Supported dict properties: + + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. + + Returns + ------- + plotly.graph_objs.scatter3d.ErrorZ + """ + return self['error_z'] + + @error_z.setter + def error_z(self, val): + self['error_z'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.scatter3d.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.scatter3d.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + def hovertext(self): + """ + Sets text elements associated with each (x,y,z) triplet. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y,z) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of plotly.graph_objs.scatter3d.Line + - A dict of string/value properties that will be passed + to the Line constructor + + Supported dict properties: + + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `line.colorscale`. Has an effect + only if in `line.color`is set to a numerical + array. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette + will be chosen according to whether numbers in + the `color` array are all positive, all + negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `line.color`) or the bounds set in + `line.cmin` and `line.cmax` Has an effect only + if in `line.color`is set to a numerical array. + Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `line.color`is set to a + numerical array. Value should have the same + units as in `line.color` and if set, + `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `line.cmin` and/or `line.cmax` to be + equidistant to this point. Has an effect only + if in `line.color`is set to a numerical array. + Value should have the same units as in + `line.color`. Has no effect when `line.cauto` + is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `line.color`is set to a + numerical array. Value should have the same + units as in `line.color` and if set, + `line.cmax` must be set as well. + color + Sets thelinecolor. It accepts either a specific + color or an array of numbers that are mapped to + the colorscale relative to the max and min + values of the array or relative to `line.cmin` + and `line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `line.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`line.cmin` and `line.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + dash + Sets the dash style of the lines. + reversescale + Reverses the color mapping if true. Has an + effect only if in `line.color`is set to a + numerical array. If true, `line.cmin` will + correspond to the last color in the array and + `line.cmax` will correspond to the first color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `line.color`is set to a numerical array. + width + Sets the line width (in px). + + Returns + ------- + plotly.graph_objs.scatter3d.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of plotly.graph_objs.scatter3d.Marker + - A dict of string/value properties that will be passed + to the Marker constructor + + Supported dict properties: + + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scatter3d.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + line + plotly.graph_objs.scatter3d.marker.Line + instance or dict with compatible properties + opacity + Sets the marker opacity. Note that the marker + opacity for scatter3d traces must be a scalar + value for performance reasons. To set a + blending opacity value (i.e. which is not + transparent), set "marker.color" to an rgba + color and use its alpha channel. + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. + symbolsrc + Sets the source reference on plot.ly for + symbol . + + Returns + ------- + plotly.graph_objs.scatter3d.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # mode + # ---- + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. If there are less than 20 points and the trace is not + stacked then the default is "lines+markers". Otherwise, + "lines". + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self['mode'] + + @mode.setter + def mode(self, val): + self['mode'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # projection + # ---------- + @property + def projection(self): + """ + The 'projection' property is an instance of Projection + that may be specified as: + - An instance of plotly.graph_objs.scatter3d.Projection + - A dict of string/value properties that will be passed + to the Projection constructor + + Supported dict properties: + + x + plotly.graph_objs.scatter3d.projection.X + instance or dict with compatible properties + y + plotly.graph_objs.scatter3d.projection.Y + instance or dict with compatible properties + z + plotly.graph_objs.scatter3d.projection.Z + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.scatter3d.Projection + """ + return self['projection'] + + @projection.setter + def projection(self, val): + self['projection'] = val + + # scene + # ----- + @property + def scene(self): + """ + Sets a reference between this trace's 3D coordinate system and + a 3D scene. If "scene" (the default value), the (x,y,z) + coordinates refer to `layout.scene`. If "scene2", the (x,y,z) + coordinates refer to `layout.scene2`, and so on. + + The 'scene' property is an identifier of a particular + subplot, of type 'scene', that may be specified as the string 'scene' + optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + + Returns + ------- + str + """ + return self['scene'] + + @scene.setter + def scene(self, val): + self['scene'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.scatter3d.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.scatter3d.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # surfaceaxis + # ----------- + @property + 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] + + Returns + ------- + Any + """ + return self['surfaceaxis'] + + @surfaceaxis.setter + def surfaceaxis(self, val): + self['surfaceaxis'] = val + + # surfacecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['surfacecolor'] + + @surfacecolor.setter + def surfacecolor(self, val): + self['surfacecolor'] = val + + # text + # ---- + @property + def text(self): + """ + Sets text elements associated with each (x,y,z) triplet. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y,z) coordinates. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, these + elements will be seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scatter3d.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # textposition + # ------------ + @property + 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', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['textposition'] + + @textposition.setter + def textposition(self, val): + self['textposition'] = val + + # textpositionsrc + # --------------- + @property + def textpositionsrc(self): + """ + Sets the source reference on plot.ly for textposition . + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textpositionsrc'] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self['textpositionsrc'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['xcalendar'] + + @xcalendar.setter + def xcalendar(self, val): + self['xcalendar'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # ycalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['ycalendar'] + + @ycalendar.setter + def ycalendar(self, val): + self['ycalendar'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # z + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # zcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['zcalendar'] + + @zcalendar.setter + def zcalendar(self, val): + self['zcalendar'] = val + + # zsrc + # ---- + @property + def zsrc(self): + """ + Sets the source reference on plot.ly for z . + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['zsrc'] + + @zsrc.setter + def zsrc(self, val): + self['zsrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + error_x + plotly.graph_objs.scatter3d.ErrorX instance or dict + with compatible properties + error_y + plotly.graph_objs.scatter3d.ErrorY instance or dict + with compatible properties + error_z + plotly.graph_objs.scatter3d.ErrorZ instance or dict + with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scatter3d.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets text elements associated with each (x,y,z) + triplet. If a single string, the same string appears + over all the data points. If an array of string, the + items are mapped in order to the this trace's (x,y,z) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scatter3d.Line instance or dict with + compatible properties + marker + plotly.graph_objs.scatter3d.Marker instance or dict + with compatible properties + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + projection + plotly.graph_objs.scatter3d.Projection instance or dict + with compatible properties + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.scatter3d.Stream instance or dict + with compatible properties + surfaceaxis + If "-1", the scatter points are not fill with a surface + If 0, 1, 2, the scatter points are filled with a + Delaunay surface about the x, y, z respectively. + surfacecolor + Sets the surface fill color. + text + Sets text elements associated with each (x,y,z) + triplet. If a single string, the same string appears + over all the data points. If an array of string, the + items are mapped in order to the this trace's (x,y,z) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + plotly.graph_objs.scatter3d.Textfont instance or dict + with compatible properties + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates. + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the z coordinates. + zcalendar + Sets the calendar system to use with `z` date data. + zsrc + Sets the source reference on plot.ly for z . + """ + + def __init__( + self, + arg=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + error_x=None, + error_y=None, + error_z=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legendgroup=None, + line=None, + marker=None, + mode=None, + name=None, + opacity=None, + projection=None, + scene=None, + selectedpoints=None, + showlegend=None, + stream=None, + surfaceaxis=None, + surfacecolor=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xcalendar=None, + xsrc=None, + y=None, + ycalendar=None, + ysrc=None, + z=None, + zcalendar=None, + zsrc=None, + **kwargs + ): + """ + Construct a new Scatter3d object + + The data visualized as scatter point or lines in 3D dimension + is set in `x`, `y`, `z`. Text (appearing either on the chart or + on hover only) is via `text`. Bubble charts are achieved by + setting `marker.size` and/or `marker.color` Projections are + achieved via `projection`. Surface fills are achieved via + `surfaceaxis`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Scatter3d + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + error_x + plotly.graph_objs.scatter3d.ErrorX instance or dict + with compatible properties + error_y + plotly.graph_objs.scatter3d.ErrorY instance or dict + with compatible properties + error_z + plotly.graph_objs.scatter3d.ErrorZ instance or dict + with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scatter3d.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets text elements associated with each (x,y,z) + triplet. If a single string, the same string appears + over all the data points. If an array of string, the + items are mapped in order to the this trace's (x,y,z) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scatter3d.Line instance or dict with + compatible properties + marker + plotly.graph_objs.scatter3d.Marker instance or dict + with compatible properties + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + projection + plotly.graph_objs.scatter3d.Projection instance or dict + with compatible properties + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.scatter3d.Stream instance or dict + with compatible properties + surfaceaxis + If "-1", the scatter points are not fill with a surface + If 0, 1, 2, the scatter points are filled with a + Delaunay surface about the x, y, z respectively. + surfacecolor + Sets the surface fill color. + text + Sets text elements associated with each (x,y,z) + triplet. If a single string, the same string appears + over all the data points. If an array of string, the + items are mapped in order to the this trace's (x,y,z) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + plotly.graph_objs.scatter3d.Textfont instance or dict + with compatible properties + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates. + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the z coordinates. + zcalendar + Sets the calendar system to use with `z` date data. + zsrc + Sets the source reference on plot.ly for z . + + Returns + ------- + Scatter3d + """ + super(Scatter3d, self).__init__('scatter3d') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Scatter3d +constructor must be a dict or +an instance of plotly.graph_objs.Scatter3d""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (scatter3d as v_scatter3d) + + # Initialize validators + # --------------------- + self._validators['connectgaps'] = v_scatter3d.ConnectgapsValidator() + self._validators['customdata'] = v_scatter3d.CustomdataValidator() + self._validators['customdatasrc'] = v_scatter3d.CustomdatasrcValidator( + ) + self._validators['error_x'] = v_scatter3d.ErrorXValidator() + self._validators['error_y'] = v_scatter3d.ErrorYValidator() + self._validators['error_z'] = v_scatter3d.ErrorZValidator() + self._validators['hoverinfo'] = v_scatter3d.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_scatter3d.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_scatter3d.HoverlabelValidator() + self._validators['hovertemplate'] = v_scatter3d.HovertemplateValidator( + ) + self._validators['hovertemplatesrc' + ] = v_scatter3d.HovertemplatesrcValidator() + self._validators['hovertext'] = v_scatter3d.HovertextValidator() + self._validators['hovertextsrc'] = v_scatter3d.HovertextsrcValidator() + self._validators['ids'] = v_scatter3d.IdsValidator() + self._validators['idssrc'] = v_scatter3d.IdssrcValidator() + self._validators['legendgroup'] = v_scatter3d.LegendgroupValidator() + self._validators['line'] = v_scatter3d.LineValidator() + self._validators['marker'] = v_scatter3d.MarkerValidator() + self._validators['mode'] = v_scatter3d.ModeValidator() + self._validators['name'] = v_scatter3d.NameValidator() + self._validators['opacity'] = v_scatter3d.OpacityValidator() + self._validators['projection'] = v_scatter3d.ProjectionValidator() + self._validators['scene'] = v_scatter3d.SceneValidator() + self._validators['selectedpoints' + ] = v_scatter3d.SelectedpointsValidator() + self._validators['showlegend'] = v_scatter3d.ShowlegendValidator() + self._validators['stream'] = v_scatter3d.StreamValidator() + self._validators['surfaceaxis'] = v_scatter3d.SurfaceaxisValidator() + self._validators['surfacecolor'] = v_scatter3d.SurfacecolorValidator() + self._validators['text'] = v_scatter3d.TextValidator() + self._validators['textfont'] = v_scatter3d.TextfontValidator() + self._validators['textposition'] = v_scatter3d.TextpositionValidator() + self._validators['textpositionsrc' + ] = v_scatter3d.TextpositionsrcValidator() + self._validators['textsrc'] = v_scatter3d.TextsrcValidator() + self._validators['uid'] = v_scatter3d.UidValidator() + self._validators['uirevision'] = v_scatter3d.UirevisionValidator() + self._validators['visible'] = v_scatter3d.VisibleValidator() + self._validators['x'] = v_scatter3d.XValidator() + self._validators['xcalendar'] = v_scatter3d.XcalendarValidator() + self._validators['xsrc'] = v_scatter3d.XsrcValidator() + self._validators['y'] = v_scatter3d.YValidator() + self._validators['ycalendar'] = v_scatter3d.YcalendarValidator() + self._validators['ysrc'] = v_scatter3d.YsrcValidator() + self._validators['z'] = v_scatter3d.ZValidator() + self._validators['zcalendar'] = v_scatter3d.ZcalendarValidator() + self._validators['zsrc'] = v_scatter3d.ZsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('connectgaps', None) + self['connectgaps'] = connectgaps if connectgaps is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('error_x', None) + self['error_x'] = error_x if error_x is not None else _v + _v = arg.pop('error_y', None) + self['error_y'] = error_y if error_y is not None else _v + _v = arg.pop('error_z', None) + self['error_z'] = error_z if error_z is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('mode', None) + self['mode'] = mode if mode is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('projection', None) + self['projection'] = projection if projection is not None else _v + _v = arg.pop('scene', None) + self['scene'] = scene if scene is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('surfaceaxis', None) + self['surfaceaxis'] = surfaceaxis if surfaceaxis is not None else _v + _v = arg.pop('surfacecolor', None) + self['surfacecolor'] = surfacecolor if surfacecolor is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + _v = arg.pop('textposition', None) + self['textposition'] = textposition if textposition is not None else _v + _v = arg.pop('textpositionsrc', None) + self['textpositionsrc' + ] = textpositionsrc if textpositionsrc is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xcalendar', None) + self['xcalendar'] = xcalendar if xcalendar is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('ycalendar', None) + self['ycalendar'] = ycalendar if ycalendar is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + _v = arg.pop('zcalendar', None) + self['zcalendar'] = zcalendar if zcalendar is not None else _v + _v = arg.pop('zsrc', None) + self['zsrc'] = zsrc if zsrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'scatter3d' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='scatter3d', val='scatter3d' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scatter(_BaseTraceType): + + # cliponaxis + # ---------- + @property + def cliponaxis(self): + """ + Determines whether or not markers and text nodes are clipped + about the subplot axes. To show markers and text nodes above + axis lines and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + + The 'cliponaxis' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cliponaxis'] + + @cliponaxis.setter + def cliponaxis(self, val): + self['cliponaxis'] = val + + # connectgaps + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['connectgaps'] + + @connectgaps.setter + def connectgaps(self, val): + self['connectgaps'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # dx + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['dx'] + + @dx.setter + def dx(self, val): + self['dx'] = val + + # dy + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['dy'] + + @dy.setter + def dy(self, val): + self['dy'] = val + + # error_x + # ------- + @property + def error_x(self): + """ + The 'error_x' property is an instance of ErrorX + that may be specified as: + - An instance of plotly.graph_objs.scatter.ErrorX + - A dict of string/value properties that will be passed + to the ErrorX constructor + + Supported dict properties: + + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. + + Returns + ------- + plotly.graph_objs.scatter.ErrorX + """ + return self['error_x'] + + @error_x.setter + def error_x(self, val): + self['error_x'] = val + + # error_y + # ------- + @property + def error_y(self): + """ + The 'error_y' property is an instance of ErrorY + that may be specified as: + - An instance of plotly.graph_objs.scatter.ErrorY + - A dict of string/value properties that will be passed + to the ErrorY constructor + + Supported dict properties: + + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. + + Returns + ------- + plotly.graph_objs.scatter.ErrorY + """ + return self['error_y'] + + @error_y.setter + def error_y(self, val): + self['error_y'] = val + + # fill + # ---- + @property + def fill(self): + """ + Sets the area to fill with a solid color. Defaults to "none" + unless this trace is stacked, then it gets "tonexty" + ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` + if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 + respectively. "tonextx" and "tonexty" fill between the + endpoints of this trace and the endpoints of the trace before + it, connecting those endpoints with straight lines (to make a + stacked area graph); if there is no trace before it, they + behave like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if it has + gaps) into a closed shape. "tonext" fills the space between two + traces if one completely encloses the other (eg consecutive + contour lines), and behaves like "toself" if there is no trace + before it. "tonext" should not be used if one trace does not + enclose the other. Traces in a `stackgroup` will only fill to + (or be filled to) other traces in the same group. With multiple + `stackgroup`s or some traces stacked and some not, if fill- + linked traces are not already consecutive, the later ones will + be pushed down in the drawing order. + + The 'fill' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', + 'toself', 'tonext'] + + Returns + ------- + Any + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # fillcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['fillcolor'] + + @fillcolor.setter + def fillcolor(self, val): + self['fillcolor'] = val + + # groupnorm + # --------- + @property + def groupnorm(self): + """ + Only relevant when `stackgroup` is used, and only the first + `groupnorm` found in the `stackgroup` will be used - including + if `visible` is "legendonly" but not if it is `false`. Sets the + normalization for the sum of this `stackgroup`. With + "fraction", the value of each trace at each location is divided + by the sum of all trace values at that location. "percent" is + the same but multiplied by 100 to show percentages. If there + are multiple subplots, or multiple `stackgroup`s on one + subplot, each will be normalized within its own set. + + The 'groupnorm' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', 'fraction', 'percent'] + + Returns + ------- + Any + """ + return self['groupnorm'] + + @groupnorm.setter + def groupnorm(self, val): + self['groupnorm'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.scatter.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.scatter.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hoveron + # ------- + @property + def hoveron(self): + """ + Do the hover effects highlight individual points (markers or + line points) or do they highlight filled regions? If the fill + is "toself" or "tonext" and there are no markers or text, then + the default is "fills", otherwise it is "points". + + The 'hoveron' property is a flaglist and may be specified + as a string containing: + - Any combination of ['points', 'fills'] joined with '+' characters + (e.g. 'points+fills') + + Returns + ------- + Any + """ + return self['hoveron'] + + @hoveron.setter + def hoveron(self, val): + self['hoveron'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + def hovertext(self): + """ + Sets hover text elements associated with each (x,y) pair. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the + lines are drawn using spline interpolation. The + other available values correspond to step-wise + line shapes. + simplify + Simplifies lines by removing nearly-collinear + points. When transitioning lines, it may be + desirable to disable this so that the number of + points along the resulting SVG path is + unaffected. + smoothing + Has an effect only if `shape` is set to + "spline" Sets the amount of smoothing. 0 + corresponds to no smoothing (equivalent to a + "linear" shape). + width + Sets the line width (in px). + + Returns + ------- + plotly.graph_objs.scatter.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scatter.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + gradient + plotly.graph_objs.scatter.marker.Gradient + instance or dict with compatible properties + line + plotly.graph_objs.scatter.marker.Line instance + or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on + the graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . + + Returns + ------- + plotly.graph_objs.scatter.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # mode + # ---- + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. If there are less than 20 points and the trace is not + stacked then the default is "lines+markers". Otherwise, + "lines". + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self['mode'] + + @mode.setter + def mode(self, val): + self['mode'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # orientation + # ----------- + @property + def orientation(self): + """ + Only relevant when `stackgroup` is used, and only the first + `orientation` found in the `stackgroup` will be used - + including if `visible` is "legendonly" but not if it is + `false`. Sets the stacking direction. With "v" ("h"), the y (x) + values of subsequent traces are added. Also affects the default + value of `fill`. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['v', 'h'] + + Returns + ------- + Any + """ + return self['orientation'] + + @orientation.setter + def orientation(self, val): + self['orientation'] = val + + # r + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['r'] + + @r.setter + def r(self, val): + self['r'] = val + + # rsrc + # ---- + @property + def rsrc(self): + """ + Sets the source reference on plot.ly for r . + + The 'rsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['rsrc'] + + @rsrc.setter + def rsrc(self, val): + self['rsrc'] = val + + # selected + # -------- + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of plotly.graph_objs.scatter.Selected + - A dict of string/value properties that will be passed + to the Selected constructor + + Supported dict properties: + + marker + plotly.graph_objs.scatter.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scatter.selected.Textfont + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.scatter.Selected + """ + return self['selected'] + + @selected.setter + def selected(self, val): + self['selected'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stackgaps + # --------- + @property + def stackgaps(self): + """ + Only relevant when `stackgroup` is used, and only the first + `stackgaps` found in the `stackgroup` will be used - including + if `visible` is "legendonly" but not if it is `false`. + Determines how we handle locations at which other traces in + this group have data but this one does not. With *infer zero* + we insert a zero at these locations. With "interpolate" we + linearly interpolate between existing values, and extrapolate a + constant beyond the existing values. + + The 'stackgaps' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['infer zero', 'interpolate'] + + Returns + ------- + Any + """ + return self['stackgaps'] + + @stackgaps.setter + def stackgaps(self, val): + self['stackgaps'] = val + + # stackgroup + # ---------- + @property + def stackgroup(self): + """ + Set several scatter traces (on the same subplot) to the same + stackgroup in order to add their y values (or their x values if + `orientation` is "h"). If blank or omitted this trace will not + be stacked. Stacking also turns `fill` on by default, using + "tonexty" ("tonextx") if `orientation` is "h" ("v") and sets + the default `mode` to "lines" irrespective of point count. You + can only stack on a numeric (linear or log) axis. Traces in a + `stackgroup` will only fill to (or be filled to) other traces + in the same group. With multiple `stackgroup`s or some traces + stacked and some not, if fill-linked traces are not already + consecutive, the later ones will be pushed down in the drawing + order. + + The 'stackgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['stackgroup'] + + @stackgroup.setter + def stackgroup(self, val): + self['stackgroup'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.scatter.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.scatter.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # t + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['t'] + + @t.setter + def t(self, val): + self['t'] = val + + # text + # ---- + @property + def text(self): + """ + Sets text elements associated with each (x,y) pair. If a single + string, the same string appears over all the data points. If an + array of string, the items are mapped in order to the this + trace's (x,y) coordinates. If trace `hoverinfo` contains a + "text" flag and "hovertext" is not set, these elements will be + seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scatter.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # textposition + # ------------ + @property + 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', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['textposition'] + + @textposition.setter + def textposition(self, val): + self['textposition'] = val + + # textpositionsrc + # --------------- + @property + def textpositionsrc(self): + """ + Sets the source reference on plot.ly for textposition . + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textpositionsrc'] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self['textpositionsrc'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # tsrc + # ---- + @property + def tsrc(self): + """ + Sets the source reference on plot.ly for t . + + The 'tsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tsrc'] + + @tsrc.setter + def tsrc(self, val): + self['tsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # unselected + # ---------- + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of plotly.graph_objs.scatter.Unselected + - A dict of string/value properties that will be passed + to the Unselected constructor + + Supported dict properties: + + marker + plotly.graph_objs.scatter.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scatter.unselected.Textfont + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.scatter.Unselected + """ + return self['unselected'] + + @unselected.setter + def unselected(self, val): + self['unselected'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # x0 + # -- + @property + 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 + ------- + Any + """ + return self['x0'] + + @x0.setter + def x0(self, val): + self['x0'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # xcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['xcalendar'] + + @xcalendar.setter + def xcalendar(self, val): + self['xcalendar'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # y0 + # -- + @property + 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 + ------- + Any + """ + return self['y0'] + + @y0.setter + def y0(self, val): + self['y0'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # ycalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['ycalendar'] + + @ycalendar.setter + def ycalendar(self, val): + self['ycalendar'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + plotly.graph_objs.scatter.ErrorX instance or dict with + compatible properties + error_y + plotly.graph_objs.scatter.ErrorY instance or dict with + compatible properties + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + groupnorm + Only relevant when `stackgroup` is used, and only the + first `groupnorm` found in the `stackgroup` will be + used - including if `visible` is "legendonly" but not + if it is `false`. Sets the normalization for the sum of + this `stackgroup`. With "fraction", the value of each + trace at each location is divided by the sum of all + trace values at that location. "percent" is the same + but multiplied by 100 to show percentages. If there are + multiple subplots, or multiple `stackgroup`s on one + subplot, each will be normalized within its own set. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scatter.Hoverlabel instance or dict + with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scatter.Line instance or dict with + compatible properties + marker + plotly.graph_objs.scatter.Marker instance or dict with + compatible properties + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + orientation + Only relevant when `stackgroup` is used, and only the + first `orientation` found in the `stackgroup` will be + used - including if `visible` is "legendonly" but not + if it is `false`. Sets the stacking direction. With "v" + ("h"), the y (x) values of subsequent traces are added. + Also affects the default value of `fill`. + r + r coordinates in scatter traces are deprecated!Please + switch to the "scatterpolar" trace type.Sets the radial + coordinatesfor legacy polar chart only. + rsrc + Sets the source reference on plot.ly for r . + selected + plotly.graph_objs.scatter.Selected instance or dict + with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stackgaps + Only relevant when `stackgroup` is used, and only the + first `stackgaps` found in the `stackgroup` will be + used - including if `visible` is "legendonly" but not + if it is `false`. Determines how we handle locations at + which other traces in this group have data but this one + does not. With *infer zero* we insert a zero at these + locations. With "interpolate" we linearly interpolate + between existing values, and extrapolate a constant + beyond the existing values. + stackgroup + Set several scatter traces (on the same subplot) to the + same stackgroup in order to add their y values (or + their x values if `orientation` is "h"). If blank or + omitted this trace will not be stacked. Stacking also + turns `fill` on by default, using "tonexty" ("tonextx") + if `orientation` is "h" ("v") and sets the default + `mode` to "lines" irrespective of point count. You can + only stack on a numeric (linear or log) axis. Traces in + a `stackgroup` will only fill to (or be filled to) + other traces in the same group. With multiple + `stackgroup`s or some traces stacked and some not, if + fill-linked traces are not already consecutive, the + later ones will be pushed down in the drawing order. + stream + plotly.graph_objs.scatter.Stream instance or dict with + compatible properties + t + t coordinates in scatter traces are deprecated!Please + switch to the "scatterpolar" trace type.Sets the + angular coordinatesfor legacy polar chart only. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + tsrc + Sets the source reference on plot.ly for t . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.scatter.Unselected instance or dict + with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + """ + + def __init__( + self, + arg=None, + cliponaxis=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + error_x=None, + error_y=None, + fill=None, + fillcolor=None, + groupnorm=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legendgroup=None, + line=None, + marker=None, + mode=None, + name=None, + opacity=None, + orientation=None, + r=None, + rsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stackgaps=None, + stackgroup=None, + stream=None, + t=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + tsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + ysrc=None, + **kwargs + ): + """ + Construct a new Scatter object + + The scatter trace type encompasses line charts, scatter charts, + text charts, and bubble charts. The data visualized as scatter + point or lines is set in `x` and `y`. Text (appearing either on + the chart or on hover only) is via `text`. Bubble charts are + achieved by setting `marker.size` and/or `marker.color` to + numerical arrays. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Scatter + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + plotly.graph_objs.scatter.ErrorX instance or dict with + compatible properties + error_y + plotly.graph_objs.scatter.ErrorY instance or dict with + compatible properties + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + groupnorm + Only relevant when `stackgroup` is used, and only the + first `groupnorm` found in the `stackgroup` will be + used - including if `visible` is "legendonly" but not + if it is `false`. Sets the normalization for the sum of + this `stackgroup`. With "fraction", the value of each + trace at each location is divided by the sum of all + trace values at that location. "percent" is the same + but multiplied by 100 to show percentages. If there are + multiple subplots, or multiple `stackgroup`s on one + subplot, each will be normalized within its own set. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.scatter.Hoverlabel instance or dict + with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.scatter.Line instance or dict with + compatible properties + marker + plotly.graph_objs.scatter.Marker instance or dict with + compatible properties + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + orientation + Only relevant when `stackgroup` is used, and only the + first `orientation` found in the `stackgroup` will be + used - including if `visible` is "legendonly" but not + if it is `false`. Sets the stacking direction. With "v" + ("h"), the y (x) values of subsequent traces are added. + Also affects the default value of `fill`. + r + r coordinates in scatter traces are deprecated!Please + switch to the "scatterpolar" trace type.Sets the radial + coordinatesfor legacy polar chart only. + rsrc + Sets the source reference on plot.ly for r . + selected + plotly.graph_objs.scatter.Selected instance or dict + with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stackgaps + Only relevant when `stackgroup` is used, and only the + first `stackgaps` found in the `stackgroup` will be + used - including if `visible` is "legendonly" but not + if it is `false`. Determines how we handle locations at + which other traces in this group have data but this one + does not. With *infer zero* we insert a zero at these + locations. With "interpolate" we linearly interpolate + between existing values, and extrapolate a constant + beyond the existing values. + stackgroup + Set several scatter traces (on the same subplot) to the + same stackgroup in order to add their y values (or + their x values if `orientation` is "h"). If blank or + omitted this trace will not be stacked. Stacking also + turns `fill` on by default, using "tonexty" ("tonextx") + if `orientation` is "h" ("v") and sets the default + `mode` to "lines" irrespective of point count. You can + only stack on a numeric (linear or log) axis. Traces in + a `stackgroup` will only fill to (or be filled to) + other traces in the same group. With multiple + `stackgroup`s or some traces stacked and some not, if + fill-linked traces are not already consecutive, the + later ones will be pushed down in the drawing order. + stream + plotly.graph_objs.scatter.Stream instance or dict with + compatible properties + t + t coordinates in scatter traces are deprecated!Please + switch to the "scatterpolar" trace type.Sets the + angular coordinatesfor legacy polar chart only. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + tsrc + Sets the source reference on plot.ly for t . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.scatter.Unselected instance or dict + with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + + Returns + ------- + Scatter + """ + super(Scatter, self).__init__('scatter') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Scatter +constructor must be a dict or +an instance of plotly.graph_objs.Scatter""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (scatter as v_scatter) + + # Initialize validators + # --------------------- + self._validators['cliponaxis'] = v_scatter.CliponaxisValidator() + self._validators['connectgaps'] = v_scatter.ConnectgapsValidator() + self._validators['customdata'] = v_scatter.CustomdataValidator() + self._validators['customdatasrc'] = v_scatter.CustomdatasrcValidator() + self._validators['dx'] = v_scatter.DxValidator() + self._validators['dy'] = v_scatter.DyValidator() + self._validators['error_x'] = v_scatter.ErrorXValidator() + self._validators['error_y'] = v_scatter.ErrorYValidator() + self._validators['fill'] = v_scatter.FillValidator() + self._validators['fillcolor'] = v_scatter.FillcolorValidator() + self._validators['groupnorm'] = v_scatter.GroupnormValidator() + self._validators['hoverinfo'] = v_scatter.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_scatter.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_scatter.HoverlabelValidator() + self._validators['hoveron'] = v_scatter.HoveronValidator() + self._validators['hovertemplate'] = v_scatter.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_scatter.HovertemplatesrcValidator() + self._validators['hovertext'] = v_scatter.HovertextValidator() + self._validators['hovertextsrc'] = v_scatter.HovertextsrcValidator() + self._validators['ids'] = v_scatter.IdsValidator() + self._validators['idssrc'] = v_scatter.IdssrcValidator() + self._validators['legendgroup'] = v_scatter.LegendgroupValidator() + self._validators['line'] = v_scatter.LineValidator() + self._validators['marker'] = v_scatter.MarkerValidator() + self._validators['mode'] = v_scatter.ModeValidator() + self._validators['name'] = v_scatter.NameValidator() + self._validators['opacity'] = v_scatter.OpacityValidator() + self._validators['orientation'] = v_scatter.OrientationValidator() + self._validators['r'] = v_scatter.RValidator() + self._validators['rsrc'] = v_scatter.RsrcValidator() + self._validators['selected'] = v_scatter.SelectedValidator() + self._validators['selectedpoints'] = v_scatter.SelectedpointsValidator( + ) + self._validators['showlegend'] = v_scatter.ShowlegendValidator() + self._validators['stackgaps'] = v_scatter.StackgapsValidator() + self._validators['stackgroup'] = v_scatter.StackgroupValidator() + self._validators['stream'] = v_scatter.StreamValidator() + self._validators['t'] = v_scatter.TValidator() + self._validators['text'] = v_scatter.TextValidator() + self._validators['textfont'] = v_scatter.TextfontValidator() + self._validators['textposition'] = v_scatter.TextpositionValidator() + self._validators['textpositionsrc' + ] = v_scatter.TextpositionsrcValidator() + self._validators['textsrc'] = v_scatter.TextsrcValidator() + self._validators['tsrc'] = v_scatter.TsrcValidator() + self._validators['uid'] = v_scatter.UidValidator() + self._validators['uirevision'] = v_scatter.UirevisionValidator() + self._validators['unselected'] = v_scatter.UnselectedValidator() + self._validators['visible'] = v_scatter.VisibleValidator() + self._validators['x'] = v_scatter.XValidator() + self._validators['x0'] = v_scatter.X0Validator() + self._validators['xaxis'] = v_scatter.XAxisValidator() + self._validators['xcalendar'] = v_scatter.XcalendarValidator() + self._validators['xsrc'] = v_scatter.XsrcValidator() + self._validators['y'] = v_scatter.YValidator() + self._validators['y0'] = v_scatter.Y0Validator() + self._validators['yaxis'] = v_scatter.YAxisValidator() + self._validators['ycalendar'] = v_scatter.YcalendarValidator() + self._validators['ysrc'] = v_scatter.YsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('cliponaxis', None) + self['cliponaxis'] = cliponaxis if cliponaxis is not None else _v + _v = arg.pop('connectgaps', None) + self['connectgaps'] = connectgaps if connectgaps is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('dx', None) + self['dx'] = dx if dx is not None else _v + _v = arg.pop('dy', None) + self['dy'] = dy if dy is not None else _v + _v = arg.pop('error_x', None) + self['error_x'] = error_x if error_x is not None else _v + _v = arg.pop('error_y', None) + self['error_y'] = error_y if error_y is not None else _v + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('fillcolor', None) + self['fillcolor'] = fillcolor if fillcolor is not None else _v + _v = arg.pop('groupnorm', None) + self['groupnorm'] = groupnorm if groupnorm is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hoveron', None) + self['hoveron'] = hoveron if hoveron is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('mode', None) + self['mode'] = mode if mode is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('orientation', None) + self['orientation'] = orientation if orientation is not None else _v + _v = arg.pop('r', None) + self['r'] = r if r is not None else _v + _v = arg.pop('rsrc', None) + self['rsrc'] = rsrc if rsrc is not None else _v + _v = arg.pop('selected', None) + self['selected'] = selected if selected is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stackgaps', None) + self['stackgaps'] = stackgaps if stackgaps is not None else _v + _v = arg.pop('stackgroup', None) + self['stackgroup'] = stackgroup if stackgroup is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('t', None) + self['t'] = t if t is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + _v = arg.pop('textposition', None) + self['textposition'] = textposition if textposition is not None else _v + _v = arg.pop('textpositionsrc', None) + self['textpositionsrc' + ] = textpositionsrc if textpositionsrc is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('tsrc', None) + self['tsrc'] = tsrc if tsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('unselected', None) + self['unselected'] = unselected if unselected is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('x0', None) + self['x0'] = x0 if x0 is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('xcalendar', None) + self['xcalendar'] = xcalendar if xcalendar is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('y0', None) + self['y0'] = y0 if y0 is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + _v = arg.pop('ycalendar', None) + self['ycalendar'] = ycalendar if ycalendar is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'scatter' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='scatter', val='scatter' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Sankey(_BaseTraceType): + + # arrangement + # ----------- + @property + def arrangement(self): + """ + If value is `snap` (the default), the node arrangement is + assisted by automatic snapping of elements to preserve space + between nodes specified via `nodepad`. If value is + `perpendicular`, the nodes can only move along a line + perpendicular to the flow. If value is `freeform`, the nodes + can freely move on the plane. If value is `fixed`, the nodes + are stationary. + + The 'arrangement' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['snap', 'perpendicular', 'freeform', 'fixed'] + + Returns + ------- + Any + """ + return self['arrangement'] + + @arrangement.setter + def arrangement(self, val): + self['arrangement'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # domain + # ------ + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of plotly.graph_objs.sankey.Domain + - A dict of string/value properties that will be passed + to the Domain constructor + + Supported dict properties: + + column + If there is a layout grid, use the domain for + this column in the grid for this sankey trace . + row + If there is a layout grid, use the domain for + this row in the grid for this sankey trace . + x + Sets the horizontal domain of this sankey trace + (in plot fraction). + y + Sets the vertical domain of this sankey trace + (in plot fraction). + + Returns + ------- + plotly.graph_objs.sankey.Domain + """ + return self['domain'] + + @domain.setter + def domain(self, val): + self['domain'] = val + + # hoverinfo + # --------- + @property + 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. + Note that this attribute is superseded by `node.hoverinfo` and + `node.hoverinfo` for nodes and links respectively. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of [] joined with '+' characters + (e.g. '') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + + Returns + ------- + Any + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.sankey.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.sankey.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # link + # ---- + @property + 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 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 + each `link`. If `link.color` is omitted, then + by default, a translucent grey link will be + used. + colorscales + plotly.graph_objs.sankey.link.Colorscale + instance or dict with compatible properties + colorscaledefaults + When used in a template (as layout.template.dat + a.sankey.link.colorscaledefaults), sets the + default property values to use for elements of + sankey.link.colorscales + colorsrc + Sets the source reference on plot.ly for color + . + hoverinfo + Determines which trace information appear when + hovering links. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverlabel + plotly.graph_objs.sankey.link.Hoverlabel + instance or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + variables `value` and `label`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + label + The shown name of the link. + labelsrc + Sets the source reference on plot.ly for label + . + line + plotly.graph_objs.sankey.link.Line instance or + dict with compatible properties + source + An integer number `[0..nodes.length - 1]` that + represents the source node. + sourcesrc + Sets the source reference on plot.ly for + source . + target + An integer number `[0..nodes.length - 1]` that + represents the target node. + targetsrc + Sets the source reference on plot.ly for + target . + value + A numeric value representing the flow volume + value. + valuesrc + Sets the source reference on plot.ly for value + . + + Returns + ------- + plotly.graph_objs.sankey.Link + """ + return self['link'] + + @link.setter + def link(self, val): + self['link'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # node + # ---- + @property + 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 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 + each `node`. If `node.color` is omitted, then + the default `Plotly` color palette will be + cycled through to have a variety of colors. + These defaults are not fully opaque, to allow + some visibility of what is beneath the node. + colorsrc + Sets the source reference on plot.ly for color + . + groups + Groups of nodes. Each group is defined by an + array with the indices of the nodes it + contains. Multiple groups can be specified. + hoverinfo + Determines which trace information appear when + hovering nodes. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverlabel + plotly.graph_objs.sankey.node.Hoverlabel + instance or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + variables `value` and `label`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + label + The shown name of the node. + labelsrc + Sets the source reference on plot.ly for label + . + line + plotly.graph_objs.sankey.node.Line instance or + dict with compatible properties + pad + Sets the padding (in px) between the `nodes`. + thickness + Sets the thickness (in px) of the `nodes`. + + Returns + ------- + plotly.graph_objs.sankey.Node + """ + return self['node'] + + @node.setter + def node(self, val): + self['node'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # orientation + # ----------- + @property + 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'] + + Returns + ------- + Any + """ + return self['orientation'] + + @orientation.setter + def orientation(self, val): + self['orientation'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.sankey.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.sankey.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # textfont + # -------- + @property + 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 plotly.graph_objs.sankey.Textfont + - A dict of string/value properties that will be passed + to the Textfont constructor + + Supported dict properties: + + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.sankey.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # valueformat + # ----------- + @property + def valueformat(self): + """ + Sets the value formatting rule using d3 formatting mini- + language which is similar to those of Python. See https://githu + b.com/d3/d3-format/blob/master/README.md#locale_format + + The 'valueformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['valueformat'] + + @valueformat.setter + def valueformat(self, val): + self['valueformat'] = val + + # valuesuffix + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['valuesuffix'] + + @valuesuffix.setter + def valuesuffix(self, val): + self['valuesuffix'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + arrangement + If value is `snap` (the default), the node arrangement + is assisted by automatic snapping of elements to + preserve space between nodes specified via `nodepad`. + If value is `perpendicular`, the nodes can only move + along a line perpendicular to the flow. If value is + `freeform`, the nodes can freely move on the plane. If + value is `fixed`, the nodes are stationary. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + domain + plotly.graph_objs.sankey.Domain instance or dict with + compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. Note that this attribute is + superseded by `node.hoverinfo` and `node.hoverinfo` for + nodes and links respectively. + hoverlabel + plotly.graph_objs.sankey.Hoverlabel instance or dict + with compatible properties + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + link + The links of the Sankey plot. + name + Sets the trace name. The trace name appear as the + legend item and on hover. + node + The nodes of the Sankey plot. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the Sankey diagram. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.sankey.Stream instance or dict with + compatible properties + textfont + Sets the font for node labels + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + valueformat + Sets the value formatting rule using d3 formatting + mini-language which is similar to those of Python. See + https://github.com/d3/d3-format/blob/master/README.md#l + ocale_format + valuesuffix + Adds a unit to follow the value in the hover tooltip. + Add a space if a separation is necessary from the + value. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + """ + + def __init__( + self, + arg=None, + arrangement=None, + customdata=None, + customdatasrc=None, + domain=None, + hoverinfo=None, + hoverlabel=None, + ids=None, + idssrc=None, + legendgroup=None, + link=None, + name=None, + node=None, + opacity=None, + orientation=None, + selectedpoints=None, + showlegend=None, + stream=None, + textfont=None, + uid=None, + uirevision=None, + valueformat=None, + valuesuffix=None, + visible=None, + **kwargs + ): + """ + Construct a new Sankey object + + Sankey plots for network flow data analysis. The nodes are + specified in `nodes` and the links between sources and targets + in `links`. The colors are set in `nodes[i].color` and + `links[i].color`; otherwise defaults are used. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Sankey + arrangement + If value is `snap` (the default), the node arrangement + is assisted by automatic snapping of elements to + preserve space between nodes specified via `nodepad`. + If value is `perpendicular`, the nodes can only move + along a line perpendicular to the flow. If value is + `freeform`, the nodes can freely move on the plane. If + value is `fixed`, the nodes are stationary. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + domain + plotly.graph_objs.sankey.Domain instance or dict with + compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. Note that this attribute is + superseded by `node.hoverinfo` and `node.hoverinfo` for + nodes and links respectively. + hoverlabel + plotly.graph_objs.sankey.Hoverlabel instance or dict + with compatible properties + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + link + The links of the Sankey plot. + name + Sets the trace name. The trace name appear as the + legend item and on hover. + node + The nodes of the Sankey plot. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the Sankey diagram. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.sankey.Stream instance or dict with + compatible properties + textfont + Sets the font for node labels + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + valueformat + Sets the value formatting rule using d3 formatting + mini-language which is similar to those of Python. See + https://github.com/d3/d3-format/blob/master/README.md#l + ocale_format + valuesuffix + Adds a unit to follow the value in the hover tooltip. + Add a space if a separation is necessary from the + value. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + + Returns + ------- + Sankey + """ + super(Sankey, self).__init__('sankey') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Sankey +constructor must be a dict or +an instance of plotly.graph_objs.Sankey""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (sankey as v_sankey) + + # Initialize validators + # --------------------- + self._validators['arrangement'] = v_sankey.ArrangementValidator() + self._validators['customdata'] = v_sankey.CustomdataValidator() + self._validators['customdatasrc'] = v_sankey.CustomdatasrcValidator() + self._validators['domain'] = v_sankey.DomainValidator() + self._validators['hoverinfo'] = v_sankey.HoverinfoValidator() + self._validators['hoverlabel'] = v_sankey.HoverlabelValidator() + self._validators['ids'] = v_sankey.IdsValidator() + self._validators['idssrc'] = v_sankey.IdssrcValidator() + self._validators['legendgroup'] = v_sankey.LegendgroupValidator() + self._validators['link'] = v_sankey.LinkValidator() + self._validators['name'] = v_sankey.NameValidator() + self._validators['node'] = v_sankey.NodeValidator() + self._validators['opacity'] = v_sankey.OpacityValidator() + self._validators['orientation'] = v_sankey.OrientationValidator() + self._validators['selectedpoints'] = v_sankey.SelectedpointsValidator() + self._validators['showlegend'] = v_sankey.ShowlegendValidator() + self._validators['stream'] = v_sankey.StreamValidator() + self._validators['textfont'] = v_sankey.TextfontValidator() + self._validators['uid'] = v_sankey.UidValidator() + self._validators['uirevision'] = v_sankey.UirevisionValidator() + self._validators['valueformat'] = v_sankey.ValueformatValidator() + self._validators['valuesuffix'] = v_sankey.ValuesuffixValidator() + self._validators['visible'] = v_sankey.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('arrangement', None) + self['arrangement'] = arrangement if arrangement is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('domain', None) + self['domain'] = domain if domain is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('link', None) + self['link'] = link if link is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('node', None) + self['node'] = node if node is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('orientation', None) + self['orientation'] = orientation if orientation is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('valueformat', None) + self['valueformat'] = valueformat if valueformat is not None else _v + _v = arg.pop('valuesuffix', None) + self['valuesuffix'] = valuesuffix if valuesuffix is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'sankey' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='sankey', val='sankey' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Pointcloud(_BaseTraceType): + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.pointcloud.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.pointcloud.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # indices + # ------- + @property + def indices(self): + """ + A sequential value, 0..n, supply it to avoid creating this + array inside plotting. If specified, it must be a typed + `Int32Array` array. Its length must be equal to or greater than + the number of points. For the best performance and memory use, + create one large `indices` typed array that is guaranteed to be + at least as long as the largest number of points during use, + and reuse it on each `Plotly.restyle()` call. + + The 'indices' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['indices'] + + @indices.setter + def indices(self, val): + self['indices'] = val + + # indicessrc + # ---------- + @property + def indicessrc(self): + """ + Sets the source reference on plot.ly for indices . + + The 'indicessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['indicessrc'] + + @indicessrc.setter + def indicessrc(self, val): + self['indicessrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of plotly.graph_objs.pointcloud.Marker + - A dict of string/value properties that will be passed + to the Marker constructor + + Supported dict properties: + + blend + Determines if colors are blended together for a + translucency effect in case `opacity` is + specified as a value less then `1`. Setting + `blend` to `true` reduces zoom/pan speed if + used with large numbers of points. + border + plotly.graph_objs.pointcloud.marker.Border + instance or dict with compatible properties + color + Sets the marker fill color. It accepts a + specific color.If the color is not fully opaque + and there are hundreds of thousandsof points, + it may cause slower zooming and panning. + opacity + Sets the marker opacity. The default value is + `1` (fully opaque). If the markers are not + fully opaque and there are hundreds of + thousands of points, it may cause slower + zooming and panning. Opacity fades the color + even if `blend` is left on `false` even if + there is no translucency effect in that case. + sizemax + Sets the maximum size (in px) of the rendered + marker points. Effective when the `pointcloud` + shows only few points. + sizemin + Sets the minimum size (in px) of the rendered + marker points, effective when the `pointcloud` + shows a million or more points. + + Returns + ------- + plotly.graph_objs.pointcloud.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.pointcloud.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.pointcloud.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + def text(self): + """ + Sets text elements associated with each (x,y) pair. If a single + string, the same string appears over all the data points. If an + array of string, the items are mapped in order to the this + trace's (x,y) coordinates. If trace `hoverinfo` contains a + "text" flag and "hovertext" is not set, these elements will be + seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # xbounds + # ------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['xbounds'] + + @xbounds.setter + def xbounds(self, val): + self['xbounds'] = val + + # xboundssrc + # ---------- + @property + def xboundssrc(self): + """ + Sets the source reference on plot.ly for xbounds . + + The 'xboundssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xboundssrc'] + + @xboundssrc.setter + def xboundssrc(self, val): + self['xboundssrc'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # xy + # -- + @property + def xy(self): + """ + Faster alternative to specifying `x` and `y` separately. If + supplied, it must be a typed `Float32Array` array that + represents points such that `xy[i * 2] = x[i]` and `xy[i * 2 + + 1] = y[i]` + + The 'xy' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['xy'] + + @xy.setter + def xy(self, val): + self['xy'] = val + + # xysrc + # ----- + @property + def xysrc(self): + """ + Sets the source reference on plot.ly for xy . + + The 'xysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xysrc'] + + @xysrc.setter + def xysrc(self, val): + self['xysrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # ybounds + # ------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ybounds'] + + @ybounds.setter + def ybounds(self, val): + self['ybounds'] = val + + # yboundssrc + # ---------- + @property + def yboundssrc(self): + """ + Sets the source reference on plot.ly for ybounds . + + The 'yboundssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['yboundssrc'] + + @yboundssrc.setter + def yboundssrc(self, val): + self['yboundssrc'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.pointcloud.Hoverlabel instance or + dict with compatible properties + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + indices + A sequential value, 0..n, supply it to avoid creating + this array inside plotting. If specified, it must be a + typed `Int32Array` array. Its length must be equal to + or greater than the number of points. For the best + performance and memory use, create one large `indices` + typed array that is guaranteed to be at least as long + as the largest number of points during use, and reuse + it on each `Plotly.restyle()` call. + indicessrc + Sets the source reference on plot.ly for indices . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + marker + plotly.graph_objs.pointcloud.Marker instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.pointcloud.Stream instance or dict + with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbounds + Specify `xbounds` in the shape of `[xMin, xMax] to + avoid looping through the `xy` typed array. Use it in + conjunction with `xy` and `ybounds` for the performance + benefits. + xboundssrc + Sets the source reference on plot.ly for xbounds . + xsrc + Sets the source reference on plot.ly for x . + xy + Faster alternative to specifying `x` and `y` + separately. If supplied, it must be a typed + `Float32Array` array that represents points such that + `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]` + xysrc + Sets the source reference on plot.ly for xy . + y + Sets the y coordinates. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybounds + Specify `ybounds` in the shape of `[yMin, yMax] to + avoid looping through the `xy` typed array. Use it in + conjunction with `xy` and `xbounds` for the performance + benefits. + yboundssrc + Sets the source reference on plot.ly for ybounds . + ysrc + Sets the source reference on plot.ly for y . + """ + + def __init__( + self, + arg=None, + customdata=None, + customdatasrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + ids=None, + idssrc=None, + indices=None, + indicessrc=None, + legendgroup=None, + marker=None, + name=None, + opacity=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xbounds=None, + xboundssrc=None, + xsrc=None, + xy=None, + xysrc=None, + y=None, + yaxis=None, + ybounds=None, + yboundssrc=None, + ysrc=None, + **kwargs + ): + """ + Construct a new Pointcloud object + + The data visualized as a point cloud set in `x` and `y` using + the WebGl plotting engine. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Pointcloud + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.pointcloud.Hoverlabel instance or + dict with compatible properties + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + indices + A sequential value, 0..n, supply it to avoid creating + this array inside plotting. If specified, it must be a + typed `Int32Array` array. Its length must be equal to + or greater than the number of points. For the best + performance and memory use, create one large `indices` + typed array that is guaranteed to be at least as long + as the largest number of points during use, and reuse + it on each `Plotly.restyle()` call. + indicessrc + Sets the source reference on plot.ly for indices . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + marker + plotly.graph_objs.pointcloud.Marker instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.pointcloud.Stream instance or dict + with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbounds + Specify `xbounds` in the shape of `[xMin, xMax] to + avoid looping through the `xy` typed array. Use it in + conjunction with `xy` and `ybounds` for the performance + benefits. + xboundssrc + Sets the source reference on plot.ly for xbounds . + xsrc + Sets the source reference on plot.ly for x . + xy + Faster alternative to specifying `x` and `y` + separately. If supplied, it must be a typed + `Float32Array` array that represents points such that + `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]` + xysrc + Sets the source reference on plot.ly for xy . + y + Sets the y coordinates. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybounds + Specify `ybounds` in the shape of `[yMin, yMax] to + avoid looping through the `xy` typed array. Use it in + conjunction with `xy` and `xbounds` for the performance + benefits. + yboundssrc + Sets the source reference on plot.ly for ybounds . + ysrc + Sets the source reference on plot.ly for y . + + Returns + ------- + Pointcloud + """ + super(Pointcloud, self).__init__('pointcloud') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Pointcloud +constructor must be a dict or +an instance of plotly.graph_objs.Pointcloud""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (pointcloud as v_pointcloud) + + # Initialize validators + # --------------------- + self._validators['customdata'] = v_pointcloud.CustomdataValidator() + self._validators['customdatasrc' + ] = v_pointcloud.CustomdatasrcValidator() + self._validators['hoverinfo'] = v_pointcloud.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_pointcloud.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_pointcloud.HoverlabelValidator() + self._validators['ids'] = v_pointcloud.IdsValidator() + self._validators['idssrc'] = v_pointcloud.IdssrcValidator() + self._validators['indices'] = v_pointcloud.IndicesValidator() + self._validators['indicessrc'] = v_pointcloud.IndicessrcValidator() + self._validators['legendgroup'] = v_pointcloud.LegendgroupValidator() + self._validators['marker'] = v_pointcloud.MarkerValidator() + self._validators['name'] = v_pointcloud.NameValidator() + self._validators['opacity'] = v_pointcloud.OpacityValidator() + self._validators['selectedpoints' + ] = v_pointcloud.SelectedpointsValidator() + self._validators['showlegend'] = v_pointcloud.ShowlegendValidator() + self._validators['stream'] = v_pointcloud.StreamValidator() + self._validators['text'] = v_pointcloud.TextValidator() + self._validators['textsrc'] = v_pointcloud.TextsrcValidator() + self._validators['uid'] = v_pointcloud.UidValidator() + self._validators['uirevision'] = v_pointcloud.UirevisionValidator() + self._validators['visible'] = v_pointcloud.VisibleValidator() + self._validators['x'] = v_pointcloud.XValidator() + self._validators['xaxis'] = v_pointcloud.XAxisValidator() + self._validators['xbounds'] = v_pointcloud.XboundsValidator() + self._validators['xboundssrc'] = v_pointcloud.XboundssrcValidator() + self._validators['xsrc'] = v_pointcloud.XsrcValidator() + self._validators['xy'] = v_pointcloud.XyValidator() + self._validators['xysrc'] = v_pointcloud.XysrcValidator() + self._validators['y'] = v_pointcloud.YValidator() + self._validators['yaxis'] = v_pointcloud.YAxisValidator() + self._validators['ybounds'] = v_pointcloud.YboundsValidator() + self._validators['yboundssrc'] = v_pointcloud.YboundssrcValidator() + self._validators['ysrc'] = v_pointcloud.YsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('indices', None) + self['indices'] = indices if indices is not None else _v + _v = arg.pop('indicessrc', None) + self['indicessrc'] = indicessrc if indicessrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('xbounds', None) + self['xbounds'] = xbounds if xbounds is not None else _v + _v = arg.pop('xboundssrc', None) + self['xboundssrc'] = xboundssrc if xboundssrc is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('xy', None) + self['xy'] = xy if xy is not None else _v + _v = arg.pop('xysrc', None) + self['xysrc'] = xysrc if xysrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + _v = arg.pop('ybounds', None) + self['ybounds'] = ybounds if ybounds is not None else _v + _v = arg.pop('yboundssrc', None) + self['yboundssrc'] = yboundssrc if yboundssrc is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'pointcloud' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='pointcloud', val='pointcloud' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Pie(_BaseTraceType): + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # direction + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['direction'] + + @direction.setter + def direction(self, val): + self['direction'] = val + + # dlabel + # ------ + @property + 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 + + Returns + ------- + int|float + """ + return self['dlabel'] + + @dlabel.setter + def dlabel(self, val): + self['dlabel'] = val + + # domain + # ------ + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of plotly.graph_objs.pie.Domain + - A dict of string/value properties that will be passed + to the Domain constructor + + Supported dict properties: + + column + If there is a layout grid, use the domain for + this column in the grid for this pie trace . + row + If there is a layout grid, use the domain for + this row in the grid for this pie trace . + x + Sets the horizontal domain of this pie trace + (in plot fraction). + y + Sets the vertical domain of this pie trace (in + plot fraction). + + Returns + ------- + plotly.graph_objs.pie.Domain + """ + return self['domain'] + + @domain.setter + def domain(self, val): + self['domain'] = val + + # hole + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['hole'] + + @hole.setter + def hole(self, val): + self['hole'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'label+text') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.pie.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.pie.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + variables `label`, `color`, `value`, `percent` and `text`. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + def hovertext(self): + """ + Sets hover text elements associated with each sector. If a + single string, the same string appears for all data points. If + an array of string, the items are mapped in order of this + trace's sectors. To be seen, trace `hoverinfo` must contain a + "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # insidetextfont + # -------------- + @property + def insidetextfont(self): + """ + Sets the font used for `textinfo` lying inside the pie. + + The 'insidetextfont' property is an instance of Insidetextfont + that may be specified as: + - An instance of 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.pie.Insidetextfont + """ + return self['insidetextfont'] + + @insidetextfont.setter + def insidetextfont(self, val): + self['insidetextfont'] = val + + # label0 + # ------ + @property + 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 + + Returns + ------- + int|float + """ + return self['label0'] + + @label0.setter + def label0(self, val): + self['label0'] = val + + # labels + # ------ + @property + def labels(self): + """ + Sets the sector labels. If `labels` entries are duplicated, we + sum associated `values` or simply count occurrences if `values` + is not provided. For other array attributes (including color) + we use the first non-empty entry among all occurrences of the + label. + + The 'labels' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['labels'] + + @labels.setter + def labels(self, val): + self['labels'] = val + + # labelssrc + # --------- + @property + def labelssrc(self): + """ + Sets the source reference on plot.ly for labels . + + The 'labelssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['labelssrc'] + + @labelssrc.setter + def labelssrc(self, val): + self['labelssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 of this pie + chart. If not specified, the default trace + color set is used to pick the sector colors. + colorssrc + Sets the source reference on plot.ly for + colors . + line + plotly.graph_objs.pie.marker.Line instance or + dict with compatible properties + + Returns + ------- + plotly.graph_objs.pie.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # outsidetextfont + # --------------- + @property + def outsidetextfont(self): + """ + Sets the font used for `textinfo` lying outside the pie. + + The 'outsidetextfont' property is an instance of Outsidetextfont + that may be specified as: + - An instance of 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.pie.Outsidetextfont + """ + return self['outsidetextfont'] + + @outsidetextfont.setter + def outsidetextfont(self, val): + self['outsidetextfont'] = val + + # pull + # ---- + @property + def pull(self): + """ + Sets the fraction of larger radius to pull the sectors out from + the center. This can be a constant to pull all slices apart + from each other equally or an array to highlight one or more + slices. + + The 'pull' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['pull'] + + @pull.setter + def pull(self, val): + self['pull'] = val + + # pullsrc + # ------- + @property + def pullsrc(self): + """ + Sets the source reference on plot.ly for pull . + + The 'pullsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['pullsrc'] + + @pullsrc.setter + def pullsrc(self, val): + self['pullsrc'] = val + + # rotation + # -------- + @property + 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] + + Returns + ------- + int|float + """ + return self['rotation'] + + @rotation.setter + def rotation(self, val): + self['rotation'] = val + + # scalegroup + # ---------- + @property + def scalegroup(self): + """ + If there are multiple pies that should be sized according to + their totals, link them by providing a non-empty group id here + shared by every trace in the same group. + + The 'scalegroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['scalegroup'] + + @scalegroup.setter + def scalegroup(self, val): + self['scalegroup'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # sort + # ---- + @property + 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) + + Returns + ------- + bool + """ + return self['sort'] + + @sort.setter + def sort(self, val): + self['sort'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.pie.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.pie.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + def text(self): + """ + Sets text elements associated with each sector. If trace + `textinfo` contains a "text" flag, these elements will be seen + on the chart. If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in the + hover labels. + + The 'text' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textfont + # -------- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.pie.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # textinfo + # -------- + @property + 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 + (e.g. 'label+text') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self['textinfo'] + + @textinfo.setter + def textinfo(self, val): + self['textinfo'] = val + + # textposition + # ------------ + @property + 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'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['textposition'] + + @textposition.setter + def textposition(self, val): + self['textposition'] = val + + # textpositionsrc + # --------------- + @property + def textpositionsrc(self): + """ + Sets the source reference on plot.ly for textposition . + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textpositionsrc'] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self['textpositionsrc'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of plotly.graph_objs.pie.Title + - A dict of string/value properties that will be passed + to the Title constructor + + Supported dict properties: + + font + Sets the font used for `title`. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + position + Specifies the location of the `title`. Note + that the title's position used to be set by the + now deprecated `titleposition` attribute. + text + Sets the title of the pie chart. If it is + empty, no title is displayed. Note that before + the existence of `title.text`, the title's + contents used to be defined as the `title` + attribute itself. This behavior has been + deprecated. + + Returns + ------- + plotly.graph_objs.pie.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleposition + # ------------- + @property + 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', + 'bottom left', 'bottom center', 'bottom right'] + + Returns + ------- + + """ + return self['titleposition'] + + @titleposition.setter + def titleposition(self, val): + self['titleposition'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # values + # ------ + @property + def values(self): + """ + Sets the values of the sectors of this pie chart. If omitted, + we count occurrences of each label. + + The 'values' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['values'] + + @values.setter + def values(self, val): + self['values'] = val + + # valuessrc + # --------- + @property + def valuessrc(self): + """ + Sets the source reference on plot.ly for values . + + The 'valuessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['valuessrc'] + + @valuessrc.setter + def valuessrc(self, val): + self['valuessrc'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + direction + Specifies the direction at which succeeding sectors + follow one another. + dlabel + Sets the label step. See `label0` for more info. + domain + plotly.graph_objs.pie.Domain instance or dict with + compatible properties + hole + Sets the fraction of the radius to cut out of the pie. + Use this to make a donut chart. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.pie.Hoverlabel instance or dict with + compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variables `label`, `color`, `value`, + `percent` and `text`. Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + insidetextfont + Sets the font used for `textinfo` lying inside the pie. + label0 + Alternate to `labels`. Builds a numeric set of labels. + Use with `dlabel` where `label0` is the starting label + and `dlabel` the step. + labels + Sets the sector labels. If `labels` entries are + duplicated, we sum associated `values` or simply count + occurrences if `values` is not provided. For other + array attributes (including color) we use the first + non-empty entry among all occurrences of the label. + labelssrc + Sets the source reference on plot.ly for labels . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + marker + plotly.graph_objs.pie.Marker instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + pie. + pull + Sets the fraction of larger radius to pull the sectors + out from the center. This can be a constant to pull all + slices apart from each other equally or an array to + highlight one or more slices. + pullsrc + Sets the source reference on plot.ly for pull . + rotation + Instead of the first slice starting at 12 o'clock, + rotate to some other angle. + scalegroup + If there are multiple pies that should be sized + according to their totals, link them by providing a + non-empty group id here shared by every trace in the + same group. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + plotly.graph_objs.pie.Stream instance or dict with + compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Specifies the location of the `textinfo`. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + title + plotly.graph_objs.pie.Title instance or dict with + compatible properties + titlefont + Deprecated: Please use pie.title.font instead. Sets the + font used for `title`. Note that the title's font used + to be set by the now deprecated `titlefont` attribute. + titleposition + Deprecated: Please use pie.title.position instead. + Specifies the location of the `title`. Note that the + title's position used to be set by the now deprecated + `titleposition` attribute. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values of the sectors of this pie chart. If + omitted, we count occurrences of each label. + valuessrc + Sets the source reference on plot.ly for values . + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleposition': ('title', 'position') + } + + def __init__( + self, + arg=None, + customdata=None, + customdatasrc=None, + direction=None, + dlabel=None, + domain=None, + hole=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + label0=None, + labels=None, + labelssrc=None, + legendgroup=None, + marker=None, + name=None, + opacity=None, + outsidetextfont=None, + pull=None, + pullsrc=None, + rotation=None, + scalegroup=None, + selectedpoints=None, + showlegend=None, + sort=None, + stream=None, + text=None, + textfont=None, + textinfo=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + title=None, + titlefont=None, + titleposition=None, + uid=None, + uirevision=None, + values=None, + valuessrc=None, + visible=None, + **kwargs + ): + """ + Construct a new Pie object + + A data visualized by the sectors of the pie is set in `values`. + The sector labels are set in `labels`. The sector colors are + set in `marker.colors` + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Pie + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + direction + Specifies the direction at which succeeding sectors + follow one another. + dlabel + Sets the label step. See `label0` for more info. + domain + plotly.graph_objs.pie.Domain instance or dict with + compatible properties + hole + Sets the fraction of the radius to cut out of the pie. + Use this to make a donut chart. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.pie.Hoverlabel instance or dict with + compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variables `label`, `color`, `value`, + `percent` and `text`. Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + insidetextfont + Sets the font used for `textinfo` lying inside the pie. + label0 + Alternate to `labels`. Builds a numeric set of labels. + Use with `dlabel` where `label0` is the starting label + and `dlabel` the step. + labels + Sets the sector labels. If `labels` entries are + duplicated, we sum associated `values` or simply count + occurrences if `values` is not provided. For other + array attributes (including color) we use the first + non-empty entry among all occurrences of the label. + labelssrc + Sets the source reference on plot.ly for labels . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + marker + plotly.graph_objs.pie.Marker instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + pie. + pull + Sets the fraction of larger radius to pull the sectors + out from the center. This can be a constant to pull all + slices apart from each other equally or an array to + highlight one or more slices. + pullsrc + Sets the source reference on plot.ly for pull . + rotation + Instead of the first slice starting at 12 o'clock, + rotate to some other angle. + scalegroup + If there are multiple pies that should be sized + according to their totals, link them by providing a + non-empty group id here shared by every trace in the + same group. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + plotly.graph_objs.pie.Stream instance or dict with + compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Specifies the location of the `textinfo`. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + title + plotly.graph_objs.pie.Title instance or dict with + compatible properties + titlefont + Deprecated: Please use pie.title.font instead. Sets the + font used for `title`. Note that the title's font used + to be set by the now deprecated `titlefont` attribute. + titleposition + Deprecated: Please use pie.title.position instead. + Specifies the location of the `title`. Note that the + title's position used to be set by the now deprecated + `titleposition` attribute. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values of the sectors of this pie chart. If + omitted, we count occurrences of each label. + valuessrc + Sets the source reference on plot.ly for values . + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + + Returns + ------- + Pie + """ + super(Pie, self).__init__('pie') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Pie +constructor must be a dict or +an instance of plotly.graph_objs.Pie""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (pie as v_pie) + + # Initialize validators + # --------------------- + self._validators['customdata'] = v_pie.CustomdataValidator() + self._validators['customdatasrc'] = v_pie.CustomdatasrcValidator() + self._validators['direction'] = v_pie.DirectionValidator() + self._validators['dlabel'] = v_pie.DlabelValidator() + self._validators['domain'] = v_pie.DomainValidator() + self._validators['hole'] = v_pie.HoleValidator() + self._validators['hoverinfo'] = v_pie.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_pie.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_pie.HoverlabelValidator() + self._validators['hovertemplate'] = v_pie.HovertemplateValidator() + self._validators['hovertemplatesrc'] = v_pie.HovertemplatesrcValidator( + ) + self._validators['hovertext'] = v_pie.HovertextValidator() + self._validators['hovertextsrc'] = v_pie.HovertextsrcValidator() + self._validators['ids'] = v_pie.IdsValidator() + self._validators['idssrc'] = v_pie.IdssrcValidator() + self._validators['insidetextfont'] = v_pie.InsidetextfontValidator() + self._validators['label0'] = v_pie.Label0Validator() + self._validators['labels'] = v_pie.LabelsValidator() + self._validators['labelssrc'] = v_pie.LabelssrcValidator() + self._validators['legendgroup'] = v_pie.LegendgroupValidator() + self._validators['marker'] = v_pie.MarkerValidator() + self._validators['name'] = v_pie.NameValidator() + self._validators['opacity'] = v_pie.OpacityValidator() + self._validators['outsidetextfont'] = v_pie.OutsidetextfontValidator() + self._validators['pull'] = v_pie.PullValidator() + self._validators['pullsrc'] = v_pie.PullsrcValidator() + self._validators['rotation'] = v_pie.RotationValidator() + self._validators['scalegroup'] = v_pie.ScalegroupValidator() + self._validators['selectedpoints'] = v_pie.SelectedpointsValidator() + self._validators['showlegend'] = v_pie.ShowlegendValidator() + self._validators['sort'] = v_pie.SortValidator() + self._validators['stream'] = v_pie.StreamValidator() + self._validators['text'] = v_pie.TextValidator() + self._validators['textfont'] = v_pie.TextfontValidator() + self._validators['textinfo'] = v_pie.TextinfoValidator() + self._validators['textposition'] = v_pie.TextpositionValidator() + self._validators['textpositionsrc'] = v_pie.TextpositionsrcValidator() + self._validators['textsrc'] = v_pie.TextsrcValidator() + self._validators['title'] = v_pie.TitleValidator() + self._validators['uid'] = v_pie.UidValidator() + self._validators['uirevision'] = v_pie.UirevisionValidator() + self._validators['values'] = v_pie.ValuesValidator() + self._validators['valuessrc'] = v_pie.ValuessrcValidator() + self._validators['visible'] = v_pie.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('direction', None) + self['direction'] = direction if direction is not None else _v + _v = arg.pop('dlabel', None) + self['dlabel'] = dlabel if dlabel is not None else _v + _v = arg.pop('domain', None) + self['domain'] = domain if domain is not None else _v + _v = arg.pop('hole', None) + self['hole'] = hole if hole is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('insidetextfont', None) + self['insidetextfont' + ] = insidetextfont if insidetextfont is not None else _v + _v = arg.pop('label0', None) + self['label0'] = label0 if label0 is not None else _v + _v = arg.pop('labels', None) + self['labels'] = labels if labels is not None else _v + _v = arg.pop('labelssrc', None) + self['labelssrc'] = labelssrc if labelssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('outsidetextfont', None) + self['outsidetextfont' + ] = outsidetextfont if outsidetextfont is not None else _v + _v = arg.pop('pull', None) + self['pull'] = pull if pull is not None else _v + _v = arg.pop('pullsrc', None) + self['pullsrc'] = pullsrc if pullsrc is not None else _v + _v = arg.pop('rotation', None) + self['rotation'] = rotation if rotation is not None else _v + _v = arg.pop('scalegroup', None) + self['scalegroup'] = scalegroup if scalegroup is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('sort', None) + self['sort'] = sort if sort is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + _v = arg.pop('textinfo', None) + self['textinfo'] = textinfo if textinfo is not None else _v + _v = arg.pop('textposition', None) + self['textposition'] = textposition if textposition is not None else _v + _v = arg.pop('textpositionsrc', None) + self['textpositionsrc' + ] = textpositionsrc if textpositionsrc is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleposition', None) + _v = titleposition if titleposition is not None else _v + if _v is not None: + self['titleposition'] = _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('values', None) + self['values'] = values if values is not None else _v + _v = arg.pop('valuessrc', None) + self['valuessrc'] = valuessrc if valuessrc is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'pie' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='pie', val='pie' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Parcoords(_BaseTraceType): + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # dimensions + # ---------- + @property + 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 + `[fromValue, toValue]` with `fromValue <= + toValue`, or if `multiselect` is not disabled, + you may give an array of arrays, where each + inner array is `[fromValue, toValue]`. + label + The shown name of the dimension. + multiselect + Do we allow multiple selection ranges or just a + single range? + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + range + The domain range that represents the full, + shown axis extent. Defaults to the `values` + extent. Must be an array of `[fromValue, + toValue]` with finite numbers as elements. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-language which is similar to + those of Python. See https://github.com/d3/d3-f + ormat/blob/master/README.md#locale_format + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + values + Dimension values. `values[n]` represents the + value of the `n`th point in the dataset, + therefore the `values` vector for all + dimensions must be the same (longer vectors + will be truncated). Each value must be a finite + number. + valuessrc + Sets the source reference on plot.ly for + values . + visible + Shows the dimension when set to `true` (the + default). Hides the dimension for `false`. + + Returns + ------- + tuple[plotly.graph_objs.parcoords.Dimension] + """ + return self['dimensions'] + + @dimensions.setter + def dimensions(self, val): + self['dimensions'] = val + + # dimensiondefaults + # ----------------- + @property + def dimensiondefaults(self): + """ + When used in a template (as + layout.template.data.parcoords.dimensiondefaults), sets the + default property values to use for elements of + parcoords.dimensions + + The 'dimensiondefaults' property is an instance of Dimension + that may be specified as: + - An instance of plotly.graph_objs.parcoords.Dimension + - A dict of string/value properties that will be passed + to the Dimension constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.parcoords.Dimension + """ + return self['dimensiondefaults'] + + @dimensiondefaults.setter + def dimensiondefaults(self, val): + self['dimensiondefaults'] = val + + # domain + # ------ + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of plotly.graph_objs.parcoords.Domain + - A dict of string/value properties that will be passed + to the Domain constructor + + Supported dict properties: + + column + If there is a layout grid, use the domain for + this column in the grid for this parcoords + trace . + row + If there is a layout grid, use the domain for + this row in the grid for this parcoords trace . + x + Sets the horizontal domain of this parcoords + trace (in plot fraction). + y + Sets the vertical domain of this parcoords + trace (in plot fraction). + + Returns + ------- + plotly.graph_objs.parcoords.Domain + """ + return self['domain'] + + @domain.setter + def domain(self, val): + self['domain'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # labelfont + # --------- + @property + 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 plotly.graph_objs.parcoords.Labelfont + - A dict of string/value properties that will be passed + to the Labelfont constructor + + Supported dict properties: + + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.parcoords.Labelfont + """ + return self['labelfont'] + + @labelfont.setter + def labelfont(self, val): + self['labelfont'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of plotly.graph_objs.parcoords.Line + - A dict of string/value properties that will be passed + to the Line constructor + + Supported dict properties: + + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `line.colorscale`. Has an effect + only if in `line.color`is set to a numerical + array. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette + will be chosen according to whether numbers in + the `color` array are all positive, all + negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `line.color`) or the bounds set in + `line.cmin` and `line.cmax` Has an effect only + if in `line.color`is set to a numerical array. + Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `line.color`is set to a + numerical array. Value should have the same + units as in `line.color` and if set, + `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `line.cmin` and/or `line.cmax` to be + equidistant to this point. Has an effect only + if in `line.color`is set to a numerical array. + Value should have the same units as in + `line.color`. Has no effect when `line.cauto` + is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `line.color`is set to a + numerical array. Value should have the same + units as in `line.color` and if set, + `line.cmax` must be set as well. + color + Sets thelinecolor. It accepts either a specific + color or an array of numbers that are mapped to + the colorscale relative to the max and min + values of the array or relative to `line.cmin` + and `line.cmax` if set. + colorbar + plotly.graph_objs.parcoords.line.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `line.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`line.cmin` and `line.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `line.color`is set to a + numerical array. If true, `line.cmin` will + correspond to the last color in the array and + `line.cmax` will correspond to the first color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `line.color`is set to a numerical array. + + Returns + ------- + plotly.graph_objs.parcoords.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # rangefont + # --------- + @property + 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 plotly.graph_objs.parcoords.Rangefont + - A dict of string/value properties that will be passed + to the Rangefont constructor + + Supported dict properties: + + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.parcoords.Rangefont + """ + return self['rangefont'] + + @rangefont.setter + def rangefont(self, val): + self['rangefont'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.parcoords.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.parcoords.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # tickfont + # -------- + @property + 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 plotly.graph_objs.parcoords.Tickfont + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Supported dict properties: + + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.parcoords.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dimensions + The dimensions (variables) of the parallel coordinates + chart. 2..60 dimensions are supported. + dimensiondefaults + When used in a template (as + layout.template.data.parcoords.dimensiondefaults), sets + the default property values to use for elements of + parcoords.dimensions + domain + plotly.graph_objs.parcoords.Domain instance or dict + with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + labelfont + Sets the font for the `dimension` labels. + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.parcoords.Line instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + rangefont + Sets the font for the `dimension` range values. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.parcoords.Stream instance or dict + with compatible properties + tickfont + Sets the font for the `dimension` tick values. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + """ + + def __init__( + self, + arg=None, + customdata=None, + customdatasrc=None, + dimensions=None, + dimensiondefaults=None, + domain=None, + hoverinfo=None, + hoverinfosrc=None, + ids=None, + idssrc=None, + labelfont=None, + legendgroup=None, + line=None, + name=None, + opacity=None, + rangefont=None, + selectedpoints=None, + showlegend=None, + stream=None, + tickfont=None, + uid=None, + uirevision=None, + visible=None, + **kwargs + ): + """ + Construct a new Parcoords object + + Parallel coordinates for multidimensional exploratory data + analysis. The samples are specified in `dimensions`. The colors + are set in `line.color`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Parcoords + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dimensions + The dimensions (variables) of the parallel coordinates + chart. 2..60 dimensions are supported. + dimensiondefaults + When used in a template (as + layout.template.data.parcoords.dimensiondefaults), sets + the default property values to use for elements of + parcoords.dimensions + domain + plotly.graph_objs.parcoords.Domain instance or dict + with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + labelfont + Sets the font for the `dimension` labels. + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.parcoords.Line instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + rangefont + Sets the font for the `dimension` range values. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.parcoords.Stream instance or dict + with compatible properties + tickfont + Sets the font for the `dimension` tick values. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + + Returns + ------- + Parcoords + """ + super(Parcoords, self).__init__('parcoords') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Parcoords +constructor must be a dict or +an instance of plotly.graph_objs.Parcoords""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (parcoords as v_parcoords) + + # Initialize validators + # --------------------- + self._validators['customdata'] = v_parcoords.CustomdataValidator() + self._validators['customdatasrc'] = v_parcoords.CustomdatasrcValidator( + ) + self._validators['dimensions'] = v_parcoords.DimensionsValidator() + self._validators['dimensiondefaults'] = v_parcoords.DimensionValidator( + ) + self._validators['domain'] = v_parcoords.DomainValidator() + self._validators['hoverinfo'] = v_parcoords.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_parcoords.HoverinfosrcValidator() + self._validators['ids'] = v_parcoords.IdsValidator() + self._validators['idssrc'] = v_parcoords.IdssrcValidator() + self._validators['labelfont'] = v_parcoords.LabelfontValidator() + self._validators['legendgroup'] = v_parcoords.LegendgroupValidator() + self._validators['line'] = v_parcoords.LineValidator() + self._validators['name'] = v_parcoords.NameValidator() + self._validators['opacity'] = v_parcoords.OpacityValidator() + self._validators['rangefont'] = v_parcoords.RangefontValidator() + self._validators['selectedpoints' + ] = v_parcoords.SelectedpointsValidator() + self._validators['showlegend'] = v_parcoords.ShowlegendValidator() + self._validators['stream'] = v_parcoords.StreamValidator() + self._validators['tickfont'] = v_parcoords.TickfontValidator() + self._validators['uid'] = v_parcoords.UidValidator() + self._validators['uirevision'] = v_parcoords.UirevisionValidator() + self._validators['visible'] = v_parcoords.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('dimensions', None) + self['dimensions'] = dimensions if dimensions is not None else _v + _v = arg.pop('dimensiondefaults', None) + self['dimensiondefaults' + ] = dimensiondefaults if dimensiondefaults is not None else _v + _v = arg.pop('domain', None) + self['domain'] = domain if domain is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('labelfont', None) + self['labelfont'] = labelfont if labelfont is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('rangefont', None) + self['rangefont'] = rangefont if rangefont is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'parcoords' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='parcoords', val='parcoords' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Parcats(_BaseTraceType): + + # arrangement + # ----------- + @property + def arrangement(self): + """ + Sets the drag interaction mode for categories and dimensions. + If `perpendicular`, the categories can only move along a line + perpendicular to the paths. If `freeform`, the categories can + freely move on the plane. If `fixed`, the categories and + dimensions are stationary. + + The 'arrangement' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['perpendicular', 'freeform', 'fixed'] + + Returns + ------- + Any + """ + return self['arrangement'] + + @arrangement.setter + def arrangement(self, val): + self['arrangement'] = val + + # bundlecolors + # ------------ + @property + 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) + + Returns + ------- + bool + """ + return self['bundlecolors'] + + @bundlecolors.setter + def bundlecolors(self, val): + self['bundlecolors'] = val + + # counts + # ------ + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['counts'] + + @counts.setter + def counts(self, val): + self['counts'] = val + + # countssrc + # --------- + @property + def countssrc(self): + """ + Sets the source reference on plot.ly for counts . + + The 'countssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['countssrc'] + + @countssrc.setter + def countssrc(self, val): + self['countssrc'] = val + + # dimensions + # ---------- + @property + 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 + `categoryorder` is set to "array". Used with + `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the categories + in the dimension. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + displayindex + The display index of dimension, from left to + right, zero indexed, defaults to dimension + index. + label + The shown name of the dimension. + ticktext + Sets alternative tick labels for the categories + in this dimension. Only has an effect if + `categoryorder` is set to "array". Should be an + array the same length as `categoryarray` Used + with `categoryorder`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + values + Dimension values. `values[n]` represents the + category value of the `n`th point in the + dataset, therefore the `values` vector for all + dimensions must be the same (longer vectors + will be truncated). + valuessrc + Sets the source reference on plot.ly for + values . + visible + Shows the dimension when set to `true` (the + default). Hides the dimension for `false`. + + Returns + ------- + tuple[plotly.graph_objs.parcats.Dimension] + """ + return self['dimensions'] + + @dimensions.setter + def dimensions(self, val): + self['dimensions'] = val + + # dimensiondefaults + # ----------------- + @property + def dimensiondefaults(self): + """ + When used in a template (as + layout.template.data.parcats.dimensiondefaults), sets the + default property values to use for elements of + parcats.dimensions + + The 'dimensiondefaults' property is an instance of Dimension + that may be specified as: + - An instance of plotly.graph_objs.parcats.Dimension + - A dict of string/value properties that will be passed + to the Dimension constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.parcats.Dimension + """ + return self['dimensiondefaults'] + + @dimensiondefaults.setter + def dimensiondefaults(self, val): + self['dimensiondefaults'] = val + + # domain + # ------ + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of plotly.graph_objs.parcats.Domain + - A dict of string/value properties that will be passed + to the Domain constructor + + Supported dict properties: + + column + If there is a layout grid, use the domain for + this column in the grid for this parcats trace + . + row + If there is a layout grid, use the domain for + this row in the grid for this parcats trace . + x + Sets the horizontal domain of this parcats + trace (in plot fraction). + y + Sets the vertical domain of this parcats trace + (in plot fraction). + + Returns + ------- + plotly.graph_objs.parcats.Domain + """ + return self['domain'] + + @domain.setter + def domain(self, val): + self['domain'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'count+probability') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + + Returns + ------- + Any + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoveron + # ------- + @property + def hoveron(self): + """ + Sets the hover interaction mode for the parcats diagram. If + `category`, hover interaction take place per category. If + `color`, hover interactions take place per color per category. + If `dimension`, hover interactions take place across all + categories per dimension. + + The 'hoveron' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['category', 'color', 'dimension'] + + Returns + ------- + Any + """ + return self['hoveron'] + + @hoveron.setter + def hoveron(self, val): + self['hoveron'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + variables `count`, `probability`, `category`, `categorycount`, + `colorcount` and `bandcolorcount`. Anything contained in tag + `` is displayed in the secondary box, for example + "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # labelfont + # --------- + @property + 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 plotly.graph_objs.parcats.Labelfont + - A dict of string/value properties that will be passed + to the Labelfont constructor + + Supported dict properties: + + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.parcats.Labelfont + """ + return self['labelfont'] + + @labelfont.setter + def labelfont(self, val): + self['labelfont'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of plotly.graph_objs.parcats.Line + - A dict of string/value properties that will be passed + to the Line constructor + + Supported dict properties: + + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `line.colorscale`. Has an effect + only if in `line.color`is set to a numerical + array. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette + will be chosen according to whether numbers in + the `color` array are all positive, all + negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `line.color`) or the bounds set in + `line.cmin` and `line.cmax` Has an effect only + if in `line.color`is set to a numerical array. + Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `line.color`is set to a + numerical array. Value should have the same + units as in `line.color` and if set, + `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `line.cmin` and/or `line.cmax` to be + equidistant to this point. Has an effect only + if in `line.color`is set to a numerical array. + Value should have the same units as in + `line.color`. Has no effect when `line.cauto` + is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `line.color`is set to a + numerical array. Value should have the same + units as in `line.color` and if set, + `line.cmax` must be set as well. + color + Sets thelinecolor. It accepts either a specific + color or an array of numbers that are mapped to + the colorscale relative to the max and min + values of the array or relative to `line.cmin` + and `line.cmax` if set. + colorbar + plotly.graph_objs.parcats.line.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `line.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`line.cmin` and `line.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + variables `count` and `probability`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". + reversescale + Reverses the color mapping if true. Has an + effect only if in `line.color`is set to a + numerical array. If true, `line.cmin` will + correspond to the last color in the array and + `line.cmax` will correspond to the first color. + shape + Sets the shape of the paths. If `linear`, paths + are composed of straight lines. If `hspline`, + paths are composed of horizontal curved splines + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `line.color`is set to a numerical array. + + Returns + ------- + plotly.graph_objs.parcats.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # sortpaths + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['sortpaths'] + + @sortpaths.setter + def sortpaths(self, val): + self['sortpaths'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.parcats.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.parcats.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # tickfont + # -------- + @property + 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 plotly.graph_objs.parcats.Tickfont + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Supported dict properties: + + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.parcats.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + arrangement + Sets the drag interaction mode for categories and + dimensions. If `perpendicular`, the categories can only + move along a line perpendicular to the paths. If + `freeform`, the categories can freely move on the + plane. If `fixed`, the categories and dimensions are + stationary. + bundlecolors + Sort paths so that like colors are bundled together + within each category. + counts + The number of observations represented by each state. + Defaults to 1 so that each state represents one + observation + countssrc + Sets the source reference on plot.ly for counts . + dimensions + The dimensions (variables) of the parallel categories + diagram. + dimensiondefaults + When used in a template (as + layout.template.data.parcats.dimensiondefaults), sets + the default property values to use for elements of + parcats.dimensions + domain + plotly.graph_objs.parcats.Domain instance or dict with + compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoveron + Sets the hover interaction mode for the parcats + diagram. If `category`, hover interaction take place + per category. If `color`, hover interactions take place + per color per category. If `dimension`, hover + interactions take place across all categories per + dimension. + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variables `count`, `probability`, + `category`, `categorycount`, `colorcount` and + `bandcolorcount`. Anything contained in tag `` + is displayed in the secondary box, for example + "{fullData.name}". + labelfont + Sets the font for the `dimension` labels. + line + plotly.graph_objs.parcats.Line instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + sortpaths + Sets the path sorting algorithm. If `forward`, sort + paths based on dimension categories from left to right. + If `backward`, sort paths based on dimensions + categories from right to left. + stream + plotly.graph_objs.parcats.Stream instance or dict with + compatible properties + tickfont + Sets the font for the `category` labels. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + """ + + def __init__( + self, + arg=None, + arrangement=None, + bundlecolors=None, + counts=None, + countssrc=None, + dimensions=None, + dimensiondefaults=None, + domain=None, + hoverinfo=None, + hoveron=None, + hovertemplate=None, + labelfont=None, + line=None, + name=None, + sortpaths=None, + stream=None, + tickfont=None, + uid=None, + uirevision=None, + visible=None, + **kwargs + ): + """ + Construct a new Parcats object + + Parallel categories diagram for multidimensional categorical + data. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Parcats + arrangement + Sets the drag interaction mode for categories and + dimensions. If `perpendicular`, the categories can only + move along a line perpendicular to the paths. If + `freeform`, the categories can freely move on the + plane. If `fixed`, the categories and dimensions are + stationary. + bundlecolors + Sort paths so that like colors are bundled together + within each category. + counts + The number of observations represented by each state. + Defaults to 1 so that each state represents one + observation + countssrc + Sets the source reference on plot.ly for counts . + dimensions + The dimensions (variables) of the parallel categories + diagram. + dimensiondefaults + When used in a template (as + layout.template.data.parcats.dimensiondefaults), sets + the default property values to use for elements of + parcats.dimensions + domain + plotly.graph_objs.parcats.Domain instance or dict with + compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoveron + Sets the hover interaction mode for the parcats + diagram. If `category`, hover interaction take place + per category. If `color`, hover interactions take place + per color per category. If `dimension`, hover + interactions take place across all categories per + dimension. + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variables `count`, `probability`, + `category`, `categorycount`, `colorcount` and + `bandcolorcount`. Anything contained in tag `` + is displayed in the secondary box, for example + "{fullData.name}". + labelfont + Sets the font for the `dimension` labels. + line + plotly.graph_objs.parcats.Line instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + sortpaths + Sets the path sorting algorithm. If `forward`, sort + paths based on dimension categories from left to right. + If `backward`, sort paths based on dimensions + categories from right to left. + stream + plotly.graph_objs.parcats.Stream instance or dict with + compatible properties + tickfont + Sets the font for the `category` labels. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + + Returns + ------- + Parcats + """ + super(Parcats, self).__init__('parcats') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Parcats +constructor must be a dict or +an instance of plotly.graph_objs.Parcats""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (parcats as v_parcats) + + # Initialize validators + # --------------------- + self._validators['arrangement'] = v_parcats.ArrangementValidator() + self._validators['bundlecolors'] = v_parcats.BundlecolorsValidator() + self._validators['counts'] = v_parcats.CountsValidator() + self._validators['countssrc'] = v_parcats.CountssrcValidator() + self._validators['dimensions'] = v_parcats.DimensionsValidator() + self._validators['dimensiondefaults'] = v_parcats.DimensionValidator() + self._validators['domain'] = v_parcats.DomainValidator() + self._validators['hoverinfo'] = v_parcats.HoverinfoValidator() + self._validators['hoveron'] = v_parcats.HoveronValidator() + self._validators['hovertemplate'] = v_parcats.HovertemplateValidator() + self._validators['labelfont'] = v_parcats.LabelfontValidator() + self._validators['line'] = v_parcats.LineValidator() + self._validators['name'] = v_parcats.NameValidator() + self._validators['sortpaths'] = v_parcats.SortpathsValidator() + self._validators['stream'] = v_parcats.StreamValidator() + self._validators['tickfont'] = v_parcats.TickfontValidator() + self._validators['uid'] = v_parcats.UidValidator() + self._validators['uirevision'] = v_parcats.UirevisionValidator() + self._validators['visible'] = v_parcats.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('arrangement', None) + self['arrangement'] = arrangement if arrangement is not None else _v + _v = arg.pop('bundlecolors', None) + self['bundlecolors'] = bundlecolors if bundlecolors is not None else _v + _v = arg.pop('counts', None) + self['counts'] = counts if counts is not None else _v + _v = arg.pop('countssrc', None) + self['countssrc'] = countssrc if countssrc is not None else _v + _v = arg.pop('dimensions', None) + self['dimensions'] = dimensions if dimensions is not None else _v + _v = arg.pop('dimensiondefaults', None) + self['dimensiondefaults' + ] = dimensiondefaults if dimensiondefaults is not None else _v + _v = arg.pop('domain', None) + self['domain'] = domain if domain is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoveron', None) + self['hoveron'] = hoveron if hoveron is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('labelfont', None) + self['labelfont'] = labelfont if labelfont is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('sortpaths', None) + self['sortpaths'] = sortpaths if sortpaths is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'parcats' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='parcats', val='parcats' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Ohlc(_BaseTraceType): + + # close + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['close'] + + @close.setter + def close(self, val): + self['close'] = val + + # closesrc + # -------- + @property + def closesrc(self): + """ + Sets the source reference on plot.ly for close . + + The 'closesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['closesrc'] + + @closesrc.setter + def closesrc(self, val): + self['closesrc'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # decreasing + # ---------- + @property + def decreasing(self): + """ + The 'decreasing' property is an instance of Decreasing + that may be specified as: + - An instance of plotly.graph_objs.ohlc.Decreasing + - A dict of string/value properties that will be passed + to the Decreasing constructor + + Supported dict properties: + + line + plotly.graph_objs.ohlc.decreasing.Line instance + or dict with compatible properties + + Returns + ------- + plotly.graph_objs.ohlc.Decreasing + """ + return self['decreasing'] + + @decreasing.setter + def decreasing(self, val): + self['decreasing'] = val + + # high + # ---- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['high'] + + @high.setter + def high(self, val): + self['high'] = val + + # highsrc + # ------- + @property + def highsrc(self): + """ + Sets the source reference on plot.ly for high . + + The 'highsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['highsrc'] + + @highsrc.setter + def highsrc(self, val): + self['highsrc'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.ohlc.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + split + Show hover information (open, close, high, low) + in separate labels. + + Returns + ------- + plotly.graph_objs.ohlc.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertext + # --------- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # increasing + # ---------- + @property + def increasing(self): + """ + The 'increasing' property is an instance of Increasing + that may be specified as: + - An instance of plotly.graph_objs.ohlc.Increasing + - A dict of string/value properties that will be passed + to the Increasing constructor + + Supported dict properties: + + line + plotly.graph_objs.ohlc.increasing.Line instance + or dict with compatible properties + + Returns + ------- + plotly.graph_objs.ohlc.Increasing + """ + return self['increasing'] + + @increasing.setter + def increasing(self, val): + self['increasing'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of plotly.graph_objs.ohlc.Line + - A dict of string/value properties that will be passed + to the Line constructor + + Supported dict properties: + + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + Note that this style setting can also be set + per direction via `increasing.line.dash` and + `decreasing.line.dash`. + width + [object Object] Note that this style setting + can also be set per direction via + `increasing.line.width` and + `decreasing.line.width`. + + Returns + ------- + plotly.graph_objs.ohlc.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # low + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['low'] + + @low.setter + def low(self, val): + self['low'] = val + + # lowsrc + # ------ + @property + def lowsrc(self): + """ + Sets the source reference on plot.ly for low . + + The 'lowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['lowsrc'] + + @lowsrc.setter + def lowsrc(self, val): + self['lowsrc'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # open + # ---- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['open'] + + @open.setter + def open(self, val): + self['open'] = val + + # opensrc + # ------- + @property + def opensrc(self): + """ + Sets the source reference on plot.ly for open . + + The 'opensrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['opensrc'] + + @opensrc.setter + def opensrc(self, val): + self['opensrc'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.ohlc.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.ohlc.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + def text(self): + """ + Sets hover text elements associated with each sample point. If + a single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + this trace's sample points. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # xcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['xcalendar'] + + @xcalendar.setter + def xcalendar(self, val): + self['xcalendar'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + close + Sets the close values. + closesrc + Sets the source reference on plot.ly for close . + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + decreasing + plotly.graph_objs.ohlc.Decreasing instance or dict with + compatible properties + high + Sets the high values. + highsrc + Sets the source reference on plot.ly for high . + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.ohlc.Hoverlabel instance or dict with + compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + increasing + plotly.graph_objs.ohlc.Increasing instance or dict with + compatible properties + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.ohlc.Line instance or dict with + compatible properties + low + Sets the low values. + lowsrc + Sets the source reference on plot.ly for low . + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + open + Sets the open values. + opensrc + Sets the source reference on plot.ly for open . + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.ohlc.Stream instance or dict with + compatible properties + text + Sets hover text elements associated with each sample + point. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to this trace's sample points. + textsrc + Sets the source reference on plot.ly for text . + tickwidth + Sets the width of the open/close tick marks relative to + the "x" minimal interval. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. If absent, linear coordinate + will be generated. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + """ + + def __init__( + self, + arg=None, + close=None, + closesrc=None, + customdata=None, + customdatasrc=None, + decreasing=None, + high=None, + highsrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + increasing=None, + legendgroup=None, + line=None, + low=None, + lowsrc=None, + name=None, + opacity=None, + open=None, + opensrc=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textsrc=None, + tickwidth=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xcalendar=None, + xsrc=None, + yaxis=None, + **kwargs + ): + """ + Construct a new Ohlc object + + The ohlc (short for Open-High-Low-Close) is a style of + financial chart describing open, high, low and close for a + given `x` coordinate (most likely time). The tip of the lines + represent the `low` and `high` values and the horizontal + segments represent the `open` and `close` values. Sample points + where the close value is higher (lower) then the open value are + called increasing (decreasing). By default, increasing items + are drawn in green whereas decreasing are drawn in red. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Ohlc + close + Sets the close values. + closesrc + Sets the source reference on plot.ly for close . + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + decreasing + plotly.graph_objs.ohlc.Decreasing instance or dict with + compatible properties + high + Sets the high values. + highsrc + Sets the source reference on plot.ly for high . + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.ohlc.Hoverlabel instance or dict with + compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + increasing + plotly.graph_objs.ohlc.Increasing instance or dict with + compatible properties + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.ohlc.Line instance or dict with + compatible properties + low + Sets the low values. + lowsrc + Sets the source reference on plot.ly for low . + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + open + Sets the open values. + opensrc + Sets the source reference on plot.ly for open . + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.ohlc.Stream instance or dict with + compatible properties + text + Sets hover text elements associated with each sample + point. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to this trace's sample points. + textsrc + Sets the source reference on plot.ly for text . + tickwidth + Sets the width of the open/close tick marks relative to + the "x" minimal interval. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. If absent, linear coordinate + will be generated. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + + Returns + ------- + Ohlc + """ + super(Ohlc, self).__init__('ohlc') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Ohlc +constructor must be a dict or +an instance of plotly.graph_objs.Ohlc""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (ohlc as v_ohlc) + + # Initialize validators + # --------------------- + self._validators['close'] = v_ohlc.CloseValidator() + self._validators['closesrc'] = v_ohlc.ClosesrcValidator() + self._validators['customdata'] = v_ohlc.CustomdataValidator() + self._validators['customdatasrc'] = v_ohlc.CustomdatasrcValidator() + self._validators['decreasing'] = v_ohlc.DecreasingValidator() + self._validators['high'] = v_ohlc.HighValidator() + self._validators['highsrc'] = v_ohlc.HighsrcValidator() + self._validators['hoverinfo'] = v_ohlc.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_ohlc.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_ohlc.HoverlabelValidator() + self._validators['hovertext'] = v_ohlc.HovertextValidator() + self._validators['hovertextsrc'] = v_ohlc.HovertextsrcValidator() + self._validators['ids'] = v_ohlc.IdsValidator() + self._validators['idssrc'] = v_ohlc.IdssrcValidator() + self._validators['increasing'] = v_ohlc.IncreasingValidator() + self._validators['legendgroup'] = v_ohlc.LegendgroupValidator() + self._validators['line'] = v_ohlc.LineValidator() + self._validators['low'] = v_ohlc.LowValidator() + self._validators['lowsrc'] = v_ohlc.LowsrcValidator() + self._validators['name'] = v_ohlc.NameValidator() + self._validators['opacity'] = v_ohlc.OpacityValidator() + self._validators['open'] = v_ohlc.OpenValidator() + self._validators['opensrc'] = v_ohlc.OpensrcValidator() + self._validators['selectedpoints'] = v_ohlc.SelectedpointsValidator() + self._validators['showlegend'] = v_ohlc.ShowlegendValidator() + self._validators['stream'] = v_ohlc.StreamValidator() + self._validators['text'] = v_ohlc.TextValidator() + self._validators['textsrc'] = v_ohlc.TextsrcValidator() + self._validators['tickwidth'] = v_ohlc.TickwidthValidator() + self._validators['uid'] = v_ohlc.UidValidator() + self._validators['uirevision'] = v_ohlc.UirevisionValidator() + self._validators['visible'] = v_ohlc.VisibleValidator() + self._validators['x'] = v_ohlc.XValidator() + self._validators['xaxis'] = v_ohlc.XAxisValidator() + self._validators['xcalendar'] = v_ohlc.XcalendarValidator() + self._validators['xsrc'] = v_ohlc.XsrcValidator() + self._validators['yaxis'] = v_ohlc.YAxisValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('close', None) + self['close'] = close if close is not None else _v + _v = arg.pop('closesrc', None) + self['closesrc'] = closesrc if closesrc is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('decreasing', None) + self['decreasing'] = decreasing if decreasing is not None else _v + _v = arg.pop('high', None) + self['high'] = high if high is not None else _v + _v = arg.pop('highsrc', None) + self['highsrc'] = highsrc if highsrc is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('increasing', None) + self['increasing'] = increasing if increasing is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('low', None) + self['low'] = low if low is not None else _v + _v = arg.pop('lowsrc', None) + self['lowsrc'] = lowsrc if lowsrc is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('open', None) + self['open'] = open if open is not None else _v + _v = arg.pop('opensrc', None) + self['opensrc'] = opensrc if opensrc is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('xcalendar', None) + self['xcalendar'] = xcalendar if xcalendar is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'ohlc' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='ohlc', val='ohlc' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Mesh3d(_BaseTraceType): + + # alphahull + # --------- + @property + def alphahull(self): + """ + Determines how the mesh surface triangles are derived from the + set of vertices (points) represented by the `x`, `y` and `z` + arrays, if the `i`, `j`, `k` arrays are not supplied. For + general use of `mesh3d` it is preferred that `i`, `j`, `k` are + supplied. If "-1", Delaunay triangulation is used, which is + mainly suitable if the mesh is a single, more or less layer + surface that is perpendicular to `delaunayaxis`. In case the + `delaunayaxis` intersects the mesh surface at more than one + point it will result triangles that are very long in the + dimension of `delaunayaxis`. If ">0", the alpha-shape algorithm + is used. In this case, the positive `alphahull` value signals + the use of the alpha-shape algorithm, _and_ its value acts as + the parameter for the mesh fitting. If 0, the convex-hull + algorithm is used. It is suitable for convex bodies or if the + intention is to enclose the `x`, `y` and `z` point set into a + convex hull. + + The 'alphahull' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['alphahull'] + + @alphahull.setter + def alphahull(self, val): + self['alphahull'] = val + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here `intensity`) or the bounds set + in `cmin` and `cmax` Defaults to `false` when `cmin` and + `cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + 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 `intensity`. Has no effect when `cauto` is + `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to mesh3d.colorscale + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of plotly.graph_objs.mesh3d.ColorBar + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Supported dict properties: + + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.mesh3d.colorbar.Tickformatsto + p instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.mesh3d.colorbar.tickformatstopdefaults), sets + the default property values to use for elements + of mesh3d.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.mesh3d.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + mesh3d.colorbar.title.font instead. Sets this + color bar's title font. Note that the title's + font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use + mesh3d.colorbar.title.side instead. Determines + the location of color bar's title with respect + to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.mesh3d.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. The colorscale must be an array containing + arrays mapping a normalized value to an rgb, rgba, hex, hsl, + hsv, or named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # contour + # ------- + @property + def contour(self): + """ + The 'contour' property is an instance of Contour + that may be specified as: + - An instance of plotly.graph_objs.mesh3d.Contour + - A dict of string/value properties that will be passed + to the Contour constructor + + Supported dict properties: + + color + Sets the color of the contour lines. + show + Sets whether or not dynamic contours are shown + on hover + width + Sets the width of the contour lines. + + Returns + ------- + plotly.graph_objs.mesh3d.Contour + """ + return self['contour'] + + @contour.setter + def contour(self, val): + self['contour'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # delaunayaxis + # ------------ + @property + def delaunayaxis(self): + """ + Sets the Delaunay axis, which is the axis that is perpendicular + to the surface of the Delaunay triangulation. It has an effect + if `i`, `j`, `k` are not provided and `alphahull` is set to + indicate Delaunay triangulation. + + The 'delaunayaxis' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['x', 'y', 'z'] + + Returns + ------- + Any + """ + return self['delaunayaxis'] + + @delaunayaxis.setter + def delaunayaxis(self, val): + self['delaunayaxis'] = val + + # facecolor + # --------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['facecolor'] + + @facecolor.setter + def facecolor(self, val): + self['facecolor'] = val + + # facecolorsrc + # ------------ + @property + def facecolorsrc(self): + """ + Sets the source reference on plot.ly for facecolor . + + The 'facecolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['facecolorsrc'] + + @facecolorsrc.setter + def facecolorsrc(self, val): + self['facecolorsrc'] = val + + # flatshading + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['flatshading'] + + @flatshading.setter + def flatshading(self, val): + self['flatshading'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.mesh3d.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.mesh3d.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # i + # - + @property + def i(self): + """ + A vector of vertex indices, i.e. integer values between 0 and + the length of the vertex vectors, representing the "first" + vertex of a triangle. For example, `{i[m], j[m], k[m]}` + together represent face m (triangle m) in the mesh, where `i[m] + = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex + arrays. Therefore, each element in `i` represents a point in + space, which is the first vertex of a triangle. + + The 'i' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['i'] + + @i.setter + def i(self, val): + self['i'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # intensity + # --------- + @property + def intensity(self): + """ + Sets the vertex intensity values, used for plotting fields on + meshes + + The 'intensity' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['intensity'] + + @intensity.setter + def intensity(self, val): + self['intensity'] = val + + # intensitysrc + # ------------ + @property + def intensitysrc(self): + """ + Sets the source reference on plot.ly for intensity . + + The 'intensitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['intensitysrc'] + + @intensitysrc.setter + def intensitysrc(self, val): + self['intensitysrc'] = val + + # isrc + # ---- + @property + def isrc(self): + """ + Sets the source reference on plot.ly for i . + + The 'isrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['isrc'] + + @isrc.setter + def isrc(self, val): + self['isrc'] = val + + # j + # - + @property + def j(self): + """ + A vector of vertex indices, i.e. integer values between 0 and + the length of the vertex vectors, representing the "second" + vertex of a triangle. For example, `{i[m], j[m], k[m]}` + together represent face m (triangle m) in the mesh, where `j[m] + = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex + arrays. Therefore, each element in `j` represents a point in + space, which is the second vertex of a triangle. + + The 'j' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['j'] + + @j.setter + def j(self, val): + self['j'] = val + + # jsrc + # ---- + @property + def jsrc(self): + """ + Sets the source reference on plot.ly for j . + + The 'jsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['jsrc'] + + @jsrc.setter + def jsrc(self, val): + self['jsrc'] = val + + # k + # - + @property + def k(self): + """ + A vector of vertex indices, i.e. integer values between 0 and + the length of the vertex vectors, representing the "third" + vertex of a triangle. For example, `{i[m], j[m], k[m]}` + together represent face m (triangle m) in the mesh, where `k[m] + = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex + arrays. Therefore, each element in `k` represents a point in + space, which is the third vertex of a triangle. + + The 'k' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['k'] + + @k.setter + def k(self, val): + self['k'] = val + + # ksrc + # ---- + @property + def ksrc(self): + """ + Sets the source reference on plot.ly for k . + + The 'ksrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ksrc'] + + @ksrc.setter + def ksrc(self, val): + self['ksrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # lighting + # -------- + @property + def lighting(self): + """ + The 'lighting' property is an instance of Lighting + that may be specified as: + - An instance of plotly.graph_objs.mesh3d.Lighting + - A dict of string/value properties that will be passed + to the Lighting constructor + + Supported dict properties: + + ambient + Ambient light increases overall color + visibility but can wash out the image. + diffuse + Represents the extent that incident rays are + reflected in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids + math issues arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of + the viewing angle; e.g. paper is reflective + when viewing it from the edge of the paper + (almost 90 degrees), causing shine. + roughness + Alters specular reflection; the rougher the + surface, the wider and less contrasty the + shine. + specular + Represents the level that incident rays are + reflected in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids + math issues arising from degenerate geometry. + + Returns + ------- + plotly.graph_objs.mesh3d.Lighting + """ + return self['lighting'] + + @lighting.setter + def lighting(self, val): + self['lighting'] = val + + # lightposition + # ------------- + @property + def lightposition(self): + """ + The 'lightposition' property is an instance of Lightposition + that may be specified as: + - An instance of plotly.graph_objs.mesh3d.Lightposition + - A dict of string/value properties that will be passed + to the Lightposition constructor + + Supported dict properties: + + x + Numeric vector, representing the X coordinate + for each vertex. + y + Numeric vector, representing the Y coordinate + for each vertex. + z + Numeric vector, representing the Z coordinate + for each vertex. + + Returns + ------- + plotly.graph_objs.mesh3d.Lightposition + """ + return self['lightposition'] + + @lightposition.setter + def lightposition(self, val): + self['lightposition'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + def opacity(self): + """ + Sets the opacity of the surface. Please note that in the case + of using high `opacity` values for example a value greater than + or equal to 0.5 on two surfaces (and 0.25 with four surfaces), + an overlay of multiple transparent surfaces may not perfectly + be sorted in depth by the webgl API. This behavior may be + improved in the near future and is subject to change. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # reversescale + # ------------ + @property + 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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # scene + # ----- + @property + def scene(self): + """ + Sets a reference between this trace's 3D coordinate system and + a 3D scene. If "scene" (the default value), the (x,y,z) + coordinates refer to `layout.scene`. If "scene2", the (x,y,z) + coordinates refer to `layout.scene2`, and so on. + + The 'scene' property is an identifier of a particular + subplot, of type 'scene', that may be specified as the string 'scene' + optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + + Returns + ------- + str + """ + return self['scene'] + + @scene.setter + def scene(self, val): + self['scene'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.mesh3d.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.mesh3d.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # vertexcolor + # ----------- + @property + def vertexcolor(self): + """ + Sets the color of each vertex Overrides "color". + + The 'vertexcolor' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['vertexcolor'] + + @vertexcolor.setter + def vertexcolor(self, val): + self['vertexcolor'] = val + + # vertexcolorsrc + # -------------- + @property + def vertexcolorsrc(self): + """ + Sets the source reference on plot.ly for vertexcolor . + + The 'vertexcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['vertexcolorsrc'] + + @vertexcolorsrc.setter + def vertexcolorsrc(self, val): + self['vertexcolorsrc'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['xcalendar'] + + @xcalendar.setter + def xcalendar(self, val): + self['xcalendar'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # ycalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['ycalendar'] + + @ycalendar.setter + def ycalendar(self, val): + self['ycalendar'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # z + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # zcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['zcalendar'] + + @zcalendar.setter + def zcalendar(self, val): + self['zcalendar'] = val + + # zsrc + # ---- + @property + def zsrc(self): + """ + Sets the source reference on plot.ly for z . + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['zsrc'] + + @zsrc.setter + def zsrc(self, val): + self['zsrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + alphahull + Determines how the mesh surface triangles are derived + from the set of vertices (points) represented by the + `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays + are not supplied. For general use of `mesh3d` it is + preferred that `i`, `j`, `k` are supplied. If "-1", + Delaunay triangulation is used, which is mainly + suitable if the mesh is a single, more or less layer + surface that is perpendicular to `delaunayaxis`. In + case the `delaunayaxis` intersects the mesh surface at + more than one point it will result triangles that are + very long in the dimension of `delaunayaxis`. If ">0", + the alpha-shape algorithm is used. In this case, the + positive `alphahull` value signals the use of the + alpha-shape algorithm, _and_ its value acts as the + parameter for the mesh fitting. If 0, the convex-hull + algorithm is used. It is suitable for convex bodies or + if the intention is to enclose the `x`, `y` and `z` + point set into a convex hull. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here `intensity`) or + the bounds set in `cmin` and `cmax` Defaults to + `false` when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as `intensity` and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as `intensity`. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as `intensity` and if set, `cmax` + must be set as well. + color + Sets the color of the whole mesh + colorbar + plotly.graph_objs.mesh3d.ColorBar instance or dict with + compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + contour + plotly.graph_objs.mesh3d.Contour instance or dict with + compatible properties + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + delaunayaxis + Sets the Delaunay axis, which is the axis that is + perpendicular to the surface of the Delaunay + triangulation. It has an effect if `i`, `j`, `k` are + not provided and `alphahull` is set to indicate + Delaunay triangulation. + facecolor + Sets the color of each face Overrides "color" and + "vertexcolor". + facecolorsrc + Sets the source reference on plot.ly for facecolor . + flatshading + Determines whether or not normal smoothing is applied + to the meshes, creating meshes with an angular, low- + poly look via flat reflections. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.mesh3d.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + i + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "first" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `i[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `i` represents a point in space, which + is the first vertex of a triangle. + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + intensity + Sets the vertex intensity values, used for plotting + fields on meshes + intensitysrc + Sets the source reference on plot.ly for intensity . + isrc + Sets the source reference on plot.ly for i . + j + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "second" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `j[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `j` represents a point in space, which + is the second vertex of a triangle. + jsrc + Sets the source reference on plot.ly for j . + k + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "third" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `k[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `k` represents a point in space, which + is the third vertex of a triangle. + ksrc + Sets the source reference on plot.ly for k . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + lighting + plotly.graph_objs.mesh3d.Lighting instance or dict with + compatible properties + lightposition + plotly.graph_objs.mesh3d.Lightposition instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.mesh3d.Stream instance or dict with + compatible properties + text + Sets the text elements associated with the vertices. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + vertexcolor + Sets the color of each vertex Overrides "color". + vertexcolorsrc + Sets the source reference on plot.ly for vertexcolor . + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the X coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the Y coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the Z coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + zcalendar + Sets the calendar system to use with `z` date data. + zsrc + Sets the source reference on plot.ly for z . + """ + + def __init__( + self, + arg=None, + alphahull=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorbar=None, + colorscale=None, + contour=None, + customdata=None, + customdatasrc=None, + delaunayaxis=None, + facecolor=None, + facecolorsrc=None, + flatshading=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + i=None, + ids=None, + idssrc=None, + intensity=None, + intensitysrc=None, + isrc=None, + j=None, + jsrc=None, + k=None, + ksrc=None, + legendgroup=None, + lighting=None, + lightposition=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + selectedpoints=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + vertexcolor=None, + vertexcolorsrc=None, + visible=None, + x=None, + xcalendar=None, + xsrc=None, + y=None, + ycalendar=None, + ysrc=None, + z=None, + zcalendar=None, + zsrc=None, + **kwargs + ): + """ + Construct a new Mesh3d object + + Draws sets of triangles with coordinates given by three + 1-dimensional arrays in `x`, `y`, `z` and (1) a sets of `i`, + `j`, `k` indices (2) Delaunay triangulation or (3) the Alpha- + shape algorithm or (4) the Convex-hull algorithm + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Mesh3d + alphahull + Determines how the mesh surface triangles are derived + from the set of vertices (points) represented by the + `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays + are not supplied. For general use of `mesh3d` it is + preferred that `i`, `j`, `k` are supplied. If "-1", + Delaunay triangulation is used, which is mainly + suitable if the mesh is a single, more or less layer + surface that is perpendicular to `delaunayaxis`. In + case the `delaunayaxis` intersects the mesh surface at + more than one point it will result triangles that are + very long in the dimension of `delaunayaxis`. If ">0", + the alpha-shape algorithm is used. In this case, the + positive `alphahull` value signals the use of the + alpha-shape algorithm, _and_ its value acts as the + parameter for the mesh fitting. If 0, the convex-hull + algorithm is used. It is suitable for convex bodies or + if the intention is to enclose the `x`, `y` and `z` + point set into a convex hull. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here `intensity`) or + the bounds set in `cmin` and `cmax` Defaults to + `false` when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as `intensity` and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as `intensity`. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as `intensity` and if set, `cmax` + must be set as well. + color + Sets the color of the whole mesh + colorbar + plotly.graph_objs.mesh3d.ColorBar instance or dict with + compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + contour + plotly.graph_objs.mesh3d.Contour instance or dict with + compatible properties + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + delaunayaxis + Sets the Delaunay axis, which is the axis that is + perpendicular to the surface of the Delaunay + triangulation. It has an effect if `i`, `j`, `k` are + not provided and `alphahull` is set to indicate + Delaunay triangulation. + facecolor + Sets the color of each face Overrides "color" and + "vertexcolor". + facecolorsrc + Sets the source reference on plot.ly for facecolor . + flatshading + Determines whether or not normal smoothing is applied + to the meshes, creating meshes with an angular, low- + poly look via flat reflections. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.mesh3d.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + i + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "first" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `i[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `i` represents a point in space, which + is the first vertex of a triangle. + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + intensity + Sets the vertex intensity values, used for plotting + fields on meshes + intensitysrc + Sets the source reference on plot.ly for intensity . + isrc + Sets the source reference on plot.ly for i . + j + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "second" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `j[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `j` represents a point in space, which + is the second vertex of a triangle. + jsrc + Sets the source reference on plot.ly for j . + k + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "third" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `k[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `k` represents a point in space, which + is the third vertex of a triangle. + ksrc + Sets the source reference on plot.ly for k . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + lighting + plotly.graph_objs.mesh3d.Lighting instance or dict with + compatible properties + lightposition + plotly.graph_objs.mesh3d.Lightposition instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.mesh3d.Stream instance or dict with + compatible properties + text + Sets the text elements associated with the vertices. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + vertexcolor + Sets the color of each vertex Overrides "color". + vertexcolorsrc + Sets the source reference on plot.ly for vertexcolor . + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the X coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the Y coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the Z coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + zcalendar + Sets the calendar system to use with `z` date data. + zsrc + Sets the source reference on plot.ly for z . + + Returns + ------- + Mesh3d + """ + super(Mesh3d, self).__init__('mesh3d') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Mesh3d +constructor must be a dict or +an instance of plotly.graph_objs.Mesh3d""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (mesh3d as v_mesh3d) + + # Initialize validators + # --------------------- + self._validators['alphahull'] = v_mesh3d.AlphahullValidator() + self._validators['autocolorscale'] = v_mesh3d.AutocolorscaleValidator() + self._validators['cauto'] = v_mesh3d.CautoValidator() + self._validators['cmax'] = v_mesh3d.CmaxValidator() + self._validators['cmid'] = v_mesh3d.CmidValidator() + self._validators['cmin'] = v_mesh3d.CminValidator() + self._validators['color'] = v_mesh3d.ColorValidator() + self._validators['colorbar'] = v_mesh3d.ColorBarValidator() + self._validators['colorscale'] = v_mesh3d.ColorscaleValidator() + self._validators['contour'] = v_mesh3d.ContourValidator() + self._validators['customdata'] = v_mesh3d.CustomdataValidator() + self._validators['customdatasrc'] = v_mesh3d.CustomdatasrcValidator() + self._validators['delaunayaxis'] = v_mesh3d.DelaunayaxisValidator() + self._validators['facecolor'] = v_mesh3d.FacecolorValidator() + self._validators['facecolorsrc'] = v_mesh3d.FacecolorsrcValidator() + self._validators['flatshading'] = v_mesh3d.FlatshadingValidator() + self._validators['hoverinfo'] = v_mesh3d.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_mesh3d.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_mesh3d.HoverlabelValidator() + self._validators['hovertemplate'] = v_mesh3d.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_mesh3d.HovertemplatesrcValidator() + self._validators['hovertext'] = v_mesh3d.HovertextValidator() + self._validators['hovertextsrc'] = v_mesh3d.HovertextsrcValidator() + self._validators['i'] = v_mesh3d.IValidator() + self._validators['ids'] = v_mesh3d.IdsValidator() + self._validators['idssrc'] = v_mesh3d.IdssrcValidator() + self._validators['intensity'] = v_mesh3d.IntensityValidator() + self._validators['intensitysrc'] = v_mesh3d.IntensitysrcValidator() + self._validators['isrc'] = v_mesh3d.IsrcValidator() + self._validators['j'] = v_mesh3d.JValidator() + self._validators['jsrc'] = v_mesh3d.JsrcValidator() + self._validators['k'] = v_mesh3d.KValidator() + self._validators['ksrc'] = v_mesh3d.KsrcValidator() + self._validators['legendgroup'] = v_mesh3d.LegendgroupValidator() + self._validators['lighting'] = v_mesh3d.LightingValidator() + self._validators['lightposition'] = v_mesh3d.LightpositionValidator() + self._validators['name'] = v_mesh3d.NameValidator() + self._validators['opacity'] = v_mesh3d.OpacityValidator() + self._validators['reversescale'] = v_mesh3d.ReversescaleValidator() + self._validators['scene'] = v_mesh3d.SceneValidator() + self._validators['selectedpoints'] = v_mesh3d.SelectedpointsValidator() + self._validators['showlegend'] = v_mesh3d.ShowlegendValidator() + self._validators['showscale'] = v_mesh3d.ShowscaleValidator() + self._validators['stream'] = v_mesh3d.StreamValidator() + self._validators['text'] = v_mesh3d.TextValidator() + self._validators['textsrc'] = v_mesh3d.TextsrcValidator() + self._validators['uid'] = v_mesh3d.UidValidator() + self._validators['uirevision'] = v_mesh3d.UirevisionValidator() + self._validators['vertexcolor'] = v_mesh3d.VertexcolorValidator() + self._validators['vertexcolorsrc'] = v_mesh3d.VertexcolorsrcValidator() + self._validators['visible'] = v_mesh3d.VisibleValidator() + self._validators['x'] = v_mesh3d.XValidator() + self._validators['xcalendar'] = v_mesh3d.XcalendarValidator() + self._validators['xsrc'] = v_mesh3d.XsrcValidator() + self._validators['y'] = v_mesh3d.YValidator() + self._validators['ycalendar'] = v_mesh3d.YcalendarValidator() + self._validators['ysrc'] = v_mesh3d.YsrcValidator() + self._validators['z'] = v_mesh3d.ZValidator() + self._validators['zcalendar'] = v_mesh3d.ZcalendarValidator() + self._validators['zsrc'] = v_mesh3d.ZsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('alphahull', None) + self['alphahull'] = alphahull if alphahull is not None else _v + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('contour', None) + self['contour'] = contour if contour is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('delaunayaxis', None) + self['delaunayaxis'] = delaunayaxis if delaunayaxis is not None else _v + _v = arg.pop('facecolor', None) + self['facecolor'] = facecolor if facecolor is not None else _v + _v = arg.pop('facecolorsrc', None) + self['facecolorsrc'] = facecolorsrc if facecolorsrc is not None else _v + _v = arg.pop('flatshading', None) + self['flatshading'] = flatshading if flatshading is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('i', None) + self['i'] = i if i is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('intensity', None) + self['intensity'] = intensity if intensity is not None else _v + _v = arg.pop('intensitysrc', None) + self['intensitysrc'] = intensitysrc if intensitysrc is not None else _v + _v = arg.pop('isrc', None) + self['isrc'] = isrc if isrc is not None else _v + _v = arg.pop('j', None) + self['j'] = j if j is not None else _v + _v = arg.pop('jsrc', None) + self['jsrc'] = jsrc if jsrc is not None else _v + _v = arg.pop('k', None) + self['k'] = k if k is not None else _v + _v = arg.pop('ksrc', None) + self['ksrc'] = ksrc if ksrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('lighting', None) + self['lighting'] = lighting if lighting is not None else _v + _v = arg.pop('lightposition', None) + self['lightposition' + ] = lightposition if lightposition is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('scene', None) + self['scene'] = scene if scene is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('vertexcolor', None) + self['vertexcolor'] = vertexcolor if vertexcolor is not None else _v + _v = arg.pop('vertexcolorsrc', None) + self['vertexcolorsrc' + ] = vertexcolorsrc if vertexcolorsrc is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xcalendar', None) + self['xcalendar'] = xcalendar if xcalendar is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('ycalendar', None) + self['ycalendar'] = ycalendar if ycalendar is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + _v = arg.pop('zcalendar', None) + self['zcalendar'] = zcalendar if zcalendar is not None else _v + _v = arg.pop('zsrc', None) + self['zsrc'] = zsrc if zsrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'mesh3d' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='mesh3d', val='mesh3d' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Isosurface(_BaseTraceType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # caps + # ---- + @property + def caps(self): + """ + The 'caps' property is an instance of Caps + that may be specified as: + - An instance of plotly.graph_objs.isosurface.Caps + - A dict of string/value properties that will be passed + to the Caps constructor + + Supported dict properties: + + x + plotly.graph_objs.isosurface.caps.X instance or + dict with compatible properties + y + plotly.graph_objs.isosurface.caps.Y instance or + dict with compatible properties + z + plotly.graph_objs.isosurface.caps.Z instance or + dict with compatible properties + + Returns + ------- + plotly.graph_objs.isosurface.Caps + """ + return self['caps'] + + @caps.setter + def caps(self, val): + self['caps'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here `value`) or the bounds set in + `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` + are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of plotly.graph_objs.isosurface.ColorBar + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Supported dict properties: + + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.isosurface.colorbar.Tickforma + tstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.isosurface.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of isosurface.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.isosurface.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + isosurface.colorbar.title.font instead. Sets + this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + isosurface.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.isosurface.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. The colorscale must be an array containing + arrays mapping a normalized value to an rgb, rgba, hex, hsl, + hsv, or named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # contour + # ------- + @property + def contour(self): + """ + The 'contour' property is an instance of Contour + that may be specified as: + - An instance of plotly.graph_objs.isosurface.Contour + - A dict of string/value properties that will be passed + to the Contour constructor + + Supported dict properties: + + color + Sets the color of the contour lines. + show + Sets whether or not dynamic contours are shown + on hover + width + Sets the width of the contour lines. + + Returns + ------- + plotly.graph_objs.isosurface.Contour + """ + return self['contour'] + + @contour.setter + def contour(self, val): + self['contour'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # flatshading + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['flatshading'] + + @flatshading.setter + def flatshading(self, val): + self['flatshading'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.isosurface.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.isosurface.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # isomax + # ------ + @property + 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 + + Returns + ------- + int|float + """ + return self['isomax'] + + @isomax.setter + def isomax(self, val): + self['isomax'] = val + + # isomin + # ------ + @property + 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 + + Returns + ------- + int|float + """ + return self['isomin'] + + @isomin.setter + def isomin(self, val): + self['isomin'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # lighting + # -------- + @property + def lighting(self): + """ + The 'lighting' property is an instance of Lighting + that may be specified as: + - An instance of plotly.graph_objs.isosurface.Lighting + - A dict of string/value properties that will be passed + to the Lighting constructor + + Supported dict properties: + + ambient + Ambient light increases overall color + visibility but can wash out the image. + diffuse + Represents the extent that incident rays are + reflected in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids + math issues arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of + the viewing angle; e.g. paper is reflective + when viewing it from the edge of the paper + (almost 90 degrees), causing shine. + roughness + Alters specular reflection; the rougher the + surface, the wider and less contrasty the + shine. + specular + Represents the level that incident rays are + reflected in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids + math issues arising from degenerate geometry. + + Returns + ------- + plotly.graph_objs.isosurface.Lighting + """ + return self['lighting'] + + @lighting.setter + def lighting(self, val): + self['lighting'] = val + + # lightposition + # ------------- + @property + def lightposition(self): + """ + The 'lightposition' property is an instance of Lightposition + that may be specified as: + - An instance of plotly.graph_objs.isosurface.Lightposition + - A dict of string/value properties that will be passed + to the Lightposition constructor + + Supported dict properties: + + x + Numeric vector, representing the X coordinate + for each vertex. + y + Numeric vector, representing the Y coordinate + for each vertex. + z + Numeric vector, representing the Z coordinate + for each vertex. + + Returns + ------- + plotly.graph_objs.isosurface.Lightposition + """ + return self['lightposition'] + + @lightposition.setter + def lightposition(self, val): + self['lightposition'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + def opacity(self): + """ + Sets the opacity of the surface. Please note that in the case + of using high `opacity` values for example a value greater than + or equal to 0.5 on two surfaces (and 0.25 with four surfaces), + an overlay of multiple transparent surfaces may not perfectly + be sorted in depth by the webgl API. This behavior may be + improved in the near future and is subject to change. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # reversescale + # ------------ + @property + 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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # scene + # ----- + @property + def scene(self): + """ + Sets a reference between this trace's 3D coordinate system and + a 3D scene. If "scene" (the default value), the (x,y,z) + coordinates refer to `layout.scene`. If "scene2", the (x,y,z) + coordinates refer to `layout.scene2`, and so on. + + The 'scene' property is an identifier of a particular + subplot, of type 'scene', that may be specified as the string 'scene' + optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + + Returns + ------- + str + """ + return self['scene'] + + @scene.setter + def scene(self, val): + self['scene'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # slices + # ------ + @property + def slices(self): + """ + The 'slices' property is an instance of Slices + that may be specified as: + - An instance of plotly.graph_objs.isosurface.Slices + - A dict of string/value properties that will be passed + to the Slices constructor + + Supported dict properties: + + x + plotly.graph_objs.isosurface.slices.X instance + or dict with compatible properties + y + plotly.graph_objs.isosurface.slices.Y instance + or dict with compatible properties + z + plotly.graph_objs.isosurface.slices.Z instance + or dict with compatible properties + + Returns + ------- + plotly.graph_objs.isosurface.Slices + """ + return self['slices'] + + @slices.setter + def slices(self, val): + self['slices'] = val + + # spaceframe + # ---------- + @property + def spaceframe(self): + """ + The 'spaceframe' property is an instance of Spaceframe + that may be specified as: + - An instance of plotly.graph_objs.isosurface.Spaceframe + - A dict of string/value properties that will be passed + to the Spaceframe constructor + + Supported dict properties: + + fill + Sets the fill ratio of the `spaceframe` + elements. The default fill value is 0.15 + meaning that only 15% of the area of every + faces of tetras would be shaded. Applying a + greater `fill` ratio would allow the creation + of stronger elements or could be sued to have + entirely closed areas (in case of using 1). + show + Displays/hides tetrahedron shapes between + minimum and maximum iso-values. Often useful + when either caps or surfaces are disabled or + filled with values less than 1. + + Returns + ------- + plotly.graph_objs.isosurface.Spaceframe + """ + return self['spaceframe'] + + @spaceframe.setter + def spaceframe(self, val): + self['spaceframe'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.isosurface.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.isosurface.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # surface + # ------- + @property + def surface(self): + """ + The 'surface' property is an instance of Surface + that may be specified as: + - An instance of plotly.graph_objs.isosurface.Surface + - A dict of string/value properties that will be passed + to the Surface constructor + + Supported dict properties: + + count + Sets the number of iso-surfaces between minimum + and maximum iso-values. By default this value + is 2 meaning that only minimum and maximum + surfaces would be drawn. + fill + Sets the fill ratio of the iso-surface. The + default fill value of the surface is 1 meaning + that they are entirely shaded. On the other + hand Applying a `fill` ratio less than one + would allow the creation of openings parallel + to the edges. + pattern + Sets the surface pattern of the iso-surface 3-D + sections. The default pattern of the surface is + `all` meaning that the rest of surface elements + would be shaded. The check options (either 1 or + 2) could be used to draw half of the squares on + the surface. Using various combinations of + capital `A`, `B`, `C`, `D` and `E` may also be + used to reduce the number of triangles on the + iso-surfaces and creating other patterns of + interest. + show + Hides/displays surfaces between minimum and + maximum iso-values. + + Returns + ------- + plotly.graph_objs.isosurface.Surface + """ + return self['surface'] + + @surface.setter + def surface(self, val): + self['surface'] = val + + # text + # ---- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # valuesrc + # -------- + @property + def valuesrc(self): + """ + Sets the source reference on plot.ly for value . + + The 'valuesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['valuesrc'] + + @valuesrc.setter + def valuesrc(self, val): + self['valuesrc'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # z + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # zsrc + # ---- + @property + def zsrc(self): + """ + Sets the source reference on plot.ly for z . + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['zsrc'] + + @zsrc.setter + def zsrc(self, val): + self['zsrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + caps + plotly.graph_objs.isosurface.Caps instance or dict with + compatible properties + cauto + Determines whether or not the color domain is computed + with respect to the input data (here `value`) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as `value` and if set, `cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as `value`. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as `value` and if set, `cmax` must + be set as well. + colorbar + plotly.graph_objs.isosurface.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + contour + plotly.graph_objs.isosurface.Contour instance or dict + with compatible properties + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + flatshading + Determines whether or not normal smoothing is applied + to the meshes, creating meshes with an angular, low- + poly look via flat reflections. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.isosurface.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + isomax + Sets the maximum boundary for iso-surface plot. + isomin + Sets the minimum boundary for iso-surface plot. + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + lighting + plotly.graph_objs.isosurface.Lighting instance or dict + with compatible properties + lightposition + plotly.graph_objs.isosurface.Lightposition instance or + dict with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + slices + plotly.graph_objs.isosurface.Slices instance or dict + with compatible properties + spaceframe + plotly.graph_objs.isosurface.Spaceframe instance or + dict with compatible properties + stream + plotly.graph_objs.isosurface.Stream instance or dict + with compatible properties + surface + plotly.graph_objs.isosurface.Surface instance or dict + with compatible properties + text + Sets the text elements associated with the vertices. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + value + Sets the 4th dimension (value) of the vertices. + valuesrc + Sets the source reference on plot.ly for value . + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the X coordinates of the vertices on X axis. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the Y coordinates of the vertices on Y axis. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the Z coordinates of the vertices on Z axis. + zsrc + Sets the source reference on plot.ly for z . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + caps=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + colorbar=None, + colorscale=None, + contour=None, + customdata=None, + customdatasrc=None, + flatshading=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + isomax=None, + isomin=None, + legendgroup=None, + lighting=None, + lightposition=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + selectedpoints=None, + showlegend=None, + showscale=None, + slices=None, + spaceframe=None, + stream=None, + surface=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + value=None, + valuesrc=None, + visible=None, + x=None, + xsrc=None, + y=None, + ysrc=None, + z=None, + zsrc=None, + **kwargs + ): + """ + Construct a new Isosurface object + + Draws isosurfaces between iso-min and iso-max values with + coordinates given by four 1-dimensional arrays containing the + `value`, `x`, `y` and `z` of every vertex of a uniform or non- + uniform 3-D grid. Horizontal or vertical slices, caps as well + as spaceframe between iso-min and iso-max values could also be + drawn using this trace. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Isosurface + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + caps + plotly.graph_objs.isosurface.Caps instance or dict with + compatible properties + cauto + Determines whether or not the color domain is computed + with respect to the input data (here `value`) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as `value` and if set, `cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as `value`. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as `value` and if set, `cmax` must + be set as well. + colorbar + plotly.graph_objs.isosurface.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + contour + plotly.graph_objs.isosurface.Contour instance or dict + with compatible properties + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + flatshading + Determines whether or not normal smoothing is applied + to the meshes, creating meshes with an angular, low- + poly look via flat reflections. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.isosurface.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + isomax + Sets the maximum boundary for iso-surface plot. + isomin + Sets the minimum boundary for iso-surface plot. + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + lighting + plotly.graph_objs.isosurface.Lighting instance or dict + with compatible properties + lightposition + plotly.graph_objs.isosurface.Lightposition instance or + dict with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + slices + plotly.graph_objs.isosurface.Slices instance or dict + with compatible properties + spaceframe + plotly.graph_objs.isosurface.Spaceframe instance or + dict with compatible properties + stream + plotly.graph_objs.isosurface.Stream instance or dict + with compatible properties + surface + plotly.graph_objs.isosurface.Surface instance or dict + with compatible properties + text + Sets the text elements associated with the vertices. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + value + Sets the 4th dimension (value) of the vertices. + valuesrc + Sets the source reference on plot.ly for value . + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the X coordinates of the vertices on X axis. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the Y coordinates of the vertices on Y axis. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the Z coordinates of the vertices on Z axis. + zsrc + Sets the source reference on plot.ly for z . + + Returns + ------- + Isosurface + """ + super(Isosurface, self).__init__('isosurface') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Isosurface +constructor must be a dict or +an instance of plotly.graph_objs.Isosurface""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (isosurface as v_isosurface) + + # Initialize validators + # --------------------- + self._validators['autocolorscale' + ] = v_isosurface.AutocolorscaleValidator() + self._validators['caps'] = v_isosurface.CapsValidator() + self._validators['cauto'] = v_isosurface.CautoValidator() + self._validators['cmax'] = v_isosurface.CmaxValidator() + self._validators['cmid'] = v_isosurface.CmidValidator() + self._validators['cmin'] = v_isosurface.CminValidator() + self._validators['colorbar'] = v_isosurface.ColorBarValidator() + self._validators['colorscale'] = v_isosurface.ColorscaleValidator() + self._validators['contour'] = v_isosurface.ContourValidator() + self._validators['customdata'] = v_isosurface.CustomdataValidator() + self._validators['customdatasrc' + ] = v_isosurface.CustomdatasrcValidator() + self._validators['flatshading'] = v_isosurface.FlatshadingValidator() + self._validators['hoverinfo'] = v_isosurface.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_isosurface.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_isosurface.HoverlabelValidator() + self._validators['hovertemplate' + ] = v_isosurface.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_isosurface.HovertemplatesrcValidator() + self._validators['hovertext'] = v_isosurface.HovertextValidator() + self._validators['hovertextsrc'] = v_isosurface.HovertextsrcValidator() + self._validators['ids'] = v_isosurface.IdsValidator() + self._validators['idssrc'] = v_isosurface.IdssrcValidator() + self._validators['isomax'] = v_isosurface.IsomaxValidator() + self._validators['isomin'] = v_isosurface.IsominValidator() + self._validators['legendgroup'] = v_isosurface.LegendgroupValidator() + self._validators['lighting'] = v_isosurface.LightingValidator() + self._validators['lightposition' + ] = v_isosurface.LightpositionValidator() + self._validators['name'] = v_isosurface.NameValidator() + self._validators['opacity'] = v_isosurface.OpacityValidator() + self._validators['reversescale'] = v_isosurface.ReversescaleValidator() + self._validators['scene'] = v_isosurface.SceneValidator() + self._validators['selectedpoints' + ] = v_isosurface.SelectedpointsValidator() + self._validators['showlegend'] = v_isosurface.ShowlegendValidator() + self._validators['showscale'] = v_isosurface.ShowscaleValidator() + self._validators['slices'] = v_isosurface.SlicesValidator() + self._validators['spaceframe'] = v_isosurface.SpaceframeValidator() + self._validators['stream'] = v_isosurface.StreamValidator() + self._validators['surface'] = v_isosurface.SurfaceValidator() + self._validators['text'] = v_isosurface.TextValidator() + self._validators['textsrc'] = v_isosurface.TextsrcValidator() + self._validators['uid'] = v_isosurface.UidValidator() + self._validators['uirevision'] = v_isosurface.UirevisionValidator() + self._validators['value'] = v_isosurface.ValueValidator() + self._validators['valuesrc'] = v_isosurface.ValuesrcValidator() + self._validators['visible'] = v_isosurface.VisibleValidator() + self._validators['x'] = v_isosurface.XValidator() + self._validators['xsrc'] = v_isosurface.XsrcValidator() + self._validators['y'] = v_isosurface.YValidator() + self._validators['ysrc'] = v_isosurface.YsrcValidator() + self._validators['z'] = v_isosurface.ZValidator() + self._validators['zsrc'] = v_isosurface.ZsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('caps', None) + self['caps'] = caps if caps is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('contour', None) + self['contour'] = contour if contour is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('flatshading', None) + self['flatshading'] = flatshading if flatshading is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('isomax', None) + self['isomax'] = isomax if isomax is not None else _v + _v = arg.pop('isomin', None) + self['isomin'] = isomin if isomin is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('lighting', None) + self['lighting'] = lighting if lighting is not None else _v + _v = arg.pop('lightposition', None) + self['lightposition' + ] = lightposition if lightposition is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('scene', None) + self['scene'] = scene if scene is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('slices', None) + self['slices'] = slices if slices is not None else _v + _v = arg.pop('spaceframe', None) + self['spaceframe'] = spaceframe if spaceframe is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('surface', None) + self['surface'] = surface if surface is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + _v = arg.pop('valuesrc', None) + self['valuesrc'] = valuesrc if valuesrc is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + _v = arg.pop('zsrc', None) + self['zsrc'] = zsrc if zsrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'isosurface' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='isosurface', val='isosurface' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Histogram2dContour(_BaseTraceType): + + # autobinx + # -------- + @property + def autobinx(self): + """ + Obsolete: since v1.42 each bin attribute is auto-determined + separately and `autobinx` is not needed. However, we accept + `autobinx: true` or `false` and will update `xbins` accordingly + before deleting `autobinx` from the trace. + + The 'autobinx' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autobinx'] + + @autobinx.setter + def autobinx(self, val): + self['autobinx'] = val + + # autobiny + # -------- + @property + def autobiny(self): + """ + Obsolete: since v1.42 each bin attribute is auto-determined + separately and `autobiny` is not needed. However, we accept + `autobiny: true` or `false` and will update `ybins` accordingly + before deleting `autobiny` from the trace. + + The 'autobiny' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autobiny'] + + @autobiny.setter + def autobiny(self, val): + self['autobiny'] = val + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # autocontour + # ----------- + @property + def autocontour(self): + """ + Determines whether or not the contour level attributes are + picked by an algorithm. If True, the number of contour levels + can be set in `ncontours`. If False, set the contour level + attributes in `contours`. + + The 'autocontour' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocontour'] + + @autocontour.setter + def autocontour(self, val): + self['autocontour'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of plotly.graph_objs.histogram2dcontour.ColorBar + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Supported dict properties: + + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.histogram2dcontour.colorbar.T + ickformatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.histogram2dcontour.colorbar.tickformatstopdef + aults), sets the default property values to use + for elements of + histogram2dcontour.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.histogram2dcontour.colorbar.T + itle instance or dict with compatible + properties + titlefont + Deprecated: Please use + histogram2dcontour.colorbar.title.font instead. + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + histogram2dcontour.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.histogram2dcontour.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. The colorscale must be an array containing + arrays mapping a normalized value to an rgb, rgba, hex, hsl, + hsv, or named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # contours + # -------- + @property + def contours(self): + """ + The 'contours' property is an instance of Contours + that may be specified as: + - An instance of plotly.graph_objs.histogram2dcontour.Contours + - A dict of string/value properties that will be passed + to the Contours constructor + + Supported dict properties: + + coloring + Determines the coloring method showing the + contour values. If "fill", coloring is done + evenly between each contour level If "heatmap", + a heatmap gradient coloring is applied between + each contour level. If "lines", coloring is + done on the contour lines. If "none", no + coloring is applied on this trace. + end + Sets the end contour level value. Must be more + than `contours.start` + labelfont + Sets the font used for labeling the contour + levels. The default color comes from the lines, + if shown. The default family and size come from + `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-language which is very similar + to Python, see: https://github.com/d3/d3-format + /blob/master/README.md#locale_format. + operation + Sets the constraint operation. "=" keeps + regions equal to `value` "<" and "<=" keep + regions less than `value` ">" and ">=" keep + regions greater than `value` "[]", "()", "[)", + and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions + outside `value[0]` to value[1]` Open vs. closed + intervals make no difference to constraint + display, but all versions are allowed for + consistency with filter transforms. + showlabels + Determines whether to label the contour lines + with their values. + showlines + Determines whether or not the contour lines are + drawn. Has an effect only if + `contours.coloring` is set to "fill". + size + Sets the step between each contour level. Must + be positive. + start + Sets the starting contour level value. Must be + less than `contours.end` + type + If `levels`, the data is represented as a + contour plot with multiple levels displayed. If + `constraint`, the data is represented as + constraints with the invalid region shaded as + specified by the `operation` and `value` + parameters. + value + Sets the value or values of the constraint + boundary. When `operation` is set to one of the + comparison values (=,<,>=,>,<=) "value" is + expected to be a number. When `operation` is + set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected + to be an array of two numbers where the first + is the lower bound and the second is the upper + bound. + + Returns + ------- + plotly.graph_objs.histogram2dcontour.Contours + """ + return self['contours'] + + @contours.setter + def contours(self, val): + self['contours'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # histfunc + # -------- + @property + def histfunc(self): + """ + Specifies the binning function used for this histogram trace. + If "count", the histogram values are computed by counting the + number of values lying inside each bin. If "sum", "avg", "min", + "max", the histogram values are computed using the sum, the + average, the minimum or the maximum of the values lying inside + each bin respectively. + + The 'histfunc' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['count', 'sum', 'avg', 'min', 'max'] + + Returns + ------- + Any + """ + return self['histfunc'] + + @histfunc.setter + def histfunc(self, val): + self['histfunc'] = val + + # histnorm + # -------- + @property + def histnorm(self): + """ + Specifies the type of normalization used for this histogram + trace. If "", the span of each bar corresponds to the number of + occurrences (i.e. the number of data points lying inside the + bins). If "percent" / "probability", the span of each bar + corresponds to the percentage / fraction of occurrences with + respect to the total number of sample points (here, the sum of + all bin HEIGHTS equals 100% / 1). If "density", the span of + each bar corresponds to the number of occurrences in a bin + divided by the size of the bin interval (here, the sum of all + bin AREAS equals the total number of sample points). If + *probability density*, the area of each bar corresponds to the + probability that an event will fall into the corresponding bin + (here, the sum of all bin AREAS equals 1). + + The 'histnorm' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', 'percent', 'probability', 'density', 'probability + density'] + + Returns + ------- + Any + """ + return self['histnorm'] + + @histnorm.setter + def histnorm(self, val): + self['histnorm'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.histogram2dcontour.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.histogram2dcontour.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + variable `z` Anything contained in tag `` is displayed + in the secondary box, for example + "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of plotly.graph_objs.histogram2dcontour.Line + - A dict of string/value properties that will be passed + to the Line constructor + + Supported dict properties: + + color + Sets the color of the contour level. Has no + effect if `contours.coloring` is set to + "lines". + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour + lines, where 0 corresponds to no smoothing. + width + Sets the line width (in px). + + Returns + ------- + plotly.graph_objs.histogram2dcontour.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of plotly.graph_objs.histogram2dcontour.Marker + - A dict of string/value properties that will be passed + to the Marker constructor + + Supported dict properties: + + color + Sets the aggregation data. + colorsrc + Sets the source reference on plot.ly for color + . + + Returns + ------- + plotly.graph_objs.histogram2dcontour.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # nbinsx + # ------ + @property + def nbinsx(self): + """ + Specifies the maximum number of desired bins. This value will + be used in an algorithm that will decide the optimal bin size + such that the histogram best visualizes the distribution of the + data. Ignored if `xbins.size` is provided. + + The 'nbinsx' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['nbinsx'] + + @nbinsx.setter + def nbinsx(self, val): + self['nbinsx'] = val + + # nbinsy + # ------ + @property + def nbinsy(self): + """ + Specifies the maximum number of desired bins. This value will + be used in an algorithm that will decide the optimal bin size + such that the histogram best visualizes the distribution of the + data. Ignored if `ybins.size` is provided. + + The 'nbinsy' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['nbinsy'] + + @nbinsy.setter + def nbinsy(self, val): + self['nbinsy'] = val + + # ncontours + # --------- + @property + def ncontours(self): + """ + Sets the maximum number of contour levels. The actual number of + contours will be chosen automatically to be less than or equal + to the value of `ncontours`. Has an effect only if + `autocontour` is True or if `contours.size` is missing. + + The 'ncontours' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self['ncontours'] + + @ncontours.setter + def ncontours(self, val): + self['ncontours'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # reversescale + # ------------ + @property + 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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.histogram2dcontour.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.histogram2dcontour.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # xbins + # ----- + @property + def xbins(self): + """ + The 'xbins' property is an instance of XBins + that may be specified as: + - An instance of plotly.graph_objs.histogram2dcontour.XBins + - A dict of string/value properties that will be passed + to the XBins constructor + + Supported dict properties: + + end + Sets the end value for the x axis bins. The + last bin may not end exactly at this value, we + increment the bin edge by `size` from `start` + until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use + a date string, and for category data `end` is + based on the category serial numbers. + size + Sets the size of each x axis bin. Default + behavior: If `nbinsx` is 0 or omitted, we + choose a nice round bin size such that the + number of bins is about the same as the typical + number of samples in each bin. If `nbinsx` is + provided, we choose a nice round bin size + giving no more than that many bins. For date + data, use milliseconds or "M" for months, as + in `axis.dtick`. For category data, the number + of categories to bin together (always defaults + to 1). + start + Sets the starting value for the x axis bins. + Defaults to the minimum data value, shifted + down if necessary to make nice round values and + to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin + edges 0.5 down, so a `size` of 5 would have a + default `start` of -0.5, so it is clear that + 0-4 are in the first bin, 5-9 in the second, + but continuous data gets a start of 0 and bins + [0,5), [5,10) etc. Dates behave similarly, and + `start` should be a date string. For category + data, `start` is based on the category serial + numbers, and defaults to -0.5. + + Returns + ------- + plotly.graph_objs.histogram2dcontour.XBins + """ + return self['xbins'] + + @xbins.setter + def xbins(self, val): + self['xbins'] = val + + # xcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['xcalendar'] + + @xcalendar.setter + def xcalendar(self, val): + self['xcalendar'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # ybins + # ----- + @property + def ybins(self): + """ + The 'ybins' property is an instance of YBins + that may be specified as: + - An instance of plotly.graph_objs.histogram2dcontour.YBins + - A dict of string/value properties that will be passed + to the YBins constructor + + Supported dict properties: + + end + Sets the end value for the y axis bins. The + last bin may not end exactly at this value, we + increment the bin edge by `size` from `start` + until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use + a date string, and for category data `end` is + based on the category serial numbers. + size + Sets the size of each y axis bin. Default + behavior: If `nbinsy` is 0 or omitted, we + choose a nice round bin size such that the + number of bins is about the same as the typical + number of samples in each bin. If `nbinsy` is + provided, we choose a nice round bin size + giving no more than that many bins. For date + data, use milliseconds or "M" for months, as + in `axis.dtick`. For category data, the number + of categories to bin together (always defaults + to 1). + start + Sets the starting value for the y axis bins. + Defaults to the minimum data value, shifted + down if necessary to make nice round values and + to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin + edges 0.5 down, so a `size` of 5 would have a + default `start` of -0.5, so it is clear that + 0-4 are in the first bin, 5-9 in the second, + but continuous data gets a start of 0 and bins + [0,5), [5,10) etc. Dates behave similarly, and + `start` should be a date string. For category + data, `start` is based on the category serial + numbers, and defaults to -0.5. + + Returns + ------- + plotly.graph_objs.histogram2dcontour.YBins + """ + return self['ybins'] + + @ybins.setter + def ybins(self, val): + self['ybins'] = val + + # ycalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['ycalendar'] + + @ycalendar.setter + def ycalendar(self, val): + self['ycalendar'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # z + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # zauto + # ----- + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['zauto'] + + @zauto.setter + def zauto(self, val): + self['zauto'] = val + + # zhoverformat + # ------------ + @property + def zhoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. See: https + ://github.com/d3/d3-format/blob/master/README.md#locale_format + + The 'zhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['zhoverformat'] + + @zhoverformat.setter + def zhoverformat(self, val): + self['zhoverformat'] = val + + # zmax + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmax'] + + @zmax.setter + def zmax(self, val): + self['zmax'] = val + + # zmid + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmid'] + + @zmid.setter + def zmid(self, val): + self['zmid'] = val + + # zmin + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmin'] + + @zmin.setter + def zmin(self, val): + self['zmin'] = val + + # zsrc + # ---- + @property + def zsrc(self): + """ + Sets the source reference on plot.ly for z . + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['zsrc'] + + @zsrc.setter + def zsrc(self, val): + self['zsrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + colorbar + plotly.graph_objs.histogram2dcontour.ColorBar instance + or dict with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + contours + plotly.graph_objs.histogram2dcontour.Contours instance + or dict with compatible properties + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + histfunc + Specifies the binning function used for this histogram + trace. If "count", the histogram values are computed by + counting the number of values lying inside each bin. If + "sum", "avg", "min", "max", the histogram values are + computed using the sum, the average, the minimum or the + maximum of the values lying inside each bin + respectively. + histnorm + Specifies the type of normalization used for this + histogram trace. If "", the span of each bar + corresponds to the number of occurrences (i.e. the + number of data points lying inside the bins). If + "percent" / "probability", the span of each bar + corresponds to the percentage / fraction of occurrences + with respect to the total number of sample points + (here, the sum of all bin HEIGHTS equals 100% / 1). If + "density", the span of each bar corresponds to the + number of occurrences in a bin divided by the size of + the bin interval (here, the sum of all bin AREAS equals + the total number of sample points). If *probability + density*, the area of each bar corresponds to the + probability that an event will fall into the + corresponding bin (here, the sum of all bin AREAS + equals 1). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.histogram2dcontour.Hoverlabel + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variable `z` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.histogram2dcontour.Line instance or + dict with compatible properties + marker + plotly.graph_objs.histogram2dcontour.Marker instance or + dict with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + nbinsx + Specifies the maximum number of desired bins. This + value will be used in an algorithm that will decide the + optimal bin size such that the histogram best + visualizes the distribution of the data. Ignored if + `xbins.size` is provided. + nbinsy + Specifies the maximum number of desired bins. This + value will be used in an algorithm that will decide the + optimal bin size such that the histogram best + visualizes the distribution of the data. Ignored if + `ybins.size` is provided. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.histogram2dcontour.Stream instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the sample data to be binned on the x axis. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbins + plotly.graph_objs.histogram2dcontour.XBins instance or + dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the sample data to be binned on the y axis. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybins + plotly.graph_objs.histogram2dcontour.YBins instance or + dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the aggregation data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. See: https://github.com/d3/d3-format/blob/maste + r/README.md#locale_format + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on plot.ly for z . + """ + + def __init__( + self, + arg=None, + autobinx=None, + autobiny=None, + autocolorscale=None, + autocontour=None, + colorbar=None, + colorscale=None, + contours=None, + customdata=None, + customdatasrc=None, + histfunc=None, + histnorm=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + ids=None, + idssrc=None, + legendgroup=None, + line=None, + marker=None, + name=None, + nbinsx=None, + nbinsy=None, + ncontours=None, + opacity=None, + reversescale=None, + selectedpoints=None, + showlegend=None, + showscale=None, + stream=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xbins=None, + xcalendar=None, + xsrc=None, + y=None, + yaxis=None, + ybins=None, + ycalendar=None, + ysrc=None, + z=None, + zauto=None, + zhoverformat=None, + zmax=None, + zmid=None, + zmin=None, + zsrc=None, + **kwargs + ): + """ + Construct a new Histogram2dContour object + + The sample data from which statistics are computed is set in + `x` and `y` (where `x` and `y` represent marginal + distributions, binning is set in `xbins` and `ybins` in this + case) or `z` (where `z` represent the 2D distribution and + binning set, binning is set by `x` and `y` in this case). The + resulting distribution is visualized as a contour plot. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Histogram2dContour + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + colorbar + plotly.graph_objs.histogram2dcontour.ColorBar instance + or dict with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + contours + plotly.graph_objs.histogram2dcontour.Contours instance + or dict with compatible properties + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + histfunc + Specifies the binning function used for this histogram + trace. If "count", the histogram values are computed by + counting the number of values lying inside each bin. If + "sum", "avg", "min", "max", the histogram values are + computed using the sum, the average, the minimum or the + maximum of the values lying inside each bin + respectively. + histnorm + Specifies the type of normalization used for this + histogram trace. If "", the span of each bar + corresponds to the number of occurrences (i.e. the + number of data points lying inside the bins). If + "percent" / "probability", the span of each bar + corresponds to the percentage / fraction of occurrences + with respect to the total number of sample points + (here, the sum of all bin HEIGHTS equals 100% / 1). If + "density", the span of each bar corresponds to the + number of occurrences in a bin divided by the size of + the bin interval (here, the sum of all bin AREAS equals + the total number of sample points). If *probability + density*, the area of each bar corresponds to the + probability that an event will fall into the + corresponding bin (here, the sum of all bin AREAS + equals 1). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.histogram2dcontour.Hoverlabel + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variable `z` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.histogram2dcontour.Line instance or + dict with compatible properties + marker + plotly.graph_objs.histogram2dcontour.Marker instance or + dict with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + nbinsx + Specifies the maximum number of desired bins. This + value will be used in an algorithm that will decide the + optimal bin size such that the histogram best + visualizes the distribution of the data. Ignored if + `xbins.size` is provided. + nbinsy + Specifies the maximum number of desired bins. This + value will be used in an algorithm that will decide the + optimal bin size such that the histogram best + visualizes the distribution of the data. Ignored if + `ybins.size` is provided. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.histogram2dcontour.Stream instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the sample data to be binned on the x axis. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbins + plotly.graph_objs.histogram2dcontour.XBins instance or + dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the sample data to be binned on the y axis. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybins + plotly.graph_objs.histogram2dcontour.YBins instance or + dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the aggregation data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. See: https://github.com/d3/d3-format/blob/maste + r/README.md#locale_format + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on plot.ly for z . + + Returns + ------- + Histogram2dContour + """ + super(Histogram2dContour, self).__init__('histogram2dcontour') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Histogram2dContour +constructor must be a dict or +an instance of plotly.graph_objs.Histogram2dContour""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import ( + histogram2dcontour as v_histogram2dcontour + ) + + # Initialize validators + # --------------------- + self._validators['autobinx'] = v_histogram2dcontour.AutobinxValidator() + self._validators['autobiny'] = v_histogram2dcontour.AutobinyValidator() + self._validators['autocolorscale' + ] = v_histogram2dcontour.AutocolorscaleValidator() + self._validators['autocontour' + ] = v_histogram2dcontour.AutocontourValidator() + self._validators['colorbar'] = v_histogram2dcontour.ColorBarValidator() + self._validators['colorscale' + ] = v_histogram2dcontour.ColorscaleValidator() + self._validators['contours'] = v_histogram2dcontour.ContoursValidator() + self._validators['customdata' + ] = v_histogram2dcontour.CustomdataValidator() + self._validators['customdatasrc' + ] = v_histogram2dcontour.CustomdatasrcValidator() + self._validators['histfunc'] = v_histogram2dcontour.HistfuncValidator() + self._validators['histnorm'] = v_histogram2dcontour.HistnormValidator() + self._validators['hoverinfo' + ] = v_histogram2dcontour.HoverinfoValidator() + self._validators['hoverinfosrc' + ] = v_histogram2dcontour.HoverinfosrcValidator() + self._validators['hoverlabel' + ] = v_histogram2dcontour.HoverlabelValidator() + self._validators['hovertemplate' + ] = v_histogram2dcontour.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_histogram2dcontour.HovertemplatesrcValidator() + self._validators['ids'] = v_histogram2dcontour.IdsValidator() + self._validators['idssrc'] = v_histogram2dcontour.IdssrcValidator() + self._validators['legendgroup' + ] = v_histogram2dcontour.LegendgroupValidator() + self._validators['line'] = v_histogram2dcontour.LineValidator() + self._validators['marker'] = v_histogram2dcontour.MarkerValidator() + self._validators['name'] = v_histogram2dcontour.NameValidator() + self._validators['nbinsx'] = v_histogram2dcontour.NbinsxValidator() + self._validators['nbinsy'] = v_histogram2dcontour.NbinsyValidator() + self._validators['ncontours' + ] = v_histogram2dcontour.NcontoursValidator() + self._validators['opacity'] = v_histogram2dcontour.OpacityValidator() + self._validators['reversescale' + ] = v_histogram2dcontour.ReversescaleValidator() + self._validators['selectedpoints' + ] = v_histogram2dcontour.SelectedpointsValidator() + self._validators['showlegend' + ] = v_histogram2dcontour.ShowlegendValidator() + self._validators['showscale' + ] = v_histogram2dcontour.ShowscaleValidator() + self._validators['stream'] = v_histogram2dcontour.StreamValidator() + self._validators['uid'] = v_histogram2dcontour.UidValidator() + self._validators['uirevision' + ] = v_histogram2dcontour.UirevisionValidator() + self._validators['visible'] = v_histogram2dcontour.VisibleValidator() + self._validators['x'] = v_histogram2dcontour.XValidator() + self._validators['xaxis'] = v_histogram2dcontour.XAxisValidator() + self._validators['xbins'] = v_histogram2dcontour.XBinsValidator() + self._validators['xcalendar' + ] = v_histogram2dcontour.XcalendarValidator() + self._validators['xsrc'] = v_histogram2dcontour.XsrcValidator() + self._validators['y'] = v_histogram2dcontour.YValidator() + self._validators['yaxis'] = v_histogram2dcontour.YAxisValidator() + self._validators['ybins'] = v_histogram2dcontour.YBinsValidator() + self._validators['ycalendar' + ] = v_histogram2dcontour.YcalendarValidator() + self._validators['ysrc'] = v_histogram2dcontour.YsrcValidator() + self._validators['z'] = v_histogram2dcontour.ZValidator() + self._validators['zauto'] = v_histogram2dcontour.ZautoValidator() + self._validators['zhoverformat' + ] = v_histogram2dcontour.ZhoverformatValidator() + self._validators['zmax'] = v_histogram2dcontour.ZmaxValidator() + self._validators['zmid'] = v_histogram2dcontour.ZmidValidator() + self._validators['zmin'] = v_histogram2dcontour.ZminValidator() + self._validators['zsrc'] = v_histogram2dcontour.ZsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autobinx', None) + self['autobinx'] = autobinx if autobinx is not None else _v + _v = arg.pop('autobiny', None) + self['autobiny'] = autobiny if autobiny is not None else _v + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('autocontour', None) + self['autocontour'] = autocontour if autocontour is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('contours', None) + self['contours'] = contours if contours is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('histfunc', None) + self['histfunc'] = histfunc if histfunc is not None else _v + _v = arg.pop('histnorm', None) + self['histnorm'] = histnorm if histnorm is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('nbinsx', None) + self['nbinsx'] = nbinsx if nbinsx is not None else _v + _v = arg.pop('nbinsy', None) + self['nbinsy'] = nbinsy if nbinsy is not None else _v + _v = arg.pop('ncontours', None) + self['ncontours'] = ncontours if ncontours is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('xbins', None) + self['xbins'] = xbins if xbins is not None else _v + _v = arg.pop('xcalendar', None) + self['xcalendar'] = xcalendar if xcalendar is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + _v = arg.pop('ybins', None) + self['ybins'] = ybins if ybins is not None else _v + _v = arg.pop('ycalendar', None) + self['ycalendar'] = ycalendar if ycalendar is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + _v = arg.pop('zauto', None) + self['zauto'] = zauto if zauto is not None else _v + _v = arg.pop('zhoverformat', None) + self['zhoverformat'] = zhoverformat if zhoverformat is not None else _v + _v = arg.pop('zmax', None) + self['zmax'] = zmax if zmax is not None else _v + _v = arg.pop('zmid', None) + self['zmid'] = zmid if zmid is not None else _v + _v = arg.pop('zmin', None) + self['zmin'] = zmin if zmin is not None else _v + _v = arg.pop('zsrc', None) + self['zsrc'] = zsrc if zsrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'histogram2dcontour' + self._validators['type'] = LiteralValidator( + plotly_name='type', + parent_name='histogram2dcontour', + val='histogram2dcontour' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Histogram2d(_BaseTraceType): + + # autobinx + # -------- + @property + def autobinx(self): + """ + Obsolete: since v1.42 each bin attribute is auto-determined + separately and `autobinx` is not needed. However, we accept + `autobinx: true` or `false` and will update `xbins` accordingly + before deleting `autobinx` from the trace. + + The 'autobinx' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autobinx'] + + @autobinx.setter + def autobinx(self, val): + self['autobinx'] = val + + # autobiny + # -------- + @property + def autobiny(self): + """ + Obsolete: since v1.42 each bin attribute is auto-determined + separately and `autobiny` is not needed. However, we accept + `autobiny: true` or `false` and will update `ybins` accordingly + before deleting `autobiny` from the trace. + + The 'autobiny' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autobiny'] + + @autobiny.setter + def autobiny(self, val): + self['autobiny'] = val + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of plotly.graph_objs.histogram2d.ColorBar + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Supported dict properties: + + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.histogram2d.colorbar.Tickform + atstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.histogram2d.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of + histogram2d.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.histogram2d.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + histogram2d.colorbar.title.font instead. Sets + this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + histogram2d.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.histogram2d.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. The colorscale must be an array containing + arrays mapping a normalized value to an rgb, rgba, hex, hsl, + hsv, or named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # histfunc + # -------- + @property + def histfunc(self): + """ + Specifies the binning function used for this histogram trace. + If "count", the histogram values are computed by counting the + number of values lying inside each bin. If "sum", "avg", "min", + "max", the histogram values are computed using the sum, the + average, the minimum or the maximum of the values lying inside + each bin respectively. + + The 'histfunc' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['count', 'sum', 'avg', 'min', 'max'] + + Returns + ------- + Any + """ + return self['histfunc'] + + @histfunc.setter + def histfunc(self, val): + self['histfunc'] = val + + # histnorm + # -------- + @property + def histnorm(self): + """ + Specifies the type of normalization used for this histogram + trace. If "", the span of each bar corresponds to the number of + occurrences (i.e. the number of data points lying inside the + bins). If "percent" / "probability", the span of each bar + corresponds to the percentage / fraction of occurrences with + respect to the total number of sample points (here, the sum of + all bin HEIGHTS equals 100% / 1). If "density", the span of + each bar corresponds to the number of occurrences in a bin + divided by the size of the bin interval (here, the sum of all + bin AREAS equals the total number of sample points). If + *probability density*, the area of each bar corresponds to the + probability that an event will fall into the corresponding bin + (here, the sum of all bin AREAS equals 1). + + The 'histnorm' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', 'percent', 'probability', 'density', 'probability + density'] + + Returns + ------- + Any + """ + return self['histnorm'] + + @histnorm.setter + def histnorm(self, val): + self['histnorm'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.histogram2d.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.histogram2d.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + variable `z` Anything contained in tag `` is displayed + in the secondary box, for example + "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of plotly.graph_objs.histogram2d.Marker + - A dict of string/value properties that will be passed + to the Marker constructor + + Supported dict properties: + + color + Sets the aggregation data. + colorsrc + Sets the source reference on plot.ly for color + . + + Returns + ------- + plotly.graph_objs.histogram2d.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # nbinsx + # ------ + @property + def nbinsx(self): + """ + Specifies the maximum number of desired bins. This value will + be used in an algorithm that will decide the optimal bin size + such that the histogram best visualizes the distribution of the + data. Ignored if `xbins.size` is provided. + + The 'nbinsx' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['nbinsx'] + + @nbinsx.setter + def nbinsx(self, val): + self['nbinsx'] = val + + # nbinsy + # ------ + @property + def nbinsy(self): + """ + Specifies the maximum number of desired bins. This value will + be used in an algorithm that will decide the optimal bin size + such that the histogram best visualizes the distribution of the + data. Ignored if `ybins.size` is provided. + + The 'nbinsy' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['nbinsy'] + + @nbinsy.setter + def nbinsy(self, val): + self['nbinsy'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # reversescale + # ------------ + @property + 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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.histogram2d.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.histogram2d.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # xbins + # ----- + @property + def xbins(self): + """ + The 'xbins' property is an instance of XBins + that may be specified as: + - An instance of plotly.graph_objs.histogram2d.XBins + - A dict of string/value properties that will be passed + to the XBins constructor + + Supported dict properties: + + end + Sets the end value for the x axis bins. The + last bin may not end exactly at this value, we + increment the bin edge by `size` from `start` + until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use + a date string, and for category data `end` is + based on the category serial numbers. + size + Sets the size of each x axis bin. Default + behavior: If `nbinsx` is 0 or omitted, we + choose a nice round bin size such that the + number of bins is about the same as the typical + number of samples in each bin. If `nbinsx` is + provided, we choose a nice round bin size + giving no more than that many bins. For date + data, use milliseconds or "M" for months, as + in `axis.dtick`. For category data, the number + of categories to bin together (always defaults + to 1). + start + Sets the starting value for the x axis bins. + Defaults to the minimum data value, shifted + down if necessary to make nice round values and + to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin + edges 0.5 down, so a `size` of 5 would have a + default `start` of -0.5, so it is clear that + 0-4 are in the first bin, 5-9 in the second, + but continuous data gets a start of 0 and bins + [0,5), [5,10) etc. Dates behave similarly, and + `start` should be a date string. For category + data, `start` is based on the category serial + numbers, and defaults to -0.5. + + Returns + ------- + plotly.graph_objs.histogram2d.XBins + """ + return self['xbins'] + + @xbins.setter + def xbins(self, val): + self['xbins'] = val + + # xcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['xcalendar'] + + @xcalendar.setter + def xcalendar(self, val): + self['xcalendar'] = val + + # xgap + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xgap'] + + @xgap.setter + def xgap(self, val): + self['xgap'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # ybins + # ----- + @property + def ybins(self): + """ + The 'ybins' property is an instance of YBins + that may be specified as: + - An instance of plotly.graph_objs.histogram2d.YBins + - A dict of string/value properties that will be passed + to the YBins constructor + + Supported dict properties: + + end + Sets the end value for the y axis bins. The + last bin may not end exactly at this value, we + increment the bin edge by `size` from `start` + until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use + a date string, and for category data `end` is + based on the category serial numbers. + size + Sets the size of each y axis bin. Default + behavior: If `nbinsy` is 0 or omitted, we + choose a nice round bin size such that the + number of bins is about the same as the typical + number of samples in each bin. If `nbinsy` is + provided, we choose a nice round bin size + giving no more than that many bins. For date + data, use milliseconds or "M" for months, as + in `axis.dtick`. For category data, the number + of categories to bin together (always defaults + to 1). + start + Sets the starting value for the y axis bins. + Defaults to the minimum data value, shifted + down if necessary to make nice round values and + to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin + edges 0.5 down, so a `size` of 5 would have a + default `start` of -0.5, so it is clear that + 0-4 are in the first bin, 5-9 in the second, + but continuous data gets a start of 0 and bins + [0,5), [5,10) etc. Dates behave similarly, and + `start` should be a date string. For category + data, `start` is based on the category serial + numbers, and defaults to -0.5. + + Returns + ------- + plotly.graph_objs.histogram2d.YBins + """ + return self['ybins'] + + @ybins.setter + def ybins(self, val): + self['ybins'] = val + + # ycalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['ycalendar'] + + @ycalendar.setter + def ycalendar(self, val): + self['ycalendar'] = val + + # ygap + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ygap'] + + @ygap.setter + def ygap(self, val): + self['ygap'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # z + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # zauto + # ----- + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['zauto'] + + @zauto.setter + def zauto(self, val): + self['zauto'] = val + + # zhoverformat + # ------------ + @property + def zhoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. See: https + ://github.com/d3/d3-format/blob/master/README.md#locale_format + + The 'zhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['zhoverformat'] + + @zhoverformat.setter + def zhoverformat(self, val): + self['zhoverformat'] = val + + # zmax + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmax'] + + @zmax.setter + def zmax(self, val): + self['zmax'] = val + + # zmid + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmid'] + + @zmid.setter + def zmid(self, val): + self['zmid'] = val + + # zmin + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmin'] + + @zmin.setter + def zmin(self, val): + self['zmin'] = val + + # zsmooth + # ------- + @property + 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] + + Returns + ------- + Any + """ + return self['zsmooth'] + + @zsmooth.setter + def zsmooth(self, val): + self['zsmooth'] = val + + # zsrc + # ---- + @property + def zsrc(self): + """ + Sets the source reference on plot.ly for z . + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['zsrc'] + + @zsrc.setter + def zsrc(self, val): + self['zsrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + colorbar + plotly.graph_objs.histogram2d.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + histfunc + Specifies the binning function used for this histogram + trace. If "count", the histogram values are computed by + counting the number of values lying inside each bin. If + "sum", "avg", "min", "max", the histogram values are + computed using the sum, the average, the minimum or the + maximum of the values lying inside each bin + respectively. + histnorm + Specifies the type of normalization used for this + histogram trace. If "", the span of each bar + corresponds to the number of occurrences (i.e. the + number of data points lying inside the bins). If + "percent" / "probability", the span of each bar + corresponds to the percentage / fraction of occurrences + with respect to the total number of sample points + (here, the sum of all bin HEIGHTS equals 100% / 1). If + "density", the span of each bar corresponds to the + number of occurrences in a bin divided by the size of + the bin interval (here, the sum of all bin AREAS equals + the total number of sample points). If *probability + density*, the area of each bar corresponds to the + probability that an event will fall into the + corresponding bin (here, the sum of all bin AREAS + equals 1). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.histogram2d.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variable `z` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + marker + plotly.graph_objs.histogram2d.Marker instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + nbinsx + Specifies the maximum number of desired bins. This + value will be used in an algorithm that will decide the + optimal bin size such that the histogram best + visualizes the distribution of the data. Ignored if + `xbins.size` is provided. + nbinsy + Specifies the maximum number of desired bins. This + value will be used in an algorithm that will decide the + optimal bin size such that the histogram best + visualizes the distribution of the data. Ignored if + `ybins.size` is provided. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.histogram2d.Stream instance or dict + with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the sample data to be binned on the x axis. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbins + plotly.graph_objs.histogram2d.XBins instance or dict + with compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xgap + Sets the horizontal gap (in pixels) between bricks. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the sample data to be binned on the y axis. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybins + plotly.graph_objs.histogram2d.YBins instance or dict + with compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + ygap + Sets the vertical gap (in pixels) between bricks. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the aggregation data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. See: https://github.com/d3/d3-format/blob/maste + r/README.md#locale_format + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsmooth + Picks a smoothing algorithm use to smooth `z` data. + zsrc + Sets the source reference on plot.ly for z . + """ + + def __init__( + self, + arg=None, + autobinx=None, + autobiny=None, + autocolorscale=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + histfunc=None, + histnorm=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + ids=None, + idssrc=None, + legendgroup=None, + marker=None, + name=None, + nbinsx=None, + nbinsy=None, + opacity=None, + reversescale=None, + selectedpoints=None, + showlegend=None, + showscale=None, + stream=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xbins=None, + xcalendar=None, + xgap=None, + xsrc=None, + y=None, + yaxis=None, + ybins=None, + ycalendar=None, + ygap=None, + ysrc=None, + z=None, + zauto=None, + zhoverformat=None, + zmax=None, + zmid=None, + zmin=None, + zsmooth=None, + zsrc=None, + **kwargs + ): + """ + Construct a new Histogram2d object + + The sample data from which statistics are computed is set in + `x` and `y` (where `x` and `y` represent marginal + distributions, binning is set in `xbins` and `ybins` in this + case) or `z` (where `z` represent the 2D distribution and + binning set, binning is set by `x` and `y` in this case). The + resulting distribution is visualized as a heatmap. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Histogram2d + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + colorbar + plotly.graph_objs.histogram2d.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + histfunc + Specifies the binning function used for this histogram + trace. If "count", the histogram values are computed by + counting the number of values lying inside each bin. If + "sum", "avg", "min", "max", the histogram values are + computed using the sum, the average, the minimum or the + maximum of the values lying inside each bin + respectively. + histnorm + Specifies the type of normalization used for this + histogram trace. If "", the span of each bar + corresponds to the number of occurrences (i.e. the + number of data points lying inside the bins). If + "percent" / "probability", the span of each bar + corresponds to the percentage / fraction of occurrences + with respect to the total number of sample points + (here, the sum of all bin HEIGHTS equals 100% / 1). If + "density", the span of each bar corresponds to the + number of occurrences in a bin divided by the size of + the bin interval (here, the sum of all bin AREAS equals + the total number of sample points). If *probability + density*, the area of each bar corresponds to the + probability that an event will fall into the + corresponding bin (here, the sum of all bin AREAS + equals 1). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.histogram2d.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variable `z` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + marker + plotly.graph_objs.histogram2d.Marker instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + nbinsx + Specifies the maximum number of desired bins. This + value will be used in an algorithm that will decide the + optimal bin size such that the histogram best + visualizes the distribution of the data. Ignored if + `xbins.size` is provided. + nbinsy + Specifies the maximum number of desired bins. This + value will be used in an algorithm that will decide the + optimal bin size such that the histogram best + visualizes the distribution of the data. Ignored if + `ybins.size` is provided. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.histogram2d.Stream instance or dict + with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the sample data to be binned on the x axis. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbins + plotly.graph_objs.histogram2d.XBins instance or dict + with compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xgap + Sets the horizontal gap (in pixels) between bricks. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the sample data to be binned on the y axis. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybins + plotly.graph_objs.histogram2d.YBins instance or dict + with compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + ygap + Sets the vertical gap (in pixels) between bricks. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the aggregation data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. See: https://github.com/d3/d3-format/blob/maste + r/README.md#locale_format + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsmooth + Picks a smoothing algorithm use to smooth `z` data. + zsrc + Sets the source reference on plot.ly for z . + + Returns + ------- + Histogram2d + """ + super(Histogram2d, self).__init__('histogram2d') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Histogram2d +constructor must be a dict or +an instance of plotly.graph_objs.Histogram2d""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (histogram2d as v_histogram2d) + + # Initialize validators + # --------------------- + self._validators['autobinx'] = v_histogram2d.AutobinxValidator() + self._validators['autobiny'] = v_histogram2d.AutobinyValidator() + self._validators['autocolorscale' + ] = v_histogram2d.AutocolorscaleValidator() + self._validators['colorbar'] = v_histogram2d.ColorBarValidator() + self._validators['colorscale'] = v_histogram2d.ColorscaleValidator() + self._validators['customdata'] = v_histogram2d.CustomdataValidator() + self._validators['customdatasrc' + ] = v_histogram2d.CustomdatasrcValidator() + self._validators['histfunc'] = v_histogram2d.HistfuncValidator() + self._validators['histnorm'] = v_histogram2d.HistnormValidator() + self._validators['hoverinfo'] = v_histogram2d.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_histogram2d.HoverinfosrcValidator( + ) + self._validators['hoverlabel'] = v_histogram2d.HoverlabelValidator() + self._validators['hovertemplate' + ] = v_histogram2d.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_histogram2d.HovertemplatesrcValidator() + self._validators['ids'] = v_histogram2d.IdsValidator() + self._validators['idssrc'] = v_histogram2d.IdssrcValidator() + self._validators['legendgroup'] = v_histogram2d.LegendgroupValidator() + self._validators['marker'] = v_histogram2d.MarkerValidator() + self._validators['name'] = v_histogram2d.NameValidator() + self._validators['nbinsx'] = v_histogram2d.NbinsxValidator() + self._validators['nbinsy'] = v_histogram2d.NbinsyValidator() + self._validators['opacity'] = v_histogram2d.OpacityValidator() + self._validators['reversescale'] = v_histogram2d.ReversescaleValidator( + ) + self._validators['selectedpoints' + ] = v_histogram2d.SelectedpointsValidator() + self._validators['showlegend'] = v_histogram2d.ShowlegendValidator() + self._validators['showscale'] = v_histogram2d.ShowscaleValidator() + self._validators['stream'] = v_histogram2d.StreamValidator() + self._validators['uid'] = v_histogram2d.UidValidator() + self._validators['uirevision'] = v_histogram2d.UirevisionValidator() + self._validators['visible'] = v_histogram2d.VisibleValidator() + self._validators['x'] = v_histogram2d.XValidator() + self._validators['xaxis'] = v_histogram2d.XAxisValidator() + self._validators['xbins'] = v_histogram2d.XBinsValidator() + self._validators['xcalendar'] = v_histogram2d.XcalendarValidator() + self._validators['xgap'] = v_histogram2d.XgapValidator() + self._validators['xsrc'] = v_histogram2d.XsrcValidator() + self._validators['y'] = v_histogram2d.YValidator() + self._validators['yaxis'] = v_histogram2d.YAxisValidator() + self._validators['ybins'] = v_histogram2d.YBinsValidator() + self._validators['ycalendar'] = v_histogram2d.YcalendarValidator() + self._validators['ygap'] = v_histogram2d.YgapValidator() + self._validators['ysrc'] = v_histogram2d.YsrcValidator() + self._validators['z'] = v_histogram2d.ZValidator() + self._validators['zauto'] = v_histogram2d.ZautoValidator() + self._validators['zhoverformat'] = v_histogram2d.ZhoverformatValidator( + ) + self._validators['zmax'] = v_histogram2d.ZmaxValidator() + self._validators['zmid'] = v_histogram2d.ZmidValidator() + self._validators['zmin'] = v_histogram2d.ZminValidator() + self._validators['zsmooth'] = v_histogram2d.ZsmoothValidator() + self._validators['zsrc'] = v_histogram2d.ZsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autobinx', None) + self['autobinx'] = autobinx if autobinx is not None else _v + _v = arg.pop('autobiny', None) + self['autobiny'] = autobiny if autobiny is not None else _v + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('histfunc', None) + self['histfunc'] = histfunc if histfunc is not None else _v + _v = arg.pop('histnorm', None) + self['histnorm'] = histnorm if histnorm is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('nbinsx', None) + self['nbinsx'] = nbinsx if nbinsx is not None else _v + _v = arg.pop('nbinsy', None) + self['nbinsy'] = nbinsy if nbinsy is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('xbins', None) + self['xbins'] = xbins if xbins is not None else _v + _v = arg.pop('xcalendar', None) + self['xcalendar'] = xcalendar if xcalendar is not None else _v + _v = arg.pop('xgap', None) + self['xgap'] = xgap if xgap is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + _v = arg.pop('ybins', None) + self['ybins'] = ybins if ybins is not None else _v + _v = arg.pop('ycalendar', None) + self['ycalendar'] = ycalendar if ycalendar is not None else _v + _v = arg.pop('ygap', None) + self['ygap'] = ygap if ygap is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + _v = arg.pop('zauto', None) + self['zauto'] = zauto if zauto is not None else _v + _v = arg.pop('zhoverformat', None) + self['zhoverformat'] = zhoverformat if zhoverformat is not None else _v + _v = arg.pop('zmax', None) + self['zmax'] = zmax if zmax is not None else _v + _v = arg.pop('zmid', None) + self['zmid'] = zmid if zmid is not None else _v + _v = arg.pop('zmin', None) + self['zmin'] = zmin if zmin is not None else _v + _v = arg.pop('zsmooth', None) + self['zsmooth'] = zsmooth if zsmooth is not None else _v + _v = arg.pop('zsrc', None) + self['zsrc'] = zsrc if zsrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'histogram2d' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='histogram2d', val='histogram2d' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Histogram(_BaseTraceType): + + # alignmentgroup + # -------------- + @property + 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 + + Returns + ------- + str + """ + return self['alignmentgroup'] + + @alignmentgroup.setter + def alignmentgroup(self, val): + self['alignmentgroup'] = val + + # autobinx + # -------- + @property + def autobinx(self): + """ + Obsolete: since v1.42 each bin attribute is auto-determined + separately and `autobinx` is not needed. However, we accept + `autobinx: true` or `false` and will update `xbins` accordingly + before deleting `autobinx` from the trace. + + The 'autobinx' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autobinx'] + + @autobinx.setter + def autobinx(self, val): + self['autobinx'] = val + + # autobiny + # -------- + @property + def autobiny(self): + """ + Obsolete: since v1.42 each bin attribute is auto-determined + separately and `autobiny` is not needed. However, we accept + `autobiny: true` or `false` and will update `ybins` accordingly + before deleting `autobiny` from the trace. + + The 'autobiny' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autobiny'] + + @autobiny.setter + def autobiny(self, val): + self['autobiny'] = val + + # cumulative + # ---------- + @property + def cumulative(self): + """ + The 'cumulative' property is an instance of Cumulative + that may be specified as: + - An instance of plotly.graph_objs.histogram.Cumulative + - A dict of string/value properties that will be passed + to the Cumulative constructor + + Supported dict properties: + + currentbin + Only applies if cumulative is enabled. Sets + whether the current bin is included, excluded, + or has half of its value included in the + current cumulative value. "include" is the + default for compatibility with various other + tools, however it introduces a half-bin bias to + the results. "exclude" makes the opposite half- + bin bias, and "half" removes it. + direction + Only applies if cumulative is enabled. If + "increasing" (default) we sum all prior bins, + so the result increases from left to right. If + "decreasing" we sum later bins so the result + decreases from left to right. + enabled + If true, display the cumulative distribution by + summing the binned values. Use the `direction` + and `centralbin` attributes to tune the + accumulation method. Note: in this mode, the + "density" `histnorm` settings behave the same + as their equivalents without "density": "" and + "density" both rise to the number of data + points, and "probability" and *probability + density* both rise to the number of sample + points. + + Returns + ------- + plotly.graph_objs.histogram.Cumulative + """ + return self['cumulative'] + + @cumulative.setter + def cumulative(self, val): + self['cumulative'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # error_x + # ------- + @property + def error_x(self): + """ + The 'error_x' property is an instance of ErrorX + that may be specified as: + - An instance of plotly.graph_objs.histogram.ErrorX + - A dict of string/value properties that will be passed + to the ErrorX constructor + + Supported dict properties: + + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. + + Returns + ------- + plotly.graph_objs.histogram.ErrorX + """ + return self['error_x'] + + @error_x.setter + def error_x(self, val): + self['error_x'] = val + + # error_y + # ------- + @property + def error_y(self): + """ + The 'error_y' property is an instance of ErrorY + that may be specified as: + - An instance of plotly.graph_objs.histogram.ErrorY + - A dict of string/value properties that will be passed + to the ErrorY constructor + + Supported dict properties: + + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. + + Returns + ------- + plotly.graph_objs.histogram.ErrorY + """ + return self['error_y'] + + @error_y.setter + def error_y(self, val): + self['error_y'] = val + + # histfunc + # -------- + @property + def histfunc(self): + """ + Specifies the binning function used for this histogram trace. + If "count", the histogram values are computed by counting the + number of values lying inside each bin. If "sum", "avg", "min", + "max", the histogram values are computed using the sum, the + average, the minimum or the maximum of the values lying inside + each bin respectively. + + The 'histfunc' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['count', 'sum', 'avg', 'min', 'max'] + + Returns + ------- + Any + """ + return self['histfunc'] + + @histfunc.setter + def histfunc(self, val): + self['histfunc'] = val + + # histnorm + # -------- + @property + def histnorm(self): + """ + Specifies the type of normalization used for this histogram + trace. If "", the span of each bar corresponds to the number of + occurrences (i.e. the number of data points lying inside the + bins). If "percent" / "probability", the span of each bar + corresponds to the percentage / fraction of occurrences with + respect to the total number of sample points (here, the sum of + all bin HEIGHTS equals 100% / 1). If "density", the span of + each bar corresponds to the number of occurrences in a bin + divided by the size of the bin interval (here, the sum of all + bin AREAS equals the total number of sample points). If + *probability density*, the area of each bar corresponds to the + probability that an event will fall into the corresponding bin + (here, the sum of all bin AREAS equals 1). + + The 'histnorm' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', 'percent', 'probability', 'density', 'probability + density'] + + Returns + ------- + Any + """ + return self['histnorm'] + + @histnorm.setter + def histnorm(self, val): + self['histnorm'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.histogram.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.histogram.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + variable `binNumber` Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of plotly.graph_objs.histogram.Marker + - A dict of string/value properties that will be passed + to the Marker constructor + + Supported dict properties: + + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.histogram.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + line + plotly.graph_objs.histogram.marker.Line + instance or dict with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + + Returns + ------- + plotly.graph_objs.histogram.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # nbinsx + # ------ + @property + def nbinsx(self): + """ + Specifies the maximum number of desired bins. This value will + be used in an algorithm that will decide the optimal bin size + such that the histogram best visualizes the distribution of the + data. Ignored if `xbins.size` is provided. + + The 'nbinsx' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['nbinsx'] + + @nbinsx.setter + def nbinsx(self, val): + self['nbinsx'] = val + + # nbinsy + # ------ + @property + def nbinsy(self): + """ + Specifies the maximum number of desired bins. This value will + be used in an algorithm that will decide the optimal bin size + such that the histogram best visualizes the distribution of the + data. Ignored if `ybins.size` is provided. + + The 'nbinsy' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['nbinsy'] + + @nbinsy.setter + def nbinsy(self, val): + self['nbinsy'] = val + + # offsetgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['offsetgroup'] + + @offsetgroup.setter + def offsetgroup(self, val): + self['offsetgroup'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # orientation + # ----------- + @property + 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'] + + Returns + ------- + Any + """ + return self['orientation'] + + @orientation.setter + def orientation(self, val): + self['orientation'] = val + + # selected + # -------- + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of plotly.graph_objs.histogram.Selected + - A dict of string/value properties that will be passed + to the Selected constructor + + Supported dict properties: + + marker + plotly.graph_objs.histogram.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.histogram.selected.Textfont + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.histogram.Selected + """ + return self['selected'] + + @selected.setter + def selected(self, val): + self['selected'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.histogram.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.histogram.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + def text(self): + """ + Sets hover text elements associated with each bar. If a single + string, the same string appears over all bars. If an array of + string, the items are mapped in order to the this trace's + coordinates. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # unselected + # ---------- + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of plotly.graph_objs.histogram.Unselected + - A dict of string/value properties that will be passed + to the Unselected constructor + + Supported dict properties: + + marker + plotly.graph_objs.histogram.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.histogram.unselected.Textfont + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.histogram.Unselected + """ + return self['unselected'] + + @unselected.setter + def unselected(self, val): + self['unselected'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # xbins + # ----- + @property + def xbins(self): + """ + The 'xbins' property is an instance of XBins + that may be specified as: + - An instance of plotly.graph_objs.histogram.XBins + - A dict of string/value properties that will be passed + to the XBins constructor + + Supported dict properties: + + end + Sets the end value for the x axis bins. The + last bin may not end exactly at this value, we + increment the bin edge by `size` from `start` + until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use + a date string, and for category data `end` is + based on the category serial numbers. + size + Sets the size of each x axis bin. Default + behavior: If `nbinsx` is 0 or omitted, we + choose a nice round bin size such that the + number of bins is about the same as the typical + number of samples in each bin. If `nbinsx` is + provided, we choose a nice round bin size + giving no more than that many bins. For date + data, use milliseconds or "M" for months, as + in `axis.dtick`. For category data, the number + of categories to bin together (always defaults + to 1). If multiple non-overlaying histograms + share a subplot, the first explicit `size` is + used and all others discarded. If no `size` is + provided,the sample data from all traces is + combined to determine `size` as described + above. + start + Sets the starting value for the x axis bins. + Defaults to the minimum data value, shifted + down if necessary to make nice round values and + to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin + edges 0.5 down, so a `size` of 5 would have a + default `start` of -0.5, so it is clear that + 0-4 are in the first bin, 5-9 in the second, + but continuous data gets a start of 0 and bins + [0,5), [5,10) etc. Dates behave similarly, and + `start` should be a date string. For category + data, `start` is based on the category serial + numbers, and defaults to -0.5. If multiple non- + overlaying histograms share a subplot, the + first explicit `start` is used exactly and all + others are shifted down (if necessary) to + differ from that one by an integer number of + bins. + + Returns + ------- + plotly.graph_objs.histogram.XBins + """ + return self['xbins'] + + @xbins.setter + def xbins(self, val): + self['xbins'] = val + + # xcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['xcalendar'] + + @xcalendar.setter + def xcalendar(self, val): + self['xcalendar'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # ybins + # ----- + @property + def ybins(self): + """ + The 'ybins' property is an instance of YBins + that may be specified as: + - An instance of plotly.graph_objs.histogram.YBins + - A dict of string/value properties that will be passed + to the YBins constructor + + Supported dict properties: + + end + Sets the end value for the y axis bins. The + last bin may not end exactly at this value, we + increment the bin edge by `size` from `start` + until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use + a date string, and for category data `end` is + based on the category serial numbers. + size + Sets the size of each y axis bin. Default + behavior: If `nbinsy` is 0 or omitted, we + choose a nice round bin size such that the + number of bins is about the same as the typical + number of samples in each bin. If `nbinsy` is + provided, we choose a nice round bin size + giving no more than that many bins. For date + data, use milliseconds or "M" for months, as + in `axis.dtick`. For category data, the number + of categories to bin together (always defaults + to 1). If multiple non-overlaying histograms + share a subplot, the first explicit `size` is + used and all others discarded. If no `size` is + provided,the sample data from all traces is + combined to determine `size` as described + above. + start + Sets the starting value for the y axis bins. + Defaults to the minimum data value, shifted + down if necessary to make nice round values and + to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin + edges 0.5 down, so a `size` of 5 would have a + default `start` of -0.5, so it is clear that + 0-4 are in the first bin, 5-9 in the second, + but continuous data gets a start of 0 and bins + [0,5), [5,10) etc. Dates behave similarly, and + `start` should be a date string. For category + data, `start` is based on the category serial + numbers, and defaults to -0.5. If multiple non- + overlaying histograms share a subplot, the + first explicit `start` is used exactly and all + others are shifted down (if necessary) to + differ from that one by an integer number of + bins. + + Returns + ------- + plotly.graph_objs.histogram.YBins + """ + return self['ybins'] + + @ybins.setter + def ybins(self, val): + self['ybins'] = val + + # ycalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['ycalendar'] + + @ycalendar.setter + def ycalendar(self, val): + self['ycalendar'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + alignmentgroup + Set several traces linked to the same position axis or + matching axes to the same alignmentgroup. This controls + whether bars compute their positional range dependently + or independently. + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + cumulative + plotly.graph_objs.histogram.Cumulative instance or dict + with compatible properties + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + error_x + plotly.graph_objs.histogram.ErrorX instance or dict + with compatible properties + error_y + plotly.graph_objs.histogram.ErrorY instance or dict + with compatible properties + histfunc + Specifies the binning function used for this histogram + trace. If "count", the histogram values are computed by + counting the number of values lying inside each bin. If + "sum", "avg", "min", "max", the histogram values are + computed using the sum, the average, the minimum or the + maximum of the values lying inside each bin + respectively. + histnorm + Specifies the type of normalization used for this + histogram trace. If "", the span of each bar + corresponds to the number of occurrences (i.e. the + number of data points lying inside the bins). If + "percent" / "probability", the span of each bar + corresponds to the percentage / fraction of occurrences + with respect to the total number of sample points + (here, the sum of all bin HEIGHTS equals 100% / 1). If + "density", the span of each bar corresponds to the + number of occurrences in a bin divided by the size of + the bin interval (here, the sum of all bin AREAS equals + the total number of sample points). If *probability + density*, the area of each bar corresponds to the + probability that an event will fall into the + corresponding bin (here, the sum of all bin AREAS + equals 1). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.histogram.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variable `binNumber` Anything contained in + tag `` is displayed in the secondary box, for + example "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + marker + plotly.graph_objs.histogram.Marker instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + nbinsx + Specifies the maximum number of desired bins. This + value will be used in an algorithm that will decide the + optimal bin size such that the histogram best + visualizes the distribution of the data. Ignored if + `xbins.size` is provided. + nbinsy + Specifies the maximum number of desired bins. This + value will be used in an algorithm that will decide the + optimal bin size such that the histogram best + visualizes the distribution of the data. Ignored if + `ybins.size` is provided. + offsetgroup + Set several traces linked to the same position axis or + matching axes to the same offsetgroup where bars of the + same position coordinate will line up. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" ("h"), the + value of the each bar spans along the vertical + (horizontal). + selected + plotly.graph_objs.histogram.Selected instance or dict + with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.histogram.Stream instance or dict + with compatible properties + text + Sets hover text elements associated with each bar. If a + single string, the same string appears over all bars. + If an array of string, the items are mapped in order to + the this trace's coordinates. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.histogram.Unselected instance or dict + with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the sample data to be binned on the x axis. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbins + plotly.graph_objs.histogram.XBins instance or dict with + compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the sample data to be binned on the y axis. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybins + plotly.graph_objs.histogram.YBins instance or dict with + compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + """ + + def __init__( + self, + arg=None, + alignmentgroup=None, + autobinx=None, + autobiny=None, + cumulative=None, + customdata=None, + customdatasrc=None, + error_x=None, + error_y=None, + histfunc=None, + histnorm=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legendgroup=None, + marker=None, + name=None, + nbinsx=None, + nbinsy=None, + offsetgroup=None, + opacity=None, + orientation=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + x=None, + xaxis=None, + xbins=None, + xcalendar=None, + xsrc=None, + y=None, + yaxis=None, + ybins=None, + ycalendar=None, + ysrc=None, + **kwargs + ): + """ + Construct a new Histogram object + + The sample data from which statistics are computed is set in + `x` for vertically spanning histograms and in `y` for + horizontally spanning histograms. Binning options are set + `xbins` and `ybins` respectively if no aggregation data is + provided. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Histogram + alignmentgroup + Set several traces linked to the same position axis or + matching axes to the same alignmentgroup. This controls + whether bars compute their positional range dependently + or independently. + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + cumulative + plotly.graph_objs.histogram.Cumulative instance or dict + with compatible properties + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + error_x + plotly.graph_objs.histogram.ErrorX instance or dict + with compatible properties + error_y + plotly.graph_objs.histogram.ErrorY instance or dict + with compatible properties + histfunc + Specifies the binning function used for this histogram + trace. If "count", the histogram values are computed by + counting the number of values lying inside each bin. If + "sum", "avg", "min", "max", the histogram values are + computed using the sum, the average, the minimum or the + maximum of the values lying inside each bin + respectively. + histnorm + Specifies the type of normalization used for this + histogram trace. If "", the span of each bar + corresponds to the number of occurrences (i.e. the + number of data points lying inside the bins). If + "percent" / "probability", the span of each bar + corresponds to the percentage / fraction of occurrences + with respect to the total number of sample points + (here, the sum of all bin HEIGHTS equals 100% / 1). If + "density", the span of each bar corresponds to the + number of occurrences in a bin divided by the size of + the bin interval (here, the sum of all bin AREAS equals + the total number of sample points). If *probability + density*, the area of each bar corresponds to the + probability that an event will fall into the + corresponding bin (here, the sum of all bin AREAS + equals 1). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.histogram.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variable `binNumber` Anything contained in + tag `` is displayed in the secondary box, for + example "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + marker + plotly.graph_objs.histogram.Marker instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + nbinsx + Specifies the maximum number of desired bins. This + value will be used in an algorithm that will decide the + optimal bin size such that the histogram best + visualizes the distribution of the data. Ignored if + `xbins.size` is provided. + nbinsy + Specifies the maximum number of desired bins. This + value will be used in an algorithm that will decide the + optimal bin size such that the histogram best + visualizes the distribution of the data. Ignored if + `ybins.size` is provided. + offsetgroup + Set several traces linked to the same position axis or + matching axes to the same offsetgroup where bars of the + same position coordinate will line up. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" ("h"), the + value of the each bar spans along the vertical + (horizontal). + selected + plotly.graph_objs.histogram.Selected instance or dict + with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.histogram.Stream instance or dict + with compatible properties + text + Sets hover text elements associated with each bar. If a + single string, the same string appears over all bars. + If an array of string, the items are mapped in order to + the this trace's coordinates. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.histogram.Unselected instance or dict + with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the sample data to be binned on the x axis. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbins + plotly.graph_objs.histogram.XBins instance or dict with + compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the sample data to be binned on the y axis. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybins + plotly.graph_objs.histogram.YBins instance or dict with + compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + + Returns + ------- + Histogram + """ + super(Histogram, self).__init__('histogram') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Histogram +constructor must be a dict or +an instance of plotly.graph_objs.Histogram""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (histogram as v_histogram) + + # Initialize validators + # --------------------- + self._validators['alignmentgroup' + ] = v_histogram.AlignmentgroupValidator() + self._validators['autobinx'] = v_histogram.AutobinxValidator() + self._validators['autobiny'] = v_histogram.AutobinyValidator() + self._validators['cumulative'] = v_histogram.CumulativeValidator() + self._validators['customdata'] = v_histogram.CustomdataValidator() + self._validators['customdatasrc'] = v_histogram.CustomdatasrcValidator( + ) + self._validators['error_x'] = v_histogram.ErrorXValidator() + self._validators['error_y'] = v_histogram.ErrorYValidator() + self._validators['histfunc'] = v_histogram.HistfuncValidator() + self._validators['histnorm'] = v_histogram.HistnormValidator() + self._validators['hoverinfo'] = v_histogram.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_histogram.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_histogram.HoverlabelValidator() + self._validators['hovertemplate'] = v_histogram.HovertemplateValidator( + ) + self._validators['hovertemplatesrc' + ] = v_histogram.HovertemplatesrcValidator() + self._validators['hovertext'] = v_histogram.HovertextValidator() + self._validators['hovertextsrc'] = v_histogram.HovertextsrcValidator() + self._validators['ids'] = v_histogram.IdsValidator() + self._validators['idssrc'] = v_histogram.IdssrcValidator() + self._validators['legendgroup'] = v_histogram.LegendgroupValidator() + self._validators['marker'] = v_histogram.MarkerValidator() + self._validators['name'] = v_histogram.NameValidator() + self._validators['nbinsx'] = v_histogram.NbinsxValidator() + self._validators['nbinsy'] = v_histogram.NbinsyValidator() + self._validators['offsetgroup'] = v_histogram.OffsetgroupValidator() + self._validators['opacity'] = v_histogram.OpacityValidator() + self._validators['orientation'] = v_histogram.OrientationValidator() + self._validators['selected'] = v_histogram.SelectedValidator() + self._validators['selectedpoints' + ] = v_histogram.SelectedpointsValidator() + self._validators['showlegend'] = v_histogram.ShowlegendValidator() + self._validators['stream'] = v_histogram.StreamValidator() + self._validators['text'] = v_histogram.TextValidator() + self._validators['textsrc'] = v_histogram.TextsrcValidator() + self._validators['uid'] = v_histogram.UidValidator() + self._validators['uirevision'] = v_histogram.UirevisionValidator() + self._validators['unselected'] = v_histogram.UnselectedValidator() + self._validators['visible'] = v_histogram.VisibleValidator() + self._validators['x'] = v_histogram.XValidator() + self._validators['xaxis'] = v_histogram.XAxisValidator() + self._validators['xbins'] = v_histogram.XBinsValidator() + self._validators['xcalendar'] = v_histogram.XcalendarValidator() + self._validators['xsrc'] = v_histogram.XsrcValidator() + self._validators['y'] = v_histogram.YValidator() + self._validators['yaxis'] = v_histogram.YAxisValidator() + self._validators['ybins'] = v_histogram.YBinsValidator() + self._validators['ycalendar'] = v_histogram.YcalendarValidator() + self._validators['ysrc'] = v_histogram.YsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('alignmentgroup', None) + self['alignmentgroup' + ] = alignmentgroup if alignmentgroup is not None else _v + _v = arg.pop('autobinx', None) + self['autobinx'] = autobinx if autobinx is not None else _v + _v = arg.pop('autobiny', None) + self['autobiny'] = autobiny if autobiny is not None else _v + _v = arg.pop('cumulative', None) + self['cumulative'] = cumulative if cumulative is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('error_x', None) + self['error_x'] = error_x if error_x is not None else _v + _v = arg.pop('error_y', None) + self['error_y'] = error_y if error_y is not None else _v + _v = arg.pop('histfunc', None) + self['histfunc'] = histfunc if histfunc is not None else _v + _v = arg.pop('histnorm', None) + self['histnorm'] = histnorm if histnorm is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('nbinsx', None) + self['nbinsx'] = nbinsx if nbinsx is not None else _v + _v = arg.pop('nbinsy', None) + self['nbinsy'] = nbinsy if nbinsy is not None else _v + _v = arg.pop('offsetgroup', None) + self['offsetgroup'] = offsetgroup if offsetgroup is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('orientation', None) + self['orientation'] = orientation if orientation is not None else _v + _v = arg.pop('selected', None) + self['selected'] = selected if selected is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('unselected', None) + self['unselected'] = unselected if unselected is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('xbins', None) + self['xbins'] = xbins if xbins is not None else _v + _v = arg.pop('xcalendar', None) + self['xcalendar'] = xcalendar if xcalendar is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + _v = arg.pop('ybins', None) + self['ybins'] = ybins if ybins is not None else _v + _v = arg.pop('ycalendar', None) + self['ycalendar'] = ycalendar if ycalendar is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'histogram' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='histogram', val='histogram' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Heatmapgl(_BaseTraceType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of plotly.graph_objs.heatmapgl.ColorBar + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Supported dict properties: + + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.heatmapgl.colorbar.Tickformat + stop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.heatmapgl.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of heatmapgl.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.heatmapgl.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + heatmapgl.colorbar.title.font instead. Sets + this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + heatmapgl.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.heatmapgl.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. The colorscale must be an array containing + arrays mapping a normalized value to an rgb, rgba, hex, hsl, + hsv, or named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # dx + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['dx'] + + @dx.setter + def dx(self, val): + self['dx'] = val + + # dy + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['dy'] + + @dy.setter + def dy(self, val): + self['dy'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.heatmapgl.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.heatmapgl.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # reversescale + # ------------ + @property + 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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.heatmapgl.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.heatmapgl.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # transpose + # --------- + @property + def transpose(self): + """ + Transposes the z data. + + The 'transpose' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['transpose'] + + @transpose.setter + def transpose(self, val): + self['transpose'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # x0 + # -- + @property + 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 + ------- + Any + """ + return self['x0'] + + @x0.setter + def x0(self, val): + self['x0'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # xtype + # ----- + @property + def xtype(self): + """ + If "array", the heatmap's x coordinates are given by "x" (the + default behavior when `x` is provided). If "scaled", the + heatmap's x coordinates are given by "x0" and "dx" (the default + behavior when `x` is not provided). + + The 'xtype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['array', 'scaled'] + + Returns + ------- + Any + """ + return self['xtype'] + + @xtype.setter + def xtype(self, val): + self['xtype'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # y0 + # -- + @property + 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 + ------- + Any + """ + return self['y0'] + + @y0.setter + def y0(self, val): + self['y0'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # ytype + # ----- + @property + def ytype(self): + """ + If "array", the heatmap's y coordinates are given by "y" (the + default behavior when `y` is provided) If "scaled", the + heatmap's y coordinates are given by "y0" and "dy" (the default + behavior when `y` is not provided) + + The 'ytype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['array', 'scaled'] + + Returns + ------- + Any + """ + return self['ytype'] + + @ytype.setter + def ytype(self, val): + self['ytype'] = val + + # z + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # zauto + # ----- + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['zauto'] + + @zauto.setter + def zauto(self, val): + self['zauto'] = val + + # zmax + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmax'] + + @zmax.setter + def zmax(self, val): + self['zmax'] = val + + # zmid + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmid'] + + @zmid.setter + def zmid(self, val): + self['zmid'] = val + + # zmin + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmin'] + + @zmin.setter + def zmin(self, val): + self['zmin'] = val + + # zsrc + # ---- + @property + def zsrc(self): + """ + Sets the source reference on plot.ly for z . + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['zsrc'] + + @zsrc.setter + def zsrc(self, val): + self['zsrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + colorbar + plotly.graph_objs.heatmapgl.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.heatmapgl.Hoverlabel instance or dict + with compatible properties + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.heatmapgl.Stream instance or dict + with compatible properties + text + Sets the text elements associated with each z value. + textsrc + Sets the source reference on plot.ly for text . + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xsrc + Sets the source reference on plot.ly for x . + xtype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ysrc + Sets the source reference on plot.ly for y . + ytype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on plot.ly for z . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + ids=None, + idssrc=None, + legendgroup=None, + name=None, + opacity=None, + reversescale=None, + selectedpoints=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textsrc=None, + transpose=None, + uid=None, + uirevision=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xsrc=None, + xtype=None, + y=None, + y0=None, + yaxis=None, + ysrc=None, + ytype=None, + z=None, + zauto=None, + zmax=None, + zmid=None, + zmin=None, + zsrc=None, + **kwargs + ): + """ + Construct a new Heatmapgl object + + WebGL version of the heatmap trace type. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Heatmapgl + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + colorbar + plotly.graph_objs.heatmapgl.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.heatmapgl.Hoverlabel instance or dict + with compatible properties + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.heatmapgl.Stream instance or dict + with compatible properties + text + Sets the text elements associated with each z value. + textsrc + Sets the source reference on plot.ly for text . + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xsrc + Sets the source reference on plot.ly for x . + xtype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ysrc + Sets the source reference on plot.ly for y . + ytype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on plot.ly for z . + + Returns + ------- + Heatmapgl + """ + super(Heatmapgl, self).__init__('heatmapgl') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Heatmapgl +constructor must be a dict or +an instance of plotly.graph_objs.Heatmapgl""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (heatmapgl as v_heatmapgl) + + # Initialize validators + # --------------------- + self._validators['autocolorscale' + ] = v_heatmapgl.AutocolorscaleValidator() + self._validators['colorbar'] = v_heatmapgl.ColorBarValidator() + self._validators['colorscale'] = v_heatmapgl.ColorscaleValidator() + self._validators['customdata'] = v_heatmapgl.CustomdataValidator() + self._validators['customdatasrc'] = v_heatmapgl.CustomdatasrcValidator( + ) + self._validators['dx'] = v_heatmapgl.DxValidator() + self._validators['dy'] = v_heatmapgl.DyValidator() + self._validators['hoverinfo'] = v_heatmapgl.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_heatmapgl.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_heatmapgl.HoverlabelValidator() + self._validators['ids'] = v_heatmapgl.IdsValidator() + self._validators['idssrc'] = v_heatmapgl.IdssrcValidator() + self._validators['legendgroup'] = v_heatmapgl.LegendgroupValidator() + self._validators['name'] = v_heatmapgl.NameValidator() + self._validators['opacity'] = v_heatmapgl.OpacityValidator() + self._validators['reversescale'] = v_heatmapgl.ReversescaleValidator() + self._validators['selectedpoints' + ] = v_heatmapgl.SelectedpointsValidator() + self._validators['showlegend'] = v_heatmapgl.ShowlegendValidator() + self._validators['showscale'] = v_heatmapgl.ShowscaleValidator() + self._validators['stream'] = v_heatmapgl.StreamValidator() + self._validators['text'] = v_heatmapgl.TextValidator() + self._validators['textsrc'] = v_heatmapgl.TextsrcValidator() + self._validators['transpose'] = v_heatmapgl.TransposeValidator() + self._validators['uid'] = v_heatmapgl.UidValidator() + self._validators['uirevision'] = v_heatmapgl.UirevisionValidator() + self._validators['visible'] = v_heatmapgl.VisibleValidator() + self._validators['x'] = v_heatmapgl.XValidator() + self._validators['x0'] = v_heatmapgl.X0Validator() + self._validators['xaxis'] = v_heatmapgl.XAxisValidator() + self._validators['xsrc'] = v_heatmapgl.XsrcValidator() + self._validators['xtype'] = v_heatmapgl.XtypeValidator() + self._validators['y'] = v_heatmapgl.YValidator() + self._validators['y0'] = v_heatmapgl.Y0Validator() + self._validators['yaxis'] = v_heatmapgl.YAxisValidator() + self._validators['ysrc'] = v_heatmapgl.YsrcValidator() + self._validators['ytype'] = v_heatmapgl.YtypeValidator() + self._validators['z'] = v_heatmapgl.ZValidator() + self._validators['zauto'] = v_heatmapgl.ZautoValidator() + self._validators['zmax'] = v_heatmapgl.ZmaxValidator() + self._validators['zmid'] = v_heatmapgl.ZmidValidator() + self._validators['zmin'] = v_heatmapgl.ZminValidator() + self._validators['zsrc'] = v_heatmapgl.ZsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('dx', None) + self['dx'] = dx if dx is not None else _v + _v = arg.pop('dy', None) + self['dy'] = dy if dy is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('transpose', None) + self['transpose'] = transpose if transpose is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('x0', None) + self['x0'] = x0 if x0 is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('xtype', None) + self['xtype'] = xtype if xtype is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('y0', None) + self['y0'] = y0 if y0 is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + _v = arg.pop('ytype', None) + self['ytype'] = ytype if ytype is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + _v = arg.pop('zauto', None) + self['zauto'] = zauto if zauto is not None else _v + _v = arg.pop('zmax', None) + self['zmax'] = zmax if zmax is not None else _v + _v = arg.pop('zmid', None) + self['zmid'] = zmid if zmid is not None else _v + _v = arg.pop('zmin', None) + self['zmin'] = zmin if zmin is not None else _v + _v = arg.pop('zsrc', None) + self['zsrc'] = zsrc if zsrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'heatmapgl' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='heatmapgl', val='heatmapgl' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Heatmap(_BaseTraceType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of plotly.graph_objs.heatmap.ColorBar + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Supported dict properties: + + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.heatmap.colorbar.Tickformatst + op instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.heatmap.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of heatmap.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.heatmap.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + heatmap.colorbar.title.font instead. Sets this + color bar's title font. Note that the title's + font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use + heatmap.colorbar.title.side instead. Determines + the location of color bar's title with respect + to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.heatmap.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. The colorscale must be an array containing + arrays mapping a normalized value to an rgb, rgba, hex, hsl, + hsv, or named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # connectgaps + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['connectgaps'] + + @connectgaps.setter + def connectgaps(self, val): + self['connectgaps'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # dx + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['dx'] + + @dx.setter + def dx(self, val): + self['dx'] = val + + # dy + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['dy'] + + @dy.setter + def dy(self, val): + self['dy'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.heatmap.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.heatmap.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # reversescale + # ------------ + @property + 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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.heatmap.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.heatmap.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # transpose + # --------- + @property + def transpose(self): + """ + Transposes the z data. + + The 'transpose' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['transpose'] + + @transpose.setter + def transpose(self, val): + self['transpose'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # x0 + # -- + @property + 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 + ------- + Any + """ + return self['x0'] + + @x0.setter + def x0(self, val): + self['x0'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # xcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['xcalendar'] + + @xcalendar.setter + def xcalendar(self, val): + self['xcalendar'] = val + + # xgap + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xgap'] + + @xgap.setter + def xgap(self, val): + self['xgap'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # xtype + # ----- + @property + def xtype(self): + """ + If "array", the heatmap's x coordinates are given by "x" (the + default behavior when `x` is provided). If "scaled", the + heatmap's x coordinates are given by "x0" and "dx" (the default + behavior when `x` is not provided). + + The 'xtype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['array', 'scaled'] + + Returns + ------- + Any + """ + return self['xtype'] + + @xtype.setter + def xtype(self, val): + self['xtype'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # y0 + # -- + @property + 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 + ------- + Any + """ + return self['y0'] + + @y0.setter + def y0(self, val): + self['y0'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # ycalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['ycalendar'] + + @ycalendar.setter + def ycalendar(self, val): + self['ycalendar'] = val + + # ygap + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ygap'] + + @ygap.setter + def ygap(self, val): + self['ygap'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # ytype + # ----- + @property + def ytype(self): + """ + If "array", the heatmap's y coordinates are given by "y" (the + default behavior when `y` is provided) If "scaled", the + heatmap's y coordinates are given by "y0" and "dy" (the default + behavior when `y` is not provided) + + The 'ytype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['array', 'scaled'] + + Returns + ------- + Any + """ + return self['ytype'] + + @ytype.setter + def ytype(self, val): + self['ytype'] = val + + # z + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # zauto + # ----- + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['zauto'] + + @zauto.setter + def zauto(self, val): + self['zauto'] = val + + # zhoverformat + # ------------ + @property + def zhoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. See: https + ://github.com/d3/d3-format/blob/master/README.md#locale_format + + The 'zhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['zhoverformat'] + + @zhoverformat.setter + def zhoverformat(self, val): + self['zhoverformat'] = val + + # zmax + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmax'] + + @zmax.setter + def zmax(self, val): + self['zmax'] = val + + # zmid + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmid'] + + @zmid.setter + def zmid(self, val): + self['zmid'] = val + + # zmin + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmin'] + + @zmin.setter + def zmin(self, val): + self['zmin'] = val + + # zsmooth + # ------- + @property + 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] + + Returns + ------- + Any + """ + return self['zsmooth'] + + @zsmooth.setter + def zsmooth(self, val): + self['zsmooth'] = val + + # zsrc + # ---- + @property + def zsrc(self): + """ + Sets the source reference on plot.ly for z . + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['zsrc'] + + @zsrc.setter + def zsrc(self, val): + self['zsrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + colorbar + plotly.graph_objs.heatmap.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data are filled in. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.heatmap.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.heatmap.Stream instance or dict with + compatible properties + text + Sets the text elements associated with each z value. + textsrc + Sets the source reference on plot.ly for text . + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xgap + Sets the horizontal gap (in pixels) between bricks. + xsrc + Sets the source reference on plot.ly for x . + xtype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + ygap + Sets the vertical gap (in pixels) between bricks. + ysrc + Sets the source reference on plot.ly for y . + ytype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. See: https://github.com/d3/d3-format/blob/maste + r/README.md#locale_format + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsmooth + Picks a smoothing algorithm use to smooth `z` data. + zsrc + Sets the source reference on plot.ly for z . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + colorbar=None, + colorscale=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legendgroup=None, + name=None, + opacity=None, + reversescale=None, + selectedpoints=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textsrc=None, + transpose=None, + uid=None, + uirevision=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xgap=None, + xsrc=None, + xtype=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + ygap=None, + ysrc=None, + ytype=None, + z=None, + zauto=None, + zhoverformat=None, + zmax=None, + zmid=None, + zmin=None, + zsmooth=None, + zsrc=None, + **kwargs + ): + """ + Construct a new Heatmap object + + The data that describes the heatmap value-to-color mapping is + set in `z`. Data in `z` can either be a 2D list of values + (ragged or not) or a 1D array of values. In the case where `z` + is a 2D list, say that `z` has N rows and M columns. Then, by + default, the resulting heatmap will have N partitions along the + y axis and M partitions along the x axis. In other words, the + i-th row/ j-th column cell in `z` is mapped to the i-th + partition of the y axis (starting from the bottom of the plot) + and the j-th partition of the x-axis (starting from the left of + the plot). This behavior can be flipped by using `transpose`. + Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1) + elements. If M (N), then the coordinates correspond to the + center of the heatmap cells and the cells have equal width. If + M+1 (N+1), then the coordinates correspond to the edges of the + heatmap cells. In the case where `z` is a 1D list, the x and y + coordinates must be provided in `x` and `y` respectively to + form data triplets. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Heatmap + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + colorbar + plotly.graph_objs.heatmap.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data are filled in. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.heatmap.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.heatmap.Stream instance or dict with + compatible properties + text + Sets the text elements associated with each z value. + textsrc + Sets the source reference on plot.ly for text . + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xgap + Sets the horizontal gap (in pixels) between bricks. + xsrc + Sets the source reference on plot.ly for x . + xtype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + ygap + Sets the vertical gap (in pixels) between bricks. + ysrc + Sets the source reference on plot.ly for y . + ytype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. See: https://github.com/d3/d3-format/blob/maste + r/README.md#locale_format + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsmooth + Picks a smoothing algorithm use to smooth `z` data. + zsrc + Sets the source reference on plot.ly for z . + + Returns + ------- + Heatmap + """ + super(Heatmap, self).__init__('heatmap') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Heatmap +constructor must be a dict or +an instance of plotly.graph_objs.Heatmap""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (heatmap as v_heatmap) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_heatmap.AutocolorscaleValidator( + ) + self._validators['colorbar'] = v_heatmap.ColorBarValidator() + self._validators['colorscale'] = v_heatmap.ColorscaleValidator() + self._validators['connectgaps'] = v_heatmap.ConnectgapsValidator() + self._validators['customdata'] = v_heatmap.CustomdataValidator() + self._validators['customdatasrc'] = v_heatmap.CustomdatasrcValidator() + self._validators['dx'] = v_heatmap.DxValidator() + self._validators['dy'] = v_heatmap.DyValidator() + self._validators['hoverinfo'] = v_heatmap.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_heatmap.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_heatmap.HoverlabelValidator() + self._validators['hovertemplate'] = v_heatmap.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_heatmap.HovertemplatesrcValidator() + self._validators['hovertext'] = v_heatmap.HovertextValidator() + self._validators['hovertextsrc'] = v_heatmap.HovertextsrcValidator() + self._validators['ids'] = v_heatmap.IdsValidator() + self._validators['idssrc'] = v_heatmap.IdssrcValidator() + self._validators['legendgroup'] = v_heatmap.LegendgroupValidator() + self._validators['name'] = v_heatmap.NameValidator() + self._validators['opacity'] = v_heatmap.OpacityValidator() + self._validators['reversescale'] = v_heatmap.ReversescaleValidator() + self._validators['selectedpoints'] = v_heatmap.SelectedpointsValidator( + ) + self._validators['showlegend'] = v_heatmap.ShowlegendValidator() + self._validators['showscale'] = v_heatmap.ShowscaleValidator() + self._validators['stream'] = v_heatmap.StreamValidator() + self._validators['text'] = v_heatmap.TextValidator() + self._validators['textsrc'] = v_heatmap.TextsrcValidator() + self._validators['transpose'] = v_heatmap.TransposeValidator() + self._validators['uid'] = v_heatmap.UidValidator() + self._validators['uirevision'] = v_heatmap.UirevisionValidator() + self._validators['visible'] = v_heatmap.VisibleValidator() + self._validators['x'] = v_heatmap.XValidator() + self._validators['x0'] = v_heatmap.X0Validator() + self._validators['xaxis'] = v_heatmap.XAxisValidator() + self._validators['xcalendar'] = v_heatmap.XcalendarValidator() + self._validators['xgap'] = v_heatmap.XgapValidator() + self._validators['xsrc'] = v_heatmap.XsrcValidator() + self._validators['xtype'] = v_heatmap.XtypeValidator() + self._validators['y'] = v_heatmap.YValidator() + self._validators['y0'] = v_heatmap.Y0Validator() + self._validators['yaxis'] = v_heatmap.YAxisValidator() + self._validators['ycalendar'] = v_heatmap.YcalendarValidator() + self._validators['ygap'] = v_heatmap.YgapValidator() + self._validators['ysrc'] = v_heatmap.YsrcValidator() + self._validators['ytype'] = v_heatmap.YtypeValidator() + self._validators['z'] = v_heatmap.ZValidator() + self._validators['zauto'] = v_heatmap.ZautoValidator() + self._validators['zhoverformat'] = v_heatmap.ZhoverformatValidator() + self._validators['zmax'] = v_heatmap.ZmaxValidator() + self._validators['zmid'] = v_heatmap.ZmidValidator() + self._validators['zmin'] = v_heatmap.ZminValidator() + self._validators['zsmooth'] = v_heatmap.ZsmoothValidator() + self._validators['zsrc'] = v_heatmap.ZsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('connectgaps', None) + self['connectgaps'] = connectgaps if connectgaps is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('dx', None) + self['dx'] = dx if dx is not None else _v + _v = arg.pop('dy', None) + self['dy'] = dy if dy is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('transpose', None) + self['transpose'] = transpose if transpose is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('x0', None) + self['x0'] = x0 if x0 is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('xcalendar', None) + self['xcalendar'] = xcalendar if xcalendar is not None else _v + _v = arg.pop('xgap', None) + self['xgap'] = xgap if xgap is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('xtype', None) + self['xtype'] = xtype if xtype is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('y0', None) + self['y0'] = y0 if y0 is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + _v = arg.pop('ycalendar', None) + self['ycalendar'] = ycalendar if ycalendar is not None else _v + _v = arg.pop('ygap', None) + self['ygap'] = ygap if ygap is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + _v = arg.pop('ytype', None) + self['ytype'] = ytype if ytype is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + _v = arg.pop('zauto', None) + self['zauto'] = zauto if zauto is not None else _v + _v = arg.pop('zhoverformat', None) + self['zhoverformat'] = zhoverformat if zhoverformat is not None else _v + _v = arg.pop('zmax', None) + self['zmax'] = zmax if zmax is not None else _v + _v = arg.pop('zmid', None) + self['zmid'] = zmid if zmid is not None else _v + _v = arg.pop('zmin', None) + self['zmin'] = zmin if zmin is not None else _v + _v = arg.pop('zsmooth', None) + self['zsmooth'] = zsmooth if zsmooth is not None else _v + _v = arg.pop('zsrc', None) + self['zsrc'] = zsrc if zsrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'heatmap' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='heatmap', val='heatmap' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Contourcarpet(_BaseTraceType): + + # a + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['a'] + + @a.setter + def a(self, val): + self['a'] = val + + # a0 + # -- + @property + 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 + ------- + Any + """ + return self['a0'] + + @a0.setter + def a0(self, val): + self['a0'] = val + + # asrc + # ---- + @property + def asrc(self): + """ + Sets the source reference on plot.ly for a . + + The 'asrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['asrc'] + + @asrc.setter + def asrc(self, val): + self['asrc'] = val + + # atype + # ----- + @property + def atype(self): + """ + If "array", the heatmap's x coordinates are given by "x" (the + default behavior when `x` is provided). If "scaled", the + heatmap's x coordinates are given by "x0" and "dx" (the default + behavior when `x` is not provided). + + The 'atype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['array', 'scaled'] + + Returns + ------- + Any + """ + return self['atype'] + + @atype.setter + def atype(self, val): + self['atype'] = val + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # autocontour + # ----------- + @property + def autocontour(self): + """ + Determines whether or not the contour level attributes are + picked by an algorithm. If True, the number of contour levels + can be set in `ncontours`. If False, set the contour level + attributes in `contours`. + + The 'autocontour' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocontour'] + + @autocontour.setter + def autocontour(self, val): + self['autocontour'] = val + + # b + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['b'] + + @b.setter + def b(self, val): + self['b'] = val + + # b0 + # -- + @property + 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 + ------- + Any + """ + return self['b0'] + + @b0.setter + def b0(self, val): + self['b0'] = val + + # bsrc + # ---- + @property + def bsrc(self): + """ + Sets the source reference on plot.ly for b . + + The 'bsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bsrc'] + + @bsrc.setter + def bsrc(self, val): + self['bsrc'] = val + + # btype + # ----- + @property + def btype(self): + """ + If "array", the heatmap's y coordinates are given by "y" (the + default behavior when `y` is provided) If "scaled", the + heatmap's y coordinates are given by "y0" and "dy" (the default + behavior when `y` is not provided) + + The 'btype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['array', 'scaled'] + + Returns + ------- + Any + """ + return self['btype'] + + @btype.setter + def btype(self, val): + self['btype'] = val + + # carpet + # ------ + @property + 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 + + Returns + ------- + str + """ + return self['carpet'] + + @carpet.setter + def carpet(self, val): + self['carpet'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of plotly.graph_objs.contourcarpet.ColorBar + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Supported dict properties: + + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.contourcarpet.colorbar.Tickfo + rmatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.contourcarpet.colorbar.tickformatstopdefaults + ), sets the default property values to use for + elements of + contourcarpet.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.contourcarpet.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + contourcarpet.colorbar.title.font instead. Sets + this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + contourcarpet.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.contourcarpet.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. The colorscale must be an array containing + arrays mapping a normalized value to an rgb, rgba, hex, hsl, + hsv, or named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # contours + # -------- + @property + def contours(self): + """ + The 'contours' property is an instance of Contours + that may be specified as: + - An instance of plotly.graph_objs.contourcarpet.Contours + - A dict of string/value properties that will be passed + to the Contours constructor + + Supported dict properties: + + coloring + Determines the coloring method showing the + contour values. If "fill", coloring is done + evenly between each contour level If "lines", + coloring is done on the contour lines. If + "none", no coloring is applied on this trace. + end + Sets the end contour level value. Must be more + than `contours.start` + labelfont + Sets the font used for labeling the contour + levels. The default color comes from the lines, + if shown. The default family and size come from + `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-language which is very similar + to Python, see: https://github.com/d3/d3-format + /blob/master/README.md#locale_format. + operation + Sets the constraint operation. "=" keeps + regions equal to `value` "<" and "<=" keep + regions less than `value` ">" and ">=" keep + regions greater than `value` "[]", "()", "[)", + and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions + outside `value[0]` to value[1]` Open vs. closed + intervals make no difference to constraint + display, but all versions are allowed for + consistency with filter transforms. + showlabels + Determines whether to label the contour lines + with their values. + showlines + Determines whether or not the contour lines are + drawn. Has an effect only if + `contours.coloring` is set to "fill". + size + Sets the step between each contour level. Must + be positive. + start + Sets the starting contour level value. Must be + less than `contours.end` + type + If `levels`, the data is represented as a + contour plot with multiple levels displayed. If + `constraint`, the data is represented as + constraints with the invalid region shaded as + specified by the `operation` and `value` + parameters. + value + Sets the value or values of the constraint + boundary. When `operation` is set to one of the + comparison values (=,<,>=,>,<=) "value" is + expected to be a number. When `operation` is + set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected + to be an array of two numbers where the first + is the lower bound and the second is the upper + bound. + + Returns + ------- + plotly.graph_objs.contourcarpet.Contours + """ + return self['contours'] + + @contours.setter + def contours(self, val): + self['contours'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # da + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['da'] + + @da.setter + def da(self, val): + self['da'] = val + + # db + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['db'] + + @db.setter + def db(self, val): + self['db'] = val + + # fillcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to contourcarpet.colorscale + + Returns + ------- + str + """ + return self['fillcolor'] + + @fillcolor.setter + def fillcolor(self, val): + self['fillcolor'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.contourcarpet.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.contourcarpet.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertext + # --------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 if + `contours.coloring` is set to "lines". + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour + lines, where 0 corresponds to no smoothing. + width + Sets the line width (in px). + + Returns + ------- + plotly.graph_objs.contourcarpet.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # ncontours + # --------- + @property + def ncontours(self): + """ + Sets the maximum number of contour levels. The actual number of + contours will be chosen automatically to be less than or equal + to the value of `ncontours`. Has an effect only if + `autocontour` is True or if `contours.size` is missing. + + The 'ncontours' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self['ncontours'] + + @ncontours.setter + def ncontours(self, val): + self['ncontours'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # reversescale + # ------------ + @property + 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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.contourcarpet.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.contourcarpet.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # transpose + # --------- + @property + def transpose(self): + """ + Transposes the z data. + + The 'transpose' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['transpose'] + + @transpose.setter + def transpose(self, val): + self['transpose'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # z + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # zauto + # ----- + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['zauto'] + + @zauto.setter + def zauto(self, val): + self['zauto'] = val + + # zmax + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmax'] + + @zmax.setter + def zmax(self, val): + self['zmax'] = val + + # zmid + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmid'] + + @zmid.setter + def zmid(self, val): + self['zmid'] = val + + # zmin + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmin'] + + @zmin.setter + def zmin(self, val): + self['zmin'] = val + + # zsrc + # ---- + @property + def zsrc(self): + """ + Sets the source reference on plot.ly for z . + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['zsrc'] + + @zsrc.setter + def zsrc(self, val): + self['zsrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + a + Sets the x coordinates. + a0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + asrc + Sets the source reference on plot.ly for a . + atype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + b + Sets the y coordinates. + b0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + bsrc + Sets the source reference on plot.ly for b . + btype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + carpet + The `carpet` of the carpet axes on which this contour + trace lies + colorbar + plotly.graph_objs.contourcarpet.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + contours + plotly.graph_objs.contourcarpet.Contours instance or + dict with compatible properties + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + da + Sets the x coordinate step. See `x0` for more info. + db + Sets the y coordinate step. See `y0` for more info. + fillcolor + Sets the fill color if `contours.type` is "constraint". + Defaults to a half-transparent variant of the line + color, marker color, or marker line color, whichever is + available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.contourcarpet.Hoverlabel instance or + dict with compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.contourcarpet.Line instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.contourcarpet.Stream instance or dict + with compatible properties + text + Sets the text elements associated with each z value. + textsrc + Sets the source reference on plot.ly for text . + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on plot.ly for z . + """ + + def __init__( + self, + arg=None, + a=None, + a0=None, + asrc=None, + atype=None, + autocolorscale=None, + autocontour=None, + b=None, + b0=None, + bsrc=None, + btype=None, + carpet=None, + colorbar=None, + colorscale=None, + contours=None, + customdata=None, + customdatasrc=None, + da=None, + db=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legendgroup=None, + line=None, + name=None, + ncontours=None, + opacity=None, + reversescale=None, + selectedpoints=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textsrc=None, + transpose=None, + uid=None, + uirevision=None, + visible=None, + xaxis=None, + yaxis=None, + z=None, + zauto=None, + zmax=None, + zmid=None, + zmin=None, + zsrc=None, + **kwargs + ): + """ + Construct a new Contourcarpet object + + Plots contours on either the first carpet axis or the carpet + axis with a matching `carpet` attribute. Data `z` is + interpreted as matching that of the corresponding carpet axis. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Contourcarpet + a + Sets the x coordinates. + a0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + asrc + Sets the source reference on plot.ly for a . + atype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + b + Sets the y coordinates. + b0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + bsrc + Sets the source reference on plot.ly for b . + btype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + carpet + The `carpet` of the carpet axes on which this contour + trace lies + colorbar + plotly.graph_objs.contourcarpet.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + contours + plotly.graph_objs.contourcarpet.Contours instance or + dict with compatible properties + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + da + Sets the x coordinate step. See `x0` for more info. + db + Sets the y coordinate step. See `y0` for more info. + fillcolor + Sets the fill color if `contours.type` is "constraint". + Defaults to a half-transparent variant of the line + color, marker color, or marker line color, whichever is + available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.contourcarpet.Hoverlabel instance or + dict with compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.contourcarpet.Line instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.contourcarpet.Stream instance or dict + with compatible properties + text + Sets the text elements associated with each z value. + textsrc + Sets the source reference on plot.ly for text . + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on plot.ly for z . + + Returns + ------- + Contourcarpet + """ + super(Contourcarpet, self).__init__('contourcarpet') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Contourcarpet +constructor must be a dict or +an instance of plotly.graph_objs.Contourcarpet""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (contourcarpet as v_contourcarpet) + + # Initialize validators + # --------------------- + self._validators['a'] = v_contourcarpet.AValidator() + self._validators['a0'] = v_contourcarpet.A0Validator() + self._validators['asrc'] = v_contourcarpet.AsrcValidator() + self._validators['atype'] = v_contourcarpet.AtypeValidator() + self._validators['autocolorscale' + ] = v_contourcarpet.AutocolorscaleValidator() + self._validators['autocontour'] = v_contourcarpet.AutocontourValidator( + ) + self._validators['b'] = v_contourcarpet.BValidator() + self._validators['b0'] = v_contourcarpet.B0Validator() + self._validators['bsrc'] = v_contourcarpet.BsrcValidator() + self._validators['btype'] = v_contourcarpet.BtypeValidator() + self._validators['carpet'] = v_contourcarpet.CarpetValidator() + self._validators['colorbar'] = v_contourcarpet.ColorBarValidator() + self._validators['colorscale'] = v_contourcarpet.ColorscaleValidator() + self._validators['contours'] = v_contourcarpet.ContoursValidator() + self._validators['customdata'] = v_contourcarpet.CustomdataValidator() + self._validators['customdatasrc' + ] = v_contourcarpet.CustomdatasrcValidator() + self._validators['da'] = v_contourcarpet.DaValidator() + self._validators['db'] = v_contourcarpet.DbValidator() + self._validators['fillcolor'] = v_contourcarpet.FillcolorValidator() + self._validators['hoverinfo'] = v_contourcarpet.HoverinfoValidator() + self._validators['hoverinfosrc' + ] = v_contourcarpet.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_contourcarpet.HoverlabelValidator() + self._validators['hovertext'] = v_contourcarpet.HovertextValidator() + self._validators['hovertextsrc' + ] = v_contourcarpet.HovertextsrcValidator() + self._validators['ids'] = v_contourcarpet.IdsValidator() + self._validators['idssrc'] = v_contourcarpet.IdssrcValidator() + self._validators['legendgroup'] = v_contourcarpet.LegendgroupValidator( + ) + self._validators['line'] = v_contourcarpet.LineValidator() + self._validators['name'] = v_contourcarpet.NameValidator() + self._validators['ncontours'] = v_contourcarpet.NcontoursValidator() + self._validators['opacity'] = v_contourcarpet.OpacityValidator() + self._validators['reversescale' + ] = v_contourcarpet.ReversescaleValidator() + self._validators['selectedpoints' + ] = v_contourcarpet.SelectedpointsValidator() + self._validators['showlegend'] = v_contourcarpet.ShowlegendValidator() + self._validators['showscale'] = v_contourcarpet.ShowscaleValidator() + self._validators['stream'] = v_contourcarpet.StreamValidator() + self._validators['text'] = v_contourcarpet.TextValidator() + self._validators['textsrc'] = v_contourcarpet.TextsrcValidator() + self._validators['transpose'] = v_contourcarpet.TransposeValidator() + self._validators['uid'] = v_contourcarpet.UidValidator() + self._validators['uirevision'] = v_contourcarpet.UirevisionValidator() + self._validators['visible'] = v_contourcarpet.VisibleValidator() + self._validators['xaxis'] = v_contourcarpet.XAxisValidator() + self._validators['yaxis'] = v_contourcarpet.YAxisValidator() + self._validators['z'] = v_contourcarpet.ZValidator() + self._validators['zauto'] = v_contourcarpet.ZautoValidator() + self._validators['zmax'] = v_contourcarpet.ZmaxValidator() + self._validators['zmid'] = v_contourcarpet.ZmidValidator() + self._validators['zmin'] = v_contourcarpet.ZminValidator() + self._validators['zsrc'] = v_contourcarpet.ZsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('a', None) + self['a'] = a if a is not None else _v + _v = arg.pop('a0', None) + self['a0'] = a0 if a0 is not None else _v + _v = arg.pop('asrc', None) + self['asrc'] = asrc if asrc is not None else _v + _v = arg.pop('atype', None) + self['atype'] = atype if atype is not None else _v + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('autocontour', None) + self['autocontour'] = autocontour if autocontour is not None else _v + _v = arg.pop('b', None) + self['b'] = b if b is not None else _v + _v = arg.pop('b0', None) + self['b0'] = b0 if b0 is not None else _v + _v = arg.pop('bsrc', None) + self['bsrc'] = bsrc if bsrc is not None else _v + _v = arg.pop('btype', None) + self['btype'] = btype if btype is not None else _v + _v = arg.pop('carpet', None) + self['carpet'] = carpet if carpet is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('contours', None) + self['contours'] = contours if contours is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('da', None) + self['da'] = da if da is not None else _v + _v = arg.pop('db', None) + self['db'] = db if db is not None else _v + _v = arg.pop('fillcolor', None) + self['fillcolor'] = fillcolor if fillcolor is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('ncontours', None) + self['ncontours'] = ncontours if ncontours is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('transpose', None) + self['transpose'] = transpose if transpose is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + _v = arg.pop('zauto', None) + self['zauto'] = zauto if zauto is not None else _v + _v = arg.pop('zmax', None) + self['zmax'] = zmax if zmax is not None else _v + _v = arg.pop('zmid', None) + self['zmid'] = zmid if zmid is not None else _v + _v = arg.pop('zmin', None) + self['zmin'] = zmin if zmin is not None else _v + _v = arg.pop('zsrc', None) + self['zsrc'] = zsrc if zsrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'contourcarpet' + self._validators['type'] = LiteralValidator( + plotly_name='type', + parent_name='contourcarpet', + val='contourcarpet' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Contour(_BaseTraceType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # autocontour + # ----------- + @property + def autocontour(self): + """ + Determines whether or not the contour level attributes are + picked by an algorithm. If True, the number of contour levels + can be set in `ncontours`. If False, set the contour level + attributes in `contours`. + + The 'autocontour' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocontour'] + + @autocontour.setter + def autocontour(self, val): + self['autocontour'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of plotly.graph_objs.contour.ColorBar + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Supported dict properties: + + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.contour.colorbar.Tickformatst + op instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.contour.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of contour.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.contour.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + contour.colorbar.title.font instead. Sets this + color bar's title font. Note that the title's + font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use + contour.colorbar.title.side instead. Determines + the location of color bar's title with respect + to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.contour.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. The colorscale must be an array containing + arrays mapping a normalized value to an rgb, rgba, hex, hsl, + hsv, or named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # connectgaps + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['connectgaps'] + + @connectgaps.setter + def connectgaps(self, val): + self['connectgaps'] = val + + # contours + # -------- + @property + def contours(self): + """ + The 'contours' property is an instance of Contours + that may be specified as: + - An instance of plotly.graph_objs.contour.Contours + - A dict of string/value properties that will be passed + to the Contours constructor + + Supported dict properties: + + coloring + Determines the coloring method showing the + contour values. If "fill", coloring is done + evenly between each contour level If "heatmap", + a heatmap gradient coloring is applied between + each contour level. If "lines", coloring is + done on the contour lines. If "none", no + coloring is applied on this trace. + end + Sets the end contour level value. Must be more + than `contours.start` + labelfont + Sets the font used for labeling the contour + levels. The default color comes from the lines, + if shown. The default family and size come from + `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-language which is very similar + to Python, see: https://github.com/d3/d3-format + /blob/master/README.md#locale_format. + operation + Sets the constraint operation. "=" keeps + regions equal to `value` "<" and "<=" keep + regions less than `value` ">" and ">=" keep + regions greater than `value` "[]", "()", "[)", + and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions + outside `value[0]` to value[1]` Open vs. closed + intervals make no difference to constraint + display, but all versions are allowed for + consistency with filter transforms. + showlabels + Determines whether to label the contour lines + with their values. + showlines + Determines whether or not the contour lines are + drawn. Has an effect only if + `contours.coloring` is set to "fill". + size + Sets the step between each contour level. Must + be positive. + start + Sets the starting contour level value. Must be + less than `contours.end` + type + If `levels`, the data is represented as a + contour plot with multiple levels displayed. If + `constraint`, the data is represented as + constraints with the invalid region shaded as + specified by the `operation` and `value` + parameters. + value + Sets the value or values of the constraint + boundary. When `operation` is set to one of the + comparison values (=,<,>=,>,<=) "value" is + expected to be a number. When `operation` is + set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected + to be an array of two numbers where the first + is the lower bound and the second is the upper + bound. + + Returns + ------- + plotly.graph_objs.contour.Contours + """ + return self['contours'] + + @contours.setter + def contours(self, val): + self['contours'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # dx + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['dx'] + + @dx.setter + def dx(self, val): + self['dx'] = val + + # dy + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['dy'] + + @dy.setter + def dy(self, val): + self['dy'] = val + + # fillcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to contour.colorscale + + Returns + ------- + str + """ + return self['fillcolor'] + + @fillcolor.setter + def fillcolor(self, val): + self['fillcolor'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.contour.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.contour.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of plotly.graph_objs.contour.Line + - A dict of string/value properties that will be passed + to the Line constructor + + Supported dict properties: + + color + Sets the color of the contour level. Has no + effect if `contours.coloring` is set to + "lines". + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour + lines, where 0 corresponds to no smoothing. + width + Sets the line width (in px). + + Returns + ------- + plotly.graph_objs.contour.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # ncontours + # --------- + @property + def ncontours(self): + """ + Sets the maximum number of contour levels. The actual number of + contours will be chosen automatically to be less than or equal + to the value of `ncontours`. Has an effect only if + `autocontour` is True or if `contours.size` is missing. + + The 'ncontours' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self['ncontours'] + + @ncontours.setter + def ncontours(self, val): + self['ncontours'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # reversescale + # ------------ + @property + 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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.contour.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.contour.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # transpose + # --------- + @property + def transpose(self): + """ + Transposes the z data. + + The 'transpose' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['transpose'] + + @transpose.setter + def transpose(self, val): + self['transpose'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # x0 + # -- + @property + 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 + ------- + Any + """ + return self['x0'] + + @x0.setter + def x0(self, val): + self['x0'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # xcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['xcalendar'] + + @xcalendar.setter + def xcalendar(self, val): + self['xcalendar'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # xtype + # ----- + @property + def xtype(self): + """ + If "array", the heatmap's x coordinates are given by "x" (the + default behavior when `x` is provided). If "scaled", the + heatmap's x coordinates are given by "x0" and "dx" (the default + behavior when `x` is not provided). + + The 'xtype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['array', 'scaled'] + + Returns + ------- + Any + """ + return self['xtype'] + + @xtype.setter + def xtype(self, val): + self['xtype'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # y0 + # -- + @property + 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 + ------- + Any + """ + return self['y0'] + + @y0.setter + def y0(self, val): + self['y0'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # ycalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['ycalendar'] + + @ycalendar.setter + def ycalendar(self, val): + self['ycalendar'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # ytype + # ----- + @property + def ytype(self): + """ + If "array", the heatmap's y coordinates are given by "y" (the + default behavior when `y` is provided) If "scaled", the + heatmap's y coordinates are given by "y0" and "dy" (the default + behavior when `y` is not provided) + + The 'ytype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['array', 'scaled'] + + Returns + ------- + Any + """ + return self['ytype'] + + @ytype.setter + def ytype(self, val): + self['ytype'] = val + + # z + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # zauto + # ----- + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['zauto'] + + @zauto.setter + def zauto(self, val): + self['zauto'] = val + + # zhoverformat + # ------------ + @property + def zhoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. See: https + ://github.com/d3/d3-format/blob/master/README.md#locale_format + + The 'zhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['zhoverformat'] + + @zhoverformat.setter + def zhoverformat(self, val): + self['zhoverformat'] = val + + # zmax + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmax'] + + @zmax.setter + def zmax(self, val): + self['zmax'] = val + + # zmid + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmid'] + + @zmid.setter + def zmid(self, val): + self['zmid'] = val + + # zmin + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmin'] + + @zmin.setter + def zmin(self, val): + self['zmin'] = val + + # zsrc + # ---- + @property + def zsrc(self): + """ + Sets the source reference on plot.ly for z . + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['zsrc'] + + @zsrc.setter + def zsrc(self, val): + self['zsrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + colorbar + plotly.graph_objs.contour.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data are filled in. + contours + plotly.graph_objs.contour.Contours instance or dict + with compatible properties + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + fillcolor + Sets the fill color if `contours.type` is "constraint". + Defaults to a half-transparent variant of the line + color, marker color, or marker line color, whichever is + available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.contour.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.contour.Line instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.contour.Stream instance or dict with + compatible properties + text + Sets the text elements associated with each z value. + textsrc + Sets the source reference on plot.ly for text . + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + xtype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + ytype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. See: https://github.com/d3/d3-format/blob/maste + r/README.md#locale_format + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on plot.ly for z . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + autocontour=None, + colorbar=None, + colorscale=None, + connectgaps=None, + contours=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legendgroup=None, + line=None, + name=None, + ncontours=None, + opacity=None, + reversescale=None, + selectedpoints=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textsrc=None, + transpose=None, + uid=None, + uirevision=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xsrc=None, + xtype=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + ysrc=None, + ytype=None, + z=None, + zauto=None, + zhoverformat=None, + zmax=None, + zmid=None, + zmin=None, + zsrc=None, + **kwargs + ): + """ + Construct a new Contour object + + The data from which contour lines are computed is set in `z`. + Data in `z` must be a 2D list of numbers. Say that `z` has N + rows and M columns, then by default, these N rows correspond to + N y coordinates (set in `y` or auto-generated) and the M + columns correspond to M x coordinates (set in `x` or auto- + generated). By setting `transpose` to True, the above behavior + is flipped. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Contour + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + colorbar + plotly.graph_objs.contour.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data are filled in. + contours + plotly.graph_objs.contour.Contours instance or dict + with compatible properties + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + fillcolor + Sets the fill color if `contours.type` is "constraint". + Defaults to a half-transparent variant of the line + color, marker color, or marker line color, whichever is + available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.contour.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.contour.Line instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.contour.Stream instance or dict with + compatible properties + text + Sets the text elements associated with each z value. + textsrc + Sets the source reference on plot.ly for text . + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + xtype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + ytype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. See: https://github.com/d3/d3-format/blob/maste + r/README.md#locale_format + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on plot.ly for z . + + Returns + ------- + Contour + """ + super(Contour, self).__init__('contour') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Contour +constructor must be a dict or +an instance of plotly.graph_objs.Contour""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (contour as v_contour) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_contour.AutocolorscaleValidator( + ) + self._validators['autocontour'] = v_contour.AutocontourValidator() + self._validators['colorbar'] = v_contour.ColorBarValidator() + self._validators['colorscale'] = v_contour.ColorscaleValidator() + self._validators['connectgaps'] = v_contour.ConnectgapsValidator() + self._validators['contours'] = v_contour.ContoursValidator() + self._validators['customdata'] = v_contour.CustomdataValidator() + self._validators['customdatasrc'] = v_contour.CustomdatasrcValidator() + self._validators['dx'] = v_contour.DxValidator() + self._validators['dy'] = v_contour.DyValidator() + self._validators['fillcolor'] = v_contour.FillcolorValidator() + self._validators['hoverinfo'] = v_contour.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_contour.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_contour.HoverlabelValidator() + self._validators['hovertemplate'] = v_contour.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_contour.HovertemplatesrcValidator() + self._validators['hovertext'] = v_contour.HovertextValidator() + self._validators['hovertextsrc'] = v_contour.HovertextsrcValidator() + self._validators['ids'] = v_contour.IdsValidator() + self._validators['idssrc'] = v_contour.IdssrcValidator() + self._validators['legendgroup'] = v_contour.LegendgroupValidator() + self._validators['line'] = v_contour.LineValidator() + self._validators['name'] = v_contour.NameValidator() + self._validators['ncontours'] = v_contour.NcontoursValidator() + self._validators['opacity'] = v_contour.OpacityValidator() + self._validators['reversescale'] = v_contour.ReversescaleValidator() + self._validators['selectedpoints'] = v_contour.SelectedpointsValidator( + ) + self._validators['showlegend'] = v_contour.ShowlegendValidator() + self._validators['showscale'] = v_contour.ShowscaleValidator() + self._validators['stream'] = v_contour.StreamValidator() + self._validators['text'] = v_contour.TextValidator() + self._validators['textsrc'] = v_contour.TextsrcValidator() + self._validators['transpose'] = v_contour.TransposeValidator() + self._validators['uid'] = v_contour.UidValidator() + self._validators['uirevision'] = v_contour.UirevisionValidator() + self._validators['visible'] = v_contour.VisibleValidator() + self._validators['x'] = v_contour.XValidator() + self._validators['x0'] = v_contour.X0Validator() + self._validators['xaxis'] = v_contour.XAxisValidator() + self._validators['xcalendar'] = v_contour.XcalendarValidator() + self._validators['xsrc'] = v_contour.XsrcValidator() + self._validators['xtype'] = v_contour.XtypeValidator() + self._validators['y'] = v_contour.YValidator() + self._validators['y0'] = v_contour.Y0Validator() + self._validators['yaxis'] = v_contour.YAxisValidator() + self._validators['ycalendar'] = v_contour.YcalendarValidator() + self._validators['ysrc'] = v_contour.YsrcValidator() + self._validators['ytype'] = v_contour.YtypeValidator() + self._validators['z'] = v_contour.ZValidator() + self._validators['zauto'] = v_contour.ZautoValidator() + self._validators['zhoverformat'] = v_contour.ZhoverformatValidator() + self._validators['zmax'] = v_contour.ZmaxValidator() + self._validators['zmid'] = v_contour.ZmidValidator() + self._validators['zmin'] = v_contour.ZminValidator() + self._validators['zsrc'] = v_contour.ZsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('autocontour', None) + self['autocontour'] = autocontour if autocontour is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('connectgaps', None) + self['connectgaps'] = connectgaps if connectgaps is not None else _v + _v = arg.pop('contours', None) + self['contours'] = contours if contours is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('dx', None) + self['dx'] = dx if dx is not None else _v + _v = arg.pop('dy', None) + self['dy'] = dy if dy is not None else _v + _v = arg.pop('fillcolor', None) + self['fillcolor'] = fillcolor if fillcolor is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('ncontours', None) + self['ncontours'] = ncontours if ncontours is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('transpose', None) + self['transpose'] = transpose if transpose is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('x0', None) + self['x0'] = x0 if x0 is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('xcalendar', None) + self['xcalendar'] = xcalendar if xcalendar is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('xtype', None) + self['xtype'] = xtype if xtype is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('y0', None) + self['y0'] = y0 if y0 is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + _v = arg.pop('ycalendar', None) + self['ycalendar'] = ycalendar if ycalendar is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + _v = arg.pop('ytype', None) + self['ytype'] = ytype if ytype is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + _v = arg.pop('zauto', None) + self['zauto'] = zauto if zauto is not None else _v + _v = arg.pop('zhoverformat', None) + self['zhoverformat'] = zhoverformat if zhoverformat is not None else _v + _v = arg.pop('zmax', None) + self['zmax'] = zmax if zmax is not None else _v + _v = arg.pop('zmid', None) + self['zmid'] = zmid if zmid is not None else _v + _v = arg.pop('zmin', None) + self['zmin'] = zmin if zmin is not None else _v + _v = arg.pop('zsrc', None) + self['zsrc'] = zsrc if zsrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'contour' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='contour', val='contour' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Cone(_BaseTraceType): + + # anchor + # ------ + @property + 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'] + + Returns + ------- + Any + """ + return self['anchor'] + + @anchor.setter + def anchor(self, val): + self['anchor'] = val + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here u/v/w norm) or the bounds set + in `cmin` and `cmax` Defaults to `false` when `cmin` and + `cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + 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 u/v/w norm. Has no effect when `cauto` is + `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of plotly.graph_objs.cone.ColorBar + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Supported dict properties: + + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.cone.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.cone.colorbar.tickformatstopdefaults), sets + the default property values to use for elements + of cone.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.cone.colorbar.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use cone.colorbar.title.font + instead. Sets this color bar's title font. Note + that the title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use cone.colorbar.title.side + instead. Determines the location of color bar's + title with respect to the color bar. Note that + the title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.cone.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. The colorscale must be an array containing + arrays mapping a normalized value to an rgb, rgba, hex, hsl, + hsv, or named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.cone.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.cone.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + variable `norm` Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # lighting + # -------- + @property + def lighting(self): + """ + The 'lighting' property is an instance of Lighting + that may be specified as: + - An instance of plotly.graph_objs.cone.Lighting + - A dict of string/value properties that will be passed + to the Lighting constructor + + Supported dict properties: + + ambient + Ambient light increases overall color + visibility but can wash out the image. + diffuse + Represents the extent that incident rays are + reflected in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids + math issues arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of + the viewing angle; e.g. paper is reflective + when viewing it from the edge of the paper + (almost 90 degrees), causing shine. + roughness + Alters specular reflection; the rougher the + surface, the wider and less contrasty the + shine. + specular + Represents the level that incident rays are + reflected in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids + math issues arising from degenerate geometry. + + Returns + ------- + plotly.graph_objs.cone.Lighting + """ + return self['lighting'] + + @lighting.setter + def lighting(self, val): + self['lighting'] = val + + # lightposition + # ------------- + @property + def lightposition(self): + """ + The 'lightposition' property is an instance of Lightposition + that may be specified as: + - An instance of plotly.graph_objs.cone.Lightposition + - A dict of string/value properties that will be passed + to the Lightposition constructor + + Supported dict properties: + + x + Numeric vector, representing the X coordinate + for each vertex. + y + Numeric vector, representing the Y coordinate + for each vertex. + z + Numeric vector, representing the Z coordinate + for each vertex. + + Returns + ------- + plotly.graph_objs.cone.Lightposition + """ + return self['lightposition'] + + @lightposition.setter + def lightposition(self, val): + self['lightposition'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + def opacity(self): + """ + Sets the opacity of the surface. Please note that in the case + of using high `opacity` values for example a value greater than + or equal to 0.5 on two surfaces (and 0.25 with four surfaces), + an overlay of multiple transparent surfaces may not perfectly + be sorted in depth by the webgl API. This behavior may be + improved in the near future and is subject to change. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # reversescale + # ------------ + @property + 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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # scene + # ----- + @property + def scene(self): + """ + Sets a reference between this trace's 3D coordinate system and + a 3D scene. If "scene" (the default value), the (x,y,z) + coordinates refer to `layout.scene`. If "scene2", the (x,y,z) + coordinates refer to `layout.scene2`, and so on. + + The 'scene' property is an identifier of a particular + subplot, of type 'scene', that may be specified as the string 'scene' + optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + + Returns + ------- + str + """ + return self['scene'] + + @scene.setter + def scene(self, val): + self['scene'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # sizemode + # -------- + @property + def sizemode(self): + """ + Determines whether `sizeref` is set as a "scaled" (i.e + unitless) scalar (normalized by the max u/v/w norm in the + vector field) or as "absolute" value (in the same units as the + vector field). + + The 'sizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['scaled', 'absolute'] + + Returns + ------- + Any + """ + return self['sizemode'] + + @sizemode.setter + def sizemode(self, val): + self['sizemode'] = val + + # sizeref + # ------- + @property + def sizeref(self): + """ + Adjusts the cone size scaling. The size of the cones is + determined by their u/v/w norm multiplied a factor and + `sizeref`. This factor (computed internally) corresponds to the + minimum "time" to travel across two successive x/y/z positions + at the average velocity of those two successive positions. All + cones in a given trace use the same factor. With `sizemode` set + to "scaled", `sizeref` is unitless, its default value is 0.5 + With `sizemode` set to "absolute", `sizeref` has the same units + as the u/v/w vector field, its the default value is half the + sample's maximum vector norm. + + The 'sizeref' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self['sizeref'] + + @sizeref.setter + def sizeref(self, val): + self['sizeref'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.cone.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.cone.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # u + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['u'] + + @u.setter + def u(self, val): + self['u'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # usrc + # ---- + @property + def usrc(self): + """ + Sets the source reference on plot.ly for u . + + The 'usrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['usrc'] + + @usrc.setter + def usrc(self, val): + self['usrc'] = val + + # v + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['v'] + + @v.setter + def v(self, val): + self['v'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # vsrc + # ---- + @property + def vsrc(self): + """ + Sets the source reference on plot.ly for v . + + The 'vsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['vsrc'] + + @vsrc.setter + def vsrc(self, val): + self['vsrc'] = val + + # w + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['w'] + + @w.setter + def w(self, val): + self['w'] = val + + # wsrc + # ---- + @property + def wsrc(self): + """ + Sets the source reference on plot.ly for w . + + The 'wsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['wsrc'] + + @wsrc.setter + def wsrc(self, val): + self['wsrc'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # z + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # zsrc + # ---- + @property + def zsrc(self): + """ + Sets the source reference on plot.ly for z . + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['zsrc'] + + @zsrc.setter + def zsrc(self, val): + self['zsrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + anchor + Sets the cones' anchor with respect to their x/y/z + positions. Note that "cm" denote the cone's center of + mass which corresponds to 1/4 from the tail to tip. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here u/v/w norm) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as u/v/w norm. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmax` + must be set as well. + colorbar + plotly.graph_objs.cone.ColorBar instance or dict with + compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.cone.Hoverlabel instance or dict with + compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variable `norm` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + lighting + plotly.graph_objs.cone.Lighting instance or dict with + compatible properties + lightposition + plotly.graph_objs.cone.Lightposition instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + sizemode + Determines whether `sizeref` is set as a "scaled" (i.e + unitless) scalar (normalized by the max u/v/w norm in + the vector field) or as "absolute" value (in the same + units as the vector field). + sizeref + Adjusts the cone size scaling. The size of the cones is + determined by their u/v/w norm multiplied a factor and + `sizeref`. This factor (computed internally) + corresponds to the minimum "time" to travel across two + successive x/y/z positions at the average velocity of + those two successive positions. All cones in a given + trace use the same factor. With `sizemode` set to + "scaled", `sizeref` is unitless, its default value is + 0.5 With `sizemode` set to "absolute", `sizeref` has + the same units as the u/v/w vector field, its the + default value is half the sample's maximum vector norm. + stream + plotly.graph_objs.cone.Stream instance or dict with + compatible properties + text + Sets the text elements associated with the cones. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on plot.ly for text . + u + Sets the x components of the vector field. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + usrc + Sets the source reference on plot.ly for u . + v + Sets the y components of the vector field. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + vsrc + Sets the source reference on plot.ly for v . + w + Sets the z components of the vector field. + wsrc + Sets the source reference on plot.ly for w . + x + Sets the x coordinates of the vector field and of the + displayed cones. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates of the vector field and of the + displayed cones. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the z coordinates of the vector field and of the + displayed cones. + zsrc + Sets the source reference on plot.ly for z . + """ + + def __init__( + self, + arg=None, + anchor=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legendgroup=None, + lighting=None, + lightposition=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + selectedpoints=None, + showlegend=None, + showscale=None, + sizemode=None, + sizeref=None, + stream=None, + text=None, + textsrc=None, + u=None, + uid=None, + uirevision=None, + usrc=None, + v=None, + visible=None, + vsrc=None, + w=None, + wsrc=None, + x=None, + xsrc=None, + y=None, + ysrc=None, + z=None, + zsrc=None, + **kwargs + ): + """ + Construct a new Cone object + + Use cone traces to visualize vector fields. Specify a vector + field using 6 1D arrays, 3 position arrays `x`, `y` and `z` and + 3 vector component arrays `u`, `v`, `w`. The cones are drawn + exactly at the positions given by `x`, `y` and `z`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Cone + anchor + Sets the cones' anchor with respect to their x/y/z + positions. Note that "cm" denote the cone's center of + mass which corresponds to 1/4 from the tail to tip. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here u/v/w norm) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as u/v/w norm. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmax` + must be set as well. + colorbar + plotly.graph_objs.cone.ColorBar instance or dict with + compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.cone.Hoverlabel instance or dict with + compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variable `norm` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + lighting + plotly.graph_objs.cone.Lighting instance or dict with + compatible properties + lightposition + plotly.graph_objs.cone.Lightposition instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + sizemode + Determines whether `sizeref` is set as a "scaled" (i.e + unitless) scalar (normalized by the max u/v/w norm in + the vector field) or as "absolute" value (in the same + units as the vector field). + sizeref + Adjusts the cone size scaling. The size of the cones is + determined by their u/v/w norm multiplied a factor and + `sizeref`. This factor (computed internally) + corresponds to the minimum "time" to travel across two + successive x/y/z positions at the average velocity of + those two successive positions. All cones in a given + trace use the same factor. With `sizemode` set to + "scaled", `sizeref` is unitless, its default value is + 0.5 With `sizemode` set to "absolute", `sizeref` has + the same units as the u/v/w vector field, its the + default value is half the sample's maximum vector norm. + stream + plotly.graph_objs.cone.Stream instance or dict with + compatible properties + text + Sets the text elements associated with the cones. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on plot.ly for text . + u + Sets the x components of the vector field. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + usrc + Sets the source reference on plot.ly for u . + v + Sets the y components of the vector field. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + vsrc + Sets the source reference on plot.ly for v . + w + Sets the z components of the vector field. + wsrc + Sets the source reference on plot.ly for w . + x + Sets the x coordinates of the vector field and of the + displayed cones. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates of the vector field and of the + displayed cones. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the z coordinates of the vector field and of the + displayed cones. + zsrc + Sets the source reference on plot.ly for z . + + Returns + ------- + Cone + """ + super(Cone, self).__init__('cone') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Cone +constructor must be a dict or +an instance of plotly.graph_objs.Cone""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (cone as v_cone) + + # Initialize validators + # --------------------- + self._validators['anchor'] = v_cone.AnchorValidator() + self._validators['autocolorscale'] = v_cone.AutocolorscaleValidator() + self._validators['cauto'] = v_cone.CautoValidator() + self._validators['cmax'] = v_cone.CmaxValidator() + self._validators['cmid'] = v_cone.CmidValidator() + self._validators['cmin'] = v_cone.CminValidator() + self._validators['colorbar'] = v_cone.ColorBarValidator() + self._validators['colorscale'] = v_cone.ColorscaleValidator() + self._validators['customdata'] = v_cone.CustomdataValidator() + self._validators['customdatasrc'] = v_cone.CustomdatasrcValidator() + self._validators['hoverinfo'] = v_cone.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_cone.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_cone.HoverlabelValidator() + self._validators['hovertemplate'] = v_cone.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_cone.HovertemplatesrcValidator() + self._validators['hovertext'] = v_cone.HovertextValidator() + self._validators['hovertextsrc'] = v_cone.HovertextsrcValidator() + self._validators['ids'] = v_cone.IdsValidator() + self._validators['idssrc'] = v_cone.IdssrcValidator() + self._validators['legendgroup'] = v_cone.LegendgroupValidator() + self._validators['lighting'] = v_cone.LightingValidator() + self._validators['lightposition'] = v_cone.LightpositionValidator() + self._validators['name'] = v_cone.NameValidator() + self._validators['opacity'] = v_cone.OpacityValidator() + self._validators['reversescale'] = v_cone.ReversescaleValidator() + self._validators['scene'] = v_cone.SceneValidator() + self._validators['selectedpoints'] = v_cone.SelectedpointsValidator() + self._validators['showlegend'] = v_cone.ShowlegendValidator() + self._validators['showscale'] = v_cone.ShowscaleValidator() + self._validators['sizemode'] = v_cone.SizemodeValidator() + self._validators['sizeref'] = v_cone.SizerefValidator() + self._validators['stream'] = v_cone.StreamValidator() + self._validators['text'] = v_cone.TextValidator() + self._validators['textsrc'] = v_cone.TextsrcValidator() + self._validators['u'] = v_cone.UValidator() + self._validators['uid'] = v_cone.UidValidator() + self._validators['uirevision'] = v_cone.UirevisionValidator() + self._validators['usrc'] = v_cone.UsrcValidator() + self._validators['v'] = v_cone.VValidator() + self._validators['visible'] = v_cone.VisibleValidator() + self._validators['vsrc'] = v_cone.VsrcValidator() + self._validators['w'] = v_cone.WValidator() + self._validators['wsrc'] = v_cone.WsrcValidator() + self._validators['x'] = v_cone.XValidator() + self._validators['xsrc'] = v_cone.XsrcValidator() + self._validators['y'] = v_cone.YValidator() + self._validators['ysrc'] = v_cone.YsrcValidator() + self._validators['z'] = v_cone.ZValidator() + self._validators['zsrc'] = v_cone.ZsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('anchor', None) + self['anchor'] = anchor if anchor is not None else _v + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('lighting', None) + self['lighting'] = lighting if lighting is not None else _v + _v = arg.pop('lightposition', None) + self['lightposition' + ] = lightposition if lightposition is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('scene', None) + self['scene'] = scene if scene is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('sizemode', None) + self['sizemode'] = sizemode if sizemode is not None else _v + _v = arg.pop('sizeref', None) + self['sizeref'] = sizeref if sizeref is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('u', None) + self['u'] = u if u is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('usrc', None) + self['usrc'] = usrc if usrc is not None else _v + _v = arg.pop('v', None) + self['v'] = v if v is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('vsrc', None) + self['vsrc'] = vsrc if vsrc is not None else _v + _v = arg.pop('w', None) + self['w'] = w if w is not None else _v + _v = arg.pop('wsrc', None) + self['wsrc'] = wsrc if wsrc is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + _v = arg.pop('zsrc', None) + self['zsrc'] = zsrc if zsrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'cone' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='cone', val='cone' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Choropleth(_BaseTraceType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of plotly.graph_objs.choropleth.ColorBar + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Supported dict properties: + + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.choropleth.colorbar.Tickforma + tstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.choropleth.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of choropleth.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.choropleth.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + choropleth.colorbar.title.font instead. Sets + this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + choropleth.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.choropleth.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. The colorscale must be an array containing + arrays mapping a normalized value to an rgb, rgba, hex, hsl, + hsv, or named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # geo + # --- + @property + def geo(self): + """ + Sets a reference between this trace's geospatial coordinates + and a geographic map. If "geo" (the default value), the + geospatial coordinates refer to `layout.geo`. If "geo2", the + geospatial coordinates refer to `layout.geo2`, and so on. + + The 'geo' property is an identifier of a particular + subplot, of type 'geo', that may be specified as the string 'geo' + optionally followed by an integer >= 1 + (e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.) + + Returns + ------- + str + """ + return self['geo'] + + @geo.setter + def geo(self, val): + self['geo'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'location+z') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.choropleth.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.choropleth.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # locationmode + # ------------ + @property + def locationmode(self): + """ + Determines the set of locations used to match entries in + `locations` to regions on the map. + + The 'locationmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['ISO-3', 'USA-states', 'country names'] + + Returns + ------- + Any + """ + return self['locationmode'] + + @locationmode.setter + def locationmode(self, val): + self['locationmode'] = val + + # locations + # --------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['locations'] + + @locations.setter + def locations(self, val): + self['locations'] = val + + # locationssrc + # ------------ + @property + def locationssrc(self): + """ + Sets the source reference on plot.ly for locations . + + The 'locationssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['locationssrc'] + + @locationssrc.setter + def locationssrc(self, val): + self['locationssrc'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of plotly.graph_objs.choropleth.Marker + - A dict of string/value properties that will be passed + to the Marker constructor + + Supported dict properties: + + line + plotly.graph_objs.choropleth.marker.Line + instance or dict with compatible properties + opacity + Sets the opacity of the locations. + opacitysrc + Sets the source reference on plot.ly for + opacity . + + Returns + ------- + plotly.graph_objs.choropleth.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # reversescale + # ------------ + @property + 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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # selected + # -------- + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of plotly.graph_objs.choropleth.Selected + - A dict of string/value properties that will be passed + to the Selected constructor + + Supported dict properties: + + marker + plotly.graph_objs.choropleth.selected.Marker + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.choropleth.Selected + """ + return self['selected'] + + @selected.setter + def selected(self, val): + self['selected'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.choropleth.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.choropleth.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # unselected + # ---------- + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of plotly.graph_objs.choropleth.Unselected + - A dict of string/value properties that will be passed + to the Unselected constructor + + Supported dict properties: + + marker + plotly.graph_objs.choropleth.unselected.Marker + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.choropleth.Unselected + """ + return self['unselected'] + + @unselected.setter + def unselected(self, val): + self['unselected'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # z + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # zauto + # ----- + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['zauto'] + + @zauto.setter + def zauto(self, val): + self['zauto'] = val + + # zmax + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmax'] + + @zmax.setter + def zmax(self, val): + self['zmax'] = val + + # zmid + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmid'] + + @zmid.setter + def zmid(self, val): + self['zmid'] = val + + # zmin + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zmin'] + + @zmin.setter + def zmin(self, val): + self['zmin'] = val + + # zsrc + # ---- + @property + def zsrc(self): + """ + Sets the source reference on plot.ly for z . + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['zsrc'] + + @zsrc.setter + def zsrc(self, val): + self['zsrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + colorbar + plotly.graph_objs.choropleth.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + geo + Sets a reference between this trace's geospatial + coordinates and a geographic map. If "geo" (the default + value), the geospatial coordinates refer to + `layout.geo`. If "geo2", the geospatial coordinates + refer to `layout.geo2`, and so on. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.choropleth.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + locationmode + Determines the set of locations used to match entries + in `locations` to regions on the map. + locations + Sets the coordinates via location IDs or names. See + `locationmode` for more info. + locationssrc + Sets the source reference on plot.ly for locations . + marker + plotly.graph_objs.choropleth.Marker instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selected + plotly.graph_objs.choropleth.Selected instance or dict + with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.choropleth.Stream instance or dict + with compatible properties + text + Sets the text elements associated with each location. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.choropleth.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + z + Sets the color values. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on plot.ly for z . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + geo=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legendgroup=None, + locationmode=None, + locations=None, + locationssrc=None, + marker=None, + name=None, + opacity=None, + reversescale=None, + selected=None, + selectedpoints=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + z=None, + zauto=None, + zmax=None, + zmid=None, + zmin=None, + zsrc=None, + **kwargs + ): + """ + Construct a new Choropleth object + + The data that describes the choropleth value-to-color mapping + is set in `z`. The geographic locations corresponding to each + value in `z` are set in `locations`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Choropleth + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + colorbar + plotly.graph_objs.choropleth.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + geo + Sets a reference between this trace's geospatial + coordinates and a geographic map. If "geo" (the default + value), the geospatial coordinates refer to + `layout.geo`. If "geo2", the geospatial coordinates + refer to `layout.geo2`, and so on. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.choropleth.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + locationmode + Determines the set of locations used to match entries + in `locations` to regions on the map. + locations + Sets the coordinates via location IDs or names. See + `locationmode` for more info. + locationssrc + Sets the source reference on plot.ly for locations . + marker + plotly.graph_objs.choropleth.Marker instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selected + plotly.graph_objs.choropleth.Selected instance or dict + with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + plotly.graph_objs.choropleth.Stream instance or dict + with compatible properties + text + Sets the text elements associated with each location. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.choropleth.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + z + Sets the color values. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on plot.ly for z . + + Returns + ------- + Choropleth + """ + super(Choropleth, self).__init__('choropleth') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Choropleth +constructor must be a dict or +an instance of plotly.graph_objs.Choropleth""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (choropleth as v_choropleth) + + # Initialize validators + # --------------------- + self._validators['autocolorscale' + ] = v_choropleth.AutocolorscaleValidator() + self._validators['colorbar'] = v_choropleth.ColorBarValidator() + self._validators['colorscale'] = v_choropleth.ColorscaleValidator() + self._validators['customdata'] = v_choropleth.CustomdataValidator() + self._validators['customdatasrc' + ] = v_choropleth.CustomdatasrcValidator() + self._validators['geo'] = v_choropleth.GeoValidator() + self._validators['hoverinfo'] = v_choropleth.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_choropleth.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_choropleth.HoverlabelValidator() + self._validators['hovertemplate' + ] = v_choropleth.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_choropleth.HovertemplatesrcValidator() + self._validators['hovertext'] = v_choropleth.HovertextValidator() + self._validators['hovertextsrc'] = v_choropleth.HovertextsrcValidator() + self._validators['ids'] = v_choropleth.IdsValidator() + self._validators['idssrc'] = v_choropleth.IdssrcValidator() + self._validators['legendgroup'] = v_choropleth.LegendgroupValidator() + self._validators['locationmode'] = v_choropleth.LocationmodeValidator() + self._validators['locations'] = v_choropleth.LocationsValidator() + self._validators['locationssrc'] = v_choropleth.LocationssrcValidator() + self._validators['marker'] = v_choropleth.MarkerValidator() + self._validators['name'] = v_choropleth.NameValidator() + self._validators['opacity'] = v_choropleth.OpacityValidator() + self._validators['reversescale'] = v_choropleth.ReversescaleValidator() + self._validators['selected'] = v_choropleth.SelectedValidator() + self._validators['selectedpoints' + ] = v_choropleth.SelectedpointsValidator() + self._validators['showlegend'] = v_choropleth.ShowlegendValidator() + self._validators['showscale'] = v_choropleth.ShowscaleValidator() + self._validators['stream'] = v_choropleth.StreamValidator() + self._validators['text'] = v_choropleth.TextValidator() + self._validators['textsrc'] = v_choropleth.TextsrcValidator() + self._validators['uid'] = v_choropleth.UidValidator() + self._validators['uirevision'] = v_choropleth.UirevisionValidator() + self._validators['unselected'] = v_choropleth.UnselectedValidator() + self._validators['visible'] = v_choropleth.VisibleValidator() + self._validators['z'] = v_choropleth.ZValidator() + self._validators['zauto'] = v_choropleth.ZautoValidator() + self._validators['zmax'] = v_choropleth.ZmaxValidator() + self._validators['zmid'] = v_choropleth.ZmidValidator() + self._validators['zmin'] = v_choropleth.ZminValidator() + self._validators['zsrc'] = v_choropleth.ZsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('geo', None) + self['geo'] = geo if geo is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('locationmode', None) + self['locationmode'] = locationmode if locationmode is not None else _v + _v = arg.pop('locations', None) + self['locations'] = locations if locations is not None else _v + _v = arg.pop('locationssrc', None) + self['locationssrc'] = locationssrc if locationssrc is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('selected', None) + self['selected'] = selected if selected is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('unselected', None) + self['unselected'] = unselected if unselected is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + _v = arg.pop('zauto', None) + self['zauto'] = zauto if zauto is not None else _v + _v = arg.pop('zmax', None) + self['zmax'] = zmax if zmax is not None else _v + _v = arg.pop('zmid', None) + self['zmid'] = zmid if zmid is not None else _v + _v = arg.pop('zmin', None) + self['zmin'] = zmin if zmin is not None else _v + _v = arg.pop('zsrc', None) + self['zsrc'] = zsrc if zsrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'choropleth' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='choropleth', val='choropleth' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Carpet(_BaseTraceType): + + # a + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['a'] + + @a.setter + def a(self, val): + self['a'] = val + + # a0 + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['a0'] + + @a0.setter + def a0(self, val): + self['a0'] = val + + # aaxis + # ----- + @property + def aaxis(self): + """ + The 'aaxis' property is an instance of Aaxis + that may be specified as: + - An instance of plotly.graph_objs.carpet.Aaxis + - A dict of string/value properties that will be passed + to the Aaxis constructor + + Supported dict properties: + + arraydtick + The stride between grid lines along the axis + arraytick0 + The starting index of grid lines along the axis + autorange + Determines whether or not the range of this + axis is computed in relation to the input data. + See `rangemode` for more info. If `range` is + provided, then `autorange` is set to False. + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + cheatertype + + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + The stride between grid lines along the axis + endline + Determines whether or not a line is drawn at + along the final value of this axis. If True, + the end line is drawn on top of the grid lines. + endlinecolor + Sets the line color of the end line. + endlinewidth + Sets the width (in px) of the end line. + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom- + able. If true, then zoom is disabled. + gridcolor + Sets the axis line color. + gridwidth + Sets the width (in px) of the axis line. + labelpadding + Extra padding between label and the axis + labelprefix + Sets a axis label prefix. + labelsuffix + Sets a axis label suffix. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + minorgridcolor + Sets the color of the grid lines. + minorgridcount + Sets the number of minor grid ticks per major + grid tick + minorgridwidth + Sets the width (in px) of the grid lines. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + range + Sets the range of this axis. If the axis `type` + is "log", then you must take the log of your + desired range (e.g. to set the range from 1 to + 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, + like date data, though Date objects and unix + milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it + should be numbers, using the scale where each + category is assigned a serial number from zero + in the order it appears. + rangemode + If "normal", the range is computed in relation + to the extrema of the input data. If *tozero*`, + the range extends to 0, regardless of the input + data If "nonnegative", the range is non- + negative, regardless of the input data. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showticklabels + Determines whether axis labels are drawn on the + low side, the high side, both, or neither side + of the axis. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + smoothing + + startline + Determines whether or not a line is drawn at + along the starting value of this axis. If True, + the start line is drawn on top of the grid + lines. + startlinecolor + Sets the line color of the start line. + startlinewidth + Sets the width (in px) of the start line. + tick0 + The starting index of grid lines along the axis + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.carpet.aaxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.carpet.aaxis.tickformatstopdefaults), sets + the default property values to use for elements + of carpet.aaxis.tickformatstops + tickmode + + tickprefix + Sets a tick label prefix. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + title + plotly.graph_objs.carpet.aaxis.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use carpet.aaxis.title.font + instead. Sets this axis' title font. Note that + the title's font used to be set by the now + deprecated `titlefont` attribute. + titleoffset + Deprecated: Please use + carpet.aaxis.title.offset instead. An + additional amount by which to offset the title + from the tick labels, given in pixels. Note + that this used to be set by the now deprecated + `titleoffset` attribute. + type + Sets the axis type. By default, plotly attempts + to determined the axis type by looking into the + data of the traces that referenced the axis in + question. + + Returns + ------- + plotly.graph_objs.carpet.Aaxis + """ + return self['aaxis'] + + @aaxis.setter + def aaxis(self, val): + self['aaxis'] = val + + # asrc + # ---- + @property + def asrc(self): + """ + Sets the source reference on plot.ly for a . + + The 'asrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['asrc'] + + @asrc.setter + def asrc(self, val): + self['asrc'] = val + + # b + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['b'] + + @b.setter + def b(self, val): + self['b'] = val + + # b0 + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['b0'] + + @b0.setter + def b0(self, val): + self['b0'] = val + + # baxis + # ----- + @property + def baxis(self): + """ + The 'baxis' property is an instance of Baxis + that may be specified as: + - An instance of plotly.graph_objs.carpet.Baxis + - A dict of string/value properties that will be passed + to the Baxis constructor + + Supported dict properties: + + arraydtick + The stride between grid lines along the axis + arraytick0 + The starting index of grid lines along the axis + autorange + Determines whether or not the range of this + axis is computed in relation to the input data. + See `rangemode` for more info. If `range` is + provided, then `autorange` is set to False. + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + cheatertype + + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + The stride between grid lines along the axis + endline + Determines whether or not a line is drawn at + along the final value of this axis. If True, + the end line is drawn on top of the grid lines. + endlinecolor + Sets the line color of the end line. + endlinewidth + Sets the width (in px) of the end line. + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom- + able. If true, then zoom is disabled. + gridcolor + Sets the axis line color. + gridwidth + Sets the width (in px) of the axis line. + labelpadding + Extra padding between label and the axis + labelprefix + Sets a axis label prefix. + labelsuffix + Sets a axis label suffix. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + minorgridcolor + Sets the color of the grid lines. + minorgridcount + Sets the number of minor grid ticks per major + grid tick + minorgridwidth + Sets the width (in px) of the grid lines. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + range + Sets the range of this axis. If the axis `type` + is "log", then you must take the log of your + desired range (e.g. to set the range from 1 to + 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, + like date data, though Date objects and unix + milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it + should be numbers, using the scale where each + category is assigned a serial number from zero + in the order it appears. + rangemode + If "normal", the range is computed in relation + to the extrema of the input data. If *tozero*`, + the range extends to 0, regardless of the input + data If "nonnegative", the range is non- + negative, regardless of the input data. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showticklabels + Determines whether axis labels are drawn on the + low side, the high side, both, or neither side + of the axis. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + smoothing + + startline + Determines whether or not a line is drawn at + along the starting value of this axis. If True, + the start line is drawn on top of the grid + lines. + startlinecolor + Sets the line color of the start line. + startlinewidth + Sets the width (in px) of the start line. + tick0 + The starting index of grid lines along the axis + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.carpet.baxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.carpet.baxis.tickformatstopdefaults), sets + the default property values to use for elements + of carpet.baxis.tickformatstops + tickmode + + tickprefix + Sets a tick label prefix. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + title + plotly.graph_objs.carpet.baxis.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use carpet.baxis.title.font + instead. Sets this axis' title font. Note that + the title's font used to be set by the now + deprecated `titlefont` attribute. + titleoffset + Deprecated: Please use + carpet.baxis.title.offset instead. An + additional amount by which to offset the title + from the tick labels, given in pixels. Note + that this used to be set by the now deprecated + `titleoffset` attribute. + type + Sets the axis type. By default, plotly attempts + to determined the axis type by looking into the + data of the traces that referenced the axis in + question. + + Returns + ------- + plotly.graph_objs.carpet.Baxis + """ + return self['baxis'] + + @baxis.setter + def baxis(self, val): + self['baxis'] = val + + # bsrc + # ---- + @property + def bsrc(self): + """ + Sets the source reference on plot.ly for b . + + The 'bsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bsrc'] + + @bsrc.setter + def bsrc(self, val): + self['bsrc'] = val + + # carpet + # ------ + @property + def carpet(self): + """ + An identifier for this carpet, so that `scattercarpet` and + `scattercontour` traces can specify a carpet plot on which they + lie + + The 'carpet' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['carpet'] + + @carpet.setter + def carpet(self, val): + self['carpet'] = val + + # cheaterslope + # ------------ + @property + 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 + + Returns + ------- + int|float + """ + return self['cheaterslope'] + + @cheaterslope.setter + def cheaterslope(self, val): + self['cheaterslope'] = val + + # color + # ----- + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # da + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['da'] + + @da.setter + def da(self, val): + self['da'] = val + + # db + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['db'] + + @db.setter + def db(self, val): + self['db'] = val + + # font + # ---- + @property + 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 plotly.graph_objs.carpet.Font + - A dict of string/value properties that will be passed + to the Font constructor + + Supported dict properties: + + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.carpet.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.carpet.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.carpet.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.carpet.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.carpet.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + a + An array containing values of the first parameter value + a0 + Alternate to `a`. Builds a linear space of a + coordinates. Use with `da` where `a0` is the starting + coordinate and `da` the step. + aaxis + plotly.graph_objs.carpet.Aaxis instance or dict with + compatible properties + asrc + Sets the source reference on plot.ly for a . + b + A two dimensional array of y coordinates at each carpet + point. + b0 + Alternate to `b`. Builds a linear space of a + coordinates. Use with `db` where `b0` is the starting + coordinate and `db` the step. + baxis + plotly.graph_objs.carpet.Baxis instance or dict with + compatible properties + bsrc + Sets the source reference on plot.ly for b . + carpet + An identifier for this carpet, so that `scattercarpet` + and `scattercontour` traces can specify a carpet plot + on which they lie + cheaterslope + The shift applied to each successive row of data in + creating a cheater plot. Only used if `x` is been + ommitted. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + da + Sets the a coordinate step. See `a0` for more info. + db + Sets the b coordinate step. See `b0` for more info. + font + The default font used for axis & tick labels on this + carpet + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.carpet.Hoverlabel instance or dict + with compatible properties + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.carpet.Stream instance or dict with + compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + A two dimensional array of x coordinates at each carpet + point. If ommitted, the plot is a cheater plot and the + xaxis is hidden by default. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xsrc + Sets the source reference on plot.ly for x . + y + A two dimensional array of y coordinates at each carpet + point. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ysrc + Sets the source reference on plot.ly for y . + """ + + def __init__( + self, + arg=None, + a=None, + a0=None, + aaxis=None, + asrc=None, + b=None, + b0=None, + baxis=None, + bsrc=None, + carpet=None, + cheaterslope=None, + color=None, + customdata=None, + customdatasrc=None, + da=None, + db=None, + font=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + ids=None, + idssrc=None, + legendgroup=None, + name=None, + opacity=None, + selectedpoints=None, + showlegend=None, + stream=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xsrc=None, + y=None, + yaxis=None, + ysrc=None, + **kwargs + ): + """ + Construct a new Carpet object + + The data describing carpet axis layout is set in `y` and + (optionally) also `x`. If only `y` is present, `x` the plot is + interpreted as a cheater plot and is filled in using the `y` + values. `x` and `y` may either be 2D arrays matching with each + dimension matching that of `a` and `b`, or they may be 1D + arrays with total length equal to that of `a` and `b`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Carpet + a + An array containing values of the first parameter value + a0 + Alternate to `a`. Builds a linear space of a + coordinates. Use with `da` where `a0` is the starting + coordinate and `da` the step. + aaxis + plotly.graph_objs.carpet.Aaxis instance or dict with + compatible properties + asrc + Sets the source reference on plot.ly for a . + b + A two dimensional array of y coordinates at each carpet + point. + b0 + Alternate to `b`. Builds a linear space of a + coordinates. Use with `db` where `b0` is the starting + coordinate and `db` the step. + baxis + plotly.graph_objs.carpet.Baxis instance or dict with + compatible properties + bsrc + Sets the source reference on plot.ly for b . + carpet + An identifier for this carpet, so that `scattercarpet` + and `scattercontour` traces can specify a carpet plot + on which they lie + cheaterslope + The shift applied to each successive row of data in + creating a cheater plot. Only used if `x` is been + ommitted. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + da + Sets the a coordinate step. See `a0` for more info. + db + Sets the b coordinate step. See `b0` for more info. + font + The default font used for axis & tick labels on this + carpet + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.carpet.Hoverlabel instance or dict + with compatible properties + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.carpet.Stream instance or dict with + compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x + A two dimensional array of x coordinates at each carpet + point. If ommitted, the plot is a cheater plot and the + xaxis is hidden by default. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xsrc + Sets the source reference on plot.ly for x . + y + A two dimensional array of y coordinates at each carpet + point. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ysrc + Sets the source reference on plot.ly for y . + + Returns + ------- + Carpet + """ + super(Carpet, self).__init__('carpet') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Carpet +constructor must be a dict or +an instance of plotly.graph_objs.Carpet""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (carpet as v_carpet) + + # Initialize validators + # --------------------- + self._validators['a'] = v_carpet.AValidator() + self._validators['a0'] = v_carpet.A0Validator() + self._validators['aaxis'] = v_carpet.AaxisValidator() + self._validators['asrc'] = v_carpet.AsrcValidator() + self._validators['b'] = v_carpet.BValidator() + self._validators['b0'] = v_carpet.B0Validator() + self._validators['baxis'] = v_carpet.BaxisValidator() + self._validators['bsrc'] = v_carpet.BsrcValidator() + self._validators['carpet'] = v_carpet.CarpetValidator() + self._validators['cheaterslope'] = v_carpet.CheaterslopeValidator() + self._validators['color'] = v_carpet.ColorValidator() + self._validators['customdata'] = v_carpet.CustomdataValidator() + self._validators['customdatasrc'] = v_carpet.CustomdatasrcValidator() + self._validators['da'] = v_carpet.DaValidator() + self._validators['db'] = v_carpet.DbValidator() + self._validators['font'] = v_carpet.FontValidator() + self._validators['hoverinfo'] = v_carpet.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_carpet.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_carpet.HoverlabelValidator() + self._validators['ids'] = v_carpet.IdsValidator() + self._validators['idssrc'] = v_carpet.IdssrcValidator() + self._validators['legendgroup'] = v_carpet.LegendgroupValidator() + self._validators['name'] = v_carpet.NameValidator() + self._validators['opacity'] = v_carpet.OpacityValidator() + self._validators['selectedpoints'] = v_carpet.SelectedpointsValidator() + self._validators['showlegend'] = v_carpet.ShowlegendValidator() + self._validators['stream'] = v_carpet.StreamValidator() + self._validators['uid'] = v_carpet.UidValidator() + self._validators['uirevision'] = v_carpet.UirevisionValidator() + self._validators['visible'] = v_carpet.VisibleValidator() + self._validators['x'] = v_carpet.XValidator() + self._validators['xaxis'] = v_carpet.XAxisValidator() + self._validators['xsrc'] = v_carpet.XsrcValidator() + self._validators['y'] = v_carpet.YValidator() + self._validators['yaxis'] = v_carpet.YAxisValidator() + self._validators['ysrc'] = v_carpet.YsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('a', None) + self['a'] = a if a is not None else _v + _v = arg.pop('a0', None) + self['a0'] = a0 if a0 is not None else _v + _v = arg.pop('aaxis', None) + self['aaxis'] = aaxis if aaxis is not None else _v + _v = arg.pop('asrc', None) + self['asrc'] = asrc if asrc is not None else _v + _v = arg.pop('b', None) + self['b'] = b if b is not None else _v + _v = arg.pop('b0', None) + self['b0'] = b0 if b0 is not None else _v + _v = arg.pop('baxis', None) + self['baxis'] = baxis if baxis is not None else _v + _v = arg.pop('bsrc', None) + self['bsrc'] = bsrc if bsrc is not None else _v + _v = arg.pop('carpet', None) + self['carpet'] = carpet if carpet is not None else _v + _v = arg.pop('cheaterslope', None) + self['cheaterslope'] = cheaterslope if cheaterslope is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('da', None) + self['da'] = da if da is not None else _v + _v = arg.pop('db', None) + self['db'] = db if db is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'carpet' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='carpet', val='carpet' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Candlestick(_BaseTraceType): + + # close + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['close'] + + @close.setter + def close(self, val): + self['close'] = val + + # closesrc + # -------- + @property + def closesrc(self): + """ + Sets the source reference on plot.ly for close . + + The 'closesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['closesrc'] + + @closesrc.setter + def closesrc(self, val): + self['closesrc'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # decreasing + # ---------- + @property + def decreasing(self): + """ + The 'decreasing' property is an instance of Decreasing + that may be specified as: + - An instance of plotly.graph_objs.candlestick.Decreasing + - A dict of string/value properties that will be passed + to the Decreasing constructor + + Supported dict properties: + + fillcolor + Sets the fill color. Defaults to a half- + transparent variant of the line color, marker + color, or marker line color, whichever is + available. + line + plotly.graph_objs.candlestick.decreasing.Line + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.candlestick.Decreasing + """ + return self['decreasing'] + + @decreasing.setter + def decreasing(self, val): + self['decreasing'] = val + + # high + # ---- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['high'] + + @high.setter + def high(self, val): + self['high'] = val + + # highsrc + # ------- + @property + def highsrc(self): + """ + Sets the source reference on plot.ly for high . + + The 'highsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['highsrc'] + + @highsrc.setter + def highsrc(self, val): + self['highsrc'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.candlestick.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + split + Show hover information (open, close, high, low) + in separate labels. + + Returns + ------- + plotly.graph_objs.candlestick.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertext + # --------- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # increasing + # ---------- + @property + def increasing(self): + """ + The 'increasing' property is an instance of Increasing + that may be specified as: + - An instance of plotly.graph_objs.candlestick.Increasing + - A dict of string/value properties that will be passed + to the Increasing constructor + + Supported dict properties: + + fillcolor + Sets the fill color. Defaults to a half- + transparent variant of the line color, marker + color, or marker line color, whichever is + available. + line + plotly.graph_objs.candlestick.increasing.Line + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.candlestick.Increasing + """ + return self['increasing'] + + @increasing.setter + def increasing(self, val): + self['increasing'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of plotly.graph_objs.candlestick.Line + - A dict of string/value properties that will be passed + to the Line constructor + + Supported dict properties: + + width + Sets the width (in px) of line bounding the + box(es). Note that this style setting can also + be set per direction via + `increasing.line.width` and + `decreasing.line.width`. + + Returns + ------- + plotly.graph_objs.candlestick.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # low + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['low'] + + @low.setter + def low(self, val): + self['low'] = val + + # lowsrc + # ------ + @property + def lowsrc(self): + """ + Sets the source reference on plot.ly for low . + + The 'lowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['lowsrc'] + + @lowsrc.setter + def lowsrc(self, val): + self['lowsrc'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # open + # ---- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['open'] + + @open.setter + def open(self, val): + self['open'] = val + + # opensrc + # ------- + @property + def opensrc(self): + """ + Sets the source reference on plot.ly for open . + + The 'opensrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['opensrc'] + + @opensrc.setter + def opensrc(self, val): + self['opensrc'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.candlestick.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.candlestick.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + def text(self): + """ + Sets hover text elements associated with each sample point. If + a single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + this trace's sample points. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # whiskerwidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['whiskerwidth'] + + @whiskerwidth.setter + def whiskerwidth(self, val): + self['whiskerwidth'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # xcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['xcalendar'] + + @xcalendar.setter + def xcalendar(self, val): + self['xcalendar'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + close + Sets the close values. + closesrc + Sets the source reference on plot.ly for close . + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + decreasing + plotly.graph_objs.candlestick.Decreasing instance or + dict with compatible properties + high + Sets the high values. + highsrc + Sets the source reference on plot.ly for high . + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.candlestick.Hoverlabel instance or + dict with compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + increasing + plotly.graph_objs.candlestick.Increasing instance or + dict with compatible properties + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.candlestick.Line instance or dict + with compatible properties + low + Sets the low values. + lowsrc + Sets the source reference on plot.ly for low . + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + open + Sets the open values. + opensrc + Sets the source reference on plot.ly for open . + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.candlestick.Stream instance or dict + with compatible properties + text + Sets hover text elements associated with each sample + point. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to this trace's sample points. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + whiskerwidth + Sets the width of the whiskers relative to the box' + width. For example, with 1, the whiskers are as wide as + the box(es). + x + Sets the x coordinates. If absent, linear coordinate + will be generated. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + """ + + def __init__( + self, + arg=None, + close=None, + closesrc=None, + customdata=None, + customdatasrc=None, + decreasing=None, + high=None, + highsrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + increasing=None, + legendgroup=None, + line=None, + low=None, + lowsrc=None, + name=None, + opacity=None, + open=None, + opensrc=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + whiskerwidth=None, + x=None, + xaxis=None, + xcalendar=None, + xsrc=None, + yaxis=None, + **kwargs + ): + """ + Construct a new Candlestick object + + The candlestick is a style of financial chart describing open, + high, low and close for a given `x` coordinate (most likely + time). The boxes represent the spread between the `open` and + `close` values and the lines represent the spread between the + `low` and `high` values Sample points where the close value is + higher (lower) then the open value are called increasing + (decreasing). By default, increasing candles are drawn in green + whereas decreasing are drawn in red. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Candlestick + close + Sets the close values. + closesrc + Sets the source reference on plot.ly for close . + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + decreasing + plotly.graph_objs.candlestick.Decreasing instance or + dict with compatible properties + high + Sets the high values. + highsrc + Sets the source reference on plot.ly for high . + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.candlestick.Hoverlabel instance or + dict with compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + increasing + plotly.graph_objs.candlestick.Increasing instance or + dict with compatible properties + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.candlestick.Line instance or dict + with compatible properties + low + Sets the low values. + lowsrc + Sets the source reference on plot.ly for low . + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + open + Sets the open values. + opensrc + Sets the source reference on plot.ly for open . + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.candlestick.Stream instance or dict + with compatible properties + text + Sets hover text elements associated with each sample + point. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to this trace's sample points. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + whiskerwidth + Sets the width of the whiskers relative to the box' + width. For example, with 1, the whiskers are as wide as + the box(es). + x + Sets the x coordinates. If absent, linear coordinate + will be generated. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + + Returns + ------- + Candlestick + """ + super(Candlestick, self).__init__('candlestick') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Candlestick +constructor must be a dict or +an instance of plotly.graph_objs.Candlestick""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (candlestick as v_candlestick) + + # Initialize validators + # --------------------- + self._validators['close'] = v_candlestick.CloseValidator() + self._validators['closesrc'] = v_candlestick.ClosesrcValidator() + self._validators['customdata'] = v_candlestick.CustomdataValidator() + self._validators['customdatasrc' + ] = v_candlestick.CustomdatasrcValidator() + self._validators['decreasing'] = v_candlestick.DecreasingValidator() + self._validators['high'] = v_candlestick.HighValidator() + self._validators['highsrc'] = v_candlestick.HighsrcValidator() + self._validators['hoverinfo'] = v_candlestick.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_candlestick.HoverinfosrcValidator( + ) + self._validators['hoverlabel'] = v_candlestick.HoverlabelValidator() + self._validators['hovertext'] = v_candlestick.HovertextValidator() + self._validators['hovertextsrc'] = v_candlestick.HovertextsrcValidator( + ) + self._validators['ids'] = v_candlestick.IdsValidator() + self._validators['idssrc'] = v_candlestick.IdssrcValidator() + self._validators['increasing'] = v_candlestick.IncreasingValidator() + self._validators['legendgroup'] = v_candlestick.LegendgroupValidator() + self._validators['line'] = v_candlestick.LineValidator() + self._validators['low'] = v_candlestick.LowValidator() + self._validators['lowsrc'] = v_candlestick.LowsrcValidator() + self._validators['name'] = v_candlestick.NameValidator() + self._validators['opacity'] = v_candlestick.OpacityValidator() + self._validators['open'] = v_candlestick.OpenValidator() + self._validators['opensrc'] = v_candlestick.OpensrcValidator() + self._validators['selectedpoints' + ] = v_candlestick.SelectedpointsValidator() + self._validators['showlegend'] = v_candlestick.ShowlegendValidator() + self._validators['stream'] = v_candlestick.StreamValidator() + self._validators['text'] = v_candlestick.TextValidator() + self._validators['textsrc'] = v_candlestick.TextsrcValidator() + self._validators['uid'] = v_candlestick.UidValidator() + self._validators['uirevision'] = v_candlestick.UirevisionValidator() + self._validators['visible'] = v_candlestick.VisibleValidator() + self._validators['whiskerwidth'] = v_candlestick.WhiskerwidthValidator( + ) + self._validators['x'] = v_candlestick.XValidator() + self._validators['xaxis'] = v_candlestick.XAxisValidator() + self._validators['xcalendar'] = v_candlestick.XcalendarValidator() + self._validators['xsrc'] = v_candlestick.XsrcValidator() + self._validators['yaxis'] = v_candlestick.YAxisValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('close', None) + self['close'] = close if close is not None else _v + _v = arg.pop('closesrc', None) + self['closesrc'] = closesrc if closesrc is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('decreasing', None) + self['decreasing'] = decreasing if decreasing is not None else _v + _v = arg.pop('high', None) + self['high'] = high if high is not None else _v + _v = arg.pop('highsrc', None) + self['highsrc'] = highsrc if highsrc is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('increasing', None) + self['increasing'] = increasing if increasing is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('low', None) + self['low'] = low if low is not None else _v + _v = arg.pop('lowsrc', None) + self['lowsrc'] = lowsrc if lowsrc is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('open', None) + self['open'] = open if open is not None else _v + _v = arg.pop('opensrc', None) + self['opensrc'] = opensrc if opensrc is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('whiskerwidth', None) + self['whiskerwidth'] = whiskerwidth if whiskerwidth is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('xcalendar', None) + self['xcalendar'] = xcalendar if xcalendar is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'candlestick' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='candlestick', val='candlestick' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Box(_BaseTraceType): + + # alignmentgroup + # -------------- + @property + 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 + + Returns + ------- + str + """ + return self['alignmentgroup'] + + @alignmentgroup.setter + def alignmentgroup(self, val): + self['alignmentgroup'] = val + + # boxmean + # ------- + @property + def boxmean(self): + """ + If True, the mean of the box(es)' underlying distribution is + drawn as a dashed line inside the box(es). If "sd" the standard + deviation is also drawn. + + The 'boxmean' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, 'sd', False] + + Returns + ------- + Any + """ + return self['boxmean'] + + @boxmean.setter + def boxmean(self, val): + self['boxmean'] = val + + # boxpoints + # --------- + @property + def boxpoints(self): + """ + If "outliers", only the sample points lying outside the + whiskers are shown If "suspectedoutliers", the outlier points + are shown and points either less than 4*Q1-3*Q3 or greater than + 4*Q3-3*Q1 are highlighted (see `outliercolor`) If "all", all + sample points are shown If False, only the box(es) are shown + with no sample points + + The 'boxpoints' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'outliers', 'suspectedoutliers', False] + + Returns + ------- + Any + """ + return self['boxpoints'] + + @boxpoints.setter + def boxpoints(self, val): + self['boxpoints'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # fillcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['fillcolor'] + + @fillcolor.setter + def fillcolor(self, val): + self['fillcolor'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.box.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.box.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hoveron + # ------- + @property + 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 + (e.g. 'boxes+points') + + Returns + ------- + Any + """ + return self['hoveron'] + + @hoveron.setter + def hoveron(self, val): + self['hoveron'] = val + + # hovertext + # --------- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # jitter + # ------ + @property + def jitter(self): + """ + Sets the amount of jitter in the sample points drawn. If 0, the + sample points align along the distribution axis. If 1, the + sample points are drawn in a random jitter of width equal to + the width of the box(es). + + The 'jitter' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self['jitter'] + + @jitter.setter + def jitter(self, val): + self['jitter'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of plotly.graph_objs.box.Line + - A dict of string/value properties that will be passed + to the Line constructor + + Supported dict properties: + + color + Sets the color of line bounding the box(es). + width + Sets the width (in px) of line bounding the + box(es). + + Returns + ------- + plotly.graph_objs.box.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + line + plotly.graph_objs.box.marker.Line instance or + dict with compatible properties + opacity + Sets the marker opacity. + outliercolor + Sets the color of the outlier sample points. + size + Sets the marker size (in px). + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + + Returns + ------- + plotly.graph_objs.box.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # name + # ---- + @property + def name(self): + """ + Sets the trace name. The trace name appear as the legend item + and on hover. For box traces, the name will also be used for + the position coordinate, if `x` and `x0` (`y` and `y0` if + horizontal) are missing and the position axis is categorical + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # notched + # ------- + @property + def notched(self): + """ + Determines whether or not notches should be drawn. + + The 'notched' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['notched'] + + @notched.setter + def notched(self, val): + self['notched'] = val + + # notchwidth + # ---------- + @property + 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] + + Returns + ------- + int|float + """ + return self['notchwidth'] + + @notchwidth.setter + def notchwidth(self, val): + self['notchwidth'] = val + + # offsetgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['offsetgroup'] + + @offsetgroup.setter + def offsetgroup(self, val): + self['offsetgroup'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # orientation + # ----------- + @property + 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'] + + Returns + ------- + Any + """ + return self['orientation'] + + @orientation.setter + def orientation(self, val): + self['orientation'] = val + + # pointpos + # -------- + @property + def pointpos(self): + """ + Sets the position of the sample points in relation to the + box(es). If 0, the sample points are places over the center of + the box(es). Positive (negative) values correspond to positions + to the right (left) for vertical boxes and above (below) for + horizontal boxes + + The 'pointpos' property is a number and may be specified as: + - An int or float in the interval [-2, 2] + + Returns + ------- + int|float + """ + return self['pointpos'] + + @pointpos.setter + def pointpos(self, val): + self['pointpos'] = val + + # selected + # -------- + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of plotly.graph_objs.box.Selected + - A dict of string/value properties that will be passed + to the Selected constructor + + Supported dict properties: + + marker + plotly.graph_objs.box.selected.Marker instance + or dict with compatible properties + + Returns + ------- + plotly.graph_objs.box.Selected + """ + return self['selected'] + + @selected.setter + def selected(self, val): + self['selected'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.box.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.box.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # text + # ---- + @property + def text(self): + """ + Sets the text elements associated with each sample value. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # unselected + # ---------- + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of plotly.graph_objs.box.Unselected + - A dict of string/value properties that will be passed + to the Unselected constructor + + Supported dict properties: + + marker + plotly.graph_objs.box.unselected.Marker + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.box.Unselected + """ + return self['unselected'] + + @unselected.setter + def unselected(self, val): + self['unselected'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # whiskerwidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['whiskerwidth'] + + @whiskerwidth.setter + def whiskerwidth(self, val): + self['whiskerwidth'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # x0 + # -- + @property + def x0(self): + """ + Sets the x coordinate of the box. See overview for more info. + + The 'x0' property accepts values of any type + + Returns + ------- + Any + """ + return self['x0'] + + @x0.setter + def x0(self, val): + self['x0'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # xcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['xcalendar'] + + @xcalendar.setter + def xcalendar(self, val): + self['xcalendar'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # y0 + # -- + @property + def y0(self): + """ + Sets the y coordinate of the box. See overview for more info. + + The 'y0' property accepts values of any type + + Returns + ------- + Any + """ + return self['y0'] + + @y0.setter + def y0(self, val): + self['y0'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # ycalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['ycalendar'] + + @ycalendar.setter + def ycalendar(self, val): + self['ycalendar'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + alignmentgroup + Set several traces linked to the same position axis or + matching axes to the same alignmentgroup. This controls + whether bars compute their positional range dependently + or independently. + boxmean + If True, the mean of the box(es)' underlying + distribution is drawn as a dashed line inside the + box(es). If "sd" the standard deviation is also drawn. + boxpoints + If "outliers", only the sample points lying outside the + whiskers are shown If "suspectedoutliers", the outlier + points are shown and points either less than 4*Q1-3*Q3 + or greater than 4*Q3-3*Q1 are highlighted (see + `outliercolor`) If "all", all sample points are shown + If False, only the box(es) are shown with no sample + points + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.box.Hoverlabel instance or dict with + compatible properties + hoveron + Do the hover effects highlight individual boxes or + sample points or both? + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + jitter + Sets the amount of jitter in the sample points drawn. + If 0, the sample points align along the distribution + axis. If 1, the sample points are drawn in a random + jitter of width equal to the width of the box(es). + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.box.Line instance or dict with + compatible properties + marker + plotly.graph_objs.box.Marker instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. For box traces, the name will + also be used for the position coordinate, if `x` and + `x0` (`y` and `y0` if horizontal) are missing and the + position axis is categorical + notched + Determines whether or not notches should be drawn. + notchwidth + Sets the width of the notches relative to the box' + width. For example, with 0, the notches are as wide as + the box(es). + offsetgroup + Set several traces linked to the same position axis or + matching axes to the same offsetgroup where bars of the + same position coordinate will line up. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the box(es). If "v" ("h"), the + distribution is visualized along the vertical + (horizontal). + pointpos + Sets the position of the sample points in relation to + the box(es). If 0, the sample points are places over + the center of the box(es). Positive (negative) values + correspond to positions to the right (left) for + vertical boxes and above (below) for horizontal boxes + selected + plotly.graph_objs.box.Selected instance or dict with + compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.box.Stream instance or dict with + compatible properties + text + Sets the text elements associated with each sample + value. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.box.Unselected instance or dict with + compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + whiskerwidth + Sets the width of the whiskers relative to the box' + width. For example, with 1, the whiskers are as wide as + the box(es). + width + Sets the width of the box in data coordinate If 0 + (default value) the width is automatically selected + based on the positions of other box traces in the same + subplot. + x + Sets the x sample data or coordinates. See overview for + more info. + x0 + Sets the x coordinate of the box. See overview for more + info. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y sample data or coordinates. See overview for + more info. + y0 + Sets the y coordinate of the box. See overview for more + info. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + """ + + def __init__( + self, + arg=None, + alignmentgroup=None, + boxmean=None, + boxpoints=None, + customdata=None, + customdatasrc=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + jitter=None, + legendgroup=None, + line=None, + marker=None, + name=None, + notched=None, + notchwidth=None, + offsetgroup=None, + opacity=None, + orientation=None, + pointpos=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + whiskerwidth=None, + width=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + ysrc=None, + **kwargs + ): + """ + Construct a new Box object + + In vertical (horizontal) box plots, statistics are computed + using `y` (`x`) values. By supplying an `x` (`y`) array, one + box per distinct x (y) value is drawn If no `x` (`y`) list is + provided, a single box is drawn. That box position is then + positioned with with `name` or with `x0` (`y0`) if provided. + Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The + second quartile (Q2) is marked by a line inside the box. By + default, the whiskers correspond to the box' edges +/- 1.5 + times the interquartile range (IQR = Q3-Q1), see "boxpoints" + for other options. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Box + alignmentgroup + Set several traces linked to the same position axis or + matching axes to the same alignmentgroup. This controls + whether bars compute their positional range dependently + or independently. + boxmean + If True, the mean of the box(es)' underlying + distribution is drawn as a dashed line inside the + box(es). If "sd" the standard deviation is also drawn. + boxpoints + If "outliers", only the sample points lying outside the + whiskers are shown If "suspectedoutliers", the outlier + points are shown and points either less than 4*Q1-3*Q3 + or greater than 4*Q3-3*Q1 are highlighted (see + `outliercolor`) If "all", all sample points are shown + If False, only the box(es) are shown with no sample + points + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.box.Hoverlabel instance or dict with + compatible properties + hoveron + Do the hover effects highlight individual boxes or + sample points or both? + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + jitter + Sets the amount of jitter in the sample points drawn. + If 0, the sample points align along the distribution + axis. If 1, the sample points are drawn in a random + jitter of width equal to the width of the box(es). + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + line + plotly.graph_objs.box.Line instance or dict with + compatible properties + marker + plotly.graph_objs.box.Marker instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. For box traces, the name will + also be used for the position coordinate, if `x` and + `x0` (`y` and `y0` if horizontal) are missing and the + position axis is categorical + notched + Determines whether or not notches should be drawn. + notchwidth + Sets the width of the notches relative to the box' + width. For example, with 0, the notches are as wide as + the box(es). + offsetgroup + Set several traces linked to the same position axis or + matching axes to the same offsetgroup where bars of the + same position coordinate will line up. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the box(es). If "v" ("h"), the + distribution is visualized along the vertical + (horizontal). + pointpos + Sets the position of the sample points in relation to + the box(es). If 0, the sample points are places over + the center of the box(es). Positive (negative) values + correspond to positions to the right (left) for + vertical boxes and above (below) for horizontal boxes + selected + plotly.graph_objs.box.Selected instance or dict with + compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.box.Stream instance or dict with + compatible properties + text + Sets the text elements associated with each sample + value. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + textsrc + Sets the source reference on plot.ly for text . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.box.Unselected instance or dict with + compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + whiskerwidth + Sets the width of the whiskers relative to the box' + width. For example, with 1, the whiskers are as wide as + the box(es). + width + Sets the width of the box in data coordinate If 0 + (default value) the width is automatically selected + based on the positions of other box traces in the same + subplot. + x + Sets the x sample data or coordinates. See overview for + more info. + x0 + Sets the x coordinate of the box. See overview for more + info. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y sample data or coordinates. See overview for + more info. + y0 + Sets the y coordinate of the box. See overview for more + info. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + + Returns + ------- + Box + """ + super(Box, self).__init__('box') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Box +constructor must be a dict or +an instance of plotly.graph_objs.Box""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (box as v_box) + + # Initialize validators + # --------------------- + self._validators['alignmentgroup'] = v_box.AlignmentgroupValidator() + self._validators['boxmean'] = v_box.BoxmeanValidator() + self._validators['boxpoints'] = v_box.BoxpointsValidator() + self._validators['customdata'] = v_box.CustomdataValidator() + self._validators['customdatasrc'] = v_box.CustomdatasrcValidator() + self._validators['fillcolor'] = v_box.FillcolorValidator() + self._validators['hoverinfo'] = v_box.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_box.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_box.HoverlabelValidator() + self._validators['hoveron'] = v_box.HoveronValidator() + self._validators['hovertext'] = v_box.HovertextValidator() + self._validators['hovertextsrc'] = v_box.HovertextsrcValidator() + self._validators['ids'] = v_box.IdsValidator() + self._validators['idssrc'] = v_box.IdssrcValidator() + self._validators['jitter'] = v_box.JitterValidator() + self._validators['legendgroup'] = v_box.LegendgroupValidator() + self._validators['line'] = v_box.LineValidator() + self._validators['marker'] = v_box.MarkerValidator() + self._validators['name'] = v_box.NameValidator() + self._validators['notched'] = v_box.NotchedValidator() + self._validators['notchwidth'] = v_box.NotchwidthValidator() + self._validators['offsetgroup'] = v_box.OffsetgroupValidator() + self._validators['opacity'] = v_box.OpacityValidator() + self._validators['orientation'] = v_box.OrientationValidator() + self._validators['pointpos'] = v_box.PointposValidator() + self._validators['selected'] = v_box.SelectedValidator() + self._validators['selectedpoints'] = v_box.SelectedpointsValidator() + self._validators['showlegend'] = v_box.ShowlegendValidator() + self._validators['stream'] = v_box.StreamValidator() + self._validators['text'] = v_box.TextValidator() + self._validators['textsrc'] = v_box.TextsrcValidator() + self._validators['uid'] = v_box.UidValidator() + self._validators['uirevision'] = v_box.UirevisionValidator() + self._validators['unselected'] = v_box.UnselectedValidator() + self._validators['visible'] = v_box.VisibleValidator() + self._validators['whiskerwidth'] = v_box.WhiskerwidthValidator() + self._validators['width'] = v_box.WidthValidator() + self._validators['x'] = v_box.XValidator() + self._validators['x0'] = v_box.X0Validator() + self._validators['xaxis'] = v_box.XAxisValidator() + self._validators['xcalendar'] = v_box.XcalendarValidator() + self._validators['xsrc'] = v_box.XsrcValidator() + self._validators['y'] = v_box.YValidator() + self._validators['y0'] = v_box.Y0Validator() + self._validators['yaxis'] = v_box.YAxisValidator() + self._validators['ycalendar'] = v_box.YcalendarValidator() + self._validators['ysrc'] = v_box.YsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('alignmentgroup', None) + self['alignmentgroup' + ] = alignmentgroup if alignmentgroup is not None else _v + _v = arg.pop('boxmean', None) + self['boxmean'] = boxmean if boxmean is not None else _v + _v = arg.pop('boxpoints', None) + self['boxpoints'] = boxpoints if boxpoints is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('fillcolor', None) + self['fillcolor'] = fillcolor if fillcolor is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hoveron', None) + self['hoveron'] = hoveron if hoveron is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('jitter', None) + self['jitter'] = jitter if jitter is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('notched', None) + self['notched'] = notched if notched is not None else _v + _v = arg.pop('notchwidth', None) + self['notchwidth'] = notchwidth if notchwidth is not None else _v + _v = arg.pop('offsetgroup', None) + self['offsetgroup'] = offsetgroup if offsetgroup is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('orientation', None) + self['orientation'] = orientation if orientation is not None else _v + _v = arg.pop('pointpos', None) + self['pointpos'] = pointpos if pointpos is not None else _v + _v = arg.pop('selected', None) + self['selected'] = selected if selected is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('unselected', None) + self['unselected'] = unselected if unselected is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('whiskerwidth', None) + self['whiskerwidth'] = whiskerwidth if whiskerwidth is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('x0', None) + self['x0'] = x0 if x0 is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('xcalendar', None) + self['xcalendar'] = xcalendar if xcalendar is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('y0', None) + self['y0'] = y0 if y0 is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + _v = arg.pop('ycalendar', None) + self['ycalendar'] = ycalendar if ycalendar is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'box' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='box', val='box' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Barpolar(_BaseTraceType): + + # base + # ---- + @property + 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 + ------- + Any|numpy.ndarray + """ + return self['base'] + + @base.setter + def base(self, val): + self['base'] = val + + # basesrc + # ------- + @property + def basesrc(self): + """ + Sets the source reference on plot.ly for base . + + The 'basesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['basesrc'] + + @basesrc.setter + def basesrc(self, val): + self['basesrc'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # dr + # -- + @property + def dr(self): + """ + Sets the r coordinate step. + + The 'dr' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['dr'] + + @dr.setter + def dr(self, val): + self['dr'] = val + + # dtheta + # ------ + @property + 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 + + Returns + ------- + int|float + """ + return self['dtheta'] + + @dtheta.setter + def dtheta(self, val): + self['dtheta'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'r+theta') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.barpolar.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.barpolar.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of plotly.graph_objs.barpolar.Marker + - A dict of string/value properties that will be passed + to the Marker constructor + + Supported dict properties: + + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.barpolar.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + line + plotly.graph_objs.barpolar.marker.Line instance + or dict with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + + Returns + ------- + plotly.graph_objs.barpolar.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # offset + # ------ + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['offset'] + + @offset.setter + def offset(self, val): + self['offset'] = val + + # offsetsrc + # --------- + @property + def offsetsrc(self): + """ + Sets the source reference on plot.ly for offset . + + The 'offsetsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['offsetsrc'] + + @offsetsrc.setter + def offsetsrc(self, val): + self['offsetsrc'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # r + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['r'] + + @r.setter + def r(self, val): + self['r'] = val + + # r0 + # -- + @property + 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 + ------- + Any + """ + return self['r0'] + + @r0.setter + def r0(self, val): + self['r0'] = val + + # rsrc + # ---- + @property + def rsrc(self): + """ + Sets the source reference on plot.ly for r . + + The 'rsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['rsrc'] + + @rsrc.setter + def rsrc(self, val): + self['rsrc'] = val + + # selected + # -------- + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of plotly.graph_objs.barpolar.Selected + - A dict of string/value properties that will be passed + to the Selected constructor + + Supported dict properties: + + marker + plotly.graph_objs.barpolar.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.barpolar.selected.Textfont + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.barpolar.Selected + """ + return self['selected'] + + @selected.setter + def selected(self, val): + self['selected'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.barpolar.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.barpolar.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # subplot + # ------- + @property + def subplot(self): + """ + Sets a reference between this trace's data coordinates and a + polar subplot. If "polar" (the default value), the data refer + to `layout.polar`. If "polar2", the data refer to + `layout.polar2`, and so on. + + The 'subplot' property is an identifier of a particular + subplot, of type 'polar', that may be specified as the string 'polar' + optionally followed by an integer >= 1 + (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) + + Returns + ------- + str + """ + return self['subplot'] + + @subplot.setter + def subplot(self, val): + self['subplot'] = val + + # text + # ---- + @property + def text(self): + """ + Sets hover text elements associated with each bar. If a single + string, the same string appears over all bars. If an array of + string, the items are mapped in order to the this trace's + coordinates. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # theta + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['theta'] + + @theta.setter + def theta(self, val): + self['theta'] = val + + # theta0 + # ------ + @property + 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 + ------- + Any + """ + return self['theta0'] + + @theta0.setter + def theta0(self, val): + self['theta0'] = val + + # thetasrc + # -------- + @property + def thetasrc(self): + """ + Sets the source reference on plot.ly for theta . + + The 'thetasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['thetasrc'] + + @thetasrc.setter + def thetasrc(self, val): + self['thetasrc'] = val + + # thetaunit + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thetaunit'] + + @thetaunit.setter + def thetaunit(self, val): + self['thetaunit'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # unselected + # ---------- + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of plotly.graph_objs.barpolar.Unselected + - A dict of string/value properties that will be passed + to the Unselected constructor + + Supported dict properties: + + marker + plotly.graph_objs.barpolar.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.barpolar.unselected.Textfont + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.barpolar.Unselected + """ + return self['unselected'] + + @unselected.setter + def unselected(self, val): + self['unselected'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + base + Sets where the bar base is drawn (in radial axis + units). In "stack" barmode, traces that set "base" will + be excluded and drawn in "overlay" mode instead. + basesrc + Sets the source reference on plot.ly for base . + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.barpolar.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + marker + plotly.graph_objs.barpolar.Marker instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + offset + Shifts the angular position where the bar is drawn (in + "thetatunit" units). + offsetsrc + Sets the source reference on plot.ly for offset . + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on plot.ly for r . + selected + plotly.graph_objs.barpolar.Selected instance or dict + with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.barpolar.Stream instance or dict with + compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + text + Sets hover text elements associated with each bar. If a + single string, the same string appears over all bars. + If an array of string, the items are mapped in order to + the this trace's coordinates. + textsrc + Sets the source reference on plot.ly for text . + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on plot.ly for theta . + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.barpolar.Unselected instance or dict + with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + width + Sets the bar angular width (in "thetaunit" units). + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + base=None, + basesrc=None, + customdata=None, + customdatasrc=None, + dr=None, + dtheta=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legendgroup=None, + marker=None, + name=None, + offset=None, + offsetsrc=None, + opacity=None, + r=None, + r0=None, + rsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textsrc=None, + theta=None, + theta0=None, + thetasrc=None, + thetaunit=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Barpolar object + + The data visualized by the radial span of the bars is set in + `r` + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Barpolar + base + Sets where the bar base is drawn (in radial axis + units). In "stack" barmode, traces that set "base" will + be excluded and drawn in "overlay" mode instead. + basesrc + Sets the source reference on plot.ly for base . + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.barpolar.Hoverlabel instance or dict + with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + marker + plotly.graph_objs.barpolar.Marker instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + offset + Shifts the angular position where the bar is drawn (in + "thetatunit" units). + offsetsrc + Sets the source reference on plot.ly for offset . + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on plot.ly for r . + selected + plotly.graph_objs.barpolar.Selected instance or dict + with compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.barpolar.Stream instance or dict with + compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + text + Sets hover text elements associated with each bar. If a + single string, the same string appears over all bars. + If an array of string, the items are mapped in order to + the this trace's coordinates. + textsrc + Sets the source reference on plot.ly for text . + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on plot.ly for theta . + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.barpolar.Unselected instance or dict + with compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + width + Sets the bar angular width (in "thetaunit" units). + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Barpolar + """ + super(Barpolar, self).__init__('barpolar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Barpolar +constructor must be a dict or +an instance of plotly.graph_objs.Barpolar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (barpolar as v_barpolar) + + # Initialize validators + # --------------------- + self._validators['base'] = v_barpolar.BaseValidator() + self._validators['basesrc'] = v_barpolar.BasesrcValidator() + self._validators['customdata'] = v_barpolar.CustomdataValidator() + self._validators['customdatasrc'] = v_barpolar.CustomdatasrcValidator() + self._validators['dr'] = v_barpolar.DrValidator() + self._validators['dtheta'] = v_barpolar.DthetaValidator() + self._validators['hoverinfo'] = v_barpolar.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_barpolar.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_barpolar.HoverlabelValidator() + self._validators['hovertemplate'] = v_barpolar.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_barpolar.HovertemplatesrcValidator() + self._validators['hovertext'] = v_barpolar.HovertextValidator() + self._validators['hovertextsrc'] = v_barpolar.HovertextsrcValidator() + self._validators['ids'] = v_barpolar.IdsValidator() + self._validators['idssrc'] = v_barpolar.IdssrcValidator() + self._validators['legendgroup'] = v_barpolar.LegendgroupValidator() + self._validators['marker'] = v_barpolar.MarkerValidator() + self._validators['name'] = v_barpolar.NameValidator() + self._validators['offset'] = v_barpolar.OffsetValidator() + self._validators['offsetsrc'] = v_barpolar.OffsetsrcValidator() + self._validators['opacity'] = v_barpolar.OpacityValidator() + self._validators['r'] = v_barpolar.RValidator() + self._validators['r0'] = v_barpolar.R0Validator() + self._validators['rsrc'] = v_barpolar.RsrcValidator() + self._validators['selected'] = v_barpolar.SelectedValidator() + self._validators['selectedpoints' + ] = v_barpolar.SelectedpointsValidator() + self._validators['showlegend'] = v_barpolar.ShowlegendValidator() + self._validators['stream'] = v_barpolar.StreamValidator() + self._validators['subplot'] = v_barpolar.SubplotValidator() + self._validators['text'] = v_barpolar.TextValidator() + self._validators['textsrc'] = v_barpolar.TextsrcValidator() + self._validators['theta'] = v_barpolar.ThetaValidator() + self._validators['theta0'] = v_barpolar.Theta0Validator() + self._validators['thetasrc'] = v_barpolar.ThetasrcValidator() + self._validators['thetaunit'] = v_barpolar.ThetaunitValidator() + self._validators['uid'] = v_barpolar.UidValidator() + self._validators['uirevision'] = v_barpolar.UirevisionValidator() + self._validators['unselected'] = v_barpolar.UnselectedValidator() + self._validators['visible'] = v_barpolar.VisibleValidator() + self._validators['width'] = v_barpolar.WidthValidator() + self._validators['widthsrc'] = v_barpolar.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('base', None) + self['base'] = base if base is not None else _v + _v = arg.pop('basesrc', None) + self['basesrc'] = basesrc if basesrc is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('dr', None) + self['dr'] = dr if dr is not None else _v + _v = arg.pop('dtheta', None) + self['dtheta'] = dtheta if dtheta is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('offset', None) + self['offset'] = offset if offset is not None else _v + _v = arg.pop('offsetsrc', None) + self['offsetsrc'] = offsetsrc if offsetsrc is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('r', None) + self['r'] = r if r is not None else _v + _v = arg.pop('r0', None) + self['r0'] = r0 if r0 is not None else _v + _v = arg.pop('rsrc', None) + self['rsrc'] = rsrc if rsrc is not None else _v + _v = arg.pop('selected', None) + self['selected'] = selected if selected is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('subplot', None) + self['subplot'] = subplot if subplot is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('theta', None) + self['theta'] = theta if theta is not None else _v + _v = arg.pop('theta0', None) + self['theta0'] = theta0 if theta0 is not None else _v + _v = arg.pop('thetasrc', None) + self['thetasrc'] = thetasrc if thetasrc is not None else _v + _v = arg.pop('thetaunit', None) + self['thetaunit'] = thetaunit if thetaunit is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('unselected', None) + self['unselected'] = unselected if unselected is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'barpolar' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='barpolar', val='barpolar' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Bar(_BaseTraceType): + + # alignmentgroup + # -------------- + @property + 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 + + Returns + ------- + str + """ + return self['alignmentgroup'] + + @alignmentgroup.setter + def alignmentgroup(self, val): + self['alignmentgroup'] = val + + # base + # ---- + @property + 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 + ------- + Any|numpy.ndarray + """ + return self['base'] + + @base.setter + def base(self, val): + self['base'] = val + + # basesrc + # ------- + @property + def basesrc(self): + """ + Sets the source reference on plot.ly for base . + + The 'basesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['basesrc'] + + @basesrc.setter + def basesrc(self, val): + self['basesrc'] = val + + # cliponaxis + # ---------- + @property + def cliponaxis(self): + """ + Determines whether the text nodes are clipped about the subplot + axes. To show the text nodes above axis lines and tick labels, + make sure to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + + The 'cliponaxis' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cliponaxis'] + + @cliponaxis.setter + def cliponaxis(self, val): + self['cliponaxis'] = val + + # constraintext + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['constraintext'] + + @constraintext.setter + def constraintext(self, val): + self['constraintext'] = val + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # dx + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['dx'] + + @dx.setter + def dx(self, val): + self['dx'] = val + + # dy + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['dy'] + + @dy.setter + def dy(self, val): + self['dy'] = val + + # error_x + # ------- + @property + def error_x(self): + """ + The 'error_x' property is an instance of ErrorX + that may be specified as: + - An instance of plotly.graph_objs.bar.ErrorX + - A dict of string/value properties that will be passed + to the ErrorX constructor + + Supported dict properties: + + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. + + Returns + ------- + plotly.graph_objs.bar.ErrorX + """ + return self['error_x'] + + @error_x.setter + def error_x(self, val): + self['error_x'] = val + + # error_y + # ------- + @property + def error_y(self): + """ + The 'error_y' property is an instance of ErrorY + that may be specified as: + - An instance of plotly.graph_objs.bar.ErrorY + - A dict of string/value properties that will be passed + to the ErrorY constructor + + Supported dict properties: + + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. + + Returns + ------- + plotly.graph_objs.bar.ErrorY + """ + return self['error_y'] + + @error_y.setter + def error_y(self, val): + self['error_y'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.bar.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.bar.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # hovertext + # --------- + @property + def hovertext(self): + """ + Sets hover text elements associated with each (x,y) pair. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # hovertextsrc + # ------------ + @property + def hovertextsrc(self): + """ + Sets the source reference on plot.ly for hovertext . + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertextsrc'] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self['hovertextsrc'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # insidetextfont + # -------------- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.bar.Insidetextfont + """ + return self['insidetextfont'] + + @insidetextfont.setter + def insidetextfont(self, val): + self['insidetextfont'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of plotly.graph_objs.bar.Marker + - A dict of string/value properties that will be passed + to the Marker constructor + + Supported dict properties: + + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.bar.marker.ColorBar instance + or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + line + plotly.graph_objs.bar.marker.Line instance or + dict with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + + Returns + ------- + plotly.graph_objs.bar.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # offset + # ------ + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['offset'] + + @offset.setter + def offset(self, val): + self['offset'] = val + + # offsetgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['offsetgroup'] + + @offsetgroup.setter + def offsetgroup(self, val): + self['offsetgroup'] = val + + # offsetsrc + # --------- + @property + def offsetsrc(self): + """ + Sets the source reference on plot.ly for offset . + + The 'offsetsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['offsetsrc'] + + @offsetsrc.setter + def offsetsrc(self, val): + self['offsetsrc'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # orientation + # ----------- + @property + 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'] + + Returns + ------- + Any + """ + return self['orientation'] + + @orientation.setter + def orientation(self, val): + self['orientation'] = val + + # outsidetextfont + # --------------- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.bar.Outsidetextfont + """ + return self['outsidetextfont'] + + @outsidetextfont.setter + def outsidetextfont(self, val): + self['outsidetextfont'] = val + + # r + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['r'] + + @r.setter + def r(self, val): + self['r'] = val + + # rsrc + # ---- + @property + def rsrc(self): + """ + Sets the source reference on plot.ly for r . + + The 'rsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['rsrc'] + + @rsrc.setter + def rsrc(self, val): + self['rsrc'] = val + + # selected + # -------- + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of plotly.graph_objs.bar.Selected + - A dict of string/value properties that will be passed + to the Selected constructor + + Supported dict properties: + + marker + plotly.graph_objs.bar.selected.Marker instance + or dict with compatible properties + textfont + plotly.graph_objs.bar.selected.Textfont + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.bar.Selected + """ + return self['selected'] + + @selected.setter + def selected(self, val): + self['selected'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of plotly.graph_objs.bar.Stream + - A dict of string/value properties that will be passed + to the Stream constructor + + Supported dict properties: + + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.bar.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # t + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['t'] + + @t.setter + def t(self, val): + self['t'] = val + + # text + # ---- + @property + def text(self): + """ + Sets text elements associated with each (x,y) pair. If a single + string, the same string appears over all the data points. If an + array of string, the items are mapped in order to the this + trace's (x,y) coordinates. If trace `hoverinfo` contains a + "text" flag and "hovertext" is not set, these elements will be + seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textfont + # -------- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.bar.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # textposition + # ------------ + @property + def textposition(self): + """ + Specifies the location of the `text`. "inside" positions `text` + inside, next to the bar end (rotated and scaled if needed). + "outside" positions `text` outside, next to the bar end (scaled + if needed), unless there is another bar stacked on this one, + then the text gets pushed inside. "auto" tries to position + `text` inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['inside', 'outside', 'auto', 'none'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['textposition'] + + @textposition.setter + def textposition(self, val): + self['textposition'] = val + + # textpositionsrc + # --------------- + @property + def textpositionsrc(self): + """ + Sets the source reference on plot.ly for textposition . + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textpositionsrc'] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self['textpositionsrc'] = val + + # textsrc + # ------- + @property + def textsrc(self): + """ + Sets the source reference on plot.ly for text . + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['textsrc'] + + @textsrc.setter + def textsrc(self, val): + self['textsrc'] = val + + # tsrc + # ---- + @property + def tsrc(self): + """ + Sets the source reference on plot.ly for t . + + The 'tsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tsrc'] + + @tsrc.setter + def tsrc(self, val): + self['tsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # unselected + # ---------- + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of plotly.graph_objs.bar.Unselected + - A dict of string/value properties that will be passed + to the Unselected constructor + + Supported dict properties: + + marker + plotly.graph_objs.bar.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.bar.unselected.Textfont + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.bar.Unselected + """ + return self['unselected'] + + @unselected.setter + def unselected(self, val): + self['unselected'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # x0 + # -- + @property + 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 + ------- + Any + """ + return self['x0'] + + @x0.setter + def x0(self, val): + self['x0'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + Sets a reference between this trace's x coordinates and a 2D + cartesian x axis. If "x" (the default value), the x coordinates + refer to `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # xcalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['xcalendar'] + + @xcalendar.setter + def xcalendar(self, val): + self['xcalendar'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # y0 + # -- + @property + 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 + ------- + Any + """ + return self['y0'] + + @y0.setter + def y0(self, val): + self['y0'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + Sets a reference between this trace's y coordinates and a 2D + cartesian y axis. If "y" (the default value), the y coordinates + refer to `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # ycalendar + # --------- + @property + 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', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['ycalendar'] + + @ycalendar.setter + def ycalendar(self, val): + self['ycalendar'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + alignmentgroup + Set several traces linked to the same position axis or + matching axes to the same alignmentgroup. This controls + whether bars compute their positional range dependently + or independently. + base + Sets where the bar base is drawn (in position axis + units). In "stack" or "relative" barmode, traces that + set "base" will be excluded and drawn in "overlay" mode + instead. + basesrc + Sets the source reference on plot.ly for base . + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + plotly.graph_objs.bar.ErrorX instance or dict with + compatible properties + error_y + plotly.graph_objs.bar.ErrorY instance or dict with + compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.bar.Hoverlabel instance or dict with + compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + insidetextfont + Sets the font used for `text` lying inside the bar. + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + marker + plotly.graph_objs.bar.Marker instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + offset + Shifts the position where the bar is drawn (in position + axis units). In "group" barmode, traces that set + "offset" will be excluded and drawn in "overlay" mode + instead. + offsetgroup + Set several traces linked to the same position axis or + matching axes to the same offsetgroup where bars of the + same position coordinate will line up. + offsetsrc + Sets the source reference on plot.ly for offset . + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" ("h"), the + value of the each bar spans along the vertical + (horizontal). + outsidetextfont + Sets the font used for `text` lying outside the bar. + r + r coordinates in scatter traces are deprecated!Please + switch to the "scatterpolar" trace type.Sets the radial + coordinatesfor legacy polar chart only. + rsrc + Sets the source reference on plot.ly for r . + selected + plotly.graph_objs.bar.Selected instance or dict with + compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.bar.Stream instance or dict with + compatible properties + t + t coordinates in scatter traces are deprecated!Please + switch to the "scatterpolar" trace type.Sets the + angular coordinatesfor legacy polar chart only. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the font used for `text`. + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + tsrc + Sets the source reference on plot.ly for t . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.bar.Unselected instance or dict with + compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + width + Sets the bar width (in position axis units). + widthsrc + Sets the source reference on plot.ly for width . + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + """ + + def __init__( + self, + arg=None, + alignmentgroup=None, + base=None, + basesrc=None, + cliponaxis=None, + constraintext=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + error_x=None, + error_y=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + legendgroup=None, + marker=None, + name=None, + offset=None, + offsetgroup=None, + offsetsrc=None, + opacity=None, + orientation=None, + outsidetextfont=None, + r=None, + rsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + t=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + tsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + width=None, + widthsrc=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + ysrc=None, + **kwargs + ): + """ + 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 + interchanged. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Bar + alignmentgroup + Set several traces linked to the same position axis or + matching axes to the same alignmentgroup. This controls + whether bars compute their positional range dependently + or independently. + base + Sets where the bar base is drawn (in position axis + units). In "stack" or "relative" barmode, traces that + set "base" will be excluded and drawn in "overlay" mode + instead. + basesrc + Sets the source reference on plot.ly for base . + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + plotly.graph_objs.bar.ErrorX instance or dict with + compatible properties + error_y + plotly.graph_objs.bar.ErrorY instance or dict with + compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.bar.Hoverlabel instance or dict with + compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for hovertext . + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + insidetextfont + Sets the font used for `text` lying inside the bar. + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + marker + plotly.graph_objs.bar.Marker instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + offset + Shifts the position where the bar is drawn (in position + axis units). In "group" barmode, traces that set + "offset" will be excluded and drawn in "overlay" mode + instead. + offsetgroup + Set several traces linked to the same position axis or + matching axes to the same offsetgroup where bars of the + same position coordinate will line up. + offsetsrc + Sets the source reference on plot.ly for offset . + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" ("h"), the + value of the each bar spans along the vertical + (horizontal). + outsidetextfont + Sets the font used for `text` lying outside the bar. + r + r coordinates in scatter traces are deprecated!Please + switch to the "scatterpolar" trace type.Sets the radial + coordinatesfor legacy polar chart only. + rsrc + Sets the source reference on plot.ly for r . + selected + plotly.graph_objs.bar.Selected instance or dict with + compatible properties + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.bar.Stream instance or dict with + compatible properties + t + t coordinates in scatter traces are deprecated!Please + switch to the "scatterpolar" trace type.Sets the + angular coordinatesfor legacy polar chart only. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the font used for `text`. + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. + textpositionsrc + Sets the source reference on plot.ly for textposition + . + textsrc + Sets the source reference on plot.ly for text . + tsrc + Sets the source reference on plot.ly for t . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + plotly.graph_objs.bar.Unselected instance or dict with + compatible properties + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + width + Sets the bar width (in position axis units). + widthsrc + Sets the source reference on plot.ly for width . + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x coordinates and + a 2D cartesian x axis. If "x" (the default value), the + x coordinates refer to `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y coordinates and + a 2D cartesian y axis. If "y" (the default value), the + y coordinates refer to `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + ysrc + Sets the source reference on plot.ly for y . + + Returns + ------- + Bar + """ + super(Bar, self).__init__('bar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Bar +constructor must be a dict or +an instance of plotly.graph_objs.Bar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (bar as v_bar) + + # Initialize validators + # --------------------- + self._validators['alignmentgroup'] = v_bar.AlignmentgroupValidator() + self._validators['base'] = v_bar.BaseValidator() + self._validators['basesrc'] = v_bar.BasesrcValidator() + self._validators['cliponaxis'] = v_bar.CliponaxisValidator() + self._validators['constraintext'] = v_bar.ConstraintextValidator() + self._validators['customdata'] = v_bar.CustomdataValidator() + self._validators['customdatasrc'] = v_bar.CustomdatasrcValidator() + self._validators['dx'] = v_bar.DxValidator() + self._validators['dy'] = v_bar.DyValidator() + self._validators['error_x'] = v_bar.ErrorXValidator() + self._validators['error_y'] = v_bar.ErrorYValidator() + self._validators['hoverinfo'] = v_bar.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_bar.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_bar.HoverlabelValidator() + self._validators['hovertemplate'] = v_bar.HovertemplateValidator() + self._validators['hovertemplatesrc'] = v_bar.HovertemplatesrcValidator( + ) + self._validators['hovertext'] = v_bar.HovertextValidator() + self._validators['hovertextsrc'] = v_bar.HovertextsrcValidator() + self._validators['ids'] = v_bar.IdsValidator() + self._validators['idssrc'] = v_bar.IdssrcValidator() + self._validators['insidetextfont'] = v_bar.InsidetextfontValidator() + self._validators['legendgroup'] = v_bar.LegendgroupValidator() + self._validators['marker'] = v_bar.MarkerValidator() + self._validators['name'] = v_bar.NameValidator() + self._validators['offset'] = v_bar.OffsetValidator() + self._validators['offsetgroup'] = v_bar.OffsetgroupValidator() + self._validators['offsetsrc'] = v_bar.OffsetsrcValidator() + self._validators['opacity'] = v_bar.OpacityValidator() + self._validators['orientation'] = v_bar.OrientationValidator() + self._validators['outsidetextfont'] = v_bar.OutsidetextfontValidator() + self._validators['r'] = v_bar.RValidator() + self._validators['rsrc'] = v_bar.RsrcValidator() + self._validators['selected'] = v_bar.SelectedValidator() + self._validators['selectedpoints'] = v_bar.SelectedpointsValidator() + self._validators['showlegend'] = v_bar.ShowlegendValidator() + self._validators['stream'] = v_bar.StreamValidator() + self._validators['t'] = v_bar.TValidator() + self._validators['text'] = v_bar.TextValidator() + self._validators['textfont'] = v_bar.TextfontValidator() + self._validators['textposition'] = v_bar.TextpositionValidator() + self._validators['textpositionsrc'] = v_bar.TextpositionsrcValidator() + self._validators['textsrc'] = v_bar.TextsrcValidator() + self._validators['tsrc'] = v_bar.TsrcValidator() + self._validators['uid'] = v_bar.UidValidator() + self._validators['uirevision'] = v_bar.UirevisionValidator() + self._validators['unselected'] = v_bar.UnselectedValidator() + self._validators['visible'] = v_bar.VisibleValidator() + self._validators['width'] = v_bar.WidthValidator() + self._validators['widthsrc'] = v_bar.WidthsrcValidator() + self._validators['x'] = v_bar.XValidator() + self._validators['x0'] = v_bar.X0Validator() + self._validators['xaxis'] = v_bar.XAxisValidator() + self._validators['xcalendar'] = v_bar.XcalendarValidator() + self._validators['xsrc'] = v_bar.XsrcValidator() + self._validators['y'] = v_bar.YValidator() + self._validators['y0'] = v_bar.Y0Validator() + self._validators['yaxis'] = v_bar.YAxisValidator() + self._validators['ycalendar'] = v_bar.YcalendarValidator() + self._validators['ysrc'] = v_bar.YsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('alignmentgroup', None) + self['alignmentgroup' + ] = alignmentgroup if alignmentgroup is not None else _v + _v = arg.pop('base', None) + self['base'] = base if base is not None else _v + _v = arg.pop('basesrc', None) + self['basesrc'] = basesrc if basesrc is not None else _v + _v = arg.pop('cliponaxis', None) + self['cliponaxis'] = cliponaxis if cliponaxis is not None else _v + _v = arg.pop('constraintext', None) + self['constraintext' + ] = constraintext if constraintext is not None else _v + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('dx', None) + self['dx'] = dx if dx is not None else _v + _v = arg.pop('dy', None) + self['dy'] = dy if dy is not None else _v + _v = arg.pop('error_x', None) + self['error_x'] = error_x if error_x is not None else _v + _v = arg.pop('error_y', None) + self['error_y'] = error_y if error_y is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('hovertextsrc', None) + self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('insidetextfont', None) + self['insidetextfont' + ] = insidetextfont if insidetextfont is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('offset', None) + self['offset'] = offset if offset is not None else _v + _v = arg.pop('offsetgroup', None) + self['offsetgroup'] = offsetgroup if offsetgroup is not None else _v + _v = arg.pop('offsetsrc', None) + self['offsetsrc'] = offsetsrc if offsetsrc is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('orientation', None) + self['orientation'] = orientation if orientation is not None else _v + _v = arg.pop('outsidetextfont', None) + self['outsidetextfont' + ] = outsidetextfont if outsidetextfont is not None else _v + _v = arg.pop('r', None) + self['r'] = r if r is not None else _v + _v = arg.pop('rsrc', None) + self['rsrc'] = rsrc if rsrc is not None else _v + _v = arg.pop('selected', None) + self['selected'] = selected if selected is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('t', None) + self['t'] = t if t is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + _v = arg.pop('textposition', None) + self['textposition'] = textposition if textposition is not None else _v + _v = arg.pop('textpositionsrc', None) + self['textpositionsrc' + ] = textpositionsrc if textpositionsrc is not None else _v + _v = arg.pop('textsrc', None) + self['textsrc'] = textsrc if textsrc is not None else _v + _v = arg.pop('tsrc', None) + self['tsrc'] = tsrc if tsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('unselected', None) + self['unselected'] = unselected if unselected is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('x0', None) + self['x0'] = x0 if x0 is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('xcalendar', None) + self['xcalendar'] = xcalendar if xcalendar is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('y0', None) + self['y0'] = y0 if y0 is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + _v = arg.pop('ycalendar', None) + self['ycalendar'] = ycalendar if ycalendar is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'bar' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='bar', val='bar' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Area(_BaseTraceType): + + # customdata + # ---------- + @property + def customdata(self): + """ + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note that, + "scatter" traces also appends customdata items in the markers + DOM elements + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['customdata'] + + @customdata.setter + def customdata(self, val): + self['customdata'] = val + + # customdatasrc + # ------------- + @property + def customdatasrc(self): + """ + Sets the source reference on plot.ly for customdata . + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['customdatasrc'] + + @customdatasrc.setter + def customdatasrc(self, val): + self['customdatasrc'] = val + + # hoverinfo + # --------- + @property + 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 + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverinfosrc + # ------------ + @property + def hoverinfosrc(self): + """ + Sets the source reference on plot.ly for hoverinfo . + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hoverinfosrc'] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self['hoverinfosrc'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.area.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.area.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # ids + # --- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ids'] + + @ids.setter + def ids(self, val): + self['ids'] = val + + # idssrc + # ------ + @property + def idssrc(self): + """ + Sets the source reference on plot.ly for ids . + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['idssrc'] + + @idssrc.setter + def idssrc(self, val): + self['idssrc'] = val + + # legendgroup + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['legendgroup'] + + @legendgroup.setter + def legendgroup(self, val): + self['legendgroup'] = val + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + It accepts either a specific color or an array + of numbers that are mapped to the colorscale + relative to the max and min values of the array + or relative to `marker.cmin` and `marker.cmax` + if set. + colorsrc + Sets the source reference on plot.ly for color + . + opacity + Area traces are deprecated! Please switch to + the "barpolar" trace type. Sets the marker + opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + size + Area traces are deprecated! Please switch to + the "barpolar" trace type. Sets the marker size + (in px). + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Area traces are deprecated! Please switch to + the "barpolar" trace type. Sets the marker + symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 + is equivalent to appending "-dot" to a symbol + name. Adding 300 is equivalent to appending + "-open-dot" or "dot-open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . + + Returns + ------- + plotly.graph_objs.area.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # r + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['r'] + + @r.setter + def r(self, val): + self['r'] = val + + # rsrc + # ---- + @property + def rsrc(self): + """ + Sets the source reference on plot.ly for r . + + The 'rsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['rsrc'] + + @rsrc.setter + def rsrc(self, val): + self['rsrc'] = val + + # selectedpoints + # -------------- + @property + def selectedpoints(self): + """ + Array containing integer indices of selected points. Has an + effect only for traces that support selections. Note that an + empty array means an empty selection where the `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self['selectedpoints'] + + @selectedpoints.setter + def selectedpoints(self, val): + self['selectedpoints'] = val + + # showlegend + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlegend'] + + @showlegend.setter + def showlegend(self, val): + self['showlegend'] = val + + # stream + # ------ + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of 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 + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. + + Returns + ------- + plotly.graph_objs.area.Stream + """ + return self['stream'] + + @stream.setter + def stream(self, val): + self['stream'] = val + + # t + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['t'] + + @t.setter + def t(self, val): + self['t'] = val + + # tsrc + # ---- + @property + def tsrc(self): + """ + Sets the source reference on plot.ly for t . + + The 'tsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tsrc'] + + @tsrc.setter + def tsrc(self, val): + self['tsrc'] = val + + # uid + # --- + @property + 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 + + Returns + ------- + str + """ + return self['uid'] + + @uid.setter + def uid(self, val): + self['uid'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # type + # ---- + @property + def type(self): + return self._props['type'] + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.area.Hoverlabel instance or dict with + compatible properties + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + marker + plotly.graph_objs.area.Marker instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + r + Area traces are deprecated! Please switch to the + "barpolar" trace type. Sets the radial coordinates for + legacy polar chart only. + rsrc + Sets the source reference on plot.ly for r . + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.area.Stream instance or dict with + compatible properties + t + Area traces are deprecated! Please switch to the + "barpolar" trace type. Sets the angular coordinates for + legacy polar chart only. + tsrc + Sets the source reference on plot.ly for t . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + """ + + def __init__( + self, + arg=None, + customdata=None, + customdatasrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + ids=None, + idssrc=None, + legendgroup=None, + marker=None, + name=None, + opacity=None, + r=None, + rsrc=None, + selectedpoints=None, + showlegend=None, + stream=None, + t=None, + tsrc=None, + uid=None, + uirevision=None, + visible=None, + **kwargs + ): + """ + Construct a new Area object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Area + customdata + Assigns extra data each datum. This may be useful when + listening to hover, click and selection events. Note + that, "scatter" traces also appends customdata items in + the markers DOM elements + customdatasrc + Sets the source reference on plot.ly for customdata . + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on plot.ly for hoverinfo . + hoverlabel + plotly.graph_objs.area.Hoverlabel instance or dict with + compatible properties + ids + Assigns id labels to each datum. These ids for object + constancy of data points during animation. Should be an + array of strings, not numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces part of + the same legend group hide/show at the same time when + toggling legend items. + marker + plotly.graph_objs.area.Marker instance or dict with + compatible properties + name + Sets the trace name. The trace name appear as the + legend item and on hover. + opacity + Sets the opacity of the trace. + r + Area traces are deprecated! Please switch to the + "barpolar" trace type. Sets the radial coordinates for + legacy polar chart only. + rsrc + Sets the source reference on plot.ly for r . + selectedpoints + Array containing integer indices of selected points. + Has an effect only for traces that support selections. + Note that an empty array means an empty selection where + the `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + plotly.graph_objs.area.Stream instance or dict with + compatible properties + t + Area traces are deprecated! Please switch to the + "barpolar" trace type. Sets the angular coordinates for + legacy polar chart only. + tsrc + Sets the source reference on plot.ly for t . + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + visible + Determines whether or not this trace is visible. If + "legendonly", the trace is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + + Returns + ------- + Area + """ + super(Area, self).__init__('area') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Area +constructor must be a dict or +an instance of plotly.graph_objs.Area""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (area as v_area) + + # Initialize validators + # --------------------- + self._validators['customdata'] = v_area.CustomdataValidator() + self._validators['customdatasrc'] = v_area.CustomdatasrcValidator() + self._validators['hoverinfo'] = v_area.HoverinfoValidator() + self._validators['hoverinfosrc'] = v_area.HoverinfosrcValidator() + self._validators['hoverlabel'] = v_area.HoverlabelValidator() + self._validators['ids'] = v_area.IdsValidator() + self._validators['idssrc'] = v_area.IdssrcValidator() + self._validators['legendgroup'] = v_area.LegendgroupValidator() + self._validators['marker'] = v_area.MarkerValidator() + self._validators['name'] = v_area.NameValidator() + self._validators['opacity'] = v_area.OpacityValidator() + self._validators['r'] = v_area.RValidator() + self._validators['rsrc'] = v_area.RsrcValidator() + self._validators['selectedpoints'] = v_area.SelectedpointsValidator() + self._validators['showlegend'] = v_area.ShowlegendValidator() + self._validators['stream'] = v_area.StreamValidator() + self._validators['t'] = v_area.TValidator() + self._validators['tsrc'] = v_area.TsrcValidator() + self._validators['uid'] = v_area.UidValidator() + self._validators['uirevision'] = v_area.UirevisionValidator() + self._validators['visible'] = v_area.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('customdata', None) + self['customdata'] = customdata if customdata is not None else _v + _v = arg.pop('customdatasrc', None) + self['customdatasrc' + ] = customdatasrc if customdatasrc is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverinfosrc', None) + self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('ids', None) + self['ids'] = ids if ids is not None else _v + _v = arg.pop('idssrc', None) + self['idssrc'] = idssrc if idssrc is not None else _v + _v = arg.pop('legendgroup', None) + self['legendgroup'] = legendgroup if legendgroup is not None else _v + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('r', None) + self['r'] = r if r is not None else _v + _v = arg.pop('rsrc', None) + self['rsrc'] = rsrc if rsrc is not None else _v + _v = arg.pop('selectedpoints', None) + self['selectedpoints' + ] = selectedpoints if selectedpoints is not None else _v + _v = arg.pop('showlegend', None) + self['showlegend'] = showlegend if showlegend is not None else _v + _v = arg.pop('stream', None) + self['stream'] = stream if stream is not None else _v + _v = arg.pop('t', None) + self['t'] = t if t is not None else _v + _v = arg.pop('tsrc', None) + self['tsrc'] = tsrc if tsrc is not None else _v + _v = arg.pop('uid', None) + self['uid'] = uid if uid is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Read-only literals + # ------------------ + from _plotly_utils.basevalidators import LiteralValidator + self._props['type'] = 'area' + self._validators['type'] = LiteralValidator( + plotly_name='type', parent_name='area', val='area' + ) + arg.pop('type', None) + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseFrameHierarchyType as _BaseFrameHierarchyType +import copy as _copy + + +class Frame(_BaseFrameHierarchyType): + + # baseframe + # --------- + @property + def baseframe(self): + """ + The name of the frame into which this frame's properties are + merged before applying. This is used to unify properties and + avoid needing to specify the same values for the same + properties in multiple frames. + + The 'baseframe' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['baseframe'] + + @baseframe.setter + def baseframe(self, val): + self['baseframe'] = val + + # data + # ---- + @property + def data(self): + """ + A list of traces this frame modifies. The format is identical + to the normal trace definition. + + Returns + ------- + Any + """ + return self['data'] + + @data.setter + def data(self, val): + self['data'] = val + + # group + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['group'] + + @group.setter + def group(self, val): + self['group'] = val + + # layout + # ------ + @property + def layout(self): + """ + Layout properties which this frame modifies. The format is + identical to the normal layout definition. + + Returns + ------- + Any + """ + return self['layout'] + + @layout.setter + def layout(self, val): + self['layout'] = val + + # name + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # traces + # ------ + @property + 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 + ------- + Any + """ + return self['traces'] + + @traces.setter + def traces(self, val): + self['traces'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return '' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + baseframe + The name of the frame into which this frame's + properties are merged before applying. This is used to + unify properties and avoid needing to specify the same + values for the same properties in multiple frames. + data + A list of traces this frame modifies. The format is + identical to the normal trace definition. + group + An identifier that specifies the group to which the + frame belongs, used by animate to select a subset of + frames. + layout + Layout properties which this frame modifies. The format + is identical to the normal layout definition. + name + A label by which to identify the frame + traces + A list of trace indices that identify the respective + traces in the data attribute + """ + + def __init__( + self, + arg=None, + baseframe=None, + data=None, + group=None, + layout=None, + name=None, + traces=None, + **kwargs + ): + """ + Construct a new Frame object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.Frame + baseframe + The name of the frame into which this frame's + properties are merged before applying. This is used to + unify properties and avoid needing to specify the same + values for the same properties in multiple frames. + data + A list of traces this frame modifies. The format is + identical to the normal trace definition. + group + An identifier that specifies the group to which the + frame belongs, used by animate to select a subset of + frames. + layout + Layout properties which this frame modifies. The format + is identical to the normal layout definition. + name + A label by which to identify the frame + traces + A list of trace indices that identify the respective + traces in the data attribute + + Returns + ------- + Frame + """ + super(Frame, self).__init__('frames') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.Frame +constructor must be a dict or +an instance of plotly.graph_objs.Frame""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators import (frame as v_frame) + + # Initialize validators + # --------------------- + self._validators['baseframe'] = v_frame.BaseframeValidator() + self._validators['data'] = v_frame.DataValidator() + self._validators['group'] = v_frame.GroupValidator() + self._validators['layout'] = v_frame.LayoutValidator() + self._validators['name'] = v_frame.NameValidator() + self._validators['traces'] = v_frame.TracesValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('baseframe', None) + self['baseframe'] = baseframe if baseframe is not None else _v + _v = arg.pop('data', None) + self['data'] = data if data is not None else _v + _v = arg.pop('group', None) + self['group'] = group if group is not None else _v + _v = arg.pop('layout', None) + self['layout'] = layout if layout is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('traces', None) + self['traces'] = traces if traces is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs import violin -from ._table import Table from plotly.graph_objs import table -from ._surface import Surface from plotly.graph_objs import surface -from ._streamtube import Streamtube from plotly.graph_objs import streamtube -from ._splom import Splom from plotly.graph_objs import splom -from ._scatterternary import Scatterternary from plotly.graph_objs import scatterternary -from ._scatterpolargl import Scatterpolargl from plotly.graph_objs import scatterpolargl -from ._scatterpolar import Scatterpolar from plotly.graph_objs import scatterpolar -from ._scattermapbox import Scattermapbox from plotly.graph_objs import scattermapbox -from ._scattergl import Scattergl from plotly.graph_objs import scattergl -from ._scattergeo import Scattergeo from plotly.graph_objs import scattergeo -from ._scattercarpet import Scattercarpet from plotly.graph_objs import scattercarpet -from ._scatter3d import Scatter3d from plotly.graph_objs import scatter3d -from ._scatter import Scatter from plotly.graph_objs import scatter -from ._sankey import Sankey from plotly.graph_objs import sankey -from ._pointcloud import Pointcloud from plotly.graph_objs import pointcloud -from ._pie import Pie from plotly.graph_objs import pie -from ._parcoords import Parcoords from plotly.graph_objs import parcoords -from ._parcats import Parcats from plotly.graph_objs import parcats -from ._ohlc import Ohlc from plotly.graph_objs import ohlc -from ._mesh3d import Mesh3d from plotly.graph_objs import mesh3d -from ._isosurface import Isosurface from plotly.graph_objs import isosurface -from ._histogram2dcontour import Histogram2dContour from plotly.graph_objs import histogram2dcontour -from ._histogram2d import Histogram2d from plotly.graph_objs import histogram2d -from ._histogram import Histogram from plotly.graph_objs import histogram -from ._heatmapgl import Heatmapgl from plotly.graph_objs import heatmapgl -from ._heatmap import Heatmap from plotly.graph_objs import heatmap -from ._contourcarpet import Contourcarpet from plotly.graph_objs import contourcarpet -from ._contour import Contour from plotly.graph_objs import contour -from ._cone import Cone from plotly.graph_objs import cone -from ._choropleth import Choropleth from plotly.graph_objs import choropleth -from ._carpet import Carpet from plotly.graph_objs import carpet -from ._candlestick import Candlestick from plotly.graph_objs import candlestick -from ._box import Box from plotly.graph_objs import box -from ._barpolar import Barpolar from plotly.graph_objs import barpolar -from ._bar import Bar from plotly.graph_objs import bar -from ._area import Area from plotly.graph_objs import area -from ._layout import Layout from plotly.graph_objs import layout -from ._frame import Frame from ._figure import Figure try: diff --git a/plotly/graph_objs/_area.py b/plotly/graph_objs/_area.py deleted file mode 100644 index 31cefb8cda9..00000000000 --- a/plotly/graph_objs/_area.py +++ /dev/null @@ -1,897 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Area(BaseTraceType): - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.area.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.area.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - It accepts either a specific color or an array - of numbers that are mapped to the colorscale - relative to the max and min values of the array - or relative to `marker.cmin` and `marker.cmax` - if set. - colorsrc - Sets the source reference on plot.ly for color - . - opacity - Area traces are deprecated! Please switch to - the "barpolar" trace type. Sets the marker - opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - size - Area traces are deprecated! Please switch to - the "barpolar" trace type. Sets the marker size - (in px). - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Area traces are deprecated! Please switch to - the "barpolar" trace type. Sets the marker - symbol type. Adding 100 is equivalent to - appending "-open" to a symbol name. Adding 200 - is equivalent to appending "-dot" to a symbol - name. Adding 300 is equivalent to appending - "-open-dot" or "dot-open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . - - Returns - ------- - plotly.graph_objs.area.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # r - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['r'] - - @r.setter - def r(self, val): - self['r'] = val - - # rsrc - # ---- - @property - def rsrc(self): - """ - Sets the source reference on plot.ly for r . - - The 'rsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['rsrc'] - - @rsrc.setter - def rsrc(self, val): - self['rsrc'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of 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 - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.area.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # t - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['t'] - - @t.setter - def t(self, val): - self['t'] = val - - # tsrc - # ---- - @property - def tsrc(self): - """ - Sets the source reference on plot.ly for t . - - The 'tsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tsrc'] - - @tsrc.setter - def tsrc(self, val): - self['tsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.area.Hoverlabel instance or dict with - compatible properties - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - marker - plotly.graph_objs.area.Marker instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - r - Area traces are deprecated! Please switch to the - "barpolar" trace type. Sets the radial coordinates for - legacy polar chart only. - rsrc - Sets the source reference on plot.ly for r . - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.area.Stream instance or dict with - compatible properties - t - Area traces are deprecated! Please switch to the - "barpolar" trace type. Sets the angular coordinates for - legacy polar chart only. - tsrc - Sets the source reference on plot.ly for t . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - """ - - def __init__( - self, - arg=None, - customdata=None, - customdatasrc=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - ids=None, - idssrc=None, - legendgroup=None, - marker=None, - name=None, - opacity=None, - r=None, - rsrc=None, - selectedpoints=None, - showlegend=None, - stream=None, - t=None, - tsrc=None, - uid=None, - uirevision=None, - visible=None, - **kwargs - ): - """ - Construct a new Area object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Area - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.area.Hoverlabel instance or dict with - compatible properties - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - marker - plotly.graph_objs.area.Marker instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - r - Area traces are deprecated! Please switch to the - "barpolar" trace type. Sets the radial coordinates for - legacy polar chart only. - rsrc - Sets the source reference on plot.ly for r . - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.area.Stream instance or dict with - compatible properties - t - Area traces are deprecated! Please switch to the - "barpolar" trace type. Sets the angular coordinates for - legacy polar chart only. - tsrc - Sets the source reference on plot.ly for t . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - - Returns - ------- - Area - """ - super(Area, self).__init__('area') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Area -constructor must be a dict or -an instance of plotly.graph_objs.Area""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (area as v_area) - - # Initialize validators - # --------------------- - self._validators['customdata'] = v_area.CustomdataValidator() - self._validators['customdatasrc'] = v_area.CustomdatasrcValidator() - self._validators['hoverinfo'] = v_area.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_area.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_area.HoverlabelValidator() - self._validators['ids'] = v_area.IdsValidator() - self._validators['idssrc'] = v_area.IdssrcValidator() - self._validators['legendgroup'] = v_area.LegendgroupValidator() - self._validators['marker'] = v_area.MarkerValidator() - self._validators['name'] = v_area.NameValidator() - self._validators['opacity'] = v_area.OpacityValidator() - self._validators['r'] = v_area.RValidator() - self._validators['rsrc'] = v_area.RsrcValidator() - self._validators['selectedpoints'] = v_area.SelectedpointsValidator() - self._validators['showlegend'] = v_area.ShowlegendValidator() - self._validators['stream'] = v_area.StreamValidator() - self._validators['t'] = v_area.TValidator() - self._validators['tsrc'] = v_area.TsrcValidator() - self._validators['uid'] = v_area.UidValidator() - self._validators['uirevision'] = v_area.UirevisionValidator() - self._validators['visible'] = v_area.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('r', None) - self['r'] = r if r is not None else _v - _v = arg.pop('rsrc', None) - self['rsrc'] = rsrc if rsrc is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('t', None) - self['t'] = t if t is not None else _v - _v = arg.pop('tsrc', None) - self['tsrc'] = tsrc if tsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'area' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='area', val='area' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_bar.py b/plotly/graph_objs/_bar.py deleted file mode 100644 index c6a038d0f48..00000000000 --- a/plotly/graph_objs/_bar.py +++ /dev/null @@ -1,2473 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Bar(BaseTraceType): - - # alignmentgroup - # -------------- - @property - 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 - - Returns - ------- - str - """ - return self['alignmentgroup'] - - @alignmentgroup.setter - def alignmentgroup(self, val): - self['alignmentgroup'] = val - - # base - # ---- - @property - 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 - ------- - Any|numpy.ndarray - """ - return self['base'] - - @base.setter - def base(self, val): - self['base'] = val - - # basesrc - # ------- - @property - def basesrc(self): - """ - Sets the source reference on plot.ly for base . - - The 'basesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['basesrc'] - - @basesrc.setter - def basesrc(self, val): - self['basesrc'] = val - - # cliponaxis - # ---------- - @property - def cliponaxis(self): - """ - Determines whether the text nodes are clipped about the subplot - axes. To show the text nodes above axis lines and tick labels, - make sure to set `xaxis.layer` and `yaxis.layer` to *below - traces*. - - The 'cliponaxis' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cliponaxis'] - - @cliponaxis.setter - def cliponaxis(self, val): - self['cliponaxis'] = val - - # constraintext - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['constraintext'] - - @constraintext.setter - def constraintext(self, val): - self['constraintext'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # dx - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['dx'] - - @dx.setter - def dx(self, val): - self['dx'] = val - - # dy - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['dy'] - - @dy.setter - def dy(self, val): - self['dy'] = val - - # error_x - # ------- - @property - def error_x(self): - """ - The 'error_x' property is an instance of ErrorX - that may be specified as: - - An instance of plotly.graph_objs.bar.ErrorX - - A dict of string/value properties that will be passed - to the ErrorX constructor - - Supported dict properties: - - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - copy_ystyle - - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. - - Returns - ------- - plotly.graph_objs.bar.ErrorX - """ - return self['error_x'] - - @error_x.setter - def error_x(self, val): - self['error_x'] = val - - # error_y - # ------- - @property - def error_y(self): - """ - The 'error_y' property is an instance of ErrorY - that may be specified as: - - An instance of plotly.graph_objs.bar.ErrorY - - A dict of string/value properties that will be passed - to the ErrorY constructor - - Supported dict properties: - - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. - - Returns - ------- - plotly.graph_objs.bar.ErrorY - """ - return self['error_y'] - - @error_y.setter - def error_y(self, val): - self['error_y'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.bar.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.bar.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - def hovertext(self): - """ - Sets hover text elements associated with each (x,y) pair. If a - single string, the same string appears over all the data - points. If an array of string, the items are mapped in order to - the this trace's (x,y) coordinates. To be seen, trace - `hoverinfo` must contain a "text" flag. - - The 'hovertext' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # insidetextfont - # -------------- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.bar.Insidetextfont - """ - return self['insidetextfont'] - - @insidetextfont.setter - def insidetextfont(self, val): - self['insidetextfont'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of plotly.graph_objs.bar.Marker - - A dict of string/value properties that will be passed - to the Marker constructor - - Supported dict properties: - - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.bar.marker.ColorBar instance - or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - line - plotly.graph_objs.bar.marker.Line instance or - dict with compatible properties - opacity - Sets the opacity of the bars. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - - Returns - ------- - plotly.graph_objs.bar.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # offset - # ------ - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['offset'] - - @offset.setter - def offset(self, val): - self['offset'] = val - - # offsetgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['offsetgroup'] - - @offsetgroup.setter - def offsetgroup(self, val): - self['offsetgroup'] = val - - # offsetsrc - # --------- - @property - def offsetsrc(self): - """ - Sets the source reference on plot.ly for offset . - - The 'offsetsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['offsetsrc'] - - @offsetsrc.setter - def offsetsrc(self, val): - self['offsetsrc'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # orientation - # ----------- - @property - 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'] - - Returns - ------- - Any - """ - return self['orientation'] - - @orientation.setter - def orientation(self, val): - self['orientation'] = val - - # outsidetextfont - # --------------- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.bar.Outsidetextfont - """ - return self['outsidetextfont'] - - @outsidetextfont.setter - def outsidetextfont(self, val): - self['outsidetextfont'] = val - - # r - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['r'] - - @r.setter - def r(self, val): - self['r'] = val - - # rsrc - # ---- - @property - def rsrc(self): - """ - Sets the source reference on plot.ly for r . - - The 'rsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['rsrc'] - - @rsrc.setter - def rsrc(self, val): - self['rsrc'] = val - - # selected - # -------- - @property - def selected(self): - """ - The 'selected' property is an instance of Selected - that may be specified as: - - An instance of plotly.graph_objs.bar.Selected - - A dict of string/value properties that will be passed - to the Selected constructor - - Supported dict properties: - - marker - plotly.graph_objs.bar.selected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objs.bar.selected.Textfont - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.bar.Selected - """ - return self['selected'] - - @selected.setter - def selected(self, val): - self['selected'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.bar.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.bar.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # t - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['t'] - - @t.setter - def t(self, val): - self['t'] = val - - # text - # ---- - @property - def text(self): - """ - Sets text elements associated with each (x,y) pair. If a single - string, the same string appears over all the data points. If an - array of string, the items are mapped in order to the this - trace's (x,y) coordinates. If trace `hoverinfo` contains a - "text" flag and "hovertext" is not set, these elements will be - seen in the hover labels. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textfont - # -------- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.bar.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # textposition - # ------------ - @property - def textposition(self): - """ - Specifies the location of the `text`. "inside" positions `text` - inside, next to the bar end (rotated and scaled if needed). - "outside" positions `text` outside, next to the bar end (scaled - if needed), unless there is another bar stacked on this one, - then the text gets pushed inside. "auto" tries to position - `text` inside the bar, but if the bar is too small and no bar - is stacked on this one the text is moved outside. - - The 'textposition' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['inside', 'outside', 'auto', 'none'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['textposition'] - - @textposition.setter - def textposition(self, val): - self['textposition'] = val - - # textpositionsrc - # --------------- - @property - def textpositionsrc(self): - """ - Sets the source reference on plot.ly for textposition . - - The 'textpositionsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textpositionsrc'] - - @textpositionsrc.setter - def textpositionsrc(self, val): - self['textpositionsrc'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # tsrc - # ---- - @property - def tsrc(self): - """ - Sets the source reference on plot.ly for t . - - The 'tsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tsrc'] - - @tsrc.setter - def tsrc(self, val): - self['tsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # unselected - # ---------- - @property - def unselected(self): - """ - The 'unselected' property is an instance of Unselected - that may be specified as: - - An instance of plotly.graph_objs.bar.Unselected - - A dict of string/value properties that will be passed - to the Unselected constructor - - Supported dict properties: - - marker - plotly.graph_objs.bar.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.bar.unselected.Textfont - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.bar.Unselected - """ - return self['unselected'] - - @unselected.setter - def unselected(self, val): - self['unselected'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # x0 - # -- - @property - 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 - ------- - Any - """ - return self['x0'] - - @x0.setter - def x0(self, val): - self['x0'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # xcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['xcalendar'] - - @xcalendar.setter - def xcalendar(self, val): - self['xcalendar'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # y0 - # -- - @property - 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 - ------- - Any - """ - return self['y0'] - - @y0.setter - def y0(self, val): - self['y0'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # ycalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['ycalendar'] - - @ycalendar.setter - def ycalendar(self, val): - self['ycalendar'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - alignmentgroup - Set several traces linked to the same position axis or - matching axes to the same alignmentgroup. This controls - whether bars compute their positional range dependently - or independently. - base - Sets where the bar base is drawn (in position axis - units). In "stack" or "relative" barmode, traces that - set "base" will be excluded and drawn in "overlay" mode - instead. - basesrc - Sets the source reference on plot.ly for base . - cliponaxis - Determines whether the text nodes are clipped about the - subplot axes. To show the text nodes above axis lines - and tick labels, make sure to set `xaxis.layer` and - `yaxis.layer` to *below traces*. - constraintext - Constrain the size of text inside or outside a bar to - be no larger than the bar itself. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dx - Sets the x coordinate step. See `x0` for more info. - dy - Sets the y coordinate step. See `y0` for more info. - error_x - plotly.graph_objs.bar.ErrorX instance or dict with - compatible properties - error_y - plotly.graph_objs.bar.ErrorY instance or dict with - compatible properties - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.bar.Hoverlabel instance or dict with - compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (x,y) - pair. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to the this trace's (x,y) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - insidetextfont - Sets the font used for `text` lying inside the bar. - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - marker - plotly.graph_objs.bar.Marker instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - offset - Shifts the position where the bar is drawn (in position - axis units). In "group" barmode, traces that set - "offset" will be excluded and drawn in "overlay" mode - instead. - offsetgroup - Set several traces linked to the same position axis or - matching axes to the same offsetgroup where bars of the - same position coordinate will line up. - offsetsrc - Sets the source reference on plot.ly for offset . - opacity - Sets the opacity of the trace. - orientation - Sets the orientation of the bars. With "v" ("h"), the - value of the each bar spans along the vertical - (horizontal). - outsidetextfont - Sets the font used for `text` lying outside the bar. - r - r coordinates in scatter traces are deprecated!Please - switch to the "scatterpolar" trace type.Sets the radial - coordinatesfor legacy polar chart only. - rsrc - Sets the source reference on plot.ly for r . - selected - plotly.graph_objs.bar.Selected instance or dict with - compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.bar.Stream instance or dict with - compatible properties - t - t coordinates in scatter traces are deprecated!Please - switch to the "scatterpolar" trace type.Sets the - angular coordinatesfor legacy polar chart only. - text - Sets text elements associated with each (x,y) pair. If - a single string, the same string appears over all the - data points. If an array of string, the items are - mapped in order to the this trace's (x,y) coordinates. - If trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textfont - Sets the font used for `text`. - textposition - Specifies the location of the `text`. "inside" - positions `text` inside, next to the bar end (rotated - and scaled if needed). "outside" positions `text` - outside, next to the bar end (scaled if needed), unless - there is another bar stacked on this one, then the text - gets pushed inside. "auto" tries to position `text` - inside the bar, but if the bar is too small and no bar - is stacked on this one the text is moved outside. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - tsrc - Sets the source reference on plot.ly for t . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.bar.Unselected instance or dict with - compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - width - Sets the bar width (in position axis units). - widthsrc - Sets the source reference on plot.ly for width . - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the starting - coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the starting - coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - """ - - def __init__( - self, - arg=None, - alignmentgroup=None, - base=None, - basesrc=None, - cliponaxis=None, - constraintext=None, - customdata=None, - customdatasrc=None, - dx=None, - dy=None, - error_x=None, - error_y=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - insidetextfont=None, - legendgroup=None, - marker=None, - name=None, - offset=None, - offsetgroup=None, - offsetsrc=None, - opacity=None, - orientation=None, - outsidetextfont=None, - r=None, - rsrc=None, - selected=None, - selectedpoints=None, - showlegend=None, - stream=None, - t=None, - text=None, - textfont=None, - textposition=None, - textpositionsrc=None, - textsrc=None, - tsrc=None, - uid=None, - uirevision=None, - unselected=None, - visible=None, - width=None, - widthsrc=None, - x=None, - x0=None, - xaxis=None, - xcalendar=None, - xsrc=None, - y=None, - y0=None, - yaxis=None, - ycalendar=None, - ysrc=None, - **kwargs - ): - """ - 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 - interchanged. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Bar - alignmentgroup - Set several traces linked to the same position axis or - matching axes to the same alignmentgroup. This controls - whether bars compute their positional range dependently - or independently. - base - Sets where the bar base is drawn (in position axis - units). In "stack" or "relative" barmode, traces that - set "base" will be excluded and drawn in "overlay" mode - instead. - basesrc - Sets the source reference on plot.ly for base . - cliponaxis - Determines whether the text nodes are clipped about the - subplot axes. To show the text nodes above axis lines - and tick labels, make sure to set `xaxis.layer` and - `yaxis.layer` to *below traces*. - constraintext - Constrain the size of text inside or outside a bar to - be no larger than the bar itself. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dx - Sets the x coordinate step. See `x0` for more info. - dy - Sets the y coordinate step. See `y0` for more info. - error_x - plotly.graph_objs.bar.ErrorX instance or dict with - compatible properties - error_y - plotly.graph_objs.bar.ErrorY instance or dict with - compatible properties - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.bar.Hoverlabel instance or dict with - compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (x,y) - pair. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to the this trace's (x,y) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - insidetextfont - Sets the font used for `text` lying inside the bar. - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - marker - plotly.graph_objs.bar.Marker instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - offset - Shifts the position where the bar is drawn (in position - axis units). In "group" barmode, traces that set - "offset" will be excluded and drawn in "overlay" mode - instead. - offsetgroup - Set several traces linked to the same position axis or - matching axes to the same offsetgroup where bars of the - same position coordinate will line up. - offsetsrc - Sets the source reference on plot.ly for offset . - opacity - Sets the opacity of the trace. - orientation - Sets the orientation of the bars. With "v" ("h"), the - value of the each bar spans along the vertical - (horizontal). - outsidetextfont - Sets the font used for `text` lying outside the bar. - r - r coordinates in scatter traces are deprecated!Please - switch to the "scatterpolar" trace type.Sets the radial - coordinatesfor legacy polar chart only. - rsrc - Sets the source reference on plot.ly for r . - selected - plotly.graph_objs.bar.Selected instance or dict with - compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.bar.Stream instance or dict with - compatible properties - t - t coordinates in scatter traces are deprecated!Please - switch to the "scatterpolar" trace type.Sets the - angular coordinatesfor legacy polar chart only. - text - Sets text elements associated with each (x,y) pair. If - a single string, the same string appears over all the - data points. If an array of string, the items are - mapped in order to the this trace's (x,y) coordinates. - If trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textfont - Sets the font used for `text`. - textposition - Specifies the location of the `text`. "inside" - positions `text` inside, next to the bar end (rotated - and scaled if needed). "outside" positions `text` - outside, next to the bar end (scaled if needed), unless - there is another bar stacked on this one, then the text - gets pushed inside. "auto" tries to position `text` - inside the bar, but if the bar is too small and no bar - is stacked on this one the text is moved outside. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - tsrc - Sets the source reference on plot.ly for t . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.bar.Unselected instance or dict with - compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - width - Sets the bar width (in position axis units). - widthsrc - Sets the source reference on plot.ly for width . - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the starting - coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the starting - coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - - Returns - ------- - Bar - """ - super(Bar, self).__init__('bar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Bar -constructor must be a dict or -an instance of plotly.graph_objs.Bar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (bar as v_bar) - - # Initialize validators - # --------------------- - self._validators['alignmentgroup'] = v_bar.AlignmentgroupValidator() - self._validators['base'] = v_bar.BaseValidator() - self._validators['basesrc'] = v_bar.BasesrcValidator() - self._validators['cliponaxis'] = v_bar.CliponaxisValidator() - self._validators['constraintext'] = v_bar.ConstraintextValidator() - self._validators['customdata'] = v_bar.CustomdataValidator() - self._validators['customdatasrc'] = v_bar.CustomdatasrcValidator() - self._validators['dx'] = v_bar.DxValidator() - self._validators['dy'] = v_bar.DyValidator() - self._validators['error_x'] = v_bar.ErrorXValidator() - self._validators['error_y'] = v_bar.ErrorYValidator() - self._validators['hoverinfo'] = v_bar.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_bar.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_bar.HoverlabelValidator() - self._validators['hovertemplate'] = v_bar.HovertemplateValidator() - self._validators['hovertemplatesrc'] = v_bar.HovertemplatesrcValidator( - ) - self._validators['hovertext'] = v_bar.HovertextValidator() - self._validators['hovertextsrc'] = v_bar.HovertextsrcValidator() - self._validators['ids'] = v_bar.IdsValidator() - self._validators['idssrc'] = v_bar.IdssrcValidator() - self._validators['insidetextfont'] = v_bar.InsidetextfontValidator() - self._validators['legendgroup'] = v_bar.LegendgroupValidator() - self._validators['marker'] = v_bar.MarkerValidator() - self._validators['name'] = v_bar.NameValidator() - self._validators['offset'] = v_bar.OffsetValidator() - self._validators['offsetgroup'] = v_bar.OffsetgroupValidator() - self._validators['offsetsrc'] = v_bar.OffsetsrcValidator() - self._validators['opacity'] = v_bar.OpacityValidator() - self._validators['orientation'] = v_bar.OrientationValidator() - self._validators['outsidetextfont'] = v_bar.OutsidetextfontValidator() - self._validators['r'] = v_bar.RValidator() - self._validators['rsrc'] = v_bar.RsrcValidator() - self._validators['selected'] = v_bar.SelectedValidator() - self._validators['selectedpoints'] = v_bar.SelectedpointsValidator() - self._validators['showlegend'] = v_bar.ShowlegendValidator() - self._validators['stream'] = v_bar.StreamValidator() - self._validators['t'] = v_bar.TValidator() - self._validators['text'] = v_bar.TextValidator() - self._validators['textfont'] = v_bar.TextfontValidator() - self._validators['textposition'] = v_bar.TextpositionValidator() - self._validators['textpositionsrc'] = v_bar.TextpositionsrcValidator() - self._validators['textsrc'] = v_bar.TextsrcValidator() - self._validators['tsrc'] = v_bar.TsrcValidator() - self._validators['uid'] = v_bar.UidValidator() - self._validators['uirevision'] = v_bar.UirevisionValidator() - self._validators['unselected'] = v_bar.UnselectedValidator() - self._validators['visible'] = v_bar.VisibleValidator() - self._validators['width'] = v_bar.WidthValidator() - self._validators['widthsrc'] = v_bar.WidthsrcValidator() - self._validators['x'] = v_bar.XValidator() - self._validators['x0'] = v_bar.X0Validator() - self._validators['xaxis'] = v_bar.XAxisValidator() - self._validators['xcalendar'] = v_bar.XcalendarValidator() - self._validators['xsrc'] = v_bar.XsrcValidator() - self._validators['y'] = v_bar.YValidator() - self._validators['y0'] = v_bar.Y0Validator() - self._validators['yaxis'] = v_bar.YAxisValidator() - self._validators['ycalendar'] = v_bar.YcalendarValidator() - self._validators['ysrc'] = v_bar.YsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('alignmentgroup', None) - self['alignmentgroup' - ] = alignmentgroup if alignmentgroup is not None else _v - _v = arg.pop('base', None) - self['base'] = base if base is not None else _v - _v = arg.pop('basesrc', None) - self['basesrc'] = basesrc if basesrc is not None else _v - _v = arg.pop('cliponaxis', None) - self['cliponaxis'] = cliponaxis if cliponaxis is not None else _v - _v = arg.pop('constraintext', None) - self['constraintext' - ] = constraintext if constraintext is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('dx', None) - self['dx'] = dx if dx is not None else _v - _v = arg.pop('dy', None) - self['dy'] = dy if dy is not None else _v - _v = arg.pop('error_x', None) - self['error_x'] = error_x if error_x is not None else _v - _v = arg.pop('error_y', None) - self['error_y'] = error_y if error_y is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('insidetextfont', None) - self['insidetextfont' - ] = insidetextfont if insidetextfont is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('offset', None) - self['offset'] = offset if offset is not None else _v - _v = arg.pop('offsetgroup', None) - self['offsetgroup'] = offsetgroup if offsetgroup is not None else _v - _v = arg.pop('offsetsrc', None) - self['offsetsrc'] = offsetsrc if offsetsrc is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('orientation', None) - self['orientation'] = orientation if orientation is not None else _v - _v = arg.pop('outsidetextfont', None) - self['outsidetextfont' - ] = outsidetextfont if outsidetextfont is not None else _v - _v = arg.pop('r', None) - self['r'] = r if r is not None else _v - _v = arg.pop('rsrc', None) - self['rsrc'] = rsrc if rsrc is not None else _v - _v = arg.pop('selected', None) - self['selected'] = selected if selected is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('t', None) - self['t'] = t if t is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - _v = arg.pop('textposition', None) - self['textposition'] = textposition if textposition is not None else _v - _v = arg.pop('textpositionsrc', None) - self['textpositionsrc' - ] = textpositionsrc if textpositionsrc is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('tsrc', None) - self['tsrc'] = tsrc if tsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('unselected', None) - self['unselected'] = unselected if unselected is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('x0', None) - self['x0'] = x0 if x0 is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('xcalendar', None) - self['xcalendar'] = xcalendar if xcalendar is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('y0', None) - self['y0'] = y0 if y0 is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - _v = arg.pop('ycalendar', None) - self['ycalendar'] = ycalendar if ycalendar is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'bar' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='bar', val='bar' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_barpolar.py b/plotly/graph_objs/_barpolar.py deleted file mode 100644 index 24526f300e6..00000000000 --- a/plotly/graph_objs/_barpolar.py +++ /dev/null @@ -1,1625 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Barpolar(BaseTraceType): - - # base - # ---- - @property - 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 - ------- - Any|numpy.ndarray - """ - return self['base'] - - @base.setter - def base(self, val): - self['base'] = val - - # basesrc - # ------- - @property - def basesrc(self): - """ - Sets the source reference on plot.ly for base . - - The 'basesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['basesrc'] - - @basesrc.setter - def basesrc(self, val): - self['basesrc'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # dr - # -- - @property - def dr(self): - """ - Sets the r coordinate step. - - The 'dr' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['dr'] - - @dr.setter - def dr(self, val): - self['dr'] = val - - # dtheta - # ------ - @property - 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 - - Returns - ------- - int|float - """ - return self['dtheta'] - - @dtheta.setter - def dtheta(self, val): - self['dtheta'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'r+theta') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.barpolar.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.barpolar.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of plotly.graph_objs.barpolar.Marker - - A dict of string/value properties that will be passed - to the Marker constructor - - Supported dict properties: - - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.barpolar.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - line - plotly.graph_objs.barpolar.marker.Line instance - or dict with compatible properties - opacity - Sets the opacity of the bars. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - - Returns - ------- - plotly.graph_objs.barpolar.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # offset - # ------ - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['offset'] - - @offset.setter - def offset(self, val): - self['offset'] = val - - # offsetsrc - # --------- - @property - def offsetsrc(self): - """ - Sets the source reference on plot.ly for offset . - - The 'offsetsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['offsetsrc'] - - @offsetsrc.setter - def offsetsrc(self, val): - self['offsetsrc'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # r - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['r'] - - @r.setter - def r(self, val): - self['r'] = val - - # r0 - # -- - @property - 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 - ------- - Any - """ - return self['r0'] - - @r0.setter - def r0(self, val): - self['r0'] = val - - # rsrc - # ---- - @property - def rsrc(self): - """ - Sets the source reference on plot.ly for r . - - The 'rsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['rsrc'] - - @rsrc.setter - def rsrc(self, val): - self['rsrc'] = val - - # selected - # -------- - @property - def selected(self): - """ - The 'selected' property is an instance of Selected - that may be specified as: - - An instance of plotly.graph_objs.barpolar.Selected - - A dict of string/value properties that will be passed - to the Selected constructor - - Supported dict properties: - - marker - plotly.graph_objs.barpolar.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.barpolar.selected.Textfont - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.barpolar.Selected - """ - return self['selected'] - - @selected.setter - def selected(self, val): - self['selected'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.barpolar.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.barpolar.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # subplot - # ------- - @property - def subplot(self): - """ - Sets a reference between this trace's data coordinates and a - polar subplot. If "polar" (the default value), the data refer - to `layout.polar`. If "polar2", the data refer to - `layout.polar2`, and so on. - - The 'subplot' property is an identifier of a particular - subplot, of type 'polar', that may be specified as the string 'polar' - optionally followed by an integer >= 1 - (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) - - Returns - ------- - str - """ - return self['subplot'] - - @subplot.setter - def subplot(self, val): - self['subplot'] = val - - # text - # ---- - @property - def text(self): - """ - Sets hover text elements associated with each bar. If a single - string, the same string appears over all bars. If an array of - string, the items are mapped in order to the this trace's - coordinates. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # theta - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['theta'] - - @theta.setter - def theta(self, val): - self['theta'] = val - - # theta0 - # ------ - @property - 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 - ------- - Any - """ - return self['theta0'] - - @theta0.setter - def theta0(self, val): - self['theta0'] = val - - # thetasrc - # -------- - @property - def thetasrc(self): - """ - Sets the source reference on plot.ly for theta . - - The 'thetasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['thetasrc'] - - @thetasrc.setter - def thetasrc(self, val): - self['thetasrc'] = val - - # thetaunit - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thetaunit'] - - @thetaunit.setter - def thetaunit(self, val): - self['thetaunit'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # unselected - # ---------- - @property - def unselected(self): - """ - The 'unselected' property is an instance of Unselected - that may be specified as: - - An instance of plotly.graph_objs.barpolar.Unselected - - A dict of string/value properties that will be passed - to the Unselected constructor - - Supported dict properties: - - marker - plotly.graph_objs.barpolar.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.barpolar.unselected.Textfont - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.barpolar.Unselected - """ - return self['unselected'] - - @unselected.setter - def unselected(self, val): - self['unselected'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - base - Sets where the bar base is drawn (in radial axis - units). In "stack" barmode, traces that set "base" will - be excluded and drawn in "overlay" mode instead. - basesrc - Sets the source reference on plot.ly for base . - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dr - Sets the r coordinate step. - dtheta - Sets the theta coordinate step. By default, the - `dtheta` step equals the subplot's period divided by - the length of the `r` coordinates. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.barpolar.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - marker - plotly.graph_objs.barpolar.Marker instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - offset - Shifts the angular position where the bar is drawn (in - "thetatunit" units). - offsetsrc - Sets the source reference on plot.ly for offset . - opacity - Sets the opacity of the trace. - r - Sets the radial coordinates - r0 - Alternate to `r`. Builds a linear space of r - coordinates. Use with `dr` where `r0` is the starting - coordinate and `dr` the step. - rsrc - Sets the source reference on plot.ly for r . - selected - plotly.graph_objs.barpolar.Selected instance or dict - with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.barpolar.Stream instance or dict with - compatible properties - subplot - Sets a reference between this trace's data coordinates - and a polar subplot. If "polar" (the default value), - the data refer to `layout.polar`. If "polar2", the data - refer to `layout.polar2`, and so on. - text - Sets hover text elements associated with each bar. If a - single string, the same string appears over all bars. - If an array of string, the items are mapped in order to - the this trace's coordinates. - textsrc - Sets the source reference on plot.ly for text . - theta - Sets the angular coordinates - theta0 - Alternate to `theta`. Builds a linear space of theta - coordinates. Use with `dtheta` where `theta0` is the - starting coordinate and `dtheta` the step. - thetasrc - Sets the source reference on plot.ly for theta . - thetaunit - Sets the unit of input "theta" values. Has an effect - only when on "linear" angular axes. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.barpolar.Unselected instance or dict - with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - width - Sets the bar angular width (in "thetaunit" units). - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - base=None, - basesrc=None, - customdata=None, - customdatasrc=None, - dr=None, - dtheta=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - legendgroup=None, - marker=None, - name=None, - offset=None, - offsetsrc=None, - opacity=None, - r=None, - r0=None, - rsrc=None, - selected=None, - selectedpoints=None, - showlegend=None, - stream=None, - subplot=None, - text=None, - textsrc=None, - theta=None, - theta0=None, - thetasrc=None, - thetaunit=None, - uid=None, - uirevision=None, - unselected=None, - visible=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Barpolar object - - The data visualized by the radial span of the bars is set in - `r` - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Barpolar - base - Sets where the bar base is drawn (in radial axis - units). In "stack" barmode, traces that set "base" will - be excluded and drawn in "overlay" mode instead. - basesrc - Sets the source reference on plot.ly for base . - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dr - Sets the r coordinate step. - dtheta - Sets the theta coordinate step. By default, the - `dtheta` step equals the subplot's period divided by - the length of the `r` coordinates. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.barpolar.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - marker - plotly.graph_objs.barpolar.Marker instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - offset - Shifts the angular position where the bar is drawn (in - "thetatunit" units). - offsetsrc - Sets the source reference on plot.ly for offset . - opacity - Sets the opacity of the trace. - r - Sets the radial coordinates - r0 - Alternate to `r`. Builds a linear space of r - coordinates. Use with `dr` where `r0` is the starting - coordinate and `dr` the step. - rsrc - Sets the source reference on plot.ly for r . - selected - plotly.graph_objs.barpolar.Selected instance or dict - with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.barpolar.Stream instance or dict with - compatible properties - subplot - Sets a reference between this trace's data coordinates - and a polar subplot. If "polar" (the default value), - the data refer to `layout.polar`. If "polar2", the data - refer to `layout.polar2`, and so on. - text - Sets hover text elements associated with each bar. If a - single string, the same string appears over all bars. - If an array of string, the items are mapped in order to - the this trace's coordinates. - textsrc - Sets the source reference on plot.ly for text . - theta - Sets the angular coordinates - theta0 - Alternate to `theta`. Builds a linear space of theta - coordinates. Use with `dtheta` where `theta0` is the - starting coordinate and `dtheta` the step. - thetasrc - Sets the source reference on plot.ly for theta . - thetaunit - Sets the unit of input "theta" values. Has an effect - only when on "linear" angular axes. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.barpolar.Unselected instance or dict - with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - width - Sets the bar angular width (in "thetaunit" units). - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Barpolar - """ - super(Barpolar, self).__init__('barpolar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Barpolar -constructor must be a dict or -an instance of plotly.graph_objs.Barpolar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (barpolar as v_barpolar) - - # Initialize validators - # --------------------- - self._validators['base'] = v_barpolar.BaseValidator() - self._validators['basesrc'] = v_barpolar.BasesrcValidator() - self._validators['customdata'] = v_barpolar.CustomdataValidator() - self._validators['customdatasrc'] = v_barpolar.CustomdatasrcValidator() - self._validators['dr'] = v_barpolar.DrValidator() - self._validators['dtheta'] = v_barpolar.DthetaValidator() - self._validators['hoverinfo'] = v_barpolar.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_barpolar.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_barpolar.HoverlabelValidator() - self._validators['hovertemplate'] = v_barpolar.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_barpolar.HovertemplatesrcValidator() - self._validators['hovertext'] = v_barpolar.HovertextValidator() - self._validators['hovertextsrc'] = v_barpolar.HovertextsrcValidator() - self._validators['ids'] = v_barpolar.IdsValidator() - self._validators['idssrc'] = v_barpolar.IdssrcValidator() - self._validators['legendgroup'] = v_barpolar.LegendgroupValidator() - self._validators['marker'] = v_barpolar.MarkerValidator() - self._validators['name'] = v_barpolar.NameValidator() - self._validators['offset'] = v_barpolar.OffsetValidator() - self._validators['offsetsrc'] = v_barpolar.OffsetsrcValidator() - self._validators['opacity'] = v_barpolar.OpacityValidator() - self._validators['r'] = v_barpolar.RValidator() - self._validators['r0'] = v_barpolar.R0Validator() - self._validators['rsrc'] = v_barpolar.RsrcValidator() - self._validators['selected'] = v_barpolar.SelectedValidator() - self._validators['selectedpoints' - ] = v_barpolar.SelectedpointsValidator() - self._validators['showlegend'] = v_barpolar.ShowlegendValidator() - self._validators['stream'] = v_barpolar.StreamValidator() - self._validators['subplot'] = v_barpolar.SubplotValidator() - self._validators['text'] = v_barpolar.TextValidator() - self._validators['textsrc'] = v_barpolar.TextsrcValidator() - self._validators['theta'] = v_barpolar.ThetaValidator() - self._validators['theta0'] = v_barpolar.Theta0Validator() - self._validators['thetasrc'] = v_barpolar.ThetasrcValidator() - self._validators['thetaunit'] = v_barpolar.ThetaunitValidator() - self._validators['uid'] = v_barpolar.UidValidator() - self._validators['uirevision'] = v_barpolar.UirevisionValidator() - self._validators['unselected'] = v_barpolar.UnselectedValidator() - self._validators['visible'] = v_barpolar.VisibleValidator() - self._validators['width'] = v_barpolar.WidthValidator() - self._validators['widthsrc'] = v_barpolar.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('base', None) - self['base'] = base if base is not None else _v - _v = arg.pop('basesrc', None) - self['basesrc'] = basesrc if basesrc is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('dr', None) - self['dr'] = dr if dr is not None else _v - _v = arg.pop('dtheta', None) - self['dtheta'] = dtheta if dtheta is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('offset', None) - self['offset'] = offset if offset is not None else _v - _v = arg.pop('offsetsrc', None) - self['offsetsrc'] = offsetsrc if offsetsrc is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('r', None) - self['r'] = r if r is not None else _v - _v = arg.pop('r0', None) - self['r0'] = r0 if r0 is not None else _v - _v = arg.pop('rsrc', None) - self['rsrc'] = rsrc if rsrc is not None else _v - _v = arg.pop('selected', None) - self['selected'] = selected if selected is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('subplot', None) - self['subplot'] = subplot if subplot is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('theta', None) - self['theta'] = theta if theta is not None else _v - _v = arg.pop('theta0', None) - self['theta0'] = theta0 if theta0 is not None else _v - _v = arg.pop('thetasrc', None) - self['thetasrc'] = thetasrc if thetasrc is not None else _v - _v = arg.pop('thetaunit', None) - self['thetaunit'] = thetaunit if thetaunit is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('unselected', None) - self['unselected'] = unselected if unselected is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'barpolar' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='barpolar', val='barpolar' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_box.py b/plotly/graph_objs/_box.py deleted file mode 100644 index fe9f4574e69..00000000000 --- a/plotly/graph_objs/_box.py +++ /dev/null @@ -1,1840 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Box(BaseTraceType): - - # alignmentgroup - # -------------- - @property - 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 - - Returns - ------- - str - """ - return self['alignmentgroup'] - - @alignmentgroup.setter - def alignmentgroup(self, val): - self['alignmentgroup'] = val - - # boxmean - # ------- - @property - def boxmean(self): - """ - If True, the mean of the box(es)' underlying distribution is - drawn as a dashed line inside the box(es). If "sd" the standard - deviation is also drawn. - - The 'boxmean' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, 'sd', False] - - Returns - ------- - Any - """ - return self['boxmean'] - - @boxmean.setter - def boxmean(self, val): - self['boxmean'] = val - - # boxpoints - # --------- - @property - def boxpoints(self): - """ - If "outliers", only the sample points lying outside the - whiskers are shown If "suspectedoutliers", the outlier points - are shown and points either less than 4*Q1-3*Q3 or greater than - 4*Q3-3*Q1 are highlighted (see `outliercolor`) If "all", all - sample points are shown If False, only the box(es) are shown - with no sample points - - The 'boxpoints' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'outliers', 'suspectedoutliers', False] - - Returns - ------- - Any - """ - return self['boxpoints'] - - @boxpoints.setter - def boxpoints(self, val): - self['boxpoints'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # fillcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['fillcolor'] - - @fillcolor.setter - def fillcolor(self, val): - self['fillcolor'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.box.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.box.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hoveron - # ------- - @property - 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 - (e.g. 'boxes+points') - - Returns - ------- - Any - """ - return self['hoveron'] - - @hoveron.setter - def hoveron(self, val): - self['hoveron'] = val - - # hovertext - # --------- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # jitter - # ------ - @property - def jitter(self): - """ - Sets the amount of jitter in the sample points drawn. If 0, the - sample points align along the distribution axis. If 1, the - sample points are drawn in a random jitter of width equal to - the width of the box(es). - - The 'jitter' property is a number and may be specified as: - - An int or float in the interval [0, 1] - - Returns - ------- - int|float - """ - return self['jitter'] - - @jitter.setter - def jitter(self, val): - self['jitter'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of plotly.graph_objs.box.Line - - A dict of string/value properties that will be passed - to the Line constructor - - Supported dict properties: - - color - Sets the color of line bounding the box(es). - width - Sets the width (in px) of line bounding the - box(es). - - Returns - ------- - plotly.graph_objs.box.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - line - plotly.graph_objs.box.marker.Line instance or - dict with compatible properties - opacity - Sets the marker opacity. - outliercolor - Sets the color of the outlier sample points. - size - Sets the marker size (in px). - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - - Returns - ------- - plotly.graph_objs.box.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # name - # ---- - @property - def name(self): - """ - Sets the trace name. The trace name appear as the legend item - and on hover. For box traces, the name will also be used for - the position coordinate, if `x` and `x0` (`y` and `y0` if - horizontal) are missing and the position axis is categorical - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # notched - # ------- - @property - def notched(self): - """ - Determines whether or not notches should be drawn. - - The 'notched' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['notched'] - - @notched.setter - def notched(self, val): - self['notched'] = val - - # notchwidth - # ---------- - @property - 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] - - Returns - ------- - int|float - """ - return self['notchwidth'] - - @notchwidth.setter - def notchwidth(self, val): - self['notchwidth'] = val - - # offsetgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['offsetgroup'] - - @offsetgroup.setter - def offsetgroup(self, val): - self['offsetgroup'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # orientation - # ----------- - @property - 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'] - - Returns - ------- - Any - """ - return self['orientation'] - - @orientation.setter - def orientation(self, val): - self['orientation'] = val - - # pointpos - # -------- - @property - def pointpos(self): - """ - Sets the position of the sample points in relation to the - box(es). If 0, the sample points are places over the center of - the box(es). Positive (negative) values correspond to positions - to the right (left) for vertical boxes and above (below) for - horizontal boxes - - The 'pointpos' property is a number and may be specified as: - - An int or float in the interval [-2, 2] - - Returns - ------- - int|float - """ - return self['pointpos'] - - @pointpos.setter - def pointpos(self, val): - self['pointpos'] = val - - # selected - # -------- - @property - def selected(self): - """ - The 'selected' property is an instance of Selected - that may be specified as: - - An instance of plotly.graph_objs.box.Selected - - A dict of string/value properties that will be passed - to the Selected constructor - - Supported dict properties: - - marker - plotly.graph_objs.box.selected.Marker instance - or dict with compatible properties - - Returns - ------- - plotly.graph_objs.box.Selected - """ - return self['selected'] - - @selected.setter - def selected(self, val): - self['selected'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.box.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.box.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - def text(self): - """ - Sets the text elements associated with each sample value. If a - single string, the same string appears over all the data - points. If an array of string, the items are mapped in order to - the this trace's (x,y) coordinates. To be seen, trace - `hoverinfo` must contain a "text" flag. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # unselected - # ---------- - @property - def unselected(self): - """ - The 'unselected' property is an instance of Unselected - that may be specified as: - - An instance of plotly.graph_objs.box.Unselected - - A dict of string/value properties that will be passed - to the Unselected constructor - - Supported dict properties: - - marker - plotly.graph_objs.box.unselected.Marker - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.box.Unselected - """ - return self['unselected'] - - @unselected.setter - def unselected(self, val): - self['unselected'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # whiskerwidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['whiskerwidth'] - - @whiskerwidth.setter - def whiskerwidth(self, val): - self['whiskerwidth'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # x0 - # -- - @property - def x0(self): - """ - Sets the x coordinate of the box. See overview for more info. - - The 'x0' property accepts values of any type - - Returns - ------- - Any - """ - return self['x0'] - - @x0.setter - def x0(self, val): - self['x0'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # xcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['xcalendar'] - - @xcalendar.setter - def xcalendar(self, val): - self['xcalendar'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # y0 - # -- - @property - def y0(self): - """ - Sets the y coordinate of the box. See overview for more info. - - The 'y0' property accepts values of any type - - Returns - ------- - Any - """ - return self['y0'] - - @y0.setter - def y0(self, val): - self['y0'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # ycalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['ycalendar'] - - @ycalendar.setter - def ycalendar(self, val): - self['ycalendar'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - alignmentgroup - Set several traces linked to the same position axis or - matching axes to the same alignmentgroup. This controls - whether bars compute their positional range dependently - or independently. - boxmean - If True, the mean of the box(es)' underlying - distribution is drawn as a dashed line inside the - box(es). If "sd" the standard deviation is also drawn. - boxpoints - If "outliers", only the sample points lying outside the - whiskers are shown If "suspectedoutliers", the outlier - points are shown and points either less than 4*Q1-3*Q3 - or greater than 4*Q3-3*Q1 are highlighted (see - `outliercolor`) If "all", all sample points are shown - If False, only the box(es) are shown with no sample - points - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.box.Hoverlabel instance or dict with - compatible properties - hoveron - Do the hover effects highlight individual boxes or - sample points or both? - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - jitter - Sets the amount of jitter in the sample points drawn. - If 0, the sample points align along the distribution - axis. If 1, the sample points are drawn in a random - jitter of width equal to the width of the box(es). - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.box.Line instance or dict with - compatible properties - marker - plotly.graph_objs.box.Marker instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. For box traces, the name will - also be used for the position coordinate, if `x` and - `x0` (`y` and `y0` if horizontal) are missing and the - position axis is categorical - notched - Determines whether or not notches should be drawn. - notchwidth - Sets the width of the notches relative to the box' - width. For example, with 0, the notches are as wide as - the box(es). - offsetgroup - Set several traces linked to the same position axis or - matching axes to the same offsetgroup where bars of the - same position coordinate will line up. - opacity - Sets the opacity of the trace. - orientation - Sets the orientation of the box(es). If "v" ("h"), the - distribution is visualized along the vertical - (horizontal). - pointpos - Sets the position of the sample points in relation to - the box(es). If 0, the sample points are places over - the center of the box(es). Positive (negative) values - correspond to positions to the right (left) for - vertical boxes and above (below) for horizontal boxes - selected - plotly.graph_objs.box.Selected instance or dict with - compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.box.Stream instance or dict with - compatible properties - text - Sets the text elements associated with each sample - value. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to the this trace's (x,y) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.box.Unselected instance or dict with - compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - whiskerwidth - Sets the width of the whiskers relative to the box' - width. For example, with 1, the whiskers are as wide as - the box(es). - width - Sets the width of the box in data coordinate If 0 - (default value) the width is automatically selected - based on the positions of other box traces in the same - subplot. - x - Sets the x sample data or coordinates. See overview for - more info. - x0 - Sets the x coordinate of the box. See overview for more - info. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y sample data or coordinates. See overview for - more info. - y0 - Sets the y coordinate of the box. See overview for more - info. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - """ - - def __init__( - self, - arg=None, - alignmentgroup=None, - boxmean=None, - boxpoints=None, - customdata=None, - customdatasrc=None, - fillcolor=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hoveron=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - jitter=None, - legendgroup=None, - line=None, - marker=None, - name=None, - notched=None, - notchwidth=None, - offsetgroup=None, - opacity=None, - orientation=None, - pointpos=None, - selected=None, - selectedpoints=None, - showlegend=None, - stream=None, - text=None, - textsrc=None, - uid=None, - uirevision=None, - unselected=None, - visible=None, - whiskerwidth=None, - width=None, - x=None, - x0=None, - xaxis=None, - xcalendar=None, - xsrc=None, - y=None, - y0=None, - yaxis=None, - ycalendar=None, - ysrc=None, - **kwargs - ): - """ - Construct a new Box object - - In vertical (horizontal) box plots, statistics are computed - using `y` (`x`) values. By supplying an `x` (`y`) array, one - box per distinct x (y) value is drawn If no `x` (`y`) list is - provided, a single box is drawn. That box position is then - positioned with with `name` or with `x0` (`y0`) if provided. - Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The - second quartile (Q2) is marked by a line inside the box. By - default, the whiskers correspond to the box' edges +/- 1.5 - times the interquartile range (IQR = Q3-Q1), see "boxpoints" - for other options. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Box - alignmentgroup - Set several traces linked to the same position axis or - matching axes to the same alignmentgroup. This controls - whether bars compute their positional range dependently - or independently. - boxmean - If True, the mean of the box(es)' underlying - distribution is drawn as a dashed line inside the - box(es). If "sd" the standard deviation is also drawn. - boxpoints - If "outliers", only the sample points lying outside the - whiskers are shown If "suspectedoutliers", the outlier - points are shown and points either less than 4*Q1-3*Q3 - or greater than 4*Q3-3*Q1 are highlighted (see - `outliercolor`) If "all", all sample points are shown - If False, only the box(es) are shown with no sample - points - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.box.Hoverlabel instance or dict with - compatible properties - hoveron - Do the hover effects highlight individual boxes or - sample points or both? - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - jitter - Sets the amount of jitter in the sample points drawn. - If 0, the sample points align along the distribution - axis. If 1, the sample points are drawn in a random - jitter of width equal to the width of the box(es). - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.box.Line instance or dict with - compatible properties - marker - plotly.graph_objs.box.Marker instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. For box traces, the name will - also be used for the position coordinate, if `x` and - `x0` (`y` and `y0` if horizontal) are missing and the - position axis is categorical - notched - Determines whether or not notches should be drawn. - notchwidth - Sets the width of the notches relative to the box' - width. For example, with 0, the notches are as wide as - the box(es). - offsetgroup - Set several traces linked to the same position axis or - matching axes to the same offsetgroup where bars of the - same position coordinate will line up. - opacity - Sets the opacity of the trace. - orientation - Sets the orientation of the box(es). If "v" ("h"), the - distribution is visualized along the vertical - (horizontal). - pointpos - Sets the position of the sample points in relation to - the box(es). If 0, the sample points are places over - the center of the box(es). Positive (negative) values - correspond to positions to the right (left) for - vertical boxes and above (below) for horizontal boxes - selected - plotly.graph_objs.box.Selected instance or dict with - compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.box.Stream instance or dict with - compatible properties - text - Sets the text elements associated with each sample - value. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to the this trace's (x,y) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.box.Unselected instance or dict with - compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - whiskerwidth - Sets the width of the whiskers relative to the box' - width. For example, with 1, the whiskers are as wide as - the box(es). - width - Sets the width of the box in data coordinate If 0 - (default value) the width is automatically selected - based on the positions of other box traces in the same - subplot. - x - Sets the x sample data or coordinates. See overview for - more info. - x0 - Sets the x coordinate of the box. See overview for more - info. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y sample data or coordinates. See overview for - more info. - y0 - Sets the y coordinate of the box. See overview for more - info. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - - Returns - ------- - Box - """ - super(Box, self).__init__('box') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Box -constructor must be a dict or -an instance of plotly.graph_objs.Box""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (box as v_box) - - # Initialize validators - # --------------------- - self._validators['alignmentgroup'] = v_box.AlignmentgroupValidator() - self._validators['boxmean'] = v_box.BoxmeanValidator() - self._validators['boxpoints'] = v_box.BoxpointsValidator() - self._validators['customdata'] = v_box.CustomdataValidator() - self._validators['customdatasrc'] = v_box.CustomdatasrcValidator() - self._validators['fillcolor'] = v_box.FillcolorValidator() - self._validators['hoverinfo'] = v_box.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_box.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_box.HoverlabelValidator() - self._validators['hoveron'] = v_box.HoveronValidator() - self._validators['hovertext'] = v_box.HovertextValidator() - self._validators['hovertextsrc'] = v_box.HovertextsrcValidator() - self._validators['ids'] = v_box.IdsValidator() - self._validators['idssrc'] = v_box.IdssrcValidator() - self._validators['jitter'] = v_box.JitterValidator() - self._validators['legendgroup'] = v_box.LegendgroupValidator() - self._validators['line'] = v_box.LineValidator() - self._validators['marker'] = v_box.MarkerValidator() - self._validators['name'] = v_box.NameValidator() - self._validators['notched'] = v_box.NotchedValidator() - self._validators['notchwidth'] = v_box.NotchwidthValidator() - self._validators['offsetgroup'] = v_box.OffsetgroupValidator() - self._validators['opacity'] = v_box.OpacityValidator() - self._validators['orientation'] = v_box.OrientationValidator() - self._validators['pointpos'] = v_box.PointposValidator() - self._validators['selected'] = v_box.SelectedValidator() - self._validators['selectedpoints'] = v_box.SelectedpointsValidator() - self._validators['showlegend'] = v_box.ShowlegendValidator() - self._validators['stream'] = v_box.StreamValidator() - self._validators['text'] = v_box.TextValidator() - self._validators['textsrc'] = v_box.TextsrcValidator() - self._validators['uid'] = v_box.UidValidator() - self._validators['uirevision'] = v_box.UirevisionValidator() - self._validators['unselected'] = v_box.UnselectedValidator() - self._validators['visible'] = v_box.VisibleValidator() - self._validators['whiskerwidth'] = v_box.WhiskerwidthValidator() - self._validators['width'] = v_box.WidthValidator() - self._validators['x'] = v_box.XValidator() - self._validators['x0'] = v_box.X0Validator() - self._validators['xaxis'] = v_box.XAxisValidator() - self._validators['xcalendar'] = v_box.XcalendarValidator() - self._validators['xsrc'] = v_box.XsrcValidator() - self._validators['y'] = v_box.YValidator() - self._validators['y0'] = v_box.Y0Validator() - self._validators['yaxis'] = v_box.YAxisValidator() - self._validators['ycalendar'] = v_box.YcalendarValidator() - self._validators['ysrc'] = v_box.YsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('alignmentgroup', None) - self['alignmentgroup' - ] = alignmentgroup if alignmentgroup is not None else _v - _v = arg.pop('boxmean', None) - self['boxmean'] = boxmean if boxmean is not None else _v - _v = arg.pop('boxpoints', None) - self['boxpoints'] = boxpoints if boxpoints is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('fillcolor', None) - self['fillcolor'] = fillcolor if fillcolor is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hoveron', None) - self['hoveron'] = hoveron if hoveron is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('jitter', None) - self['jitter'] = jitter if jitter is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('notched', None) - self['notched'] = notched if notched is not None else _v - _v = arg.pop('notchwidth', None) - self['notchwidth'] = notchwidth if notchwidth is not None else _v - _v = arg.pop('offsetgroup', None) - self['offsetgroup'] = offsetgroup if offsetgroup is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('orientation', None) - self['orientation'] = orientation if orientation is not None else _v - _v = arg.pop('pointpos', None) - self['pointpos'] = pointpos if pointpos is not None else _v - _v = arg.pop('selected', None) - self['selected'] = selected if selected is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('unselected', None) - self['unselected'] = unselected if unselected is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('whiskerwidth', None) - self['whiskerwidth'] = whiskerwidth if whiskerwidth is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('x0', None) - self['x0'] = x0 if x0 is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('xcalendar', None) - self['xcalendar'] = xcalendar if xcalendar is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('y0', None) - self['y0'] = y0 if y0 is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - _v = arg.pop('ycalendar', None) - self['ycalendar'] = ycalendar if ycalendar is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'box' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='box', val='box' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_candlestick.py b/plotly/graph_objs/_candlestick.py deleted file mode 100644 index 4b5303198ab..00000000000 --- a/plotly/graph_objs/_candlestick.py +++ /dev/null @@ -1,1395 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Candlestick(BaseTraceType): - - # close - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['close'] - - @close.setter - def close(self, val): - self['close'] = val - - # closesrc - # -------- - @property - def closesrc(self): - """ - Sets the source reference on plot.ly for close . - - The 'closesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['closesrc'] - - @closesrc.setter - def closesrc(self, val): - self['closesrc'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # decreasing - # ---------- - @property - def decreasing(self): - """ - The 'decreasing' property is an instance of Decreasing - that may be specified as: - - An instance of plotly.graph_objs.candlestick.Decreasing - - A dict of string/value properties that will be passed - to the Decreasing constructor - - Supported dict properties: - - fillcolor - Sets the fill color. Defaults to a half- - transparent variant of the line color, marker - color, or marker line color, whichever is - available. - line - plotly.graph_objs.candlestick.decreasing.Line - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.candlestick.Decreasing - """ - return self['decreasing'] - - @decreasing.setter - def decreasing(self, val): - self['decreasing'] = val - - # high - # ---- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['high'] - - @high.setter - def high(self, val): - self['high'] = val - - # highsrc - # ------- - @property - def highsrc(self): - """ - Sets the source reference on plot.ly for high . - - The 'highsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['highsrc'] - - @highsrc.setter - def highsrc(self, val): - self['highsrc'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.candlestick.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - split - Show hover information (open, close, high, low) - in separate labels. - - Returns - ------- - plotly.graph_objs.candlestick.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertext - # --------- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # increasing - # ---------- - @property - def increasing(self): - """ - The 'increasing' property is an instance of Increasing - that may be specified as: - - An instance of plotly.graph_objs.candlestick.Increasing - - A dict of string/value properties that will be passed - to the Increasing constructor - - Supported dict properties: - - fillcolor - Sets the fill color. Defaults to a half- - transparent variant of the line color, marker - color, or marker line color, whichever is - available. - line - plotly.graph_objs.candlestick.increasing.Line - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.candlestick.Increasing - """ - return self['increasing'] - - @increasing.setter - def increasing(self, val): - self['increasing'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of plotly.graph_objs.candlestick.Line - - A dict of string/value properties that will be passed - to the Line constructor - - Supported dict properties: - - width - Sets the width (in px) of line bounding the - box(es). Note that this style setting can also - be set per direction via - `increasing.line.width` and - `decreasing.line.width`. - - Returns - ------- - plotly.graph_objs.candlestick.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # low - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['low'] - - @low.setter - def low(self, val): - self['low'] = val - - # lowsrc - # ------ - @property - def lowsrc(self): - """ - Sets the source reference on plot.ly for low . - - The 'lowsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['lowsrc'] - - @lowsrc.setter - def lowsrc(self, val): - self['lowsrc'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # open - # ---- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['open'] - - @open.setter - def open(self, val): - self['open'] = val - - # opensrc - # ------- - @property - def opensrc(self): - """ - Sets the source reference on plot.ly for open . - - The 'opensrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['opensrc'] - - @opensrc.setter - def opensrc(self, val): - self['opensrc'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.candlestick.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.candlestick.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - def text(self): - """ - Sets hover text elements associated with each sample point. If - a single string, the same string appears over all the data - points. If an array of string, the items are mapped in order to - this trace's sample points. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # whiskerwidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['whiskerwidth'] - - @whiskerwidth.setter - def whiskerwidth(self, val): - self['whiskerwidth'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # xcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['xcalendar'] - - @xcalendar.setter - def xcalendar(self, val): - self['xcalendar'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - close - Sets the close values. - closesrc - Sets the source reference on plot.ly for close . - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - decreasing - plotly.graph_objs.candlestick.Decreasing instance or - dict with compatible properties - high - Sets the high values. - highsrc - Sets the source reference on plot.ly for high . - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.candlestick.Hoverlabel instance or - dict with compatible properties - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - increasing - plotly.graph_objs.candlestick.Increasing instance or - dict with compatible properties - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.candlestick.Line instance or dict - with compatible properties - low - Sets the low values. - lowsrc - Sets the source reference on plot.ly for low . - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - open - Sets the open values. - opensrc - Sets the source reference on plot.ly for open . - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.candlestick.Stream instance or dict - with compatible properties - text - Sets hover text elements associated with each sample - point. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to this trace's sample points. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - whiskerwidth - Sets the width of the whiskers relative to the box' - width. For example, with 1, the whiskers are as wide as - the box(es). - x - Sets the x coordinates. If absent, linear coordinate - will be generated. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - """ - - def __init__( - self, - arg=None, - close=None, - closesrc=None, - customdata=None, - customdatasrc=None, - decreasing=None, - high=None, - highsrc=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - increasing=None, - legendgroup=None, - line=None, - low=None, - lowsrc=None, - name=None, - opacity=None, - open=None, - opensrc=None, - selectedpoints=None, - showlegend=None, - stream=None, - text=None, - textsrc=None, - uid=None, - uirevision=None, - visible=None, - whiskerwidth=None, - x=None, - xaxis=None, - xcalendar=None, - xsrc=None, - yaxis=None, - **kwargs - ): - """ - Construct a new Candlestick object - - The candlestick is a style of financial chart describing open, - high, low and close for a given `x` coordinate (most likely - time). The boxes represent the spread between the `open` and - `close` values and the lines represent the spread between the - `low` and `high` values Sample points where the close value is - higher (lower) then the open value are called increasing - (decreasing). By default, increasing candles are drawn in green - whereas decreasing are drawn in red. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Candlestick - close - Sets the close values. - closesrc - Sets the source reference on plot.ly for close . - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - decreasing - plotly.graph_objs.candlestick.Decreasing instance or - dict with compatible properties - high - Sets the high values. - highsrc - Sets the source reference on plot.ly for high . - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.candlestick.Hoverlabel instance or - dict with compatible properties - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - increasing - plotly.graph_objs.candlestick.Increasing instance or - dict with compatible properties - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.candlestick.Line instance or dict - with compatible properties - low - Sets the low values. - lowsrc - Sets the source reference on plot.ly for low . - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - open - Sets the open values. - opensrc - Sets the source reference on plot.ly for open . - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.candlestick.Stream instance or dict - with compatible properties - text - Sets hover text elements associated with each sample - point. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to this trace's sample points. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - whiskerwidth - Sets the width of the whiskers relative to the box' - width. For example, with 1, the whiskers are as wide as - the box(es). - x - Sets the x coordinates. If absent, linear coordinate - will be generated. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - - Returns - ------- - Candlestick - """ - super(Candlestick, self).__init__('candlestick') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Candlestick -constructor must be a dict or -an instance of plotly.graph_objs.Candlestick""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (candlestick as v_candlestick) - - # Initialize validators - # --------------------- - self._validators['close'] = v_candlestick.CloseValidator() - self._validators['closesrc'] = v_candlestick.ClosesrcValidator() - self._validators['customdata'] = v_candlestick.CustomdataValidator() - self._validators['customdatasrc' - ] = v_candlestick.CustomdatasrcValidator() - self._validators['decreasing'] = v_candlestick.DecreasingValidator() - self._validators['high'] = v_candlestick.HighValidator() - self._validators['highsrc'] = v_candlestick.HighsrcValidator() - self._validators['hoverinfo'] = v_candlestick.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_candlestick.HoverinfosrcValidator( - ) - self._validators['hoverlabel'] = v_candlestick.HoverlabelValidator() - self._validators['hovertext'] = v_candlestick.HovertextValidator() - self._validators['hovertextsrc'] = v_candlestick.HovertextsrcValidator( - ) - self._validators['ids'] = v_candlestick.IdsValidator() - self._validators['idssrc'] = v_candlestick.IdssrcValidator() - self._validators['increasing'] = v_candlestick.IncreasingValidator() - self._validators['legendgroup'] = v_candlestick.LegendgroupValidator() - self._validators['line'] = v_candlestick.LineValidator() - self._validators['low'] = v_candlestick.LowValidator() - self._validators['lowsrc'] = v_candlestick.LowsrcValidator() - self._validators['name'] = v_candlestick.NameValidator() - self._validators['opacity'] = v_candlestick.OpacityValidator() - self._validators['open'] = v_candlestick.OpenValidator() - self._validators['opensrc'] = v_candlestick.OpensrcValidator() - self._validators['selectedpoints' - ] = v_candlestick.SelectedpointsValidator() - self._validators['showlegend'] = v_candlestick.ShowlegendValidator() - self._validators['stream'] = v_candlestick.StreamValidator() - self._validators['text'] = v_candlestick.TextValidator() - self._validators['textsrc'] = v_candlestick.TextsrcValidator() - self._validators['uid'] = v_candlestick.UidValidator() - self._validators['uirevision'] = v_candlestick.UirevisionValidator() - self._validators['visible'] = v_candlestick.VisibleValidator() - self._validators['whiskerwidth'] = v_candlestick.WhiskerwidthValidator( - ) - self._validators['x'] = v_candlestick.XValidator() - self._validators['xaxis'] = v_candlestick.XAxisValidator() - self._validators['xcalendar'] = v_candlestick.XcalendarValidator() - self._validators['xsrc'] = v_candlestick.XsrcValidator() - self._validators['yaxis'] = v_candlestick.YAxisValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('close', None) - self['close'] = close if close is not None else _v - _v = arg.pop('closesrc', None) - self['closesrc'] = closesrc if closesrc is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('decreasing', None) - self['decreasing'] = decreasing if decreasing is not None else _v - _v = arg.pop('high', None) - self['high'] = high if high is not None else _v - _v = arg.pop('highsrc', None) - self['highsrc'] = highsrc if highsrc is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('increasing', None) - self['increasing'] = increasing if increasing is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('low', None) - self['low'] = low if low is not None else _v - _v = arg.pop('lowsrc', None) - self['lowsrc'] = lowsrc if lowsrc is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('open', None) - self['open'] = open if open is not None else _v - _v = arg.pop('opensrc', None) - self['opensrc'] = opensrc if opensrc is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('whiskerwidth', None) - self['whiskerwidth'] = whiskerwidth if whiskerwidth is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('xcalendar', None) - self['xcalendar'] = xcalendar if xcalendar is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'candlestick' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='candlestick', val='candlestick' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_carpet.py b/plotly/graph_objs/_carpet.py deleted file mode 100644 index d55d1bc5681..00000000000 --- a/plotly/graph_objs/_carpet.py +++ /dev/null @@ -1,1837 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Carpet(BaseTraceType): - - # a - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['a'] - - @a.setter - def a(self, val): - self['a'] = val - - # a0 - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['a0'] - - @a0.setter - def a0(self, val): - self['a0'] = val - - # aaxis - # ----- - @property - def aaxis(self): - """ - The 'aaxis' property is an instance of Aaxis - that may be specified as: - - An instance of plotly.graph_objs.carpet.Aaxis - - A dict of string/value properties that will be passed - to the Aaxis constructor - - Supported dict properties: - - arraydtick - The stride between grid lines along the axis - arraytick0 - The starting index of grid lines along the axis - autorange - Determines whether or not the range of this - axis is computed in relation to the input data. - See `rangemode` for more info. If `range` is - provided, then `autorange` is set to False. - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - cheatertype - - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - The stride between grid lines along the axis - endline - Determines whether or not a line is drawn at - along the final value of this axis. If True, - the end line is drawn on top of the grid lines. - endlinecolor - Sets the line color of the end line. - endlinewidth - Sets the width (in px) of the end line. - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - fixedrange - Determines whether or not this axis is zoom- - able. If true, then zoom is disabled. - gridcolor - Sets the axis line color. - gridwidth - Sets the width (in px) of the axis line. - labelpadding - Extra padding between label and the axis - labelprefix - Sets a axis label prefix. - labelsuffix - Sets a axis label suffix. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - minorgridcolor - Sets the color of the grid lines. - minorgridcount - Sets the number of minor grid ticks per major - grid tick - minorgridwidth - Sets the width (in px) of the grid lines. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - range - Sets the range of this axis. If the axis `type` - is "log", then you must take the log of your - desired range (e.g. to set the range from 1 to - 100, set the range from 0 to 2). If the axis - `type` is "date", it should be date strings, - like date data, though Date objects and unix - milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it - should be numbers, using the scale where each - category is assigned a serial number from zero - in the order it appears. - rangemode - If "normal", the range is computed in relation - to the extrema of the input data. If *tozero*`, - the range extends to 0, regardless of the input - data If "nonnegative", the range is non- - negative, regardless of the input data. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showticklabels - Determines whether axis labels are drawn on the - low side, the high side, both, or neither side - of the axis. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - smoothing - - startline - Determines whether or not a line is drawn at - along the starting value of this axis. If True, - the start line is drawn on top of the grid - lines. - startlinecolor - Sets the line color of the start line. - startlinewidth - Sets the width (in px) of the start line. - tick0 - The starting index of grid lines along the axis - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.carpet.aaxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.carpet.aaxis.tickformatstopdefaults), sets - the default property values to use for elements - of carpet.aaxis.tickformatstops - tickmode - - tickprefix - Sets a tick label prefix. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - title - plotly.graph_objs.carpet.aaxis.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use carpet.aaxis.title.font - instead. Sets this axis' title font. Note that - the title's font used to be set by the now - deprecated `titlefont` attribute. - titleoffset - Deprecated: Please use - carpet.aaxis.title.offset instead. An - additional amount by which to offset the title - from the tick labels, given in pixels. Note - that this used to be set by the now deprecated - `titleoffset` attribute. - type - Sets the axis type. By default, plotly attempts - to determined the axis type by looking into the - data of the traces that referenced the axis in - question. - - Returns - ------- - plotly.graph_objs.carpet.Aaxis - """ - return self['aaxis'] - - @aaxis.setter - def aaxis(self, val): - self['aaxis'] = val - - # asrc - # ---- - @property - def asrc(self): - """ - Sets the source reference on plot.ly for a . - - The 'asrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['asrc'] - - @asrc.setter - def asrc(self, val): - self['asrc'] = val - - # b - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['b'] - - @b.setter - def b(self, val): - self['b'] = val - - # b0 - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['b0'] - - @b0.setter - def b0(self, val): - self['b0'] = val - - # baxis - # ----- - @property - def baxis(self): - """ - The 'baxis' property is an instance of Baxis - that may be specified as: - - An instance of plotly.graph_objs.carpet.Baxis - - A dict of string/value properties that will be passed - to the Baxis constructor - - Supported dict properties: - - arraydtick - The stride between grid lines along the axis - arraytick0 - The starting index of grid lines along the axis - autorange - Determines whether or not the range of this - axis is computed in relation to the input data. - See `rangemode` for more info. If `range` is - provided, then `autorange` is set to False. - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - cheatertype - - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - The stride between grid lines along the axis - endline - Determines whether or not a line is drawn at - along the final value of this axis. If True, - the end line is drawn on top of the grid lines. - endlinecolor - Sets the line color of the end line. - endlinewidth - Sets the width (in px) of the end line. - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - fixedrange - Determines whether or not this axis is zoom- - able. If true, then zoom is disabled. - gridcolor - Sets the axis line color. - gridwidth - Sets the width (in px) of the axis line. - labelpadding - Extra padding between label and the axis - labelprefix - Sets a axis label prefix. - labelsuffix - Sets a axis label suffix. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - minorgridcolor - Sets the color of the grid lines. - minorgridcount - Sets the number of minor grid ticks per major - grid tick - minorgridwidth - Sets the width (in px) of the grid lines. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - range - Sets the range of this axis. If the axis `type` - is "log", then you must take the log of your - desired range (e.g. to set the range from 1 to - 100, set the range from 0 to 2). If the axis - `type` is "date", it should be date strings, - like date data, though Date objects and unix - milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it - should be numbers, using the scale where each - category is assigned a serial number from zero - in the order it appears. - rangemode - If "normal", the range is computed in relation - to the extrema of the input data. If *tozero*`, - the range extends to 0, regardless of the input - data If "nonnegative", the range is non- - negative, regardless of the input data. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showticklabels - Determines whether axis labels are drawn on the - low side, the high side, both, or neither side - of the axis. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - smoothing - - startline - Determines whether or not a line is drawn at - along the starting value of this axis. If True, - the start line is drawn on top of the grid - lines. - startlinecolor - Sets the line color of the start line. - startlinewidth - Sets the width (in px) of the start line. - tick0 - The starting index of grid lines along the axis - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.carpet.baxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.carpet.baxis.tickformatstopdefaults), sets - the default property values to use for elements - of carpet.baxis.tickformatstops - tickmode - - tickprefix - Sets a tick label prefix. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - title - plotly.graph_objs.carpet.baxis.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use carpet.baxis.title.font - instead. Sets this axis' title font. Note that - the title's font used to be set by the now - deprecated `titlefont` attribute. - titleoffset - Deprecated: Please use - carpet.baxis.title.offset instead. An - additional amount by which to offset the title - from the tick labels, given in pixels. Note - that this used to be set by the now deprecated - `titleoffset` attribute. - type - Sets the axis type. By default, plotly attempts - to determined the axis type by looking into the - data of the traces that referenced the axis in - question. - - Returns - ------- - plotly.graph_objs.carpet.Baxis - """ - return self['baxis'] - - @baxis.setter - def baxis(self, val): - self['baxis'] = val - - # bsrc - # ---- - @property - def bsrc(self): - """ - Sets the source reference on plot.ly for b . - - The 'bsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bsrc'] - - @bsrc.setter - def bsrc(self, val): - self['bsrc'] = val - - # carpet - # ------ - @property - def carpet(self): - """ - An identifier for this carpet, so that `scattercarpet` and - `scattercontour` traces can specify a carpet plot on which they - lie - - The 'carpet' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['carpet'] - - @carpet.setter - def carpet(self, val): - self['carpet'] = val - - # cheaterslope - # ------------ - @property - 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 - - Returns - ------- - int|float - """ - return self['cheaterslope'] - - @cheaterslope.setter - def cheaterslope(self, val): - self['cheaterslope'] = val - - # color - # ----- - @property - def color(self): - """ - Sets default for all colors associated with this axis all at - once: line, font, tick, and grid colors. Grid color is - lightened by blending this with the plot background Individual - pieces can override this. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # da - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['da'] - - @da.setter - def da(self, val): - self['da'] = val - - # db - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['db'] - - @db.setter - def db(self, val): - self['db'] = val - - # font - # ---- - @property - 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 plotly.graph_objs.carpet.Font - - A dict of string/value properties that will be passed - to the Font constructor - - Supported dict properties: - - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.carpet.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.carpet.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.carpet.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.carpet.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.carpet.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - a - An array containing values of the first parameter value - a0 - Alternate to `a`. Builds a linear space of a - coordinates. Use with `da` where `a0` is the starting - coordinate and `da` the step. - aaxis - plotly.graph_objs.carpet.Aaxis instance or dict with - compatible properties - asrc - Sets the source reference on plot.ly for a . - b - A two dimensional array of y coordinates at each carpet - point. - b0 - Alternate to `b`. Builds a linear space of a - coordinates. Use with `db` where `b0` is the starting - coordinate and `db` the step. - baxis - plotly.graph_objs.carpet.Baxis instance or dict with - compatible properties - bsrc - Sets the source reference on plot.ly for b . - carpet - An identifier for this carpet, so that `scattercarpet` - and `scattercontour` traces can specify a carpet plot - on which they lie - cheaterslope - The shift applied to each successive row of data in - creating a cheater plot. Only used if `x` is been - ommitted. - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - da - Sets the a coordinate step. See `a0` for more info. - db - Sets the b coordinate step. See `b0` for more info. - font - The default font used for axis & tick labels on this - carpet - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.carpet.Hoverlabel instance or dict - with compatible properties - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.carpet.Stream instance or dict with - compatible properties - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - A two dimensional array of x coordinates at each carpet - point. If ommitted, the plot is a cheater plot and the - xaxis is hidden by default. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xsrc - Sets the source reference on plot.ly for x . - y - A two dimensional array of y coordinates at each carpet - point. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ysrc - Sets the source reference on plot.ly for y . - """ - - def __init__( - self, - arg=None, - a=None, - a0=None, - aaxis=None, - asrc=None, - b=None, - b0=None, - baxis=None, - bsrc=None, - carpet=None, - cheaterslope=None, - color=None, - customdata=None, - customdatasrc=None, - da=None, - db=None, - font=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - ids=None, - idssrc=None, - legendgroup=None, - name=None, - opacity=None, - selectedpoints=None, - showlegend=None, - stream=None, - uid=None, - uirevision=None, - visible=None, - x=None, - xaxis=None, - xsrc=None, - y=None, - yaxis=None, - ysrc=None, - **kwargs - ): - """ - Construct a new Carpet object - - The data describing carpet axis layout is set in `y` and - (optionally) also `x`. If only `y` is present, `x` the plot is - interpreted as a cheater plot and is filled in using the `y` - values. `x` and `y` may either be 2D arrays matching with each - dimension matching that of `a` and `b`, or they may be 1D - arrays with total length equal to that of `a` and `b`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Carpet - a - An array containing values of the first parameter value - a0 - Alternate to `a`. Builds a linear space of a - coordinates. Use with `da` where `a0` is the starting - coordinate and `da` the step. - aaxis - plotly.graph_objs.carpet.Aaxis instance or dict with - compatible properties - asrc - Sets the source reference on plot.ly for a . - b - A two dimensional array of y coordinates at each carpet - point. - b0 - Alternate to `b`. Builds a linear space of a - coordinates. Use with `db` where `b0` is the starting - coordinate and `db` the step. - baxis - plotly.graph_objs.carpet.Baxis instance or dict with - compatible properties - bsrc - Sets the source reference on plot.ly for b . - carpet - An identifier for this carpet, so that `scattercarpet` - and `scattercontour` traces can specify a carpet plot - on which they lie - cheaterslope - The shift applied to each successive row of data in - creating a cheater plot. Only used if `x` is been - ommitted. - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - da - Sets the a coordinate step. See `a0` for more info. - db - Sets the b coordinate step. See `b0` for more info. - font - The default font used for axis & tick labels on this - carpet - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.carpet.Hoverlabel instance or dict - with compatible properties - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.carpet.Stream instance or dict with - compatible properties - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - A two dimensional array of x coordinates at each carpet - point. If ommitted, the plot is a cheater plot and the - xaxis is hidden by default. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xsrc - Sets the source reference on plot.ly for x . - y - A two dimensional array of y coordinates at each carpet - point. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ysrc - Sets the source reference on plot.ly for y . - - Returns - ------- - Carpet - """ - super(Carpet, self).__init__('carpet') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Carpet -constructor must be a dict or -an instance of plotly.graph_objs.Carpet""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (carpet as v_carpet) - - # Initialize validators - # --------------------- - self._validators['a'] = v_carpet.AValidator() - self._validators['a0'] = v_carpet.A0Validator() - self._validators['aaxis'] = v_carpet.AaxisValidator() - self._validators['asrc'] = v_carpet.AsrcValidator() - self._validators['b'] = v_carpet.BValidator() - self._validators['b0'] = v_carpet.B0Validator() - self._validators['baxis'] = v_carpet.BaxisValidator() - self._validators['bsrc'] = v_carpet.BsrcValidator() - self._validators['carpet'] = v_carpet.CarpetValidator() - self._validators['cheaterslope'] = v_carpet.CheaterslopeValidator() - self._validators['color'] = v_carpet.ColorValidator() - self._validators['customdata'] = v_carpet.CustomdataValidator() - self._validators['customdatasrc'] = v_carpet.CustomdatasrcValidator() - self._validators['da'] = v_carpet.DaValidator() - self._validators['db'] = v_carpet.DbValidator() - self._validators['font'] = v_carpet.FontValidator() - self._validators['hoverinfo'] = v_carpet.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_carpet.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_carpet.HoverlabelValidator() - self._validators['ids'] = v_carpet.IdsValidator() - self._validators['idssrc'] = v_carpet.IdssrcValidator() - self._validators['legendgroup'] = v_carpet.LegendgroupValidator() - self._validators['name'] = v_carpet.NameValidator() - self._validators['opacity'] = v_carpet.OpacityValidator() - self._validators['selectedpoints'] = v_carpet.SelectedpointsValidator() - self._validators['showlegend'] = v_carpet.ShowlegendValidator() - self._validators['stream'] = v_carpet.StreamValidator() - self._validators['uid'] = v_carpet.UidValidator() - self._validators['uirevision'] = v_carpet.UirevisionValidator() - self._validators['visible'] = v_carpet.VisibleValidator() - self._validators['x'] = v_carpet.XValidator() - self._validators['xaxis'] = v_carpet.XAxisValidator() - self._validators['xsrc'] = v_carpet.XsrcValidator() - self._validators['y'] = v_carpet.YValidator() - self._validators['yaxis'] = v_carpet.YAxisValidator() - self._validators['ysrc'] = v_carpet.YsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('a', None) - self['a'] = a if a is not None else _v - _v = arg.pop('a0', None) - self['a0'] = a0 if a0 is not None else _v - _v = arg.pop('aaxis', None) - self['aaxis'] = aaxis if aaxis is not None else _v - _v = arg.pop('asrc', None) - self['asrc'] = asrc if asrc is not None else _v - _v = arg.pop('b', None) - self['b'] = b if b is not None else _v - _v = arg.pop('b0', None) - self['b0'] = b0 if b0 is not None else _v - _v = arg.pop('baxis', None) - self['baxis'] = baxis if baxis is not None else _v - _v = arg.pop('bsrc', None) - self['bsrc'] = bsrc if bsrc is not None else _v - _v = arg.pop('carpet', None) - self['carpet'] = carpet if carpet is not None else _v - _v = arg.pop('cheaterslope', None) - self['cheaterslope'] = cheaterslope if cheaterslope is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('da', None) - self['da'] = da if da is not None else _v - _v = arg.pop('db', None) - self['db'] = db if db is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'carpet' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='carpet', val='carpet' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_choropleth.py b/plotly/graph_objs/_choropleth.py deleted file mode 100644 index ffe84fdd0c9..00000000000 --- a/plotly/graph_objs/_choropleth.py +++ /dev/null @@ -1,1792 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Choropleth(BaseTraceType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be chosen - according to whether numbers in the `color` array are all - positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of plotly.graph_objs.choropleth.ColorBar - - A dict of string/value properties that will be passed - to the ColorBar constructor - - Supported dict properties: - - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.choropleth.colorbar.Tickforma - tstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.choropleth.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of choropleth.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.choropleth.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - choropleth.colorbar.title.font instead. Sets - this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - choropleth.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.choropleth.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. The colorscale must be an array containing - arrays mapping a normalized value to an rgb, rgba, hex, hsl, - hsv, or named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # geo - # --- - @property - def geo(self): - """ - Sets a reference between this trace's geospatial coordinates - and a geographic map. If "geo" (the default value), the - geospatial coordinates refer to `layout.geo`. If "geo2", the - geospatial coordinates refer to `layout.geo2`, and so on. - - The 'geo' property is an identifier of a particular - subplot, of type 'geo', that may be specified as the string 'geo' - optionally followed by an integer >= 1 - (e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.) - - Returns - ------- - str - """ - return self['geo'] - - @geo.setter - def geo(self, val): - self['geo'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'location+z') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.choropleth.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.choropleth.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # locationmode - # ------------ - @property - def locationmode(self): - """ - Determines the set of locations used to match entries in - `locations` to regions on the map. - - The 'locationmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['ISO-3', 'USA-states', 'country names'] - - Returns - ------- - Any - """ - return self['locationmode'] - - @locationmode.setter - def locationmode(self, val): - self['locationmode'] = val - - # locations - # --------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['locations'] - - @locations.setter - def locations(self, val): - self['locations'] = val - - # locationssrc - # ------------ - @property - def locationssrc(self): - """ - Sets the source reference on plot.ly for locations . - - The 'locationssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['locationssrc'] - - @locationssrc.setter - def locationssrc(self, val): - self['locationssrc'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of plotly.graph_objs.choropleth.Marker - - A dict of string/value properties that will be passed - to the Marker constructor - - Supported dict properties: - - line - plotly.graph_objs.choropleth.marker.Line - instance or dict with compatible properties - opacity - Sets the opacity of the locations. - opacitysrc - Sets the source reference on plot.ly for - opacity . - - Returns - ------- - plotly.graph_objs.choropleth.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # reversescale - # ------------ - @property - 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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # selected - # -------- - @property - def selected(self): - """ - The 'selected' property is an instance of Selected - that may be specified as: - - An instance of plotly.graph_objs.choropleth.Selected - - A dict of string/value properties that will be passed - to the Selected constructor - - Supported dict properties: - - marker - plotly.graph_objs.choropleth.selected.Marker - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.choropleth.Selected - """ - return self['selected'] - - @selected.setter - def selected(self, val): - self['selected'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.choropleth.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.choropleth.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # unselected - # ---------- - @property - def unselected(self): - """ - The 'unselected' property is an instance of Unselected - that may be specified as: - - An instance of plotly.graph_objs.choropleth.Unselected - - A dict of string/value properties that will be passed - to the Unselected constructor - - Supported dict properties: - - marker - plotly.graph_objs.choropleth.unselected.Marker - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.choropleth.Unselected - """ - return self['unselected'] - - @unselected.setter - def unselected(self, val): - self['unselected'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # z - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # zauto - # ----- - @property - def zauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `z`) or the bounds set in - `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` - are set by the user. - - The 'zauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['zauto'] - - @zauto.setter - def zauto(self, val): - self['zauto'] = val - - # zmax - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmax'] - - @zmax.setter - def zmax(self, val): - self['zmax'] = val - - # zmid - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmid'] - - @zmid.setter - def zmid(self, val): - self['zmid'] = val - - # zmin - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmin'] - - @zmin.setter - def zmin(self, val): - self['zmin'] = val - - # zsrc - # ---- - @property - def zsrc(self): - """ - Sets the source reference on plot.ly for z . - - The 'zsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['zsrc'] - - @zsrc.setter - def zsrc(self, val): - self['zsrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - colorbar - plotly.graph_objs.choropleth.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - geo - Sets a reference between this trace's geospatial - coordinates and a geographic map. If "geo" (the default - value), the geospatial coordinates refer to - `layout.geo`. If "geo2", the geospatial coordinates - refer to `layout.geo2`, and so on. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.choropleth.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - locationmode - Determines the set of locations used to match entries - in `locations` to regions on the map. - locations - Sets the coordinates via location IDs or names. See - `locationmode` for more info. - locationssrc - Sets the source reference on plot.ly for locations . - marker - plotly.graph_objs.choropleth.Marker instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, `zmin` - will correspond to the last color in the array and - `zmax` will correspond to the first color. - selected - plotly.graph_objs.choropleth.Selected instance or dict - with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.choropleth.Stream instance or dict - with compatible properties - text - Sets the text elements associated with each location. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.choropleth.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - z - Sets the color values. - zauto - Determines whether or not the color domain is computed - with respect to the input data (here in `z`) or the - bounds set in `zmin` and `zmax` Defaults to `false` - when `zmin` and `zmax` are set by the user. - zmax - Sets the upper bound of the color domain. Value should - have the same units as in `z` and if set, `zmin` must - be set as well. - zmid - Sets the mid-point of the color domain by scaling - `zmin` and/or `zmax` to be equidistant to this point. - Value should have the same units as in `z`. Has no - effect when `zauto` is `false`. - zmin - Sets the lower bound of the color domain. Value should - have the same units as in `z` and if set, `zmax` must - be set as well. - zsrc - Sets the source reference on plot.ly for z . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - colorbar=None, - colorscale=None, - customdata=None, - customdatasrc=None, - geo=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - legendgroup=None, - locationmode=None, - locations=None, - locationssrc=None, - marker=None, - name=None, - opacity=None, - reversescale=None, - selected=None, - selectedpoints=None, - showlegend=None, - showscale=None, - stream=None, - text=None, - textsrc=None, - uid=None, - uirevision=None, - unselected=None, - visible=None, - z=None, - zauto=None, - zmax=None, - zmid=None, - zmin=None, - zsrc=None, - **kwargs - ): - """ - Construct a new Choropleth object - - The data that describes the choropleth value-to-color mapping - is set in `z`. The geographic locations corresponding to each - value in `z` are set in `locations`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Choropleth - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - colorbar - plotly.graph_objs.choropleth.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - geo - Sets a reference between this trace's geospatial - coordinates and a geographic map. If "geo" (the default - value), the geospatial coordinates refer to - `layout.geo`. If "geo2", the geospatial coordinates - refer to `layout.geo2`, and so on. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.choropleth.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - locationmode - Determines the set of locations used to match entries - in `locations` to regions on the map. - locations - Sets the coordinates via location IDs or names. See - `locationmode` for more info. - locationssrc - Sets the source reference on plot.ly for locations . - marker - plotly.graph_objs.choropleth.Marker instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, `zmin` - will correspond to the last color in the array and - `zmax` will correspond to the first color. - selected - plotly.graph_objs.choropleth.Selected instance or dict - with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.choropleth.Stream instance or dict - with compatible properties - text - Sets the text elements associated with each location. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.choropleth.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - z - Sets the color values. - zauto - Determines whether or not the color domain is computed - with respect to the input data (here in `z`) or the - bounds set in `zmin` and `zmax` Defaults to `false` - when `zmin` and `zmax` are set by the user. - zmax - Sets the upper bound of the color domain. Value should - have the same units as in `z` and if set, `zmin` must - be set as well. - zmid - Sets the mid-point of the color domain by scaling - `zmin` and/or `zmax` to be equidistant to this point. - Value should have the same units as in `z`. Has no - effect when `zauto` is `false`. - zmin - Sets the lower bound of the color domain. Value should - have the same units as in `z` and if set, `zmax` must - be set as well. - zsrc - Sets the source reference on plot.ly for z . - - Returns - ------- - Choropleth - """ - super(Choropleth, self).__init__('choropleth') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Choropleth -constructor must be a dict or -an instance of plotly.graph_objs.Choropleth""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (choropleth as v_choropleth) - - # Initialize validators - # --------------------- - self._validators['autocolorscale' - ] = v_choropleth.AutocolorscaleValidator() - self._validators['colorbar'] = v_choropleth.ColorBarValidator() - self._validators['colorscale'] = v_choropleth.ColorscaleValidator() - self._validators['customdata'] = v_choropleth.CustomdataValidator() - self._validators['customdatasrc' - ] = v_choropleth.CustomdatasrcValidator() - self._validators['geo'] = v_choropleth.GeoValidator() - self._validators['hoverinfo'] = v_choropleth.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_choropleth.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_choropleth.HoverlabelValidator() - self._validators['hovertemplate' - ] = v_choropleth.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_choropleth.HovertemplatesrcValidator() - self._validators['hovertext'] = v_choropleth.HovertextValidator() - self._validators['hovertextsrc'] = v_choropleth.HovertextsrcValidator() - self._validators['ids'] = v_choropleth.IdsValidator() - self._validators['idssrc'] = v_choropleth.IdssrcValidator() - self._validators['legendgroup'] = v_choropleth.LegendgroupValidator() - self._validators['locationmode'] = v_choropleth.LocationmodeValidator() - self._validators['locations'] = v_choropleth.LocationsValidator() - self._validators['locationssrc'] = v_choropleth.LocationssrcValidator() - self._validators['marker'] = v_choropleth.MarkerValidator() - self._validators['name'] = v_choropleth.NameValidator() - self._validators['opacity'] = v_choropleth.OpacityValidator() - self._validators['reversescale'] = v_choropleth.ReversescaleValidator() - self._validators['selected'] = v_choropleth.SelectedValidator() - self._validators['selectedpoints' - ] = v_choropleth.SelectedpointsValidator() - self._validators['showlegend'] = v_choropleth.ShowlegendValidator() - self._validators['showscale'] = v_choropleth.ShowscaleValidator() - self._validators['stream'] = v_choropleth.StreamValidator() - self._validators['text'] = v_choropleth.TextValidator() - self._validators['textsrc'] = v_choropleth.TextsrcValidator() - self._validators['uid'] = v_choropleth.UidValidator() - self._validators['uirevision'] = v_choropleth.UirevisionValidator() - self._validators['unselected'] = v_choropleth.UnselectedValidator() - self._validators['visible'] = v_choropleth.VisibleValidator() - self._validators['z'] = v_choropleth.ZValidator() - self._validators['zauto'] = v_choropleth.ZautoValidator() - self._validators['zmax'] = v_choropleth.ZmaxValidator() - self._validators['zmid'] = v_choropleth.ZmidValidator() - self._validators['zmin'] = v_choropleth.ZminValidator() - self._validators['zsrc'] = v_choropleth.ZsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('geo', None) - self['geo'] = geo if geo is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('locationmode', None) - self['locationmode'] = locationmode if locationmode is not None else _v - _v = arg.pop('locations', None) - self['locations'] = locations if locations is not None else _v - _v = arg.pop('locationssrc', None) - self['locationssrc'] = locationssrc if locationssrc is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('selected', None) - self['selected'] = selected if selected is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('unselected', None) - self['unselected'] = unselected if unselected is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - _v = arg.pop('zauto', None) - self['zauto'] = zauto if zauto is not None else _v - _v = arg.pop('zmax', None) - self['zmax'] = zmax if zmax is not None else _v - _v = arg.pop('zmid', None) - self['zmid'] = zmid if zmid is not None else _v - _v = arg.pop('zmin', None) - self['zmin'] = zmin if zmin is not None else _v - _v = arg.pop('zsrc', None) - self['zsrc'] = zsrc if zsrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'choropleth' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='choropleth', val='choropleth' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_cone.py b/plotly/graph_objs/_cone.py deleted file mode 100644 index 5b1973d3794..00000000000 --- a/plotly/graph_objs/_cone.py +++ /dev/null @@ -1,2129 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Cone(BaseTraceType): - - # anchor - # ------ - @property - 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'] - - Returns - ------- - Any - """ - return self['anchor'] - - @anchor.setter - def anchor(self, val): - self['anchor'] = val - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be chosen - according to whether numbers in the `color` array are all - positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here u/v/w norm) or the bounds set - in `cmin` and `cmax` Defaults to `false` when `cmin` and - `cmax` are set by the user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - 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 u/v/w norm. Has no effect when `cauto` is - `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of plotly.graph_objs.cone.ColorBar - - A dict of string/value properties that will be passed - to the ColorBar constructor - - Supported dict properties: - - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.cone.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.cone.colorbar.tickformatstopdefaults), sets - the default property values to use for elements - of cone.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.cone.colorbar.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use cone.colorbar.title.font - instead. Sets this color bar's title font. Note - that the title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use cone.colorbar.title.side - instead. Determines the location of color bar's - title with respect to the color bar. Note that - the title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.cone.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. The colorscale must be an array containing - arrays mapping a normalized value to an rgb, rgba, hex, hsl, - hsv, or named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.cone.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.cone.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - variable `norm` Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # lighting - # -------- - @property - def lighting(self): - """ - The 'lighting' property is an instance of Lighting - that may be specified as: - - An instance of plotly.graph_objs.cone.Lighting - - A dict of string/value properties that will be passed - to the Lighting constructor - - Supported dict properties: - - ambient - Ambient light increases overall color - visibility but can wash out the image. - diffuse - Represents the extent that incident rays are - reflected in a range of angles. - facenormalsepsilon - Epsilon for face normals calculation avoids - math issues arising from degenerate geometry. - fresnel - Represents the reflectance as a dependency of - the viewing angle; e.g. paper is reflective - when viewing it from the edge of the paper - (almost 90 degrees), causing shine. - roughness - Alters specular reflection; the rougher the - surface, the wider and less contrasty the - shine. - specular - Represents the level that incident rays are - reflected in a single direction, causing shine. - vertexnormalsepsilon - Epsilon for vertex normals calculation avoids - math issues arising from degenerate geometry. - - Returns - ------- - plotly.graph_objs.cone.Lighting - """ - return self['lighting'] - - @lighting.setter - def lighting(self, val): - self['lighting'] = val - - # lightposition - # ------------- - @property - def lightposition(self): - """ - The 'lightposition' property is an instance of Lightposition - that may be specified as: - - An instance of plotly.graph_objs.cone.Lightposition - - A dict of string/value properties that will be passed - to the Lightposition constructor - - Supported dict properties: - - x - Numeric vector, representing the X coordinate - for each vertex. - y - Numeric vector, representing the Y coordinate - for each vertex. - z - Numeric vector, representing the Z coordinate - for each vertex. - - Returns - ------- - plotly.graph_objs.cone.Lightposition - """ - return self['lightposition'] - - @lightposition.setter - def lightposition(self, val): - self['lightposition'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - def opacity(self): - """ - Sets the opacity of the surface. Please note that in the case - of using high `opacity` values for example a value greater than - or equal to 0.5 on two surfaces (and 0.25 with four surfaces), - an overlay of multiple transparent surfaces may not perfectly - be sorted in depth by the webgl API. This behavior may be - improved in the near future and is subject to change. - - The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # reversescale - # ------------ - @property - 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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # scene - # ----- - @property - def scene(self): - """ - Sets a reference between this trace's 3D coordinate system and - a 3D scene. If "scene" (the default value), the (x,y,z) - coordinates refer to `layout.scene`. If "scene2", the (x,y,z) - coordinates refer to `layout.scene2`, and so on. - - The 'scene' property is an identifier of a particular - subplot, of type 'scene', that may be specified as the string 'scene' - optionally followed by an integer >= 1 - (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) - - Returns - ------- - str - """ - return self['scene'] - - @scene.setter - def scene(self, val): - self['scene'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # sizemode - # -------- - @property - def sizemode(self): - """ - Determines whether `sizeref` is set as a "scaled" (i.e - unitless) scalar (normalized by the max u/v/w norm in the - vector field) or as "absolute" value (in the same units as the - vector field). - - The 'sizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['scaled', 'absolute'] - - Returns - ------- - Any - """ - return self['sizemode'] - - @sizemode.setter - def sizemode(self, val): - self['sizemode'] = val - - # sizeref - # ------- - @property - def sizeref(self): - """ - Adjusts the cone size scaling. The size of the cones is - determined by their u/v/w norm multiplied a factor and - `sizeref`. This factor (computed internally) corresponds to the - minimum "time" to travel across two successive x/y/z positions - at the average velocity of those two successive positions. All - cones in a given trace use the same factor. With `sizemode` set - to "scaled", `sizeref` is unitless, its default value is 0.5 - With `sizemode` set to "absolute", `sizeref` has the same units - as the u/v/w vector field, its the default value is half the - sample's maximum vector norm. - - The 'sizeref' property is a number and may be specified as: - - An int or float in the interval [0, inf] - - Returns - ------- - int|float - """ - return self['sizeref'] - - @sizeref.setter - def sizeref(self, val): - self['sizeref'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.cone.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.cone.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # u - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['u'] - - @u.setter - def u(self, val): - self['u'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # usrc - # ---- - @property - def usrc(self): - """ - Sets the source reference on plot.ly for u . - - The 'usrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['usrc'] - - @usrc.setter - def usrc(self, val): - self['usrc'] = val - - # v - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['v'] - - @v.setter - def v(self, val): - self['v'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # vsrc - # ---- - @property - def vsrc(self): - """ - Sets the source reference on plot.ly for v . - - The 'vsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['vsrc'] - - @vsrc.setter - def vsrc(self, val): - self['vsrc'] = val - - # w - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['w'] - - @w.setter - def w(self, val): - self['w'] = val - - # wsrc - # ---- - @property - def wsrc(self): - """ - Sets the source reference on plot.ly for w . - - The 'wsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['wsrc'] - - @wsrc.setter - def wsrc(self, val): - self['wsrc'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # z - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # zsrc - # ---- - @property - def zsrc(self): - """ - Sets the source reference on plot.ly for z . - - The 'zsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['zsrc'] - - @zsrc.setter - def zsrc(self, val): - self['zsrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - anchor - Sets the cones' anchor with respect to their x/y/z - positions. Note that "cm" denote the cone's center of - mass which corresponds to 1/4 from the tail to tip. - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here u/v/w norm) or the - bounds set in `cmin` and `cmax` Defaults to `false` - when `cmin` and `cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Value should - have the same units as u/v/w norm and if set, `cmin` - must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `cmin` and/or `cmax` to be equidistant to this point. - Value should have the same units as u/v/w norm. Has no - effect when `cauto` is `false`. - cmin - Sets the lower bound of the color domain. Value should - have the same units as u/v/w norm and if set, `cmax` - must be set as well. - colorbar - plotly.graph_objs.cone.ColorBar instance or dict with - compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.cone.Hoverlabel instance or dict with - compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variable `norm` Anything contained in tag - `` is displayed in the secondary box, for - example "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - lighting - plotly.graph_objs.cone.Lighting instance or dict with - compatible properties - lightposition - plotly.graph_objs.cone.Lightposition instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the surface. Please note that in - the case of using high `opacity` values for example a - value greater than or equal to 0.5 on two surfaces (and - 0.25 with four surfaces), an overlay of multiple - transparent surfaces may not perfectly be sorted in - depth by the webgl API. This behavior may be improved - in the near future and is subject to change. - reversescale - Reverses the color mapping if true. If true, `cmin` - will correspond to the last color in the array and - `cmax` will correspond to the first color. - scene - Sets a reference between this trace's 3D coordinate - system and a 3D scene. If "scene" (the default value), - the (x,y,z) coordinates refer to `layout.scene`. If - "scene2", the (x,y,z) coordinates refer to - `layout.scene2`, and so on. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - sizemode - Determines whether `sizeref` is set as a "scaled" (i.e - unitless) scalar (normalized by the max u/v/w norm in - the vector field) or as "absolute" value (in the same - units as the vector field). - sizeref - Adjusts the cone size scaling. The size of the cones is - determined by their u/v/w norm multiplied a factor and - `sizeref`. This factor (computed internally) - corresponds to the minimum "time" to travel across two - successive x/y/z positions at the average velocity of - those two successive positions. All cones in a given - trace use the same factor. With `sizemode` set to - "scaled", `sizeref` is unitless, its default value is - 0.5 With `sizemode` set to "absolute", `sizeref` has - the same units as the u/v/w vector field, its the - default value is half the sample's maximum vector norm. - stream - plotly.graph_objs.cone.Stream instance or dict with - compatible properties - text - Sets the text elements associated with the cones. If - trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textsrc - Sets the source reference on plot.ly for text . - u - Sets the x components of the vector field. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - usrc - Sets the source reference on plot.ly for u . - v - Sets the y components of the vector field. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - vsrc - Sets the source reference on plot.ly for v . - w - Sets the z components of the vector field. - wsrc - Sets the source reference on plot.ly for w . - x - Sets the x coordinates of the vector field and of the - displayed cones. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates of the vector field and of the - displayed cones. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the z coordinates of the vector field and of the - displayed cones. - zsrc - Sets the source reference on plot.ly for z . - """ - - def __init__( - self, - arg=None, - anchor=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - colorbar=None, - colorscale=None, - customdata=None, - customdatasrc=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - legendgroup=None, - lighting=None, - lightposition=None, - name=None, - opacity=None, - reversescale=None, - scene=None, - selectedpoints=None, - showlegend=None, - showscale=None, - sizemode=None, - sizeref=None, - stream=None, - text=None, - textsrc=None, - u=None, - uid=None, - uirevision=None, - usrc=None, - v=None, - visible=None, - vsrc=None, - w=None, - wsrc=None, - x=None, - xsrc=None, - y=None, - ysrc=None, - z=None, - zsrc=None, - **kwargs - ): - """ - Construct a new Cone object - - Use cone traces to visualize vector fields. Specify a vector - field using 6 1D arrays, 3 position arrays `x`, `y` and `z` and - 3 vector component arrays `u`, `v`, `w`. The cones are drawn - exactly at the positions given by `x`, `y` and `z`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Cone - anchor - Sets the cones' anchor with respect to their x/y/z - positions. Note that "cm" denote the cone's center of - mass which corresponds to 1/4 from the tail to tip. - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here u/v/w norm) or the - bounds set in `cmin` and `cmax` Defaults to `false` - when `cmin` and `cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Value should - have the same units as u/v/w norm and if set, `cmin` - must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `cmin` and/or `cmax` to be equidistant to this point. - Value should have the same units as u/v/w norm. Has no - effect when `cauto` is `false`. - cmin - Sets the lower bound of the color domain. Value should - have the same units as u/v/w norm and if set, `cmax` - must be set as well. - colorbar - plotly.graph_objs.cone.ColorBar instance or dict with - compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.cone.Hoverlabel instance or dict with - compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variable `norm` Anything contained in tag - `` is displayed in the secondary box, for - example "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - lighting - plotly.graph_objs.cone.Lighting instance or dict with - compatible properties - lightposition - plotly.graph_objs.cone.Lightposition instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the surface. Please note that in - the case of using high `opacity` values for example a - value greater than or equal to 0.5 on two surfaces (and - 0.25 with four surfaces), an overlay of multiple - transparent surfaces may not perfectly be sorted in - depth by the webgl API. This behavior may be improved - in the near future and is subject to change. - reversescale - Reverses the color mapping if true. If true, `cmin` - will correspond to the last color in the array and - `cmax` will correspond to the first color. - scene - Sets a reference between this trace's 3D coordinate - system and a 3D scene. If "scene" (the default value), - the (x,y,z) coordinates refer to `layout.scene`. If - "scene2", the (x,y,z) coordinates refer to - `layout.scene2`, and so on. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - sizemode - Determines whether `sizeref` is set as a "scaled" (i.e - unitless) scalar (normalized by the max u/v/w norm in - the vector field) or as "absolute" value (in the same - units as the vector field). - sizeref - Adjusts the cone size scaling. The size of the cones is - determined by their u/v/w norm multiplied a factor and - `sizeref`. This factor (computed internally) - corresponds to the minimum "time" to travel across two - successive x/y/z positions at the average velocity of - those two successive positions. All cones in a given - trace use the same factor. With `sizemode` set to - "scaled", `sizeref` is unitless, its default value is - 0.5 With `sizemode` set to "absolute", `sizeref` has - the same units as the u/v/w vector field, its the - default value is half the sample's maximum vector norm. - stream - plotly.graph_objs.cone.Stream instance or dict with - compatible properties - text - Sets the text elements associated with the cones. If - trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textsrc - Sets the source reference on plot.ly for text . - u - Sets the x components of the vector field. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - usrc - Sets the source reference on plot.ly for u . - v - Sets the y components of the vector field. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - vsrc - Sets the source reference on plot.ly for v . - w - Sets the z components of the vector field. - wsrc - Sets the source reference on plot.ly for w . - x - Sets the x coordinates of the vector field and of the - displayed cones. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates of the vector field and of the - displayed cones. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the z coordinates of the vector field and of the - displayed cones. - zsrc - Sets the source reference on plot.ly for z . - - Returns - ------- - Cone - """ - super(Cone, self).__init__('cone') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Cone -constructor must be a dict or -an instance of plotly.graph_objs.Cone""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (cone as v_cone) - - # Initialize validators - # --------------------- - self._validators['anchor'] = v_cone.AnchorValidator() - self._validators['autocolorscale'] = v_cone.AutocolorscaleValidator() - self._validators['cauto'] = v_cone.CautoValidator() - self._validators['cmax'] = v_cone.CmaxValidator() - self._validators['cmid'] = v_cone.CmidValidator() - self._validators['cmin'] = v_cone.CminValidator() - self._validators['colorbar'] = v_cone.ColorBarValidator() - self._validators['colorscale'] = v_cone.ColorscaleValidator() - self._validators['customdata'] = v_cone.CustomdataValidator() - self._validators['customdatasrc'] = v_cone.CustomdatasrcValidator() - self._validators['hoverinfo'] = v_cone.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_cone.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_cone.HoverlabelValidator() - self._validators['hovertemplate'] = v_cone.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_cone.HovertemplatesrcValidator() - self._validators['hovertext'] = v_cone.HovertextValidator() - self._validators['hovertextsrc'] = v_cone.HovertextsrcValidator() - self._validators['ids'] = v_cone.IdsValidator() - self._validators['idssrc'] = v_cone.IdssrcValidator() - self._validators['legendgroup'] = v_cone.LegendgroupValidator() - self._validators['lighting'] = v_cone.LightingValidator() - self._validators['lightposition'] = v_cone.LightpositionValidator() - self._validators['name'] = v_cone.NameValidator() - self._validators['opacity'] = v_cone.OpacityValidator() - self._validators['reversescale'] = v_cone.ReversescaleValidator() - self._validators['scene'] = v_cone.SceneValidator() - self._validators['selectedpoints'] = v_cone.SelectedpointsValidator() - self._validators['showlegend'] = v_cone.ShowlegendValidator() - self._validators['showscale'] = v_cone.ShowscaleValidator() - self._validators['sizemode'] = v_cone.SizemodeValidator() - self._validators['sizeref'] = v_cone.SizerefValidator() - self._validators['stream'] = v_cone.StreamValidator() - self._validators['text'] = v_cone.TextValidator() - self._validators['textsrc'] = v_cone.TextsrcValidator() - self._validators['u'] = v_cone.UValidator() - self._validators['uid'] = v_cone.UidValidator() - self._validators['uirevision'] = v_cone.UirevisionValidator() - self._validators['usrc'] = v_cone.UsrcValidator() - self._validators['v'] = v_cone.VValidator() - self._validators['visible'] = v_cone.VisibleValidator() - self._validators['vsrc'] = v_cone.VsrcValidator() - self._validators['w'] = v_cone.WValidator() - self._validators['wsrc'] = v_cone.WsrcValidator() - self._validators['x'] = v_cone.XValidator() - self._validators['xsrc'] = v_cone.XsrcValidator() - self._validators['y'] = v_cone.YValidator() - self._validators['ysrc'] = v_cone.YsrcValidator() - self._validators['z'] = v_cone.ZValidator() - self._validators['zsrc'] = v_cone.ZsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('anchor', None) - self['anchor'] = anchor if anchor is not None else _v - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('lighting', None) - self['lighting'] = lighting if lighting is not None else _v - _v = arg.pop('lightposition', None) - self['lightposition' - ] = lightposition if lightposition is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('scene', None) - self['scene'] = scene if scene is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('sizemode', None) - self['sizemode'] = sizemode if sizemode is not None else _v - _v = arg.pop('sizeref', None) - self['sizeref'] = sizeref if sizeref is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('u', None) - self['u'] = u if u is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('usrc', None) - self['usrc'] = usrc if usrc is not None else _v - _v = arg.pop('v', None) - self['v'] = v if v is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('vsrc', None) - self['vsrc'] = vsrc if vsrc is not None else _v - _v = arg.pop('w', None) - self['w'] = w if w is not None else _v - _v = arg.pop('wsrc', None) - self['wsrc'] = wsrc if wsrc is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - _v = arg.pop('zsrc', None) - self['zsrc'] = zsrc if zsrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'cone' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='cone', val='cone' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_contour.py b/plotly/graph_objs/_contour.py deleted file mode 100644 index 0848bea2302..00000000000 --- a/plotly/graph_objs/_contour.py +++ /dev/null @@ -1,2391 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Contour(BaseTraceType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be chosen - according to whether numbers in the `color` array are all - positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # autocontour - # ----------- - @property - def autocontour(self): - """ - Determines whether or not the contour level attributes are - picked by an algorithm. If True, the number of contour levels - can be set in `ncontours`. If False, set the contour level - attributes in `contours`. - - The 'autocontour' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocontour'] - - @autocontour.setter - def autocontour(self, val): - self['autocontour'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of plotly.graph_objs.contour.ColorBar - - A dict of string/value properties that will be passed - to the ColorBar constructor - - Supported dict properties: - - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.contour.colorbar.Tickformatst - op instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.contour.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of contour.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.contour.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - contour.colorbar.title.font instead. Sets this - color bar's title font. Note that the title's - font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use - contour.colorbar.title.side instead. Determines - the location of color bar's title with respect - to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.contour.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. The colorscale must be an array containing - arrays mapping a normalized value to an rgb, rgba, hex, hsl, - hsv, or named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # connectgaps - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['connectgaps'] - - @connectgaps.setter - def connectgaps(self, val): - self['connectgaps'] = val - - # contours - # -------- - @property - def contours(self): - """ - The 'contours' property is an instance of Contours - that may be specified as: - - An instance of plotly.graph_objs.contour.Contours - - A dict of string/value properties that will be passed - to the Contours constructor - - Supported dict properties: - - coloring - Determines the coloring method showing the - contour values. If "fill", coloring is done - evenly between each contour level If "heatmap", - a heatmap gradient coloring is applied between - each contour level. If "lines", coloring is - done on the contour lines. If "none", no - coloring is applied on this trace. - end - Sets the end contour level value. Must be more - than `contours.start` - labelfont - Sets the font used for labeling the contour - levels. The default color comes from the lines, - if shown. The default family and size come from - `layout.font`. - labelformat - Sets the contour label formatting rule using d3 - formatting mini-language which is very similar - to Python, see: https://github.com/d3/d3-format - /blob/master/README.md#locale_format. - operation - Sets the constraint operation. "=" keeps - regions equal to `value` "<" and "<=" keep - regions less than `value` ">" and ">=" keep - regions greater than `value` "[]", "()", "[)", - and "(]" keep regions inside `value[0]` to - `value[1]` "][", ")(", "](", ")[" keep regions - outside `value[0]` to value[1]` Open vs. closed - intervals make no difference to constraint - display, but all versions are allowed for - consistency with filter transforms. - showlabels - Determines whether to label the contour lines - with their values. - showlines - Determines whether or not the contour lines are - drawn. Has an effect only if - `contours.coloring` is set to "fill". - size - Sets the step between each contour level. Must - be positive. - start - Sets the starting contour level value. Must be - less than `contours.end` - type - If `levels`, the data is represented as a - contour plot with multiple levels displayed. If - `constraint`, the data is represented as - constraints with the invalid region shaded as - specified by the `operation` and `value` - parameters. - value - Sets the value or values of the constraint - boundary. When `operation` is set to one of the - comparison values (=,<,>=,>,<=) "value" is - expected to be a number. When `operation` is - set to one of the interval values - ([],(),[),(],][,)(,](,)[) "value" is expected - to be an array of two numbers where the first - is the lower bound and the second is the upper - bound. - - Returns - ------- - plotly.graph_objs.contour.Contours - """ - return self['contours'] - - @contours.setter - def contours(self, val): - self['contours'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # dx - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['dx'] - - @dx.setter - def dx(self, val): - self['dx'] = val - - # dy - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['dy'] - - @dy.setter - def dy(self, val): - self['dy'] = val - - # fillcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to contour.colorscale - - Returns - ------- - str - """ - return self['fillcolor'] - - @fillcolor.setter - def fillcolor(self, val): - self['fillcolor'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.contour.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.contour.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of plotly.graph_objs.contour.Line - - A dict of string/value properties that will be passed - to the Line constructor - - Supported dict properties: - - color - Sets the color of the contour level. Has no - effect if `contours.coloring` is set to - "lines". - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - smoothing - Sets the amount of smoothing for the contour - lines, where 0 corresponds to no smoothing. - width - Sets the line width (in px). - - Returns - ------- - plotly.graph_objs.contour.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # ncontours - # --------- - @property - def ncontours(self): - """ - Sets the maximum number of contour levels. The actual number of - contours will be chosen automatically to be less than or equal - to the value of `ncontours`. Has an effect only if - `autocontour` is True or if `contours.size` is missing. - - The 'ncontours' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [1, 9223372036854775807] - - Returns - ------- - int - """ - return self['ncontours'] - - @ncontours.setter - def ncontours(self, val): - self['ncontours'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # reversescale - # ------------ - @property - 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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.contour.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.contour.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # transpose - # --------- - @property - def transpose(self): - """ - Transposes the z data. - - The 'transpose' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['transpose'] - - @transpose.setter - def transpose(self, val): - self['transpose'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # x0 - # -- - @property - 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 - ------- - Any - """ - return self['x0'] - - @x0.setter - def x0(self, val): - self['x0'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # xcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['xcalendar'] - - @xcalendar.setter - def xcalendar(self, val): - self['xcalendar'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # xtype - # ----- - @property - def xtype(self): - """ - If "array", the heatmap's x coordinates are given by "x" (the - default behavior when `x` is provided). If "scaled", the - heatmap's x coordinates are given by "x0" and "dx" (the default - behavior when `x` is not provided). - - The 'xtype' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['array', 'scaled'] - - Returns - ------- - Any - """ - return self['xtype'] - - @xtype.setter - def xtype(self, val): - self['xtype'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # y0 - # -- - @property - 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 - ------- - Any - """ - return self['y0'] - - @y0.setter - def y0(self, val): - self['y0'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # ycalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['ycalendar'] - - @ycalendar.setter - def ycalendar(self, val): - self['ycalendar'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # ytype - # ----- - @property - def ytype(self): - """ - If "array", the heatmap's y coordinates are given by "y" (the - default behavior when `y` is provided) If "scaled", the - heatmap's y coordinates are given by "y0" and "dy" (the default - behavior when `y` is not provided) - - The 'ytype' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['array', 'scaled'] - - Returns - ------- - Any - """ - return self['ytype'] - - @ytype.setter - def ytype(self, val): - self['ytype'] = val - - # z - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # zauto - # ----- - @property - def zauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `z`) or the bounds set in - `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` - are set by the user. - - The 'zauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['zauto'] - - @zauto.setter - def zauto(self, val): - self['zauto'] = val - - # zhoverformat - # ------------ - @property - def zhoverformat(self): - """ - Sets the hover text formatting rule using d3 formatting mini- - languages which are very similar to those in Python. See: https - ://github.com/d3/d3-format/blob/master/README.md#locale_format - - The 'zhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['zhoverformat'] - - @zhoverformat.setter - def zhoverformat(self, val): - self['zhoverformat'] = val - - # zmax - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmax'] - - @zmax.setter - def zmax(self, val): - self['zmax'] = val - - # zmid - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmid'] - - @zmid.setter - def zmid(self, val): - self['zmid'] = val - - # zmin - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmin'] - - @zmin.setter - def zmin(self, val): - self['zmin'] = val - - # zsrc - # ---- - @property - def zsrc(self): - """ - Sets the source reference on plot.ly for z . - - The 'zsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['zsrc'] - - @zsrc.setter - def zsrc(self, val): - self['zsrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - autocontour - Determines whether or not the contour level attributes - are picked by an algorithm. If True, the number of - contour levels can be set in `ncontours`. If False, set - the contour level attributes in `contours`. - colorbar - plotly.graph_objs.contour.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the `z` data are filled in. - contours - plotly.graph_objs.contour.Contours instance or dict - with compatible properties - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dx - Sets the x coordinate step. See `x0` for more info. - dy - Sets the y coordinate step. See `y0` for more info. - fillcolor - Sets the fill color if `contours.type` is "constraint". - Defaults to a half-transparent variant of the line - color, marker color, or marker line color, whichever is - available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.contour.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.contour.Line instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - ncontours - Sets the maximum number of contour levels. The actual - number of contours will be chosen automatically to be - less than or equal to the value of `ncontours`. Has an - effect only if `autocontour` is True or if - `contours.size` is missing. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, `zmin` - will correspond to the last color in the array and - `zmax` will correspond to the first color. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.contour.Stream instance or dict with - compatible properties - text - Sets the text elements associated with each z value. - textsrc - Sets the source reference on plot.ly for text . - transpose - Transposes the z data. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the starting - coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - xtype - If "array", the heatmap's x coordinates are given by - "x" (the default behavior when `x` is provided). If - "scaled", the heatmap's x coordinates are given by "x0" - and "dx" (the default behavior when `x` is not - provided). - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the starting - coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - ytype - If "array", the heatmap's y coordinates are given by - "y" (the default behavior when `y` is provided) If - "scaled", the heatmap's y coordinates are given by "y0" - and "dy" (the default behavior when `y` is not - provided) - z - Sets the z data. - zauto - Determines whether or not the color domain is computed - with respect to the input data (here in `z`) or the - bounds set in `zmin` and `zmax` Defaults to `false` - when `zmin` and `zmax` are set by the user. - zhoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. See: https://github.com/d3/d3-format/blob/maste - r/README.md#locale_format - zmax - Sets the upper bound of the color domain. Value should - have the same units as in `z` and if set, `zmin` must - be set as well. - zmid - Sets the mid-point of the color domain by scaling - `zmin` and/or `zmax` to be equidistant to this point. - Value should have the same units as in `z`. Has no - effect when `zauto` is `false`. - zmin - Sets the lower bound of the color domain. Value should - have the same units as in `z` and if set, `zmax` must - be set as well. - zsrc - Sets the source reference on plot.ly for z . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - autocontour=None, - colorbar=None, - colorscale=None, - connectgaps=None, - contours=None, - customdata=None, - customdatasrc=None, - dx=None, - dy=None, - fillcolor=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - legendgroup=None, - line=None, - name=None, - ncontours=None, - opacity=None, - reversescale=None, - selectedpoints=None, - showlegend=None, - showscale=None, - stream=None, - text=None, - textsrc=None, - transpose=None, - uid=None, - uirevision=None, - visible=None, - x=None, - x0=None, - xaxis=None, - xcalendar=None, - xsrc=None, - xtype=None, - y=None, - y0=None, - yaxis=None, - ycalendar=None, - ysrc=None, - ytype=None, - z=None, - zauto=None, - zhoverformat=None, - zmax=None, - zmid=None, - zmin=None, - zsrc=None, - **kwargs - ): - """ - Construct a new Contour object - - The data from which contour lines are computed is set in `z`. - Data in `z` must be a 2D list of numbers. Say that `z` has N - rows and M columns, then by default, these N rows correspond to - N y coordinates (set in `y` or auto-generated) and the M - columns correspond to M x coordinates (set in `x` or auto- - generated). By setting `transpose` to True, the above behavior - is flipped. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Contour - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - autocontour - Determines whether or not the contour level attributes - are picked by an algorithm. If True, the number of - contour levels can be set in `ncontours`. If False, set - the contour level attributes in `contours`. - colorbar - plotly.graph_objs.contour.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the `z` data are filled in. - contours - plotly.graph_objs.contour.Contours instance or dict - with compatible properties - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dx - Sets the x coordinate step. See `x0` for more info. - dy - Sets the y coordinate step. See `y0` for more info. - fillcolor - Sets the fill color if `contours.type` is "constraint". - Defaults to a half-transparent variant of the line - color, marker color, or marker line color, whichever is - available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.contour.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.contour.Line instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - ncontours - Sets the maximum number of contour levels. The actual - number of contours will be chosen automatically to be - less than or equal to the value of `ncontours`. Has an - effect only if `autocontour` is True or if - `contours.size` is missing. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, `zmin` - will correspond to the last color in the array and - `zmax` will correspond to the first color. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.contour.Stream instance or dict with - compatible properties - text - Sets the text elements associated with each z value. - textsrc - Sets the source reference on plot.ly for text . - transpose - Transposes the z data. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the starting - coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - xtype - If "array", the heatmap's x coordinates are given by - "x" (the default behavior when `x` is provided). If - "scaled", the heatmap's x coordinates are given by "x0" - and "dx" (the default behavior when `x` is not - provided). - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the starting - coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - ytype - If "array", the heatmap's y coordinates are given by - "y" (the default behavior when `y` is provided) If - "scaled", the heatmap's y coordinates are given by "y0" - and "dy" (the default behavior when `y` is not - provided) - z - Sets the z data. - zauto - Determines whether or not the color domain is computed - with respect to the input data (here in `z`) or the - bounds set in `zmin` and `zmax` Defaults to `false` - when `zmin` and `zmax` are set by the user. - zhoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. See: https://github.com/d3/d3-format/blob/maste - r/README.md#locale_format - zmax - Sets the upper bound of the color domain. Value should - have the same units as in `z` and if set, `zmin` must - be set as well. - zmid - Sets the mid-point of the color domain by scaling - `zmin` and/or `zmax` to be equidistant to this point. - Value should have the same units as in `z`. Has no - effect when `zauto` is `false`. - zmin - Sets the lower bound of the color domain. Value should - have the same units as in `z` and if set, `zmax` must - be set as well. - zsrc - Sets the source reference on plot.ly for z . - - Returns - ------- - Contour - """ - super(Contour, self).__init__('contour') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Contour -constructor must be a dict or -an instance of plotly.graph_objs.Contour""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (contour as v_contour) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_contour.AutocolorscaleValidator( - ) - self._validators['autocontour'] = v_contour.AutocontourValidator() - self._validators['colorbar'] = v_contour.ColorBarValidator() - self._validators['colorscale'] = v_contour.ColorscaleValidator() - self._validators['connectgaps'] = v_contour.ConnectgapsValidator() - self._validators['contours'] = v_contour.ContoursValidator() - self._validators['customdata'] = v_contour.CustomdataValidator() - self._validators['customdatasrc'] = v_contour.CustomdatasrcValidator() - self._validators['dx'] = v_contour.DxValidator() - self._validators['dy'] = v_contour.DyValidator() - self._validators['fillcolor'] = v_contour.FillcolorValidator() - self._validators['hoverinfo'] = v_contour.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_contour.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_contour.HoverlabelValidator() - self._validators['hovertemplate'] = v_contour.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_contour.HovertemplatesrcValidator() - self._validators['hovertext'] = v_contour.HovertextValidator() - self._validators['hovertextsrc'] = v_contour.HovertextsrcValidator() - self._validators['ids'] = v_contour.IdsValidator() - self._validators['idssrc'] = v_contour.IdssrcValidator() - self._validators['legendgroup'] = v_contour.LegendgroupValidator() - self._validators['line'] = v_contour.LineValidator() - self._validators['name'] = v_contour.NameValidator() - self._validators['ncontours'] = v_contour.NcontoursValidator() - self._validators['opacity'] = v_contour.OpacityValidator() - self._validators['reversescale'] = v_contour.ReversescaleValidator() - self._validators['selectedpoints'] = v_contour.SelectedpointsValidator( - ) - self._validators['showlegend'] = v_contour.ShowlegendValidator() - self._validators['showscale'] = v_contour.ShowscaleValidator() - self._validators['stream'] = v_contour.StreamValidator() - self._validators['text'] = v_contour.TextValidator() - self._validators['textsrc'] = v_contour.TextsrcValidator() - self._validators['transpose'] = v_contour.TransposeValidator() - self._validators['uid'] = v_contour.UidValidator() - self._validators['uirevision'] = v_contour.UirevisionValidator() - self._validators['visible'] = v_contour.VisibleValidator() - self._validators['x'] = v_contour.XValidator() - self._validators['x0'] = v_contour.X0Validator() - self._validators['xaxis'] = v_contour.XAxisValidator() - self._validators['xcalendar'] = v_contour.XcalendarValidator() - self._validators['xsrc'] = v_contour.XsrcValidator() - self._validators['xtype'] = v_contour.XtypeValidator() - self._validators['y'] = v_contour.YValidator() - self._validators['y0'] = v_contour.Y0Validator() - self._validators['yaxis'] = v_contour.YAxisValidator() - self._validators['ycalendar'] = v_contour.YcalendarValidator() - self._validators['ysrc'] = v_contour.YsrcValidator() - self._validators['ytype'] = v_contour.YtypeValidator() - self._validators['z'] = v_contour.ZValidator() - self._validators['zauto'] = v_contour.ZautoValidator() - self._validators['zhoverformat'] = v_contour.ZhoverformatValidator() - self._validators['zmax'] = v_contour.ZmaxValidator() - self._validators['zmid'] = v_contour.ZmidValidator() - self._validators['zmin'] = v_contour.ZminValidator() - self._validators['zsrc'] = v_contour.ZsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('autocontour', None) - self['autocontour'] = autocontour if autocontour is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('connectgaps', None) - self['connectgaps'] = connectgaps if connectgaps is not None else _v - _v = arg.pop('contours', None) - self['contours'] = contours if contours is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('dx', None) - self['dx'] = dx if dx is not None else _v - _v = arg.pop('dy', None) - self['dy'] = dy if dy is not None else _v - _v = arg.pop('fillcolor', None) - self['fillcolor'] = fillcolor if fillcolor is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('ncontours', None) - self['ncontours'] = ncontours if ncontours is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('transpose', None) - self['transpose'] = transpose if transpose is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('x0', None) - self['x0'] = x0 if x0 is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('xcalendar', None) - self['xcalendar'] = xcalendar if xcalendar is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('xtype', None) - self['xtype'] = xtype if xtype is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('y0', None) - self['y0'] = y0 if y0 is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - _v = arg.pop('ycalendar', None) - self['ycalendar'] = ycalendar if ycalendar is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - _v = arg.pop('ytype', None) - self['ytype'] = ytype if ytype is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - _v = arg.pop('zauto', None) - self['zauto'] = zauto if zauto is not None else _v - _v = arg.pop('zhoverformat', None) - self['zhoverformat'] = zhoverformat if zhoverformat is not None else _v - _v = arg.pop('zmax', None) - self['zmax'] = zmax if zmax is not None else _v - _v = arg.pop('zmid', None) - self['zmid'] = zmid if zmid is not None else _v - _v = arg.pop('zmin', None) - self['zmin'] = zmin if zmin is not None else _v - _v = arg.pop('zsrc', None) - self['zsrc'] = zsrc if zsrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'contour' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='contour', val='contour' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_contourcarpet.py b/plotly/graph_objs/_contourcarpet.py deleted file mode 100644 index b38d577c203..00000000000 --- a/plotly/graph_objs/_contourcarpet.py +++ /dev/null @@ -1,2189 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Contourcarpet(BaseTraceType): - - # a - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['a'] - - @a.setter - def a(self, val): - self['a'] = val - - # a0 - # -- - @property - 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 - ------- - Any - """ - return self['a0'] - - @a0.setter - def a0(self, val): - self['a0'] = val - - # asrc - # ---- - @property - def asrc(self): - """ - Sets the source reference on plot.ly for a . - - The 'asrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['asrc'] - - @asrc.setter - def asrc(self, val): - self['asrc'] = val - - # atype - # ----- - @property - def atype(self): - """ - If "array", the heatmap's x coordinates are given by "x" (the - default behavior when `x` is provided). If "scaled", the - heatmap's x coordinates are given by "x0" and "dx" (the default - behavior when `x` is not provided). - - The 'atype' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['array', 'scaled'] - - Returns - ------- - Any - """ - return self['atype'] - - @atype.setter - def atype(self, val): - self['atype'] = val - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be chosen - according to whether numbers in the `color` array are all - positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # autocontour - # ----------- - @property - def autocontour(self): - """ - Determines whether or not the contour level attributes are - picked by an algorithm. If True, the number of contour levels - can be set in `ncontours`. If False, set the contour level - attributes in `contours`. - - The 'autocontour' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocontour'] - - @autocontour.setter - def autocontour(self, val): - self['autocontour'] = val - - # b - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['b'] - - @b.setter - def b(self, val): - self['b'] = val - - # b0 - # -- - @property - 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 - ------- - Any - """ - return self['b0'] - - @b0.setter - def b0(self, val): - self['b0'] = val - - # bsrc - # ---- - @property - def bsrc(self): - """ - Sets the source reference on plot.ly for b . - - The 'bsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bsrc'] - - @bsrc.setter - def bsrc(self, val): - self['bsrc'] = val - - # btype - # ----- - @property - def btype(self): - """ - If "array", the heatmap's y coordinates are given by "y" (the - default behavior when `y` is provided) If "scaled", the - heatmap's y coordinates are given by "y0" and "dy" (the default - behavior when `y` is not provided) - - The 'btype' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['array', 'scaled'] - - Returns - ------- - Any - """ - return self['btype'] - - @btype.setter - def btype(self, val): - self['btype'] = val - - # carpet - # ------ - @property - 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 - - Returns - ------- - str - """ - return self['carpet'] - - @carpet.setter - def carpet(self, val): - self['carpet'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of plotly.graph_objs.contourcarpet.ColorBar - - A dict of string/value properties that will be passed - to the ColorBar constructor - - Supported dict properties: - - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.contourcarpet.colorbar.Tickfo - rmatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.contourcarpet.colorbar.tickformatstopdefaults - ), sets the default property values to use for - elements of - contourcarpet.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.contourcarpet.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - contourcarpet.colorbar.title.font instead. Sets - this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - contourcarpet.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.contourcarpet.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. The colorscale must be an array containing - arrays mapping a normalized value to an rgb, rgba, hex, hsl, - hsv, or named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # contours - # -------- - @property - def contours(self): - """ - The 'contours' property is an instance of Contours - that may be specified as: - - An instance of plotly.graph_objs.contourcarpet.Contours - - A dict of string/value properties that will be passed - to the Contours constructor - - Supported dict properties: - - coloring - Determines the coloring method showing the - contour values. If "fill", coloring is done - evenly between each contour level If "lines", - coloring is done on the contour lines. If - "none", no coloring is applied on this trace. - end - Sets the end contour level value. Must be more - than `contours.start` - labelfont - Sets the font used for labeling the contour - levels. The default color comes from the lines, - if shown. The default family and size come from - `layout.font`. - labelformat - Sets the contour label formatting rule using d3 - formatting mini-language which is very similar - to Python, see: https://github.com/d3/d3-format - /blob/master/README.md#locale_format. - operation - Sets the constraint operation. "=" keeps - regions equal to `value` "<" and "<=" keep - regions less than `value` ">" and ">=" keep - regions greater than `value` "[]", "()", "[)", - and "(]" keep regions inside `value[0]` to - `value[1]` "][", ")(", "](", ")[" keep regions - outside `value[0]` to value[1]` Open vs. closed - intervals make no difference to constraint - display, but all versions are allowed for - consistency with filter transforms. - showlabels - Determines whether to label the contour lines - with their values. - showlines - Determines whether or not the contour lines are - drawn. Has an effect only if - `contours.coloring` is set to "fill". - size - Sets the step between each contour level. Must - be positive. - start - Sets the starting contour level value. Must be - less than `contours.end` - type - If `levels`, the data is represented as a - contour plot with multiple levels displayed. If - `constraint`, the data is represented as - constraints with the invalid region shaded as - specified by the `operation` and `value` - parameters. - value - Sets the value or values of the constraint - boundary. When `operation` is set to one of the - comparison values (=,<,>=,>,<=) "value" is - expected to be a number. When `operation` is - set to one of the interval values - ([],(),[),(],][,)(,](,)[) "value" is expected - to be an array of two numbers where the first - is the lower bound and the second is the upper - bound. - - Returns - ------- - plotly.graph_objs.contourcarpet.Contours - """ - return self['contours'] - - @contours.setter - def contours(self, val): - self['contours'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # da - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['da'] - - @da.setter - def da(self, val): - self['da'] = val - - # db - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['db'] - - @db.setter - def db(self, val): - self['db'] = val - - # fillcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to contourcarpet.colorscale - - Returns - ------- - str - """ - return self['fillcolor'] - - @fillcolor.setter - def fillcolor(self, val): - self['fillcolor'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.contourcarpet.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.contourcarpet.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertext - # --------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 if - `contours.coloring` is set to "lines". - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - smoothing - Sets the amount of smoothing for the contour - lines, where 0 corresponds to no smoothing. - width - Sets the line width (in px). - - Returns - ------- - plotly.graph_objs.contourcarpet.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # ncontours - # --------- - @property - def ncontours(self): - """ - Sets the maximum number of contour levels. The actual number of - contours will be chosen automatically to be less than or equal - to the value of `ncontours`. Has an effect only if - `autocontour` is True or if `contours.size` is missing. - - The 'ncontours' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [1, 9223372036854775807] - - Returns - ------- - int - """ - return self['ncontours'] - - @ncontours.setter - def ncontours(self, val): - self['ncontours'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # reversescale - # ------------ - @property - 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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.contourcarpet.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.contourcarpet.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # transpose - # --------- - @property - def transpose(self): - """ - Transposes the z data. - - The 'transpose' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['transpose'] - - @transpose.setter - def transpose(self, val): - self['transpose'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # z - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # zauto - # ----- - @property - def zauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `z`) or the bounds set in - `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` - are set by the user. - - The 'zauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['zauto'] - - @zauto.setter - def zauto(self, val): - self['zauto'] = val - - # zmax - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmax'] - - @zmax.setter - def zmax(self, val): - self['zmax'] = val - - # zmid - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmid'] - - @zmid.setter - def zmid(self, val): - self['zmid'] = val - - # zmin - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmin'] - - @zmin.setter - def zmin(self, val): - self['zmin'] = val - - # zsrc - # ---- - @property - def zsrc(self): - """ - Sets the source reference on plot.ly for z . - - The 'zsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['zsrc'] - - @zsrc.setter - def zsrc(self, val): - self['zsrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - a - Sets the x coordinates. - a0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the starting - coordinate and `dx` the step. - asrc - Sets the source reference on plot.ly for a . - atype - If "array", the heatmap's x coordinates are given by - "x" (the default behavior when `x` is provided). If - "scaled", the heatmap's x coordinates are given by "x0" - and "dx" (the default behavior when `x` is not - provided). - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - autocontour - Determines whether or not the contour level attributes - are picked by an algorithm. If True, the number of - contour levels can be set in `ncontours`. If False, set - the contour level attributes in `contours`. - b - Sets the y coordinates. - b0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the starting - coordinate and `dy` the step. - bsrc - Sets the source reference on plot.ly for b . - btype - If "array", the heatmap's y coordinates are given by - "y" (the default behavior when `y` is provided) If - "scaled", the heatmap's y coordinates are given by "y0" - and "dy" (the default behavior when `y` is not - provided) - carpet - The `carpet` of the carpet axes on which this contour - trace lies - colorbar - plotly.graph_objs.contourcarpet.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - contours - plotly.graph_objs.contourcarpet.Contours instance or - dict with compatible properties - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - da - Sets the x coordinate step. See `x0` for more info. - db - Sets the y coordinate step. See `y0` for more info. - fillcolor - Sets the fill color if `contours.type` is "constraint". - Defaults to a half-transparent variant of the line - color, marker color, or marker line color, whichever is - available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.contourcarpet.Hoverlabel instance or - dict with compatible properties - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.contourcarpet.Line instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - ncontours - Sets the maximum number of contour levels. The actual - number of contours will be chosen automatically to be - less than or equal to the value of `ncontours`. Has an - effect only if `autocontour` is True or if - `contours.size` is missing. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, `zmin` - will correspond to the last color in the array and - `zmax` will correspond to the first color. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.contourcarpet.Stream instance or dict - with compatible properties - text - Sets the text elements associated with each z value. - textsrc - Sets the source reference on plot.ly for text . - transpose - Transposes the z data. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - z - Sets the z data. - zauto - Determines whether or not the color domain is computed - with respect to the input data (here in `z`) or the - bounds set in `zmin` and `zmax` Defaults to `false` - when `zmin` and `zmax` are set by the user. - zmax - Sets the upper bound of the color domain. Value should - have the same units as in `z` and if set, `zmin` must - be set as well. - zmid - Sets the mid-point of the color domain by scaling - `zmin` and/or `zmax` to be equidistant to this point. - Value should have the same units as in `z`. Has no - effect when `zauto` is `false`. - zmin - Sets the lower bound of the color domain. Value should - have the same units as in `z` and if set, `zmax` must - be set as well. - zsrc - Sets the source reference on plot.ly for z . - """ - - def __init__( - self, - arg=None, - a=None, - a0=None, - asrc=None, - atype=None, - autocolorscale=None, - autocontour=None, - b=None, - b0=None, - bsrc=None, - btype=None, - carpet=None, - colorbar=None, - colorscale=None, - contours=None, - customdata=None, - customdatasrc=None, - da=None, - db=None, - fillcolor=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - legendgroup=None, - line=None, - name=None, - ncontours=None, - opacity=None, - reversescale=None, - selectedpoints=None, - showlegend=None, - showscale=None, - stream=None, - text=None, - textsrc=None, - transpose=None, - uid=None, - uirevision=None, - visible=None, - xaxis=None, - yaxis=None, - z=None, - zauto=None, - zmax=None, - zmid=None, - zmin=None, - zsrc=None, - **kwargs - ): - """ - Construct a new Contourcarpet object - - Plots contours on either the first carpet axis or the carpet - axis with a matching `carpet` attribute. Data `z` is - interpreted as matching that of the corresponding carpet axis. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Contourcarpet - a - Sets the x coordinates. - a0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the starting - coordinate and `dx` the step. - asrc - Sets the source reference on plot.ly for a . - atype - If "array", the heatmap's x coordinates are given by - "x" (the default behavior when `x` is provided). If - "scaled", the heatmap's x coordinates are given by "x0" - and "dx" (the default behavior when `x` is not - provided). - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - autocontour - Determines whether or not the contour level attributes - are picked by an algorithm. If True, the number of - contour levels can be set in `ncontours`. If False, set - the contour level attributes in `contours`. - b - Sets the y coordinates. - b0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the starting - coordinate and `dy` the step. - bsrc - Sets the source reference on plot.ly for b . - btype - If "array", the heatmap's y coordinates are given by - "y" (the default behavior when `y` is provided) If - "scaled", the heatmap's y coordinates are given by "y0" - and "dy" (the default behavior when `y` is not - provided) - carpet - The `carpet` of the carpet axes on which this contour - trace lies - colorbar - plotly.graph_objs.contourcarpet.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - contours - plotly.graph_objs.contourcarpet.Contours instance or - dict with compatible properties - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - da - Sets the x coordinate step. See `x0` for more info. - db - Sets the y coordinate step. See `y0` for more info. - fillcolor - Sets the fill color if `contours.type` is "constraint". - Defaults to a half-transparent variant of the line - color, marker color, or marker line color, whichever is - available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.contourcarpet.Hoverlabel instance or - dict with compatible properties - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.contourcarpet.Line instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - ncontours - Sets the maximum number of contour levels. The actual - number of contours will be chosen automatically to be - less than or equal to the value of `ncontours`. Has an - effect only if `autocontour` is True or if - `contours.size` is missing. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, `zmin` - will correspond to the last color in the array and - `zmax` will correspond to the first color. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.contourcarpet.Stream instance or dict - with compatible properties - text - Sets the text elements associated with each z value. - textsrc - Sets the source reference on plot.ly for text . - transpose - Transposes the z data. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - z - Sets the z data. - zauto - Determines whether or not the color domain is computed - with respect to the input data (here in `z`) or the - bounds set in `zmin` and `zmax` Defaults to `false` - when `zmin` and `zmax` are set by the user. - zmax - Sets the upper bound of the color domain. Value should - have the same units as in `z` and if set, `zmin` must - be set as well. - zmid - Sets the mid-point of the color domain by scaling - `zmin` and/or `zmax` to be equidistant to this point. - Value should have the same units as in `z`. Has no - effect when `zauto` is `false`. - zmin - Sets the lower bound of the color domain. Value should - have the same units as in `z` and if set, `zmax` must - be set as well. - zsrc - Sets the source reference on plot.ly for z . - - Returns - ------- - Contourcarpet - """ - super(Contourcarpet, self).__init__('contourcarpet') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Contourcarpet -constructor must be a dict or -an instance of plotly.graph_objs.Contourcarpet""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (contourcarpet as v_contourcarpet) - - # Initialize validators - # --------------------- - self._validators['a'] = v_contourcarpet.AValidator() - self._validators['a0'] = v_contourcarpet.A0Validator() - self._validators['asrc'] = v_contourcarpet.AsrcValidator() - self._validators['atype'] = v_contourcarpet.AtypeValidator() - self._validators['autocolorscale' - ] = v_contourcarpet.AutocolorscaleValidator() - self._validators['autocontour'] = v_contourcarpet.AutocontourValidator( - ) - self._validators['b'] = v_contourcarpet.BValidator() - self._validators['b0'] = v_contourcarpet.B0Validator() - self._validators['bsrc'] = v_contourcarpet.BsrcValidator() - self._validators['btype'] = v_contourcarpet.BtypeValidator() - self._validators['carpet'] = v_contourcarpet.CarpetValidator() - self._validators['colorbar'] = v_contourcarpet.ColorBarValidator() - self._validators['colorscale'] = v_contourcarpet.ColorscaleValidator() - self._validators['contours'] = v_contourcarpet.ContoursValidator() - self._validators['customdata'] = v_contourcarpet.CustomdataValidator() - self._validators['customdatasrc' - ] = v_contourcarpet.CustomdatasrcValidator() - self._validators['da'] = v_contourcarpet.DaValidator() - self._validators['db'] = v_contourcarpet.DbValidator() - self._validators['fillcolor'] = v_contourcarpet.FillcolorValidator() - self._validators['hoverinfo'] = v_contourcarpet.HoverinfoValidator() - self._validators['hoverinfosrc' - ] = v_contourcarpet.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_contourcarpet.HoverlabelValidator() - self._validators['hovertext'] = v_contourcarpet.HovertextValidator() - self._validators['hovertextsrc' - ] = v_contourcarpet.HovertextsrcValidator() - self._validators['ids'] = v_contourcarpet.IdsValidator() - self._validators['idssrc'] = v_contourcarpet.IdssrcValidator() - self._validators['legendgroup'] = v_contourcarpet.LegendgroupValidator( - ) - self._validators['line'] = v_contourcarpet.LineValidator() - self._validators['name'] = v_contourcarpet.NameValidator() - self._validators['ncontours'] = v_contourcarpet.NcontoursValidator() - self._validators['opacity'] = v_contourcarpet.OpacityValidator() - self._validators['reversescale' - ] = v_contourcarpet.ReversescaleValidator() - self._validators['selectedpoints' - ] = v_contourcarpet.SelectedpointsValidator() - self._validators['showlegend'] = v_contourcarpet.ShowlegendValidator() - self._validators['showscale'] = v_contourcarpet.ShowscaleValidator() - self._validators['stream'] = v_contourcarpet.StreamValidator() - self._validators['text'] = v_contourcarpet.TextValidator() - self._validators['textsrc'] = v_contourcarpet.TextsrcValidator() - self._validators['transpose'] = v_contourcarpet.TransposeValidator() - self._validators['uid'] = v_contourcarpet.UidValidator() - self._validators['uirevision'] = v_contourcarpet.UirevisionValidator() - self._validators['visible'] = v_contourcarpet.VisibleValidator() - self._validators['xaxis'] = v_contourcarpet.XAxisValidator() - self._validators['yaxis'] = v_contourcarpet.YAxisValidator() - self._validators['z'] = v_contourcarpet.ZValidator() - self._validators['zauto'] = v_contourcarpet.ZautoValidator() - self._validators['zmax'] = v_contourcarpet.ZmaxValidator() - self._validators['zmid'] = v_contourcarpet.ZmidValidator() - self._validators['zmin'] = v_contourcarpet.ZminValidator() - self._validators['zsrc'] = v_contourcarpet.ZsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('a', None) - self['a'] = a if a is not None else _v - _v = arg.pop('a0', None) - self['a0'] = a0 if a0 is not None else _v - _v = arg.pop('asrc', None) - self['asrc'] = asrc if asrc is not None else _v - _v = arg.pop('atype', None) - self['atype'] = atype if atype is not None else _v - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('autocontour', None) - self['autocontour'] = autocontour if autocontour is not None else _v - _v = arg.pop('b', None) - self['b'] = b if b is not None else _v - _v = arg.pop('b0', None) - self['b0'] = b0 if b0 is not None else _v - _v = arg.pop('bsrc', None) - self['bsrc'] = bsrc if bsrc is not None else _v - _v = arg.pop('btype', None) - self['btype'] = btype if btype is not None else _v - _v = arg.pop('carpet', None) - self['carpet'] = carpet if carpet is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('contours', None) - self['contours'] = contours if contours is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('da', None) - self['da'] = da if da is not None else _v - _v = arg.pop('db', None) - self['db'] = db if db is not None else _v - _v = arg.pop('fillcolor', None) - self['fillcolor'] = fillcolor if fillcolor is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('ncontours', None) - self['ncontours'] = ncontours if ncontours is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('transpose', None) - self['transpose'] = transpose if transpose is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - _v = arg.pop('zauto', None) - self['zauto'] = zauto if zauto is not None else _v - _v = arg.pop('zmax', None) - self['zmax'] = zmax if zmax is not None else _v - _v = arg.pop('zmid', None) - self['zmid'] = zmid if zmid is not None else _v - _v = arg.pop('zmin', None) - self['zmin'] = zmin if zmin is not None else _v - _v = arg.pop('zsrc', None) - self['zsrc'] = zsrc if zsrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'contourcarpet' - self._validators['type'] = LiteralValidator( - plotly_name='type', - parent_name='contourcarpet', - val='contourcarpet' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_frame.py b/plotly/graph_objs/_frame.py deleted file mode 100644 index a31652e7db6..00000000000 --- a/plotly/graph_objs/_frame.py +++ /dev/null @@ -1,263 +0,0 @@ -from plotly.basedatatypes import BaseFrameHierarchyType -import copy - - -class Frame(BaseFrameHierarchyType): - - # baseframe - # --------- - @property - def baseframe(self): - """ - The name of the frame into which this frame's properties are - merged before applying. This is used to unify properties and - avoid needing to specify the same values for the same - properties in multiple frames. - - The 'baseframe' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['baseframe'] - - @baseframe.setter - def baseframe(self, val): - self['baseframe'] = val - - # data - # ---- - @property - def data(self): - """ - A list of traces this frame modifies. The format is identical - to the normal trace definition. - - Returns - ------- - Any - """ - return self['data'] - - @data.setter - def data(self, val): - self['data'] = val - - # group - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['group'] - - @group.setter - def group(self, val): - self['group'] = val - - # layout - # ------ - @property - def layout(self): - """ - Layout properties which this frame modifies. The format is - identical to the normal layout definition. - - Returns - ------- - Any - """ - return self['layout'] - - @layout.setter - def layout(self, val): - self['layout'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # traces - # ------ - @property - 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 - ------- - Any - """ - return self['traces'] - - @traces.setter - def traces(self, val): - self['traces'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - baseframe - The name of the frame into which this frame's - properties are merged before applying. This is used to - unify properties and avoid needing to specify the same - values for the same properties in multiple frames. - data - A list of traces this frame modifies. The format is - identical to the normal trace definition. - group - An identifier that specifies the group to which the - frame belongs, used by animate to select a subset of - frames. - layout - Layout properties which this frame modifies. The format - is identical to the normal layout definition. - name - A label by which to identify the frame - traces - A list of trace indices that identify the respective - traces in the data attribute - """ - - def __init__( - self, - arg=None, - baseframe=None, - data=None, - group=None, - layout=None, - name=None, - traces=None, - **kwargs - ): - """ - Construct a new Frame object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Frame - baseframe - The name of the frame into which this frame's - properties are merged before applying. This is used to - unify properties and avoid needing to specify the same - values for the same properties in multiple frames. - data - A list of traces this frame modifies. The format is - identical to the normal trace definition. - group - An identifier that specifies the group to which the - frame belongs, used by animate to select a subset of - frames. - layout - Layout properties which this frame modifies. The format - is identical to the normal layout definition. - name - A label by which to identify the frame - traces - A list of trace indices that identify the respective - traces in the data attribute - - Returns - ------- - Frame - """ - super(Frame, self).__init__('frames') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Frame -constructor must be a dict or -an instance of plotly.graph_objs.Frame""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (frame as v_frame) - - # Initialize validators - # --------------------- - self._validators['baseframe'] = v_frame.BaseframeValidator() - self._validators['data'] = v_frame.DataValidator() - self._validators['group'] = v_frame.GroupValidator() - self._validators['layout'] = v_frame.LayoutValidator() - self._validators['name'] = v_frame.NameValidator() - self._validators['traces'] = v_frame.TracesValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('baseframe', None) - self['baseframe'] = baseframe if baseframe is not None else _v - _v = arg.pop('data', None) - self['data'] = data if data is not None else _v - _v = arg.pop('group', None) - self['group'] = group if group is not None else _v - _v = arg.pop('layout', None) - self['layout'] = layout if layout is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('traces', None) - self['traces'] = traces if traces is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_heatmap.py b/plotly/graph_objs/_heatmap.py deleted file mode 100644 index 585befd0ef5..00000000000 --- a/plotly/graph_objs/_heatmap.py +++ /dev/null @@ -1,2188 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Heatmap(BaseTraceType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be chosen - according to whether numbers in the `color` array are all - positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of plotly.graph_objs.heatmap.ColorBar - - A dict of string/value properties that will be passed - to the ColorBar constructor - - Supported dict properties: - - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.heatmap.colorbar.Tickformatst - op instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.heatmap.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of heatmap.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.heatmap.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - heatmap.colorbar.title.font instead. Sets this - color bar's title font. Note that the title's - font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use - heatmap.colorbar.title.side instead. Determines - the location of color bar's title with respect - to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.heatmap.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. The colorscale must be an array containing - arrays mapping a normalized value to an rgb, rgba, hex, hsl, - hsv, or named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # connectgaps - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['connectgaps'] - - @connectgaps.setter - def connectgaps(self, val): - self['connectgaps'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # dx - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['dx'] - - @dx.setter - def dx(self, val): - self['dx'] = val - - # dy - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['dy'] - - @dy.setter - def dy(self, val): - self['dy'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.heatmap.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.heatmap.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # reversescale - # ------------ - @property - 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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.heatmap.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.heatmap.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # transpose - # --------- - @property - def transpose(self): - """ - Transposes the z data. - - The 'transpose' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['transpose'] - - @transpose.setter - def transpose(self, val): - self['transpose'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # x0 - # -- - @property - 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 - ------- - Any - """ - return self['x0'] - - @x0.setter - def x0(self, val): - self['x0'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # xcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['xcalendar'] - - @xcalendar.setter - def xcalendar(self, val): - self['xcalendar'] = val - - # xgap - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xgap'] - - @xgap.setter - def xgap(self, val): - self['xgap'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # xtype - # ----- - @property - def xtype(self): - """ - If "array", the heatmap's x coordinates are given by "x" (the - default behavior when `x` is provided). If "scaled", the - heatmap's x coordinates are given by "x0" and "dx" (the default - behavior when `x` is not provided). - - The 'xtype' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['array', 'scaled'] - - Returns - ------- - Any - """ - return self['xtype'] - - @xtype.setter - def xtype(self, val): - self['xtype'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # y0 - # -- - @property - 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 - ------- - Any - """ - return self['y0'] - - @y0.setter - def y0(self, val): - self['y0'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # ycalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['ycalendar'] - - @ycalendar.setter - def ycalendar(self, val): - self['ycalendar'] = val - - # ygap - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ygap'] - - @ygap.setter - def ygap(self, val): - self['ygap'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # ytype - # ----- - @property - def ytype(self): - """ - If "array", the heatmap's y coordinates are given by "y" (the - default behavior when `y` is provided) If "scaled", the - heatmap's y coordinates are given by "y0" and "dy" (the default - behavior when `y` is not provided) - - The 'ytype' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['array', 'scaled'] - - Returns - ------- - Any - """ - return self['ytype'] - - @ytype.setter - def ytype(self, val): - self['ytype'] = val - - # z - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # zauto - # ----- - @property - def zauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `z`) or the bounds set in - `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` - are set by the user. - - The 'zauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['zauto'] - - @zauto.setter - def zauto(self, val): - self['zauto'] = val - - # zhoverformat - # ------------ - @property - def zhoverformat(self): - """ - Sets the hover text formatting rule using d3 formatting mini- - languages which are very similar to those in Python. See: https - ://github.com/d3/d3-format/blob/master/README.md#locale_format - - The 'zhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['zhoverformat'] - - @zhoverformat.setter - def zhoverformat(self, val): - self['zhoverformat'] = val - - # zmax - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmax'] - - @zmax.setter - def zmax(self, val): - self['zmax'] = val - - # zmid - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmid'] - - @zmid.setter - def zmid(self, val): - self['zmid'] = val - - # zmin - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmin'] - - @zmin.setter - def zmin(self, val): - self['zmin'] = val - - # zsmooth - # ------- - @property - 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] - - Returns - ------- - Any - """ - return self['zsmooth'] - - @zsmooth.setter - def zsmooth(self, val): - self['zsmooth'] = val - - # zsrc - # ---- - @property - def zsrc(self): - """ - Sets the source reference on plot.ly for z . - - The 'zsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['zsrc'] - - @zsrc.setter - def zsrc(self, val): - self['zsrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - colorbar - plotly.graph_objs.heatmap.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the `z` data are filled in. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dx - Sets the x coordinate step. See `x0` for more info. - dy - Sets the y coordinate step. See `y0` for more info. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.heatmap.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, `zmin` - will correspond to the last color in the array and - `zmax` will correspond to the first color. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.heatmap.Stream instance or dict with - compatible properties - text - Sets the text elements associated with each z value. - textsrc - Sets the source reference on plot.ly for text . - transpose - Transposes the z data. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the starting - coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date data. - xgap - Sets the horizontal gap (in pixels) between bricks. - xsrc - Sets the source reference on plot.ly for x . - xtype - If "array", the heatmap's x coordinates are given by - "x" (the default behavior when `x` is provided). If - "scaled", the heatmap's x coordinates are given by "x0" - and "dx" (the default behavior when `x` is not - provided). - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the starting - coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date data. - ygap - Sets the vertical gap (in pixels) between bricks. - ysrc - Sets the source reference on plot.ly for y . - ytype - If "array", the heatmap's y coordinates are given by - "y" (the default behavior when `y` is provided) If - "scaled", the heatmap's y coordinates are given by "y0" - and "dy" (the default behavior when `y` is not - provided) - z - Sets the z data. - zauto - Determines whether or not the color domain is computed - with respect to the input data (here in `z`) or the - bounds set in `zmin` and `zmax` Defaults to `false` - when `zmin` and `zmax` are set by the user. - zhoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. See: https://github.com/d3/d3-format/blob/maste - r/README.md#locale_format - zmax - Sets the upper bound of the color domain. Value should - have the same units as in `z` and if set, `zmin` must - be set as well. - zmid - Sets the mid-point of the color domain by scaling - `zmin` and/or `zmax` to be equidistant to this point. - Value should have the same units as in `z`. Has no - effect when `zauto` is `false`. - zmin - Sets the lower bound of the color domain. Value should - have the same units as in `z` and if set, `zmax` must - be set as well. - zsmooth - Picks a smoothing algorithm use to smooth `z` data. - zsrc - Sets the source reference on plot.ly for z . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - colorbar=None, - colorscale=None, - connectgaps=None, - customdata=None, - customdatasrc=None, - dx=None, - dy=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - legendgroup=None, - name=None, - opacity=None, - reversescale=None, - selectedpoints=None, - showlegend=None, - showscale=None, - stream=None, - text=None, - textsrc=None, - transpose=None, - uid=None, - uirevision=None, - visible=None, - x=None, - x0=None, - xaxis=None, - xcalendar=None, - xgap=None, - xsrc=None, - xtype=None, - y=None, - y0=None, - yaxis=None, - ycalendar=None, - ygap=None, - ysrc=None, - ytype=None, - z=None, - zauto=None, - zhoverformat=None, - zmax=None, - zmid=None, - zmin=None, - zsmooth=None, - zsrc=None, - **kwargs - ): - """ - Construct a new Heatmap object - - The data that describes the heatmap value-to-color mapping is - set in `z`. Data in `z` can either be a 2D list of values - (ragged or not) or a 1D array of values. In the case where `z` - is a 2D list, say that `z` has N rows and M columns. Then, by - default, the resulting heatmap will have N partitions along the - y axis and M partitions along the x axis. In other words, the - i-th row/ j-th column cell in `z` is mapped to the i-th - partition of the y axis (starting from the bottom of the plot) - and the j-th partition of the x-axis (starting from the left of - the plot). This behavior can be flipped by using `transpose`. - Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1) - elements. If M (N), then the coordinates correspond to the - center of the heatmap cells and the cells have equal width. If - M+1 (N+1), then the coordinates correspond to the edges of the - heatmap cells. In the case where `z` is a 1D list, the x and y - coordinates must be provided in `x` and `y` respectively to - form data triplets. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Heatmap - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - colorbar - plotly.graph_objs.heatmap.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the `z` data are filled in. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dx - Sets the x coordinate step. See `x0` for more info. - dy - Sets the y coordinate step. See `y0` for more info. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.heatmap.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, `zmin` - will correspond to the last color in the array and - `zmax` will correspond to the first color. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.heatmap.Stream instance or dict with - compatible properties - text - Sets the text elements associated with each z value. - textsrc - Sets the source reference on plot.ly for text . - transpose - Transposes the z data. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the starting - coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date data. - xgap - Sets the horizontal gap (in pixels) between bricks. - xsrc - Sets the source reference on plot.ly for x . - xtype - If "array", the heatmap's x coordinates are given by - "x" (the default behavior when `x` is provided). If - "scaled", the heatmap's x coordinates are given by "x0" - and "dx" (the default behavior when `x` is not - provided). - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the starting - coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date data. - ygap - Sets the vertical gap (in pixels) between bricks. - ysrc - Sets the source reference on plot.ly for y . - ytype - If "array", the heatmap's y coordinates are given by - "y" (the default behavior when `y` is provided) If - "scaled", the heatmap's y coordinates are given by "y0" - and "dy" (the default behavior when `y` is not - provided) - z - Sets the z data. - zauto - Determines whether or not the color domain is computed - with respect to the input data (here in `z`) or the - bounds set in `zmin` and `zmax` Defaults to `false` - when `zmin` and `zmax` are set by the user. - zhoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. See: https://github.com/d3/d3-format/blob/maste - r/README.md#locale_format - zmax - Sets the upper bound of the color domain. Value should - have the same units as in `z` and if set, `zmin` must - be set as well. - zmid - Sets the mid-point of the color domain by scaling - `zmin` and/or `zmax` to be equidistant to this point. - Value should have the same units as in `z`. Has no - effect when `zauto` is `false`. - zmin - Sets the lower bound of the color domain. Value should - have the same units as in `z` and if set, `zmax` must - be set as well. - zsmooth - Picks a smoothing algorithm use to smooth `z` data. - zsrc - Sets the source reference on plot.ly for z . - - Returns - ------- - Heatmap - """ - super(Heatmap, self).__init__('heatmap') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Heatmap -constructor must be a dict or -an instance of plotly.graph_objs.Heatmap""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (heatmap as v_heatmap) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_heatmap.AutocolorscaleValidator( - ) - self._validators['colorbar'] = v_heatmap.ColorBarValidator() - self._validators['colorscale'] = v_heatmap.ColorscaleValidator() - self._validators['connectgaps'] = v_heatmap.ConnectgapsValidator() - self._validators['customdata'] = v_heatmap.CustomdataValidator() - self._validators['customdatasrc'] = v_heatmap.CustomdatasrcValidator() - self._validators['dx'] = v_heatmap.DxValidator() - self._validators['dy'] = v_heatmap.DyValidator() - self._validators['hoverinfo'] = v_heatmap.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_heatmap.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_heatmap.HoverlabelValidator() - self._validators['hovertemplate'] = v_heatmap.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_heatmap.HovertemplatesrcValidator() - self._validators['hovertext'] = v_heatmap.HovertextValidator() - self._validators['hovertextsrc'] = v_heatmap.HovertextsrcValidator() - self._validators['ids'] = v_heatmap.IdsValidator() - self._validators['idssrc'] = v_heatmap.IdssrcValidator() - self._validators['legendgroup'] = v_heatmap.LegendgroupValidator() - self._validators['name'] = v_heatmap.NameValidator() - self._validators['opacity'] = v_heatmap.OpacityValidator() - self._validators['reversescale'] = v_heatmap.ReversescaleValidator() - self._validators['selectedpoints'] = v_heatmap.SelectedpointsValidator( - ) - self._validators['showlegend'] = v_heatmap.ShowlegendValidator() - self._validators['showscale'] = v_heatmap.ShowscaleValidator() - self._validators['stream'] = v_heatmap.StreamValidator() - self._validators['text'] = v_heatmap.TextValidator() - self._validators['textsrc'] = v_heatmap.TextsrcValidator() - self._validators['transpose'] = v_heatmap.TransposeValidator() - self._validators['uid'] = v_heatmap.UidValidator() - self._validators['uirevision'] = v_heatmap.UirevisionValidator() - self._validators['visible'] = v_heatmap.VisibleValidator() - self._validators['x'] = v_heatmap.XValidator() - self._validators['x0'] = v_heatmap.X0Validator() - self._validators['xaxis'] = v_heatmap.XAxisValidator() - self._validators['xcalendar'] = v_heatmap.XcalendarValidator() - self._validators['xgap'] = v_heatmap.XgapValidator() - self._validators['xsrc'] = v_heatmap.XsrcValidator() - self._validators['xtype'] = v_heatmap.XtypeValidator() - self._validators['y'] = v_heatmap.YValidator() - self._validators['y0'] = v_heatmap.Y0Validator() - self._validators['yaxis'] = v_heatmap.YAxisValidator() - self._validators['ycalendar'] = v_heatmap.YcalendarValidator() - self._validators['ygap'] = v_heatmap.YgapValidator() - self._validators['ysrc'] = v_heatmap.YsrcValidator() - self._validators['ytype'] = v_heatmap.YtypeValidator() - self._validators['z'] = v_heatmap.ZValidator() - self._validators['zauto'] = v_heatmap.ZautoValidator() - self._validators['zhoverformat'] = v_heatmap.ZhoverformatValidator() - self._validators['zmax'] = v_heatmap.ZmaxValidator() - self._validators['zmid'] = v_heatmap.ZmidValidator() - self._validators['zmin'] = v_heatmap.ZminValidator() - self._validators['zsmooth'] = v_heatmap.ZsmoothValidator() - self._validators['zsrc'] = v_heatmap.ZsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('connectgaps', None) - self['connectgaps'] = connectgaps if connectgaps is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('dx', None) - self['dx'] = dx if dx is not None else _v - _v = arg.pop('dy', None) - self['dy'] = dy if dy is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('transpose', None) - self['transpose'] = transpose if transpose is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('x0', None) - self['x0'] = x0 if x0 is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('xcalendar', None) - self['xcalendar'] = xcalendar if xcalendar is not None else _v - _v = arg.pop('xgap', None) - self['xgap'] = xgap if xgap is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('xtype', None) - self['xtype'] = xtype if xtype is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('y0', None) - self['y0'] = y0 if y0 is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - _v = arg.pop('ycalendar', None) - self['ycalendar'] = ycalendar if ycalendar is not None else _v - _v = arg.pop('ygap', None) - self['ygap'] = ygap if ygap is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - _v = arg.pop('ytype', None) - self['ytype'] = ytype if ytype is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - _v = arg.pop('zauto', None) - self['zauto'] = zauto if zauto is not None else _v - _v = arg.pop('zhoverformat', None) - self['zhoverformat'] = zhoverformat if zhoverformat is not None else _v - _v = arg.pop('zmax', None) - self['zmax'] = zmax if zmax is not None else _v - _v = arg.pop('zmid', None) - self['zmid'] = zmid if zmid is not None else _v - _v = arg.pop('zmin', None) - self['zmin'] = zmin if zmin is not None else _v - _v = arg.pop('zsmooth', None) - self['zsmooth'] = zsmooth if zsmooth is not None else _v - _v = arg.pop('zsrc', None) - self['zsrc'] = zsrc if zsrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'heatmap' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='heatmap', val='heatmap' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_heatmapgl.py b/plotly/graph_objs/_heatmapgl.py deleted file mode 100644 index cb58b68db36..00000000000 --- a/plotly/graph_objs/_heatmapgl.py +++ /dev/null @@ -1,1796 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Heatmapgl(BaseTraceType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be chosen - according to whether numbers in the `color` array are all - positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of plotly.graph_objs.heatmapgl.ColorBar - - A dict of string/value properties that will be passed - to the ColorBar constructor - - Supported dict properties: - - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.heatmapgl.colorbar.Tickformat - stop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.heatmapgl.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of heatmapgl.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.heatmapgl.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - heatmapgl.colorbar.title.font instead. Sets - this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - heatmapgl.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.heatmapgl.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. The colorscale must be an array containing - arrays mapping a normalized value to an rgb, rgba, hex, hsl, - hsv, or named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # dx - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['dx'] - - @dx.setter - def dx(self, val): - self['dx'] = val - - # dy - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['dy'] - - @dy.setter - def dy(self, val): - self['dy'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.heatmapgl.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.heatmapgl.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # reversescale - # ------------ - @property - 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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.heatmapgl.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.heatmapgl.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # transpose - # --------- - @property - def transpose(self): - """ - Transposes the z data. - - The 'transpose' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['transpose'] - - @transpose.setter - def transpose(self, val): - self['transpose'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # x0 - # -- - @property - 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 - ------- - Any - """ - return self['x0'] - - @x0.setter - def x0(self, val): - self['x0'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # xtype - # ----- - @property - def xtype(self): - """ - If "array", the heatmap's x coordinates are given by "x" (the - default behavior when `x` is provided). If "scaled", the - heatmap's x coordinates are given by "x0" and "dx" (the default - behavior when `x` is not provided). - - The 'xtype' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['array', 'scaled'] - - Returns - ------- - Any - """ - return self['xtype'] - - @xtype.setter - def xtype(self, val): - self['xtype'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # y0 - # -- - @property - 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 - ------- - Any - """ - return self['y0'] - - @y0.setter - def y0(self, val): - self['y0'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # ytype - # ----- - @property - def ytype(self): - """ - If "array", the heatmap's y coordinates are given by "y" (the - default behavior when `y` is provided) If "scaled", the - heatmap's y coordinates are given by "y0" and "dy" (the default - behavior when `y` is not provided) - - The 'ytype' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['array', 'scaled'] - - Returns - ------- - Any - """ - return self['ytype'] - - @ytype.setter - def ytype(self, val): - self['ytype'] = val - - # z - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # zauto - # ----- - @property - def zauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `z`) or the bounds set in - `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` - are set by the user. - - The 'zauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['zauto'] - - @zauto.setter - def zauto(self, val): - self['zauto'] = val - - # zmax - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmax'] - - @zmax.setter - def zmax(self, val): - self['zmax'] = val - - # zmid - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmid'] - - @zmid.setter - def zmid(self, val): - self['zmid'] = val - - # zmin - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmin'] - - @zmin.setter - def zmin(self, val): - self['zmin'] = val - - # zsrc - # ---- - @property - def zsrc(self): - """ - Sets the source reference on plot.ly for z . - - The 'zsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['zsrc'] - - @zsrc.setter - def zsrc(self, val): - self['zsrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - colorbar - plotly.graph_objs.heatmapgl.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dx - Sets the x coordinate step. See `x0` for more info. - dy - Sets the y coordinate step. See `y0` for more info. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.heatmapgl.Hoverlabel instance or dict - with compatible properties - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, `zmin` - will correspond to the last color in the array and - `zmax` will correspond to the first color. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.heatmapgl.Stream instance or dict - with compatible properties - text - Sets the text elements associated with each z value. - textsrc - Sets the source reference on plot.ly for text . - transpose - Transposes the z data. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the starting - coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xsrc - Sets the source reference on plot.ly for x . - xtype - If "array", the heatmap's x coordinates are given by - "x" (the default behavior when `x` is provided). If - "scaled", the heatmap's x coordinates are given by "x0" - and "dx" (the default behavior when `x` is not - provided). - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the starting - coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ysrc - Sets the source reference on plot.ly for y . - ytype - If "array", the heatmap's y coordinates are given by - "y" (the default behavior when `y` is provided) If - "scaled", the heatmap's y coordinates are given by "y0" - and "dy" (the default behavior when `y` is not - provided) - z - Sets the z data. - zauto - Determines whether or not the color domain is computed - with respect to the input data (here in `z`) or the - bounds set in `zmin` and `zmax` Defaults to `false` - when `zmin` and `zmax` are set by the user. - zmax - Sets the upper bound of the color domain. Value should - have the same units as in `z` and if set, `zmin` must - be set as well. - zmid - Sets the mid-point of the color domain by scaling - `zmin` and/or `zmax` to be equidistant to this point. - Value should have the same units as in `z`. Has no - effect when `zauto` is `false`. - zmin - Sets the lower bound of the color domain. Value should - have the same units as in `z` and if set, `zmax` must - be set as well. - zsrc - Sets the source reference on plot.ly for z . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - colorbar=None, - colorscale=None, - customdata=None, - customdatasrc=None, - dx=None, - dy=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - ids=None, - idssrc=None, - legendgroup=None, - name=None, - opacity=None, - reversescale=None, - selectedpoints=None, - showlegend=None, - showscale=None, - stream=None, - text=None, - textsrc=None, - transpose=None, - uid=None, - uirevision=None, - visible=None, - x=None, - x0=None, - xaxis=None, - xsrc=None, - xtype=None, - y=None, - y0=None, - yaxis=None, - ysrc=None, - ytype=None, - z=None, - zauto=None, - zmax=None, - zmid=None, - zmin=None, - zsrc=None, - **kwargs - ): - """ - Construct a new Heatmapgl object - - WebGL version of the heatmap trace type. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Heatmapgl - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - colorbar - plotly.graph_objs.heatmapgl.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dx - Sets the x coordinate step. See `x0` for more info. - dy - Sets the y coordinate step. See `y0` for more info. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.heatmapgl.Hoverlabel instance or dict - with compatible properties - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, `zmin` - will correspond to the last color in the array and - `zmax` will correspond to the first color. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.heatmapgl.Stream instance or dict - with compatible properties - text - Sets the text elements associated with each z value. - textsrc - Sets the source reference on plot.ly for text . - transpose - Transposes the z data. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the starting - coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xsrc - Sets the source reference on plot.ly for x . - xtype - If "array", the heatmap's x coordinates are given by - "x" (the default behavior when `x` is provided). If - "scaled", the heatmap's x coordinates are given by "x0" - and "dx" (the default behavior when `x` is not - provided). - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the starting - coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ysrc - Sets the source reference on plot.ly for y . - ytype - If "array", the heatmap's y coordinates are given by - "y" (the default behavior when `y` is provided) If - "scaled", the heatmap's y coordinates are given by "y0" - and "dy" (the default behavior when `y` is not - provided) - z - Sets the z data. - zauto - Determines whether or not the color domain is computed - with respect to the input data (here in `z`) or the - bounds set in `zmin` and `zmax` Defaults to `false` - when `zmin` and `zmax` are set by the user. - zmax - Sets the upper bound of the color domain. Value should - have the same units as in `z` and if set, `zmin` must - be set as well. - zmid - Sets the mid-point of the color domain by scaling - `zmin` and/or `zmax` to be equidistant to this point. - Value should have the same units as in `z`. Has no - effect when `zauto` is `false`. - zmin - Sets the lower bound of the color domain. Value should - have the same units as in `z` and if set, `zmax` must - be set as well. - zsrc - Sets the source reference on plot.ly for z . - - Returns - ------- - Heatmapgl - """ - super(Heatmapgl, self).__init__('heatmapgl') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Heatmapgl -constructor must be a dict or -an instance of plotly.graph_objs.Heatmapgl""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (heatmapgl as v_heatmapgl) - - # Initialize validators - # --------------------- - self._validators['autocolorscale' - ] = v_heatmapgl.AutocolorscaleValidator() - self._validators['colorbar'] = v_heatmapgl.ColorBarValidator() - self._validators['colorscale'] = v_heatmapgl.ColorscaleValidator() - self._validators['customdata'] = v_heatmapgl.CustomdataValidator() - self._validators['customdatasrc'] = v_heatmapgl.CustomdatasrcValidator( - ) - self._validators['dx'] = v_heatmapgl.DxValidator() - self._validators['dy'] = v_heatmapgl.DyValidator() - self._validators['hoverinfo'] = v_heatmapgl.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_heatmapgl.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_heatmapgl.HoverlabelValidator() - self._validators['ids'] = v_heatmapgl.IdsValidator() - self._validators['idssrc'] = v_heatmapgl.IdssrcValidator() - self._validators['legendgroup'] = v_heatmapgl.LegendgroupValidator() - self._validators['name'] = v_heatmapgl.NameValidator() - self._validators['opacity'] = v_heatmapgl.OpacityValidator() - self._validators['reversescale'] = v_heatmapgl.ReversescaleValidator() - self._validators['selectedpoints' - ] = v_heatmapgl.SelectedpointsValidator() - self._validators['showlegend'] = v_heatmapgl.ShowlegendValidator() - self._validators['showscale'] = v_heatmapgl.ShowscaleValidator() - self._validators['stream'] = v_heatmapgl.StreamValidator() - self._validators['text'] = v_heatmapgl.TextValidator() - self._validators['textsrc'] = v_heatmapgl.TextsrcValidator() - self._validators['transpose'] = v_heatmapgl.TransposeValidator() - self._validators['uid'] = v_heatmapgl.UidValidator() - self._validators['uirevision'] = v_heatmapgl.UirevisionValidator() - self._validators['visible'] = v_heatmapgl.VisibleValidator() - self._validators['x'] = v_heatmapgl.XValidator() - self._validators['x0'] = v_heatmapgl.X0Validator() - self._validators['xaxis'] = v_heatmapgl.XAxisValidator() - self._validators['xsrc'] = v_heatmapgl.XsrcValidator() - self._validators['xtype'] = v_heatmapgl.XtypeValidator() - self._validators['y'] = v_heatmapgl.YValidator() - self._validators['y0'] = v_heatmapgl.Y0Validator() - self._validators['yaxis'] = v_heatmapgl.YAxisValidator() - self._validators['ysrc'] = v_heatmapgl.YsrcValidator() - self._validators['ytype'] = v_heatmapgl.YtypeValidator() - self._validators['z'] = v_heatmapgl.ZValidator() - self._validators['zauto'] = v_heatmapgl.ZautoValidator() - self._validators['zmax'] = v_heatmapgl.ZmaxValidator() - self._validators['zmid'] = v_heatmapgl.ZmidValidator() - self._validators['zmin'] = v_heatmapgl.ZminValidator() - self._validators['zsrc'] = v_heatmapgl.ZsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('dx', None) - self['dx'] = dx if dx is not None else _v - _v = arg.pop('dy', None) - self['dy'] = dy if dy is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('transpose', None) - self['transpose'] = transpose if transpose is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('x0', None) - self['x0'] = x0 if x0 is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('xtype', None) - self['xtype'] = xtype if xtype is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('y0', None) - self['y0'] = y0 if y0 is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - _v = arg.pop('ytype', None) - self['ytype'] = ytype if ytype is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - _v = arg.pop('zauto', None) - self['zauto'] = zauto if zauto is not None else _v - _v = arg.pop('zmax', None) - self['zmax'] = zmax if zmax is not None else _v - _v = arg.pop('zmid', None) - self['zmid'] = zmid if zmid is not None else _v - _v = arg.pop('zmin', None) - self['zmin'] = zmin if zmin is not None else _v - _v = arg.pop('zsrc', None) - self['zsrc'] = zsrc if zsrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'heatmapgl' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='heatmapgl', val='heatmapgl' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_histogram.py b/plotly/graph_objs/_histogram.py deleted file mode 100644 index 9c6d21e570a..00000000000 --- a/plotly/graph_objs/_histogram.py +++ /dev/null @@ -1,2176 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Histogram(BaseTraceType): - - # alignmentgroup - # -------------- - @property - 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 - - Returns - ------- - str - """ - return self['alignmentgroup'] - - @alignmentgroup.setter - def alignmentgroup(self, val): - self['alignmentgroup'] = val - - # autobinx - # -------- - @property - def autobinx(self): - """ - Obsolete: since v1.42 each bin attribute is auto-determined - separately and `autobinx` is not needed. However, we accept - `autobinx: true` or `false` and will update `xbins` accordingly - before deleting `autobinx` from the trace. - - The 'autobinx' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autobinx'] - - @autobinx.setter - def autobinx(self, val): - self['autobinx'] = val - - # autobiny - # -------- - @property - def autobiny(self): - """ - Obsolete: since v1.42 each bin attribute is auto-determined - separately and `autobiny` is not needed. However, we accept - `autobiny: true` or `false` and will update `ybins` accordingly - before deleting `autobiny` from the trace. - - The 'autobiny' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autobiny'] - - @autobiny.setter - def autobiny(self, val): - self['autobiny'] = val - - # cumulative - # ---------- - @property - def cumulative(self): - """ - The 'cumulative' property is an instance of Cumulative - that may be specified as: - - An instance of plotly.graph_objs.histogram.Cumulative - - A dict of string/value properties that will be passed - to the Cumulative constructor - - Supported dict properties: - - currentbin - Only applies if cumulative is enabled. Sets - whether the current bin is included, excluded, - or has half of its value included in the - current cumulative value. "include" is the - default for compatibility with various other - tools, however it introduces a half-bin bias to - the results. "exclude" makes the opposite half- - bin bias, and "half" removes it. - direction - Only applies if cumulative is enabled. If - "increasing" (default) we sum all prior bins, - so the result increases from left to right. If - "decreasing" we sum later bins so the result - decreases from left to right. - enabled - If true, display the cumulative distribution by - summing the binned values. Use the `direction` - and `centralbin` attributes to tune the - accumulation method. Note: in this mode, the - "density" `histnorm` settings behave the same - as their equivalents without "density": "" and - "density" both rise to the number of data - points, and "probability" and *probability - density* both rise to the number of sample - points. - - Returns - ------- - plotly.graph_objs.histogram.Cumulative - """ - return self['cumulative'] - - @cumulative.setter - def cumulative(self, val): - self['cumulative'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # error_x - # ------- - @property - def error_x(self): - """ - The 'error_x' property is an instance of ErrorX - that may be specified as: - - An instance of plotly.graph_objs.histogram.ErrorX - - A dict of string/value properties that will be passed - to the ErrorX constructor - - Supported dict properties: - - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - copy_ystyle - - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. - - Returns - ------- - plotly.graph_objs.histogram.ErrorX - """ - return self['error_x'] - - @error_x.setter - def error_x(self, val): - self['error_x'] = val - - # error_y - # ------- - @property - def error_y(self): - """ - The 'error_y' property is an instance of ErrorY - that may be specified as: - - An instance of plotly.graph_objs.histogram.ErrorY - - A dict of string/value properties that will be passed - to the ErrorY constructor - - Supported dict properties: - - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. - - Returns - ------- - plotly.graph_objs.histogram.ErrorY - """ - return self['error_y'] - - @error_y.setter - def error_y(self, val): - self['error_y'] = val - - # histfunc - # -------- - @property - def histfunc(self): - """ - Specifies the binning function used for this histogram trace. - If "count", the histogram values are computed by counting the - number of values lying inside each bin. If "sum", "avg", "min", - "max", the histogram values are computed using the sum, the - average, the minimum or the maximum of the values lying inside - each bin respectively. - - The 'histfunc' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['count', 'sum', 'avg', 'min', 'max'] - - Returns - ------- - Any - """ - return self['histfunc'] - - @histfunc.setter - def histfunc(self, val): - self['histfunc'] = val - - # histnorm - # -------- - @property - def histnorm(self): - """ - Specifies the type of normalization used for this histogram - trace. If "", the span of each bar corresponds to the number of - occurrences (i.e. the number of data points lying inside the - bins). If "percent" / "probability", the span of each bar - corresponds to the percentage / fraction of occurrences with - respect to the total number of sample points (here, the sum of - all bin HEIGHTS equals 100% / 1). If "density", the span of - each bar corresponds to the number of occurrences in a bin - divided by the size of the bin interval (here, the sum of all - bin AREAS equals the total number of sample points). If - *probability density*, the area of each bar corresponds to the - probability that an event will fall into the corresponding bin - (here, the sum of all bin AREAS equals 1). - - The 'histnorm' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['', 'percent', 'probability', 'density', 'probability - density'] - - Returns - ------- - Any - """ - return self['histnorm'] - - @histnorm.setter - def histnorm(self, val): - self['histnorm'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.histogram.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.histogram.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - variable `binNumber` Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of plotly.graph_objs.histogram.Marker - - A dict of string/value properties that will be passed - to the Marker constructor - - Supported dict properties: - - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.histogram.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - line - plotly.graph_objs.histogram.marker.Line - instance or dict with compatible properties - opacity - Sets the opacity of the bars. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - - Returns - ------- - plotly.graph_objs.histogram.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # nbinsx - # ------ - @property - def nbinsx(self): - """ - Specifies the maximum number of desired bins. This value will - be used in an algorithm that will decide the optimal bin size - such that the histogram best visualizes the distribution of the - data. Ignored if `xbins.size` is provided. - - The 'nbinsx' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['nbinsx'] - - @nbinsx.setter - def nbinsx(self, val): - self['nbinsx'] = val - - # nbinsy - # ------ - @property - def nbinsy(self): - """ - Specifies the maximum number of desired bins. This value will - be used in an algorithm that will decide the optimal bin size - such that the histogram best visualizes the distribution of the - data. Ignored if `ybins.size` is provided. - - The 'nbinsy' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['nbinsy'] - - @nbinsy.setter - def nbinsy(self, val): - self['nbinsy'] = val - - # offsetgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['offsetgroup'] - - @offsetgroup.setter - def offsetgroup(self, val): - self['offsetgroup'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # orientation - # ----------- - @property - 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'] - - Returns - ------- - Any - """ - return self['orientation'] - - @orientation.setter - def orientation(self, val): - self['orientation'] = val - - # selected - # -------- - @property - def selected(self): - """ - The 'selected' property is an instance of Selected - that may be specified as: - - An instance of plotly.graph_objs.histogram.Selected - - A dict of string/value properties that will be passed - to the Selected constructor - - Supported dict properties: - - marker - plotly.graph_objs.histogram.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.histogram.selected.Textfont - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.histogram.Selected - """ - return self['selected'] - - @selected.setter - def selected(self, val): - self['selected'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.histogram.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.histogram.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - def text(self): - """ - Sets hover text elements associated with each bar. If a single - string, the same string appears over all bars. If an array of - string, the items are mapped in order to the this trace's - coordinates. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # unselected - # ---------- - @property - def unselected(self): - """ - The 'unselected' property is an instance of Unselected - that may be specified as: - - An instance of plotly.graph_objs.histogram.Unselected - - A dict of string/value properties that will be passed - to the Unselected constructor - - Supported dict properties: - - marker - plotly.graph_objs.histogram.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.histogram.unselected.Textfont - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.histogram.Unselected - """ - return self['unselected'] - - @unselected.setter - def unselected(self, val): - self['unselected'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # xbins - # ----- - @property - def xbins(self): - """ - The 'xbins' property is an instance of XBins - that may be specified as: - - An instance of plotly.graph_objs.histogram.XBins - - A dict of string/value properties that will be passed - to the XBins constructor - - Supported dict properties: - - end - Sets the end value for the x axis bins. The - last bin may not end exactly at this value, we - increment the bin edge by `size` from `start` - until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use - a date string, and for category data `end` is - based on the category serial numbers. - size - Sets the size of each x axis bin. Default - behavior: If `nbinsx` is 0 or omitted, we - choose a nice round bin size such that the - number of bins is about the same as the typical - number of samples in each bin. If `nbinsx` is - provided, we choose a nice round bin size - giving no more than that many bins. For date - data, use milliseconds or "M" for months, as - in `axis.dtick`. For category data, the number - of categories to bin together (always defaults - to 1). If multiple non-overlaying histograms - share a subplot, the first explicit `size` is - used and all others discarded. If no `size` is - provided,the sample data from all traces is - combined to determine `size` as described - above. - start - Sets the starting value for the x axis bins. - Defaults to the minimum data value, shifted - down if necessary to make nice round values and - to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin - edges 0.5 down, so a `size` of 5 would have a - default `start` of -0.5, so it is clear that - 0-4 are in the first bin, 5-9 in the second, - but continuous data gets a start of 0 and bins - [0,5), [5,10) etc. Dates behave similarly, and - `start` should be a date string. For category - data, `start` is based on the category serial - numbers, and defaults to -0.5. If multiple non- - overlaying histograms share a subplot, the - first explicit `start` is used exactly and all - others are shifted down (if necessary) to - differ from that one by an integer number of - bins. - - Returns - ------- - plotly.graph_objs.histogram.XBins - """ - return self['xbins'] - - @xbins.setter - def xbins(self, val): - self['xbins'] = val - - # xcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['xcalendar'] - - @xcalendar.setter - def xcalendar(self, val): - self['xcalendar'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # ybins - # ----- - @property - def ybins(self): - """ - The 'ybins' property is an instance of YBins - that may be specified as: - - An instance of plotly.graph_objs.histogram.YBins - - A dict of string/value properties that will be passed - to the YBins constructor - - Supported dict properties: - - end - Sets the end value for the y axis bins. The - last bin may not end exactly at this value, we - increment the bin edge by `size` from `start` - until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use - a date string, and for category data `end` is - based on the category serial numbers. - size - Sets the size of each y axis bin. Default - behavior: If `nbinsy` is 0 or omitted, we - choose a nice round bin size such that the - number of bins is about the same as the typical - number of samples in each bin. If `nbinsy` is - provided, we choose a nice round bin size - giving no more than that many bins. For date - data, use milliseconds or "M" for months, as - in `axis.dtick`. For category data, the number - of categories to bin together (always defaults - to 1). If multiple non-overlaying histograms - share a subplot, the first explicit `size` is - used and all others discarded. If no `size` is - provided,the sample data from all traces is - combined to determine `size` as described - above. - start - Sets the starting value for the y axis bins. - Defaults to the minimum data value, shifted - down if necessary to make nice round values and - to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin - edges 0.5 down, so a `size` of 5 would have a - default `start` of -0.5, so it is clear that - 0-4 are in the first bin, 5-9 in the second, - but continuous data gets a start of 0 and bins - [0,5), [5,10) etc. Dates behave similarly, and - `start` should be a date string. For category - data, `start` is based on the category serial - numbers, and defaults to -0.5. If multiple non- - overlaying histograms share a subplot, the - first explicit `start` is used exactly and all - others are shifted down (if necessary) to - differ from that one by an integer number of - bins. - - Returns - ------- - plotly.graph_objs.histogram.YBins - """ - return self['ybins'] - - @ybins.setter - def ybins(self, val): - self['ybins'] = val - - # ycalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['ycalendar'] - - @ycalendar.setter - def ycalendar(self, val): - self['ycalendar'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - alignmentgroup - Set several traces linked to the same position axis or - matching axes to the same alignmentgroup. This controls - whether bars compute their positional range dependently - or independently. - autobinx - Obsolete: since v1.42 each bin attribute is auto- - determined separately and `autobinx` is not needed. - However, we accept `autobinx: true` or `false` and will - update `xbins` accordingly before deleting `autobinx` - from the trace. - autobiny - Obsolete: since v1.42 each bin attribute is auto- - determined separately and `autobiny` is not needed. - However, we accept `autobiny: true` or `false` and will - update `ybins` accordingly before deleting `autobiny` - from the trace. - cumulative - plotly.graph_objs.histogram.Cumulative instance or dict - with compatible properties - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - error_x - plotly.graph_objs.histogram.ErrorX instance or dict - with compatible properties - error_y - plotly.graph_objs.histogram.ErrorY instance or dict - with compatible properties - histfunc - Specifies the binning function used for this histogram - trace. If "count", the histogram values are computed by - counting the number of values lying inside each bin. If - "sum", "avg", "min", "max", the histogram values are - computed using the sum, the average, the minimum or the - maximum of the values lying inside each bin - respectively. - histnorm - Specifies the type of normalization used for this - histogram trace. If "", the span of each bar - corresponds to the number of occurrences (i.e. the - number of data points lying inside the bins). If - "percent" / "probability", the span of each bar - corresponds to the percentage / fraction of occurrences - with respect to the total number of sample points - (here, the sum of all bin HEIGHTS equals 100% / 1). If - "density", the span of each bar corresponds to the - number of occurrences in a bin divided by the size of - the bin interval (here, the sum of all bin AREAS equals - the total number of sample points). If *probability - density*, the area of each bar corresponds to the - probability that an event will fall into the - corresponding bin (here, the sum of all bin AREAS - equals 1). - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.histogram.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variable `binNumber` Anything contained in - tag `` is displayed in the secondary box, for - example "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - marker - plotly.graph_objs.histogram.Marker instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - nbinsx - Specifies the maximum number of desired bins. This - value will be used in an algorithm that will decide the - optimal bin size such that the histogram best - visualizes the distribution of the data. Ignored if - `xbins.size` is provided. - nbinsy - Specifies the maximum number of desired bins. This - value will be used in an algorithm that will decide the - optimal bin size such that the histogram best - visualizes the distribution of the data. Ignored if - `ybins.size` is provided. - offsetgroup - Set several traces linked to the same position axis or - matching axes to the same offsetgroup where bars of the - same position coordinate will line up. - opacity - Sets the opacity of the trace. - orientation - Sets the orientation of the bars. With "v" ("h"), the - value of the each bar spans along the vertical - (horizontal). - selected - plotly.graph_objs.histogram.Selected instance or dict - with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.histogram.Stream instance or dict - with compatible properties - text - Sets hover text elements associated with each bar. If a - single string, the same string appears over all bars. - If an array of string, the items are mapped in order to - the this trace's coordinates. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.histogram.Unselected instance or dict - with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the sample data to be binned on the x axis. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xbins - plotly.graph_objs.histogram.XBins instance or dict with - compatible properties - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the sample data to be binned on the y axis. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ybins - plotly.graph_objs.histogram.YBins instance or dict with - compatible properties - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - """ - - def __init__( - self, - arg=None, - alignmentgroup=None, - autobinx=None, - autobiny=None, - cumulative=None, - customdata=None, - customdatasrc=None, - error_x=None, - error_y=None, - histfunc=None, - histnorm=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - legendgroup=None, - marker=None, - name=None, - nbinsx=None, - nbinsy=None, - offsetgroup=None, - opacity=None, - orientation=None, - selected=None, - selectedpoints=None, - showlegend=None, - stream=None, - text=None, - textsrc=None, - uid=None, - uirevision=None, - unselected=None, - visible=None, - x=None, - xaxis=None, - xbins=None, - xcalendar=None, - xsrc=None, - y=None, - yaxis=None, - ybins=None, - ycalendar=None, - ysrc=None, - **kwargs - ): - """ - Construct a new Histogram object - - The sample data from which statistics are computed is set in - `x` for vertically spanning histograms and in `y` for - horizontally spanning histograms. Binning options are set - `xbins` and `ybins` respectively if no aggregation data is - provided. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Histogram - alignmentgroup - Set several traces linked to the same position axis or - matching axes to the same alignmentgroup. This controls - whether bars compute their positional range dependently - or independently. - autobinx - Obsolete: since v1.42 each bin attribute is auto- - determined separately and `autobinx` is not needed. - However, we accept `autobinx: true` or `false` and will - update `xbins` accordingly before deleting `autobinx` - from the trace. - autobiny - Obsolete: since v1.42 each bin attribute is auto- - determined separately and `autobiny` is not needed. - However, we accept `autobiny: true` or `false` and will - update `ybins` accordingly before deleting `autobiny` - from the trace. - cumulative - plotly.graph_objs.histogram.Cumulative instance or dict - with compatible properties - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - error_x - plotly.graph_objs.histogram.ErrorX instance or dict - with compatible properties - error_y - plotly.graph_objs.histogram.ErrorY instance or dict - with compatible properties - histfunc - Specifies the binning function used for this histogram - trace. If "count", the histogram values are computed by - counting the number of values lying inside each bin. If - "sum", "avg", "min", "max", the histogram values are - computed using the sum, the average, the minimum or the - maximum of the values lying inside each bin - respectively. - histnorm - Specifies the type of normalization used for this - histogram trace. If "", the span of each bar - corresponds to the number of occurrences (i.e. the - number of data points lying inside the bins). If - "percent" / "probability", the span of each bar - corresponds to the percentage / fraction of occurrences - with respect to the total number of sample points - (here, the sum of all bin HEIGHTS equals 100% / 1). If - "density", the span of each bar corresponds to the - number of occurrences in a bin divided by the size of - the bin interval (here, the sum of all bin AREAS equals - the total number of sample points). If *probability - density*, the area of each bar corresponds to the - probability that an event will fall into the - corresponding bin (here, the sum of all bin AREAS - equals 1). - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.histogram.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variable `binNumber` Anything contained in - tag `` is displayed in the secondary box, for - example "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - marker - plotly.graph_objs.histogram.Marker instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - nbinsx - Specifies the maximum number of desired bins. This - value will be used in an algorithm that will decide the - optimal bin size such that the histogram best - visualizes the distribution of the data. Ignored if - `xbins.size` is provided. - nbinsy - Specifies the maximum number of desired bins. This - value will be used in an algorithm that will decide the - optimal bin size such that the histogram best - visualizes the distribution of the data. Ignored if - `ybins.size` is provided. - offsetgroup - Set several traces linked to the same position axis or - matching axes to the same offsetgroup where bars of the - same position coordinate will line up. - opacity - Sets the opacity of the trace. - orientation - Sets the orientation of the bars. With "v" ("h"), the - value of the each bar spans along the vertical - (horizontal). - selected - plotly.graph_objs.histogram.Selected instance or dict - with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.histogram.Stream instance or dict - with compatible properties - text - Sets hover text elements associated with each bar. If a - single string, the same string appears over all bars. - If an array of string, the items are mapped in order to - the this trace's coordinates. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.histogram.Unselected instance or dict - with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the sample data to be binned on the x axis. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xbins - plotly.graph_objs.histogram.XBins instance or dict with - compatible properties - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the sample data to be binned on the y axis. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ybins - plotly.graph_objs.histogram.YBins instance or dict with - compatible properties - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - - Returns - ------- - Histogram - """ - super(Histogram, self).__init__('histogram') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Histogram -constructor must be a dict or -an instance of plotly.graph_objs.Histogram""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (histogram as v_histogram) - - # Initialize validators - # --------------------- - self._validators['alignmentgroup' - ] = v_histogram.AlignmentgroupValidator() - self._validators['autobinx'] = v_histogram.AutobinxValidator() - self._validators['autobiny'] = v_histogram.AutobinyValidator() - self._validators['cumulative'] = v_histogram.CumulativeValidator() - self._validators['customdata'] = v_histogram.CustomdataValidator() - self._validators['customdatasrc'] = v_histogram.CustomdatasrcValidator( - ) - self._validators['error_x'] = v_histogram.ErrorXValidator() - self._validators['error_y'] = v_histogram.ErrorYValidator() - self._validators['histfunc'] = v_histogram.HistfuncValidator() - self._validators['histnorm'] = v_histogram.HistnormValidator() - self._validators['hoverinfo'] = v_histogram.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_histogram.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_histogram.HoverlabelValidator() - self._validators['hovertemplate'] = v_histogram.HovertemplateValidator( - ) - self._validators['hovertemplatesrc' - ] = v_histogram.HovertemplatesrcValidator() - self._validators['hovertext'] = v_histogram.HovertextValidator() - self._validators['hovertextsrc'] = v_histogram.HovertextsrcValidator() - self._validators['ids'] = v_histogram.IdsValidator() - self._validators['idssrc'] = v_histogram.IdssrcValidator() - self._validators['legendgroup'] = v_histogram.LegendgroupValidator() - self._validators['marker'] = v_histogram.MarkerValidator() - self._validators['name'] = v_histogram.NameValidator() - self._validators['nbinsx'] = v_histogram.NbinsxValidator() - self._validators['nbinsy'] = v_histogram.NbinsyValidator() - self._validators['offsetgroup'] = v_histogram.OffsetgroupValidator() - self._validators['opacity'] = v_histogram.OpacityValidator() - self._validators['orientation'] = v_histogram.OrientationValidator() - self._validators['selected'] = v_histogram.SelectedValidator() - self._validators['selectedpoints' - ] = v_histogram.SelectedpointsValidator() - self._validators['showlegend'] = v_histogram.ShowlegendValidator() - self._validators['stream'] = v_histogram.StreamValidator() - self._validators['text'] = v_histogram.TextValidator() - self._validators['textsrc'] = v_histogram.TextsrcValidator() - self._validators['uid'] = v_histogram.UidValidator() - self._validators['uirevision'] = v_histogram.UirevisionValidator() - self._validators['unselected'] = v_histogram.UnselectedValidator() - self._validators['visible'] = v_histogram.VisibleValidator() - self._validators['x'] = v_histogram.XValidator() - self._validators['xaxis'] = v_histogram.XAxisValidator() - self._validators['xbins'] = v_histogram.XBinsValidator() - self._validators['xcalendar'] = v_histogram.XcalendarValidator() - self._validators['xsrc'] = v_histogram.XsrcValidator() - self._validators['y'] = v_histogram.YValidator() - self._validators['yaxis'] = v_histogram.YAxisValidator() - self._validators['ybins'] = v_histogram.YBinsValidator() - self._validators['ycalendar'] = v_histogram.YcalendarValidator() - self._validators['ysrc'] = v_histogram.YsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('alignmentgroup', None) - self['alignmentgroup' - ] = alignmentgroup if alignmentgroup is not None else _v - _v = arg.pop('autobinx', None) - self['autobinx'] = autobinx if autobinx is not None else _v - _v = arg.pop('autobiny', None) - self['autobiny'] = autobiny if autobiny is not None else _v - _v = arg.pop('cumulative', None) - self['cumulative'] = cumulative if cumulative is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('error_x', None) - self['error_x'] = error_x if error_x is not None else _v - _v = arg.pop('error_y', None) - self['error_y'] = error_y if error_y is not None else _v - _v = arg.pop('histfunc', None) - self['histfunc'] = histfunc if histfunc is not None else _v - _v = arg.pop('histnorm', None) - self['histnorm'] = histnorm if histnorm is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('nbinsx', None) - self['nbinsx'] = nbinsx if nbinsx is not None else _v - _v = arg.pop('nbinsy', None) - self['nbinsy'] = nbinsy if nbinsy is not None else _v - _v = arg.pop('offsetgroup', None) - self['offsetgroup'] = offsetgroup if offsetgroup is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('orientation', None) - self['orientation'] = orientation if orientation is not None else _v - _v = arg.pop('selected', None) - self['selected'] = selected if selected is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('unselected', None) - self['unselected'] = unselected if unselected is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('xbins', None) - self['xbins'] = xbins if xbins is not None else _v - _v = arg.pop('xcalendar', None) - self['xcalendar'] = xcalendar if xcalendar is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - _v = arg.pop('ybins', None) - self['ybins'] = ybins if ybins is not None else _v - _v = arg.pop('ycalendar', None) - self['ycalendar'] = ycalendar if ycalendar is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'histogram' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='histogram', val='histogram' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_histogram2d.py b/plotly/graph_objs/_histogram2d.py deleted file mode 100644 index fbc845d81d3..00000000000 --- a/plotly/graph_objs/_histogram2d.py +++ /dev/null @@ -1,2263 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Histogram2d(BaseTraceType): - - # autobinx - # -------- - @property - def autobinx(self): - """ - Obsolete: since v1.42 each bin attribute is auto-determined - separately and `autobinx` is not needed. However, we accept - `autobinx: true` or `false` and will update `xbins` accordingly - before deleting `autobinx` from the trace. - - The 'autobinx' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autobinx'] - - @autobinx.setter - def autobinx(self, val): - self['autobinx'] = val - - # autobiny - # -------- - @property - def autobiny(self): - """ - Obsolete: since v1.42 each bin attribute is auto-determined - separately and `autobiny` is not needed. However, we accept - `autobiny: true` or `false` and will update `ybins` accordingly - before deleting `autobiny` from the trace. - - The 'autobiny' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autobiny'] - - @autobiny.setter - def autobiny(self, val): - self['autobiny'] = val - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be chosen - according to whether numbers in the `color` array are all - positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of plotly.graph_objs.histogram2d.ColorBar - - A dict of string/value properties that will be passed - to the ColorBar constructor - - Supported dict properties: - - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.histogram2d.colorbar.Tickform - atstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.histogram2d.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of - histogram2d.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.histogram2d.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - histogram2d.colorbar.title.font instead. Sets - this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - histogram2d.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.histogram2d.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. The colorscale must be an array containing - arrays mapping a normalized value to an rgb, rgba, hex, hsl, - hsv, or named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # histfunc - # -------- - @property - def histfunc(self): - """ - Specifies the binning function used for this histogram trace. - If "count", the histogram values are computed by counting the - number of values lying inside each bin. If "sum", "avg", "min", - "max", the histogram values are computed using the sum, the - average, the minimum or the maximum of the values lying inside - each bin respectively. - - The 'histfunc' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['count', 'sum', 'avg', 'min', 'max'] - - Returns - ------- - Any - """ - return self['histfunc'] - - @histfunc.setter - def histfunc(self, val): - self['histfunc'] = val - - # histnorm - # -------- - @property - def histnorm(self): - """ - Specifies the type of normalization used for this histogram - trace. If "", the span of each bar corresponds to the number of - occurrences (i.e. the number of data points lying inside the - bins). If "percent" / "probability", the span of each bar - corresponds to the percentage / fraction of occurrences with - respect to the total number of sample points (here, the sum of - all bin HEIGHTS equals 100% / 1). If "density", the span of - each bar corresponds to the number of occurrences in a bin - divided by the size of the bin interval (here, the sum of all - bin AREAS equals the total number of sample points). If - *probability density*, the area of each bar corresponds to the - probability that an event will fall into the corresponding bin - (here, the sum of all bin AREAS equals 1). - - The 'histnorm' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['', 'percent', 'probability', 'density', 'probability - density'] - - Returns - ------- - Any - """ - return self['histnorm'] - - @histnorm.setter - def histnorm(self, val): - self['histnorm'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.histogram2d.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.histogram2d.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - variable `z` Anything contained in tag `` is displayed - in the secondary box, for example - "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of plotly.graph_objs.histogram2d.Marker - - A dict of string/value properties that will be passed - to the Marker constructor - - Supported dict properties: - - color - Sets the aggregation data. - colorsrc - Sets the source reference on plot.ly for color - . - - Returns - ------- - plotly.graph_objs.histogram2d.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # nbinsx - # ------ - @property - def nbinsx(self): - """ - Specifies the maximum number of desired bins. This value will - be used in an algorithm that will decide the optimal bin size - such that the histogram best visualizes the distribution of the - data. Ignored if `xbins.size` is provided. - - The 'nbinsx' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['nbinsx'] - - @nbinsx.setter - def nbinsx(self, val): - self['nbinsx'] = val - - # nbinsy - # ------ - @property - def nbinsy(self): - """ - Specifies the maximum number of desired bins. This value will - be used in an algorithm that will decide the optimal bin size - such that the histogram best visualizes the distribution of the - data. Ignored if `ybins.size` is provided. - - The 'nbinsy' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['nbinsy'] - - @nbinsy.setter - def nbinsy(self, val): - self['nbinsy'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # reversescale - # ------------ - @property - 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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.histogram2d.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.histogram2d.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # xbins - # ----- - @property - def xbins(self): - """ - The 'xbins' property is an instance of XBins - that may be specified as: - - An instance of plotly.graph_objs.histogram2d.XBins - - A dict of string/value properties that will be passed - to the XBins constructor - - Supported dict properties: - - end - Sets the end value for the x axis bins. The - last bin may not end exactly at this value, we - increment the bin edge by `size` from `start` - until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use - a date string, and for category data `end` is - based on the category serial numbers. - size - Sets the size of each x axis bin. Default - behavior: If `nbinsx` is 0 or omitted, we - choose a nice round bin size such that the - number of bins is about the same as the typical - number of samples in each bin. If `nbinsx` is - provided, we choose a nice round bin size - giving no more than that many bins. For date - data, use milliseconds or "M" for months, as - in `axis.dtick`. For category data, the number - of categories to bin together (always defaults - to 1). - start - Sets the starting value for the x axis bins. - Defaults to the minimum data value, shifted - down if necessary to make nice round values and - to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin - edges 0.5 down, so a `size` of 5 would have a - default `start` of -0.5, so it is clear that - 0-4 are in the first bin, 5-9 in the second, - but continuous data gets a start of 0 and bins - [0,5), [5,10) etc. Dates behave similarly, and - `start` should be a date string. For category - data, `start` is based on the category serial - numbers, and defaults to -0.5. - - Returns - ------- - plotly.graph_objs.histogram2d.XBins - """ - return self['xbins'] - - @xbins.setter - def xbins(self, val): - self['xbins'] = val - - # xcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['xcalendar'] - - @xcalendar.setter - def xcalendar(self, val): - self['xcalendar'] = val - - # xgap - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xgap'] - - @xgap.setter - def xgap(self, val): - self['xgap'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # ybins - # ----- - @property - def ybins(self): - """ - The 'ybins' property is an instance of YBins - that may be specified as: - - An instance of plotly.graph_objs.histogram2d.YBins - - A dict of string/value properties that will be passed - to the YBins constructor - - Supported dict properties: - - end - Sets the end value for the y axis bins. The - last bin may not end exactly at this value, we - increment the bin edge by `size` from `start` - until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use - a date string, and for category data `end` is - based on the category serial numbers. - size - Sets the size of each y axis bin. Default - behavior: If `nbinsy` is 0 or omitted, we - choose a nice round bin size such that the - number of bins is about the same as the typical - number of samples in each bin. If `nbinsy` is - provided, we choose a nice round bin size - giving no more than that many bins. For date - data, use milliseconds or "M" for months, as - in `axis.dtick`. For category data, the number - of categories to bin together (always defaults - to 1). - start - Sets the starting value for the y axis bins. - Defaults to the minimum data value, shifted - down if necessary to make nice round values and - to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin - edges 0.5 down, so a `size` of 5 would have a - default `start` of -0.5, so it is clear that - 0-4 are in the first bin, 5-9 in the second, - but continuous data gets a start of 0 and bins - [0,5), [5,10) etc. Dates behave similarly, and - `start` should be a date string. For category - data, `start` is based on the category serial - numbers, and defaults to -0.5. - - Returns - ------- - plotly.graph_objs.histogram2d.YBins - """ - return self['ybins'] - - @ybins.setter - def ybins(self, val): - self['ybins'] = val - - # ycalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['ycalendar'] - - @ycalendar.setter - def ycalendar(self, val): - self['ycalendar'] = val - - # ygap - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ygap'] - - @ygap.setter - def ygap(self, val): - self['ygap'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # z - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # zauto - # ----- - @property - def zauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `z`) or the bounds set in - `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` - are set by the user. - - The 'zauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['zauto'] - - @zauto.setter - def zauto(self, val): - self['zauto'] = val - - # zhoverformat - # ------------ - @property - def zhoverformat(self): - """ - Sets the hover text formatting rule using d3 formatting mini- - languages which are very similar to those in Python. See: https - ://github.com/d3/d3-format/blob/master/README.md#locale_format - - The 'zhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['zhoverformat'] - - @zhoverformat.setter - def zhoverformat(self, val): - self['zhoverformat'] = val - - # zmax - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmax'] - - @zmax.setter - def zmax(self, val): - self['zmax'] = val - - # zmid - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmid'] - - @zmid.setter - def zmid(self, val): - self['zmid'] = val - - # zmin - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmin'] - - @zmin.setter - def zmin(self, val): - self['zmin'] = val - - # zsmooth - # ------- - @property - 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] - - Returns - ------- - Any - """ - return self['zsmooth'] - - @zsmooth.setter - def zsmooth(self, val): - self['zsmooth'] = val - - # zsrc - # ---- - @property - def zsrc(self): - """ - Sets the source reference on plot.ly for z . - - The 'zsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['zsrc'] - - @zsrc.setter - def zsrc(self, val): - self['zsrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autobinx - Obsolete: since v1.42 each bin attribute is auto- - determined separately and `autobinx` is not needed. - However, we accept `autobinx: true` or `false` and will - update `xbins` accordingly before deleting `autobinx` - from the trace. - autobiny - Obsolete: since v1.42 each bin attribute is auto- - determined separately and `autobiny` is not needed. - However, we accept `autobiny: true` or `false` and will - update `ybins` accordingly before deleting `autobiny` - from the trace. - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - colorbar - plotly.graph_objs.histogram2d.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - histfunc - Specifies the binning function used for this histogram - trace. If "count", the histogram values are computed by - counting the number of values lying inside each bin. If - "sum", "avg", "min", "max", the histogram values are - computed using the sum, the average, the minimum or the - maximum of the values lying inside each bin - respectively. - histnorm - Specifies the type of normalization used for this - histogram trace. If "", the span of each bar - corresponds to the number of occurrences (i.e. the - number of data points lying inside the bins). If - "percent" / "probability", the span of each bar - corresponds to the percentage / fraction of occurrences - with respect to the total number of sample points - (here, the sum of all bin HEIGHTS equals 100% / 1). If - "density", the span of each bar corresponds to the - number of occurrences in a bin divided by the size of - the bin interval (here, the sum of all bin AREAS equals - the total number of sample points). If *probability - density*, the area of each bar corresponds to the - probability that an event will fall into the - corresponding bin (here, the sum of all bin AREAS - equals 1). - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.histogram2d.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variable `z` Anything contained in tag - `` is displayed in the secondary box, for - example "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - marker - plotly.graph_objs.histogram2d.Marker instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - nbinsx - Specifies the maximum number of desired bins. This - value will be used in an algorithm that will decide the - optimal bin size such that the histogram best - visualizes the distribution of the data. Ignored if - `xbins.size` is provided. - nbinsy - Specifies the maximum number of desired bins. This - value will be used in an algorithm that will decide the - optimal bin size such that the histogram best - visualizes the distribution of the data. Ignored if - `ybins.size` is provided. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, `zmin` - will correspond to the last color in the array and - `zmax` will correspond to the first color. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.histogram2d.Stream instance or dict - with compatible properties - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the sample data to be binned on the x axis. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xbins - plotly.graph_objs.histogram2d.XBins instance or dict - with compatible properties - xcalendar - Sets the calendar system to use with `x` date data. - xgap - Sets the horizontal gap (in pixels) between bricks. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the sample data to be binned on the y axis. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ybins - plotly.graph_objs.histogram2d.YBins instance or dict - with compatible properties - ycalendar - Sets the calendar system to use with `y` date data. - ygap - Sets the vertical gap (in pixels) between bricks. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the aggregation data. - zauto - Determines whether or not the color domain is computed - with respect to the input data (here in `z`) or the - bounds set in `zmin` and `zmax` Defaults to `false` - when `zmin` and `zmax` are set by the user. - zhoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. See: https://github.com/d3/d3-format/blob/maste - r/README.md#locale_format - zmax - Sets the upper bound of the color domain. Value should - have the same units as in `z` and if set, `zmin` must - be set as well. - zmid - Sets the mid-point of the color domain by scaling - `zmin` and/or `zmax` to be equidistant to this point. - Value should have the same units as in `z`. Has no - effect when `zauto` is `false`. - zmin - Sets the lower bound of the color domain. Value should - have the same units as in `z` and if set, `zmax` must - be set as well. - zsmooth - Picks a smoothing algorithm use to smooth `z` data. - zsrc - Sets the source reference on plot.ly for z . - """ - - def __init__( - self, - arg=None, - autobinx=None, - autobiny=None, - autocolorscale=None, - colorbar=None, - colorscale=None, - customdata=None, - customdatasrc=None, - histfunc=None, - histnorm=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - ids=None, - idssrc=None, - legendgroup=None, - marker=None, - name=None, - nbinsx=None, - nbinsy=None, - opacity=None, - reversescale=None, - selectedpoints=None, - showlegend=None, - showscale=None, - stream=None, - uid=None, - uirevision=None, - visible=None, - x=None, - xaxis=None, - xbins=None, - xcalendar=None, - xgap=None, - xsrc=None, - y=None, - yaxis=None, - ybins=None, - ycalendar=None, - ygap=None, - ysrc=None, - z=None, - zauto=None, - zhoverformat=None, - zmax=None, - zmid=None, - zmin=None, - zsmooth=None, - zsrc=None, - **kwargs - ): - """ - Construct a new Histogram2d object - - The sample data from which statistics are computed is set in - `x` and `y` (where `x` and `y` represent marginal - distributions, binning is set in `xbins` and `ybins` in this - case) or `z` (where `z` represent the 2D distribution and - binning set, binning is set by `x` and `y` in this case). The - resulting distribution is visualized as a heatmap. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Histogram2d - autobinx - Obsolete: since v1.42 each bin attribute is auto- - determined separately and `autobinx` is not needed. - However, we accept `autobinx: true` or `false` and will - update `xbins` accordingly before deleting `autobinx` - from the trace. - autobiny - Obsolete: since v1.42 each bin attribute is auto- - determined separately and `autobiny` is not needed. - However, we accept `autobiny: true` or `false` and will - update `ybins` accordingly before deleting `autobiny` - from the trace. - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - colorbar - plotly.graph_objs.histogram2d.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - histfunc - Specifies the binning function used for this histogram - trace. If "count", the histogram values are computed by - counting the number of values lying inside each bin. If - "sum", "avg", "min", "max", the histogram values are - computed using the sum, the average, the minimum or the - maximum of the values lying inside each bin - respectively. - histnorm - Specifies the type of normalization used for this - histogram trace. If "", the span of each bar - corresponds to the number of occurrences (i.e. the - number of data points lying inside the bins). If - "percent" / "probability", the span of each bar - corresponds to the percentage / fraction of occurrences - with respect to the total number of sample points - (here, the sum of all bin HEIGHTS equals 100% / 1). If - "density", the span of each bar corresponds to the - number of occurrences in a bin divided by the size of - the bin interval (here, the sum of all bin AREAS equals - the total number of sample points). If *probability - density*, the area of each bar corresponds to the - probability that an event will fall into the - corresponding bin (here, the sum of all bin AREAS - equals 1). - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.histogram2d.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variable `z` Anything contained in tag - `` is displayed in the secondary box, for - example "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - marker - plotly.graph_objs.histogram2d.Marker instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - nbinsx - Specifies the maximum number of desired bins. This - value will be used in an algorithm that will decide the - optimal bin size such that the histogram best - visualizes the distribution of the data. Ignored if - `xbins.size` is provided. - nbinsy - Specifies the maximum number of desired bins. This - value will be used in an algorithm that will decide the - optimal bin size such that the histogram best - visualizes the distribution of the data. Ignored if - `ybins.size` is provided. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, `zmin` - will correspond to the last color in the array and - `zmax` will correspond to the first color. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.histogram2d.Stream instance or dict - with compatible properties - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the sample data to be binned on the x axis. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xbins - plotly.graph_objs.histogram2d.XBins instance or dict - with compatible properties - xcalendar - Sets the calendar system to use with `x` date data. - xgap - Sets the horizontal gap (in pixels) between bricks. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the sample data to be binned on the y axis. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ybins - plotly.graph_objs.histogram2d.YBins instance or dict - with compatible properties - ycalendar - Sets the calendar system to use with `y` date data. - ygap - Sets the vertical gap (in pixels) between bricks. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the aggregation data. - zauto - Determines whether or not the color domain is computed - with respect to the input data (here in `z`) or the - bounds set in `zmin` and `zmax` Defaults to `false` - when `zmin` and `zmax` are set by the user. - zhoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. See: https://github.com/d3/d3-format/blob/maste - r/README.md#locale_format - zmax - Sets the upper bound of the color domain. Value should - have the same units as in `z` and if set, `zmin` must - be set as well. - zmid - Sets the mid-point of the color domain by scaling - `zmin` and/or `zmax` to be equidistant to this point. - Value should have the same units as in `z`. Has no - effect when `zauto` is `false`. - zmin - Sets the lower bound of the color domain. Value should - have the same units as in `z` and if set, `zmax` must - be set as well. - zsmooth - Picks a smoothing algorithm use to smooth `z` data. - zsrc - Sets the source reference on plot.ly for z . - - Returns - ------- - Histogram2d - """ - super(Histogram2d, self).__init__('histogram2d') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Histogram2d -constructor must be a dict or -an instance of plotly.graph_objs.Histogram2d""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (histogram2d as v_histogram2d) - - # Initialize validators - # --------------------- - self._validators['autobinx'] = v_histogram2d.AutobinxValidator() - self._validators['autobiny'] = v_histogram2d.AutobinyValidator() - self._validators['autocolorscale' - ] = v_histogram2d.AutocolorscaleValidator() - self._validators['colorbar'] = v_histogram2d.ColorBarValidator() - self._validators['colorscale'] = v_histogram2d.ColorscaleValidator() - self._validators['customdata'] = v_histogram2d.CustomdataValidator() - self._validators['customdatasrc' - ] = v_histogram2d.CustomdatasrcValidator() - self._validators['histfunc'] = v_histogram2d.HistfuncValidator() - self._validators['histnorm'] = v_histogram2d.HistnormValidator() - self._validators['hoverinfo'] = v_histogram2d.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_histogram2d.HoverinfosrcValidator( - ) - self._validators['hoverlabel'] = v_histogram2d.HoverlabelValidator() - self._validators['hovertemplate' - ] = v_histogram2d.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_histogram2d.HovertemplatesrcValidator() - self._validators['ids'] = v_histogram2d.IdsValidator() - self._validators['idssrc'] = v_histogram2d.IdssrcValidator() - self._validators['legendgroup'] = v_histogram2d.LegendgroupValidator() - self._validators['marker'] = v_histogram2d.MarkerValidator() - self._validators['name'] = v_histogram2d.NameValidator() - self._validators['nbinsx'] = v_histogram2d.NbinsxValidator() - self._validators['nbinsy'] = v_histogram2d.NbinsyValidator() - self._validators['opacity'] = v_histogram2d.OpacityValidator() - self._validators['reversescale'] = v_histogram2d.ReversescaleValidator( - ) - self._validators['selectedpoints' - ] = v_histogram2d.SelectedpointsValidator() - self._validators['showlegend'] = v_histogram2d.ShowlegendValidator() - self._validators['showscale'] = v_histogram2d.ShowscaleValidator() - self._validators['stream'] = v_histogram2d.StreamValidator() - self._validators['uid'] = v_histogram2d.UidValidator() - self._validators['uirevision'] = v_histogram2d.UirevisionValidator() - self._validators['visible'] = v_histogram2d.VisibleValidator() - self._validators['x'] = v_histogram2d.XValidator() - self._validators['xaxis'] = v_histogram2d.XAxisValidator() - self._validators['xbins'] = v_histogram2d.XBinsValidator() - self._validators['xcalendar'] = v_histogram2d.XcalendarValidator() - self._validators['xgap'] = v_histogram2d.XgapValidator() - self._validators['xsrc'] = v_histogram2d.XsrcValidator() - self._validators['y'] = v_histogram2d.YValidator() - self._validators['yaxis'] = v_histogram2d.YAxisValidator() - self._validators['ybins'] = v_histogram2d.YBinsValidator() - self._validators['ycalendar'] = v_histogram2d.YcalendarValidator() - self._validators['ygap'] = v_histogram2d.YgapValidator() - self._validators['ysrc'] = v_histogram2d.YsrcValidator() - self._validators['z'] = v_histogram2d.ZValidator() - self._validators['zauto'] = v_histogram2d.ZautoValidator() - self._validators['zhoverformat'] = v_histogram2d.ZhoverformatValidator( - ) - self._validators['zmax'] = v_histogram2d.ZmaxValidator() - self._validators['zmid'] = v_histogram2d.ZmidValidator() - self._validators['zmin'] = v_histogram2d.ZminValidator() - self._validators['zsmooth'] = v_histogram2d.ZsmoothValidator() - self._validators['zsrc'] = v_histogram2d.ZsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autobinx', None) - self['autobinx'] = autobinx if autobinx is not None else _v - _v = arg.pop('autobiny', None) - self['autobiny'] = autobiny if autobiny is not None else _v - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('histfunc', None) - self['histfunc'] = histfunc if histfunc is not None else _v - _v = arg.pop('histnorm', None) - self['histnorm'] = histnorm if histnorm is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('nbinsx', None) - self['nbinsx'] = nbinsx if nbinsx is not None else _v - _v = arg.pop('nbinsy', None) - self['nbinsy'] = nbinsy if nbinsy is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('xbins', None) - self['xbins'] = xbins if xbins is not None else _v - _v = arg.pop('xcalendar', None) - self['xcalendar'] = xcalendar if xcalendar is not None else _v - _v = arg.pop('xgap', None) - self['xgap'] = xgap if xgap is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - _v = arg.pop('ybins', None) - self['ybins'] = ybins if ybins is not None else _v - _v = arg.pop('ycalendar', None) - self['ycalendar'] = ycalendar if ycalendar is not None else _v - _v = arg.pop('ygap', None) - self['ygap'] = ygap if ygap is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - _v = arg.pop('zauto', None) - self['zauto'] = zauto if zauto is not None else _v - _v = arg.pop('zhoverformat', None) - self['zhoverformat'] = zhoverformat if zhoverformat is not None else _v - _v = arg.pop('zmax', None) - self['zmax'] = zmax if zmax is not None else _v - _v = arg.pop('zmid', None) - self['zmid'] = zmid if zmid is not None else _v - _v = arg.pop('zmin', None) - self['zmin'] = zmin if zmin is not None else _v - _v = arg.pop('zsmooth', None) - self['zsmooth'] = zsmooth if zsmooth is not None else _v - _v = arg.pop('zsrc', None) - self['zsrc'] = zsrc if zsrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'histogram2d' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='histogram2d', val='histogram2d' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_histogram2dcontour.py b/plotly/graph_objs/_histogram2dcontour.py deleted file mode 100644 index ea994cf1fc7..00000000000 --- a/plotly/graph_objs/_histogram2dcontour.py +++ /dev/null @@ -1,2416 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Histogram2dContour(BaseTraceType): - - # autobinx - # -------- - @property - def autobinx(self): - """ - Obsolete: since v1.42 each bin attribute is auto-determined - separately and `autobinx` is not needed. However, we accept - `autobinx: true` or `false` and will update `xbins` accordingly - before deleting `autobinx` from the trace. - - The 'autobinx' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autobinx'] - - @autobinx.setter - def autobinx(self, val): - self['autobinx'] = val - - # autobiny - # -------- - @property - def autobiny(self): - """ - Obsolete: since v1.42 each bin attribute is auto-determined - separately and `autobiny` is not needed. However, we accept - `autobiny: true` or `false` and will update `ybins` accordingly - before deleting `autobiny` from the trace. - - The 'autobiny' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autobiny'] - - @autobiny.setter - def autobiny(self, val): - self['autobiny'] = val - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be chosen - according to whether numbers in the `color` array are all - positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # autocontour - # ----------- - @property - def autocontour(self): - """ - Determines whether or not the contour level attributes are - picked by an algorithm. If True, the number of contour levels - can be set in `ncontours`. If False, set the contour level - attributes in `contours`. - - The 'autocontour' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocontour'] - - @autocontour.setter - def autocontour(self, val): - self['autocontour'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.ColorBar - - A dict of string/value properties that will be passed - to the ColorBar constructor - - Supported dict properties: - - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.histogram2dcontour.colorbar.T - ickformatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.histogram2dcontour.colorbar.tickformatstopdef - aults), sets the default property values to use - for elements of - histogram2dcontour.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.histogram2dcontour.colorbar.T - itle instance or dict with compatible - properties - titlefont - Deprecated: Please use - histogram2dcontour.colorbar.title.font instead. - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - histogram2dcontour.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.histogram2dcontour.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. The colorscale must be an array containing - arrays mapping a normalized value to an rgb, rgba, hex, hsl, - hsv, or named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # contours - # -------- - @property - def contours(self): - """ - The 'contours' property is an instance of Contours - that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.Contours - - A dict of string/value properties that will be passed - to the Contours constructor - - Supported dict properties: - - coloring - Determines the coloring method showing the - contour values. If "fill", coloring is done - evenly between each contour level If "heatmap", - a heatmap gradient coloring is applied between - each contour level. If "lines", coloring is - done on the contour lines. If "none", no - coloring is applied on this trace. - end - Sets the end contour level value. Must be more - than `contours.start` - labelfont - Sets the font used for labeling the contour - levels. The default color comes from the lines, - if shown. The default family and size come from - `layout.font`. - labelformat - Sets the contour label formatting rule using d3 - formatting mini-language which is very similar - to Python, see: https://github.com/d3/d3-format - /blob/master/README.md#locale_format. - operation - Sets the constraint operation. "=" keeps - regions equal to `value` "<" and "<=" keep - regions less than `value` ">" and ">=" keep - regions greater than `value` "[]", "()", "[)", - and "(]" keep regions inside `value[0]` to - `value[1]` "][", ")(", "](", ")[" keep regions - outside `value[0]` to value[1]` Open vs. closed - intervals make no difference to constraint - display, but all versions are allowed for - consistency with filter transforms. - showlabels - Determines whether to label the contour lines - with their values. - showlines - Determines whether or not the contour lines are - drawn. Has an effect only if - `contours.coloring` is set to "fill". - size - Sets the step between each contour level. Must - be positive. - start - Sets the starting contour level value. Must be - less than `contours.end` - type - If `levels`, the data is represented as a - contour plot with multiple levels displayed. If - `constraint`, the data is represented as - constraints with the invalid region shaded as - specified by the `operation` and `value` - parameters. - value - Sets the value or values of the constraint - boundary. When `operation` is set to one of the - comparison values (=,<,>=,>,<=) "value" is - expected to be a number. When `operation` is - set to one of the interval values - ([],(),[),(],][,)(,](,)[) "value" is expected - to be an array of two numbers where the first - is the lower bound and the second is the upper - bound. - - Returns - ------- - plotly.graph_objs.histogram2dcontour.Contours - """ - return self['contours'] - - @contours.setter - def contours(self, val): - self['contours'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # histfunc - # -------- - @property - def histfunc(self): - """ - Specifies the binning function used for this histogram trace. - If "count", the histogram values are computed by counting the - number of values lying inside each bin. If "sum", "avg", "min", - "max", the histogram values are computed using the sum, the - average, the minimum or the maximum of the values lying inside - each bin respectively. - - The 'histfunc' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['count', 'sum', 'avg', 'min', 'max'] - - Returns - ------- - Any - """ - return self['histfunc'] - - @histfunc.setter - def histfunc(self, val): - self['histfunc'] = val - - # histnorm - # -------- - @property - def histnorm(self): - """ - Specifies the type of normalization used for this histogram - trace. If "", the span of each bar corresponds to the number of - occurrences (i.e. the number of data points lying inside the - bins). If "percent" / "probability", the span of each bar - corresponds to the percentage / fraction of occurrences with - respect to the total number of sample points (here, the sum of - all bin HEIGHTS equals 100% / 1). If "density", the span of - each bar corresponds to the number of occurrences in a bin - divided by the size of the bin interval (here, the sum of all - bin AREAS equals the total number of sample points). If - *probability density*, the area of each bar corresponds to the - probability that an event will fall into the corresponding bin - (here, the sum of all bin AREAS equals 1). - - The 'histnorm' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['', 'percent', 'probability', 'density', 'probability - density'] - - Returns - ------- - Any - """ - return self['histnorm'] - - @histnorm.setter - def histnorm(self, val): - self['histnorm'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.histogram2dcontour.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - variable `z` Anything contained in tag `` is displayed - in the secondary box, for example - "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.Line - - A dict of string/value properties that will be passed - to the Line constructor - - Supported dict properties: - - color - Sets the color of the contour level. Has no - effect if `contours.coloring` is set to - "lines". - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - smoothing - Sets the amount of smoothing for the contour - lines, where 0 corresponds to no smoothing. - width - Sets the line width (in px). - - Returns - ------- - plotly.graph_objs.histogram2dcontour.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.Marker - - A dict of string/value properties that will be passed - to the Marker constructor - - Supported dict properties: - - color - Sets the aggregation data. - colorsrc - Sets the source reference on plot.ly for color - . - - Returns - ------- - plotly.graph_objs.histogram2dcontour.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # nbinsx - # ------ - @property - def nbinsx(self): - """ - Specifies the maximum number of desired bins. This value will - be used in an algorithm that will decide the optimal bin size - such that the histogram best visualizes the distribution of the - data. Ignored if `xbins.size` is provided. - - The 'nbinsx' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['nbinsx'] - - @nbinsx.setter - def nbinsx(self, val): - self['nbinsx'] = val - - # nbinsy - # ------ - @property - def nbinsy(self): - """ - Specifies the maximum number of desired bins. This value will - be used in an algorithm that will decide the optimal bin size - such that the histogram best visualizes the distribution of the - data. Ignored if `ybins.size` is provided. - - The 'nbinsy' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['nbinsy'] - - @nbinsy.setter - def nbinsy(self, val): - self['nbinsy'] = val - - # ncontours - # --------- - @property - def ncontours(self): - """ - Sets the maximum number of contour levels. The actual number of - contours will be chosen automatically to be less than or equal - to the value of `ncontours`. Has an effect only if - `autocontour` is True or if `contours.size` is missing. - - The 'ncontours' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [1, 9223372036854775807] - - Returns - ------- - int - """ - return self['ncontours'] - - @ncontours.setter - def ncontours(self, val): - self['ncontours'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # reversescale - # ------------ - @property - 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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.histogram2dcontour.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # xbins - # ----- - @property - def xbins(self): - """ - The 'xbins' property is an instance of XBins - that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.XBins - - A dict of string/value properties that will be passed - to the XBins constructor - - Supported dict properties: - - end - Sets the end value for the x axis bins. The - last bin may not end exactly at this value, we - increment the bin edge by `size` from `start` - until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use - a date string, and for category data `end` is - based on the category serial numbers. - size - Sets the size of each x axis bin. Default - behavior: If `nbinsx` is 0 or omitted, we - choose a nice round bin size such that the - number of bins is about the same as the typical - number of samples in each bin. If `nbinsx` is - provided, we choose a nice round bin size - giving no more than that many bins. For date - data, use milliseconds or "M" for months, as - in `axis.dtick`. For category data, the number - of categories to bin together (always defaults - to 1). - start - Sets the starting value for the x axis bins. - Defaults to the minimum data value, shifted - down if necessary to make nice round values and - to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin - edges 0.5 down, so a `size` of 5 would have a - default `start` of -0.5, so it is clear that - 0-4 are in the first bin, 5-9 in the second, - but continuous data gets a start of 0 and bins - [0,5), [5,10) etc. Dates behave similarly, and - `start` should be a date string. For category - data, `start` is based on the category serial - numbers, and defaults to -0.5. - - Returns - ------- - plotly.graph_objs.histogram2dcontour.XBins - """ - return self['xbins'] - - @xbins.setter - def xbins(self, val): - self['xbins'] = val - - # xcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['xcalendar'] - - @xcalendar.setter - def xcalendar(self, val): - self['xcalendar'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # ybins - # ----- - @property - def ybins(self): - """ - The 'ybins' property is an instance of YBins - that may be specified as: - - An instance of plotly.graph_objs.histogram2dcontour.YBins - - A dict of string/value properties that will be passed - to the YBins constructor - - Supported dict properties: - - end - Sets the end value for the y axis bins. The - last bin may not end exactly at this value, we - increment the bin edge by `size` from `start` - until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use - a date string, and for category data `end` is - based on the category serial numbers. - size - Sets the size of each y axis bin. Default - behavior: If `nbinsy` is 0 or omitted, we - choose a nice round bin size such that the - number of bins is about the same as the typical - number of samples in each bin. If `nbinsy` is - provided, we choose a nice round bin size - giving no more than that many bins. For date - data, use milliseconds or "M" for months, as - in `axis.dtick`. For category data, the number - of categories to bin together (always defaults - to 1). - start - Sets the starting value for the y axis bins. - Defaults to the minimum data value, shifted - down if necessary to make nice round values and - to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin - edges 0.5 down, so a `size` of 5 would have a - default `start` of -0.5, so it is clear that - 0-4 are in the first bin, 5-9 in the second, - but continuous data gets a start of 0 and bins - [0,5), [5,10) etc. Dates behave similarly, and - `start` should be a date string. For category - data, `start` is based on the category serial - numbers, and defaults to -0.5. - - Returns - ------- - plotly.graph_objs.histogram2dcontour.YBins - """ - return self['ybins'] - - @ybins.setter - def ybins(self, val): - self['ybins'] = val - - # ycalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['ycalendar'] - - @ycalendar.setter - def ycalendar(self, val): - self['ycalendar'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # z - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # zauto - # ----- - @property - def zauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `z`) or the bounds set in - `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` - are set by the user. - - The 'zauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['zauto'] - - @zauto.setter - def zauto(self, val): - self['zauto'] = val - - # zhoverformat - # ------------ - @property - def zhoverformat(self): - """ - Sets the hover text formatting rule using d3 formatting mini- - languages which are very similar to those in Python. See: https - ://github.com/d3/d3-format/blob/master/README.md#locale_format - - The 'zhoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['zhoverformat'] - - @zhoverformat.setter - def zhoverformat(self, val): - self['zhoverformat'] = val - - # zmax - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmax'] - - @zmax.setter - def zmax(self, val): - self['zmax'] = val - - # zmid - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmid'] - - @zmid.setter - def zmid(self, val): - self['zmid'] = val - - # zmin - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zmin'] - - @zmin.setter - def zmin(self, val): - self['zmin'] = val - - # zsrc - # ---- - @property - def zsrc(self): - """ - Sets the source reference on plot.ly for z . - - The 'zsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['zsrc'] - - @zsrc.setter - def zsrc(self, val): - self['zsrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autobinx - Obsolete: since v1.42 each bin attribute is auto- - determined separately and `autobinx` is not needed. - However, we accept `autobinx: true` or `false` and will - update `xbins` accordingly before deleting `autobinx` - from the trace. - autobiny - Obsolete: since v1.42 each bin attribute is auto- - determined separately and `autobiny` is not needed. - However, we accept `autobiny: true` or `false` and will - update `ybins` accordingly before deleting `autobiny` - from the trace. - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - autocontour - Determines whether or not the contour level attributes - are picked by an algorithm. If True, the number of - contour levels can be set in `ncontours`. If False, set - the contour level attributes in `contours`. - colorbar - plotly.graph_objs.histogram2dcontour.ColorBar instance - or dict with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - contours - plotly.graph_objs.histogram2dcontour.Contours instance - or dict with compatible properties - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - histfunc - Specifies the binning function used for this histogram - trace. If "count", the histogram values are computed by - counting the number of values lying inside each bin. If - "sum", "avg", "min", "max", the histogram values are - computed using the sum, the average, the minimum or the - maximum of the values lying inside each bin - respectively. - histnorm - Specifies the type of normalization used for this - histogram trace. If "", the span of each bar - corresponds to the number of occurrences (i.e. the - number of data points lying inside the bins). If - "percent" / "probability", the span of each bar - corresponds to the percentage / fraction of occurrences - with respect to the total number of sample points - (here, the sum of all bin HEIGHTS equals 100% / 1). If - "density", the span of each bar corresponds to the - number of occurrences in a bin divided by the size of - the bin interval (here, the sum of all bin AREAS equals - the total number of sample points). If *probability - density*, the area of each bar corresponds to the - probability that an event will fall into the - corresponding bin (here, the sum of all bin AREAS - equals 1). - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.histogram2dcontour.Hoverlabel - instance or dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variable `z` Anything contained in tag - `` is displayed in the secondary box, for - example "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.histogram2dcontour.Line instance or - dict with compatible properties - marker - plotly.graph_objs.histogram2dcontour.Marker instance or - dict with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - nbinsx - Specifies the maximum number of desired bins. This - value will be used in an algorithm that will decide the - optimal bin size such that the histogram best - visualizes the distribution of the data. Ignored if - `xbins.size` is provided. - nbinsy - Specifies the maximum number of desired bins. This - value will be used in an algorithm that will decide the - optimal bin size such that the histogram best - visualizes the distribution of the data. Ignored if - `ybins.size` is provided. - ncontours - Sets the maximum number of contour levels. The actual - number of contours will be chosen automatically to be - less than or equal to the value of `ncontours`. Has an - effect only if `autocontour` is True or if - `contours.size` is missing. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, `zmin` - will correspond to the last color in the array and - `zmax` will correspond to the first color. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.histogram2dcontour.Stream instance or - dict with compatible properties - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the sample data to be binned on the x axis. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xbins - plotly.graph_objs.histogram2dcontour.XBins instance or - dict with compatible properties - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the sample data to be binned on the y axis. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ybins - plotly.graph_objs.histogram2dcontour.YBins instance or - dict with compatible properties - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the aggregation data. - zauto - Determines whether or not the color domain is computed - with respect to the input data (here in `z`) or the - bounds set in `zmin` and `zmax` Defaults to `false` - when `zmin` and `zmax` are set by the user. - zhoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. See: https://github.com/d3/d3-format/blob/maste - r/README.md#locale_format - zmax - Sets the upper bound of the color domain. Value should - have the same units as in `z` and if set, `zmin` must - be set as well. - zmid - Sets the mid-point of the color domain by scaling - `zmin` and/or `zmax` to be equidistant to this point. - Value should have the same units as in `z`. Has no - effect when `zauto` is `false`. - zmin - Sets the lower bound of the color domain. Value should - have the same units as in `z` and if set, `zmax` must - be set as well. - zsrc - Sets the source reference on plot.ly for z . - """ - - def __init__( - self, - arg=None, - autobinx=None, - autobiny=None, - autocolorscale=None, - autocontour=None, - colorbar=None, - colorscale=None, - contours=None, - customdata=None, - customdatasrc=None, - histfunc=None, - histnorm=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - ids=None, - idssrc=None, - legendgroup=None, - line=None, - marker=None, - name=None, - nbinsx=None, - nbinsy=None, - ncontours=None, - opacity=None, - reversescale=None, - selectedpoints=None, - showlegend=None, - showscale=None, - stream=None, - uid=None, - uirevision=None, - visible=None, - x=None, - xaxis=None, - xbins=None, - xcalendar=None, - xsrc=None, - y=None, - yaxis=None, - ybins=None, - ycalendar=None, - ysrc=None, - z=None, - zauto=None, - zhoverformat=None, - zmax=None, - zmid=None, - zmin=None, - zsrc=None, - **kwargs - ): - """ - Construct a new Histogram2dContour object - - The sample data from which statistics are computed is set in - `x` and `y` (where `x` and `y` represent marginal - distributions, binning is set in `xbins` and `ybins` in this - case) or `z` (where `z` represent the 2D distribution and - binning set, binning is set by `x` and `y` in this case). The - resulting distribution is visualized as a contour plot. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Histogram2dContour - autobinx - Obsolete: since v1.42 each bin attribute is auto- - determined separately and `autobinx` is not needed. - However, we accept `autobinx: true` or `false` and will - update `xbins` accordingly before deleting `autobinx` - from the trace. - autobiny - Obsolete: since v1.42 each bin attribute is auto- - determined separately and `autobiny` is not needed. - However, we accept `autobiny: true` or `false` and will - update `ybins` accordingly before deleting `autobiny` - from the trace. - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - autocontour - Determines whether or not the contour level attributes - are picked by an algorithm. If True, the number of - contour levels can be set in `ncontours`. If False, set - the contour level attributes in `contours`. - colorbar - plotly.graph_objs.histogram2dcontour.ColorBar instance - or dict with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and `zmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - contours - plotly.graph_objs.histogram2dcontour.Contours instance - or dict with compatible properties - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - histfunc - Specifies the binning function used for this histogram - trace. If "count", the histogram values are computed by - counting the number of values lying inside each bin. If - "sum", "avg", "min", "max", the histogram values are - computed using the sum, the average, the minimum or the - maximum of the values lying inside each bin - respectively. - histnorm - Specifies the type of normalization used for this - histogram trace. If "", the span of each bar - corresponds to the number of occurrences (i.e. the - number of data points lying inside the bins). If - "percent" / "probability", the span of each bar - corresponds to the percentage / fraction of occurrences - with respect to the total number of sample points - (here, the sum of all bin HEIGHTS equals 100% / 1). If - "density", the span of each bar corresponds to the - number of occurrences in a bin divided by the size of - the bin interval (here, the sum of all bin AREAS equals - the total number of sample points). If *probability - density*, the area of each bar corresponds to the - probability that an event will fall into the - corresponding bin (here, the sum of all bin AREAS - equals 1). - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.histogram2dcontour.Hoverlabel - instance or dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variable `z` Anything contained in tag - `` is displayed in the secondary box, for - example "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.histogram2dcontour.Line instance or - dict with compatible properties - marker - plotly.graph_objs.histogram2dcontour.Marker instance or - dict with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - nbinsx - Specifies the maximum number of desired bins. This - value will be used in an algorithm that will decide the - optimal bin size such that the histogram best - visualizes the distribution of the data. Ignored if - `xbins.size` is provided. - nbinsy - Specifies the maximum number of desired bins. This - value will be used in an algorithm that will decide the - optimal bin size such that the histogram best - visualizes the distribution of the data. Ignored if - `ybins.size` is provided. - ncontours - Sets the maximum number of contour levels. The actual - number of contours will be chosen automatically to be - less than or equal to the value of `ncontours`. Has an - effect only if `autocontour` is True or if - `contours.size` is missing. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, `zmin` - will correspond to the last color in the array and - `zmax` will correspond to the first color. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.histogram2dcontour.Stream instance or - dict with compatible properties - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the sample data to be binned on the x axis. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xbins - plotly.graph_objs.histogram2dcontour.XBins instance or - dict with compatible properties - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the sample data to be binned on the y axis. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ybins - plotly.graph_objs.histogram2dcontour.YBins instance or - dict with compatible properties - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the aggregation data. - zauto - Determines whether or not the color domain is computed - with respect to the input data (here in `z`) or the - bounds set in `zmin` and `zmax` Defaults to `false` - when `zmin` and `zmax` are set by the user. - zhoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. See: https://github.com/d3/d3-format/blob/maste - r/README.md#locale_format - zmax - Sets the upper bound of the color domain. Value should - have the same units as in `z` and if set, `zmin` must - be set as well. - zmid - Sets the mid-point of the color domain by scaling - `zmin` and/or `zmax` to be equidistant to this point. - Value should have the same units as in `z`. Has no - effect when `zauto` is `false`. - zmin - Sets the lower bound of the color domain. Value should - have the same units as in `z` and if set, `zmax` must - be set as well. - zsrc - Sets the source reference on plot.ly for z . - - Returns - ------- - Histogram2dContour - """ - super(Histogram2dContour, self).__init__('histogram2dcontour') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Histogram2dContour -constructor must be a dict or -an instance of plotly.graph_objs.Histogram2dContour""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import ( - histogram2dcontour as v_histogram2dcontour - ) - - # Initialize validators - # --------------------- - self._validators['autobinx'] = v_histogram2dcontour.AutobinxValidator() - self._validators['autobiny'] = v_histogram2dcontour.AutobinyValidator() - self._validators['autocolorscale' - ] = v_histogram2dcontour.AutocolorscaleValidator() - self._validators['autocontour' - ] = v_histogram2dcontour.AutocontourValidator() - self._validators['colorbar'] = v_histogram2dcontour.ColorBarValidator() - self._validators['colorscale' - ] = v_histogram2dcontour.ColorscaleValidator() - self._validators['contours'] = v_histogram2dcontour.ContoursValidator() - self._validators['customdata' - ] = v_histogram2dcontour.CustomdataValidator() - self._validators['customdatasrc' - ] = v_histogram2dcontour.CustomdatasrcValidator() - self._validators['histfunc'] = v_histogram2dcontour.HistfuncValidator() - self._validators['histnorm'] = v_histogram2dcontour.HistnormValidator() - self._validators['hoverinfo' - ] = v_histogram2dcontour.HoverinfoValidator() - self._validators['hoverinfosrc' - ] = v_histogram2dcontour.HoverinfosrcValidator() - self._validators['hoverlabel' - ] = v_histogram2dcontour.HoverlabelValidator() - self._validators['hovertemplate' - ] = v_histogram2dcontour.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_histogram2dcontour.HovertemplatesrcValidator() - self._validators['ids'] = v_histogram2dcontour.IdsValidator() - self._validators['idssrc'] = v_histogram2dcontour.IdssrcValidator() - self._validators['legendgroup' - ] = v_histogram2dcontour.LegendgroupValidator() - self._validators['line'] = v_histogram2dcontour.LineValidator() - self._validators['marker'] = v_histogram2dcontour.MarkerValidator() - self._validators['name'] = v_histogram2dcontour.NameValidator() - self._validators['nbinsx'] = v_histogram2dcontour.NbinsxValidator() - self._validators['nbinsy'] = v_histogram2dcontour.NbinsyValidator() - self._validators['ncontours' - ] = v_histogram2dcontour.NcontoursValidator() - self._validators['opacity'] = v_histogram2dcontour.OpacityValidator() - self._validators['reversescale' - ] = v_histogram2dcontour.ReversescaleValidator() - self._validators['selectedpoints' - ] = v_histogram2dcontour.SelectedpointsValidator() - self._validators['showlegend' - ] = v_histogram2dcontour.ShowlegendValidator() - self._validators['showscale' - ] = v_histogram2dcontour.ShowscaleValidator() - self._validators['stream'] = v_histogram2dcontour.StreamValidator() - self._validators['uid'] = v_histogram2dcontour.UidValidator() - self._validators['uirevision' - ] = v_histogram2dcontour.UirevisionValidator() - self._validators['visible'] = v_histogram2dcontour.VisibleValidator() - self._validators['x'] = v_histogram2dcontour.XValidator() - self._validators['xaxis'] = v_histogram2dcontour.XAxisValidator() - self._validators['xbins'] = v_histogram2dcontour.XBinsValidator() - self._validators['xcalendar' - ] = v_histogram2dcontour.XcalendarValidator() - self._validators['xsrc'] = v_histogram2dcontour.XsrcValidator() - self._validators['y'] = v_histogram2dcontour.YValidator() - self._validators['yaxis'] = v_histogram2dcontour.YAxisValidator() - self._validators['ybins'] = v_histogram2dcontour.YBinsValidator() - self._validators['ycalendar' - ] = v_histogram2dcontour.YcalendarValidator() - self._validators['ysrc'] = v_histogram2dcontour.YsrcValidator() - self._validators['z'] = v_histogram2dcontour.ZValidator() - self._validators['zauto'] = v_histogram2dcontour.ZautoValidator() - self._validators['zhoverformat' - ] = v_histogram2dcontour.ZhoverformatValidator() - self._validators['zmax'] = v_histogram2dcontour.ZmaxValidator() - self._validators['zmid'] = v_histogram2dcontour.ZmidValidator() - self._validators['zmin'] = v_histogram2dcontour.ZminValidator() - self._validators['zsrc'] = v_histogram2dcontour.ZsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autobinx', None) - self['autobinx'] = autobinx if autobinx is not None else _v - _v = arg.pop('autobiny', None) - self['autobiny'] = autobiny if autobiny is not None else _v - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('autocontour', None) - self['autocontour'] = autocontour if autocontour is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('contours', None) - self['contours'] = contours if contours is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('histfunc', None) - self['histfunc'] = histfunc if histfunc is not None else _v - _v = arg.pop('histnorm', None) - self['histnorm'] = histnorm if histnorm is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('nbinsx', None) - self['nbinsx'] = nbinsx if nbinsx is not None else _v - _v = arg.pop('nbinsy', None) - self['nbinsy'] = nbinsy if nbinsy is not None else _v - _v = arg.pop('ncontours', None) - self['ncontours'] = ncontours if ncontours is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('xbins', None) - self['xbins'] = xbins if xbins is not None else _v - _v = arg.pop('xcalendar', None) - self['xcalendar'] = xcalendar if xcalendar is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - _v = arg.pop('ybins', None) - self['ybins'] = ybins if ybins is not None else _v - _v = arg.pop('ycalendar', None) - self['ycalendar'] = ycalendar if ycalendar is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - _v = arg.pop('zauto', None) - self['zauto'] = zauto if zauto is not None else _v - _v = arg.pop('zhoverformat', None) - self['zhoverformat'] = zhoverformat if zhoverformat is not None else _v - _v = arg.pop('zmax', None) - self['zmax'] = zmax if zmax is not None else _v - _v = arg.pop('zmid', None) - self['zmid'] = zmid if zmid is not None else _v - _v = arg.pop('zmin', None) - self['zmin'] = zmin if zmin is not None else _v - _v = arg.pop('zsrc', None) - self['zsrc'] = zsrc if zsrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'histogram2dcontour' - self._validators['type'] = LiteralValidator( - plotly_name='type', - parent_name='histogram2dcontour', - val='histogram2dcontour' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_isosurface.py b/plotly/graph_objs/_isosurface.py deleted file mode 100644 index 370202ae2fd..00000000000 --- a/plotly/graph_objs/_isosurface.py +++ /dev/null @@ -1,2208 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Isosurface(BaseTraceType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be chosen - according to whether numbers in the `color` array are all - positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # caps - # ---- - @property - def caps(self): - """ - The 'caps' property is an instance of Caps - that may be specified as: - - An instance of plotly.graph_objs.isosurface.Caps - - A dict of string/value properties that will be passed - to the Caps constructor - - Supported dict properties: - - x - plotly.graph_objs.isosurface.caps.X instance or - dict with compatible properties - y - plotly.graph_objs.isosurface.caps.Y instance or - dict with compatible properties - z - plotly.graph_objs.isosurface.caps.Z instance or - dict with compatible properties - - Returns - ------- - plotly.graph_objs.isosurface.Caps - """ - return self['caps'] - - @caps.setter - def caps(self, val): - self['caps'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here `value`) or the bounds set in - `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` - are set by the user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of plotly.graph_objs.isosurface.ColorBar - - A dict of string/value properties that will be passed - to the ColorBar constructor - - Supported dict properties: - - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.isosurface.colorbar.Tickforma - tstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.isosurface.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of isosurface.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.isosurface.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - isosurface.colorbar.title.font instead. Sets - this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - isosurface.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.isosurface.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. The colorscale must be an array containing - arrays mapping a normalized value to an rgb, rgba, hex, hsl, - hsv, or named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # contour - # ------- - @property - def contour(self): - """ - The 'contour' property is an instance of Contour - that may be specified as: - - An instance of plotly.graph_objs.isosurface.Contour - - A dict of string/value properties that will be passed - to the Contour constructor - - Supported dict properties: - - color - Sets the color of the contour lines. - show - Sets whether or not dynamic contours are shown - on hover - width - Sets the width of the contour lines. - - Returns - ------- - plotly.graph_objs.isosurface.Contour - """ - return self['contour'] - - @contour.setter - def contour(self, val): - self['contour'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # flatshading - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['flatshading'] - - @flatshading.setter - def flatshading(self, val): - self['flatshading'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.isosurface.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.isosurface.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # isomax - # ------ - @property - 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 - - Returns - ------- - int|float - """ - return self['isomax'] - - @isomax.setter - def isomax(self, val): - self['isomax'] = val - - # isomin - # ------ - @property - 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 - - Returns - ------- - int|float - """ - return self['isomin'] - - @isomin.setter - def isomin(self, val): - self['isomin'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # lighting - # -------- - @property - def lighting(self): - """ - The 'lighting' property is an instance of Lighting - that may be specified as: - - An instance of plotly.graph_objs.isosurface.Lighting - - A dict of string/value properties that will be passed - to the Lighting constructor - - Supported dict properties: - - ambient - Ambient light increases overall color - visibility but can wash out the image. - diffuse - Represents the extent that incident rays are - reflected in a range of angles. - facenormalsepsilon - Epsilon for face normals calculation avoids - math issues arising from degenerate geometry. - fresnel - Represents the reflectance as a dependency of - the viewing angle; e.g. paper is reflective - when viewing it from the edge of the paper - (almost 90 degrees), causing shine. - roughness - Alters specular reflection; the rougher the - surface, the wider and less contrasty the - shine. - specular - Represents the level that incident rays are - reflected in a single direction, causing shine. - vertexnormalsepsilon - Epsilon for vertex normals calculation avoids - math issues arising from degenerate geometry. - - Returns - ------- - plotly.graph_objs.isosurface.Lighting - """ - return self['lighting'] - - @lighting.setter - def lighting(self, val): - self['lighting'] = val - - # lightposition - # ------------- - @property - def lightposition(self): - """ - The 'lightposition' property is an instance of Lightposition - that may be specified as: - - An instance of plotly.graph_objs.isosurface.Lightposition - - A dict of string/value properties that will be passed - to the Lightposition constructor - - Supported dict properties: - - x - Numeric vector, representing the X coordinate - for each vertex. - y - Numeric vector, representing the Y coordinate - for each vertex. - z - Numeric vector, representing the Z coordinate - for each vertex. - - Returns - ------- - plotly.graph_objs.isosurface.Lightposition - """ - return self['lightposition'] - - @lightposition.setter - def lightposition(self, val): - self['lightposition'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - def opacity(self): - """ - Sets the opacity of the surface. Please note that in the case - of using high `opacity` values for example a value greater than - or equal to 0.5 on two surfaces (and 0.25 with four surfaces), - an overlay of multiple transparent surfaces may not perfectly - be sorted in depth by the webgl API. This behavior may be - improved in the near future and is subject to change. - - The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # reversescale - # ------------ - @property - 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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # scene - # ----- - @property - def scene(self): - """ - Sets a reference between this trace's 3D coordinate system and - a 3D scene. If "scene" (the default value), the (x,y,z) - coordinates refer to `layout.scene`. If "scene2", the (x,y,z) - coordinates refer to `layout.scene2`, and so on. - - The 'scene' property is an identifier of a particular - subplot, of type 'scene', that may be specified as the string 'scene' - optionally followed by an integer >= 1 - (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) - - Returns - ------- - str - """ - return self['scene'] - - @scene.setter - def scene(self, val): - self['scene'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # slices - # ------ - @property - def slices(self): - """ - The 'slices' property is an instance of Slices - that may be specified as: - - An instance of plotly.graph_objs.isosurface.Slices - - A dict of string/value properties that will be passed - to the Slices constructor - - Supported dict properties: - - x - plotly.graph_objs.isosurface.slices.X instance - or dict with compatible properties - y - plotly.graph_objs.isosurface.slices.Y instance - or dict with compatible properties - z - plotly.graph_objs.isosurface.slices.Z instance - or dict with compatible properties - - Returns - ------- - plotly.graph_objs.isosurface.Slices - """ - return self['slices'] - - @slices.setter - def slices(self, val): - self['slices'] = val - - # spaceframe - # ---------- - @property - def spaceframe(self): - """ - The 'spaceframe' property is an instance of Spaceframe - that may be specified as: - - An instance of plotly.graph_objs.isosurface.Spaceframe - - A dict of string/value properties that will be passed - to the Spaceframe constructor - - Supported dict properties: - - fill - Sets the fill ratio of the `spaceframe` - elements. The default fill value is 0.15 - meaning that only 15% of the area of every - faces of tetras would be shaded. Applying a - greater `fill` ratio would allow the creation - of stronger elements or could be sued to have - entirely closed areas (in case of using 1). - show - Displays/hides tetrahedron shapes between - minimum and maximum iso-values. Often useful - when either caps or surfaces are disabled or - filled with values less than 1. - - Returns - ------- - plotly.graph_objs.isosurface.Spaceframe - """ - return self['spaceframe'] - - @spaceframe.setter - def spaceframe(self, val): - self['spaceframe'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.isosurface.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.isosurface.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # surface - # ------- - @property - def surface(self): - """ - The 'surface' property is an instance of Surface - that may be specified as: - - An instance of plotly.graph_objs.isosurface.Surface - - A dict of string/value properties that will be passed - to the Surface constructor - - Supported dict properties: - - count - Sets the number of iso-surfaces between minimum - and maximum iso-values. By default this value - is 2 meaning that only minimum and maximum - surfaces would be drawn. - fill - Sets the fill ratio of the iso-surface. The - default fill value of the surface is 1 meaning - that they are entirely shaded. On the other - hand Applying a `fill` ratio less than one - would allow the creation of openings parallel - to the edges. - pattern - Sets the surface pattern of the iso-surface 3-D - sections. The default pattern of the surface is - `all` meaning that the rest of surface elements - would be shaded. The check options (either 1 or - 2) could be used to draw half of the squares on - the surface. Using various combinations of - capital `A`, `B`, `C`, `D` and `E` may also be - used to reduce the number of triangles on the - iso-surfaces and creating other patterns of - interest. - show - Hides/displays surfaces between minimum and - maximum iso-values. - - Returns - ------- - plotly.graph_objs.isosurface.Surface - """ - return self['surface'] - - @surface.setter - def surface(self, val): - self['surface'] = val - - # text - # ---- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # valuesrc - # -------- - @property - def valuesrc(self): - """ - Sets the source reference on plot.ly for value . - - The 'valuesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['valuesrc'] - - @valuesrc.setter - def valuesrc(self, val): - self['valuesrc'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # z - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # zsrc - # ---- - @property - def zsrc(self): - """ - Sets the source reference on plot.ly for z . - - The 'zsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['zsrc'] - - @zsrc.setter - def zsrc(self, val): - self['zsrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - caps - plotly.graph_objs.isosurface.Caps instance or dict with - compatible properties - cauto - Determines whether or not the color domain is computed - with respect to the input data (here `value`) or the - bounds set in `cmin` and `cmax` Defaults to `false` - when `cmin` and `cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Value should - have the same units as `value` and if set, `cmin` must - be set as well. - cmid - Sets the mid-point of the color domain by scaling - `cmin` and/or `cmax` to be equidistant to this point. - Value should have the same units as `value`. Has no - effect when `cauto` is `false`. - cmin - Sets the lower bound of the color domain. Value should - have the same units as `value` and if set, `cmax` must - be set as well. - colorbar - plotly.graph_objs.isosurface.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - contour - plotly.graph_objs.isosurface.Contour instance or dict - with compatible properties - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - flatshading - Determines whether or not normal smoothing is applied - to the meshes, creating meshes with an angular, low- - poly look via flat reflections. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.isosurface.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - isomax - Sets the maximum boundary for iso-surface plot. - isomin - Sets the minimum boundary for iso-surface plot. - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - lighting - plotly.graph_objs.isosurface.Lighting instance or dict - with compatible properties - lightposition - plotly.graph_objs.isosurface.Lightposition instance or - dict with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the surface. Please note that in - the case of using high `opacity` values for example a - value greater than or equal to 0.5 on two surfaces (and - 0.25 with four surfaces), an overlay of multiple - transparent surfaces may not perfectly be sorted in - depth by the webgl API. This behavior may be improved - in the near future and is subject to change. - reversescale - Reverses the color mapping if true. If true, `cmin` - will correspond to the last color in the array and - `cmax` will correspond to the first color. - scene - Sets a reference between this trace's 3D coordinate - system and a 3D scene. If "scene" (the default value), - the (x,y,z) coordinates refer to `layout.scene`. If - "scene2", the (x,y,z) coordinates refer to - `layout.scene2`, and so on. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - slices - plotly.graph_objs.isosurface.Slices instance or dict - with compatible properties - spaceframe - plotly.graph_objs.isosurface.Spaceframe instance or - dict with compatible properties - stream - plotly.graph_objs.isosurface.Stream instance or dict - with compatible properties - surface - plotly.graph_objs.isosurface.Surface instance or dict - with compatible properties - text - Sets the text elements associated with the vertices. If - trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - value - Sets the 4th dimension (value) of the vertices. - valuesrc - Sets the source reference on plot.ly for value . - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the X coordinates of the vertices on X axis. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the Y coordinates of the vertices on Y axis. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the Z coordinates of the vertices on Z axis. - zsrc - Sets the source reference on plot.ly for z . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - caps=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - colorbar=None, - colorscale=None, - contour=None, - customdata=None, - customdatasrc=None, - flatshading=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - isomax=None, - isomin=None, - legendgroup=None, - lighting=None, - lightposition=None, - name=None, - opacity=None, - reversescale=None, - scene=None, - selectedpoints=None, - showlegend=None, - showscale=None, - slices=None, - spaceframe=None, - stream=None, - surface=None, - text=None, - textsrc=None, - uid=None, - uirevision=None, - value=None, - valuesrc=None, - visible=None, - x=None, - xsrc=None, - y=None, - ysrc=None, - z=None, - zsrc=None, - **kwargs - ): - """ - Construct a new Isosurface object - - Draws isosurfaces between iso-min and iso-max values with - coordinates given by four 1-dimensional arrays containing the - `value`, `x`, `y` and `z` of every vertex of a uniform or non- - uniform 3-D grid. Horizontal or vertical slices, caps as well - as spaceframe between iso-min and iso-max values could also be - drawn using this trace. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Isosurface - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - caps - plotly.graph_objs.isosurface.Caps instance or dict with - compatible properties - cauto - Determines whether or not the color domain is computed - with respect to the input data (here `value`) or the - bounds set in `cmin` and `cmax` Defaults to `false` - when `cmin` and `cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Value should - have the same units as `value` and if set, `cmin` must - be set as well. - cmid - Sets the mid-point of the color domain by scaling - `cmin` and/or `cmax` to be equidistant to this point. - Value should have the same units as `value`. Has no - effect when `cauto` is `false`. - cmin - Sets the lower bound of the color domain. Value should - have the same units as `value` and if set, `cmax` must - be set as well. - colorbar - plotly.graph_objs.isosurface.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - contour - plotly.graph_objs.isosurface.Contour instance or dict - with compatible properties - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - flatshading - Determines whether or not normal smoothing is applied - to the meshes, creating meshes with an angular, low- - poly look via flat reflections. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.isosurface.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - isomax - Sets the maximum boundary for iso-surface plot. - isomin - Sets the minimum boundary for iso-surface plot. - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - lighting - plotly.graph_objs.isosurface.Lighting instance or dict - with compatible properties - lightposition - plotly.graph_objs.isosurface.Lightposition instance or - dict with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the surface. Please note that in - the case of using high `opacity` values for example a - value greater than or equal to 0.5 on two surfaces (and - 0.25 with four surfaces), an overlay of multiple - transparent surfaces may not perfectly be sorted in - depth by the webgl API. This behavior may be improved - in the near future and is subject to change. - reversescale - Reverses the color mapping if true. If true, `cmin` - will correspond to the last color in the array and - `cmax` will correspond to the first color. - scene - Sets a reference between this trace's 3D coordinate - system and a 3D scene. If "scene" (the default value), - the (x,y,z) coordinates refer to `layout.scene`. If - "scene2", the (x,y,z) coordinates refer to - `layout.scene2`, and so on. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - slices - plotly.graph_objs.isosurface.Slices instance or dict - with compatible properties - spaceframe - plotly.graph_objs.isosurface.Spaceframe instance or - dict with compatible properties - stream - plotly.graph_objs.isosurface.Stream instance or dict - with compatible properties - surface - plotly.graph_objs.isosurface.Surface instance or dict - with compatible properties - text - Sets the text elements associated with the vertices. If - trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - value - Sets the 4th dimension (value) of the vertices. - valuesrc - Sets the source reference on plot.ly for value . - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the X coordinates of the vertices on X axis. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the Y coordinates of the vertices on Y axis. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the Z coordinates of the vertices on Z axis. - zsrc - Sets the source reference on plot.ly for z . - - Returns - ------- - Isosurface - """ - super(Isosurface, self).__init__('isosurface') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Isosurface -constructor must be a dict or -an instance of plotly.graph_objs.Isosurface""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (isosurface as v_isosurface) - - # Initialize validators - # --------------------- - self._validators['autocolorscale' - ] = v_isosurface.AutocolorscaleValidator() - self._validators['caps'] = v_isosurface.CapsValidator() - self._validators['cauto'] = v_isosurface.CautoValidator() - self._validators['cmax'] = v_isosurface.CmaxValidator() - self._validators['cmid'] = v_isosurface.CmidValidator() - self._validators['cmin'] = v_isosurface.CminValidator() - self._validators['colorbar'] = v_isosurface.ColorBarValidator() - self._validators['colorscale'] = v_isosurface.ColorscaleValidator() - self._validators['contour'] = v_isosurface.ContourValidator() - self._validators['customdata'] = v_isosurface.CustomdataValidator() - self._validators['customdatasrc' - ] = v_isosurface.CustomdatasrcValidator() - self._validators['flatshading'] = v_isosurface.FlatshadingValidator() - self._validators['hoverinfo'] = v_isosurface.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_isosurface.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_isosurface.HoverlabelValidator() - self._validators['hovertemplate' - ] = v_isosurface.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_isosurface.HovertemplatesrcValidator() - self._validators['hovertext'] = v_isosurface.HovertextValidator() - self._validators['hovertextsrc'] = v_isosurface.HovertextsrcValidator() - self._validators['ids'] = v_isosurface.IdsValidator() - self._validators['idssrc'] = v_isosurface.IdssrcValidator() - self._validators['isomax'] = v_isosurface.IsomaxValidator() - self._validators['isomin'] = v_isosurface.IsominValidator() - self._validators['legendgroup'] = v_isosurface.LegendgroupValidator() - self._validators['lighting'] = v_isosurface.LightingValidator() - self._validators['lightposition' - ] = v_isosurface.LightpositionValidator() - self._validators['name'] = v_isosurface.NameValidator() - self._validators['opacity'] = v_isosurface.OpacityValidator() - self._validators['reversescale'] = v_isosurface.ReversescaleValidator() - self._validators['scene'] = v_isosurface.SceneValidator() - self._validators['selectedpoints' - ] = v_isosurface.SelectedpointsValidator() - self._validators['showlegend'] = v_isosurface.ShowlegendValidator() - self._validators['showscale'] = v_isosurface.ShowscaleValidator() - self._validators['slices'] = v_isosurface.SlicesValidator() - self._validators['spaceframe'] = v_isosurface.SpaceframeValidator() - self._validators['stream'] = v_isosurface.StreamValidator() - self._validators['surface'] = v_isosurface.SurfaceValidator() - self._validators['text'] = v_isosurface.TextValidator() - self._validators['textsrc'] = v_isosurface.TextsrcValidator() - self._validators['uid'] = v_isosurface.UidValidator() - self._validators['uirevision'] = v_isosurface.UirevisionValidator() - self._validators['value'] = v_isosurface.ValueValidator() - self._validators['valuesrc'] = v_isosurface.ValuesrcValidator() - self._validators['visible'] = v_isosurface.VisibleValidator() - self._validators['x'] = v_isosurface.XValidator() - self._validators['xsrc'] = v_isosurface.XsrcValidator() - self._validators['y'] = v_isosurface.YValidator() - self._validators['ysrc'] = v_isosurface.YsrcValidator() - self._validators['z'] = v_isosurface.ZValidator() - self._validators['zsrc'] = v_isosurface.ZsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('caps', None) - self['caps'] = caps if caps is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('contour', None) - self['contour'] = contour if contour is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('flatshading', None) - self['flatshading'] = flatshading if flatshading is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('isomax', None) - self['isomax'] = isomax if isomax is not None else _v - _v = arg.pop('isomin', None) - self['isomin'] = isomin if isomin is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('lighting', None) - self['lighting'] = lighting if lighting is not None else _v - _v = arg.pop('lightposition', None) - self['lightposition' - ] = lightposition if lightposition is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('scene', None) - self['scene'] = scene if scene is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('slices', None) - self['slices'] = slices if slices is not None else _v - _v = arg.pop('spaceframe', None) - self['spaceframe'] = spaceframe if spaceframe is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('surface', None) - self['surface'] = surface if surface is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - _v = arg.pop('valuesrc', None) - self['valuesrc'] = valuesrc if valuesrc is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - _v = arg.pop('zsrc', None) - self['zsrc'] = zsrc if zsrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'isosurface' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='isosurface', val='isosurface' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_layout.py b/plotly/graph_objs/_layout.py deleted file mode 100644 index bb383e583b8..00000000000 --- a/plotly/graph_objs/_layout.py +++ /dev/null @@ -1,4862 +0,0 @@ -from plotly.basedatatypes import BaseLayoutType -import copy - - -class Layout(BaseLayoutType): - - # angularaxis - # ----------- - @property - def angularaxis(self): - """ - The 'angularaxis' property is an instance of AngularAxis - that may be specified as: - - An instance of 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. - endpadding - Legacy polar charts are deprecated! Please - switch to "polar" subplots. - range - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Defines the start - and end point of this angular axis. - showline - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Determines whether - or not the line bounding this angular axis will - be shown on the figure. - showticklabels - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Determines whether - or not the angular axis ticks will feature tick - labels. - tickcolor - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the color of - the tick lines on this angular axis. - ticklen - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the length of - the tick lines on this angular axis. - tickorientation - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the - orientation (from the paper perspective) of the - angular axis tick labels. - ticksuffix - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the length of - the tick lines on this angular axis. - visible - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Determines whether - or not this axis will be visible. - - Returns - ------- - plotly.graph_objs.layout.AngularAxis - """ - return self['angularaxis'] - - @angularaxis.setter - def angularaxis(self, val): - self['angularaxis'] = val - - # annotations - # ----------- - @property - def annotations(self): - """ - The 'annotations' property is a tuple of instances of - Annotation that may be specified as: - - A list or tuple of instances of plotly.graph_objs.layout.Annotation - - A list or tuple of dicts of string/value properties that - will be passed to the Annotation constructor - - Supported dict properties: - - align - Sets the horizontal alignment of the `text` - within the box. Has an effect only if `text` - spans more two or more lines (i.e. `text` - contains one or more
HTML tags) or if an - explicit width is set to override the text - width. - arrowcolor - Sets the color of the annotation arrow. - arrowhead - Sets the end annotation arrow head style. - arrowside - Sets the annotation arrow head position. - arrowsize - Sets the size of the end annotation arrow head, - relative to `arrowwidth`. A value of 1 - (default) gives a head about 3x as wide as the - line. - arrowwidth - Sets the width (in px) of annotation arrow - line. - ax - Sets the x component of the arrow tail about - the arrow head. If `axref` is `pixel`, a - positive (negative) component corresponds to - an arrow pointing from right to left (left to - right). If `axref` is an axis, this is an - absolute value on that axis, like `x`, NOT a - relative value. - axref - Indicates in what terms the tail of the - annotation (ax,ay) is specified. If `pixel`, - `ax` is a relative offset in pixels from `x`. - If set to an x axis id (e.g. "x" or "x2"), `ax` - is specified in the same terms as that axis. - This is useful for trendline annotations which - should continue to indicate the correct trend - when zoomed. - ay - Sets the y component of the arrow tail about - the arrow head. If `ayref` is `pixel`, a - positive (negative) component corresponds to - an arrow pointing from bottom to top (top to - bottom). If `ayref` is an axis, this is an - absolute value on that axis, like `y`, NOT a - relative value. - ayref - Indicates in what terms the tail of the - annotation (ax,ay) is specified. If `pixel`, - `ay` is a relative offset in pixels from `y`. - If set to a y axis id (e.g. "y" or "y2"), `ay` - is specified in the same terms as that axis. - This is useful for trendline annotations which - should continue to indicate the correct trend - when zoomed. - bgcolor - Sets the background color of the annotation. - bordercolor - Sets the color of the border enclosing the - annotation `text`. - borderpad - Sets the padding (in px) between the `text` and - the enclosing border. - borderwidth - Sets the width (in px) of the border enclosing - the annotation `text`. - captureevents - Determines whether the annotation text box - captures mouse move and click events, or allows - those events to pass through to data points in - the plot that may be behind the annotation. By - default `captureevents` is False unless - `hovertext` is provided. If you use the event - `plotly_clickannotation` without `hovertext` - you must explicitly enable `captureevents`. - clicktoshow - Makes this annotation respond to clicks on the - plot. If you click a data point that exactly - matches the `x` and `y` values of this - annotation, and it is hidden (visible: false), - it will appear. In "onoff" mode, you must click - the same point again to make it disappear, so - if you click multiple points, you can show - multiple annotations. In "onout" mode, a click - anywhere else in the plot (on another data - point or not) will hide this annotation. If you - need to show/hide this annotation in response - to different `x` or `y` values, you can set - `xclick` and/or `yclick`. This is useful for - example to label the side of a bar. To label - markers though, `standoff` is preferred over - `xclick` and `yclick`. - font - Sets the annotation text font. - height - Sets an explicit height for the text box. null - (default) lets the text set the box height. - Taller text will be clipped. - hoverlabel - plotly.graph_objs.layout.annotation.Hoverlabel - instance or dict with compatible properties - hovertext - Sets text to appear when hovering over this - annotation. If omitted or blank, no hover label - will appear. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - opacity - Sets the opacity of the annotation (text + - arrow). - showarrow - Determines whether or not the annotation is - drawn with an arrow. If True, `text` is placed - near the arrow's tail. If False, `text` lines - up with the `x` and `y` provided. - standoff - Sets a distance, in pixels, to move the end - arrowhead away from the position it is pointing - at, for example to point at the edge of a - marker independent of zoom. Note that this - shortens the arrow from the `ax` / `ay` vector, - in contrast to `xshift` / `yshift` which moves - everything by this amount. - startarrowhead - Sets the start annotation arrow head style. - startarrowsize - Sets the size of the start annotation arrow - head, relative to `arrowwidth`. A value of 1 - (default) gives a head about 3x as wide as the - line. - startstandoff - Sets a distance, in pixels, to move the start - arrowhead away from the position it is pointing - at, for example to point at the edge of a - marker independent of zoom. Note that this - shortens the arrow from the `ax` / `ay` vector, - in contrast to `xshift` / `yshift` which moves - everything by this amount. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - text - Sets the text associated with this annotation. - Plotly uses a subset of HTML tags to do things - like newline (
), bold (), italics - (), hyperlinks (). - Tags , , are also - supported. - textangle - Sets the angle at which the `text` is drawn - with respect to the horizontal. - valign - Sets the vertical alignment of the `text` - within the box. Has an effect only if an - explicit height is set to override the text - height. - visible - Determines whether or not this annotation is - visible. - width - Sets an explicit width for the text box. null - (default) lets the text set the box width. - Wider text will be clipped. There is no - automatic wrapping; use
to start a new - line. - x - Sets the annotation's x position. If the axis - `type` is "log", then you must take the log of - your desired range. If the axis `type` is - "date", it should be date strings, like date - data, though Date objects and unix milliseconds - will be accepted and converted to strings. If - the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order - it appears. - xanchor - Sets the text box's horizontal position anchor - This anchor binds the `x` position to the - "left", "center" or "right" of the annotation. - For example, if `x` is set to 1, `xref` to - "paper" and `xanchor` to "right" then the - right-most portion of the annotation lines up - with the right-most edge of the plotting area. - If "auto", the anchor is equivalent to "center" - for data-referenced annotations or if there is - an arrow, whereas for paper-referenced with no - arrow, the anchor picked corresponds to the - closest side. - xclick - Toggle this annotation when clicking a data - point whose `x` value is `xclick` rather than - the annotation's `x` value. - xref - Sets the annotation's x coordinate axis. If set - to an x axis id (e.g. "x" or "x2"), the `x` - position refers to an x coordinate If set to - "paper", the `x` position refers to the - distance from the left side of the plotting - area in normalized coordinates where 0 (1) - corresponds to the left (right) side. - xshift - Shifts the position of the whole annotation and - arrow to the right (positive) or left - (negative) by this many pixels. - y - Sets the annotation's y position. If the axis - `type` is "log", then you must take the log of - your desired range. If the axis `type` is - "date", it should be date strings, like date - data, though Date objects and unix milliseconds - will be accepted and converted to strings. If - the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order - it appears. - yanchor - Sets the text box's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the annotation. - For example, if `y` is set to 1, `yref` to - "paper" and `yanchor` to "top" then the top- - most portion of the annotation lines up with - the top-most edge of the plotting area. If - "auto", the anchor is equivalent to "middle" - for data-referenced annotations or if there is - an arrow, whereas for paper-referenced with no - arrow, the anchor picked corresponds to the - closest side. - yclick - Toggle this annotation when clicking a data - point whose `y` value is `yclick` rather than - the annotation's `y` value. - yref - Sets the annotation's y coordinate axis. If set - to an y axis id (e.g. "y" or "y2"), the `y` - position refers to an y coordinate If set to - "paper", the `y` position refers to the - distance from the bottom of the plotting area - in normalized coordinates where 0 (1) - corresponds to the bottom (top). - yshift - Shifts the position of the whole annotation and - arrow up (positive) or down (negative) by this - many pixels. - - Returns - ------- - tuple[plotly.graph_objs.layout.Annotation] - """ - return self['annotations'] - - @annotations.setter - def annotations(self, val): - self['annotations'] = val - - # annotationdefaults - # ------------------ - @property - 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 plotly.graph_objs.layout.Annotation - - A dict of string/value properties that will be passed - to the Annotation constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.layout.Annotation - """ - return self['annotationdefaults'] - - @annotationdefaults.setter - def annotationdefaults(self, val): - self['annotationdefaults'] = val - - # autosize - # -------- - @property - def autosize(self): - """ - Determines whether or not a layout width or height that has - been left undefined by the user is initialized on each - relayout. Note that, regardless of this attribute, an undefined - layout width or height is always initialized on the first call - to plot. - - The 'autosize' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autosize'] - - @autosize.setter - def autosize(self, val): - self['autosize'] = val - - # bargap - # ------ - @property - 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] - - Returns - ------- - int|float - """ - return self['bargap'] - - @bargap.setter - def bargap(self, val): - self['bargap'] = val - - # bargroupgap - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['bargroupgap'] - - @bargroupgap.setter - def bargroupgap(self, val): - self['bargroupgap'] = val - - # barmode - # ------- - @property - def barmode(self): - """ - Determines how bars at the same location coordinate are - displayed on the graph. With "stack", the bars are stacked on - top of one another With "relative", the bars are stacked on top - of one another, with negative values below the axis, positive - values above With "group", the bars are plotted next to one - another centered around the shared location. With "overlay", - the bars are plotted over one another, you might need to an - "opacity" to see multiple bars. - - The 'barmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['stack', 'group', 'overlay', 'relative'] - - Returns - ------- - Any - """ - return self['barmode'] - - @barmode.setter - def barmode(self, val): - self['barmode'] = val - - # barnorm - # ------- - @property - def barnorm(self): - """ - Sets the normalization for bar traces on the graph. With - "fraction", the value of each bar is divided by the sum of all - values at that location coordinate. "percent" is the same but - multiplied by 100 to show percentages. - - The 'barnorm' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['', 'fraction', 'percent'] - - Returns - ------- - Any - """ - return self['barnorm'] - - @barnorm.setter - def barnorm(self, val): - self['barnorm'] = val - - # boxgap - # ------ - @property - 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] - - Returns - ------- - int|float - """ - return self['boxgap'] - - @boxgap.setter - def boxgap(self, val): - self['boxgap'] = val - - # boxgroupgap - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['boxgroupgap'] - - @boxgroupgap.setter - def boxgroupgap(self, val): - self['boxgroupgap'] = val - - # boxmode - # ------- - @property - def boxmode(self): - """ - Determines how boxes at the same location coordinate are - displayed on the graph. If "group", the boxes are plotted next - to one another centered around the shared location. If - "overlay", the boxes are plotted over one another, you might - need to set "opacity" to see them multiple boxes. Has no effect - on traces that have "width" set. - - The 'boxmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['group', 'overlay'] - - Returns - ------- - Any - """ - return self['boxmode'] - - @boxmode.setter - def boxmode(self, val): - self['boxmode'] = val - - # calendar - # -------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['calendar'] - - @calendar.setter - def calendar(self, val): - self['calendar'] = val - - # clickmode - # --------- - @property - def clickmode(self): - """ - Determines the mode of single click interactions. "event" is - the default value and emits the `plotly_click` event. In - addition this mode emits the `plotly_selected` event in drag - modes "lasso" and "select", but with no event data attached - (kept for compatibility reasons). The "select" flag enables - selecting single data points via click. This mode also supports - persistent selections, meaning that pressing Shift while - clicking, adds to / subtracts from an existing selection. - "select" with `hovermode`: "x" can be confusing, consider - explicitly setting `hovermode`: "closest" when using this - feature. Selection events are sent accordingly as long as - "event" flag is set as well. When the "event" flag is missing, - `plotly_click` and `plotly_selected` events are not fired. - - The 'clickmode' property is a flaglist and may be specified - as a string containing: - - Any combination of ['event', 'select'] joined with '+' characters - (e.g. 'event+select') - OR exactly one of ['none'] (e.g. 'none') - - Returns - ------- - Any - """ - return self['clickmode'] - - @clickmode.setter - def clickmode(self, val): - self['clickmode'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - The 'colorscale' property is an instance of Colorscale - that may be specified as: - - An instance of plotly.graph_objs.layout.Colorscale - - A dict of string/value properties that will be passed - to the Colorscale constructor - - Supported dict properties: - - diverging - Sets the default diverging colorscale. Note - that `autocolorscale` must be true for this - attribute to work. - sequential - Sets the default sequential colorscale for - positive values. Note that `autocolorscale` - must be true for this attribute to work. - sequentialminus - Sets the default sequential colorscale for - negative values. Note that `autocolorscale` - must be true for this attribute to work. - - Returns - ------- - plotly.graph_objs.layout.Colorscale - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorway - # -------- - @property - 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 - - Returns - ------- - list - """ - return self['colorway'] - - @colorway.setter - def colorway(self, val): - self['colorway'] = val - - # datarevision - # ------------ - @property - def datarevision(self): - """ - If provided, a changed value tells `Plotly.react` that one or - more data arrays has changed. This way you can modify arrays - in-place rather than making a complete new copy for an - incremental change. If NOT provided, `Plotly.react` assumes - that data arrays are being treated as immutable, thus any data - array with a different identity from its predecessor contains - new data. - - The 'datarevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['datarevision'] - - @datarevision.setter - def datarevision(self, val): - self['datarevision'] = val - - # direction - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['direction'] - - @direction.setter - def direction(self, val): - self['direction'] = val - - # dragmode - # -------- - @property - 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', 'orbit', 'turntable', - False] - - Returns - ------- - Any - """ - return self['dragmode'] - - @dragmode.setter - def dragmode(self, val): - self['dragmode'] = val - - # editrevision - # ------------ - @property - 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 - ------- - Any - """ - return self['editrevision'] - - @editrevision.setter - def editrevision(self, val): - self['editrevision'] = val - - # extendpiecolors - # --------------- - @property - def extendpiecolors(self): - """ - If `true`, the pie slice colors (whether given by `piecolorway` - or inherited from `colorway`) will be extended to three times - its original length by first repeating every color 20% lighter - then each color 20% darker. This is intended to reduce the - likelihood of reusing the same color when you have many slices, - but you can set `false` to disable. Colors provided in the - trace, using `marker.colors`, are never extended. - - The 'extendpiecolors' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['extendpiecolors'] - - @extendpiecolors.setter - def extendpiecolors(self, val): - self['extendpiecolors'] = val - - # font - # ---- - @property - 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 plotly.graph_objs.layout.Font - - A dict of string/value properties that will be passed - to the Font constructor - - Supported dict properties: - - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # geo - # --- - @property - def geo(self): - """ - The 'geo' property is an instance of Geo - that may be specified as: - - An instance of 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 - plotly.graph_objs.layout.geo.Center instance or - dict with compatible properties - coastlinecolor - Sets the coastline color. - coastlinewidth - Sets the coastline stroke width (in px). - countrycolor - Sets line color of the country boundaries. - countrywidth - Sets line width (in px) of the country - boundaries. - domain - plotly.graph_objs.layout.geo.Domain instance or - dict with compatible properties - framecolor - Sets the color the frame. - framewidth - Sets the stroke width (in px) of the frame. - lakecolor - Sets the color of the lakes. - landcolor - Sets the land mass color. - lataxis - plotly.graph_objs.layout.geo.Lataxis instance - or dict with compatible properties - lonaxis - plotly.graph_objs.layout.geo.Lonaxis instance - or dict with compatible properties - oceancolor - Sets the ocean color - projection - plotly.graph_objs.layout.geo.Projection - instance or dict with compatible properties - resolution - Sets the resolution of the base layers. The - values have units of km/mm e.g. 110 corresponds - to a scale ratio of 1:110,000,000. - rivercolor - Sets color of the rivers. - riverwidth - Sets the stroke width (in px) of the rivers. - scope - Set the scope of the map. - showcoastlines - Sets whether or not the coastlines are drawn. - showcountries - Sets whether or not country boundaries are - drawn. - showframe - Sets whether or not a frame is drawn around the - map. - showlakes - Sets whether or not lakes are drawn. - showland - Sets whether or not land masses are filled in - color. - showocean - Sets whether or not oceans are filled in color. - showrivers - Sets whether or not rivers are drawn. - showsubunits - Sets whether or not boundaries of subunits - within countries (e.g. states, provinces) are - drawn. - subunitcolor - Sets the color of the subunits boundaries. - subunitwidth - Sets the stroke width (in px) of the subunits - boundaries. - uirevision - Controls persistence of user-driven changes in - the view (projection and center). Defaults to - `layout.uirevision`. - - Returns - ------- - plotly.graph_objs.layout.Geo - """ - return self['geo'] - - @geo.setter - def geo(self, val): - self['geo'] = val - - # grid - # ---- - @property - def grid(self): - """ - The 'grid' property is an instance of Grid - that may be specified as: - - An instance of plotly.graph_objs.layout.Grid - - A dict of string/value properties that will be passed - to the Grid constructor - - Supported dict properties: - - columns - The number of columns in the grid. If you - provide a 2D `subplots` array, the length of - its longest row is used as the default. If you - give an `xaxes` array, its length is used as - the default. But it's also possible to have a - different length, if you want to leave a row at - the end for non-cartesian subplots. - domain - plotly.graph_objs.layout.grid.Domain instance - or dict with compatible properties - pattern - If no `subplots`, `xaxes`, or `yaxes` are given - but we do have `rows` and `columns`, we can - generate defaults using consecutive axis IDs, - in two ways: "coupled" gives one x axis per - column and one y axis per row. "independent" - uses a new xy pair for each cell, left-to-right - across each row then iterating rows according - to `roworder`. - roworder - Is the first row the top or the bottom? Note - that columns are always enumerated from left to - right. - rows - The number of rows in the grid. If you provide - a 2D `subplots` array or a `yaxes` array, its - length is used as the default. But it's also - possible to have a different length, if you - want to leave a row at the end for non- - cartesian subplots. - subplots - Used for freeform grids, where some axes may be - shared across subplots but others are not. Each - entry should be a cartesian subplot id, like - "xy" or "x3y2", or "" to leave that cell empty. - You may reuse x axes within the same column, - and y axes within the same row. Non-cartesian - subplots and traces that support `domain` can - place themselves in this grid separately using - the `gridcell` attribute. - xaxes - Used with `yaxes` when the x and y axes are - shared across columns and rows. Each entry - should be an x axis id like "x", "x2", etc., or - "" to not put an x axis in that column. Entries - other than "" must be unique. Ignored if - `subplots` is present. If missing but `yaxes` - is present, will generate consecutive IDs. - xgap - Horizontal space between grid cells, expressed - as a fraction of the total width available to - one cell. Defaults to 0.1 for coupled-axes - grids and 0.2 for independent grids. - xside - Sets where the x axis labels and titles go. - "bottom" means the very bottom of the grid. - "bottom plot" is the lowest plot that each x - axis is used in. "top" and "top plot" are - similar. - yaxes - Used with `yaxes` when the x and y axes are - shared across columns and rows. Each entry - should be an y axis id like "y", "y2", etc., or - "" to not put a y axis in that row. Entries - other than "" must be unique. Ignored if - `subplots` is present. If missing but `xaxes` - is present, will generate consecutive IDs. - ygap - Vertical space between grid cells, expressed as - a fraction of the total height available to one - cell. Defaults to 0.1 for coupled-axes grids - and 0.3 for independent grids. - yside - Sets where the y axis labels and titles go. - "left" means the very left edge of the grid. - *left plot* is the leftmost plot that each y - axis is used in. "right" and *right plot* are - similar. - - Returns - ------- - plotly.graph_objs.layout.Grid - """ - return self['grid'] - - @grid.setter - def grid(self, val): - self['grid'] = val - - # height - # ------ - @property - 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] - - Returns - ------- - int|float - """ - return self['height'] - - @height.setter - def height(self, val): - self['height'] = val - - # hiddenlabels - # ------------ - @property - def hiddenlabels(self): - """ - The 'hiddenlabels' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['hiddenlabels'] - - @hiddenlabels.setter - def hiddenlabels(self, val): - self['hiddenlabels'] = val - - # hiddenlabelssrc - # --------------- - @property - def hiddenlabelssrc(self): - """ - Sets the source reference on plot.ly for hiddenlabels . - - The 'hiddenlabelssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hiddenlabelssrc'] - - @hiddenlabelssrc.setter - def hiddenlabelssrc(self, val): - self['hiddenlabelssrc'] = val - - # hidesources - # ----------- - @property - def hidesources(self): - """ - Determines whether or not a text link citing the data source is - placed at the bottom-right cored of the figure. Has only an - effect only on graphs that have been generated via forked - graphs from the plotly service (at https://plot.ly or on- - premise). - - The 'hidesources' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['hidesources'] - - @hidesources.setter - def hidesources(self, val): - self['hidesources'] = val - - # hoverdistance - # ------------- - @property - def hoverdistance(self): - """ - Sets the default distance (in pixels) to look for data to add - hover labels (-1 means no cutoff, 0 means no looking for data). - This is only a real distance for hovering on point-like - objects, like scatter points. For area-like objects (bars, - scatter fills, etc) hovering is on inside the area and off - outside, but these objects will not supersede hover on point- - like objects in case of conflict. - - The 'hoverdistance' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [-1, 9223372036854775807] - - Returns - ------- - int - """ - return self['hoverdistance'] - - @hoverdistance.setter - def hoverdistance(self, val): - self['hoverdistance'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.layout.Hoverlabel - - A dict of string/value properties that will be passed - to the Hoverlabel constructor - - Supported dict properties: - - bgcolor - Sets the background color of all hover labels - on graph - bordercolor - Sets the border color of all hover labels on - graph. - font - Sets the default hover label font used by all - traces on the graph. - namelength - Sets the default length (in number of - characters) of the trace name in the hover - labels for all traces. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 - characters, and an integer >3 will show the - whole name if it is less than that many - characters, but if it is longer, will truncate - to `namelength - 3` characters and add an - ellipsis. - - Returns - ------- - plotly.graph_objs.layout.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovermode - # --------- - @property - def hovermode(self): - """ - Determines the mode of hover interactions. If `clickmode` - includes the "select" flag, `hovermode` defaults to "closest". - If `clickmode` lacks the "select" flag, it defaults to "x" or - "y" (depending on the trace's `orientation` value) for plots - based on cartesian coordinates. For anything else the default - value is "closest". - - The 'hovermode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['x', 'y', 'closest', False] - - Returns - ------- - Any - """ - return self['hovermode'] - - @hovermode.setter - def hovermode(self, val): - self['hovermode'] = val - - # images - # ------ - @property - def images(self): - """ - The 'images' property is a tuple of instances of - Image that may be specified as: - - A list or tuple of instances of plotly.graph_objs.layout.Image - - A list or tuple of dicts of string/value properties that - will be passed to the Image constructor - - Supported dict properties: - - layer - Specifies whether images are drawn below or - above traces. When `xref` and `yref` are both - set to `paper`, image is drawn below the entire - plot area. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - opacity - Sets the opacity of the image. - sizex - Sets the image container size horizontally. The - image will be sized based on the `position` - value. When `xref` is set to `paper`, units are - sized relative to the plot width. - sizey - Sets the image container size vertically. The - image will be sized based on the `position` - value. When `yref` is set to `paper`, units are - sized relative to the plot height. - sizing - Specifies which dimension of the image to - constrain. - source - Specifies the URL of the image to be used. The - URL must be accessible from the domain where - the plot code is run, and can be either - relative or absolute. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - visible - Determines whether or not this image is - visible. - x - Sets the image's x position. When `xref` is set - to `paper`, units are sized relative to the - plot height. See `xref` for more info - xanchor - Sets the anchor for the x position - xref - Sets the images's x coordinate axis. If set to - a x axis id (e.g. "x" or "x2"), the `x` - position refers to an x data coordinate If set - to "paper", the `x` position refers to the - distance from the left of plot in normalized - coordinates where 0 (1) corresponds to the left - (right). - y - Sets the image's y position. When `yref` is set - to `paper`, units are sized relative to the - plot height. See `yref` for more info - yanchor - Sets the anchor for the y position. - yref - Sets the images's y coordinate axis. If set to - a y axis id (e.g. "y" or "y2"), the `y` - position refers to a y data coordinate. If set - to "paper", the `y` position refers to the - distance from the bottom of the plot in - normalized coordinates where 0 (1) corresponds - to the bottom (top). - - Returns - ------- - tuple[plotly.graph_objs.layout.Image] - """ - return self['images'] - - @images.setter - def images(self, val): - self['images'] = val - - # imagedefaults - # ------------- - @property - 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 plotly.graph_objs.layout.Image - - A dict of string/value properties that will be passed - to the Image constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.layout.Image - """ - return self['imagedefaults'] - - @imagedefaults.setter - def imagedefaults(self, val): - self['imagedefaults'] = val - - # legend - # ------ - @property - def legend(self): - """ - The 'legend' property is an instance of Legend - that may be specified as: - - An instance of 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. - bordercolor - Sets the color of the border enclosing the - legend. - borderwidth - Sets the width (in px) of the border enclosing - the legend. - font - Sets the font used to text the legend items. - orientation - Sets the orientation of the legend. - tracegroupgap - Sets the amount of vertical space (in px) - between legend groups. - traceorder - Determines the order at which the legend items - are displayed. If "normal", the items are - displayed top-to-bottom in the same order as - the input data. If "reversed", the items are - displayed in the opposite order as "normal". If - "grouped", the items are displayed in groups - (when a trace `legendgroup` is provided). if - "grouped+reversed", the items are displayed in - the opposite order as "grouped". - uirevision - Controls persistence of legend-driven changes - in trace and pie label visibility. Defaults to - `layout.uirevision`. - valign - Sets the vertical alignment of the symbols with - respect to their associated text. - x - Sets the x position (in normalized coordinates) - of the legend. - xanchor - Sets the legend's horizontal position anchor. - This anchor binds the `x` position to the - "left", "center" or "right" of the legend. - y - Sets the y position (in normalized coordinates) - of the legend. - yanchor - Sets the legend's vertical position anchor This - anchor binds the `y` position to the "top", - "middle" or "bottom" of the legend. - - Returns - ------- - plotly.graph_objs.layout.Legend - """ - return self['legend'] - - @legend.setter - def legend(self, val): - self['legend'] = val - - # mapbox - # ------ - @property - def mapbox(self): - """ - The 'mapbox' property is an instance of Mapbox - that may be specified as: - - An instance of plotly.graph_objs.layout.Mapbox - - A dict of string/value properties that will be passed - to the Mapbox constructor - - Supported dict properties: - - accesstoken - Sets the mapbox access token to be used for - this mapbox map. Alternatively, the mapbox - access token can be set in the configuration - options under `mapboxAccessToken`. - bearing - Sets the bearing angle of the map in degrees - counter-clockwise from North (mapbox.bearing). - center - plotly.graph_objs.layout.mapbox.Center instance - or dict with compatible properties - domain - plotly.graph_objs.layout.mapbox.Domain instance - or dict with compatible properties - layers - plotly.graph_objs.layout.mapbox.Layer instance - or dict with compatible properties - layerdefaults - When used in a template (as - layout.template.layout.mapbox.layerdefaults), - sets the default property values to use for - elements of layout.mapbox.layers - pitch - Sets the pitch angle of the map (in degrees, - where 0 means perpendicular to the surface of - the map) (mapbox.pitch). - style - Sets the Mapbox map style. Either input one of - the default Mapbox style names or the URL to a - custom style or a valid Mapbox style JSON. - uirevision - Controls persistence of user-driven changes in - the view: `center`, `zoom`, `bearing`, `pitch`. - Defaults to `layout.uirevision`. - zoom - Sets the zoom level of the map (mapbox.zoom). - - Returns - ------- - plotly.graph_objs.layout.Mapbox - """ - return self['mapbox'] - - @mapbox.setter - def mapbox(self, val): - self['mapbox'] = val - - # margin - # ------ - @property - def margin(self): - """ - The 'margin' property is an instance of Margin - that may be specified as: - - An instance of plotly.graph_objs.layout.Margin - - A dict of string/value properties that will be passed - to the Margin constructor - - Supported dict properties: - - autoexpand - - b - Sets the bottom margin (in px). - l - Sets the left margin (in px). - pad - Sets the amount of padding (in px) between the - plotting area and the axis lines - r - Sets the right margin (in px). - t - Sets the top margin (in px). - - Returns - ------- - plotly.graph_objs.layout.Margin - """ - return self['margin'] - - @margin.setter - def margin(self, val): - self['margin'] = val - - # meta - # ---- - @property - def meta(self): - """ - Assigns extra meta information that can be used in various - `text` attributes. Attributes such as the graph, axis and - colorbar `title.text`, annotation `text` `trace.name` in legend - items, `rangeselector`, `updatemenues` and `sliders` `label` - text all support `meta`. One can access `meta` fields using - template strings: `%{meta[i]}` where `i` is the index of the - `meta` item in question. - - The 'meta' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['meta'] - - @meta.setter - def meta(self, val): - self['meta'] = val - - # metasrc - # ------- - @property - def metasrc(self): - """ - Sets the source reference on plot.ly for meta . - - The 'metasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['metasrc'] - - @metasrc.setter - def metasrc(self, val): - self['metasrc'] = val - - # modebar - # ------- - @property - def modebar(self): - """ - The 'modebar' property is an instance of Modebar - that may be specified as: - - An instance of 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. - bgcolor - Sets the background color of the modebar. - color - Sets the color of the icons in the modebar. - orientation - Sets the orientation of the modebar. - uirevision - Controls persistence of user-driven changes - related to the modebar, including `hovermode`, - `dragmode`, and `showspikes` at both the root - level and inside subplots. Defaults to - `layout.uirevision`. - - Returns - ------- - plotly.graph_objs.layout.Modebar - """ - return self['modebar'] - - @modebar.setter - def modebar(self, val): - self['modebar'] = val - - # orientation - # ----------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['orientation'] - - @orientation.setter - def orientation(self, val): - self['orientation'] = val - - # paper_bgcolor - # ------------- - @property - def paper_bgcolor(self): - """ - Sets the color of paper where the graph is drawn. - - The 'paper_bgcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['paper_bgcolor'] - - @paper_bgcolor.setter - def paper_bgcolor(self, val): - self['paper_bgcolor'] = val - - # piecolorway - # ----------- - @property - def piecolorway(self): - """ - Sets the default pie slice colors. Defaults to the main - `colorway` used for trace colors. If you specify a new list - here it can still be extended with lighter and darker colors, - see `extendpiecolors`. - - The 'piecolorway' property is a colorlist that may be specified - as a tuple, list, one-dimensional numpy array, or pandas Series of valid - color strings - - Returns - ------- - list - """ - return self['piecolorway'] - - @piecolorway.setter - def piecolorway(self, val): - self['piecolorway'] = val - - # plot_bgcolor - # ------------ - @property - def plot_bgcolor(self): - """ - Sets the color of plotting area in-between x and y axes. - - The 'plot_bgcolor' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['plot_bgcolor'] - - @plot_bgcolor.setter - def plot_bgcolor(self, val): - self['plot_bgcolor'] = val - - # polar - # ----- - @property - def polar(self): - """ - The 'polar' property is an instance of Polar - that may be specified as: - - An instance of plotly.graph_objs.layout.Polar - - A dict of string/value properties that will be passed - to the Polar constructor - - Supported dict properties: - - angularaxis - plotly.graph_objs.layout.polar.AngularAxis - instance or dict with compatible properties - bargap - Sets the gap between bars of adjacent location - coordinates. Values are unitless, they - represent fractions of the minimum difference - in bar positions in the data. - barmode - Determines how bars at the same location - coordinate are displayed on the graph. With - "stack", the bars are stacked on top of one - another With "overlay", the bars are plotted - over one another, you might need to an - "opacity" to see multiple bars. - bgcolor - Set the background color of the subplot - domain - plotly.graph_objs.layout.polar.Domain instance - or dict with compatible properties - gridshape - Determines if the radial axis grid lines and - angular axis line are drawn as "circular" - sectors or as "linear" (polygon) sectors. Has - an effect only when the angular axis has `type` - "category". Note that `radialaxis.angle` is - snapped to the angle of the closest vertex when - `gridshape` is "circular" (so that radial axis - scale is the same as the data scale). - hole - Sets the fraction of the radius to cut out of - the polar subplot. - radialaxis - plotly.graph_objs.layout.polar.RadialAxis - instance or dict with compatible properties - sector - Sets angular span of this polar subplot with - two angles (in degrees). Sector are assumed to - be spanned in the counterclockwise direction - with 0 corresponding to rightmost limit of the - polar subplot. - uirevision - Controls persistence of user-driven changes in - axis attributes, if not overridden in the - individual axes. Defaults to - `layout.uirevision`. - - Returns - ------- - plotly.graph_objs.layout.Polar - """ - return self['polar'] - - @polar.setter - def polar(self, val): - self['polar'] = val - - # radialaxis - # ---------- - @property - def radialaxis(self): - """ - The 'radialaxis' property is an instance of RadialAxis - that may be specified as: - - An instance of 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. - endpadding - Legacy polar charts are deprecated! Please - switch to "polar" subplots. - orientation - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the - orientation (an angle with respect to the - origin) of the radial axis. - range - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Defines the start - and end point of this radial axis. - showline - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Determines whether - or not the line bounding this radial axis will - be shown on the figure. - showticklabels - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Determines whether - or not the radial axis ticks will feature tick - labels. - tickcolor - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the color of - the tick lines on this radial axis. - ticklen - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the length of - the tick lines on this radial axis. - tickorientation - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the - orientation (from the paper perspective) of the - radial axis tick labels. - ticksuffix - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the length of - the tick lines on this radial axis. - visible - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Determines whether - or not this axis will be visible. - - Returns - ------- - plotly.graph_objs.layout.RadialAxis - """ - return self['radialaxis'] - - @radialaxis.setter - def radialaxis(self, val): - self['radialaxis'] = val - - # scene - # ----- - @property - def scene(self): - """ - The 'scene' property is an instance of Scene - that may be specified as: - - An instance of plotly.graph_objs.layout.Scene - - A dict of string/value properties that will be passed - to the Scene constructor - - Supported dict properties: - - annotations - plotly.graph_objs.layout.scene.Annotation - instance or dict with compatible properties - annotationdefaults - When used in a template (as layout.template.lay - out.scene.annotationdefaults), sets the default - property values to use for elements of - layout.scene.annotations - aspectmode - If "cube", this scene's axes are drawn as a - cube, regardless of the axes' ranges. If - "data", this scene's axes are drawn in - proportion with the axes' ranges. If "manual", - this scene's axes are drawn in proportion with - the input of "aspectratio" (the default - behavior if "aspectratio" is provided). If - "auto", this scene's axes are drawn using the - results of "data" except when one axis is more - than four times the size of the two others, - where in that case the results of "cube" are - used. - aspectratio - Sets this scene's axis aspectratio. - bgcolor - - camera - plotly.graph_objs.layout.scene.Camera instance - or dict with compatible properties - domain - plotly.graph_objs.layout.scene.Domain instance - or dict with compatible properties - dragmode - Determines the mode of drag interactions for - this scene. - hovermode - Determines the mode of hover interactions for - this scene. - uirevision - Controls persistence of user-driven changes in - camera attributes. Defaults to - `layout.uirevision`. - xaxis - plotly.graph_objs.layout.scene.XAxis instance - or dict with compatible properties - yaxis - plotly.graph_objs.layout.scene.YAxis instance - or dict with compatible properties - zaxis - plotly.graph_objs.layout.scene.ZAxis instance - or dict with compatible properties - - Returns - ------- - plotly.graph_objs.layout.Scene - """ - return self['scene'] - - @scene.setter - def scene(self, val): - self['scene'] = val - - # selectdirection - # --------------- - @property - def selectdirection(self): - """ - When "dragmode" is set to "select", this limits the selection - of the drag to horizontal, vertical or diagonal. "h" only - allows horizontal selection, "v" only vertical, "d" only - diagonal and "any" sets no limit. - - The 'selectdirection' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['h', 'v', 'd', 'any'] - - Returns - ------- - Any - """ - return self['selectdirection'] - - @selectdirection.setter - def selectdirection(self, val): - self['selectdirection'] = val - - # selectionrevision - # ----------------- - @property - def selectionrevision(self): - """ - Controls persistence of user-driven changes in selected points - from all traces. - - The 'selectionrevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectionrevision'] - - @selectionrevision.setter - def selectionrevision(self, val): - self['selectionrevision'] = val - - # separators - # ---------- - @property - def separators(self): - """ - Sets the decimal and thousand separators. For example, *. * - puts a '.' before decimals and a space between thousands. In - English locales, dflt is ".," but other locales may alter this - default. - - The 'separators' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['separators'] - - @separators.setter - def separators(self, val): - self['separators'] = val - - # shapes - # ------ - @property - def shapes(self): - """ - The 'shapes' property is a tuple of instances of - Shape that may be specified as: - - A list or tuple of instances of plotly.graph_objs.layout.Shape - - A list or tuple of dicts of string/value properties that - will be passed to the Shape constructor - - Supported dict properties: - - fillcolor - Sets the color filling the shape's interior. - layer - Specifies whether shapes are drawn below or - above traces. - line - plotly.graph_objs.layout.shape.Line instance or - dict with compatible properties - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - opacity - Sets the opacity of the shape. - path - For `type` "path" - a valid SVG path with the - pixel values replaced by data values in - `xsizemode`/`ysizemode` being "scaled" and - taken unmodified as pixels relative to - `xanchor` and `yanchor` in case of "pixel" size - mode. There are a few restrictions / quirks - only absolute instructions, not relative. So - the allowed segments are: M, L, H, V, Q, C, T, - S, and Z arcs (A) are not allowed because - radius rx and ry are relative. In the future we - could consider supporting relative commands, - but we would have to decide on how to handle - date and log axes. Note that even as is, Q and - C Bezier paths that are smooth on linear axes - may not be smooth on log, and vice versa. no - chained "polybezier" commands - specify the - segment type for each one. On category axes, - values are numbers scaled to the serial numbers - of categories because using the categories - themselves there would be no way to describe - fractional positions On data axes: because - space and T are both normal components of path - strings, we can't use either to separate date - from time parts. Therefore we'll use underscore - for this purpose: 2015-02-21_13:45:56.789 - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - type - Specifies the shape type to be drawn. If - "line", a line is drawn from (`x0`,`y0`) to - (`x1`,`y1`) with respect to the axes' sizing - mode. If "circle", a circle is drawn from - ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius - (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 - -`y0`)|) with respect to the axes' sizing mode. - If "rect", a rectangle is drawn linking - (`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`), - (`x0`,`y1`), (`x0`,`y0`) with respect to the - axes' sizing mode. If "path", draw a custom SVG - path using `path`. with respect to the axes' - sizing mode. - visible - Determines whether or not this shape is - visible. - x0 - Sets the shape's starting x position. See - `type` and `xsizemode` for more info. - x1 - Sets the shape's end x position. See `type` and - `xsizemode` for more info. - xanchor - Only relevant in conjunction with `xsizemode` - set to "pixel". Specifies the anchor point on - the x axis to which `x0`, `x1` and x - coordinates within `path` are relative to. E.g. - useful to attach a pixel sized shape to a - certain data value. No effect when `xsizemode` - not set to "pixel". - xref - Sets the shape's x coordinate axis. If set to - an x axis id (e.g. "x" or "x2"), the `x` - position refers to an x coordinate. If set to - "paper", the `x` position refers to the - distance from the left side of the plotting - area in normalized coordinates where 0 (1) - corresponds to the left (right) side. If the - axis `type` is "log", then you must take the - log of your desired range. If the axis `type` - is "date", then you must convert the date to - unix time in milliseconds. - xsizemode - Sets the shapes's sizing mode along the x axis. - If set to "scaled", `x0`, `x1` and x - coordinates within `path` refer to data values - on the x axis or a fraction of the plot area's - width (`xref` set to "paper"). If set to - "pixel", `xanchor` specifies the x position in - terms of data or plot fraction but `x0`, `x1` - and x coordinates within `path` are pixels - relative to `xanchor`. This way, the shape can - have a fixed width while maintaining a position - relative to data or plot fraction. - y0 - Sets the shape's starting y position. See - `type` and `ysizemode` for more info. - y1 - Sets the shape's end y position. See `type` and - `ysizemode` for more info. - yanchor - Only relevant in conjunction with `ysizemode` - set to "pixel". Specifies the anchor point on - the y axis to which `y0`, `y1` and y - coordinates within `path` are relative to. E.g. - useful to attach a pixel sized shape to a - certain data value. No effect when `ysizemode` - not set to "pixel". - yref - Sets the annotation's y coordinate axis. If set - to an y axis id (e.g. "y" or "y2"), the `y` - position refers to an y coordinate If set to - "paper", the `y` position refers to the - distance from the bottom of the plotting area - in normalized coordinates where 0 (1) - corresponds to the bottom (top). - ysizemode - Sets the shapes's sizing mode along the y axis. - If set to "scaled", `y0`, `y1` and y - coordinates within `path` refer to data values - on the y axis or a fraction of the plot area's - height (`yref` set to "paper"). If set to - "pixel", `yanchor` specifies the y position in - terms of data or plot fraction but `y0`, `y1` - and y coordinates within `path` are pixels - relative to `yanchor`. This way, the shape can - have a fixed height while maintaining a - position relative to data or plot fraction. - - Returns - ------- - tuple[plotly.graph_objs.layout.Shape] - """ - return self['shapes'] - - @shapes.setter - def shapes(self, val): - self['shapes'] = val - - # shapedefaults - # ------------- - @property - 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 plotly.graph_objs.layout.Shape - - A dict of string/value properties that will be passed - to the Shape constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.layout.Shape - """ - return self['shapedefaults'] - - @shapedefaults.setter - def shapedefaults(self, val): - self['shapedefaults'] = val - - # showlegend - # ---------- - @property - def showlegend(self): - """ - Determines whether or not a legend is drawn. Default is `true` - if there is a trace to show and any of these: a) Two or more - traces would by default be shown in the legend. b) One pie - trace is shown in the legend. c) One trace is explicitly given - with `showlegend: true`. - - The 'showlegend' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # sliders - # ------- - @property - def sliders(self): - """ - The 'sliders' property is a tuple of instances of - Slider that may be specified as: - - A list or tuple of instances of plotly.graph_objs.layout.Slider - - A list or tuple of dicts of string/value properties that - will be passed to the Slider constructor - - Supported dict properties: - - active - Determines which button (by index starting from - 0) is considered active. - activebgcolor - Sets the background color of the slider grip - while dragging. - bgcolor - Sets the background color of the slider. - bordercolor - Sets the color of the border enclosing the - slider. - borderwidth - Sets the width (in px) of the border enclosing - the slider. - currentvalue - plotly.graph_objs.layout.slider.Currentvalue - instance or dict with compatible properties - font - Sets the font of the slider step labels. - len - Sets the length of the slider This measure - excludes the padding of both ends. That is, the - slider's length is this length minus the - padding on both ends. - lenmode - Determines whether this slider length is set in - units of plot "fraction" or in *pixels. Use - `len` to set the value. - minorticklen - Sets the length in pixels of minor step tick - marks - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - pad - Set the padding of the slider component along - each side. - steps - plotly.graph_objs.layout.slider.Step instance - or dict with compatible properties - stepdefaults - When used in a template (as - layout.template.layout.slider.stepdefaults), - sets the default property values to use for - elements of layout.slider.steps - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - tickcolor - Sets the color of the border enclosing the - slider. - ticklen - Sets the length in pixels of step tick marks - tickwidth - Sets the tick width (in px). - transition - plotly.graph_objs.layout.slider.Transition - instance or dict with compatible properties - visible - Determines whether or not the slider is - visible. - x - Sets the x position (in normalized coordinates) - of the slider. - xanchor - Sets the slider's horizontal position anchor. - This anchor binds the `x` position to the - "left", "center" or "right" of the range - selector. - y - Sets the y position (in normalized coordinates) - of the slider. - yanchor - Sets the slider's vertical position anchor This - anchor binds the `y` position to the "top", - "middle" or "bottom" of the range selector. - - Returns - ------- - tuple[plotly.graph_objs.layout.Slider] - """ - return self['sliders'] - - @sliders.setter - def sliders(self, val): - self['sliders'] = val - - # sliderdefaults - # -------------- - @property - 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 plotly.graph_objs.layout.Slider - - A dict of string/value properties that will be passed - to the Slider constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.layout.Slider - """ - return self['sliderdefaults'] - - @sliderdefaults.setter - def sliderdefaults(self, val): - self['sliderdefaults'] = val - - # spikedistance - # ------------- - @property - def spikedistance(self): - """ - Sets the default distance (in pixels) to look for data to draw - spikelines to (-1 means no cutoff, 0 means no looking for - data). As with hoverdistance, distance does not apply to area- - like objects. In addition, some objects can be hovered on but - will not generate spikelines, such as scatter fills. - - The 'spikedistance' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [-1, 9223372036854775807] - - Returns - ------- - int - """ - return self['spikedistance'] - - @spikedistance.setter - def spikedistance(self, val): - self['spikedistance'] = val - - # template - # -------- - @property - def template(self): - """ - Default attributes to be applied to the plot. This should be a - dict with format: `{'layout': layoutTemplate, 'data': - {trace_type: [traceTemplate, ...], ...}}` where - `layoutTemplate` is a dict matching the structure of - `figure.layout` and `traceTemplate` is a dict matching the - structure of the trace with type `trace_type` (e.g. 'scatter'). - Alternatively, this may be specified as an instance of - plotly.graph_objs.layout.Template. Trace templates are applied - cyclically to traces of each type. Container arrays (eg - `annotations`) have special handling: An object ending in - `defaults` (eg `annotationdefaults`) is applied to each array - item. But if an item has a `templateitemname` key we look in - the template array for an item with matching `name` and apply - that instead. If no matching `name` is found we mark the item - invisible. Any named template item not referenced is appended - to the end of the array, so this can be used to add a watermark - annotation or a logo image, for example. To omit one of these - items on the plot, make an item with matching - `templateitemname` and `visible: false`. - - The 'template' property is an instance of Template - that may be specified as: - - An instance of plotly.graph_objs.layout.Template - - A dict of string/value properties that will be passed - to the Template constructor - - Supported dict properties: - - data - plotly.graph_objs.layout.template.Data instance - or dict with compatible properties - layout - plotly.graph_objs.layout.template.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) - - A string containing multiple registered template names, joined on '+' - characters (e.g. 'template1+template2'). In this case the resulting - template is computed by merging together the collection of registered - templates - - Returns - ------- - plotly.graph_objs.layout.Template - """ - return self['template'] - - @template.setter - def template(self, val): - self['template'] = val - - # ternary - # ------- - @property - def ternary(self): - """ - The 'ternary' property is an instance of Ternary - that may be specified as: - - An instance of plotly.graph_objs.layout.Ternary - - A dict of string/value properties that will be passed - to the Ternary constructor - - Supported dict properties: - - aaxis - plotly.graph_objs.layout.ternary.Aaxis instance - or dict with compatible properties - baxis - plotly.graph_objs.layout.ternary.Baxis instance - or dict with compatible properties - bgcolor - Set the background color of the subplot - caxis - plotly.graph_objs.layout.ternary.Caxis instance - or dict with compatible properties - domain - plotly.graph_objs.layout.ternary.Domain - instance or dict with compatible properties - sum - The number each triplet should sum to, and the - maximum range of each axis - uirevision - Controls persistence of user-driven changes in - axis `min` and `title`, if not overridden in - the individual axes. Defaults to - `layout.uirevision`. - - Returns - ------- - plotly.graph_objs.layout.Ternary - """ - return self['ternary'] - - @ternary.setter - def ternary(self, val): - self['ternary'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - `titlefont` attribute. - pad - Sets the padding of the title. Each padding - value only applies when the corresponding - `xanchor`/`yanchor` value is set accordingly. - E.g. for left padding to take effect, `xanchor` - must be set to "left". The same rule applies if - `xanchor`/`yanchor` is determined - automatically. Padding is muted if the - respective anchor value is "middle*/*center". - text - Sets the plot's title. Note that before the - existence of `title.text`, the title's contents - used to be defined as the `title` attribute - itself. This behavior has been deprecated. - x - Sets the x position with respect to `xref` in - normalized coordinates from 0 (left) to 1 - (right). - xanchor - Sets the title's horizontal alignment with - respect to its x position. "left" means that - the title starts at x, "right" means that the - title ends at x and "center" means that the - title's center is at x. "auto" divides `xref` - by three and calculates the `xanchor` value - automatically based on the value of `x`. - xref - Sets the container `x` refers to. "container" - spans the entire `width` of the plot. "paper" - refers to the width of the plotting area only. - y - Sets the y position with respect to `yref` in - normalized coordinates from 0 (bottom) to 1 - (top). "auto" places the baseline of the title - onto the vertical center of the top margin. - yanchor - Sets the title's vertical alignment with - respect to its y position. "top" means that the - title's cap line is at y, "bottom" means that - the title's baseline is at y and "middle" means - that the title's midline is at y. "auto" - divides `yref` by three and calculates the - `yanchor` value automatically based on the - value of `y`. - yref - Sets the container `y` refers to. "container" - spans the entire `height` of the plot. "paper" - refers to the height of the plotting area only. - - Returns - ------- - plotly.graph_objs.layout.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 plotly.graph_objs.layout.title.Font - - A dict of string/value properties that will be passed - to the Font constructor - - Supported dict properties: - - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # transition - # ---------- - @property - 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 plotly.graph_objs.layout.Transition - - A dict of string/value properties that will be passed - to the Transition constructor - - Supported dict properties: - - duration - The duration of the transition, in - milliseconds. If equal to zero, updates are - synchronous. - easing - The easing function used for the transition - ordering - Determines whether the figure's layout or - traces smoothly transitions during updates that - make both traces and layout change. - - Returns - ------- - plotly.graph_objs.layout.Transition - """ - return self['transition'] - - @transition.setter - def transition(self, val): - self['transition'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Used to allow user interactions with the plot to persist after - `Plotly.react` calls that are unaware of these interactions. If - `uirevision` is omitted, or if it is given and it changed from - the previous `Plotly.react` call, the exact new figure is used. - If `uirevision` is truthy and did NOT change, any attribute - that has been affected by user interactions and did not receive - a different value in the new figure will keep the interaction - value. `layout.uirevision` attribute serves as the default for - `uirevision` attributes in various sub-containers. For finer - control you can set these sub-attributes directly. For example, - if your app separately controls the data on the x and y axes - you might set `xaxis.uirevision=*time*` and - `yaxis.uirevision=*cost*`. Then if only the y data is changed, - you can update `yaxis.uirevision=*quantity*` and the y axis - range will reset but the x axis range will retain any user- - driven zoom. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # updatemenus - # ----------- - @property - def updatemenus(self): - """ - The 'updatemenus' property is a tuple of instances of - Updatemenu that may be specified as: - - A list or tuple of instances of plotly.graph_objs.layout.Updatemenu - - A list or tuple of dicts of string/value properties that - will be passed to the Updatemenu constructor - - Supported dict properties: - - active - Determines which button (by index starting from - 0) is considered active. - bgcolor - Sets the background color of the update menu - buttons. - bordercolor - Sets the color of the border enclosing the - update menu. - borderwidth - Sets the width (in px) of the border enclosing - the update menu. - buttons - plotly.graph_objs.layout.updatemenu.Button - instance or dict with compatible properties - buttondefaults - When used in a template (as layout.template.lay - out.updatemenu.buttondefaults), sets the - default property values to use for elements of - layout.updatemenu.buttons - direction - Determines the direction in which the buttons - are laid out, whether in a dropdown menu or a - row/column of buttons. For `left` and `up`, the - buttons will still appear in left-to-right or - top-to-bottom order respectively. - font - Sets the font of the update menu button text. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - pad - Sets the padding around the buttons or dropdown - menu. - showactive - Highlights active dropdown item or active - button if true. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - type - Determines whether the buttons are accessible - via a dropdown menu or whether the buttons are - stacked horizontally or vertically - visible - Determines whether or not the update menu is - visible. - x - Sets the x position (in normalized coordinates) - of the update menu. - xanchor - Sets the update menu's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the range - selector. - y - Sets the y position (in normalized coordinates) - of the update menu. - yanchor - Sets the update menu's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the range - selector. - - Returns - ------- - tuple[plotly.graph_objs.layout.Updatemenu] - """ - return self['updatemenus'] - - @updatemenus.setter - def updatemenus(self, val): - self['updatemenus'] = val - - # updatemenudefaults - # ------------------ - @property - 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 plotly.graph_objs.layout.Updatemenu - - A dict of string/value properties that will be passed - to the Updatemenu constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.layout.Updatemenu - """ - return self['updatemenudefaults'] - - @updatemenudefaults.setter - def updatemenudefaults(self, val): - self['updatemenudefaults'] = val - - # violingap - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['violingap'] - - @violingap.setter - def violingap(self, val): - self['violingap'] = val - - # violingroupgap - # -------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['violingroupgap'] - - @violingroupgap.setter - def violingroupgap(self, val): - self['violingroupgap'] = val - - # violinmode - # ---------- - @property - def violinmode(self): - """ - Determines how violins at the same location coordinate are - displayed on the graph. If "group", the violins are plotted - next to one another centered around the shared location. If - "overlay", the violins are plotted over one another, you might - need to set "opacity" to see them multiple violins. Has no - effect on traces that have "width" set. - - The 'violinmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['group', 'overlay'] - - Returns - ------- - Any - """ - return self['violinmode'] - - @violinmode.setter - def violinmode(self, val): - self['violinmode'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - The 'xaxis' property is an instance of XAxis - that may be specified as: - - An instance of plotly.graph_objs.layout.XAxis - - A dict of string/value properties that will be passed - to the XAxis constructor - - Supported dict properties: - - anchor - If set to an opposite-letter axis id (e.g. - `x2`, `y`), this axis is bound to the - corresponding opposite-letter axis. If set to - "free", this axis' position is determined by - `position`. - automargin - Determines whether long tick labels - automatically grow the figure margins. - autorange - Determines whether or not the range of this - axis is computed in relation to the input data. - See `rangemode` for more info. If `range` is - provided, then `autorange` is set to False. - calendar - Sets the calendar system to use for `range` and - `tick0` if this is a date axis. This does not - set the calendar for interpreting data on this - axis, that's specified in the trace or via the - global `layout.calendar` - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - constrain - If this axis needs to be compressed (either due - to its own `scaleanchor` and `scaleratio` or - those of the other axis), determines how that - happens: by increasing the "range" (default), - or by decreasing the "domain". - constraintoward - If this axis needs to be compressed (either due - to its own `scaleanchor` and `scaleratio` or - those of the other axis), determines which - direction we push the originally specified plot - area. Options are "left", "center" (default), - and "right" for x axes, and "top", "middle" - (default), and "bottom" for y axes. - dividercolor - Sets the color of the dividers Only has an - effect on "multicategory" axes. - dividerwidth - Sets the width (in px) of the dividers Only has - an effect on "multicategory" axes. - domain - Sets the domain of this axis (in plot - fraction). - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - fixedrange - Determines whether or not this axis is zoom- - able. If true, then zoom is disabled. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - layer - Sets the layer on which this axis is displayed. - If *above traces*, this axis is displayed above - all the subplot's traces If *below traces*, - this axis is displayed below all the subplot's - traces, but above the grid lines. Useful when - used together with scatter-like traces with - `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - matches - If set to another axis id (e.g. `x2`, `y`), the - range of this axis will match the range of the - corresponding axis in data-coordinates space. - Moreover, matching axes share auto-range - values, category lists and histogram auto-bins. - Note that setting axes simultaneously in both a - `scaleanchor` and a `matches` constraint is - currently forbidden. Moreover, note that - matching axes must have the same `type`. - mirror - Determines if the axis lines or/and ticks are - mirrored to the opposite side of the plotting - area. If True, the axis lines are mirrored. If - "ticks", the axis lines and ticks are mirrored. - If False, mirroring is disable. If "all", axis - lines are mirrored on all shared-axes subplots. - If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - overlaying - If set a same-letter axis id, this axis is - overlaid on top of the corresponding same- - letter axis, with traces and axes visible for - both axes. If False, this axis does not overlay - any same-letter axes. In this case, for axes - with overlapping domains only the highest- - numbered axis will be visible. - position - Sets the position of this axis in the plotting - space (in normalized coordinates). Only has an - effect if `anchor` is set to "free". - range - Sets the range of this axis. If the axis `type` - is "log", then you must take the log of your - desired range (e.g. to set the range from 1 to - 100, set the range from 0 to 2). If the axis - `type` is "date", it should be date strings, - like date data, though Date objects and unix - milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it - should be numbers, using the scale where each - category is assigned a serial number from zero - in the order it appears. - rangemode - If "normal", the range is computed in relation - to the extrema of the input data. If *tozero*`, - the range extends to 0, regardless of the input - data If "nonnegative", the range is non- - negative, regardless of the input data. Applies - only to linear axes. - rangeselector - plotly.graph_objs.layout.xaxis.Rangeselector - instance or dict with compatible properties - rangeslider - plotly.graph_objs.layout.xaxis.Rangeslider - instance or dict with compatible properties - scaleanchor - If set to another axis id (e.g. `x2`, `y`), the - range of this axis changes together with the - range of the corresponding axis such that the - scale of pixels per unit is in a constant - ratio. Both axes are still zoomable, but when - you zoom one, the other will zoom the same - amount, keeping a fixed midpoint. `constrain` - and `constraintoward` determine how we enforce - the constraint. You can chain these, ie `yaxis: - {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` - but you can only link axes of the same `type`. - The linked axis can have the opposite letter - (to constrain the aspect ratio) or the same - letter (to match scales across subplots). Loops - (`yaxis: {scaleanchor: *x*}, xaxis: - {scaleanchor: *y*}` or longer) are redundant - and the last constraint encountered will be - ignored to avoid possible inconsistent - constraints via `scaleratio`. Note that setting - axes simultaneously in both a `scaleanchor` and - a `matches` constraint is currently forbidden. - scaleratio - If this axis is linked to another by - `scaleanchor`, this determines the pixel to - unit scale ratio. For example, if this value is - 10, then every unit on this axis spans 10 times - the number of pixels as a unit on the linked - axis. Use this for example to create an - elevation profile where the vertical scale is - exaggerated a fixed amount with respect to the - horizontal. - separatethousands - If "true", even 4-digit integers are separated - showdividers - Determines whether or not a dividers are drawn - between the category levels of this axis. Only - has an effect on "multicategory" axes. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showspikes - Determines whether or not spikes (aka - droplines) are drawn for this axis. Note: This - only takes affect when hovermode = closest - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - side - Determines whether a x (y) axis is positioned - at the "bottom" ("left") or "top" ("right") of - the plotting area. - spikecolor - Sets the spike color. If undefined, will use - the series color - spikedash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - spikemode - Determines the drawing mode for the spike line - If "toaxis", the line is drawn from the data - point to the axis the series is plotted on. If - "across", the line is drawn across the entire - plot area, and supercedes "toaxis". If - "marker", then a marker dot is drawn on the - axis the series is plotted on - spikesnap - Determines whether spikelines are stuck to the - cursor or to the closest datapoints. - spikethickness - Sets the width (in px) of the zero line. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.xaxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.xaxis.tickformatstopdefaults), sets the - default property values to use for elements of - layout.xaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - tickson - Determines where ticks and grid lines are drawn - with respect to their corresponding tick - labels. Only has an effect for axes of `type` - "category" or "multicategory". When set to - "boundaries", ticks and grid lines are drawn - half a category to the left/bottom of labels. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.xaxis.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use layout.xaxis.title.font - instead. Sets this axis' title font. Note that - the title's font used to be customized by the - now deprecated `titlefont` attribute. - type - Sets the axis type. By default, plotly attempts - to determined the axis type by looking into the - data of the traces that referenced the axis in - question. - uirevision - Controls persistence of user-driven changes in - axis `range`, `autorange`, and `title` if in - `editable: true` configuration. Defaults to - `layout.uirevision`. - visible - A single toggle to hide the axis while - preserving interaction like dragging. Default - is true when a cheater plot is present on the - axis, otherwise false - zeroline - Determines whether or not a line is drawn at - along the 0 value of this axis. If True, the - zero line is drawn on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. - - Returns - ------- - plotly.graph_objs.layout.XAxis - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - The 'yaxis' property is an instance of YAxis - that may be specified as: - - An instance of plotly.graph_objs.layout.YAxis - - A dict of string/value properties that will be passed - to the YAxis constructor - - Supported dict properties: - - anchor - If set to an opposite-letter axis id (e.g. - `x2`, `y`), this axis is bound to the - corresponding opposite-letter axis. If set to - "free", this axis' position is determined by - `position`. - automargin - Determines whether long tick labels - automatically grow the figure margins. - autorange - Determines whether or not the range of this - axis is computed in relation to the input data. - See `rangemode` for more info. If `range` is - provided, then `autorange` is set to False. - calendar - Sets the calendar system to use for `range` and - `tick0` if this is a date axis. This does not - set the calendar for interpreting data on this - axis, that's specified in the trace or via the - global `layout.calendar` - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - constrain - If this axis needs to be compressed (either due - to its own `scaleanchor` and `scaleratio` or - those of the other axis), determines how that - happens: by increasing the "range" (default), - or by decreasing the "domain". - constraintoward - If this axis needs to be compressed (either due - to its own `scaleanchor` and `scaleratio` or - those of the other axis), determines which - direction we push the originally specified plot - area. Options are "left", "center" (default), - and "right" for x axes, and "top", "middle" - (default), and "bottom" for y axes. - dividercolor - Sets the color of the dividers Only has an - effect on "multicategory" axes. - dividerwidth - Sets the width (in px) of the dividers Only has - an effect on "multicategory" axes. - domain - Sets the domain of this axis (in plot - fraction). - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - fixedrange - Determines whether or not this axis is zoom- - able. If true, then zoom is disabled. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - layer - Sets the layer on which this axis is displayed. - If *above traces*, this axis is displayed above - all the subplot's traces If *below traces*, - this axis is displayed below all the subplot's - traces, but above the grid lines. Useful when - used together with scatter-like traces with - `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - matches - If set to another axis id (e.g. `x2`, `y`), the - range of this axis will match the range of the - corresponding axis in data-coordinates space. - Moreover, matching axes share auto-range - values, category lists and histogram auto-bins. - Note that setting axes simultaneously in both a - `scaleanchor` and a `matches` constraint is - currently forbidden. Moreover, note that - matching axes must have the same `type`. - mirror - Determines if the axis lines or/and ticks are - mirrored to the opposite side of the plotting - area. If True, the axis lines are mirrored. If - "ticks", the axis lines and ticks are mirrored. - If False, mirroring is disable. If "all", axis - lines are mirrored on all shared-axes subplots. - If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - overlaying - If set a same-letter axis id, this axis is - overlaid on top of the corresponding same- - letter axis, with traces and axes visible for - both axes. If False, this axis does not overlay - any same-letter axes. In this case, for axes - with overlapping domains only the highest- - numbered axis will be visible. - position - Sets the position of this axis in the plotting - space (in normalized coordinates). Only has an - effect if `anchor` is set to "free". - range - Sets the range of this axis. If the axis `type` - is "log", then you must take the log of your - desired range (e.g. to set the range from 1 to - 100, set the range from 0 to 2). If the axis - `type` is "date", it should be date strings, - like date data, though Date objects and unix - milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it - should be numbers, using the scale where each - category is assigned a serial number from zero - in the order it appears. - rangemode - If "normal", the range is computed in relation - to the extrema of the input data. If *tozero*`, - the range extends to 0, regardless of the input - data If "nonnegative", the range is non- - negative, regardless of the input data. Applies - only to linear axes. - scaleanchor - If set to another axis id (e.g. `x2`, `y`), the - range of this axis changes together with the - range of the corresponding axis such that the - scale of pixels per unit is in a constant - ratio. Both axes are still zoomable, but when - you zoom one, the other will zoom the same - amount, keeping a fixed midpoint. `constrain` - and `constraintoward` determine how we enforce - the constraint. You can chain these, ie `yaxis: - {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` - but you can only link axes of the same `type`. - The linked axis can have the opposite letter - (to constrain the aspect ratio) or the same - letter (to match scales across subplots). Loops - (`yaxis: {scaleanchor: *x*}, xaxis: - {scaleanchor: *y*}` or longer) are redundant - and the last constraint encountered will be - ignored to avoid possible inconsistent - constraints via `scaleratio`. Note that setting - axes simultaneously in both a `scaleanchor` and - a `matches` constraint is currently forbidden. - scaleratio - If this axis is linked to another by - `scaleanchor`, this determines the pixel to - unit scale ratio. For example, if this value is - 10, then every unit on this axis spans 10 times - the number of pixels as a unit on the linked - axis. Use this for example to create an - elevation profile where the vertical scale is - exaggerated a fixed amount with respect to the - horizontal. - separatethousands - If "true", even 4-digit integers are separated - showdividers - Determines whether or not a dividers are drawn - between the category levels of this axis. Only - has an effect on "multicategory" axes. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showspikes - Determines whether or not spikes (aka - droplines) are drawn for this axis. Note: This - only takes affect when hovermode = closest - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - side - Determines whether a x (y) axis is positioned - at the "bottom" ("left") or "top" ("right") of - the plotting area. - spikecolor - Sets the spike color. If undefined, will use - the series color - spikedash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - spikemode - Determines the drawing mode for the spike line - If "toaxis", the line is drawn from the data - point to the axis the series is plotted on. If - "across", the line is drawn across the entire - plot area, and supercedes "toaxis". If - "marker", then a marker dot is drawn on the - axis the series is plotted on - spikesnap - Determines whether spikelines are stuck to the - cursor or to the closest datapoints. - spikethickness - Sets the width (in px) of the zero line. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.yaxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.yaxis.tickformatstopdefaults), sets the - default property values to use for elements of - layout.yaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - tickson - Determines where ticks and grid lines are drawn - with respect to their corresponding tick - labels. Only has an effect for axes of `type` - "category" or "multicategory". When set to - "boundaries", ticks and grid lines are drawn - half a category to the left/bottom of labels. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.yaxis.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use layout.yaxis.title.font - instead. Sets this axis' title font. Note that - the title's font used to be customized by the - now deprecated `titlefont` attribute. - type - Sets the axis type. By default, plotly attempts - to determined the axis type by looking into the - data of the traces that referenced the axis in - question. - uirevision - Controls persistence of user-driven changes in - axis `range`, `autorange`, and `title` if in - `editable: true` configuration. Defaults to - `layout.uirevision`. - visible - A single toggle to hide the axis while - preserving interaction like dragging. Default - is true when a cheater plot is present on the - axis, otherwise false - zeroline - Determines whether or not a line is drawn at - along the 0 value of this axis. If True, the - zero line is drawn on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. - - Returns - ------- - plotly.graph_objs.layout.YAxis - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - angularaxis - plotly.graph_objs.layout.AngularAxis instance or dict - with compatible properties - annotations - plotly.graph_objs.layout.Annotation instance or dict - with compatible properties - annotationdefaults - When used in a template (as - layout.template.layout.annotationdefaults), sets the - default property values to use for elements of - layout.annotations - autosize - Determines whether or not a layout width or height that - has been left undefined by the user is initialized on - each relayout. Note that, regardless of this attribute, - an undefined layout width or height is always - initialized on the first call to plot. - bargap - Sets the gap (in plot fraction) between bars of - adjacent location coordinates. - bargroupgap - Sets the gap (in plot fraction) between bars of the - same location coordinate. - barmode - Determines how bars at the same location coordinate are - displayed on the graph. With "stack", the bars are - stacked on top of one another With "relative", the bars - are stacked on top of one another, with negative values - below the axis, positive values above With "group", the - bars are plotted next to one another centered around - the shared location. With "overlay", the bars are - plotted over one another, you might need to an - "opacity" to see multiple bars. - barnorm - Sets the normalization for bar traces on the graph. - With "fraction", the value of each bar is divided by - the sum of all values at that location coordinate. - "percent" is the same but multiplied by 100 to show - percentages. - boxgap - Sets the gap (in plot fraction) between boxes of - adjacent location coordinates. Has no effect on traces - that have "width" set. - boxgroupgap - Sets the gap (in plot fraction) between boxes of the - same location coordinate. Has no effect on traces that - have "width" set. - boxmode - Determines how boxes at the same location coordinate - are displayed on the graph. If "group", the boxes are - plotted next to one another centered around the shared - location. If "overlay", the boxes are plotted over one - another, you might need to set "opacity" to see them - multiple boxes. Has no effect on traces that have - "width" set. - calendar - Sets the default calendar system to use for - interpreting and displaying dates throughout the plot. - clickmode - Determines the mode of single click interactions. - "event" is the default value and emits the - `plotly_click` event. In addition this mode emits the - `plotly_selected` event in drag modes "lasso" and - "select", but with no event data attached (kept for - compatibility reasons). The "select" flag enables - selecting single data points via click. This mode also - supports persistent selections, meaning that pressing - Shift while clicking, adds to / subtracts from an - existing selection. "select" with `hovermode`: "x" can - be confusing, consider explicitly setting `hovermode`: - "closest" when using this feature. Selection events are - sent accordingly as long as "event" flag is set as - well. When the "event" flag is missing, `plotly_click` - and `plotly_selected` events are not fired. - colorscale - plotly.graph_objs.layout.Colorscale instance or dict - with compatible properties - colorway - Sets the default trace colors. - datarevision - If provided, a changed value tells `Plotly.react` that - one or more data arrays has changed. This way you can - modify arrays in-place rather than making a complete - new copy for an incremental change. If NOT provided, - `Plotly.react` assumes that data arrays are being - treated as immutable, thus any data array with a - different identity from its predecessor contains new - data. - direction - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the direction corresponding to - positive angles in legacy polar charts. - dragmode - Determines the mode of drag interactions. "select" and - "lasso" apply only to scatter traces with markers or - text. "orbit" and "turntable" apply only to 3D scenes. - editrevision - Controls persistence of user-driven changes in - `editable: true` configuration, other than trace names - and axis titles. Defaults to `layout.uirevision`. - extendpiecolors - If `true`, the pie slice colors (whether given by - `piecolorway` or inherited from `colorway`) will be - extended to three times its original length by first - repeating every color 20% lighter then each color 20% - darker. This is intended to reduce the likelihood of - reusing the same color when you have many slices, but - you can set `false` to disable. Colors provided in the - trace, using `marker.colors`, are never extended. - font - Sets the global font. Note that fonts used in traces - and other layout components inherit from the global - font. - geo - plotly.graph_objs.layout.Geo instance or dict with - compatible properties - grid - plotly.graph_objs.layout.Grid instance or dict with - compatible properties - height - Sets the plot's height (in px). - hiddenlabels - - hiddenlabelssrc - Sets the source reference on plot.ly for hiddenlabels - . - hidesources - Determines whether or not a text link citing the data - source is placed at the bottom-right cored of the - figure. Has only an effect only on graphs that have - been generated via forked graphs from the plotly - service (at https://plot.ly or on-premise). - hoverdistance - Sets the default distance (in pixels) to look for data - to add hover labels (-1 means no cutoff, 0 means no - looking for data). This is only a real distance for - hovering on point-like objects, like scatter points. - For area-like objects (bars, scatter fills, etc) - hovering is on inside the area and off outside, but - these objects will not supersede hover on point-like - objects in case of conflict. - hoverlabel - plotly.graph_objs.layout.Hoverlabel instance or dict - with compatible properties - hovermode - Determines the mode of hover interactions. If - `clickmode` includes the "select" flag, `hovermode` - defaults to "closest". If `clickmode` lacks the - "select" flag, it defaults to "x" or "y" (depending on - the trace's `orientation` value) for plots based on - cartesian coordinates. For anything else the default - value is "closest". - images - plotly.graph_objs.layout.Image instance or dict with - compatible properties - imagedefaults - When used in a template (as - layout.template.layout.imagedefaults), sets the default - property values to use for elements of layout.images - legend - plotly.graph_objs.layout.Legend instance or dict with - compatible properties - mapbox - plotly.graph_objs.layout.Mapbox instance or dict with - compatible properties - margin - plotly.graph_objs.layout.Margin instance or dict with - compatible properties - meta - Assigns extra meta information that can be used in - various `text` attributes. Attributes such as the - graph, axis and colorbar `title.text`, annotation - `text` `trace.name` in legend items, `rangeselector`, - `updatemenues` and `sliders` `label` text all support - `meta`. One can access `meta` fields using template - strings: `%{meta[i]}` where `i` is the index of the - `meta` item in question. - metasrc - Sets the source reference on plot.ly for meta . - modebar - plotly.graph_objs.layout.Modebar instance or dict with - compatible properties - orientation - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Rotates the entire polar by the given - angle in legacy polar charts. - paper_bgcolor - Sets the color of paper where the graph is drawn. - piecolorway - Sets the default pie slice colors. Defaults to the main - `colorway` used for trace colors. If you specify a new - list here it can still be extended with lighter and - darker colors, see `extendpiecolors`. - plot_bgcolor - Sets the color of plotting area in-between x and y - axes. - polar - plotly.graph_objs.layout.Polar instance or dict with - compatible properties - radialaxis - plotly.graph_objs.layout.RadialAxis instance or dict - with compatible properties - scene - plotly.graph_objs.layout.Scene instance or dict with - compatible properties - selectdirection - When "dragmode" is set to "select", this limits the - selection of the drag to horizontal, vertical or - diagonal. "h" only allows horizontal selection, "v" - only vertical, "d" only diagonal and "any" sets no - limit. - selectionrevision - Controls persistence of user-driven changes in selected - points from all traces. - separators - Sets the decimal and thousand separators. For example, - *. * puts a '.' before decimals and a space between - thousands. In English locales, dflt is ".," but other - locales may alter this default. - shapes - plotly.graph_objs.layout.Shape instance or dict with - compatible properties - shapedefaults - When used in a template (as - layout.template.layout.shapedefaults), sets the default - property values to use for elements of layout.shapes - showlegend - Determines whether or not a legend is drawn. Default is - `true` if there is a trace to show and any of these: a) - Two or more traces would by default be shown in the - legend. b) One pie trace is shown in the legend. c) One - trace is explicitly given with `showlegend: true`. - sliders - plotly.graph_objs.layout.Slider instance or dict with - compatible properties - sliderdefaults - When used in a template (as - layout.template.layout.sliderdefaults), sets the - default property values to use for elements of - layout.sliders - spikedistance - Sets the default distance (in pixels) to look for data - to draw spikelines to (-1 means no cutoff, 0 means no - looking for data). As with hoverdistance, distance does - not apply to area-like objects. In addition, some - objects can be hovered on but will not generate - spikelines, such as scatter fills. - template - Default attributes to be applied to the plot. This - should be a dict with format: `{'layout': - layoutTemplate, 'data': {trace_type: [traceTemplate, - ...], ...}}` where `layoutTemplate` is a dict matching - the structure of `figure.layout` and `traceTemplate` is - a dict matching the structure of the trace with type - `trace_type` (e.g. 'scatter'). Alternatively, this may - be specified as an instance of - plotly.graph_objs.layout.Template. Trace templates are - applied cyclically to traces of each type. Container - arrays (eg `annotations`) have special handling: An - object ending in `defaults` (eg `annotationdefaults`) - is applied to each array item. But if an item has a - `templateitemname` key we look in the template array - for an item with matching `name` and apply that - instead. If no matching `name` is found we mark the - item invisible. Any named template item not referenced - is appended to the end of the array, so this can be - used to add a watermark annotation or a logo image, for - example. To omit one of these items on the plot, make - an item with matching `templateitemname` and `visible: - false`. - ternary - plotly.graph_objs.layout.Ternary instance or dict with - compatible properties - title - plotly.graph_objs.layout.Title instance or dict with - compatible properties - titlefont - Deprecated: Please use layout.title.font instead. Sets - the title font. Note that the title's font used to be - customized by the now deprecated `titlefont` attribute. - transition - Sets transition options used during Plotly.react - updates. - uirevision - Used to allow user interactions with the plot to - persist after `Plotly.react` calls that are unaware of - these interactions. If `uirevision` is omitted, or if - it is given and it changed from the previous - `Plotly.react` call, the exact new figure is used. If - `uirevision` is truthy and did NOT change, any - attribute that has been affected by user interactions - and did not receive a different value in the new figure - will keep the interaction value. `layout.uirevision` - attribute serves as the default for `uirevision` - attributes in various sub-containers. For finer control - you can set these sub-attributes directly. For example, - if your app separately controls the data on the x and y - axes you might set `xaxis.uirevision=*time*` and - `yaxis.uirevision=*cost*`. Then if only the y data is - changed, you can update `yaxis.uirevision=*quantity*` - and the y axis range will reset but the x axis range - will retain any user-driven zoom. - updatemenus - plotly.graph_objs.layout.Updatemenu instance or dict - with compatible properties - updatemenudefaults - When used in a template (as - layout.template.layout.updatemenudefaults), sets the - default property values to use for elements of - layout.updatemenus - violingap - Sets the gap (in plot fraction) between violins of - adjacent location coordinates. Has no effect on traces - that have "width" set. - violingroupgap - Sets the gap (in plot fraction) between violins of the - same location coordinate. Has no effect on traces that - have "width" set. - violinmode - Determines how violins at the same location coordinate - are displayed on the graph. If "group", the violins are - plotted next to one another centered around the shared - location. If "overlay", the violins are plotted over - one another, you might need to set "opacity" to see - them multiple violins. Has no effect on traces that - have "width" set. - width - Sets the plot's width (in px). - xaxis - plotly.graph_objs.layout.XAxis instance or dict with - compatible properties - yaxis - plotly.graph_objs.layout.YAxis instance or dict with - compatible properties - """ - - _mapped_properties = {'titlefont': ('title', 'font')} - - def __init__( - self, - arg=None, - angularaxis=None, - annotations=None, - annotationdefaults=None, - autosize=None, - bargap=None, - bargroupgap=None, - barmode=None, - barnorm=None, - boxgap=None, - boxgroupgap=None, - boxmode=None, - calendar=None, - clickmode=None, - colorscale=None, - colorway=None, - datarevision=None, - direction=None, - dragmode=None, - editrevision=None, - extendpiecolors=None, - font=None, - geo=None, - grid=None, - height=None, - hiddenlabels=None, - hiddenlabelssrc=None, - hidesources=None, - hoverdistance=None, - hoverlabel=None, - hovermode=None, - images=None, - imagedefaults=None, - legend=None, - mapbox=None, - margin=None, - meta=None, - metasrc=None, - modebar=None, - orientation=None, - paper_bgcolor=None, - piecolorway=None, - plot_bgcolor=None, - polar=None, - radialaxis=None, - scene=None, - selectdirection=None, - selectionrevision=None, - separators=None, - shapes=None, - shapedefaults=None, - showlegend=None, - sliders=None, - sliderdefaults=None, - spikedistance=None, - template=None, - ternary=None, - title=None, - titlefont=None, - transition=None, - uirevision=None, - updatemenus=None, - updatemenudefaults=None, - violingap=None, - violingroupgap=None, - violinmode=None, - width=None, - xaxis=None, - yaxis=None, - **kwargs - ): - """ - Construct a new Layout object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Layout - angularaxis - plotly.graph_objs.layout.AngularAxis instance or dict - with compatible properties - annotations - plotly.graph_objs.layout.Annotation instance or dict - with compatible properties - annotationdefaults - When used in a template (as - layout.template.layout.annotationdefaults), sets the - default property values to use for elements of - layout.annotations - autosize - Determines whether or not a layout width or height that - has been left undefined by the user is initialized on - each relayout. Note that, regardless of this attribute, - an undefined layout width or height is always - initialized on the first call to plot. - bargap - Sets the gap (in plot fraction) between bars of - adjacent location coordinates. - bargroupgap - Sets the gap (in plot fraction) between bars of the - same location coordinate. - barmode - Determines how bars at the same location coordinate are - displayed on the graph. With "stack", the bars are - stacked on top of one another With "relative", the bars - are stacked on top of one another, with negative values - below the axis, positive values above With "group", the - bars are plotted next to one another centered around - the shared location. With "overlay", the bars are - plotted over one another, you might need to an - "opacity" to see multiple bars. - barnorm - Sets the normalization for bar traces on the graph. - With "fraction", the value of each bar is divided by - the sum of all values at that location coordinate. - "percent" is the same but multiplied by 100 to show - percentages. - boxgap - Sets the gap (in plot fraction) between boxes of - adjacent location coordinates. Has no effect on traces - that have "width" set. - boxgroupgap - Sets the gap (in plot fraction) between boxes of the - same location coordinate. Has no effect on traces that - have "width" set. - boxmode - Determines how boxes at the same location coordinate - are displayed on the graph. If "group", the boxes are - plotted next to one another centered around the shared - location. If "overlay", the boxes are plotted over one - another, you might need to set "opacity" to see them - multiple boxes. Has no effect on traces that have - "width" set. - calendar - Sets the default calendar system to use for - interpreting and displaying dates throughout the plot. - clickmode - Determines the mode of single click interactions. - "event" is the default value and emits the - `plotly_click` event. In addition this mode emits the - `plotly_selected` event in drag modes "lasso" and - "select", but with no event data attached (kept for - compatibility reasons). The "select" flag enables - selecting single data points via click. This mode also - supports persistent selections, meaning that pressing - Shift while clicking, adds to / subtracts from an - existing selection. "select" with `hovermode`: "x" can - be confusing, consider explicitly setting `hovermode`: - "closest" when using this feature. Selection events are - sent accordingly as long as "event" flag is set as - well. When the "event" flag is missing, `plotly_click` - and `plotly_selected` events are not fired. - colorscale - plotly.graph_objs.layout.Colorscale instance or dict - with compatible properties - colorway - Sets the default trace colors. - datarevision - If provided, a changed value tells `Plotly.react` that - one or more data arrays has changed. This way you can - modify arrays in-place rather than making a complete - new copy for an incremental change. If NOT provided, - `Plotly.react` assumes that data arrays are being - treated as immutable, thus any data array with a - different identity from its predecessor contains new - data. - direction - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the direction corresponding to - positive angles in legacy polar charts. - dragmode - Determines the mode of drag interactions. "select" and - "lasso" apply only to scatter traces with markers or - text. "orbit" and "turntable" apply only to 3D scenes. - editrevision - Controls persistence of user-driven changes in - `editable: true` configuration, other than trace names - and axis titles. Defaults to `layout.uirevision`. - extendpiecolors - If `true`, the pie slice colors (whether given by - `piecolorway` or inherited from `colorway`) will be - extended to three times its original length by first - repeating every color 20% lighter then each color 20% - darker. This is intended to reduce the likelihood of - reusing the same color when you have many slices, but - you can set `false` to disable. Colors provided in the - trace, using `marker.colors`, are never extended. - font - Sets the global font. Note that fonts used in traces - and other layout components inherit from the global - font. - geo - plotly.graph_objs.layout.Geo instance or dict with - compatible properties - grid - plotly.graph_objs.layout.Grid instance or dict with - compatible properties - height - Sets the plot's height (in px). - hiddenlabels - - hiddenlabelssrc - Sets the source reference on plot.ly for hiddenlabels - . - hidesources - Determines whether or not a text link citing the data - source is placed at the bottom-right cored of the - figure. Has only an effect only on graphs that have - been generated via forked graphs from the plotly - service (at https://plot.ly or on-premise). - hoverdistance - Sets the default distance (in pixels) to look for data - to add hover labels (-1 means no cutoff, 0 means no - looking for data). This is only a real distance for - hovering on point-like objects, like scatter points. - For area-like objects (bars, scatter fills, etc) - hovering is on inside the area and off outside, but - these objects will not supersede hover on point-like - objects in case of conflict. - hoverlabel - plotly.graph_objs.layout.Hoverlabel instance or dict - with compatible properties - hovermode - Determines the mode of hover interactions. If - `clickmode` includes the "select" flag, `hovermode` - defaults to "closest". If `clickmode` lacks the - "select" flag, it defaults to "x" or "y" (depending on - the trace's `orientation` value) for plots based on - cartesian coordinates. For anything else the default - value is "closest". - images - plotly.graph_objs.layout.Image instance or dict with - compatible properties - imagedefaults - When used in a template (as - layout.template.layout.imagedefaults), sets the default - property values to use for elements of layout.images - legend - plotly.graph_objs.layout.Legend instance or dict with - compatible properties - mapbox - plotly.graph_objs.layout.Mapbox instance or dict with - compatible properties - margin - plotly.graph_objs.layout.Margin instance or dict with - compatible properties - meta - Assigns extra meta information that can be used in - various `text` attributes. Attributes such as the - graph, axis and colorbar `title.text`, annotation - `text` `trace.name` in legend items, `rangeselector`, - `updatemenues` and `sliders` `label` text all support - `meta`. One can access `meta` fields using template - strings: `%{meta[i]}` where `i` is the index of the - `meta` item in question. - metasrc - Sets the source reference on plot.ly for meta . - modebar - plotly.graph_objs.layout.Modebar instance or dict with - compatible properties - orientation - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Rotates the entire polar by the given - angle in legacy polar charts. - paper_bgcolor - Sets the color of paper where the graph is drawn. - piecolorway - Sets the default pie slice colors. Defaults to the main - `colorway` used for trace colors. If you specify a new - list here it can still be extended with lighter and - darker colors, see `extendpiecolors`. - plot_bgcolor - Sets the color of plotting area in-between x and y - axes. - polar - plotly.graph_objs.layout.Polar instance or dict with - compatible properties - radialaxis - plotly.graph_objs.layout.RadialAxis instance or dict - with compatible properties - scene - plotly.graph_objs.layout.Scene instance or dict with - compatible properties - selectdirection - When "dragmode" is set to "select", this limits the - selection of the drag to horizontal, vertical or - diagonal. "h" only allows horizontal selection, "v" - only vertical, "d" only diagonal and "any" sets no - limit. - selectionrevision - Controls persistence of user-driven changes in selected - points from all traces. - separators - Sets the decimal and thousand separators. For example, - *. * puts a '.' before decimals and a space between - thousands. In English locales, dflt is ".," but other - locales may alter this default. - shapes - plotly.graph_objs.layout.Shape instance or dict with - compatible properties - shapedefaults - When used in a template (as - layout.template.layout.shapedefaults), sets the default - property values to use for elements of layout.shapes - showlegend - Determines whether or not a legend is drawn. Default is - `true` if there is a trace to show and any of these: a) - Two or more traces would by default be shown in the - legend. b) One pie trace is shown in the legend. c) One - trace is explicitly given with `showlegend: true`. - sliders - plotly.graph_objs.layout.Slider instance or dict with - compatible properties - sliderdefaults - When used in a template (as - layout.template.layout.sliderdefaults), sets the - default property values to use for elements of - layout.sliders - spikedistance - Sets the default distance (in pixels) to look for data - to draw spikelines to (-1 means no cutoff, 0 means no - looking for data). As with hoverdistance, distance does - not apply to area-like objects. In addition, some - objects can be hovered on but will not generate - spikelines, such as scatter fills. - template - Default attributes to be applied to the plot. This - should be a dict with format: `{'layout': - layoutTemplate, 'data': {trace_type: [traceTemplate, - ...], ...}}` where `layoutTemplate` is a dict matching - the structure of `figure.layout` and `traceTemplate` is - a dict matching the structure of the trace with type - `trace_type` (e.g. 'scatter'). Alternatively, this may - be specified as an instance of - plotly.graph_objs.layout.Template. Trace templates are - applied cyclically to traces of each type. Container - arrays (eg `annotations`) have special handling: An - object ending in `defaults` (eg `annotationdefaults`) - is applied to each array item. But if an item has a - `templateitemname` key we look in the template array - for an item with matching `name` and apply that - instead. If no matching `name` is found we mark the - item invisible. Any named template item not referenced - is appended to the end of the array, so this can be - used to add a watermark annotation or a logo image, for - example. To omit one of these items on the plot, make - an item with matching `templateitemname` and `visible: - false`. - ternary - plotly.graph_objs.layout.Ternary instance or dict with - compatible properties - title - plotly.graph_objs.layout.Title instance or dict with - compatible properties - titlefont - Deprecated: Please use layout.title.font instead. Sets - the title font. Note that the title's font used to be - customized by the now deprecated `titlefont` attribute. - transition - Sets transition options used during Plotly.react - updates. - uirevision - Used to allow user interactions with the plot to - persist after `Plotly.react` calls that are unaware of - these interactions. If `uirevision` is omitted, or if - it is given and it changed from the previous - `Plotly.react` call, the exact new figure is used. If - `uirevision` is truthy and did NOT change, any - attribute that has been affected by user interactions - and did not receive a different value in the new figure - will keep the interaction value. `layout.uirevision` - attribute serves as the default for `uirevision` - attributes in various sub-containers. For finer control - you can set these sub-attributes directly. For example, - if your app separately controls the data on the x and y - axes you might set `xaxis.uirevision=*time*` and - `yaxis.uirevision=*cost*`. Then if only the y data is - changed, you can update `yaxis.uirevision=*quantity*` - and the y axis range will reset but the x axis range - will retain any user-driven zoom. - updatemenus - plotly.graph_objs.layout.Updatemenu instance or dict - with compatible properties - updatemenudefaults - When used in a template (as - layout.template.layout.updatemenudefaults), sets the - default property values to use for elements of - layout.updatemenus - violingap - Sets the gap (in plot fraction) between violins of - adjacent location coordinates. Has no effect on traces - that have "width" set. - violingroupgap - Sets the gap (in plot fraction) between violins of the - same location coordinate. Has no effect on traces that - have "width" set. - violinmode - Determines how violins at the same location coordinate - are displayed on the graph. If "group", the violins are - plotted next to one another centered around the shared - location. If "overlay", the violins are plotted over - one another, you might need to set "opacity" to see - them multiple violins. Has no effect on traces that - have "width" set. - width - Sets the plot's width (in px). - xaxis - plotly.graph_objs.layout.XAxis instance or dict with - compatible properties - yaxis - plotly.graph_objs.layout.YAxis instance or dict with - compatible properties - - Returns - ------- - Layout - """ - super(Layout, self).__init__('layout') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Layout -constructor must be a dict or -an instance of plotly.graph_objs.Layout""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (layout as v_layout) - - # Initialize validators - # --------------------- - self._validators['angularaxis'] = v_layout.AngularAxisValidator() - self._validators['annotations'] = v_layout.AnnotationsValidator() - self._validators['annotationdefaults'] = v_layout.AnnotationValidator() - self._validators['autosize'] = v_layout.AutosizeValidator() - self._validators['bargap'] = v_layout.BargapValidator() - self._validators['bargroupgap'] = v_layout.BargroupgapValidator() - self._validators['barmode'] = v_layout.BarmodeValidator() - self._validators['barnorm'] = v_layout.BarnormValidator() - self._validators['boxgap'] = v_layout.BoxgapValidator() - self._validators['boxgroupgap'] = v_layout.BoxgroupgapValidator() - self._validators['boxmode'] = v_layout.BoxmodeValidator() - self._validators['calendar'] = v_layout.CalendarValidator() - self._validators['clickmode'] = v_layout.ClickmodeValidator() - self._validators['colorscale'] = v_layout.ColorscaleValidator() - self._validators['colorway'] = v_layout.ColorwayValidator() - self._validators['datarevision'] = v_layout.DatarevisionValidator() - self._validators['direction'] = v_layout.DirectionValidator() - self._validators['dragmode'] = v_layout.DragmodeValidator() - self._validators['editrevision'] = v_layout.EditrevisionValidator() - self._validators['extendpiecolors' - ] = v_layout.ExtendpiecolorsValidator() - self._validators['font'] = v_layout.FontValidator() - self._validators['geo'] = v_layout.GeoValidator() - self._validators['grid'] = v_layout.GridValidator() - self._validators['height'] = v_layout.HeightValidator() - self._validators['hiddenlabels'] = v_layout.HiddenlabelsValidator() - self._validators['hiddenlabelssrc' - ] = v_layout.HiddenlabelssrcValidator() - self._validators['hidesources'] = v_layout.HidesourcesValidator() - self._validators['hoverdistance'] = v_layout.HoverdistanceValidator() - self._validators['hoverlabel'] = v_layout.HoverlabelValidator() - self._validators['hovermode'] = v_layout.HovermodeValidator() - self._validators['images'] = v_layout.ImagesValidator() - self._validators['imagedefaults'] = v_layout.ImageValidator() - self._validators['legend'] = v_layout.LegendValidator() - self._validators['mapbox'] = v_layout.MapboxValidator() - self._validators['margin'] = v_layout.MarginValidator() - self._validators['meta'] = v_layout.MetaValidator() - self._validators['metasrc'] = v_layout.MetasrcValidator() - self._validators['modebar'] = v_layout.ModebarValidator() - self._validators['orientation'] = v_layout.OrientationValidator() - self._validators['paper_bgcolor'] = v_layout.PaperBgcolorValidator() - self._validators['piecolorway'] = v_layout.PiecolorwayValidator() - self._validators['plot_bgcolor'] = v_layout.PlotBgcolorValidator() - self._validators['polar'] = v_layout.PolarValidator() - self._validators['radialaxis'] = v_layout.RadialAxisValidator() - self._validators['scene'] = v_layout.SceneValidator() - self._validators['selectdirection' - ] = v_layout.SelectdirectionValidator() - self._validators['selectionrevision' - ] = v_layout.SelectionrevisionValidator() - self._validators['separators'] = v_layout.SeparatorsValidator() - self._validators['shapes'] = v_layout.ShapesValidator() - self._validators['shapedefaults'] = v_layout.ShapeValidator() - self._validators['showlegend'] = v_layout.ShowlegendValidator() - self._validators['sliders'] = v_layout.SlidersValidator() - self._validators['sliderdefaults'] = v_layout.SliderValidator() - self._validators['spikedistance'] = v_layout.SpikedistanceValidator() - self._validators['template'] = v_layout.TemplateValidator() - self._validators['ternary'] = v_layout.TernaryValidator() - self._validators['title'] = v_layout.TitleValidator() - self._validators['transition'] = v_layout.TransitionValidator() - self._validators['uirevision'] = v_layout.UirevisionValidator() - self._validators['updatemenus'] = v_layout.UpdatemenusValidator() - self._validators['updatemenudefaults'] = v_layout.UpdatemenuValidator() - self._validators['violingap'] = v_layout.ViolingapValidator() - self._validators['violingroupgap'] = v_layout.ViolingroupgapValidator() - self._validators['violinmode'] = v_layout.ViolinmodeValidator() - self._validators['width'] = v_layout.WidthValidator() - self._validators['xaxis'] = v_layout.XAxisValidator() - self._validators['yaxis'] = v_layout.YAxisValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('angularaxis', None) - self['angularaxis'] = angularaxis if angularaxis is not None else _v - _v = arg.pop('annotations', None) - self['annotations'] = annotations if annotations is not None else _v - _v = arg.pop('annotationdefaults', None) - self['annotationdefaults' - ] = annotationdefaults if annotationdefaults is not None else _v - _v = arg.pop('autosize', None) - self['autosize'] = autosize if autosize is not None else _v - _v = arg.pop('bargap', None) - self['bargap'] = bargap if bargap is not None else _v - _v = arg.pop('bargroupgap', None) - self['bargroupgap'] = bargroupgap if bargroupgap is not None else _v - _v = arg.pop('barmode', None) - self['barmode'] = barmode if barmode is not None else _v - _v = arg.pop('barnorm', None) - self['barnorm'] = barnorm if barnorm is not None else _v - _v = arg.pop('boxgap', None) - self['boxgap'] = boxgap if boxgap is not None else _v - _v = arg.pop('boxgroupgap', None) - self['boxgroupgap'] = boxgroupgap if boxgroupgap is not None else _v - _v = arg.pop('boxmode', None) - self['boxmode'] = boxmode if boxmode is not None else _v - _v = arg.pop('calendar', None) - self['calendar'] = calendar if calendar is not None else _v - _v = arg.pop('clickmode', None) - self['clickmode'] = clickmode if clickmode is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorway', None) - self['colorway'] = colorway if colorway is not None else _v - _v = arg.pop('datarevision', None) - self['datarevision'] = datarevision if datarevision is not None else _v - _v = arg.pop('direction', None) - self['direction'] = direction if direction is not None else _v - _v = arg.pop('dragmode', None) - self['dragmode'] = dragmode if dragmode is not None else _v - _v = arg.pop('editrevision', None) - self['editrevision'] = editrevision if editrevision is not None else _v - _v = arg.pop('extendpiecolors', None) - self['extendpiecolors' - ] = extendpiecolors if extendpiecolors is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('geo', None) - self['geo'] = geo if geo is not None else _v - _v = arg.pop('grid', None) - self['grid'] = grid if grid is not None else _v - _v = arg.pop('height', None) - self['height'] = height if height is not None else _v - _v = arg.pop('hiddenlabels', None) - self['hiddenlabels'] = hiddenlabels if hiddenlabels is not None else _v - _v = arg.pop('hiddenlabelssrc', None) - self['hiddenlabelssrc' - ] = hiddenlabelssrc if hiddenlabelssrc is not None else _v - _v = arg.pop('hidesources', None) - self['hidesources'] = hidesources if hidesources is not None else _v - _v = arg.pop('hoverdistance', None) - self['hoverdistance' - ] = hoverdistance if hoverdistance is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovermode', None) - self['hovermode'] = hovermode if hovermode is not None else _v - _v = arg.pop('images', None) - self['images'] = images if images is not None else _v - _v = arg.pop('imagedefaults', None) - self['imagedefaults' - ] = imagedefaults if imagedefaults is not None else _v - _v = arg.pop('legend', None) - self['legend'] = legend if legend is not None else _v - _v = arg.pop('mapbox', None) - self['mapbox'] = mapbox if mapbox is not None else _v - _v = arg.pop('margin', None) - self['margin'] = margin if margin is not None else _v - _v = arg.pop('meta', None) - self['meta'] = meta if meta is not None else _v - _v = arg.pop('metasrc', None) - self['metasrc'] = metasrc if metasrc is not None else _v - _v = arg.pop('modebar', None) - self['modebar'] = modebar if modebar is not None else _v - _v = arg.pop('orientation', None) - self['orientation'] = orientation if orientation is not None else _v - _v = arg.pop('paper_bgcolor', None) - self['paper_bgcolor' - ] = paper_bgcolor if paper_bgcolor is not None else _v - _v = arg.pop('piecolorway', None) - self['piecolorway'] = piecolorway if piecolorway is not None else _v - _v = arg.pop('plot_bgcolor', None) - self['plot_bgcolor'] = plot_bgcolor if plot_bgcolor is not None else _v - _v = arg.pop('polar', None) - self['polar'] = polar if polar is not None else _v - _v = arg.pop('radialaxis', None) - self['radialaxis'] = radialaxis if radialaxis is not None else _v - _v = arg.pop('scene', None) - self['scene'] = scene if scene is not None else _v - _v = arg.pop('selectdirection', None) - self['selectdirection' - ] = selectdirection if selectdirection is not None else _v - _v = arg.pop('selectionrevision', None) - self['selectionrevision' - ] = selectionrevision if selectionrevision is not None else _v - _v = arg.pop('separators', None) - self['separators'] = separators if separators is not None else _v - _v = arg.pop('shapes', None) - self['shapes'] = shapes if shapes is not None else _v - _v = arg.pop('shapedefaults', None) - self['shapedefaults' - ] = shapedefaults if shapedefaults is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('sliders', None) - self['sliders'] = sliders if sliders is not None else _v - _v = arg.pop('sliderdefaults', None) - self['sliderdefaults' - ] = sliderdefaults if sliderdefaults is not None else _v - _v = arg.pop('spikedistance', None) - self['spikedistance' - ] = spikedistance if spikedistance is not None else _v - _v = arg.pop('template', None) - _v = template if template is not None else _v - if _v is not None: - self['template'] = _v - _v = arg.pop('ternary', None) - self['ternary'] = ternary if ternary is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('transition', None) - self['transition'] = transition if transition is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('updatemenus', None) - self['updatemenus'] = updatemenus if updatemenus is not None else _v - _v = arg.pop('updatemenudefaults', None) - self['updatemenudefaults' - ] = updatemenudefaults if updatemenudefaults is not None else _v - _v = arg.pop('violingap', None) - self['violingap'] = violingap if violingap is not None else _v - _v = arg.pop('violingroupgap', None) - self['violingroupgap' - ] = violingroupgap if violingroupgap is not None else _v - _v = arg.pop('violinmode', None) - self['violinmode'] = violinmode if violinmode is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_mesh3d.py b/plotly/graph_objs/_mesh3d.py deleted file mode 100644 index aee1f42ddbe..00000000000 --- a/plotly/graph_objs/_mesh3d.py +++ /dev/null @@ -1,2601 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Mesh3d(BaseTraceType): - - # alphahull - # --------- - @property - def alphahull(self): - """ - Determines how the mesh surface triangles are derived from the - set of vertices (points) represented by the `x`, `y` and `z` - arrays, if the `i`, `j`, `k` arrays are not supplied. For - general use of `mesh3d` it is preferred that `i`, `j`, `k` are - supplied. If "-1", Delaunay triangulation is used, which is - mainly suitable if the mesh is a single, more or less layer - surface that is perpendicular to `delaunayaxis`. In case the - `delaunayaxis` intersects the mesh surface at more than one - point it will result triangles that are very long in the - dimension of `delaunayaxis`. If ">0", the alpha-shape algorithm - is used. In this case, the positive `alphahull` value signals - the use of the alpha-shape algorithm, _and_ its value acts as - the parameter for the mesh fitting. If 0, the convex-hull - algorithm is used. It is suitable for convex bodies or if the - intention is to enclose the `x`, `y` and `z` point set into a - convex hull. - - The 'alphahull' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['alphahull'] - - @alphahull.setter - def alphahull(self, val): - self['alphahull'] = val - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be chosen - according to whether numbers in the `color` array are all - positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here `intensity`) or the bounds set - in `cmin` and `cmax` Defaults to `false` when `cmin` and - `cmax` are set by the user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - 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 `intensity`. Has no effect when `cauto` is - `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to mesh3d.colorscale - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of plotly.graph_objs.mesh3d.ColorBar - - A dict of string/value properties that will be passed - to the ColorBar constructor - - Supported dict properties: - - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.mesh3d.colorbar.Tickformatsto - p instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.mesh3d.colorbar.tickformatstopdefaults), sets - the default property values to use for elements - of mesh3d.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.mesh3d.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - mesh3d.colorbar.title.font instead. Sets this - color bar's title font. Note that the title's - font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use - mesh3d.colorbar.title.side instead. Determines - the location of color bar's title with respect - to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.mesh3d.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. The colorscale must be an array containing - arrays mapping a normalized value to an rgb, rgba, hex, hsl, - hsv, or named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # contour - # ------- - @property - def contour(self): - """ - The 'contour' property is an instance of Contour - that may be specified as: - - An instance of plotly.graph_objs.mesh3d.Contour - - A dict of string/value properties that will be passed - to the Contour constructor - - Supported dict properties: - - color - Sets the color of the contour lines. - show - Sets whether or not dynamic contours are shown - on hover - width - Sets the width of the contour lines. - - Returns - ------- - plotly.graph_objs.mesh3d.Contour - """ - return self['contour'] - - @contour.setter - def contour(self, val): - self['contour'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # delaunayaxis - # ------------ - @property - def delaunayaxis(self): - """ - Sets the Delaunay axis, which is the axis that is perpendicular - to the surface of the Delaunay triangulation. It has an effect - if `i`, `j`, `k` are not provided and `alphahull` is set to - indicate Delaunay triangulation. - - The 'delaunayaxis' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['x', 'y', 'z'] - - Returns - ------- - Any - """ - return self['delaunayaxis'] - - @delaunayaxis.setter - def delaunayaxis(self, val): - self['delaunayaxis'] = val - - # facecolor - # --------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['facecolor'] - - @facecolor.setter - def facecolor(self, val): - self['facecolor'] = val - - # facecolorsrc - # ------------ - @property - def facecolorsrc(self): - """ - Sets the source reference on plot.ly for facecolor . - - The 'facecolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['facecolorsrc'] - - @facecolorsrc.setter - def facecolorsrc(self, val): - self['facecolorsrc'] = val - - # flatshading - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['flatshading'] - - @flatshading.setter - def flatshading(self, val): - self['flatshading'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.mesh3d.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.mesh3d.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # i - # - - @property - def i(self): - """ - A vector of vertex indices, i.e. integer values between 0 and - the length of the vertex vectors, representing the "first" - vertex of a triangle. For example, `{i[m], j[m], k[m]}` - together represent face m (triangle m) in the mesh, where `i[m] - = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex - arrays. Therefore, each element in `i` represents a point in - space, which is the first vertex of a triangle. - - The 'i' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['i'] - - @i.setter - def i(self, val): - self['i'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # intensity - # --------- - @property - def intensity(self): - """ - Sets the vertex intensity values, used for plotting fields on - meshes - - The 'intensity' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['intensity'] - - @intensity.setter - def intensity(self, val): - self['intensity'] = val - - # intensitysrc - # ------------ - @property - def intensitysrc(self): - """ - Sets the source reference on plot.ly for intensity . - - The 'intensitysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['intensitysrc'] - - @intensitysrc.setter - def intensitysrc(self, val): - self['intensitysrc'] = val - - # isrc - # ---- - @property - def isrc(self): - """ - Sets the source reference on plot.ly for i . - - The 'isrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['isrc'] - - @isrc.setter - def isrc(self, val): - self['isrc'] = val - - # j - # - - @property - def j(self): - """ - A vector of vertex indices, i.e. integer values between 0 and - the length of the vertex vectors, representing the "second" - vertex of a triangle. For example, `{i[m], j[m], k[m]}` - together represent face m (triangle m) in the mesh, where `j[m] - = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex - arrays. Therefore, each element in `j` represents a point in - space, which is the second vertex of a triangle. - - The 'j' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['j'] - - @j.setter - def j(self, val): - self['j'] = val - - # jsrc - # ---- - @property - def jsrc(self): - """ - Sets the source reference on plot.ly for j . - - The 'jsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['jsrc'] - - @jsrc.setter - def jsrc(self, val): - self['jsrc'] = val - - # k - # - - @property - def k(self): - """ - A vector of vertex indices, i.e. integer values between 0 and - the length of the vertex vectors, representing the "third" - vertex of a triangle. For example, `{i[m], j[m], k[m]}` - together represent face m (triangle m) in the mesh, where `k[m] - = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex - arrays. Therefore, each element in `k` represents a point in - space, which is the third vertex of a triangle. - - The 'k' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['k'] - - @k.setter - def k(self, val): - self['k'] = val - - # ksrc - # ---- - @property - def ksrc(self): - """ - Sets the source reference on plot.ly for k . - - The 'ksrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ksrc'] - - @ksrc.setter - def ksrc(self, val): - self['ksrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # lighting - # -------- - @property - def lighting(self): - """ - The 'lighting' property is an instance of Lighting - that may be specified as: - - An instance of plotly.graph_objs.mesh3d.Lighting - - A dict of string/value properties that will be passed - to the Lighting constructor - - Supported dict properties: - - ambient - Ambient light increases overall color - visibility but can wash out the image. - diffuse - Represents the extent that incident rays are - reflected in a range of angles. - facenormalsepsilon - Epsilon for face normals calculation avoids - math issues arising from degenerate geometry. - fresnel - Represents the reflectance as a dependency of - the viewing angle; e.g. paper is reflective - when viewing it from the edge of the paper - (almost 90 degrees), causing shine. - roughness - Alters specular reflection; the rougher the - surface, the wider and less contrasty the - shine. - specular - Represents the level that incident rays are - reflected in a single direction, causing shine. - vertexnormalsepsilon - Epsilon for vertex normals calculation avoids - math issues arising from degenerate geometry. - - Returns - ------- - plotly.graph_objs.mesh3d.Lighting - """ - return self['lighting'] - - @lighting.setter - def lighting(self, val): - self['lighting'] = val - - # lightposition - # ------------- - @property - def lightposition(self): - """ - The 'lightposition' property is an instance of Lightposition - that may be specified as: - - An instance of plotly.graph_objs.mesh3d.Lightposition - - A dict of string/value properties that will be passed - to the Lightposition constructor - - Supported dict properties: - - x - Numeric vector, representing the X coordinate - for each vertex. - y - Numeric vector, representing the Y coordinate - for each vertex. - z - Numeric vector, representing the Z coordinate - for each vertex. - - Returns - ------- - plotly.graph_objs.mesh3d.Lightposition - """ - return self['lightposition'] - - @lightposition.setter - def lightposition(self, val): - self['lightposition'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - def opacity(self): - """ - Sets the opacity of the surface. Please note that in the case - of using high `opacity` values for example a value greater than - or equal to 0.5 on two surfaces (and 0.25 with four surfaces), - an overlay of multiple transparent surfaces may not perfectly - be sorted in depth by the webgl API. This behavior may be - improved in the near future and is subject to change. - - The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # reversescale - # ------------ - @property - 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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # scene - # ----- - @property - def scene(self): - """ - Sets a reference between this trace's 3D coordinate system and - a 3D scene. If "scene" (the default value), the (x,y,z) - coordinates refer to `layout.scene`. If "scene2", the (x,y,z) - coordinates refer to `layout.scene2`, and so on. - - The 'scene' property is an identifier of a particular - subplot, of type 'scene', that may be specified as the string 'scene' - optionally followed by an integer >= 1 - (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) - - Returns - ------- - str - """ - return self['scene'] - - @scene.setter - def scene(self, val): - self['scene'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.mesh3d.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.mesh3d.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # vertexcolor - # ----------- - @property - def vertexcolor(self): - """ - Sets the color of each vertex Overrides "color". - - The 'vertexcolor' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['vertexcolor'] - - @vertexcolor.setter - def vertexcolor(self, val): - self['vertexcolor'] = val - - # vertexcolorsrc - # -------------- - @property - def vertexcolorsrc(self): - """ - Sets the source reference on plot.ly for vertexcolor . - - The 'vertexcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['vertexcolorsrc'] - - @vertexcolorsrc.setter - def vertexcolorsrc(self, val): - self['vertexcolorsrc'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['xcalendar'] - - @xcalendar.setter - def xcalendar(self, val): - self['xcalendar'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # ycalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['ycalendar'] - - @ycalendar.setter - def ycalendar(self, val): - self['ycalendar'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # z - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # zcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['zcalendar'] - - @zcalendar.setter - def zcalendar(self, val): - self['zcalendar'] = val - - # zsrc - # ---- - @property - def zsrc(self): - """ - Sets the source reference on plot.ly for z . - - The 'zsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['zsrc'] - - @zsrc.setter - def zsrc(self, val): - self['zsrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - alphahull - Determines how the mesh surface triangles are derived - from the set of vertices (points) represented by the - `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays - are not supplied. For general use of `mesh3d` it is - preferred that `i`, `j`, `k` are supplied. If "-1", - Delaunay triangulation is used, which is mainly - suitable if the mesh is a single, more or less layer - surface that is perpendicular to `delaunayaxis`. In - case the `delaunayaxis` intersects the mesh surface at - more than one point it will result triangles that are - very long in the dimension of `delaunayaxis`. If ">0", - the alpha-shape algorithm is used. In this case, the - positive `alphahull` value signals the use of the - alpha-shape algorithm, _and_ its value acts as the - parameter for the mesh fitting. If 0, the convex-hull - algorithm is used. It is suitable for convex bodies or - if the intention is to enclose the `x`, `y` and `z` - point set into a convex hull. - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here `intensity`) or - the bounds set in `cmin` and `cmax` Defaults to - `false` when `cmin` and `cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Value should - have the same units as `intensity` and if set, `cmin` - must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `cmin` and/or `cmax` to be equidistant to this point. - Value should have the same units as `intensity`. Has no - effect when `cauto` is `false`. - cmin - Sets the lower bound of the color domain. Value should - have the same units as `intensity` and if set, `cmax` - must be set as well. - color - Sets the color of the whole mesh - colorbar - plotly.graph_objs.mesh3d.ColorBar instance or dict with - compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - contour - plotly.graph_objs.mesh3d.Contour instance or dict with - compatible properties - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - delaunayaxis - Sets the Delaunay axis, which is the axis that is - perpendicular to the surface of the Delaunay - triangulation. It has an effect if `i`, `j`, `k` are - not provided and `alphahull` is set to indicate - Delaunay triangulation. - facecolor - Sets the color of each face Overrides "color" and - "vertexcolor". - facecolorsrc - Sets the source reference on plot.ly for facecolor . - flatshading - Determines whether or not normal smoothing is applied - to the meshes, creating meshes with an angular, low- - poly look via flat reflections. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.mesh3d.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - i - A vector of vertex indices, i.e. integer values between - 0 and the length of the vertex vectors, representing - the "first" vertex of a triangle. For example, `{i[m], - j[m], k[m]}` together represent face m (triangle m) in - the mesh, where `i[m] = n` points to the triplet - `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, - each element in `i` represents a point in space, which - is the first vertex of a triangle. - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - intensity - Sets the vertex intensity values, used for plotting - fields on meshes - intensitysrc - Sets the source reference on plot.ly for intensity . - isrc - Sets the source reference on plot.ly for i . - j - A vector of vertex indices, i.e. integer values between - 0 and the length of the vertex vectors, representing - the "second" vertex of a triangle. For example, `{i[m], - j[m], k[m]}` together represent face m (triangle m) in - the mesh, where `j[m] = n` points to the triplet - `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, - each element in `j` represents a point in space, which - is the second vertex of a triangle. - jsrc - Sets the source reference on plot.ly for j . - k - A vector of vertex indices, i.e. integer values between - 0 and the length of the vertex vectors, representing - the "third" vertex of a triangle. For example, `{i[m], - j[m], k[m]}` together represent face m (triangle m) in - the mesh, where `k[m] = n` points to the triplet - `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, - each element in `k` represents a point in space, which - is the third vertex of a triangle. - ksrc - Sets the source reference on plot.ly for k . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - lighting - plotly.graph_objs.mesh3d.Lighting instance or dict with - compatible properties - lightposition - plotly.graph_objs.mesh3d.Lightposition instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the surface. Please note that in - the case of using high `opacity` values for example a - value greater than or equal to 0.5 on two surfaces (and - 0.25 with four surfaces), an overlay of multiple - transparent surfaces may not perfectly be sorted in - depth by the webgl API. This behavior may be improved - in the near future and is subject to change. - reversescale - Reverses the color mapping if true. If true, `cmin` - will correspond to the last color in the array and - `cmax` will correspond to the first color. - scene - Sets a reference between this trace's 3D coordinate - system and a 3D scene. If "scene" (the default value), - the (x,y,z) coordinates refer to `layout.scene`. If - "scene2", the (x,y,z) coordinates refer to - `layout.scene2`, and so on. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.mesh3d.Stream instance or dict with - compatible properties - text - Sets the text elements associated with the vertices. If - trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - vertexcolor - Sets the color of each vertex Overrides "color". - vertexcolorsrc - Sets the source reference on plot.ly for vertexcolor . - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the X coordinates of the vertices. The nth element - of vectors `x`, `y` and `z` jointly represent the X, Y - and Z coordinates of the nth vertex. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the Y coordinates of the vertices. The nth element - of vectors `x`, `y` and `z` jointly represent the X, Y - and Z coordinates of the nth vertex. - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the Z coordinates of the vertices. The nth element - of vectors `x`, `y` and `z` jointly represent the X, Y - and Z coordinates of the nth vertex. - zcalendar - Sets the calendar system to use with `z` date data. - zsrc - Sets the source reference on plot.ly for z . - """ - - def __init__( - self, - arg=None, - alphahull=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorbar=None, - colorscale=None, - contour=None, - customdata=None, - customdatasrc=None, - delaunayaxis=None, - facecolor=None, - facecolorsrc=None, - flatshading=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - i=None, - ids=None, - idssrc=None, - intensity=None, - intensitysrc=None, - isrc=None, - j=None, - jsrc=None, - k=None, - ksrc=None, - legendgroup=None, - lighting=None, - lightposition=None, - name=None, - opacity=None, - reversescale=None, - scene=None, - selectedpoints=None, - showlegend=None, - showscale=None, - stream=None, - text=None, - textsrc=None, - uid=None, - uirevision=None, - vertexcolor=None, - vertexcolorsrc=None, - visible=None, - x=None, - xcalendar=None, - xsrc=None, - y=None, - ycalendar=None, - ysrc=None, - z=None, - zcalendar=None, - zsrc=None, - **kwargs - ): - """ - Construct a new Mesh3d object - - Draws sets of triangles with coordinates given by three - 1-dimensional arrays in `x`, `y`, `z` and (1) a sets of `i`, - `j`, `k` indices (2) Delaunay triangulation or (3) the Alpha- - shape algorithm or (4) the Convex-hull algorithm - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Mesh3d - alphahull - Determines how the mesh surface triangles are derived - from the set of vertices (points) represented by the - `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays - are not supplied. For general use of `mesh3d` it is - preferred that `i`, `j`, `k` are supplied. If "-1", - Delaunay triangulation is used, which is mainly - suitable if the mesh is a single, more or less layer - surface that is perpendicular to `delaunayaxis`. In - case the `delaunayaxis` intersects the mesh surface at - more than one point it will result triangles that are - very long in the dimension of `delaunayaxis`. If ">0", - the alpha-shape algorithm is used. In this case, the - positive `alphahull` value signals the use of the - alpha-shape algorithm, _and_ its value acts as the - parameter for the mesh fitting. If 0, the convex-hull - algorithm is used. It is suitable for convex bodies or - if the intention is to enclose the `x`, `y` and `z` - point set into a convex hull. - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here `intensity`) or - the bounds set in `cmin` and `cmax` Defaults to - `false` when `cmin` and `cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Value should - have the same units as `intensity` and if set, `cmin` - must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `cmin` and/or `cmax` to be equidistant to this point. - Value should have the same units as `intensity`. Has no - effect when `cauto` is `false`. - cmin - Sets the lower bound of the color domain. Value should - have the same units as `intensity` and if set, `cmax` - must be set as well. - color - Sets the color of the whole mesh - colorbar - plotly.graph_objs.mesh3d.ColorBar instance or dict with - compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - contour - plotly.graph_objs.mesh3d.Contour instance or dict with - compatible properties - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - delaunayaxis - Sets the Delaunay axis, which is the axis that is - perpendicular to the surface of the Delaunay - triangulation. It has an effect if `i`, `j`, `k` are - not provided and `alphahull` is set to indicate - Delaunay triangulation. - facecolor - Sets the color of each face Overrides "color" and - "vertexcolor". - facecolorsrc - Sets the source reference on plot.ly for facecolor . - flatshading - Determines whether or not normal smoothing is applied - to the meshes, creating meshes with an angular, low- - poly look via flat reflections. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.mesh3d.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - i - A vector of vertex indices, i.e. integer values between - 0 and the length of the vertex vectors, representing - the "first" vertex of a triangle. For example, `{i[m], - j[m], k[m]}` together represent face m (triangle m) in - the mesh, where `i[m] = n` points to the triplet - `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, - each element in `i` represents a point in space, which - is the first vertex of a triangle. - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - intensity - Sets the vertex intensity values, used for plotting - fields on meshes - intensitysrc - Sets the source reference on plot.ly for intensity . - isrc - Sets the source reference on plot.ly for i . - j - A vector of vertex indices, i.e. integer values between - 0 and the length of the vertex vectors, representing - the "second" vertex of a triangle. For example, `{i[m], - j[m], k[m]}` together represent face m (triangle m) in - the mesh, where `j[m] = n` points to the triplet - `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, - each element in `j` represents a point in space, which - is the second vertex of a triangle. - jsrc - Sets the source reference on plot.ly for j . - k - A vector of vertex indices, i.e. integer values between - 0 and the length of the vertex vectors, representing - the "third" vertex of a triangle. For example, `{i[m], - j[m], k[m]}` together represent face m (triangle m) in - the mesh, where `k[m] = n` points to the triplet - `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, - each element in `k` represents a point in space, which - is the third vertex of a triangle. - ksrc - Sets the source reference on plot.ly for k . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - lighting - plotly.graph_objs.mesh3d.Lighting instance or dict with - compatible properties - lightposition - plotly.graph_objs.mesh3d.Lightposition instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the surface. Please note that in - the case of using high `opacity` values for example a - value greater than or equal to 0.5 on two surfaces (and - 0.25 with four surfaces), an overlay of multiple - transparent surfaces may not perfectly be sorted in - depth by the webgl API. This behavior may be improved - in the near future and is subject to change. - reversescale - Reverses the color mapping if true. If true, `cmin` - will correspond to the last color in the array and - `cmax` will correspond to the first color. - scene - Sets a reference between this trace's 3D coordinate - system and a 3D scene. If "scene" (the default value), - the (x,y,z) coordinates refer to `layout.scene`. If - "scene2", the (x,y,z) coordinates refer to - `layout.scene2`, and so on. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.mesh3d.Stream instance or dict with - compatible properties - text - Sets the text elements associated with the vertices. If - trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - vertexcolor - Sets the color of each vertex Overrides "color". - vertexcolorsrc - Sets the source reference on plot.ly for vertexcolor . - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the X coordinates of the vertices. The nth element - of vectors `x`, `y` and `z` jointly represent the X, Y - and Z coordinates of the nth vertex. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the Y coordinates of the vertices. The nth element - of vectors `x`, `y` and `z` jointly represent the X, Y - and Z coordinates of the nth vertex. - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the Z coordinates of the vertices. The nth element - of vectors `x`, `y` and `z` jointly represent the X, Y - and Z coordinates of the nth vertex. - zcalendar - Sets the calendar system to use with `z` date data. - zsrc - Sets the source reference on plot.ly for z . - - Returns - ------- - Mesh3d - """ - super(Mesh3d, self).__init__('mesh3d') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Mesh3d -constructor must be a dict or -an instance of plotly.graph_objs.Mesh3d""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (mesh3d as v_mesh3d) - - # Initialize validators - # --------------------- - self._validators['alphahull'] = v_mesh3d.AlphahullValidator() - self._validators['autocolorscale'] = v_mesh3d.AutocolorscaleValidator() - self._validators['cauto'] = v_mesh3d.CautoValidator() - self._validators['cmax'] = v_mesh3d.CmaxValidator() - self._validators['cmid'] = v_mesh3d.CmidValidator() - self._validators['cmin'] = v_mesh3d.CminValidator() - self._validators['color'] = v_mesh3d.ColorValidator() - self._validators['colorbar'] = v_mesh3d.ColorBarValidator() - self._validators['colorscale'] = v_mesh3d.ColorscaleValidator() - self._validators['contour'] = v_mesh3d.ContourValidator() - self._validators['customdata'] = v_mesh3d.CustomdataValidator() - self._validators['customdatasrc'] = v_mesh3d.CustomdatasrcValidator() - self._validators['delaunayaxis'] = v_mesh3d.DelaunayaxisValidator() - self._validators['facecolor'] = v_mesh3d.FacecolorValidator() - self._validators['facecolorsrc'] = v_mesh3d.FacecolorsrcValidator() - self._validators['flatshading'] = v_mesh3d.FlatshadingValidator() - self._validators['hoverinfo'] = v_mesh3d.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_mesh3d.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_mesh3d.HoverlabelValidator() - self._validators['hovertemplate'] = v_mesh3d.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_mesh3d.HovertemplatesrcValidator() - self._validators['hovertext'] = v_mesh3d.HovertextValidator() - self._validators['hovertextsrc'] = v_mesh3d.HovertextsrcValidator() - self._validators['i'] = v_mesh3d.IValidator() - self._validators['ids'] = v_mesh3d.IdsValidator() - self._validators['idssrc'] = v_mesh3d.IdssrcValidator() - self._validators['intensity'] = v_mesh3d.IntensityValidator() - self._validators['intensitysrc'] = v_mesh3d.IntensitysrcValidator() - self._validators['isrc'] = v_mesh3d.IsrcValidator() - self._validators['j'] = v_mesh3d.JValidator() - self._validators['jsrc'] = v_mesh3d.JsrcValidator() - self._validators['k'] = v_mesh3d.KValidator() - self._validators['ksrc'] = v_mesh3d.KsrcValidator() - self._validators['legendgroup'] = v_mesh3d.LegendgroupValidator() - self._validators['lighting'] = v_mesh3d.LightingValidator() - self._validators['lightposition'] = v_mesh3d.LightpositionValidator() - self._validators['name'] = v_mesh3d.NameValidator() - self._validators['opacity'] = v_mesh3d.OpacityValidator() - self._validators['reversescale'] = v_mesh3d.ReversescaleValidator() - self._validators['scene'] = v_mesh3d.SceneValidator() - self._validators['selectedpoints'] = v_mesh3d.SelectedpointsValidator() - self._validators['showlegend'] = v_mesh3d.ShowlegendValidator() - self._validators['showscale'] = v_mesh3d.ShowscaleValidator() - self._validators['stream'] = v_mesh3d.StreamValidator() - self._validators['text'] = v_mesh3d.TextValidator() - self._validators['textsrc'] = v_mesh3d.TextsrcValidator() - self._validators['uid'] = v_mesh3d.UidValidator() - self._validators['uirevision'] = v_mesh3d.UirevisionValidator() - self._validators['vertexcolor'] = v_mesh3d.VertexcolorValidator() - self._validators['vertexcolorsrc'] = v_mesh3d.VertexcolorsrcValidator() - self._validators['visible'] = v_mesh3d.VisibleValidator() - self._validators['x'] = v_mesh3d.XValidator() - self._validators['xcalendar'] = v_mesh3d.XcalendarValidator() - self._validators['xsrc'] = v_mesh3d.XsrcValidator() - self._validators['y'] = v_mesh3d.YValidator() - self._validators['ycalendar'] = v_mesh3d.YcalendarValidator() - self._validators['ysrc'] = v_mesh3d.YsrcValidator() - self._validators['z'] = v_mesh3d.ZValidator() - self._validators['zcalendar'] = v_mesh3d.ZcalendarValidator() - self._validators['zsrc'] = v_mesh3d.ZsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('alphahull', None) - self['alphahull'] = alphahull if alphahull is not None else _v - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('contour', None) - self['contour'] = contour if contour is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('delaunayaxis', None) - self['delaunayaxis'] = delaunayaxis if delaunayaxis is not None else _v - _v = arg.pop('facecolor', None) - self['facecolor'] = facecolor if facecolor is not None else _v - _v = arg.pop('facecolorsrc', None) - self['facecolorsrc'] = facecolorsrc if facecolorsrc is not None else _v - _v = arg.pop('flatshading', None) - self['flatshading'] = flatshading if flatshading is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('i', None) - self['i'] = i if i is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('intensity', None) - self['intensity'] = intensity if intensity is not None else _v - _v = arg.pop('intensitysrc', None) - self['intensitysrc'] = intensitysrc if intensitysrc is not None else _v - _v = arg.pop('isrc', None) - self['isrc'] = isrc if isrc is not None else _v - _v = arg.pop('j', None) - self['j'] = j if j is not None else _v - _v = arg.pop('jsrc', None) - self['jsrc'] = jsrc if jsrc is not None else _v - _v = arg.pop('k', None) - self['k'] = k if k is not None else _v - _v = arg.pop('ksrc', None) - self['ksrc'] = ksrc if ksrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('lighting', None) - self['lighting'] = lighting if lighting is not None else _v - _v = arg.pop('lightposition', None) - self['lightposition' - ] = lightposition if lightposition is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('scene', None) - self['scene'] = scene if scene is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('vertexcolor', None) - self['vertexcolor'] = vertexcolor if vertexcolor is not None else _v - _v = arg.pop('vertexcolorsrc', None) - self['vertexcolorsrc' - ] = vertexcolorsrc if vertexcolorsrc is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xcalendar', None) - self['xcalendar'] = xcalendar if xcalendar is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('ycalendar', None) - self['ycalendar'] = ycalendar if ycalendar is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - _v = arg.pop('zcalendar', None) - self['zcalendar'] = zcalendar if zcalendar is not None else _v - _v = arg.pop('zsrc', None) - self['zsrc'] = zsrc if zsrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'mesh3d' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='mesh3d', val='mesh3d' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_ohlc.py b/plotly/graph_objs/_ohlc.py deleted file mode 100644 index 99627601c84..00000000000 --- a/plotly/graph_objs/_ohlc.py +++ /dev/null @@ -1,1385 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Ohlc(BaseTraceType): - - # close - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['close'] - - @close.setter - def close(self, val): - self['close'] = val - - # closesrc - # -------- - @property - def closesrc(self): - """ - Sets the source reference on plot.ly for close . - - The 'closesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['closesrc'] - - @closesrc.setter - def closesrc(self, val): - self['closesrc'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # decreasing - # ---------- - @property - def decreasing(self): - """ - The 'decreasing' property is an instance of Decreasing - that may be specified as: - - An instance of plotly.graph_objs.ohlc.Decreasing - - A dict of string/value properties that will be passed - to the Decreasing constructor - - Supported dict properties: - - line - plotly.graph_objs.ohlc.decreasing.Line instance - or dict with compatible properties - - Returns - ------- - plotly.graph_objs.ohlc.Decreasing - """ - return self['decreasing'] - - @decreasing.setter - def decreasing(self, val): - self['decreasing'] = val - - # high - # ---- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['high'] - - @high.setter - def high(self, val): - self['high'] = val - - # highsrc - # ------- - @property - def highsrc(self): - """ - Sets the source reference on plot.ly for high . - - The 'highsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['highsrc'] - - @highsrc.setter - def highsrc(self, val): - self['highsrc'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.ohlc.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - split - Show hover information (open, close, high, low) - in separate labels. - - Returns - ------- - plotly.graph_objs.ohlc.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertext - # --------- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # increasing - # ---------- - @property - def increasing(self): - """ - The 'increasing' property is an instance of Increasing - that may be specified as: - - An instance of plotly.graph_objs.ohlc.Increasing - - A dict of string/value properties that will be passed - to the Increasing constructor - - Supported dict properties: - - line - plotly.graph_objs.ohlc.increasing.Line instance - or dict with compatible properties - - Returns - ------- - plotly.graph_objs.ohlc.Increasing - """ - return self['increasing'] - - @increasing.setter - def increasing(self, val): - self['increasing'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of plotly.graph_objs.ohlc.Line - - A dict of string/value properties that will be passed - to the Line constructor - - Supported dict properties: - - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - Note that this style setting can also be set - per direction via `increasing.line.dash` and - `decreasing.line.dash`. - width - [object Object] Note that this style setting - can also be set per direction via - `increasing.line.width` and - `decreasing.line.width`. - - Returns - ------- - plotly.graph_objs.ohlc.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # low - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['low'] - - @low.setter - def low(self, val): - self['low'] = val - - # lowsrc - # ------ - @property - def lowsrc(self): - """ - Sets the source reference on plot.ly for low . - - The 'lowsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['lowsrc'] - - @lowsrc.setter - def lowsrc(self, val): - self['lowsrc'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # open - # ---- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['open'] - - @open.setter - def open(self, val): - self['open'] = val - - # opensrc - # ------- - @property - def opensrc(self): - """ - Sets the source reference on plot.ly for open . - - The 'opensrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['opensrc'] - - @opensrc.setter - def opensrc(self, val): - self['opensrc'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.ohlc.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.ohlc.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - def text(self): - """ - Sets hover text elements associated with each sample point. If - a single string, the same string appears over all the data - points. If an array of string, the items are mapped in order to - this trace's sample points. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # xcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['xcalendar'] - - @xcalendar.setter - def xcalendar(self, val): - self['xcalendar'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - close - Sets the close values. - closesrc - Sets the source reference on plot.ly for close . - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - decreasing - plotly.graph_objs.ohlc.Decreasing instance or dict with - compatible properties - high - Sets the high values. - highsrc - Sets the source reference on plot.ly for high . - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.ohlc.Hoverlabel instance or dict with - compatible properties - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - increasing - plotly.graph_objs.ohlc.Increasing instance or dict with - compatible properties - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.ohlc.Line instance or dict with - compatible properties - low - Sets the low values. - lowsrc - Sets the source reference on plot.ly for low . - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - open - Sets the open values. - opensrc - Sets the source reference on plot.ly for open . - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.ohlc.Stream instance or dict with - compatible properties - text - Sets hover text elements associated with each sample - point. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to this trace's sample points. - textsrc - Sets the source reference on plot.ly for text . - tickwidth - Sets the width of the open/close tick marks relative to - the "x" minimal interval. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. If absent, linear coordinate - will be generated. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - """ - - def __init__( - self, - arg=None, - close=None, - closesrc=None, - customdata=None, - customdatasrc=None, - decreasing=None, - high=None, - highsrc=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - increasing=None, - legendgroup=None, - line=None, - low=None, - lowsrc=None, - name=None, - opacity=None, - open=None, - opensrc=None, - selectedpoints=None, - showlegend=None, - stream=None, - text=None, - textsrc=None, - tickwidth=None, - uid=None, - uirevision=None, - visible=None, - x=None, - xaxis=None, - xcalendar=None, - xsrc=None, - yaxis=None, - **kwargs - ): - """ - Construct a new Ohlc object - - The ohlc (short for Open-High-Low-Close) is a style of - financial chart describing open, high, low and close for a - given `x` coordinate (most likely time). The tip of the lines - represent the `low` and `high` values and the horizontal - segments represent the `open` and `close` values. Sample points - where the close value is higher (lower) then the open value are - called increasing (decreasing). By default, increasing items - are drawn in green whereas decreasing are drawn in red. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Ohlc - close - Sets the close values. - closesrc - Sets the source reference on plot.ly for close . - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - decreasing - plotly.graph_objs.ohlc.Decreasing instance or dict with - compatible properties - high - Sets the high values. - highsrc - Sets the source reference on plot.ly for high . - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.ohlc.Hoverlabel instance or dict with - compatible properties - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - increasing - plotly.graph_objs.ohlc.Increasing instance or dict with - compatible properties - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.ohlc.Line instance or dict with - compatible properties - low - Sets the low values. - lowsrc - Sets the source reference on plot.ly for low . - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - open - Sets the open values. - opensrc - Sets the source reference on plot.ly for open . - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.ohlc.Stream instance or dict with - compatible properties - text - Sets hover text elements associated with each sample - point. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to this trace's sample points. - textsrc - Sets the source reference on plot.ly for text . - tickwidth - Sets the width of the open/close tick marks relative to - the "x" minimal interval. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. If absent, linear coordinate - will be generated. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - - Returns - ------- - Ohlc - """ - super(Ohlc, self).__init__('ohlc') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Ohlc -constructor must be a dict or -an instance of plotly.graph_objs.Ohlc""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (ohlc as v_ohlc) - - # Initialize validators - # --------------------- - self._validators['close'] = v_ohlc.CloseValidator() - self._validators['closesrc'] = v_ohlc.ClosesrcValidator() - self._validators['customdata'] = v_ohlc.CustomdataValidator() - self._validators['customdatasrc'] = v_ohlc.CustomdatasrcValidator() - self._validators['decreasing'] = v_ohlc.DecreasingValidator() - self._validators['high'] = v_ohlc.HighValidator() - self._validators['highsrc'] = v_ohlc.HighsrcValidator() - self._validators['hoverinfo'] = v_ohlc.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_ohlc.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_ohlc.HoverlabelValidator() - self._validators['hovertext'] = v_ohlc.HovertextValidator() - self._validators['hovertextsrc'] = v_ohlc.HovertextsrcValidator() - self._validators['ids'] = v_ohlc.IdsValidator() - self._validators['idssrc'] = v_ohlc.IdssrcValidator() - self._validators['increasing'] = v_ohlc.IncreasingValidator() - self._validators['legendgroup'] = v_ohlc.LegendgroupValidator() - self._validators['line'] = v_ohlc.LineValidator() - self._validators['low'] = v_ohlc.LowValidator() - self._validators['lowsrc'] = v_ohlc.LowsrcValidator() - self._validators['name'] = v_ohlc.NameValidator() - self._validators['opacity'] = v_ohlc.OpacityValidator() - self._validators['open'] = v_ohlc.OpenValidator() - self._validators['opensrc'] = v_ohlc.OpensrcValidator() - self._validators['selectedpoints'] = v_ohlc.SelectedpointsValidator() - self._validators['showlegend'] = v_ohlc.ShowlegendValidator() - self._validators['stream'] = v_ohlc.StreamValidator() - self._validators['text'] = v_ohlc.TextValidator() - self._validators['textsrc'] = v_ohlc.TextsrcValidator() - self._validators['tickwidth'] = v_ohlc.TickwidthValidator() - self._validators['uid'] = v_ohlc.UidValidator() - self._validators['uirevision'] = v_ohlc.UirevisionValidator() - self._validators['visible'] = v_ohlc.VisibleValidator() - self._validators['x'] = v_ohlc.XValidator() - self._validators['xaxis'] = v_ohlc.XAxisValidator() - self._validators['xcalendar'] = v_ohlc.XcalendarValidator() - self._validators['xsrc'] = v_ohlc.XsrcValidator() - self._validators['yaxis'] = v_ohlc.YAxisValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('close', None) - self['close'] = close if close is not None else _v - _v = arg.pop('closesrc', None) - self['closesrc'] = closesrc if closesrc is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('decreasing', None) - self['decreasing'] = decreasing if decreasing is not None else _v - _v = arg.pop('high', None) - self['high'] = high if high is not None else _v - _v = arg.pop('highsrc', None) - self['highsrc'] = highsrc if highsrc is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('increasing', None) - self['increasing'] = increasing if increasing is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('low', None) - self['low'] = low if low is not None else _v - _v = arg.pop('lowsrc', None) - self['lowsrc'] = lowsrc if lowsrc is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('open', None) - self['open'] = open if open is not None else _v - _v = arg.pop('opensrc', None) - self['opensrc'] = opensrc if opensrc is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('xcalendar', None) - self['xcalendar'] = xcalendar if xcalendar is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'ohlc' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='ohlc', val='ohlc' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_parcats.py b/plotly/graph_objs/_parcats.py deleted file mode 100644 index b7db3a912ac..00000000000 --- a/plotly/graph_objs/_parcats.py +++ /dev/null @@ -1,1062 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Parcats(BaseTraceType): - - # arrangement - # ----------- - @property - def arrangement(self): - """ - Sets the drag interaction mode for categories and dimensions. - If `perpendicular`, the categories can only move along a line - perpendicular to the paths. If `freeform`, the categories can - freely move on the plane. If `fixed`, the categories and - dimensions are stationary. - - The 'arrangement' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['perpendicular', 'freeform', 'fixed'] - - Returns - ------- - Any - """ - return self['arrangement'] - - @arrangement.setter - def arrangement(self, val): - self['arrangement'] = val - - # bundlecolors - # ------------ - @property - 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) - - Returns - ------- - bool - """ - return self['bundlecolors'] - - @bundlecolors.setter - def bundlecolors(self, val): - self['bundlecolors'] = val - - # counts - # ------ - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['counts'] - - @counts.setter - def counts(self, val): - self['counts'] = val - - # countssrc - # --------- - @property - def countssrc(self): - """ - Sets the source reference on plot.ly for counts . - - The 'countssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['countssrc'] - - @countssrc.setter - def countssrc(self, val): - self['countssrc'] = val - - # dimensions - # ---------- - @property - 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 - `categoryorder` is set to "array". Used with - `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the categories - in the dimension. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - displayindex - The display index of dimension, from left to - right, zero indexed, defaults to dimension - index. - label - The shown name of the dimension. - ticktext - Sets alternative tick labels for the categories - in this dimension. Only has an effect if - `categoryorder` is set to "array". Should be an - array the same length as `categoryarray` Used - with `categoryorder`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - values - Dimension values. `values[n]` represents the - category value of the `n`th point in the - dataset, therefore the `values` vector for all - dimensions must be the same (longer vectors - will be truncated). - valuessrc - Sets the source reference on plot.ly for - values . - visible - Shows the dimension when set to `true` (the - default). Hides the dimension for `false`. - - Returns - ------- - tuple[plotly.graph_objs.parcats.Dimension] - """ - return self['dimensions'] - - @dimensions.setter - def dimensions(self, val): - self['dimensions'] = val - - # dimensiondefaults - # ----------------- - @property - def dimensiondefaults(self): - """ - When used in a template (as - layout.template.data.parcats.dimensiondefaults), sets the - default property values to use for elements of - parcats.dimensions - - The 'dimensiondefaults' property is an instance of Dimension - that may be specified as: - - An instance of plotly.graph_objs.parcats.Dimension - - A dict of string/value properties that will be passed - to the Dimension constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.parcats.Dimension - """ - return self['dimensiondefaults'] - - @dimensiondefaults.setter - def dimensiondefaults(self, val): - self['dimensiondefaults'] = val - - # domain - # ------ - @property - def domain(self): - """ - The 'domain' property is an instance of Domain - that may be specified as: - - An instance of plotly.graph_objs.parcats.Domain - - A dict of string/value properties that will be passed - to the Domain constructor - - Supported dict properties: - - column - If there is a layout grid, use the domain for - this column in the grid for this parcats trace - . - row - If there is a layout grid, use the domain for - this row in the grid for this parcats trace . - x - Sets the horizontal domain of this parcats - trace (in plot fraction). - y - Sets the vertical domain of this parcats trace - (in plot fraction). - - Returns - ------- - plotly.graph_objs.parcats.Domain - """ - return self['domain'] - - @domain.setter - def domain(self, val): - self['domain'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'count+probability') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - Returns - ------- - Any - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoveron - # ------- - @property - def hoveron(self): - """ - Sets the hover interaction mode for the parcats diagram. If - `category`, hover interaction take place per category. If - `color`, hover interactions take place per color per category. - If `dimension`, hover interactions take place across all - categories per dimension. - - The 'hoveron' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['category', 'color', 'dimension'] - - Returns - ------- - Any - """ - return self['hoveron'] - - @hoveron.setter - def hoveron(self, val): - self['hoveron'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - variables `count`, `probability`, `category`, `categorycount`, - `colorcount` and `bandcolorcount`. Anything contained in tag - `` is displayed in the secondary box, for example - "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # labelfont - # --------- - @property - 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 plotly.graph_objs.parcats.Labelfont - - A dict of string/value properties that will be passed - to the Labelfont constructor - - Supported dict properties: - - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.parcats.Labelfont - """ - return self['labelfont'] - - @labelfont.setter - def labelfont(self, val): - self['labelfont'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of plotly.graph_objs.parcats.Line - - A dict of string/value properties that will be passed - to the Line constructor - - Supported dict properties: - - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `line.colorscale`. Has an effect - only if in `line.color`is set to a numerical - array. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette - will be chosen according to whether numbers in - the `color` array are all positive, all - negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `line.color`) or the bounds set in - `line.cmin` and `line.cmax` Has an effect only - if in `line.color`is set to a numerical array. - Defaults to `false` when `line.cmin` and - `line.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `line.color`is set to a - numerical array. Value should have the same - units as in `line.color` and if set, - `line.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `line.cmin` and/or `line.cmax` to be - equidistant to this point. Has an effect only - if in `line.color`is set to a numerical array. - Value should have the same units as in - `line.color`. Has no effect when `line.cauto` - is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `line.color`is set to a - numerical array. Value should have the same - units as in `line.color` and if set, - `line.cmax` must be set as well. - color - Sets thelinecolor. It accepts either a specific - color or an array of numbers that are mapped to - the colorscale relative to the max and min - values of the array or relative to `line.cmin` - and `line.cmax` if set. - colorbar - plotly.graph_objs.parcats.line.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `line.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`line.cmin` and `line.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - variables `count` and `probability`. Anything - contained in tag `` is displayed in the - secondary box, for example - "{fullData.name}". - reversescale - Reverses the color mapping if true. Has an - effect only if in `line.color`is set to a - numerical array. If true, `line.cmin` will - correspond to the last color in the array and - `line.cmax` will correspond to the first color. - shape - Sets the shape of the paths. If `linear`, paths - are composed of straight lines. If `hspline`, - paths are composed of horizontal curved splines - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `line.color`is set to a numerical array. - - Returns - ------- - plotly.graph_objs.parcats.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # sortpaths - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['sortpaths'] - - @sortpaths.setter - def sortpaths(self, val): - self['sortpaths'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.parcats.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.parcats.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # tickfont - # -------- - @property - 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 plotly.graph_objs.parcats.Tickfont - - A dict of string/value properties that will be passed - to the Tickfont constructor - - Supported dict properties: - - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.parcats.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - arrangement - Sets the drag interaction mode for categories and - dimensions. If `perpendicular`, the categories can only - move along a line perpendicular to the paths. If - `freeform`, the categories can freely move on the - plane. If `fixed`, the categories and dimensions are - stationary. - bundlecolors - Sort paths so that like colors are bundled together - within each category. - counts - The number of observations represented by each state. - Defaults to 1 so that each state represents one - observation - countssrc - Sets the source reference on plot.ly for counts . - dimensions - The dimensions (variables) of the parallel categories - diagram. - dimensiondefaults - When used in a template (as - layout.template.data.parcats.dimensiondefaults), sets - the default property values to use for elements of - parcats.dimensions - domain - plotly.graph_objs.parcats.Domain instance or dict with - compatible properties - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoveron - Sets the hover interaction mode for the parcats - diagram. If `category`, hover interaction take place - per category. If `color`, hover interactions take place - per color per category. If `dimension`, hover - interactions take place across all categories per - dimension. - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variables `count`, `probability`, - `category`, `categorycount`, `colorcount` and - `bandcolorcount`. Anything contained in tag `` - is displayed in the secondary box, for example - "{fullData.name}". - labelfont - Sets the font for the `dimension` labels. - line - plotly.graph_objs.parcats.Line instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - sortpaths - Sets the path sorting algorithm. If `forward`, sort - paths based on dimension categories from left to right. - If `backward`, sort paths based on dimensions - categories from right to left. - stream - plotly.graph_objs.parcats.Stream instance or dict with - compatible properties - tickfont - Sets the font for the `category` labels. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - """ - - def __init__( - self, - arg=None, - arrangement=None, - bundlecolors=None, - counts=None, - countssrc=None, - dimensions=None, - dimensiondefaults=None, - domain=None, - hoverinfo=None, - hoveron=None, - hovertemplate=None, - labelfont=None, - line=None, - name=None, - sortpaths=None, - stream=None, - tickfont=None, - uid=None, - uirevision=None, - visible=None, - **kwargs - ): - """ - Construct a new Parcats object - - Parallel categories diagram for multidimensional categorical - data. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Parcats - arrangement - Sets the drag interaction mode for categories and - dimensions. If `perpendicular`, the categories can only - move along a line perpendicular to the paths. If - `freeform`, the categories can freely move on the - plane. If `fixed`, the categories and dimensions are - stationary. - bundlecolors - Sort paths so that like colors are bundled together - within each category. - counts - The number of observations represented by each state. - Defaults to 1 so that each state represents one - observation - countssrc - Sets the source reference on plot.ly for counts . - dimensions - The dimensions (variables) of the parallel categories - diagram. - dimensiondefaults - When used in a template (as - layout.template.data.parcats.dimensiondefaults), sets - the default property values to use for elements of - parcats.dimensions - domain - plotly.graph_objs.parcats.Domain instance or dict with - compatible properties - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoveron - Sets the hover interaction mode for the parcats - diagram. If `category`, hover interaction take place - per category. If `color`, hover interactions take place - per color per category. If `dimension`, hover - interactions take place across all categories per - dimension. - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variables `count`, `probability`, - `category`, `categorycount`, `colorcount` and - `bandcolorcount`. Anything contained in tag `` - is displayed in the secondary box, for example - "{fullData.name}". - labelfont - Sets the font for the `dimension` labels. - line - plotly.graph_objs.parcats.Line instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - sortpaths - Sets the path sorting algorithm. If `forward`, sort - paths based on dimension categories from left to right. - If `backward`, sort paths based on dimensions - categories from right to left. - stream - plotly.graph_objs.parcats.Stream instance or dict with - compatible properties - tickfont - Sets the font for the `category` labels. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - - Returns - ------- - Parcats - """ - super(Parcats, self).__init__('parcats') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Parcats -constructor must be a dict or -an instance of plotly.graph_objs.Parcats""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (parcats as v_parcats) - - # Initialize validators - # --------------------- - self._validators['arrangement'] = v_parcats.ArrangementValidator() - self._validators['bundlecolors'] = v_parcats.BundlecolorsValidator() - self._validators['counts'] = v_parcats.CountsValidator() - self._validators['countssrc'] = v_parcats.CountssrcValidator() - self._validators['dimensions'] = v_parcats.DimensionsValidator() - self._validators['dimensiondefaults'] = v_parcats.DimensionValidator() - self._validators['domain'] = v_parcats.DomainValidator() - self._validators['hoverinfo'] = v_parcats.HoverinfoValidator() - self._validators['hoveron'] = v_parcats.HoveronValidator() - self._validators['hovertemplate'] = v_parcats.HovertemplateValidator() - self._validators['labelfont'] = v_parcats.LabelfontValidator() - self._validators['line'] = v_parcats.LineValidator() - self._validators['name'] = v_parcats.NameValidator() - self._validators['sortpaths'] = v_parcats.SortpathsValidator() - self._validators['stream'] = v_parcats.StreamValidator() - self._validators['tickfont'] = v_parcats.TickfontValidator() - self._validators['uid'] = v_parcats.UidValidator() - self._validators['uirevision'] = v_parcats.UirevisionValidator() - self._validators['visible'] = v_parcats.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('arrangement', None) - self['arrangement'] = arrangement if arrangement is not None else _v - _v = arg.pop('bundlecolors', None) - self['bundlecolors'] = bundlecolors if bundlecolors is not None else _v - _v = arg.pop('counts', None) - self['counts'] = counts if counts is not None else _v - _v = arg.pop('countssrc', None) - self['countssrc'] = countssrc if countssrc is not None else _v - _v = arg.pop('dimensions', None) - self['dimensions'] = dimensions if dimensions is not None else _v - _v = arg.pop('dimensiondefaults', None) - self['dimensiondefaults' - ] = dimensiondefaults if dimensiondefaults is not None else _v - _v = arg.pop('domain', None) - self['domain'] = domain if domain is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoveron', None) - self['hoveron'] = hoveron if hoveron is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('labelfont', None) - self['labelfont'] = labelfont if labelfont is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('sortpaths', None) - self['sortpaths'] = sortpaths if sortpaths is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'parcats' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='parcats', val='parcats' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_parcoords.py b/plotly/graph_objs/_parcoords.py deleted file mode 100644 index ae89fe2e0a5..00000000000 --- a/plotly/graph_objs/_parcoords.py +++ /dev/null @@ -1,1117 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Parcoords(BaseTraceType): - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # dimensions - # ---------- - @property - 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 - `[fromValue, toValue]` with `fromValue <= - toValue`, or if `multiselect` is not disabled, - you may give an array of arrays, where each - inner array is `[fromValue, toValue]`. - label - The shown name of the dimension. - multiselect - Do we allow multiple selection ranges or just a - single range? - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - range - The domain range that represents the full, - shown axis extent. Defaults to the `values` - extent. Must be an array of `[fromValue, - toValue]` with finite numbers as elements. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-language which is similar to - those of Python. See https://github.com/d3/d3-f - ormat/blob/master/README.md#locale_format - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - values - Dimension values. `values[n]` represents the - value of the `n`th point in the dataset, - therefore the `values` vector for all - dimensions must be the same (longer vectors - will be truncated). Each value must be a finite - number. - valuessrc - Sets the source reference on plot.ly for - values . - visible - Shows the dimension when set to `true` (the - default). Hides the dimension for `false`. - - Returns - ------- - tuple[plotly.graph_objs.parcoords.Dimension] - """ - return self['dimensions'] - - @dimensions.setter - def dimensions(self, val): - self['dimensions'] = val - - # dimensiondefaults - # ----------------- - @property - def dimensiondefaults(self): - """ - When used in a template (as - layout.template.data.parcoords.dimensiondefaults), sets the - default property values to use for elements of - parcoords.dimensions - - The 'dimensiondefaults' property is an instance of Dimension - that may be specified as: - - An instance of plotly.graph_objs.parcoords.Dimension - - A dict of string/value properties that will be passed - to the Dimension constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.parcoords.Dimension - """ - return self['dimensiondefaults'] - - @dimensiondefaults.setter - def dimensiondefaults(self, val): - self['dimensiondefaults'] = val - - # domain - # ------ - @property - def domain(self): - """ - The 'domain' property is an instance of Domain - that may be specified as: - - An instance of plotly.graph_objs.parcoords.Domain - - A dict of string/value properties that will be passed - to the Domain constructor - - Supported dict properties: - - column - If there is a layout grid, use the domain for - this column in the grid for this parcoords - trace . - row - If there is a layout grid, use the domain for - this row in the grid for this parcoords trace . - x - Sets the horizontal domain of this parcoords - trace (in plot fraction). - y - Sets the vertical domain of this parcoords - trace (in plot fraction). - - Returns - ------- - plotly.graph_objs.parcoords.Domain - """ - return self['domain'] - - @domain.setter - def domain(self, val): - self['domain'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # labelfont - # --------- - @property - 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 plotly.graph_objs.parcoords.Labelfont - - A dict of string/value properties that will be passed - to the Labelfont constructor - - Supported dict properties: - - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.parcoords.Labelfont - """ - return self['labelfont'] - - @labelfont.setter - def labelfont(self, val): - self['labelfont'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of plotly.graph_objs.parcoords.Line - - A dict of string/value properties that will be passed - to the Line constructor - - Supported dict properties: - - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `line.colorscale`. Has an effect - only if in `line.color`is set to a numerical - array. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette - will be chosen according to whether numbers in - the `color` array are all positive, all - negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `line.color`) or the bounds set in - `line.cmin` and `line.cmax` Has an effect only - if in `line.color`is set to a numerical array. - Defaults to `false` when `line.cmin` and - `line.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `line.color`is set to a - numerical array. Value should have the same - units as in `line.color` and if set, - `line.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `line.cmin` and/or `line.cmax` to be - equidistant to this point. Has an effect only - if in `line.color`is set to a numerical array. - Value should have the same units as in - `line.color`. Has no effect when `line.cauto` - is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `line.color`is set to a - numerical array. Value should have the same - units as in `line.color` and if set, - `line.cmax` must be set as well. - color - Sets thelinecolor. It accepts either a specific - color or an array of numbers that are mapped to - the colorscale relative to the max and min - values of the array or relative to `line.cmin` - and `line.cmax` if set. - colorbar - plotly.graph_objs.parcoords.line.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `line.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`line.cmin` and `line.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `line.color`is set to a - numerical array. If true, `line.cmin` will - correspond to the last color in the array and - `line.cmax` will correspond to the first color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `line.color`is set to a numerical array. - - Returns - ------- - plotly.graph_objs.parcoords.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # rangefont - # --------- - @property - 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 plotly.graph_objs.parcoords.Rangefont - - A dict of string/value properties that will be passed - to the Rangefont constructor - - Supported dict properties: - - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.parcoords.Rangefont - """ - return self['rangefont'] - - @rangefont.setter - def rangefont(self, val): - self['rangefont'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.parcoords.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.parcoords.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # tickfont - # -------- - @property - 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 plotly.graph_objs.parcoords.Tickfont - - A dict of string/value properties that will be passed - to the Tickfont constructor - - Supported dict properties: - - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.parcoords.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dimensions - The dimensions (variables) of the parallel coordinates - chart. 2..60 dimensions are supported. - dimensiondefaults - When used in a template (as - layout.template.data.parcoords.dimensiondefaults), sets - the default property values to use for elements of - parcoords.dimensions - domain - plotly.graph_objs.parcoords.Domain instance or dict - with compatible properties - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - labelfont - Sets the font for the `dimension` labels. - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.parcoords.Line instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - rangefont - Sets the font for the `dimension` range values. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.parcoords.Stream instance or dict - with compatible properties - tickfont - Sets the font for the `dimension` tick values. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - """ - - def __init__( - self, - arg=None, - customdata=None, - customdatasrc=None, - dimensions=None, - dimensiondefaults=None, - domain=None, - hoverinfo=None, - hoverinfosrc=None, - ids=None, - idssrc=None, - labelfont=None, - legendgroup=None, - line=None, - name=None, - opacity=None, - rangefont=None, - selectedpoints=None, - showlegend=None, - stream=None, - tickfont=None, - uid=None, - uirevision=None, - visible=None, - **kwargs - ): - """ - Construct a new Parcoords object - - Parallel coordinates for multidimensional exploratory data - analysis. The samples are specified in `dimensions`. The colors - are set in `line.color`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Parcoords - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dimensions - The dimensions (variables) of the parallel coordinates - chart. 2..60 dimensions are supported. - dimensiondefaults - When used in a template (as - layout.template.data.parcoords.dimensiondefaults), sets - the default property values to use for elements of - parcoords.dimensions - domain - plotly.graph_objs.parcoords.Domain instance or dict - with compatible properties - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - labelfont - Sets the font for the `dimension` labels. - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.parcoords.Line instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - rangefont - Sets the font for the `dimension` range values. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.parcoords.Stream instance or dict - with compatible properties - tickfont - Sets the font for the `dimension` tick values. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - - Returns - ------- - Parcoords - """ - super(Parcoords, self).__init__('parcoords') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Parcoords -constructor must be a dict or -an instance of plotly.graph_objs.Parcoords""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (parcoords as v_parcoords) - - # Initialize validators - # --------------------- - self._validators['customdata'] = v_parcoords.CustomdataValidator() - self._validators['customdatasrc'] = v_parcoords.CustomdatasrcValidator( - ) - self._validators['dimensions'] = v_parcoords.DimensionsValidator() - self._validators['dimensiondefaults'] = v_parcoords.DimensionValidator( - ) - self._validators['domain'] = v_parcoords.DomainValidator() - self._validators['hoverinfo'] = v_parcoords.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_parcoords.HoverinfosrcValidator() - self._validators['ids'] = v_parcoords.IdsValidator() - self._validators['idssrc'] = v_parcoords.IdssrcValidator() - self._validators['labelfont'] = v_parcoords.LabelfontValidator() - self._validators['legendgroup'] = v_parcoords.LegendgroupValidator() - self._validators['line'] = v_parcoords.LineValidator() - self._validators['name'] = v_parcoords.NameValidator() - self._validators['opacity'] = v_parcoords.OpacityValidator() - self._validators['rangefont'] = v_parcoords.RangefontValidator() - self._validators['selectedpoints' - ] = v_parcoords.SelectedpointsValidator() - self._validators['showlegend'] = v_parcoords.ShowlegendValidator() - self._validators['stream'] = v_parcoords.StreamValidator() - self._validators['tickfont'] = v_parcoords.TickfontValidator() - self._validators['uid'] = v_parcoords.UidValidator() - self._validators['uirevision'] = v_parcoords.UirevisionValidator() - self._validators['visible'] = v_parcoords.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('dimensions', None) - self['dimensions'] = dimensions if dimensions is not None else _v - _v = arg.pop('dimensiondefaults', None) - self['dimensiondefaults' - ] = dimensiondefaults if dimensiondefaults is not None else _v - _v = arg.pop('domain', None) - self['domain'] = domain if domain is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('labelfont', None) - self['labelfont'] = labelfont if labelfont is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('rangefont', None) - self['rangefont'] = rangefont if rangefont is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'parcoords' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='parcoords', val='parcoords' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_pie.py b/plotly/graph_objs/_pie.py deleted file mode 100644 index 0d88effd3e1..00000000000 --- a/plotly/graph_objs/_pie.py +++ /dev/null @@ -1,1908 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Pie(BaseTraceType): - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # direction - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['direction'] - - @direction.setter - def direction(self, val): - self['direction'] = val - - # dlabel - # ------ - @property - 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 - - Returns - ------- - int|float - """ - return self['dlabel'] - - @dlabel.setter - def dlabel(self, val): - self['dlabel'] = val - - # domain - # ------ - @property - def domain(self): - """ - The 'domain' property is an instance of Domain - that may be specified as: - - An instance of plotly.graph_objs.pie.Domain - - A dict of string/value properties that will be passed - to the Domain constructor - - Supported dict properties: - - column - If there is a layout grid, use the domain for - this column in the grid for this pie trace . - row - If there is a layout grid, use the domain for - this row in the grid for this pie trace . - x - Sets the horizontal domain of this pie trace - (in plot fraction). - y - Sets the vertical domain of this pie trace (in - plot fraction). - - Returns - ------- - plotly.graph_objs.pie.Domain - """ - return self['domain'] - - @domain.setter - def domain(self, val): - self['domain'] = val - - # hole - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['hole'] - - @hole.setter - def hole(self, val): - self['hole'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'label+text') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.pie.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.pie.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - variables `label`, `color`, `value`, `percent` and `text`. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - def hovertext(self): - """ - Sets hover text elements associated with each sector. If a - single string, the same string appears for all data points. If - an array of string, the items are mapped in order of this - trace's sectors. To be seen, trace `hoverinfo` must contain a - "text" flag. - - The 'hovertext' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # insidetextfont - # -------------- - @property - def insidetextfont(self): - """ - Sets the font used for `textinfo` lying inside the pie. - - The 'insidetextfont' property is an instance of Insidetextfont - that may be specified as: - - An instance of 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.pie.Insidetextfont - """ - return self['insidetextfont'] - - @insidetextfont.setter - def insidetextfont(self, val): - self['insidetextfont'] = val - - # label0 - # ------ - @property - 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 - - Returns - ------- - int|float - """ - return self['label0'] - - @label0.setter - def label0(self, val): - self['label0'] = val - - # labels - # ------ - @property - def labels(self): - """ - Sets the sector labels. If `labels` entries are duplicated, we - sum associated `values` or simply count occurrences if `values` - is not provided. For other array attributes (including color) - we use the first non-empty entry among all occurrences of the - label. - - The 'labels' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['labels'] - - @labels.setter - def labels(self, val): - self['labels'] = val - - # labelssrc - # --------- - @property - def labelssrc(self): - """ - Sets the source reference on plot.ly for labels . - - The 'labelssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['labelssrc'] - - @labelssrc.setter - def labelssrc(self, val): - self['labelssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 of this pie - chart. If not specified, the default trace - color set is used to pick the sector colors. - colorssrc - Sets the source reference on plot.ly for - colors . - line - plotly.graph_objs.pie.marker.Line instance or - dict with compatible properties - - Returns - ------- - plotly.graph_objs.pie.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # outsidetextfont - # --------------- - @property - def outsidetextfont(self): - """ - Sets the font used for `textinfo` lying outside the pie. - - The 'outsidetextfont' property is an instance of Outsidetextfont - that may be specified as: - - An instance of 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.pie.Outsidetextfont - """ - return self['outsidetextfont'] - - @outsidetextfont.setter - def outsidetextfont(self, val): - self['outsidetextfont'] = val - - # pull - # ---- - @property - def pull(self): - """ - Sets the fraction of larger radius to pull the sectors out from - the center. This can be a constant to pull all slices apart - from each other equally or an array to highlight one or more - slices. - - The 'pull' property is a number and may be specified as: - - An int or float in the interval [0, 1] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['pull'] - - @pull.setter - def pull(self, val): - self['pull'] = val - - # pullsrc - # ------- - @property - def pullsrc(self): - """ - Sets the source reference on plot.ly for pull . - - The 'pullsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['pullsrc'] - - @pullsrc.setter - def pullsrc(self, val): - self['pullsrc'] = val - - # rotation - # -------- - @property - 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] - - Returns - ------- - int|float - """ - return self['rotation'] - - @rotation.setter - def rotation(self, val): - self['rotation'] = val - - # scalegroup - # ---------- - @property - def scalegroup(self): - """ - If there are multiple pies that should be sized according to - their totals, link them by providing a non-empty group id here - shared by every trace in the same group. - - The 'scalegroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['scalegroup'] - - @scalegroup.setter - def scalegroup(self, val): - self['scalegroup'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # sort - # ---- - @property - 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) - - Returns - ------- - bool - """ - return self['sort'] - - @sort.setter - def sort(self, val): - self['sort'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.pie.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.pie.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - def text(self): - """ - Sets text elements associated with each sector. If trace - `textinfo` contains a "text" flag, these elements will be seen - on the chart. If trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in the - hover labels. - - The 'text' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textfont - # -------- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.pie.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # textinfo - # -------- - @property - 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 - (e.g. 'label+text') - OR exactly one of ['none'] (e.g. 'none') - - Returns - ------- - Any - """ - return self['textinfo'] - - @textinfo.setter - def textinfo(self, val): - self['textinfo'] = val - - # textposition - # ------------ - @property - 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'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['textposition'] - - @textposition.setter - def textposition(self, val): - self['textposition'] = val - - # textpositionsrc - # --------------- - @property - def textpositionsrc(self): - """ - Sets the source reference on plot.ly for textposition . - - The 'textpositionsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textpositionsrc'] - - @textpositionsrc.setter - def textpositionsrc(self, val): - self['textpositionsrc'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of plotly.graph_objs.pie.Title - - A dict of string/value properties that will be passed - to the Title constructor - - Supported dict properties: - - font - Sets the font used for `title`. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - position - Specifies the location of the `title`. Note - that the title's position used to be set by the - now deprecated `titleposition` attribute. - text - Sets the title of the pie chart. If it is - empty, no title is displayed. Note that before - the existence of `title.text`, the title's - contents used to be defined as the `title` - attribute itself. This behavior has been - deprecated. - - Returns - ------- - plotly.graph_objs.pie.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleposition - # ------------- - @property - 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', - 'bottom left', 'bottom center', 'bottom right'] - - Returns - ------- - - """ - return self['titleposition'] - - @titleposition.setter - def titleposition(self, val): - self['titleposition'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # values - # ------ - @property - def values(self): - """ - Sets the values of the sectors of this pie chart. If omitted, - we count occurrences of each label. - - The 'values' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['values'] - - @values.setter - def values(self, val): - self['values'] = val - - # valuessrc - # --------- - @property - def valuessrc(self): - """ - Sets the source reference on plot.ly for values . - - The 'valuessrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['valuessrc'] - - @valuessrc.setter - def valuessrc(self, val): - self['valuessrc'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - direction - Specifies the direction at which succeeding sectors - follow one another. - dlabel - Sets the label step. See `label0` for more info. - domain - plotly.graph_objs.pie.Domain instance or dict with - compatible properties - hole - Sets the fraction of the radius to cut out of the pie. - Use this to make a donut chart. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.pie.Hoverlabel instance or dict with - compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variables `label`, `color`, `value`, - `percent` and `text`. Anything contained in tag - `` is displayed in the secondary box, for - example "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each sector. - If a single string, the same string appears for all - data points. If an array of string, the items are - mapped in order of this trace's sectors. To be seen, - trace `hoverinfo` must contain a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - insidetextfont - Sets the font used for `textinfo` lying inside the pie. - label0 - Alternate to `labels`. Builds a numeric set of labels. - Use with `dlabel` where `label0` is the starting label - and `dlabel` the step. - labels - Sets the sector labels. If `labels` entries are - duplicated, we sum associated `values` or simply count - occurrences if `values` is not provided. For other - array attributes (including color) we use the first - non-empty entry among all occurrences of the label. - labelssrc - Sets the source reference on plot.ly for labels . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - marker - plotly.graph_objs.pie.Marker instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - outsidetextfont - Sets the font used for `textinfo` lying outside the - pie. - pull - Sets the fraction of larger radius to pull the sectors - out from the center. This can be a constant to pull all - slices apart from each other equally or an array to - highlight one or more slices. - pullsrc - Sets the source reference on plot.ly for pull . - rotation - Instead of the first slice starting at 12 o'clock, - rotate to some other angle. - scalegroup - If there are multiple pies that should be sized - according to their totals, link them by providing a - non-empty group id here shared by every trace in the - same group. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - sort - Determines whether or not the sectors are reordered - from largest to smallest. - stream - plotly.graph_objs.pie.Stream instance or dict with - compatible properties - text - Sets text elements associated with each sector. If - trace `textinfo` contains a "text" flag, these elements - will be seen on the chart. If trace `hoverinfo` - contains a "text" flag and "hovertext" is not set, - these elements will be seen in the hover labels. - textfont - Sets the font used for `textinfo`. - textinfo - Determines which trace information appear on the graph. - textposition - Specifies the location of the `textinfo`. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - title - plotly.graph_objs.pie.Title instance or dict with - compatible properties - titlefont - Deprecated: Please use pie.title.font instead. Sets the - font used for `title`. Note that the title's font used - to be set by the now deprecated `titlefont` attribute. - titleposition - Deprecated: Please use pie.title.position instead. - Specifies the location of the `title`. Note that the - title's position used to be set by the now deprecated - `titleposition` attribute. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - values - Sets the values of the sectors of this pie chart. If - omitted, we count occurrences of each label. - valuessrc - Sets the source reference on plot.ly for values . - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleposition': ('title', 'position') - } - - def __init__( - self, - arg=None, - customdata=None, - customdatasrc=None, - direction=None, - dlabel=None, - domain=None, - hole=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - insidetextfont=None, - label0=None, - labels=None, - labelssrc=None, - legendgroup=None, - marker=None, - name=None, - opacity=None, - outsidetextfont=None, - pull=None, - pullsrc=None, - rotation=None, - scalegroup=None, - selectedpoints=None, - showlegend=None, - sort=None, - stream=None, - text=None, - textfont=None, - textinfo=None, - textposition=None, - textpositionsrc=None, - textsrc=None, - title=None, - titlefont=None, - titleposition=None, - uid=None, - uirevision=None, - values=None, - valuessrc=None, - visible=None, - **kwargs - ): - """ - Construct a new Pie object - - A data visualized by the sectors of the pie is set in `values`. - The sector labels are set in `labels`. The sector colors are - set in `marker.colors` - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Pie - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - direction - Specifies the direction at which succeeding sectors - follow one another. - dlabel - Sets the label step. See `label0` for more info. - domain - plotly.graph_objs.pie.Domain instance or dict with - compatible properties - hole - Sets the fraction of the radius to cut out of the pie. - Use this to make a donut chart. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.pie.Hoverlabel instance or dict with - compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variables `label`, `color`, `value`, - `percent` and `text`. Anything contained in tag - `` is displayed in the secondary box, for - example "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each sector. - If a single string, the same string appears for all - data points. If an array of string, the items are - mapped in order of this trace's sectors. To be seen, - trace `hoverinfo` must contain a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - insidetextfont - Sets the font used for `textinfo` lying inside the pie. - label0 - Alternate to `labels`. Builds a numeric set of labels. - Use with `dlabel` where `label0` is the starting label - and `dlabel` the step. - labels - Sets the sector labels. If `labels` entries are - duplicated, we sum associated `values` or simply count - occurrences if `values` is not provided. For other - array attributes (including color) we use the first - non-empty entry among all occurrences of the label. - labelssrc - Sets the source reference on plot.ly for labels . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - marker - plotly.graph_objs.pie.Marker instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - outsidetextfont - Sets the font used for `textinfo` lying outside the - pie. - pull - Sets the fraction of larger radius to pull the sectors - out from the center. This can be a constant to pull all - slices apart from each other equally or an array to - highlight one or more slices. - pullsrc - Sets the source reference on plot.ly for pull . - rotation - Instead of the first slice starting at 12 o'clock, - rotate to some other angle. - scalegroup - If there are multiple pies that should be sized - according to their totals, link them by providing a - non-empty group id here shared by every trace in the - same group. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - sort - Determines whether or not the sectors are reordered - from largest to smallest. - stream - plotly.graph_objs.pie.Stream instance or dict with - compatible properties - text - Sets text elements associated with each sector. If - trace `textinfo` contains a "text" flag, these elements - will be seen on the chart. If trace `hoverinfo` - contains a "text" flag and "hovertext" is not set, - these elements will be seen in the hover labels. - textfont - Sets the font used for `textinfo`. - textinfo - Determines which trace information appear on the graph. - textposition - Specifies the location of the `textinfo`. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - title - plotly.graph_objs.pie.Title instance or dict with - compatible properties - titlefont - Deprecated: Please use pie.title.font instead. Sets the - font used for `title`. Note that the title's font used - to be set by the now deprecated `titlefont` attribute. - titleposition - Deprecated: Please use pie.title.position instead. - Specifies the location of the `title`. Note that the - title's position used to be set by the now deprecated - `titleposition` attribute. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - values - Sets the values of the sectors of this pie chart. If - omitted, we count occurrences of each label. - valuessrc - Sets the source reference on plot.ly for values . - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - - Returns - ------- - Pie - """ - super(Pie, self).__init__('pie') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Pie -constructor must be a dict or -an instance of plotly.graph_objs.Pie""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (pie as v_pie) - - # Initialize validators - # --------------------- - self._validators['customdata'] = v_pie.CustomdataValidator() - self._validators['customdatasrc'] = v_pie.CustomdatasrcValidator() - self._validators['direction'] = v_pie.DirectionValidator() - self._validators['dlabel'] = v_pie.DlabelValidator() - self._validators['domain'] = v_pie.DomainValidator() - self._validators['hole'] = v_pie.HoleValidator() - self._validators['hoverinfo'] = v_pie.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_pie.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_pie.HoverlabelValidator() - self._validators['hovertemplate'] = v_pie.HovertemplateValidator() - self._validators['hovertemplatesrc'] = v_pie.HovertemplatesrcValidator( - ) - self._validators['hovertext'] = v_pie.HovertextValidator() - self._validators['hovertextsrc'] = v_pie.HovertextsrcValidator() - self._validators['ids'] = v_pie.IdsValidator() - self._validators['idssrc'] = v_pie.IdssrcValidator() - self._validators['insidetextfont'] = v_pie.InsidetextfontValidator() - self._validators['label0'] = v_pie.Label0Validator() - self._validators['labels'] = v_pie.LabelsValidator() - self._validators['labelssrc'] = v_pie.LabelssrcValidator() - self._validators['legendgroup'] = v_pie.LegendgroupValidator() - self._validators['marker'] = v_pie.MarkerValidator() - self._validators['name'] = v_pie.NameValidator() - self._validators['opacity'] = v_pie.OpacityValidator() - self._validators['outsidetextfont'] = v_pie.OutsidetextfontValidator() - self._validators['pull'] = v_pie.PullValidator() - self._validators['pullsrc'] = v_pie.PullsrcValidator() - self._validators['rotation'] = v_pie.RotationValidator() - self._validators['scalegroup'] = v_pie.ScalegroupValidator() - self._validators['selectedpoints'] = v_pie.SelectedpointsValidator() - self._validators['showlegend'] = v_pie.ShowlegendValidator() - self._validators['sort'] = v_pie.SortValidator() - self._validators['stream'] = v_pie.StreamValidator() - self._validators['text'] = v_pie.TextValidator() - self._validators['textfont'] = v_pie.TextfontValidator() - self._validators['textinfo'] = v_pie.TextinfoValidator() - self._validators['textposition'] = v_pie.TextpositionValidator() - self._validators['textpositionsrc'] = v_pie.TextpositionsrcValidator() - self._validators['textsrc'] = v_pie.TextsrcValidator() - self._validators['title'] = v_pie.TitleValidator() - self._validators['uid'] = v_pie.UidValidator() - self._validators['uirevision'] = v_pie.UirevisionValidator() - self._validators['values'] = v_pie.ValuesValidator() - self._validators['valuessrc'] = v_pie.ValuessrcValidator() - self._validators['visible'] = v_pie.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('direction', None) - self['direction'] = direction if direction is not None else _v - _v = arg.pop('dlabel', None) - self['dlabel'] = dlabel if dlabel is not None else _v - _v = arg.pop('domain', None) - self['domain'] = domain if domain is not None else _v - _v = arg.pop('hole', None) - self['hole'] = hole if hole is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('insidetextfont', None) - self['insidetextfont' - ] = insidetextfont if insidetextfont is not None else _v - _v = arg.pop('label0', None) - self['label0'] = label0 if label0 is not None else _v - _v = arg.pop('labels', None) - self['labels'] = labels if labels is not None else _v - _v = arg.pop('labelssrc', None) - self['labelssrc'] = labelssrc if labelssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('outsidetextfont', None) - self['outsidetextfont' - ] = outsidetextfont if outsidetextfont is not None else _v - _v = arg.pop('pull', None) - self['pull'] = pull if pull is not None else _v - _v = arg.pop('pullsrc', None) - self['pullsrc'] = pullsrc if pullsrc is not None else _v - _v = arg.pop('rotation', None) - self['rotation'] = rotation if rotation is not None else _v - _v = arg.pop('scalegroup', None) - self['scalegroup'] = scalegroup if scalegroup is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('sort', None) - self['sort'] = sort if sort is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - _v = arg.pop('textinfo', None) - self['textinfo'] = textinfo if textinfo is not None else _v - _v = arg.pop('textposition', None) - self['textposition'] = textposition if textposition is not None else _v - _v = arg.pop('textpositionsrc', None) - self['textpositionsrc' - ] = textpositionsrc if textpositionsrc is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleposition', None) - _v = titleposition if titleposition is not None else _v - if _v is not None: - self['titleposition'] = _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('values', None) - self['values'] = values if values is not None else _v - _v = arg.pop('valuessrc', None) - self['valuessrc'] = valuessrc if valuessrc is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'pie' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='pie', val='pie' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_pointcloud.py b/plotly/graph_objs/_pointcloud.py deleted file mode 100644 index 1d34e2b7ffe..00000000000 --- a/plotly/graph_objs/_pointcloud.py +++ /dev/null @@ -1,1306 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Pointcloud(BaseTraceType): - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.pointcloud.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.pointcloud.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # indices - # ------- - @property - def indices(self): - """ - A sequential value, 0..n, supply it to avoid creating this - array inside plotting. If specified, it must be a typed - `Int32Array` array. Its length must be equal to or greater than - the number of points. For the best performance and memory use, - create one large `indices` typed array that is guaranteed to be - at least as long as the largest number of points during use, - and reuse it on each `Plotly.restyle()` call. - - The 'indices' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['indices'] - - @indices.setter - def indices(self, val): - self['indices'] = val - - # indicessrc - # ---------- - @property - def indicessrc(self): - """ - Sets the source reference on plot.ly for indices . - - The 'indicessrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['indicessrc'] - - @indicessrc.setter - def indicessrc(self, val): - self['indicessrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of plotly.graph_objs.pointcloud.Marker - - A dict of string/value properties that will be passed - to the Marker constructor - - Supported dict properties: - - blend - Determines if colors are blended together for a - translucency effect in case `opacity` is - specified as a value less then `1`. Setting - `blend` to `true` reduces zoom/pan speed if - used with large numbers of points. - border - plotly.graph_objs.pointcloud.marker.Border - instance or dict with compatible properties - color - Sets the marker fill color. It accepts a - specific color.If the color is not fully opaque - and there are hundreds of thousandsof points, - it may cause slower zooming and panning. - opacity - Sets the marker opacity. The default value is - `1` (fully opaque). If the markers are not - fully opaque and there are hundreds of - thousands of points, it may cause slower - zooming and panning. Opacity fades the color - even if `blend` is left on `false` even if - there is no translucency effect in that case. - sizemax - Sets the maximum size (in px) of the rendered - marker points. Effective when the `pointcloud` - shows only few points. - sizemin - Sets the minimum size (in px) of the rendered - marker points, effective when the `pointcloud` - shows a million or more points. - - Returns - ------- - plotly.graph_objs.pointcloud.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.pointcloud.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.pointcloud.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - def text(self): - """ - Sets text elements associated with each (x,y) pair. If a single - string, the same string appears over all the data points. If an - array of string, the items are mapped in order to the this - trace's (x,y) coordinates. If trace `hoverinfo` contains a - "text" flag and "hovertext" is not set, these elements will be - seen in the hover labels. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # xbounds - # ------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['xbounds'] - - @xbounds.setter - def xbounds(self, val): - self['xbounds'] = val - - # xboundssrc - # ---------- - @property - def xboundssrc(self): - """ - Sets the source reference on plot.ly for xbounds . - - The 'xboundssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xboundssrc'] - - @xboundssrc.setter - def xboundssrc(self, val): - self['xboundssrc'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # xy - # -- - @property - def xy(self): - """ - Faster alternative to specifying `x` and `y` separately. If - supplied, it must be a typed `Float32Array` array that - represents points such that `xy[i * 2] = x[i]` and `xy[i * 2 + - 1] = y[i]` - - The 'xy' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['xy'] - - @xy.setter - def xy(self, val): - self['xy'] = val - - # xysrc - # ----- - @property - def xysrc(self): - """ - Sets the source reference on plot.ly for xy . - - The 'xysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xysrc'] - - @xysrc.setter - def xysrc(self, val): - self['xysrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # ybounds - # ------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ybounds'] - - @ybounds.setter - def ybounds(self, val): - self['ybounds'] = val - - # yboundssrc - # ---------- - @property - def yboundssrc(self): - """ - Sets the source reference on plot.ly for ybounds . - - The 'yboundssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['yboundssrc'] - - @yboundssrc.setter - def yboundssrc(self, val): - self['yboundssrc'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.pointcloud.Hoverlabel instance or - dict with compatible properties - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - indices - A sequential value, 0..n, supply it to avoid creating - this array inside plotting. If specified, it must be a - typed `Int32Array` array. Its length must be equal to - or greater than the number of points. For the best - performance and memory use, create one large `indices` - typed array that is guaranteed to be at least as long - as the largest number of points during use, and reuse - it on each `Plotly.restyle()` call. - indicessrc - Sets the source reference on plot.ly for indices . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - marker - plotly.graph_objs.pointcloud.Marker instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.pointcloud.Stream instance or dict - with compatible properties - text - Sets text elements associated with each (x,y) pair. If - a single string, the same string appears over all the - data points. If an array of string, the items are - mapped in order to the this trace's (x,y) coordinates. - If trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xbounds - Specify `xbounds` in the shape of `[xMin, xMax] to - avoid looping through the `xy` typed array. Use it in - conjunction with `xy` and `ybounds` for the performance - benefits. - xboundssrc - Sets the source reference on plot.ly for xbounds . - xsrc - Sets the source reference on plot.ly for x . - xy - Faster alternative to specifying `x` and `y` - separately. If supplied, it must be a typed - `Float32Array` array that represents points such that - `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]` - xysrc - Sets the source reference on plot.ly for xy . - y - Sets the y coordinates. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ybounds - Specify `ybounds` in the shape of `[yMin, yMax] to - avoid looping through the `xy` typed array. Use it in - conjunction with `xy` and `xbounds` for the performance - benefits. - yboundssrc - Sets the source reference on plot.ly for ybounds . - ysrc - Sets the source reference on plot.ly for y . - """ - - def __init__( - self, - arg=None, - customdata=None, - customdatasrc=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - ids=None, - idssrc=None, - indices=None, - indicessrc=None, - legendgroup=None, - marker=None, - name=None, - opacity=None, - selectedpoints=None, - showlegend=None, - stream=None, - text=None, - textsrc=None, - uid=None, - uirevision=None, - visible=None, - x=None, - xaxis=None, - xbounds=None, - xboundssrc=None, - xsrc=None, - xy=None, - xysrc=None, - y=None, - yaxis=None, - ybounds=None, - yboundssrc=None, - ysrc=None, - **kwargs - ): - """ - Construct a new Pointcloud object - - The data visualized as a point cloud set in `x` and `y` using - the WebGl plotting engine. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Pointcloud - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.pointcloud.Hoverlabel instance or - dict with compatible properties - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - indices - A sequential value, 0..n, supply it to avoid creating - this array inside plotting. If specified, it must be a - typed `Int32Array` array. Its length must be equal to - or greater than the number of points. For the best - performance and memory use, create one large `indices` - typed array that is guaranteed to be at least as long - as the largest number of points during use, and reuse - it on each `Plotly.restyle()` call. - indicessrc - Sets the source reference on plot.ly for indices . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - marker - plotly.graph_objs.pointcloud.Marker instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.pointcloud.Stream instance or dict - with compatible properties - text - Sets text elements associated with each (x,y) pair. If - a single string, the same string appears over all the - data points. If an array of string, the items are - mapped in order to the this trace's (x,y) coordinates. - If trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xbounds - Specify `xbounds` in the shape of `[xMin, xMax] to - avoid looping through the `xy` typed array. Use it in - conjunction with `xy` and `ybounds` for the performance - benefits. - xboundssrc - Sets the source reference on plot.ly for xbounds . - xsrc - Sets the source reference on plot.ly for x . - xy - Faster alternative to specifying `x` and `y` - separately. If supplied, it must be a typed - `Float32Array` array that represents points such that - `xy[i * 2] = x[i]` and `xy[i * 2 + 1] = y[i]` - xysrc - Sets the source reference on plot.ly for xy . - y - Sets the y coordinates. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ybounds - Specify `ybounds` in the shape of `[yMin, yMax] to - avoid looping through the `xy` typed array. Use it in - conjunction with `xy` and `xbounds` for the performance - benefits. - yboundssrc - Sets the source reference on plot.ly for ybounds . - ysrc - Sets the source reference on plot.ly for y . - - Returns - ------- - Pointcloud - """ - super(Pointcloud, self).__init__('pointcloud') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Pointcloud -constructor must be a dict or -an instance of plotly.graph_objs.Pointcloud""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (pointcloud as v_pointcloud) - - # Initialize validators - # --------------------- - self._validators['customdata'] = v_pointcloud.CustomdataValidator() - self._validators['customdatasrc' - ] = v_pointcloud.CustomdatasrcValidator() - self._validators['hoverinfo'] = v_pointcloud.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_pointcloud.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_pointcloud.HoverlabelValidator() - self._validators['ids'] = v_pointcloud.IdsValidator() - self._validators['idssrc'] = v_pointcloud.IdssrcValidator() - self._validators['indices'] = v_pointcloud.IndicesValidator() - self._validators['indicessrc'] = v_pointcloud.IndicessrcValidator() - self._validators['legendgroup'] = v_pointcloud.LegendgroupValidator() - self._validators['marker'] = v_pointcloud.MarkerValidator() - self._validators['name'] = v_pointcloud.NameValidator() - self._validators['opacity'] = v_pointcloud.OpacityValidator() - self._validators['selectedpoints' - ] = v_pointcloud.SelectedpointsValidator() - self._validators['showlegend'] = v_pointcloud.ShowlegendValidator() - self._validators['stream'] = v_pointcloud.StreamValidator() - self._validators['text'] = v_pointcloud.TextValidator() - self._validators['textsrc'] = v_pointcloud.TextsrcValidator() - self._validators['uid'] = v_pointcloud.UidValidator() - self._validators['uirevision'] = v_pointcloud.UirevisionValidator() - self._validators['visible'] = v_pointcloud.VisibleValidator() - self._validators['x'] = v_pointcloud.XValidator() - self._validators['xaxis'] = v_pointcloud.XAxisValidator() - self._validators['xbounds'] = v_pointcloud.XboundsValidator() - self._validators['xboundssrc'] = v_pointcloud.XboundssrcValidator() - self._validators['xsrc'] = v_pointcloud.XsrcValidator() - self._validators['xy'] = v_pointcloud.XyValidator() - self._validators['xysrc'] = v_pointcloud.XysrcValidator() - self._validators['y'] = v_pointcloud.YValidator() - self._validators['yaxis'] = v_pointcloud.YAxisValidator() - self._validators['ybounds'] = v_pointcloud.YboundsValidator() - self._validators['yboundssrc'] = v_pointcloud.YboundssrcValidator() - self._validators['ysrc'] = v_pointcloud.YsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('indices', None) - self['indices'] = indices if indices is not None else _v - _v = arg.pop('indicessrc', None) - self['indicessrc'] = indicessrc if indicessrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('xbounds', None) - self['xbounds'] = xbounds if xbounds is not None else _v - _v = arg.pop('xboundssrc', None) - self['xboundssrc'] = xboundssrc if xboundssrc is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('xy', None) - self['xy'] = xy if xy is not None else _v - _v = arg.pop('xysrc', None) - self['xysrc'] = xysrc if xysrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - _v = arg.pop('ybounds', None) - self['ybounds'] = ybounds if ybounds is not None else _v - _v = arg.pop('yboundssrc', None) - self['yboundssrc'] = yboundssrc if yboundssrc is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'pointcloud' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='pointcloud', val='pointcloud' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_sankey.py b/plotly/graph_objs/_sankey.py deleted file mode 100644 index bb2725302f2..00000000000 --- a/plotly/graph_objs/_sankey.py +++ /dev/null @@ -1,1133 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Sankey(BaseTraceType): - - # arrangement - # ----------- - @property - def arrangement(self): - """ - If value is `snap` (the default), the node arrangement is - assisted by automatic snapping of elements to preserve space - between nodes specified via `nodepad`. If value is - `perpendicular`, the nodes can only move along a line - perpendicular to the flow. If value is `freeform`, the nodes - can freely move on the plane. If value is `fixed`, the nodes - are stationary. - - The 'arrangement' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['snap', 'perpendicular', 'freeform', 'fixed'] - - Returns - ------- - Any - """ - return self['arrangement'] - - @arrangement.setter - def arrangement(self, val): - self['arrangement'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # domain - # ------ - @property - def domain(self): - """ - The 'domain' property is an instance of Domain - that may be specified as: - - An instance of plotly.graph_objs.sankey.Domain - - A dict of string/value properties that will be passed - to the Domain constructor - - Supported dict properties: - - column - If there is a layout grid, use the domain for - this column in the grid for this sankey trace . - row - If there is a layout grid, use the domain for - this row in the grid for this sankey trace . - x - Sets the horizontal domain of this sankey trace - (in plot fraction). - y - Sets the vertical domain of this sankey trace - (in plot fraction). - - Returns - ------- - plotly.graph_objs.sankey.Domain - """ - return self['domain'] - - @domain.setter - def domain(self, val): - self['domain'] = val - - # hoverinfo - # --------- - @property - 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. - Note that this attribute is superseded by `node.hoverinfo` and - `node.hoverinfo` for nodes and links respectively. - - The 'hoverinfo' property is a flaglist and may be specified - as a string containing: - - Any combination of [] joined with '+' characters - (e.g. '') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - Returns - ------- - Any - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.sankey.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.sankey.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # link - # ---- - @property - 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 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 - each `link`. If `link.color` is omitted, then - by default, a translucent grey link will be - used. - colorscales - plotly.graph_objs.sankey.link.Colorscale - instance or dict with compatible properties - colorscaledefaults - When used in a template (as layout.template.dat - a.sankey.link.colorscaledefaults), sets the - default property values to use for elements of - sankey.link.colorscales - colorsrc - Sets the source reference on plot.ly for color - . - hoverinfo - Determines which trace information appear when - hovering links. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverlabel - plotly.graph_objs.sankey.link.Hoverlabel - instance or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - variables `value` and `label`. Anything - contained in tag `` is displayed in the - secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - label - The shown name of the link. - labelsrc - Sets the source reference on plot.ly for label - . - line - plotly.graph_objs.sankey.link.Line instance or - dict with compatible properties - source - An integer number `[0..nodes.length - 1]` that - represents the source node. - sourcesrc - Sets the source reference on plot.ly for - source . - target - An integer number `[0..nodes.length - 1]` that - represents the target node. - targetsrc - Sets the source reference on plot.ly for - target . - value - A numeric value representing the flow volume - value. - valuesrc - Sets the source reference on plot.ly for value - . - - Returns - ------- - plotly.graph_objs.sankey.Link - """ - return self['link'] - - @link.setter - def link(self, val): - self['link'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # node - # ---- - @property - 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 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 - each `node`. If `node.color` is omitted, then - the default `Plotly` color palette will be - cycled through to have a variety of colors. - These defaults are not fully opaque, to allow - some visibility of what is beneath the node. - colorsrc - Sets the source reference on plot.ly for color - . - groups - Groups of nodes. Each group is defined by an - array with the indices of the nodes it - contains. Multiple groups can be specified. - hoverinfo - Determines which trace information appear when - hovering nodes. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverlabel - plotly.graph_objs.sankey.node.Hoverlabel - instance or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - variables `value` and `label`. Anything - contained in tag `` is displayed in the - secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - label - The shown name of the node. - labelsrc - Sets the source reference on plot.ly for label - . - line - plotly.graph_objs.sankey.node.Line instance or - dict with compatible properties - pad - Sets the padding (in px) between the `nodes`. - thickness - Sets the thickness (in px) of the `nodes`. - - Returns - ------- - plotly.graph_objs.sankey.Node - """ - return self['node'] - - @node.setter - def node(self, val): - self['node'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # orientation - # ----------- - @property - 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'] - - Returns - ------- - Any - """ - return self['orientation'] - - @orientation.setter - def orientation(self, val): - self['orientation'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.sankey.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.sankey.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # textfont - # -------- - @property - 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 plotly.graph_objs.sankey.Textfont - - A dict of string/value properties that will be passed - to the Textfont constructor - - Supported dict properties: - - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.sankey.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # valueformat - # ----------- - @property - def valueformat(self): - """ - Sets the value formatting rule using d3 formatting mini- - language which is similar to those of Python. See https://githu - b.com/d3/d3-format/blob/master/README.md#locale_format - - The 'valueformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['valueformat'] - - @valueformat.setter - def valueformat(self, val): - self['valueformat'] = val - - # valuesuffix - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['valuesuffix'] - - @valuesuffix.setter - def valuesuffix(self, val): - self['valuesuffix'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - arrangement - If value is `snap` (the default), the node arrangement - is assisted by automatic snapping of elements to - preserve space between nodes specified via `nodepad`. - If value is `perpendicular`, the nodes can only move - along a line perpendicular to the flow. If value is - `freeform`, the nodes can freely move on the plane. If - value is `fixed`, the nodes are stationary. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - domain - plotly.graph_objs.sankey.Domain instance or dict with - compatible properties - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. Note that this attribute is - superseded by `node.hoverinfo` and `node.hoverinfo` for - nodes and links respectively. - hoverlabel - plotly.graph_objs.sankey.Hoverlabel instance or dict - with compatible properties - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - link - The links of the Sankey plot. - name - Sets the trace name. The trace name appear as the - legend item and on hover. - node - The nodes of the Sankey plot. - opacity - Sets the opacity of the trace. - orientation - Sets the orientation of the Sankey diagram. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.sankey.Stream instance or dict with - compatible properties - textfont - Sets the font for node labels - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - valueformat - Sets the value formatting rule using d3 formatting - mini-language which is similar to those of Python. See - https://github.com/d3/d3-format/blob/master/README.md#l - ocale_format - valuesuffix - Adds a unit to follow the value in the hover tooltip. - Add a space if a separation is necessary from the - value. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - """ - - def __init__( - self, - arg=None, - arrangement=None, - customdata=None, - customdatasrc=None, - domain=None, - hoverinfo=None, - hoverlabel=None, - ids=None, - idssrc=None, - legendgroup=None, - link=None, - name=None, - node=None, - opacity=None, - orientation=None, - selectedpoints=None, - showlegend=None, - stream=None, - textfont=None, - uid=None, - uirevision=None, - valueformat=None, - valuesuffix=None, - visible=None, - **kwargs - ): - """ - Construct a new Sankey object - - Sankey plots for network flow data analysis. The nodes are - specified in `nodes` and the links between sources and targets - in `links`. The colors are set in `nodes[i].color` and - `links[i].color`; otherwise defaults are used. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Sankey - arrangement - If value is `snap` (the default), the node arrangement - is assisted by automatic snapping of elements to - preserve space between nodes specified via `nodepad`. - If value is `perpendicular`, the nodes can only move - along a line perpendicular to the flow. If value is - `freeform`, the nodes can freely move on the plane. If - value is `fixed`, the nodes are stationary. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - domain - plotly.graph_objs.sankey.Domain instance or dict with - compatible properties - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. Note that this attribute is - superseded by `node.hoverinfo` and `node.hoverinfo` for - nodes and links respectively. - hoverlabel - plotly.graph_objs.sankey.Hoverlabel instance or dict - with compatible properties - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - link - The links of the Sankey plot. - name - Sets the trace name. The trace name appear as the - legend item and on hover. - node - The nodes of the Sankey plot. - opacity - Sets the opacity of the trace. - orientation - Sets the orientation of the Sankey diagram. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.sankey.Stream instance or dict with - compatible properties - textfont - Sets the font for node labels - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - valueformat - Sets the value formatting rule using d3 formatting - mini-language which is similar to those of Python. See - https://github.com/d3/d3-format/blob/master/README.md#l - ocale_format - valuesuffix - Adds a unit to follow the value in the hover tooltip. - Add a space if a separation is necessary from the - value. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - - Returns - ------- - Sankey - """ - super(Sankey, self).__init__('sankey') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Sankey -constructor must be a dict or -an instance of plotly.graph_objs.Sankey""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (sankey as v_sankey) - - # Initialize validators - # --------------------- - self._validators['arrangement'] = v_sankey.ArrangementValidator() - self._validators['customdata'] = v_sankey.CustomdataValidator() - self._validators['customdatasrc'] = v_sankey.CustomdatasrcValidator() - self._validators['domain'] = v_sankey.DomainValidator() - self._validators['hoverinfo'] = v_sankey.HoverinfoValidator() - self._validators['hoverlabel'] = v_sankey.HoverlabelValidator() - self._validators['ids'] = v_sankey.IdsValidator() - self._validators['idssrc'] = v_sankey.IdssrcValidator() - self._validators['legendgroup'] = v_sankey.LegendgroupValidator() - self._validators['link'] = v_sankey.LinkValidator() - self._validators['name'] = v_sankey.NameValidator() - self._validators['node'] = v_sankey.NodeValidator() - self._validators['opacity'] = v_sankey.OpacityValidator() - self._validators['orientation'] = v_sankey.OrientationValidator() - self._validators['selectedpoints'] = v_sankey.SelectedpointsValidator() - self._validators['showlegend'] = v_sankey.ShowlegendValidator() - self._validators['stream'] = v_sankey.StreamValidator() - self._validators['textfont'] = v_sankey.TextfontValidator() - self._validators['uid'] = v_sankey.UidValidator() - self._validators['uirevision'] = v_sankey.UirevisionValidator() - self._validators['valueformat'] = v_sankey.ValueformatValidator() - self._validators['valuesuffix'] = v_sankey.ValuesuffixValidator() - self._validators['visible'] = v_sankey.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('arrangement', None) - self['arrangement'] = arrangement if arrangement is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('domain', None) - self['domain'] = domain if domain is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('link', None) - self['link'] = link if link is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('node', None) - self['node'] = node if node is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('orientation', None) - self['orientation'] = orientation if orientation is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('valueformat', None) - self['valueformat'] = valueformat if valueformat is not None else _v - _v = arg.pop('valuesuffix', None) - self['valuesuffix'] = valuesuffix if valuesuffix is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'sankey' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='sankey', val='sankey' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_scatter.py b/plotly/graph_objs/_scatter.py deleted file mode 100644 index bfea963b3fd..00000000000 --- a/plotly/graph_objs/_scatter.py +++ /dev/null @@ -1,2600 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Scatter(BaseTraceType): - - # cliponaxis - # ---------- - @property - def cliponaxis(self): - """ - Determines whether or not markers and text nodes are clipped - about the subplot axes. To show markers and text nodes above - axis lines and tick labels, make sure to set `xaxis.layer` and - `yaxis.layer` to *below traces*. - - The 'cliponaxis' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cliponaxis'] - - @cliponaxis.setter - def cliponaxis(self, val): - self['cliponaxis'] = val - - # connectgaps - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['connectgaps'] - - @connectgaps.setter - def connectgaps(self, val): - self['connectgaps'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # dx - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['dx'] - - @dx.setter - def dx(self, val): - self['dx'] = val - - # dy - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['dy'] - - @dy.setter - def dy(self, val): - self['dy'] = val - - # error_x - # ------- - @property - def error_x(self): - """ - The 'error_x' property is an instance of ErrorX - that may be specified as: - - An instance of plotly.graph_objs.scatter.ErrorX - - A dict of string/value properties that will be passed - to the ErrorX constructor - - Supported dict properties: - - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - copy_ystyle - - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. - - Returns - ------- - plotly.graph_objs.scatter.ErrorX - """ - return self['error_x'] - - @error_x.setter - def error_x(self, val): - self['error_x'] = val - - # error_y - # ------- - @property - def error_y(self): - """ - The 'error_y' property is an instance of ErrorY - that may be specified as: - - An instance of plotly.graph_objs.scatter.ErrorY - - A dict of string/value properties that will be passed - to the ErrorY constructor - - Supported dict properties: - - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. - - Returns - ------- - plotly.graph_objs.scatter.ErrorY - """ - return self['error_y'] - - @error_y.setter - def error_y(self, val): - self['error_y'] = val - - # fill - # ---- - @property - def fill(self): - """ - Sets the area to fill with a solid color. Defaults to "none" - unless this trace is stacked, then it gets "tonexty" - ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` - if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 - respectively. "tonextx" and "tonexty" fill between the - endpoints of this trace and the endpoints of the trace before - it, connecting those endpoints with straight lines (to make a - stacked area graph); if there is no trace before it, they - behave like "tozerox" and "tozeroy". "toself" connects the - endpoints of the trace (or each segment of the trace if it has - gaps) into a closed shape. "tonext" fills the space between two - traces if one completely encloses the other (eg consecutive - contour lines), and behaves like "toself" if there is no trace - before it. "tonext" should not be used if one trace does not - enclose the other. Traces in a `stackgroup` will only fill to - (or be filled to) other traces in the same group. With multiple - `stackgroup`s or some traces stacked and some not, if fill- - linked traces are not already consecutive, the later ones will - be pushed down in the drawing order. - - The 'fill' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', - 'toself', 'tonext'] - - Returns - ------- - Any - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # fillcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['fillcolor'] - - @fillcolor.setter - def fillcolor(self, val): - self['fillcolor'] = val - - # groupnorm - # --------- - @property - def groupnorm(self): - """ - Only relevant when `stackgroup` is used, and only the first - `groupnorm` found in the `stackgroup` will be used - including - if `visible` is "legendonly" but not if it is `false`. Sets the - normalization for the sum of this `stackgroup`. With - "fraction", the value of each trace at each location is divided - by the sum of all trace values at that location. "percent" is - the same but multiplied by 100 to show percentages. If there - are multiple subplots, or multiple `stackgroup`s on one - subplot, each will be normalized within its own set. - - The 'groupnorm' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['', 'fraction', 'percent'] - - Returns - ------- - Any - """ - return self['groupnorm'] - - @groupnorm.setter - def groupnorm(self, val): - self['groupnorm'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.scatter.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.scatter.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hoveron - # ------- - @property - def hoveron(self): - """ - Do the hover effects highlight individual points (markers or - line points) or do they highlight filled regions? If the fill - is "toself" or "tonext" and there are no markers or text, then - the default is "fills", otherwise it is "points". - - The 'hoveron' property is a flaglist and may be specified - as a string containing: - - Any combination of ['points', 'fills'] joined with '+' characters - (e.g. 'points+fills') - - Returns - ------- - Any - """ - return self['hoveron'] - - @hoveron.setter - def hoveron(self, val): - self['hoveron'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - def hovertext(self): - """ - Sets hover text elements associated with each (x,y) pair. If a - single string, the same string appears over all the data - points. If an array of string, the items are mapped in order to - the this trace's (x,y) coordinates. To be seen, trace - `hoverinfo` must contain a "text" flag. - - The 'hovertext' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - shape - Determines the line shape. With "spline" the - lines are drawn using spline interpolation. The - other available values correspond to step-wise - line shapes. - simplify - Simplifies lines by removing nearly-collinear - points. When transitioning lines, it may be - desirable to disable this so that the number of - points along the resulting SVG path is - unaffected. - smoothing - Has an effect only if `shape` is set to - "spline" Sets the amount of smoothing. 0 - corresponds to no smoothing (equivalent to a - "linear" shape). - width - Sets the line width (in px). - - Returns - ------- - plotly.graph_objs.scatter.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scatter.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - gradient - plotly.graph_objs.scatter.marker.Gradient - instance or dict with compatible properties - line - plotly.graph_objs.scatter.marker.Line instance - or dict with compatible properties - maxdisplayed - Sets a maximum number of points to be drawn on - the graph. 0 corresponds to no limit. - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . - - Returns - ------- - plotly.graph_objs.scatter.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # mode - # ---- - @property - def mode(self): - """ - Determines the drawing mode for this scatter trace. If the - provided `mode` includes "text" then the `text` elements appear - at the coordinates. Otherwise, the `text` elements appear on - hover. If there are less than 20 points and the trace is not - stacked then the default is "lines+markers". Otherwise, - "lines". - - The 'mode' property is a flaglist and may be specified - as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters - (e.g. 'lines+markers') - OR exactly one of ['none'] (e.g. 'none') - - Returns - ------- - Any - """ - return self['mode'] - - @mode.setter - def mode(self, val): - self['mode'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # orientation - # ----------- - @property - def orientation(self): - """ - Only relevant when `stackgroup` is used, and only the first - `orientation` found in the `stackgroup` will be used - - including if `visible` is "legendonly" but not if it is - `false`. Sets the stacking direction. With "v" ("h"), the y (x) - values of subsequent traces are added. Also affects the default - value of `fill`. - - The 'orientation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['v', 'h'] - - Returns - ------- - Any - """ - return self['orientation'] - - @orientation.setter - def orientation(self, val): - self['orientation'] = val - - # r - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['r'] - - @r.setter - def r(self, val): - self['r'] = val - - # rsrc - # ---- - @property - def rsrc(self): - """ - Sets the source reference on plot.ly for r . - - The 'rsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['rsrc'] - - @rsrc.setter - def rsrc(self, val): - self['rsrc'] = val - - # selected - # -------- - @property - def selected(self): - """ - The 'selected' property is an instance of Selected - that may be specified as: - - An instance of plotly.graph_objs.scatter.Selected - - A dict of string/value properties that will be passed - to the Selected constructor - - Supported dict properties: - - marker - plotly.graph_objs.scatter.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scatter.selected.Textfont - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.scatter.Selected - """ - return self['selected'] - - @selected.setter - def selected(self, val): - self['selected'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stackgaps - # --------- - @property - def stackgaps(self): - """ - Only relevant when `stackgroup` is used, and only the first - `stackgaps` found in the `stackgroup` will be used - including - if `visible` is "legendonly" but not if it is `false`. - Determines how we handle locations at which other traces in - this group have data but this one does not. With *infer zero* - we insert a zero at these locations. With "interpolate" we - linearly interpolate between existing values, and extrapolate a - constant beyond the existing values. - - The 'stackgaps' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['infer zero', 'interpolate'] - - Returns - ------- - Any - """ - return self['stackgaps'] - - @stackgaps.setter - def stackgaps(self, val): - self['stackgaps'] = val - - # stackgroup - # ---------- - @property - def stackgroup(self): - """ - Set several scatter traces (on the same subplot) to the same - stackgroup in order to add their y values (or their x values if - `orientation` is "h"). If blank or omitted this trace will not - be stacked. Stacking also turns `fill` on by default, using - "tonexty" ("tonextx") if `orientation` is "h" ("v") and sets - the default `mode` to "lines" irrespective of point count. You - can only stack on a numeric (linear or log) axis. Traces in a - `stackgroup` will only fill to (or be filled to) other traces - in the same group. With multiple `stackgroup`s or some traces - stacked and some not, if fill-linked traces are not already - consecutive, the later ones will be pushed down in the drawing - order. - - The 'stackgroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['stackgroup'] - - @stackgroup.setter - def stackgroup(self, val): - self['stackgroup'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.scatter.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.scatter.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # t - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['t'] - - @t.setter - def t(self, val): - self['t'] = val - - # text - # ---- - @property - def text(self): - """ - Sets text elements associated with each (x,y) pair. If a single - string, the same string appears over all the data points. If an - array of string, the items are mapped in order to the this - trace's (x,y) coordinates. If trace `hoverinfo` contains a - "text" flag and "hovertext" is not set, these elements will be - seen in the hover labels. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - Sets the text font. - - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scatter.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # textposition - # ------------ - @property - 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', - 'middle center', 'middle right', 'bottom left', 'bottom - center', 'bottom right'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['textposition'] - - @textposition.setter - def textposition(self, val): - self['textposition'] = val - - # textpositionsrc - # --------------- - @property - def textpositionsrc(self): - """ - Sets the source reference on plot.ly for textposition . - - The 'textpositionsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textpositionsrc'] - - @textpositionsrc.setter - def textpositionsrc(self, val): - self['textpositionsrc'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # tsrc - # ---- - @property - def tsrc(self): - """ - Sets the source reference on plot.ly for t . - - The 'tsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tsrc'] - - @tsrc.setter - def tsrc(self, val): - self['tsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # unselected - # ---------- - @property - def unselected(self): - """ - The 'unselected' property is an instance of Unselected - that may be specified as: - - An instance of plotly.graph_objs.scatter.Unselected - - A dict of string/value properties that will be passed - to the Unselected constructor - - Supported dict properties: - - marker - plotly.graph_objs.scatter.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scatter.unselected.Textfont - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.scatter.Unselected - """ - return self['unselected'] - - @unselected.setter - def unselected(self, val): - self['unselected'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # x0 - # -- - @property - 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 - ------- - Any - """ - return self['x0'] - - @x0.setter - def x0(self, val): - self['x0'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # xcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['xcalendar'] - - @xcalendar.setter - def xcalendar(self, val): - self['xcalendar'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # y0 - # -- - @property - 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 - ------- - Any - """ - return self['y0'] - - @y0.setter - def y0(self, val): - self['y0'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # ycalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['ycalendar'] - - @ycalendar.setter - def ycalendar(self, val): - self['ycalendar'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - cliponaxis - Determines whether or not markers and text nodes are - clipped about the subplot axes. To show markers and - text nodes above axis lines and tick labels, make sure - to set `xaxis.layer` and `yaxis.layer` to *below - traces*. - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dx - Sets the x coordinate step. See `x0` for more info. - dy - Sets the y coordinate step. See `y0` for more info. - error_x - plotly.graph_objs.scatter.ErrorX instance or dict with - compatible properties - error_y - plotly.graph_objs.scatter.ErrorY instance or dict with - compatible properties - fill - Sets the area to fill with a solid color. Defaults to - "none" unless this trace is stacked, then it gets - "tonexty" ("tonextx") if `orientation` is "v" ("h") Use - with `fillcolor` if not "none". "tozerox" and "tozeroy" - fill to x=0 and y=0 respectively. "tonextx" and - "tonexty" fill between the endpoints of this trace and - the endpoints of the trace before it, connecting those - endpoints with straight lines (to make a stacked area - graph); if there is no trace before it, they behave - like "tozerox" and "tozeroy". "toself" connects the - endpoints of the trace (or each segment of the trace if - it has gaps) into a closed shape. "tonext" fills the - space between two traces if one completely encloses the - other (eg consecutive contour lines), and behaves like - "toself" if there is no trace before it. "tonext" - should not be used if one trace does not enclose the - other. Traces in a `stackgroup` will only fill to (or - be filled to) other traces in the same group. With - multiple `stackgroup`s or some traces stacked and some - not, if fill-linked traces are not already consecutive, - the later ones will be pushed down in the drawing - order. - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - groupnorm - Only relevant when `stackgroup` is used, and only the - first `groupnorm` found in the `stackgroup` will be - used - including if `visible` is "legendonly" but not - if it is `false`. Sets the normalization for the sum of - this `stackgroup`. With "fraction", the value of each - trace at each location is divided by the sum of all - trace values at that location. "percent" is the same - but multiplied by 100 to show percentages. If there are - multiple subplots, or multiple `stackgroup`s on one - subplot, each will be normalized within its own set. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scatter.Hoverlabel instance or dict - with compatible properties - hoveron - Do the hover effects highlight individual points - (markers or line points) or do they highlight filled - regions? If the fill is "toself" or "tonext" and there - are no markers or text, then the default is "fills", - otherwise it is "points". - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (x,y) - pair. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to the this trace's (x,y) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scatter.Line instance or dict with - compatible properties - marker - plotly.graph_objs.scatter.Marker instance or dict with - compatible properties - mode - Determines the drawing mode for this scatter trace. If - the provided `mode` includes "text" then the `text` - elements appear at the coordinates. Otherwise, the - `text` elements appear on hover. If there are less than - 20 points and the trace is not stacked then the default - is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - orientation - Only relevant when `stackgroup` is used, and only the - first `orientation` found in the `stackgroup` will be - used - including if `visible` is "legendonly" but not - if it is `false`. Sets the stacking direction. With "v" - ("h"), the y (x) values of subsequent traces are added. - Also affects the default value of `fill`. - r - r coordinates in scatter traces are deprecated!Please - switch to the "scatterpolar" trace type.Sets the radial - coordinatesfor legacy polar chart only. - rsrc - Sets the source reference on plot.ly for r . - selected - plotly.graph_objs.scatter.Selected instance or dict - with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stackgaps - Only relevant when `stackgroup` is used, and only the - first `stackgaps` found in the `stackgroup` will be - used - including if `visible` is "legendonly" but not - if it is `false`. Determines how we handle locations at - which other traces in this group have data but this one - does not. With *infer zero* we insert a zero at these - locations. With "interpolate" we linearly interpolate - between existing values, and extrapolate a constant - beyond the existing values. - stackgroup - Set several scatter traces (on the same subplot) to the - same stackgroup in order to add their y values (or - their x values if `orientation` is "h"). If blank or - omitted this trace will not be stacked. Stacking also - turns `fill` on by default, using "tonexty" ("tonextx") - if `orientation` is "h" ("v") and sets the default - `mode` to "lines" irrespective of point count. You can - only stack on a numeric (linear or log) axis. Traces in - a `stackgroup` will only fill to (or be filled to) - other traces in the same group. With multiple - `stackgroup`s or some traces stacked and some not, if - fill-linked traces are not already consecutive, the - later ones will be pushed down in the drawing order. - stream - plotly.graph_objs.scatter.Stream instance or dict with - compatible properties - t - t coordinates in scatter traces are deprecated!Please - switch to the "scatterpolar" trace type.Sets the - angular coordinatesfor legacy polar chart only. - text - Sets text elements associated with each (x,y) pair. If - a single string, the same string appears over all the - data points. If an array of string, the items are - mapped in order to the this trace's (x,y) coordinates. - If trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - tsrc - Sets the source reference on plot.ly for t . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.scatter.Unselected instance or dict - with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the starting - coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the starting - coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - """ - - def __init__( - self, - arg=None, - cliponaxis=None, - connectgaps=None, - customdata=None, - customdatasrc=None, - dx=None, - dy=None, - error_x=None, - error_y=None, - fill=None, - fillcolor=None, - groupnorm=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hoveron=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - legendgroup=None, - line=None, - marker=None, - mode=None, - name=None, - opacity=None, - orientation=None, - r=None, - rsrc=None, - selected=None, - selectedpoints=None, - showlegend=None, - stackgaps=None, - stackgroup=None, - stream=None, - t=None, - text=None, - textfont=None, - textposition=None, - textpositionsrc=None, - textsrc=None, - tsrc=None, - uid=None, - uirevision=None, - unselected=None, - visible=None, - x=None, - x0=None, - xaxis=None, - xcalendar=None, - xsrc=None, - y=None, - y0=None, - yaxis=None, - ycalendar=None, - ysrc=None, - **kwargs - ): - """ - Construct a new Scatter object - - The scatter trace type encompasses line charts, scatter charts, - text charts, and bubble charts. The data visualized as scatter - point or lines is set in `x` and `y`. Text (appearing either on - the chart or on hover only) is via `text`. Bubble charts are - achieved by setting `marker.size` and/or `marker.color` to - numerical arrays. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scatter - cliponaxis - Determines whether or not markers and text nodes are - clipped about the subplot axes. To show markers and - text nodes above axis lines and tick labels, make sure - to set `xaxis.layer` and `yaxis.layer` to *below - traces*. - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dx - Sets the x coordinate step. See `x0` for more info. - dy - Sets the y coordinate step. See `y0` for more info. - error_x - plotly.graph_objs.scatter.ErrorX instance or dict with - compatible properties - error_y - plotly.graph_objs.scatter.ErrorY instance or dict with - compatible properties - fill - Sets the area to fill with a solid color. Defaults to - "none" unless this trace is stacked, then it gets - "tonexty" ("tonextx") if `orientation` is "v" ("h") Use - with `fillcolor` if not "none". "tozerox" and "tozeroy" - fill to x=0 and y=0 respectively. "tonextx" and - "tonexty" fill between the endpoints of this trace and - the endpoints of the trace before it, connecting those - endpoints with straight lines (to make a stacked area - graph); if there is no trace before it, they behave - like "tozerox" and "tozeroy". "toself" connects the - endpoints of the trace (or each segment of the trace if - it has gaps) into a closed shape. "tonext" fills the - space between two traces if one completely encloses the - other (eg consecutive contour lines), and behaves like - "toself" if there is no trace before it. "tonext" - should not be used if one trace does not enclose the - other. Traces in a `stackgroup` will only fill to (or - be filled to) other traces in the same group. With - multiple `stackgroup`s or some traces stacked and some - not, if fill-linked traces are not already consecutive, - the later ones will be pushed down in the drawing - order. - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - groupnorm - Only relevant when `stackgroup` is used, and only the - first `groupnorm` found in the `stackgroup` will be - used - including if `visible` is "legendonly" but not - if it is `false`. Sets the normalization for the sum of - this `stackgroup`. With "fraction", the value of each - trace at each location is divided by the sum of all - trace values at that location. "percent" is the same - but multiplied by 100 to show percentages. If there are - multiple subplots, or multiple `stackgroup`s on one - subplot, each will be normalized within its own set. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scatter.Hoverlabel instance or dict - with compatible properties - hoveron - Do the hover effects highlight individual points - (markers or line points) or do they highlight filled - regions? If the fill is "toself" or "tonext" and there - are no markers or text, then the default is "fills", - otherwise it is "points". - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (x,y) - pair. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to the this trace's (x,y) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scatter.Line instance or dict with - compatible properties - marker - plotly.graph_objs.scatter.Marker instance or dict with - compatible properties - mode - Determines the drawing mode for this scatter trace. If - the provided `mode` includes "text" then the `text` - elements appear at the coordinates. Otherwise, the - `text` elements appear on hover. If there are less than - 20 points and the trace is not stacked then the default - is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - orientation - Only relevant when `stackgroup` is used, and only the - first `orientation` found in the `stackgroup` will be - used - including if `visible` is "legendonly" but not - if it is `false`. Sets the stacking direction. With "v" - ("h"), the y (x) values of subsequent traces are added. - Also affects the default value of `fill`. - r - r coordinates in scatter traces are deprecated!Please - switch to the "scatterpolar" trace type.Sets the radial - coordinatesfor legacy polar chart only. - rsrc - Sets the source reference on plot.ly for r . - selected - plotly.graph_objs.scatter.Selected instance or dict - with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stackgaps - Only relevant when `stackgroup` is used, and only the - first `stackgaps` found in the `stackgroup` will be - used - including if `visible` is "legendonly" but not - if it is `false`. Determines how we handle locations at - which other traces in this group have data but this one - does not. With *infer zero* we insert a zero at these - locations. With "interpolate" we linearly interpolate - between existing values, and extrapolate a constant - beyond the existing values. - stackgroup - Set several scatter traces (on the same subplot) to the - same stackgroup in order to add their y values (or - their x values if `orientation` is "h"). If blank or - omitted this trace will not be stacked. Stacking also - turns `fill` on by default, using "tonexty" ("tonextx") - if `orientation` is "h" ("v") and sets the default - `mode` to "lines" irrespective of point count. You can - only stack on a numeric (linear or log) axis. Traces in - a `stackgroup` will only fill to (or be filled to) - other traces in the same group. With multiple - `stackgroup`s or some traces stacked and some not, if - fill-linked traces are not already consecutive, the - later ones will be pushed down in the drawing order. - stream - plotly.graph_objs.scatter.Stream instance or dict with - compatible properties - t - t coordinates in scatter traces are deprecated!Please - switch to the "scatterpolar" trace type.Sets the - angular coordinatesfor legacy polar chart only. - text - Sets text elements associated with each (x,y) pair. If - a single string, the same string appears over all the - data points. If an array of string, the items are - mapped in order to the this trace's (x,y) coordinates. - If trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - tsrc - Sets the source reference on plot.ly for t . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.scatter.Unselected instance or dict - with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the starting - coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the starting - coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - - Returns - ------- - Scatter - """ - super(Scatter, self).__init__('scatter') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Scatter -constructor must be a dict or -an instance of plotly.graph_objs.Scatter""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (scatter as v_scatter) - - # Initialize validators - # --------------------- - self._validators['cliponaxis'] = v_scatter.CliponaxisValidator() - self._validators['connectgaps'] = v_scatter.ConnectgapsValidator() - self._validators['customdata'] = v_scatter.CustomdataValidator() - self._validators['customdatasrc'] = v_scatter.CustomdatasrcValidator() - self._validators['dx'] = v_scatter.DxValidator() - self._validators['dy'] = v_scatter.DyValidator() - self._validators['error_x'] = v_scatter.ErrorXValidator() - self._validators['error_y'] = v_scatter.ErrorYValidator() - self._validators['fill'] = v_scatter.FillValidator() - self._validators['fillcolor'] = v_scatter.FillcolorValidator() - self._validators['groupnorm'] = v_scatter.GroupnormValidator() - self._validators['hoverinfo'] = v_scatter.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_scatter.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_scatter.HoverlabelValidator() - self._validators['hoveron'] = v_scatter.HoveronValidator() - self._validators['hovertemplate'] = v_scatter.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_scatter.HovertemplatesrcValidator() - self._validators['hovertext'] = v_scatter.HovertextValidator() - self._validators['hovertextsrc'] = v_scatter.HovertextsrcValidator() - self._validators['ids'] = v_scatter.IdsValidator() - self._validators['idssrc'] = v_scatter.IdssrcValidator() - self._validators['legendgroup'] = v_scatter.LegendgroupValidator() - self._validators['line'] = v_scatter.LineValidator() - self._validators['marker'] = v_scatter.MarkerValidator() - self._validators['mode'] = v_scatter.ModeValidator() - self._validators['name'] = v_scatter.NameValidator() - self._validators['opacity'] = v_scatter.OpacityValidator() - self._validators['orientation'] = v_scatter.OrientationValidator() - self._validators['r'] = v_scatter.RValidator() - self._validators['rsrc'] = v_scatter.RsrcValidator() - self._validators['selected'] = v_scatter.SelectedValidator() - self._validators['selectedpoints'] = v_scatter.SelectedpointsValidator( - ) - self._validators['showlegend'] = v_scatter.ShowlegendValidator() - self._validators['stackgaps'] = v_scatter.StackgapsValidator() - self._validators['stackgroup'] = v_scatter.StackgroupValidator() - self._validators['stream'] = v_scatter.StreamValidator() - self._validators['t'] = v_scatter.TValidator() - self._validators['text'] = v_scatter.TextValidator() - self._validators['textfont'] = v_scatter.TextfontValidator() - self._validators['textposition'] = v_scatter.TextpositionValidator() - self._validators['textpositionsrc' - ] = v_scatter.TextpositionsrcValidator() - self._validators['textsrc'] = v_scatter.TextsrcValidator() - self._validators['tsrc'] = v_scatter.TsrcValidator() - self._validators['uid'] = v_scatter.UidValidator() - self._validators['uirevision'] = v_scatter.UirevisionValidator() - self._validators['unselected'] = v_scatter.UnselectedValidator() - self._validators['visible'] = v_scatter.VisibleValidator() - self._validators['x'] = v_scatter.XValidator() - self._validators['x0'] = v_scatter.X0Validator() - self._validators['xaxis'] = v_scatter.XAxisValidator() - self._validators['xcalendar'] = v_scatter.XcalendarValidator() - self._validators['xsrc'] = v_scatter.XsrcValidator() - self._validators['y'] = v_scatter.YValidator() - self._validators['y0'] = v_scatter.Y0Validator() - self._validators['yaxis'] = v_scatter.YAxisValidator() - self._validators['ycalendar'] = v_scatter.YcalendarValidator() - self._validators['ysrc'] = v_scatter.YsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('cliponaxis', None) - self['cliponaxis'] = cliponaxis if cliponaxis is not None else _v - _v = arg.pop('connectgaps', None) - self['connectgaps'] = connectgaps if connectgaps is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('dx', None) - self['dx'] = dx if dx is not None else _v - _v = arg.pop('dy', None) - self['dy'] = dy if dy is not None else _v - _v = arg.pop('error_x', None) - self['error_x'] = error_x if error_x is not None else _v - _v = arg.pop('error_y', None) - self['error_y'] = error_y if error_y is not None else _v - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('fillcolor', None) - self['fillcolor'] = fillcolor if fillcolor is not None else _v - _v = arg.pop('groupnorm', None) - self['groupnorm'] = groupnorm if groupnorm is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hoveron', None) - self['hoveron'] = hoveron if hoveron is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('mode', None) - self['mode'] = mode if mode is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('orientation', None) - self['orientation'] = orientation if orientation is not None else _v - _v = arg.pop('r', None) - self['r'] = r if r is not None else _v - _v = arg.pop('rsrc', None) - self['rsrc'] = rsrc if rsrc is not None else _v - _v = arg.pop('selected', None) - self['selected'] = selected if selected is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stackgaps', None) - self['stackgaps'] = stackgaps if stackgaps is not None else _v - _v = arg.pop('stackgroup', None) - self['stackgroup'] = stackgroup if stackgroup is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('t', None) - self['t'] = t if t is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - _v = arg.pop('textposition', None) - self['textposition'] = textposition if textposition is not None else _v - _v = arg.pop('textpositionsrc', None) - self['textpositionsrc' - ] = textpositionsrc if textpositionsrc is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('tsrc', None) - self['tsrc'] = tsrc if tsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('unselected', None) - self['unselected'] = unselected if unselected is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('x0', None) - self['x0'] = x0 if x0 is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('xcalendar', None) - self['xcalendar'] = xcalendar if xcalendar is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('y0', None) - self['y0'] = y0 if y0 is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - _v = arg.pop('ycalendar', None) - self['ycalendar'] = ycalendar if ycalendar is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'scatter' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='scatter', val='scatter' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_scatter3d.py b/plotly/graph_objs/_scatter3d.py deleted file mode 100644 index 521b402266c..00000000000 --- a/plotly/graph_objs/_scatter3d.py +++ /dev/null @@ -1,2145 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Scatter3d(BaseTraceType): - - # connectgaps - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['connectgaps'] - - @connectgaps.setter - def connectgaps(self, val): - self['connectgaps'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # error_x - # ------- - @property - def error_x(self): - """ - The 'error_x' property is an instance of ErrorX - that may be specified as: - - An instance of plotly.graph_objs.scatter3d.ErrorX - - A dict of string/value properties that will be passed - to the ErrorX constructor - - Supported dict properties: - - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - copy_zstyle - - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. - - Returns - ------- - plotly.graph_objs.scatter3d.ErrorX - """ - return self['error_x'] - - @error_x.setter - def error_x(self, val): - self['error_x'] = val - - # error_y - # ------- - @property - def error_y(self): - """ - The 'error_y' property is an instance of ErrorY - that may be specified as: - - An instance of plotly.graph_objs.scatter3d.ErrorY - - A dict of string/value properties that will be passed - to the ErrorY constructor - - Supported dict properties: - - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - copy_zstyle - - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. - - Returns - ------- - plotly.graph_objs.scatter3d.ErrorY - """ - return self['error_y'] - - @error_y.setter - def error_y(self, val): - self['error_y'] = val - - # error_z - # ------- - @property - def error_z(self): - """ - The 'error_z' property is an instance of ErrorZ - that may be specified as: - - An instance of plotly.graph_objs.scatter3d.ErrorZ - - A dict of string/value properties that will be passed - to the ErrorZ constructor - - Supported dict properties: - - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. - - Returns - ------- - plotly.graph_objs.scatter3d.ErrorZ - """ - return self['error_z'] - - @error_z.setter - def error_z(self, val): - self['error_z'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.scatter3d.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.scatter3d.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - def hovertext(self): - """ - Sets text elements associated with each (x,y,z) triplet. If a - single string, the same string appears over all the data - points. If an array of string, the items are mapped in order to - the this trace's (x,y,z) coordinates. To be seen, trace - `hoverinfo` must contain a "text" flag. - - The 'hovertext' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of plotly.graph_objs.scatter3d.Line - - A dict of string/value properties that will be passed - to the Line constructor - - Supported dict properties: - - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `line.colorscale`. Has an effect - only if in `line.color`is set to a numerical - array. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette - will be chosen according to whether numbers in - the `color` array are all positive, all - negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `line.color`) or the bounds set in - `line.cmin` and `line.cmax` Has an effect only - if in `line.color`is set to a numerical array. - Defaults to `false` when `line.cmin` and - `line.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `line.color`is set to a - numerical array. Value should have the same - units as in `line.color` and if set, - `line.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `line.cmin` and/or `line.cmax` to be - equidistant to this point. Has an effect only - if in `line.color`is set to a numerical array. - Value should have the same units as in - `line.color`. Has no effect when `line.cauto` - is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `line.color`is set to a - numerical array. Value should have the same - units as in `line.color` and if set, - `line.cmax` must be set as well. - color - Sets thelinecolor. It accepts either a specific - color or an array of numbers that are mapped to - the colorscale relative to the max and min - values of the array or relative to `line.cmin` - and `line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `line.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`line.cmin` and `line.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - dash - Sets the dash style of the lines. - reversescale - Reverses the color mapping if true. Has an - effect only if in `line.color`is set to a - numerical array. If true, `line.cmin` will - correspond to the last color in the array and - `line.cmax` will correspond to the first color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `line.color`is set to a numerical array. - width - Sets the line width (in px). - - Returns - ------- - plotly.graph_objs.scatter3d.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of plotly.graph_objs.scatter3d.Marker - - A dict of string/value properties that will be passed - to the Marker constructor - - Supported dict properties: - - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scatter3d.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - line - plotly.graph_objs.scatter3d.marker.Line - instance or dict with compatible properties - opacity - Sets the marker opacity. Note that the marker - opacity for scatter3d traces must be a scalar - value for performance reasons. To set a - blending opacity value (i.e. which is not - transparent), set "marker.color" to an rgba - color and use its alpha channel. - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. - symbolsrc - Sets the source reference on plot.ly for - symbol . - - Returns - ------- - plotly.graph_objs.scatter3d.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # mode - # ---- - @property - def mode(self): - """ - Determines the drawing mode for this scatter trace. If the - provided `mode` includes "text" then the `text` elements appear - at the coordinates. Otherwise, the `text` elements appear on - hover. If there are less than 20 points and the trace is not - stacked then the default is "lines+markers". Otherwise, - "lines". - - The 'mode' property is a flaglist and may be specified - as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters - (e.g. 'lines+markers') - OR exactly one of ['none'] (e.g. 'none') - - Returns - ------- - Any - """ - return self['mode'] - - @mode.setter - def mode(self, val): - self['mode'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # projection - # ---------- - @property - def projection(self): - """ - The 'projection' property is an instance of Projection - that may be specified as: - - An instance of plotly.graph_objs.scatter3d.Projection - - A dict of string/value properties that will be passed - to the Projection constructor - - Supported dict properties: - - x - plotly.graph_objs.scatter3d.projection.X - instance or dict with compatible properties - y - plotly.graph_objs.scatter3d.projection.Y - instance or dict with compatible properties - z - plotly.graph_objs.scatter3d.projection.Z - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.scatter3d.Projection - """ - return self['projection'] - - @projection.setter - def projection(self, val): - self['projection'] = val - - # scene - # ----- - @property - def scene(self): - """ - Sets a reference between this trace's 3D coordinate system and - a 3D scene. If "scene" (the default value), the (x,y,z) - coordinates refer to `layout.scene`. If "scene2", the (x,y,z) - coordinates refer to `layout.scene2`, and so on. - - The 'scene' property is an identifier of a particular - subplot, of type 'scene', that may be specified as the string 'scene' - optionally followed by an integer >= 1 - (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) - - Returns - ------- - str - """ - return self['scene'] - - @scene.setter - def scene(self, val): - self['scene'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.scatter3d.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.scatter3d.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # surfaceaxis - # ----------- - @property - 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] - - Returns - ------- - Any - """ - return self['surfaceaxis'] - - @surfaceaxis.setter - def surfaceaxis(self, val): - self['surfaceaxis'] = val - - # surfacecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['surfacecolor'] - - @surfacecolor.setter - def surfacecolor(self, val): - self['surfacecolor'] = val - - # text - # ---- - @property - def text(self): - """ - Sets text elements associated with each (x,y,z) triplet. If a - single string, the same string appears over all the data - points. If an array of string, the items are mapped in order to - the this trace's (x,y,z) coordinates. If trace `hoverinfo` - contains a "text" flag and "hovertext" is not set, these - elements will be seen in the hover labels. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scatter3d.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # textposition - # ------------ - @property - 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', - 'middle center', 'middle right', 'bottom left', 'bottom - center', 'bottom right'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['textposition'] - - @textposition.setter - def textposition(self, val): - self['textposition'] = val - - # textpositionsrc - # --------------- - @property - def textpositionsrc(self): - """ - Sets the source reference on plot.ly for textposition . - - The 'textpositionsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textpositionsrc'] - - @textpositionsrc.setter - def textpositionsrc(self, val): - self['textpositionsrc'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['xcalendar'] - - @xcalendar.setter - def xcalendar(self, val): - self['xcalendar'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # ycalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['ycalendar'] - - @ycalendar.setter - def ycalendar(self, val): - self['ycalendar'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # z - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # zcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['zcalendar'] - - @zcalendar.setter - def zcalendar(self, val): - self['zcalendar'] = val - - # zsrc - # ---- - @property - def zsrc(self): - """ - Sets the source reference on plot.ly for z . - - The 'zsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['zsrc'] - - @zsrc.setter - def zsrc(self, val): - self['zsrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - error_x - plotly.graph_objs.scatter3d.ErrorX instance or dict - with compatible properties - error_y - plotly.graph_objs.scatter3d.ErrorY instance or dict - with compatible properties - error_z - plotly.graph_objs.scatter3d.ErrorZ instance or dict - with compatible properties - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scatter3d.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets text elements associated with each (x,y,z) - triplet. If a single string, the same string appears - over all the data points. If an array of string, the - items are mapped in order to the this trace's (x,y,z) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scatter3d.Line instance or dict with - compatible properties - marker - plotly.graph_objs.scatter3d.Marker instance or dict - with compatible properties - mode - Determines the drawing mode for this scatter trace. If - the provided `mode` includes "text" then the `text` - elements appear at the coordinates. Otherwise, the - `text` elements appear on hover. If there are less than - 20 points and the trace is not stacked then the default - is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - projection - plotly.graph_objs.scatter3d.Projection instance or dict - with compatible properties - scene - Sets a reference between this trace's 3D coordinate - system and a 3D scene. If "scene" (the default value), - the (x,y,z) coordinates refer to `layout.scene`. If - "scene2", the (x,y,z) coordinates refer to - `layout.scene2`, and so on. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.scatter3d.Stream instance or dict - with compatible properties - surfaceaxis - If "-1", the scatter points are not fill with a surface - If 0, 1, 2, the scatter points are filled with a - Delaunay surface about the x, y, z respectively. - surfacecolor - Sets the surface fill color. - text - Sets text elements associated with each (x,y,z) - triplet. If a single string, the same string appears - over all the data points. If an array of string, the - items are mapped in order to the this trace's (x,y,z) - coordinates. If trace `hoverinfo` contains a "text" - flag and "hovertext" is not set, these elements will be - seen in the hover labels. - textfont - plotly.graph_objs.scatter3d.Textfont instance or dict - with compatible properties - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates. - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the z coordinates. - zcalendar - Sets the calendar system to use with `z` date data. - zsrc - Sets the source reference on plot.ly for z . - """ - - def __init__( - self, - arg=None, - connectgaps=None, - customdata=None, - customdatasrc=None, - error_x=None, - error_y=None, - error_z=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - legendgroup=None, - line=None, - marker=None, - mode=None, - name=None, - opacity=None, - projection=None, - scene=None, - selectedpoints=None, - showlegend=None, - stream=None, - surfaceaxis=None, - surfacecolor=None, - text=None, - textfont=None, - textposition=None, - textpositionsrc=None, - textsrc=None, - uid=None, - uirevision=None, - visible=None, - x=None, - xcalendar=None, - xsrc=None, - y=None, - ycalendar=None, - ysrc=None, - z=None, - zcalendar=None, - zsrc=None, - **kwargs - ): - """ - Construct a new Scatter3d object - - The data visualized as scatter point or lines in 3D dimension - is set in `x`, `y`, `z`. Text (appearing either on the chart or - on hover only) is via `text`. Bubble charts are achieved by - setting `marker.size` and/or `marker.color` Projections are - achieved via `projection`. Surface fills are achieved via - `surfaceaxis`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scatter3d - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - error_x - plotly.graph_objs.scatter3d.ErrorX instance or dict - with compatible properties - error_y - plotly.graph_objs.scatter3d.ErrorY instance or dict - with compatible properties - error_z - plotly.graph_objs.scatter3d.ErrorZ instance or dict - with compatible properties - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scatter3d.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets text elements associated with each (x,y,z) - triplet. If a single string, the same string appears - over all the data points. If an array of string, the - items are mapped in order to the this trace's (x,y,z) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scatter3d.Line instance or dict with - compatible properties - marker - plotly.graph_objs.scatter3d.Marker instance or dict - with compatible properties - mode - Determines the drawing mode for this scatter trace. If - the provided `mode` includes "text" then the `text` - elements appear at the coordinates. Otherwise, the - `text` elements appear on hover. If there are less than - 20 points and the trace is not stacked then the default - is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - projection - plotly.graph_objs.scatter3d.Projection instance or dict - with compatible properties - scene - Sets a reference between this trace's 3D coordinate - system and a 3D scene. If "scene" (the default value), - the (x,y,z) coordinates refer to `layout.scene`. If - "scene2", the (x,y,z) coordinates refer to - `layout.scene2`, and so on. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.scatter3d.Stream instance or dict - with compatible properties - surfaceaxis - If "-1", the scatter points are not fill with a surface - If 0, 1, 2, the scatter points are filled with a - Delaunay surface about the x, y, z respectively. - surfacecolor - Sets the surface fill color. - text - Sets text elements associated with each (x,y,z) - triplet. If a single string, the same string appears - over all the data points. If an array of string, the - items are mapped in order to the this trace's (x,y,z) - coordinates. If trace `hoverinfo` contains a "text" - flag and "hovertext" is not set, these elements will be - seen in the hover labels. - textfont - plotly.graph_objs.scatter3d.Textfont instance or dict - with compatible properties - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates. - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the z coordinates. - zcalendar - Sets the calendar system to use with `z` date data. - zsrc - Sets the source reference on plot.ly for z . - - Returns - ------- - Scatter3d - """ - super(Scatter3d, self).__init__('scatter3d') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Scatter3d -constructor must be a dict or -an instance of plotly.graph_objs.Scatter3d""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (scatter3d as v_scatter3d) - - # Initialize validators - # --------------------- - self._validators['connectgaps'] = v_scatter3d.ConnectgapsValidator() - self._validators['customdata'] = v_scatter3d.CustomdataValidator() - self._validators['customdatasrc'] = v_scatter3d.CustomdatasrcValidator( - ) - self._validators['error_x'] = v_scatter3d.ErrorXValidator() - self._validators['error_y'] = v_scatter3d.ErrorYValidator() - self._validators['error_z'] = v_scatter3d.ErrorZValidator() - self._validators['hoverinfo'] = v_scatter3d.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_scatter3d.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_scatter3d.HoverlabelValidator() - self._validators['hovertemplate'] = v_scatter3d.HovertemplateValidator( - ) - self._validators['hovertemplatesrc' - ] = v_scatter3d.HovertemplatesrcValidator() - self._validators['hovertext'] = v_scatter3d.HovertextValidator() - self._validators['hovertextsrc'] = v_scatter3d.HovertextsrcValidator() - self._validators['ids'] = v_scatter3d.IdsValidator() - self._validators['idssrc'] = v_scatter3d.IdssrcValidator() - self._validators['legendgroup'] = v_scatter3d.LegendgroupValidator() - self._validators['line'] = v_scatter3d.LineValidator() - self._validators['marker'] = v_scatter3d.MarkerValidator() - self._validators['mode'] = v_scatter3d.ModeValidator() - self._validators['name'] = v_scatter3d.NameValidator() - self._validators['opacity'] = v_scatter3d.OpacityValidator() - self._validators['projection'] = v_scatter3d.ProjectionValidator() - self._validators['scene'] = v_scatter3d.SceneValidator() - self._validators['selectedpoints' - ] = v_scatter3d.SelectedpointsValidator() - self._validators['showlegend'] = v_scatter3d.ShowlegendValidator() - self._validators['stream'] = v_scatter3d.StreamValidator() - self._validators['surfaceaxis'] = v_scatter3d.SurfaceaxisValidator() - self._validators['surfacecolor'] = v_scatter3d.SurfacecolorValidator() - self._validators['text'] = v_scatter3d.TextValidator() - self._validators['textfont'] = v_scatter3d.TextfontValidator() - self._validators['textposition'] = v_scatter3d.TextpositionValidator() - self._validators['textpositionsrc' - ] = v_scatter3d.TextpositionsrcValidator() - self._validators['textsrc'] = v_scatter3d.TextsrcValidator() - self._validators['uid'] = v_scatter3d.UidValidator() - self._validators['uirevision'] = v_scatter3d.UirevisionValidator() - self._validators['visible'] = v_scatter3d.VisibleValidator() - self._validators['x'] = v_scatter3d.XValidator() - self._validators['xcalendar'] = v_scatter3d.XcalendarValidator() - self._validators['xsrc'] = v_scatter3d.XsrcValidator() - self._validators['y'] = v_scatter3d.YValidator() - self._validators['ycalendar'] = v_scatter3d.YcalendarValidator() - self._validators['ysrc'] = v_scatter3d.YsrcValidator() - self._validators['z'] = v_scatter3d.ZValidator() - self._validators['zcalendar'] = v_scatter3d.ZcalendarValidator() - self._validators['zsrc'] = v_scatter3d.ZsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('connectgaps', None) - self['connectgaps'] = connectgaps if connectgaps is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('error_x', None) - self['error_x'] = error_x if error_x is not None else _v - _v = arg.pop('error_y', None) - self['error_y'] = error_y if error_y is not None else _v - _v = arg.pop('error_z', None) - self['error_z'] = error_z if error_z is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('mode', None) - self['mode'] = mode if mode is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('projection', None) - self['projection'] = projection if projection is not None else _v - _v = arg.pop('scene', None) - self['scene'] = scene if scene is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('surfaceaxis', None) - self['surfaceaxis'] = surfaceaxis if surfaceaxis is not None else _v - _v = arg.pop('surfacecolor', None) - self['surfacecolor'] = surfacecolor if surfacecolor is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - _v = arg.pop('textposition', None) - self['textposition'] = textposition if textposition is not None else _v - _v = arg.pop('textpositionsrc', None) - self['textpositionsrc' - ] = textpositionsrc if textpositionsrc is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xcalendar', None) - self['xcalendar'] = xcalendar if xcalendar is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('ycalendar', None) - self['ycalendar'] = ycalendar if ycalendar is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - _v = arg.pop('zcalendar', None) - self['zcalendar'] = zcalendar if zcalendar is not None else _v - _v = arg.pop('zsrc', None) - self['zsrc'] = zsrc if zsrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'scatter3d' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='scatter3d', val='scatter3d' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_scattercarpet.py b/plotly/graph_objs/_scattercarpet.py deleted file mode 100644 index 6e69d4c6186..00000000000 --- a/plotly/graph_objs/_scattercarpet.py +++ /dev/null @@ -1,1854 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Scattercarpet(BaseTraceType): - - # a - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['a'] - - @a.setter - def a(self, val): - self['a'] = val - - # asrc - # ---- - @property - def asrc(self): - """ - Sets the source reference on plot.ly for a . - - The 'asrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['asrc'] - - @asrc.setter - def asrc(self, val): - self['asrc'] = val - - # b - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['b'] - - @b.setter - def b(self, val): - self['b'] = val - - # bsrc - # ---- - @property - def bsrc(self): - """ - Sets the source reference on plot.ly for b . - - The 'bsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bsrc'] - - @bsrc.setter - def bsrc(self, val): - self['bsrc'] = val - - # carpet - # ------ - @property - def carpet(self): - """ - An identifier for this carpet, so that `scattercarpet` and - `scattercontour` traces can specify a carpet plot on which they - lie - - The 'carpet' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['carpet'] - - @carpet.setter - def carpet(self, val): - self['carpet'] = val - - # connectgaps - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['connectgaps'] - - @connectgaps.setter - def connectgaps(self, val): - self['connectgaps'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # fill - # ---- - @property - def fill(self): - """ - Sets the area to fill with a solid color. Use with `fillcolor` - if not "none". scatterternary has a subset of the options - available to scatter. "toself" connects the endpoints of the - trace (or each segment of the trace if it has gaps) into a - closed shape. "tonext" fills the space between two traces if - one completely encloses the other (eg consecutive contour - lines), and behaves like "toself" if there is no trace before - it. "tonext" should not be used if one trace does not enclose - the other. - - The 'fill' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'toself', 'tonext'] - - Returns - ------- - Any - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # fillcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['fillcolor'] - - @fillcolor.setter - def fillcolor(self, val): - self['fillcolor'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'a+b') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.scattercarpet.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hoveron - # ------- - @property - def hoveron(self): - """ - Do the hover effects highlight individual points (markers or - line points) or do they highlight filled regions? If the fill - is "toself" or "tonext" and there are no markers or text, then - the default is "fills", otherwise it is "points". - - The 'hoveron' property is a flaglist and may be specified - as a string containing: - - Any combination of ['points', 'fills'] joined with '+' characters - (e.g. 'points+fills') - - Returns - ------- - Any - """ - return self['hoveron'] - - @hoveron.setter - def hoveron(self, val): - self['hoveron'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - def hovertext(self): - """ - Sets hover text elements associated with each (a,b) point. If a - single string, the same string appears over all the data - points. If an array of strings, the items are mapped in order - to the the data points in (a,b). To be seen, trace `hoverinfo` - must contain a "text" flag. - - The 'hovertext' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - shape - Determines the line shape. With "spline" the - lines are drawn using spline interpolation. The - other available values correspond to step-wise - line shapes. - smoothing - Has an effect only if `shape` is set to - "spline" Sets the amount of smoothing. 0 - corresponds to no smoothing (equivalent to a - "linear" shape). - width - Sets the line width (in px). - - Returns - ------- - plotly.graph_objs.scattercarpet.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scattercarpet.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - gradient - plotly.graph_objs.scattercarpet.marker.Gradient - instance or dict with compatible properties - line - plotly.graph_objs.scattercarpet.marker.Line - instance or dict with compatible properties - maxdisplayed - Sets a maximum number of points to be drawn on - the graph. 0 corresponds to no limit. - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . - - Returns - ------- - plotly.graph_objs.scattercarpet.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # mode - # ---- - @property - def mode(self): - """ - Determines the drawing mode for this scatter trace. If the - provided `mode` includes "text" then the `text` elements appear - at the coordinates. Otherwise, the `text` elements appear on - hover. If there are less than 20 points and the trace is not - stacked then the default is "lines+markers". Otherwise, - "lines". - - The 'mode' property is a flaglist and may be specified - as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters - (e.g. 'lines+markers') - OR exactly one of ['none'] (e.g. 'none') - - Returns - ------- - Any - """ - return self['mode'] - - @mode.setter - def mode(self, val): - self['mode'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # selected - # -------- - @property - def selected(self): - """ - The 'selected' property is an instance of Selected - that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.Selected - - A dict of string/value properties that will be passed - to the Selected constructor - - Supported dict properties: - - marker - plotly.graph_objs.scattercarpet.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scattercarpet.selected.Textfo - nt instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.scattercarpet.Selected - """ - return self['selected'] - - @selected.setter - def selected(self, val): - self['selected'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.scattercarpet.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - def text(self): - """ - Sets text elements associated with each (a,b) point. If a - single string, the same string appears over all the data - points. If an array of strings, the items are mapped in order - to the the data points in (a,b). If trace `hoverinfo` contains - a "text" flag and "hovertext" is not set, these elements will - be seen in the hover labels. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - Sets the text font. - - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scattercarpet.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # textposition - # ------------ - @property - 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', - 'middle center', 'middle right', 'bottom left', 'bottom - center', 'bottom right'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['textposition'] - - @textposition.setter - def textposition(self, val): - self['textposition'] = val - - # textpositionsrc - # --------------- - @property - def textpositionsrc(self): - """ - Sets the source reference on plot.ly for textposition . - - The 'textpositionsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textpositionsrc'] - - @textpositionsrc.setter - def textpositionsrc(self, val): - self['textpositionsrc'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # unselected - # ---------- - @property - def unselected(self): - """ - The 'unselected' property is an instance of Unselected - that may be specified as: - - An instance of plotly.graph_objs.scattercarpet.Unselected - - A dict of string/value properties that will be passed - to the Unselected constructor - - Supported dict properties: - - marker - plotly.graph_objs.scattercarpet.unselected.Mark - er instance or dict with compatible properties - textfont - plotly.graph_objs.scattercarpet.unselected.Text - font instance or dict with compatible - properties - - Returns - ------- - plotly.graph_objs.scattercarpet.Unselected - """ - return self['unselected'] - - @unselected.setter - def unselected(self, val): - self['unselected'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - a - Sets the a-axis coordinates. - asrc - Sets the source reference on plot.ly for a . - b - Sets the b-axis coordinates. - bsrc - Sets the source reference on plot.ly for b . - carpet - An identifier for this carpet, so that `scattercarpet` - and `scattercontour` traces can specify a carpet plot - on which they lie - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - fill - Sets the area to fill with a solid color. Use with - `fillcolor` if not "none". scatterternary has a subset - of the options available to scatter. "toself" connects - the endpoints of the trace (or each segment of the - trace if it has gaps) into a closed shape. "tonext" - fills the space between two traces if one completely - encloses the other (eg consecutive contour lines), and - behaves like "toself" if there is no trace before it. - "tonext" should not be used if one trace does not - enclose the other. - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scattercarpet.Hoverlabel instance or - dict with compatible properties - hoveron - Do the hover effects highlight individual points - (markers or line points) or do they highlight filled - regions? If the fill is "toself" or "tonext" and there - are no markers or text, then the default is "fills", - otherwise it is "points". - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (a,b) - point. If a single string, the same string appears over - all the data points. If an array of strings, the items - are mapped in order to the the data points in (a,b). To - be seen, trace `hoverinfo` must contain a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scattercarpet.Line instance or dict - with compatible properties - marker - plotly.graph_objs.scattercarpet.Marker instance or dict - with compatible properties - mode - Determines the drawing mode for this scatter trace. If - the provided `mode` includes "text" then the `text` - elements appear at the coordinates. Otherwise, the - `text` elements appear on hover. If there are less than - 20 points and the trace is not stacked then the default - is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.scattercarpet.Selected instance or - dict with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.scattercarpet.Stream instance or dict - with compatible properties - text - Sets text elements associated with each (a,b) point. If - a single string, the same string appears over all the - data points. If an array of strings, the items are - mapped in order to the the data points in (a,b). If - trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.scattercarpet.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - """ - - def __init__( - self, - arg=None, - a=None, - asrc=None, - b=None, - bsrc=None, - carpet=None, - connectgaps=None, - customdata=None, - customdatasrc=None, - fill=None, - fillcolor=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hoveron=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - legendgroup=None, - line=None, - marker=None, - mode=None, - name=None, - opacity=None, - selected=None, - selectedpoints=None, - showlegend=None, - stream=None, - text=None, - textfont=None, - textposition=None, - textpositionsrc=None, - textsrc=None, - uid=None, - uirevision=None, - unselected=None, - visible=None, - xaxis=None, - yaxis=None, - **kwargs - ): - """ - Construct a new Scattercarpet object - - Plots a scatter trace on either the first carpet axis or the - carpet axis with a matching `carpet` attribute. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scattercarpet - a - Sets the a-axis coordinates. - asrc - Sets the source reference on plot.ly for a . - b - Sets the b-axis coordinates. - bsrc - Sets the source reference on plot.ly for b . - carpet - An identifier for this carpet, so that `scattercarpet` - and `scattercontour` traces can specify a carpet plot - on which they lie - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - fill - Sets the area to fill with a solid color. Use with - `fillcolor` if not "none". scatterternary has a subset - of the options available to scatter. "toself" connects - the endpoints of the trace (or each segment of the - trace if it has gaps) into a closed shape. "tonext" - fills the space between two traces if one completely - encloses the other (eg consecutive contour lines), and - behaves like "toself" if there is no trace before it. - "tonext" should not be used if one trace does not - enclose the other. - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scattercarpet.Hoverlabel instance or - dict with compatible properties - hoveron - Do the hover effects highlight individual points - (markers or line points) or do they highlight filled - regions? If the fill is "toself" or "tonext" and there - are no markers or text, then the default is "fills", - otherwise it is "points". - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (a,b) - point. If a single string, the same string appears over - all the data points. If an array of strings, the items - are mapped in order to the the data points in (a,b). To - be seen, trace `hoverinfo` must contain a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scattercarpet.Line instance or dict - with compatible properties - marker - plotly.graph_objs.scattercarpet.Marker instance or dict - with compatible properties - mode - Determines the drawing mode for this scatter trace. If - the provided `mode` includes "text" then the `text` - elements appear at the coordinates. Otherwise, the - `text` elements appear on hover. If there are less than - 20 points and the trace is not stacked then the default - is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.scattercarpet.Selected instance or - dict with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.scattercarpet.Stream instance or dict - with compatible properties - text - Sets text elements associated with each (a,b) point. If - a single string, the same string appears over all the - data points. If an array of strings, the items are - mapped in order to the the data points in (a,b). If - trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.scattercarpet.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - - Returns - ------- - Scattercarpet - """ - super(Scattercarpet, self).__init__('scattercarpet') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Scattercarpet -constructor must be a dict or -an instance of plotly.graph_objs.Scattercarpet""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (scattercarpet as v_scattercarpet) - - # Initialize validators - # --------------------- - self._validators['a'] = v_scattercarpet.AValidator() - self._validators['asrc'] = v_scattercarpet.AsrcValidator() - self._validators['b'] = v_scattercarpet.BValidator() - self._validators['bsrc'] = v_scattercarpet.BsrcValidator() - self._validators['carpet'] = v_scattercarpet.CarpetValidator() - self._validators['connectgaps'] = v_scattercarpet.ConnectgapsValidator( - ) - self._validators['customdata'] = v_scattercarpet.CustomdataValidator() - self._validators['customdatasrc' - ] = v_scattercarpet.CustomdatasrcValidator() - self._validators['fill'] = v_scattercarpet.FillValidator() - self._validators['fillcolor'] = v_scattercarpet.FillcolorValidator() - self._validators['hoverinfo'] = v_scattercarpet.HoverinfoValidator() - self._validators['hoverinfosrc' - ] = v_scattercarpet.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_scattercarpet.HoverlabelValidator() - self._validators['hoveron'] = v_scattercarpet.HoveronValidator() - self._validators['hovertemplate' - ] = v_scattercarpet.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_scattercarpet.HovertemplatesrcValidator() - self._validators['hovertext'] = v_scattercarpet.HovertextValidator() - self._validators['hovertextsrc' - ] = v_scattercarpet.HovertextsrcValidator() - self._validators['ids'] = v_scattercarpet.IdsValidator() - self._validators['idssrc'] = v_scattercarpet.IdssrcValidator() - self._validators['legendgroup'] = v_scattercarpet.LegendgroupValidator( - ) - self._validators['line'] = v_scattercarpet.LineValidator() - self._validators['marker'] = v_scattercarpet.MarkerValidator() - self._validators['mode'] = v_scattercarpet.ModeValidator() - self._validators['name'] = v_scattercarpet.NameValidator() - self._validators['opacity'] = v_scattercarpet.OpacityValidator() - self._validators['selected'] = v_scattercarpet.SelectedValidator() - self._validators['selectedpoints' - ] = v_scattercarpet.SelectedpointsValidator() - self._validators['showlegend'] = v_scattercarpet.ShowlegendValidator() - self._validators['stream'] = v_scattercarpet.StreamValidator() - self._validators['text'] = v_scattercarpet.TextValidator() - self._validators['textfont'] = v_scattercarpet.TextfontValidator() - self._validators['textposition' - ] = v_scattercarpet.TextpositionValidator() - self._validators['textpositionsrc' - ] = v_scattercarpet.TextpositionsrcValidator() - self._validators['textsrc'] = v_scattercarpet.TextsrcValidator() - self._validators['uid'] = v_scattercarpet.UidValidator() - self._validators['uirevision'] = v_scattercarpet.UirevisionValidator() - self._validators['unselected'] = v_scattercarpet.UnselectedValidator() - self._validators['visible'] = v_scattercarpet.VisibleValidator() - self._validators['xaxis'] = v_scattercarpet.XAxisValidator() - self._validators['yaxis'] = v_scattercarpet.YAxisValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('a', None) - self['a'] = a if a is not None else _v - _v = arg.pop('asrc', None) - self['asrc'] = asrc if asrc is not None else _v - _v = arg.pop('b', None) - self['b'] = b if b is not None else _v - _v = arg.pop('bsrc', None) - self['bsrc'] = bsrc if bsrc is not None else _v - _v = arg.pop('carpet', None) - self['carpet'] = carpet if carpet is not None else _v - _v = arg.pop('connectgaps', None) - self['connectgaps'] = connectgaps if connectgaps is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('fillcolor', None) - self['fillcolor'] = fillcolor if fillcolor is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hoveron', None) - self['hoveron'] = hoveron if hoveron is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('mode', None) - self['mode'] = mode if mode is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('selected', None) - self['selected'] = selected if selected is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - _v = arg.pop('textposition', None) - self['textposition'] = textposition if textposition is not None else _v - _v = arg.pop('textpositionsrc', None) - self['textpositionsrc' - ] = textpositionsrc if textpositionsrc is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('unselected', None) - self['unselected'] = unselected if unselected is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'scattercarpet' - self._validators['type'] = LiteralValidator( - plotly_name='type', - parent_name='scattercarpet', - val='scattercarpet' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_scattergeo.py b/plotly/graph_objs/_scattergeo.py deleted file mode 100644 index 0c8d9def46f..00000000000 --- a/plotly/graph_objs/_scattergeo.py +++ /dev/null @@ -1,1804 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Scattergeo(BaseTraceType): - - # connectgaps - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['connectgaps'] - - @connectgaps.setter - def connectgaps(self, val): - self['connectgaps'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # fill - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # fillcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['fillcolor'] - - @fillcolor.setter - def fillcolor(self, val): - self['fillcolor'] = val - - # geo - # --- - @property - def geo(self): - """ - Sets a reference between this trace's geospatial coordinates - and a geographic map. If "geo" (the default value), the - geospatial coordinates refer to `layout.geo`. If "geo2", the - geospatial coordinates refer to `layout.geo2`, and so on. - - The 'geo' property is an identifier of a particular - subplot, of type 'geo', that may be specified as the string 'geo' - optionally followed by an integer >= 1 - (e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.) - - Returns - ------- - str - """ - return self['geo'] - - @geo.setter - def geo(self, val): - self['geo'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'lon+lat') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.scattergeo.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.scattergeo.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - def hovertext(self): - """ - Sets hover text elements associated with each (lon,lat) pair or - item in `locations`. If a single string, the same string - appears over all the data points. If an array of string, the - items are mapped in order to the this trace's (lon,lat) or - `locations` coordinates. To be seen, trace `hoverinfo` must - contain a "text" flag. - - The 'hovertext' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # lat - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['lat'] - - @lat.setter - def lat(self, val): - self['lat'] = val - - # latsrc - # ------ - @property - def latsrc(self): - """ - Sets the source reference on plot.ly for lat . - - The 'latsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['latsrc'] - - @latsrc.setter - def latsrc(self, val): - self['latsrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of plotly.graph_objs.scattergeo.Line - - A dict of string/value properties that will be passed - to the Line constructor - - Supported dict properties: - - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - width - Sets the line width (in px). - - Returns - ------- - plotly.graph_objs.scattergeo.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # locationmode - # ------------ - @property - def locationmode(self): - """ - Determines the set of locations used to match entries in - `locations` to regions on the map. - - The 'locationmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['ISO-3', 'USA-states', 'country names'] - - Returns - ------- - Any - """ - return self['locationmode'] - - @locationmode.setter - def locationmode(self, val): - self['locationmode'] = val - - # locations - # --------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['locations'] - - @locations.setter - def locations(self, val): - self['locations'] = val - - # locationssrc - # ------------ - @property - def locationssrc(self): - """ - Sets the source reference on plot.ly for locations . - - The 'locationssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['locationssrc'] - - @locationssrc.setter - def locationssrc(self, val): - self['locationssrc'] = val - - # lon - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['lon'] - - @lon.setter - def lon(self, val): - self['lon'] = val - - # lonsrc - # ------ - @property - def lonsrc(self): - """ - Sets the source reference on plot.ly for lon . - - The 'lonsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['lonsrc'] - - @lonsrc.setter - def lonsrc(self, val): - self['lonsrc'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scattergeo.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - gradient - plotly.graph_objs.scattergeo.marker.Gradient - instance or dict with compatible properties - line - plotly.graph_objs.scattergeo.marker.Line - instance or dict with compatible properties - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . - - Returns - ------- - plotly.graph_objs.scattergeo.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # mode - # ---- - @property - def mode(self): - """ - Determines the drawing mode for this scatter trace. If the - provided `mode` includes "text" then the `text` elements appear - at the coordinates. Otherwise, the `text` elements appear on - hover. If there are less than 20 points and the trace is not - stacked then the default is "lines+markers". Otherwise, - "lines". - - The 'mode' property is a flaglist and may be specified - as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters - (e.g. 'lines+markers') - OR exactly one of ['none'] (e.g. 'none') - - Returns - ------- - Any - """ - return self['mode'] - - @mode.setter - def mode(self, val): - self['mode'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # selected - # -------- - @property - def selected(self): - """ - The 'selected' property is an instance of Selected - that may be specified as: - - An instance of plotly.graph_objs.scattergeo.Selected - - A dict of string/value properties that will be passed - to the Selected constructor - - Supported dict properties: - - marker - plotly.graph_objs.scattergeo.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scattergeo.selected.Textfont - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.scattergeo.Selected - """ - return self['selected'] - - @selected.setter - def selected(self, val): - self['selected'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.scattergeo.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.scattergeo.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - def text(self): - """ - Sets text elements associated with each (lon,lat) pair or item - in `locations`. If a single string, the same string appears - over all the data points. If an array of string, the items are - mapped in order to the this trace's (lon,lat) or `locations` - coordinates. If trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in the - hover labels. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - Sets the text font. - - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scattergeo.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # textposition - # ------------ - @property - 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', - 'middle center', 'middle right', 'bottom left', 'bottom - center', 'bottom right'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['textposition'] - - @textposition.setter - def textposition(self, val): - self['textposition'] = val - - # textpositionsrc - # --------------- - @property - def textpositionsrc(self): - """ - Sets the source reference on plot.ly for textposition . - - The 'textpositionsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textpositionsrc'] - - @textpositionsrc.setter - def textpositionsrc(self, val): - self['textpositionsrc'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # unselected - # ---------- - @property - def unselected(self): - """ - The 'unselected' property is an instance of Unselected - that may be specified as: - - An instance of plotly.graph_objs.scattergeo.Unselected - - A dict of string/value properties that will be passed - to the Unselected constructor - - Supported dict properties: - - marker - plotly.graph_objs.scattergeo.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scattergeo.unselected.Textfon - t instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.scattergeo.Unselected - """ - return self['unselected'] - - @unselected.setter - def unselected(self, val): - self['unselected'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - fill - Sets the area to fill with a solid color. Use with - `fillcolor` if not "none". "toself" connects the - endpoints of the trace (or each segment of the trace if - it has gaps) into a closed shape. - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - geo - Sets a reference between this trace's geospatial - coordinates and a geographic map. If "geo" (the default - value), the geospatial coordinates refer to - `layout.geo`. If "geo2", the geospatial coordinates - refer to `layout.geo2`, and so on. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scattergeo.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (lon,lat) - pair or item in `locations`. If a single string, the - same string appears over all the data points. If an - array of string, the items are mapped in order to the - this trace's (lon,lat) or `locations` coordinates. To - be seen, trace `hoverinfo` must contain a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - lat - Sets the latitude coordinates (in degrees North). - latsrc - Sets the source reference on plot.ly for lat . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scattergeo.Line instance or dict with - compatible properties - locationmode - Determines the set of locations used to match entries - in `locations` to regions on the map. - locations - Sets the coordinates via location IDs or names. - Coordinates correspond to the centroid of each location - given. See `locationmode` for more info. - locationssrc - Sets the source reference on plot.ly for locations . - lon - Sets the longitude coordinates (in degrees East). - lonsrc - Sets the source reference on plot.ly for lon . - marker - plotly.graph_objs.scattergeo.Marker instance or dict - with compatible properties - mode - Determines the drawing mode for this scatter trace. If - the provided `mode` includes "text" then the `text` - elements appear at the coordinates. Otherwise, the - `text` elements appear on hover. If there are less than - 20 points and the trace is not stacked then the default - is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.scattergeo.Selected instance or dict - with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.scattergeo.Stream instance or dict - with compatible properties - text - Sets text elements associated with each (lon,lat) pair - or item in `locations`. If a single string, the same - string appears over all the data points. If an array of - string, the items are mapped in order to the this - trace's (lon,lat) or `locations` coordinates. If trace - `hoverinfo` contains a "text" flag and "hovertext" is - not set, these elements will be seen in the hover - labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.scattergeo.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - """ - - def __init__( - self, - arg=None, - connectgaps=None, - customdata=None, - customdatasrc=None, - fill=None, - fillcolor=None, - geo=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - lat=None, - latsrc=None, - legendgroup=None, - line=None, - locationmode=None, - locations=None, - locationssrc=None, - lon=None, - lonsrc=None, - marker=None, - mode=None, - name=None, - opacity=None, - selected=None, - selectedpoints=None, - showlegend=None, - stream=None, - text=None, - textfont=None, - textposition=None, - textpositionsrc=None, - textsrc=None, - uid=None, - uirevision=None, - unselected=None, - visible=None, - **kwargs - ): - """ - Construct a new Scattergeo object - - The data visualized as scatter point or lines on a geographic - map is provided either by longitude/latitude pairs in `lon` and - `lat` respectively or by geographic location IDs or names in - `locations`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scattergeo - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - fill - Sets the area to fill with a solid color. Use with - `fillcolor` if not "none". "toself" connects the - endpoints of the trace (or each segment of the trace if - it has gaps) into a closed shape. - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - geo - Sets a reference between this trace's geospatial - coordinates and a geographic map. If "geo" (the default - value), the geospatial coordinates refer to - `layout.geo`. If "geo2", the geospatial coordinates - refer to `layout.geo2`, and so on. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scattergeo.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (lon,lat) - pair or item in `locations`. If a single string, the - same string appears over all the data points. If an - array of string, the items are mapped in order to the - this trace's (lon,lat) or `locations` coordinates. To - be seen, trace `hoverinfo` must contain a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - lat - Sets the latitude coordinates (in degrees North). - latsrc - Sets the source reference on plot.ly for lat . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scattergeo.Line instance or dict with - compatible properties - locationmode - Determines the set of locations used to match entries - in `locations` to regions on the map. - locations - Sets the coordinates via location IDs or names. - Coordinates correspond to the centroid of each location - given. See `locationmode` for more info. - locationssrc - Sets the source reference on plot.ly for locations . - lon - Sets the longitude coordinates (in degrees East). - lonsrc - Sets the source reference on plot.ly for lon . - marker - plotly.graph_objs.scattergeo.Marker instance or dict - with compatible properties - mode - Determines the drawing mode for this scatter trace. If - the provided `mode` includes "text" then the `text` - elements appear at the coordinates. Otherwise, the - `text` elements appear on hover. If there are less than - 20 points and the trace is not stacked then the default - is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.scattergeo.Selected instance or dict - with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.scattergeo.Stream instance or dict - with compatible properties - text - Sets text elements associated with each (lon,lat) pair - or item in `locations`. If a single string, the same - string appears over all the data points. If an array of - string, the items are mapped in order to the this - trace's (lon,lat) or `locations` coordinates. If trace - `hoverinfo` contains a "text" flag and "hovertext" is - not set, these elements will be seen in the hover - labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.scattergeo.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - - Returns - ------- - Scattergeo - """ - super(Scattergeo, self).__init__('scattergeo') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Scattergeo -constructor must be a dict or -an instance of plotly.graph_objs.Scattergeo""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (scattergeo as v_scattergeo) - - # Initialize validators - # --------------------- - self._validators['connectgaps'] = v_scattergeo.ConnectgapsValidator() - self._validators['customdata'] = v_scattergeo.CustomdataValidator() - self._validators['customdatasrc' - ] = v_scattergeo.CustomdatasrcValidator() - self._validators['fill'] = v_scattergeo.FillValidator() - self._validators['fillcolor'] = v_scattergeo.FillcolorValidator() - self._validators['geo'] = v_scattergeo.GeoValidator() - self._validators['hoverinfo'] = v_scattergeo.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_scattergeo.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_scattergeo.HoverlabelValidator() - self._validators['hovertemplate' - ] = v_scattergeo.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_scattergeo.HovertemplatesrcValidator() - self._validators['hovertext'] = v_scattergeo.HovertextValidator() - self._validators['hovertextsrc'] = v_scattergeo.HovertextsrcValidator() - self._validators['ids'] = v_scattergeo.IdsValidator() - self._validators['idssrc'] = v_scattergeo.IdssrcValidator() - self._validators['lat'] = v_scattergeo.LatValidator() - self._validators['latsrc'] = v_scattergeo.LatsrcValidator() - self._validators['legendgroup'] = v_scattergeo.LegendgroupValidator() - self._validators['line'] = v_scattergeo.LineValidator() - self._validators['locationmode'] = v_scattergeo.LocationmodeValidator() - self._validators['locations'] = v_scattergeo.LocationsValidator() - self._validators['locationssrc'] = v_scattergeo.LocationssrcValidator() - self._validators['lon'] = v_scattergeo.LonValidator() - self._validators['lonsrc'] = v_scattergeo.LonsrcValidator() - self._validators['marker'] = v_scattergeo.MarkerValidator() - self._validators['mode'] = v_scattergeo.ModeValidator() - self._validators['name'] = v_scattergeo.NameValidator() - self._validators['opacity'] = v_scattergeo.OpacityValidator() - self._validators['selected'] = v_scattergeo.SelectedValidator() - self._validators['selectedpoints' - ] = v_scattergeo.SelectedpointsValidator() - self._validators['showlegend'] = v_scattergeo.ShowlegendValidator() - self._validators['stream'] = v_scattergeo.StreamValidator() - self._validators['text'] = v_scattergeo.TextValidator() - self._validators['textfont'] = v_scattergeo.TextfontValidator() - self._validators['textposition'] = v_scattergeo.TextpositionValidator() - self._validators['textpositionsrc' - ] = v_scattergeo.TextpositionsrcValidator() - self._validators['textsrc'] = v_scattergeo.TextsrcValidator() - self._validators['uid'] = v_scattergeo.UidValidator() - self._validators['uirevision'] = v_scattergeo.UirevisionValidator() - self._validators['unselected'] = v_scattergeo.UnselectedValidator() - self._validators['visible'] = v_scattergeo.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('connectgaps', None) - self['connectgaps'] = connectgaps if connectgaps is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('fillcolor', None) - self['fillcolor'] = fillcolor if fillcolor is not None else _v - _v = arg.pop('geo', None) - self['geo'] = geo if geo is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('lat', None) - self['lat'] = lat if lat is not None else _v - _v = arg.pop('latsrc', None) - self['latsrc'] = latsrc if latsrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('locationmode', None) - self['locationmode'] = locationmode if locationmode is not None else _v - _v = arg.pop('locations', None) - self['locations'] = locations if locations is not None else _v - _v = arg.pop('locationssrc', None) - self['locationssrc'] = locationssrc if locationssrc is not None else _v - _v = arg.pop('lon', None) - self['lon'] = lon if lon is not None else _v - _v = arg.pop('lonsrc', None) - self['lonsrc'] = lonsrc if lonsrc is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('mode', None) - self['mode'] = mode if mode is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('selected', None) - self['selected'] = selected if selected is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - _v = arg.pop('textposition', None) - self['textposition'] = textposition if textposition is not None else _v - _v = arg.pop('textpositionsrc', None) - self['textpositionsrc' - ] = textpositionsrc if textpositionsrc is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('unselected', None) - self['unselected'] = unselected if unselected is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'scattergeo' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='scattergeo', val='scattergeo' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_scattergl.py b/plotly/graph_objs/_scattergl.py deleted file mode 100644 index 8eb2bb126f5..00000000000 --- a/plotly/graph_objs/_scattergl.py +++ /dev/null @@ -1,2144 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Scattergl(BaseTraceType): - - # connectgaps - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['connectgaps'] - - @connectgaps.setter - def connectgaps(self, val): - self['connectgaps'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # dx - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['dx'] - - @dx.setter - def dx(self, val): - self['dx'] = val - - # dy - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['dy'] - - @dy.setter - def dy(self, val): - self['dy'] = val - - # error_x - # ------- - @property - def error_x(self): - """ - The 'error_x' property is an instance of ErrorX - that may be specified as: - - An instance of plotly.graph_objs.scattergl.ErrorX - - A dict of string/value properties that will be passed - to the ErrorX constructor - - Supported dict properties: - - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - copy_ystyle - - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. - - Returns - ------- - plotly.graph_objs.scattergl.ErrorX - """ - return self['error_x'] - - @error_x.setter - def error_x(self, val): - self['error_x'] = val - - # error_y - # ------- - @property - def error_y(self): - """ - The 'error_y' property is an instance of ErrorY - that may be specified as: - - An instance of plotly.graph_objs.scattergl.ErrorY - - A dict of string/value properties that will be passed - to the ErrorY constructor - - Supported dict properties: - - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. - - Returns - ------- - plotly.graph_objs.scattergl.ErrorY - """ - return self['error_y'] - - @error_y.setter - def error_y(self, val): - self['error_y'] = val - - # fill - # ---- - @property - def fill(self): - """ - Sets the area to fill with a solid color. Defaults to "none" - unless this trace is stacked, then it gets "tonexty" - ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` - if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 - respectively. "tonextx" and "tonexty" fill between the - endpoints of this trace and the endpoints of the trace before - it, connecting those endpoints with straight lines (to make a - stacked area graph); if there is no trace before it, they - behave like "tozerox" and "tozeroy". "toself" connects the - endpoints of the trace (or each segment of the trace if it has - gaps) into a closed shape. "tonext" fills the space between two - traces if one completely encloses the other (eg consecutive - contour lines), and behaves like "toself" if there is no trace - before it. "tonext" should not be used if one trace does not - enclose the other. Traces in a `stackgroup` will only fill to - (or be filled to) other traces in the same group. With multiple - `stackgroup`s or some traces stacked and some not, if fill- - linked traces are not already consecutive, the later ones will - be pushed down in the drawing order. - - The 'fill' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', - 'toself', 'tonext'] - - Returns - ------- - Any - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # fillcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['fillcolor'] - - @fillcolor.setter - def fillcolor(self, val): - self['fillcolor'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.scattergl.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.scattergl.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - def hovertext(self): - """ - Sets hover text elements associated with each (x,y) pair. If a - single string, the same string appears over all the data - points. If an array of string, the items are mapped in order to - the this trace's (x,y) coordinates. To be seen, trace - `hoverinfo` must contain a "text" flag. - - The 'hovertext' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of plotly.graph_objs.scattergl.Line - - A dict of string/value properties that will be passed - to the Line constructor - - Supported dict properties: - - color - Sets the line color. - dash - Sets the style of the lines. - shape - Determines the line shape. The values - correspond to step-wise line shapes. - width - Sets the line width (in px). - - Returns - ------- - plotly.graph_objs.scattergl.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scattergl.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - line - plotly.graph_objs.scattergl.marker.Line - instance or dict with compatible properties - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . - - Returns - ------- - plotly.graph_objs.scattergl.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # mode - # ---- - @property - 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 - (e.g. 'lines+markers') - OR exactly one of ['none'] (e.g. 'none') - - Returns - ------- - Any - """ - return self['mode'] - - @mode.setter - def mode(self, val): - self['mode'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # selected - # -------- - @property - def selected(self): - """ - The 'selected' property is an instance of Selected - that may be specified as: - - An instance of plotly.graph_objs.scattergl.Selected - - A dict of string/value properties that will be passed - to the Selected constructor - - Supported dict properties: - - marker - plotly.graph_objs.scattergl.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scattergl.selected.Textfont - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.scattergl.Selected - """ - return self['selected'] - - @selected.setter - def selected(self, val): - self['selected'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.scattergl.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.scattergl.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - def text(self): - """ - Sets text elements associated with each (x,y) pair. If a single - string, the same string appears over all the data points. If an - array of string, the items are mapped in order to the this - trace's (x,y) coordinates. If trace `hoverinfo` contains a - "text" flag and "hovertext" is not set, these elements will be - seen in the hover labels. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - Sets the text font. - - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scattergl.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # textposition - # ------------ - @property - 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', - 'middle center', 'middle right', 'bottom left', 'bottom - center', 'bottom right'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['textposition'] - - @textposition.setter - def textposition(self, val): - self['textposition'] = val - - # textpositionsrc - # --------------- - @property - def textpositionsrc(self): - """ - Sets the source reference on plot.ly for textposition . - - The 'textpositionsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textpositionsrc'] - - @textpositionsrc.setter - def textpositionsrc(self, val): - self['textpositionsrc'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # unselected - # ---------- - @property - def unselected(self): - """ - The 'unselected' property is an instance of Unselected - that may be specified as: - - An instance of plotly.graph_objs.scattergl.Unselected - - A dict of string/value properties that will be passed - to the Unselected constructor - - Supported dict properties: - - marker - plotly.graph_objs.scattergl.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scattergl.unselected.Textfont - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.scattergl.Unselected - """ - return self['unselected'] - - @unselected.setter - def unselected(self, val): - self['unselected'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # x0 - # -- - @property - 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 - ------- - Any - """ - return self['x0'] - - @x0.setter - def x0(self, val): - self['x0'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # xcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['xcalendar'] - - @xcalendar.setter - def xcalendar(self, val): - self['xcalendar'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # y0 - # -- - @property - 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 - ------- - Any - """ - return self['y0'] - - @y0.setter - def y0(self, val): - self['y0'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # ycalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['ycalendar'] - - @ycalendar.setter - def ycalendar(self, val): - self['ycalendar'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dx - Sets the x coordinate step. See `x0` for more info. - dy - Sets the y coordinate step. See `y0` for more info. - error_x - plotly.graph_objs.scattergl.ErrorX instance or dict - with compatible properties - error_y - plotly.graph_objs.scattergl.ErrorY instance or dict - with compatible properties - fill - Sets the area to fill with a solid color. Defaults to - "none" unless this trace is stacked, then it gets - "tonexty" ("tonextx") if `orientation` is "v" ("h") Use - with `fillcolor` if not "none". "tozerox" and "tozeroy" - fill to x=0 and y=0 respectively. "tonextx" and - "tonexty" fill between the endpoints of this trace and - the endpoints of the trace before it, connecting those - endpoints with straight lines (to make a stacked area - graph); if there is no trace before it, they behave - like "tozerox" and "tozeroy". "toself" connects the - endpoints of the trace (or each segment of the trace if - it has gaps) into a closed shape. "tonext" fills the - space between two traces if one completely encloses the - other (eg consecutive contour lines), and behaves like - "toself" if there is no trace before it. "tonext" - should not be used if one trace does not enclose the - other. Traces in a `stackgroup` will only fill to (or - be filled to) other traces in the same group. With - multiple `stackgroup`s or some traces stacked and some - not, if fill-linked traces are not already consecutive, - the later ones will be pushed down in the drawing - order. - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scattergl.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (x,y) - pair. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to the this trace's (x,y) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scattergl.Line instance or dict with - compatible properties - marker - plotly.graph_objs.scattergl.Marker instance or dict - with compatible properties - mode - Determines the drawing mode for this scatter trace. - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.scattergl.Selected instance or dict - with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.scattergl.Stream instance or dict - with compatible properties - text - Sets text elements associated with each (x,y) pair. If - a single string, the same string appears over all the - data points. If an array of string, the items are - mapped in order to the this trace's (x,y) coordinates. - If trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.scattergl.Unselected instance or dict - with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the starting - coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the starting - coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - """ - - def __init__( - self, - arg=None, - connectgaps=None, - customdata=None, - customdatasrc=None, - dx=None, - dy=None, - error_x=None, - error_y=None, - fill=None, - fillcolor=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - legendgroup=None, - line=None, - marker=None, - mode=None, - name=None, - opacity=None, - selected=None, - selectedpoints=None, - showlegend=None, - stream=None, - text=None, - textfont=None, - textposition=None, - textpositionsrc=None, - textsrc=None, - uid=None, - uirevision=None, - unselected=None, - visible=None, - x=None, - x0=None, - xaxis=None, - xcalendar=None, - xsrc=None, - y=None, - y0=None, - yaxis=None, - ycalendar=None, - ysrc=None, - **kwargs - ): - """ - Construct a new Scattergl object - - The data visualized as scatter point or lines is set in `x` and - `y` using the WebGL plotting engine. Bubble charts are achieved - by setting `marker.size` and/or `marker.color` to a numerical - arrays. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scattergl - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dx - Sets the x coordinate step. See `x0` for more info. - dy - Sets the y coordinate step. See `y0` for more info. - error_x - plotly.graph_objs.scattergl.ErrorX instance or dict - with compatible properties - error_y - plotly.graph_objs.scattergl.ErrorY instance or dict - with compatible properties - fill - Sets the area to fill with a solid color. Defaults to - "none" unless this trace is stacked, then it gets - "tonexty" ("tonextx") if `orientation` is "v" ("h") Use - with `fillcolor` if not "none". "tozerox" and "tozeroy" - fill to x=0 and y=0 respectively. "tonextx" and - "tonexty" fill between the endpoints of this trace and - the endpoints of the trace before it, connecting those - endpoints with straight lines (to make a stacked area - graph); if there is no trace before it, they behave - like "tozerox" and "tozeroy". "toself" connects the - endpoints of the trace (or each segment of the trace if - it has gaps) into a closed shape. "tonext" fills the - space between two traces if one completely encloses the - other (eg consecutive contour lines), and behaves like - "toself" if there is no trace before it. "tonext" - should not be used if one trace does not enclose the - other. Traces in a `stackgroup` will only fill to (or - be filled to) other traces in the same group. With - multiple `stackgroup`s or some traces stacked and some - not, if fill-linked traces are not already consecutive, - the later ones will be pushed down in the drawing - order. - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scattergl.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (x,y) - pair. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to the this trace's (x,y) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scattergl.Line instance or dict with - compatible properties - marker - plotly.graph_objs.scattergl.Marker instance or dict - with compatible properties - mode - Determines the drawing mode for this scatter trace. - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.scattergl.Selected instance or dict - with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.scattergl.Stream instance or dict - with compatible properties - text - Sets text elements associated with each (x,y) pair. If - a single string, the same string appears over all the - data points. If an array of string, the items are - mapped in order to the this trace's (x,y) coordinates. - If trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.scattergl.Unselected instance or dict - with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the starting - coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the starting - coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - - Returns - ------- - Scattergl - """ - super(Scattergl, self).__init__('scattergl') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Scattergl -constructor must be a dict or -an instance of plotly.graph_objs.Scattergl""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (scattergl as v_scattergl) - - # Initialize validators - # --------------------- - self._validators['connectgaps'] = v_scattergl.ConnectgapsValidator() - self._validators['customdata'] = v_scattergl.CustomdataValidator() - self._validators['customdatasrc'] = v_scattergl.CustomdatasrcValidator( - ) - self._validators['dx'] = v_scattergl.DxValidator() - self._validators['dy'] = v_scattergl.DyValidator() - self._validators['error_x'] = v_scattergl.ErrorXValidator() - self._validators['error_y'] = v_scattergl.ErrorYValidator() - self._validators['fill'] = v_scattergl.FillValidator() - self._validators['fillcolor'] = v_scattergl.FillcolorValidator() - self._validators['hoverinfo'] = v_scattergl.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_scattergl.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_scattergl.HoverlabelValidator() - self._validators['hovertemplate'] = v_scattergl.HovertemplateValidator( - ) - self._validators['hovertemplatesrc' - ] = v_scattergl.HovertemplatesrcValidator() - self._validators['hovertext'] = v_scattergl.HovertextValidator() - self._validators['hovertextsrc'] = v_scattergl.HovertextsrcValidator() - self._validators['ids'] = v_scattergl.IdsValidator() - self._validators['idssrc'] = v_scattergl.IdssrcValidator() - self._validators['legendgroup'] = v_scattergl.LegendgroupValidator() - self._validators['line'] = v_scattergl.LineValidator() - self._validators['marker'] = v_scattergl.MarkerValidator() - self._validators['mode'] = v_scattergl.ModeValidator() - self._validators['name'] = v_scattergl.NameValidator() - self._validators['opacity'] = v_scattergl.OpacityValidator() - self._validators['selected'] = v_scattergl.SelectedValidator() - self._validators['selectedpoints' - ] = v_scattergl.SelectedpointsValidator() - self._validators['showlegend'] = v_scattergl.ShowlegendValidator() - self._validators['stream'] = v_scattergl.StreamValidator() - self._validators['text'] = v_scattergl.TextValidator() - self._validators['textfont'] = v_scattergl.TextfontValidator() - self._validators['textposition'] = v_scattergl.TextpositionValidator() - self._validators['textpositionsrc' - ] = v_scattergl.TextpositionsrcValidator() - self._validators['textsrc'] = v_scattergl.TextsrcValidator() - self._validators['uid'] = v_scattergl.UidValidator() - self._validators['uirevision'] = v_scattergl.UirevisionValidator() - self._validators['unselected'] = v_scattergl.UnselectedValidator() - self._validators['visible'] = v_scattergl.VisibleValidator() - self._validators['x'] = v_scattergl.XValidator() - self._validators['x0'] = v_scattergl.X0Validator() - self._validators['xaxis'] = v_scattergl.XAxisValidator() - self._validators['xcalendar'] = v_scattergl.XcalendarValidator() - self._validators['xsrc'] = v_scattergl.XsrcValidator() - self._validators['y'] = v_scattergl.YValidator() - self._validators['y0'] = v_scattergl.Y0Validator() - self._validators['yaxis'] = v_scattergl.YAxisValidator() - self._validators['ycalendar'] = v_scattergl.YcalendarValidator() - self._validators['ysrc'] = v_scattergl.YsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('connectgaps', None) - self['connectgaps'] = connectgaps if connectgaps is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('dx', None) - self['dx'] = dx if dx is not None else _v - _v = arg.pop('dy', None) - self['dy'] = dy if dy is not None else _v - _v = arg.pop('error_x', None) - self['error_x'] = error_x if error_x is not None else _v - _v = arg.pop('error_y', None) - self['error_y'] = error_y if error_y is not None else _v - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('fillcolor', None) - self['fillcolor'] = fillcolor if fillcolor is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('mode', None) - self['mode'] = mode if mode is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('selected', None) - self['selected'] = selected if selected is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - _v = arg.pop('textposition', None) - self['textposition'] = textposition if textposition is not None else _v - _v = arg.pop('textpositionsrc', None) - self['textpositionsrc' - ] = textpositionsrc if textpositionsrc is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('unselected', None) - self['unselected'] = unselected if unselected is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('x0', None) - self['x0'] = x0 if x0 is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('xcalendar', None) - self['xcalendar'] = xcalendar if xcalendar is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('y0', None) - self['y0'] = y0 if y0 is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - _v = arg.pop('ycalendar', None) - self['ycalendar'] = ycalendar if ycalendar is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'scattergl' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='scattergl', val='scattergl' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_scattermapbox.py b/plotly/graph_objs/_scattermapbox.py deleted file mode 100644 index 2a3ddb49a8f..00000000000 --- a/plotly/graph_objs/_scattermapbox.py +++ /dev/null @@ -1,1648 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Scattermapbox(BaseTraceType): - - # connectgaps - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['connectgaps'] - - @connectgaps.setter - def connectgaps(self, val): - self['connectgaps'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # fill - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # fillcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['fillcolor'] - - @fillcolor.setter - def fillcolor(self, val): - self['fillcolor'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'lon+lat') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.scattermapbox.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - def hovertext(self): - """ - Sets hover text elements associated with each (lon,lat) pair If - a single string, the same string appears over all the data - points. If an array of string, the items are mapped in order to - the this trace's (lon,lat) coordinates. To be seen, trace - `hoverinfo` must contain a "text" flag. - - The 'hovertext' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # lat - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['lat'] - - @lat.setter - def lat(self, val): - self['lat'] = val - - # latsrc - # ------ - @property - def latsrc(self): - """ - Sets the source reference on plot.ly for lat . - - The 'latsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['latsrc'] - - @latsrc.setter - def latsrc(self, val): - self['latsrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.Line - - A dict of string/value properties that will be passed - to the Line constructor - - Supported dict properties: - - color - Sets the line color. - width - Sets the line width (in px). - - Returns - ------- - plotly.graph_objs.scattermapbox.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # lon - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['lon'] - - @lon.setter - def lon(self, val): - self['lon'] = val - - # lonsrc - # ------ - @property - def lonsrc(self): - """ - Sets the source reference on plot.ly for lon . - - The 'lonsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['lonsrc'] - - @lonsrc.setter - def lonsrc(self, val): - self['lonsrc'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.Marker - - A dict of string/value properties that will be passed - to the Marker constructor - - Supported dict properties: - - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scattermapbox.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol. Full list: - https://www.mapbox.com/maki-icons/ Note that - the array `marker.color` and `marker.size` are - only available for "circle" symbols. - symbolsrc - Sets the source reference on plot.ly for - symbol . - - Returns - ------- - plotly.graph_objs.scattermapbox.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # mode - # ---- - @property - def mode(self): - """ - Determines the drawing mode for this scatter trace. If the - provided `mode` includes "text" then the `text` elements appear - at the coordinates. Otherwise, the `text` elements appear on - hover. - - The 'mode' property is a flaglist and may be specified - as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters - (e.g. 'lines+markers') - OR exactly one of ['none'] (e.g. 'none') - - Returns - ------- - Any - """ - return self['mode'] - - @mode.setter - def mode(self, val): - self['mode'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # selected - # -------- - @property - def selected(self): - """ - The 'selected' property is an instance of Selected - that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.Selected - - A dict of string/value properties that will be passed - to the Selected constructor - - Supported dict properties: - - marker - plotly.graph_objs.scattermapbox.selected.Marker - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.scattermapbox.Selected - """ - return self['selected'] - - @selected.setter - def selected(self, val): - self['selected'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.scattermapbox.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # subplot - # ------- - @property - def subplot(self): - """ - Sets a reference between this trace's data coordinates and a - mapbox subplot. If "mapbox" (the default value), the data refer - to `layout.mapbox`. If "mapbox2", the data refer to - `layout.mapbox2`, and so on. - - The 'subplot' property is an identifier of a particular - subplot, of type 'mapbox', that may be specified as the string 'mapbox' - optionally followed by an integer >= 1 - (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.) - - Returns - ------- - str - """ - return self['subplot'] - - @subplot.setter - def subplot(self, val): - self['subplot'] = val - - # text - # ---- - @property - def text(self): - """ - Sets text elements associated with each (lon,lat) pair If a - single string, the same string appears over all the data - points. If an array of string, the items are mapped in order to - the this trace's (lon,lat) coordinates. If trace `hoverinfo` - contains a "text" flag and "hovertext" is not set, these - elements will be seen in the hover labels. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textfont - # -------- - @property - 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 plotly.graph_objs.scattermapbox.Textfont - - A dict of string/value properties that will be passed - to the Textfont constructor - - Supported dict properties: - - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scattermapbox.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # textposition - # ------------ - @property - 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', - 'middle center', 'middle right', 'bottom left', 'bottom - center', 'bottom right'] - - Returns - ------- - Any - """ - return self['textposition'] - - @textposition.setter - def textposition(self, val): - self['textposition'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # unselected - # ---------- - @property - def unselected(self): - """ - The 'unselected' property is an instance of Unselected - that may be specified as: - - An instance of plotly.graph_objs.scattermapbox.Unselected - - A dict of string/value properties that will be passed - to the Unselected constructor - - Supported dict properties: - - marker - plotly.graph_objs.scattermapbox.unselected.Mark - er instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.scattermapbox.Unselected - """ - return self['unselected'] - - @unselected.setter - def unselected(self, val): - self['unselected'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - fill - Sets the area to fill with a solid color. Use with - `fillcolor` if not "none". "toself" connects the - endpoints of the trace (or each segment of the trace if - it has gaps) into a closed shape. - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scattermapbox.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (lon,lat) - pair If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to the this trace's (lon,lat) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - lat - Sets the latitude coordinates (in degrees North). - latsrc - Sets the source reference on plot.ly for lat . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scattermapbox.Line instance or dict - with compatible properties - lon - Sets the longitude coordinates (in degrees East). - lonsrc - Sets the source reference on plot.ly for lon . - marker - plotly.graph_objs.scattermapbox.Marker instance or dict - with compatible properties - mode - Determines the drawing mode for this scatter trace. If - the provided `mode` includes "text" then the `text` - elements appear at the coordinates. Otherwise, the - `text` elements appear on hover. - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.scattermapbox.Selected instance or - dict with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.scattermapbox.Stream instance or dict - with compatible properties - subplot - Sets a reference between this trace's data coordinates - and a mapbox subplot. If "mapbox" (the default value), - the data refer to `layout.mapbox`. If "mapbox2", the - data refer to `layout.mapbox2`, and so on. - text - Sets text elements associated with each (lon,lat) pair - If a single string, the same string appears over all - the data points. If an array of string, the items are - mapped in order to the this trace's (lon,lat) - coordinates. If trace `hoverinfo` contains a "text" - flag and "hovertext" is not set, these elements will be - seen in the hover labels. - textfont - Sets the icon text font (color=mapbox.layer.paint.text- - color, size=mapbox.layer.layout.text-size). Has an - effect only when `type` is set to "symbol". - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.scattermapbox.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - """ - - def __init__( - self, - arg=None, - connectgaps=None, - customdata=None, - customdatasrc=None, - fill=None, - fillcolor=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - lat=None, - latsrc=None, - legendgroup=None, - line=None, - lon=None, - lonsrc=None, - marker=None, - mode=None, - name=None, - opacity=None, - selected=None, - selectedpoints=None, - showlegend=None, - stream=None, - subplot=None, - text=None, - textfont=None, - textposition=None, - textsrc=None, - uid=None, - uirevision=None, - unselected=None, - visible=None, - **kwargs - ): - """ - 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`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scattermapbox - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - fill - Sets the area to fill with a solid color. Use with - `fillcolor` if not "none". "toself" connects the - endpoints of the trace (or each segment of the trace if - it has gaps) into a closed shape. - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scattermapbox.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (lon,lat) - pair If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to the this trace's (lon,lat) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - lat - Sets the latitude coordinates (in degrees North). - latsrc - Sets the source reference on plot.ly for lat . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scattermapbox.Line instance or dict - with compatible properties - lon - Sets the longitude coordinates (in degrees East). - lonsrc - Sets the source reference on plot.ly for lon . - marker - plotly.graph_objs.scattermapbox.Marker instance or dict - with compatible properties - mode - Determines the drawing mode for this scatter trace. If - the provided `mode` includes "text" then the `text` - elements appear at the coordinates. Otherwise, the - `text` elements appear on hover. - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.scattermapbox.Selected instance or - dict with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.scattermapbox.Stream instance or dict - with compatible properties - subplot - Sets a reference between this trace's data coordinates - and a mapbox subplot. If "mapbox" (the default value), - the data refer to `layout.mapbox`. If "mapbox2", the - data refer to `layout.mapbox2`, and so on. - text - Sets text elements associated with each (lon,lat) pair - If a single string, the same string appears over all - the data points. If an array of string, the items are - mapped in order to the this trace's (lon,lat) - coordinates. If trace `hoverinfo` contains a "text" - flag and "hovertext" is not set, these elements will be - seen in the hover labels. - textfont - Sets the icon text font (color=mapbox.layer.paint.text- - color, size=mapbox.layer.layout.text-size). Has an - effect only when `type` is set to "symbol". - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.scattermapbox.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - - Returns - ------- - Scattermapbox - """ - super(Scattermapbox, self).__init__('scattermapbox') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Scattermapbox -constructor must be a dict or -an instance of plotly.graph_objs.Scattermapbox""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (scattermapbox as v_scattermapbox) - - # Initialize validators - # --------------------- - self._validators['connectgaps'] = v_scattermapbox.ConnectgapsValidator( - ) - self._validators['customdata'] = v_scattermapbox.CustomdataValidator() - self._validators['customdatasrc' - ] = v_scattermapbox.CustomdatasrcValidator() - self._validators['fill'] = v_scattermapbox.FillValidator() - self._validators['fillcolor'] = v_scattermapbox.FillcolorValidator() - self._validators['hoverinfo'] = v_scattermapbox.HoverinfoValidator() - self._validators['hoverinfosrc' - ] = v_scattermapbox.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_scattermapbox.HoverlabelValidator() - self._validators['hovertemplate' - ] = v_scattermapbox.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_scattermapbox.HovertemplatesrcValidator() - self._validators['hovertext'] = v_scattermapbox.HovertextValidator() - self._validators['hovertextsrc' - ] = v_scattermapbox.HovertextsrcValidator() - self._validators['ids'] = v_scattermapbox.IdsValidator() - self._validators['idssrc'] = v_scattermapbox.IdssrcValidator() - self._validators['lat'] = v_scattermapbox.LatValidator() - self._validators['latsrc'] = v_scattermapbox.LatsrcValidator() - self._validators['legendgroup'] = v_scattermapbox.LegendgroupValidator( - ) - self._validators['line'] = v_scattermapbox.LineValidator() - self._validators['lon'] = v_scattermapbox.LonValidator() - self._validators['lonsrc'] = v_scattermapbox.LonsrcValidator() - self._validators['marker'] = v_scattermapbox.MarkerValidator() - self._validators['mode'] = v_scattermapbox.ModeValidator() - self._validators['name'] = v_scattermapbox.NameValidator() - self._validators['opacity'] = v_scattermapbox.OpacityValidator() - self._validators['selected'] = v_scattermapbox.SelectedValidator() - self._validators['selectedpoints' - ] = v_scattermapbox.SelectedpointsValidator() - self._validators['showlegend'] = v_scattermapbox.ShowlegendValidator() - self._validators['stream'] = v_scattermapbox.StreamValidator() - self._validators['subplot'] = v_scattermapbox.SubplotValidator() - self._validators['text'] = v_scattermapbox.TextValidator() - self._validators['textfont'] = v_scattermapbox.TextfontValidator() - self._validators['textposition' - ] = v_scattermapbox.TextpositionValidator() - self._validators['textsrc'] = v_scattermapbox.TextsrcValidator() - self._validators['uid'] = v_scattermapbox.UidValidator() - self._validators['uirevision'] = v_scattermapbox.UirevisionValidator() - self._validators['unselected'] = v_scattermapbox.UnselectedValidator() - self._validators['visible'] = v_scattermapbox.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('connectgaps', None) - self['connectgaps'] = connectgaps if connectgaps is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('fillcolor', None) - self['fillcolor'] = fillcolor if fillcolor is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('lat', None) - self['lat'] = lat if lat is not None else _v - _v = arg.pop('latsrc', None) - self['latsrc'] = latsrc if latsrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('lon', None) - self['lon'] = lon if lon is not None else _v - _v = arg.pop('lonsrc', None) - self['lonsrc'] = lonsrc if lonsrc is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('mode', None) - self['mode'] = mode if mode is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('selected', None) - self['selected'] = selected if selected is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('subplot', None) - self['subplot'] = subplot if subplot is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - _v = arg.pop('textposition', None) - self['textposition'] = textposition if textposition is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('unselected', None) - self['unselected'] = unselected if unselected is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'scattermapbox' - self._validators['type'] = LiteralValidator( - plotly_name='type', - parent_name='scattermapbox', - val='scattermapbox' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_scatterpolar.py b/plotly/graph_objs/_scatterpolar.py deleted file mode 100644 index 444a80c39e0..00000000000 --- a/plotly/graph_objs/_scatterpolar.py +++ /dev/null @@ -1,1981 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Scatterpolar(BaseTraceType): - - # cliponaxis - # ---------- - @property - def cliponaxis(self): - """ - Determines whether or not markers and text nodes are clipped - about the subplot axes. To show markers and text nodes above - axis lines and tick labels, make sure to set `xaxis.layer` and - `yaxis.layer` to *below traces*. - - The 'cliponaxis' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cliponaxis'] - - @cliponaxis.setter - def cliponaxis(self, val): - self['cliponaxis'] = val - - # connectgaps - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['connectgaps'] - - @connectgaps.setter - def connectgaps(self, val): - self['connectgaps'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # dr - # -- - @property - def dr(self): - """ - Sets the r coordinate step. - - The 'dr' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['dr'] - - @dr.setter - def dr(self, val): - self['dr'] = val - - # dtheta - # ------ - @property - 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 - - Returns - ------- - int|float - """ - return self['dtheta'] - - @dtheta.setter - def dtheta(self, val): - self['dtheta'] = val - - # fill - # ---- - @property - def fill(self): - """ - Sets the area to fill with a solid color. Use with `fillcolor` - if not "none". scatterpolar has a subset of the options - available to scatter. "toself" connects the endpoints of the - trace (or each segment of the trace if it has gaps) into a - closed shape. "tonext" fills the space between two traces if - one completely encloses the other (eg consecutive contour - lines), and behaves like "toself" if there is no trace before - it. "tonext" should not be used if one trace does not enclose - the other. - - The 'fill' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'toself', 'tonext'] - - Returns - ------- - Any - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # fillcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['fillcolor'] - - @fillcolor.setter - def fillcolor(self, val): - self['fillcolor'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'r+theta') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.scatterpolar.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hoveron - # ------- - @property - def hoveron(self): - """ - Do the hover effects highlight individual points (markers or - line points) or do they highlight filled regions? If the fill - is "toself" or "tonext" and there are no markers or text, then - the default is "fills", otherwise it is "points". - - The 'hoveron' property is a flaglist and may be specified - as a string containing: - - Any combination of ['points', 'fills'] joined with '+' characters - (e.g. 'points+fills') - - Returns - ------- - Any - """ - return self['hoveron'] - - @hoveron.setter - def hoveron(self, val): - self['hoveron'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - def hovertext(self): - """ - Sets hover text elements associated with each (x,y) pair. If a - single string, the same string appears over all the data - points. If an array of string, the items are mapped in order to - the this trace's (x,y) coordinates. To be seen, trace - `hoverinfo` must contain a "text" flag. - - The 'hovertext' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - shape - Determines the line shape. With "spline" the - lines are drawn using spline interpolation. The - other available values correspond to step-wise - line shapes. - smoothing - Has an effect only if `shape` is set to - "spline" Sets the amount of smoothing. 0 - corresponds to no smoothing (equivalent to a - "linear" shape). - width - Sets the line width (in px). - - Returns - ------- - plotly.graph_objs.scatterpolar.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scatterpolar.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - gradient - plotly.graph_objs.scatterpolar.marker.Gradient - instance or dict with compatible properties - line - plotly.graph_objs.scatterpolar.marker.Line - instance or dict with compatible properties - maxdisplayed - Sets a maximum number of points to be drawn on - the graph. 0 corresponds to no limit. - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . - - Returns - ------- - plotly.graph_objs.scatterpolar.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # mode - # ---- - @property - def mode(self): - """ - Determines the drawing mode for this scatter trace. If the - provided `mode` includes "text" then the `text` elements appear - at the coordinates. Otherwise, the `text` elements appear on - hover. If there are less than 20 points and the trace is not - stacked then the default is "lines+markers". Otherwise, - "lines". - - The 'mode' property is a flaglist and may be specified - as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters - (e.g. 'lines+markers') - OR exactly one of ['none'] (e.g. 'none') - - Returns - ------- - Any - """ - return self['mode'] - - @mode.setter - def mode(self, val): - self['mode'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # r - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['r'] - - @r.setter - def r(self, val): - self['r'] = val - - # r0 - # -- - @property - 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 - ------- - Any - """ - return self['r0'] - - @r0.setter - def r0(self, val): - self['r0'] = val - - # rsrc - # ---- - @property - def rsrc(self): - """ - Sets the source reference on plot.ly for r . - - The 'rsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['rsrc'] - - @rsrc.setter - def rsrc(self, val): - self['rsrc'] = val - - # selected - # -------- - @property - def selected(self): - """ - The 'selected' property is an instance of Selected - that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.Selected - - A dict of string/value properties that will be passed - to the Selected constructor - - Supported dict properties: - - marker - plotly.graph_objs.scatterpolar.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scatterpolar.selected.Textfon - t instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.scatterpolar.Selected - """ - return self['selected'] - - @selected.setter - def selected(self, val): - self['selected'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.scatterpolar.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # subplot - # ------- - @property - def subplot(self): - """ - Sets a reference between this trace's data coordinates and a - polar subplot. If "polar" (the default value), the data refer - to `layout.polar`. If "polar2", the data refer to - `layout.polar2`, and so on. - - The 'subplot' property is an identifier of a particular - subplot, of type 'polar', that may be specified as the string 'polar' - optionally followed by an integer >= 1 - (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) - - Returns - ------- - str - """ - return self['subplot'] - - @subplot.setter - def subplot(self, val): - self['subplot'] = val - - # text - # ---- - @property - def text(self): - """ - Sets text elements associated with each (x,y) pair. If a single - string, the same string appears over all the data points. If an - array of string, the items are mapped in order to the this - trace's (x,y) coordinates. If trace `hoverinfo` contains a - "text" flag and "hovertext" is not set, these elements will be - seen in the hover labels. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - Sets the text font. - - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scatterpolar.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # textposition - # ------------ - @property - 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', - 'middle center', 'middle right', 'bottom left', 'bottom - center', 'bottom right'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['textposition'] - - @textposition.setter - def textposition(self, val): - self['textposition'] = val - - # textpositionsrc - # --------------- - @property - def textpositionsrc(self): - """ - Sets the source reference on plot.ly for textposition . - - The 'textpositionsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textpositionsrc'] - - @textpositionsrc.setter - def textpositionsrc(self, val): - self['textpositionsrc'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # theta - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['theta'] - - @theta.setter - def theta(self, val): - self['theta'] = val - - # theta0 - # ------ - @property - 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 - ------- - Any - """ - return self['theta0'] - - @theta0.setter - def theta0(self, val): - self['theta0'] = val - - # thetasrc - # -------- - @property - def thetasrc(self): - """ - Sets the source reference on plot.ly for theta . - - The 'thetasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['thetasrc'] - - @thetasrc.setter - def thetasrc(self, val): - self['thetasrc'] = val - - # thetaunit - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thetaunit'] - - @thetaunit.setter - def thetaunit(self, val): - self['thetaunit'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # unselected - # ---------- - @property - def unselected(self): - """ - The 'unselected' property is an instance of Unselected - that may be specified as: - - An instance of plotly.graph_objs.scatterpolar.Unselected - - A dict of string/value properties that will be passed - to the Unselected constructor - - Supported dict properties: - - marker - plotly.graph_objs.scatterpolar.unselected.Marke - r instance or dict with compatible properties - textfont - plotly.graph_objs.scatterpolar.unselected.Textf - ont instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.scatterpolar.Unselected - """ - return self['unselected'] - - @unselected.setter - def unselected(self, val): - self['unselected'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - cliponaxis - Determines whether or not markers and text nodes are - clipped about the subplot axes. To show markers and - text nodes above axis lines and tick labels, make sure - to set `xaxis.layer` and `yaxis.layer` to *below - traces*. - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dr - Sets the r coordinate step. - dtheta - Sets the theta coordinate step. By default, the - `dtheta` step equals the subplot's period divided by - the length of the `r` coordinates. - fill - Sets the area to fill with a solid color. Use with - `fillcolor` if not "none". scatterpolar has a subset of - the options available to scatter. "toself" connects the - endpoints of the trace (or each segment of the trace if - it has gaps) into a closed shape. "tonext" fills the - space between two traces if one completely encloses the - other (eg consecutive contour lines), and behaves like - "toself" if there is no trace before it. "tonext" - should not be used if one trace does not enclose the - other. - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scatterpolar.Hoverlabel instance or - dict with compatible properties - hoveron - Do the hover effects highlight individual points - (markers or line points) or do they highlight filled - regions? If the fill is "toself" or "tonext" and there - are no markers or text, then the default is "fills", - otherwise it is "points". - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (x,y) - pair. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to the this trace's (x,y) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scatterpolar.Line instance or dict - with compatible properties - marker - plotly.graph_objs.scatterpolar.Marker instance or dict - with compatible properties - mode - Determines the drawing mode for this scatter trace. If - the provided `mode` includes "text" then the `text` - elements appear at the coordinates. Otherwise, the - `text` elements appear on hover. If there are less than - 20 points and the trace is not stacked then the default - is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - r - Sets the radial coordinates - r0 - Alternate to `r`. Builds a linear space of r - coordinates. Use with `dr` where `r0` is the starting - coordinate and `dr` the step. - rsrc - Sets the source reference on plot.ly for r . - selected - plotly.graph_objs.scatterpolar.Selected instance or - dict with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.scatterpolar.Stream instance or dict - with compatible properties - subplot - Sets a reference between this trace's data coordinates - and a polar subplot. If "polar" (the default value), - the data refer to `layout.polar`. If "polar2", the data - refer to `layout.polar2`, and so on. - text - Sets text elements associated with each (x,y) pair. If - a single string, the same string appears over all the - data points. If an array of string, the items are - mapped in order to the this trace's (x,y) coordinates. - If trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - theta - Sets the angular coordinates - theta0 - Alternate to `theta`. Builds a linear space of theta - coordinates. Use with `dtheta` where `theta0` is the - starting coordinate and `dtheta` the step. - thetasrc - Sets the source reference on plot.ly for theta . - thetaunit - Sets the unit of input "theta" values. Has an effect - only when on "linear" angular axes. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.scatterpolar.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - """ - - def __init__( - self, - arg=None, - cliponaxis=None, - connectgaps=None, - customdata=None, - customdatasrc=None, - dr=None, - dtheta=None, - fill=None, - fillcolor=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hoveron=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - legendgroup=None, - line=None, - marker=None, - mode=None, - name=None, - opacity=None, - r=None, - r0=None, - rsrc=None, - selected=None, - selectedpoints=None, - showlegend=None, - stream=None, - subplot=None, - text=None, - textfont=None, - textposition=None, - textpositionsrc=None, - textsrc=None, - theta=None, - theta0=None, - thetasrc=None, - thetaunit=None, - uid=None, - uirevision=None, - unselected=None, - visible=None, - **kwargs - ): - """ - Construct a new Scatterpolar object - - The scatterpolar trace type encompasses line charts, scatter - charts, text charts, and bubble charts in polar coordinates. - The data visualized as scatter point or lines is set in `r` - (radial) and `theta` (angular) coordinates Text (appearing - either on the chart or on hover only) is via `text`. Bubble - charts are achieved by setting `marker.size` and/or - `marker.color` to numerical arrays. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scatterpolar - cliponaxis - Determines whether or not markers and text nodes are - clipped about the subplot axes. To show markers and - text nodes above axis lines and tick labels, make sure - to set `xaxis.layer` and `yaxis.layer` to *below - traces*. - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dr - Sets the r coordinate step. - dtheta - Sets the theta coordinate step. By default, the - `dtheta` step equals the subplot's period divided by - the length of the `r` coordinates. - fill - Sets the area to fill with a solid color. Use with - `fillcolor` if not "none". scatterpolar has a subset of - the options available to scatter. "toself" connects the - endpoints of the trace (or each segment of the trace if - it has gaps) into a closed shape. "tonext" fills the - space between two traces if one completely encloses the - other (eg consecutive contour lines), and behaves like - "toself" if there is no trace before it. "tonext" - should not be used if one trace does not enclose the - other. - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scatterpolar.Hoverlabel instance or - dict with compatible properties - hoveron - Do the hover effects highlight individual points - (markers or line points) or do they highlight filled - regions? If the fill is "toself" or "tonext" and there - are no markers or text, then the default is "fills", - otherwise it is "points". - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (x,y) - pair. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to the this trace's (x,y) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scatterpolar.Line instance or dict - with compatible properties - marker - plotly.graph_objs.scatterpolar.Marker instance or dict - with compatible properties - mode - Determines the drawing mode for this scatter trace. If - the provided `mode` includes "text" then the `text` - elements appear at the coordinates. Otherwise, the - `text` elements appear on hover. If there are less than - 20 points and the trace is not stacked then the default - is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - r - Sets the radial coordinates - r0 - Alternate to `r`. Builds a linear space of r - coordinates. Use with `dr` where `r0` is the starting - coordinate and `dr` the step. - rsrc - Sets the source reference on plot.ly for r . - selected - plotly.graph_objs.scatterpolar.Selected instance or - dict with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.scatterpolar.Stream instance or dict - with compatible properties - subplot - Sets a reference between this trace's data coordinates - and a polar subplot. If "polar" (the default value), - the data refer to `layout.polar`. If "polar2", the data - refer to `layout.polar2`, and so on. - text - Sets text elements associated with each (x,y) pair. If - a single string, the same string appears over all the - data points. If an array of string, the items are - mapped in order to the this trace's (x,y) coordinates. - If trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - theta - Sets the angular coordinates - theta0 - Alternate to `theta`. Builds a linear space of theta - coordinates. Use with `dtheta` where `theta0` is the - starting coordinate and `dtheta` the step. - thetasrc - Sets the source reference on plot.ly for theta . - thetaunit - Sets the unit of input "theta" values. Has an effect - only when on "linear" angular axes. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.scatterpolar.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - - Returns - ------- - Scatterpolar - """ - super(Scatterpolar, self).__init__('scatterpolar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Scatterpolar -constructor must be a dict or -an instance of plotly.graph_objs.Scatterpolar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (scatterpolar as v_scatterpolar) - - # Initialize validators - # --------------------- - self._validators['cliponaxis'] = v_scatterpolar.CliponaxisValidator() - self._validators['connectgaps'] = v_scatterpolar.ConnectgapsValidator() - self._validators['customdata'] = v_scatterpolar.CustomdataValidator() - self._validators['customdatasrc' - ] = v_scatterpolar.CustomdatasrcValidator() - self._validators['dr'] = v_scatterpolar.DrValidator() - self._validators['dtheta'] = v_scatterpolar.DthetaValidator() - self._validators['fill'] = v_scatterpolar.FillValidator() - self._validators['fillcolor'] = v_scatterpolar.FillcolorValidator() - self._validators['hoverinfo'] = v_scatterpolar.HoverinfoValidator() - self._validators['hoverinfosrc' - ] = v_scatterpolar.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_scatterpolar.HoverlabelValidator() - self._validators['hoveron'] = v_scatterpolar.HoveronValidator() - self._validators['hovertemplate' - ] = v_scatterpolar.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_scatterpolar.HovertemplatesrcValidator() - self._validators['hovertext'] = v_scatterpolar.HovertextValidator() - self._validators['hovertextsrc' - ] = v_scatterpolar.HovertextsrcValidator() - self._validators['ids'] = v_scatterpolar.IdsValidator() - self._validators['idssrc'] = v_scatterpolar.IdssrcValidator() - self._validators['legendgroup'] = v_scatterpolar.LegendgroupValidator() - self._validators['line'] = v_scatterpolar.LineValidator() - self._validators['marker'] = v_scatterpolar.MarkerValidator() - self._validators['mode'] = v_scatterpolar.ModeValidator() - self._validators['name'] = v_scatterpolar.NameValidator() - self._validators['opacity'] = v_scatterpolar.OpacityValidator() - self._validators['r'] = v_scatterpolar.RValidator() - self._validators['r0'] = v_scatterpolar.R0Validator() - self._validators['rsrc'] = v_scatterpolar.RsrcValidator() - self._validators['selected'] = v_scatterpolar.SelectedValidator() - self._validators['selectedpoints' - ] = v_scatterpolar.SelectedpointsValidator() - self._validators['showlegend'] = v_scatterpolar.ShowlegendValidator() - self._validators['stream'] = v_scatterpolar.StreamValidator() - self._validators['subplot'] = v_scatterpolar.SubplotValidator() - self._validators['text'] = v_scatterpolar.TextValidator() - self._validators['textfont'] = v_scatterpolar.TextfontValidator() - self._validators['textposition' - ] = v_scatterpolar.TextpositionValidator() - self._validators['textpositionsrc' - ] = v_scatterpolar.TextpositionsrcValidator() - self._validators['textsrc'] = v_scatterpolar.TextsrcValidator() - self._validators['theta'] = v_scatterpolar.ThetaValidator() - self._validators['theta0'] = v_scatterpolar.Theta0Validator() - self._validators['thetasrc'] = v_scatterpolar.ThetasrcValidator() - self._validators['thetaunit'] = v_scatterpolar.ThetaunitValidator() - self._validators['uid'] = v_scatterpolar.UidValidator() - self._validators['uirevision'] = v_scatterpolar.UirevisionValidator() - self._validators['unselected'] = v_scatterpolar.UnselectedValidator() - self._validators['visible'] = v_scatterpolar.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('cliponaxis', None) - self['cliponaxis'] = cliponaxis if cliponaxis is not None else _v - _v = arg.pop('connectgaps', None) - self['connectgaps'] = connectgaps if connectgaps is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('dr', None) - self['dr'] = dr if dr is not None else _v - _v = arg.pop('dtheta', None) - self['dtheta'] = dtheta if dtheta is not None else _v - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('fillcolor', None) - self['fillcolor'] = fillcolor if fillcolor is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hoveron', None) - self['hoveron'] = hoveron if hoveron is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('mode', None) - self['mode'] = mode if mode is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('r', None) - self['r'] = r if r is not None else _v - _v = arg.pop('r0', None) - self['r0'] = r0 if r0 is not None else _v - _v = arg.pop('rsrc', None) - self['rsrc'] = rsrc if rsrc is not None else _v - _v = arg.pop('selected', None) - self['selected'] = selected if selected is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('subplot', None) - self['subplot'] = subplot if subplot is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - _v = arg.pop('textposition', None) - self['textposition'] = textposition if textposition is not None else _v - _v = arg.pop('textpositionsrc', None) - self['textpositionsrc' - ] = textpositionsrc if textpositionsrc is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('theta', None) - self['theta'] = theta if theta is not None else _v - _v = arg.pop('theta0', None) - self['theta0'] = theta0 if theta0 is not None else _v - _v = arg.pop('thetasrc', None) - self['thetasrc'] = thetasrc if thetasrc is not None else _v - _v = arg.pop('thetaunit', None) - self['thetaunit'] = thetaunit if thetaunit is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('unselected', None) - self['unselected'] = unselected if unselected is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'scatterpolar' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='scatterpolar', val='scatterpolar' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_scatterpolargl.py b/plotly/graph_objs/_scatterpolargl.py deleted file mode 100644 index e4444dc2676..00000000000 --- a/plotly/graph_objs/_scatterpolargl.py +++ /dev/null @@ -1,1924 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Scatterpolargl(BaseTraceType): - - # connectgaps - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['connectgaps'] - - @connectgaps.setter - def connectgaps(self, val): - self['connectgaps'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # dr - # -- - @property - def dr(self): - """ - Sets the r coordinate step. - - The 'dr' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['dr'] - - @dr.setter - def dr(self, val): - self['dr'] = val - - # dtheta - # ------ - @property - 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 - - Returns - ------- - int|float - """ - return self['dtheta'] - - @dtheta.setter - def dtheta(self, val): - self['dtheta'] = val - - # fill - # ---- - @property - def fill(self): - """ - Sets the area to fill with a solid color. Defaults to "none" - unless this trace is stacked, then it gets "tonexty" - ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` - if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 - respectively. "tonextx" and "tonexty" fill between the - endpoints of this trace and the endpoints of the trace before - it, connecting those endpoints with straight lines (to make a - stacked area graph); if there is no trace before it, they - behave like "tozerox" and "tozeroy". "toself" connects the - endpoints of the trace (or each segment of the trace if it has - gaps) into a closed shape. "tonext" fills the space between two - traces if one completely encloses the other (eg consecutive - contour lines), and behaves like "toself" if there is no trace - before it. "tonext" should not be used if one trace does not - enclose the other. Traces in a `stackgroup` will only fill to - (or be filled to) other traces in the same group. With multiple - `stackgroup`s or some traces stacked and some not, if fill- - linked traces are not already consecutive, the later ones will - be pushed down in the drawing order. - - The 'fill' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', - 'toself', 'tonext'] - - Returns - ------- - Any - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # fillcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['fillcolor'] - - @fillcolor.setter - def fillcolor(self, val): - self['fillcolor'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'r+theta') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.scatterpolargl.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - def hovertext(self): - """ - Sets hover text elements associated with each (x,y) pair. If a - single string, the same string appears over all the data - points. If an array of string, the items are mapped in order to - the this trace's (x,y) coordinates. To be seen, trace - `hoverinfo` must contain a "text" flag. - - The 'hovertext' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.Line - - A dict of string/value properties that will be passed - to the Line constructor - - Supported dict properties: - - color - Sets the line color. - dash - Sets the style of the lines. - shape - Determines the line shape. The values - correspond to step-wise line shapes. - width - Sets the line width (in px). - - Returns - ------- - plotly.graph_objs.scatterpolargl.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scatterpolargl.marker.ColorBa - r instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - line - plotly.graph_objs.scatterpolargl.marker.Line - instance or dict with compatible properties - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . - - Returns - ------- - plotly.graph_objs.scatterpolargl.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # mode - # ---- - @property - def mode(self): - """ - Determines the drawing mode for this scatter trace. If the - provided `mode` includes "text" then the `text` elements appear - at the coordinates. Otherwise, the `text` elements appear on - hover. If there are less than 20 points and the trace is not - stacked then the default is "lines+markers". Otherwise, - "lines". - - The 'mode' property is a flaglist and may be specified - as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters - (e.g. 'lines+markers') - OR exactly one of ['none'] (e.g. 'none') - - Returns - ------- - Any - """ - return self['mode'] - - @mode.setter - def mode(self, val): - self['mode'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # r - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['r'] - - @r.setter - def r(self, val): - self['r'] = val - - # r0 - # -- - @property - 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 - ------- - Any - """ - return self['r0'] - - @r0.setter - def r0(self, val): - self['r0'] = val - - # rsrc - # ---- - @property - def rsrc(self): - """ - Sets the source reference on plot.ly for r . - - The 'rsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['rsrc'] - - @rsrc.setter - def rsrc(self, val): - self['rsrc'] = val - - # selected - # -------- - @property - def selected(self): - """ - The 'selected' property is an instance of Selected - that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.Selected - - A dict of string/value properties that will be passed - to the Selected constructor - - Supported dict properties: - - marker - plotly.graph_objs.scatterpolargl.selected.Marke - r instance or dict with compatible properties - textfont - plotly.graph_objs.scatterpolargl.selected.Textf - ont instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.scatterpolargl.Selected - """ - return self['selected'] - - @selected.setter - def selected(self, val): - self['selected'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.scatterpolargl.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # subplot - # ------- - @property - def subplot(self): - """ - Sets a reference between this trace's data coordinates and a - polar subplot. If "polar" (the default value), the data refer - to `layout.polar`. If "polar2", the data refer to - `layout.polar2`, and so on. - - The 'subplot' property is an identifier of a particular - subplot, of type 'polar', that may be specified as the string 'polar' - optionally followed by an integer >= 1 - (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) - - Returns - ------- - str - """ - return self['subplot'] - - @subplot.setter - def subplot(self, val): - self['subplot'] = val - - # text - # ---- - @property - def text(self): - """ - Sets text elements associated with each (x,y) pair. If a single - string, the same string appears over all the data points. If an - array of string, the items are mapped in order to the this - trace's (x,y) coordinates. If trace `hoverinfo` contains a - "text" flag and "hovertext" is not set, these elements will be - seen in the hover labels. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - Sets the text font. - - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scatterpolargl.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # textposition - # ------------ - @property - 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', - 'middle center', 'middle right', 'bottom left', 'bottom - center', 'bottom right'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['textposition'] - - @textposition.setter - def textposition(self, val): - self['textposition'] = val - - # textpositionsrc - # --------------- - @property - def textpositionsrc(self): - """ - Sets the source reference on plot.ly for textposition . - - The 'textpositionsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textpositionsrc'] - - @textpositionsrc.setter - def textpositionsrc(self, val): - self['textpositionsrc'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # theta - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['theta'] - - @theta.setter - def theta(self, val): - self['theta'] = val - - # theta0 - # ------ - @property - 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 - ------- - Any - """ - return self['theta0'] - - @theta0.setter - def theta0(self, val): - self['theta0'] = val - - # thetasrc - # -------- - @property - def thetasrc(self): - """ - Sets the source reference on plot.ly for theta . - - The 'thetasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['thetasrc'] - - @thetasrc.setter - def thetasrc(self, val): - self['thetasrc'] = val - - # thetaunit - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thetaunit'] - - @thetaunit.setter - def thetaunit(self, val): - self['thetaunit'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # unselected - # ---------- - @property - def unselected(self): - """ - The 'unselected' property is an instance of Unselected - that may be specified as: - - An instance of plotly.graph_objs.scatterpolargl.Unselected - - A dict of string/value properties that will be passed - to the Unselected constructor - - Supported dict properties: - - marker - plotly.graph_objs.scatterpolargl.unselected.Mar - ker instance or dict with compatible properties - textfont - plotly.graph_objs.scatterpolargl.unselected.Tex - tfont instance or dict with compatible - properties - - Returns - ------- - plotly.graph_objs.scatterpolargl.Unselected - """ - return self['unselected'] - - @unselected.setter - def unselected(self, val): - self['unselected'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dr - Sets the r coordinate step. - dtheta - Sets the theta coordinate step. By default, the - `dtheta` step equals the subplot's period divided by - the length of the `r` coordinates. - fill - Sets the area to fill with a solid color. Defaults to - "none" unless this trace is stacked, then it gets - "tonexty" ("tonextx") if `orientation` is "v" ("h") Use - with `fillcolor` if not "none". "tozerox" and "tozeroy" - fill to x=0 and y=0 respectively. "tonextx" and - "tonexty" fill between the endpoints of this trace and - the endpoints of the trace before it, connecting those - endpoints with straight lines (to make a stacked area - graph); if there is no trace before it, they behave - like "tozerox" and "tozeroy". "toself" connects the - endpoints of the trace (or each segment of the trace if - it has gaps) into a closed shape. "tonext" fills the - space between two traces if one completely encloses the - other (eg consecutive contour lines), and behaves like - "toself" if there is no trace before it. "tonext" - should not be used if one trace does not enclose the - other. Traces in a `stackgroup` will only fill to (or - be filled to) other traces in the same group. With - multiple `stackgroup`s or some traces stacked and some - not, if fill-linked traces are not already consecutive, - the later ones will be pushed down in the drawing - order. - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scatterpolargl.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (x,y) - pair. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to the this trace's (x,y) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scatterpolargl.Line instance or dict - with compatible properties - marker - plotly.graph_objs.scatterpolargl.Marker instance or - dict with compatible properties - mode - Determines the drawing mode for this scatter trace. If - the provided `mode` includes "text" then the `text` - elements appear at the coordinates. Otherwise, the - `text` elements appear on hover. If there are less than - 20 points and the trace is not stacked then the default - is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - r - Sets the radial coordinates - r0 - Alternate to `r`. Builds a linear space of r - coordinates. Use with `dr` where `r0` is the starting - coordinate and `dr` the step. - rsrc - Sets the source reference on plot.ly for r . - selected - plotly.graph_objs.scatterpolargl.Selected instance or - dict with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.scatterpolargl.Stream instance or - dict with compatible properties - subplot - Sets a reference between this trace's data coordinates - and a polar subplot. If "polar" (the default value), - the data refer to `layout.polar`. If "polar2", the data - refer to `layout.polar2`, and so on. - text - Sets text elements associated with each (x,y) pair. If - a single string, the same string appears over all the - data points. If an array of string, the items are - mapped in order to the this trace's (x,y) coordinates. - If trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - theta - Sets the angular coordinates - theta0 - Alternate to `theta`. Builds a linear space of theta - coordinates. Use with `dtheta` where `theta0` is the - starting coordinate and `dtheta` the step. - thetasrc - Sets the source reference on plot.ly for theta . - thetaunit - Sets the unit of input "theta" values. Has an effect - only when on "linear" angular axes. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.scatterpolargl.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - """ - - def __init__( - self, - arg=None, - connectgaps=None, - customdata=None, - customdatasrc=None, - dr=None, - dtheta=None, - fill=None, - fillcolor=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - legendgroup=None, - line=None, - marker=None, - mode=None, - name=None, - opacity=None, - r=None, - r0=None, - rsrc=None, - selected=None, - selectedpoints=None, - showlegend=None, - stream=None, - subplot=None, - text=None, - textfont=None, - textposition=None, - textpositionsrc=None, - textsrc=None, - theta=None, - theta0=None, - thetasrc=None, - thetaunit=None, - uid=None, - uirevision=None, - unselected=None, - visible=None, - **kwargs - ): - """ - Construct a new Scatterpolargl object - - The scatterpolargl trace type encompasses line charts, scatter - charts, and bubble charts in polar coordinates using the WebGL - plotting engine. The data visualized as scatter point or lines - is set in `r` (radial) and `theta` (angular) coordinates Bubble - charts are achieved by setting `marker.size` and/or - `marker.color` to numerical arrays. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scatterpolargl - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - dr - Sets the r coordinate step. - dtheta - Sets the theta coordinate step. By default, the - `dtheta` step equals the subplot's period divided by - the length of the `r` coordinates. - fill - Sets the area to fill with a solid color. Defaults to - "none" unless this trace is stacked, then it gets - "tonexty" ("tonextx") if `orientation` is "v" ("h") Use - with `fillcolor` if not "none". "tozerox" and "tozeroy" - fill to x=0 and y=0 respectively. "tonextx" and - "tonexty" fill between the endpoints of this trace and - the endpoints of the trace before it, connecting those - endpoints with straight lines (to make a stacked area - graph); if there is no trace before it, they behave - like "tozerox" and "tozeroy". "toself" connects the - endpoints of the trace (or each segment of the trace if - it has gaps) into a closed shape. "tonext" fills the - space between two traces if one completely encloses the - other (eg consecutive contour lines), and behaves like - "toself" if there is no trace before it. "tonext" - should not be used if one trace does not enclose the - other. Traces in a `stackgroup` will only fill to (or - be filled to) other traces in the same group. With - multiple `stackgroup`s or some traces stacked and some - not, if fill-linked traces are not already consecutive, - the later ones will be pushed down in the drawing - order. - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scatterpolargl.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (x,y) - pair. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to the this trace's (x,y) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scatterpolargl.Line instance or dict - with compatible properties - marker - plotly.graph_objs.scatterpolargl.Marker instance or - dict with compatible properties - mode - Determines the drawing mode for this scatter trace. If - the provided `mode` includes "text" then the `text` - elements appear at the coordinates. Otherwise, the - `text` elements appear on hover. If there are less than - 20 points and the trace is not stacked then the default - is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - r - Sets the radial coordinates - r0 - Alternate to `r`. Builds a linear space of r - coordinates. Use with `dr` where `r0` is the starting - coordinate and `dr` the step. - rsrc - Sets the source reference on plot.ly for r . - selected - plotly.graph_objs.scatterpolargl.Selected instance or - dict with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.scatterpolargl.Stream instance or - dict with compatible properties - subplot - Sets a reference between this trace's data coordinates - and a polar subplot. If "polar" (the default value), - the data refer to `layout.polar`. If "polar2", the data - refer to `layout.polar2`, and so on. - text - Sets text elements associated with each (x,y) pair. If - a single string, the same string appears over all the - data points. If an array of string, the items are - mapped in order to the this trace's (x,y) coordinates. - If trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - theta - Sets the angular coordinates - theta0 - Alternate to `theta`. Builds a linear space of theta - coordinates. Use with `dtheta` where `theta0` is the - starting coordinate and `dtheta` the step. - thetasrc - Sets the source reference on plot.ly for theta . - thetaunit - Sets the unit of input "theta" values. Has an effect - only when on "linear" angular axes. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.scatterpolargl.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - - Returns - ------- - Scatterpolargl - """ - super(Scatterpolargl, self).__init__('scatterpolargl') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Scatterpolargl -constructor must be a dict or -an instance of plotly.graph_objs.Scatterpolargl""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (scatterpolargl as v_scatterpolargl) - - # Initialize validators - # --------------------- - self._validators['connectgaps' - ] = v_scatterpolargl.ConnectgapsValidator() - self._validators['customdata'] = v_scatterpolargl.CustomdataValidator() - self._validators['customdatasrc' - ] = v_scatterpolargl.CustomdatasrcValidator() - self._validators['dr'] = v_scatterpolargl.DrValidator() - self._validators['dtheta'] = v_scatterpolargl.DthetaValidator() - self._validators['fill'] = v_scatterpolargl.FillValidator() - self._validators['fillcolor'] = v_scatterpolargl.FillcolorValidator() - self._validators['hoverinfo'] = v_scatterpolargl.HoverinfoValidator() - self._validators['hoverinfosrc' - ] = v_scatterpolargl.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_scatterpolargl.HoverlabelValidator() - self._validators['hovertemplate' - ] = v_scatterpolargl.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_scatterpolargl.HovertemplatesrcValidator() - self._validators['hovertext'] = v_scatterpolargl.HovertextValidator() - self._validators['hovertextsrc' - ] = v_scatterpolargl.HovertextsrcValidator() - self._validators['ids'] = v_scatterpolargl.IdsValidator() - self._validators['idssrc'] = v_scatterpolargl.IdssrcValidator() - self._validators['legendgroup' - ] = v_scatterpolargl.LegendgroupValidator() - self._validators['line'] = v_scatterpolargl.LineValidator() - self._validators['marker'] = v_scatterpolargl.MarkerValidator() - self._validators['mode'] = v_scatterpolargl.ModeValidator() - self._validators['name'] = v_scatterpolargl.NameValidator() - self._validators['opacity'] = v_scatterpolargl.OpacityValidator() - self._validators['r'] = v_scatterpolargl.RValidator() - self._validators['r0'] = v_scatterpolargl.R0Validator() - self._validators['rsrc'] = v_scatterpolargl.RsrcValidator() - self._validators['selected'] = v_scatterpolargl.SelectedValidator() - self._validators['selectedpoints' - ] = v_scatterpolargl.SelectedpointsValidator() - self._validators['showlegend'] = v_scatterpolargl.ShowlegendValidator() - self._validators['stream'] = v_scatterpolargl.StreamValidator() - self._validators['subplot'] = v_scatterpolargl.SubplotValidator() - self._validators['text'] = v_scatterpolargl.TextValidator() - self._validators['textfont'] = v_scatterpolargl.TextfontValidator() - self._validators['textposition' - ] = v_scatterpolargl.TextpositionValidator() - self._validators['textpositionsrc' - ] = v_scatterpolargl.TextpositionsrcValidator() - self._validators['textsrc'] = v_scatterpolargl.TextsrcValidator() - self._validators['theta'] = v_scatterpolargl.ThetaValidator() - self._validators['theta0'] = v_scatterpolargl.Theta0Validator() - self._validators['thetasrc'] = v_scatterpolargl.ThetasrcValidator() - self._validators['thetaunit'] = v_scatterpolargl.ThetaunitValidator() - self._validators['uid'] = v_scatterpolargl.UidValidator() - self._validators['uirevision'] = v_scatterpolargl.UirevisionValidator() - self._validators['unselected'] = v_scatterpolargl.UnselectedValidator() - self._validators['visible'] = v_scatterpolargl.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('connectgaps', None) - self['connectgaps'] = connectgaps if connectgaps is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('dr', None) - self['dr'] = dr if dr is not None else _v - _v = arg.pop('dtheta', None) - self['dtheta'] = dtheta if dtheta is not None else _v - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('fillcolor', None) - self['fillcolor'] = fillcolor if fillcolor is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('mode', None) - self['mode'] = mode if mode is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('r', None) - self['r'] = r if r is not None else _v - _v = arg.pop('r0', None) - self['r0'] = r0 if r0 is not None else _v - _v = arg.pop('rsrc', None) - self['rsrc'] = rsrc if rsrc is not None else _v - _v = arg.pop('selected', None) - self['selected'] = selected if selected is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('subplot', None) - self['subplot'] = subplot if subplot is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - _v = arg.pop('textposition', None) - self['textposition'] = textposition if textposition is not None else _v - _v = arg.pop('textpositionsrc', None) - self['textpositionsrc' - ] = textpositionsrc if textpositionsrc is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('theta', None) - self['theta'] = theta if theta is not None else _v - _v = arg.pop('theta0', None) - self['theta0'] = theta0 if theta0 is not None else _v - _v = arg.pop('thetasrc', None) - self['thetasrc'] = thetasrc if thetasrc is not None else _v - _v = arg.pop('thetaunit', None) - self['thetaunit'] = thetaunit if thetaunit is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('unselected', None) - self['unselected'] = unselected if unselected is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'scatterpolargl' - self._validators['type'] = LiteralValidator( - plotly_name='type', - parent_name='scatterpolargl', - val='scatterpolargl' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_scatterternary.py b/plotly/graph_objs/_scatterternary.py deleted file mode 100644 index 7dd5630f236..00000000000 --- a/plotly/graph_objs/_scatterternary.py +++ /dev/null @@ -1,1953 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Scatterternary(BaseTraceType): - - # a - # - - @property - def a(self): - """ - Sets the quantity of component `a` in each data point. If `a`, - `b`, and `c` are all provided, they need not be normalized, - only the relative values matter. If only two arrays are - provided they must be normalized to match `ternary.sum`. - - The 'a' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['a'] - - @a.setter - def a(self, val): - self['a'] = val - - # asrc - # ---- - @property - def asrc(self): - """ - Sets the source reference on plot.ly for a . - - The 'asrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['asrc'] - - @asrc.setter - def asrc(self, val): - self['asrc'] = val - - # b - # - - @property - def b(self): - """ - Sets the quantity of component `a` in each data point. If `a`, - `b`, and `c` are all provided, they need not be normalized, - only the relative values matter. If only two arrays are - provided they must be normalized to match `ternary.sum`. - - The 'b' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['b'] - - @b.setter - def b(self, val): - self['b'] = val - - # bsrc - # ---- - @property - def bsrc(self): - """ - Sets the source reference on plot.ly for b . - - The 'bsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bsrc'] - - @bsrc.setter - def bsrc(self, val): - self['bsrc'] = val - - # c - # - - @property - def c(self): - """ - Sets the quantity of component `a` in each data point. If `a`, - `b`, and `c` are all provided, they need not be normalized, - only the relative values matter. If only two arrays are - provided they must be normalized to match `ternary.sum`. - - The 'c' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['c'] - - @c.setter - def c(self, val): - self['c'] = val - - # cliponaxis - # ---------- - @property - def cliponaxis(self): - """ - Determines whether or not markers and text nodes are clipped - about the subplot axes. To show markers and text nodes above - axis lines and tick labels, make sure to set `xaxis.layer` and - `yaxis.layer` to *below traces*. - - The 'cliponaxis' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cliponaxis'] - - @cliponaxis.setter - def cliponaxis(self, val): - self['cliponaxis'] = val - - # connectgaps - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['connectgaps'] - - @connectgaps.setter - def connectgaps(self, val): - self['connectgaps'] = val - - # csrc - # ---- - @property - def csrc(self): - """ - Sets the source reference on plot.ly for c . - - The 'csrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['csrc'] - - @csrc.setter - def csrc(self, val): - self['csrc'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # fill - # ---- - @property - def fill(self): - """ - Sets the area to fill with a solid color. Use with `fillcolor` - if not "none". scatterternary has a subset of the options - available to scatter. "toself" connects the endpoints of the - trace (or each segment of the trace if it has gaps) into a - closed shape. "tonext" fills the space between two traces if - one completely encloses the other (eg consecutive contour - lines), and behaves like "toself" if there is no trace before - it. "tonext" should not be used if one trace does not enclose - the other. - - The 'fill' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'toself', 'tonext'] - - Returns - ------- - Any - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # fillcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['fillcolor'] - - @fillcolor.setter - def fillcolor(self, val): - self['fillcolor'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'a+b') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.scatterternary.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.scatterternary.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hoveron - # ------- - @property - def hoveron(self): - """ - Do the hover effects highlight individual points (markers or - line points) or do they highlight filled regions? If the fill - is "toself" or "tonext" and there are no markers or text, then - the default is "fills", otherwise it is "points". - - The 'hoveron' property is a flaglist and may be specified - as a string containing: - - Any combination of ['points', 'fills'] joined with '+' characters - (e.g. 'points+fills') - - Returns - ------- - Any - """ - return self['hoveron'] - - @hoveron.setter - def hoveron(self, val): - self['hoveron'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - def hovertext(self): - """ - Sets hover text elements associated with each (a,b,c) point. If - a single string, the same string appears over all the data - points. If an array of strings, the items are mapped in order - to the the data points in (a,b,c). To be seen, trace - `hoverinfo` must contain a "text" flag. - - The 'hovertext' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - shape - Determines the line shape. With "spline" the - lines are drawn using spline interpolation. The - other available values correspond to step-wise - line shapes. - smoothing - Has an effect only if `shape` is set to - "spline" Sets the amount of smoothing. 0 - corresponds to no smoothing (equivalent to a - "linear" shape). - width - Sets the line width (in px). - - Returns - ------- - plotly.graph_objs.scatterternary.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scatterternary.marker.ColorBa - r instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - gradient - plotly.graph_objs.scatterternary.marker.Gradien - t instance or dict with compatible properties - line - plotly.graph_objs.scatterternary.marker.Line - instance or dict with compatible properties - maxdisplayed - Sets a maximum number of points to be drawn on - the graph. 0 corresponds to no limit. - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . - - Returns - ------- - plotly.graph_objs.scatterternary.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # mode - # ---- - @property - def mode(self): - """ - Determines the drawing mode for this scatter trace. If the - provided `mode` includes "text" then the `text` elements appear - at the coordinates. Otherwise, the `text` elements appear on - hover. If there are less than 20 points and the trace is not - stacked then the default is "lines+markers". Otherwise, - "lines". - - The 'mode' property is a flaglist and may be specified - as a string containing: - - Any combination of ['lines', 'markers', 'text'] joined with '+' characters - (e.g. 'lines+markers') - OR exactly one of ['none'] (e.g. 'none') - - Returns - ------- - Any - """ - return self['mode'] - - @mode.setter - def mode(self, val): - self['mode'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # selected - # -------- - @property - def selected(self): - """ - The 'selected' property is an instance of Selected - that may be specified as: - - An instance of plotly.graph_objs.scatterternary.Selected - - A dict of string/value properties that will be passed - to the Selected constructor - - Supported dict properties: - - marker - plotly.graph_objs.scatterternary.selected.Marke - r instance or dict with compatible properties - textfont - plotly.graph_objs.scatterternary.selected.Textf - ont instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.scatterternary.Selected - """ - return self['selected'] - - @selected.setter - def selected(self, val): - self['selected'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.scatterternary.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.scatterternary.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # subplot - # ------- - @property - def subplot(self): - """ - Sets a reference between this trace's data coordinates and a - ternary subplot. If "ternary" (the default value), the data - refer to `layout.ternary`. If "ternary2", the data refer to - `layout.ternary2`, and so on. - - The 'subplot' property is an identifier of a particular - subplot, of type 'ternary', that may be specified as the string 'ternary' - optionally followed by an integer >= 1 - (e.g. 'ternary', 'ternary1', 'ternary2', 'ternary3', etc.) - - Returns - ------- - str - """ - return self['subplot'] - - @subplot.setter - def subplot(self, val): - self['subplot'] = val - - # sum - # --- - @property - def sum(self): - """ - The number each triplet should sum to, if only two of `a`, `b`, - and `c` are provided. This overrides `ternary.sum` to - normalize this specific trace, but does not affect the values - displayed on the axes. 0 (or missing) means to use - ternary.sum - - The 'sum' property is a number and may be specified as: - - An int or float in the interval [0, inf] - - Returns - ------- - int|float - """ - return self['sum'] - - @sum.setter - def sum(self, val): - self['sum'] = val - - # text - # ---- - @property - def text(self): - """ - Sets text elements associated with each (a,b,c) point. If a - single string, the same string appears over all the data - points. If an array of strings, the items are mapped in order - to the the data points in (a,b,c). If trace `hoverinfo` - contains a "text" flag and "hovertext" is not set, these - elements will be seen in the hover labels. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - Sets the text font. - - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scatterternary.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # textposition - # ------------ - @property - 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', - 'middle center', 'middle right', 'bottom left', 'bottom - center', 'bottom right'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['textposition'] - - @textposition.setter - def textposition(self, val): - self['textposition'] = val - - # textpositionsrc - # --------------- - @property - def textpositionsrc(self): - """ - Sets the source reference on plot.ly for textposition . - - The 'textpositionsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textpositionsrc'] - - @textpositionsrc.setter - def textpositionsrc(self, val): - self['textpositionsrc'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # unselected - # ---------- - @property - def unselected(self): - """ - The 'unselected' property is an instance of Unselected - that may be specified as: - - An instance of plotly.graph_objs.scatterternary.Unselected - - A dict of string/value properties that will be passed - to the Unselected constructor - - Supported dict properties: - - marker - plotly.graph_objs.scatterternary.unselected.Mar - ker instance or dict with compatible properties - textfont - plotly.graph_objs.scatterternary.unselected.Tex - tfont instance or dict with compatible - properties - - Returns - ------- - plotly.graph_objs.scatterternary.Unselected - """ - return self['unselected'] - - @unselected.setter - def unselected(self, val): - self['unselected'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - a - Sets the quantity of component `a` in each data point. - If `a`, `b`, and `c` are all provided, they need not be - normalized, only the relative values matter. If only - two arrays are provided they must be normalized to - match `ternary.sum`. - asrc - Sets the source reference on plot.ly for a . - b - Sets the quantity of component `a` in each data point. - If `a`, `b`, and `c` are all provided, they need not be - normalized, only the relative values matter. If only - two arrays are provided they must be normalized to - match `ternary.sum`. - bsrc - Sets the source reference on plot.ly for b . - c - Sets the quantity of component `a` in each data point. - If `a`, `b`, and `c` are all provided, they need not be - normalized, only the relative values matter. If only - two arrays are provided they must be normalized to - match `ternary.sum`. - cliponaxis - Determines whether or not markers and text nodes are - clipped about the subplot axes. To show markers and - text nodes above axis lines and tick labels, make sure - to set `xaxis.layer` and `yaxis.layer` to *below - traces*. - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - csrc - Sets the source reference on plot.ly for c . - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - fill - Sets the area to fill with a solid color. Use with - `fillcolor` if not "none". scatterternary has a subset - of the options available to scatter. "toself" connects - the endpoints of the trace (or each segment of the - trace if it has gaps) into a closed shape. "tonext" - fills the space between two traces if one completely - encloses the other (eg consecutive contour lines), and - behaves like "toself" if there is no trace before it. - "tonext" should not be used if one trace does not - enclose the other. - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scatterternary.Hoverlabel instance or - dict with compatible properties - hoveron - Do the hover effects highlight individual points - (markers or line points) or do they highlight filled - regions? If the fill is "toself" or "tonext" and there - are no markers or text, then the default is "fills", - otherwise it is "points". - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (a,b,c) - point. If a single string, the same string appears over - all the data points. If an array of strings, the items - are mapped in order to the the data points in (a,b,c). - To be seen, trace `hoverinfo` must contain a "text" - flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scatterternary.Line instance or dict - with compatible properties - marker - plotly.graph_objs.scatterternary.Marker instance or - dict with compatible properties - mode - Determines the drawing mode for this scatter trace. If - the provided `mode` includes "text" then the `text` - elements appear at the coordinates. Otherwise, the - `text` elements appear on hover. If there are less than - 20 points and the trace is not stacked then the default - is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.scatterternary.Selected instance or - dict with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.scatterternary.Stream instance or - dict with compatible properties - subplot - Sets a reference between this trace's data coordinates - and a ternary subplot. If "ternary" (the default - value), the data refer to `layout.ternary`. If - "ternary2", the data refer to `layout.ternary2`, and so - on. - sum - The number each triplet should sum to, if only two of - `a`, `b`, and `c` are provided. This overrides - `ternary.sum` to normalize this specific trace, but - does not affect the values displayed on the axes. 0 (or - missing) means to use ternary.sum - text - Sets text elements associated with each (a,b,c) point. - If a single string, the same string appears over all - the data points. If an array of strings, the items are - mapped in order to the the data points in (a,b,c). If - trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.scatterternary.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - """ - - def __init__( - self, - arg=None, - a=None, - asrc=None, - b=None, - bsrc=None, - c=None, - cliponaxis=None, - connectgaps=None, - csrc=None, - customdata=None, - customdatasrc=None, - fill=None, - fillcolor=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hoveron=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - legendgroup=None, - line=None, - marker=None, - mode=None, - name=None, - opacity=None, - selected=None, - selectedpoints=None, - showlegend=None, - stream=None, - subplot=None, - sum=None, - text=None, - textfont=None, - textposition=None, - textpositionsrc=None, - textsrc=None, - uid=None, - uirevision=None, - unselected=None, - visible=None, - **kwargs - ): - """ - Construct a new Scatterternary object - - Provides similar functionality to the "scatter" type but on a - ternary phase diagram. The data is provided by at least two - arrays out of `a`, `b`, `c` triplets. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Scatterternary - a - Sets the quantity of component `a` in each data point. - If `a`, `b`, and `c` are all provided, they need not be - normalized, only the relative values matter. If only - two arrays are provided they must be normalized to - match `ternary.sum`. - asrc - Sets the source reference on plot.ly for a . - b - Sets the quantity of component `a` in each data point. - If `a`, `b`, and `c` are all provided, they need not be - normalized, only the relative values matter. If only - two arrays are provided they must be normalized to - match `ternary.sum`. - bsrc - Sets the source reference on plot.ly for b . - c - Sets the quantity of component `a` in each data point. - If `a`, `b`, and `c` are all provided, they need not be - normalized, only the relative values matter. If only - two arrays are provided they must be normalized to - match `ternary.sum`. - cliponaxis - Determines whether or not markers and text nodes are - clipped about the subplot axes. To show markers and - text nodes above axis lines and tick labels, make sure - to set `xaxis.layer` and `yaxis.layer` to *below - traces*. - connectgaps - Determines whether or not gaps (i.e. {nan} or missing - values) in the provided data arrays are connected. - csrc - Sets the source reference on plot.ly for c . - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - fill - Sets the area to fill with a solid color. Use with - `fillcolor` if not "none". scatterternary has a subset - of the options available to scatter. "toself" connects - the endpoints of the trace (or each segment of the - trace if it has gaps) into a closed shape. "tonext" - fills the space between two traces if one completely - encloses the other (eg consecutive contour lines), and - behaves like "toself" if there is no trace before it. - "tonext" should not be used if one trace does not - enclose the other. - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.scatterternary.Hoverlabel instance or - dict with compatible properties - hoveron - Do the hover effects highlight individual points - (markers or line points) or do they highlight filled - regions? If the fill is "toself" or "tonext" and there - are no markers or text, then the default is "fills", - otherwise it is "points". - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Sets hover text elements associated with each (a,b,c) - point. If a single string, the same string appears over - all the data points. If an array of strings, the items - are mapped in order to the the data points in (a,b,c). - To be seen, trace `hoverinfo` must contain a "text" - flag. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.scatterternary.Line instance or dict - with compatible properties - marker - plotly.graph_objs.scatterternary.Marker instance or - dict with compatible properties - mode - Determines the drawing mode for this scatter trace. If - the provided `mode` includes "text" then the `text` - elements appear at the coordinates. Otherwise, the - `text` elements appear on hover. If there are less than - 20 points and the trace is not stacked then the default - is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.scatterternary.Selected instance or - dict with compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.scatterternary.Stream instance or - dict with compatible properties - subplot - Sets a reference between this trace's data coordinates - and a ternary subplot. If "ternary" (the default - value), the data refer to `layout.ternary`. If - "ternary2", the data refer to `layout.ternary2`, and so - on. - sum - The number each triplet should sum to, if only two of - `a`, `b`, and `c` are provided. This overrides - `ternary.sum` to normalize this specific trace, but - does not affect the values displayed on the axes. 0 (or - missing) means to use ternary.sum - text - Sets text elements associated with each (a,b,c) point. - If a single string, the same string appears over all - the data points. If an array of strings, the items are - mapped in order to the the data points in (a,b,c). If - trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for textposition - . - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.scatterternary.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - - Returns - ------- - Scatterternary - """ - super(Scatterternary, self).__init__('scatterternary') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Scatterternary -constructor must be a dict or -an instance of plotly.graph_objs.Scatterternary""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (scatterternary as v_scatterternary) - - # Initialize validators - # --------------------- - self._validators['a'] = v_scatterternary.AValidator() - self._validators['asrc'] = v_scatterternary.AsrcValidator() - self._validators['b'] = v_scatterternary.BValidator() - self._validators['bsrc'] = v_scatterternary.BsrcValidator() - self._validators['c'] = v_scatterternary.CValidator() - self._validators['cliponaxis'] = v_scatterternary.CliponaxisValidator() - self._validators['connectgaps' - ] = v_scatterternary.ConnectgapsValidator() - self._validators['csrc'] = v_scatterternary.CsrcValidator() - self._validators['customdata'] = v_scatterternary.CustomdataValidator() - self._validators['customdatasrc' - ] = v_scatterternary.CustomdatasrcValidator() - self._validators['fill'] = v_scatterternary.FillValidator() - self._validators['fillcolor'] = v_scatterternary.FillcolorValidator() - self._validators['hoverinfo'] = v_scatterternary.HoverinfoValidator() - self._validators['hoverinfosrc' - ] = v_scatterternary.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_scatterternary.HoverlabelValidator() - self._validators['hoveron'] = v_scatterternary.HoveronValidator() - self._validators['hovertemplate' - ] = v_scatterternary.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_scatterternary.HovertemplatesrcValidator() - self._validators['hovertext'] = v_scatterternary.HovertextValidator() - self._validators['hovertextsrc' - ] = v_scatterternary.HovertextsrcValidator() - self._validators['ids'] = v_scatterternary.IdsValidator() - self._validators['idssrc'] = v_scatterternary.IdssrcValidator() - self._validators['legendgroup' - ] = v_scatterternary.LegendgroupValidator() - self._validators['line'] = v_scatterternary.LineValidator() - self._validators['marker'] = v_scatterternary.MarkerValidator() - self._validators['mode'] = v_scatterternary.ModeValidator() - self._validators['name'] = v_scatterternary.NameValidator() - self._validators['opacity'] = v_scatterternary.OpacityValidator() - self._validators['selected'] = v_scatterternary.SelectedValidator() - self._validators['selectedpoints' - ] = v_scatterternary.SelectedpointsValidator() - self._validators['showlegend'] = v_scatterternary.ShowlegendValidator() - self._validators['stream'] = v_scatterternary.StreamValidator() - self._validators['subplot'] = v_scatterternary.SubplotValidator() - self._validators['sum'] = v_scatterternary.SumValidator() - self._validators['text'] = v_scatterternary.TextValidator() - self._validators['textfont'] = v_scatterternary.TextfontValidator() - self._validators['textposition' - ] = v_scatterternary.TextpositionValidator() - self._validators['textpositionsrc' - ] = v_scatterternary.TextpositionsrcValidator() - self._validators['textsrc'] = v_scatterternary.TextsrcValidator() - self._validators['uid'] = v_scatterternary.UidValidator() - self._validators['uirevision'] = v_scatterternary.UirevisionValidator() - self._validators['unselected'] = v_scatterternary.UnselectedValidator() - self._validators['visible'] = v_scatterternary.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('a', None) - self['a'] = a if a is not None else _v - _v = arg.pop('asrc', None) - self['asrc'] = asrc if asrc is not None else _v - _v = arg.pop('b', None) - self['b'] = b if b is not None else _v - _v = arg.pop('bsrc', None) - self['bsrc'] = bsrc if bsrc is not None else _v - _v = arg.pop('c', None) - self['c'] = c if c is not None else _v - _v = arg.pop('cliponaxis', None) - self['cliponaxis'] = cliponaxis if cliponaxis is not None else _v - _v = arg.pop('connectgaps', None) - self['connectgaps'] = connectgaps if connectgaps is not None else _v - _v = arg.pop('csrc', None) - self['csrc'] = csrc if csrc is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('fillcolor', None) - self['fillcolor'] = fillcolor if fillcolor is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hoveron', None) - self['hoveron'] = hoveron if hoveron is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('mode', None) - self['mode'] = mode if mode is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('selected', None) - self['selected'] = selected if selected is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('subplot', None) - self['subplot'] = subplot if subplot is not None else _v - _v = arg.pop('sum', None) - self['sum'] = sum if sum is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - _v = arg.pop('textposition', None) - self['textposition'] = textposition if textposition is not None else _v - _v = arg.pop('textpositionsrc', None) - self['textpositionsrc' - ] = textpositionsrc if textpositionsrc is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('unselected', None) - self['unselected'] = unselected if unselected is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'scatterternary' - self._validators['type'] = LiteralValidator( - plotly_name='type', - parent_name='scatterternary', - val='scatterternary' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_splom.py b/plotly/graph_objs/_splom.py deleted file mode 100644 index 7907e70df2c..00000000000 --- a/plotly/graph_objs/_splom.py +++ /dev/null @@ -1,1476 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Splom(BaseTraceType): - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # diagonal - # -------- - @property - def diagonal(self): - """ - The 'diagonal' property is an instance of Diagonal - that may be specified as: - - An instance of plotly.graph_objs.splom.Diagonal - - A dict of string/value properties that will be passed - to the Diagonal constructor - - Supported dict properties: - - visible - Determines whether or not subplots on the - diagonal are displayed. - - Returns - ------- - plotly.graph_objs.splom.Diagonal - """ - return self['diagonal'] - - @diagonal.setter - def diagonal(self, val): - self['diagonal'] = val - - # dimensions - # ---------- - @property - def dimensions(self): - """ - The 'dimensions' property is a tuple of instances of - Dimension that may be specified as: - - A list or tuple of instances of plotly.graph_objs.splom.Dimension - - A list or tuple of dicts of string/value properties that - will be passed to the Dimension constructor - - Supported dict properties: - - axis - plotly.graph_objs.splom.dimension.Axis instance - or dict with compatible properties - label - Sets the label corresponding to this splom - dimension. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - values - Sets the dimension values to be plotted. - valuessrc - Sets the source reference on plot.ly for - values . - visible - Determines whether or not this dimension is - shown on the graph. Note that even visible - false dimension contribute to the default grid - generate by this splom trace. - - Returns - ------- - tuple[plotly.graph_objs.splom.Dimension] - """ - return self['dimensions'] - - @dimensions.setter - def dimensions(self, val): - self['dimensions'] = val - - # dimensiondefaults - # ----------------- - @property - 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 plotly.graph_objs.splom.Dimension - - A dict of string/value properties that will be passed - to the Dimension constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.splom.Dimension - """ - return self['dimensiondefaults'] - - @dimensiondefaults.setter - def dimensiondefaults(self, val): - self['dimensiondefaults'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.splom.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.splom.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.splom.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - line - plotly.graph_objs.splom.marker.Line instance or - dict with compatible properties - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . - - Returns - ------- - plotly.graph_objs.splom.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # selected - # -------- - @property - def selected(self): - """ - The 'selected' property is an instance of Selected - that may be specified as: - - An instance of plotly.graph_objs.splom.Selected - - A dict of string/value properties that will be passed - to the Selected constructor - - Supported dict properties: - - marker - plotly.graph_objs.splom.selected.Marker - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.splom.Selected - """ - return self['selected'] - - @selected.setter - def selected(self, val): - self['selected'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # showlowerhalf - # ------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlowerhalf'] - - @showlowerhalf.setter - def showlowerhalf(self, val): - self['showlowerhalf'] = val - - # showupperhalf - # ------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showupperhalf'] - - @showupperhalf.setter - def showupperhalf(self, val): - self['showupperhalf'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.splom.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.splom.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - def text(self): - """ - Sets text elements associated with each (x,y) pair to appear on - hover. If a single string, the same string appears over all the - data points. If an array of string, the items are mapped in - order to the this trace's (x,y) coordinates. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # unselected - # ---------- - @property - def unselected(self): - """ - The 'unselected' property is an instance of Unselected - that may be specified as: - - An instance of plotly.graph_objs.splom.Unselected - - A dict of string/value properties that will be passed - to the Unselected constructor - - Supported dict properties: - - marker - plotly.graph_objs.splom.unselected.Marker - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.splom.Unselected - """ - return self['unselected'] - - @unselected.setter - def unselected(self, val): - self['unselected'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # xaxes - # ----- - @property - def xaxes(self): - """ - Sets the list of x axes corresponding to dimensions of this - splom trace. By default, a splom will match the first N xaxes - where N is the number of input dimensions. Note that, in case - where `diagonal.visible` is false and `showupperhalf` or - `showlowerhalf` is false, this splom trace will generate one - less x-axis and one less y-axis. - - The 'xaxes' property is an info array that may be specified as: - * a list of elements where: - The 'xaxes[i]' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - list - """ - return self['xaxes'] - - @xaxes.setter - def xaxes(self, val): - self['xaxes'] = val - - # yaxes - # ----- - @property - def yaxes(self): - """ - Sets the list of y axes corresponding to dimensions of this - splom trace. By default, a splom will match the first N yaxes - where N is the number of input dimensions. Note that, in case - where `diagonal.visible` is false and `showupperhalf` or - `showlowerhalf` is false, this splom trace will generate one - less x-axis and one less y-axis. - - The 'yaxes' property is an info array that may be specified as: - * a list of elements where: - The 'yaxes[i]' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - list - """ - return self['yaxes'] - - @yaxes.setter - def yaxes(self, val): - self['yaxes'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - diagonal - plotly.graph_objs.splom.Diagonal instance or dict with - compatible properties - dimensions - plotly.graph_objs.splom.Dimension instance or dict with - compatible properties - dimensiondefaults - When used in a template (as - layout.template.data.splom.dimensiondefaults), sets the - default property values to use for elements of - splom.dimensions - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.splom.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - marker - plotly.graph_objs.splom.Marker instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.splom.Selected instance or dict with - compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showlowerhalf - Determines whether or not subplots on the lower half - from the diagonal are displayed. - showupperhalf - Determines whether or not subplots on the upper half - from the diagonal are displayed. - stream - plotly.graph_objs.splom.Stream instance or dict with - compatible properties - text - Sets text elements associated with each (x,y) pair to - appear on hover. If a single string, the same string - appears over all the data points. If an array of - string, the items are mapped in order to the this - trace's (x,y) coordinates. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.splom.Unselected instance or dict - with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - xaxes - Sets the list of x axes corresponding to dimensions of - this splom trace. By default, a splom will match the - first N xaxes where N is the number of input - dimensions. Note that, in case where `diagonal.visible` - is false and `showupperhalf` or `showlowerhalf` is - false, this splom trace will generate one less x-axis - and one less y-axis. - yaxes - Sets the list of y axes corresponding to dimensions of - this splom trace. By default, a splom will match the - first N yaxes where N is the number of input - dimensions. Note that, in case where `diagonal.visible` - is false and `showupperhalf` or `showlowerhalf` is - false, this splom trace will generate one less x-axis - and one less y-axis. - """ - - def __init__( - self, - arg=None, - customdata=None, - customdatasrc=None, - diagonal=None, - dimensions=None, - dimensiondefaults=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - legendgroup=None, - marker=None, - name=None, - opacity=None, - selected=None, - selectedpoints=None, - showlegend=None, - showlowerhalf=None, - showupperhalf=None, - stream=None, - text=None, - textsrc=None, - uid=None, - uirevision=None, - unselected=None, - visible=None, - xaxes=None, - yaxes=None, - **kwargs - ): - """ - Construct a new Splom object - - Splom traces generate scatter plot matrix visualizations. Each - splom `dimensions` items correspond to a generated axis. Values - for each of those dimensions are set in `dimensions[i].values`. - Splom traces support all `scattergl` marker style attributes. - Specify `layout.grid` attributes and/or layout x-axis and - y-axis attributes for more control over the axis positioning - and style. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Splom - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - diagonal - plotly.graph_objs.splom.Diagonal instance or dict with - compatible properties - dimensions - plotly.graph_objs.splom.Dimension instance or dict with - compatible properties - dimensiondefaults - When used in a template (as - layout.template.data.splom.dimensiondefaults), sets the - default property values to use for elements of - splom.dimensions - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.splom.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - marker - plotly.graph_objs.splom.Marker instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.splom.Selected instance or dict with - compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showlowerhalf - Determines whether or not subplots on the lower half - from the diagonal are displayed. - showupperhalf - Determines whether or not subplots on the upper half - from the diagonal are displayed. - stream - plotly.graph_objs.splom.Stream instance or dict with - compatible properties - text - Sets text elements associated with each (x,y) pair to - appear on hover. If a single string, the same string - appears over all the data points. If an array of - string, the items are mapped in order to the this - trace's (x,y) coordinates. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.splom.Unselected instance or dict - with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - xaxes - Sets the list of x axes corresponding to dimensions of - this splom trace. By default, a splom will match the - first N xaxes where N is the number of input - dimensions. Note that, in case where `diagonal.visible` - is false and `showupperhalf` or `showlowerhalf` is - false, this splom trace will generate one less x-axis - and one less y-axis. - yaxes - Sets the list of y axes corresponding to dimensions of - this splom trace. By default, a splom will match the - first N yaxes where N is the number of input - dimensions. Note that, in case where `diagonal.visible` - is false and `showupperhalf` or `showlowerhalf` is - false, this splom trace will generate one less x-axis - and one less y-axis. - - Returns - ------- - Splom - """ - super(Splom, self).__init__('splom') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Splom -constructor must be a dict or -an instance of plotly.graph_objs.Splom""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (splom as v_splom) - - # Initialize validators - # --------------------- - self._validators['customdata'] = v_splom.CustomdataValidator() - self._validators['customdatasrc'] = v_splom.CustomdatasrcValidator() - self._validators['diagonal'] = v_splom.DiagonalValidator() - self._validators['dimensions'] = v_splom.DimensionsValidator() - self._validators['dimensiondefaults'] = v_splom.DimensionValidator() - self._validators['hoverinfo'] = v_splom.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_splom.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_splom.HoverlabelValidator() - self._validators['hovertemplate'] = v_splom.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_splom.HovertemplatesrcValidator() - self._validators['hovertext'] = v_splom.HovertextValidator() - self._validators['hovertextsrc'] = v_splom.HovertextsrcValidator() - self._validators['ids'] = v_splom.IdsValidator() - self._validators['idssrc'] = v_splom.IdssrcValidator() - self._validators['legendgroup'] = v_splom.LegendgroupValidator() - self._validators['marker'] = v_splom.MarkerValidator() - self._validators['name'] = v_splom.NameValidator() - self._validators['opacity'] = v_splom.OpacityValidator() - self._validators['selected'] = v_splom.SelectedValidator() - self._validators['selectedpoints'] = v_splom.SelectedpointsValidator() - self._validators['showlegend'] = v_splom.ShowlegendValidator() - self._validators['showlowerhalf'] = v_splom.ShowlowerhalfValidator() - self._validators['showupperhalf'] = v_splom.ShowupperhalfValidator() - self._validators['stream'] = v_splom.StreamValidator() - self._validators['text'] = v_splom.TextValidator() - self._validators['textsrc'] = v_splom.TextsrcValidator() - self._validators['uid'] = v_splom.UidValidator() - self._validators['uirevision'] = v_splom.UirevisionValidator() - self._validators['unselected'] = v_splom.UnselectedValidator() - self._validators['visible'] = v_splom.VisibleValidator() - self._validators['xaxes'] = v_splom.XaxesValidator() - self._validators['yaxes'] = v_splom.YaxesValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('diagonal', None) - self['diagonal'] = diagonal if diagonal is not None else _v - _v = arg.pop('dimensions', None) - self['dimensions'] = dimensions if dimensions is not None else _v - _v = arg.pop('dimensiondefaults', None) - self['dimensiondefaults' - ] = dimensiondefaults if dimensiondefaults is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('selected', None) - self['selected'] = selected if selected is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('showlowerhalf', None) - self['showlowerhalf' - ] = showlowerhalf if showlowerhalf is not None else _v - _v = arg.pop('showupperhalf', None) - self['showupperhalf' - ] = showupperhalf if showupperhalf is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('unselected', None) - self['unselected'] = unselected if unselected is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('xaxes', None) - self['xaxes'] = xaxes if xaxes is not None else _v - _v = arg.pop('yaxes', None) - self['yaxes'] = yaxes if yaxes is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'splom' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='splom', val='splom' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_streamtube.py b/plotly/graph_objs/_streamtube.py deleted file mode 100644 index 99aaca316b2..00000000000 --- a/plotly/graph_objs/_streamtube.py +++ /dev/null @@ -1,2063 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Streamtube(BaseTraceType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be chosen - according to whether numbers in the `color` array are all - positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here u/v/w norm) or the bounds set - in `cmin` and `cmax` Defaults to `false` when `cmin` and - `cmax` are set by the user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - 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 u/v/w norm. Has no effect when `cauto` is - `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of plotly.graph_objs.streamtube.ColorBar - - A dict of string/value properties that will be passed - to the ColorBar constructor - - Supported dict properties: - - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.streamtube.colorbar.Tickforma - tstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.streamtube.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of streamtube.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.streamtube.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - streamtube.colorbar.title.font instead. Sets - this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - streamtube.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.streamtube.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. The colorscale must be an array containing - arrays mapping a normalized value to an rgb, rgba, hex, hsl, - hsv, or named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.streamtube.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.streamtube.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - variables `tubex`, `tubey`, `tubez`, `tubeu`, `tubev`, `tubew`, - `norm` and `divergence`. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - 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 - - Returns - ------- - str - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # lighting - # -------- - @property - def lighting(self): - """ - The 'lighting' property is an instance of Lighting - that may be specified as: - - An instance of plotly.graph_objs.streamtube.Lighting - - A dict of string/value properties that will be passed - to the Lighting constructor - - Supported dict properties: - - ambient - Ambient light increases overall color - visibility but can wash out the image. - diffuse - Represents the extent that incident rays are - reflected in a range of angles. - facenormalsepsilon - Epsilon for face normals calculation avoids - math issues arising from degenerate geometry. - fresnel - Represents the reflectance as a dependency of - the viewing angle; e.g. paper is reflective - when viewing it from the edge of the paper - (almost 90 degrees), causing shine. - roughness - Alters specular reflection; the rougher the - surface, the wider and less contrasty the - shine. - specular - Represents the level that incident rays are - reflected in a single direction, causing shine. - vertexnormalsepsilon - Epsilon for vertex normals calculation avoids - math issues arising from degenerate geometry. - - Returns - ------- - plotly.graph_objs.streamtube.Lighting - """ - return self['lighting'] - - @lighting.setter - def lighting(self, val): - self['lighting'] = val - - # lightposition - # ------------- - @property - def lightposition(self): - """ - The 'lightposition' property is an instance of Lightposition - that may be specified as: - - An instance of plotly.graph_objs.streamtube.Lightposition - - A dict of string/value properties that will be passed - to the Lightposition constructor - - Supported dict properties: - - x - Numeric vector, representing the X coordinate - for each vertex. - y - Numeric vector, representing the Y coordinate - for each vertex. - z - Numeric vector, representing the Z coordinate - for each vertex. - - Returns - ------- - plotly.graph_objs.streamtube.Lightposition - """ - return self['lightposition'] - - @lightposition.setter - def lightposition(self, val): - self['lightposition'] = val - - # maxdisplayed - # ------------ - @property - 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] - - Returns - ------- - int - """ - return self['maxdisplayed'] - - @maxdisplayed.setter - def maxdisplayed(self, val): - self['maxdisplayed'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - def opacity(self): - """ - Sets the opacity of the surface. Please note that in the case - of using high `opacity` values for example a value greater than - or equal to 0.5 on two surfaces (and 0.25 with four surfaces), - an overlay of multiple transparent surfaces may not perfectly - be sorted in depth by the webgl API. This behavior may be - improved in the near future and is subject to change. - - The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # reversescale - # ------------ - @property - 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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # scene - # ----- - @property - def scene(self): - """ - Sets a reference between this trace's 3D coordinate system and - a 3D scene. If "scene" (the default value), the (x,y,z) - coordinates refer to `layout.scene`. If "scene2", the (x,y,z) - coordinates refer to `layout.scene2`, and so on. - - The 'scene' property is an identifier of a particular - subplot, of type 'scene', that may be specified as the string 'scene' - optionally followed by an integer >= 1 - (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) - - Returns - ------- - str - """ - return self['scene'] - - @scene.setter - def scene(self, val): - self['scene'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # sizeref - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['sizeref'] - - @sizeref.setter - def sizeref(self, val): - self['sizeref'] = val - - # starts - # ------ - @property - def starts(self): - """ - The 'starts' property is an instance of Starts - that may be specified as: - - An instance of plotly.graph_objs.streamtube.Starts - - A dict of string/value properties that will be passed - to the Starts constructor - - Supported dict properties: - - x - Sets the x components of the starting position - of the streamtubes - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y components of the starting position - of the streamtubes - ysrc - Sets the source reference on plot.ly for y . - z - Sets the z components of the starting position - of the streamtubes - zsrc - Sets the source reference on plot.ly for z . - - Returns - ------- - plotly.graph_objs.streamtube.Starts - """ - return self['starts'] - - @starts.setter - def starts(self, val): - self['starts'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.streamtube.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.streamtube.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - def text(self): - """ - Sets a text element associated with this trace. If trace - `hoverinfo` contains a "text" flag, this text element will be - seen in all hover labels. Note that streamtube traces do not - support array `text` values. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # u - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['u'] - - @u.setter - def u(self, val): - self['u'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # usrc - # ---- - @property - def usrc(self): - """ - Sets the source reference on plot.ly for u . - - The 'usrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['usrc'] - - @usrc.setter - def usrc(self, val): - self['usrc'] = val - - # v - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['v'] - - @v.setter - def v(self, val): - self['v'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # vsrc - # ---- - @property - def vsrc(self): - """ - Sets the source reference on plot.ly for v . - - The 'vsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['vsrc'] - - @vsrc.setter - def vsrc(self, val): - self['vsrc'] = val - - # w - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['w'] - - @w.setter - def w(self, val): - self['w'] = val - - # wsrc - # ---- - @property - def wsrc(self): - """ - Sets the source reference on plot.ly for w . - - The 'wsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['wsrc'] - - @wsrc.setter - def wsrc(self, val): - self['wsrc'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # z - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # zsrc - # ---- - @property - def zsrc(self): - """ - Sets the source reference on plot.ly for z . - - The 'zsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['zsrc'] - - @zsrc.setter - def zsrc(self, val): - self['zsrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here u/v/w norm) or the - bounds set in `cmin` and `cmax` Defaults to `false` - when `cmin` and `cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Value should - have the same units as u/v/w norm and if set, `cmin` - must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `cmin` and/or `cmax` to be equidistant to this point. - Value should have the same units as u/v/w norm. Has no - effect when `cauto` is `false`. - cmin - Sets the lower bound of the color domain. Value should - have the same units as u/v/w norm and if set, `cmax` - must be set as well. - colorbar - plotly.graph_objs.streamtube.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.streamtube.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variables `tubex`, `tubey`, `tubez`, - `tubeu`, `tubev`, `tubew`, `norm` and `divergence`. - Anything contained in tag `` is displayed in the - secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - lighting - plotly.graph_objs.streamtube.Lighting instance or dict - with compatible properties - lightposition - plotly.graph_objs.streamtube.Lightposition instance or - dict with compatible properties - maxdisplayed - The maximum number of displayed segments in a - streamtube. - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the surface. Please note that in - the case of using high `opacity` values for example a - value greater than or equal to 0.5 on two surfaces (and - 0.25 with four surfaces), an overlay of multiple - transparent surfaces may not perfectly be sorted in - depth by the webgl API. This behavior may be improved - in the near future and is subject to change. - reversescale - Reverses the color mapping if true. If true, `cmin` - will correspond to the last color in the array and - `cmax` will correspond to the first color. - scene - Sets a reference between this trace's 3D coordinate - system and a 3D scene. If "scene" (the default value), - the (x,y,z) coordinates refer to `layout.scene`. If - "scene2", the (x,y,z) coordinates refer to - `layout.scene2`, and so on. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - sizeref - The scaling factor for the streamtubes. The default is - 1, which avoids two max divergence tubes from touching - at adjacent starting positions. - starts - plotly.graph_objs.streamtube.Starts instance or dict - with compatible properties - stream - plotly.graph_objs.streamtube.Stream instance or dict - with compatible properties - text - Sets a text element associated with this trace. If - trace `hoverinfo` contains a "text" flag, this text - element will be seen in all hover labels. Note that - streamtube traces do not support array `text` values. - u - Sets the x components of the vector field. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - usrc - Sets the source reference on plot.ly for u . - v - Sets the y components of the vector field. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - vsrc - Sets the source reference on plot.ly for v . - w - Sets the z components of the vector field. - wsrc - Sets the source reference on plot.ly for w . - x - Sets the x coordinates of the vector field. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates of the vector field. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the z coordinates of the vector field. - zsrc - Sets the source reference on plot.ly for z . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - colorbar=None, - colorscale=None, - customdata=None, - customdatasrc=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - ids=None, - idssrc=None, - legendgroup=None, - lighting=None, - lightposition=None, - maxdisplayed=None, - name=None, - opacity=None, - reversescale=None, - scene=None, - selectedpoints=None, - showlegend=None, - showscale=None, - sizeref=None, - starts=None, - stream=None, - text=None, - u=None, - uid=None, - uirevision=None, - usrc=None, - v=None, - visible=None, - vsrc=None, - w=None, - wsrc=None, - x=None, - xsrc=None, - y=None, - ysrc=None, - z=None, - zsrc=None, - **kwargs - ): - """ - Construct a new Streamtube object - - Use a streamtube trace to visualize flow in a vector field. - Specify a vector field using 6 1D arrays of equal length, 3 - position arrays `x`, `y` and `z` and 3 vector component arrays - `u`, `v`, and `w`. By default, the tubes' starting positions - will be cut from the vector field's x-z plane at its minimum y - value. To specify your own starting position, use attributes - `starts.x`, `starts.y` and `starts.z`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Streamtube - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here u/v/w norm) or the - bounds set in `cmin` and `cmax` Defaults to `false` - when `cmin` and `cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Value should - have the same units as u/v/w norm and if set, `cmin` - must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `cmin` and/or `cmax` to be equidistant to this point. - Value should have the same units as u/v/w norm. Has no - effect when `cauto` is `false`. - cmin - Sets the lower bound of the color domain. Value should - have the same units as u/v/w norm and if set, `cmax` - must be set as well. - colorbar - plotly.graph_objs.streamtube.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.streamtube.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variables `tubex`, `tubey`, `tubez`, - `tubeu`, `tubev`, `tubew`, `norm` and `divergence`. - Anything contained in tag `` is displayed in the - secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - lighting - plotly.graph_objs.streamtube.Lighting instance or dict - with compatible properties - lightposition - plotly.graph_objs.streamtube.Lightposition instance or - dict with compatible properties - maxdisplayed - The maximum number of displayed segments in a - streamtube. - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the surface. Please note that in - the case of using high `opacity` values for example a - value greater than or equal to 0.5 on two surfaces (and - 0.25 with four surfaces), an overlay of multiple - transparent surfaces may not perfectly be sorted in - depth by the webgl API. This behavior may be improved - in the near future and is subject to change. - reversescale - Reverses the color mapping if true. If true, `cmin` - will correspond to the last color in the array and - `cmax` will correspond to the first color. - scene - Sets a reference between this trace's 3D coordinate - system and a 3D scene. If "scene" (the default value), - the (x,y,z) coordinates refer to `layout.scene`. If - "scene2", the (x,y,z) coordinates refer to - `layout.scene2`, and so on. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - sizeref - The scaling factor for the streamtubes. The default is - 1, which avoids two max divergence tubes from touching - at adjacent starting positions. - starts - plotly.graph_objs.streamtube.Starts instance or dict - with compatible properties - stream - plotly.graph_objs.streamtube.Stream instance or dict - with compatible properties - text - Sets a text element associated with this trace. If - trace `hoverinfo` contains a "text" flag, this text - element will be seen in all hover labels. Note that - streamtube traces do not support array `text` values. - u - Sets the x components of the vector field. - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - usrc - Sets the source reference on plot.ly for u . - v - Sets the y components of the vector field. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - vsrc - Sets the source reference on plot.ly for v . - w - Sets the z components of the vector field. - wsrc - Sets the source reference on plot.ly for w . - x - Sets the x coordinates of the vector field. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates of the vector field. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the z coordinates of the vector field. - zsrc - Sets the source reference on plot.ly for z . - - Returns - ------- - Streamtube - """ - super(Streamtube, self).__init__('streamtube') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Streamtube -constructor must be a dict or -an instance of plotly.graph_objs.Streamtube""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (streamtube as v_streamtube) - - # Initialize validators - # --------------------- - self._validators['autocolorscale' - ] = v_streamtube.AutocolorscaleValidator() - self._validators['cauto'] = v_streamtube.CautoValidator() - self._validators['cmax'] = v_streamtube.CmaxValidator() - self._validators['cmid'] = v_streamtube.CmidValidator() - self._validators['cmin'] = v_streamtube.CminValidator() - self._validators['colorbar'] = v_streamtube.ColorBarValidator() - self._validators['colorscale'] = v_streamtube.ColorscaleValidator() - self._validators['customdata'] = v_streamtube.CustomdataValidator() - self._validators['customdatasrc' - ] = v_streamtube.CustomdatasrcValidator() - self._validators['hoverinfo'] = v_streamtube.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_streamtube.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_streamtube.HoverlabelValidator() - self._validators['hovertemplate' - ] = v_streamtube.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_streamtube.HovertemplatesrcValidator() - self._validators['hovertext'] = v_streamtube.HovertextValidator() - self._validators['ids'] = v_streamtube.IdsValidator() - self._validators['idssrc'] = v_streamtube.IdssrcValidator() - self._validators['legendgroup'] = v_streamtube.LegendgroupValidator() - self._validators['lighting'] = v_streamtube.LightingValidator() - self._validators['lightposition' - ] = v_streamtube.LightpositionValidator() - self._validators['maxdisplayed'] = v_streamtube.MaxdisplayedValidator() - self._validators['name'] = v_streamtube.NameValidator() - self._validators['opacity'] = v_streamtube.OpacityValidator() - self._validators['reversescale'] = v_streamtube.ReversescaleValidator() - self._validators['scene'] = v_streamtube.SceneValidator() - self._validators['selectedpoints' - ] = v_streamtube.SelectedpointsValidator() - self._validators['showlegend'] = v_streamtube.ShowlegendValidator() - self._validators['showscale'] = v_streamtube.ShowscaleValidator() - self._validators['sizeref'] = v_streamtube.SizerefValidator() - self._validators['starts'] = v_streamtube.StartsValidator() - self._validators['stream'] = v_streamtube.StreamValidator() - self._validators['text'] = v_streamtube.TextValidator() - self._validators['u'] = v_streamtube.UValidator() - self._validators['uid'] = v_streamtube.UidValidator() - self._validators['uirevision'] = v_streamtube.UirevisionValidator() - self._validators['usrc'] = v_streamtube.UsrcValidator() - self._validators['v'] = v_streamtube.VValidator() - self._validators['visible'] = v_streamtube.VisibleValidator() - self._validators['vsrc'] = v_streamtube.VsrcValidator() - self._validators['w'] = v_streamtube.WValidator() - self._validators['wsrc'] = v_streamtube.WsrcValidator() - self._validators['x'] = v_streamtube.XValidator() - self._validators['xsrc'] = v_streamtube.XsrcValidator() - self._validators['y'] = v_streamtube.YValidator() - self._validators['ysrc'] = v_streamtube.YsrcValidator() - self._validators['z'] = v_streamtube.ZValidator() - self._validators['zsrc'] = v_streamtube.ZsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('lighting', None) - self['lighting'] = lighting if lighting is not None else _v - _v = arg.pop('lightposition', None) - self['lightposition' - ] = lightposition if lightposition is not None else _v - _v = arg.pop('maxdisplayed', None) - self['maxdisplayed'] = maxdisplayed if maxdisplayed is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('scene', None) - self['scene'] = scene if scene is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('sizeref', None) - self['sizeref'] = sizeref if sizeref is not None else _v - _v = arg.pop('starts', None) - self['starts'] = starts if starts is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('u', None) - self['u'] = u if u is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('usrc', None) - self['usrc'] = usrc if usrc is not None else _v - _v = arg.pop('v', None) - self['v'] = v if v is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('vsrc', None) - self['vsrc'] = vsrc if vsrc is not None else _v - _v = arg.pop('w', None) - self['w'] = w if w is not None else _v - _v = arg.pop('wsrc', None) - self['wsrc'] = wsrc if wsrc is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - _v = arg.pop('zsrc', None) - self['zsrc'] = zsrc if zsrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'streamtube' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='streamtube', val='streamtube' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_surface.py b/plotly/graph_objs/_surface.py deleted file mode 100644 index a62651830d2..00000000000 --- a/plotly/graph_objs/_surface.py +++ /dev/null @@ -1,2062 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Surface(BaseTraceType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be chosen - according to whether numbers in the `color` array are all - positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here z or surfacecolor) or the - bounds set in `cmin` and `cmax` Defaults to `false` when - `cmin` and `cmax` are set by the user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - 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 z or surfacecolor. Has no effect when `cauto` is - `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of plotly.graph_objs.surface.ColorBar - - A dict of string/value properties that will be passed - to the ColorBar constructor - - Supported dict properties: - - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.surface.colorbar.Tickformatst - op instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.surface.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of surface.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.surface.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - surface.colorbar.title.font instead. Sets this - color bar's title font. Note that the title's - font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use - surface.colorbar.title.side instead. Determines - the location of color bar's title with respect - to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.surface.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. The colorscale must be an array containing - arrays mapping a normalized value to an rgb, rgba, hex, hsl, - hsv, or named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # contours - # -------- - @property - def contours(self): - """ - The 'contours' property is an instance of Contours - that may be specified as: - - An instance of plotly.graph_objs.surface.Contours - - A dict of string/value properties that will be passed - to the Contours constructor - - Supported dict properties: - - x - plotly.graph_objs.surface.contours.X instance - or dict with compatible properties - y - plotly.graph_objs.surface.contours.Y instance - or dict with compatible properties - z - plotly.graph_objs.surface.contours.Z instance - or dict with compatible properties - - Returns - ------- - plotly.graph_objs.surface.Contours - """ - return self['contours'] - - @contours.setter - def contours(self, val): - self['contours'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # hidesurface - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['hidesurface'] - - @hidesurface.setter - def hidesurface(self, val): - self['hidesurface'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.surface.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.surface.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - Anything contained in tag `` is displayed in the - secondary box, for example "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # hovertext - # --------- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # lighting - # -------- - @property - def lighting(self): - """ - The 'lighting' property is an instance of Lighting - that may be specified as: - - An instance of plotly.graph_objs.surface.Lighting - - A dict of string/value properties that will be passed - to the Lighting constructor - - Supported dict properties: - - ambient - Ambient light increases overall color - visibility but can wash out the image. - diffuse - Represents the extent that incident rays are - reflected in a range of angles. - fresnel - Represents the reflectance as a dependency of - the viewing angle; e.g. paper is reflective - when viewing it from the edge of the paper - (almost 90 degrees), causing shine. - roughness - Alters specular reflection; the rougher the - surface, the wider and less contrasty the - shine. - specular - Represents the level that incident rays are - reflected in a single direction, causing shine. - - Returns - ------- - plotly.graph_objs.surface.Lighting - """ - return self['lighting'] - - @lighting.setter - def lighting(self, val): - self['lighting'] = val - - # lightposition - # ------------- - @property - def lightposition(self): - """ - The 'lightposition' property is an instance of Lightposition - that may be specified as: - - An instance of plotly.graph_objs.surface.Lightposition - - A dict of string/value properties that will be passed - to the Lightposition constructor - - Supported dict properties: - - x - Numeric vector, representing the X coordinate - for each vertex. - y - Numeric vector, representing the Y coordinate - for each vertex. - z - Numeric vector, representing the Z coordinate - for each vertex. - - Returns - ------- - plotly.graph_objs.surface.Lightposition - """ - return self['lightposition'] - - @lightposition.setter - def lightposition(self, val): - self['lightposition'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - def opacity(self): - """ - Sets the opacity of the surface. Please note that in the case - of using high `opacity` values for example a value greater than - or equal to 0.5 on two surfaces (and 0.25 with four surfaces), - an overlay of multiple transparent surfaces may not perfectly - be sorted in depth by the webgl API. This behavior may be - improved in the near future and is subject to change. - - The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # reversescale - # ------------ - @property - 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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # scene - # ----- - @property - def scene(self): - """ - Sets a reference between this trace's 3D coordinate system and - a 3D scene. If "scene" (the default value), the (x,y,z) - coordinates refer to `layout.scene`. If "scene2", the (x,y,z) - coordinates refer to `layout.scene2`, and so on. - - The 'scene' property is an identifier of a particular - subplot, of type 'scene', that may be specified as the string 'scene' - optionally followed by an integer >= 1 - (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) - - Returns - ------- - str - """ - return self['scene'] - - @scene.setter - def scene(self, val): - self['scene'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.surface.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.surface.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # surfacecolor - # ------------ - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['surfacecolor'] - - @surfacecolor.setter - def surfacecolor(self, val): - self['surfacecolor'] = val - - # surfacecolorsrc - # --------------- - @property - def surfacecolorsrc(self): - """ - Sets the source reference on plot.ly for surfacecolor . - - The 'surfacecolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['surfacecolorsrc'] - - @surfacecolorsrc.setter - def surfacecolorsrc(self, val): - self['surfacecolorsrc'] = val - - # text - # ---- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['xcalendar'] - - @xcalendar.setter - def xcalendar(self, val): - self['xcalendar'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # ycalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['ycalendar'] - - @ycalendar.setter - def ycalendar(self, val): - self['ycalendar'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # z - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # zcalendar - # --------- - @property - 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', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['zcalendar'] - - @zcalendar.setter - def zcalendar(self, val): - self['zcalendar'] = val - - # zsrc - # ---- - @property - def zsrc(self): - """ - Sets the source reference on plot.ly for z . - - The 'zsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['zsrc'] - - @zsrc.setter - def zsrc(self, val): - self['zsrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here z or surfacecolor) - or the bounds set in `cmin` and `cmax` Defaults to - `false` when `cmin` and `cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Value should - have the same units as z or surfacecolor and if set, - `cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `cmin` and/or `cmax` to be equidistant to this point. - Value should have the same units as z or surfacecolor. - Has no effect when `cauto` is `false`. - cmin - Sets the lower bound of the color domain. Value should - have the same units as z or surfacecolor and if set, - `cmax` must be set as well. - colorbar - plotly.graph_objs.surface.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - contours - plotly.graph_objs.surface.Contours instance or dict - with compatible properties - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - hidesurface - Determines whether or not a surface is drawn. For - example, set `hidesurface` to False `contours.x.show` - to True and `contours.y.show` to True to draw a wire - frame plot. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.surface.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - lighting - plotly.graph_objs.surface.Lighting instance or dict - with compatible properties - lightposition - plotly.graph_objs.surface.Lightposition instance or - dict with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the surface. Please note that in - the case of using high `opacity` values for example a - value greater than or equal to 0.5 on two surfaces (and - 0.25 with four surfaces), an overlay of multiple - transparent surfaces may not perfectly be sorted in - depth by the webgl API. This behavior may be improved - in the near future and is subject to change. - reversescale - Reverses the color mapping if true. If true, `cmin` - will correspond to the last color in the array and - `cmax` will correspond to the first color. - scene - Sets a reference between this trace's 3D coordinate - system and a 3D scene. If "scene" (the default value), - the (x,y,z) coordinates refer to `layout.scene`. If - "scene2", the (x,y,z) coordinates refer to - `layout.scene2`, and so on. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.surface.Stream instance or dict with - compatible properties - surfacecolor - Sets the surface color values, used for setting a color - scale independent of `z`. - surfacecolorsrc - Sets the source reference on plot.ly for surfacecolor - . - text - Sets the text elements associated with each z value. If - trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates. - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the z coordinates. - zcalendar - Sets the calendar system to use with `z` date data. - zsrc - Sets the source reference on plot.ly for z . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - colorbar=None, - colorscale=None, - contours=None, - customdata=None, - customdatasrc=None, - hidesurface=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - legendgroup=None, - lighting=None, - lightposition=None, - name=None, - opacity=None, - reversescale=None, - scene=None, - selectedpoints=None, - showlegend=None, - showscale=None, - stream=None, - surfacecolor=None, - surfacecolorsrc=None, - text=None, - textsrc=None, - uid=None, - uirevision=None, - visible=None, - x=None, - xcalendar=None, - xsrc=None, - y=None, - ycalendar=None, - ysrc=None, - z=None, - zcalendar=None, - zsrc=None, - **kwargs - ): - """ - Construct a new Surface object - - The data the describes the coordinates of the surface is set in - `z`. Data in `z` should be a 2D list. Coordinates in `x` and - `y` can either be 1D lists or 2D lists (e.g. to graph - parametric surfaces). If not provided in `x` and `y`, the x and - y coordinates are assumed to be linear starting at 0 with a - unit step. The color scale corresponds to the `z` values by - default. For custom color scales, use `surfacecolor` which - should be a 2D list, where its bounds can be controlled using - `cmin` and `cmax`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Surface - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `colorscale`. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` - array are all positive, all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here z or surfacecolor) - or the bounds set in `cmin` and `cmax` Defaults to - `false` when `cmin` and `cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Value should - have the same units as z or surfacecolor and if set, - `cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `cmin` and/or `cmax` to be equidistant to this point. - Value should have the same units as z or surfacecolor. - Has no effect when `cauto` is `false`. - cmin - Sets the lower bound of the color domain. Value should - have the same units as z or surfacecolor and if set, - `cmax` must be set as well. - colorbar - plotly.graph_objs.surface.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - contours - plotly.graph_objs.surface.Contours instance or dict - with compatible properties - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - hidesurface - Determines whether or not a surface is drawn. For - example, set `hidesurface` to False `contours.x.show` - to True and `contours.y.show` to True to draw a wire - frame plot. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.surface.Hoverlabel instance or dict - with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - lighting - plotly.graph_objs.surface.Lighting instance or dict - with compatible properties - lightposition - plotly.graph_objs.surface.Lightposition instance or - dict with compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the surface. Please note that in - the case of using high `opacity` values for example a - value greater than or equal to 0.5 on two surfaces (and - 0.25 with four surfaces), an overlay of multiple - transparent surfaces may not perfectly be sorted in - depth by the webgl API. This behavior may be improved - in the near future and is subject to change. - reversescale - Reverses the color mapping if true. If true, `cmin` - will correspond to the last color in the array and - `cmax` will correspond to the first color. - scene - Sets a reference between this trace's 3D coordinate - system and a 3D scene. If "scene" (the default value), - the (x,y,z) coordinates refer to `layout.scene`. If - "scene2", the (x,y,z) coordinates refer to - `layout.scene2`, and so on. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - showscale - Determines whether or not a colorbar is displayed for - this trace. - stream - plotly.graph_objs.surface.Stream instance or dict with - compatible properties - surfacecolor - Sets the surface color values, used for setting a color - scale independent of `z`. - surfacecolorsrc - Sets the source reference on plot.ly for surfacecolor - . - text - Sets the text elements associated with each z value. If - trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be seen in - the hover labels. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - x - Sets the x coordinates. - xcalendar - Sets the calendar system to use with `x` date data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates. - ycalendar - Sets the calendar system to use with `y` date data. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the z coordinates. - zcalendar - Sets the calendar system to use with `z` date data. - zsrc - Sets the source reference on plot.ly for z . - - Returns - ------- - Surface - """ - super(Surface, self).__init__('surface') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Surface -constructor must be a dict or -an instance of plotly.graph_objs.Surface""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (surface as v_surface) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_surface.AutocolorscaleValidator( - ) - self._validators['cauto'] = v_surface.CautoValidator() - self._validators['cmax'] = v_surface.CmaxValidator() - self._validators['cmid'] = v_surface.CmidValidator() - self._validators['cmin'] = v_surface.CminValidator() - self._validators['colorbar'] = v_surface.ColorBarValidator() - self._validators['colorscale'] = v_surface.ColorscaleValidator() - self._validators['contours'] = v_surface.ContoursValidator() - self._validators['customdata'] = v_surface.CustomdataValidator() - self._validators['customdatasrc'] = v_surface.CustomdatasrcValidator() - self._validators['hidesurface'] = v_surface.HidesurfaceValidator() - self._validators['hoverinfo'] = v_surface.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_surface.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_surface.HoverlabelValidator() - self._validators['hovertemplate'] = v_surface.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_surface.HovertemplatesrcValidator() - self._validators['hovertext'] = v_surface.HovertextValidator() - self._validators['hovertextsrc'] = v_surface.HovertextsrcValidator() - self._validators['ids'] = v_surface.IdsValidator() - self._validators['idssrc'] = v_surface.IdssrcValidator() - self._validators['legendgroup'] = v_surface.LegendgroupValidator() - self._validators['lighting'] = v_surface.LightingValidator() - self._validators['lightposition'] = v_surface.LightpositionValidator() - self._validators['name'] = v_surface.NameValidator() - self._validators['opacity'] = v_surface.OpacityValidator() - self._validators['reversescale'] = v_surface.ReversescaleValidator() - self._validators['scene'] = v_surface.SceneValidator() - self._validators['selectedpoints'] = v_surface.SelectedpointsValidator( - ) - self._validators['showlegend'] = v_surface.ShowlegendValidator() - self._validators['showscale'] = v_surface.ShowscaleValidator() - self._validators['stream'] = v_surface.StreamValidator() - self._validators['surfacecolor'] = v_surface.SurfacecolorValidator() - self._validators['surfacecolorsrc' - ] = v_surface.SurfacecolorsrcValidator() - self._validators['text'] = v_surface.TextValidator() - self._validators['textsrc'] = v_surface.TextsrcValidator() - self._validators['uid'] = v_surface.UidValidator() - self._validators['uirevision'] = v_surface.UirevisionValidator() - self._validators['visible'] = v_surface.VisibleValidator() - self._validators['x'] = v_surface.XValidator() - self._validators['xcalendar'] = v_surface.XcalendarValidator() - self._validators['xsrc'] = v_surface.XsrcValidator() - self._validators['y'] = v_surface.YValidator() - self._validators['ycalendar'] = v_surface.YcalendarValidator() - self._validators['ysrc'] = v_surface.YsrcValidator() - self._validators['z'] = v_surface.ZValidator() - self._validators['zcalendar'] = v_surface.ZcalendarValidator() - self._validators['zsrc'] = v_surface.ZsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('contours', None) - self['contours'] = contours if contours is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('hidesurface', None) - self['hidesurface'] = hidesurface if hidesurface is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('lighting', None) - self['lighting'] = lighting if lighting is not None else _v - _v = arg.pop('lightposition', None) - self['lightposition' - ] = lightposition if lightposition is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('scene', None) - self['scene'] = scene if scene is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('surfacecolor', None) - self['surfacecolor'] = surfacecolor if surfacecolor is not None else _v - _v = arg.pop('surfacecolorsrc', None) - self['surfacecolorsrc' - ] = surfacecolorsrc if surfacecolorsrc is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xcalendar', None) - self['xcalendar'] = xcalendar if xcalendar is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('ycalendar', None) - self['ycalendar'] = ycalendar if ycalendar is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - _v = arg.pop('zcalendar', None) - self['zcalendar'] = zcalendar if zcalendar is not None else _v - _v = arg.pop('zsrc', None) - self['zsrc'] = zsrc if zsrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'surface' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='surface', val='surface' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_table.py b/plotly/graph_objs/_table.py deleted file mode 100644 index e6f0b853d20..00000000000 --- a/plotly/graph_objs/_table.py +++ /dev/null @@ -1,1050 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Table(BaseTraceType): - - # cells - # ----- - @property - def cells(self): - """ - The 'cells' property is an instance of Cells - that may be specified as: - - An instance of plotly.graph_objs.table.Cells - - A dict of string/value properties that will be passed - to the Cells constructor - - Supported dict properties: - - align - Sets the horizontal alignment of the `text` - within the box. Has an effect only if `text` - spans more two or more lines (i.e. `text` - contains one or more
HTML tags) or if an - explicit width is set to override the text - width. - alignsrc - Sets the source reference on plot.ly for align - . - fill - plotly.graph_objs.table.cells.Fill instance or - dict with compatible properties - font - plotly.graph_objs.table.cells.Font instance or - dict with compatible properties - format - Sets the cell value formatting rule using d3 - formatting mini-language which is similar to - those of Python. See https://github.com/d3/d3-f - ormat/blob/master/README.md#locale_format - formatsrc - Sets the source reference on plot.ly for - format . - height - The height of cells. - line - plotly.graph_objs.table.cells.Line instance or - dict with compatible properties - prefix - Prefix for cell values. - prefixsrc - Sets the source reference on plot.ly for - prefix . - suffix - Suffix for cell values. - suffixsrc - Sets the source reference on plot.ly for - suffix . - values - Cell values. `values[m][n]` represents the - value of the `n`th point in column `m`, - therefore the `values[m]` vector length for all - columns must be the same (longer vectors will - be truncated). Each value must be a finite - number or a string. - valuessrc - Sets the source reference on plot.ly for - values . - - Returns - ------- - plotly.graph_objs.table.Cells - """ - return self['cells'] - - @cells.setter - def cells(self, val): - self['cells'] = val - - # columnorder - # ----------- - @property - def columnorder(self): - """ - Specifies the rendered order of the data columns; for example, - a value `2` at position `0` means that column index `0` in the - data will be rendered as the third column, as columns have an - index base of zero. - - The 'columnorder' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['columnorder'] - - @columnorder.setter - def columnorder(self, val): - self['columnorder'] = val - - # columnordersrc - # -------------- - @property - def columnordersrc(self): - """ - Sets the source reference on plot.ly for columnorder . - - The 'columnordersrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['columnordersrc'] - - @columnordersrc.setter - def columnordersrc(self, val): - self['columnordersrc'] = val - - # columnwidth - # ----------- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['columnwidth'] - - @columnwidth.setter - def columnwidth(self, val): - self['columnwidth'] = val - - # columnwidthsrc - # -------------- - @property - def columnwidthsrc(self): - """ - Sets the source reference on plot.ly for columnwidth . - - The 'columnwidthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['columnwidthsrc'] - - @columnwidthsrc.setter - def columnwidthsrc(self, val): - self['columnwidthsrc'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # domain - # ------ - @property - def domain(self): - """ - The 'domain' property is an instance of Domain - that may be specified as: - - An instance of plotly.graph_objs.table.Domain - - A dict of string/value properties that will be passed - to the Domain constructor - - Supported dict properties: - - column - If there is a layout grid, use the domain for - this column in the grid for this table trace . - row - If there is a layout grid, use the domain for - this row in the grid for this table trace . - x - Sets the horizontal domain of this table trace - (in plot fraction). - y - Sets the vertical domain of this table trace - (in plot fraction). - - Returns - ------- - plotly.graph_objs.table.Domain - """ - return self['domain'] - - @domain.setter - def domain(self, val): - self['domain'] = val - - # header - # ------ - @property - def header(self): - """ - The 'header' property is an instance of Header - that may be specified as: - - An instance of plotly.graph_objs.table.Header - - A dict of string/value properties that will be passed - to the Header constructor - - Supported dict properties: - - align - Sets the horizontal alignment of the `text` - within the box. Has an effect only if `text` - spans more two or more lines (i.e. `text` - contains one or more
HTML tags) or if an - explicit width is set to override the text - width. - alignsrc - Sets the source reference on plot.ly for align - . - fill - plotly.graph_objs.table.header.Fill instance or - dict with compatible properties - font - plotly.graph_objs.table.header.Font instance or - dict with compatible properties - format - Sets the cell value formatting rule using d3 - formatting mini-language which is similar to - those of Python. See https://github.com/d3/d3-f - ormat/blob/master/README.md#locale_format - formatsrc - Sets the source reference on plot.ly for - format . - height - The height of cells. - line - plotly.graph_objs.table.header.Line instance or - dict with compatible properties - prefix - Prefix for cell values. - prefixsrc - Sets the source reference on plot.ly for - prefix . - suffix - Suffix for cell values. - suffixsrc - Sets the source reference on plot.ly for - suffix . - values - Header cell values. `values[m][n]` represents - the value of the `n`th point in column `m`, - therefore the `values[m]` vector length for all - columns must be the same (longer vectors will - be truncated). Each value must be a finite - number or a string. - valuessrc - Sets the source reference on plot.ly for - values . - - Returns - ------- - plotly.graph_objs.table.Header - """ - return self['header'] - - @header.setter - def header(self, val): - self['header'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.table.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.table.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # name - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.table.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.table.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - cells - plotly.graph_objs.table.Cells instance or dict with - compatible properties - columnorder - Specifies the rendered order of the data columns; for - example, a value `2` at position `0` means that column - index `0` in the data will be rendered as the third - column, as columns have an index base of zero. - columnordersrc - Sets the source reference on plot.ly for columnorder . - columnwidth - The width of columns expressed as a ratio. Columns fill - the available width in proportion of their specified - column widths. - columnwidthsrc - Sets the source reference on plot.ly for columnwidth . - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - domain - plotly.graph_objs.table.Domain instance or dict with - compatible properties - header - plotly.graph_objs.table.Header instance or dict with - compatible properties - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.table.Hoverlabel instance or dict - with compatible properties - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.table.Stream instance or dict with - compatible properties - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - """ - - def __init__( - self, - arg=None, - cells=None, - columnorder=None, - columnordersrc=None, - columnwidth=None, - columnwidthsrc=None, - customdata=None, - customdatasrc=None, - domain=None, - header=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - ids=None, - idssrc=None, - legendgroup=None, - name=None, - opacity=None, - selectedpoints=None, - showlegend=None, - stream=None, - uid=None, - uirevision=None, - visible=None, - **kwargs - ): - """ - Construct a new Table object - - Table view for detailed data viewing. The data are arranged in - a grid of rows and columns. Most styling can be specified for - columns, rows or individual cells. Table is using a column- - major order, ie. the grid is represented as a vector of column - vectors. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Table - cells - plotly.graph_objs.table.Cells instance or dict with - compatible properties - columnorder - Specifies the rendered order of the data columns; for - example, a value `2` at position `0` means that column - index `0` in the data will be rendered as the third - column, as columns have an index base of zero. - columnordersrc - Sets the source reference on plot.ly for columnorder . - columnwidth - The width of columns expressed as a ratio. Columns fill - the available width in proportion of their specified - column widths. - columnwidthsrc - Sets the source reference on plot.ly for columnwidth . - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - domain - plotly.graph_objs.table.Domain instance or dict with - compatible properties - header - plotly.graph_objs.table.Header instance or dict with - compatible properties - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.table.Hoverlabel instance or dict - with compatible properties - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - name - Sets the trace name. The trace name appear as the - legend item and on hover. - opacity - Sets the opacity of the trace. - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - stream - plotly.graph_objs.table.Stream instance or dict with - compatible properties - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - - Returns - ------- - Table - """ - super(Table, self).__init__('table') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Table -constructor must be a dict or -an instance of plotly.graph_objs.Table""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (table as v_table) - - # Initialize validators - # --------------------- - self._validators['cells'] = v_table.CellsValidator() - self._validators['columnorder'] = v_table.ColumnorderValidator() - self._validators['columnordersrc'] = v_table.ColumnordersrcValidator() - self._validators['columnwidth'] = v_table.ColumnwidthValidator() - self._validators['columnwidthsrc'] = v_table.ColumnwidthsrcValidator() - self._validators['customdata'] = v_table.CustomdataValidator() - self._validators['customdatasrc'] = v_table.CustomdatasrcValidator() - self._validators['domain'] = v_table.DomainValidator() - self._validators['header'] = v_table.HeaderValidator() - self._validators['hoverinfo'] = v_table.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_table.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_table.HoverlabelValidator() - self._validators['ids'] = v_table.IdsValidator() - self._validators['idssrc'] = v_table.IdssrcValidator() - self._validators['legendgroup'] = v_table.LegendgroupValidator() - self._validators['name'] = v_table.NameValidator() - self._validators['opacity'] = v_table.OpacityValidator() - self._validators['selectedpoints'] = v_table.SelectedpointsValidator() - self._validators['showlegend'] = v_table.ShowlegendValidator() - self._validators['stream'] = v_table.StreamValidator() - self._validators['uid'] = v_table.UidValidator() - self._validators['uirevision'] = v_table.UirevisionValidator() - self._validators['visible'] = v_table.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('cells', None) - self['cells'] = cells if cells is not None else _v - _v = arg.pop('columnorder', None) - self['columnorder'] = columnorder if columnorder is not None else _v - _v = arg.pop('columnordersrc', None) - self['columnordersrc' - ] = columnordersrc if columnordersrc is not None else _v - _v = arg.pop('columnwidth', None) - self['columnwidth'] = columnwidth if columnwidth is not None else _v - _v = arg.pop('columnwidthsrc', None) - self['columnwidthsrc' - ] = columnwidthsrc if columnwidthsrc is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('domain', None) - self['domain'] = domain if domain is not None else _v - _v = arg.pop('header', None) - self['header'] = header if header is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'table' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='table', val='table' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/_violin.py b/plotly/graph_objs/_violin.py deleted file mode 100644 index ae19c3934ff..00000000000 --- a/plotly/graph_objs/_violin.py +++ /dev/null @@ -1,1975 +0,0 @@ -from plotly.basedatatypes import BaseTraceType -import copy - - -class Violin(BaseTraceType): - - # alignmentgroup - # -------------- - @property - 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 - - Returns - ------- - str - """ - return self['alignmentgroup'] - - @alignmentgroup.setter - def alignmentgroup(self, val): - self['alignmentgroup'] = val - - # bandwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['bandwidth'] - - @bandwidth.setter - def bandwidth(self, val): - self['bandwidth'] = val - - # box - # --- - @property - def box(self): - """ - The 'box' property is an instance of Box - that may be specified as: - - An instance of 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 - plotly.graph_objs.violin.box.Line instance or - dict with compatible properties - visible - Determines if an miniature box plot is drawn - inside the violins. - width - Sets the width of the inner box plots relative - to the violins' width. For example, with 1, the - inner box plots are as wide as the violins. - - Returns - ------- - plotly.graph_objs.violin.Box - """ - return self['box'] - - @box.setter - def box(self, val): - self['box'] = val - - # customdata - # ---------- - @property - def customdata(self): - """ - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note that, - "scatter" traces also appends customdata items in the markers - DOM elements - - The 'customdata' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['customdata'] - - @customdata.setter - def customdata(self, val): - self['customdata'] = val - - # customdatasrc - # ------------- - @property - def customdatasrc(self): - """ - Sets the source reference on plot.ly for customdata . - - The 'customdatasrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['customdatasrc'] - - @customdatasrc.setter - def customdatasrc(self, val): - self['customdatasrc'] = val - - # fillcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['fillcolor'] - - @fillcolor.setter - def fillcolor(self, val): - self['fillcolor'] = val - - # hoverinfo - # --------- - @property - 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 - (e.g. 'x+y') - OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') - - A list or array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverinfosrc - # ------------ - @property - def hoverinfosrc(self): - """ - Sets the source reference on plot.ly for hoverinfo . - - The 'hoverinfosrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hoverinfosrc'] - - @hoverinfosrc.setter - def hoverinfosrc(self, val): - self['hoverinfosrc'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.violin.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.violin.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hoveron - # ------- - @property - 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 - (e.g. 'violins+points') - OR exactly one of ['all'] (e.g. 'all') - - Returns - ------- - Any - """ - return self['hoveron'] - - @hoveron.setter - def hoveron(self, val): - self['hoveron'] = val - - # hovertext - # --------- - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # hovertextsrc - # ------------ - @property - def hovertextsrc(self): - """ - Sets the source reference on plot.ly for hovertext . - - The 'hovertextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertextsrc'] - - @hovertextsrc.setter - def hovertextsrc(self, val): - self['hovertextsrc'] = val - - # ids - # --- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ids'] - - @ids.setter - def ids(self, val): - self['ids'] = val - - # idssrc - # ------ - @property - def idssrc(self): - """ - Sets the source reference on plot.ly for ids . - - The 'idssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['idssrc'] - - @idssrc.setter - def idssrc(self, val): - self['idssrc'] = val - - # jitter - # ------ - @property - def jitter(self): - """ - Sets the amount of jitter in the sample points drawn. If 0, the - sample points align along the distribution axis. If 1, the - sample points are drawn in a random jitter of width equal to - the width of the violins. - - The 'jitter' property is a number and may be specified as: - - An int or float in the interval [0, 1] - - Returns - ------- - int|float - """ - return self['jitter'] - - @jitter.setter - def jitter(self, val): - self['jitter'] = val - - # legendgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['legendgroup'] - - @legendgroup.setter - def legendgroup(self, val): - self['legendgroup'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of plotly.graph_objs.violin.Line - - A dict of string/value properties that will be passed - to the Line constructor - - Supported dict properties: - - color - Sets the color of line bounding the violin(s). - width - Sets the width (in px) of line bounding the - violin(s). - - Returns - ------- - plotly.graph_objs.violin.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - line - plotly.graph_objs.violin.marker.Line instance - or dict with compatible properties - opacity - Sets the marker opacity. - outliercolor - Sets the color of the outlier sample points. - size - Sets the marker size (in px). - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - - Returns - ------- - plotly.graph_objs.violin.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # meanline - # -------- - @property - def meanline(self): - """ - The 'meanline' property is an instance of Meanline - that may be specified as: - - An instance of plotly.graph_objs.violin.Meanline - - A dict of string/value properties that will be passed - to the Meanline constructor - - Supported dict properties: - - color - Sets the mean line color. - visible - Determines if a line corresponding to the - sample's mean is shown inside the violins. If - `box.visible` is turned on, the mean line is - drawn inside the inner box. Otherwise, the mean - line is drawn from one side of the violin to - other. - width - Sets the mean line width. - - Returns - ------- - plotly.graph_objs.violin.Meanline - """ - return self['meanline'] - - @meanline.setter - def meanline(self, val): - self['meanline'] = val - - # name - # ---- - @property - def name(self): - """ - Sets the trace name. The trace name appear as the legend item - and on hover. For box traces, the name will also be used for - the position coordinate, if `x` and `x0` (`y` and `y0` if - horizontal) are missing and the position axis is categorical - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # offsetgroup - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['offsetgroup'] - - @offsetgroup.setter - def offsetgroup(self, val): - self['offsetgroup'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # orientation - # ----------- - @property - 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'] - - Returns - ------- - Any - """ - return self['orientation'] - - @orientation.setter - def orientation(self, val): - self['orientation'] = val - - # pointpos - # -------- - @property - def pointpos(self): - """ - Sets the position of the sample points in relation to the - violins. If 0, the sample points are places over the center of - the violins. Positive (negative) values correspond to positions - to the right (left) for vertical violins and above (below) for - horizontal violins. - - The 'pointpos' property is a number and may be specified as: - - An int or float in the interval [-2, 2] - - Returns - ------- - int|float - """ - return self['pointpos'] - - @pointpos.setter - def pointpos(self, val): - self['pointpos'] = val - - # points - # ------ - @property - def points(self): - """ - If "outliers", only the sample points lying outside the - whiskers are shown If "suspectedoutliers", the outlier points - are shown and points either less than 4*Q1-3*Q3 or greater than - 4*Q3-3*Q1 are highlighted (see `outliercolor`) If "all", all - sample points are shown If False, only the violins are shown - with no sample points - - The 'points' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'outliers', 'suspectedoutliers', False] - - Returns - ------- - Any - """ - return self['points'] - - @points.setter - def points(self, val): - self['points'] = val - - # scalegroup - # ---------- - @property - def scalegroup(self): - """ - If there are multiple violins that should be sized according to - to some metric (see `scalemode`), link them by providing a non- - empty group id here shared by every trace in the same group. - - The 'scalegroup' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['scalegroup'] - - @scalegroup.setter - def scalegroup(self, val): - self['scalegroup'] = val - - # scalemode - # --------- - @property - def scalemode(self): - """ - Sets the metric by which the width of each violin is - determined."width" means each violin has the same (max) - width*count* means the violins are scaled by the number of - sample points makingup each violin. - - The 'scalemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['width', 'count'] - - Returns - ------- - Any - """ - return self['scalemode'] - - @scalemode.setter - def scalemode(self, val): - self['scalemode'] = val - - # selected - # -------- - @property - def selected(self): - """ - The 'selected' property is an instance of Selected - that may be specified as: - - An instance of plotly.graph_objs.violin.Selected - - A dict of string/value properties that will be passed - to the Selected constructor - - Supported dict properties: - - marker - plotly.graph_objs.violin.selected.Marker - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.violin.Selected - """ - return self['selected'] - - @selected.setter - def selected(self, val): - self['selected'] = val - - # selectedpoints - # -------------- - @property - def selectedpoints(self): - """ - Array containing integer indices of selected points. Has an - effect only for traces that support selections. Note that an - empty array means an empty selection where the `unselected` are - turned on for all points, whereas, any other non-array values - means no selection all where the `selected` and `unselected` - styles have no effect. - - The 'selectedpoints' property accepts values of any type - - Returns - ------- - Any - """ - return self['selectedpoints'] - - @selectedpoints.setter - def selectedpoints(self, val): - self['selectedpoints'] = val - - # showlegend - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlegend'] - - @showlegend.setter - def showlegend(self, val): - self['showlegend'] = val - - # side - # ---- - @property - def side(self): - """ - Determines on which side of the position value the density - function making up one half of a violin is plotted. Useful when - comparing two violin traces under "overlay" mode, where one - trace has `side` set to "positive" and the other to "negative". - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['both', 'positive', 'negative'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # span - # ---- - @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 - - Returns - ------- - list - """ - return self['span'] - - @span.setter - def span(self, val): - self['span'] = val - - # spanmode - # -------- - @property - def spanmode(self): - """ - Sets the method by which the span in data space where the - density function will be computed. "soft" means the span goes - from the sample's minimum value minus two bandwidths to the - sample's maximum value plus two bandwidths. "hard" means the - span goes from the sample's minimum to its maximum value. For - custom span settings, use mode "manual" and fill in the `span` - attribute. - - The 'spanmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['soft', 'hard', 'manual'] - - Returns - ------- - Any - """ - return self['spanmode'] - - @spanmode.setter - def spanmode(self, val): - self['spanmode'] = val - - # stream - # ------ - @property - def stream(self): - """ - The 'stream' property is an instance of Stream - that may be specified as: - - An instance of plotly.graph_objs.violin.Stream - - A dict of string/value properties that will be passed - to the Stream constructor - - Supported dict properties: - - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. - - Returns - ------- - plotly.graph_objs.violin.Stream - """ - return self['stream'] - - @stream.setter - def stream(self, val): - self['stream'] = val - - # text - # ---- - @property - def text(self): - """ - Sets the text elements associated with each sample value. If a - single string, the same string appears over all the data - points. If an array of string, the items are mapped in order to - the this trace's (x,y) coordinates. To be seen, trace - `hoverinfo` must contain a "text" flag. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textsrc - # ------- - @property - def textsrc(self): - """ - Sets the source reference on plot.ly for text . - - The 'textsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['textsrc'] - - @textsrc.setter - def textsrc(self, val): - self['textsrc'] = val - - # uid - # --- - @property - 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 - - Returns - ------- - str - """ - return self['uid'] - - @uid.setter - def uid(self, val): - self['uid'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of some user-driven changes to the trace: - `constraintrange` in `parcoords` traces, as well as some - `editable: true` modifications such as `name` and - `colorbar.title`. Defaults to `layout.uirevision`. Note that - other user-driven trace attribute changes are controlled by - `layout` attributes: `trace.visible` is controlled by - `layout.legend.uirevision`, `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` (accessible - with `config: {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are tracked by `uid`, - which only falls back on trace index if no `uid` is provided. - So if your app can add/remove traces before the end of the - `data` array, such that the same trace has a different index, - you can still preserve user-driven changes if you give each - trace a `uid` that stays with it as it moves. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # unselected - # ---------- - @property - def unselected(self): - """ - The 'unselected' property is an instance of Unselected - that may be specified as: - - An instance of plotly.graph_objs.violin.Unselected - - A dict of string/value properties that will be passed - to the Unselected constructor - - Supported dict properties: - - marker - plotly.graph_objs.violin.unselected.Marker - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.violin.Unselected - """ - return self['unselected'] - - @unselected.setter - def unselected(self, val): - self['unselected'] = val - - # visible - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # x0 - # -- - @property - def x0(self): - """ - Sets the x coordinate of the box. See overview for more info. - - The 'x0' property accepts values of any type - - Returns - ------- - Any - """ - return self['x0'] - - @x0.setter - def x0(self, val): - self['x0'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - Sets a reference between this trace's x coordinates and a 2D - cartesian x axis. If "x" (the default value), the x coordinates - refer to `layout.xaxis`. If "x2", the x coordinates refer to - `layout.xaxis2`, and so on. - - The 'xaxis' property is an identifier of a particular - subplot, of type 'x', that may be specified as the string 'x' - optionally followed by an integer >= 1 - (e.g. 'x', 'x1', 'x2', 'x3', etc.) - - Returns - ------- - str - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # y0 - # -- - @property - def y0(self): - """ - Sets the y coordinate of the box. See overview for more info. - - The 'y0' property accepts values of any type - - Returns - ------- - Any - """ - return self['y0'] - - @y0.setter - def y0(self, val): - self['y0'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - Sets a reference between this trace's y coordinates and a 2D - cartesian y axis. If "y" (the default value), the y coordinates - refer to `layout.yaxis`. If "y2", the y coordinates refer to - `layout.yaxis2`, and so on. - - The 'yaxis' property is an identifier of a particular - subplot, of type 'y', that may be specified as the string 'y' - optionally followed by an integer >= 1 - (e.g. 'y', 'y1', 'y2', 'y3', etc.) - - Returns - ------- - str - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # type - # ---- - @property - def type(self): - return self._props['type'] - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return '' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - alignmentgroup - Set several traces linked to the same position axis or - matching axes to the same alignmentgroup. This controls - whether bars compute their positional range dependently - or independently. - bandwidth - Sets the bandwidth used to compute the kernel density - estimate. By default, the bandwidth is determined by - Silverman's rule of thumb. - box - plotly.graph_objs.violin.Box instance or dict with - compatible properties - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.violin.Hoverlabel instance or dict - with compatible properties - hoveron - Do the hover effects highlight individual violins or - sample points or the kernel density estimate or any - combination of them? - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - jitter - Sets the amount of jitter in the sample points drawn. - If 0, the sample points align along the distribution - axis. If 1, the sample points are drawn in a random - jitter of width equal to the width of the violins. - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.violin.Line instance or dict with - compatible properties - marker - plotly.graph_objs.violin.Marker instance or dict with - compatible properties - meanline - plotly.graph_objs.violin.Meanline instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. For box traces, the name will - also be used for the position coordinate, if `x` and - `x0` (`y` and `y0` if horizontal) are missing and the - position axis is categorical - offsetgroup - Set several traces linked to the same position axis or - matching axes to the same offsetgroup where bars of the - same position coordinate will line up. - opacity - Sets the opacity of the trace. - orientation - Sets the orientation of the violin(s). If "v" ("h"), - the distribution is visualized along the vertical - (horizontal). - pointpos - Sets the position of the sample points in relation to - the violins. If 0, the sample points are places over - the center of the violins. Positive (negative) values - correspond to positions to the right (left) for - vertical violins and above (below) for horizontal - violins. - points - If "outliers", only the sample points lying outside the - whiskers are shown If "suspectedoutliers", the outlier - points are shown and points either less than 4*Q1-3*Q3 - or greater than 4*Q3-3*Q1 are highlighted (see - `outliercolor`) If "all", all sample points are shown - If False, only the violins are shown with no sample - points - scalegroup - If there are multiple violins that should be sized - according to to some metric (see `scalemode`), link - them by providing a non-empty group id here shared by - every trace in the same group. - scalemode - Sets the metric by which the width of each violin is - determined."width" means each violin has the same (max) - width*count* means the violins are scaled by the number - of sample points makingup each violin. - selected - plotly.graph_objs.violin.Selected instance or dict with - compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - side - Determines on which side of the position value the - density function making up one half of a violin is - plotted. Useful when comparing two violin traces under - "overlay" mode, where one trace has `side` set to - "positive" and the other to "negative". - span - Sets the span in data space for which the density - function will be computed. Has an effect only when - `spanmode` is set to "manual". - spanmode - Sets the method by which the span in data space where - the density function will be computed. "soft" means the - span goes from the sample's minimum value minus two - bandwidths to the sample's maximum value plus two - bandwidths. "hard" means the span goes from the - sample's minimum to its maximum value. For custom span - settings, use mode "manual" and fill in the `span` - attribute. - stream - plotly.graph_objs.violin.Stream instance or dict with - compatible properties - text - Sets the text elements associated with each sample - value. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to the this trace's (x,y) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.violin.Unselected instance or dict - with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - width - Sets the width of the violin in data coordinates. If 0 - (default value) the width is automatically selected - based on the positions of other violin traces in the - same subplot. - x - Sets the x sample data or coordinates. See overview for - more info. - x0 - Sets the x coordinate of the box. See overview for more - info. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y sample data or coordinates. See overview for - more info. - y0 - Sets the y coordinate of the box. See overview for more - info. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ysrc - Sets the source reference on plot.ly for y . - """ - - def __init__( - self, - arg=None, - alignmentgroup=None, - bandwidth=None, - box=None, - customdata=None, - customdatasrc=None, - fillcolor=None, - hoverinfo=None, - hoverinfosrc=None, - hoverlabel=None, - hoveron=None, - hovertext=None, - hovertextsrc=None, - ids=None, - idssrc=None, - jitter=None, - legendgroup=None, - line=None, - marker=None, - meanline=None, - name=None, - offsetgroup=None, - opacity=None, - orientation=None, - pointpos=None, - points=None, - scalegroup=None, - scalemode=None, - selected=None, - selectedpoints=None, - showlegend=None, - side=None, - span=None, - spanmode=None, - stream=None, - text=None, - textsrc=None, - uid=None, - uirevision=None, - unselected=None, - visible=None, - width=None, - x=None, - x0=None, - xaxis=None, - xsrc=None, - y=None, - y0=None, - yaxis=None, - ysrc=None, - **kwargs - ): - """ - Construct a new Violin object - - In vertical (horizontal) violin plots, statistics are computed - using `y` (`x`) values. By supplying an `x` (`y`) array, one - violin per distinct x (y) value is drawn If no `x` (`y`) list - is provided, a single violin is drawn. That violin position is - then positioned with with `name` or with `x0` (`y0`) if - provided. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.Violin - alignmentgroup - Set several traces linked to the same position axis or - matching axes to the same alignmentgroup. This controls - whether bars compute their positional range dependently - or independently. - bandwidth - Sets the bandwidth used to compute the kernel density - estimate. By default, the bandwidth is determined by - Silverman's rule of thumb. - box - plotly.graph_objs.violin.Box instance or dict with - compatible properties - customdata - Assigns extra data each datum. This may be useful when - listening to hover, click and selection events. Note - that, "scatter" traces also appends customdata items in - the markers DOM elements - customdatasrc - Sets the source reference on plot.ly for customdata . - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - hoverinfo - Determines which trace information appear on hover. If - `none` or `skip` are set, no information is displayed - upon hovering. But, if `none` is set, click and hover - events are still fired. - hoverinfosrc - Sets the source reference on plot.ly for hoverinfo . - hoverlabel - plotly.graph_objs.violin.Hoverlabel instance or dict - with compatible properties - hoveron - Do the hover effects highlight individual violins or - sample points or the kernel density estimate or any - combination of them? - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for hovertext . - ids - Assigns id labels to each datum. These ids for object - constancy of data points during animation. Should be an - array of strings, not numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - jitter - Sets the amount of jitter in the sample points drawn. - If 0, the sample points align along the distribution - axis. If 1, the sample points are drawn in a random - jitter of width equal to the width of the violins. - legendgroup - Sets the legend group for this trace. Traces part of - the same legend group hide/show at the same time when - toggling legend items. - line - plotly.graph_objs.violin.Line instance or dict with - compatible properties - marker - plotly.graph_objs.violin.Marker instance or dict with - compatible properties - meanline - plotly.graph_objs.violin.Meanline instance or dict with - compatible properties - name - Sets the trace name. The trace name appear as the - legend item and on hover. For box traces, the name will - also be used for the position coordinate, if `x` and - `x0` (`y` and `y0` if horizontal) are missing and the - position axis is categorical - offsetgroup - Set several traces linked to the same position axis or - matching axes to the same offsetgroup where bars of the - same position coordinate will line up. - opacity - Sets the opacity of the trace. - orientation - Sets the orientation of the violin(s). If "v" ("h"), - the distribution is visualized along the vertical - (horizontal). - pointpos - Sets the position of the sample points in relation to - the violins. If 0, the sample points are places over - the center of the violins. Positive (negative) values - correspond to positions to the right (left) for - vertical violins and above (below) for horizontal - violins. - points - If "outliers", only the sample points lying outside the - whiskers are shown If "suspectedoutliers", the outlier - points are shown and points either less than 4*Q1-3*Q3 - or greater than 4*Q3-3*Q1 are highlighted (see - `outliercolor`) If "all", all sample points are shown - If False, only the violins are shown with no sample - points - scalegroup - If there are multiple violins that should be sized - according to to some metric (see `scalemode`), link - them by providing a non-empty group id here shared by - every trace in the same group. - scalemode - Sets the metric by which the width of each violin is - determined."width" means each violin has the same (max) - width*count* means the violins are scaled by the number - of sample points makingup each violin. - selected - plotly.graph_objs.violin.Selected instance or dict with - compatible properties - selectedpoints - Array containing integer indices of selected points. - Has an effect only for traces that support selections. - Note that an empty array means an empty selection where - the `unselected` are turned on for all points, whereas, - any other non-array values means no selection all where - the `selected` and `unselected` styles have no effect. - showlegend - Determines whether or not an item corresponding to this - trace is shown in the legend. - side - Determines on which side of the position value the - density function making up one half of a violin is - plotted. Useful when comparing two violin traces under - "overlay" mode, where one trace has `side` set to - "positive" and the other to "negative". - span - Sets the span in data space for which the density - function will be computed. Has an effect only when - `spanmode` is set to "manual". - spanmode - Sets the method by which the span in data space where - the density function will be computed. "soft" means the - span goes from the sample's minimum value minus two - bandwidths to the sample's maximum value plus two - bandwidths. "hard" means the span goes from the - sample's minimum to its maximum value. For custom span - settings, use mode "manual" and fill in the `span` - attribute. - stream - plotly.graph_objs.violin.Stream instance or dict with - compatible properties - text - Sets the text elements associated with each sample - value. If a single string, the same string appears over - all the data points. If an array of string, the items - are mapped in order to the this trace's (x,y) - coordinates. To be seen, trace `hoverinfo` must contain - a "text" flag. - textsrc - Sets the source reference on plot.ly for text . - uid - Assign an id to this trace, Use this to provide object - constancy between traces during animations and - transitions. - uirevision - Controls persistence of some user-driven changes to the - trace: `constraintrange` in `parcoords` traces, as well - as some `editable: true` modifications such as `name` - and `colorbar.title`. Defaults to `layout.uirevision`. - Note that other user-driven trace attribute changes are - controlled by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and `colorbar.(x|y)` - (accessible with `config: {editable: true}`) is - controlled by `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on trace index - if no `uid` is provided. So if your app can add/remove - traces before the end of the `data` array, such that - the same trace has a different index, you can still - preserve user-driven changes if you give each trace a - `uid` that stays with it as it moves. - unselected - plotly.graph_objs.violin.Unselected instance or dict - with compatible properties - visible - Determines whether or not this trace is visible. If - "legendonly", the trace is not drawn, but can appear as - a legend item (provided that the legend itself is - visible). - width - Sets the width of the violin in data coordinates. If 0 - (default value) the width is automatically selected - based on the positions of other violin traces in the - same subplot. - x - Sets the x sample data or coordinates. See overview for - more info. - x0 - Sets the x coordinate of the box. See overview for more - info. - xaxis - Sets a reference between this trace's x coordinates and - a 2D cartesian x axis. If "x" (the default value), the - x coordinates refer to `layout.xaxis`. If "x2", the x - coordinates refer to `layout.xaxis2`, and so on. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y sample data or coordinates. See overview for - more info. - y0 - Sets the y coordinate of the box. See overview for more - info. - yaxis - Sets a reference between this trace's y coordinates and - a 2D cartesian y axis. If "y" (the default value), the - y coordinates refer to `layout.yaxis`. If "y2", the y - coordinates refer to `layout.yaxis2`, and so on. - ysrc - Sets the source reference on plot.ly for y . - - Returns - ------- - Violin - """ - super(Violin, self).__init__('violin') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.Violin -constructor must be a dict or -an instance of plotly.graph_objs.Violin""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators import (violin as v_violin) - - # Initialize validators - # --------------------- - self._validators['alignmentgroup'] = v_violin.AlignmentgroupValidator() - self._validators['bandwidth'] = v_violin.BandwidthValidator() - self._validators['box'] = v_violin.BoxValidator() - self._validators['customdata'] = v_violin.CustomdataValidator() - self._validators['customdatasrc'] = v_violin.CustomdatasrcValidator() - self._validators['fillcolor'] = v_violin.FillcolorValidator() - self._validators['hoverinfo'] = v_violin.HoverinfoValidator() - self._validators['hoverinfosrc'] = v_violin.HoverinfosrcValidator() - self._validators['hoverlabel'] = v_violin.HoverlabelValidator() - self._validators['hoveron'] = v_violin.HoveronValidator() - self._validators['hovertext'] = v_violin.HovertextValidator() - self._validators['hovertextsrc'] = v_violin.HovertextsrcValidator() - self._validators['ids'] = v_violin.IdsValidator() - self._validators['idssrc'] = v_violin.IdssrcValidator() - self._validators['jitter'] = v_violin.JitterValidator() - self._validators['legendgroup'] = v_violin.LegendgroupValidator() - self._validators['line'] = v_violin.LineValidator() - self._validators['marker'] = v_violin.MarkerValidator() - self._validators['meanline'] = v_violin.MeanlineValidator() - self._validators['name'] = v_violin.NameValidator() - self._validators['offsetgroup'] = v_violin.OffsetgroupValidator() - self._validators['opacity'] = v_violin.OpacityValidator() - self._validators['orientation'] = v_violin.OrientationValidator() - self._validators['pointpos'] = v_violin.PointposValidator() - self._validators['points'] = v_violin.PointsValidator() - self._validators['scalegroup'] = v_violin.ScalegroupValidator() - self._validators['scalemode'] = v_violin.ScalemodeValidator() - self._validators['selected'] = v_violin.SelectedValidator() - self._validators['selectedpoints'] = v_violin.SelectedpointsValidator() - self._validators['showlegend'] = v_violin.ShowlegendValidator() - self._validators['side'] = v_violin.SideValidator() - self._validators['span'] = v_violin.SpanValidator() - self._validators['spanmode'] = v_violin.SpanmodeValidator() - self._validators['stream'] = v_violin.StreamValidator() - self._validators['text'] = v_violin.TextValidator() - self._validators['textsrc'] = v_violin.TextsrcValidator() - self._validators['uid'] = v_violin.UidValidator() - self._validators['uirevision'] = v_violin.UirevisionValidator() - self._validators['unselected'] = v_violin.UnselectedValidator() - self._validators['visible'] = v_violin.VisibleValidator() - self._validators['width'] = v_violin.WidthValidator() - self._validators['x'] = v_violin.XValidator() - self._validators['x0'] = v_violin.X0Validator() - self._validators['xaxis'] = v_violin.XAxisValidator() - self._validators['xsrc'] = v_violin.XsrcValidator() - self._validators['y'] = v_violin.YValidator() - self._validators['y0'] = v_violin.Y0Validator() - self._validators['yaxis'] = v_violin.YAxisValidator() - self._validators['ysrc'] = v_violin.YsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('alignmentgroup', None) - self['alignmentgroup' - ] = alignmentgroup if alignmentgroup is not None else _v - _v = arg.pop('bandwidth', None) - self['bandwidth'] = bandwidth if bandwidth is not None else _v - _v = arg.pop('box', None) - self['box'] = box if box is not None else _v - _v = arg.pop('customdata', None) - self['customdata'] = customdata if customdata is not None else _v - _v = arg.pop('customdatasrc', None) - self['customdatasrc' - ] = customdatasrc if customdatasrc is not None else _v - _v = arg.pop('fillcolor', None) - self['fillcolor'] = fillcolor if fillcolor is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverinfosrc', None) - self['hoverinfosrc'] = hoverinfosrc if hoverinfosrc is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hoveron', None) - self['hoveron'] = hoveron if hoveron is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('hovertextsrc', None) - self['hovertextsrc'] = hovertextsrc if hovertextsrc is not None else _v - _v = arg.pop('ids', None) - self['ids'] = ids if ids is not None else _v - _v = arg.pop('idssrc', None) - self['idssrc'] = idssrc if idssrc is not None else _v - _v = arg.pop('jitter', None) - self['jitter'] = jitter if jitter is not None else _v - _v = arg.pop('legendgroup', None) - self['legendgroup'] = legendgroup if legendgroup is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('meanline', None) - self['meanline'] = meanline if meanline is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('offsetgroup', None) - self['offsetgroup'] = offsetgroup if offsetgroup is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('orientation', None) - self['orientation'] = orientation if orientation is not None else _v - _v = arg.pop('pointpos', None) - self['pointpos'] = pointpos if pointpos is not None else _v - _v = arg.pop('points', None) - self['points'] = points if points is not None else _v - _v = arg.pop('scalegroup', None) - self['scalegroup'] = scalegroup if scalegroup is not None else _v - _v = arg.pop('scalemode', None) - self['scalemode'] = scalemode if scalemode is not None else _v - _v = arg.pop('selected', None) - self['selected'] = selected if selected is not None else _v - _v = arg.pop('selectedpoints', None) - self['selectedpoints' - ] = selectedpoints if selectedpoints is not None else _v - _v = arg.pop('showlegend', None) - self['showlegend'] = showlegend if showlegend is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('span', None) - self['span'] = span if span is not None else _v - _v = arg.pop('spanmode', None) - self['spanmode'] = spanmode if spanmode is not None else _v - _v = arg.pop('stream', None) - self['stream'] = stream if stream is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textsrc', None) - self['textsrc'] = textsrc if textsrc is not None else _v - _v = arg.pop('uid', None) - self['uid'] = uid if uid is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('unselected', None) - self['unselected'] = unselected if unselected is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('x0', None) - self['x0'] = x0 if x0 is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('y0', None) - self['y0'] = y0 if y0 is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - - # Read-only literals - # ------------------ - from _plotly_utils.basevalidators import LiteralValidator - self._props['type'] = 'violin' - self._validators['type'] = LiteralValidator( - plotly_name='type', parent_name='violin', val='violin' - ) - arg.pop('type', None) - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/area/__init__.py b/plotly/graph_objs/area/__init__.py index b0ba112a9d8..4706d3a2dc8 100644 --- a/plotly/graph_objs/area/__init__.py +++ b/plotly/graph_objs/area/__init__.py @@ -1,4 +1,1001 @@ -from ._stream import Stream -from ._marker import Marker -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'area' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.area.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.area.Stream +constructor must be a dict or +an instance of plotly.graph_objs.area.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.area import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + Area traces are deprecated! Please switch to the "barpolar" + trace type. Sets themarkercolor. It accepts either a specific + color or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # opacity + # ------- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # opacitysrc + # ---------- + @property + def opacitysrc(self): + """ + Sets the source reference on plot.ly for opacity . + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['opacitysrc'] + + @opacitysrc.setter + def opacitysrc(self, val): + self['opacitysrc'] = val + + # size + # ---- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # symbol + # ------ + @property + def symbol(self): + """ + Area traces are deprecated! Please switch to the "barpolar" + trace type. Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot-open" to a symbol + name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', + 315, 'hexagon2-open-dot', 16, 'octagon', 116, + 'octagon-open', 216, 'octagon-dot', 316, + 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, + 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, + 'hexagram-open', 218, 'hexagram-dot', 318, + 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', + 120, 'star-triangle-down-open', 220, + 'star-triangle-down-dot', 320, + 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, + 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, + 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, + 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, + 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, + 'line-nw-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['symbol'] + + @symbol.setter + def symbol(self, val): + self['symbol'] = val + + # symbolsrc + # --------- + @property + def symbolsrc(self): + """ + Sets the source reference on plot.ly for symbol . + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['symbolsrc'] + + @symbolsrc.setter + def symbolsrc(self, val): + self['symbolsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'area' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Area traces are deprecated! Please switch to the + "barpolar" trace type. Sets themarkercolor. It accepts + either a specific color or an array of numbers that are + mapped to the colorscale relative to the max and min + values of the array or relative to `marker.cmin` and + `marker.cmax` if set. + colorsrc + Sets the source reference on plot.ly for color . + opacity + Area traces are deprecated! Please switch to the + "barpolar" trace type. Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + size + Area traces are deprecated! Please switch to the + "barpolar" trace type. Sets the marker size (in px). + sizesrc + Sets the source reference on plot.ly for size . + symbol + Area traces are deprecated! Please switch to the + "barpolar" trace type. Sets the marker symbol type. + Adding 100 is equivalent to appending "-open" to a + symbol name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + opacity=None, + opacitysrc=None, + size=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.area.Marker + color + Area traces are deprecated! Please switch to the + "barpolar" trace type. Sets themarkercolor. It accepts + either a specific color or an array of numbers that are + mapped to the colorscale relative to the max and min + values of the array or relative to `marker.cmin` and + `marker.cmax` if set. + colorsrc + Sets the source reference on plot.ly for color . + opacity + Area traces are deprecated! Please switch to the + "barpolar" trace type. Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + size + Area traces are deprecated! Please switch to the + "barpolar" trace type. Sets the marker size (in px). + sizesrc + Sets the source reference on plot.ly for size . + symbol + Area traces are deprecated! Please switch to the + "barpolar" trace type. Sets the marker symbol type. + Adding 100 is equivalent to appending "-open" to a + symbol name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.area.Marker +constructor must be a dict or +an instance of plotly.graph_objs.area.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.area import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['colorsrc'] = v_marker.ColorsrcValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() + self._validators['size'] = v_marker.SizeValidator() + self._validators['sizesrc'] = v_marker.SizesrcValidator() + self._validators['symbol'] = v_marker.SymbolValidator() + self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('opacitysrc', None) + self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + _v = arg.pop('symbol', None) + self['symbol'] = symbol if symbol is not None else _v + _v = arg.pop('symbolsrc', None) + self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.area.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'area' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.area.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.area.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.area.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.area import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.area import hoverlabel diff --git a/plotly/graph_objs/area/_hoverlabel.py b/plotly/graph_objs/area/_hoverlabel.py deleted file mode 100644 index e3178fb9362..00000000000 --- a/plotly/graph_objs/area/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.area.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'area' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.area.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.area.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.area.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.area import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/area/_marker.py b/plotly/graph_objs/area/_marker.py deleted file mode 100644 index 4b61bac8c5a..00000000000 --- a/plotly/graph_objs/area/_marker.py +++ /dev/null @@ -1,439 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - Area traces are deprecated! Please switch to the "barpolar" - trace type. Sets themarkercolor. It accepts either a specific - color or an array of numbers that are mapped to the colorscale - relative to the max and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # opacity - # ------- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # opacitysrc - # ---------- - @property - def opacitysrc(self): - """ - Sets the source reference on plot.ly for opacity . - - The 'opacitysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['opacitysrc'] - - @opacitysrc.setter - def opacitysrc(self, val): - self['opacitysrc'] = val - - # size - # ---- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # symbol - # ------ - @property - def symbol(self): - """ - Area traces are deprecated! Please switch to the "barpolar" - trace type. Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot-open" to a symbol - name. - - The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', - 315, 'hexagon2-open-dot', 16, 'octagon', 116, - 'octagon-open', 216, 'octagon-dot', 316, - 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, - 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, - 'hexagram-open', 218, 'hexagram-dot', 318, - 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', - 120, 'star-triangle-down-open', 220, - 'star-triangle-down-dot', 320, - 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, - 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, - 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, - 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, - 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, - 'line-nw-open'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['symbol'] - - @symbol.setter - def symbol(self, val): - self['symbol'] = val - - # symbolsrc - # --------- - @property - def symbolsrc(self): - """ - Sets the source reference on plot.ly for symbol . - - The 'symbolsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['symbolsrc'] - - @symbolsrc.setter - def symbolsrc(self, val): - self['symbolsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'area' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Area traces are deprecated! Please switch to the - "barpolar" trace type. Sets themarkercolor. It accepts - either a specific color or an array of numbers that are - mapped to the colorscale relative to the max and min - values of the array or relative to `marker.cmin` and - `marker.cmax` if set. - colorsrc - Sets the source reference on plot.ly for color . - opacity - Area traces are deprecated! Please switch to the - "barpolar" trace type. Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - size - Area traces are deprecated! Please switch to the - "barpolar" trace type. Sets the marker size (in px). - sizesrc - Sets the source reference on plot.ly for size . - symbol - Area traces are deprecated! Please switch to the - "barpolar" trace type. Sets the marker symbol type. - Adding 100 is equivalent to appending "-open" to a - symbol name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is equivalent to - appending "-open-dot" or "dot-open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - opacity=None, - opacitysrc=None, - size=None, - sizesrc=None, - symbol=None, - symbolsrc=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.area.Marker - color - Area traces are deprecated! Please switch to the - "barpolar" trace type. Sets themarkercolor. It accepts - either a specific color or an array of numbers that are - mapped to the colorscale relative to the max and min - values of the array or relative to `marker.cmin` and - `marker.cmax` if set. - colorsrc - Sets the source reference on plot.ly for color . - opacity - Area traces are deprecated! Please switch to the - "barpolar" trace type. Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - size - Area traces are deprecated! Please switch to the - "barpolar" trace type. Sets the marker size (in px). - sizesrc - Sets the source reference on plot.ly for size . - symbol - Area traces are deprecated! Please switch to the - "barpolar" trace type. Sets the marker symbol type. - Adding 100 is equivalent to appending "-open" to a - symbol name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is equivalent to - appending "-open-dot" or "dot-open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.area.Marker -constructor must be a dict or -an instance of plotly.graph_objs.area.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.area import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['colorsrc'] = v_marker.ColorsrcValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() - self._validators['size'] = v_marker.SizeValidator() - self._validators['sizesrc'] = v_marker.SizesrcValidator() - self._validators['symbol'] = v_marker.SymbolValidator() - self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('opacitysrc', None) - self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - _v = arg.pop('symbol', None) - self['symbol'] = symbol if symbol is not None else _v - _v = arg.pop('symbolsrc', None) - self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/area/_stream.py b/plotly/graph_objs/area/_stream.py deleted file mode 100644 index 44a51f57298..00000000000 --- a/plotly/graph_objs/area/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'area' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.area.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.area.Stream -constructor must be a dict or -an instance of plotly.graph_objs.area.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.area import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/area/hoverlabel/__init__.py b/plotly/graph_objs/area/hoverlabel/__init__.py index c37b8b5cd28..fc3a516acf6 100644 --- a/plotly/graph_objs/area/hoverlabel/__init__.py +++ b/plotly/graph_objs/area/hoverlabel/__init__.py @@ -1 +1,321 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'area.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.area.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.area.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.area.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.area.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/area/hoverlabel/_font.py b/plotly/graph_objs/area/hoverlabel/_font.py deleted file mode 100644 index 02c732c6e00..00000000000 --- a/plotly/graph_objs/area/hoverlabel/_font.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'area.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.area.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.area.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.area.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.area.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/__init__.py b/plotly/graph_objs/bar/__init__.py index 3925f3dfaa4..160b7a1c43f 100644 --- a/plotly/graph_objs/bar/__init__.py +++ b/plotly/graph_objs/bar/__init__.py @@ -1,14 +1,3946 @@ -from ._unselected import Unselected + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + + Returns + ------- + plotly.graph_objs.bar.unselected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.bar.unselected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.bar.unselected.Marker instance or + dict with compatible properties + textfont + plotly.graph_objs.bar.unselected.Textfont instance or + dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.bar.Unselected + marker + plotly.graph_objs.bar.unselected.Marker instance or + dict with compatible properties + textfont + plotly.graph_objs.bar.unselected.Textfont instance or + dict with compatible properties + + Returns + ------- + Unselected + """ + super(Unselected, self).__init__('unselected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.Unselected +constructor must be a dict or +an instance of plotly.graph_objs.bar.Unselected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar import (unselected as v_unselected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_unselected.MarkerValidator() + self._validators['textfont'] = v_unselected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Textfont object + + Sets the font used for `text`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.bar.Textfont + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.bar.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar import (textfont as v_textfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + self._validators['colorsrc'] = v_textfont.ColorsrcValidator() + self._validators['family'] = v_textfont.FamilyValidator() + self._validators['familysrc'] = v_textfont.FamilysrcValidator() + self._validators['size'] = v_textfont.SizeValidator() + self._validators['sizesrc'] = v_textfont.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.bar.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.Stream +constructor must be a dict or +an instance of plotly.graph_objs.bar.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + Sets the marker opacity of selected points. + + Returns + ------- + plotly.graph_objs.bar.selected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.bar.selected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.bar.selected.Marker instance or dict + with compatible properties + textfont + plotly.graph_objs.bar.selected.Textfont instance or + dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.bar.Selected + marker + plotly.graph_objs.bar.selected.Marker instance or dict + with compatible properties + textfont + plotly.graph_objs.bar.selected.Textfont instance or + dict with compatible properties + + Returns + ------- + Selected + """ + super(Selected, self).__init__('selected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.Selected +constructor must be a dict or +an instance of plotly.graph_objs.bar.Selected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar import (selected as v_selected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_selected.MarkerValidator() + self._validators['textfont'] = v_selected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Outsidetextfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Outsidetextfont object + + Sets the font used for `text` lying outside the bar. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.bar.Outsidetextfont + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Outsidetextfont + """ + super(Outsidetextfont, self).__init__('outsidetextfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.Outsidetextfont +constructor must be a dict or +an instance of plotly.graph_objs.bar.Outsidetextfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar import ( + outsidetextfont as v_outsidetextfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_outsidetextfont.ColorValidator() + self._validators['colorsrc'] = v_outsidetextfont.ColorsrcValidator() + self._validators['family'] = v_outsidetextfont.FamilyValidator() + self._validators['familysrc'] = v_outsidetextfont.FamilysrcValidator() + self._validators['size'] = v_outsidetextfont.SizeValidator() + self._validators['sizesrc'] = v_outsidetextfont.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color`is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` array are + all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmin` + must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmax` + must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarkercolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to bar.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of 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 + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.bar.marker.colorbar.Tickforma + tstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.bar.marker.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of bar.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.bar.marker.colorbar.Title + instance or dict with compatible properties + titlefont + 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. + titleside + Deprecated: Please use + bar.marker.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.bar.marker.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color`is + set to a numerical array. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At minimum, a mapping for + the lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Greys,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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.bar.marker.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # opacity + # ------- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # opacitysrc + # ---------- + @property + def opacitysrc(self): + """ + Sets the source reference on plot.ly for opacity . + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['opacitysrc'] + + @opacitysrc.setter + def opacitysrc(self, val): + self['opacitysrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color`is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.bar.marker.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + line + plotly.graph_objs.bar.marker.Line instance or dict with + compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorbar=None, + colorscale=None, + colorsrc=None, + line=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.bar.Marker + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.bar.marker.ColorBar instance or dict + with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + line + plotly.graph_objs.bar.marker.Line instance or dict with + compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.Marker +constructor must be a dict or +an instance of plotly.graph_objs.bar.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() + self._validators['cauto'] = v_marker.CautoValidator() + self._validators['cmax'] = v_marker.CmaxValidator() + self._validators['cmid'] = v_marker.CmidValidator() + self._validators['cmin'] = v_marker.CminValidator() + self._validators['color'] = v_marker.ColorValidator() + self._validators['colorbar'] = v_marker.ColorBarValidator() + self._validators['colorscale'] = v_marker.ColorscaleValidator() + self._validators['colorsrc'] = v_marker.ColorsrcValidator() + self._validators['line'] = v_marker.LineValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() + self._validators['reversescale'] = v_marker.ReversescaleValidator() + self._validators['showscale'] = v_marker.ShowscaleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('opacitysrc', None) + self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Insidetextfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Insidetextfont object + + Sets the font used for `text` lying inside the bar. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.bar.Insidetextfont + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Insidetextfont + """ + super(Insidetextfont, self).__init__('insidetextfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.Insidetextfont +constructor must be a dict or +an instance of plotly.graph_objs.bar.Insidetextfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar import (insidetextfont as v_insidetextfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_insidetextfont.ColorValidator() + self._validators['colorsrc'] = v_insidetextfont.ColorsrcValidator() + self._validators['family'] = v_insidetextfont.FamilyValidator() + self._validators['familysrc'] = v_insidetextfont.FamilysrcValidator() + self._validators['size'] = v_insidetextfont.SizeValidator() + self._validators['sizesrc'] = v_insidetextfont.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.bar.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.bar.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.bar.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorY(_BaseTraceHierarchyType): + + # array + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['array'] + + @array.setter + def array(self, val): + self['array'] = val + + # arrayminus + # ---------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['arrayminus'] + + @arrayminus.setter + def arrayminus(self, val): + self['arrayminus'] = val + + # arrayminussrc + # ------------- + @property + def arrayminussrc(self): + """ + Sets the source reference on plot.ly for arrayminus . + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arrayminussrc'] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self['arrayminussrc'] = val + + # arraysrc + # -------- + @property + def arraysrc(self): + """ + Sets the source reference on plot.ly for array . + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arraysrc'] + + @arraysrc.setter + def arraysrc(self, val): + self['arraysrc'] = val + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # symmetric + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['symmetric'] + + @symmetric.setter + def symmetric(self, val): + self['symmetric'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # traceref + # -------- + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['traceref'] + + @traceref.setter + def traceref(self, val): + self['traceref'] = val + + # tracerefminus + # ------------- + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['tracerefminus'] + + @tracerefminus.setter + def tracerefminus(self, val): + self['tracerefminus'] = val + + # type + # ---- + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the sqaure of + the underlying data. If "array", 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # value + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # valueminus + # ---------- + @property + def valueminus(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 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] + + Returns + ------- + int|float + """ + return self['valueminus'] + + @valueminus.setter + def valueminus(self, val): + self['valueminus'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs + ): + """ + Construct a new ErrorY object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.bar.ErrorY + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorY + """ + super(ErrorY, self).__init__('error_y') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.ErrorY +constructor must be a dict or +an instance of plotly.graph_objs.bar.ErrorY""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar import (error_y as v_error_y) + + # Initialize validators + # --------------------- + self._validators['array'] = v_error_y.ArrayValidator() + self._validators['arrayminus'] = v_error_y.ArrayminusValidator() + self._validators['arrayminussrc'] = v_error_y.ArrayminussrcValidator() + self._validators['arraysrc'] = v_error_y.ArraysrcValidator() + self._validators['color'] = v_error_y.ColorValidator() + self._validators['symmetric'] = v_error_y.SymmetricValidator() + self._validators['thickness'] = v_error_y.ThicknessValidator() + self._validators['traceref'] = v_error_y.TracerefValidator() + self._validators['tracerefminus'] = v_error_y.TracerefminusValidator() + self._validators['type'] = v_error_y.TypeValidator() + self._validators['value'] = v_error_y.ValueValidator() + self._validators['valueminus'] = v_error_y.ValueminusValidator() + self._validators['visible'] = v_error_y.VisibleValidator() + self._validators['width'] = v_error_y.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('array', None) + self['array'] = array if array is not None else _v + _v = arg.pop('arrayminus', None) + self['arrayminus'] = arrayminus if arrayminus is not None else _v + _v = arg.pop('arrayminussrc', None) + self['arrayminussrc' + ] = arrayminussrc if arrayminussrc is not None else _v + _v = arg.pop('arraysrc', None) + self['arraysrc'] = arraysrc if arraysrc is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('symmetric', None) + self['symmetric'] = symmetric if symmetric is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('traceref', None) + self['traceref'] = traceref if traceref is not None else _v + _v = arg.pop('tracerefminus', None) + self['tracerefminus' + ] = tracerefminus if tracerefminus is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + _v = arg.pop('valueminus', None) + self['valueminus'] = valueminus if valueminus is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorX(_BaseTraceHierarchyType): + + # array + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['array'] + + @array.setter + def array(self, val): + self['array'] = val + + # arrayminus + # ---------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['arrayminus'] + + @arrayminus.setter + def arrayminus(self, val): + self['arrayminus'] = val + + # arrayminussrc + # ------------- + @property + def arrayminussrc(self): + """ + Sets the source reference on plot.ly for arrayminus . + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arrayminussrc'] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self['arrayminussrc'] = val + + # arraysrc + # -------- + @property + def arraysrc(self): + """ + Sets the source reference on plot.ly for array . + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arraysrc'] + + @arraysrc.setter + def arraysrc(self, val): + self['arraysrc'] = val + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # copy_ystyle + # ----------- + @property + def copy_ystyle(self): + """ + The 'copy_ystyle' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['copy_ystyle'] + + @copy_ystyle.setter + def copy_ystyle(self, val): + self['copy_ystyle'] = val + + # symmetric + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['symmetric'] + + @symmetric.setter + def symmetric(self, val): + self['symmetric'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # traceref + # -------- + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['traceref'] + + @traceref.setter + def traceref(self, val): + self['traceref'] = val + + # tracerefminus + # ------------- + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['tracerefminus'] + + @tracerefminus.setter + def tracerefminus(self, val): + self['tracerefminus'] = val + + # type + # ---- + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the sqaure of + the underlying data. If "array", 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # value + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # valueminus + # ---------- + @property + def valueminus(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 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] + + Returns + ------- + int|float + """ + return self['valueminus'] + + @valueminus.setter + def valueminus(self, val): + self['valueminus'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + copy_ystyle=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs + ): + """ + Construct a new ErrorX object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.bar.ErrorX + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorX + """ + super(ErrorX, self).__init__('error_x') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.ErrorX +constructor must be a dict or +an instance of plotly.graph_objs.bar.ErrorX""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar import (error_x as v_error_x) + + # Initialize validators + # --------------------- + self._validators['array'] = v_error_x.ArrayValidator() + self._validators['arrayminus'] = v_error_x.ArrayminusValidator() + self._validators['arrayminussrc'] = v_error_x.ArrayminussrcValidator() + self._validators['arraysrc'] = v_error_x.ArraysrcValidator() + self._validators['color'] = v_error_x.ColorValidator() + self._validators['copy_ystyle'] = v_error_x.CopyYstyleValidator() + self._validators['symmetric'] = v_error_x.SymmetricValidator() + self._validators['thickness'] = v_error_x.ThicknessValidator() + self._validators['traceref'] = v_error_x.TracerefValidator() + self._validators['tracerefminus'] = v_error_x.TracerefminusValidator() + self._validators['type'] = v_error_x.TypeValidator() + self._validators['value'] = v_error_x.ValueValidator() + self._validators['valueminus'] = v_error_x.ValueminusValidator() + self._validators['visible'] = v_error_x.VisibleValidator() + self._validators['width'] = v_error_x.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('array', None) + self['array'] = array if array is not None else _v + _v = arg.pop('arrayminus', None) + self['arrayminus'] = arrayminus if arrayminus is not None else _v + _v = arg.pop('arrayminussrc', None) + self['arrayminussrc' + ] = arrayminussrc if arrayminussrc is not None else _v + _v = arg.pop('arraysrc', None) + self['arraysrc'] = arraysrc if arraysrc is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('copy_ystyle', None) + self['copy_ystyle'] = copy_ystyle if copy_ystyle is not None else _v + _v = arg.pop('symmetric', None) + self['symmetric'] = symmetric if symmetric is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('traceref', None) + self['traceref'] = traceref if traceref is not None else _v + _v = arg.pop('tracerefminus', None) + self['tracerefminus' + ] = tracerefminus if tracerefminus is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + _v = arg.pop('valueminus', None) + self['valueminus'] = valueminus if valueminus is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.bar import unselected -from ._textfont import Textfont -from ._stream import Stream -from ._selected import Selected from plotly.graph_objs.bar import selected -from ._outsidetextfont import Outsidetextfont -from ._marker import Marker from plotly.graph_objs.bar import marker -from ._insidetextfont import Insidetextfont -from ._hoverlabel import Hoverlabel from plotly.graph_objs.bar import hoverlabel -from ._error_y import ErrorY -from ._error_x import ErrorX diff --git a/plotly/graph_objs/bar/_error_x.py b/plotly/graph_objs/bar/_error_x.py deleted file mode 100644 index 2a923c3c161..00000000000 --- a/plotly/graph_objs/bar/_error_x.py +++ /dev/null @@ -1,597 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ErrorX(BaseTraceHierarchyType): - - # array - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['array'] - - @array.setter - def array(self, val): - self['array'] = val - - # arrayminus - # ---------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['arrayminus'] - - @arrayminus.setter - def arrayminus(self, val): - self['arrayminus'] = val - - # arrayminussrc - # ------------- - @property - def arrayminussrc(self): - """ - Sets the source reference on plot.ly for arrayminus . - - The 'arrayminussrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arrayminussrc'] - - @arrayminussrc.setter - def arrayminussrc(self, val): - self['arrayminussrc'] = val - - # arraysrc - # -------- - @property - def arraysrc(self): - """ - Sets the source reference on plot.ly for array . - - The 'arraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arraysrc'] - - @arraysrc.setter - def arraysrc(self, val): - self['arraysrc'] = val - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # copy_ystyle - # ----------- - @property - def copy_ystyle(self): - """ - The 'copy_ystyle' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['copy_ystyle'] - - @copy_ystyle.setter - def copy_ystyle(self, val): - self['copy_ystyle'] = val - - # symmetric - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['symmetric'] - - @symmetric.setter - def symmetric(self, val): - self['symmetric'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # traceref - # -------- - @property - def traceref(self): - """ - The 'traceref' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['traceref'] - - @traceref.setter - def traceref(self, val): - self['traceref'] = val - - # tracerefminus - # ------------- - @property - def tracerefminus(self): - """ - The 'tracerefminus' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['tracerefminus'] - - @tracerefminus.setter - def tracerefminus(self, val): - self['tracerefminus'] = val - - # type - # ---- - @property - def type(self): - """ - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. Set this - constant in `value`. If "percent", the bar lengths correspond - to a percentage of underlying data. Set this percentage in - `value`. If "sqrt", the bar lengths correspond to the sqaure of - the underlying data. If "array", 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # value - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # valueminus - # ---------- - @property - def valueminus(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 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] - - Returns - ------- - int|float - """ - return self['valueminus'] - - @valueminus.setter - def valueminus(self, val): - self['valueminus'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - copy_ystyle - - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - """ - - def __init__( - self, - arg=None, - array=None, - arrayminus=None, - arrayminussrc=None, - arraysrc=None, - color=None, - copy_ystyle=None, - symmetric=None, - thickness=None, - traceref=None, - tracerefminus=None, - type=None, - value=None, - valueminus=None, - visible=None, - width=None, - **kwargs - ): - """ - Construct a new ErrorX object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.ErrorX - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - copy_ystyle - - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - - Returns - ------- - ErrorX - """ - super(ErrorX, self).__init__('error_x') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.ErrorX -constructor must be a dict or -an instance of plotly.graph_objs.bar.ErrorX""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar import (error_x as v_error_x) - - # Initialize validators - # --------------------- - self._validators['array'] = v_error_x.ArrayValidator() - self._validators['arrayminus'] = v_error_x.ArrayminusValidator() - self._validators['arrayminussrc'] = v_error_x.ArrayminussrcValidator() - self._validators['arraysrc'] = v_error_x.ArraysrcValidator() - self._validators['color'] = v_error_x.ColorValidator() - self._validators['copy_ystyle'] = v_error_x.CopyYstyleValidator() - self._validators['symmetric'] = v_error_x.SymmetricValidator() - self._validators['thickness'] = v_error_x.ThicknessValidator() - self._validators['traceref'] = v_error_x.TracerefValidator() - self._validators['tracerefminus'] = v_error_x.TracerefminusValidator() - self._validators['type'] = v_error_x.TypeValidator() - self._validators['value'] = v_error_x.ValueValidator() - self._validators['valueminus'] = v_error_x.ValueminusValidator() - self._validators['visible'] = v_error_x.VisibleValidator() - self._validators['width'] = v_error_x.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('array', None) - self['array'] = array if array is not None else _v - _v = arg.pop('arrayminus', None) - self['arrayminus'] = arrayminus if arrayminus is not None else _v - _v = arg.pop('arrayminussrc', None) - self['arrayminussrc' - ] = arrayminussrc if arrayminussrc is not None else _v - _v = arg.pop('arraysrc', None) - self['arraysrc'] = arraysrc if arraysrc is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('copy_ystyle', None) - self['copy_ystyle'] = copy_ystyle if copy_ystyle is not None else _v - _v = arg.pop('symmetric', None) - self['symmetric'] = symmetric if symmetric is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('traceref', None) - self['traceref'] = traceref if traceref is not None else _v - _v = arg.pop('tracerefminus', None) - self['tracerefminus' - ] = tracerefminus if tracerefminus is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - _v = arg.pop('valueminus', None) - self['valueminus'] = valueminus if valueminus is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/_error_y.py b/plotly/graph_objs/bar/_error_y.py deleted file mode 100644 index 019ce081625..00000000000 --- a/plotly/graph_objs/bar/_error_y.py +++ /dev/null @@ -1,571 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ErrorY(BaseTraceHierarchyType): - - # array - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['array'] - - @array.setter - def array(self, val): - self['array'] = val - - # arrayminus - # ---------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['arrayminus'] - - @arrayminus.setter - def arrayminus(self, val): - self['arrayminus'] = val - - # arrayminussrc - # ------------- - @property - def arrayminussrc(self): - """ - Sets the source reference on plot.ly for arrayminus . - - The 'arrayminussrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arrayminussrc'] - - @arrayminussrc.setter - def arrayminussrc(self, val): - self['arrayminussrc'] = val - - # arraysrc - # -------- - @property - def arraysrc(self): - """ - Sets the source reference on plot.ly for array . - - The 'arraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arraysrc'] - - @arraysrc.setter - def arraysrc(self, val): - self['arraysrc'] = val - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # symmetric - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['symmetric'] - - @symmetric.setter - def symmetric(self, val): - self['symmetric'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # traceref - # -------- - @property - def traceref(self): - """ - The 'traceref' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['traceref'] - - @traceref.setter - def traceref(self, val): - self['traceref'] = val - - # tracerefminus - # ------------- - @property - def tracerefminus(self): - """ - The 'tracerefminus' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['tracerefminus'] - - @tracerefminus.setter - def tracerefminus(self, val): - self['tracerefminus'] = val - - # type - # ---- - @property - def type(self): - """ - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. Set this - constant in `value`. If "percent", the bar lengths correspond - to a percentage of underlying data. Set this percentage in - `value`. If "sqrt", the bar lengths correspond to the sqaure of - the underlying data. If "array", 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # value - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # valueminus - # ---------- - @property - def valueminus(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 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] - - Returns - ------- - int|float - """ - return self['valueminus'] - - @valueminus.setter - def valueminus(self, val): - self['valueminus'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - """ - - def __init__( - self, - arg=None, - array=None, - arrayminus=None, - arrayminussrc=None, - arraysrc=None, - color=None, - symmetric=None, - thickness=None, - traceref=None, - tracerefminus=None, - type=None, - value=None, - valueminus=None, - visible=None, - width=None, - **kwargs - ): - """ - Construct a new ErrorY object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.ErrorY - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - - Returns - ------- - ErrorY - """ - super(ErrorY, self).__init__('error_y') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.ErrorY -constructor must be a dict or -an instance of plotly.graph_objs.bar.ErrorY""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar import (error_y as v_error_y) - - # Initialize validators - # --------------------- - self._validators['array'] = v_error_y.ArrayValidator() - self._validators['arrayminus'] = v_error_y.ArrayminusValidator() - self._validators['arrayminussrc'] = v_error_y.ArrayminussrcValidator() - self._validators['arraysrc'] = v_error_y.ArraysrcValidator() - self._validators['color'] = v_error_y.ColorValidator() - self._validators['symmetric'] = v_error_y.SymmetricValidator() - self._validators['thickness'] = v_error_y.ThicknessValidator() - self._validators['traceref'] = v_error_y.TracerefValidator() - self._validators['tracerefminus'] = v_error_y.TracerefminusValidator() - self._validators['type'] = v_error_y.TypeValidator() - self._validators['value'] = v_error_y.ValueValidator() - self._validators['valueminus'] = v_error_y.ValueminusValidator() - self._validators['visible'] = v_error_y.VisibleValidator() - self._validators['width'] = v_error_y.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('array', None) - self['array'] = array if array is not None else _v - _v = arg.pop('arrayminus', None) - self['arrayminus'] = arrayminus if arrayminus is not None else _v - _v = arg.pop('arrayminussrc', None) - self['arrayminussrc' - ] = arrayminussrc if arrayminussrc is not None else _v - _v = arg.pop('arraysrc', None) - self['arraysrc'] = arraysrc if arraysrc is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('symmetric', None) - self['symmetric'] = symmetric if symmetric is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('traceref', None) - self['traceref'] = traceref if traceref is not None else _v - _v = arg.pop('tracerefminus', None) - self['tracerefminus' - ] = tracerefminus if tracerefminus is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - _v = arg.pop('valueminus', None) - self['valueminus'] = valueminus if valueminus is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/_hoverlabel.py b/plotly/graph_objs/bar/_hoverlabel.py deleted file mode 100644 index f55a58f3d54..00000000000 --- a/plotly/graph_objs/bar/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.bar.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.bar.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/_insidetextfont.py b/plotly/graph_objs/bar/_insidetextfont.py deleted file mode 100644 index 3ff7c6b1d00..00000000000 --- a/plotly/graph_objs/bar/_insidetextfont.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Insidetextfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Insidetextfont object - - Sets the font used for `text` lying inside the bar. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.Insidetextfont - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Insidetextfont - """ - super(Insidetextfont, self).__init__('insidetextfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.Insidetextfont -constructor must be a dict or -an instance of plotly.graph_objs.bar.Insidetextfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar import (insidetextfont as v_insidetextfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_insidetextfont.ColorValidator() - self._validators['colorsrc'] = v_insidetextfont.ColorsrcValidator() - self._validators['family'] = v_insidetextfont.FamilyValidator() - self._validators['familysrc'] = v_insidetextfont.FamilysrcValidator() - self._validators['size'] = v_insidetextfont.SizeValidator() - self._validators['sizesrc'] = v_insidetextfont.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/_marker.py b/plotly/graph_objs/bar/_marker.py deleted file mode 100644 index b2086461796..00000000000 --- a/plotly/graph_objs/bar/_marker.py +++ /dev/null @@ -1,949 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in `marker.color`is - set to a numerical array. In case `colorscale` is unspecified - or `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` array are - all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.color`) or the - bounds set in `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical array. Defaults - to `false` when `marker.cmin` and `marker.cmax` are set by the - user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmin` - must be set as well. - - The 'cmax' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling `marker.cmin` - and/or `marker.cmax` to be equidistant to this point. Has an - effect only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color`. Has no - effect when `marker.cauto` is `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmax` - must be set as well. - - The 'cmin' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarkercolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to bar.marker.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of 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 - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.bar.marker.colorbar.Tickforma - tstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.bar.marker.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of bar.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.bar.marker.colorbar.Title - instance or dict with compatible properties - titlefont - 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. - titleside - Deprecated: Please use - bar.marker.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.bar.marker.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in `marker.color`is - set to a numerical array. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At minimum, a mapping for - the lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` - may be a palette name string of the following list: Greys,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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.bar.marker.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # opacity - # ------- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # opacitysrc - # ---------- - @property - def opacitysrc(self): - """ - Sets the source reference on plot.ly for opacity . - - The 'opacitysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['opacitysrc'] - - @opacitysrc.setter - def opacitysrc(self, val): - self['opacitysrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.color`is set to a numerical array. If true, - `marker.cmin` will correspond to the last color in the array - and `marker.cmax` will correspond to the first color. - - The 'reversescale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.bar.marker.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - line - plotly.graph_objs.bar.marker.Line instance or dict with - compatible properties - opacity - Sets the opacity of the bars. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorbar=None, - colorscale=None, - colorsrc=None, - line=None, - opacity=None, - opacitysrc=None, - reversescale=None, - showscale=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.Marker - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.bar.marker.ColorBar instance or dict - with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - line - plotly.graph_objs.bar.marker.Line instance or dict with - compatible properties - opacity - Sets the opacity of the bars. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.Marker -constructor must be a dict or -an instance of plotly.graph_objs.bar.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() - self._validators['cauto'] = v_marker.CautoValidator() - self._validators['cmax'] = v_marker.CmaxValidator() - self._validators['cmid'] = v_marker.CmidValidator() - self._validators['cmin'] = v_marker.CminValidator() - self._validators['color'] = v_marker.ColorValidator() - self._validators['colorbar'] = v_marker.ColorBarValidator() - self._validators['colorscale'] = v_marker.ColorscaleValidator() - self._validators['colorsrc'] = v_marker.ColorsrcValidator() - self._validators['line'] = v_marker.LineValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() - self._validators['reversescale'] = v_marker.ReversescaleValidator() - self._validators['showscale'] = v_marker.ShowscaleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('opacitysrc', None) - self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/_outsidetextfont.py b/plotly/graph_objs/bar/_outsidetextfont.py deleted file mode 100644 index ce74955ff00..00000000000 --- a/plotly/graph_objs/bar/_outsidetextfont.py +++ /dev/null @@ -1,321 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Outsidetextfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Outsidetextfont object - - Sets the font used for `text` lying outside the bar. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.Outsidetextfont - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Outsidetextfont - """ - super(Outsidetextfont, self).__init__('outsidetextfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.Outsidetextfont -constructor must be a dict or -an instance of plotly.graph_objs.bar.Outsidetextfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar import ( - outsidetextfont as v_outsidetextfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_outsidetextfont.ColorValidator() - self._validators['colorsrc'] = v_outsidetextfont.ColorsrcValidator() - self._validators['family'] = v_outsidetextfont.FamilyValidator() - self._validators['familysrc'] = v_outsidetextfont.FamilysrcValidator() - self._validators['size'] = v_outsidetextfont.SizeValidator() - self._validators['sizesrc'] = v_outsidetextfont.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/_selected.py b/plotly/graph_objs/bar/_selected.py deleted file mode 100644 index 98ac2c031b2..00000000000 --- a/plotly/graph_objs/bar/_selected.py +++ /dev/null @@ -1,144 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Selected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - Sets the marker opacity of selected points. - - Returns - ------- - plotly.graph_objs.bar.selected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.bar.selected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.bar.selected.Marker instance or dict - with compatible properties - textfont - plotly.graph_objs.bar.selected.Textfont instance or - dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Selected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.Selected - marker - plotly.graph_objs.bar.selected.Marker instance or dict - with compatible properties - textfont - plotly.graph_objs.bar.selected.Textfont instance or - dict with compatible properties - - Returns - ------- - Selected - """ - super(Selected, self).__init__('selected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.Selected -constructor must be a dict or -an instance of plotly.graph_objs.bar.Selected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar import (selected as v_selected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_selected.MarkerValidator() - self._validators['textfont'] = v_selected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/_stream.py b/plotly/graph_objs/bar/_stream.py deleted file mode 100644 index 975e1985390..00000000000 --- a/plotly/graph_objs/bar/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.Stream -constructor must be a dict or -an instance of plotly.graph_objs.bar.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/_textfont.py b/plotly/graph_objs/bar/_textfont.py deleted file mode 100644 index 603cc5dddaa..00000000000 --- a/plotly/graph_objs/bar/_textfont.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Textfont object - - Sets the font used for `text`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.Textfont - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.bar.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar import (textfont as v_textfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - self._validators['colorsrc'] = v_textfont.ColorsrcValidator() - self._validators['family'] = v_textfont.FamilyValidator() - self._validators['familysrc'] = v_textfont.FamilysrcValidator() - self._validators['size'] = v_textfont.SizeValidator() - self._validators['sizesrc'] = v_textfont.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/_unselected.py b/plotly/graph_objs/bar/_unselected.py deleted file mode 100644 index 6945a224448..00000000000 --- a/plotly/graph_objs/bar/_unselected.py +++ /dev/null @@ -1,147 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Unselected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - - Returns - ------- - plotly.graph_objs.bar.unselected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.bar.unselected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.bar.unselected.Marker instance or - dict with compatible properties - textfont - plotly.graph_objs.bar.unselected.Textfont instance or - dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Unselected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.Unselected - marker - plotly.graph_objs.bar.unselected.Marker instance or - dict with compatible properties - textfont - plotly.graph_objs.bar.unselected.Textfont instance or - dict with compatible properties - - Returns - ------- - Unselected - """ - super(Unselected, self).__init__('unselected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.Unselected -constructor must be a dict or -an instance of plotly.graph_objs.bar.Unselected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar import (unselected as v_unselected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_unselected.MarkerValidator() - self._validators['textfont'] = v_unselected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/hoverlabel/__init__.py b/plotly/graph_objs/bar/hoverlabel/__init__.py index c37b8b5cd28..92bbf93d5c7 100644 --- a/plotly/graph_objs/bar/hoverlabel/__init__.py +++ b/plotly/graph_objs/bar/hoverlabel/__init__.py @@ -1 +1,321 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.bar.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.bar.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/bar/hoverlabel/_font.py b/plotly/graph_objs/bar/hoverlabel/_font.py deleted file mode 100644 index 96eae10bde6..00000000000 --- a/plotly/graph_objs/bar/hoverlabel/_font.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.bar.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/marker/__init__.py b/plotly/graph_objs/bar/marker/__init__.py index e11d61b568a..4415daac8dc 100644 --- a/plotly/graph_objs/bar/marker/__init__.py +++ b/plotly/graph_objs/bar/marker/__init__.py @@ -1,3 +1,2441 @@ -from ._line import Line -from ._colorbar import ColorBar + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + 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) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color`is + 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 + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarker.linecolor. It accepts either a specific color or + an array of numbers that are mapped to the colorscale relative + to the max and min values of the array or relative to + `marker.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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to bar.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized value + to an rgb, rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and highest (1) values + are required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color`is set to a numerical array. If true, + `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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.bar.marker.Line + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.marker.Line +constructor must be a dict or +an instance of plotly.graph_objs.bar.marker.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar.marker import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() + self._validators['cauto'] = v_line.CautoValidator() + self._validators['cmax'] = v_line.CmaxValidator() + self._validators['cmid'] = v_line.CmidValidator() + self._validators['cmin'] = v_line.CminValidator() + self._validators['color'] = v_line.ColorValidator() + self._validators['colorscale'] = v_line.ColorscaleValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['reversescale'] = v_line.ReversescaleValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.bar.marker.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.bar.marker.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + 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 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 + ------- + plotly.graph_objs.bar.marker.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.bar.marker.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use bar.marker.colorbar.title.side instead. + Determines the location of color bar's title with respect to + the color bar. Note that the title's location used to be set by + the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.bar.marker.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.bar.ma + rker.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + bar.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.bar.marker.colorbar.Title instance or + dict with compatible properties + titlefont + 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. + titleside + Deprecated: Please use bar.marker.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.bar.marker.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.bar.marker.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.bar.ma + rker.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + bar.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.bar.marker.colorbar.Title instance or + dict with compatible properties + titlefont + 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. + titleside + Deprecated: Please use bar.marker.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.marker.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.bar.marker.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar.marker import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.bar.marker import colorbar diff --git a/plotly/graph_objs/bar/marker/_colorbar.py b/plotly/graph_objs/bar/marker/_colorbar.py deleted file mode 100644 index 5749fd35c8e..00000000000 --- a/plotly/graph_objs/bar/marker/_colorbar.py +++ /dev/null @@ -1,1862 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.bar.marker.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.bar.marker.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - 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 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 - ------- - plotly.graph_objs.bar.marker.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.bar.marker.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use bar.marker.colorbar.title.side instead. - Determines the location of color bar's title with respect to - the color bar. Note that the title's location used to be set by - the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.bar.marker.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.bar.ma - rker.colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - bar.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.bar.marker.colorbar.Title instance or - dict with compatible properties - titlefont - 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. - titleside - Deprecated: Please use bar.marker.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.marker.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.bar.marker.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.bar.ma - rker.colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - bar.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.bar.marker.colorbar.Title instance or - dict with compatible properties - titlefont - 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. - titleside - Deprecated: Please use bar.marker.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.marker.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.bar.marker.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar.marker import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/marker/_line.py b/plotly/graph_objs/bar/marker/_line.py deleted file mode 100644 index b3048b2aad4..00000000000 --- a/plotly/graph_objs/bar/marker/_line.py +++ /dev/null @@ -1,572 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is true, the - default palette will be chosen according to whether numbers in - the `color` array are all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.line.color`) or the - bounds set in `marker.line.cmin` and `marker.line.cmax` Has an - 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) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be equidistant - to this point. Has an effect only if in `marker.line.color`is - 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 - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarker.linecolor. It accepts either a specific color or - an array of numbers that are mapped to the colorscale relative - to the max and min values of the array or relative to - `marker.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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to bar.marker.line.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized value - to an rgb, rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and highest (1) values - are required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the colorscale in - color space, use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.line.color`is set to a numerical array. If true, - `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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorscale=None, - colorsrc=None, - reversescale=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.marker.Line - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.marker.Line -constructor must be a dict or -an instance of plotly.graph_objs.bar.marker.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar.marker import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() - self._validators['cauto'] = v_line.CautoValidator() - self._validators['cmax'] = v_line.CmaxValidator() - self._validators['cmid'] = v_line.CmidValidator() - self._validators['cmin'] = v_line.CminValidator() - self._validators['color'] = v_line.ColorValidator() - self._validators['colorscale'] = v_line.ColorscaleValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['reversescale'] = v_line.ReversescaleValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/marker/colorbar/__init__.py b/plotly/graph_objs/bar/marker/colorbar/__init__.py index b0a2f9661ed..66d2df5344c 100644 --- a/plotly/graph_objs/bar/marker/colorbar/__init__.py +++ b/plotly/graph_objs/bar/marker/colorbar/__init__.py @@ -1,4 +1,723 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.bar.marker.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.bar.marker.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.marker.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.bar.marker.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar.marker.colorbar import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.bar.marker.colorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.bar.marker.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar.marker.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.bar.marker.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.marker.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.bar.marker.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar.marker.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.bar.marker.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/bar/marker/colorbar/_tickfont.py b/plotly/graph_objs/bar/marker/colorbar/_tickfont.py deleted file mode 100644 index fb0a02d8800..00000000000 --- a/plotly/graph_objs/bar/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.bar.marker.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.marker.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.bar.marker.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar.marker.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py deleted file mode 100644 index 2ec155427ef..00000000000 --- a/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.bar.marker.colorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.marker.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.bar.marker.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar.marker.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/marker/colorbar/_title.py b/plotly/graph_objs/bar/marker/colorbar/_title.py deleted file mode 100644 index 23ea8e7f0c7..00000000000 --- a/plotly/graph_objs/bar/marker/colorbar/_title.py +++ /dev/null @@ -1,202 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.bar.marker.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.bar.marker.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.marker.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.bar.marker.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar.marker.colorbar import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/marker/colorbar/title/__init__.py b/plotly/graph_objs/bar/marker/colorbar/title/__init__.py index c37b8b5cd28..b45676419af 100644 --- a/plotly/graph_objs/bar/marker/colorbar/title/__init__.py +++ b/plotly/graph_objs/bar/marker/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar.marker.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.bar.marker.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.marker.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.bar.marker.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar.marker.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/bar/marker/colorbar/title/_font.py b/plotly/graph_objs/bar/marker/colorbar/title/_font.py deleted file mode 100644 index 1985bff869e..00000000000 --- a/plotly/graph_objs/bar/marker/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar.marker.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.bar.marker.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.marker.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.bar.marker.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar.marker.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/selected/__init__.py b/plotly/graph_objs/bar/selected/__init__.py index adba53218ca..bb957242060 100644 --- a/plotly/graph_objs/bar/selected/__init__.py +++ b/plotly/graph_objs/bar/selected/__init__.py @@ -1,2 +1,307 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.bar.selected.Textfont + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.selected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.bar.selected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar.selected import (textfont as v_textfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.bar.selected.Marker + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.selected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.bar.selected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar.selected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/bar/selected/_marker.py b/plotly/graph_objs/bar/selected/_marker.py deleted file mode 100644 index 851eb1f0525..00000000000 --- a/plotly/graph_objs/bar/selected/_marker.py +++ /dev/null @@ -1,165 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - """ - - def __init__(self, arg=None, color=None, opacity=None, **kwargs): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.selected.Marker - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.selected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.bar.selected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar.selected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/selected/_textfont.py b/plotly/graph_objs/bar/selected/_textfont.py deleted file mode 100644 index 2ced5cd935d..00000000000 --- a/plotly/graph_objs/bar/selected/_textfont.py +++ /dev/null @@ -1,138 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of selected points. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.selected.Textfont - color - Sets the text font color of selected points. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.selected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.bar.selected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar.selected import (textfont as v_textfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/unselected/__init__.py b/plotly/graph_objs/bar/unselected/__init__.py index adba53218ca..ded33040b2e 100644 --- a/plotly/graph_objs/bar/unselected/__init__.py +++ b/plotly/graph_objs/bar/unselected/__init__.py @@ -1,2 +1,317 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.bar.unselected.Textfont + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.unselected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.bar.unselected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar.unselected import (textfont as v_textfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'bar.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.bar.unselected.Marker + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.bar.unselected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.bar.unselected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.bar.unselected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/bar/unselected/_marker.py b/plotly/graph_objs/bar/unselected/_marker.py deleted file mode 100644 index 766f94438f6..00000000000 --- a/plotly/graph_objs/bar/unselected/_marker.py +++ /dev/null @@ -1,171 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - """ - - def __init__(self, arg=None, color=None, opacity=None, **kwargs): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.bar.unselected.Marker - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.unselected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.bar.unselected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar.unselected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/bar/unselected/_textfont.py b/plotly/graph_objs/bar/unselected/_textfont.py deleted file mode 100644 index 0a6178cdad2..00000000000 --- a/plotly/graph_objs/bar/unselected/_textfont.py +++ /dev/null @@ -1,142 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'bar.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of unselected points, applied - only when a selection exists. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.bar.unselected.Textfont - color - Sets the text font color of unselected points, applied - only when a selection exists. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.bar.unselected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.bar.unselected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.bar.unselected import (textfont as v_textfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/__init__.py b/plotly/graph_objs/barpolar/__init__.py index 9813a5b92b0..8cabf448aa5 100644 --- a/plotly/graph_objs/barpolar/__init__.py +++ b/plotly/graph_objs/barpolar/__init__.py @@ -1,9 +1,1810 @@ -from ._unselected import Unselected + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + + Returns + ------- + plotly.graph_objs.barpolar.unselected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.barpolar.unselected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'barpolar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.barpolar.unselected.Marker instance + or dict with compatible properties + textfont + plotly.graph_objs.barpolar.unselected.Textfont instance + or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.barpolar.Unselected + marker + plotly.graph_objs.barpolar.unselected.Marker instance + or dict with compatible properties + textfont + plotly.graph_objs.barpolar.unselected.Textfont instance + or dict with compatible properties + + Returns + ------- + Unselected + """ + super(Unselected, self).__init__('unselected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.barpolar.Unselected +constructor must be a dict or +an instance of plotly.graph_objs.barpolar.Unselected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.barpolar import (unselected as v_unselected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_unselected.MarkerValidator() + self._validators['textfont'] = v_unselected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'barpolar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.barpolar.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.barpolar.Stream +constructor must be a dict or +an instance of plotly.graph_objs.barpolar.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.barpolar import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + Sets the marker opacity of selected points. + + Returns + ------- + plotly.graph_objs.barpolar.selected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.barpolar.selected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'barpolar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.barpolar.selected.Marker instance or + dict with compatible properties + textfont + plotly.graph_objs.barpolar.selected.Textfont instance + or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.barpolar.Selected + marker + plotly.graph_objs.barpolar.selected.Marker instance or + dict with compatible properties + textfont + plotly.graph_objs.barpolar.selected.Textfont instance + or dict with compatible properties + + Returns + ------- + Selected + """ + super(Selected, self).__init__('selected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.barpolar.Selected +constructor must be a dict or +an instance of plotly.graph_objs.barpolar.Selected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.barpolar import (selected as v_selected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_selected.MarkerValidator() + self._validators['textfont'] = v_selected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color`is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` array are + all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmin` + must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmax` + must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarkercolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to barpolar.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of 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 + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.barpolar.marker.colorbar.Tick + formatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.barpolar.marker.colorbar.tickformatstopdefaul + ts), sets the default property values to use + for elements of + barpolar.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.barpolar.marker.colorbar.Titl + e instance or dict with compatible properties + titlefont + Deprecated: Please use + barpolar.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. + titleside + Deprecated: Please use + barpolar.marker.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.barpolar.marker.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color`is + set to a numerical array. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At minimum, a mapping for + the lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Greys,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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.barpolar.marker.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # opacity + # ------- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # opacitysrc + # ---------- + @property + def opacitysrc(self): + """ + Sets the source reference on plot.ly for opacity . + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['opacitysrc'] + + @opacitysrc.setter + def opacitysrc(self, val): + self['opacitysrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color`is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'barpolar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.barpolar.marker.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + line + plotly.graph_objs.barpolar.marker.Line instance or dict + with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorbar=None, + colorscale=None, + colorsrc=None, + line=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.barpolar.Marker + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.barpolar.marker.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + line + plotly.graph_objs.barpolar.marker.Line instance or dict + with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.barpolar.Marker +constructor must be a dict or +an instance of plotly.graph_objs.barpolar.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.barpolar import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() + self._validators['cauto'] = v_marker.CautoValidator() + self._validators['cmax'] = v_marker.CmaxValidator() + self._validators['cmid'] = v_marker.CmidValidator() + self._validators['cmin'] = v_marker.CminValidator() + self._validators['color'] = v_marker.ColorValidator() + self._validators['colorbar'] = v_marker.ColorBarValidator() + self._validators['colorscale'] = v_marker.ColorscaleValidator() + self._validators['colorsrc'] = v_marker.ColorsrcValidator() + self._validators['line'] = v_marker.LineValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() + self._validators['reversescale'] = v_marker.ReversescaleValidator() + self._validators['showscale'] = v_marker.ShowscaleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('opacitysrc', None) + self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.barpolar.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'barpolar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.barpolar.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.barpolar.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.barpolar.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.barpolar import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.barpolar import unselected -from ._stream import Stream -from ._selected import Selected from plotly.graph_objs.barpolar import selected -from ._marker import Marker from plotly.graph_objs.barpolar import marker -from ._hoverlabel import Hoverlabel from plotly.graph_objs.barpolar import hoverlabel diff --git a/plotly/graph_objs/barpolar/_hoverlabel.py b/plotly/graph_objs/barpolar/_hoverlabel.py deleted file mode 100644 index 3c2885d7297..00000000000 --- a/plotly/graph_objs/barpolar/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.barpolar.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'barpolar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.barpolar.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.barpolar.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.barpolar.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.barpolar import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/_marker.py b/plotly/graph_objs/barpolar/_marker.py deleted file mode 100644 index d57119359a2..00000000000 --- a/plotly/graph_objs/barpolar/_marker.py +++ /dev/null @@ -1,950 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in `marker.color`is - set to a numerical array. In case `colorscale` is unspecified - or `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` array are - all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.color`) or the - bounds set in `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical array. Defaults - to `false` when `marker.cmin` and `marker.cmax` are set by the - user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmin` - must be set as well. - - The 'cmax' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling `marker.cmin` - and/or `marker.cmax` to be equidistant to this point. Has an - effect only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color`. Has no - effect when `marker.cauto` is `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmax` - must be set as well. - - The 'cmin' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarkercolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to barpolar.marker.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of 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 - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.barpolar.marker.colorbar.Tick - formatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.barpolar.marker.colorbar.tickformatstopdefaul - ts), sets the default property values to use - for elements of - barpolar.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.barpolar.marker.colorbar.Titl - e instance or dict with compatible properties - titlefont - Deprecated: Please use - barpolar.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. - titleside - Deprecated: Please use - barpolar.marker.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.barpolar.marker.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in `marker.color`is - set to a numerical array. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At minimum, a mapping for - the lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` - may be a palette name string of the following list: Greys,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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.barpolar.marker.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # opacity - # ------- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # opacitysrc - # ---------- - @property - def opacitysrc(self): - """ - Sets the source reference on plot.ly for opacity . - - The 'opacitysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['opacitysrc'] - - @opacitysrc.setter - def opacitysrc(self, val): - self['opacitysrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.color`is set to a numerical array. If true, - `marker.cmin` will correspond to the last color in the array - and `marker.cmax` will correspond to the first color. - - The 'reversescale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'barpolar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.barpolar.marker.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - line - plotly.graph_objs.barpolar.marker.Line instance or dict - with compatible properties - opacity - Sets the opacity of the bars. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorbar=None, - colorscale=None, - colorsrc=None, - line=None, - opacity=None, - opacitysrc=None, - reversescale=None, - showscale=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.barpolar.Marker - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.barpolar.marker.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - line - plotly.graph_objs.barpolar.marker.Line instance or dict - with compatible properties - opacity - Sets the opacity of the bars. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.barpolar.Marker -constructor must be a dict or -an instance of plotly.graph_objs.barpolar.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.barpolar import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() - self._validators['cauto'] = v_marker.CautoValidator() - self._validators['cmax'] = v_marker.CmaxValidator() - self._validators['cmid'] = v_marker.CmidValidator() - self._validators['cmin'] = v_marker.CminValidator() - self._validators['color'] = v_marker.ColorValidator() - self._validators['colorbar'] = v_marker.ColorBarValidator() - self._validators['colorscale'] = v_marker.ColorscaleValidator() - self._validators['colorsrc'] = v_marker.ColorsrcValidator() - self._validators['line'] = v_marker.LineValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() - self._validators['reversescale'] = v_marker.ReversescaleValidator() - self._validators['showscale'] = v_marker.ShowscaleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('opacitysrc', None) - self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/_selected.py b/plotly/graph_objs/barpolar/_selected.py deleted file mode 100644 index 294b32bf651..00000000000 --- a/plotly/graph_objs/barpolar/_selected.py +++ /dev/null @@ -1,144 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Selected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - Sets the marker opacity of selected points. - - Returns - ------- - plotly.graph_objs.barpolar.selected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.barpolar.selected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'barpolar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.barpolar.selected.Marker instance or - dict with compatible properties - textfont - plotly.graph_objs.barpolar.selected.Textfont instance - or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Selected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.barpolar.Selected - marker - plotly.graph_objs.barpolar.selected.Marker instance or - dict with compatible properties - textfont - plotly.graph_objs.barpolar.selected.Textfont instance - or dict with compatible properties - - Returns - ------- - Selected - """ - super(Selected, self).__init__('selected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.barpolar.Selected -constructor must be a dict or -an instance of plotly.graph_objs.barpolar.Selected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.barpolar import (selected as v_selected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_selected.MarkerValidator() - self._validators['textfont'] = v_selected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/_stream.py b/plotly/graph_objs/barpolar/_stream.py deleted file mode 100644 index f03df5bd980..00000000000 --- a/plotly/graph_objs/barpolar/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'barpolar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.barpolar.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.barpolar.Stream -constructor must be a dict or -an instance of plotly.graph_objs.barpolar.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.barpolar import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/_unselected.py b/plotly/graph_objs/barpolar/_unselected.py deleted file mode 100644 index 5d55b520823..00000000000 --- a/plotly/graph_objs/barpolar/_unselected.py +++ /dev/null @@ -1,147 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Unselected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - - Returns - ------- - plotly.graph_objs.barpolar.unselected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.barpolar.unselected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'barpolar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.barpolar.unselected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objs.barpolar.unselected.Textfont instance - or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Unselected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.barpolar.Unselected - marker - plotly.graph_objs.barpolar.unselected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objs.barpolar.unselected.Textfont instance - or dict with compatible properties - - Returns - ------- - Unselected - """ - super(Unselected, self).__init__('unselected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.barpolar.Unselected -constructor must be a dict or -an instance of plotly.graph_objs.barpolar.Unselected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.barpolar import (unselected as v_unselected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_unselected.MarkerValidator() - self._validators['textfont'] = v_unselected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/hoverlabel/__init__.py b/plotly/graph_objs/barpolar/hoverlabel/__init__.py index c37b8b5cd28..fc12d8e3a83 100644 --- a/plotly/graph_objs/barpolar/hoverlabel/__init__.py +++ b/plotly/graph_objs/barpolar/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'barpolar.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.barpolar.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.barpolar.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.barpolar.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.barpolar.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/hoverlabel/_font.py b/plotly/graph_objs/barpolar/hoverlabel/_font.py deleted file mode 100644 index 47348735662..00000000000 --- a/plotly/graph_objs/barpolar/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'barpolar.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.barpolar.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.barpolar.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.barpolar.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.barpolar.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/marker/__init__.py b/plotly/graph_objs/barpolar/marker/__init__.py index 125ae9f9051..8371ab837ae 100644 --- a/plotly/graph_objs/barpolar/marker/__init__.py +++ b/plotly/graph_objs/barpolar/marker/__init__.py @@ -1,3 +1,2444 @@ -from ._line import Line -from ._colorbar import ColorBar + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + 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) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color`is + 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 + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarker.linecolor. It accepts either a specific color or + an array of numbers that are mapped to the colorscale relative + to the max and min values of the array or relative to + `marker.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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to barpolar.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized value + to an rgb, rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and highest (1) values + are required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color`is set to a numerical array. If true, + `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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'barpolar.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.barpolar.marker.Line + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.barpolar.marker.Line +constructor must be a dict or +an instance of plotly.graph_objs.barpolar.marker.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.barpolar.marker import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() + self._validators['cauto'] = v_line.CautoValidator() + self._validators['cmax'] = v_line.CmaxValidator() + self._validators['cmid'] = v_line.CmidValidator() + self._validators['cmin'] = v_line.CminValidator() + self._validators['color'] = v_line.ColorValidator() + self._validators['colorscale'] = v_line.ColorscaleValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['reversescale'] = v_line.ReversescaleValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.barpolar.marker.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.barpolar.marke + 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 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 + ------- + plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.barpolar.marker.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use barpolar.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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use barpolar.marker.colorbar.title.side + instead. Determines the location of color bar's title with + respect to the color bar. Note that the title's location used + to be set by the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'barpolar.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.barpolar.marker.colorbar.Tickformatst + op instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.barpol + ar.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + barpolar.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.barpolar.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + barpolar.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. + titleside + Deprecated: Please use + barpolar.marker.colorbar.title.side instead. Determines + the location of color bar's title with respect to the + color bar. Note that the title's location used to be + set by the now deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.barpolar.marker.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.barpolar.marker.colorbar.Tickformatst + op instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.barpol + ar.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + barpolar.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.barpolar.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + barpolar.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. + titleside + Deprecated: Please use + barpolar.marker.colorbar.title.side instead. Determines + the location of color bar's title with respect to the + color bar. Note that the title's location used to be + set by the now deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.barpolar.marker.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.barpolar.marker.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.barpolar.marker import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.barpolar.marker import colorbar diff --git a/plotly/graph_objs/barpolar/marker/_colorbar.py b/plotly/graph_objs/barpolar/marker/_colorbar.py deleted file mode 100644 index 4ccc0b92422..00000000000 --- a/plotly/graph_objs/barpolar/marker/_colorbar.py +++ /dev/null @@ -1,1865 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.barpolar.marker.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.barpolar.marke - 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 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 - ------- - plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.barpolar.marker.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use barpolar.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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use barpolar.marker.colorbar.title.side - instead. Determines the location of color bar's title with - respect to the color bar. Note that the title's location used - to be set by the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'barpolar.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.barpolar.marker.colorbar.Tickformatst - op instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.barpol - ar.marker.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - barpolar.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.barpolar.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - barpolar.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. - titleside - Deprecated: Please use - barpolar.marker.colorbar.title.side instead. Determines - the location of color bar's title with respect to the - color bar. Note that the title's location used to be - set by the now deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.barpolar.marker.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.barpolar.marker.colorbar.Tickformatst - op instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.barpol - ar.marker.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - barpolar.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.barpolar.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - barpolar.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. - titleside - Deprecated: Please use - barpolar.marker.colorbar.title.side instead. Determines - the location of color bar's title with respect to the - color bar. Note that the title's location used to be - set by the now deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.barpolar.marker.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.barpolar.marker.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.barpolar.marker import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/marker/_line.py b/plotly/graph_objs/barpolar/marker/_line.py deleted file mode 100644 index cbc3d16f1bf..00000000000 --- a/plotly/graph_objs/barpolar/marker/_line.py +++ /dev/null @@ -1,572 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is true, the - default palette will be chosen according to whether numbers in - the `color` array are all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.line.color`) or the - bounds set in `marker.line.cmin` and `marker.line.cmax` Has an - 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) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be equidistant - to this point. Has an effect only if in `marker.line.color`is - 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 - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarker.linecolor. It accepts either a specific color or - an array of numbers that are mapped to the colorscale relative - to the max and min values of the array or relative to - `marker.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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to barpolar.marker.line.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized value - to an rgb, rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and highest (1) values - are required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the colorscale in - color space, use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.line.color`is set to a numerical array. If true, - `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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'barpolar.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorscale=None, - colorsrc=None, - reversescale=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.barpolar.marker.Line - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.barpolar.marker.Line -constructor must be a dict or -an instance of plotly.graph_objs.barpolar.marker.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.barpolar.marker import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() - self._validators['cauto'] = v_line.CautoValidator() - self._validators['cmax'] = v_line.CmaxValidator() - self._validators['cmid'] = v_line.CmidValidator() - self._validators['cmin'] = v_line.CminValidator() - self._validators['color'] = v_line.ColorValidator() - self._validators['colorscale'] = v_line.ColorscaleValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['reversescale'] = v_line.ReversescaleValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/marker/colorbar/__init__.py b/plotly/graph_objs/barpolar/marker/colorbar/__init__.py index f23addb9a07..d9215ea65ac 100644 --- a/plotly/graph_objs/barpolar/marker/colorbar/__init__.py +++ b/plotly/graph_objs/barpolar/marker/colorbar/__init__.py @@ -1,4 +1,725 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.barpolar.marker.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'barpolar.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.barpolar.marker.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.barpolar.marker.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.barpolar.marker.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.barpolar.marker.colorbar import ( + title as v_title + ) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'barpolar.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.barpolar.marker.colorb + ar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.barpolar.marker.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'barpolar.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.barpolar.marker.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.barpolar.marker.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.barpolar.marker.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.barpolar.marker.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.barpolar.marker.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/barpolar/marker/colorbar/_tickfont.py b/plotly/graph_objs/barpolar/marker/colorbar/_tickfont.py deleted file mode 100644 index 2d7830391d0..00000000000 --- a/plotly/graph_objs/barpolar/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'barpolar.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.barpolar.marker.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.barpolar.marker.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.barpolar.marker.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.barpolar.marker.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py deleted file mode 100644 index e2d98b3e771..00000000000 --- a/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'barpolar.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.barpolar.marker.colorb - ar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.barpolar.marker.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/marker/colorbar/_title.py b/plotly/graph_objs/barpolar/marker/colorbar/_title.py deleted file mode 100644 index 34a62cada00..00000000000 --- a/plotly/graph_objs/barpolar/marker/colorbar/_title.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.barpolar.marker.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'barpolar.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.barpolar.marker.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.barpolar.marker.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.barpolar.marker.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.barpolar.marker.colorbar import ( - title as v_title - ) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/marker/colorbar/title/__init__.py b/plotly/graph_objs/barpolar/marker/colorbar/title/__init__.py index c37b8b5cd28..45c958fa308 100644 --- a/plotly/graph_objs/barpolar/marker/colorbar/title/__init__.py +++ b/plotly/graph_objs/barpolar/marker/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'barpolar.marker.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.barpolar.marker.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.barpolar.marker.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.barpolar.marker.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.barpolar.marker.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/marker/colorbar/title/_font.py b/plotly/graph_objs/barpolar/marker/colorbar/title/_font.py deleted file mode 100644 index 605994984c2..00000000000 --- a/plotly/graph_objs/barpolar/marker/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'barpolar.marker.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.barpolar.marker.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.barpolar.marker.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.barpolar.marker.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.barpolar.marker.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/selected/__init__.py b/plotly/graph_objs/barpolar/selected/__init__.py index adba53218ca..d6f726b86b5 100644 --- a/plotly/graph_objs/barpolar/selected/__init__.py +++ b/plotly/graph_objs/barpolar/selected/__init__.py @@ -1,2 +1,311 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'barpolar.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.barpolar.selected.Textfont + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.barpolar.selected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.barpolar.selected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.barpolar.selected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'barpolar.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.barpolar.selected.Marker + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.barpolar.selected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.barpolar.selected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.barpolar.selected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/selected/_marker.py b/plotly/graph_objs/barpolar/selected/_marker.py deleted file mode 100644 index 1821df2f907..00000000000 --- a/plotly/graph_objs/barpolar/selected/_marker.py +++ /dev/null @@ -1,166 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'barpolar.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - """ - - def __init__(self, arg=None, color=None, opacity=None, **kwargs): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.barpolar.selected.Marker - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.barpolar.selected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.barpolar.selected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.barpolar.selected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/selected/_textfont.py b/plotly/graph_objs/barpolar/selected/_textfont.py deleted file mode 100644 index 800df5fcca9..00000000000 --- a/plotly/graph_objs/barpolar/selected/_textfont.py +++ /dev/null @@ -1,141 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'barpolar.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of selected points. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.barpolar.selected.Textfont - color - Sets the text font color of selected points. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.barpolar.selected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.barpolar.selected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.barpolar.selected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/unselected/__init__.py b/plotly/graph_objs/barpolar/unselected/__init__.py index adba53218ca..03861d4cd47 100644 --- a/plotly/graph_objs/barpolar/unselected/__init__.py +++ b/plotly/graph_objs/barpolar/unselected/__init__.py @@ -1,2 +1,320 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'barpolar.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.barpolar.unselected.Textfont + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.barpolar.unselected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.barpolar.unselected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.barpolar.unselected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'barpolar.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.barpolar.unselected.Marker + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.barpolar.unselected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.barpolar.unselected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.barpolar.unselected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/unselected/_marker.py b/plotly/graph_objs/barpolar/unselected/_marker.py deleted file mode 100644 index 991b8a996cd..00000000000 --- a/plotly/graph_objs/barpolar/unselected/_marker.py +++ /dev/null @@ -1,172 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'barpolar.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - """ - - def __init__(self, arg=None, color=None, opacity=None, **kwargs): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.barpolar.unselected.Marker - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.barpolar.unselected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.barpolar.unselected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.barpolar.unselected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/barpolar/unselected/_textfont.py b/plotly/graph_objs/barpolar/unselected/_textfont.py deleted file mode 100644 index 18592a06d72..00000000000 --- a/plotly/graph_objs/barpolar/unselected/_textfont.py +++ /dev/null @@ -1,144 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'barpolar.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of unselected points, applied - only when a selection exists. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.barpolar.unselected.Textfont - color - Sets the text font color of unselected points, applied - only when a selection exists. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.barpolar.unselected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.barpolar.unselected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.barpolar.unselected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/box/__init__.py b/plotly/graph_objs/box/__init__.py index 7ba9dd59bc3..ad9d821b839 100644 --- a/plotly/graph_objs/box/__init__.py +++ b/plotly/graph_objs/box/__init__.py @@ -1,10 +1,1388 @@ -from ._unselected import Unselected + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. + + Returns + ------- + plotly.graph_objs.box.unselected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'box' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.box.unselected.Marker instance or + dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.box.Unselected + marker + plotly.graph_objs.box.unselected.Marker instance or + dict with compatible properties + + Returns + ------- + Unselected + """ + super(Unselected, self).__init__('unselected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.box.Unselected +constructor must be a dict or +an instance of plotly.graph_objs.box.Unselected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.box import (unselected as v_unselected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_unselected.MarkerValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'box' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.box.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.box.Stream +constructor must be a dict or +an instance of plotly.graph_objs.box.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.box import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + plotly.graph_objs.box.selected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'box' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.box.selected.Marker instance or dict + with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.box.Selected + marker + plotly.graph_objs.box.selected.Marker instance or dict + with compatible properties + + Returns + ------- + Selected + """ + super(Selected, self).__init__('selected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.box.Selected +constructor must be a dict or +an instance of plotly.graph_objs.box.Selected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.box import (selected as v_selected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_selected.MarkerValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + Sets themarkercolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + 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. + outliercolor + Sets the border line color of the outlier + sample points. Defaults to marker.color + outlierwidth + Sets the border line width (in px) of the + outlier sample points. + width + Sets the width (in px) of the lines bounding + the marker points. + + Returns + ------- + plotly.graph_objs.box.marker.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # outliercolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outliercolor'] + + @outliercolor.setter + def outliercolor(self, val): + self['outliercolor'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # symbol + # ------ + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', + 315, 'hexagon2-open-dot', 16, 'octagon', 116, + 'octagon-open', 216, 'octagon-dot', 316, + 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, + 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, + 'hexagram-open', 218, 'hexagram-dot', 318, + 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', + 120, 'star-triangle-down-open', 220, + 'star-triangle-down-dot', 320, + 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, + 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, + 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, + 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, + 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, + 'line-nw-open'] + + Returns + ------- + Any + """ + return self['symbol'] + + @symbol.setter + def symbol(self, val): + self['symbol'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'box' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + line + plotly.graph_objs.box.marker.Line instance or dict with + compatible properties + opacity + Sets the marker opacity. + outliercolor + Sets the color of the outlier sample points. + size + Sets the marker size (in px). + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + """ + + def __init__( + self, + arg=None, + color=None, + line=None, + opacity=None, + outliercolor=None, + size=None, + symbol=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.box.Marker + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + line + plotly.graph_objs.box.marker.Line instance or dict with + compatible properties + opacity + Sets the marker opacity. + outliercolor + Sets the color of the outlier sample points. + size + Sets the marker size (in px). + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.box.Marker +constructor must be a dict or +an instance of plotly.graph_objs.box.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.box import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['line'] = v_marker.LineValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['outliercolor'] = v_marker.OutliercolorValidator() + self._validators['size'] = v_marker.SizeValidator() + self._validators['symbol'] = v_marker.SymbolValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('outliercolor', None) + self['outliercolor'] = outliercolor if outliercolor is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('symbol', None) + self['symbol'] = symbol if symbol is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'box' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of line bounding the box(es). + width + Sets the width (in px) of line bounding the box(es). + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.box.Line + color + Sets the color of line bounding the box(es). + width + Sets the width (in px) of line bounding the box(es). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.box.Line +constructor must be a dict or +an instance of plotly.graph_objs.box.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.box import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.box.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'box' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.box.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.box.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.box.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.box import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.box import unselected -from ._stream import Stream -from ._selected import Selected from plotly.graph_objs.box import selected -from ._marker import Marker from plotly.graph_objs.box import marker -from ._line import Line -from ._hoverlabel import Hoverlabel from plotly.graph_objs.box import hoverlabel diff --git a/plotly/graph_objs/box/_hoverlabel.py b/plotly/graph_objs/box/_hoverlabel.py deleted file mode 100644 index 68fa046719f..00000000000 --- a/plotly/graph_objs/box/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.box.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'box' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.box.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.box.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.box import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/box/_line.py b/plotly/graph_objs/box/_line.py deleted file mode 100644 index b032134b68c..00000000000 --- a/plotly/graph_objs/box/_line.py +++ /dev/null @@ -1,165 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'box' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the color of line bounding the box(es). - width - Sets the width (in px) of line bounding the box(es). - """ - - def __init__(self, arg=None, color=None, width=None, **kwargs): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.Line - color - Sets the color of line bounding the box(es). - width - Sets the width (in px) of line bounding the box(es). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.box.Line -constructor must be a dict or -an instance of plotly.graph_objs.box.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.box import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/box/_marker.py b/plotly/graph_objs/box/_marker.py deleted file mode 100644 index 154dbe2c1a7..00000000000 --- a/plotly/graph_objs/box/_marker.py +++ /dev/null @@ -1,427 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - Sets themarkercolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - 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. - outliercolor - Sets the border line color of the outlier - sample points. Defaults to marker.color - outlierwidth - Sets the border line width (in px) of the - outlier sample points. - width - Sets the width (in px) of the lines bounding - the marker points. - - Returns - ------- - plotly.graph_objs.box.marker.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # outliercolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outliercolor'] - - @outliercolor.setter - def outliercolor(self, val): - self['outliercolor'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # symbol - # ------ - @property - def symbol(self): - """ - Sets the marker symbol type. Adding 100 is equivalent to - appending "-open" to a symbol name. Adding 200 is equivalent to - appending "-dot" to a symbol name. Adding 300 is equivalent to - appending "-open-dot" or "dot-open" to a symbol name. - - The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', - 315, 'hexagon2-open-dot', 16, 'octagon', 116, - 'octagon-open', 216, 'octagon-dot', 316, - 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, - 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, - 'hexagram-open', 218, 'hexagram-dot', 318, - 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', - 120, 'star-triangle-down-open', 220, - 'star-triangle-down-dot', 320, - 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, - 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, - 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, - 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, - 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, - 'line-nw-open'] - - Returns - ------- - Any - """ - return self['symbol'] - - @symbol.setter - def symbol(self, val): - self['symbol'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'box' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - line - plotly.graph_objs.box.marker.Line instance or dict with - compatible properties - opacity - Sets the marker opacity. - outliercolor - Sets the color of the outlier sample points. - size - Sets the marker size (in px). - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - """ - - def __init__( - self, - arg=None, - color=None, - line=None, - opacity=None, - outliercolor=None, - size=None, - symbol=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.Marker - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - line - plotly.graph_objs.box.marker.Line instance or dict with - compatible properties - opacity - Sets the marker opacity. - outliercolor - Sets the color of the outlier sample points. - size - Sets the marker size (in px). - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.box.Marker -constructor must be a dict or -an instance of plotly.graph_objs.box.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.box import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['line'] = v_marker.LineValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['outliercolor'] = v_marker.OutliercolorValidator() - self._validators['size'] = v_marker.SizeValidator() - self._validators['symbol'] = v_marker.SymbolValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('outliercolor', None) - self['outliercolor'] = outliercolor if outliercolor is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('symbol', None) - self['symbol'] = symbol if symbol is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/box/_selected.py b/plotly/graph_objs/box/_selected.py deleted file mode 100644 index f91b3a95a9f..00000000000 --- a/plotly/graph_objs/box/_selected.py +++ /dev/null @@ -1,111 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Selected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - plotly.graph_objs.box.selected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'box' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.box.selected.Marker instance or dict - with compatible properties - """ - - def __init__(self, arg=None, marker=None, **kwargs): - """ - Construct a new Selected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.Selected - marker - plotly.graph_objs.box.selected.Marker instance or dict - with compatible properties - - Returns - ------- - Selected - """ - super(Selected, self).__init__('selected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.box.Selected -constructor must be a dict or -an instance of plotly.graph_objs.box.Selected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.box import (selected as v_selected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_selected.MarkerValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/box/_stream.py b/plotly/graph_objs/box/_stream.py deleted file mode 100644 index b7c9f1bc2a8..00000000000 --- a/plotly/graph_objs/box/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'box' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.box.Stream -constructor must be a dict or -an instance of plotly.graph_objs.box.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.box import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/box/_unselected.py b/plotly/graph_objs/box/_unselected.py deleted file mode 100644 index d7492da2b61..00000000000 --- a/plotly/graph_objs/box/_unselected.py +++ /dev/null @@ -1,114 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Unselected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. - - Returns - ------- - plotly.graph_objs.box.unselected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'box' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.box.unselected.Marker instance or - dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, **kwargs): - """ - Construct a new Unselected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.Unselected - marker - plotly.graph_objs.box.unselected.Marker instance or - dict with compatible properties - - Returns - ------- - Unselected - """ - super(Unselected, self).__init__('unselected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.box.Unselected -constructor must be a dict or -an instance of plotly.graph_objs.box.Unselected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.box import (unselected as v_unselected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_unselected.MarkerValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/box/hoverlabel/__init__.py b/plotly/graph_objs/box/hoverlabel/__init__.py index c37b8b5cd28..a2d9a9c90c3 100644 --- a/plotly/graph_objs/box/hoverlabel/__init__.py +++ b/plotly/graph_objs/box/hoverlabel/__init__.py @@ -1 +1,321 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'box.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.box.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.box.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.box.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.box.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/box/hoverlabel/_font.py b/plotly/graph_objs/box/hoverlabel/_font.py deleted file mode 100644 index c74e775f502..00000000000 --- a/plotly/graph_objs/box/hoverlabel/_font.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'box.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.box.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.box.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.box.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/box/marker/__init__.py b/plotly/graph_objs/box/marker/__init__.py index 471a5835d71..c3df8028ffb 100644 --- a/plotly/graph_objs/box/marker/__init__.py +++ b/plotly/graph_objs/box/marker/__init__.py @@ -1 +1,287 @@ -from ._line import Line + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + Sets themarker.linecolor. It accepts either a specific color or + an array of numbers that are mapped to the colorscale relative + to the max and min values of the array or relative to + `marker.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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # outliercolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outliercolor'] + + @outliercolor.setter + def outliercolor(self, val): + self['outliercolor'] = val + + # outlierwidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlierwidth'] + + @outlierwidth.setter + def outlierwidth(self, val): + self['outlierwidth'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'box.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + outliercolor + Sets the border line color of the outlier sample + points. Defaults to marker.color + outlierwidth + Sets the border line width (in px) of the outlier + sample points. + width + Sets the width (in px) of the lines bounding the marker + points. + """ + + def __init__( + self, + arg=None, + color=None, + outliercolor=None, + outlierwidth=None, + width=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.box.marker.Line + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + outliercolor + Sets the border line color of the outlier sample + points. Defaults to marker.color + outlierwidth + Sets the border line width (in px) of the outlier + sample points. + width + Sets the width (in px) of the lines bounding the marker + points. + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.box.marker.Line +constructor must be a dict or +an instance of plotly.graph_objs.box.marker.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.box.marker import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['outliercolor'] = v_line.OutliercolorValidator() + self._validators['outlierwidth'] = v_line.OutlierwidthValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('outliercolor', None) + self['outliercolor'] = outliercolor if outliercolor is not None else _v + _v = arg.pop('outlierwidth', None) + self['outlierwidth'] = outlierwidth if outlierwidth is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/box/marker/_line.py b/plotly/graph_objs/box/marker/_line.py deleted file mode 100644 index 2eb19fcfa1a..00000000000 --- a/plotly/graph_objs/box/marker/_line.py +++ /dev/null @@ -1,285 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - Sets themarker.linecolor. It accepts either a specific color or - an array of numbers that are mapped to the colorscale relative - to the max and min values of the array or relative to - `marker.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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # outliercolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outliercolor'] - - @outliercolor.setter - def outliercolor(self, val): - self['outliercolor'] = val - - # outlierwidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlierwidth'] - - @outlierwidth.setter - def outlierwidth(self, val): - self['outlierwidth'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'box.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - outliercolor - Sets the border line color of the outlier sample - points. Defaults to marker.color - outlierwidth - Sets the border line width (in px) of the outlier - sample points. - width - Sets the width (in px) of the lines bounding the marker - points. - """ - - def __init__( - self, - arg=None, - color=None, - outliercolor=None, - outlierwidth=None, - width=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.marker.Line - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - outliercolor - Sets the border line color of the outlier sample - points. Defaults to marker.color - outlierwidth - Sets the border line width (in px) of the outlier - sample points. - width - Sets the width (in px) of the lines bounding the marker - points. - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.box.marker.Line -constructor must be a dict or -an instance of plotly.graph_objs.box.marker.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.box.marker import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['outliercolor'] = v_line.OutliercolorValidator() - self._validators['outlierwidth'] = v_line.OutlierwidthValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('outliercolor', None) - self['outliercolor'] = outliercolor if outliercolor is not None else _v - _v = arg.pop('outlierwidth', None) - self['outlierwidth'] = outlierwidth if outlierwidth is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/box/selected/__init__.py b/plotly/graph_objs/box/selected/__init__.py index 0bda16c3500..91918fe1ff5 100644 --- a/plotly/graph_objs/box/selected/__init__.py +++ b/plotly/graph_objs/box/selected/__init__.py @@ -1 +1,196 @@ -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'box.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.box.selected.Marker + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.box.selected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.box.selected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.box.selected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/box/selected/_marker.py b/plotly/graph_objs/box/selected/_marker.py deleted file mode 100644 index a8c1b5e340a..00000000000 --- a/plotly/graph_objs/box/selected/_marker.py +++ /dev/null @@ -1,194 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'box.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.selected.Marker - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.box.selected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.box.selected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.box.selected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/box/unselected/__init__.py b/plotly/graph_objs/box/unselected/__init__.py index 0bda16c3500..2b2c927a866 100644 --- a/plotly/graph_objs/box/unselected/__init__.py +++ b/plotly/graph_objs/box/unselected/__init__.py @@ -1 +1,205 @@ -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'box.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.box.unselected.Marker + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.box.unselected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.box.unselected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.box.unselected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/box/unselected/_marker.py b/plotly/graph_objs/box/unselected/_marker.py deleted file mode 100644 index e58f2aa6324..00000000000 --- a/plotly/graph_objs/box/unselected/_marker.py +++ /dev/null @@ -1,203 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'box.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.box.unselected.Marker - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.box.unselected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.box.unselected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.box.unselected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/candlestick/__init__.py b/plotly/graph_objs/candlestick/__init__.py index 5fa8e67488a..67a4dcb5df8 100644 --- a/plotly/graph_objs/candlestick/__init__.py +++ b/plotly/graph_objs/candlestick/__init__.py @@ -1,8 +1,1070 @@ -from ._stream import Stream -from ._line import Line -from ._increasing import Increasing + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'candlestick' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.candlestick.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.candlestick.Stream +constructor must be a dict or +an instance of plotly.graph_objs.candlestick.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.candlestick import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'candlestick' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + width + Sets the width (in px) of line bounding the box(es). + Note that this style setting can also be set per + direction via `increasing.line.width` and + `decreasing.line.width`. + """ + + def __init__(self, arg=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.candlestick.Line + width + Sets the width (in px) of line bounding the box(es). + Note that this style setting can also be set per + direction via `increasing.line.width` and + `decreasing.line.width`. + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.candlestick.Line +constructor must be a dict or +an instance of plotly.graph_objs.candlestick.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.candlestick import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Increasing(_BaseTraceHierarchyType): + + # fillcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['fillcolor'] + + @fillcolor.setter + def fillcolor(self, val): + self['fillcolor'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + Sets the width (in px) of line bounding the + box(es). + + Returns + ------- + plotly.graph_objs.candlestick.increasing.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'candlestick' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + line + plotly.graph_objs.candlestick.increasing.Line instance + or dict with compatible properties + """ + + def __init__(self, arg=None, fillcolor=None, line=None, **kwargs): + """ + Construct a new Increasing object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.candlestick.Increasing + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + line + plotly.graph_objs.candlestick.increasing.Line instance + or dict with compatible properties + + Returns + ------- + Increasing + """ + super(Increasing, self).__init__('increasing') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.candlestick.Increasing +constructor must be a dict or +an instance of plotly.graph_objs.candlestick.Increasing""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.candlestick import (increasing as v_increasing) + + # Initialize validators + # --------------------- + self._validators['fillcolor'] = v_increasing.FillcolorValidator() + self._validators['line'] = v_increasing.LineValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('fillcolor', None) + self['fillcolor'] = fillcolor if fillcolor is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.candlestick.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # split + # ----- + @property + 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) + + Returns + ------- + bool + """ + return self['split'] + + @split.setter + def split(self, val): + self['split'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'candlestick' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + split + Show hover information (open, close, high, low) in + separate labels. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + split=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.candlestick.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + split + Show hover information (open, close, high, low) in + separate labels. + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.candlestick.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.candlestick.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.candlestick import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + self._validators['split'] = v_hoverlabel.SplitValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + _v = arg.pop('split', None) + self['split'] = split if split is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Decreasing(_BaseTraceHierarchyType): + + # fillcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['fillcolor'] + + @fillcolor.setter + def fillcolor(self, val): + self['fillcolor'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + Sets the width (in px) of line bounding the + box(es). + + Returns + ------- + plotly.graph_objs.candlestick.decreasing.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'candlestick' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + line + plotly.graph_objs.candlestick.decreasing.Line instance + or dict with compatible properties + """ + + def __init__(self, arg=None, fillcolor=None, line=None, **kwargs): + """ + Construct a new Decreasing object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.candlestick.Decreasing + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + line + plotly.graph_objs.candlestick.decreasing.Line instance + or dict with compatible properties + + Returns + ------- + Decreasing + """ + super(Decreasing, self).__init__('decreasing') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.candlestick.Decreasing +constructor must be a dict or +an instance of plotly.graph_objs.candlestick.Decreasing""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.candlestick import (decreasing as v_decreasing) + + # Initialize validators + # --------------------- + self._validators['fillcolor'] = v_decreasing.FillcolorValidator() + self._validators['line'] = v_decreasing.LineValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('fillcolor', None) + self['fillcolor'] = fillcolor if fillcolor is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.candlestick import increasing -from ._hoverlabel import Hoverlabel from plotly.graph_objs.candlestick import hoverlabel -from ._decreasing import Decreasing from plotly.graph_objs.candlestick import decreasing diff --git a/plotly/graph_objs/candlestick/_decreasing.py b/plotly/graph_objs/candlestick/_decreasing.py deleted file mode 100644 index ced21de40a8..00000000000 --- a/plotly/graph_objs/candlestick/_decreasing.py +++ /dev/null @@ -1,182 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Decreasing(BaseTraceHierarchyType): - - # fillcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['fillcolor'] - - @fillcolor.setter - def fillcolor(self, val): - self['fillcolor'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - Sets the width (in px) of line bounding the - box(es). - - Returns - ------- - plotly.graph_objs.candlestick.decreasing.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'candlestick' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - line - plotly.graph_objs.candlestick.decreasing.Line instance - or dict with compatible properties - """ - - def __init__(self, arg=None, fillcolor=None, line=None, **kwargs): - """ - Construct a new Decreasing object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.candlestick.Decreasing - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - line - plotly.graph_objs.candlestick.decreasing.Line instance - or dict with compatible properties - - Returns - ------- - Decreasing - """ - super(Decreasing, self).__init__('decreasing') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.candlestick.Decreasing -constructor must be a dict or -an instance of plotly.graph_objs.candlestick.Decreasing""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.candlestick import (decreasing as v_decreasing) - - # Initialize validators - # --------------------- - self._validators['fillcolor'] = v_decreasing.FillcolorValidator() - self._validators['line'] = v_decreasing.LineValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('fillcolor', None) - self['fillcolor'] = fillcolor if fillcolor is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/candlestick/_hoverlabel.py b/plotly/graph_objs/candlestick/_hoverlabel.py deleted file mode 100644 index 39e46bc59a8..00000000000 --- a/plotly/graph_objs/candlestick/_hoverlabel.py +++ /dev/null @@ -1,445 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.candlestick.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # split - # ----- - @property - 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) - - Returns - ------- - bool - """ - return self['split'] - - @split.setter - def split(self, val): - self['split'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'candlestick' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - split - Show hover information (open, close, high, low) in - separate labels. - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - split=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.candlestick.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - split - Show hover information (open, close, high, low) in - separate labels. - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.candlestick.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.candlestick.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.candlestick import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - self._validators['split'] = v_hoverlabel.SplitValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - _v = arg.pop('split', None) - self['split'] = split if split is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/candlestick/_increasing.py b/plotly/graph_objs/candlestick/_increasing.py deleted file mode 100644 index 183ae295fc7..00000000000 --- a/plotly/graph_objs/candlestick/_increasing.py +++ /dev/null @@ -1,182 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Increasing(BaseTraceHierarchyType): - - # fillcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['fillcolor'] - - @fillcolor.setter - def fillcolor(self, val): - self['fillcolor'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - Sets the width (in px) of line bounding the - box(es). - - Returns - ------- - plotly.graph_objs.candlestick.increasing.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'candlestick' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - line - plotly.graph_objs.candlestick.increasing.Line instance - or dict with compatible properties - """ - - def __init__(self, arg=None, fillcolor=None, line=None, **kwargs): - """ - Construct a new Increasing object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.candlestick.Increasing - fillcolor - Sets the fill color. Defaults to a half-transparent - variant of the line color, marker color, or marker line - color, whichever is available. - line - plotly.graph_objs.candlestick.increasing.Line instance - or dict with compatible properties - - Returns - ------- - Increasing - """ - super(Increasing, self).__init__('increasing') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.candlestick.Increasing -constructor must be a dict or -an instance of plotly.graph_objs.candlestick.Increasing""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.candlestick import (increasing as v_increasing) - - # Initialize validators - # --------------------- - self._validators['fillcolor'] = v_increasing.FillcolorValidator() - self._validators['line'] = v_increasing.LineValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('fillcolor', None) - self['fillcolor'] = fillcolor if fillcolor is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/candlestick/_line.py b/plotly/graph_objs/candlestick/_line.py deleted file mode 100644 index 409cd3eed55..00000000000 --- a/plotly/graph_objs/candlestick/_line.py +++ /dev/null @@ -1,107 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'candlestick' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - width - Sets the width (in px) of line bounding the box(es). - Note that this style setting can also be set per - direction via `increasing.line.width` and - `decreasing.line.width`. - """ - - def __init__(self, arg=None, width=None, **kwargs): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.candlestick.Line - width - Sets the width (in px) of line bounding the box(es). - Note that this style setting can also be set per - direction via `increasing.line.width` and - `decreasing.line.width`. - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.candlestick.Line -constructor must be a dict or -an instance of plotly.graph_objs.candlestick.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.candlestick import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/candlestick/_stream.py b/plotly/graph_objs/candlestick/_stream.py deleted file mode 100644 index 9fc67b9f446..00000000000 --- a/plotly/graph_objs/candlestick/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'candlestick' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.candlestick.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.candlestick.Stream -constructor must be a dict or -an instance of plotly.graph_objs.candlestick.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.candlestick import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/candlestick/decreasing/__init__.py b/plotly/graph_objs/candlestick/decreasing/__init__.py index 471a5835d71..8b6e29e4970 100644 --- a/plotly/graph_objs/candlestick/decreasing/__init__.py +++ b/plotly/graph_objs/candlestick/decreasing/__init__.py @@ -1 +1,168 @@ -from ._line import Line + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'candlestick.decreasing' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of line bounding the box(es). + width + Sets the width (in px) of line bounding the box(es). + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.candlestick.decreasing.Line + color + Sets the color of line bounding the box(es). + width + Sets the width (in px) of line bounding the box(es). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.candlestick.decreasing.Line +constructor must be a dict or +an instance of plotly.graph_objs.candlestick.decreasing.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.candlestick.decreasing import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/candlestick/decreasing/_line.py b/plotly/graph_objs/candlestick/decreasing/_line.py deleted file mode 100644 index c015eb6f8ab..00000000000 --- a/plotly/graph_objs/candlestick/decreasing/_line.py +++ /dev/null @@ -1,166 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'candlestick.decreasing' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the color of line bounding the box(es). - width - Sets the width (in px) of line bounding the box(es). - """ - - def __init__(self, arg=None, color=None, width=None, **kwargs): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.candlestick.decreasing.Line - color - Sets the color of line bounding the box(es). - width - Sets the width (in px) of line bounding the box(es). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.candlestick.decreasing.Line -constructor must be a dict or -an instance of plotly.graph_objs.candlestick.decreasing.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.candlestick.decreasing import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/candlestick/hoverlabel/__init__.py b/plotly/graph_objs/candlestick/hoverlabel/__init__.py index c37b8b5cd28..8629cef74af 100644 --- a/plotly/graph_objs/candlestick/hoverlabel/__init__.py +++ b/plotly/graph_objs/candlestick/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'candlestick.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.candlestick.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.candlestick.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.candlestick.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.candlestick.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/candlestick/hoverlabel/_font.py b/plotly/graph_objs/candlestick/hoverlabel/_font.py deleted file mode 100644 index 28048904f82..00000000000 --- a/plotly/graph_objs/candlestick/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'candlestick.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.candlestick.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.candlestick.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.candlestick.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.candlestick.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/candlestick/increasing/__init__.py b/plotly/graph_objs/candlestick/increasing/__init__.py index 471a5835d71..e98a02b2d0a 100644 --- a/plotly/graph_objs/candlestick/increasing/__init__.py +++ b/plotly/graph_objs/candlestick/increasing/__init__.py @@ -1 +1,168 @@ -from ._line import Line + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'candlestick.increasing' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of line bounding the box(es). + width + Sets the width (in px) of line bounding the box(es). + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.candlestick.increasing.Line + color + Sets the color of line bounding the box(es). + width + Sets the width (in px) of line bounding the box(es). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.candlestick.increasing.Line +constructor must be a dict or +an instance of plotly.graph_objs.candlestick.increasing.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.candlestick.increasing import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/candlestick/increasing/_line.py b/plotly/graph_objs/candlestick/increasing/_line.py deleted file mode 100644 index ae14c22da53..00000000000 --- a/plotly/graph_objs/candlestick/increasing/_line.py +++ /dev/null @@ -1,166 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'candlestick.increasing' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the color of line bounding the box(es). - width - Sets the width (in px) of line bounding the box(es). - """ - - def __init__(self, arg=None, color=None, width=None, **kwargs): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.candlestick.increasing.Line - color - Sets the color of line bounding the box(es). - width - Sets the width (in px) of line bounding the box(es). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.candlestick.increasing.Line -constructor must be a dict or -an instance of plotly.graph_objs.candlestick.increasing.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.candlestick.increasing import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/__init__.py b/plotly/graph_objs/carpet/__init__.py index 1ed69a1bd08..2e384028936 100644 --- a/plotly/graph_objs/carpet/__init__.py +++ b/plotly/graph_objs/carpet/__init__.py @@ -1,8 +1,5285 @@ -from ._stream import Stream -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'carpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.carpet.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.carpet.Stream +constructor must be a dict or +an instance of plotly.graph_objs.carpet.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.carpet import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 plotly.graph_objs.carpet.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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.carpet.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'carpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.carpet.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.carpet.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.carpet.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.carpet import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'carpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.carpet.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.carpet.Font +constructor must be a dict or +an instance of plotly.graph_objs.carpet.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.carpet import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Baxis(_BaseTraceHierarchyType): + + # arraydtick + # ---------- + @property + 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] + + Returns + ------- + int + """ + return self['arraydtick'] + + @arraydtick.setter + def arraydtick(self, val): + self['arraydtick'] = val + + # arraytick0 + # ---------- + @property + 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] + + Returns + ------- + int + """ + return self['arraytick0'] + + @arraytick0.setter + def arraytick0(self, val): + self['arraytick0'] = val + + # autorange + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['autorange'] + + @autorange.setter + def autorange(self, val): + self['autorange'] = val + + # categoryarray + # ------------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['categoryarray'] + + @categoryarray.setter + def categoryarray(self, val): + self['categoryarray'] = val + + # categoryarraysrc + # ---------------- + @property + def categoryarraysrc(self): + """ + Sets the source reference on plot.ly for categoryarray . + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['categoryarraysrc'] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self['categoryarraysrc'] = val + + # categoryorder + # ------------- + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array'] + + Returns + ------- + Any + """ + return self['categoryorder'] + + @categoryorder.setter + def categoryorder(self, val): + self['categoryorder'] = val + + # cheatertype + # ----------- + @property + def cheatertype(self): + """ + The 'cheatertype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['index', 'value'] + + Returns + ------- + Any + """ + return self['cheatertype'] + + @cheatertype.setter + def cheatertype(self, val): + self['cheatertype'] = val + + # color + # ----- + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dtick + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # endline + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['endline'] + + @endline.setter + def endline(self, val): + self['endline'] = val + + # endlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['endlinecolor'] + + @endlinecolor.setter + def endlinecolor(self, val): + self['endlinecolor'] = val + + # endlinewidth + # ------------ + @property + 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 + + Returns + ------- + int|float + """ + return self['endlinewidth'] + + @endlinewidth.setter + def endlinewidth(self, val): + self['endlinewidth'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # fixedrange + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['fixedrange'] + + @fixedrange.setter + def fixedrange(self, val): + self['fixedrange'] = val + + # gridcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['gridcolor'] + + @gridcolor.setter + def gridcolor(self, val): + self['gridcolor'] = val + + # gridwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['gridwidth'] + + @gridwidth.setter + def gridwidth(self, val): + self['gridwidth'] = val + + # labelpadding + # ------------ + @property + 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) + + Returns + ------- + int + """ + return self['labelpadding'] + + @labelpadding.setter + def labelpadding(self, val): + self['labelpadding'] = val + + # labelprefix + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['labelprefix'] + + @labelprefix.setter + def labelprefix(self, val): + self['labelprefix'] = val + + # labelsuffix + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['labelsuffix'] + + @labelsuffix.setter + def labelsuffix(self, val): + self['labelsuffix'] = val + + # linecolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['linecolor'] + + @linecolor.setter + def linecolor(self, val): + self['linecolor'] = val + + # linewidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['linewidth'] + + @linewidth.setter + def linewidth(self, val): + self['linewidth'] = val + + # minorgridcolor + # -------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['minorgridcolor'] + + @minorgridcolor.setter + def minorgridcolor(self, val): + self['minorgridcolor'] = val + + # minorgridcount + # -------------- + @property + 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] + + Returns + ------- + int + """ + return self['minorgridcount'] + + @minorgridcount.setter + def minorgridcount(self, val): + self['minorgridcount'] = val + + # minorgridwidth + # -------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['minorgridwidth'] + + @minorgridwidth.setter + def minorgridwidth(self, val): + self['minorgridwidth'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # range + # ----- + @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 + + Returns + ------- + list + """ + return self['range'] + + @range.setter + def range(self, val): + self['range'] = val + + # rangemode + # --------- + @property + def rangemode(self): + """ + If "normal", the range is computed in relation to the extrema + of the input data. If *tozero*`, the range extends to 0, + regardless of the input data If "nonnegative", the range is + non-negative, regardless of the input data. + + The 'rangemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'tozero', 'nonnegative'] + + Returns + ------- + Any + """ + return self['rangemode'] + + @rangemode.setter + def rangemode(self, val): + self['rangemode'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showgrid + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showgrid'] + + @showgrid.setter + def showgrid(self, val): + self['showgrid'] = val + + # showline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showline'] + + @showline.setter + def showline(self, val): + self['showline'] = val + + # showticklabels + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # smoothing + # --------- + @property + def smoothing(self): + """ + The 'smoothing' property is a number and may be specified as: + - An int or float in the interval [0, 1.3] + + Returns + ------- + int|float + """ + return self['smoothing'] + + @smoothing.setter + def smoothing(self, val): + self['smoothing'] = val + + # startline + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['startline'] + + @startline.setter + def startline(self, val): + self['startline'] = val + + # startlinecolor + # -------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['startlinecolor'] + + @startlinecolor.setter + def startlinecolor(self, val): + self['startlinecolor'] = val + + # startlinewidth + # -------------- + @property + 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 + + Returns + ------- + int|float + """ + return self['startlinewidth'] + + @startlinewidth.setter + def startlinewidth(self, val): + self['startlinewidth'] = val + + # tick0 + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickfont + # -------- + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.carpet.baxis.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.carpet.baxis.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + 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 plotly.graph_objs.carpet.baxis.Tickformatstop + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.carpet.baxis.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + offset + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.carpet.baxis.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleoffset + # ----------- + @property + def titleoffset(self): + """ + Deprecated: Please use carpet.baxis.title.offset instead. An + additional amount by which to offset the title from the tick + labels, given in pixels. Note that this used to be set by the + now deprecated `titleoffset` attribute. + + The 'offset' property is a number and may be specified as: + - An int or float + + Returns + ------- + + """ + return self['titleoffset'] + + @titleoffset.setter + def titleoffset(self, val): + self['titleoffset'] = val + + # type + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'carpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + arraydtick + The stride between grid lines along the axis + arraytick0 + The starting index of grid lines along the axis + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + cheatertype + + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + The stride between grid lines along the axis + endline + Determines whether or not a line is drawn at along the + final value of this axis. If True, the end line is + drawn on top of the grid lines. + endlinecolor + Sets the line color of the end line. + endlinewidth + Sets the width (in px) of the end line. + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom-able. If + true, then zoom is disabled. + gridcolor + Sets the axis line color. + gridwidth + Sets the width (in px) of the axis line. + labelpadding + Extra padding between label and the axis + labelprefix + Sets a axis label prefix. + labelsuffix + Sets a axis label suffix. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + minorgridcolor + Sets the color of the grid lines. + minorgridcount + Sets the number of minor grid ticks per major grid tick + minorgridwidth + Sets the width (in px) of the grid lines. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If *tozero*`, the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether axis labels are drawn on the low + side, the high side, both, or neither side of the axis. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + smoothing + + startline + Determines whether or not a line is drawn at along the + starting value of this axis. If True, the start line is + drawn on top of the grid lines. + startlinecolor + Sets the line color of the start line. + startlinewidth + Sets the width (in px) of the start line. + tick0 + The starting index of grid lines along the axis + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.carpet.baxis.Tickformatstop instance + or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.carpet + .baxis.tickformatstopdefaults), sets the default + property values to use for elements of + carpet.baxis.tickformatstops + tickmode + + tickprefix + Sets a tick label prefix. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + title + plotly.graph_objs.carpet.baxis.Title instance or dict + with compatible properties + titlefont + Deprecated: Please use carpet.baxis.title.font instead. + Sets this axis' title font. Note that the title's font + used to be set by the now deprecated `titlefont` + attribute. + titleoffset + Deprecated: Please use carpet.baxis.title.offset + instead. An additional amount by which to offset the + title from the tick labels, given in pixels. Note that + this used to be set by the now deprecated `titleoffset` + attribute. + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleoffset': ('title', 'offset') + } + + def __init__( + self, + arg=None, + arraydtick=None, + arraytick0=None, + autorange=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + cheatertype=None, + color=None, + dtick=None, + endline=None, + endlinecolor=None, + endlinewidth=None, + exponentformat=None, + fixedrange=None, + gridcolor=None, + gridwidth=None, + labelpadding=None, + labelprefix=None, + labelsuffix=None, + linecolor=None, + linewidth=None, + minorgridcolor=None, + minorgridcount=None, + minorgridwidth=None, + nticks=None, + range=None, + rangemode=None, + separatethousands=None, + showexponent=None, + showgrid=None, + showline=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + smoothing=None, + startline=None, + startlinecolor=None, + startlinewidth=None, + tick0=None, + tickangle=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + tickmode=None, + tickprefix=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + title=None, + titlefont=None, + titleoffset=None, + type=None, + **kwargs + ): + """ + Construct a new Baxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.carpet.Baxis + arraydtick + The stride between grid lines along the axis + arraytick0 + The starting index of grid lines along the axis + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + cheatertype + + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + The stride between grid lines along the axis + endline + Determines whether or not a line is drawn at along the + final value of this axis. If True, the end line is + drawn on top of the grid lines. + endlinecolor + Sets the line color of the end line. + endlinewidth + Sets the width (in px) of the end line. + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom-able. If + true, then zoom is disabled. + gridcolor + Sets the axis line color. + gridwidth + Sets the width (in px) of the axis line. + labelpadding + Extra padding between label and the axis + labelprefix + Sets a axis label prefix. + labelsuffix + Sets a axis label suffix. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + minorgridcolor + Sets the color of the grid lines. + minorgridcount + Sets the number of minor grid ticks per major grid tick + minorgridwidth + Sets the width (in px) of the grid lines. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If *tozero*`, the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether axis labels are drawn on the low + side, the high side, both, or neither side of the axis. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + smoothing + + startline + Determines whether or not a line is drawn at along the + starting value of this axis. If True, the start line is + drawn on top of the grid lines. + startlinecolor + Sets the line color of the start line. + startlinewidth + Sets the width (in px) of the start line. + tick0 + The starting index of grid lines along the axis + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.carpet.baxis.Tickformatstop instance + or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.carpet + .baxis.tickformatstopdefaults), sets the default + property values to use for elements of + carpet.baxis.tickformatstops + tickmode + + tickprefix + Sets a tick label prefix. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + title + plotly.graph_objs.carpet.baxis.Title instance or dict + with compatible properties + titlefont + Deprecated: Please use carpet.baxis.title.font instead. + Sets this axis' title font. Note that the title's font + used to be set by the now deprecated `titlefont` + attribute. + titleoffset + Deprecated: Please use carpet.baxis.title.offset + instead. An additional amount by which to offset the + title from the tick labels, given in pixels. Note that + this used to be set by the now deprecated `titleoffset` + attribute. + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + + Returns + ------- + Baxis + """ + super(Baxis, self).__init__('baxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.carpet.Baxis +constructor must be a dict or +an instance of plotly.graph_objs.carpet.Baxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.carpet import (baxis as v_baxis) + + # Initialize validators + # --------------------- + self._validators['arraydtick'] = v_baxis.ArraydtickValidator() + self._validators['arraytick0'] = v_baxis.Arraytick0Validator() + self._validators['autorange'] = v_baxis.AutorangeValidator() + self._validators['categoryarray'] = v_baxis.CategoryarrayValidator() + self._validators['categoryarraysrc' + ] = v_baxis.CategoryarraysrcValidator() + self._validators['categoryorder'] = v_baxis.CategoryorderValidator() + self._validators['cheatertype'] = v_baxis.CheatertypeValidator() + self._validators['color'] = v_baxis.ColorValidator() + self._validators['dtick'] = v_baxis.DtickValidator() + self._validators['endline'] = v_baxis.EndlineValidator() + self._validators['endlinecolor'] = v_baxis.EndlinecolorValidator() + self._validators['endlinewidth'] = v_baxis.EndlinewidthValidator() + self._validators['exponentformat'] = v_baxis.ExponentformatValidator() + self._validators['fixedrange'] = v_baxis.FixedrangeValidator() + self._validators['gridcolor'] = v_baxis.GridcolorValidator() + self._validators['gridwidth'] = v_baxis.GridwidthValidator() + self._validators['labelpadding'] = v_baxis.LabelpaddingValidator() + self._validators['labelprefix'] = v_baxis.LabelprefixValidator() + self._validators['labelsuffix'] = v_baxis.LabelsuffixValidator() + self._validators['linecolor'] = v_baxis.LinecolorValidator() + self._validators['linewidth'] = v_baxis.LinewidthValidator() + self._validators['minorgridcolor'] = v_baxis.MinorgridcolorValidator() + self._validators['minorgridcount'] = v_baxis.MinorgridcountValidator() + self._validators['minorgridwidth'] = v_baxis.MinorgridwidthValidator() + self._validators['nticks'] = v_baxis.NticksValidator() + self._validators['range'] = v_baxis.RangeValidator() + self._validators['rangemode'] = v_baxis.RangemodeValidator() + self._validators['separatethousands' + ] = v_baxis.SeparatethousandsValidator() + self._validators['showexponent'] = v_baxis.ShowexponentValidator() + self._validators['showgrid'] = v_baxis.ShowgridValidator() + self._validators['showline'] = v_baxis.ShowlineValidator() + self._validators['showticklabels'] = v_baxis.ShowticklabelsValidator() + self._validators['showtickprefix'] = v_baxis.ShowtickprefixValidator() + self._validators['showticksuffix'] = v_baxis.ShowticksuffixValidator() + self._validators['smoothing'] = v_baxis.SmoothingValidator() + self._validators['startline'] = v_baxis.StartlineValidator() + self._validators['startlinecolor'] = v_baxis.StartlinecolorValidator() + self._validators['startlinewidth'] = v_baxis.StartlinewidthValidator() + self._validators['tick0'] = v_baxis.Tick0Validator() + self._validators['tickangle'] = v_baxis.TickangleValidator() + self._validators['tickfont'] = v_baxis.TickfontValidator() + self._validators['tickformat'] = v_baxis.TickformatValidator() + self._validators['tickformatstops'] = v_baxis.TickformatstopsValidator( + ) + self._validators['tickformatstopdefaults' + ] = v_baxis.TickformatstopValidator() + self._validators['tickmode'] = v_baxis.TickmodeValidator() + self._validators['tickprefix'] = v_baxis.TickprefixValidator() + self._validators['ticksuffix'] = v_baxis.TicksuffixValidator() + self._validators['ticktext'] = v_baxis.TicktextValidator() + self._validators['ticktextsrc'] = v_baxis.TicktextsrcValidator() + self._validators['tickvals'] = v_baxis.TickvalsValidator() + self._validators['tickvalssrc'] = v_baxis.TickvalssrcValidator() + self._validators['title'] = v_baxis.TitleValidator() + self._validators['type'] = v_baxis.TypeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('arraydtick', None) + self['arraydtick'] = arraydtick if arraydtick is not None else _v + _v = arg.pop('arraytick0', None) + self['arraytick0'] = arraytick0 if arraytick0 is not None else _v + _v = arg.pop('autorange', None) + self['autorange'] = autorange if autorange is not None else _v + _v = arg.pop('categoryarray', None) + self['categoryarray' + ] = categoryarray if categoryarray is not None else _v + _v = arg.pop('categoryarraysrc', None) + self['categoryarraysrc' + ] = categoryarraysrc if categoryarraysrc is not None else _v + _v = arg.pop('categoryorder', None) + self['categoryorder' + ] = categoryorder if categoryorder is not None else _v + _v = arg.pop('cheatertype', None) + self['cheatertype'] = cheatertype if cheatertype is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('endline', None) + self['endline'] = endline if endline is not None else _v + _v = arg.pop('endlinecolor', None) + self['endlinecolor'] = endlinecolor if endlinecolor is not None else _v + _v = arg.pop('endlinewidth', None) + self['endlinewidth'] = endlinewidth if endlinewidth is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('fixedrange', None) + self['fixedrange'] = fixedrange if fixedrange is not None else _v + _v = arg.pop('gridcolor', None) + self['gridcolor'] = gridcolor if gridcolor is not None else _v + _v = arg.pop('gridwidth', None) + self['gridwidth'] = gridwidth if gridwidth is not None else _v + _v = arg.pop('labelpadding', None) + self['labelpadding'] = labelpadding if labelpadding is not None else _v + _v = arg.pop('labelprefix', None) + self['labelprefix'] = labelprefix if labelprefix is not None else _v + _v = arg.pop('labelsuffix', None) + self['labelsuffix'] = labelsuffix if labelsuffix is not None else _v + _v = arg.pop('linecolor', None) + self['linecolor'] = linecolor if linecolor is not None else _v + _v = arg.pop('linewidth', None) + self['linewidth'] = linewidth if linewidth is not None else _v + _v = arg.pop('minorgridcolor', None) + self['minorgridcolor' + ] = minorgridcolor if minorgridcolor is not None else _v + _v = arg.pop('minorgridcount', None) + self['minorgridcount' + ] = minorgridcount if minorgridcount is not None else _v + _v = arg.pop('minorgridwidth', None) + self['minorgridwidth' + ] = minorgridwidth if minorgridwidth is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('range', None) + self['range'] = range if range is not None else _v + _v = arg.pop('rangemode', None) + self['rangemode'] = rangemode if rangemode is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showgrid', None) + self['showgrid'] = showgrid if showgrid is not None else _v + _v = arg.pop('showline', None) + self['showline'] = showline if showline is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('smoothing', None) + self['smoothing'] = smoothing if smoothing is not None else _v + _v = arg.pop('startline', None) + self['startline'] = startline if startline is not None else _v + _v = arg.pop('startlinecolor', None) + self['startlinecolor' + ] = startlinecolor if startlinecolor is not None else _v + _v = arg.pop('startlinewidth', None) + self['startlinewidth' + ] = startlinewidth if startlinewidth is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleoffset', None) + _v = titleoffset if titleoffset is not None else _v + if _v is not None: + self['titleoffset'] = _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Aaxis(_BaseTraceHierarchyType): + + # arraydtick + # ---------- + @property + 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] + + Returns + ------- + int + """ + return self['arraydtick'] + + @arraydtick.setter + def arraydtick(self, val): + self['arraydtick'] = val + + # arraytick0 + # ---------- + @property + 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] + + Returns + ------- + int + """ + return self['arraytick0'] + + @arraytick0.setter + def arraytick0(self, val): + self['arraytick0'] = val + + # autorange + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['autorange'] + + @autorange.setter + def autorange(self, val): + self['autorange'] = val + + # categoryarray + # ------------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['categoryarray'] + + @categoryarray.setter + def categoryarray(self, val): + self['categoryarray'] = val + + # categoryarraysrc + # ---------------- + @property + def categoryarraysrc(self): + """ + Sets the source reference on plot.ly for categoryarray . + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['categoryarraysrc'] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self['categoryarraysrc'] = val + + # categoryorder + # ------------- + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array'] + + Returns + ------- + Any + """ + return self['categoryorder'] + + @categoryorder.setter + def categoryorder(self, val): + self['categoryorder'] = val + + # cheatertype + # ----------- + @property + def cheatertype(self): + """ + The 'cheatertype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['index', 'value'] + + Returns + ------- + Any + """ + return self['cheatertype'] + + @cheatertype.setter + def cheatertype(self, val): + self['cheatertype'] = val + + # color + # ----- + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dtick + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # endline + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['endline'] + + @endline.setter + def endline(self, val): + self['endline'] = val + + # endlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['endlinecolor'] + + @endlinecolor.setter + def endlinecolor(self, val): + self['endlinecolor'] = val + + # endlinewidth + # ------------ + @property + 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 + + Returns + ------- + int|float + """ + return self['endlinewidth'] + + @endlinewidth.setter + def endlinewidth(self, val): + self['endlinewidth'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # fixedrange + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['fixedrange'] + + @fixedrange.setter + def fixedrange(self, val): + self['fixedrange'] = val + + # gridcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['gridcolor'] + + @gridcolor.setter + def gridcolor(self, val): + self['gridcolor'] = val + + # gridwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['gridwidth'] + + @gridwidth.setter + def gridwidth(self, val): + self['gridwidth'] = val + + # labelpadding + # ------------ + @property + 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) + + Returns + ------- + int + """ + return self['labelpadding'] + + @labelpadding.setter + def labelpadding(self, val): + self['labelpadding'] = val + + # labelprefix + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['labelprefix'] + + @labelprefix.setter + def labelprefix(self, val): + self['labelprefix'] = val + + # labelsuffix + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['labelsuffix'] + + @labelsuffix.setter + def labelsuffix(self, val): + self['labelsuffix'] = val + + # linecolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['linecolor'] + + @linecolor.setter + def linecolor(self, val): + self['linecolor'] = val + + # linewidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['linewidth'] + + @linewidth.setter + def linewidth(self, val): + self['linewidth'] = val + + # minorgridcolor + # -------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['minorgridcolor'] + + @minorgridcolor.setter + def minorgridcolor(self, val): + self['minorgridcolor'] = val + + # minorgridcount + # -------------- + @property + 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] + + Returns + ------- + int + """ + return self['minorgridcount'] + + @minorgridcount.setter + def minorgridcount(self, val): + self['minorgridcount'] = val + + # minorgridwidth + # -------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['minorgridwidth'] + + @minorgridwidth.setter + def minorgridwidth(self, val): + self['minorgridwidth'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # range + # ----- + @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 + + Returns + ------- + list + """ + return self['range'] + + @range.setter + def range(self, val): + self['range'] = val + + # rangemode + # --------- + @property + def rangemode(self): + """ + If "normal", the range is computed in relation to the extrema + of the input data. If *tozero*`, the range extends to 0, + regardless of the input data If "nonnegative", the range is + non-negative, regardless of the input data. + + The 'rangemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'tozero', 'nonnegative'] + + Returns + ------- + Any + """ + return self['rangemode'] + + @rangemode.setter + def rangemode(self, val): + self['rangemode'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showgrid + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showgrid'] + + @showgrid.setter + def showgrid(self, val): + self['showgrid'] = val + + # showline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showline'] + + @showline.setter + def showline(self, val): + self['showline'] = val + + # showticklabels + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # smoothing + # --------- + @property + def smoothing(self): + """ + The 'smoothing' property is a number and may be specified as: + - An int or float in the interval [0, 1.3] + + Returns + ------- + int|float + """ + return self['smoothing'] + + @smoothing.setter + def smoothing(self, val): + self['smoothing'] = val + + # startline + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['startline'] + + @startline.setter + def startline(self, val): + self['startline'] = val + + # startlinecolor + # -------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['startlinecolor'] + + @startlinecolor.setter + def startlinecolor(self, val): + self['startlinecolor'] = val + + # startlinewidth + # -------------- + @property + 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 + + Returns + ------- + int|float + """ + return self['startlinewidth'] + + @startlinewidth.setter + def startlinewidth(self, val): + self['startlinewidth'] = val + + # tick0 + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickfont + # -------- + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.carpet.aaxis.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.carpet.aaxis.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + 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 plotly.graph_objs.carpet.aaxis.Tickformatstop + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.carpet.aaxis.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + offset + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.carpet.aaxis.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleoffset + # ----------- + @property + def titleoffset(self): + """ + Deprecated: Please use carpet.aaxis.title.offset instead. An + additional amount by which to offset the title from the tick + labels, given in pixels. Note that this used to be set by the + now deprecated `titleoffset` attribute. + + The 'offset' property is a number and may be specified as: + - An int or float + + Returns + ------- + + """ + return self['titleoffset'] + + @titleoffset.setter + def titleoffset(self, val): + self['titleoffset'] = val + + # type + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'carpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + arraydtick + The stride between grid lines along the axis + arraytick0 + The starting index of grid lines along the axis + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + cheatertype + + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + The stride between grid lines along the axis + endline + Determines whether or not a line is drawn at along the + final value of this axis. If True, the end line is + drawn on top of the grid lines. + endlinecolor + Sets the line color of the end line. + endlinewidth + Sets the width (in px) of the end line. + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom-able. If + true, then zoom is disabled. + gridcolor + Sets the axis line color. + gridwidth + Sets the width (in px) of the axis line. + labelpadding + Extra padding between label and the axis + labelprefix + Sets a axis label prefix. + labelsuffix + Sets a axis label suffix. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + minorgridcolor + Sets the color of the grid lines. + minorgridcount + Sets the number of minor grid ticks per major grid tick + minorgridwidth + Sets the width (in px) of the grid lines. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If *tozero*`, the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether axis labels are drawn on the low + side, the high side, both, or neither side of the axis. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + smoothing + + startline + Determines whether or not a line is drawn at along the + starting value of this axis. If True, the start line is + drawn on top of the grid lines. + startlinecolor + Sets the line color of the start line. + startlinewidth + Sets the width (in px) of the start line. + tick0 + The starting index of grid lines along the axis + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.carpet.aaxis.Tickformatstop instance + or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.carpet + .aaxis.tickformatstopdefaults), sets the default + property values to use for elements of + carpet.aaxis.tickformatstops + tickmode + + tickprefix + Sets a tick label prefix. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + title + plotly.graph_objs.carpet.aaxis.Title instance or dict + with compatible properties + titlefont + Deprecated: Please use carpet.aaxis.title.font instead. + Sets this axis' title font. Note that the title's font + used to be set by the now deprecated `titlefont` + attribute. + titleoffset + Deprecated: Please use carpet.aaxis.title.offset + instead. An additional amount by which to offset the + title from the tick labels, given in pixels. Note that + this used to be set by the now deprecated `titleoffset` + attribute. + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleoffset': ('title', 'offset') + } + + def __init__( + self, + arg=None, + arraydtick=None, + arraytick0=None, + autorange=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + cheatertype=None, + color=None, + dtick=None, + endline=None, + endlinecolor=None, + endlinewidth=None, + exponentformat=None, + fixedrange=None, + gridcolor=None, + gridwidth=None, + labelpadding=None, + labelprefix=None, + labelsuffix=None, + linecolor=None, + linewidth=None, + minorgridcolor=None, + minorgridcount=None, + minorgridwidth=None, + nticks=None, + range=None, + rangemode=None, + separatethousands=None, + showexponent=None, + showgrid=None, + showline=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + smoothing=None, + startline=None, + startlinecolor=None, + startlinewidth=None, + tick0=None, + tickangle=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + tickmode=None, + tickprefix=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + title=None, + titlefont=None, + titleoffset=None, + type=None, + **kwargs + ): + """ + Construct a new Aaxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.carpet.Aaxis + arraydtick + The stride between grid lines along the axis + arraytick0 + The starting index of grid lines along the axis + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + cheatertype + + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + The stride between grid lines along the axis + endline + Determines whether or not a line is drawn at along the + final value of this axis. If True, the end line is + drawn on top of the grid lines. + endlinecolor + Sets the line color of the end line. + endlinewidth + Sets the width (in px) of the end line. + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom-able. If + true, then zoom is disabled. + gridcolor + Sets the axis line color. + gridwidth + Sets the width (in px) of the axis line. + labelpadding + Extra padding between label and the axis + labelprefix + Sets a axis label prefix. + labelsuffix + Sets a axis label suffix. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + minorgridcolor + Sets the color of the grid lines. + minorgridcount + Sets the number of minor grid ticks per major grid tick + minorgridwidth + Sets the width (in px) of the grid lines. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If *tozero*`, the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether axis labels are drawn on the low + side, the high side, both, or neither side of the axis. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + smoothing + + startline + Determines whether or not a line is drawn at along the + starting value of this axis. If True, the start line is + drawn on top of the grid lines. + startlinecolor + Sets the line color of the start line. + startlinewidth + Sets the width (in px) of the start line. + tick0 + The starting index of grid lines along the axis + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.carpet.aaxis.Tickformatstop instance + or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.carpet + .aaxis.tickformatstopdefaults), sets the default + property values to use for elements of + carpet.aaxis.tickformatstops + tickmode + + tickprefix + Sets a tick label prefix. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + title + plotly.graph_objs.carpet.aaxis.Title instance or dict + with compatible properties + titlefont + Deprecated: Please use carpet.aaxis.title.font instead. + Sets this axis' title font. Note that the title's font + used to be set by the now deprecated `titlefont` + attribute. + titleoffset + Deprecated: Please use carpet.aaxis.title.offset + instead. An additional amount by which to offset the + title from the tick labels, given in pixels. Note that + this used to be set by the now deprecated `titleoffset` + attribute. + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + + Returns + ------- + Aaxis + """ + super(Aaxis, self).__init__('aaxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.carpet.Aaxis +constructor must be a dict or +an instance of plotly.graph_objs.carpet.Aaxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.carpet import (aaxis as v_aaxis) + + # Initialize validators + # --------------------- + self._validators['arraydtick'] = v_aaxis.ArraydtickValidator() + self._validators['arraytick0'] = v_aaxis.Arraytick0Validator() + self._validators['autorange'] = v_aaxis.AutorangeValidator() + self._validators['categoryarray'] = v_aaxis.CategoryarrayValidator() + self._validators['categoryarraysrc' + ] = v_aaxis.CategoryarraysrcValidator() + self._validators['categoryorder'] = v_aaxis.CategoryorderValidator() + self._validators['cheatertype'] = v_aaxis.CheatertypeValidator() + self._validators['color'] = v_aaxis.ColorValidator() + self._validators['dtick'] = v_aaxis.DtickValidator() + self._validators['endline'] = v_aaxis.EndlineValidator() + self._validators['endlinecolor'] = v_aaxis.EndlinecolorValidator() + self._validators['endlinewidth'] = v_aaxis.EndlinewidthValidator() + self._validators['exponentformat'] = v_aaxis.ExponentformatValidator() + self._validators['fixedrange'] = v_aaxis.FixedrangeValidator() + self._validators['gridcolor'] = v_aaxis.GridcolorValidator() + self._validators['gridwidth'] = v_aaxis.GridwidthValidator() + self._validators['labelpadding'] = v_aaxis.LabelpaddingValidator() + self._validators['labelprefix'] = v_aaxis.LabelprefixValidator() + self._validators['labelsuffix'] = v_aaxis.LabelsuffixValidator() + self._validators['linecolor'] = v_aaxis.LinecolorValidator() + self._validators['linewidth'] = v_aaxis.LinewidthValidator() + self._validators['minorgridcolor'] = v_aaxis.MinorgridcolorValidator() + self._validators['minorgridcount'] = v_aaxis.MinorgridcountValidator() + self._validators['minorgridwidth'] = v_aaxis.MinorgridwidthValidator() + self._validators['nticks'] = v_aaxis.NticksValidator() + self._validators['range'] = v_aaxis.RangeValidator() + self._validators['rangemode'] = v_aaxis.RangemodeValidator() + self._validators['separatethousands' + ] = v_aaxis.SeparatethousandsValidator() + self._validators['showexponent'] = v_aaxis.ShowexponentValidator() + self._validators['showgrid'] = v_aaxis.ShowgridValidator() + self._validators['showline'] = v_aaxis.ShowlineValidator() + self._validators['showticklabels'] = v_aaxis.ShowticklabelsValidator() + self._validators['showtickprefix'] = v_aaxis.ShowtickprefixValidator() + self._validators['showticksuffix'] = v_aaxis.ShowticksuffixValidator() + self._validators['smoothing'] = v_aaxis.SmoothingValidator() + self._validators['startline'] = v_aaxis.StartlineValidator() + self._validators['startlinecolor'] = v_aaxis.StartlinecolorValidator() + self._validators['startlinewidth'] = v_aaxis.StartlinewidthValidator() + self._validators['tick0'] = v_aaxis.Tick0Validator() + self._validators['tickangle'] = v_aaxis.TickangleValidator() + self._validators['tickfont'] = v_aaxis.TickfontValidator() + self._validators['tickformat'] = v_aaxis.TickformatValidator() + self._validators['tickformatstops'] = v_aaxis.TickformatstopsValidator( + ) + self._validators['tickformatstopdefaults' + ] = v_aaxis.TickformatstopValidator() + self._validators['tickmode'] = v_aaxis.TickmodeValidator() + self._validators['tickprefix'] = v_aaxis.TickprefixValidator() + self._validators['ticksuffix'] = v_aaxis.TicksuffixValidator() + self._validators['ticktext'] = v_aaxis.TicktextValidator() + self._validators['ticktextsrc'] = v_aaxis.TicktextsrcValidator() + self._validators['tickvals'] = v_aaxis.TickvalsValidator() + self._validators['tickvalssrc'] = v_aaxis.TickvalssrcValidator() + self._validators['title'] = v_aaxis.TitleValidator() + self._validators['type'] = v_aaxis.TypeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('arraydtick', None) + self['arraydtick'] = arraydtick if arraydtick is not None else _v + _v = arg.pop('arraytick0', None) + self['arraytick0'] = arraytick0 if arraytick0 is not None else _v + _v = arg.pop('autorange', None) + self['autorange'] = autorange if autorange is not None else _v + _v = arg.pop('categoryarray', None) + self['categoryarray' + ] = categoryarray if categoryarray is not None else _v + _v = arg.pop('categoryarraysrc', None) + self['categoryarraysrc' + ] = categoryarraysrc if categoryarraysrc is not None else _v + _v = arg.pop('categoryorder', None) + self['categoryorder' + ] = categoryorder if categoryorder is not None else _v + _v = arg.pop('cheatertype', None) + self['cheatertype'] = cheatertype if cheatertype is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('endline', None) + self['endline'] = endline if endline is not None else _v + _v = arg.pop('endlinecolor', None) + self['endlinecolor'] = endlinecolor if endlinecolor is not None else _v + _v = arg.pop('endlinewidth', None) + self['endlinewidth'] = endlinewidth if endlinewidth is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('fixedrange', None) + self['fixedrange'] = fixedrange if fixedrange is not None else _v + _v = arg.pop('gridcolor', None) + self['gridcolor'] = gridcolor if gridcolor is not None else _v + _v = arg.pop('gridwidth', None) + self['gridwidth'] = gridwidth if gridwidth is not None else _v + _v = arg.pop('labelpadding', None) + self['labelpadding'] = labelpadding if labelpadding is not None else _v + _v = arg.pop('labelprefix', None) + self['labelprefix'] = labelprefix if labelprefix is not None else _v + _v = arg.pop('labelsuffix', None) + self['labelsuffix'] = labelsuffix if labelsuffix is not None else _v + _v = arg.pop('linecolor', None) + self['linecolor'] = linecolor if linecolor is not None else _v + _v = arg.pop('linewidth', None) + self['linewidth'] = linewidth if linewidth is not None else _v + _v = arg.pop('minorgridcolor', None) + self['minorgridcolor' + ] = minorgridcolor if minorgridcolor is not None else _v + _v = arg.pop('minorgridcount', None) + self['minorgridcount' + ] = minorgridcount if minorgridcount is not None else _v + _v = arg.pop('minorgridwidth', None) + self['minorgridwidth' + ] = minorgridwidth if minorgridwidth is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('range', None) + self['range'] = range if range is not None else _v + _v = arg.pop('rangemode', None) + self['rangemode'] = rangemode if rangemode is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showgrid', None) + self['showgrid'] = showgrid if showgrid is not None else _v + _v = arg.pop('showline', None) + self['showline'] = showline if showline is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('smoothing', None) + self['smoothing'] = smoothing if smoothing is not None else _v + _v = arg.pop('startline', None) + self['startline'] = startline if startline is not None else _v + _v = arg.pop('startlinecolor', None) + self['startlinecolor' + ] = startlinecolor if startlinecolor is not None else _v + _v = arg.pop('startlinewidth', None) + self['startlinewidth' + ] = startlinewidth if startlinewidth is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleoffset', None) + _v = titleoffset if titleoffset is not None else _v + if _v is not None: + self['titleoffset'] = _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.carpet import hoverlabel -from ._font import Font -from ._baxis import Baxis from plotly.graph_objs.carpet import baxis -from ._aaxis import Aaxis from plotly.graph_objs.carpet import aaxis diff --git a/plotly/graph_objs/carpet/_aaxis.py b/plotly/graph_objs/carpet/_aaxis.py deleted file mode 100644 index 6d6bd1925e8..00000000000 --- a/plotly/graph_objs/carpet/_aaxis.py +++ /dev/null @@ -1,2246 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Aaxis(BaseTraceHierarchyType): - - # arraydtick - # ---------- - @property - 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] - - Returns - ------- - int - """ - return self['arraydtick'] - - @arraydtick.setter - def arraydtick(self, val): - self['arraydtick'] = val - - # arraytick0 - # ---------- - @property - 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] - - Returns - ------- - int - """ - return self['arraytick0'] - - @arraytick0.setter - def arraytick0(self, val): - self['arraytick0'] = val - - # autorange - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['autorange'] - - @autorange.setter - def autorange(self, val): - self['autorange'] = val - - # categoryarray - # ------------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['categoryarray'] - - @categoryarray.setter - def categoryarray(self, val): - self['categoryarray'] = val - - # categoryarraysrc - # ---------------- - @property - def categoryarraysrc(self): - """ - Sets the source reference on plot.ly for categoryarray . - - The 'categoryarraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['categoryarraysrc'] - - @categoryarraysrc.setter - def categoryarraysrc(self, val): - self['categoryarraysrc'] = val - - # categoryorder - # ------------- - @property - def categoryorder(self): - """ - Specifies the ordering logic for the case of categorical - variables. By default, plotly uses "trace", which specifies the - order that is present in the data supplied. Set `categoryorder` - to *category ascending* or *category descending* if order - should be determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" to derive the - ordering from the attribute `categoryarray`. If a category is - not found in the `categoryarray` array, the sorting behavior - for that attribute will be identical to the "trace" mode. The - unspecified categories will follow the categories in - `categoryarray`. - - The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array'] - - Returns - ------- - Any - """ - return self['categoryorder'] - - @categoryorder.setter - def categoryorder(self, val): - self['categoryorder'] = val - - # cheatertype - # ----------- - @property - def cheatertype(self): - """ - The 'cheatertype' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['index', 'value'] - - Returns - ------- - Any - """ - return self['cheatertype'] - - @cheatertype.setter - def cheatertype(self, val): - self['cheatertype'] = val - - # color - # ----- - @property - def color(self): - """ - Sets default for all colors associated with this axis all at - once: line, font, tick, and grid colors. Grid color is - lightened by blending this with the plot background Individual - pieces can override this. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dtick - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # endline - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['endline'] - - @endline.setter - def endline(self, val): - self['endline'] = val - - # endlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['endlinecolor'] - - @endlinecolor.setter - def endlinecolor(self, val): - self['endlinecolor'] = val - - # endlinewidth - # ------------ - @property - 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 - - Returns - ------- - int|float - """ - return self['endlinewidth'] - - @endlinewidth.setter - def endlinewidth(self, val): - self['endlinewidth'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # fixedrange - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['fixedrange'] - - @fixedrange.setter - def fixedrange(self, val): - self['fixedrange'] = val - - # gridcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['gridcolor'] - - @gridcolor.setter - def gridcolor(self, val): - self['gridcolor'] = val - - # gridwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['gridwidth'] - - @gridwidth.setter - def gridwidth(self, val): - self['gridwidth'] = val - - # labelpadding - # ------------ - @property - 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) - - Returns - ------- - int - """ - return self['labelpadding'] - - @labelpadding.setter - def labelpadding(self, val): - self['labelpadding'] = val - - # labelprefix - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['labelprefix'] - - @labelprefix.setter - def labelprefix(self, val): - self['labelprefix'] = val - - # labelsuffix - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['labelsuffix'] - - @labelsuffix.setter - def labelsuffix(self, val): - self['labelsuffix'] = val - - # linecolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['linecolor'] - - @linecolor.setter - def linecolor(self, val): - self['linecolor'] = val - - # linewidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['linewidth'] - - @linewidth.setter - def linewidth(self, val): - self['linewidth'] = val - - # minorgridcolor - # -------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['minorgridcolor'] - - @minorgridcolor.setter - def minorgridcolor(self, val): - self['minorgridcolor'] = val - - # minorgridcount - # -------------- - @property - 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] - - Returns - ------- - int - """ - return self['minorgridcount'] - - @minorgridcount.setter - def minorgridcount(self, val): - self['minorgridcount'] = val - - # minorgridwidth - # -------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['minorgridwidth'] - - @minorgridwidth.setter - def minorgridwidth(self, val): - self['minorgridwidth'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # range - # ----- - @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 - - Returns - ------- - list - """ - return self['range'] - - @range.setter - def range(self, val): - self['range'] = val - - # rangemode - # --------- - @property - def rangemode(self): - """ - If "normal", the range is computed in relation to the extrema - of the input data. If *tozero*`, the range extends to 0, - regardless of the input data If "nonnegative", the range is - non-negative, regardless of the input data. - - The 'rangemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'tozero', 'nonnegative'] - - Returns - ------- - Any - """ - return self['rangemode'] - - @rangemode.setter - def rangemode(self, val): - self['rangemode'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showgrid - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showgrid'] - - @showgrid.setter - def showgrid(self, val): - self['showgrid'] = val - - # showline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showline'] - - @showline.setter - def showline(self, val): - self['showline'] = val - - # showticklabels - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # smoothing - # --------- - @property - def smoothing(self): - """ - The 'smoothing' property is a number and may be specified as: - - An int or float in the interval [0, 1.3] - - Returns - ------- - int|float - """ - return self['smoothing'] - - @smoothing.setter - def smoothing(self, val): - self['smoothing'] = val - - # startline - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['startline'] - - @startline.setter - def startline(self, val): - self['startline'] = val - - # startlinecolor - # -------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['startlinecolor'] - - @startlinecolor.setter - def startlinecolor(self, val): - self['startlinecolor'] = val - - # startlinewidth - # -------------- - @property - 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 - - Returns - ------- - int|float - """ - return self['startlinewidth'] - - @startlinewidth.setter - def startlinewidth(self, val): - self['startlinewidth'] = val - - # tick0 - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickfont - # -------- - @property - def tickfont(self): - """ - Sets the tick font. - - The 'tickfont' property is an instance of Tickfont - that may be specified as: - - An instance of 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.carpet.aaxis.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.carpet.aaxis.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as - 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 plotly.graph_objs.carpet.aaxis.Tickformatstop - - A dict of string/value properties that will be passed - to the Tickformatstop constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.carpet.aaxis.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - offset - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.carpet.aaxis.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleoffset - # ----------- - @property - def titleoffset(self): - """ - Deprecated: Please use carpet.aaxis.title.offset instead. An - additional amount by which to offset the title from the tick - labels, given in pixels. Note that this used to be set by the - now deprecated `titleoffset` attribute. - - The 'offset' property is a number and may be specified as: - - An int or float - - Returns - ------- - - """ - return self['titleoffset'] - - @titleoffset.setter - def titleoffset(self, val): - self['titleoffset'] = val - - # type - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'carpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - arraydtick - The stride between grid lines along the axis - arraytick0 - The starting index of grid lines along the axis - autorange - Determines whether or not the range of this axis is - computed in relation to the input data. See `rangemode` - for more info. If `range` is provided, then `autorange` - is set to False. - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - cheatertype - - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - The stride between grid lines along the axis - endline - Determines whether or not a line is drawn at along the - final value of this axis. If True, the end line is - drawn on top of the grid lines. - endlinecolor - Sets the line color of the end line. - endlinewidth - Sets the width (in px) of the end line. - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - fixedrange - Determines whether or not this axis is zoom-able. If - true, then zoom is disabled. - gridcolor - Sets the axis line color. - gridwidth - Sets the width (in px) of the axis line. - labelpadding - Extra padding between label and the axis - labelprefix - Sets a axis label prefix. - labelsuffix - Sets a axis label suffix. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - minorgridcolor - Sets the color of the grid lines. - minorgridcount - Sets the number of minor grid ticks per major grid tick - minorgridwidth - Sets the width (in px) of the grid lines. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - range - Sets the range of this axis. If the axis `type` is - "log", then you must take the log of your desired range - (e.g. to set the range from 1 to 100, set the range - from 0 to 2). If the axis `type` is "date", it should - be date strings, like date data, though Date objects - and unix milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order it - appears. - rangemode - If "normal", the range is computed in relation to the - extrema of the input data. If *tozero*`, the range - extends to 0, regardless of the input data If - "nonnegative", the range is non-negative, regardless of - the input data. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showticklabels - Determines whether axis labels are drawn on the low - side, the high side, both, or neither side of the axis. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - smoothing - - startline - Determines whether or not a line is drawn at along the - starting value of this axis. If True, the start line is - drawn on top of the grid lines. - startlinecolor - Sets the line color of the start line. - startlinewidth - Sets the width (in px) of the start line. - tick0 - The starting index of grid lines along the axis - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.carpet.aaxis.Tickformatstop instance - or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.carpet - .aaxis.tickformatstopdefaults), sets the default - property values to use for elements of - carpet.aaxis.tickformatstops - tickmode - - tickprefix - Sets a tick label prefix. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - title - plotly.graph_objs.carpet.aaxis.Title instance or dict - with compatible properties - titlefont - Deprecated: Please use carpet.aaxis.title.font instead. - Sets this axis' title font. Note that the title's font - used to be set by the now deprecated `titlefont` - attribute. - titleoffset - Deprecated: Please use carpet.aaxis.title.offset - instead. An additional amount by which to offset the - title from the tick labels, given in pixels. Note that - this used to be set by the now deprecated `titleoffset` - attribute. - type - Sets the axis type. By default, plotly attempts to - determined the axis type by looking into the data of - the traces that referenced the axis in question. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleoffset': ('title', 'offset') - } - - def __init__( - self, - arg=None, - arraydtick=None, - arraytick0=None, - autorange=None, - categoryarray=None, - categoryarraysrc=None, - categoryorder=None, - cheatertype=None, - color=None, - dtick=None, - endline=None, - endlinecolor=None, - endlinewidth=None, - exponentformat=None, - fixedrange=None, - gridcolor=None, - gridwidth=None, - labelpadding=None, - labelprefix=None, - labelsuffix=None, - linecolor=None, - linewidth=None, - minorgridcolor=None, - minorgridcount=None, - minorgridwidth=None, - nticks=None, - range=None, - rangemode=None, - separatethousands=None, - showexponent=None, - showgrid=None, - showline=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - smoothing=None, - startline=None, - startlinecolor=None, - startlinewidth=None, - tick0=None, - tickangle=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - tickmode=None, - tickprefix=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - title=None, - titlefont=None, - titleoffset=None, - type=None, - **kwargs - ): - """ - Construct a new Aaxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.Aaxis - arraydtick - The stride between grid lines along the axis - arraytick0 - The starting index of grid lines along the axis - autorange - Determines whether or not the range of this axis is - computed in relation to the input data. See `rangemode` - for more info. If `range` is provided, then `autorange` - is set to False. - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - cheatertype - - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - The stride between grid lines along the axis - endline - Determines whether or not a line is drawn at along the - final value of this axis. If True, the end line is - drawn on top of the grid lines. - endlinecolor - Sets the line color of the end line. - endlinewidth - Sets the width (in px) of the end line. - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - fixedrange - Determines whether or not this axis is zoom-able. If - true, then zoom is disabled. - gridcolor - Sets the axis line color. - gridwidth - Sets the width (in px) of the axis line. - labelpadding - Extra padding between label and the axis - labelprefix - Sets a axis label prefix. - labelsuffix - Sets a axis label suffix. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - minorgridcolor - Sets the color of the grid lines. - minorgridcount - Sets the number of minor grid ticks per major grid tick - minorgridwidth - Sets the width (in px) of the grid lines. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - range - Sets the range of this axis. If the axis `type` is - "log", then you must take the log of your desired range - (e.g. to set the range from 1 to 100, set the range - from 0 to 2). If the axis `type` is "date", it should - be date strings, like date data, though Date objects - and unix milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order it - appears. - rangemode - If "normal", the range is computed in relation to the - extrema of the input data. If *tozero*`, the range - extends to 0, regardless of the input data If - "nonnegative", the range is non-negative, regardless of - the input data. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showticklabels - Determines whether axis labels are drawn on the low - side, the high side, both, or neither side of the axis. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - smoothing - - startline - Determines whether or not a line is drawn at along the - starting value of this axis. If True, the start line is - drawn on top of the grid lines. - startlinecolor - Sets the line color of the start line. - startlinewidth - Sets the width (in px) of the start line. - tick0 - The starting index of grid lines along the axis - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.carpet.aaxis.Tickformatstop instance - or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.carpet - .aaxis.tickformatstopdefaults), sets the default - property values to use for elements of - carpet.aaxis.tickformatstops - tickmode - - tickprefix - Sets a tick label prefix. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - title - plotly.graph_objs.carpet.aaxis.Title instance or dict - with compatible properties - titlefont - Deprecated: Please use carpet.aaxis.title.font instead. - Sets this axis' title font. Note that the title's font - used to be set by the now deprecated `titlefont` - attribute. - titleoffset - Deprecated: Please use carpet.aaxis.title.offset - instead. An additional amount by which to offset the - title from the tick labels, given in pixels. Note that - this used to be set by the now deprecated `titleoffset` - attribute. - type - Sets the axis type. By default, plotly attempts to - determined the axis type by looking into the data of - the traces that referenced the axis in question. - - Returns - ------- - Aaxis - """ - super(Aaxis, self).__init__('aaxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.carpet.Aaxis -constructor must be a dict or -an instance of plotly.graph_objs.carpet.Aaxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.carpet import (aaxis as v_aaxis) - - # Initialize validators - # --------------------- - self._validators['arraydtick'] = v_aaxis.ArraydtickValidator() - self._validators['arraytick0'] = v_aaxis.Arraytick0Validator() - self._validators['autorange'] = v_aaxis.AutorangeValidator() - self._validators['categoryarray'] = v_aaxis.CategoryarrayValidator() - self._validators['categoryarraysrc' - ] = v_aaxis.CategoryarraysrcValidator() - self._validators['categoryorder'] = v_aaxis.CategoryorderValidator() - self._validators['cheatertype'] = v_aaxis.CheatertypeValidator() - self._validators['color'] = v_aaxis.ColorValidator() - self._validators['dtick'] = v_aaxis.DtickValidator() - self._validators['endline'] = v_aaxis.EndlineValidator() - self._validators['endlinecolor'] = v_aaxis.EndlinecolorValidator() - self._validators['endlinewidth'] = v_aaxis.EndlinewidthValidator() - self._validators['exponentformat'] = v_aaxis.ExponentformatValidator() - self._validators['fixedrange'] = v_aaxis.FixedrangeValidator() - self._validators['gridcolor'] = v_aaxis.GridcolorValidator() - self._validators['gridwidth'] = v_aaxis.GridwidthValidator() - self._validators['labelpadding'] = v_aaxis.LabelpaddingValidator() - self._validators['labelprefix'] = v_aaxis.LabelprefixValidator() - self._validators['labelsuffix'] = v_aaxis.LabelsuffixValidator() - self._validators['linecolor'] = v_aaxis.LinecolorValidator() - self._validators['linewidth'] = v_aaxis.LinewidthValidator() - self._validators['minorgridcolor'] = v_aaxis.MinorgridcolorValidator() - self._validators['minorgridcount'] = v_aaxis.MinorgridcountValidator() - self._validators['minorgridwidth'] = v_aaxis.MinorgridwidthValidator() - self._validators['nticks'] = v_aaxis.NticksValidator() - self._validators['range'] = v_aaxis.RangeValidator() - self._validators['rangemode'] = v_aaxis.RangemodeValidator() - self._validators['separatethousands' - ] = v_aaxis.SeparatethousandsValidator() - self._validators['showexponent'] = v_aaxis.ShowexponentValidator() - self._validators['showgrid'] = v_aaxis.ShowgridValidator() - self._validators['showline'] = v_aaxis.ShowlineValidator() - self._validators['showticklabels'] = v_aaxis.ShowticklabelsValidator() - self._validators['showtickprefix'] = v_aaxis.ShowtickprefixValidator() - self._validators['showticksuffix'] = v_aaxis.ShowticksuffixValidator() - self._validators['smoothing'] = v_aaxis.SmoothingValidator() - self._validators['startline'] = v_aaxis.StartlineValidator() - self._validators['startlinecolor'] = v_aaxis.StartlinecolorValidator() - self._validators['startlinewidth'] = v_aaxis.StartlinewidthValidator() - self._validators['tick0'] = v_aaxis.Tick0Validator() - self._validators['tickangle'] = v_aaxis.TickangleValidator() - self._validators['tickfont'] = v_aaxis.TickfontValidator() - self._validators['tickformat'] = v_aaxis.TickformatValidator() - self._validators['tickformatstops'] = v_aaxis.TickformatstopsValidator( - ) - self._validators['tickformatstopdefaults' - ] = v_aaxis.TickformatstopValidator() - self._validators['tickmode'] = v_aaxis.TickmodeValidator() - self._validators['tickprefix'] = v_aaxis.TickprefixValidator() - self._validators['ticksuffix'] = v_aaxis.TicksuffixValidator() - self._validators['ticktext'] = v_aaxis.TicktextValidator() - self._validators['ticktextsrc'] = v_aaxis.TicktextsrcValidator() - self._validators['tickvals'] = v_aaxis.TickvalsValidator() - self._validators['tickvalssrc'] = v_aaxis.TickvalssrcValidator() - self._validators['title'] = v_aaxis.TitleValidator() - self._validators['type'] = v_aaxis.TypeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('arraydtick', None) - self['arraydtick'] = arraydtick if arraydtick is not None else _v - _v = arg.pop('arraytick0', None) - self['arraytick0'] = arraytick0 if arraytick0 is not None else _v - _v = arg.pop('autorange', None) - self['autorange'] = autorange if autorange is not None else _v - _v = arg.pop('categoryarray', None) - self['categoryarray' - ] = categoryarray if categoryarray is not None else _v - _v = arg.pop('categoryarraysrc', None) - self['categoryarraysrc' - ] = categoryarraysrc if categoryarraysrc is not None else _v - _v = arg.pop('categoryorder', None) - self['categoryorder' - ] = categoryorder if categoryorder is not None else _v - _v = arg.pop('cheatertype', None) - self['cheatertype'] = cheatertype if cheatertype is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('endline', None) - self['endline'] = endline if endline is not None else _v - _v = arg.pop('endlinecolor', None) - self['endlinecolor'] = endlinecolor if endlinecolor is not None else _v - _v = arg.pop('endlinewidth', None) - self['endlinewidth'] = endlinewidth if endlinewidth is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('fixedrange', None) - self['fixedrange'] = fixedrange if fixedrange is not None else _v - _v = arg.pop('gridcolor', None) - self['gridcolor'] = gridcolor if gridcolor is not None else _v - _v = arg.pop('gridwidth', None) - self['gridwidth'] = gridwidth if gridwidth is not None else _v - _v = arg.pop('labelpadding', None) - self['labelpadding'] = labelpadding if labelpadding is not None else _v - _v = arg.pop('labelprefix', None) - self['labelprefix'] = labelprefix if labelprefix is not None else _v - _v = arg.pop('labelsuffix', None) - self['labelsuffix'] = labelsuffix if labelsuffix is not None else _v - _v = arg.pop('linecolor', None) - self['linecolor'] = linecolor if linecolor is not None else _v - _v = arg.pop('linewidth', None) - self['linewidth'] = linewidth if linewidth is not None else _v - _v = arg.pop('minorgridcolor', None) - self['minorgridcolor' - ] = minorgridcolor if minorgridcolor is not None else _v - _v = arg.pop('minorgridcount', None) - self['minorgridcount' - ] = minorgridcount if minorgridcount is not None else _v - _v = arg.pop('minorgridwidth', None) - self['minorgridwidth' - ] = minorgridwidth if minorgridwidth is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('range', None) - self['range'] = range if range is not None else _v - _v = arg.pop('rangemode', None) - self['rangemode'] = rangemode if rangemode is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showgrid', None) - self['showgrid'] = showgrid if showgrid is not None else _v - _v = arg.pop('showline', None) - self['showline'] = showline if showline is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('smoothing', None) - self['smoothing'] = smoothing if smoothing is not None else _v - _v = arg.pop('startline', None) - self['startline'] = startline if startline is not None else _v - _v = arg.pop('startlinecolor', None) - self['startlinecolor' - ] = startlinecolor if startlinecolor is not None else _v - _v = arg.pop('startlinewidth', None) - self['startlinewidth' - ] = startlinewidth if startlinewidth is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleoffset', None) - _v = titleoffset if titleoffset is not None else _v - if _v is not None: - self['titleoffset'] = _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/_baxis.py b/plotly/graph_objs/carpet/_baxis.py deleted file mode 100644 index 50876f6ec0d..00000000000 --- a/plotly/graph_objs/carpet/_baxis.py +++ /dev/null @@ -1,2246 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Baxis(BaseTraceHierarchyType): - - # arraydtick - # ---------- - @property - 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] - - Returns - ------- - int - """ - return self['arraydtick'] - - @arraydtick.setter - def arraydtick(self, val): - self['arraydtick'] = val - - # arraytick0 - # ---------- - @property - 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] - - Returns - ------- - int - """ - return self['arraytick0'] - - @arraytick0.setter - def arraytick0(self, val): - self['arraytick0'] = val - - # autorange - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['autorange'] - - @autorange.setter - def autorange(self, val): - self['autorange'] = val - - # categoryarray - # ------------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['categoryarray'] - - @categoryarray.setter - def categoryarray(self, val): - self['categoryarray'] = val - - # categoryarraysrc - # ---------------- - @property - def categoryarraysrc(self): - """ - Sets the source reference on plot.ly for categoryarray . - - The 'categoryarraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['categoryarraysrc'] - - @categoryarraysrc.setter - def categoryarraysrc(self, val): - self['categoryarraysrc'] = val - - # categoryorder - # ------------- - @property - def categoryorder(self): - """ - Specifies the ordering logic for the case of categorical - variables. By default, plotly uses "trace", which specifies the - order that is present in the data supplied. Set `categoryorder` - to *category ascending* or *category descending* if order - should be determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" to derive the - ordering from the attribute `categoryarray`. If a category is - not found in the `categoryarray` array, the sorting behavior - for that attribute will be identical to the "trace" mode. The - unspecified categories will follow the categories in - `categoryarray`. - - The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array'] - - Returns - ------- - Any - """ - return self['categoryorder'] - - @categoryorder.setter - def categoryorder(self, val): - self['categoryorder'] = val - - # cheatertype - # ----------- - @property - def cheatertype(self): - """ - The 'cheatertype' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['index', 'value'] - - Returns - ------- - Any - """ - return self['cheatertype'] - - @cheatertype.setter - def cheatertype(self, val): - self['cheatertype'] = val - - # color - # ----- - @property - def color(self): - """ - Sets default for all colors associated with this axis all at - once: line, font, tick, and grid colors. Grid color is - lightened by blending this with the plot background Individual - pieces can override this. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dtick - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # endline - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['endline'] - - @endline.setter - def endline(self, val): - self['endline'] = val - - # endlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['endlinecolor'] - - @endlinecolor.setter - def endlinecolor(self, val): - self['endlinecolor'] = val - - # endlinewidth - # ------------ - @property - 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 - - Returns - ------- - int|float - """ - return self['endlinewidth'] - - @endlinewidth.setter - def endlinewidth(self, val): - self['endlinewidth'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # fixedrange - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['fixedrange'] - - @fixedrange.setter - def fixedrange(self, val): - self['fixedrange'] = val - - # gridcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['gridcolor'] - - @gridcolor.setter - def gridcolor(self, val): - self['gridcolor'] = val - - # gridwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['gridwidth'] - - @gridwidth.setter - def gridwidth(self, val): - self['gridwidth'] = val - - # labelpadding - # ------------ - @property - 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) - - Returns - ------- - int - """ - return self['labelpadding'] - - @labelpadding.setter - def labelpadding(self, val): - self['labelpadding'] = val - - # labelprefix - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['labelprefix'] - - @labelprefix.setter - def labelprefix(self, val): - self['labelprefix'] = val - - # labelsuffix - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['labelsuffix'] - - @labelsuffix.setter - def labelsuffix(self, val): - self['labelsuffix'] = val - - # linecolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['linecolor'] - - @linecolor.setter - def linecolor(self, val): - self['linecolor'] = val - - # linewidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['linewidth'] - - @linewidth.setter - def linewidth(self, val): - self['linewidth'] = val - - # minorgridcolor - # -------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['minorgridcolor'] - - @minorgridcolor.setter - def minorgridcolor(self, val): - self['minorgridcolor'] = val - - # minorgridcount - # -------------- - @property - 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] - - Returns - ------- - int - """ - return self['minorgridcount'] - - @minorgridcount.setter - def minorgridcount(self, val): - self['minorgridcount'] = val - - # minorgridwidth - # -------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['minorgridwidth'] - - @minorgridwidth.setter - def minorgridwidth(self, val): - self['minorgridwidth'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # range - # ----- - @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 - - Returns - ------- - list - """ - return self['range'] - - @range.setter - def range(self, val): - self['range'] = val - - # rangemode - # --------- - @property - def rangemode(self): - """ - If "normal", the range is computed in relation to the extrema - of the input data. If *tozero*`, the range extends to 0, - regardless of the input data If "nonnegative", the range is - non-negative, regardless of the input data. - - The 'rangemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'tozero', 'nonnegative'] - - Returns - ------- - Any - """ - return self['rangemode'] - - @rangemode.setter - def rangemode(self, val): - self['rangemode'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showgrid - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showgrid'] - - @showgrid.setter - def showgrid(self, val): - self['showgrid'] = val - - # showline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showline'] - - @showline.setter - def showline(self, val): - self['showline'] = val - - # showticklabels - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # smoothing - # --------- - @property - def smoothing(self): - """ - The 'smoothing' property is a number and may be specified as: - - An int or float in the interval [0, 1.3] - - Returns - ------- - int|float - """ - return self['smoothing'] - - @smoothing.setter - def smoothing(self, val): - self['smoothing'] = val - - # startline - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['startline'] - - @startline.setter - def startline(self, val): - self['startline'] = val - - # startlinecolor - # -------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['startlinecolor'] - - @startlinecolor.setter - def startlinecolor(self, val): - self['startlinecolor'] = val - - # startlinewidth - # -------------- - @property - 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 - - Returns - ------- - int|float - """ - return self['startlinewidth'] - - @startlinewidth.setter - def startlinewidth(self, val): - self['startlinewidth'] = val - - # tick0 - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickfont - # -------- - @property - def tickfont(self): - """ - Sets the tick font. - - The 'tickfont' property is an instance of Tickfont - that may be specified as: - - An instance of 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.carpet.baxis.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.carpet.baxis.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as - 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 plotly.graph_objs.carpet.baxis.Tickformatstop - - A dict of string/value properties that will be passed - to the Tickformatstop constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.carpet.baxis.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - offset - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.carpet.baxis.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleoffset - # ----------- - @property - def titleoffset(self): - """ - Deprecated: Please use carpet.baxis.title.offset instead. An - additional amount by which to offset the title from the tick - labels, given in pixels. Note that this used to be set by the - now deprecated `titleoffset` attribute. - - The 'offset' property is a number and may be specified as: - - An int or float - - Returns - ------- - - """ - return self['titleoffset'] - - @titleoffset.setter - def titleoffset(self, val): - self['titleoffset'] = val - - # type - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'carpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - arraydtick - The stride between grid lines along the axis - arraytick0 - The starting index of grid lines along the axis - autorange - Determines whether or not the range of this axis is - computed in relation to the input data. See `rangemode` - for more info. If `range` is provided, then `autorange` - is set to False. - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - cheatertype - - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - The stride between grid lines along the axis - endline - Determines whether or not a line is drawn at along the - final value of this axis. If True, the end line is - drawn on top of the grid lines. - endlinecolor - Sets the line color of the end line. - endlinewidth - Sets the width (in px) of the end line. - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - fixedrange - Determines whether or not this axis is zoom-able. If - true, then zoom is disabled. - gridcolor - Sets the axis line color. - gridwidth - Sets the width (in px) of the axis line. - labelpadding - Extra padding between label and the axis - labelprefix - Sets a axis label prefix. - labelsuffix - Sets a axis label suffix. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - minorgridcolor - Sets the color of the grid lines. - minorgridcount - Sets the number of minor grid ticks per major grid tick - minorgridwidth - Sets the width (in px) of the grid lines. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - range - Sets the range of this axis. If the axis `type` is - "log", then you must take the log of your desired range - (e.g. to set the range from 1 to 100, set the range - from 0 to 2). If the axis `type` is "date", it should - be date strings, like date data, though Date objects - and unix milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order it - appears. - rangemode - If "normal", the range is computed in relation to the - extrema of the input data. If *tozero*`, the range - extends to 0, regardless of the input data If - "nonnegative", the range is non-negative, regardless of - the input data. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showticklabels - Determines whether axis labels are drawn on the low - side, the high side, both, or neither side of the axis. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - smoothing - - startline - Determines whether or not a line is drawn at along the - starting value of this axis. If True, the start line is - drawn on top of the grid lines. - startlinecolor - Sets the line color of the start line. - startlinewidth - Sets the width (in px) of the start line. - tick0 - The starting index of grid lines along the axis - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.carpet.baxis.Tickformatstop instance - or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.carpet - .baxis.tickformatstopdefaults), sets the default - property values to use for elements of - carpet.baxis.tickformatstops - tickmode - - tickprefix - Sets a tick label prefix. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - title - plotly.graph_objs.carpet.baxis.Title instance or dict - with compatible properties - titlefont - Deprecated: Please use carpet.baxis.title.font instead. - Sets this axis' title font. Note that the title's font - used to be set by the now deprecated `titlefont` - attribute. - titleoffset - Deprecated: Please use carpet.baxis.title.offset - instead. An additional amount by which to offset the - title from the tick labels, given in pixels. Note that - this used to be set by the now deprecated `titleoffset` - attribute. - type - Sets the axis type. By default, plotly attempts to - determined the axis type by looking into the data of - the traces that referenced the axis in question. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleoffset': ('title', 'offset') - } - - def __init__( - self, - arg=None, - arraydtick=None, - arraytick0=None, - autorange=None, - categoryarray=None, - categoryarraysrc=None, - categoryorder=None, - cheatertype=None, - color=None, - dtick=None, - endline=None, - endlinecolor=None, - endlinewidth=None, - exponentformat=None, - fixedrange=None, - gridcolor=None, - gridwidth=None, - labelpadding=None, - labelprefix=None, - labelsuffix=None, - linecolor=None, - linewidth=None, - minorgridcolor=None, - minorgridcount=None, - minorgridwidth=None, - nticks=None, - range=None, - rangemode=None, - separatethousands=None, - showexponent=None, - showgrid=None, - showline=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - smoothing=None, - startline=None, - startlinecolor=None, - startlinewidth=None, - tick0=None, - tickangle=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - tickmode=None, - tickprefix=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - title=None, - titlefont=None, - titleoffset=None, - type=None, - **kwargs - ): - """ - Construct a new Baxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.Baxis - arraydtick - The stride between grid lines along the axis - arraytick0 - The starting index of grid lines along the axis - autorange - Determines whether or not the range of this axis is - computed in relation to the input data. See `rangemode` - for more info. If `range` is provided, then `autorange` - is set to False. - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - cheatertype - - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - The stride between grid lines along the axis - endline - Determines whether or not a line is drawn at along the - final value of this axis. If True, the end line is - drawn on top of the grid lines. - endlinecolor - Sets the line color of the end line. - endlinewidth - Sets the width (in px) of the end line. - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - fixedrange - Determines whether or not this axis is zoom-able. If - true, then zoom is disabled. - gridcolor - Sets the axis line color. - gridwidth - Sets the width (in px) of the axis line. - labelpadding - Extra padding between label and the axis - labelprefix - Sets a axis label prefix. - labelsuffix - Sets a axis label suffix. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - minorgridcolor - Sets the color of the grid lines. - minorgridcount - Sets the number of minor grid ticks per major grid tick - minorgridwidth - Sets the width (in px) of the grid lines. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - range - Sets the range of this axis. If the axis `type` is - "log", then you must take the log of your desired range - (e.g. to set the range from 1 to 100, set the range - from 0 to 2). If the axis `type` is "date", it should - be date strings, like date data, though Date objects - and unix milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order it - appears. - rangemode - If "normal", the range is computed in relation to the - extrema of the input data. If *tozero*`, the range - extends to 0, regardless of the input data If - "nonnegative", the range is non-negative, regardless of - the input data. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showticklabels - Determines whether axis labels are drawn on the low - side, the high side, both, or neither side of the axis. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - smoothing - - startline - Determines whether or not a line is drawn at along the - starting value of this axis. If True, the start line is - drawn on top of the grid lines. - startlinecolor - Sets the line color of the start line. - startlinewidth - Sets the width (in px) of the start line. - tick0 - The starting index of grid lines along the axis - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.carpet.baxis.Tickformatstop instance - or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.carpet - .baxis.tickformatstopdefaults), sets the default - property values to use for elements of - carpet.baxis.tickformatstops - tickmode - - tickprefix - Sets a tick label prefix. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - title - plotly.graph_objs.carpet.baxis.Title instance or dict - with compatible properties - titlefont - Deprecated: Please use carpet.baxis.title.font instead. - Sets this axis' title font. Note that the title's font - used to be set by the now deprecated `titlefont` - attribute. - titleoffset - Deprecated: Please use carpet.baxis.title.offset - instead. An additional amount by which to offset the - title from the tick labels, given in pixels. Note that - this used to be set by the now deprecated `titleoffset` - attribute. - type - Sets the axis type. By default, plotly attempts to - determined the axis type by looking into the data of - the traces that referenced the axis in question. - - Returns - ------- - Baxis - """ - super(Baxis, self).__init__('baxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.carpet.Baxis -constructor must be a dict or -an instance of plotly.graph_objs.carpet.Baxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.carpet import (baxis as v_baxis) - - # Initialize validators - # --------------------- - self._validators['arraydtick'] = v_baxis.ArraydtickValidator() - self._validators['arraytick0'] = v_baxis.Arraytick0Validator() - self._validators['autorange'] = v_baxis.AutorangeValidator() - self._validators['categoryarray'] = v_baxis.CategoryarrayValidator() - self._validators['categoryarraysrc' - ] = v_baxis.CategoryarraysrcValidator() - self._validators['categoryorder'] = v_baxis.CategoryorderValidator() - self._validators['cheatertype'] = v_baxis.CheatertypeValidator() - self._validators['color'] = v_baxis.ColorValidator() - self._validators['dtick'] = v_baxis.DtickValidator() - self._validators['endline'] = v_baxis.EndlineValidator() - self._validators['endlinecolor'] = v_baxis.EndlinecolorValidator() - self._validators['endlinewidth'] = v_baxis.EndlinewidthValidator() - self._validators['exponentformat'] = v_baxis.ExponentformatValidator() - self._validators['fixedrange'] = v_baxis.FixedrangeValidator() - self._validators['gridcolor'] = v_baxis.GridcolorValidator() - self._validators['gridwidth'] = v_baxis.GridwidthValidator() - self._validators['labelpadding'] = v_baxis.LabelpaddingValidator() - self._validators['labelprefix'] = v_baxis.LabelprefixValidator() - self._validators['labelsuffix'] = v_baxis.LabelsuffixValidator() - self._validators['linecolor'] = v_baxis.LinecolorValidator() - self._validators['linewidth'] = v_baxis.LinewidthValidator() - self._validators['minorgridcolor'] = v_baxis.MinorgridcolorValidator() - self._validators['minorgridcount'] = v_baxis.MinorgridcountValidator() - self._validators['minorgridwidth'] = v_baxis.MinorgridwidthValidator() - self._validators['nticks'] = v_baxis.NticksValidator() - self._validators['range'] = v_baxis.RangeValidator() - self._validators['rangemode'] = v_baxis.RangemodeValidator() - self._validators['separatethousands' - ] = v_baxis.SeparatethousandsValidator() - self._validators['showexponent'] = v_baxis.ShowexponentValidator() - self._validators['showgrid'] = v_baxis.ShowgridValidator() - self._validators['showline'] = v_baxis.ShowlineValidator() - self._validators['showticklabels'] = v_baxis.ShowticklabelsValidator() - self._validators['showtickprefix'] = v_baxis.ShowtickprefixValidator() - self._validators['showticksuffix'] = v_baxis.ShowticksuffixValidator() - self._validators['smoothing'] = v_baxis.SmoothingValidator() - self._validators['startline'] = v_baxis.StartlineValidator() - self._validators['startlinecolor'] = v_baxis.StartlinecolorValidator() - self._validators['startlinewidth'] = v_baxis.StartlinewidthValidator() - self._validators['tick0'] = v_baxis.Tick0Validator() - self._validators['tickangle'] = v_baxis.TickangleValidator() - self._validators['tickfont'] = v_baxis.TickfontValidator() - self._validators['tickformat'] = v_baxis.TickformatValidator() - self._validators['tickformatstops'] = v_baxis.TickformatstopsValidator( - ) - self._validators['tickformatstopdefaults' - ] = v_baxis.TickformatstopValidator() - self._validators['tickmode'] = v_baxis.TickmodeValidator() - self._validators['tickprefix'] = v_baxis.TickprefixValidator() - self._validators['ticksuffix'] = v_baxis.TicksuffixValidator() - self._validators['ticktext'] = v_baxis.TicktextValidator() - self._validators['ticktextsrc'] = v_baxis.TicktextsrcValidator() - self._validators['tickvals'] = v_baxis.TickvalsValidator() - self._validators['tickvalssrc'] = v_baxis.TickvalssrcValidator() - self._validators['title'] = v_baxis.TitleValidator() - self._validators['type'] = v_baxis.TypeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('arraydtick', None) - self['arraydtick'] = arraydtick if arraydtick is not None else _v - _v = arg.pop('arraytick0', None) - self['arraytick0'] = arraytick0 if arraytick0 is not None else _v - _v = arg.pop('autorange', None) - self['autorange'] = autorange if autorange is not None else _v - _v = arg.pop('categoryarray', None) - self['categoryarray' - ] = categoryarray if categoryarray is not None else _v - _v = arg.pop('categoryarraysrc', None) - self['categoryarraysrc' - ] = categoryarraysrc if categoryarraysrc is not None else _v - _v = arg.pop('categoryorder', None) - self['categoryorder' - ] = categoryorder if categoryorder is not None else _v - _v = arg.pop('cheatertype', None) - self['cheatertype'] = cheatertype if cheatertype is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('endline', None) - self['endline'] = endline if endline is not None else _v - _v = arg.pop('endlinecolor', None) - self['endlinecolor'] = endlinecolor if endlinecolor is not None else _v - _v = arg.pop('endlinewidth', None) - self['endlinewidth'] = endlinewidth if endlinewidth is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('fixedrange', None) - self['fixedrange'] = fixedrange if fixedrange is not None else _v - _v = arg.pop('gridcolor', None) - self['gridcolor'] = gridcolor if gridcolor is not None else _v - _v = arg.pop('gridwidth', None) - self['gridwidth'] = gridwidth if gridwidth is not None else _v - _v = arg.pop('labelpadding', None) - self['labelpadding'] = labelpadding if labelpadding is not None else _v - _v = arg.pop('labelprefix', None) - self['labelprefix'] = labelprefix if labelprefix is not None else _v - _v = arg.pop('labelsuffix', None) - self['labelsuffix'] = labelsuffix if labelsuffix is not None else _v - _v = arg.pop('linecolor', None) - self['linecolor'] = linecolor if linecolor is not None else _v - _v = arg.pop('linewidth', None) - self['linewidth'] = linewidth if linewidth is not None else _v - _v = arg.pop('minorgridcolor', None) - self['minorgridcolor' - ] = minorgridcolor if minorgridcolor is not None else _v - _v = arg.pop('minorgridcount', None) - self['minorgridcount' - ] = minorgridcount if minorgridcount is not None else _v - _v = arg.pop('minorgridwidth', None) - self['minorgridwidth' - ] = minorgridwidth if minorgridwidth is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('range', None) - self['range'] = range if range is not None else _v - _v = arg.pop('rangemode', None) - self['rangemode'] = rangemode if rangemode is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showgrid', None) - self['showgrid'] = showgrid if showgrid is not None else _v - _v = arg.pop('showline', None) - self['showline'] = showline if showline is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('smoothing', None) - self['smoothing'] = smoothing if smoothing is not None else _v - _v = arg.pop('startline', None) - self['startline'] = startline if startline is not None else _v - _v = arg.pop('startlinecolor', None) - self['startlinecolor' - ] = startlinecolor if startlinecolor is not None else _v - _v = arg.pop('startlinewidth', None) - self['startlinewidth' - ] = startlinewidth if startlinewidth is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleoffset', None) - _v = titleoffset if titleoffset is not None else _v - if _v is not None: - self['titleoffset'] = _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/_font.py b/plotly/graph_objs/carpet/_font.py deleted file mode 100644 index 152abf1e95c..00000000000 --- a/plotly/graph_objs/carpet/_font.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'carpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.carpet.Font -constructor must be a dict or -an instance of plotly.graph_objs.carpet.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.carpet import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/_hoverlabel.py b/plotly/graph_objs/carpet/_hoverlabel.py deleted file mode 100644 index 921fd78c34a..00000000000 --- a/plotly/graph_objs/carpet/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 plotly.graph_objs.carpet.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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.carpet.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'carpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.carpet.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.carpet.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.carpet import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/_stream.py b/plotly/graph_objs/carpet/_stream.py deleted file mode 100644 index 8c344296ef1..00000000000 --- a/plotly/graph_objs/carpet/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'carpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.carpet.Stream -constructor must be a dict or -an instance of plotly.graph_objs.carpet.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.carpet import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/aaxis/__init__.py b/plotly/graph_objs/carpet/aaxis/__init__.py index ed0668a218b..4c9959f25b6 100644 --- a/plotly/graph_objs/carpet/aaxis/__init__.py +++ b/plotly/graph_objs/carpet/aaxis/__init__.py @@ -1,4 +1,718 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.carpet.aaxis.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # offset + # ------ + @property + 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 + + Returns + ------- + int|float + """ + return self['offset'] + + @offset.setter + def offset(self, val): + self['offset'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'carpet.aaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. Note that the title's font + used to be set by the now deprecated `titlefont` + attribute. + offset + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, offset=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.carpet.aaxis.Title + font + Sets this axis' title font. Note that the title's font + used to be set by the now deprecated `titlefont` + attribute. + offset + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.carpet.aaxis.Title +constructor must be a dict or +an instance of plotly.graph_objs.carpet.aaxis.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.carpet.aaxis import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['offset'] = v_title.OffsetValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('offset', None) + self['offset'] = offset if offset is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'carpet.aaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.carpet.aaxis.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.carpet.aaxis.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.carpet.aaxis.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.carpet.aaxis import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'carpet.aaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.carpet.aaxis.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.carpet.aaxis.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.carpet.aaxis.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.carpet.aaxis import (tickfont as v_tickfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.carpet.aaxis import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/carpet/aaxis/_tickfont.py b/plotly/graph_objs/carpet/aaxis/_tickfont.py deleted file mode 100644 index 51c4f1771fc..00000000000 --- a/plotly/graph_objs/carpet/aaxis/_tickfont.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'carpet.aaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): - """ - Construct a new Tickfont object - - Sets the tick font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.aaxis.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.carpet.aaxis.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.carpet.aaxis.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.carpet.aaxis import (tickfont as v_tickfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/aaxis/_tickformatstop.py b/plotly/graph_objs/carpet/aaxis/_tickformatstop.py deleted file mode 100644 index 8155edc2153..00000000000 --- a/plotly/graph_objs/carpet/aaxis/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'carpet.aaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.carpet.aaxis.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.carpet.aaxis.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.carpet.aaxis.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.carpet.aaxis import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/aaxis/_title.py b/plotly/graph_objs/carpet/aaxis/_title.py deleted file mode 100644 index f45f6216542..00000000000 --- a/plotly/graph_objs/carpet/aaxis/_title.py +++ /dev/null @@ -1,200 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.carpet.aaxis.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # offset - # ------ - @property - 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 - - Returns - ------- - int|float - """ - return self['offset'] - - @offset.setter - def offset(self, val): - self['offset'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'carpet.aaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this axis' title font. Note that the title's font - used to be set by the now deprecated `titlefont` - attribute. - offset - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, offset=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.aaxis.Title - font - Sets this axis' title font. Note that the title's font - used to be set by the now deprecated `titlefont` - attribute. - offset - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.carpet.aaxis.Title -constructor must be a dict or -an instance of plotly.graph_objs.carpet.aaxis.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.carpet.aaxis import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['offset'] = v_title.OffsetValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('offset', None) - self['offset'] = offset if offset is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/aaxis/title/__init__.py b/plotly/graph_objs/carpet/aaxis/title/__init__.py index c37b8b5cd28..008243e3d8a 100644 --- a/plotly/graph_objs/carpet/aaxis/title/__init__.py +++ b/plotly/graph_objs/carpet/aaxis/title/__init__.py @@ -1 +1,229 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'carpet.aaxis.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.carpet.aaxis.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.carpet.aaxis.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.carpet.aaxis.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.carpet.aaxis.title import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/aaxis/title/_font.py b/plotly/graph_objs/carpet/aaxis/title/_font.py deleted file mode 100644 index 23b34653f22..00000000000 --- a/plotly/graph_objs/carpet/aaxis/title/_font.py +++ /dev/null @@ -1,227 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'carpet.aaxis.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.carpet.aaxis.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.carpet.aaxis.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.carpet.aaxis.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.carpet.aaxis.title import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/baxis/__init__.py b/plotly/graph_objs/carpet/baxis/__init__.py index 6eac139620f..1a55cd6cc1a 100644 --- a/plotly/graph_objs/carpet/baxis/__init__.py +++ b/plotly/graph_objs/carpet/baxis/__init__.py @@ -1,4 +1,718 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.carpet.baxis.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # offset + # ------ + @property + 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 + + Returns + ------- + int|float + """ + return self['offset'] + + @offset.setter + def offset(self, val): + self['offset'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'carpet.baxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. Note that the title's font + used to be set by the now deprecated `titlefont` + attribute. + offset + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, offset=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.carpet.baxis.Title + font + Sets this axis' title font. Note that the title's font + used to be set by the now deprecated `titlefont` + attribute. + offset + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.carpet.baxis.Title +constructor must be a dict or +an instance of plotly.graph_objs.carpet.baxis.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.carpet.baxis import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['offset'] = v_title.OffsetValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('offset', None) + self['offset'] = offset if offset is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'carpet.baxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.carpet.baxis.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.carpet.baxis.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.carpet.baxis.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.carpet.baxis import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'carpet.baxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.carpet.baxis.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.carpet.baxis.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.carpet.baxis.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.carpet.baxis import (tickfont as v_tickfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.carpet.baxis import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/carpet/baxis/_tickfont.py b/plotly/graph_objs/carpet/baxis/_tickfont.py deleted file mode 100644 index acf897cf25b..00000000000 --- a/plotly/graph_objs/carpet/baxis/_tickfont.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'carpet.baxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): - """ - Construct a new Tickfont object - - Sets the tick font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.baxis.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.carpet.baxis.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.carpet.baxis.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.carpet.baxis import (tickfont as v_tickfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/baxis/_tickformatstop.py b/plotly/graph_objs/carpet/baxis/_tickformatstop.py deleted file mode 100644 index bcb6ee66055..00000000000 --- a/plotly/graph_objs/carpet/baxis/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'carpet.baxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.carpet.baxis.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.carpet.baxis.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.carpet.baxis.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.carpet.baxis import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/baxis/_title.py b/plotly/graph_objs/carpet/baxis/_title.py deleted file mode 100644 index 5003f98494e..00000000000 --- a/plotly/graph_objs/carpet/baxis/_title.py +++ /dev/null @@ -1,200 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.carpet.baxis.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # offset - # ------ - @property - 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 - - Returns - ------- - int|float - """ - return self['offset'] - - @offset.setter - def offset(self, val): - self['offset'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'carpet.baxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this axis' title font. Note that the title's font - used to be set by the now deprecated `titlefont` - attribute. - offset - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, offset=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.baxis.Title - font - Sets this axis' title font. Note that the title's font - used to be set by the now deprecated `titlefont` - attribute. - offset - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.carpet.baxis.Title -constructor must be a dict or -an instance of plotly.graph_objs.carpet.baxis.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.carpet.baxis import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['offset'] = v_title.OffsetValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('offset', None) - self['offset'] = offset if offset is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/baxis/title/__init__.py b/plotly/graph_objs/carpet/baxis/title/__init__.py index c37b8b5cd28..73e71cf9325 100644 --- a/plotly/graph_objs/carpet/baxis/title/__init__.py +++ b/plotly/graph_objs/carpet/baxis/title/__init__.py @@ -1 +1,229 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'carpet.baxis.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.carpet.baxis.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.carpet.baxis.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.carpet.baxis.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.carpet.baxis.title import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/baxis/title/_font.py b/plotly/graph_objs/carpet/baxis/title/_font.py deleted file mode 100644 index 498f2720e6e..00000000000 --- a/plotly/graph_objs/carpet/baxis/title/_font.py +++ /dev/null @@ -1,227 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'carpet.baxis.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.carpet.baxis.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.carpet.baxis.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.carpet.baxis.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.carpet.baxis.title import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/hoverlabel/__init__.py b/plotly/graph_objs/carpet/hoverlabel/__init__.py index c37b8b5cd28..6b1cb7c60f8 100644 --- a/plotly/graph_objs/carpet/hoverlabel/__init__.py +++ b/plotly/graph_objs/carpet/hoverlabel/__init__.py @@ -1 +1,321 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'carpet.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.carpet.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.carpet.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.carpet.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.carpet.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/carpet/hoverlabel/_font.py b/plotly/graph_objs/carpet/hoverlabel/_font.py deleted file mode 100644 index 1d45abecb7a..00000000000 --- a/plotly/graph_objs/carpet/hoverlabel/_font.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'carpet.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.carpet.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.carpet.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.carpet.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.carpet.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/__init__.py b/plotly/graph_objs/choropleth/__init__.py index 836539c7090..5790fb620a2 100644 --- a/plotly/graph_objs/choropleth/__init__.py +++ b/plotly/graph_objs/choropleth/__init__.py @@ -1,11 +1,2827 @@ -from ._unselected import Unselected + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.choropleth.unselected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'choropleth' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.choropleth.unselected.Marker instance + or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.choropleth.Unselected + marker + plotly.graph_objs.choropleth.unselected.Marker instance + or dict with compatible properties + + Returns + ------- + Unselected + """ + super(Unselected, self).__init__('unselected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.choropleth.Unselected +constructor must be a dict or +an instance of plotly.graph_objs.choropleth.Unselected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.choropleth import (unselected as v_unselected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_unselected.MarkerValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'choropleth' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.choropleth.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.choropleth.Stream +constructor must be a dict or +an instance of plotly.graph_objs.choropleth.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.choropleth import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.choropleth.selected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'choropleth' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.choropleth.selected.Marker instance + or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.choropleth.Selected + marker + plotly.graph_objs.choropleth.selected.Marker instance + or dict with compatible properties + + Returns + ------- + Selected + """ + super(Selected, self).__init__('selected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.choropleth.Selected +constructor must be a dict or +an instance of plotly.graph_objs.choropleth.Selected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.choropleth import (selected as v_selected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_selected.MarkerValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + 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. + colorsrc + Sets the source reference on plot.ly for color + . + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.choropleth.marker.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # opacity + # ------- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # opacitysrc + # ---------- + @property + def opacitysrc(self): + """ + Sets the source reference on plot.ly for opacity . + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['opacitysrc'] + + @opacitysrc.setter + def opacitysrc(self, val): + self['opacitysrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'choropleth' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + line + plotly.graph_objs.choropleth.marker.Line instance or + dict with compatible properties + opacity + Sets the opacity of the locations. + opacitysrc + Sets the source reference on plot.ly for opacity . + """ + + def __init__( + self, arg=None, line=None, opacity=None, opacitysrc=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.choropleth.Marker + line + plotly.graph_objs.choropleth.marker.Line instance or + dict with compatible properties + opacity + Sets the opacity of the locations. + opacitysrc + Sets the source reference on plot.ly for opacity . + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.choropleth.Marker +constructor must be a dict or +an instance of plotly.graph_objs.choropleth.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.choropleth import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['line'] = v_marker.LineValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('opacitysrc', None) + self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.choropleth.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'choropleth' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.choropleth.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.choropleth.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.choropleth.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.choropleth import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.choropleth.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.choropleth.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + 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 plotly.graph_objs.choropleth.colorbar.Tickformatstop + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.choropleth.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.choropleth.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use choropleth.colorbar.title.side instead. + Determines the location of color bar's title with respect to + the color bar. Note that the title's location used to be set by + the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'choropleth' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.choropleth.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.chorop + leth.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + choropleth.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.choropleth.colorbar.Title instance or + dict with compatible properties + titlefont + Deprecated: Please use choropleth.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use choropleth.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.choropleth.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.choropleth.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.chorop + leth.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + choropleth.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.choropleth.colorbar.Title instance or + dict with compatible properties + titlefont + Deprecated: Please use choropleth.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use choropleth.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.choropleth.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.choropleth.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.choropleth import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.choropleth import unselected -from ._stream import Stream -from ._selected import Selected from plotly.graph_objs.choropleth import selected -from ._marker import Marker from plotly.graph_objs.choropleth import marker -from ._hoverlabel import Hoverlabel from plotly.graph_objs.choropleth import hoverlabel -from ._colorbar import ColorBar from plotly.graph_objs.choropleth import colorbar diff --git a/plotly/graph_objs/choropleth/_colorbar.py b/plotly/graph_objs/choropleth/_colorbar.py deleted file mode 100644 index 2edcdd95307..00000000000 --- a/plotly/graph_objs/choropleth/_colorbar.py +++ /dev/null @@ -1,1862 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.choropleth.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.choropleth.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - 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 plotly.graph_objs.choropleth.colorbar.Tickformatstop - - A dict of string/value properties that will be passed - to the Tickformatstop constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.choropleth.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.choropleth.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use choropleth.colorbar.title.side instead. - Determines the location of color bar's title with respect to - the color bar. Note that the title's location used to be set by - the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'choropleth' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.choropleth.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.chorop - leth.colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - choropleth.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.choropleth.colorbar.Title instance or - dict with compatible properties - titlefont - Deprecated: Please use choropleth.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use choropleth.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.choropleth.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.choropleth.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.chorop - leth.colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - choropleth.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.choropleth.colorbar.Title instance or - dict with compatible properties - titlefont - Deprecated: Please use choropleth.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use choropleth.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.choropleth.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.choropleth.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.choropleth import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/_hoverlabel.py b/plotly/graph_objs/choropleth/_hoverlabel.py deleted file mode 100644 index 248e4905926..00000000000 --- a/plotly/graph_objs/choropleth/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.choropleth.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'choropleth' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.choropleth.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.choropleth.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.choropleth.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.choropleth import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/_marker.py b/plotly/graph_objs/choropleth/_marker.py deleted file mode 100644 index 282f3b2710d..00000000000 --- a/plotly/graph_objs/choropleth/_marker.py +++ /dev/null @@ -1,178 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - 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. - colorsrc - Sets the source reference on plot.ly for color - . - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.choropleth.marker.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # opacity - # ------- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # opacitysrc - # ---------- - @property - def opacitysrc(self): - """ - Sets the source reference on plot.ly for opacity . - - The 'opacitysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['opacitysrc'] - - @opacitysrc.setter - def opacitysrc(self, val): - self['opacitysrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'choropleth' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - line - plotly.graph_objs.choropleth.marker.Line instance or - dict with compatible properties - opacity - Sets the opacity of the locations. - opacitysrc - Sets the source reference on plot.ly for opacity . - """ - - def __init__( - self, arg=None, line=None, opacity=None, opacitysrc=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.choropleth.Marker - line - plotly.graph_objs.choropleth.marker.Line instance or - dict with compatible properties - opacity - Sets the opacity of the locations. - opacitysrc - Sets the source reference on plot.ly for opacity . - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.choropleth.Marker -constructor must be a dict or -an instance of plotly.graph_objs.choropleth.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.choropleth import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['line'] = v_marker.LineValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('opacitysrc', None) - self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/_selected.py b/plotly/graph_objs/choropleth/_selected.py deleted file mode 100644 index 0958fcb7a41..00000000000 --- a/plotly/graph_objs/choropleth/_selected.py +++ /dev/null @@ -1,107 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Selected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.choropleth.selected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'choropleth' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.choropleth.selected.Marker instance - or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, **kwargs): - """ - Construct a new Selected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.choropleth.Selected - marker - plotly.graph_objs.choropleth.selected.Marker instance - or dict with compatible properties - - Returns - ------- - Selected - """ - super(Selected, self).__init__('selected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.choropleth.Selected -constructor must be a dict or -an instance of plotly.graph_objs.choropleth.Selected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.choropleth import (selected as v_selected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_selected.MarkerValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/_stream.py b/plotly/graph_objs/choropleth/_stream.py deleted file mode 100644 index e4575c8569a..00000000000 --- a/plotly/graph_objs/choropleth/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'choropleth' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.choropleth.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.choropleth.Stream -constructor must be a dict or -an instance of plotly.graph_objs.choropleth.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.choropleth import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/_unselected.py b/plotly/graph_objs/choropleth/_unselected.py deleted file mode 100644 index b9a67ab6178..00000000000 --- a/plotly/graph_objs/choropleth/_unselected.py +++ /dev/null @@ -1,108 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Unselected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.choropleth.unselected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'choropleth' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.choropleth.unselected.Marker instance - or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, **kwargs): - """ - Construct a new Unselected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.choropleth.Unselected - marker - plotly.graph_objs.choropleth.unselected.Marker instance - or dict with compatible properties - - Returns - ------- - Unselected - """ - super(Unselected, self).__init__('unselected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.choropleth.Unselected -constructor must be a dict or -an instance of plotly.graph_objs.choropleth.Unselected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.choropleth import (unselected as v_unselected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_unselected.MarkerValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/colorbar/__init__.py b/plotly/graph_objs/choropleth/colorbar/__init__.py index a3477d9f592..27f274da85d 100644 --- a/plotly/graph_objs/choropleth/colorbar/__init__.py +++ b/plotly/graph_objs/choropleth/colorbar/__init__.py @@ -1,4 +1,723 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.choropleth.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'choropleth.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.choropleth.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.choropleth.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.choropleth.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.choropleth.colorbar import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'choropleth.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.choropleth.colorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.choropleth.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.choropleth.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.choropleth.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'choropleth.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.choropleth.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.choropleth.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.choropleth.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.choropleth.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.choropleth.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/choropleth/colorbar/_tickfont.py b/plotly/graph_objs/choropleth/colorbar/_tickfont.py deleted file mode 100644 index 298e53909ee..00000000000 --- a/plotly/graph_objs/choropleth/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'choropleth.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.choropleth.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.choropleth.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.choropleth.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.choropleth.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py b/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py deleted file mode 100644 index 34c84613422..00000000000 --- a/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'choropleth.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.choropleth.colorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.choropleth.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.choropleth.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.choropleth.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/colorbar/_title.py b/plotly/graph_objs/choropleth/colorbar/_title.py deleted file mode 100644 index 47211c8489b..00000000000 --- a/plotly/graph_objs/choropleth/colorbar/_title.py +++ /dev/null @@ -1,202 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.choropleth.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'choropleth.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.choropleth.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.choropleth.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.choropleth.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.choropleth.colorbar import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/colorbar/title/__init__.py b/plotly/graph_objs/choropleth/colorbar/title/__init__.py index c37b8b5cd28..c819235765d 100644 --- a/plotly/graph_objs/choropleth/colorbar/title/__init__.py +++ b/plotly/graph_objs/choropleth/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'choropleth.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.choropleth.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.choropleth.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.choropleth.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.choropleth.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/colorbar/title/_font.py b/plotly/graph_objs/choropleth/colorbar/title/_font.py deleted file mode 100644 index 16c06639d70..00000000000 --- a/plotly/graph_objs/choropleth/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'choropleth.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.choropleth.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.choropleth.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.choropleth.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.choropleth.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/hoverlabel/__init__.py b/plotly/graph_objs/choropleth/hoverlabel/__init__.py index c37b8b5cd28..ca7676771ac 100644 --- a/plotly/graph_objs/choropleth/hoverlabel/__init__.py +++ b/plotly/graph_objs/choropleth/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'choropleth.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.choropleth.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.choropleth.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.choropleth.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.choropleth.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/hoverlabel/_font.py b/plotly/graph_objs/choropleth/hoverlabel/_font.py deleted file mode 100644 index d4b38823d75..00000000000 --- a/plotly/graph_objs/choropleth/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'choropleth.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.choropleth.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.choropleth.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.choropleth.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.choropleth.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/marker/__init__.py b/plotly/graph_objs/choropleth/marker/__init__.py index 471a5835d71..d6ac63db9a3 100644 --- a/plotly/graph_objs/choropleth/marker/__init__.py +++ b/plotly/graph_objs/choropleth/marker/__init__.py @@ -1 +1,244 @@ -from ._line import Line + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + Sets themarker.linecolor. It accepts either a specific color or + an array of numbers that are mapped to the colorscale relative + to the max and min values of the array or relative to + `marker.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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'choropleth.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorsrc + Sets the source reference on plot.ly for color . + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.choropleth.marker.Line + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorsrc + Sets the source reference on plot.ly for color . + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.choropleth.marker.Line +constructor must be a dict or +an instance of plotly.graph_objs.choropleth.marker.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.choropleth.marker import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/marker/_line.py b/plotly/graph_objs/choropleth/marker/_line.py deleted file mode 100644 index b4353478f40..00000000000 --- a/plotly/graph_objs/choropleth/marker/_line.py +++ /dev/null @@ -1,242 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - Sets themarker.linecolor. It accepts either a specific color or - an array of numbers that are mapped to the colorscale relative - to the max and min values of the array or relative to - `marker.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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'choropleth.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorsrc - Sets the source reference on plot.ly for color . - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.choropleth.marker.Line - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorsrc - Sets the source reference on plot.ly for color . - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.choropleth.marker.Line -constructor must be a dict or -an instance of plotly.graph_objs.choropleth.marker.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.choropleth.marker import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/selected/__init__.py b/plotly/graph_objs/choropleth/selected/__init__.py index 0bda16c3500..184e03682ec 100644 --- a/plotly/graph_objs/choropleth/selected/__init__.py +++ b/plotly/graph_objs/choropleth/selected/__init__.py @@ -1 +1,102 @@ -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'choropleth.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + opacity + Sets the marker opacity of selected points. + """ + + def __init__(self, arg=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.choropleth.selected.Marker + opacity + Sets the marker opacity of selected points. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.choropleth.selected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.choropleth.selected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.choropleth.selected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['opacity'] = v_marker.OpacityValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/selected/_marker.py b/plotly/graph_objs/choropleth/selected/_marker.py deleted file mode 100644 index 8a52dc19b4a..00000000000 --- a/plotly/graph_objs/choropleth/selected/_marker.py +++ /dev/null @@ -1,100 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'choropleth.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - opacity - Sets the marker opacity of selected points. - """ - - def __init__(self, arg=None, opacity=None, **kwargs): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.choropleth.selected.Marker - opacity - Sets the marker opacity of selected points. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.choropleth.selected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.choropleth.selected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.choropleth.selected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['opacity'] = v_marker.OpacityValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/unselected/__init__.py b/plotly/graph_objs/choropleth/unselected/__init__.py index 0bda16c3500..98a71dbfe9d 100644 --- a/plotly/graph_objs/choropleth/unselected/__init__.py +++ b/plotly/graph_objs/choropleth/unselected/__init__.py @@ -1 +1,107 @@ -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'choropleth.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.choropleth.unselected.Marker + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.choropleth.unselected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.choropleth.unselected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.choropleth.unselected import ( + marker as v_marker + ) + + # Initialize validators + # --------------------- + self._validators['opacity'] = v_marker.OpacityValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/choropleth/unselected/_marker.py b/plotly/graph_objs/choropleth/unselected/_marker.py deleted file mode 100644 index e82a069dcd5..00000000000 --- a/plotly/graph_objs/choropleth/unselected/_marker.py +++ /dev/null @@ -1,105 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'choropleth.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - """ - - def __init__(self, arg=None, opacity=None, **kwargs): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.choropleth.unselected.Marker - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.choropleth.unselected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.choropleth.unselected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.choropleth.unselected import ( - marker as v_marker - ) - - # Initialize validators - # --------------------- - self._validators['opacity'] = v_marker.OpacityValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/cone/__init__.py b/plotly/graph_objs/cone/__init__.py index b2469854e03..deb85908375 100644 --- a/plotly/graph_objs/cone/__init__.py +++ b/plotly/graph_objs/cone/__init__.py @@ -1,7 +1,2892 @@ -from ._stream import Stream -from ._lightposition import Lightposition -from ._lighting import Lighting -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'cone' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.cone.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.cone.Stream +constructor must be a dict or +an instance of plotly.graph_objs.cone.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.cone import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lightposition(_BaseTraceHierarchyType): + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # z + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'cone' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Lightposition object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.cone.Lightposition + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + + Returns + ------- + Lightposition + """ + super(Lightposition, self).__init__('lightposition') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.cone.Lightposition +constructor must be a dict or +an instance of plotly.graph_objs.cone.Lightposition""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.cone import (lightposition as v_lightposition) + + # Initialize validators + # --------------------- + self._validators['x'] = v_lightposition.XValidator() + self._validators['y'] = v_lightposition.YValidator() + self._validators['z'] = v_lightposition.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lighting(_BaseTraceHierarchyType): + + # ambient + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ambient'] + + @ambient.setter + def ambient(self, val): + self['ambient'] = val + + # diffuse + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['diffuse'] + + @diffuse.setter + def diffuse(self, val): + self['diffuse'] = val + + # facenormalsepsilon + # ------------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['facenormalsepsilon'] + + @facenormalsepsilon.setter + def facenormalsepsilon(self, val): + self['facenormalsepsilon'] = val + + # fresnel + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['fresnel'] + + @fresnel.setter + def fresnel(self, val): + self['fresnel'] = val + + # roughness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['roughness'] + + @roughness.setter + def roughness(self, val): + self['roughness'] = val + + # specular + # -------- + @property + 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] + + Returns + ------- + int|float + """ + return self['specular'] + + @specular.setter + def specular(self, val): + self['specular'] = val + + # vertexnormalsepsilon + # -------------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['vertexnormalsepsilon'] + + @vertexnormalsepsilon.setter + def vertexnormalsepsilon(self, val): + self['vertexnormalsepsilon'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'cone' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + """ + + def __init__( + self, + arg=None, + ambient=None, + diffuse=None, + facenormalsepsilon=None, + fresnel=None, + roughness=None, + specular=None, + vertexnormalsepsilon=None, + **kwargs + ): + """ + Construct a new Lighting object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.cone.Lighting + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + + Returns + ------- + Lighting + """ + super(Lighting, self).__init__('lighting') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.cone.Lighting +constructor must be a dict or +an instance of plotly.graph_objs.cone.Lighting""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.cone import (lighting as v_lighting) + + # Initialize validators + # --------------------- + self._validators['ambient'] = v_lighting.AmbientValidator() + self._validators['diffuse'] = v_lighting.DiffuseValidator() + self._validators['facenormalsepsilon' + ] = v_lighting.FacenormalsepsilonValidator() + self._validators['fresnel'] = v_lighting.FresnelValidator() + self._validators['roughness'] = v_lighting.RoughnessValidator() + self._validators['specular'] = v_lighting.SpecularValidator() + self._validators['vertexnormalsepsilon' + ] = v_lighting.VertexnormalsepsilonValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('ambient', None) + self['ambient'] = ambient if ambient is not None else _v + _v = arg.pop('diffuse', None) + self['diffuse'] = diffuse if diffuse is not None else _v + _v = arg.pop('facenormalsepsilon', None) + self['facenormalsepsilon' + ] = facenormalsepsilon if facenormalsepsilon is not None else _v + _v = arg.pop('fresnel', None) + self['fresnel'] = fresnel if fresnel is not None else _v + _v = arg.pop('roughness', None) + self['roughness'] = roughness if roughness is not None else _v + _v = arg.pop('specular', None) + self['specular'] = specular if specular is not None else _v + _v = arg.pop('vertexnormalsepsilon', None) + self[ + 'vertexnormalsepsilon' + ] = vertexnormalsepsilon if vertexnormalsepsilon is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.cone.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'cone' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.cone.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.cone.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.cone.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.cone import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.cone.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.cone.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + 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 plotly.graph_objs.cone.colorbar.Tickformatstop + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.cone.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.cone.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use cone.colorbar.title.side instead. + Determines the location of color bar's title with respect to + the color bar. Note that the title's location used to be set by + the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'cone' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.cone.colorbar.Tickformatstop instance + or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.cone.c + olorbar.tickformatstopdefaults), sets the default + property values to use for elements of + cone.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.cone.colorbar.Title instance or dict + with compatible properties + titlefont + Deprecated: Please use cone.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use cone.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.cone.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.cone.colorbar.Tickformatstop instance + or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.cone.c + olorbar.tickformatstopdefaults), sets the default + property values to use for elements of + cone.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.cone.colorbar.Title instance or dict + with compatible properties + titlefont + Deprecated: Please use cone.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use cone.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.cone.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.cone.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.cone import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.cone import hoverlabel -from ._colorbar import ColorBar from plotly.graph_objs.cone import colorbar diff --git a/plotly/graph_objs/cone/_colorbar.py b/plotly/graph_objs/cone/_colorbar.py deleted file mode 100644 index 3dbb04c4a00..00000000000 --- a/plotly/graph_objs/cone/_colorbar.py +++ /dev/null @@ -1,1863 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.cone.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.cone.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as - 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 plotly.graph_objs.cone.colorbar.Tickformatstop - - A dict of string/value properties that will be passed - to the Tickformatstop constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.cone.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.cone.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use cone.colorbar.title.side instead. - Determines the location of color bar's title with respect to - the color bar. Note that the title's location used to be set by - the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'cone' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.cone.colorbar.Tickformatstop instance - or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.cone.c - olorbar.tickformatstopdefaults), sets the default - property values to use for elements of - cone.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.cone.colorbar.Title instance or dict - with compatible properties - titlefont - Deprecated: Please use cone.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use cone.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.cone.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.cone.colorbar.Tickformatstop instance - or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.cone.c - olorbar.tickformatstopdefaults), sets the default - property values to use for elements of - cone.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.cone.colorbar.Title instance or dict - with compatible properties - titlefont - Deprecated: Please use cone.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use cone.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.cone.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.cone.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.cone import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/cone/_hoverlabel.py b/plotly/graph_objs/cone/_hoverlabel.py deleted file mode 100644 index ce351432258..00000000000 --- a/plotly/graph_objs/cone/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.cone.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'cone' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.cone.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.cone.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.cone.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.cone import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/cone/_lighting.py b/plotly/graph_objs/cone/_lighting.py deleted file mode 100644 index da3e158bf0d..00000000000 --- a/plotly/graph_objs/cone/_lighting.py +++ /dev/null @@ -1,303 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Lighting(BaseTraceHierarchyType): - - # ambient - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ambient'] - - @ambient.setter - def ambient(self, val): - self['ambient'] = val - - # diffuse - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['diffuse'] - - @diffuse.setter - def diffuse(self, val): - self['diffuse'] = val - - # facenormalsepsilon - # ------------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['facenormalsepsilon'] - - @facenormalsepsilon.setter - def facenormalsepsilon(self, val): - self['facenormalsepsilon'] = val - - # fresnel - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['fresnel'] - - @fresnel.setter - def fresnel(self, val): - self['fresnel'] = val - - # roughness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['roughness'] - - @roughness.setter - def roughness(self, val): - self['roughness'] = val - - # specular - # -------- - @property - 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] - - Returns - ------- - int|float - """ - return self['specular'] - - @specular.setter - def specular(self, val): - self['specular'] = val - - # vertexnormalsepsilon - # -------------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['vertexnormalsepsilon'] - - @vertexnormalsepsilon.setter - def vertexnormalsepsilon(self, val): - self['vertexnormalsepsilon'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'cone' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - ambient - Ambient light increases overall color visibility but - can wash out the image. - diffuse - Represents the extent that incident rays are reflected - in a range of angles. - facenormalsepsilon - Epsilon for face normals calculation avoids math issues - arising from degenerate geometry. - fresnel - Represents the reflectance as a dependency of the - viewing angle; e.g. paper is reflective when viewing it - from the edge of the paper (almost 90 degrees), causing - shine. - roughness - Alters specular reflection; the rougher the surface, - the wider and less contrasty the shine. - specular - Represents the level that incident rays are reflected - in a single direction, causing shine. - vertexnormalsepsilon - Epsilon for vertex normals calculation avoids math - issues arising from degenerate geometry. - """ - - def __init__( - self, - arg=None, - ambient=None, - diffuse=None, - facenormalsepsilon=None, - fresnel=None, - roughness=None, - specular=None, - vertexnormalsepsilon=None, - **kwargs - ): - """ - Construct a new Lighting object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.cone.Lighting - ambient - Ambient light increases overall color visibility but - can wash out the image. - diffuse - Represents the extent that incident rays are reflected - in a range of angles. - facenormalsepsilon - Epsilon for face normals calculation avoids math issues - arising from degenerate geometry. - fresnel - Represents the reflectance as a dependency of the - viewing angle; e.g. paper is reflective when viewing it - from the edge of the paper (almost 90 degrees), causing - shine. - roughness - Alters specular reflection; the rougher the surface, - the wider and less contrasty the shine. - specular - Represents the level that incident rays are reflected - in a single direction, causing shine. - vertexnormalsepsilon - Epsilon for vertex normals calculation avoids math - issues arising from degenerate geometry. - - Returns - ------- - Lighting - """ - super(Lighting, self).__init__('lighting') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.cone.Lighting -constructor must be a dict or -an instance of plotly.graph_objs.cone.Lighting""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.cone import (lighting as v_lighting) - - # Initialize validators - # --------------------- - self._validators['ambient'] = v_lighting.AmbientValidator() - self._validators['diffuse'] = v_lighting.DiffuseValidator() - self._validators['facenormalsepsilon' - ] = v_lighting.FacenormalsepsilonValidator() - self._validators['fresnel'] = v_lighting.FresnelValidator() - self._validators['roughness'] = v_lighting.RoughnessValidator() - self._validators['specular'] = v_lighting.SpecularValidator() - self._validators['vertexnormalsepsilon' - ] = v_lighting.VertexnormalsepsilonValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('ambient', None) - self['ambient'] = ambient if ambient is not None else _v - _v = arg.pop('diffuse', None) - self['diffuse'] = diffuse if diffuse is not None else _v - _v = arg.pop('facenormalsepsilon', None) - self['facenormalsepsilon' - ] = facenormalsepsilon if facenormalsepsilon is not None else _v - _v = arg.pop('fresnel', None) - self['fresnel'] = fresnel if fresnel is not None else _v - _v = arg.pop('roughness', None) - self['roughness'] = roughness if roughness is not None else _v - _v = arg.pop('specular', None) - self['specular'] = specular if specular is not None else _v - _v = arg.pop('vertexnormalsepsilon', None) - self[ - 'vertexnormalsepsilon' - ] = vertexnormalsepsilon if vertexnormalsepsilon is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/cone/_lightposition.py b/plotly/graph_objs/cone/_lightposition.py deleted file mode 100644 index 8377ce0d6f6..00000000000 --- a/plotly/graph_objs/cone/_lightposition.py +++ /dev/null @@ -1,159 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Lightposition(BaseTraceHierarchyType): - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # z - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'cone' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - Numeric vector, representing the X coordinate for each - vertex. - y - Numeric vector, representing the Y coordinate for each - vertex. - z - Numeric vector, representing the Z coordinate for each - vertex. - """ - - def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): - """ - Construct a new Lightposition object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.cone.Lightposition - x - Numeric vector, representing the X coordinate for each - vertex. - y - Numeric vector, representing the Y coordinate for each - vertex. - z - Numeric vector, representing the Z coordinate for each - vertex. - - Returns - ------- - Lightposition - """ - super(Lightposition, self).__init__('lightposition') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.cone.Lightposition -constructor must be a dict or -an instance of plotly.graph_objs.cone.Lightposition""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.cone import (lightposition as v_lightposition) - - # Initialize validators - # --------------------- - self._validators['x'] = v_lightposition.XValidator() - self._validators['y'] = v_lightposition.YValidator() - self._validators['z'] = v_lightposition.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/cone/_stream.py b/plotly/graph_objs/cone/_stream.py deleted file mode 100644 index fd699106783..00000000000 --- a/plotly/graph_objs/cone/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'cone' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.cone.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.cone.Stream -constructor must be a dict or -an instance of plotly.graph_objs.cone.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.cone import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/cone/colorbar/__init__.py b/plotly/graph_objs/cone/colorbar/__init__.py index ebd89c3e86f..93a90c439ff 100644 --- a/plotly/graph_objs/cone/colorbar/__init__.py +++ b/plotly/graph_objs/cone/colorbar/__init__.py @@ -1,4 +1,719 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.cone.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'cone.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.cone.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.cone.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.cone.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.cone.colorbar import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'cone.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.cone.colorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.cone.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.cone.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.cone.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'cone.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.cone.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.cone.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.cone.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.cone.colorbar import (tickfont as v_tickfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.cone.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/cone/colorbar/_tickfont.py b/plotly/graph_objs/cone/colorbar/_tickfont.py deleted file mode 100644 index 75f5d45a612..00000000000 --- a/plotly/graph_objs/cone/colorbar/_tickfont.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'cone.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.cone.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.cone.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.cone.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.cone.colorbar import (tickfont as v_tickfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/cone/colorbar/_tickformatstop.py b/plotly/graph_objs/cone/colorbar/_tickformatstop.py deleted file mode 100644 index 024ed03207a..00000000000 --- a/plotly/graph_objs/cone/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'cone.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.cone.colorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.cone.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.cone.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.cone.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/cone/colorbar/_title.py b/plotly/graph_objs/cone/colorbar/_title.py deleted file mode 100644 index 1e5895ed958..00000000000 --- a/plotly/graph_objs/cone/colorbar/_title.py +++ /dev/null @@ -1,201 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.cone.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'cone.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.cone.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.cone.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.cone.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.cone.colorbar import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/cone/colorbar/title/__init__.py b/plotly/graph_objs/cone/colorbar/title/__init__.py index c37b8b5cd28..14f6ff61a9f 100644 --- a/plotly/graph_objs/cone/colorbar/title/__init__.py +++ b/plotly/graph_objs/cone/colorbar/title/__init__.py @@ -1 +1,229 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'cone.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.cone.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.cone.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.cone.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.cone.colorbar.title import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/cone/colorbar/title/_font.py b/plotly/graph_objs/cone/colorbar/title/_font.py deleted file mode 100644 index c05a9a660d5..00000000000 --- a/plotly/graph_objs/cone/colorbar/title/_font.py +++ /dev/null @@ -1,227 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'cone.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.cone.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.cone.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.cone.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.cone.colorbar.title import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/cone/hoverlabel/__init__.py b/plotly/graph_objs/cone/hoverlabel/__init__.py index c37b8b5cd28..b9d86aa282e 100644 --- a/plotly/graph_objs/cone/hoverlabel/__init__.py +++ b/plotly/graph_objs/cone/hoverlabel/__init__.py @@ -1 +1,321 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'cone.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.cone.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.cone.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.cone.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.cone.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/cone/hoverlabel/_font.py b/plotly/graph_objs/cone/hoverlabel/_font.py deleted file mode 100644 index 70a71ef806a..00000000000 --- a/plotly/graph_objs/cone/hoverlabel/_font.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'cone.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.cone.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.cone.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.cone.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.cone.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contour/__init__.py b/plotly/graph_objs/contour/__init__.py index 73dadc12194..64a99457e73 100644 --- a/plotly/graph_objs/contour/__init__.py +++ b/plotly/graph_objs/contour/__init__.py @@ -1,8 +1,3183 @@ -from ._stream import Stream -from ._line import Line -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contour' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.contour.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contour.Stream +constructor must be a dict or +an instance of plotly.graph_objs.contour.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contour import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dash + # ---- + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self['dash'] + + @dash.setter + def dash(self, val): + self['dash'] = val + + # smoothing + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['smoothing'] + + @smoothing.setter + def smoothing(self, val): + self['smoothing'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contour' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour level. Has no effect if + `contours.coloring` is set to "lines". + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour lines, + where 0 corresponds to no smoothing. + width + Sets the line width (in px). + """ + + def __init__( + self, + arg=None, + color=None, + dash=None, + smoothing=None, + width=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.contour.Line + color + Sets the color of the contour level. Has no effect if + `contours.coloring` is set to "lines". + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour lines, + where 0 corresponds to no smoothing. + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contour.Line +constructor must be a dict or +an instance of plotly.graph_objs.contour.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contour import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['dash'] = v_line.DashValidator() + self._validators['smoothing'] = v_line.SmoothingValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dash', None) + self['dash'] = dash if dash is not None else _v + _v = arg.pop('smoothing', None) + self['smoothing'] = smoothing if smoothing is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.contour.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contour' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.contour.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contour.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.contour.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contour import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Contours(_BaseTraceHierarchyType): + + # coloring + # -------- + @property + def coloring(self): + """ + Determines the coloring method showing the contour values. If + "fill", coloring is done evenly between each contour level If + "heatmap", a heatmap gradient coloring is applied between each + contour level. If "lines", coloring is done on the contour + lines. If "none", no coloring is applied on this trace. + + The 'coloring' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fill', 'heatmap', 'lines', 'none'] + + Returns + ------- + Any + """ + return self['coloring'] + + @coloring.setter + def coloring(self, val): + self['coloring'] = val + + # end + # --- + @property + 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 + + Returns + ------- + int|float + """ + return self['end'] + + @end.setter + def end(self, val): + self['end'] = val + + # labelfont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.contour.contours.Labelfont + """ + return self['labelfont'] + + @labelfont.setter + def labelfont(self, val): + self['labelfont'] = val + + # labelformat + # ----------- + @property + def labelformat(self): + """ + Sets the contour label formatting rule using d3 formatting + mini-language which is very similar to Python, see: https://git + hub.com/d3/d3-format/blob/master/README.md#locale_format. + + The 'labelformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['labelformat'] + + @labelformat.setter + def labelformat(self, val): + self['labelformat'] = val + + # operation + # --------- + @property + def operation(self): + """ + Sets the constraint operation. "=" keeps regions equal to + `value` "<" and "<=" keep regions less than `value` ">" and + ">=" keep regions greater than `value` "[]", "()", "[)", and + "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", + "](", ")[" keep regions outside `value[0]` to value[1]` Open + vs. closed intervals make no difference to constraint display, + but all versions are allowed for consistency with filter + transforms. + + The 'operation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', + ')(', '](', ')['] + + Returns + ------- + Any + """ + return self['operation'] + + @operation.setter + def operation(self, val): + self['operation'] = val + + # showlabels + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlabels'] + + @showlabels.setter + def showlabels(self, val): + self['showlabels'] = val + + # showlines + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlines'] + + @showlines.setter + def showlines(self, val): + self['showlines'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # start + # ----- + @property + 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 + + Returns + ------- + int|float + """ + return self['start'] + + @start.setter + def start(self, val): + self['start'] = val + + # type + # ---- + @property + def type(self): + """ + If `levels`, the data is represented as a contour plot with + multiple levels displayed. If `constraint`, the data is + represented as constraints with the invalid region shaded as + specified by the `operation` and `value` parameters. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['levels', 'constraint'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # value + # ----- + @property + def value(self): + """ + Sets the value or values of the constraint boundary. When + `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of + two numbers where the first is the lower bound and the second + is the upper bound. + + The 'value' property accepts values of any type + + Returns + ------- + Any + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contour' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + coloring + Determines the coloring method showing the contour + values. If "fill", coloring is done evenly between each + contour level If "heatmap", a heatmap gradient coloring + is applied between each contour level. If "lines", + coloring is done on the contour lines. If "none", no + coloring is applied on this trace. + end + Sets the end contour level value. Must be more than + `contours.start` + labelfont + Sets the font used for labeling the contour levels. The + default color comes from the lines, if shown. The + default family and size come from `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-language which is very similar to + Python, see: https://github.com/d3/d3-format/blob/maste + r/README.md#locale_format. + operation + Sets the constraint operation. "=" keeps regions equal + to `value` "<" and "<=" keep regions less than `value` + ">" and ">=" keep regions greater than `value` "[]", + "()", "[)", and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions outside + `value[0]` to value[1]` Open vs. closed intervals make + no difference to constraint display, but all versions + are allowed for consistency with filter transforms. + showlabels + Determines whether to label the contour lines with + their values. + showlines + Determines whether or not the contour lines are drawn. + Has an effect only if `contours.coloring` is set to + "fill". + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + type + If `levels`, the data is represented as a contour plot + with multiple levels displayed. If `constraint`, the + data is represented as constraints with the invalid + region shaded as specified by the `operation` and + `value` parameters. + value + Sets the value or values of the constraint boundary. + When `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an + array of two numbers where the first is the lower bound + and the second is the upper bound. + """ + + def __init__( + self, + arg=None, + coloring=None, + end=None, + labelfont=None, + labelformat=None, + operation=None, + showlabels=None, + showlines=None, + size=None, + start=None, + type=None, + value=None, + **kwargs + ): + """ + Construct a new Contours object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.contour.Contours + coloring + Determines the coloring method showing the contour + values. If "fill", coloring is done evenly between each + contour level If "heatmap", a heatmap gradient coloring + is applied between each contour level. If "lines", + coloring is done on the contour lines. If "none", no + coloring is applied on this trace. + end + Sets the end contour level value. Must be more than + `contours.start` + labelfont + Sets the font used for labeling the contour levels. The + default color comes from the lines, if shown. The + default family and size come from `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-language which is very similar to + Python, see: https://github.com/d3/d3-format/blob/maste + r/README.md#locale_format. + operation + Sets the constraint operation. "=" keeps regions equal + to `value` "<" and "<=" keep regions less than `value` + ">" and ">=" keep regions greater than `value` "[]", + "()", "[)", and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions outside + `value[0]` to value[1]` Open vs. closed intervals make + no difference to constraint display, but all versions + are allowed for consistency with filter transforms. + showlabels + Determines whether to label the contour lines with + their values. + showlines + Determines whether or not the contour lines are drawn. + Has an effect only if `contours.coloring` is set to + "fill". + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + type + If `levels`, the data is represented as a contour plot + with multiple levels displayed. If `constraint`, the + data is represented as constraints with the invalid + region shaded as specified by the `operation` and + `value` parameters. + value + Sets the value or values of the constraint boundary. + When `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an + array of two numbers where the first is the lower bound + and the second is the upper bound. + + Returns + ------- + Contours + """ + super(Contours, self).__init__('contours') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contour.Contours +constructor must be a dict or +an instance of plotly.graph_objs.contour.Contours""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contour import (contours as v_contours) + + # Initialize validators + # --------------------- + self._validators['coloring'] = v_contours.ColoringValidator() + self._validators['end'] = v_contours.EndValidator() + self._validators['labelfont'] = v_contours.LabelfontValidator() + self._validators['labelformat'] = v_contours.LabelformatValidator() + self._validators['operation'] = v_contours.OperationValidator() + self._validators['showlabels'] = v_contours.ShowlabelsValidator() + self._validators['showlines'] = v_contours.ShowlinesValidator() + self._validators['size'] = v_contours.SizeValidator() + self._validators['start'] = v_contours.StartValidator() + self._validators['type'] = v_contours.TypeValidator() + self._validators['value'] = v_contours.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('coloring', None) + self['coloring'] = coloring if coloring is not None else _v + _v = arg.pop('end', None) + self['end'] = end if end is not None else _v + _v = arg.pop('labelfont', None) + self['labelfont'] = labelfont if labelfont is not None else _v + _v = arg.pop('labelformat', None) + self['labelformat'] = labelformat if labelformat is not None else _v + _v = arg.pop('operation', None) + self['operation'] = operation if operation is not None else _v + _v = arg.pop('showlabels', None) + self['showlabels'] = showlabels if showlabels is not None else _v + _v = arg.pop('showlines', None) + self['showlines'] = showlines if showlines is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('start', None) + self['start'] = start if start is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.contour.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.contour.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + 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 plotly.graph_objs.contour.colorbar.Tickformatstop + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.contour.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.contour.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use contour.colorbar.title.side instead. + Determines the location of color bar's title with respect to + the color bar. Note that the title's location used to be set by + the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contour' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.contour.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.contou + r.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + contour.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.contour.colorbar.Title instance or + dict with compatible properties + titlefont + Deprecated: Please use contour.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use contour.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.contour.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.contour.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.contou + r.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + contour.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.contour.colorbar.Title instance or + dict with compatible properties + titlefont + Deprecated: Please use contour.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use contour.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contour.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.contour.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contour import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.contour import hoverlabel -from ._contours import Contours from plotly.graph_objs.contour import contours -from ._colorbar import ColorBar from plotly.graph_objs.contour import colorbar diff --git a/plotly/graph_objs/contour/_colorbar.py b/plotly/graph_objs/contour/_colorbar.py deleted file mode 100644 index 7432cad6df1..00000000000 --- a/plotly/graph_objs/contour/_colorbar.py +++ /dev/null @@ -1,1863 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.contour.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.contour.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as - 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 plotly.graph_objs.contour.colorbar.Tickformatstop - - A dict of string/value properties that will be passed - to the Tickformatstop constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.contour.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.contour.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use contour.colorbar.title.side instead. - Determines the location of color bar's title with respect to - the color bar. Note that the title's location used to be set by - the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contour' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.contour.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.contou - r.colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - contour.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.contour.colorbar.Title instance or - dict with compatible properties - titlefont - Deprecated: Please use contour.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use contour.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contour.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.contour.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.contou - r.colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - contour.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.contour.colorbar.Title instance or - dict with compatible properties - titlefont - Deprecated: Please use contour.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use contour.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contour.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.contour.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contour import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contour/_contours.py b/plotly/graph_objs/contour/_contours.py deleted file mode 100644 index abc08e5ee51..00000000000 --- a/plotly/graph_objs/contour/_contours.py +++ /dev/null @@ -1,507 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Contours(BaseTraceHierarchyType): - - # coloring - # -------- - @property - def coloring(self): - """ - Determines the coloring method showing the contour values. If - "fill", coloring is done evenly between each contour level If - "heatmap", a heatmap gradient coloring is applied between each - contour level. If "lines", coloring is done on the contour - lines. If "none", no coloring is applied on this trace. - - The 'coloring' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['fill', 'heatmap', 'lines', 'none'] - - Returns - ------- - Any - """ - return self['coloring'] - - @coloring.setter - def coloring(self, val): - self['coloring'] = val - - # end - # --- - @property - 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 - - Returns - ------- - int|float - """ - return self['end'] - - @end.setter - def end(self, val): - self['end'] = val - - # labelfont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.contour.contours.Labelfont - """ - return self['labelfont'] - - @labelfont.setter - def labelfont(self, val): - self['labelfont'] = val - - # labelformat - # ----------- - @property - def labelformat(self): - """ - Sets the contour label formatting rule using d3 formatting - mini-language which is very similar to Python, see: https://git - hub.com/d3/d3-format/blob/master/README.md#locale_format. - - The 'labelformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['labelformat'] - - @labelformat.setter - def labelformat(self, val): - self['labelformat'] = val - - # operation - # --------- - @property - def operation(self): - """ - Sets the constraint operation. "=" keeps regions equal to - `value` "<" and "<=" keep regions less than `value` ">" and - ">=" keep regions greater than `value` "[]", "()", "[)", and - "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", - "](", ")[" keep regions outside `value[0]` to value[1]` Open - vs. closed intervals make no difference to constraint display, - but all versions are allowed for consistency with filter - transforms. - - The 'operation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', - ')(', '](', ')['] - - Returns - ------- - Any - """ - return self['operation'] - - @operation.setter - def operation(self, val): - self['operation'] = val - - # showlabels - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlabels'] - - @showlabels.setter - def showlabels(self, val): - self['showlabels'] = val - - # showlines - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlines'] - - @showlines.setter - def showlines(self, val): - self['showlines'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # start - # ----- - @property - 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 - - Returns - ------- - int|float - """ - return self['start'] - - @start.setter - def start(self, val): - self['start'] = val - - # type - # ---- - @property - def type(self): - """ - If `levels`, the data is represented as a contour plot with - multiple levels displayed. If `constraint`, the data is - represented as constraints with the invalid region shaded as - specified by the `operation` and `value` parameters. - - The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['levels', 'constraint'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # value - # ----- - @property - def value(self): - """ - Sets the value or values of the constraint boundary. When - `operation` is set to one of the comparison values - (=,<,>=,>,<=) "value" is expected to be a number. When - `operation` is set to one of the interval values - ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of - two numbers where the first is the lower bound and the second - is the upper bound. - - The 'value' property accepts values of any type - - Returns - ------- - Any - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contour' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - coloring - Determines the coloring method showing the contour - values. If "fill", coloring is done evenly between each - contour level If "heatmap", a heatmap gradient coloring - is applied between each contour level. If "lines", - coloring is done on the contour lines. If "none", no - coloring is applied on this trace. - end - Sets the end contour level value. Must be more than - `contours.start` - labelfont - Sets the font used for labeling the contour levels. The - default color comes from the lines, if shown. The - default family and size come from `layout.font`. - labelformat - Sets the contour label formatting rule using d3 - formatting mini-language which is very similar to - Python, see: https://github.com/d3/d3-format/blob/maste - r/README.md#locale_format. - operation - Sets the constraint operation. "=" keeps regions equal - to `value` "<" and "<=" keep regions less than `value` - ">" and ">=" keep regions greater than `value` "[]", - "()", "[)", and "(]" keep regions inside `value[0]` to - `value[1]` "][", ")(", "](", ")[" keep regions outside - `value[0]` to value[1]` Open vs. closed intervals make - no difference to constraint display, but all versions - are allowed for consistency with filter transforms. - showlabels - Determines whether to label the contour lines with - their values. - showlines - Determines whether or not the contour lines are drawn. - Has an effect only if `contours.coloring` is set to - "fill". - size - Sets the step between each contour level. Must be - positive. - start - Sets the starting contour level value. Must be less - than `contours.end` - type - If `levels`, the data is represented as a contour plot - with multiple levels displayed. If `constraint`, the - data is represented as constraints with the invalid - region shaded as specified by the `operation` and - `value` parameters. - value - Sets the value or values of the constraint boundary. - When `operation` is set to one of the comparison values - (=,<,>=,>,<=) "value" is expected to be a number. When - `operation` is set to one of the interval values - ([],(),[),(],][,)(,](,)[) "value" is expected to be an - array of two numbers where the first is the lower bound - and the second is the upper bound. - """ - - def __init__( - self, - arg=None, - coloring=None, - end=None, - labelfont=None, - labelformat=None, - operation=None, - showlabels=None, - showlines=None, - size=None, - start=None, - type=None, - value=None, - **kwargs - ): - """ - Construct a new Contours object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contour.Contours - coloring - Determines the coloring method showing the contour - values. If "fill", coloring is done evenly between each - contour level If "heatmap", a heatmap gradient coloring - is applied between each contour level. If "lines", - coloring is done on the contour lines. If "none", no - coloring is applied on this trace. - end - Sets the end contour level value. Must be more than - `contours.start` - labelfont - Sets the font used for labeling the contour levels. The - default color comes from the lines, if shown. The - default family and size come from `layout.font`. - labelformat - Sets the contour label formatting rule using d3 - formatting mini-language which is very similar to - Python, see: https://github.com/d3/d3-format/blob/maste - r/README.md#locale_format. - operation - Sets the constraint operation. "=" keeps regions equal - to `value` "<" and "<=" keep regions less than `value` - ">" and ">=" keep regions greater than `value` "[]", - "()", "[)", and "(]" keep regions inside `value[0]` to - `value[1]` "][", ")(", "](", ")[" keep regions outside - `value[0]` to value[1]` Open vs. closed intervals make - no difference to constraint display, but all versions - are allowed for consistency with filter transforms. - showlabels - Determines whether to label the contour lines with - their values. - showlines - Determines whether or not the contour lines are drawn. - Has an effect only if `contours.coloring` is set to - "fill". - size - Sets the step between each contour level. Must be - positive. - start - Sets the starting contour level value. Must be less - than `contours.end` - type - If `levels`, the data is represented as a contour plot - with multiple levels displayed. If `constraint`, the - data is represented as constraints with the invalid - region shaded as specified by the `operation` and - `value` parameters. - value - Sets the value or values of the constraint boundary. - When `operation` is set to one of the comparison values - (=,<,>=,>,<=) "value" is expected to be a number. When - `operation` is set to one of the interval values - ([],(),[),(],][,)(,](,)[) "value" is expected to be an - array of two numbers where the first is the lower bound - and the second is the upper bound. - - Returns - ------- - Contours - """ - super(Contours, self).__init__('contours') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contour.Contours -constructor must be a dict or -an instance of plotly.graph_objs.contour.Contours""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contour import (contours as v_contours) - - # Initialize validators - # --------------------- - self._validators['coloring'] = v_contours.ColoringValidator() - self._validators['end'] = v_contours.EndValidator() - self._validators['labelfont'] = v_contours.LabelfontValidator() - self._validators['labelformat'] = v_contours.LabelformatValidator() - self._validators['operation'] = v_contours.OperationValidator() - self._validators['showlabels'] = v_contours.ShowlabelsValidator() - self._validators['showlines'] = v_contours.ShowlinesValidator() - self._validators['size'] = v_contours.SizeValidator() - self._validators['start'] = v_contours.StartValidator() - self._validators['type'] = v_contours.TypeValidator() - self._validators['value'] = v_contours.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('coloring', None) - self['coloring'] = coloring if coloring is not None else _v - _v = arg.pop('end', None) - self['end'] = end if end is not None else _v - _v = arg.pop('labelfont', None) - self['labelfont'] = labelfont if labelfont is not None else _v - _v = arg.pop('labelformat', None) - self['labelformat'] = labelformat if labelformat is not None else _v - _v = arg.pop('operation', None) - self['operation'] = operation if operation is not None else _v - _v = arg.pop('showlabels', None) - self['showlabels'] = showlabels if showlabels is not None else _v - _v = arg.pop('showlines', None) - self['showlines'] = showlines if showlines is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('start', None) - self['start'] = start if start is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contour/_hoverlabel.py b/plotly/graph_objs/contour/_hoverlabel.py deleted file mode 100644 index e5cb3542dd9..00000000000 --- a/plotly/graph_objs/contour/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.contour.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contour' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contour.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contour.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.contour.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contour import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contour/_line.py b/plotly/graph_objs/contour/_line.py deleted file mode 100644 index 67622b0582e..00000000000 --- a/plotly/graph_objs/contour/_line.py +++ /dev/null @@ -1,245 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dash - # ---- - @property - def dash(self): - """ - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - - The 'dash' property is an enumeration that may be specified as: - - One of the following dash styles: - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - - A string containing a dash length list in pixels or percentages - (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) - - Returns - ------- - str - """ - return self['dash'] - - @dash.setter - def dash(self, val): - self['dash'] = val - - # smoothing - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['smoothing'] - - @smoothing.setter - def smoothing(self, val): - self['smoothing'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contour' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the color of the contour level. Has no effect if - `contours.coloring` is set to "lines". - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - smoothing - Sets the amount of smoothing for the contour lines, - where 0 corresponds to no smoothing. - width - Sets the line width (in px). - """ - - def __init__( - self, - arg=None, - color=None, - dash=None, - smoothing=None, - width=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contour.Line - color - Sets the color of the contour level. Has no effect if - `contours.coloring` is set to "lines". - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - smoothing - Sets the amount of smoothing for the contour lines, - where 0 corresponds to no smoothing. - width - Sets the line width (in px). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contour.Line -constructor must be a dict or -an instance of plotly.graph_objs.contour.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contour import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['dash'] = v_line.DashValidator() - self._validators['smoothing'] = v_line.SmoothingValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dash', None) - self['dash'] = dash if dash is not None else _v - _v = arg.pop('smoothing', None) - self['smoothing'] = smoothing if smoothing is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contour/_stream.py b/plotly/graph_objs/contour/_stream.py deleted file mode 100644 index 60a721fa737..00000000000 --- a/plotly/graph_objs/contour/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contour' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contour.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contour.Stream -constructor must be a dict or -an instance of plotly.graph_objs.contour.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contour import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contour/colorbar/__init__.py b/plotly/graph_objs/contour/colorbar/__init__.py index 903d774b974..960e50d4f12 100644 --- a/plotly/graph_objs/contour/colorbar/__init__.py +++ b/plotly/graph_objs/contour/colorbar/__init__.py @@ -1,4 +1,720 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.contour.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contour.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.contour.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contour.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.contour.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contour.colorbar import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contour.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.contour.colorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contour.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.contour.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contour.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contour.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.contour.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contour.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.contour.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contour.colorbar import (tickfont as v_tickfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.contour.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/contour/colorbar/_tickfont.py b/plotly/graph_objs/contour/colorbar/_tickfont.py deleted file mode 100644 index 08b011dd56c..00000000000 --- a/plotly/graph_objs/contour/colorbar/_tickfont.py +++ /dev/null @@ -1,226 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contour.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contour.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contour.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.contour.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contour.colorbar import (tickfont as v_tickfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contour/colorbar/_tickformatstop.py b/plotly/graph_objs/contour/colorbar/_tickformatstop.py deleted file mode 100644 index 7db8664dced..00000000000 --- a/plotly/graph_objs/contour/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contour.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contour.colorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contour.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.contour.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contour.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contour/colorbar/_title.py b/plotly/graph_objs/contour/colorbar/_title.py deleted file mode 100644 index 10c81612d1d..00000000000 --- a/plotly/graph_objs/contour/colorbar/_title.py +++ /dev/null @@ -1,201 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.contour.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contour.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contour.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contour.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.contour.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contour.colorbar import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contour/colorbar/title/__init__.py b/plotly/graph_objs/contour/colorbar/title/__init__.py index c37b8b5cd28..4e65e065d36 100644 --- a/plotly/graph_objs/contour/colorbar/title/__init__.py +++ b/plotly/graph_objs/contour/colorbar/title/__init__.py @@ -1 +1,229 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contour.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.contour.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contour.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.contour.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contour.colorbar.title import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/contour/colorbar/title/_font.py b/plotly/graph_objs/contour/colorbar/title/_font.py deleted file mode 100644 index 8dd39689de4..00000000000 --- a/plotly/graph_objs/contour/colorbar/title/_font.py +++ /dev/null @@ -1,227 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contour.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contour.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contour.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.contour.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contour.colorbar.title import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contour/contours/__init__.py b/plotly/graph_objs/contour/contours/__init__.py index 4729349bff3..ab83eb6b7d6 100644 --- a/plotly/graph_objs/contour/contours/__init__.py +++ b/plotly/graph_objs/contour/contours/__init__.py @@ -1 +1,232 @@ -from ._labelfont import Labelfont + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Labelfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contour.contours' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.contour.contours.Labelfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Labelfont + """ + super(Labelfont, self).__init__('labelfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contour.contours.Labelfont +constructor must be a dict or +an instance of plotly.graph_objs.contour.contours.Labelfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contour.contours import ( + labelfont as v_labelfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_labelfont.ColorValidator() + self._validators['family'] = v_labelfont.FamilyValidator() + self._validators['size'] = v_labelfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/contour/contours/_labelfont.py b/plotly/graph_objs/contour/contours/_labelfont.py deleted file mode 100644 index 7f82c24f2af..00000000000 --- a/plotly/graph_objs/contour/contours/_labelfont.py +++ /dev/null @@ -1,230 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Labelfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contour.contours' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contour.contours.Labelfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Labelfont - """ - super(Labelfont, self).__init__('labelfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contour.contours.Labelfont -constructor must be a dict or -an instance of plotly.graph_objs.contour.contours.Labelfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contour.contours import ( - labelfont as v_labelfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_labelfont.ColorValidator() - self._validators['family'] = v_labelfont.FamilyValidator() - self._validators['size'] = v_labelfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contour/hoverlabel/__init__.py b/plotly/graph_objs/contour/hoverlabel/__init__.py index c37b8b5cd28..44c4cecfe68 100644 --- a/plotly/graph_objs/contour/hoverlabel/__init__.py +++ b/plotly/graph_objs/contour/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contour.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.contour.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contour.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.contour.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contour.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/contour/hoverlabel/_font.py b/plotly/graph_objs/contour/hoverlabel/_font.py deleted file mode 100644 index 07f93c0c6e2..00000000000 --- a/plotly/graph_objs/contour/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contour.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contour.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contour.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.contour.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contour.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contourcarpet/__init__.py b/plotly/graph_objs/contourcarpet/__init__.py index 5c794e002aa..6f568fbdfa2 100644 --- a/plotly/graph_objs/contourcarpet/__init__.py +++ b/plotly/graph_objs/contourcarpet/__init__.py @@ -1,8 +1,3184 @@ -from ._stream import Stream -from ._line import Line -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contourcarpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.contourcarpet.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contourcarpet.Stream +constructor must be a dict or +an instance of plotly.graph_objs.contourcarpet.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contourcarpet import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + Sets the color of the contour level. Has no 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dash + # ---- + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self['dash'] + + @dash.setter + def dash(self, val): + self['dash'] = val + + # smoothing + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['smoothing'] + + @smoothing.setter + def smoothing(self, val): + self['smoothing'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contourcarpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour level. Has no if + `contours.coloring` is set to "lines". + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour lines, + where 0 corresponds to no smoothing. + width + Sets the line width (in px). + """ + + def __init__( + self, + arg=None, + color=None, + dash=None, + smoothing=None, + width=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.contourcarpet.Line + color + Sets the color of the contour level. Has no if + `contours.coloring` is set to "lines". + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour lines, + where 0 corresponds to no smoothing. + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contourcarpet.Line +constructor must be a dict or +an instance of plotly.graph_objs.contourcarpet.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contourcarpet import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['dash'] = v_line.DashValidator() + self._validators['smoothing'] = v_line.SmoothingValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dash', None) + self['dash'] = dash if dash is not None else _v + _v = arg.pop('smoothing', None) + self['smoothing'] = smoothing if smoothing is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 plotly.graph_objs.contourcarpet.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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.contourcarpet.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contourcarpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.contourcarpet.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contourcarpet.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.contourcarpet.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contourcarpet import ( + hoverlabel as v_hoverlabel + ) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Contours(_BaseTraceHierarchyType): + + # coloring + # -------- + @property + def coloring(self): + """ + Determines the coloring method showing the contour values. If + "fill", coloring is done evenly between each contour level If + "lines", coloring is done on the contour lines. If "none", no + coloring is applied on this trace. + + The 'coloring' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fill', 'lines', 'none'] + + Returns + ------- + Any + """ + return self['coloring'] + + @coloring.setter + def coloring(self, val): + self['coloring'] = val + + # end + # --- + @property + 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 + + Returns + ------- + int|float + """ + return self['end'] + + @end.setter + def end(self, val): + self['end'] = val + + # labelfont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.contourcarpet.contours.Labelfont + """ + return self['labelfont'] + + @labelfont.setter + def labelfont(self, val): + self['labelfont'] = val + + # labelformat + # ----------- + @property + def labelformat(self): + """ + Sets the contour label formatting rule using d3 formatting + mini-language which is very similar to Python, see: https://git + hub.com/d3/d3-format/blob/master/README.md#locale_format. + + The 'labelformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['labelformat'] + + @labelformat.setter + def labelformat(self, val): + self['labelformat'] = val + + # operation + # --------- + @property + def operation(self): + """ + Sets the constraint operation. "=" keeps regions equal to + `value` "<" and "<=" keep regions less than `value` ">" and + ">=" keep regions greater than `value` "[]", "()", "[)", and + "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", + "](", ")[" keep regions outside `value[0]` to value[1]` Open + vs. closed intervals make no difference to constraint display, + but all versions are allowed for consistency with filter + transforms. + + The 'operation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', + ')(', '](', ')['] + + Returns + ------- + Any + """ + return self['operation'] + + @operation.setter + def operation(self, val): + self['operation'] = val + + # showlabels + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlabels'] + + @showlabels.setter + def showlabels(self, val): + self['showlabels'] = val + + # showlines + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlines'] + + @showlines.setter + def showlines(self, val): + self['showlines'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # start + # ----- + @property + 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 + + Returns + ------- + int|float + """ + return self['start'] + + @start.setter + def start(self, val): + self['start'] = val + + # type + # ---- + @property + def type(self): + """ + If `levels`, the data is represented as a contour plot with + multiple levels displayed. If `constraint`, the data is + represented as constraints with the invalid region shaded as + specified by the `operation` and `value` parameters. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['levels', 'constraint'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # value + # ----- + @property + def value(self): + """ + Sets the value or values of the constraint boundary. When + `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of + two numbers where the first is the lower bound and the second + is the upper bound. + + The 'value' property accepts values of any type + + Returns + ------- + Any + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contourcarpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + coloring + Determines the coloring method showing the contour + values. If "fill", coloring is done evenly between each + contour level If "lines", coloring is done on the + contour lines. If "none", no coloring is applied on + this trace. + end + Sets the end contour level value. Must be more than + `contours.start` + labelfont + Sets the font used for labeling the contour levels. The + default color comes from the lines, if shown. The + default family and size come from `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-language which is very similar to + Python, see: https://github.com/d3/d3-format/blob/maste + r/README.md#locale_format. + operation + Sets the constraint operation. "=" keeps regions equal + to `value` "<" and "<=" keep regions less than `value` + ">" and ">=" keep regions greater than `value` "[]", + "()", "[)", and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions outside + `value[0]` to value[1]` Open vs. closed intervals make + no difference to constraint display, but all versions + are allowed for consistency with filter transforms. + showlabels + Determines whether to label the contour lines with + their values. + showlines + Determines whether or not the contour lines are drawn. + Has an effect only if `contours.coloring` is set to + "fill". + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + type + If `levels`, the data is represented as a contour plot + with multiple levels displayed. If `constraint`, the + data is represented as constraints with the invalid + region shaded as specified by the `operation` and + `value` parameters. + value + Sets the value or values of the constraint boundary. + When `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an + array of two numbers where the first is the lower bound + and the second is the upper bound. + """ + + def __init__( + self, + arg=None, + coloring=None, + end=None, + labelfont=None, + labelformat=None, + operation=None, + showlabels=None, + showlines=None, + size=None, + start=None, + type=None, + value=None, + **kwargs + ): + """ + Construct a new Contours object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.contourcarpet.Contours + coloring + Determines the coloring method showing the contour + values. If "fill", coloring is done evenly between each + contour level If "lines", coloring is done on the + contour lines. If "none", no coloring is applied on + this trace. + end + Sets the end contour level value. Must be more than + `contours.start` + labelfont + Sets the font used for labeling the contour levels. The + default color comes from the lines, if shown. The + default family and size come from `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-language which is very similar to + Python, see: https://github.com/d3/d3-format/blob/maste + r/README.md#locale_format. + operation + Sets the constraint operation. "=" keeps regions equal + to `value` "<" and "<=" keep regions less than `value` + ">" and ">=" keep regions greater than `value` "[]", + "()", "[)", and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions outside + `value[0]` to value[1]` Open vs. closed intervals make + no difference to constraint display, but all versions + are allowed for consistency with filter transforms. + showlabels + Determines whether to label the contour lines with + their values. + showlines + Determines whether or not the contour lines are drawn. + Has an effect only if `contours.coloring` is set to + "fill". + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + type + If `levels`, the data is represented as a contour plot + with multiple levels displayed. If `constraint`, the + data is represented as constraints with the invalid + region shaded as specified by the `operation` and + `value` parameters. + value + Sets the value or values of the constraint boundary. + When `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an + array of two numbers where the first is the lower bound + and the second is the upper bound. + + Returns + ------- + Contours + """ + super(Contours, self).__init__('contours') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contourcarpet.Contours +constructor must be a dict or +an instance of plotly.graph_objs.contourcarpet.Contours""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contourcarpet import (contours as v_contours) + + # Initialize validators + # --------------------- + self._validators['coloring'] = v_contours.ColoringValidator() + self._validators['end'] = v_contours.EndValidator() + self._validators['labelfont'] = v_contours.LabelfontValidator() + self._validators['labelformat'] = v_contours.LabelformatValidator() + self._validators['operation'] = v_contours.OperationValidator() + self._validators['showlabels'] = v_contours.ShowlabelsValidator() + self._validators['showlines'] = v_contours.ShowlinesValidator() + self._validators['size'] = v_contours.SizeValidator() + self._validators['start'] = v_contours.StartValidator() + self._validators['type'] = v_contours.TypeValidator() + self._validators['value'] = v_contours.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('coloring', None) + self['coloring'] = coloring if coloring is not None else _v + _v = arg.pop('end', None) + self['end'] = end if end is not None else _v + _v = arg.pop('labelfont', None) + self['labelfont'] = labelfont if labelfont is not None else _v + _v = arg.pop('labelformat', None) + self['labelformat'] = labelformat if labelformat is not None else _v + _v = arg.pop('operation', None) + self['operation'] = operation if operation is not None else _v + _v = arg.pop('showlabels', None) + self['showlabels'] = showlabels if showlabels is not None else _v + _v = arg.pop('showlines', None) + self['showlines'] = showlines if showlines is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('start', None) + self['start'] = start if start is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.contourcarpet.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.contourcarpet.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.contourcarpet. + 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 plotly.graph_objs.contourcarpet.colorbar.Tickformatstop + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.contourcarpet.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.contourcarpet.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use contourcarpet.colorbar.title.font + instead. Sets this color bar's title font. Note that the + title's font used to be set by the now deprecated `titlefont` + attribute. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use contourcarpet.colorbar.title.side + instead. Determines the location of color bar's title with + respect to the color bar. Note that the title's location used + to be set by the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contourcarpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.contourcarpet.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.contou + rcarpet.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + contourcarpet.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.contourcarpet.colorbar.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use + contourcarpet.colorbar.title.font instead. Sets this + color bar's title font. Note that the title's font used + to be set by the now deprecated `titlefont` attribute. + titleside + Deprecated: Please use + contourcarpet.colorbar.title.side instead. Determines + the location of color bar's title with respect to the + color bar. Note that the title's location used to be + set by the now deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.contourcarpet.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.contourcarpet.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.contou + rcarpet.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + contourcarpet.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.contourcarpet.colorbar.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use + contourcarpet.colorbar.title.font instead. Sets this + color bar's title font. Note that the title's font used + to be set by the now deprecated `titlefont` attribute. + titleside + Deprecated: Please use + contourcarpet.colorbar.title.side instead. Determines + the location of color bar's title with respect to the + color bar. Note that the title's location used to be + set by the now deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contourcarpet.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.contourcarpet.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contourcarpet import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.contourcarpet import hoverlabel -from ._contours import Contours from plotly.graph_objs.contourcarpet import contours -from ._colorbar import ColorBar from plotly.graph_objs.contourcarpet import colorbar diff --git a/plotly/graph_objs/contourcarpet/_colorbar.py b/plotly/graph_objs/contourcarpet/_colorbar.py deleted file mode 100644 index fb8a311e9fb..00000000000 --- a/plotly/graph_objs/contourcarpet/_colorbar.py +++ /dev/null @@ -1,1864 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.contourcarpet.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.contourcarpet.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.contourcarpet. - 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 plotly.graph_objs.contourcarpet.colorbar.Tickformatstop - - A dict of string/value properties that will be passed - to the Tickformatstop constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.contourcarpet.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.contourcarpet.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use contourcarpet.colorbar.title.font - instead. Sets this color bar's title font. Note that the - title's font used to be set by the now deprecated `titlefont` - attribute. - - The 'font' property is an instance of Font - that may be specified as: - - An instance of 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use contourcarpet.colorbar.title.side - instead. Determines the location of color bar's title with - respect to the color bar. Note that the title's location used - to be set by the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contourcarpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.contourcarpet.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.contou - rcarpet.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - contourcarpet.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.contourcarpet.colorbar.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use - contourcarpet.colorbar.title.font instead. Sets this - color bar's title font. Note that the title's font used - to be set by the now deprecated `titlefont` attribute. - titleside - Deprecated: Please use - contourcarpet.colorbar.title.side instead. Determines - the location of color bar's title with respect to the - color bar. Note that the title's location used to be - set by the now deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contourcarpet.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.contourcarpet.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.contou - rcarpet.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - contourcarpet.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.contourcarpet.colorbar.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use - contourcarpet.colorbar.title.font instead. Sets this - color bar's title font. Note that the title's font used - to be set by the now deprecated `titlefont` attribute. - titleside - Deprecated: Please use - contourcarpet.colorbar.title.side instead. Determines - the location of color bar's title with respect to the - color bar. Note that the title's location used to be - set by the now deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contourcarpet.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contourcarpet import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contourcarpet/_contours.py b/plotly/graph_objs/contourcarpet/_contours.py deleted file mode 100644 index d75aa6651f1..00000000000 --- a/plotly/graph_objs/contourcarpet/_contours.py +++ /dev/null @@ -1,504 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Contours(BaseTraceHierarchyType): - - # coloring - # -------- - @property - def coloring(self): - """ - Determines the coloring method showing the contour values. If - "fill", coloring is done evenly between each contour level If - "lines", coloring is done on the contour lines. If "none", no - coloring is applied on this trace. - - The 'coloring' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['fill', 'lines', 'none'] - - Returns - ------- - Any - """ - return self['coloring'] - - @coloring.setter - def coloring(self, val): - self['coloring'] = val - - # end - # --- - @property - 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 - - Returns - ------- - int|float - """ - return self['end'] - - @end.setter - def end(self, val): - self['end'] = val - - # labelfont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.contourcarpet.contours.Labelfont - """ - return self['labelfont'] - - @labelfont.setter - def labelfont(self, val): - self['labelfont'] = val - - # labelformat - # ----------- - @property - def labelformat(self): - """ - Sets the contour label formatting rule using d3 formatting - mini-language which is very similar to Python, see: https://git - hub.com/d3/d3-format/blob/master/README.md#locale_format. - - The 'labelformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['labelformat'] - - @labelformat.setter - def labelformat(self, val): - self['labelformat'] = val - - # operation - # --------- - @property - def operation(self): - """ - Sets the constraint operation. "=" keeps regions equal to - `value` "<" and "<=" keep regions less than `value` ">" and - ">=" keep regions greater than `value` "[]", "()", "[)", and - "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", - "](", ")[" keep regions outside `value[0]` to value[1]` Open - vs. closed intervals make no difference to constraint display, - but all versions are allowed for consistency with filter - transforms. - - The 'operation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', - ')(', '](', ')['] - - Returns - ------- - Any - """ - return self['operation'] - - @operation.setter - def operation(self, val): - self['operation'] = val - - # showlabels - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlabels'] - - @showlabels.setter - def showlabels(self, val): - self['showlabels'] = val - - # showlines - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlines'] - - @showlines.setter - def showlines(self, val): - self['showlines'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # start - # ----- - @property - 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 - - Returns - ------- - int|float - """ - return self['start'] - - @start.setter - def start(self, val): - self['start'] = val - - # type - # ---- - @property - def type(self): - """ - If `levels`, the data is represented as a contour plot with - multiple levels displayed. If `constraint`, the data is - represented as constraints with the invalid region shaded as - specified by the `operation` and `value` parameters. - - The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['levels', 'constraint'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # value - # ----- - @property - def value(self): - """ - Sets the value or values of the constraint boundary. When - `operation` is set to one of the comparison values - (=,<,>=,>,<=) "value" is expected to be a number. When - `operation` is set to one of the interval values - ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of - two numbers where the first is the lower bound and the second - is the upper bound. - - The 'value' property accepts values of any type - - Returns - ------- - Any - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contourcarpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - coloring - Determines the coloring method showing the contour - values. If "fill", coloring is done evenly between each - contour level If "lines", coloring is done on the - contour lines. If "none", no coloring is applied on - this trace. - end - Sets the end contour level value. Must be more than - `contours.start` - labelfont - Sets the font used for labeling the contour levels. The - default color comes from the lines, if shown. The - default family and size come from `layout.font`. - labelformat - Sets the contour label formatting rule using d3 - formatting mini-language which is very similar to - Python, see: https://github.com/d3/d3-format/blob/maste - r/README.md#locale_format. - operation - Sets the constraint operation. "=" keeps regions equal - to `value` "<" and "<=" keep regions less than `value` - ">" and ">=" keep regions greater than `value` "[]", - "()", "[)", and "(]" keep regions inside `value[0]` to - `value[1]` "][", ")(", "](", ")[" keep regions outside - `value[0]` to value[1]` Open vs. closed intervals make - no difference to constraint display, but all versions - are allowed for consistency with filter transforms. - showlabels - Determines whether to label the contour lines with - their values. - showlines - Determines whether or not the contour lines are drawn. - Has an effect only if `contours.coloring` is set to - "fill". - size - Sets the step between each contour level. Must be - positive. - start - Sets the starting contour level value. Must be less - than `contours.end` - type - If `levels`, the data is represented as a contour plot - with multiple levels displayed. If `constraint`, the - data is represented as constraints with the invalid - region shaded as specified by the `operation` and - `value` parameters. - value - Sets the value or values of the constraint boundary. - When `operation` is set to one of the comparison values - (=,<,>=,>,<=) "value" is expected to be a number. When - `operation` is set to one of the interval values - ([],(),[),(],][,)(,](,)[) "value" is expected to be an - array of two numbers where the first is the lower bound - and the second is the upper bound. - """ - - def __init__( - self, - arg=None, - coloring=None, - end=None, - labelfont=None, - labelformat=None, - operation=None, - showlabels=None, - showlines=None, - size=None, - start=None, - type=None, - value=None, - **kwargs - ): - """ - Construct a new Contours object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contourcarpet.Contours - coloring - Determines the coloring method showing the contour - values. If "fill", coloring is done evenly between each - contour level If "lines", coloring is done on the - contour lines. If "none", no coloring is applied on - this trace. - end - Sets the end contour level value. Must be more than - `contours.start` - labelfont - Sets the font used for labeling the contour levels. The - default color comes from the lines, if shown. The - default family and size come from `layout.font`. - labelformat - Sets the contour label formatting rule using d3 - formatting mini-language which is very similar to - Python, see: https://github.com/d3/d3-format/blob/maste - r/README.md#locale_format. - operation - Sets the constraint operation. "=" keeps regions equal - to `value` "<" and "<=" keep regions less than `value` - ">" and ">=" keep regions greater than `value` "[]", - "()", "[)", and "(]" keep regions inside `value[0]` to - `value[1]` "][", ")(", "](", ")[" keep regions outside - `value[0]` to value[1]` Open vs. closed intervals make - no difference to constraint display, but all versions - are allowed for consistency with filter transforms. - showlabels - Determines whether to label the contour lines with - their values. - showlines - Determines whether or not the contour lines are drawn. - Has an effect only if `contours.coloring` is set to - "fill". - size - Sets the step between each contour level. Must be - positive. - start - Sets the starting contour level value. Must be less - than `contours.end` - type - If `levels`, the data is represented as a contour plot - with multiple levels displayed. If `constraint`, the - data is represented as constraints with the invalid - region shaded as specified by the `operation` and - `value` parameters. - value - Sets the value or values of the constraint boundary. - When `operation` is set to one of the comparison values - (=,<,>=,>,<=) "value" is expected to be a number. When - `operation` is set to one of the interval values - ([],(),[),(],][,)(,](,)[) "value" is expected to be an - array of two numbers where the first is the lower bound - and the second is the upper bound. - - Returns - ------- - Contours - """ - super(Contours, self).__init__('contours') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contourcarpet.Contours -constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.Contours""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contourcarpet import (contours as v_contours) - - # Initialize validators - # --------------------- - self._validators['coloring'] = v_contours.ColoringValidator() - self._validators['end'] = v_contours.EndValidator() - self._validators['labelfont'] = v_contours.LabelfontValidator() - self._validators['labelformat'] = v_contours.LabelformatValidator() - self._validators['operation'] = v_contours.OperationValidator() - self._validators['showlabels'] = v_contours.ShowlabelsValidator() - self._validators['showlines'] = v_contours.ShowlinesValidator() - self._validators['size'] = v_contours.SizeValidator() - self._validators['start'] = v_contours.StartValidator() - self._validators['type'] = v_contours.TypeValidator() - self._validators['value'] = v_contours.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('coloring', None) - self['coloring'] = coloring if coloring is not None else _v - _v = arg.pop('end', None) - self['end'] = end if end is not None else _v - _v = arg.pop('labelfont', None) - self['labelfont'] = labelfont if labelfont is not None else _v - _v = arg.pop('labelformat', None) - self['labelformat'] = labelformat if labelformat is not None else _v - _v = arg.pop('operation', None) - self['operation'] = operation if operation is not None else _v - _v = arg.pop('showlabels', None) - self['showlabels'] = showlabels if showlabels is not None else _v - _v = arg.pop('showlines', None) - self['showlines'] = showlines if showlines is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('start', None) - self['start'] = start if start is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contourcarpet/_hoverlabel.py b/plotly/graph_objs/contourcarpet/_hoverlabel.py deleted file mode 100644 index 382510ec1d5..00000000000 --- a/plotly/graph_objs/contourcarpet/_hoverlabel.py +++ /dev/null @@ -1,417 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 plotly.graph_objs.contourcarpet.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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.contourcarpet.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contourcarpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contourcarpet.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contourcarpet.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contourcarpet import ( - hoverlabel as v_hoverlabel - ) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contourcarpet/_line.py b/plotly/graph_objs/contourcarpet/_line.py deleted file mode 100644 index 69d6296ff37..00000000000 --- a/plotly/graph_objs/contourcarpet/_line.py +++ /dev/null @@ -1,245 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - Sets the color of the contour level. Has no 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dash - # ---- - @property - def dash(self): - """ - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - - The 'dash' property is an enumeration that may be specified as: - - One of the following dash styles: - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - - A string containing a dash length list in pixels or percentages - (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) - - Returns - ------- - str - """ - return self['dash'] - - @dash.setter - def dash(self, val): - self['dash'] = val - - # smoothing - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['smoothing'] - - @smoothing.setter - def smoothing(self, val): - self['smoothing'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contourcarpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the color of the contour level. Has no if - `contours.coloring` is set to "lines". - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - smoothing - Sets the amount of smoothing for the contour lines, - where 0 corresponds to no smoothing. - width - Sets the line width (in px). - """ - - def __init__( - self, - arg=None, - color=None, - dash=None, - smoothing=None, - width=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contourcarpet.Line - color - Sets the color of the contour level. Has no if - `contours.coloring` is set to "lines". - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - smoothing - Sets the amount of smoothing for the contour lines, - where 0 corresponds to no smoothing. - width - Sets the line width (in px). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contourcarpet.Line -constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contourcarpet import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['dash'] = v_line.DashValidator() - self._validators['smoothing'] = v_line.SmoothingValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dash', None) - self['dash'] = dash if dash is not None else _v - _v = arg.pop('smoothing', None) - self['smoothing'] = smoothing if smoothing is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contourcarpet/_stream.py b/plotly/graph_objs/contourcarpet/_stream.py deleted file mode 100644 index 410a2a1a610..00000000000 --- a/plotly/graph_objs/contourcarpet/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contourcarpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.contourcarpet.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contourcarpet.Stream -constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contourcarpet import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contourcarpet/colorbar/__init__.py b/plotly/graph_objs/contourcarpet/colorbar/__init__.py index 92d3b511407..a3fa7a996b2 100644 --- a/plotly/graph_objs/contourcarpet/colorbar/__init__.py +++ b/plotly/graph_objs/contourcarpet/colorbar/__init__.py @@ -1,4 +1,723 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.contourcarpet.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contourcarpet.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.contourcarpet.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contourcarpet.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.contourcarpet.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contourcarpet.colorbar import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contourcarpet.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.contourcarpet.colorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contourcarpet.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.contourcarpet.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contourcarpet.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contourcarpet.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.contourcarpet.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contourcarpet.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.contourcarpet.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contourcarpet.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.contourcarpet.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/contourcarpet/colorbar/_tickfont.py b/plotly/graph_objs/contourcarpet/colorbar/_tickfont.py deleted file mode 100644 index d0a7c56ae7d..00000000000 --- a/plotly/graph_objs/contourcarpet/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contourcarpet.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contourcarpet.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contourcarpet.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contourcarpet.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py b/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py deleted file mode 100644 index d9c8d0e6d84..00000000000 --- a/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contourcarpet.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contourcarpet.colorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contourcarpet.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contourcarpet.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contourcarpet/colorbar/_title.py b/plotly/graph_objs/contourcarpet/colorbar/_title.py deleted file mode 100644 index e7f99276e46..00000000000 --- a/plotly/graph_objs/contourcarpet/colorbar/_title.py +++ /dev/null @@ -1,202 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.contourcarpet.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contourcarpet.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contourcarpet.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contourcarpet.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contourcarpet.colorbar import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contourcarpet/colorbar/title/__init__.py b/plotly/graph_objs/contourcarpet/colorbar/title/__init__.py index c37b8b5cd28..c84a111fbd7 100644 --- a/plotly/graph_objs/contourcarpet/colorbar/title/__init__.py +++ b/plotly/graph_objs/contourcarpet/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contourcarpet.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.contourcarpet.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contourcarpet.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.contourcarpet.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contourcarpet.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/contourcarpet/colorbar/title/_font.py b/plotly/graph_objs/contourcarpet/colorbar/title/_font.py deleted file mode 100644 index 080722cc2c7..00000000000 --- a/plotly/graph_objs/contourcarpet/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contourcarpet.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contourcarpet.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contourcarpet.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contourcarpet.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contourcarpet/contours/__init__.py b/plotly/graph_objs/contourcarpet/contours/__init__.py index 4729349bff3..77e95221092 100644 --- a/plotly/graph_objs/contourcarpet/contours/__init__.py +++ b/plotly/graph_objs/contourcarpet/contours/__init__.py @@ -1 +1,232 @@ -from ._labelfont import Labelfont + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Labelfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contourcarpet.contours' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.contourcarpet.contours.Labelfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Labelfont + """ + super(Labelfont, self).__init__('labelfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contourcarpet.contours.Labelfont +constructor must be a dict or +an instance of plotly.graph_objs.contourcarpet.contours.Labelfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contourcarpet.contours import ( + labelfont as v_labelfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_labelfont.ColorValidator() + self._validators['family'] = v_labelfont.FamilyValidator() + self._validators['size'] = v_labelfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/contourcarpet/contours/_labelfont.py b/plotly/graph_objs/contourcarpet/contours/_labelfont.py deleted file mode 100644 index db7368c69b7..00000000000 --- a/plotly/graph_objs/contourcarpet/contours/_labelfont.py +++ /dev/null @@ -1,230 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Labelfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contourcarpet.contours' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contourcarpet.contours.Labelfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Labelfont - """ - super(Labelfont, self).__init__('labelfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contourcarpet.contours.Labelfont -constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.contours.Labelfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contourcarpet.contours import ( - labelfont as v_labelfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_labelfont.ColorValidator() - self._validators['family'] = v_labelfont.FamilyValidator() - self._validators['size'] = v_labelfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/contourcarpet/hoverlabel/__init__.py b/plotly/graph_objs/contourcarpet/hoverlabel/__init__.py index c37b8b5cd28..95f942f49ca 100644 --- a/plotly/graph_objs/contourcarpet/hoverlabel/__init__.py +++ b/plotly/graph_objs/contourcarpet/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'contourcarpet.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.contourcarpet.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.contourcarpet.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.contourcarpet.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.contourcarpet.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/contourcarpet/hoverlabel/_font.py b/plotly/graph_objs/contourcarpet/hoverlabel/_font.py deleted file mode 100644 index 1dfed6552a2..00000000000 --- a/plotly/graph_objs/contourcarpet/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'contourcarpet.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.contourcarpet.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.contourcarpet.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.contourcarpet.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.contourcarpet.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/heatmap/__init__.py b/plotly/graph_objs/heatmap/__init__.py index f6c2af194e3..f2ac898c32b 100644 --- a/plotly/graph_objs/heatmap/__init__.py +++ b/plotly/graph_objs/heatmap/__init__.py @@ -1,5 +1,2426 @@ -from ._stream import Stream -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'heatmap' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.heatmap.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.heatmap.Stream +constructor must be a dict or +an instance of plotly.graph_objs.heatmap.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.heatmap import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.heatmap.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'heatmap' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.heatmap.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.heatmap.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.heatmap.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.heatmap import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.heatmap.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.heatmap.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + 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 plotly.graph_objs.heatmap.colorbar.Tickformatstop + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.heatmap.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.heatmap.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use heatmap.colorbar.title.side instead. + Determines the location of color bar's title with respect to + the color bar. Note that the title's location used to be set by + the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'heatmap' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.heatmap.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.heatma + p.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + heatmap.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.heatmap.colorbar.Title instance or + dict with compatible properties + titlefont + Deprecated: Please use heatmap.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use heatmap.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.heatmap.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.heatmap.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.heatma + p.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + heatmap.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.heatmap.colorbar.Title instance or + dict with compatible properties + titlefont + Deprecated: Please use heatmap.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use heatmap.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.heatmap.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.heatmap.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.heatmap import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.heatmap import hoverlabel -from ._colorbar import ColorBar from plotly.graph_objs.heatmap import colorbar diff --git a/plotly/graph_objs/heatmap/_colorbar.py b/plotly/graph_objs/heatmap/_colorbar.py deleted file mode 100644 index 70d7cab856e..00000000000 --- a/plotly/graph_objs/heatmap/_colorbar.py +++ /dev/null @@ -1,1863 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.heatmap.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.heatmap.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as - 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 plotly.graph_objs.heatmap.colorbar.Tickformatstop - - A dict of string/value properties that will be passed - to the Tickformatstop constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.heatmap.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.heatmap.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use heatmap.colorbar.title.side instead. - Determines the location of color bar's title with respect to - the color bar. Note that the title's location used to be set by - the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'heatmap' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.heatmap.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.heatma - p.colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - heatmap.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.heatmap.colorbar.Title instance or - dict with compatible properties - titlefont - Deprecated: Please use heatmap.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use heatmap.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.heatmap.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.heatmap.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.heatma - p.colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - heatmap.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.heatmap.colorbar.Title instance or - dict with compatible properties - titlefont - Deprecated: Please use heatmap.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use heatmap.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.heatmap.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.heatmap.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.heatmap import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/heatmap/_hoverlabel.py b/plotly/graph_objs/heatmap/_hoverlabel.py deleted file mode 100644 index eb152d1e866..00000000000 --- a/plotly/graph_objs/heatmap/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.heatmap.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'heatmap' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.heatmap.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.heatmap.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.heatmap.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.heatmap import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/heatmap/_stream.py b/plotly/graph_objs/heatmap/_stream.py deleted file mode 100644 index b1884348b4f..00000000000 --- a/plotly/graph_objs/heatmap/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'heatmap' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.heatmap.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.heatmap.Stream -constructor must be a dict or -an instance of plotly.graph_objs.heatmap.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.heatmap import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/heatmap/colorbar/__init__.py b/plotly/graph_objs/heatmap/colorbar/__init__.py index beb022d183a..312689c28b8 100644 --- a/plotly/graph_objs/heatmap/colorbar/__init__.py +++ b/plotly/graph_objs/heatmap/colorbar/__init__.py @@ -1,4 +1,720 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.heatmap.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'heatmap.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.heatmap.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.heatmap.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.heatmap.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.heatmap.colorbar import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'heatmap.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.heatmap.colorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.heatmap.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.heatmap.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.heatmap.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'heatmap.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.heatmap.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.heatmap.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.heatmap.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.heatmap.colorbar import (tickfont as v_tickfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.heatmap.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/heatmap/colorbar/_tickfont.py b/plotly/graph_objs/heatmap/colorbar/_tickfont.py deleted file mode 100644 index 74e222643f5..00000000000 --- a/plotly/graph_objs/heatmap/colorbar/_tickfont.py +++ /dev/null @@ -1,226 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'heatmap.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.heatmap.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.heatmap.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.heatmap.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.heatmap.colorbar import (tickfont as v_tickfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py b/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py deleted file mode 100644 index e1ac0c0364f..00000000000 --- a/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'heatmap.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.heatmap.colorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.heatmap.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.heatmap.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.heatmap.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/heatmap/colorbar/_title.py b/plotly/graph_objs/heatmap/colorbar/_title.py deleted file mode 100644 index 5f923bbf075..00000000000 --- a/plotly/graph_objs/heatmap/colorbar/_title.py +++ /dev/null @@ -1,201 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.heatmap.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'heatmap.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.heatmap.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.heatmap.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.heatmap.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.heatmap.colorbar import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/heatmap/colorbar/title/__init__.py b/plotly/graph_objs/heatmap/colorbar/title/__init__.py index c37b8b5cd28..4b45529e837 100644 --- a/plotly/graph_objs/heatmap/colorbar/title/__init__.py +++ b/plotly/graph_objs/heatmap/colorbar/title/__init__.py @@ -1 +1,229 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'heatmap.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.heatmap.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.heatmap.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.heatmap.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.heatmap.colorbar.title import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/heatmap/colorbar/title/_font.py b/plotly/graph_objs/heatmap/colorbar/title/_font.py deleted file mode 100644 index 4432a5951cd..00000000000 --- a/plotly/graph_objs/heatmap/colorbar/title/_font.py +++ /dev/null @@ -1,227 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'heatmap.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.heatmap.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.heatmap.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.heatmap.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.heatmap.colorbar.title import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/heatmap/hoverlabel/__init__.py b/plotly/graph_objs/heatmap/hoverlabel/__init__.py index c37b8b5cd28..77fdebf414f 100644 --- a/plotly/graph_objs/heatmap/hoverlabel/__init__.py +++ b/plotly/graph_objs/heatmap/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'heatmap.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.heatmap.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.heatmap.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.heatmap.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.heatmap.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/heatmap/hoverlabel/_font.py b/plotly/graph_objs/heatmap/hoverlabel/_font.py deleted file mode 100644 index c6e65bb6994..00000000000 --- a/plotly/graph_objs/heatmap/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'heatmap.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.heatmap.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.heatmap.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.heatmap.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.heatmap.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/heatmapgl/__init__.py b/plotly/graph_objs/heatmapgl/__init__.py index 2ed0469664d..3ab7f8b55c0 100644 --- a/plotly/graph_objs/heatmapgl/__init__.py +++ b/plotly/graph_objs/heatmapgl/__init__.py @@ -1,5 +1,2425 @@ -from ._stream import Stream -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'heatmapgl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.heatmapgl.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.heatmapgl.Stream +constructor must be a dict or +an instance of plotly.graph_objs.heatmapgl.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.heatmapgl import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.heatmapgl.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'heatmapgl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.heatmapgl.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.heatmapgl.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.heatmapgl.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.heatmapgl import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.heatmapgl.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.heatmapgl.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + 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 plotly.graph_objs.heatmapgl.colorbar.Tickformatstop + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.heatmapgl.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.heatmapgl.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use heatmapgl.colorbar.title.side instead. + Determines the location of color bar's title with respect to + the color bar. Note that the title's location used to be set by + the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'heatmapgl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.heatmapgl.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.heatma + pgl.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + heatmapgl.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.heatmapgl.colorbar.Title instance or + dict with compatible properties + titlefont + Deprecated: Please use heatmapgl.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use heatmapgl.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.heatmapgl.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.heatmapgl.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.heatma + pgl.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + heatmapgl.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.heatmapgl.colorbar.Title instance or + dict with compatible properties + titlefont + Deprecated: Please use heatmapgl.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use heatmapgl.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.heatmapgl.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.heatmapgl.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.heatmapgl import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.heatmapgl import hoverlabel -from ._colorbar import ColorBar from plotly.graph_objs.heatmapgl import colorbar diff --git a/plotly/graph_objs/heatmapgl/_colorbar.py b/plotly/graph_objs/heatmapgl/_colorbar.py deleted file mode 100644 index 13ed126dd14..00000000000 --- a/plotly/graph_objs/heatmapgl/_colorbar.py +++ /dev/null @@ -1,1862 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.heatmapgl.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.heatmapgl.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - 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 plotly.graph_objs.heatmapgl.colorbar.Tickformatstop - - A dict of string/value properties that will be passed - to the Tickformatstop constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.heatmapgl.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.heatmapgl.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use heatmapgl.colorbar.title.side instead. - Determines the location of color bar's title with respect to - the color bar. Note that the title's location used to be set by - the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'heatmapgl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.heatmapgl.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.heatma - pgl.colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - heatmapgl.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.heatmapgl.colorbar.Title instance or - dict with compatible properties - titlefont - Deprecated: Please use heatmapgl.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use heatmapgl.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.heatmapgl.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.heatmapgl.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.heatma - pgl.colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - heatmapgl.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.heatmapgl.colorbar.Title instance or - dict with compatible properties - titlefont - Deprecated: Please use heatmapgl.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use heatmapgl.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.heatmapgl.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.heatmapgl.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.heatmapgl import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/heatmapgl/_hoverlabel.py b/plotly/graph_objs/heatmapgl/_hoverlabel.py deleted file mode 100644 index 23a7755643e..00000000000 --- a/plotly/graph_objs/heatmapgl/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.heatmapgl.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'heatmapgl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.heatmapgl.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.heatmapgl.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.heatmapgl.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.heatmapgl import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/heatmapgl/_stream.py b/plotly/graph_objs/heatmapgl/_stream.py deleted file mode 100644 index 9ab6191c9e1..00000000000 --- a/plotly/graph_objs/heatmapgl/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'heatmapgl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.heatmapgl.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.heatmapgl.Stream -constructor must be a dict or -an instance of plotly.graph_objs.heatmapgl.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.heatmapgl import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/heatmapgl/colorbar/__init__.py b/plotly/graph_objs/heatmapgl/colorbar/__init__.py index 4cb5ae03a46..2b1f6f31ad8 100644 --- a/plotly/graph_objs/heatmapgl/colorbar/__init__.py +++ b/plotly/graph_objs/heatmapgl/colorbar/__init__.py @@ -1,4 +1,723 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.heatmapgl.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'heatmapgl.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.heatmapgl.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.heatmapgl.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.heatmapgl.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.heatmapgl.colorbar import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'heatmapgl.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.heatmapgl.colorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.heatmapgl.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.heatmapgl.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.heatmapgl.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'heatmapgl.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.heatmapgl.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.heatmapgl.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.heatmapgl.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.heatmapgl.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.heatmapgl.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/heatmapgl/colorbar/_tickfont.py b/plotly/graph_objs/heatmapgl/colorbar/_tickfont.py deleted file mode 100644 index 86e1f9119b8..00000000000 --- a/plotly/graph_objs/heatmapgl/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'heatmapgl.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.heatmapgl.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.heatmapgl.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.heatmapgl.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.heatmapgl.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/heatmapgl/colorbar/_tickformatstop.py b/plotly/graph_objs/heatmapgl/colorbar/_tickformatstop.py deleted file mode 100644 index 73869b95002..00000000000 --- a/plotly/graph_objs/heatmapgl/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'heatmapgl.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.heatmapgl.colorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.heatmapgl.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.heatmapgl.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.heatmapgl.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/heatmapgl/colorbar/_title.py b/plotly/graph_objs/heatmapgl/colorbar/_title.py deleted file mode 100644 index 5d4012e8232..00000000000 --- a/plotly/graph_objs/heatmapgl/colorbar/_title.py +++ /dev/null @@ -1,202 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.heatmapgl.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'heatmapgl.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.heatmapgl.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.heatmapgl.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.heatmapgl.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.heatmapgl.colorbar import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/heatmapgl/colorbar/title/__init__.py b/plotly/graph_objs/heatmapgl/colorbar/title/__init__.py index c37b8b5cd28..cde0ac806b5 100644 --- a/plotly/graph_objs/heatmapgl/colorbar/title/__init__.py +++ b/plotly/graph_objs/heatmapgl/colorbar/title/__init__.py @@ -1 +1,229 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'heatmapgl.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.heatmapgl.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.heatmapgl.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.heatmapgl.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.heatmapgl.colorbar.title import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/heatmapgl/colorbar/title/_font.py b/plotly/graph_objs/heatmapgl/colorbar/title/_font.py deleted file mode 100644 index fcb656d9d50..00000000000 --- a/plotly/graph_objs/heatmapgl/colorbar/title/_font.py +++ /dev/null @@ -1,227 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'heatmapgl.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.heatmapgl.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.heatmapgl.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.heatmapgl.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.heatmapgl.colorbar.title import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/heatmapgl/hoverlabel/__init__.py b/plotly/graph_objs/heatmapgl/hoverlabel/__init__.py index c37b8b5cd28..4a2721b5a7b 100644 --- a/plotly/graph_objs/heatmapgl/hoverlabel/__init__.py +++ b/plotly/graph_objs/heatmapgl/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'heatmapgl.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.heatmapgl.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.heatmapgl.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.heatmapgl.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.heatmapgl.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/heatmapgl/hoverlabel/_font.py b/plotly/graph_objs/heatmapgl/hoverlabel/_font.py deleted file mode 100644 index 5233fba0f67..00000000000 --- a/plotly/graph_objs/heatmapgl/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'heatmapgl.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.heatmapgl.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.heatmapgl.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.heatmapgl.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.heatmapgl.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/__init__.py b/plotly/graph_objs/histogram/__init__.py index 75c8795ac9c..4e304c0cce8 100644 --- a/plotly/graph_objs/histogram/__init__.py +++ b/plotly/graph_objs/histogram/__init__.py @@ -1,14 +1,3676 @@ -from ._ybins import YBins -from ._xbins import XBins -from ._unselected import Unselected + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class YBins(_BaseTraceHierarchyType): + + # end + # --- + @property + def end(self): + """ + Sets the end value for the y axis bins. The last bin may not + end exactly at this value, we increment the bin edge by `size` + from `start` until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use a date string, + and for category data `end` is based on the category serial + numbers. + + The 'end' property accepts values of any type + + Returns + ------- + Any + """ + return self['end'] + + @end.setter + def end(self, val): + self['end'] = val + + # size + # ---- + @property + def size(self): + """ + Sets the size of each y axis bin. Default behavior: If `nbinsy` + is 0 or omitted, we choose a nice round bin size such that the + number of bins is about the same as the typical number of + samples in each bin. If `nbinsy` is provided, we choose a nice + round bin size giving no more than that many bins. For date + data, use milliseconds or "M" for months, as in + `axis.dtick`. For category data, the number of categories to + bin together (always defaults to 1). If multiple non-overlaying + histograms share a subplot, the first explicit `size` is used + and all others discarded. If no `size` is provided,the sample + data from all traces is combined to determine `size` as + described above. + + The 'size' property accepts values of any type + + Returns + ------- + Any + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # start + # ----- + @property + def start(self): + """ + Sets the starting value for the y axis bins. Defaults to the + minimum data value, shifted down if necessary to make nice + round values and to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin edges 0.5 down, + so a `size` of 5 would have a default `start` of -0.5, so it is + clear that 0-4 are in the first bin, 5-9 in the second, but + continuous data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date string. + For category data, `start` is based on the category serial + numbers, and defaults to -0.5. If multiple non-overlaying + histograms share a subplot, the first explicit `start` is used + exactly and all others are shifted down (if necessary) to + differ from that one by an integer number of bins. + + The 'start' property accepts values of any type + + Returns + ------- + Any + """ + return self['start'] + + @start.setter + def start(self, val): + self['start'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + end + Sets the end value for the y axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each y axis bin. Default behavior: If + `nbinsy` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsy` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). If multiple non- + overlaying histograms share a subplot, the first + explicit `size` is used and all others discarded. If no + `size` is provided,the sample data from all traces is + combined to determine `size` as described above. + start + Sets the starting value for the y axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. If + multiple non-overlaying histograms share a subplot, the + first explicit `start` is used exactly and all others + are shifted down (if necessary) to differ from that one + by an integer number of bins. + """ + + def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): + """ + Construct a new YBins object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram.YBins + end + Sets the end value for the y axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each y axis bin. Default behavior: If + `nbinsy` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsy` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). If multiple non- + overlaying histograms share a subplot, the first + explicit `size` is used and all others discarded. If no + `size` is provided,the sample data from all traces is + combined to determine `size` as described above. + start + Sets the starting value for the y axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. If + multiple non-overlaying histograms share a subplot, the + first explicit `start` is used exactly and all others + are shifted down (if necessary) to differ from that one + by an integer number of bins. + + Returns + ------- + YBins + """ + super(YBins, self).__init__('ybins') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.YBins +constructor must be a dict or +an instance of plotly.graph_objs.histogram.YBins""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram import (ybins as v_ybins) + + # Initialize validators + # --------------------- + self._validators['end'] = v_ybins.EndValidator() + self._validators['size'] = v_ybins.SizeValidator() + self._validators['start'] = v_ybins.StartValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('end', None) + self['end'] = end if end is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('start', None) + self['start'] = start if start is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class XBins(_BaseTraceHierarchyType): + + # end + # --- + @property + def end(self): + """ + Sets the end value for the x axis bins. The last bin may not + end exactly at this value, we increment the bin edge by `size` + from `start` until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use a date string, + and for category data `end` is based on the category serial + numbers. + + The 'end' property accepts values of any type + + Returns + ------- + Any + """ + return self['end'] + + @end.setter + def end(self, val): + self['end'] = val + + # size + # ---- + @property + def size(self): + """ + Sets the size of each x axis bin. Default behavior: If `nbinsx` + is 0 or omitted, we choose a nice round bin size such that the + number of bins is about the same as the typical number of + samples in each bin. If `nbinsx` is provided, we choose a nice + round bin size giving no more than that many bins. For date + data, use milliseconds or "M" for months, as in + `axis.dtick`. For category data, the number of categories to + bin together (always defaults to 1). If multiple non-overlaying + histograms share a subplot, the first explicit `size` is used + and all others discarded. If no `size` is provided,the sample + data from all traces is combined to determine `size` as + described above. + + The 'size' property accepts values of any type + + Returns + ------- + Any + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # start + # ----- + @property + def start(self): + """ + Sets the starting value for the x axis bins. Defaults to the + minimum data value, shifted down if necessary to make nice + round values and to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin edges 0.5 down, + so a `size` of 5 would have a default `start` of -0.5, so it is + clear that 0-4 are in the first bin, 5-9 in the second, but + continuous data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date string. + For category data, `start` is based on the category serial + numbers, and defaults to -0.5. If multiple non-overlaying + histograms share a subplot, the first explicit `start` is used + exactly and all others are shifted down (if necessary) to + differ from that one by an integer number of bins. + + The 'start' property accepts values of any type + + Returns + ------- + Any + """ + return self['start'] + + @start.setter + def start(self, val): + self['start'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + end + Sets the end value for the x axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each x axis bin. Default behavior: If + `nbinsx` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsx` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). If multiple non- + overlaying histograms share a subplot, the first + explicit `size` is used and all others discarded. If no + `size` is provided,the sample data from all traces is + combined to determine `size` as described above. + start + Sets the starting value for the x axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. If + multiple non-overlaying histograms share a subplot, the + first explicit `start` is used exactly and all others + are shifted down (if necessary) to differ from that one + by an integer number of bins. + """ + + def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): + """ + Construct a new XBins object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram.XBins + end + Sets the end value for the x axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each x axis bin. Default behavior: If + `nbinsx` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsx` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). If multiple non- + overlaying histograms share a subplot, the first + explicit `size` is used and all others discarded. If no + `size` is provided,the sample data from all traces is + combined to determine `size` as described above. + start + Sets the starting value for the x axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. If + multiple non-overlaying histograms share a subplot, the + first explicit `start` is used exactly and all others + are shifted down (if necessary) to differ from that one + by an integer number of bins. + + Returns + ------- + XBins + """ + super(XBins, self).__init__('xbins') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.XBins +constructor must be a dict or +an instance of plotly.graph_objs.histogram.XBins""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram import (xbins as v_xbins) + + # Initialize validators + # --------------------- + self._validators['end'] = v_xbins.EndValidator() + self._validators['size'] = v_xbins.SizeValidator() + self._validators['start'] = v_xbins.StartValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('end', None) + self['end'] = end if end is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('start', None) + self['start'] = start if start is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + + Returns + ------- + plotly.graph_objs.histogram.unselected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.histogram.unselected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.histogram.unselected.Marker instance + or dict with compatible properties + textfont + plotly.graph_objs.histogram.unselected.Textfont + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram.Unselected + marker + plotly.graph_objs.histogram.unselected.Marker instance + or dict with compatible properties + textfont + plotly.graph_objs.histogram.unselected.Textfont + instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super(Unselected, self).__init__('unselected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.Unselected +constructor must be a dict or +an instance of plotly.graph_objs.histogram.Unselected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram import (unselected as v_unselected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_unselected.MarkerValidator() + self._validators['textfont'] = v_unselected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.Stream +constructor must be a dict or +an instance of plotly.graph_objs.histogram.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + Sets the marker opacity of selected points. + + Returns + ------- + plotly.graph_objs.histogram.selected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.histogram.selected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.histogram.selected.Marker instance or + dict with compatible properties + textfont + plotly.graph_objs.histogram.selected.Textfont instance + or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram.Selected + marker + plotly.graph_objs.histogram.selected.Marker instance or + dict with compatible properties + textfont + plotly.graph_objs.histogram.selected.Textfont instance + or dict with compatible properties + + Returns + ------- + Selected + """ + super(Selected, self).__init__('selected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.Selected +constructor must be a dict or +an instance of plotly.graph_objs.histogram.Selected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram import (selected as v_selected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_selected.MarkerValidator() + self._validators['textfont'] = v_selected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color`is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` array are + all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmin` + must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmax` + must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarkercolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to histogram.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of 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 + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.histogram.marker.colorbar.Tic + kformatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.histogram.marker.colorbar.tickformatstopdefau + lts), sets the default property values to use + for elements of + histogram.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.histogram.marker.colorbar.Tit + le instance or dict with compatible properties + titlefont + Deprecated: Please use + histogram.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. + titleside + Deprecated: Please use + histogram.marker.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.histogram.marker.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color`is + set to a numerical array. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At minimum, a mapping for + the lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Greys,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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.histogram.marker.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # opacity + # ------- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # opacitysrc + # ---------- + @property + def opacitysrc(self): + """ + Sets the source reference on plot.ly for opacity . + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['opacitysrc'] + + @opacitysrc.setter + def opacitysrc(self, val): + self['opacitysrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color`is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.histogram.marker.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + line + plotly.graph_objs.histogram.marker.Line instance or + dict with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorbar=None, + colorscale=None, + colorsrc=None, + line=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram.Marker + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.histogram.marker.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + line + plotly.graph_objs.histogram.marker.Line instance or + dict with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.Marker +constructor must be a dict or +an instance of plotly.graph_objs.histogram.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() + self._validators['cauto'] = v_marker.CautoValidator() + self._validators['cmax'] = v_marker.CmaxValidator() + self._validators['cmid'] = v_marker.CmidValidator() + self._validators['cmin'] = v_marker.CminValidator() + self._validators['color'] = v_marker.ColorValidator() + self._validators['colorbar'] = v_marker.ColorBarValidator() + self._validators['colorscale'] = v_marker.ColorscaleValidator() + self._validators['colorsrc'] = v_marker.ColorsrcValidator() + self._validators['line'] = v_marker.LineValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() + self._validators['reversescale'] = v_marker.ReversescaleValidator() + self._validators['showscale'] = v_marker.ShowscaleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('opacitysrc', None) + self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.histogram.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.histogram.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorY(_BaseTraceHierarchyType): + + # array + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['array'] + + @array.setter + def array(self, val): + self['array'] = val + + # arrayminus + # ---------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['arrayminus'] + + @arrayminus.setter + def arrayminus(self, val): + self['arrayminus'] = val + + # arrayminussrc + # ------------- + @property + def arrayminussrc(self): + """ + Sets the source reference on plot.ly for arrayminus . + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arrayminussrc'] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self['arrayminussrc'] = val + + # arraysrc + # -------- + @property + def arraysrc(self): + """ + Sets the source reference on plot.ly for array . + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arraysrc'] + + @arraysrc.setter + def arraysrc(self, val): + self['arraysrc'] = val + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # symmetric + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['symmetric'] + + @symmetric.setter + def symmetric(self, val): + self['symmetric'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # traceref + # -------- + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['traceref'] + + @traceref.setter + def traceref(self, val): + self['traceref'] = val + + # tracerefminus + # ------------- + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['tracerefminus'] + + @tracerefminus.setter + def tracerefminus(self, val): + self['tracerefminus'] = val + + # type + # ---- + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the sqaure of + the underlying data. If "array", 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # value + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # valueminus + # ---------- + @property + def valueminus(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 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] + + Returns + ------- + int|float + """ + return self['valueminus'] + + @valueminus.setter + def valueminus(self, val): + self['valueminus'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs + ): + """ + Construct a new ErrorY object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram.ErrorY + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorY + """ + super(ErrorY, self).__init__('error_y') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.ErrorY +constructor must be a dict or +an instance of plotly.graph_objs.histogram.ErrorY""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram import (error_y as v_error_y) + + # Initialize validators + # --------------------- + self._validators['array'] = v_error_y.ArrayValidator() + self._validators['arrayminus'] = v_error_y.ArrayminusValidator() + self._validators['arrayminussrc'] = v_error_y.ArrayminussrcValidator() + self._validators['arraysrc'] = v_error_y.ArraysrcValidator() + self._validators['color'] = v_error_y.ColorValidator() + self._validators['symmetric'] = v_error_y.SymmetricValidator() + self._validators['thickness'] = v_error_y.ThicknessValidator() + self._validators['traceref'] = v_error_y.TracerefValidator() + self._validators['tracerefminus'] = v_error_y.TracerefminusValidator() + self._validators['type'] = v_error_y.TypeValidator() + self._validators['value'] = v_error_y.ValueValidator() + self._validators['valueminus'] = v_error_y.ValueminusValidator() + self._validators['visible'] = v_error_y.VisibleValidator() + self._validators['width'] = v_error_y.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('array', None) + self['array'] = array if array is not None else _v + _v = arg.pop('arrayminus', None) + self['arrayminus'] = arrayminus if arrayminus is not None else _v + _v = arg.pop('arrayminussrc', None) + self['arrayminussrc' + ] = arrayminussrc if arrayminussrc is not None else _v + _v = arg.pop('arraysrc', None) + self['arraysrc'] = arraysrc if arraysrc is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('symmetric', None) + self['symmetric'] = symmetric if symmetric is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('traceref', None) + self['traceref'] = traceref if traceref is not None else _v + _v = arg.pop('tracerefminus', None) + self['tracerefminus' + ] = tracerefminus if tracerefminus is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + _v = arg.pop('valueminus', None) + self['valueminus'] = valueminus if valueminus is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorX(_BaseTraceHierarchyType): + + # array + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['array'] + + @array.setter + def array(self, val): + self['array'] = val + + # arrayminus + # ---------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['arrayminus'] + + @arrayminus.setter + def arrayminus(self, val): + self['arrayminus'] = val + + # arrayminussrc + # ------------- + @property + def arrayminussrc(self): + """ + Sets the source reference on plot.ly for arrayminus . + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arrayminussrc'] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self['arrayminussrc'] = val + + # arraysrc + # -------- + @property + def arraysrc(self): + """ + Sets the source reference on plot.ly for array . + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arraysrc'] + + @arraysrc.setter + def arraysrc(self, val): + self['arraysrc'] = val + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # copy_ystyle + # ----------- + @property + def copy_ystyle(self): + """ + The 'copy_ystyle' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['copy_ystyle'] + + @copy_ystyle.setter + def copy_ystyle(self, val): + self['copy_ystyle'] = val + + # symmetric + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['symmetric'] + + @symmetric.setter + def symmetric(self, val): + self['symmetric'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # traceref + # -------- + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['traceref'] + + @traceref.setter + def traceref(self, val): + self['traceref'] = val + + # tracerefminus + # ------------- + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['tracerefminus'] + + @tracerefminus.setter + def tracerefminus(self, val): + self['tracerefminus'] = val + + # type + # ---- + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the sqaure of + the underlying data. If "array", 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # value + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # valueminus + # ---------- + @property + def valueminus(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 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] + + Returns + ------- + int|float + """ + return self['valueminus'] + + @valueminus.setter + def valueminus(self, val): + self['valueminus'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + copy_ystyle=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs + ): + """ + Construct a new ErrorX object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram.ErrorX + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorX + """ + super(ErrorX, self).__init__('error_x') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.ErrorX +constructor must be a dict or +an instance of plotly.graph_objs.histogram.ErrorX""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram import (error_x as v_error_x) + + # Initialize validators + # --------------------- + self._validators['array'] = v_error_x.ArrayValidator() + self._validators['arrayminus'] = v_error_x.ArrayminusValidator() + self._validators['arrayminussrc'] = v_error_x.ArrayminussrcValidator() + self._validators['arraysrc'] = v_error_x.ArraysrcValidator() + self._validators['color'] = v_error_x.ColorValidator() + self._validators['copy_ystyle'] = v_error_x.CopyYstyleValidator() + self._validators['symmetric'] = v_error_x.SymmetricValidator() + self._validators['thickness'] = v_error_x.ThicknessValidator() + self._validators['traceref'] = v_error_x.TracerefValidator() + self._validators['tracerefminus'] = v_error_x.TracerefminusValidator() + self._validators['type'] = v_error_x.TypeValidator() + self._validators['value'] = v_error_x.ValueValidator() + self._validators['valueminus'] = v_error_x.ValueminusValidator() + self._validators['visible'] = v_error_x.VisibleValidator() + self._validators['width'] = v_error_x.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('array', None) + self['array'] = array if array is not None else _v + _v = arg.pop('arrayminus', None) + self['arrayminus'] = arrayminus if arrayminus is not None else _v + _v = arg.pop('arrayminussrc', None) + self['arrayminussrc' + ] = arrayminussrc if arrayminussrc is not None else _v + _v = arg.pop('arraysrc', None) + self['arraysrc'] = arraysrc if arraysrc is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('copy_ystyle', None) + self['copy_ystyle'] = copy_ystyle if copy_ystyle is not None else _v + _v = arg.pop('symmetric', None) + self['symmetric'] = symmetric if symmetric is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('traceref', None) + self['traceref'] = traceref if traceref is not None else _v + _v = arg.pop('tracerefminus', None) + self['tracerefminus' + ] = tracerefminus if tracerefminus is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + _v = arg.pop('valueminus', None) + self['valueminus'] = valueminus if valueminus is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Cumulative(_BaseTraceHierarchyType): + + # currentbin + # ---------- + @property + def currentbin(self): + """ + Only applies if cumulative is enabled. Sets whether the current + bin is included, excluded, or has half of its value included in + the current cumulative value. "include" is the default for + compatibility with various other tools, however it introduces a + half-bin bias to the results. "exclude" makes the opposite + half-bin bias, and "half" removes it. + + The 'currentbin' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['include', 'exclude', 'half'] + + Returns + ------- + Any + """ + return self['currentbin'] + + @currentbin.setter + def currentbin(self, val): + self['currentbin'] = val + + # direction + # --------- + @property + def direction(self): + """ + Only applies if cumulative is enabled. If "increasing" + (default) we sum all prior bins, so the result increases from + left to right. If "decreasing" we sum later bins so the result + decreases from left to right. + + The 'direction' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['increasing', 'decreasing'] + + Returns + ------- + Any + """ + return self['direction'] + + @direction.setter + def direction(self, val): + self['direction'] = val + + # enabled + # ------- + @property + def enabled(self): + """ + If true, display the cumulative distribution by summing the + binned values. Use the `direction` and `centralbin` attributes + to tune the accumulation method. Note: in this mode, the + "density" `histnorm` settings behave the same as their + equivalents without "density": "" and "density" both rise to + the number of data points, and "probability" and *probability + density* both rise to the number of sample points. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + currentbin + Only applies if cumulative is enabled. Sets whether the + current bin is included, excluded, or has half of its + value included in the current cumulative value. + "include" is the default for compatibility with various + other tools, however it introduces a half-bin bias to + the results. "exclude" makes the opposite half-bin + bias, and "half" removes it. + direction + Only applies if cumulative is enabled. If "increasing" + (default) we sum all prior bins, so the result + increases from left to right. If "decreasing" we sum + later bins so the result decreases from left to right. + enabled + If true, display the cumulative distribution by summing + the binned values. Use the `direction` and `centralbin` + attributes to tune the accumulation method. Note: in + this mode, the "density" `histnorm` settings behave the + same as their equivalents without "density": "" and + "density" both rise to the number of data points, and + "probability" and *probability density* both rise to + the number of sample points. + """ + + def __init__( + self, + arg=None, + currentbin=None, + direction=None, + enabled=None, + **kwargs + ): + """ + Construct a new Cumulative object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram.Cumulative + currentbin + Only applies if cumulative is enabled. Sets whether the + current bin is included, excluded, or has half of its + value included in the current cumulative value. + "include" is the default for compatibility with various + other tools, however it introduces a half-bin bias to + the results. "exclude" makes the opposite half-bin + bias, and "half" removes it. + direction + Only applies if cumulative is enabled. If "increasing" + (default) we sum all prior bins, so the result + increases from left to right. If "decreasing" we sum + later bins so the result decreases from left to right. + enabled + If true, display the cumulative distribution by summing + the binned values. Use the `direction` and `centralbin` + attributes to tune the accumulation method. Note: in + this mode, the "density" `histnorm` settings behave the + same as their equivalents without "density": "" and + "density" both rise to the number of data points, and + "probability" and *probability density* both rise to + the number of sample points. + + Returns + ------- + Cumulative + """ + super(Cumulative, self).__init__('cumulative') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.Cumulative +constructor must be a dict or +an instance of plotly.graph_objs.histogram.Cumulative""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram import (cumulative as v_cumulative) + + # Initialize validators + # --------------------- + self._validators['currentbin'] = v_cumulative.CurrentbinValidator() + self._validators['direction'] = v_cumulative.DirectionValidator() + self._validators['enabled'] = v_cumulative.EnabledValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('currentbin', None) + self['currentbin'] = currentbin if currentbin is not None else _v + _v = arg.pop('direction', None) + self['direction'] = direction if direction is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.histogram import unselected -from ._stream import Stream -from ._selected import Selected from plotly.graph_objs.histogram import selected -from ._marker import Marker from plotly.graph_objs.histogram import marker -from ._hoverlabel import Hoverlabel from plotly.graph_objs.histogram import hoverlabel -from ._error_y import ErrorY -from ._error_x import ErrorX -from ._cumulative import Cumulative diff --git a/plotly/graph_objs/histogram/_cumulative.py b/plotly/graph_objs/histogram/_cumulative.py deleted file mode 100644 index fa2b0a83a71..00000000000 --- a/plotly/graph_objs/histogram/_cumulative.py +++ /dev/null @@ -1,208 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Cumulative(BaseTraceHierarchyType): - - # currentbin - # ---------- - @property - def currentbin(self): - """ - Only applies if cumulative is enabled. Sets whether the current - bin is included, excluded, or has half of its value included in - the current cumulative value. "include" is the default for - compatibility with various other tools, however it introduces a - half-bin bias to the results. "exclude" makes the opposite - half-bin bias, and "half" removes it. - - The 'currentbin' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['include', 'exclude', 'half'] - - Returns - ------- - Any - """ - return self['currentbin'] - - @currentbin.setter - def currentbin(self, val): - self['currentbin'] = val - - # direction - # --------- - @property - def direction(self): - """ - Only applies if cumulative is enabled. If "increasing" - (default) we sum all prior bins, so the result increases from - left to right. If "decreasing" we sum later bins so the result - decreases from left to right. - - The 'direction' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['increasing', 'decreasing'] - - Returns - ------- - Any - """ - return self['direction'] - - @direction.setter - def direction(self, val): - self['direction'] = val - - # enabled - # ------- - @property - def enabled(self): - """ - If true, display the cumulative distribution by summing the - binned values. Use the `direction` and `centralbin` attributes - to tune the accumulation method. Note: in this mode, the - "density" `histnorm` settings behave the same as their - equivalents without "density": "" and "density" both rise to - the number of data points, and "probability" and *probability - density* both rise to the number of sample points. - - The 'enabled' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - currentbin - Only applies if cumulative is enabled. Sets whether the - current bin is included, excluded, or has half of its - value included in the current cumulative value. - "include" is the default for compatibility with various - other tools, however it introduces a half-bin bias to - the results. "exclude" makes the opposite half-bin - bias, and "half" removes it. - direction - Only applies if cumulative is enabled. If "increasing" - (default) we sum all prior bins, so the result - increases from left to right. If "decreasing" we sum - later bins so the result decreases from left to right. - enabled - If true, display the cumulative distribution by summing - the binned values. Use the `direction` and `centralbin` - attributes to tune the accumulation method. Note: in - this mode, the "density" `histnorm` settings behave the - same as their equivalents without "density": "" and - "density" both rise to the number of data points, and - "probability" and *probability density* both rise to - the number of sample points. - """ - - def __init__( - self, - arg=None, - currentbin=None, - direction=None, - enabled=None, - **kwargs - ): - """ - Construct a new Cumulative object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.Cumulative - currentbin - Only applies if cumulative is enabled. Sets whether the - current bin is included, excluded, or has half of its - value included in the current cumulative value. - "include" is the default for compatibility with various - other tools, however it introduces a half-bin bias to - the results. "exclude" makes the opposite half-bin - bias, and "half" removes it. - direction - Only applies if cumulative is enabled. If "increasing" - (default) we sum all prior bins, so the result - increases from left to right. If "decreasing" we sum - later bins so the result decreases from left to right. - enabled - If true, display the cumulative distribution by summing - the binned values. Use the `direction` and `centralbin` - attributes to tune the accumulation method. Note: in - this mode, the "density" `histnorm` settings behave the - same as their equivalents without "density": "" and - "density" both rise to the number of data points, and - "probability" and *probability density* both rise to - the number of sample points. - - Returns - ------- - Cumulative - """ - super(Cumulative, self).__init__('cumulative') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.Cumulative -constructor must be a dict or -an instance of plotly.graph_objs.histogram.Cumulative""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram import (cumulative as v_cumulative) - - # Initialize validators - # --------------------- - self._validators['currentbin'] = v_cumulative.CurrentbinValidator() - self._validators['direction'] = v_cumulative.DirectionValidator() - self._validators['enabled'] = v_cumulative.EnabledValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('currentbin', None) - self['currentbin'] = currentbin if currentbin is not None else _v - _v = arg.pop('direction', None) - self['direction'] = direction if direction is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/_error_x.py b/plotly/graph_objs/histogram/_error_x.py deleted file mode 100644 index a3e3e9067ba..00000000000 --- a/plotly/graph_objs/histogram/_error_x.py +++ /dev/null @@ -1,597 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ErrorX(BaseTraceHierarchyType): - - # array - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['array'] - - @array.setter - def array(self, val): - self['array'] = val - - # arrayminus - # ---------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['arrayminus'] - - @arrayminus.setter - def arrayminus(self, val): - self['arrayminus'] = val - - # arrayminussrc - # ------------- - @property - def arrayminussrc(self): - """ - Sets the source reference on plot.ly for arrayminus . - - The 'arrayminussrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arrayminussrc'] - - @arrayminussrc.setter - def arrayminussrc(self, val): - self['arrayminussrc'] = val - - # arraysrc - # -------- - @property - def arraysrc(self): - """ - Sets the source reference on plot.ly for array . - - The 'arraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arraysrc'] - - @arraysrc.setter - def arraysrc(self, val): - self['arraysrc'] = val - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # copy_ystyle - # ----------- - @property - def copy_ystyle(self): - """ - The 'copy_ystyle' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['copy_ystyle'] - - @copy_ystyle.setter - def copy_ystyle(self, val): - self['copy_ystyle'] = val - - # symmetric - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['symmetric'] - - @symmetric.setter - def symmetric(self, val): - self['symmetric'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # traceref - # -------- - @property - def traceref(self): - """ - The 'traceref' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['traceref'] - - @traceref.setter - def traceref(self, val): - self['traceref'] = val - - # tracerefminus - # ------------- - @property - def tracerefminus(self): - """ - The 'tracerefminus' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['tracerefminus'] - - @tracerefminus.setter - def tracerefminus(self, val): - self['tracerefminus'] = val - - # type - # ---- - @property - def type(self): - """ - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. Set this - constant in `value`. If "percent", the bar lengths correspond - to a percentage of underlying data. Set this percentage in - `value`. If "sqrt", the bar lengths correspond to the sqaure of - the underlying data. If "array", 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # value - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # valueminus - # ---------- - @property - def valueminus(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 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] - - Returns - ------- - int|float - """ - return self['valueminus'] - - @valueminus.setter - def valueminus(self, val): - self['valueminus'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - copy_ystyle - - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - """ - - def __init__( - self, - arg=None, - array=None, - arrayminus=None, - arrayminussrc=None, - arraysrc=None, - color=None, - copy_ystyle=None, - symmetric=None, - thickness=None, - traceref=None, - tracerefminus=None, - type=None, - value=None, - valueminus=None, - visible=None, - width=None, - **kwargs - ): - """ - Construct a new ErrorX object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.ErrorX - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - copy_ystyle - - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - - Returns - ------- - ErrorX - """ - super(ErrorX, self).__init__('error_x') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.ErrorX -constructor must be a dict or -an instance of plotly.graph_objs.histogram.ErrorX""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram import (error_x as v_error_x) - - # Initialize validators - # --------------------- - self._validators['array'] = v_error_x.ArrayValidator() - self._validators['arrayminus'] = v_error_x.ArrayminusValidator() - self._validators['arrayminussrc'] = v_error_x.ArrayminussrcValidator() - self._validators['arraysrc'] = v_error_x.ArraysrcValidator() - self._validators['color'] = v_error_x.ColorValidator() - self._validators['copy_ystyle'] = v_error_x.CopyYstyleValidator() - self._validators['symmetric'] = v_error_x.SymmetricValidator() - self._validators['thickness'] = v_error_x.ThicknessValidator() - self._validators['traceref'] = v_error_x.TracerefValidator() - self._validators['tracerefminus'] = v_error_x.TracerefminusValidator() - self._validators['type'] = v_error_x.TypeValidator() - self._validators['value'] = v_error_x.ValueValidator() - self._validators['valueminus'] = v_error_x.ValueminusValidator() - self._validators['visible'] = v_error_x.VisibleValidator() - self._validators['width'] = v_error_x.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('array', None) - self['array'] = array if array is not None else _v - _v = arg.pop('arrayminus', None) - self['arrayminus'] = arrayminus if arrayminus is not None else _v - _v = arg.pop('arrayminussrc', None) - self['arrayminussrc' - ] = arrayminussrc if arrayminussrc is not None else _v - _v = arg.pop('arraysrc', None) - self['arraysrc'] = arraysrc if arraysrc is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('copy_ystyle', None) - self['copy_ystyle'] = copy_ystyle if copy_ystyle is not None else _v - _v = arg.pop('symmetric', None) - self['symmetric'] = symmetric if symmetric is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('traceref', None) - self['traceref'] = traceref if traceref is not None else _v - _v = arg.pop('tracerefminus', None) - self['tracerefminus' - ] = tracerefminus if tracerefminus is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - _v = arg.pop('valueminus', None) - self['valueminus'] = valueminus if valueminus is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/_error_y.py b/plotly/graph_objs/histogram/_error_y.py deleted file mode 100644 index a7a8095f613..00000000000 --- a/plotly/graph_objs/histogram/_error_y.py +++ /dev/null @@ -1,571 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ErrorY(BaseTraceHierarchyType): - - # array - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['array'] - - @array.setter - def array(self, val): - self['array'] = val - - # arrayminus - # ---------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['arrayminus'] - - @arrayminus.setter - def arrayminus(self, val): - self['arrayminus'] = val - - # arrayminussrc - # ------------- - @property - def arrayminussrc(self): - """ - Sets the source reference on plot.ly for arrayminus . - - The 'arrayminussrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arrayminussrc'] - - @arrayminussrc.setter - def arrayminussrc(self, val): - self['arrayminussrc'] = val - - # arraysrc - # -------- - @property - def arraysrc(self): - """ - Sets the source reference on plot.ly for array . - - The 'arraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arraysrc'] - - @arraysrc.setter - def arraysrc(self, val): - self['arraysrc'] = val - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # symmetric - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['symmetric'] - - @symmetric.setter - def symmetric(self, val): - self['symmetric'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # traceref - # -------- - @property - def traceref(self): - """ - The 'traceref' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['traceref'] - - @traceref.setter - def traceref(self, val): - self['traceref'] = val - - # tracerefminus - # ------------- - @property - def tracerefminus(self): - """ - The 'tracerefminus' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['tracerefminus'] - - @tracerefminus.setter - def tracerefminus(self, val): - self['tracerefminus'] = val - - # type - # ---- - @property - def type(self): - """ - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. Set this - constant in `value`. If "percent", the bar lengths correspond - to a percentage of underlying data. Set this percentage in - `value`. If "sqrt", the bar lengths correspond to the sqaure of - the underlying data. If "array", 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # value - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # valueminus - # ---------- - @property - def valueminus(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 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] - - Returns - ------- - int|float - """ - return self['valueminus'] - - @valueminus.setter - def valueminus(self, val): - self['valueminus'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - """ - - def __init__( - self, - arg=None, - array=None, - arrayminus=None, - arrayminussrc=None, - arraysrc=None, - color=None, - symmetric=None, - thickness=None, - traceref=None, - tracerefminus=None, - type=None, - value=None, - valueminus=None, - visible=None, - width=None, - **kwargs - ): - """ - Construct a new ErrorY object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.ErrorY - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - - Returns - ------- - ErrorY - """ - super(ErrorY, self).__init__('error_y') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.ErrorY -constructor must be a dict or -an instance of plotly.graph_objs.histogram.ErrorY""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram import (error_y as v_error_y) - - # Initialize validators - # --------------------- - self._validators['array'] = v_error_y.ArrayValidator() - self._validators['arrayminus'] = v_error_y.ArrayminusValidator() - self._validators['arrayminussrc'] = v_error_y.ArrayminussrcValidator() - self._validators['arraysrc'] = v_error_y.ArraysrcValidator() - self._validators['color'] = v_error_y.ColorValidator() - self._validators['symmetric'] = v_error_y.SymmetricValidator() - self._validators['thickness'] = v_error_y.ThicknessValidator() - self._validators['traceref'] = v_error_y.TracerefValidator() - self._validators['tracerefminus'] = v_error_y.TracerefminusValidator() - self._validators['type'] = v_error_y.TypeValidator() - self._validators['value'] = v_error_y.ValueValidator() - self._validators['valueminus'] = v_error_y.ValueminusValidator() - self._validators['visible'] = v_error_y.VisibleValidator() - self._validators['width'] = v_error_y.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('array', None) - self['array'] = array if array is not None else _v - _v = arg.pop('arrayminus', None) - self['arrayminus'] = arrayminus if arrayminus is not None else _v - _v = arg.pop('arrayminussrc', None) - self['arrayminussrc' - ] = arrayminussrc if arrayminussrc is not None else _v - _v = arg.pop('arraysrc', None) - self['arraysrc'] = arraysrc if arraysrc is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('symmetric', None) - self['symmetric'] = symmetric if symmetric is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('traceref', None) - self['traceref'] = traceref if traceref is not None else _v - _v = arg.pop('tracerefminus', None) - self['tracerefminus' - ] = tracerefminus if tracerefminus is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - _v = arg.pop('valueminus', None) - self['valueminus'] = valueminus if valueminus is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/_hoverlabel.py b/plotly/graph_objs/histogram/_hoverlabel.py deleted file mode 100644 index 25531d1a055..00000000000 --- a/plotly/graph_objs/histogram/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.histogram.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.histogram.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/_marker.py b/plotly/graph_objs/histogram/_marker.py deleted file mode 100644 index e6b77189245..00000000000 --- a/plotly/graph_objs/histogram/_marker.py +++ /dev/null @@ -1,950 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in `marker.color`is - set to a numerical array. In case `colorscale` is unspecified - or `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` array are - all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.color`) or the - bounds set in `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical array. Defaults - to `false` when `marker.cmin` and `marker.cmax` are set by the - user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmin` - must be set as well. - - The 'cmax' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling `marker.cmin` - and/or `marker.cmax` to be equidistant to this point. Has an - effect only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color`. Has no - effect when `marker.cauto` is `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmax` - must be set as well. - - The 'cmin' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarkercolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to histogram.marker.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of 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 - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.histogram.marker.colorbar.Tic - kformatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.histogram.marker.colorbar.tickformatstopdefau - lts), sets the default property values to use - for elements of - histogram.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.histogram.marker.colorbar.Tit - le instance or dict with compatible properties - titlefont - Deprecated: Please use - histogram.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. - titleside - Deprecated: Please use - histogram.marker.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.histogram.marker.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in `marker.color`is - set to a numerical array. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At minimum, a mapping for - the lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` - may be a palette name string of the following list: Greys,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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.histogram.marker.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # opacity - # ------- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # opacitysrc - # ---------- - @property - def opacitysrc(self): - """ - Sets the source reference on plot.ly for opacity . - - The 'opacitysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['opacitysrc'] - - @opacitysrc.setter - def opacitysrc(self, val): - self['opacitysrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.color`is set to a numerical array. If true, - `marker.cmin` will correspond to the last color in the array - and `marker.cmax` will correspond to the first color. - - The 'reversescale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.histogram.marker.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - line - plotly.graph_objs.histogram.marker.Line instance or - dict with compatible properties - opacity - Sets the opacity of the bars. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorbar=None, - colorscale=None, - colorsrc=None, - line=None, - opacity=None, - opacitysrc=None, - reversescale=None, - showscale=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.Marker - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.histogram.marker.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - line - plotly.graph_objs.histogram.marker.Line instance or - dict with compatible properties - opacity - Sets the opacity of the bars. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.Marker -constructor must be a dict or -an instance of plotly.graph_objs.histogram.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() - self._validators['cauto'] = v_marker.CautoValidator() - self._validators['cmax'] = v_marker.CmaxValidator() - self._validators['cmid'] = v_marker.CmidValidator() - self._validators['cmin'] = v_marker.CminValidator() - self._validators['color'] = v_marker.ColorValidator() - self._validators['colorbar'] = v_marker.ColorBarValidator() - self._validators['colorscale'] = v_marker.ColorscaleValidator() - self._validators['colorsrc'] = v_marker.ColorsrcValidator() - self._validators['line'] = v_marker.LineValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() - self._validators['reversescale'] = v_marker.ReversescaleValidator() - self._validators['showscale'] = v_marker.ShowscaleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('opacitysrc', None) - self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/_selected.py b/plotly/graph_objs/histogram/_selected.py deleted file mode 100644 index 92b86e690d8..00000000000 --- a/plotly/graph_objs/histogram/_selected.py +++ /dev/null @@ -1,144 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Selected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - Sets the marker opacity of selected points. - - Returns - ------- - plotly.graph_objs.histogram.selected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.histogram.selected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.histogram.selected.Marker instance or - dict with compatible properties - textfont - plotly.graph_objs.histogram.selected.Textfont instance - or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Selected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.Selected - marker - plotly.graph_objs.histogram.selected.Marker instance or - dict with compatible properties - textfont - plotly.graph_objs.histogram.selected.Textfont instance - or dict with compatible properties - - Returns - ------- - Selected - """ - super(Selected, self).__init__('selected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.Selected -constructor must be a dict or -an instance of plotly.graph_objs.histogram.Selected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram import (selected as v_selected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_selected.MarkerValidator() - self._validators['textfont'] = v_selected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/_stream.py b/plotly/graph_objs/histogram/_stream.py deleted file mode 100644 index 9d93f77d37b..00000000000 --- a/plotly/graph_objs/histogram/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.Stream -constructor must be a dict or -an instance of plotly.graph_objs.histogram.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/_unselected.py b/plotly/graph_objs/histogram/_unselected.py deleted file mode 100644 index fdf977bf86d..00000000000 --- a/plotly/graph_objs/histogram/_unselected.py +++ /dev/null @@ -1,147 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Unselected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - - Returns - ------- - plotly.graph_objs.histogram.unselected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.histogram.unselected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.histogram.unselected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objs.histogram.unselected.Textfont - instance or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Unselected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.Unselected - marker - plotly.graph_objs.histogram.unselected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objs.histogram.unselected.Textfont - instance or dict with compatible properties - - Returns - ------- - Unselected - """ - super(Unselected, self).__init__('unselected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.Unselected -constructor must be a dict or -an instance of plotly.graph_objs.histogram.Unselected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram import (unselected as v_unselected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_unselected.MarkerValidator() - self._validators['textfont'] = v_unselected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/_xbins.py b/plotly/graph_objs/histogram/_xbins.py deleted file mode 100644 index f74df111202..00000000000 --- a/plotly/graph_objs/histogram/_xbins.py +++ /dev/null @@ -1,240 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class XBins(BaseTraceHierarchyType): - - # end - # --- - @property - def end(self): - """ - Sets the end value for the x axis bins. The last bin may not - end exactly at this value, we increment the bin edge by `size` - from `start` until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use a date string, - and for category data `end` is based on the category serial - numbers. - - The 'end' property accepts values of any type - - Returns - ------- - Any - """ - return self['end'] - - @end.setter - def end(self, val): - self['end'] = val - - # size - # ---- - @property - def size(self): - """ - Sets the size of each x axis bin. Default behavior: If `nbinsx` - is 0 or omitted, we choose a nice round bin size such that the - number of bins is about the same as the typical number of - samples in each bin. If `nbinsx` is provided, we choose a nice - round bin size giving no more than that many bins. For date - data, use milliseconds or "M" for months, as in - `axis.dtick`. For category data, the number of categories to - bin together (always defaults to 1). If multiple non-overlaying - histograms share a subplot, the first explicit `size` is used - and all others discarded. If no `size` is provided,the sample - data from all traces is combined to determine `size` as - described above. - - The 'size' property accepts values of any type - - Returns - ------- - Any - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # start - # ----- - @property - def start(self): - """ - Sets the starting value for the x axis bins. Defaults to the - minimum data value, shifted down if necessary to make nice - round values and to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin edges 0.5 down, - so a `size` of 5 would have a default `start` of -0.5, so it is - clear that 0-4 are in the first bin, 5-9 in the second, but - continuous data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date string. - For category data, `start` is based on the category serial - numbers, and defaults to -0.5. If multiple non-overlaying - histograms share a subplot, the first explicit `start` is used - exactly and all others are shifted down (if necessary) to - differ from that one by an integer number of bins. - - The 'start' property accepts values of any type - - Returns - ------- - Any - """ - return self['start'] - - @start.setter - def start(self, val): - self['start'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - end - Sets the end value for the x axis bins. The last bin - may not end exactly at this value, we increment the bin - edge by `size` from `start` until we reach or exceed - `end`. Defaults to the maximum data value. Like - `start`, for dates use a date string, and for category - data `end` is based on the category serial numbers. - size - Sets the size of each x axis bin. Default behavior: If - `nbinsx` is 0 or omitted, we choose a nice round bin - size such that the number of bins is about the same as - the typical number of samples in each bin. If `nbinsx` - is provided, we choose a nice round bin size giving no - more than that many bins. For date data, use - milliseconds or "M" for months, as in `axis.dtick`. - For category data, the number of categories to bin - together (always defaults to 1). If multiple non- - overlaying histograms share a subplot, the first - explicit `size` is used and all others discarded. If no - `size` is provided,the sample data from all traces is - combined to determine `size` as described above. - start - Sets the starting value for the x axis bins. Defaults - to the minimum data value, shifted down if necessary to - make nice round values and to remove ambiguous bin - edges. For example, if most of the data is integers we - shift the bin edges 0.5 down, so a `size` of 5 would - have a default `start` of -0.5, so it is clear that 0-4 - are in the first bin, 5-9 in the second, but continuous - data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date - string. For category data, `start` is based on the - category serial numbers, and defaults to -0.5. If - multiple non-overlaying histograms share a subplot, the - first explicit `start` is used exactly and all others - are shifted down (if necessary) to differ from that one - by an integer number of bins. - """ - - def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): - """ - Construct a new XBins object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.XBins - end - Sets the end value for the x axis bins. The last bin - may not end exactly at this value, we increment the bin - edge by `size` from `start` until we reach or exceed - `end`. Defaults to the maximum data value. Like - `start`, for dates use a date string, and for category - data `end` is based on the category serial numbers. - size - Sets the size of each x axis bin. Default behavior: If - `nbinsx` is 0 or omitted, we choose a nice round bin - size such that the number of bins is about the same as - the typical number of samples in each bin. If `nbinsx` - is provided, we choose a nice round bin size giving no - more than that many bins. For date data, use - milliseconds or "M" for months, as in `axis.dtick`. - For category data, the number of categories to bin - together (always defaults to 1). If multiple non- - overlaying histograms share a subplot, the first - explicit `size` is used and all others discarded. If no - `size` is provided,the sample data from all traces is - combined to determine `size` as described above. - start - Sets the starting value for the x axis bins. Defaults - to the minimum data value, shifted down if necessary to - make nice round values and to remove ambiguous bin - edges. For example, if most of the data is integers we - shift the bin edges 0.5 down, so a `size` of 5 would - have a default `start` of -0.5, so it is clear that 0-4 - are in the first bin, 5-9 in the second, but continuous - data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date - string. For category data, `start` is based on the - category serial numbers, and defaults to -0.5. If - multiple non-overlaying histograms share a subplot, the - first explicit `start` is used exactly and all others - are shifted down (if necessary) to differ from that one - by an integer number of bins. - - Returns - ------- - XBins - """ - super(XBins, self).__init__('xbins') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.XBins -constructor must be a dict or -an instance of plotly.graph_objs.histogram.XBins""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram import (xbins as v_xbins) - - # Initialize validators - # --------------------- - self._validators['end'] = v_xbins.EndValidator() - self._validators['size'] = v_xbins.SizeValidator() - self._validators['start'] = v_xbins.StartValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('end', None) - self['end'] = end if end is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('start', None) - self['start'] = start if start is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/_ybins.py b/plotly/graph_objs/histogram/_ybins.py deleted file mode 100644 index 6e1a83e8a6d..00000000000 --- a/plotly/graph_objs/histogram/_ybins.py +++ /dev/null @@ -1,240 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class YBins(BaseTraceHierarchyType): - - # end - # --- - @property - def end(self): - """ - Sets the end value for the y axis bins. The last bin may not - end exactly at this value, we increment the bin edge by `size` - from `start` until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use a date string, - and for category data `end` is based on the category serial - numbers. - - The 'end' property accepts values of any type - - Returns - ------- - Any - """ - return self['end'] - - @end.setter - def end(self, val): - self['end'] = val - - # size - # ---- - @property - def size(self): - """ - Sets the size of each y axis bin. Default behavior: If `nbinsy` - is 0 or omitted, we choose a nice round bin size such that the - number of bins is about the same as the typical number of - samples in each bin. If `nbinsy` is provided, we choose a nice - round bin size giving no more than that many bins. For date - data, use milliseconds or "M" for months, as in - `axis.dtick`. For category data, the number of categories to - bin together (always defaults to 1). If multiple non-overlaying - histograms share a subplot, the first explicit `size` is used - and all others discarded. If no `size` is provided,the sample - data from all traces is combined to determine `size` as - described above. - - The 'size' property accepts values of any type - - Returns - ------- - Any - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # start - # ----- - @property - def start(self): - """ - Sets the starting value for the y axis bins. Defaults to the - minimum data value, shifted down if necessary to make nice - round values and to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin edges 0.5 down, - so a `size` of 5 would have a default `start` of -0.5, so it is - clear that 0-4 are in the first bin, 5-9 in the second, but - continuous data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date string. - For category data, `start` is based on the category serial - numbers, and defaults to -0.5. If multiple non-overlaying - histograms share a subplot, the first explicit `start` is used - exactly and all others are shifted down (if necessary) to - differ from that one by an integer number of bins. - - The 'start' property accepts values of any type - - Returns - ------- - Any - """ - return self['start'] - - @start.setter - def start(self, val): - self['start'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - end - Sets the end value for the y axis bins. The last bin - may not end exactly at this value, we increment the bin - edge by `size` from `start` until we reach or exceed - `end`. Defaults to the maximum data value. Like - `start`, for dates use a date string, and for category - data `end` is based on the category serial numbers. - size - Sets the size of each y axis bin. Default behavior: If - `nbinsy` is 0 or omitted, we choose a nice round bin - size such that the number of bins is about the same as - the typical number of samples in each bin. If `nbinsy` - is provided, we choose a nice round bin size giving no - more than that many bins. For date data, use - milliseconds or "M" for months, as in `axis.dtick`. - For category data, the number of categories to bin - together (always defaults to 1). If multiple non- - overlaying histograms share a subplot, the first - explicit `size` is used and all others discarded. If no - `size` is provided,the sample data from all traces is - combined to determine `size` as described above. - start - Sets the starting value for the y axis bins. Defaults - to the minimum data value, shifted down if necessary to - make nice round values and to remove ambiguous bin - edges. For example, if most of the data is integers we - shift the bin edges 0.5 down, so a `size` of 5 would - have a default `start` of -0.5, so it is clear that 0-4 - are in the first bin, 5-9 in the second, but continuous - data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date - string. For category data, `start` is based on the - category serial numbers, and defaults to -0.5. If - multiple non-overlaying histograms share a subplot, the - first explicit `start` is used exactly and all others - are shifted down (if necessary) to differ from that one - by an integer number of bins. - """ - - def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): - """ - Construct a new YBins object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.YBins - end - Sets the end value for the y axis bins. The last bin - may not end exactly at this value, we increment the bin - edge by `size` from `start` until we reach or exceed - `end`. Defaults to the maximum data value. Like - `start`, for dates use a date string, and for category - data `end` is based on the category serial numbers. - size - Sets the size of each y axis bin. Default behavior: If - `nbinsy` is 0 or omitted, we choose a nice round bin - size such that the number of bins is about the same as - the typical number of samples in each bin. If `nbinsy` - is provided, we choose a nice round bin size giving no - more than that many bins. For date data, use - milliseconds or "M" for months, as in `axis.dtick`. - For category data, the number of categories to bin - together (always defaults to 1). If multiple non- - overlaying histograms share a subplot, the first - explicit `size` is used and all others discarded. If no - `size` is provided,the sample data from all traces is - combined to determine `size` as described above. - start - Sets the starting value for the y axis bins. Defaults - to the minimum data value, shifted down if necessary to - make nice round values and to remove ambiguous bin - edges. For example, if most of the data is integers we - shift the bin edges 0.5 down, so a `size` of 5 would - have a default `start` of -0.5, so it is clear that 0-4 - are in the first bin, 5-9 in the second, but continuous - data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date - string. For category data, `start` is based on the - category serial numbers, and defaults to -0.5. If - multiple non-overlaying histograms share a subplot, the - first explicit `start` is used exactly and all others - are shifted down (if necessary) to differ from that one - by an integer number of bins. - - Returns - ------- - YBins - """ - super(YBins, self).__init__('ybins') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.YBins -constructor must be a dict or -an instance of plotly.graph_objs.histogram.YBins""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram import (ybins as v_ybins) - - # Initialize validators - # --------------------- - self._validators['end'] = v_ybins.EndValidator() - self._validators['size'] = v_ybins.SizeValidator() - self._validators['start'] = v_ybins.StartValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('end', None) - self['end'] = end if end is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('start', None) - self['start'] = start if start is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/hoverlabel/__init__.py b/plotly/graph_objs/histogram/hoverlabel/__init__.py index c37b8b5cd28..4341c54f649 100644 --- a/plotly/graph_objs/histogram/hoverlabel/__init__.py +++ b/plotly/graph_objs/histogram/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.histogram.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/hoverlabel/_font.py b/plotly/graph_objs/histogram/hoverlabel/_font.py deleted file mode 100644 index 0fb33755f0e..00000000000 --- a/plotly/graph_objs/histogram/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.histogram.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/marker/__init__.py b/plotly/graph_objs/histogram/marker/__init__.py index 3c2c7eac9b8..62fb583d132 100644 --- a/plotly/graph_objs/histogram/marker/__init__.py +++ b/plotly/graph_objs/histogram/marker/__init__.py @@ -1,3 +1,2446 @@ -from ._line import Line -from ._colorbar import ColorBar + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + 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) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color`is + 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 + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarker.linecolor. It accepts either a specific color or + an array of numbers that are mapped to the colorscale relative + to the max and min values of the array or relative to + `marker.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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to histogram.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized value + to an rgb, rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and highest (1) values + are required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color`is set to a numerical array. If true, + `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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram.marker.Line + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.marker.Line +constructor must be a dict or +an instance of plotly.graph_objs.histogram.marker.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram.marker import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() + self._validators['cauto'] = v_line.CautoValidator() + self._validators['cmax'] = v_line.CmaxValidator() + self._validators['cmid'] = v_line.CmidValidator() + self._validators['cmin'] = v_line.CminValidator() + self._validators['color'] = v_line.ColorValidator() + self._validators['colorscale'] = v_line.ColorscaleValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['reversescale'] = v_line.ReversescaleValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.histogram.marker.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.histogram.marker.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.histogram.mark + 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 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 + ------- + plotly.graph_objs.histogram.marker.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.histogram.marker.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use histogram.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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use histogram.marker.colorbar.title.side + instead. Determines the location of color bar's title with + respect to the color bar. Note that the title's location used + to be set by the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.histogram.marker.colorbar.Tickformats + top instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.histog + ram.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + histogram.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.histogram.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + histogram.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. + titleside + Deprecated: Please use + histogram.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram.marker.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.histogram.marker.colorbar.Tickformats + top instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.histog + ram.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + histogram.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.histogram.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + histogram.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. + titleside + Deprecated: Please use + histogram.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.marker.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.histogram.marker.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram.marker import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.histogram.marker import colorbar diff --git a/plotly/graph_objs/histogram/marker/_colorbar.py b/plotly/graph_objs/histogram/marker/_colorbar.py deleted file mode 100644 index 01b600f64ed..00000000000 --- a/plotly/graph_objs/histogram/marker/_colorbar.py +++ /dev/null @@ -1,1867 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.histogram.marker.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.histogram.marker.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.histogram.mark - 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 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 - ------- - plotly.graph_objs.histogram.marker.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.histogram.marker.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use histogram.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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use histogram.marker.colorbar.title.side - instead. Determines the location of color bar's title with - respect to the color bar. Note that the title's location used - to be set by the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.histogram.marker.colorbar.Tickformats - top instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.histog - ram.marker.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - histogram.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.histogram.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - histogram.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. - titleside - Deprecated: Please use - histogram.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram.marker.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.histogram.marker.colorbar.Tickformats - top instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.histog - ram.marker.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - histogram.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.histogram.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - histogram.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. - titleside - Deprecated: Please use - histogram.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.marker.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.histogram.marker.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram.marker import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/marker/_line.py b/plotly/graph_objs/histogram/marker/_line.py deleted file mode 100644 index 798b704dbcc..00000000000 --- a/plotly/graph_objs/histogram/marker/_line.py +++ /dev/null @@ -1,572 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is true, the - default palette will be chosen according to whether numbers in - the `color` array are all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.line.color`) or the - bounds set in `marker.line.cmin` and `marker.line.cmax` Has an - 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) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be equidistant - to this point. Has an effect only if in `marker.line.color`is - 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 - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarker.linecolor. It accepts either a specific color or - an array of numbers that are mapped to the colorscale relative - to the max and min values of the array or relative to - `marker.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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to histogram.marker.line.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized value - to an rgb, rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and highest (1) values - are required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the colorscale in - color space, use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.line.color`is set to a numerical array. If true, - `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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorscale=None, - colorsrc=None, - reversescale=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.marker.Line - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.marker.Line -constructor must be a dict or -an instance of plotly.graph_objs.histogram.marker.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram.marker import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() - self._validators['cauto'] = v_line.CautoValidator() - self._validators['cmax'] = v_line.CmaxValidator() - self._validators['cmid'] = v_line.CmidValidator() - self._validators['cmin'] = v_line.CminValidator() - self._validators['color'] = v_line.ColorValidator() - self._validators['colorscale'] = v_line.ColorscaleValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['reversescale'] = v_line.ReversescaleValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/marker/colorbar/__init__.py b/plotly/graph_objs/histogram/marker/colorbar/__init__.py index 48ce9f0eadd..4677f34798b 100644 --- a/plotly/graph_objs/histogram/marker/colorbar/__init__.py +++ b/plotly/graph_objs/histogram/marker/colorbar/__init__.py @@ -1,4 +1,725 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.histogram.marker.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram.marker.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.marker.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.histogram.marker.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram.marker.colorbar import ( + title as v_title + ) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram.marker.color + bar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.histogram.marker.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram.marker.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram.marker.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.marker.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.histogram.marker.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram.marker.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.histogram.marker.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/histogram/marker/colorbar/_tickfont.py b/plotly/graph_objs/histogram/marker/colorbar/_tickfont.py deleted file mode 100644 index 5123e405cd1..00000000000 --- a/plotly/graph_objs/histogram/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram.marker.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.marker.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.histogram.marker.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram.marker.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py deleted file mode 100644 index fabf3fde128..00000000000 --- a/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram.marker.color - bar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.marker.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.histogram.marker.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram.marker.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/marker/colorbar/_title.py b/plotly/graph_objs/histogram/marker/colorbar/_title.py deleted file mode 100644 index b9ecbbab7c1..00000000000 --- a/plotly/graph_objs/histogram/marker/colorbar/_title.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.histogram.marker.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram.marker.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.marker.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.histogram.marker.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram.marker.colorbar import ( - title as v_title - ) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/marker/colorbar/title/__init__.py b/plotly/graph_objs/histogram/marker/colorbar/title/__init__.py index c37b8b5cd28..253bda34afc 100644 --- a/plotly/graph_objs/histogram/marker/colorbar/title/__init__.py +++ b/plotly/graph_objs/histogram/marker/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram.marker.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram.marker.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.marker.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.histogram.marker.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram.marker.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/marker/colorbar/title/_font.py b/plotly/graph_objs/histogram/marker/colorbar/title/_font.py deleted file mode 100644 index d2ca8855bf5..00000000000 --- a/plotly/graph_objs/histogram/marker/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram.marker.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram.marker.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.marker.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.histogram.marker.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram.marker.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/selected/__init__.py b/plotly/graph_objs/histogram/selected/__init__.py index adba53218ca..881f1e25b20 100644 --- a/plotly/graph_objs/histogram/selected/__init__.py +++ b/plotly/graph_objs/histogram/selected/__init__.py @@ -1,2 +1,311 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram.selected.Textfont + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.selected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.histogram.selected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram.selected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram.selected.Marker + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.selected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.histogram.selected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram.selected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/selected/_marker.py b/plotly/graph_objs/histogram/selected/_marker.py deleted file mode 100644 index cf31ca716c6..00000000000 --- a/plotly/graph_objs/histogram/selected/_marker.py +++ /dev/null @@ -1,166 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - """ - - def __init__(self, arg=None, color=None, opacity=None, **kwargs): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram.selected.Marker - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.selected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.histogram.selected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram.selected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/selected/_textfont.py b/plotly/graph_objs/histogram/selected/_textfont.py deleted file mode 100644 index 73072f42f36..00000000000 --- a/plotly/graph_objs/histogram/selected/_textfont.py +++ /dev/null @@ -1,141 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of selected points. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram.selected.Textfont - color - Sets the text font color of selected points. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.selected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.histogram.selected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram.selected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/unselected/__init__.py b/plotly/graph_objs/histogram/unselected/__init__.py index adba53218ca..fed743532bc 100644 --- a/plotly/graph_objs/histogram/unselected/__init__.py +++ b/plotly/graph_objs/histogram/unselected/__init__.py @@ -1,2 +1,320 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram.unselected.Textfont + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.unselected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.histogram.unselected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram.unselected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram.unselected.Marker + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram.unselected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.histogram.unselected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram.unselected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/unselected/_marker.py b/plotly/graph_objs/histogram/unselected/_marker.py deleted file mode 100644 index 84ce6792527..00000000000 --- a/plotly/graph_objs/histogram/unselected/_marker.py +++ /dev/null @@ -1,172 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - """ - - def __init__(self, arg=None, color=None, opacity=None, **kwargs): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram.unselected.Marker - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.unselected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.histogram.unselected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram.unselected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram/unselected/_textfont.py b/plotly/graph_objs/histogram/unselected/_textfont.py deleted file mode 100644 index 43f2e7b9465..00000000000 --- a/plotly/graph_objs/histogram/unselected/_textfont.py +++ /dev/null @@ -1,144 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of unselected points, applied - only when a selection exists. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram.unselected.Textfont - color - Sets the text font color of unselected points, applied - only when a selection exists. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram.unselected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.histogram.unselected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram.unselected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2d/__init__.py b/plotly/graph_objs/histogram2d/__init__.py index 8bb12d1ad6d..565bc69573b 100644 --- a/plotly/graph_objs/histogram2d/__init__.py +++ b/plotly/graph_objs/histogram2d/__init__.py @@ -1,8 +1,2992 @@ -from ._ybins import YBins -from ._xbins import XBins -from ._stream import Stream -from ._marker import Marker -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class YBins(_BaseTraceHierarchyType): + + # end + # --- + @property + def end(self): + """ + Sets the end value for the y axis bins. The last bin may not + end exactly at this value, we increment the bin edge by `size` + from `start` until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use a date string, + and for category data `end` is based on the category serial + numbers. + + The 'end' property accepts values of any type + + Returns + ------- + Any + """ + return self['end'] + + @end.setter + def end(self, val): + self['end'] = val + + # size + # ---- + @property + def size(self): + """ + Sets the size of each y axis bin. Default behavior: If `nbinsy` + is 0 or omitted, we choose a nice round bin size such that the + number of bins is about the same as the typical number of + samples in each bin. If `nbinsy` is provided, we choose a nice + round bin size giving no more than that many bins. For date + data, use milliseconds or "M" 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 + ------- + Any + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # start + # ----- + @property + def start(self): + """ + Sets the starting value for the y axis bins. Defaults to the + minimum data value, shifted down if necessary to make nice + round values and to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin edges 0.5 down, + so a `size` of 5 would have a default `start` of -0.5, so it is + clear that 0-4 are in the first bin, 5-9 in the second, but + continuous data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date string. + For category data, `start` is based on the category serial + numbers, and defaults to -0.5. + + The 'start' property accepts values of any type + + Returns + ------- + Any + """ + return self['start'] + + @start.setter + def start(self, val): + self['start'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + end + Sets the end value for the y axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each y axis bin. Default behavior: If + `nbinsy` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsy` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). + start + Sets the starting value for the y axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. + """ + + def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): + """ + Construct a new YBins object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram2d.YBins + end + Sets the end value for the y axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each y axis bin. Default behavior: If + `nbinsy` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsy` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). + start + Sets the starting value for the y axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. + + Returns + ------- + YBins + """ + super(YBins, self).__init__('ybins') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2d.YBins +constructor must be a dict or +an instance of plotly.graph_objs.histogram2d.YBins""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2d import (ybins as v_ybins) + + # Initialize validators + # --------------------- + self._validators['end'] = v_ybins.EndValidator() + self._validators['size'] = v_ybins.SizeValidator() + self._validators['start'] = v_ybins.StartValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('end', None) + self['end'] = end if end is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('start', None) + self['start'] = start if start is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class XBins(_BaseTraceHierarchyType): + + # end + # --- + @property + def end(self): + """ + Sets the end value for the x axis bins. The last bin may not + end exactly at this value, we increment the bin edge by `size` + from `start` until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use a date string, + and for category data `end` is based on the category serial + numbers. + + The 'end' property accepts values of any type + + Returns + ------- + Any + """ + return self['end'] + + @end.setter + def end(self, val): + self['end'] = val + + # size + # ---- + @property + def size(self): + """ + Sets the size of each x axis bin. Default behavior: If `nbinsx` + is 0 or omitted, we choose a nice round bin size such that the + number of bins is about the same as the typical number of + samples in each bin. If `nbinsx` is provided, we choose a nice + round bin size giving no more than that many bins. For date + data, use milliseconds or "M" 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 + ------- + Any + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # start + # ----- + @property + def start(self): + """ + Sets the starting value for the x axis bins. Defaults to the + minimum data value, shifted down if necessary to make nice + round values and to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin edges 0.5 down, + so a `size` of 5 would have a default `start` of -0.5, so it is + clear that 0-4 are in the first bin, 5-9 in the second, but + continuous data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date string. + For category data, `start` is based on the category serial + numbers, and defaults to -0.5. + + The 'start' property accepts values of any type + + Returns + ------- + Any + """ + return self['start'] + + @start.setter + def start(self, val): + self['start'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + end + Sets the end value for the x axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each x axis bin. Default behavior: If + `nbinsx` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsx` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). + start + Sets the starting value for the x axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. + """ + + def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): + """ + Construct a new XBins object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram2d.XBins + end + Sets the end value for the x axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each x axis bin. Default behavior: If + `nbinsx` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsx` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). + start + Sets the starting value for the x axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. + + Returns + ------- + XBins + """ + super(XBins, self).__init__('xbins') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2d.XBins +constructor must be a dict or +an instance of plotly.graph_objs.histogram2d.XBins""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2d import (xbins as v_xbins) + + # Initialize validators + # --------------------- + self._validators['end'] = v_xbins.EndValidator() + self._validators['size'] = v_xbins.SizeValidator() + self._validators['start'] = v_xbins.StartValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('end', None) + self['end'] = end if end is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('start', None) + self['start'] = start if start is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram2d.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2d.Stream +constructor must be a dict or +an instance of plotly.graph_objs.histogram2d.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2d import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the aggregation data. + colorsrc + Sets the source reference on plot.ly for color . + """ + + def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram2d.Marker + color + Sets the aggregation data. + colorsrc + Sets the source reference on plot.ly for color . + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2d.Marker +constructor must be a dict or +an instance of plotly.graph_objs.histogram2d.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2d import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['colorsrc'] = v_marker.ColorsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.histogram2d.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram2d.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2d.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.histogram2d.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2d import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.histogram2d.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.histogram2d.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.histogram2d.co + 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 plotly.graph_objs.histogram2d.colorbar.Tickformatstop + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.histogram2d.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.histogram2d.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use histogram2d.colorbar.title.side instead. + Determines the location of color bar's title with respect to + the color bar. Note that the title's location used to be set by + the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.histogram2d.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.histog + ram2d.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + histogram2d.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.histogram2d.colorbar.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use histogram2d.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use histogram2d.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram2d.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.histogram2d.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.histog + ram2d.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + histogram2d.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.histogram2d.colorbar.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use histogram2d.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use histogram2d.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2d.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.histogram2d.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2d import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.histogram2d import hoverlabel -from ._colorbar import ColorBar from plotly.graph_objs.histogram2d import colorbar diff --git a/plotly/graph_objs/histogram2d/_colorbar.py b/plotly/graph_objs/histogram2d/_colorbar.py deleted file mode 100644 index 6a63f2efa7a..00000000000 --- a/plotly/graph_objs/histogram2d/_colorbar.py +++ /dev/null @@ -1,1863 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.histogram2d.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.histogram2d.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.histogram2d.co - 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 plotly.graph_objs.histogram2d.colorbar.Tickformatstop - - A dict of string/value properties that will be passed - to the Tickformatstop constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.histogram2d.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.histogram2d.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use histogram2d.colorbar.title.side instead. - Determines the location of color bar's title with respect to - the color bar. Note that the title's location used to be set by - the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.histogram2d.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.histog - ram2d.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - histogram2d.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.histogram2d.colorbar.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use histogram2d.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use histogram2d.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram2d.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.histogram2d.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.histog - ram2d.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - histogram2d.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.histogram2d.colorbar.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use histogram2d.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use histogram2d.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2d.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2d import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2d/_hoverlabel.py b/plotly/graph_objs/histogram2d/_hoverlabel.py deleted file mode 100644 index 9dc107964dd..00000000000 --- a/plotly/graph_objs/histogram2d/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.histogram2d.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram2d.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2d.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2d import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2d/_marker.py b/plotly/graph_objs/histogram2d/_marker.py deleted file mode 100644 index c49327981dc..00000000000 --- a/plotly/graph_objs/histogram2d/_marker.py +++ /dev/null @@ -1,126 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the aggregation data. - colorsrc - Sets the source reference on plot.ly for color . - """ - - def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram2d.Marker - color - Sets the aggregation data. - colorsrc - Sets the source reference on plot.ly for color . - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2d.Marker -constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2d import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['colorsrc'] = v_marker.ColorsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2d/_stream.py b/plotly/graph_objs/histogram2d/_stream.py deleted file mode 100644 index cffd916205f..00000000000 --- a/plotly/graph_objs/histogram2d/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram2d.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2d.Stream -constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2d import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2d/_xbins.py b/plotly/graph_objs/histogram2d/_xbins.py deleted file mode 100644 index 7c8e8c4b9e9..00000000000 --- a/plotly/graph_objs/histogram2d/_xbins.py +++ /dev/null @@ -1,217 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class XBins(BaseTraceHierarchyType): - - # end - # --- - @property - def end(self): - """ - Sets the end value for the x axis bins. The last bin may not - end exactly at this value, we increment the bin edge by `size` - from `start` until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use a date string, - and for category data `end` is based on the category serial - numbers. - - The 'end' property accepts values of any type - - Returns - ------- - Any - """ - return self['end'] - - @end.setter - def end(self, val): - self['end'] = val - - # size - # ---- - @property - def size(self): - """ - Sets the size of each x axis bin. Default behavior: If `nbinsx` - is 0 or omitted, we choose a nice round bin size such that the - number of bins is about the same as the typical number of - samples in each bin. If `nbinsx` is provided, we choose a nice - round bin size giving no more than that many bins. For date - data, use milliseconds or "M" 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 - ------- - Any - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # start - # ----- - @property - def start(self): - """ - Sets the starting value for the x axis bins. Defaults to the - minimum data value, shifted down if necessary to make nice - round values and to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin edges 0.5 down, - so a `size` of 5 would have a default `start` of -0.5, so it is - clear that 0-4 are in the first bin, 5-9 in the second, but - continuous data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date string. - For category data, `start` is based on the category serial - numbers, and defaults to -0.5. - - The 'start' property accepts values of any type - - Returns - ------- - Any - """ - return self['start'] - - @start.setter - def start(self, val): - self['start'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - end - Sets the end value for the x axis bins. The last bin - may not end exactly at this value, we increment the bin - edge by `size` from `start` until we reach or exceed - `end`. Defaults to the maximum data value. Like - `start`, for dates use a date string, and for category - data `end` is based on the category serial numbers. - size - Sets the size of each x axis bin. Default behavior: If - `nbinsx` is 0 or omitted, we choose a nice round bin - size such that the number of bins is about the same as - the typical number of samples in each bin. If `nbinsx` - is provided, we choose a nice round bin size giving no - more than that many bins. For date data, use - milliseconds or "M" for months, as in `axis.dtick`. - For category data, the number of categories to bin - together (always defaults to 1). - start - Sets the starting value for the x axis bins. Defaults - to the minimum data value, shifted down if necessary to - make nice round values and to remove ambiguous bin - edges. For example, if most of the data is integers we - shift the bin edges 0.5 down, so a `size` of 5 would - have a default `start` of -0.5, so it is clear that 0-4 - are in the first bin, 5-9 in the second, but continuous - data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date - string. For category data, `start` is based on the - category serial numbers, and defaults to -0.5. - """ - - def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): - """ - Construct a new XBins object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram2d.XBins - end - Sets the end value for the x axis bins. The last bin - may not end exactly at this value, we increment the bin - edge by `size` from `start` until we reach or exceed - `end`. Defaults to the maximum data value. Like - `start`, for dates use a date string, and for category - data `end` is based on the category serial numbers. - size - Sets the size of each x axis bin. Default behavior: If - `nbinsx` is 0 or omitted, we choose a nice round bin - size such that the number of bins is about the same as - the typical number of samples in each bin. If `nbinsx` - is provided, we choose a nice round bin size giving no - more than that many bins. For date data, use - milliseconds or "M" for months, as in `axis.dtick`. - For category data, the number of categories to bin - together (always defaults to 1). - start - Sets the starting value for the x axis bins. Defaults - to the minimum data value, shifted down if necessary to - make nice round values and to remove ambiguous bin - edges. For example, if most of the data is integers we - shift the bin edges 0.5 down, so a `size` of 5 would - have a default `start` of -0.5, so it is clear that 0-4 - are in the first bin, 5-9 in the second, but continuous - data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date - string. For category data, `start` is based on the - category serial numbers, and defaults to -0.5. - - Returns - ------- - XBins - """ - super(XBins, self).__init__('xbins') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2d.XBins -constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.XBins""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2d import (xbins as v_xbins) - - # Initialize validators - # --------------------- - self._validators['end'] = v_xbins.EndValidator() - self._validators['size'] = v_xbins.SizeValidator() - self._validators['start'] = v_xbins.StartValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('end', None) - self['end'] = end if end is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('start', None) - self['start'] = start if start is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2d/_ybins.py b/plotly/graph_objs/histogram2d/_ybins.py deleted file mode 100644 index f86f69b2f6d..00000000000 --- a/plotly/graph_objs/histogram2d/_ybins.py +++ /dev/null @@ -1,217 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class YBins(BaseTraceHierarchyType): - - # end - # --- - @property - def end(self): - """ - Sets the end value for the y axis bins. The last bin may not - end exactly at this value, we increment the bin edge by `size` - from `start` until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use a date string, - and for category data `end` is based on the category serial - numbers. - - The 'end' property accepts values of any type - - Returns - ------- - Any - """ - return self['end'] - - @end.setter - def end(self, val): - self['end'] = val - - # size - # ---- - @property - def size(self): - """ - Sets the size of each y axis bin. Default behavior: If `nbinsy` - is 0 or omitted, we choose a nice round bin size such that the - number of bins is about the same as the typical number of - samples in each bin. If `nbinsy` is provided, we choose a nice - round bin size giving no more than that many bins. For date - data, use milliseconds or "M" 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 - ------- - Any - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # start - # ----- - @property - def start(self): - """ - Sets the starting value for the y axis bins. Defaults to the - minimum data value, shifted down if necessary to make nice - round values and to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin edges 0.5 down, - so a `size` of 5 would have a default `start` of -0.5, so it is - clear that 0-4 are in the first bin, 5-9 in the second, but - continuous data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date string. - For category data, `start` is based on the category serial - numbers, and defaults to -0.5. - - The 'start' property accepts values of any type - - Returns - ------- - Any - """ - return self['start'] - - @start.setter - def start(self, val): - self['start'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - end - Sets the end value for the y axis bins. The last bin - may not end exactly at this value, we increment the bin - edge by `size` from `start` until we reach or exceed - `end`. Defaults to the maximum data value. Like - `start`, for dates use a date string, and for category - data `end` is based on the category serial numbers. - size - Sets the size of each y axis bin. Default behavior: If - `nbinsy` is 0 or omitted, we choose a nice round bin - size such that the number of bins is about the same as - the typical number of samples in each bin. If `nbinsy` - is provided, we choose a nice round bin size giving no - more than that many bins. For date data, use - milliseconds or "M" for months, as in `axis.dtick`. - For category data, the number of categories to bin - together (always defaults to 1). - start - Sets the starting value for the y axis bins. Defaults - to the minimum data value, shifted down if necessary to - make nice round values and to remove ambiguous bin - edges. For example, if most of the data is integers we - shift the bin edges 0.5 down, so a `size` of 5 would - have a default `start` of -0.5, so it is clear that 0-4 - are in the first bin, 5-9 in the second, but continuous - data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date - string. For category data, `start` is based on the - category serial numbers, and defaults to -0.5. - """ - - def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): - """ - Construct a new YBins object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram2d.YBins - end - Sets the end value for the y axis bins. The last bin - may not end exactly at this value, we increment the bin - edge by `size` from `start` until we reach or exceed - `end`. Defaults to the maximum data value. Like - `start`, for dates use a date string, and for category - data `end` is based on the category serial numbers. - size - Sets the size of each y axis bin. Default behavior: If - `nbinsy` is 0 or omitted, we choose a nice round bin - size such that the number of bins is about the same as - the typical number of samples in each bin. If `nbinsy` - is provided, we choose a nice round bin size giving no - more than that many bins. For date data, use - milliseconds or "M" for months, as in `axis.dtick`. - For category data, the number of categories to bin - together (always defaults to 1). - start - Sets the starting value for the y axis bins. Defaults - to the minimum data value, shifted down if necessary to - make nice round values and to remove ambiguous bin - edges. For example, if most of the data is integers we - shift the bin edges 0.5 down, so a `size` of 5 would - have a default `start` of -0.5, so it is clear that 0-4 - are in the first bin, 5-9 in the second, but continuous - data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date - string. For category data, `start` is based on the - category serial numbers, and defaults to -0.5. - - Returns - ------- - YBins - """ - super(YBins, self).__init__('ybins') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2d.YBins -constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.YBins""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2d import (ybins as v_ybins) - - # Initialize validators - # --------------------- - self._validators['end'] = v_ybins.EndValidator() - self._validators['size'] = v_ybins.SizeValidator() - self._validators['start'] = v_ybins.StartValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('end', None) - self['end'] = end if end is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('start', None) - self['start'] = start if start is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2d/colorbar/__init__.py b/plotly/graph_objs/histogram2d/colorbar/__init__.py index 3dac0b92612..62ae35a8672 100644 --- a/plotly/graph_objs/histogram2d/colorbar/__init__.py +++ b/plotly/graph_objs/histogram2d/colorbar/__init__.py @@ -1,4 +1,723 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.histogram2d.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2d.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2d.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2d.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.histogram2d.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2d.colorbar import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2d.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2d.colorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2d.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.histogram2d.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2d.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2d.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2d.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2d.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.histogram2d.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2d.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.histogram2d.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/histogram2d/colorbar/_tickfont.py b/plotly/graph_objs/histogram2d/colorbar/_tickfont.py deleted file mode 100644 index 6c1da913b48..00000000000 --- a/plotly/graph_objs/histogram2d/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2d.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2d.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2d.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2d.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py b/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py deleted file mode 100644 index 431f2ed61e0..00000000000 --- a/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2d.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2d.colorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2d.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2d.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2d/colorbar/_title.py b/plotly/graph_objs/histogram2d/colorbar/_title.py deleted file mode 100644 index d988add47fe..00000000000 --- a/plotly/graph_objs/histogram2d/colorbar/_title.py +++ /dev/null @@ -1,202 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.histogram2d.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2d.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2d.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2d.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2d.colorbar import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2d/colorbar/title/__init__.py b/plotly/graph_objs/histogram2d/colorbar/title/__init__.py index c37b8b5cd28..e2eb2849562 100644 --- a/plotly/graph_objs/histogram2d/colorbar/title/__init__.py +++ b/plotly/graph_objs/histogram2d/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2d.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2d.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2d.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.histogram2d.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2d.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2d/colorbar/title/_font.py b/plotly/graph_objs/histogram2d/colorbar/title/_font.py deleted file mode 100644 index 90e4d4c494d..00000000000 --- a/plotly/graph_objs/histogram2d/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2d.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2d.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2d.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2d.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2d/hoverlabel/__init__.py b/plotly/graph_objs/histogram2d/hoverlabel/__init__.py index c37b8b5cd28..baff5de899d 100644 --- a/plotly/graph_objs/histogram2d/hoverlabel/__init__.py +++ b/plotly/graph_objs/histogram2d/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2d.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2d.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2d.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.histogram2d.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2d.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2d/hoverlabel/_font.py b/plotly/graph_objs/histogram2d/hoverlabel/_font.py deleted file mode 100644 index e48e88f95e3..00000000000 --- a/plotly/graph_objs/histogram2d/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2d.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2d.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2d.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.histogram2d.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2d.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/__init__.py b/plotly/graph_objs/histogram2dcontour/__init__.py index 3cfeee14b4b..c2a7a2bb786 100644 --- a/plotly/graph_objs/histogram2dcontour/__init__.py +++ b/plotly/graph_objs/histogram2dcontour/__init__.py @@ -1,11 +1,3768 @@ -from ._ybins import YBins -from ._xbins import XBins -from ._stream import Stream -from ._marker import Marker -from ._line import Line -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class YBins(_BaseTraceHierarchyType): + + # end + # --- + @property + def end(self): + """ + Sets the end value for the y axis bins. The last bin may not + end exactly at this value, we increment the bin edge by `size` + from `start` until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use a date string, + and for category data `end` is based on the category serial + numbers. + + The 'end' property accepts values of any type + + Returns + ------- + Any + """ + return self['end'] + + @end.setter + def end(self, val): + self['end'] = val + + # size + # ---- + @property + def size(self): + """ + Sets the size of each y axis bin. Default behavior: If `nbinsy` + is 0 or omitted, we choose a nice round bin size such that the + number of bins is about the same as the typical number of + samples in each bin. If `nbinsy` is provided, we choose a nice + round bin size giving no more than that many bins. For date + data, use milliseconds or "M" 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 + ------- + Any + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # start + # ----- + @property + def start(self): + """ + Sets the starting value for the y axis bins. Defaults to the + minimum data value, shifted down if necessary to make nice + round values and to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin edges 0.5 down, + so a `size` of 5 would have a default `start` of -0.5, so it is + clear that 0-4 are in the first bin, 5-9 in the second, but + continuous data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date string. + For category data, `start` is based on the category serial + numbers, and defaults to -0.5. + + The 'start' property accepts values of any type + + Returns + ------- + Any + """ + return self['start'] + + @start.setter + def start(self, val): + self['start'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2dcontour' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + end + Sets the end value for the y axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each y axis bin. Default behavior: If + `nbinsy` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsy` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). + start + Sets the starting value for the y axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. + """ + + def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): + """ + Construct a new YBins object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2dcontour.YBins + end + Sets the end value for the y axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each y axis bin. Default behavior: If + `nbinsy` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsy` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). + start + Sets the starting value for the y axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. + + Returns + ------- + YBins + """ + super(YBins, self).__init__('ybins') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2dcontour.YBins +constructor must be a dict or +an instance of plotly.graph_objs.histogram2dcontour.YBins""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2dcontour import (ybins as v_ybins) + + # Initialize validators + # --------------------- + self._validators['end'] = v_ybins.EndValidator() + self._validators['size'] = v_ybins.SizeValidator() + self._validators['start'] = v_ybins.StartValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('end', None) + self['end'] = end if end is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('start', None) + self['start'] = start if start is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class XBins(_BaseTraceHierarchyType): + + # end + # --- + @property + def end(self): + """ + Sets the end value for the x axis bins. The last bin may not + end exactly at this value, we increment the bin edge by `size` + from `start` until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use a date string, + and for category data `end` is based on the category serial + numbers. + + The 'end' property accepts values of any type + + Returns + ------- + Any + """ + return self['end'] + + @end.setter + def end(self, val): + self['end'] = val + + # size + # ---- + @property + def size(self): + """ + Sets the size of each x axis bin. Default behavior: If `nbinsx` + is 0 or omitted, we choose a nice round bin size such that the + number of bins is about the same as the typical number of + samples in each bin. If `nbinsx` is provided, we choose a nice + round bin size giving no more than that many bins. For date + data, use milliseconds or "M" 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 + ------- + Any + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # start + # ----- + @property + def start(self): + """ + Sets the starting value for the x axis bins. Defaults to the + minimum data value, shifted down if necessary to make nice + round values and to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin edges 0.5 down, + so a `size` of 5 would have a default `start` of -0.5, so it is + clear that 0-4 are in the first bin, 5-9 in the second, but + continuous data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date string. + For category data, `start` is based on the category serial + numbers, and defaults to -0.5. + + The 'start' property accepts values of any type + + Returns + ------- + Any + """ + return self['start'] + + @start.setter + def start(self, val): + self['start'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2dcontour' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + end + Sets the end value for the x axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each x axis bin. Default behavior: If + `nbinsx` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsx` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). + start + Sets the starting value for the x axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. + """ + + def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): + """ + Construct a new XBins object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2dcontour.XBins + end + Sets the end value for the x axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each x axis bin. Default behavior: If + `nbinsx` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsx` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). + start + Sets the starting value for the x axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. + + Returns + ------- + XBins + """ + super(XBins, self).__init__('xbins') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2dcontour.XBins +constructor must be a dict or +an instance of plotly.graph_objs.histogram2dcontour.XBins""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2dcontour import (xbins as v_xbins) + + # Initialize validators + # --------------------- + self._validators['end'] = v_xbins.EndValidator() + self._validators['size'] = v_xbins.SizeValidator() + self._validators['start'] = v_xbins.StartValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('end', None) + self['end'] = end if end is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('start', None) + self['start'] = start if start is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2dcontour' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2dcontour.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2dcontour.Stream +constructor must be a dict or +an instance of plotly.graph_objs.histogram2dcontour.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2dcontour import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2dcontour' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the aggregation data. + colorsrc + Sets the source reference on plot.ly for color . + """ + + def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2dcontour.Marker + color + Sets the aggregation data. + colorsrc + Sets the source reference on plot.ly for color . + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2dcontour.Marker +constructor must be a dict or +an instance of plotly.graph_objs.histogram2dcontour.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2dcontour import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['colorsrc'] = v_marker.ColorsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dash + # ---- + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self['dash'] + + @dash.setter + def dash(self, val): + self['dash'] = val + + # smoothing + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['smoothing'] + + @smoothing.setter + def smoothing(self, val): + self['smoothing'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2dcontour' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour level. Has no effect if + `contours.coloring` is set to "lines". + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour lines, + where 0 corresponds to no smoothing. + width + Sets the line width (in px). + """ + + def __init__( + self, + arg=None, + color=None, + dash=None, + smoothing=None, + width=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2dcontour.Line + color + Sets the color of the contour level. Has no effect if + `contours.coloring` is set to "lines". + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour lines, + where 0 corresponds to no smoothing. + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2dcontour.Line +constructor must be a dict or +an instance of plotly.graph_objs.histogram2dcontour.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2dcontour import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['dash'] = v_line.DashValidator() + self._validators['smoothing'] = v_line.SmoothingValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dash', None) + self['dash'] = dash if dash is not None else _v + _v = arg.pop('smoothing', None) + self['smoothing'] = smoothing if smoothing is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.histogram2dcontour.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2dcontour' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2dcontour.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2dcontour.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.histogram2dcontour.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2dcontour import ( + hoverlabel as v_hoverlabel + ) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Contours(_BaseTraceHierarchyType): + + # coloring + # -------- + @property + def coloring(self): + """ + Determines the coloring method showing the contour values. If + "fill", coloring is done evenly between each contour level If + "heatmap", a heatmap gradient coloring is applied between each + contour level. If "lines", coloring is done on the contour + lines. If "none", no coloring is applied on this trace. + + The 'coloring' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fill', 'heatmap', 'lines', 'none'] + + Returns + ------- + Any + """ + return self['coloring'] + + @coloring.setter + def coloring(self, val): + self['coloring'] = val + + # end + # --- + @property + 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 + + Returns + ------- + int|float + """ + return self['end'] + + @end.setter + def end(self, val): + self['end'] = val + + # labelfont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.histogram2dcontour.contours.Labelfont + """ + return self['labelfont'] + + @labelfont.setter + def labelfont(self, val): + self['labelfont'] = val + + # labelformat + # ----------- + @property + def labelformat(self): + """ + Sets the contour label formatting rule using d3 formatting + mini-language which is very similar to Python, see: https://git + hub.com/d3/d3-format/blob/master/README.md#locale_format. + + The 'labelformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['labelformat'] + + @labelformat.setter + def labelformat(self, val): + self['labelformat'] = val + + # operation + # --------- + @property + def operation(self): + """ + Sets the constraint operation. "=" keeps regions equal to + `value` "<" and "<=" keep regions less than `value` ">" and + ">=" keep regions greater than `value` "[]", "()", "[)", and + "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", + "](", ")[" keep regions outside `value[0]` to value[1]` Open + vs. closed intervals make no difference to constraint display, + but all versions are allowed for consistency with filter + transforms. + + The 'operation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', + ')(', '](', ')['] + + Returns + ------- + Any + """ + return self['operation'] + + @operation.setter + def operation(self, val): + self['operation'] = val + + # showlabels + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlabels'] + + @showlabels.setter + def showlabels(self, val): + self['showlabels'] = val + + # showlines + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showlines'] + + @showlines.setter + def showlines(self, val): + self['showlines'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # start + # ----- + @property + 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 + + Returns + ------- + int|float + """ + return self['start'] + + @start.setter + def start(self, val): + self['start'] = val + + # type + # ---- + @property + def type(self): + """ + If `levels`, the data is represented as a contour plot with + multiple levels displayed. If `constraint`, the data is + represented as constraints with the invalid region shaded as + specified by the `operation` and `value` parameters. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['levels', 'constraint'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # value + # ----- + @property + def value(self): + """ + Sets the value or values of the constraint boundary. When + `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of + two numbers where the first is the lower bound and the second + is the upper bound. + + The 'value' property accepts values of any type + + Returns + ------- + Any + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2dcontour' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + coloring + Determines the coloring method showing the contour + values. If "fill", coloring is done evenly between each + contour level If "heatmap", a heatmap gradient coloring + is applied between each contour level. If "lines", + coloring is done on the contour lines. If "none", no + coloring is applied on this trace. + end + Sets the end contour level value. Must be more than + `contours.start` + labelfont + Sets the font used for labeling the contour levels. The + default color comes from the lines, if shown. The + default family and size come from `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-language which is very similar to + Python, see: https://github.com/d3/d3-format/blob/maste + r/README.md#locale_format. + operation + Sets the constraint operation. "=" keeps regions equal + to `value` "<" and "<=" keep regions less than `value` + ">" and ">=" keep regions greater than `value` "[]", + "()", "[)", and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions outside + `value[0]` to value[1]` Open vs. closed intervals make + no difference to constraint display, but all versions + are allowed for consistency with filter transforms. + showlabels + Determines whether to label the contour lines with + their values. + showlines + Determines whether or not the contour lines are drawn. + Has an effect only if `contours.coloring` is set to + "fill". + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + type + If `levels`, the data is represented as a contour plot + with multiple levels displayed. If `constraint`, the + data is represented as constraints with the invalid + region shaded as specified by the `operation` and + `value` parameters. + value + Sets the value or values of the constraint boundary. + When `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an + array of two numbers where the first is the lower bound + and the second is the upper bound. + """ + + def __init__( + self, + arg=None, + coloring=None, + end=None, + labelfont=None, + labelformat=None, + operation=None, + showlabels=None, + showlines=None, + size=None, + start=None, + type=None, + value=None, + **kwargs + ): + """ + Construct a new Contours object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2dcontour.Contours + coloring + Determines the coloring method showing the contour + values. If "fill", coloring is done evenly between each + contour level If "heatmap", a heatmap gradient coloring + is applied between each contour level. If "lines", + coloring is done on the contour lines. If "none", no + coloring is applied on this trace. + end + Sets the end contour level value. Must be more than + `contours.start` + labelfont + Sets the font used for labeling the contour levels. The + default color comes from the lines, if shown. The + default family and size come from `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-language which is very similar to + Python, see: https://github.com/d3/d3-format/blob/maste + r/README.md#locale_format. + operation + Sets the constraint operation. "=" keeps regions equal + to `value` "<" and "<=" keep regions less than `value` + ">" and ">=" keep regions greater than `value` "[]", + "()", "[)", and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions outside + `value[0]` to value[1]` Open vs. closed intervals make + no difference to constraint display, but all versions + are allowed for consistency with filter transforms. + showlabels + Determines whether to label the contour lines with + their values. + showlines + Determines whether or not the contour lines are drawn. + Has an effect only if `contours.coloring` is set to + "fill". + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + type + If `levels`, the data is represented as a contour plot + with multiple levels displayed. If `constraint`, the + data is represented as constraints with the invalid + region shaded as specified by the `operation` and + `value` parameters. + value + Sets the value or values of the constraint boundary. + When `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an + array of two numbers where the first is the lower bound + and the second is the upper bound. + + Returns + ------- + Contours + """ + super(Contours, self).__init__('contours') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2dcontour.Contours +constructor must be a dict or +an instance of plotly.graph_objs.histogram2dcontour.Contours""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2dcontour import ( + contours as v_contours + ) + + # Initialize validators + # --------------------- + self._validators['coloring'] = v_contours.ColoringValidator() + self._validators['end'] = v_contours.EndValidator() + self._validators['labelfont'] = v_contours.LabelfontValidator() + self._validators['labelformat'] = v_contours.LabelformatValidator() + self._validators['operation'] = v_contours.OperationValidator() + self._validators['showlabels'] = v_contours.ShowlabelsValidator() + self._validators['showlines'] = v_contours.ShowlinesValidator() + self._validators['size'] = v_contours.SizeValidator() + self._validators['start'] = v_contours.StartValidator() + self._validators['type'] = v_contours.TypeValidator() + self._validators['value'] = v_contours.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('coloring', None) + self['coloring'] = coloring if coloring is not None else _v + _v = arg.pop('end', None) + self['end'] = end if end is not None else _v + _v = arg.pop('labelfont', None) + self['labelfont'] = labelfont if labelfont is not None else _v + _v = arg.pop('labelformat', None) + self['labelformat'] = labelformat if labelformat is not None else _v + _v = arg.pop('operation', None) + self['operation'] = operation if operation is not None else _v + _v = arg.pop('showlabels', None) + self['showlabels'] = showlabels if showlabels is not None else _v + _v = arg.pop('showlines', None) + self['showlines'] = showlines if showlines is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('start', None) + self['start'] = start if start is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.histogram2dcontour.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.histogram2dcon + 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 plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.histogram2dcontour.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use histogram2dcontour.colorbar.title.font + instead. Sets this color bar's title font. Note that the + title's font used to be set by the now deprecated `titlefont` + attribute. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use histogram2dcontour.colorbar.title.side + instead. Determines the location of color bar's title with + respect to the color bar. Note that the title's location used + to be set by the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2dcontour' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.histogram2dcontour.colorbar.Tickforma + tstop instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.histog + ram2dcontour.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + histogram2dcontour.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.histogram2dcontour.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + histogram2dcontour.colorbar.title.font instead. Sets + this color bar's title font. Note that the title's font + used to be set by the now deprecated `titlefont` + attribute. + titleside + Deprecated: Please use + histogram2dcontour.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2dcontour.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.histogram2dcontour.colorbar.Tickforma + tstop instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.histog + ram2dcontour.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + histogram2dcontour.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.histogram2dcontour.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + histogram2dcontour.colorbar.title.font instead. Sets + this color bar's title font. Note that the title's font + used to be set by the now deprecated `titlefont` + attribute. + titleside + Deprecated: Please use + histogram2dcontour.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2dcontour.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.histogram2dcontour.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2dcontour import ( + colorbar as v_colorbar + ) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.histogram2dcontour import hoverlabel -from ._contours import Contours from plotly.graph_objs.histogram2dcontour import contours -from ._colorbar import ColorBar from plotly.graph_objs.histogram2dcontour import colorbar diff --git a/plotly/graph_objs/histogram2dcontour/_colorbar.py b/plotly/graph_objs/histogram2dcontour/_colorbar.py deleted file mode 100644 index 47135347593..00000000000 --- a/plotly/graph_objs/histogram2dcontour/_colorbar.py +++ /dev/null @@ -1,1871 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.histogram2dcontour.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.histogram2dcon - 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 plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop - - A dict of string/value properties that will be passed - to the Tickformatstop constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.histogram2dcontour.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use histogram2dcontour.colorbar.title.font - instead. Sets this color bar's title font. Note that the - title's font used to be set by the now deprecated `titlefont` - attribute. - - The 'font' property is an instance of Font - that may be specified as: - - An instance of 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use histogram2dcontour.colorbar.title.side - instead. Determines the location of color bar's title with - respect to the color bar. Note that the title's location used - to be set by the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2dcontour' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.histogram2dcontour.colorbar.Tickforma - tstop instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.histog - ram2dcontour.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - histogram2dcontour.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.histogram2dcontour.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - histogram2dcontour.colorbar.title.font instead. Sets - this color bar's title font. Note that the title's font - used to be set by the now deprecated `titlefont` - attribute. - titleside - Deprecated: Please use - histogram2dcontour.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.histogram2dcontour.colorbar.Tickforma - tstop instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.histog - ram2dcontour.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - histogram2dcontour.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.histogram2dcontour.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - histogram2dcontour.colorbar.title.font instead. Sets - this color bar's title font. Note that the title's font - used to be set by the now deprecated `titlefont` - attribute. - titleside - Deprecated: Please use - histogram2dcontour.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2dcontour.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2dcontour import ( - colorbar as v_colorbar - ) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/_contours.py b/plotly/graph_objs/histogram2dcontour/_contours.py deleted file mode 100644 index ba3b28e6086..00000000000 --- a/plotly/graph_objs/histogram2dcontour/_contours.py +++ /dev/null @@ -1,510 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Contours(BaseTraceHierarchyType): - - # coloring - # -------- - @property - def coloring(self): - """ - Determines the coloring method showing the contour values. If - "fill", coloring is done evenly between each contour level If - "heatmap", a heatmap gradient coloring is applied between each - contour level. If "lines", coloring is done on the contour - lines. If "none", no coloring is applied on this trace. - - The 'coloring' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['fill', 'heatmap', 'lines', 'none'] - - Returns - ------- - Any - """ - return self['coloring'] - - @coloring.setter - def coloring(self, val): - self['coloring'] = val - - # end - # --- - @property - 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 - - Returns - ------- - int|float - """ - return self['end'] - - @end.setter - def end(self, val): - self['end'] = val - - # labelfont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.histogram2dcontour.contours.Labelfont - """ - return self['labelfont'] - - @labelfont.setter - def labelfont(self, val): - self['labelfont'] = val - - # labelformat - # ----------- - @property - def labelformat(self): - """ - Sets the contour label formatting rule using d3 formatting - mini-language which is very similar to Python, see: https://git - hub.com/d3/d3-format/blob/master/README.md#locale_format. - - The 'labelformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['labelformat'] - - @labelformat.setter - def labelformat(self, val): - self['labelformat'] = val - - # operation - # --------- - @property - def operation(self): - """ - Sets the constraint operation. "=" keeps regions equal to - `value` "<" and "<=" keep regions less than `value` ">" and - ">=" keep regions greater than `value` "[]", "()", "[)", and - "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", - "](", ")[" keep regions outside `value[0]` to value[1]` Open - vs. closed intervals make no difference to constraint display, - but all versions are allowed for consistency with filter - transforms. - - The 'operation' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', - ')(', '](', ')['] - - Returns - ------- - Any - """ - return self['operation'] - - @operation.setter - def operation(self, val): - self['operation'] = val - - # showlabels - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlabels'] - - @showlabels.setter - def showlabels(self, val): - self['showlabels'] = val - - # showlines - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showlines'] - - @showlines.setter - def showlines(self, val): - self['showlines'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # start - # ----- - @property - 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 - - Returns - ------- - int|float - """ - return self['start'] - - @start.setter - def start(self, val): - self['start'] = val - - # type - # ---- - @property - def type(self): - """ - If `levels`, the data is represented as a contour plot with - multiple levels displayed. If `constraint`, the data is - represented as constraints with the invalid region shaded as - specified by the `operation` and `value` parameters. - - The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['levels', 'constraint'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # value - # ----- - @property - def value(self): - """ - Sets the value or values of the constraint boundary. When - `operation` is set to one of the comparison values - (=,<,>=,>,<=) "value" is expected to be a number. When - `operation` is set to one of the interval values - ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of - two numbers where the first is the lower bound and the second - is the upper bound. - - The 'value' property accepts values of any type - - Returns - ------- - Any - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2dcontour' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - coloring - Determines the coloring method showing the contour - values. If "fill", coloring is done evenly between each - contour level If "heatmap", a heatmap gradient coloring - is applied between each contour level. If "lines", - coloring is done on the contour lines. If "none", no - coloring is applied on this trace. - end - Sets the end contour level value. Must be more than - `contours.start` - labelfont - Sets the font used for labeling the contour levels. The - default color comes from the lines, if shown. The - default family and size come from `layout.font`. - labelformat - Sets the contour label formatting rule using d3 - formatting mini-language which is very similar to - Python, see: https://github.com/d3/d3-format/blob/maste - r/README.md#locale_format. - operation - Sets the constraint operation. "=" keeps regions equal - to `value` "<" and "<=" keep regions less than `value` - ">" and ">=" keep regions greater than `value` "[]", - "()", "[)", and "(]" keep regions inside `value[0]` to - `value[1]` "][", ")(", "](", ")[" keep regions outside - `value[0]` to value[1]` Open vs. closed intervals make - no difference to constraint display, but all versions - are allowed for consistency with filter transforms. - showlabels - Determines whether to label the contour lines with - their values. - showlines - Determines whether or not the contour lines are drawn. - Has an effect only if `contours.coloring` is set to - "fill". - size - Sets the step between each contour level. Must be - positive. - start - Sets the starting contour level value. Must be less - than `contours.end` - type - If `levels`, the data is represented as a contour plot - with multiple levels displayed. If `constraint`, the - data is represented as constraints with the invalid - region shaded as specified by the `operation` and - `value` parameters. - value - Sets the value or values of the constraint boundary. - When `operation` is set to one of the comparison values - (=,<,>=,>,<=) "value" is expected to be a number. When - `operation` is set to one of the interval values - ([],(),[),(],][,)(,](,)[) "value" is expected to be an - array of two numbers where the first is the lower bound - and the second is the upper bound. - """ - - def __init__( - self, - arg=None, - coloring=None, - end=None, - labelfont=None, - labelformat=None, - operation=None, - showlabels=None, - showlines=None, - size=None, - start=None, - type=None, - value=None, - **kwargs - ): - """ - Construct a new Contours object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.Contours - coloring - Determines the coloring method showing the contour - values. If "fill", coloring is done evenly between each - contour level If "heatmap", a heatmap gradient coloring - is applied between each contour level. If "lines", - coloring is done on the contour lines. If "none", no - coloring is applied on this trace. - end - Sets the end contour level value. Must be more than - `contours.start` - labelfont - Sets the font used for labeling the contour levels. The - default color comes from the lines, if shown. The - default family and size come from `layout.font`. - labelformat - Sets the contour label formatting rule using d3 - formatting mini-language which is very similar to - Python, see: https://github.com/d3/d3-format/blob/maste - r/README.md#locale_format. - operation - Sets the constraint operation. "=" keeps regions equal - to `value` "<" and "<=" keep regions less than `value` - ">" and ">=" keep regions greater than `value` "[]", - "()", "[)", and "(]" keep regions inside `value[0]` to - `value[1]` "][", ")(", "](", ")[" keep regions outside - `value[0]` to value[1]` Open vs. closed intervals make - no difference to constraint display, but all versions - are allowed for consistency with filter transforms. - showlabels - Determines whether to label the contour lines with - their values. - showlines - Determines whether or not the contour lines are drawn. - Has an effect only if `contours.coloring` is set to - "fill". - size - Sets the step between each contour level. Must be - positive. - start - Sets the starting contour level value. Must be less - than `contours.end` - type - If `levels`, the data is represented as a contour plot - with multiple levels displayed. If `constraint`, the - data is represented as constraints with the invalid - region shaded as specified by the `operation` and - `value` parameters. - value - Sets the value or values of the constraint boundary. - When `operation` is set to one of the comparison values - (=,<,>=,>,<=) "value" is expected to be a number. When - `operation` is set to one of the interval values - ([],(),[),(],][,)(,](,)[) "value" is expected to be an - array of two numbers where the first is the lower bound - and the second is the upper bound. - - Returns - ------- - Contours - """ - super(Contours, self).__init__('contours') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2dcontour.Contours -constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.Contours""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2dcontour import ( - contours as v_contours - ) - - # Initialize validators - # --------------------- - self._validators['coloring'] = v_contours.ColoringValidator() - self._validators['end'] = v_contours.EndValidator() - self._validators['labelfont'] = v_contours.LabelfontValidator() - self._validators['labelformat'] = v_contours.LabelformatValidator() - self._validators['operation'] = v_contours.OperationValidator() - self._validators['showlabels'] = v_contours.ShowlabelsValidator() - self._validators['showlines'] = v_contours.ShowlinesValidator() - self._validators['size'] = v_contours.SizeValidator() - self._validators['start'] = v_contours.StartValidator() - self._validators['type'] = v_contours.TypeValidator() - self._validators['value'] = v_contours.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('coloring', None) - self['coloring'] = coloring if coloring is not None else _v - _v = arg.pop('end', None) - self['end'] = end if end is not None else _v - _v = arg.pop('labelfont', None) - self['labelfont'] = labelfont if labelfont is not None else _v - _v = arg.pop('labelformat', None) - self['labelformat'] = labelformat if labelformat is not None else _v - _v = arg.pop('operation', None) - self['operation'] = operation if operation is not None else _v - _v = arg.pop('showlabels', None) - self['showlabels'] = showlabels if showlabels is not None else _v - _v = arg.pop('showlines', None) - self['showlines'] = showlines if showlines is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('start', None) - self['start'] = start if start is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/_hoverlabel.py b/plotly/graph_objs/histogram2dcontour/_hoverlabel.py deleted file mode 100644 index 40ae45ae12e..00000000000 --- a/plotly/graph_objs/histogram2dcontour/_hoverlabel.py +++ /dev/null @@ -1,417 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.histogram2dcontour.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2dcontour' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2dcontour.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2dcontour import ( - hoverlabel as v_hoverlabel - ) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/_line.py b/plotly/graph_objs/histogram2dcontour/_line.py deleted file mode 100644 index 95eb936d50f..00000000000 --- a/plotly/graph_objs/histogram2dcontour/_line.py +++ /dev/null @@ -1,246 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dash - # ---- - @property - def dash(self): - """ - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - - The 'dash' property is an enumeration that may be specified as: - - One of the following dash styles: - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - - A string containing a dash length list in pixels or percentages - (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) - - Returns - ------- - str - """ - return self['dash'] - - @dash.setter - def dash(self, val): - self['dash'] = val - - # smoothing - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['smoothing'] - - @smoothing.setter - def smoothing(self, val): - self['smoothing'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2dcontour' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the color of the contour level. Has no effect if - `contours.coloring` is set to "lines". - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - smoothing - Sets the amount of smoothing for the contour lines, - where 0 corresponds to no smoothing. - width - Sets the line width (in px). - """ - - def __init__( - self, - arg=None, - color=None, - dash=None, - smoothing=None, - width=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.Line - color - Sets the color of the contour level. Has no effect if - `contours.coloring` is set to "lines". - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - smoothing - Sets the amount of smoothing for the contour lines, - where 0 corresponds to no smoothing. - width - Sets the line width (in px). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2dcontour.Line -constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2dcontour import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['dash'] = v_line.DashValidator() - self._validators['smoothing'] = v_line.SmoothingValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dash', None) - self['dash'] = dash if dash is not None else _v - _v = arg.pop('smoothing', None) - self['smoothing'] = smoothing if smoothing is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/_marker.py b/plotly/graph_objs/histogram2dcontour/_marker.py deleted file mode 100644 index 090a5a5397c..00000000000 --- a/plotly/graph_objs/histogram2dcontour/_marker.py +++ /dev/null @@ -1,127 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2dcontour' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the aggregation data. - colorsrc - Sets the source reference on plot.ly for color . - """ - - def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.Marker - color - Sets the aggregation data. - colorsrc - Sets the source reference on plot.ly for color . - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2dcontour.Marker -constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2dcontour import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['colorsrc'] = v_marker.ColorsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/_stream.py b/plotly/graph_objs/histogram2dcontour/_stream.py deleted file mode 100644 index 2be7c4a726a..00000000000 --- a/plotly/graph_objs/histogram2dcontour/_stream.py +++ /dev/null @@ -1,140 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2dcontour' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2dcontour.Stream -constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2dcontour import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/_xbins.py b/plotly/graph_objs/histogram2dcontour/_xbins.py deleted file mode 100644 index 83e4dc80ead..00000000000 --- a/plotly/graph_objs/histogram2dcontour/_xbins.py +++ /dev/null @@ -1,218 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class XBins(BaseTraceHierarchyType): - - # end - # --- - @property - def end(self): - """ - Sets the end value for the x axis bins. The last bin may not - end exactly at this value, we increment the bin edge by `size` - from `start` until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use a date string, - and for category data `end` is based on the category serial - numbers. - - The 'end' property accepts values of any type - - Returns - ------- - Any - """ - return self['end'] - - @end.setter - def end(self, val): - self['end'] = val - - # size - # ---- - @property - def size(self): - """ - Sets the size of each x axis bin. Default behavior: If `nbinsx` - is 0 or omitted, we choose a nice round bin size such that the - number of bins is about the same as the typical number of - samples in each bin. If `nbinsx` is provided, we choose a nice - round bin size giving no more than that many bins. For date - data, use milliseconds or "M" 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 - ------- - Any - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # start - # ----- - @property - def start(self): - """ - Sets the starting value for the x axis bins. Defaults to the - minimum data value, shifted down if necessary to make nice - round values and to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin edges 0.5 down, - so a `size` of 5 would have a default `start` of -0.5, so it is - clear that 0-4 are in the first bin, 5-9 in the second, but - continuous data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date string. - For category data, `start` is based on the category serial - numbers, and defaults to -0.5. - - The 'start' property accepts values of any type - - Returns - ------- - Any - """ - return self['start'] - - @start.setter - def start(self, val): - self['start'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2dcontour' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - end - Sets the end value for the x axis bins. The last bin - may not end exactly at this value, we increment the bin - edge by `size` from `start` until we reach or exceed - `end`. Defaults to the maximum data value. Like - `start`, for dates use a date string, and for category - data `end` is based on the category serial numbers. - size - Sets the size of each x axis bin. Default behavior: If - `nbinsx` is 0 or omitted, we choose a nice round bin - size such that the number of bins is about the same as - the typical number of samples in each bin. If `nbinsx` - is provided, we choose a nice round bin size giving no - more than that many bins. For date data, use - milliseconds or "M" for months, as in `axis.dtick`. - For category data, the number of categories to bin - together (always defaults to 1). - start - Sets the starting value for the x axis bins. Defaults - to the minimum data value, shifted down if necessary to - make nice round values and to remove ambiguous bin - edges. For example, if most of the data is integers we - shift the bin edges 0.5 down, so a `size` of 5 would - have a default `start` of -0.5, so it is clear that 0-4 - are in the first bin, 5-9 in the second, but continuous - data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date - string. For category data, `start` is based on the - category serial numbers, and defaults to -0.5. - """ - - def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): - """ - Construct a new XBins object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.XBins - end - Sets the end value for the x axis bins. The last bin - may not end exactly at this value, we increment the bin - edge by `size` from `start` until we reach or exceed - `end`. Defaults to the maximum data value. Like - `start`, for dates use a date string, and for category - data `end` is based on the category serial numbers. - size - Sets the size of each x axis bin. Default behavior: If - `nbinsx` is 0 or omitted, we choose a nice round bin - size such that the number of bins is about the same as - the typical number of samples in each bin. If `nbinsx` - is provided, we choose a nice round bin size giving no - more than that many bins. For date data, use - milliseconds or "M" for months, as in `axis.dtick`. - For category data, the number of categories to bin - together (always defaults to 1). - start - Sets the starting value for the x axis bins. Defaults - to the minimum data value, shifted down if necessary to - make nice round values and to remove ambiguous bin - edges. For example, if most of the data is integers we - shift the bin edges 0.5 down, so a `size` of 5 would - have a default `start` of -0.5, so it is clear that 0-4 - are in the first bin, 5-9 in the second, but continuous - data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date - string. For category data, `start` is based on the - category serial numbers, and defaults to -0.5. - - Returns - ------- - XBins - """ - super(XBins, self).__init__('xbins') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2dcontour.XBins -constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.XBins""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2dcontour import (xbins as v_xbins) - - # Initialize validators - # --------------------- - self._validators['end'] = v_xbins.EndValidator() - self._validators['size'] = v_xbins.SizeValidator() - self._validators['start'] = v_xbins.StartValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('end', None) - self['end'] = end if end is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('start', None) - self['start'] = start if start is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/_ybins.py b/plotly/graph_objs/histogram2dcontour/_ybins.py deleted file mode 100644 index 11bdd9175b2..00000000000 --- a/plotly/graph_objs/histogram2dcontour/_ybins.py +++ /dev/null @@ -1,218 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class YBins(BaseTraceHierarchyType): - - # end - # --- - @property - def end(self): - """ - Sets the end value for the y axis bins. The last bin may not - end exactly at this value, we increment the bin edge by `size` - from `start` until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use a date string, - and for category data `end` is based on the category serial - numbers. - - The 'end' property accepts values of any type - - Returns - ------- - Any - """ - return self['end'] - - @end.setter - def end(self, val): - self['end'] = val - - # size - # ---- - @property - def size(self): - """ - Sets the size of each y axis bin. Default behavior: If `nbinsy` - is 0 or omitted, we choose a nice round bin size such that the - number of bins is about the same as the typical number of - samples in each bin. If `nbinsy` is provided, we choose a nice - round bin size giving no more than that many bins. For date - data, use milliseconds or "M" 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 - ------- - Any - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # start - # ----- - @property - def start(self): - """ - Sets the starting value for the y axis bins. Defaults to the - minimum data value, shifted down if necessary to make nice - round values and to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin edges 0.5 down, - so a `size` of 5 would have a default `start` of -0.5, so it is - clear that 0-4 are in the first bin, 5-9 in the second, but - continuous data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date string. - For category data, `start` is based on the category serial - numbers, and defaults to -0.5. - - The 'start' property accepts values of any type - - Returns - ------- - Any - """ - return self['start'] - - @start.setter - def start(self, val): - self['start'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2dcontour' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - end - Sets the end value for the y axis bins. The last bin - may not end exactly at this value, we increment the bin - edge by `size` from `start` until we reach or exceed - `end`. Defaults to the maximum data value. Like - `start`, for dates use a date string, and for category - data `end` is based on the category serial numbers. - size - Sets the size of each y axis bin. Default behavior: If - `nbinsy` is 0 or omitted, we choose a nice round bin - size such that the number of bins is about the same as - the typical number of samples in each bin. If `nbinsy` - is provided, we choose a nice round bin size giving no - more than that many bins. For date data, use - milliseconds or "M" for months, as in `axis.dtick`. - For category data, the number of categories to bin - together (always defaults to 1). - start - Sets the starting value for the y axis bins. Defaults - to the minimum data value, shifted down if necessary to - make nice round values and to remove ambiguous bin - edges. For example, if most of the data is integers we - shift the bin edges 0.5 down, so a `size` of 5 would - have a default `start` of -0.5, so it is clear that 0-4 - are in the first bin, 5-9 in the second, but continuous - data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date - string. For category data, `start` is based on the - category serial numbers, and defaults to -0.5. - """ - - def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): - """ - Construct a new YBins object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.YBins - end - Sets the end value for the y axis bins. The last bin - may not end exactly at this value, we increment the bin - edge by `size` from `start` until we reach or exceed - `end`. Defaults to the maximum data value. Like - `start`, for dates use a date string, and for category - data `end` is based on the category serial numbers. - size - Sets the size of each y axis bin. Default behavior: If - `nbinsy` is 0 or omitted, we choose a nice round bin - size such that the number of bins is about the same as - the typical number of samples in each bin. If `nbinsy` - is provided, we choose a nice round bin size giving no - more than that many bins. For date data, use - milliseconds or "M" for months, as in `axis.dtick`. - For category data, the number of categories to bin - together (always defaults to 1). - start - Sets the starting value for the y axis bins. Defaults - to the minimum data value, shifted down if necessary to - make nice round values and to remove ambiguous bin - edges. For example, if most of the data is integers we - shift the bin edges 0.5 down, so a `size` of 5 would - have a default `start` of -0.5, so it is clear that 0-4 - are in the first bin, 5-9 in the second, but continuous - data gets a start of 0 and bins [0,5), [5,10) etc. - Dates behave similarly, and `start` should be a date - string. For category data, `start` is based on the - category serial numbers, and defaults to -0.5. - - Returns - ------- - YBins - """ - super(YBins, self).__init__('ybins') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2dcontour.YBins -constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.YBins""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2dcontour import (ybins as v_ybins) - - # Initialize validators - # --------------------- - self._validators['end'] = v_ybins.EndValidator() - self._validators['size'] = v_ybins.SizeValidator() - self._validators['start'] = v_ybins.StartValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('end', None) - self['end'] = end if end is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('start', None) - self['start'] = start if start is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/colorbar/__init__.py b/plotly/graph_objs/histogram2dcontour/colorbar/__init__.py index 88f63044a30..fd4459c9925 100644 --- a/plotly/graph_objs/histogram2dcontour/colorbar/__init__.py +++ b/plotly/graph_objs/histogram2dcontour/colorbar/__init__.py @@ -1,4 +1,725 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.histogram2dcontour.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2dcontour.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2dcontour.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.histogram2dcontour.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2dcontour.colorbar import ( + title as v_title + ) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2dcontour.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram2dcontour.col + orbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2dcontour.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2dcontour.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2dcontour.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.histogram2dcontour.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2dcontour.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.histogram2dcontour.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/histogram2dcontour/colorbar/_tickfont.py b/plotly/graph_objs/histogram2dcontour/colorbar/_tickfont.py deleted file mode 100644 index 34f75f59718..00000000000 --- a/plotly/graph_objs/histogram2dcontour/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2dcontour.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2dcontour.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py b/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py deleted file mode 100644 index e22a3c1b14d..00000000000 --- a/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2dcontour.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram2dcontour.col - orbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2dcontour.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/colorbar/_title.py b/plotly/graph_objs/histogram2dcontour/colorbar/_title.py deleted file mode 100644 index 6de78fa7570..00000000000 --- a/plotly/graph_objs/histogram2dcontour/colorbar/_title.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.histogram2dcontour.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2dcontour.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2dcontour.colorbar import ( - title as v_title - ) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/colorbar/title/__init__.py b/plotly/graph_objs/histogram2dcontour/colorbar/title/__init__.py index c37b8b5cd28..14312351aea 100644 --- a/plotly/graph_objs/histogram2dcontour/colorbar/title/__init__.py +++ b/plotly/graph_objs/histogram2dcontour/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2dcontour.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.histogram2dcontour.col + orbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.histogram2dcontour.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2dcontour.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/colorbar/title/_font.py b/plotly/graph_objs/histogram2dcontour/colorbar/title/_font.py deleted file mode 100644 index 0dbacad764c..00000000000 --- a/plotly/graph_objs/histogram2dcontour/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2dcontour.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.histogram2dcontour.col - orbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2dcontour.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/contours/__init__.py b/plotly/graph_objs/histogram2dcontour/contours/__init__.py index 4729349bff3..7e38abdd8c1 100644 --- a/plotly/graph_objs/histogram2dcontour/contours/__init__.py +++ b/plotly/graph_objs/histogram2dcontour/contours/__init__.py @@ -1 +1,232 @@ -from ._labelfont import Labelfont + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Labelfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2dcontour.contours' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2dcontour.contours.Labelfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Labelfont + """ + super(Labelfont, self).__init__('labelfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2dcontour.contours.Labelfont +constructor must be a dict or +an instance of plotly.graph_objs.histogram2dcontour.contours.Labelfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2dcontour.contours import ( + labelfont as v_labelfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_labelfont.ColorValidator() + self._validators['family'] = v_labelfont.FamilyValidator() + self._validators['size'] = v_labelfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/contours/_labelfont.py b/plotly/graph_objs/histogram2dcontour/contours/_labelfont.py deleted file mode 100644 index f1db4ec4093..00000000000 --- a/plotly/graph_objs/histogram2dcontour/contours/_labelfont.py +++ /dev/null @@ -1,230 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Labelfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2dcontour.contours' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.contours.Labelfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Labelfont - """ - super(Labelfont, self).__init__('labelfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2dcontour.contours.Labelfont -constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.contours.Labelfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2dcontour.contours import ( - labelfont as v_labelfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_labelfont.ColorValidator() - self._validators['family'] = v_labelfont.FamilyValidator() - self._validators['size'] = v_labelfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/hoverlabel/__init__.py b/plotly/graph_objs/histogram2dcontour/hoverlabel/__init__.py index c37b8b5cd28..73b7994690d 100644 --- a/plotly/graph_objs/histogram2dcontour/hoverlabel/__init__.py +++ b/plotly/graph_objs/histogram2dcontour/hoverlabel/__init__.py @@ -1 +1,324 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'histogram2dcontour.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.histogram2dcontour.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.histogram2dcontour.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.histogram2dcontour.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.histogram2dcontour.hoverlabel import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/histogram2dcontour/hoverlabel/_font.py b/plotly/graph_objs/histogram2dcontour/hoverlabel/_font.py deleted file mode 100644 index 323e42dc5cc..00000000000 --- a/plotly/graph_objs/histogram2dcontour/hoverlabel/_font.py +++ /dev/null @@ -1,322 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'histogram2dcontour.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.histogram2dcontour.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.histogram2dcontour.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.histogram2dcontour.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.histogram2dcontour.hoverlabel import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/__init__.py b/plotly/graph_objs/isosurface/__init__.py index 4185fadeab3..5bb6c77ded1 100644 --- a/plotly/graph_objs/isosurface/__init__.py +++ b/plotly/graph_objs/isosurface/__init__.py @@ -1,14 +1,3914 @@ -from ._surface import Surface -from ._stream import Stream -from ._spaceframe import Spaceframe -from ._slices import Slices + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Surface(_BaseTraceHierarchyType): + + # count + # ----- + @property + 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] + + Returns + ------- + int + """ + return self['count'] + + @count.setter + def count(self, val): + self['count'] = val + + # fill + # ---- + @property + def fill(self): + """ + Sets the fill ratio of the iso-surface. The default fill value + of the surface is 1 meaning that they are entirely shaded. On + the other hand Applying a `fill` ratio less than one would + allow the creation of openings parallel to the edges. + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # pattern + # ------- + @property + def pattern(self): + """ + Sets the surface pattern of the iso-surface 3-D sections. The + default pattern of the surface is `all` meaning that the rest + of surface elements would be shaded. The check options (either + 1 or 2) could be used to draw half of the squares on the + surface. Using various combinations of capital `A`, `B`, `C`, + `D` and `E` may also be used to reduce the number of triangles + on the iso-surfaces and creating other patterns of interest. + + 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 + (e.g. 'A+B') + OR exactly one of ['all', 'odd', 'even'] (e.g. 'even') + + Returns + ------- + Any + """ + return self['pattern'] + + @pattern.setter + def pattern(self, val): + self['pattern'] = val + + # show + # ---- + @property + 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) + + Returns + ------- + bool + """ + return self['show'] + + @show.setter + def show(self, val): + self['show'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + count + Sets the number of iso-surfaces between minimum and + maximum iso-values. By default this value is 2 meaning + that only minimum and maximum surfaces would be drawn. + fill + Sets the fill ratio of the iso-surface. The default + fill value of the surface is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + pattern + Sets the surface pattern of the iso-surface 3-D + sections. The default pattern of the surface is `all` + meaning that the rest of surface elements would be + shaded. The check options (either 1 or 2) could be used + to draw half of the squares on the surface. Using + various combinations of capital `A`, `B`, `C`, `D` and + `E` may also be used to reduce the number of triangles + on the iso-surfaces and creating other patterns of + interest. + show + Hides/displays surfaces between minimum and maximum + iso-values. + """ + + def __init__( + self, + arg=None, + count=None, + fill=None, + pattern=None, + show=None, + **kwargs + ): + """ + Construct a new Surface object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.isosurface.Surface + count + Sets the number of iso-surfaces between minimum and + maximum iso-values. By default this value is 2 meaning + that only minimum and maximum surfaces would be drawn. + fill + Sets the fill ratio of the iso-surface. The default + fill value of the surface is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + pattern + Sets the surface pattern of the iso-surface 3-D + sections. The default pattern of the surface is `all` + meaning that the rest of surface elements would be + shaded. The check options (either 1 or 2) could be used + to draw half of the squares on the surface. Using + various combinations of capital `A`, `B`, `C`, `D` and + `E` may also be used to reduce the number of triangles + on the iso-surfaces and creating other patterns of + interest. + show + Hides/displays surfaces between minimum and maximum + iso-values. + + Returns + ------- + Surface + """ + super(Surface, self).__init__('surface') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.Surface +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.Surface""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface import (surface as v_surface) + + # Initialize validators + # --------------------- + self._validators['count'] = v_surface.CountValidator() + self._validators['fill'] = v_surface.FillValidator() + self._validators['pattern'] = v_surface.PatternValidator() + self._validators['show'] = v_surface.ShowValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('count', None) + self['count'] = count if count is not None else _v + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('pattern', None) + self['pattern'] = pattern if pattern is not None else _v + _v = arg.pop('show', None) + self['show'] = show if show is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.isosurface.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.Stream +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Spaceframe(_BaseTraceHierarchyType): + + # fill + # ---- + @property + def fill(self): + """ + Sets the fill ratio of the `spaceframe` elements. The default + fill value is 0.15 meaning that only 15% of the area of every + faces of tetras would be shaded. Applying a greater `fill` + ratio would allow the creation of stronger elements or could be + sued to have entirely closed areas (in case of using 1). + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # show + # ---- + @property + 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) + + Returns + ------- + bool + """ + return self['show'] + + @show.setter + def show(self, val): + self['show'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `spaceframe` elements. The + default fill value is 0.15 meaning that only 15% of the + area of every faces of tetras would be shaded. Applying + a greater `fill` ratio would allow the creation of + stronger elements or could be sued to have entirely + closed areas (in case of using 1). + show + Displays/hides tetrahedron shapes between minimum and + maximum iso-values. Often useful when either caps or + surfaces are disabled or filled with values less than + 1. + """ + + def __init__(self, arg=None, fill=None, show=None, **kwargs): + """ + Construct a new Spaceframe object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.isosurface.Spaceframe + fill + Sets the fill ratio of the `spaceframe` elements. The + default fill value is 0.15 meaning that only 15% of the + area of every faces of tetras would be shaded. Applying + a greater `fill` ratio would allow the creation of + stronger elements or could be sued to have entirely + closed areas (in case of using 1). + show + Displays/hides tetrahedron shapes between minimum and + maximum iso-values. Often useful when either caps or + surfaces are disabled or filled with values less than + 1. + + Returns + ------- + Spaceframe + """ + super(Spaceframe, self).__init__('spaceframe') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.Spaceframe +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.Spaceframe""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface import (spaceframe as v_spaceframe) + + # Initialize validators + # --------------------- + self._validators['fill'] = v_spaceframe.FillValidator() + self._validators['show'] = v_spaceframe.ShowValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('show', None) + self['show'] = show if show is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Slices(_BaseTraceHierarchyType): + + # x + # - + @property + def x(self): + """ + The 'x' property is an instance of X + that may be specified as: + - An instance of 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 + 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. + locations + Specifies the location(s) of slices on the + axis. When not locations specified slices would + be created for all points of the axis x except + start and end. + locationssrc + Sets the source reference on plot.ly for + locations . + show + Determines whether or not slice planes about + the x dimension are drawn. + + Returns + ------- + plotly.graph_objs.isosurface.slices.X + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @property + def y(self): + """ + The 'y' property is an instance of Y + that may be specified as: + - An instance of 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 + 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. + locations + Specifies the location(s) of slices on the + axis. When not locations specified slices would + be created for all points of the axis y except + start and end. + locationssrc + Sets the source reference on plot.ly for + locations . + show + Determines whether or not slice planes about + the y dimension are drawn. + + Returns + ------- + plotly.graph_objs.isosurface.slices.Y + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # z + # - + @property + def z(self): + """ + The 'z' property is an instance of Z + that may be specified as: + - An instance of 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 + 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. + locations + Specifies the location(s) of slices on the + axis. When not locations specified slices would + be created for all points of the axis z except + start and end. + locationssrc + Sets the source reference on plot.ly for + locations . + show + Determines whether or not slice planes about + the z dimension are drawn. + + Returns + ------- + plotly.graph_objs.isosurface.slices.Z + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + plotly.graph_objs.isosurface.slices.X instance or dict + with compatible properties + y + plotly.graph_objs.isosurface.slices.Y instance or dict + with compatible properties + z + plotly.graph_objs.isosurface.slices.Z instance or dict + with compatible properties + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Slices object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.isosurface.Slices + x + plotly.graph_objs.isosurface.slices.X instance or dict + with compatible properties + y + plotly.graph_objs.isosurface.slices.Y instance or dict + with compatible properties + z + plotly.graph_objs.isosurface.slices.Z instance or dict + with compatible properties + + Returns + ------- + Slices + """ + super(Slices, self).__init__('slices') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.Slices +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.Slices""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface import (slices as v_slices) + + # Initialize validators + # --------------------- + self._validators['x'] = v_slices.XValidator() + self._validators['y'] = v_slices.YValidator() + self._validators['z'] = v_slices.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lightposition(_BaseTraceHierarchyType): + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # z + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Lightposition object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.isosurface.Lightposition + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + + Returns + ------- + Lightposition + """ + super(Lightposition, self).__init__('lightposition') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.Lightposition +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.Lightposition""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface import ( + lightposition as v_lightposition + ) + + # Initialize validators + # --------------------- + self._validators['x'] = v_lightposition.XValidator() + self._validators['y'] = v_lightposition.YValidator() + self._validators['z'] = v_lightposition.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lighting(_BaseTraceHierarchyType): + + # ambient + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ambient'] + + @ambient.setter + def ambient(self, val): + self['ambient'] = val + + # diffuse + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['diffuse'] + + @diffuse.setter + def diffuse(self, val): + self['diffuse'] = val + + # facenormalsepsilon + # ------------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['facenormalsepsilon'] + + @facenormalsepsilon.setter + def facenormalsepsilon(self, val): + self['facenormalsepsilon'] = val + + # fresnel + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['fresnel'] + + @fresnel.setter + def fresnel(self, val): + self['fresnel'] = val + + # roughness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['roughness'] + + @roughness.setter + def roughness(self, val): + self['roughness'] = val + + # specular + # -------- + @property + 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] + + Returns + ------- + int|float + """ + return self['specular'] + + @specular.setter + def specular(self, val): + self['specular'] = val + + # vertexnormalsepsilon + # -------------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['vertexnormalsepsilon'] + + @vertexnormalsepsilon.setter + def vertexnormalsepsilon(self, val): + self['vertexnormalsepsilon'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + """ + + def __init__( + self, + arg=None, + ambient=None, + diffuse=None, + facenormalsepsilon=None, + fresnel=None, + roughness=None, + specular=None, + vertexnormalsepsilon=None, + **kwargs + ): + """ + Construct a new Lighting object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.isosurface.Lighting + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + + Returns + ------- + Lighting + """ + super(Lighting, self).__init__('lighting') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.Lighting +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.Lighting""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface import (lighting as v_lighting) + + # Initialize validators + # --------------------- + self._validators['ambient'] = v_lighting.AmbientValidator() + self._validators['diffuse'] = v_lighting.DiffuseValidator() + self._validators['facenormalsepsilon' + ] = v_lighting.FacenormalsepsilonValidator() + self._validators['fresnel'] = v_lighting.FresnelValidator() + self._validators['roughness'] = v_lighting.RoughnessValidator() + self._validators['specular'] = v_lighting.SpecularValidator() + self._validators['vertexnormalsepsilon' + ] = v_lighting.VertexnormalsepsilonValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('ambient', None) + self['ambient'] = ambient if ambient is not None else _v + _v = arg.pop('diffuse', None) + self['diffuse'] = diffuse if diffuse is not None else _v + _v = arg.pop('facenormalsepsilon', None) + self['facenormalsepsilon' + ] = facenormalsepsilon if facenormalsepsilon is not None else _v + _v = arg.pop('fresnel', None) + self['fresnel'] = fresnel if fresnel is not None else _v + _v = arg.pop('roughness', None) + self['roughness'] = roughness if roughness is not None else _v + _v = arg.pop('specular', None) + self['specular'] = specular if specular is not None else _v + _v = arg.pop('vertexnormalsepsilon', None) + self[ + 'vertexnormalsepsilon' + ] = vertexnormalsepsilon if vertexnormalsepsilon is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.isosurface.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.isosurface.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Contour(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # show + # ---- + @property + 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) + + Returns + ------- + bool + """ + return self['show'] + + @show.setter + def show(self, val): + self['show'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour lines. + show + Sets whether or not dynamic contours are shown on hover + width + Sets the width of the contour lines. + """ + + def __init__(self, arg=None, color=None, show=None, width=None, **kwargs): + """ + Construct a new Contour object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.isosurface.Contour + color + Sets the color of the contour lines. + show + Sets whether or not dynamic contours are shown on hover + width + Sets the width of the contour lines. + + Returns + ------- + Contour + """ + super(Contour, self).__init__('contour') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.Contour +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.Contour""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface import (contour as v_contour) + + # Initialize validators + # --------------------- + self._validators['color'] = v_contour.ColorValidator() + self._validators['show'] = v_contour.ShowValidator() + self._validators['width'] = v_contour.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('show', None) + self['show'] = show if show is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.isosurface.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.isosurface.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + 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 plotly.graph_objs.isosurface.colorbar.Tickformatstop + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.isosurface.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.isosurface.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use isosurface.colorbar.title.side instead. + Determines the location of color bar's title with respect to + the color bar. Note that the title's location used to be set by + the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.isosurface.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.isosur + face.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + isosurface.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.isosurface.colorbar.Title instance or + dict with compatible properties + titlefont + Deprecated: Please use isosurface.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use isosurface.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.isosurface.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.isosurface.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.isosur + face.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + isosurface.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.isosurface.colorbar.Title instance or + dict with compatible properties + titlefont + Deprecated: Please use isosurface.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use isosurface.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Caps(_BaseTraceHierarchyType): + + # x + # - + @property + def x(self): + """ + The 'x' property is an instance of X + that may be specified as: + - An instance of 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 + are entirely shaded. On the other hand Applying + a `fill` ratio less than one would allow the + creation of openings parallel to the edges. + show + Sets the fill ratio of the `slices`. The + default fill value of 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. + + Returns + ------- + plotly.graph_objs.isosurface.caps.X + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @property + def y(self): + """ + The 'y' property is an instance of Y + that may be specified as: + - An instance of 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 + are entirely shaded. On the other hand Applying + a `fill` ratio less than one would allow the + creation of openings parallel to the edges. + show + Sets the fill ratio of the `slices`. The + default fill value of 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. + + Returns + ------- + plotly.graph_objs.isosurface.caps.Y + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # z + # - + @property + def z(self): + """ + The 'z' property is an instance of Z + that may be specified as: + - An instance of 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 + are entirely shaded. On the other hand Applying + a `fill` ratio less than one would allow the + creation of openings parallel to the edges. + show + Sets the fill ratio of the `slices`. The + default fill value of 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. + + Returns + ------- + plotly.graph_objs.isosurface.caps.Z + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + plotly.graph_objs.isosurface.caps.X instance or dict + with compatible properties + y + plotly.graph_objs.isosurface.caps.Y instance or dict + with compatible properties + z + plotly.graph_objs.isosurface.caps.Z instance or dict + with compatible properties + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Caps object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.isosurface.Caps + x + plotly.graph_objs.isosurface.caps.X instance or dict + with compatible properties + y + plotly.graph_objs.isosurface.caps.Y instance or dict + with compatible properties + z + plotly.graph_objs.isosurface.caps.Z instance or dict + with compatible properties + + Returns + ------- + Caps + """ + super(Caps, self).__init__('caps') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.Caps +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.Caps""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface import (caps as v_caps) + + # Initialize validators + # --------------------- + self._validators['x'] = v_caps.XValidator() + self._validators['y'] = v_caps.YValidator() + self._validators['z'] = v_caps.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.isosurface import slices -from ._lightposition import Lightposition -from ._lighting import Lighting -from ._hoverlabel import Hoverlabel from plotly.graph_objs.isosurface import hoverlabel -from ._contour import Contour -from ._colorbar import ColorBar from plotly.graph_objs.isosurface import colorbar -from ._caps import Caps from plotly.graph_objs.isosurface import caps diff --git a/plotly/graph_objs/isosurface/_caps.py b/plotly/graph_objs/isosurface/_caps.py deleted file mode 100644 index 6297019f466..00000000000 --- a/plotly/graph_objs/isosurface/_caps.py +++ /dev/null @@ -1,210 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Caps(BaseTraceHierarchyType): - - # x - # - - @property - def x(self): - """ - The 'x' property is an instance of X - that may be specified as: - - An instance of 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 - are entirely shaded. On the other hand Applying - a `fill` ratio less than one would allow the - creation of openings parallel to the edges. - show - Sets the fill ratio of the `slices`. The - default fill value of 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. - - Returns - ------- - plotly.graph_objs.isosurface.caps.X - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @property - def y(self): - """ - The 'y' property is an instance of Y - that may be specified as: - - An instance of 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 - are entirely shaded. On the other hand Applying - a `fill` ratio less than one would allow the - creation of openings parallel to the edges. - show - Sets the fill ratio of the `slices`. The - default fill value of 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. - - Returns - ------- - plotly.graph_objs.isosurface.caps.Y - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # z - # - - @property - def z(self): - """ - The 'z' property is an instance of Z - that may be specified as: - - An instance of 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 - are entirely shaded. On the other hand Applying - a `fill` ratio less than one would allow the - creation of openings parallel to the edges. - show - Sets the fill ratio of the `slices`. The - default fill value of 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. - - Returns - ------- - plotly.graph_objs.isosurface.caps.Z - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - plotly.graph_objs.isosurface.caps.X instance or dict - with compatible properties - y - plotly.graph_objs.isosurface.caps.Y instance or dict - with compatible properties - z - plotly.graph_objs.isosurface.caps.Z instance or dict - with compatible properties - """ - - def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): - """ - Construct a new Caps object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.Caps - x - plotly.graph_objs.isosurface.caps.X instance or dict - with compatible properties - y - plotly.graph_objs.isosurface.caps.Y instance or dict - with compatible properties - z - plotly.graph_objs.isosurface.caps.Z instance or dict - with compatible properties - - Returns - ------- - Caps - """ - super(Caps, self).__init__('caps') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.Caps -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Caps""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface import (caps as v_caps) - - # Initialize validators - # --------------------- - self._validators['x'] = v_caps.XValidator() - self._validators['y'] = v_caps.YValidator() - self._validators['z'] = v_caps.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/_colorbar.py b/plotly/graph_objs/isosurface/_colorbar.py deleted file mode 100644 index 61c4c7f870a..00000000000 --- a/plotly/graph_objs/isosurface/_colorbar.py +++ /dev/null @@ -1,1862 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.isosurface.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.isosurface.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - 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 plotly.graph_objs.isosurface.colorbar.Tickformatstop - - A dict of string/value properties that will be passed - to the Tickformatstop constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.isosurface.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.isosurface.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use isosurface.colorbar.title.side instead. - Determines the location of color bar's title with respect to - the color bar. Note that the title's location used to be set by - the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.isosurface.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.isosur - face.colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - isosurface.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.isosurface.colorbar.Title instance or - dict with compatible properties - titlefont - Deprecated: Please use isosurface.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use isosurface.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.isosurface.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.isosur - face.colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - isosurface.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.isosurface.colorbar.Title instance or - dict with compatible properties - titlefont - Deprecated: Please use isosurface.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use isosurface.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/_contour.py b/plotly/graph_objs/isosurface/_contour.py deleted file mode 100644 index efc6f05eb11..00000000000 --- a/plotly/graph_objs/isosurface/_contour.py +++ /dev/null @@ -1,192 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Contour(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # show - # ---- - @property - 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) - - Returns - ------- - bool - """ - return self['show'] - - @show.setter - def show(self, val): - self['show'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the color of the contour lines. - show - Sets whether or not dynamic contours are shown on hover - width - Sets the width of the contour lines. - """ - - def __init__(self, arg=None, color=None, show=None, width=None, **kwargs): - """ - Construct a new Contour object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.Contour - color - Sets the color of the contour lines. - show - Sets whether or not dynamic contours are shown on hover - width - Sets the width of the contour lines. - - Returns - ------- - Contour - """ - super(Contour, self).__init__('contour') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.Contour -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Contour""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface import (contour as v_contour) - - # Initialize validators - # --------------------- - self._validators['color'] = v_contour.ColorValidator() - self._validators['show'] = v_contour.ShowValidator() - self._validators['width'] = v_contour.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('show', None) - self['show'] = show if show is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/_hoverlabel.py b/plotly/graph_objs/isosurface/_hoverlabel.py deleted file mode 100644 index c1e12524857..00000000000 --- a/plotly/graph_objs/isosurface/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.isosurface.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/_lighting.py b/plotly/graph_objs/isosurface/_lighting.py deleted file mode 100644 index 0da9935a2f3..00000000000 --- a/plotly/graph_objs/isosurface/_lighting.py +++ /dev/null @@ -1,303 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Lighting(BaseTraceHierarchyType): - - # ambient - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ambient'] - - @ambient.setter - def ambient(self, val): - self['ambient'] = val - - # diffuse - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['diffuse'] - - @diffuse.setter - def diffuse(self, val): - self['diffuse'] = val - - # facenormalsepsilon - # ------------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['facenormalsepsilon'] - - @facenormalsepsilon.setter - def facenormalsepsilon(self, val): - self['facenormalsepsilon'] = val - - # fresnel - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['fresnel'] - - @fresnel.setter - def fresnel(self, val): - self['fresnel'] = val - - # roughness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['roughness'] - - @roughness.setter - def roughness(self, val): - self['roughness'] = val - - # specular - # -------- - @property - 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] - - Returns - ------- - int|float - """ - return self['specular'] - - @specular.setter - def specular(self, val): - self['specular'] = val - - # vertexnormalsepsilon - # -------------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['vertexnormalsepsilon'] - - @vertexnormalsepsilon.setter - def vertexnormalsepsilon(self, val): - self['vertexnormalsepsilon'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - ambient - Ambient light increases overall color visibility but - can wash out the image. - diffuse - Represents the extent that incident rays are reflected - in a range of angles. - facenormalsepsilon - Epsilon for face normals calculation avoids math issues - arising from degenerate geometry. - fresnel - Represents the reflectance as a dependency of the - viewing angle; e.g. paper is reflective when viewing it - from the edge of the paper (almost 90 degrees), causing - shine. - roughness - Alters specular reflection; the rougher the surface, - the wider and less contrasty the shine. - specular - Represents the level that incident rays are reflected - in a single direction, causing shine. - vertexnormalsepsilon - Epsilon for vertex normals calculation avoids math - issues arising from degenerate geometry. - """ - - def __init__( - self, - arg=None, - ambient=None, - diffuse=None, - facenormalsepsilon=None, - fresnel=None, - roughness=None, - specular=None, - vertexnormalsepsilon=None, - **kwargs - ): - """ - Construct a new Lighting object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.Lighting - ambient - Ambient light increases overall color visibility but - can wash out the image. - diffuse - Represents the extent that incident rays are reflected - in a range of angles. - facenormalsepsilon - Epsilon for face normals calculation avoids math issues - arising from degenerate geometry. - fresnel - Represents the reflectance as a dependency of the - viewing angle; e.g. paper is reflective when viewing it - from the edge of the paper (almost 90 degrees), causing - shine. - roughness - Alters specular reflection; the rougher the surface, - the wider and less contrasty the shine. - specular - Represents the level that incident rays are reflected - in a single direction, causing shine. - vertexnormalsepsilon - Epsilon for vertex normals calculation avoids math - issues arising from degenerate geometry. - - Returns - ------- - Lighting - """ - super(Lighting, self).__init__('lighting') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.Lighting -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Lighting""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface import (lighting as v_lighting) - - # Initialize validators - # --------------------- - self._validators['ambient'] = v_lighting.AmbientValidator() - self._validators['diffuse'] = v_lighting.DiffuseValidator() - self._validators['facenormalsepsilon' - ] = v_lighting.FacenormalsepsilonValidator() - self._validators['fresnel'] = v_lighting.FresnelValidator() - self._validators['roughness'] = v_lighting.RoughnessValidator() - self._validators['specular'] = v_lighting.SpecularValidator() - self._validators['vertexnormalsepsilon' - ] = v_lighting.VertexnormalsepsilonValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('ambient', None) - self['ambient'] = ambient if ambient is not None else _v - _v = arg.pop('diffuse', None) - self['diffuse'] = diffuse if diffuse is not None else _v - _v = arg.pop('facenormalsepsilon', None) - self['facenormalsepsilon' - ] = facenormalsepsilon if facenormalsepsilon is not None else _v - _v = arg.pop('fresnel', None) - self['fresnel'] = fresnel if fresnel is not None else _v - _v = arg.pop('roughness', None) - self['roughness'] = roughness if roughness is not None else _v - _v = arg.pop('specular', None) - self['specular'] = specular if specular is not None else _v - _v = arg.pop('vertexnormalsepsilon', None) - self[ - 'vertexnormalsepsilon' - ] = vertexnormalsepsilon if vertexnormalsepsilon is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/_lightposition.py b/plotly/graph_objs/isosurface/_lightposition.py deleted file mode 100644 index 7445accadf9..00000000000 --- a/plotly/graph_objs/isosurface/_lightposition.py +++ /dev/null @@ -1,162 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Lightposition(BaseTraceHierarchyType): - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # z - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - Numeric vector, representing the X coordinate for each - vertex. - y - Numeric vector, representing the Y coordinate for each - vertex. - z - Numeric vector, representing the Z coordinate for each - vertex. - """ - - def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): - """ - Construct a new Lightposition object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.isosurface.Lightposition - x - Numeric vector, representing the X coordinate for each - vertex. - y - Numeric vector, representing the Y coordinate for each - vertex. - z - Numeric vector, representing the Z coordinate for each - vertex. - - Returns - ------- - Lightposition - """ - super(Lightposition, self).__init__('lightposition') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.Lightposition -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Lightposition""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface import ( - lightposition as v_lightposition - ) - - # Initialize validators - # --------------------- - self._validators['x'] = v_lightposition.XValidator() - self._validators['y'] = v_lightposition.YValidator() - self._validators['z'] = v_lightposition.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/_slices.py b/plotly/graph_objs/isosurface/_slices.py deleted file mode 100644 index d791d1dc8dc..00000000000 --- a/plotly/graph_objs/isosurface/_slices.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Slices(BaseTraceHierarchyType): - - # x - # - - @property - def x(self): - """ - The 'x' property is an instance of X - that may be specified as: - - An instance of 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 - 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. - locations - Specifies the location(s) of slices on the - axis. When not locations specified slices would - be created for all points of the axis x except - start and end. - locationssrc - Sets the source reference on plot.ly for - locations . - show - Determines whether or not slice planes about - the x dimension are drawn. - - Returns - ------- - plotly.graph_objs.isosurface.slices.X - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @property - def y(self): - """ - The 'y' property is an instance of Y - that may be specified as: - - An instance of 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 - 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. - locations - Specifies the location(s) of slices on the - axis. When not locations specified slices would - be created for all points of the axis y except - start and end. - locationssrc - Sets the source reference on plot.ly for - locations . - show - Determines whether or not slice planes about - the y dimension are drawn. - - Returns - ------- - plotly.graph_objs.isosurface.slices.Y - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # z - # - - @property - def z(self): - """ - The 'z' property is an instance of Z - that may be specified as: - - An instance of 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 - 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. - locations - Specifies the location(s) of slices on the - axis. When not locations specified slices would - be created for all points of the axis z except - start and end. - locationssrc - Sets the source reference on plot.ly for - locations . - show - Determines whether or not slice planes about - the z dimension are drawn. - - Returns - ------- - plotly.graph_objs.isosurface.slices.Z - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - plotly.graph_objs.isosurface.slices.X instance or dict - with compatible properties - y - plotly.graph_objs.isosurface.slices.Y instance or dict - with compatible properties - z - plotly.graph_objs.isosurface.slices.Z instance or dict - with compatible properties - """ - - def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): - """ - Construct a new Slices object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.Slices - x - plotly.graph_objs.isosurface.slices.X instance or dict - with compatible properties - y - plotly.graph_objs.isosurface.slices.Y instance or dict - with compatible properties - z - plotly.graph_objs.isosurface.slices.Z instance or dict - with compatible properties - - Returns - ------- - Slices - """ - super(Slices, self).__init__('slices') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.Slices -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Slices""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface import (slices as v_slices) - - # Initialize validators - # --------------------- - self._validators['x'] = v_slices.XValidator() - self._validators['y'] = v_slices.YValidator() - self._validators['z'] = v_slices.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/_spaceframe.py b/plotly/graph_objs/isosurface/_spaceframe.py deleted file mode 100644 index 084a1cdace1..00000000000 --- a/plotly/graph_objs/isosurface/_spaceframe.py +++ /dev/null @@ -1,148 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Spaceframe(BaseTraceHierarchyType): - - # fill - # ---- - @property - def fill(self): - """ - Sets the fill ratio of the `spaceframe` elements. The default - fill value is 0.15 meaning that only 15% of the area of every - faces of tetras would be shaded. Applying a greater `fill` - ratio would allow the creation of stronger elements or could be - sued to have entirely closed areas (in case of using 1). - - The 'fill' property is a number and may be specified as: - - An int or float in the interval [0, 1] - - Returns - ------- - int|float - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # show - # ---- - @property - 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) - - Returns - ------- - bool - """ - return self['show'] - - @show.setter - def show(self, val): - self['show'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - fill - Sets the fill ratio of the `spaceframe` elements. The - default fill value is 0.15 meaning that only 15% of the - area of every faces of tetras would be shaded. Applying - a greater `fill` ratio would allow the creation of - stronger elements or could be sued to have entirely - closed areas (in case of using 1). - show - Displays/hides tetrahedron shapes between minimum and - maximum iso-values. Often useful when either caps or - surfaces are disabled or filled with values less than - 1. - """ - - def __init__(self, arg=None, fill=None, show=None, **kwargs): - """ - Construct a new Spaceframe object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.Spaceframe - fill - Sets the fill ratio of the `spaceframe` elements. The - default fill value is 0.15 meaning that only 15% of the - area of every faces of tetras would be shaded. Applying - a greater `fill` ratio would allow the creation of - stronger elements or could be sued to have entirely - closed areas (in case of using 1). - show - Displays/hides tetrahedron shapes between minimum and - maximum iso-values. Often useful when either caps or - surfaces are disabled or filled with values less than - 1. - - Returns - ------- - Spaceframe - """ - super(Spaceframe, self).__init__('spaceframe') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.Spaceframe -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Spaceframe""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface import (spaceframe as v_spaceframe) - - # Initialize validators - # --------------------- - self._validators['fill'] = v_spaceframe.FillValidator() - self._validators['show'] = v_spaceframe.ShowValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('show', None) - self['show'] = show if show is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/_stream.py b/plotly/graph_objs/isosurface/_stream.py deleted file mode 100644 index 0f62dc3dec7..00000000000 --- a/plotly/graph_objs/isosurface/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.Stream -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/_surface.py b/plotly/graph_objs/isosurface/_surface.py deleted file mode 100644 index d12cbe06229..00000000000 --- a/plotly/graph_objs/isosurface/_surface.py +++ /dev/null @@ -1,233 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Surface(BaseTraceHierarchyType): - - # count - # ----- - @property - 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] - - Returns - ------- - int - """ - return self['count'] - - @count.setter - def count(self, val): - self['count'] = val - - # fill - # ---- - @property - def fill(self): - """ - Sets the fill ratio of the iso-surface. The default fill value - of the surface is 1 meaning that they are entirely shaded. On - the other hand Applying a `fill` ratio less than one would - allow the creation of openings parallel to the edges. - - The 'fill' property is a number and may be specified as: - - An int or float in the interval [0, 1] - - Returns - ------- - int|float - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # pattern - # ------- - @property - def pattern(self): - """ - Sets the surface pattern of the iso-surface 3-D sections. The - default pattern of the surface is `all` meaning that the rest - of surface elements would be shaded. The check options (either - 1 or 2) could be used to draw half of the squares on the - surface. Using various combinations of capital `A`, `B`, `C`, - `D` and `E` may also be used to reduce the number of triangles - on the iso-surfaces and creating other patterns of interest. - - 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 - (e.g. 'A+B') - OR exactly one of ['all', 'odd', 'even'] (e.g. 'even') - - Returns - ------- - Any - """ - return self['pattern'] - - @pattern.setter - def pattern(self, val): - self['pattern'] = val - - # show - # ---- - @property - 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) - - Returns - ------- - bool - """ - return self['show'] - - @show.setter - def show(self, val): - self['show'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - count - Sets the number of iso-surfaces between minimum and - maximum iso-values. By default this value is 2 meaning - that only minimum and maximum surfaces would be drawn. - fill - Sets the fill ratio of the iso-surface. The default - fill value of the surface is 1 meaning that they are - entirely shaded. On the other hand Applying a `fill` - ratio less than one would allow the creation of - openings parallel to the edges. - pattern - Sets the surface pattern of the iso-surface 3-D - sections. The default pattern of the surface is `all` - meaning that the rest of surface elements would be - shaded. The check options (either 1 or 2) could be used - to draw half of the squares on the surface. Using - various combinations of capital `A`, `B`, `C`, `D` and - `E` may also be used to reduce the number of triangles - on the iso-surfaces and creating other patterns of - interest. - show - Hides/displays surfaces between minimum and maximum - iso-values. - """ - - def __init__( - self, - arg=None, - count=None, - fill=None, - pattern=None, - show=None, - **kwargs - ): - """ - Construct a new Surface object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.Surface - count - Sets the number of iso-surfaces between minimum and - maximum iso-values. By default this value is 2 meaning - that only minimum and maximum surfaces would be drawn. - fill - Sets the fill ratio of the iso-surface. The default - fill value of the surface is 1 meaning that they are - entirely shaded. On the other hand Applying a `fill` - ratio less than one would allow the creation of - openings parallel to the edges. - pattern - Sets the surface pattern of the iso-surface 3-D - sections. The default pattern of the surface is `all` - meaning that the rest of surface elements would be - shaded. The check options (either 1 or 2) could be used - to draw half of the squares on the surface. Using - various combinations of capital `A`, `B`, `C`, `D` and - `E` may also be used to reduce the number of triangles - on the iso-surfaces and creating other patterns of - interest. - show - Hides/displays surfaces between minimum and maximum - iso-values. - - Returns - ------- - Surface - """ - super(Surface, self).__init__('surface') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.Surface -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.Surface""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface import (surface as v_surface) - - # Initialize validators - # --------------------- - self._validators['count'] = v_surface.CountValidator() - self._validators['fill'] = v_surface.FillValidator() - self._validators['pattern'] = v_surface.PatternValidator() - self._validators['show'] = v_surface.ShowValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('count', None) - self['count'] = count if count is not None else _v - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('pattern', None) - self['pattern'] = pattern if pattern is not None else _v - _v = arg.pop('show', None) - self['show'] = show if show is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/caps/__init__.py b/plotly/graph_objs/isosurface/caps/__init__.py index a9611dfd9fb..1013cb6dc97 100644 --- a/plotly/graph_objs/isosurface/caps/__init__.py +++ b/plotly/graph_objs/isosurface/caps/__init__.py @@ -1,3 +1,450 @@ -from ._z import Z -from ._y import Y -from ._x import X + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Z(_BaseTraceHierarchyType): + + # fill + # ---- + @property + def fill(self): + """ + Sets the fill ratio of the `caps`. The default fill value of + 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] + + Returns + ------- + int|float + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # show + # ---- + @property + def show(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + 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) + + Returns + ------- + bool + """ + return self['show'] + + @show.setter + def show(self, val): + self['show'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface.caps' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `caps`. The default fill + value of 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. + show + Sets the fill ratio of the `slices`. The default fill + value of 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. + """ + + def __init__(self, arg=None, fill=None, show=None, **kwargs): + """ + Construct a new Z object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.isosurface.caps.Z + fill + Sets the fill ratio of the `caps`. The default fill + value of 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. + show + Sets the fill ratio of the `slices`. The default fill + value of 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. + + Returns + ------- + Z + """ + super(Z, self).__init__('z') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.caps.Z +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.caps.Z""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface.caps import (z as v_z) + + # Initialize validators + # --------------------- + self._validators['fill'] = v_z.FillValidator() + self._validators['show'] = v_z.ShowValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('show', None) + self['show'] = show if show is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Y(_BaseTraceHierarchyType): + + # fill + # ---- + @property + def fill(self): + """ + Sets the fill ratio of the `caps`. The default fill value of + 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] + + Returns + ------- + int|float + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # show + # ---- + @property + def show(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + 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) + + Returns + ------- + bool + """ + return self['show'] + + @show.setter + def show(self, val): + self['show'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface.caps' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `caps`. The default fill + value of 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. + show + Sets the fill ratio of the `slices`. The default fill + value of 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. + """ + + def __init__(self, arg=None, fill=None, show=None, **kwargs): + """ + Construct a new Y object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.isosurface.caps.Y + fill + Sets the fill ratio of the `caps`. The default fill + value of 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. + show + Sets the fill ratio of the `slices`. The default fill + value of 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. + + Returns + ------- + Y + """ + super(Y, self).__init__('y') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.caps.Y +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.caps.Y""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface.caps import (y as v_y) + + # Initialize validators + # --------------------- + self._validators['fill'] = v_y.FillValidator() + self._validators['show'] = v_y.ShowValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('show', None) + self['show'] = show if show is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class X(_BaseTraceHierarchyType): + + # fill + # ---- + @property + def fill(self): + """ + Sets the fill ratio of the `caps`. The default fill value of + 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] + + Returns + ------- + int|float + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # show + # ---- + @property + def show(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + 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) + + Returns + ------- + bool + """ + return self['show'] + + @show.setter + def show(self, val): + self['show'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface.caps' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `caps`. The default fill + value of 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. + show + Sets the fill ratio of the `slices`. The default fill + value of 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. + """ + + def __init__(self, arg=None, fill=None, show=None, **kwargs): + """ + Construct a new X object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.isosurface.caps.X + fill + Sets the fill ratio of the `caps`. The default fill + value of 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. + show + Sets the fill ratio of the `slices`. The default fill + value of 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. + + Returns + ------- + X + """ + super(X, self).__init__('x') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.caps.X +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.caps.X""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface.caps import (x as v_x) + + # Initialize validators + # --------------------- + self._validators['fill'] = v_x.FillValidator() + self._validators['show'] = v_x.ShowValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('show', None) + self['show'] = show if show is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/caps/_x.py b/plotly/graph_objs/isosurface/caps/_x.py deleted file mode 100644 index c38291a5ac6..00000000000 --- a/plotly/graph_objs/isosurface/caps/_x.py +++ /dev/null @@ -1,148 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class X(BaseTraceHierarchyType): - - # fill - # ---- - @property - def fill(self): - """ - Sets the fill ratio of the `caps`. The default fill value of - 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] - - Returns - ------- - int|float - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # show - # ---- - @property - def show(self): - """ - Sets the fill ratio of the `slices`. The default fill value of - 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) - - Returns - ------- - bool - """ - return self['show'] - - @show.setter - def show(self, val): - self['show'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface.caps' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - fill - Sets the fill ratio of the `caps`. The default fill - value of 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. - show - Sets the fill ratio of the `slices`. The default fill - value of 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. - """ - - def __init__(self, arg=None, fill=None, show=None, **kwargs): - """ - Construct a new X object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.caps.X - fill - Sets the fill ratio of the `caps`. The default fill - value of 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. - show - Sets the fill ratio of the `slices`. The default fill - value of 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. - - Returns - ------- - X - """ - super(X, self).__init__('x') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.caps.X -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.caps.X""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface.caps import (x as v_x) - - # Initialize validators - # --------------------- - self._validators['fill'] = v_x.FillValidator() - self._validators['show'] = v_x.ShowValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('show', None) - self['show'] = show if show is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/caps/_y.py b/plotly/graph_objs/isosurface/caps/_y.py deleted file mode 100644 index 51a060aa40c..00000000000 --- a/plotly/graph_objs/isosurface/caps/_y.py +++ /dev/null @@ -1,148 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Y(BaseTraceHierarchyType): - - # fill - # ---- - @property - def fill(self): - """ - Sets the fill ratio of the `caps`. The default fill value of - 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] - - Returns - ------- - int|float - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # show - # ---- - @property - def show(self): - """ - Sets the fill ratio of the `slices`. The default fill value of - 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) - - Returns - ------- - bool - """ - return self['show'] - - @show.setter - def show(self, val): - self['show'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface.caps' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - fill - Sets the fill ratio of the `caps`. The default fill - value of 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. - show - Sets the fill ratio of the `slices`. The default fill - value of 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. - """ - - def __init__(self, arg=None, fill=None, show=None, **kwargs): - """ - Construct a new Y object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.caps.Y - fill - Sets the fill ratio of the `caps`. The default fill - value of 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. - show - Sets the fill ratio of the `slices`. The default fill - value of 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. - - Returns - ------- - Y - """ - super(Y, self).__init__('y') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.caps.Y -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.caps.Y""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface.caps import (y as v_y) - - # Initialize validators - # --------------------- - self._validators['fill'] = v_y.FillValidator() - self._validators['show'] = v_y.ShowValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('show', None) - self['show'] = show if show is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/caps/_z.py b/plotly/graph_objs/isosurface/caps/_z.py deleted file mode 100644 index 9d22dd574f0..00000000000 --- a/plotly/graph_objs/isosurface/caps/_z.py +++ /dev/null @@ -1,148 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Z(BaseTraceHierarchyType): - - # fill - # ---- - @property - def fill(self): - """ - Sets the fill ratio of the `caps`. The default fill value of - 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] - - Returns - ------- - int|float - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # show - # ---- - @property - def show(self): - """ - Sets the fill ratio of the `slices`. The default fill value of - 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) - - Returns - ------- - bool - """ - return self['show'] - - @show.setter - def show(self, val): - self['show'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface.caps' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - fill - Sets the fill ratio of the `caps`. The default fill - value of 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. - show - Sets the fill ratio of the `slices`. The default fill - value of 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. - """ - - def __init__(self, arg=None, fill=None, show=None, **kwargs): - """ - Construct a new Z object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.caps.Z - fill - Sets the fill ratio of the `caps`. The default fill - value of 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. - show - Sets the fill ratio of the `slices`. The default fill - value of 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. - - Returns - ------- - Z - """ - super(Z, self).__init__('z') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.caps.Z -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.caps.Z""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface.caps import (z as v_z) - - # Initialize validators - # --------------------- - self._validators['fill'] = v_z.FillValidator() - self._validators['show'] = v_z.ShowValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('show', None) - self['show'] = show if show is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/colorbar/__init__.py b/plotly/graph_objs/isosurface/colorbar/__init__.py index 41d33056e80..c1da8c53e1e 100644 --- a/plotly/graph_objs/isosurface/colorbar/__init__.py +++ b/plotly/graph_objs/isosurface/colorbar/__init__.py @@ -1,4 +1,723 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.isosurface.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.isosurface.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface.colorbar import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.isosurface.colorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.isosurface.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.isosurface.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/isosurface/colorbar/_tickfont.py b/plotly/graph_objs/isosurface/colorbar/_tickfont.py deleted file mode 100644 index ad37e81a7fc..00000000000 --- a/plotly/graph_objs/isosurface/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.isosurface.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/colorbar/_tickformatstop.py b/plotly/graph_objs/isosurface/colorbar/_tickformatstop.py deleted file mode 100644 index cbf79008128..00000000000 --- a/plotly/graph_objs/isosurface/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.isosurface.colorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/colorbar/_title.py b/plotly/graph_objs/isosurface/colorbar/_title.py deleted file mode 100644 index a59e83799e5..00000000000 --- a/plotly/graph_objs/isosurface/colorbar/_title.py +++ /dev/null @@ -1,202 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.isosurface.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.isosurface.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface.colorbar import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/colorbar/title/__init__.py b/plotly/graph_objs/isosurface/colorbar/title/__init__.py index c37b8b5cd28..efc5048b3eb 100644 --- a/plotly/graph_objs/isosurface/colorbar/title/__init__.py +++ b/plotly/graph_objs/isosurface/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.isosurface.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/colorbar/title/_font.py b/plotly/graph_objs/isosurface/colorbar/title/_font.py deleted file mode 100644 index 5f622816389..00000000000 --- a/plotly/graph_objs/isosurface/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.isosurface.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/hoverlabel/__init__.py b/plotly/graph_objs/isosurface/hoverlabel/__init__.py index c37b8b5cd28..95e924ac452 100644 --- a/plotly/graph_objs/isosurface/hoverlabel/__init__.py +++ b/plotly/graph_objs/isosurface/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.isosurface.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/hoverlabel/_font.py b/plotly/graph_objs/isosurface/hoverlabel/_font.py deleted file mode 100644 index 6393e90a67d..00000000000 --- a/plotly/graph_objs/isosurface/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.isosurface.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/slices/__init__.py b/plotly/graph_objs/isosurface/slices/__init__.py index a9611dfd9fb..25c5fb54722 100644 --- a/plotly/graph_objs/isosurface/slices/__init__.py +++ b/plotly/graph_objs/isosurface/slices/__init__.py @@ -1,3 +1,630 @@ -from ._z import Z -from ._y import Y -from ._x import X + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Z(_BaseTraceHierarchyType): + + # fill + # ---- + @property + def fill(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + 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] + + Returns + ------- + int|float + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # locations + # --------- + @property + def locations(self): + """ + Specifies the location(s) of slices on the axis. When not + locations 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 + + Returns + ------- + numpy.ndarray + """ + return self['locations'] + + @locations.setter + def locations(self, val): + self['locations'] = val + + # locationssrc + # ------------ + @property + def locationssrc(self): + """ + Sets the source reference on plot.ly for locations . + + The 'locationssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['locationssrc'] + + @locationssrc.setter + def locationssrc(self, val): + self['locationssrc'] = val + + # show + # ---- + @property + 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) + + Returns + ------- + bool + """ + return self['show'] + + @show.setter + def show(self, val): + self['show'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface.slices' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `slices`. The default fill + value of 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. + locations + Specifies the location(s) of slices on the axis. When + not locations specified slices would be created for all + points of the axis z except start and end. + locationssrc + Sets the source reference on plot.ly for locations . + show + Determines whether or not slice planes about the z + dimension are drawn. + """ + + def __init__( + self, + arg=None, + fill=None, + locations=None, + locationssrc=None, + show=None, + **kwargs + ): + """ + Construct a new Z object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.isosurface.slices.Z + fill + Sets the fill ratio of the `slices`. The default fill + value of 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. + locations + Specifies the location(s) of slices on the axis. When + not locations specified slices would be created for all + points of the axis z except start and end. + locationssrc + Sets the source reference on plot.ly for locations . + show + Determines whether or not slice planes about the z + dimension are drawn. + + Returns + ------- + Z + """ + super(Z, self).__init__('z') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.slices.Z +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.slices.Z""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface.slices import (z as v_z) + + # Initialize validators + # --------------------- + self._validators['fill'] = v_z.FillValidator() + self._validators['locations'] = v_z.LocationsValidator() + self._validators['locationssrc'] = v_z.LocationssrcValidator() + self._validators['show'] = v_z.ShowValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('locations', None) + self['locations'] = locations if locations is not None else _v + _v = arg.pop('locationssrc', None) + self['locationssrc'] = locationssrc if locationssrc is not None else _v + _v = arg.pop('show', None) + self['show'] = show if show is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Y(_BaseTraceHierarchyType): + + # fill + # ---- + @property + def fill(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + 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] + + Returns + ------- + int|float + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # locations + # --------- + @property + def locations(self): + """ + Specifies the location(s) of slices on the axis. When not + locations 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 + + Returns + ------- + numpy.ndarray + """ + return self['locations'] + + @locations.setter + def locations(self, val): + self['locations'] = val + + # locationssrc + # ------------ + @property + def locationssrc(self): + """ + Sets the source reference on plot.ly for locations . + + The 'locationssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['locationssrc'] + + @locationssrc.setter + def locationssrc(self, val): + self['locationssrc'] = val + + # show + # ---- + @property + 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) + + Returns + ------- + bool + """ + return self['show'] + + @show.setter + def show(self, val): + self['show'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface.slices' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `slices`. The default fill + value of 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. + locations + Specifies the location(s) of slices on the axis. When + not locations specified slices would be created for all + points of the axis y except start and end. + locationssrc + Sets the source reference on plot.ly for locations . + show + Determines whether or not slice planes about the y + dimension are drawn. + """ + + def __init__( + self, + arg=None, + fill=None, + locations=None, + locationssrc=None, + show=None, + **kwargs + ): + """ + Construct a new Y object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.isosurface.slices.Y + fill + Sets the fill ratio of the `slices`. The default fill + value of 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. + locations + Specifies the location(s) of slices on the axis. When + not locations specified slices would be created for all + points of the axis y except start and end. + locationssrc + Sets the source reference on plot.ly for locations . + show + Determines whether or not slice planes about the y + dimension are drawn. + + Returns + ------- + Y + """ + super(Y, self).__init__('y') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.slices.Y +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.slices.Y""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface.slices import (y as v_y) + + # Initialize validators + # --------------------- + self._validators['fill'] = v_y.FillValidator() + self._validators['locations'] = v_y.LocationsValidator() + self._validators['locationssrc'] = v_y.LocationssrcValidator() + self._validators['show'] = v_y.ShowValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('locations', None) + self['locations'] = locations if locations is not None else _v + _v = arg.pop('locationssrc', None) + self['locationssrc'] = locationssrc if locationssrc is not None else _v + _v = arg.pop('show', None) + self['show'] = show if show is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class X(_BaseTraceHierarchyType): + + # fill + # ---- + @property + def fill(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + 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] + + Returns + ------- + int|float + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # locations + # --------- + @property + def locations(self): + """ + Specifies the location(s) of slices on the axis. When not + locations 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 + + Returns + ------- + numpy.ndarray + """ + return self['locations'] + + @locations.setter + def locations(self, val): + self['locations'] = val + + # locationssrc + # ------------ + @property + def locationssrc(self): + """ + Sets the source reference on plot.ly for locations . + + The 'locationssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['locationssrc'] + + @locationssrc.setter + def locationssrc(self, val): + self['locationssrc'] = val + + # show + # ---- + @property + 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) + + Returns + ------- + bool + """ + return self['show'] + + @show.setter + def show(self, val): + self['show'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'isosurface.slices' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `slices`. The default fill + value of 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. + locations + Specifies the location(s) of slices on the axis. When + not locations specified slices would be created for all + points of the axis x except start and end. + locationssrc + Sets the source reference on plot.ly for locations . + show + Determines whether or not slice planes about the x + dimension are drawn. + """ + + def __init__( + self, + arg=None, + fill=None, + locations=None, + locationssrc=None, + show=None, + **kwargs + ): + """ + Construct a new X object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.isosurface.slices.X + fill + Sets the fill ratio of the `slices`. The default fill + value of 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. + locations + Specifies the location(s) of slices on the axis. When + not locations specified slices would be created for all + points of the axis x except start and end. + locationssrc + Sets the source reference on plot.ly for locations . + show + Determines whether or not slice planes about the x + dimension are drawn. + + Returns + ------- + X + """ + super(X, self).__init__('x') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.isosurface.slices.X +constructor must be a dict or +an instance of plotly.graph_objs.isosurface.slices.X""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.isosurface.slices import (x as v_x) + + # Initialize validators + # --------------------- + self._validators['fill'] = v_x.FillValidator() + self._validators['locations'] = v_x.LocationsValidator() + self._validators['locationssrc'] = v_x.LocationssrcValidator() + self._validators['show'] = v_x.ShowValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('locations', None) + self['locations'] = locations if locations is not None else _v + _v = arg.pop('locationssrc', None) + self['locationssrc'] = locationssrc if locationssrc is not None else _v + _v = arg.pop('show', None) + self['show'] = show if show is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/slices/_x.py b/plotly/graph_objs/isosurface/slices/_x.py deleted file mode 100644 index 4ad02c17b6b..00000000000 --- a/plotly/graph_objs/isosurface/slices/_x.py +++ /dev/null @@ -1,208 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class X(BaseTraceHierarchyType): - - # fill - # ---- - @property - def fill(self): - """ - Sets the fill ratio of the `slices`. The default fill value of - 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] - - Returns - ------- - int|float - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # locations - # --------- - @property - def locations(self): - """ - Specifies the location(s) of slices on the axis. When not - locations 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 - - Returns - ------- - numpy.ndarray - """ - return self['locations'] - - @locations.setter - def locations(self, val): - self['locations'] = val - - # locationssrc - # ------------ - @property - def locationssrc(self): - """ - Sets the source reference on plot.ly for locations . - - The 'locationssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['locationssrc'] - - @locationssrc.setter - def locationssrc(self, val): - self['locationssrc'] = val - - # show - # ---- - @property - 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) - - Returns - ------- - bool - """ - return self['show'] - - @show.setter - def show(self, val): - self['show'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface.slices' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - fill - Sets the fill ratio of the `slices`. The default fill - value of 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. - locations - Specifies the location(s) of slices on the axis. When - not locations specified slices would be created for all - points of the axis x except start and end. - locationssrc - Sets the source reference on plot.ly for locations . - show - Determines whether or not slice planes about the x - dimension are drawn. - """ - - def __init__( - self, - arg=None, - fill=None, - locations=None, - locationssrc=None, - show=None, - **kwargs - ): - """ - Construct a new X object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.slices.X - fill - Sets the fill ratio of the `slices`. The default fill - value of 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. - locations - Specifies the location(s) of slices on the axis. When - not locations specified slices would be created for all - points of the axis x except start and end. - locationssrc - Sets the source reference on plot.ly for locations . - show - Determines whether or not slice planes about the x - dimension are drawn. - - Returns - ------- - X - """ - super(X, self).__init__('x') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.slices.X -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.slices.X""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface.slices import (x as v_x) - - # Initialize validators - # --------------------- - self._validators['fill'] = v_x.FillValidator() - self._validators['locations'] = v_x.LocationsValidator() - self._validators['locationssrc'] = v_x.LocationssrcValidator() - self._validators['show'] = v_x.ShowValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('locations', None) - self['locations'] = locations if locations is not None else _v - _v = arg.pop('locationssrc', None) - self['locationssrc'] = locationssrc if locationssrc is not None else _v - _v = arg.pop('show', None) - self['show'] = show if show is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/slices/_y.py b/plotly/graph_objs/isosurface/slices/_y.py deleted file mode 100644 index 83ecd3545ce..00000000000 --- a/plotly/graph_objs/isosurface/slices/_y.py +++ /dev/null @@ -1,208 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Y(BaseTraceHierarchyType): - - # fill - # ---- - @property - def fill(self): - """ - Sets the fill ratio of the `slices`. The default fill value of - 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] - - Returns - ------- - int|float - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # locations - # --------- - @property - def locations(self): - """ - Specifies the location(s) of slices on the axis. When not - locations 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 - - Returns - ------- - numpy.ndarray - """ - return self['locations'] - - @locations.setter - def locations(self, val): - self['locations'] = val - - # locationssrc - # ------------ - @property - def locationssrc(self): - """ - Sets the source reference on plot.ly for locations . - - The 'locationssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['locationssrc'] - - @locationssrc.setter - def locationssrc(self, val): - self['locationssrc'] = val - - # show - # ---- - @property - 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) - - Returns - ------- - bool - """ - return self['show'] - - @show.setter - def show(self, val): - self['show'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface.slices' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - fill - Sets the fill ratio of the `slices`. The default fill - value of 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. - locations - Specifies the location(s) of slices on the axis. When - not locations specified slices would be created for all - points of the axis y except start and end. - locationssrc - Sets the source reference on plot.ly for locations . - show - Determines whether or not slice planes about the y - dimension are drawn. - """ - - def __init__( - self, - arg=None, - fill=None, - locations=None, - locationssrc=None, - show=None, - **kwargs - ): - """ - Construct a new Y object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.slices.Y - fill - Sets the fill ratio of the `slices`. The default fill - value of 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. - locations - Specifies the location(s) of slices on the axis. When - not locations specified slices would be created for all - points of the axis y except start and end. - locationssrc - Sets the source reference on plot.ly for locations . - show - Determines whether or not slice planes about the y - dimension are drawn. - - Returns - ------- - Y - """ - super(Y, self).__init__('y') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.slices.Y -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.slices.Y""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface.slices import (y as v_y) - - # Initialize validators - # --------------------- - self._validators['fill'] = v_y.FillValidator() - self._validators['locations'] = v_y.LocationsValidator() - self._validators['locationssrc'] = v_y.LocationssrcValidator() - self._validators['show'] = v_y.ShowValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('locations', None) - self['locations'] = locations if locations is not None else _v - _v = arg.pop('locationssrc', None) - self['locationssrc'] = locationssrc if locationssrc is not None else _v - _v = arg.pop('show', None) - self['show'] = show if show is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/isosurface/slices/_z.py b/plotly/graph_objs/isosurface/slices/_z.py deleted file mode 100644 index 4f00ef687e6..00000000000 --- a/plotly/graph_objs/isosurface/slices/_z.py +++ /dev/null @@ -1,208 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Z(BaseTraceHierarchyType): - - # fill - # ---- - @property - def fill(self): - """ - Sets the fill ratio of the `slices`. The default fill value of - 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] - - Returns - ------- - int|float - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # locations - # --------- - @property - def locations(self): - """ - Specifies the location(s) of slices on the axis. When not - locations 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 - - Returns - ------- - numpy.ndarray - """ - return self['locations'] - - @locations.setter - def locations(self, val): - self['locations'] = val - - # locationssrc - # ------------ - @property - def locationssrc(self): - """ - Sets the source reference on plot.ly for locations . - - The 'locationssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['locationssrc'] - - @locationssrc.setter - def locationssrc(self, val): - self['locationssrc'] = val - - # show - # ---- - @property - 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) - - Returns - ------- - bool - """ - return self['show'] - - @show.setter - def show(self, val): - self['show'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'isosurface.slices' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - fill - Sets the fill ratio of the `slices`. The default fill - value of 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. - locations - Specifies the location(s) of slices on the axis. When - not locations specified slices would be created for all - points of the axis z except start and end. - locationssrc - Sets the source reference on plot.ly for locations . - show - Determines whether or not slice planes about the z - dimension are drawn. - """ - - def __init__( - self, - arg=None, - fill=None, - locations=None, - locationssrc=None, - show=None, - **kwargs - ): - """ - Construct a new Z object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.isosurface.slices.Z - fill - Sets the fill ratio of the `slices`. The default fill - value of 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. - locations - Specifies the location(s) of slices on the axis. When - not locations specified slices would be created for all - points of the axis z except start and end. - locationssrc - Sets the source reference on plot.ly for locations . - show - Determines whether or not slice planes about the z - dimension are drawn. - - Returns - ------- - Z - """ - super(Z, self).__init__('z') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.isosurface.slices.Z -constructor must be a dict or -an instance of plotly.graph_objs.isosurface.slices.Z""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.isosurface.slices import (z as v_z) - - # Initialize validators - # --------------------- - self._validators['fill'] = v_z.FillValidator() - self._validators['locations'] = v_z.LocationsValidator() - self._validators['locationssrc'] = v_z.LocationssrcValidator() - self._validators['show'] = v_z.ShowValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('locations', None) - self['locations'] = locations if locations is not None else _v - _v = arg.pop('locationssrc', None) - self['locationssrc'] = locationssrc if locationssrc is not None else _v - _v = arg.pop('show', None) - self['show'] = show if show is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/__init__.py b/plotly/graph_objs/layout/__init__.py index ddca4a39b22..15832f41ea1 100644 --- a/plotly/graph_objs/layout/__init__.py +++ b/plotly/graph_objs/layout/__init__.py @@ -1,40 +1,21861 @@ -from ._yaxis import YAxis + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class YAxis(_BaseLayoutHierarchyType): + + # anchor + # ------ + @property + 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'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?$', '^y([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + Any + """ + return self['anchor'] + + @anchor.setter + def anchor(self, val): + self['anchor'] = val + + # automargin + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['automargin'] + + @automargin.setter + def automargin(self, val): + self['automargin'] = val + + # autorange + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['autorange'] + + @autorange.setter + def autorange(self, val): + self['autorange'] = val + + # calendar + # -------- + @property + def calendar(self): + """ + Sets the calendar system to use for `range` and `tick0` if this + is a date axis. This does not set the calendar for interpreting + data on this axis, that's specified in the trace or via the + global `layout.calendar` + + The 'calendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['gregorian', 'chinese', 'coptic', 'discworld', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['calendar'] + + @calendar.setter + def calendar(self, val): + self['calendar'] = val + + # categoryarray + # ------------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['categoryarray'] + + @categoryarray.setter + def categoryarray(self, val): + self['categoryarray'] = val + + # categoryarraysrc + # ---------------- + @property + def categoryarraysrc(self): + """ + Sets the source reference on plot.ly for categoryarray . + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['categoryarraysrc'] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self['categoryarraysrc'] = val + + # categoryorder + # ------------- + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array'] + + Returns + ------- + Any + """ + return self['categoryorder'] + + @categoryorder.setter + def categoryorder(self, val): + self['categoryorder'] = val + + # color + # ----- + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # constrain + # --------- + @property + def constrain(self): + """ + If this axis needs to be compressed (either due to its own + `scaleanchor` and `scaleratio` or those of the other axis), + determines how that happens: by increasing the "range" + (default), or by decreasing the "domain". + + The 'constrain' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['range', 'domain'] + + Returns + ------- + Any + """ + return self['constrain'] + + @constrain.setter + def constrain(self, val): + self['constrain'] = val + + # constraintoward + # --------------- + @property + def constraintoward(self): + """ + If this axis needs to be compressed (either due to its own + `scaleanchor` and `scaleratio` or those of the other axis), + determines which direction we push the originally specified + plot area. Options are "left", "center" (default), and "right" + for x axes, and "top", "middle" (default), and "bottom" for y + axes. + + The 'constraintoward' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right', 'top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self['constraintoward'] + + @constraintoward.setter + def constraintoward(self, val): + self['constraintoward'] = val + + # dividercolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['dividercolor'] + + @dividercolor.setter + def dividercolor(self, val): + self['dividercolor'] = val + + # dividerwidth + # ------------ + @property + 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 + + Returns + ------- + int|float + """ + return self['dividerwidth'] + + @dividerwidth.setter + def dividerwidth(self, val): + self['dividerwidth'] = val + + # domain + # ------ + @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] + + Returns + ------- + list + """ + return self['domain'] + + @domain.setter + def domain(self, val): + self['domain'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # fixedrange + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['fixedrange'] + + @fixedrange.setter + def fixedrange(self, val): + self['fixedrange'] = val + + # gridcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['gridcolor'] + + @gridcolor.setter + def gridcolor(self, val): + self['gridcolor'] = val + + # gridwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['gridwidth'] + + @gridwidth.setter + def gridwidth(self, val): + self['gridwidth'] = val + + # hoverformat + # ----------- + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['hoverformat'] + + @hoverformat.setter + def hoverformat(self, val): + self['hoverformat'] = val + + # layer + # ----- + @property + def layer(self): + """ + Sets the layer on which this axis is displayed. If *above + traces*, this axis is displayed above all the subplot's traces + If *below traces*, this axis is displayed below all the + subplot's traces, but above the grid lines. Useful when used + together with scatter-like traces with `cliponaxis` set to + False to show markers and/or text nodes above this axis. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['above traces', 'below traces'] + + Returns + ------- + Any + """ + return self['layer'] + + @layer.setter + def layer(self, val): + self['layer'] = val + + # linecolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['linecolor'] + + @linecolor.setter + def linecolor(self, val): + self['linecolor'] = val + + # linewidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['linewidth'] + + @linewidth.setter + def linewidth(self, val): + self['linewidth'] = val + + # matches + # ------- + @property + def matches(self): + """ + If set to another axis id (e.g. `x2`, `y`), the range of this + axis will match the range of the corresponding axis in data- + coordinates space. Moreover, matching axes share auto-range + values, category lists and histogram auto-bins. Note that + setting axes simultaneously in both a `scaleanchor` and a + `matches` constraint is currently forbidden. Moreover, note + that matching axes must have the same `type`. + + 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]+)?$', '^y([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + Any + """ + return self['matches'] + + @matches.setter + def matches(self, val): + self['matches'] = val + + # mirror + # ------ + @property + def mirror(self): + """ + Determines if the axis lines or/and ticks are mirrored to the + opposite side of the plotting area. If True, the axis lines are + mirrored. If "ticks", the axis lines and ticks are mirrored. If + False, mirroring is disable. If "all", axis lines are mirrored + on all shared-axes subplots. If "allticks", axis lines and + ticks are mirrored on all shared-axes subplots. + + The 'mirror' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, 'ticks', False, 'all', 'allticks'] + + Returns + ------- + Any + """ + return self['mirror'] + + @mirror.setter + def mirror(self, val): + self['mirror'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # overlaying + # ---------- + @property + def overlaying(self): + """ + If set a same-letter axis id, this axis is overlaid on top of + the corresponding same-letter axis, with traces and axes + visible for both axes. If False, this axis does not overlay any + same-letter axes. In this case, for axes with overlapping + domains only the highest-numbered axis will be visible. + + The 'overlaying' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['free'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?$', '^y([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + Any + """ + return self['overlaying'] + + @overlaying.setter + def overlaying(self, val): + self['overlaying'] = val + + # position + # -------- + @property + 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] + + Returns + ------- + int|float + """ + return self['position'] + + @position.setter + def position(self, val): + self['position'] = val + + # range + # ----- + @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 + + Returns + ------- + list + """ + return self['range'] + + @range.setter + def range(self, val): + self['range'] = val + + # rangemode + # --------- + @property + def rangemode(self): + """ + If "normal", the range is computed in relation to the extrema + of the input data. If *tozero*`, the range extends to 0, + regardless of the input data If "nonnegative", the range is + non-negative, regardless of the input data. Applies only to + linear axes. + + The 'rangemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'tozero', 'nonnegative'] + + Returns + ------- + Any + """ + return self['rangemode'] + + @rangemode.setter + def rangemode(self, val): + self['rangemode'] = val + + # scaleanchor + # ----------- + @property + def scaleanchor(self): + """ + If set to another axis id (e.g. `x2`, `y`), the range of this + axis changes together with the range of the corresponding axis + such that the scale of pixels per unit is in a constant ratio. + Both axes are still zoomable, but when you zoom one, the other + will zoom the same amount, keeping a fixed midpoint. + `constrain` and `constraintoward` determine how we enforce the + constraint. You can chain these, ie `yaxis: {scaleanchor: *x*}, + xaxis2: {scaleanchor: *y*}` but you can only link axes of the + same `type`. The linked axis can have the opposite letter (to + constrain the aspect ratio) or the same letter (to match scales + across subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: + {scaleanchor: *y*}` or longer) are redundant and the last + constraint encountered will be ignored to avoid possible + inconsistent constraints via `scaleratio`. Note that setting + axes simultaneously in both a `scaleanchor` and a `matches` + constraint is currently forbidden. + + 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]+)?$', '^y([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + Any + """ + return self['scaleanchor'] + + @scaleanchor.setter + def scaleanchor(self, val): + self['scaleanchor'] = val + + # scaleratio + # ---------- + @property + def scaleratio(self): + """ + If this axis is linked to another by `scaleanchor`, this + determines the pixel to unit scale ratio. For example, if this + value is 10, then every unit on this axis spans 10 times the + number of pixels as a unit on the linked axis. Use this for + example to create an elevation profile where the vertical scale + is exaggerated a fixed amount with respect to the horizontal. + + The 'scaleratio' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self['scaleratio'] + + @scaleratio.setter + def scaleratio(self, val): + self['scaleratio'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showdividers + # ------------ + @property + 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) + + Returns + ------- + bool + """ + return self['showdividers'] + + @showdividers.setter + def showdividers(self, val): + self['showdividers'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showgrid + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showgrid'] + + @showgrid.setter + def showgrid(self, val): + self['showgrid'] = val + + # showline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showline'] + + @showline.setter + def showline(self, val): + self['showline'] = val + + # showspikes + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showspikes'] + + @showspikes.setter + def showspikes(self, val): + self['showspikes'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # spikecolor + # ---------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['spikecolor'] + + @spikecolor.setter + def spikecolor(self, val): + self['spikecolor'] = val + + # spikedash + # --------- + @property + def spikedash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'spikedash' property is a string and must be specified as: + - One of the following strings: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', + 'longdashdot'] + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['spikedash'] + + @spikedash.setter + def spikedash(self, val): + self['spikedash'] = val + + # spikemode + # --------- + @property + def spikemode(self): + """ + Determines the drawing mode for the spike line If "toaxis", the + line is drawn from the data point to the axis the series is + plotted on. If "across", the line is drawn across the entire + plot area, and supercedes "toaxis". If "marker", then a marker + dot is drawn on the axis the series is plotted on + + The 'spikemode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['toaxis', 'across', 'marker'] joined with '+' characters + (e.g. 'toaxis+across') + + Returns + ------- + Any + """ + return self['spikemode'] + + @spikemode.setter + def spikemode(self, val): + self['spikemode'] = val + + # spikesnap + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['spikesnap'] + + @spikesnap.setter + def spikesnap(self, val): + self['spikesnap'] = val + + # spikethickness + # -------------- + @property + 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 + + Returns + ------- + int|float + """ + return self['spikethickness'] + + @spikethickness.setter + def spikethickness(self, val): + self['spikethickness'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.yaxis.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.layout.yaxis.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + 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 plotly.graph_objs.layout.yaxis.Tickformatstop + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.layout.yaxis.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # tickson + # ------- + @property + def tickson(self): + """ + Determines where ticks and grid lines are drawn with respect to + their corresponding tick labels. Only has an effect for axes of + `type` "category" or "multicategory". When set to "boundaries", + ticks and grid lines are drawn half a category to the + left/bottom of labels. + + The 'tickson' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['labels', 'boundaries'] + + Returns + ------- + Any + """ + return self['tickson'] + + @tickson.setter + def tickson(self, val): + self['tickson'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + text + 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. + + Returns + ------- + plotly.graph_objs.layout.yaxis.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # type + # ---- + @property + 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', + 'multicategory'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # uirevision + # ---------- + @property + 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 + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # zeroline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['zeroline'] + + @zeroline.setter + def zeroline(self, val): + self['zeroline'] = val + + # zerolinecolor + # ------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['zerolinecolor'] + + @zerolinecolor.setter + def zerolinecolor(self, val): + self['zerolinecolor'] = val + + # zerolinewidth + # ------------- + @property + 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 + + Returns + ------- + int|float + """ + return self['zerolinewidth'] + + @zerolinewidth.setter + def zerolinewidth(self, val): + self['zerolinewidth'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + anchor + If set to an opposite-letter axis id (e.g. `x2`, `y`), + this axis is bound to the corresponding opposite-letter + axis. If set to "free", this axis' position is + determined by `position`. + automargin + Determines whether long tick labels automatically grow + the figure margins. + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + constrain + If this axis needs to be compressed (either due to its + own `scaleanchor` and `scaleratio` or those of the + other axis), determines how that happens: by increasing + the "range" (default), or by decreasing the "domain". + constraintoward + If this axis needs to be compressed (either due to its + own `scaleanchor` and `scaleratio` or those of the + other axis), determines which direction we push the + originally specified plot area. Options are "left", + "center" (default), and "right" for x axes, and "top", + "middle" (default), and "bottom" for y axes. + dividercolor + Sets the color of the dividers Only has an effect on + "multicategory" axes. + dividerwidth + Sets the width (in px) of the dividers Only has an + effect on "multicategory" axes. + domain + Sets the domain of this axis (in plot fraction). + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom-able. If + true, then zoom is disabled. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + matches + If set to another axis id (e.g. `x2`, `y`), the range + of this axis will match the range of the corresponding + axis in data-coordinates space. Moreover, matching axes + share auto-range values, category lists and histogram + auto-bins. Note that setting axes simultaneously in + both a `scaleanchor` and a `matches` constraint is + currently forbidden. Moreover, note that matching axes + must have the same `type`. + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + overlaying + If set a same-letter axis id, this axis is overlaid on + top of the corresponding same-letter axis, with traces + and axes visible for both axes. If False, this axis + does not overlay any same-letter axes. In this case, + for axes with overlapping domains only the highest- + numbered axis will be visible. + position + Sets the position of this axis in the plotting space + (in normalized coordinates). Only has an effect if + `anchor` is set to "free". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If *tozero*`, the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + scaleanchor + If set to another axis id (e.g. `x2`, `y`), the range + of this axis changes together with the range of the + corresponding axis such that the scale of pixels per + unit is in a constant ratio. Both axes are still + zoomable, but when you zoom one, the other will zoom + the same amount, keeping a fixed midpoint. `constrain` + and `constraintoward` determine how we enforce the + constraint. You can chain these, ie `yaxis: + {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` but you + can only link axes of the same `type`. The linked axis + can have the opposite letter (to constrain the aspect + ratio) or the same letter (to match scales across + subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: + {scaleanchor: *y*}` or longer) are redundant and the + last constraint encountered will be ignored to avoid + possible inconsistent constraints via `scaleratio`. + Note that setting axes simultaneously in both a + `scaleanchor` and a `matches` constraint is currently + forbidden. + scaleratio + If this axis is linked to another by `scaleanchor`, + this determines the pixel to unit scale ratio. For + example, if this value is 10, then every unit on this + axis spans 10 times the number of pixels as a unit on + the linked axis. Use this for example to create an + elevation profile where the vertical scale is + exaggerated a fixed amount with respect to the + horizontal. + separatethousands + If "true", even 4-digit integers are separated + showdividers + Determines whether or not a dividers are drawn between + the category levels of this axis. Only has an effect on + "multicategory" axes. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Determines whether or not spikes (aka droplines) are + drawn for this axis. Note: This only takes affect when + hovermode = closest + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines whether a x (y) axis is positioned at the + "bottom" ("left") or "top" ("right") of the plotting + area. + spikecolor + Sets the spike color. If undefined, will use the series + color + spikedash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + spikemode + Determines the drawing mode for the spike line If + "toaxis", the line is drawn from the data point to the + axis the series is plotted on. If "across", the line + is drawn across the entire plot area, and supercedes + "toaxis". If "marker", then a marker dot is drawn on + the axis the series is plotted on + spikesnap + Determines whether spikelines are stuck to the cursor + or to the closest datapoints. + spikethickness + Sets the width (in px) of the zero line. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.yaxis.Tickformatstop instance + or dict with compatible properties + tickformatstopdefaults + When used in a template (as + layout.template.layout.yaxis.tickformatstopdefaults), + sets the default property values to use for elements of + layout.yaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + tickson + Determines where ticks and grid lines are drawn with + respect to their corresponding tick labels. Only has an + effect for axes of `type` "category" or + "multicategory". When set to "boundaries", ticks and + grid lines are drawn half a category to the left/bottom + of labels. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.yaxis.Title instance or dict + with compatible properties + titlefont + Deprecated: Please use layout.yaxis.title.font instead. + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + uirevision + Controls persistence of user-driven changes in axis + `range`, `autorange`, and `title` if in `editable: + true` configuration. Defaults to `layout.uirevision`. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + """ + + _mapped_properties = {'titlefont': ('title', 'font')} + + def __init__( + self, + arg=None, + anchor=None, + automargin=None, + autorange=None, + calendar=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + color=None, + constrain=None, + constraintoward=None, + dividercolor=None, + dividerwidth=None, + domain=None, + dtick=None, + exponentformat=None, + fixedrange=None, + gridcolor=None, + gridwidth=None, + hoverformat=None, + layer=None, + linecolor=None, + linewidth=None, + matches=None, + mirror=None, + nticks=None, + overlaying=None, + position=None, + range=None, + rangemode=None, + scaleanchor=None, + scaleratio=None, + separatethousands=None, + showdividers=None, + showexponent=None, + showgrid=None, + showline=None, + showspikes=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + side=None, + spikecolor=None, + spikedash=None, + spikemode=None, + spikesnap=None, + spikethickness=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + tickson=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + type=None, + uirevision=None, + visible=None, + zeroline=None, + zerolinecolor=None, + zerolinewidth=None, + **kwargs + ): + """ + Construct a new YAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.YAxis + anchor + If set to an opposite-letter axis id (e.g. `x2`, `y`), + this axis is bound to the corresponding opposite-letter + axis. If set to "free", this axis' position is + determined by `position`. + automargin + Determines whether long tick labels automatically grow + the figure margins. + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + constrain + If this axis needs to be compressed (either due to its + own `scaleanchor` and `scaleratio` or those of the + other axis), determines how that happens: by increasing + the "range" (default), or by decreasing the "domain". + constraintoward + If this axis needs to be compressed (either due to its + own `scaleanchor` and `scaleratio` or those of the + other axis), determines which direction we push the + originally specified plot area. Options are "left", + "center" (default), and "right" for x axes, and "top", + "middle" (default), and "bottom" for y axes. + dividercolor + Sets the color of the dividers Only has an effect on + "multicategory" axes. + dividerwidth + Sets the width (in px) of the dividers Only has an + effect on "multicategory" axes. + domain + Sets the domain of this axis (in plot fraction). + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom-able. If + true, then zoom is disabled. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + matches + If set to another axis id (e.g. `x2`, `y`), the range + of this axis will match the range of the corresponding + axis in data-coordinates space. Moreover, matching axes + share auto-range values, category lists and histogram + auto-bins. Note that setting axes simultaneously in + both a `scaleanchor` and a `matches` constraint is + currently forbidden. Moreover, note that matching axes + must have the same `type`. + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + overlaying + If set a same-letter axis id, this axis is overlaid on + top of the corresponding same-letter axis, with traces + and axes visible for both axes. If False, this axis + does not overlay any same-letter axes. In this case, + for axes with overlapping domains only the highest- + numbered axis will be visible. + position + Sets the position of this axis in the plotting space + (in normalized coordinates). Only has an effect if + `anchor` is set to "free". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If *tozero*`, the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + scaleanchor + If set to another axis id (e.g. `x2`, `y`), the range + of this axis changes together with the range of the + corresponding axis such that the scale of pixels per + unit is in a constant ratio. Both axes are still + zoomable, but when you zoom one, the other will zoom + the same amount, keeping a fixed midpoint. `constrain` + and `constraintoward` determine how we enforce the + constraint. You can chain these, ie `yaxis: + {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` but you + can only link axes of the same `type`. The linked axis + can have the opposite letter (to constrain the aspect + ratio) or the same letter (to match scales across + subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: + {scaleanchor: *y*}` or longer) are redundant and the + last constraint encountered will be ignored to avoid + possible inconsistent constraints via `scaleratio`. + Note that setting axes simultaneously in both a + `scaleanchor` and a `matches` constraint is currently + forbidden. + scaleratio + If this axis is linked to another by `scaleanchor`, + this determines the pixel to unit scale ratio. For + example, if this value is 10, then every unit on this + axis spans 10 times the number of pixels as a unit on + the linked axis. Use this for example to create an + elevation profile where the vertical scale is + exaggerated a fixed amount with respect to the + horizontal. + separatethousands + If "true", even 4-digit integers are separated + showdividers + Determines whether or not a dividers are drawn between + the category levels of this axis. Only has an effect on + "multicategory" axes. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Determines whether or not spikes (aka droplines) are + drawn for this axis. Note: This only takes affect when + hovermode = closest + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines whether a x (y) axis is positioned at the + "bottom" ("left") or "top" ("right") of the plotting + area. + spikecolor + Sets the spike color. If undefined, will use the series + color + spikedash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + spikemode + Determines the drawing mode for the spike line If + "toaxis", the line is drawn from the data point to the + axis the series is plotted on. If "across", the line + is drawn across the entire plot area, and supercedes + "toaxis". If "marker", then a marker dot is drawn on + the axis the series is plotted on + spikesnap + Determines whether spikelines are stuck to the cursor + or to the closest datapoints. + spikethickness + Sets the width (in px) of the zero line. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.yaxis.Tickformatstop instance + or dict with compatible properties + tickformatstopdefaults + When used in a template (as + layout.template.layout.yaxis.tickformatstopdefaults), + sets the default property values to use for elements of + layout.yaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + tickson + Determines where ticks and grid lines are drawn with + respect to their corresponding tick labels. Only has an + effect for axes of `type` "category" or + "multicategory". When set to "boundaries", ticks and + grid lines are drawn half a category to the left/bottom + of labels. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.yaxis.Title instance or dict + with compatible properties + titlefont + Deprecated: Please use layout.yaxis.title.font instead. + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + uirevision + Controls persistence of user-driven changes in axis + `range`, `autorange`, and `title` if in `editable: + true` configuration. Defaults to `layout.uirevision`. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + + Returns + ------- + YAxis + """ + super(YAxis, self).__init__('yaxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.YAxis +constructor must be a dict or +an instance of plotly.graph_objs.layout.YAxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (yaxis as v_yaxis) + + # Initialize validators + # --------------------- + self._validators['anchor'] = v_yaxis.AnchorValidator() + self._validators['automargin'] = v_yaxis.AutomarginValidator() + self._validators['autorange'] = v_yaxis.AutorangeValidator() + self._validators['calendar'] = v_yaxis.CalendarValidator() + self._validators['categoryarray'] = v_yaxis.CategoryarrayValidator() + self._validators['categoryarraysrc' + ] = v_yaxis.CategoryarraysrcValidator() + self._validators['categoryorder'] = v_yaxis.CategoryorderValidator() + self._validators['color'] = v_yaxis.ColorValidator() + self._validators['constrain'] = v_yaxis.ConstrainValidator() + self._validators['constraintoward'] = v_yaxis.ConstraintowardValidator( + ) + self._validators['dividercolor'] = v_yaxis.DividercolorValidator() + self._validators['dividerwidth'] = v_yaxis.DividerwidthValidator() + self._validators['domain'] = v_yaxis.DomainValidator() + self._validators['dtick'] = v_yaxis.DtickValidator() + self._validators['exponentformat'] = v_yaxis.ExponentformatValidator() + self._validators['fixedrange'] = v_yaxis.FixedrangeValidator() + self._validators['gridcolor'] = v_yaxis.GridcolorValidator() + self._validators['gridwidth'] = v_yaxis.GridwidthValidator() + self._validators['hoverformat'] = v_yaxis.HoverformatValidator() + self._validators['layer'] = v_yaxis.LayerValidator() + self._validators['linecolor'] = v_yaxis.LinecolorValidator() + self._validators['linewidth'] = v_yaxis.LinewidthValidator() + self._validators['matches'] = v_yaxis.MatchesValidator() + self._validators['mirror'] = v_yaxis.MirrorValidator() + self._validators['nticks'] = v_yaxis.NticksValidator() + self._validators['overlaying'] = v_yaxis.OverlayingValidator() + self._validators['position'] = v_yaxis.PositionValidator() + self._validators['range'] = v_yaxis.RangeValidator() + self._validators['rangemode'] = v_yaxis.RangemodeValidator() + self._validators['scaleanchor'] = v_yaxis.ScaleanchorValidator() + self._validators['scaleratio'] = v_yaxis.ScaleratioValidator() + self._validators['separatethousands' + ] = v_yaxis.SeparatethousandsValidator() + self._validators['showdividers'] = v_yaxis.ShowdividersValidator() + self._validators['showexponent'] = v_yaxis.ShowexponentValidator() + self._validators['showgrid'] = v_yaxis.ShowgridValidator() + self._validators['showline'] = v_yaxis.ShowlineValidator() + self._validators['showspikes'] = v_yaxis.ShowspikesValidator() + self._validators['showticklabels'] = v_yaxis.ShowticklabelsValidator() + self._validators['showtickprefix'] = v_yaxis.ShowtickprefixValidator() + self._validators['showticksuffix'] = v_yaxis.ShowticksuffixValidator() + self._validators['side'] = v_yaxis.SideValidator() + self._validators['spikecolor'] = v_yaxis.SpikecolorValidator() + self._validators['spikedash'] = v_yaxis.SpikedashValidator() + self._validators['spikemode'] = v_yaxis.SpikemodeValidator() + self._validators['spikesnap'] = v_yaxis.SpikesnapValidator() + self._validators['spikethickness'] = v_yaxis.SpikethicknessValidator() + self._validators['tick0'] = v_yaxis.Tick0Validator() + self._validators['tickangle'] = v_yaxis.TickangleValidator() + self._validators['tickcolor'] = v_yaxis.TickcolorValidator() + self._validators['tickfont'] = v_yaxis.TickfontValidator() + self._validators['tickformat'] = v_yaxis.TickformatValidator() + self._validators['tickformatstops'] = v_yaxis.TickformatstopsValidator( + ) + self._validators['tickformatstopdefaults' + ] = v_yaxis.TickformatstopValidator() + self._validators['ticklen'] = v_yaxis.TicklenValidator() + self._validators['tickmode'] = v_yaxis.TickmodeValidator() + self._validators['tickprefix'] = v_yaxis.TickprefixValidator() + self._validators['ticks'] = v_yaxis.TicksValidator() + self._validators['tickson'] = v_yaxis.TicksonValidator() + self._validators['ticksuffix'] = v_yaxis.TicksuffixValidator() + self._validators['ticktext'] = v_yaxis.TicktextValidator() + self._validators['ticktextsrc'] = v_yaxis.TicktextsrcValidator() + self._validators['tickvals'] = v_yaxis.TickvalsValidator() + self._validators['tickvalssrc'] = v_yaxis.TickvalssrcValidator() + self._validators['tickwidth'] = v_yaxis.TickwidthValidator() + self._validators['title'] = v_yaxis.TitleValidator() + self._validators['type'] = v_yaxis.TypeValidator() + self._validators['uirevision'] = v_yaxis.UirevisionValidator() + self._validators['visible'] = v_yaxis.VisibleValidator() + self._validators['zeroline'] = v_yaxis.ZerolineValidator() + self._validators['zerolinecolor'] = v_yaxis.ZerolinecolorValidator() + self._validators['zerolinewidth'] = v_yaxis.ZerolinewidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('anchor', None) + self['anchor'] = anchor if anchor is not None else _v + _v = arg.pop('automargin', None) + self['automargin'] = automargin if automargin is not None else _v + _v = arg.pop('autorange', None) + self['autorange'] = autorange if autorange is not None else _v + _v = arg.pop('calendar', None) + self['calendar'] = calendar if calendar is not None else _v + _v = arg.pop('categoryarray', None) + self['categoryarray' + ] = categoryarray if categoryarray is not None else _v + _v = arg.pop('categoryarraysrc', None) + self['categoryarraysrc' + ] = categoryarraysrc if categoryarraysrc is not None else _v + _v = arg.pop('categoryorder', None) + self['categoryorder' + ] = categoryorder if categoryorder is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('constrain', None) + self['constrain'] = constrain if constrain is not None else _v + _v = arg.pop('constraintoward', None) + self['constraintoward' + ] = constraintoward if constraintoward is not None else _v + _v = arg.pop('dividercolor', None) + self['dividercolor'] = dividercolor if dividercolor is not None else _v + _v = arg.pop('dividerwidth', None) + self['dividerwidth'] = dividerwidth if dividerwidth is not None else _v + _v = arg.pop('domain', None) + self['domain'] = domain if domain is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('fixedrange', None) + self['fixedrange'] = fixedrange if fixedrange is not None else _v + _v = arg.pop('gridcolor', None) + self['gridcolor'] = gridcolor if gridcolor is not None else _v + _v = arg.pop('gridwidth', None) + self['gridwidth'] = gridwidth if gridwidth is not None else _v + _v = arg.pop('hoverformat', None) + self['hoverformat'] = hoverformat if hoverformat is not None else _v + _v = arg.pop('layer', None) + self['layer'] = layer if layer is not None else _v + _v = arg.pop('linecolor', None) + self['linecolor'] = linecolor if linecolor is not None else _v + _v = arg.pop('linewidth', None) + self['linewidth'] = linewidth if linewidth is not None else _v + _v = arg.pop('matches', None) + self['matches'] = matches if matches is not None else _v + _v = arg.pop('mirror', None) + self['mirror'] = mirror if mirror is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('overlaying', None) + self['overlaying'] = overlaying if overlaying is not None else _v + _v = arg.pop('position', None) + self['position'] = position if position is not None else _v + _v = arg.pop('range', None) + self['range'] = range if range is not None else _v + _v = arg.pop('rangemode', None) + self['rangemode'] = rangemode if rangemode is not None else _v + _v = arg.pop('scaleanchor', None) + self['scaleanchor'] = scaleanchor if scaleanchor is not None else _v + _v = arg.pop('scaleratio', None) + self['scaleratio'] = scaleratio if scaleratio is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showdividers', None) + self['showdividers'] = showdividers if showdividers is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showgrid', None) + self['showgrid'] = showgrid if showgrid is not None else _v + _v = arg.pop('showline', None) + self['showline'] = showline if showline is not None else _v + _v = arg.pop('showspikes', None) + self['showspikes'] = showspikes if showspikes is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('spikecolor', None) + self['spikecolor'] = spikecolor if spikecolor is not None else _v + _v = arg.pop('spikedash', None) + self['spikedash'] = spikedash if spikedash is not None else _v + _v = arg.pop('spikemode', None) + self['spikemode'] = spikemode if spikemode is not None else _v + _v = arg.pop('spikesnap', None) + self['spikesnap'] = spikesnap if spikesnap is not None else _v + _v = arg.pop('spikethickness', None) + self['spikethickness' + ] = spikethickness if spikethickness is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('tickson', None) + self['tickson'] = tickson if tickson is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('zeroline', None) + self['zeroline'] = zeroline if zeroline is not None else _v + _v = arg.pop('zerolinecolor', None) + self['zerolinecolor' + ] = zerolinecolor if zerolinecolor is not None else _v + _v = arg.pop('zerolinewidth', None) + self['zerolinewidth' + ] = zerolinewidth if zerolinewidth is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class XAxis(_BaseLayoutHierarchyType): + + # anchor + # ------ + @property + 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'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?$', '^y([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + Any + """ + return self['anchor'] + + @anchor.setter + def anchor(self, val): + self['anchor'] = val + + # automargin + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['automargin'] + + @automargin.setter + def automargin(self, val): + self['automargin'] = val + + # autorange + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['autorange'] + + @autorange.setter + def autorange(self, val): + self['autorange'] = val + + # calendar + # -------- + @property + def calendar(self): + """ + Sets the calendar system to use for `range` and `tick0` if this + is a date axis. This does not set the calendar for interpreting + data on this axis, that's specified in the trace or via the + global `layout.calendar` + + The 'calendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['gregorian', 'chinese', 'coptic', 'discworld', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['calendar'] + + @calendar.setter + def calendar(self, val): + self['calendar'] = val + + # categoryarray + # ------------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['categoryarray'] + + @categoryarray.setter + def categoryarray(self, val): + self['categoryarray'] = val + + # categoryarraysrc + # ---------------- + @property + def categoryarraysrc(self): + """ + Sets the source reference on plot.ly for categoryarray . + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['categoryarraysrc'] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self['categoryarraysrc'] = val + + # categoryorder + # ------------- + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array'] + + Returns + ------- + Any + """ + return self['categoryorder'] + + @categoryorder.setter + def categoryorder(self, val): + self['categoryorder'] = val + + # color + # ----- + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # constrain + # --------- + @property + def constrain(self): + """ + If this axis needs to be compressed (either due to its own + `scaleanchor` and `scaleratio` or those of the other axis), + determines how that happens: by increasing the "range" + (default), or by decreasing the "domain". + + The 'constrain' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['range', 'domain'] + + Returns + ------- + Any + """ + return self['constrain'] + + @constrain.setter + def constrain(self, val): + self['constrain'] = val + + # constraintoward + # --------------- + @property + def constraintoward(self): + """ + If this axis needs to be compressed (either due to its own + `scaleanchor` and `scaleratio` or those of the other axis), + determines which direction we push the originally specified + plot area. Options are "left", "center" (default), and "right" + for x axes, and "top", "middle" (default), and "bottom" for y + axes. + + The 'constraintoward' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right', 'top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self['constraintoward'] + + @constraintoward.setter + def constraintoward(self, val): + self['constraintoward'] = val + + # dividercolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['dividercolor'] + + @dividercolor.setter + def dividercolor(self, val): + self['dividercolor'] = val + + # dividerwidth + # ------------ + @property + 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 + + Returns + ------- + int|float + """ + return self['dividerwidth'] + + @dividerwidth.setter + def dividerwidth(self, val): + self['dividerwidth'] = val + + # domain + # ------ + @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] + + Returns + ------- + list + """ + return self['domain'] + + @domain.setter + def domain(self, val): + self['domain'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # fixedrange + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['fixedrange'] + + @fixedrange.setter + def fixedrange(self, val): + self['fixedrange'] = val + + # gridcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['gridcolor'] + + @gridcolor.setter + def gridcolor(self, val): + self['gridcolor'] = val + + # gridwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['gridwidth'] + + @gridwidth.setter + def gridwidth(self, val): + self['gridwidth'] = val + + # hoverformat + # ----------- + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['hoverformat'] + + @hoverformat.setter + def hoverformat(self, val): + self['hoverformat'] = val + + # layer + # ----- + @property + def layer(self): + """ + Sets the layer on which this axis is displayed. If *above + traces*, this axis is displayed above all the subplot's traces + If *below traces*, this axis is displayed below all the + subplot's traces, but above the grid lines. Useful when used + together with scatter-like traces with `cliponaxis` set to + False to show markers and/or text nodes above this axis. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['above traces', 'below traces'] + + Returns + ------- + Any + """ + return self['layer'] + + @layer.setter + def layer(self, val): + self['layer'] = val + + # linecolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['linecolor'] + + @linecolor.setter + def linecolor(self, val): + self['linecolor'] = val + + # linewidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['linewidth'] + + @linewidth.setter + def linewidth(self, val): + self['linewidth'] = val + + # matches + # ------- + @property + def matches(self): + """ + If set to another axis id (e.g. `x2`, `y`), the range of this + axis will match the range of the corresponding axis in data- + coordinates space. Moreover, matching axes share auto-range + values, category lists and histogram auto-bins. Note that + setting axes simultaneously in both a `scaleanchor` and a + `matches` constraint is currently forbidden. Moreover, note + that matching axes must have the same `type`. + + 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]+)?$', '^y([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + Any + """ + return self['matches'] + + @matches.setter + def matches(self, val): + self['matches'] = val + + # mirror + # ------ + @property + def mirror(self): + """ + Determines if the axis lines or/and ticks are mirrored to the + opposite side of the plotting area. If True, the axis lines are + mirrored. If "ticks", the axis lines and ticks are mirrored. If + False, mirroring is disable. If "all", axis lines are mirrored + on all shared-axes subplots. If "allticks", axis lines and + ticks are mirrored on all shared-axes subplots. + + The 'mirror' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, 'ticks', False, 'all', 'allticks'] + + Returns + ------- + Any + """ + return self['mirror'] + + @mirror.setter + def mirror(self, val): + self['mirror'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # overlaying + # ---------- + @property + def overlaying(self): + """ + If set a same-letter axis id, this axis is overlaid on top of + the corresponding same-letter axis, with traces and axes + visible for both axes. If False, this axis does not overlay any + same-letter axes. In this case, for axes with overlapping + domains only the highest-numbered axis will be visible. + + The 'overlaying' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['free'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?$', '^y([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + Any + """ + return self['overlaying'] + + @overlaying.setter + def overlaying(self, val): + self['overlaying'] = val + + # position + # -------- + @property + 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] + + Returns + ------- + int|float + """ + return self['position'] + + @position.setter + def position(self, val): + self['position'] = val + + # range + # ----- + @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 + + Returns + ------- + list + """ + return self['range'] + + @range.setter + def range(self, val): + self['range'] = val + + # rangemode + # --------- + @property + def rangemode(self): + """ + If "normal", the range is computed in relation to the extrema + of the input data. If *tozero*`, the range extends to 0, + regardless of the input data If "nonnegative", the range is + non-negative, regardless of the input data. Applies only to + linear axes. + + The 'rangemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'tozero', 'nonnegative'] + + Returns + ------- + Any + """ + return self['rangemode'] + + @rangemode.setter + def rangemode(self, val): + self['rangemode'] = val + + # rangeselector + # ------------- + @property + def rangeselector(self): + """ + The 'rangeselector' property is an instance of Rangeselector + that may be specified as: + - An instance of 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. + bgcolor + Sets the background color of the range selector + buttons. + bordercolor + Sets the color of the border enclosing the + range selector. + borderwidth + Sets the width (in px) of the border enclosing + the range selector. + buttons + Sets the specifications for each buttons. By + default, a range selector comes with no + buttons. + buttondefaults + When used in a template (as layout.template.lay + out.xaxis.rangeselector.buttondefaults), sets + the default property values to use for elements + of layout.xaxis.rangeselector.buttons + font + Sets the font of the range selector button + text. + visible + 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". + x + Sets the x position (in normalized coordinates) + of the range selector. + xanchor + Sets the range selector's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the range + selector. + y + Sets the y position (in normalized coordinates) + of the range selector. + yanchor + Sets the range selector's vertical position + anchor This anchor binds the `y` position to + the "top", "middle" or "bottom" of the range + selector. + + Returns + ------- + plotly.graph_objs.layout.xaxis.Rangeselector + """ + return self['rangeselector'] + + @rangeselector.setter + def rangeselector(self, val): + self['rangeselector'] = val + + # rangeslider + # ----------- + @property + def rangeslider(self): + """ + The 'rangeslider' property is an instance of Rangeslider + that may be specified as: + - An instance of 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 + data. If `range` is provided, then `autorange` + is set to False. + bgcolor + Sets the background color of the range slider. + bordercolor + Sets the border color of the range slider. + borderwidth + Sets the border width of the range slider. + range + 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. + thickness + The height of the range slider as a fraction of + the total plot area height. + visible + Determines whether or not the range slider will + be visible. If visible, perpendicular axes will + be set to `fixedrange` + yaxis + plotly.graph_objs.layout.xaxis.rangeslider.YAxi + s instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.layout.xaxis.Rangeslider + """ + return self['rangeslider'] + + @rangeslider.setter + def rangeslider(self, val): + self['rangeslider'] = val + + # scaleanchor + # ----------- + @property + def scaleanchor(self): + """ + If set to another axis id (e.g. `x2`, `y`), the range of this + axis changes together with the range of the corresponding axis + such that the scale of pixels per unit is in a constant ratio. + Both axes are still zoomable, but when you zoom one, the other + will zoom the same amount, keeping a fixed midpoint. + `constrain` and `constraintoward` determine how we enforce the + constraint. You can chain these, ie `yaxis: {scaleanchor: *x*}, + xaxis2: {scaleanchor: *y*}` but you can only link axes of the + same `type`. The linked axis can have the opposite letter (to + constrain the aspect ratio) or the same letter (to match scales + across subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: + {scaleanchor: *y*}` or longer) are redundant and the last + constraint encountered will be ignored to avoid possible + inconsistent constraints via `scaleratio`. Note that setting + axes simultaneously in both a `scaleanchor` and a `matches` + constraint is currently forbidden. + + 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]+)?$', '^y([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + Any + """ + return self['scaleanchor'] + + @scaleanchor.setter + def scaleanchor(self, val): + self['scaleanchor'] = val + + # scaleratio + # ---------- + @property + def scaleratio(self): + """ + If this axis is linked to another by `scaleanchor`, this + determines the pixel to unit scale ratio. For example, if this + value is 10, then every unit on this axis spans 10 times the + number of pixels as a unit on the linked axis. Use this for + example to create an elevation profile where the vertical scale + is exaggerated a fixed amount with respect to the horizontal. + + The 'scaleratio' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self['scaleratio'] + + @scaleratio.setter + def scaleratio(self, val): + self['scaleratio'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showdividers + # ------------ + @property + 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) + + Returns + ------- + bool + """ + return self['showdividers'] + + @showdividers.setter + def showdividers(self, val): + self['showdividers'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showgrid + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showgrid'] + + @showgrid.setter + def showgrid(self, val): + self['showgrid'] = val + + # showline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showline'] + + @showline.setter + def showline(self, val): + self['showline'] = val + + # showspikes + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showspikes'] + + @showspikes.setter + def showspikes(self, val): + self['showspikes'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # spikecolor + # ---------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['spikecolor'] + + @spikecolor.setter + def spikecolor(self, val): + self['spikecolor'] = val + + # spikedash + # --------- + @property + def spikedash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'spikedash' property is a string and must be specified as: + - One of the following strings: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', + 'longdashdot'] + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['spikedash'] + + @spikedash.setter + def spikedash(self, val): + self['spikedash'] = val + + # spikemode + # --------- + @property + def spikemode(self): + """ + Determines the drawing mode for the spike line If "toaxis", the + line is drawn from the data point to the axis the series is + plotted on. If "across", the line is drawn across the entire + plot area, and supercedes "toaxis". If "marker", then a marker + dot is drawn on the axis the series is plotted on + + The 'spikemode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['toaxis', 'across', 'marker'] joined with '+' characters + (e.g. 'toaxis+across') + + Returns + ------- + Any + """ + return self['spikemode'] + + @spikemode.setter + def spikemode(self, val): + self['spikemode'] = val + + # spikesnap + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['spikesnap'] + + @spikesnap.setter + def spikesnap(self, val): + self['spikesnap'] = val + + # spikethickness + # -------------- + @property + 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 + + Returns + ------- + int|float + """ + return self['spikethickness'] + + @spikethickness.setter + def spikethickness(self, val): + self['spikethickness'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.xaxis.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.layout.xaxis.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + 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 plotly.graph_objs.layout.xaxis.Tickformatstop + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.layout.xaxis.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # tickson + # ------- + @property + def tickson(self): + """ + Determines where ticks and grid lines are drawn with respect to + their corresponding tick labels. Only has an effect for axes of + `type` "category" or "multicategory". When set to "boundaries", + ticks and grid lines are drawn half a category to the + left/bottom of labels. + + The 'tickson' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['labels', 'boundaries'] + + Returns + ------- + Any + """ + return self['tickson'] + + @tickson.setter + def tickson(self, val): + self['tickson'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + text + 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. + + Returns + ------- + plotly.graph_objs.layout.xaxis.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # type + # ---- + @property + 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', + 'multicategory'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # uirevision + # ---------- + @property + 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 + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # zeroline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['zeroline'] + + @zeroline.setter + def zeroline(self, val): + self['zeroline'] = val + + # zerolinecolor + # ------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['zerolinecolor'] + + @zerolinecolor.setter + def zerolinecolor(self, val): + self['zerolinecolor'] = val + + # zerolinewidth + # ------------- + @property + 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 + + Returns + ------- + int|float + """ + return self['zerolinewidth'] + + @zerolinewidth.setter + def zerolinewidth(self, val): + self['zerolinewidth'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + anchor + If set to an opposite-letter axis id (e.g. `x2`, `y`), + this axis is bound to the corresponding opposite-letter + axis. If set to "free", this axis' position is + determined by `position`. + automargin + Determines whether long tick labels automatically grow + the figure margins. + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + constrain + If this axis needs to be compressed (either due to its + own `scaleanchor` and `scaleratio` or those of the + other axis), determines how that happens: by increasing + the "range" (default), or by decreasing the "domain". + constraintoward + If this axis needs to be compressed (either due to its + own `scaleanchor` and `scaleratio` or those of the + other axis), determines which direction we push the + originally specified plot area. Options are "left", + "center" (default), and "right" for x axes, and "top", + "middle" (default), and "bottom" for y axes. + dividercolor + Sets the color of the dividers Only has an effect on + "multicategory" axes. + dividerwidth + Sets the width (in px) of the dividers Only has an + effect on "multicategory" axes. + domain + Sets the domain of this axis (in plot fraction). + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom-able. If + true, then zoom is disabled. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + matches + If set to another axis id (e.g. `x2`, `y`), the range + of this axis will match the range of the corresponding + axis in data-coordinates space. Moreover, matching axes + share auto-range values, category lists and histogram + auto-bins. Note that setting axes simultaneously in + both a `scaleanchor` and a `matches` constraint is + currently forbidden. Moreover, note that matching axes + must have the same `type`. + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + overlaying + If set a same-letter axis id, this axis is overlaid on + top of the corresponding same-letter axis, with traces + and axes visible for both axes. If False, this axis + does not overlay any same-letter axes. In this case, + for axes with overlapping domains only the highest- + numbered axis will be visible. + position + Sets the position of this axis in the plotting space + (in normalized coordinates). Only has an effect if + `anchor` is set to "free". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If *tozero*`, the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + rangeselector + plotly.graph_objs.layout.xaxis.Rangeselector instance + or dict with compatible properties + rangeslider + plotly.graph_objs.layout.xaxis.Rangeslider instance or + dict with compatible properties + scaleanchor + If set to another axis id (e.g. `x2`, `y`), the range + of this axis changes together with the range of the + corresponding axis such that the scale of pixels per + unit is in a constant ratio. Both axes are still + zoomable, but when you zoom one, the other will zoom + the same amount, keeping a fixed midpoint. `constrain` + and `constraintoward` determine how we enforce the + constraint. You can chain these, ie `yaxis: + {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` but you + can only link axes of the same `type`. The linked axis + can have the opposite letter (to constrain the aspect + ratio) or the same letter (to match scales across + subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: + {scaleanchor: *y*}` or longer) are redundant and the + last constraint encountered will be ignored to avoid + possible inconsistent constraints via `scaleratio`. + Note that setting axes simultaneously in both a + `scaleanchor` and a `matches` constraint is currently + forbidden. + scaleratio + If this axis is linked to another by `scaleanchor`, + this determines the pixel to unit scale ratio. For + example, if this value is 10, then every unit on this + axis spans 10 times the number of pixels as a unit on + the linked axis. Use this for example to create an + elevation profile where the vertical scale is + exaggerated a fixed amount with respect to the + horizontal. + separatethousands + If "true", even 4-digit integers are separated + showdividers + Determines whether or not a dividers are drawn between + the category levels of this axis. Only has an effect on + "multicategory" axes. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Determines whether or not spikes (aka droplines) are + drawn for this axis. Note: This only takes affect when + hovermode = closest + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines whether a x (y) axis is positioned at the + "bottom" ("left") or "top" ("right") of the plotting + area. + spikecolor + Sets the spike color. If undefined, will use the series + color + spikedash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + spikemode + Determines the drawing mode for the spike line If + "toaxis", the line is drawn from the data point to the + axis the series is plotted on. If "across", the line + is drawn across the entire plot area, and supercedes + "toaxis". If "marker", then a marker dot is drawn on + the axis the series is plotted on + spikesnap + Determines whether spikelines are stuck to the cursor + or to the closest datapoints. + spikethickness + Sets the width (in px) of the zero line. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.xaxis.Tickformatstop instance + or dict with compatible properties + tickformatstopdefaults + When used in a template (as + layout.template.layout.xaxis.tickformatstopdefaults), + sets the default property values to use for elements of + layout.xaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + tickson + Determines where ticks and grid lines are drawn with + respect to their corresponding tick labels. Only has an + effect for axes of `type` "category" or + "multicategory". When set to "boundaries", ticks and + grid lines are drawn half a category to the left/bottom + of labels. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.xaxis.Title instance or dict + with compatible properties + titlefont + Deprecated: Please use layout.xaxis.title.font instead. + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + uirevision + Controls persistence of user-driven changes in axis + `range`, `autorange`, and `title` if in `editable: + true` configuration. Defaults to `layout.uirevision`. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + """ + + _mapped_properties = {'titlefont': ('title', 'font')} + + def __init__( + self, + arg=None, + anchor=None, + automargin=None, + autorange=None, + calendar=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + color=None, + constrain=None, + constraintoward=None, + dividercolor=None, + dividerwidth=None, + domain=None, + dtick=None, + exponentformat=None, + fixedrange=None, + gridcolor=None, + gridwidth=None, + hoverformat=None, + layer=None, + linecolor=None, + linewidth=None, + matches=None, + mirror=None, + nticks=None, + overlaying=None, + position=None, + range=None, + rangemode=None, + rangeselector=None, + rangeslider=None, + scaleanchor=None, + scaleratio=None, + separatethousands=None, + showdividers=None, + showexponent=None, + showgrid=None, + showline=None, + showspikes=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + side=None, + spikecolor=None, + spikedash=None, + spikemode=None, + spikesnap=None, + spikethickness=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + tickson=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + type=None, + uirevision=None, + visible=None, + zeroline=None, + zerolinecolor=None, + zerolinewidth=None, + **kwargs + ): + """ + Construct a new XAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.XAxis + anchor + If set to an opposite-letter axis id (e.g. `x2`, `y`), + this axis is bound to the corresponding opposite-letter + axis. If set to "free", this axis' position is + determined by `position`. + automargin + Determines whether long tick labels automatically grow + the figure margins. + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + constrain + If this axis needs to be compressed (either due to its + own `scaleanchor` and `scaleratio` or those of the + other axis), determines how that happens: by increasing + the "range" (default), or by decreasing the "domain". + constraintoward + If this axis needs to be compressed (either due to its + own `scaleanchor` and `scaleratio` or those of the + other axis), determines which direction we push the + originally specified plot area. Options are "left", + "center" (default), and "right" for x axes, and "top", + "middle" (default), and "bottom" for y axes. + dividercolor + Sets the color of the dividers Only has an effect on + "multicategory" axes. + dividerwidth + Sets the width (in px) of the dividers Only has an + effect on "multicategory" axes. + domain + Sets the domain of this axis (in plot fraction). + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom-able. If + true, then zoom is disabled. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + matches + If set to another axis id (e.g. `x2`, `y`), the range + of this axis will match the range of the corresponding + axis in data-coordinates space. Moreover, matching axes + share auto-range values, category lists and histogram + auto-bins. Note that setting axes simultaneously in + both a `scaleanchor` and a `matches` constraint is + currently forbidden. Moreover, note that matching axes + must have the same `type`. + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + overlaying + If set a same-letter axis id, this axis is overlaid on + top of the corresponding same-letter axis, with traces + and axes visible for both axes. If False, this axis + does not overlay any same-letter axes. In this case, + for axes with overlapping domains only the highest- + numbered axis will be visible. + position + Sets the position of this axis in the plotting space + (in normalized coordinates). Only has an effect if + `anchor` is set to "free". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If *tozero*`, the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + rangeselector + plotly.graph_objs.layout.xaxis.Rangeselector instance + or dict with compatible properties + rangeslider + plotly.graph_objs.layout.xaxis.Rangeslider instance or + dict with compatible properties + scaleanchor + If set to another axis id (e.g. `x2`, `y`), the range + of this axis changes together with the range of the + corresponding axis such that the scale of pixels per + unit is in a constant ratio. Both axes are still + zoomable, but when you zoom one, the other will zoom + the same amount, keeping a fixed midpoint. `constrain` + and `constraintoward` determine how we enforce the + constraint. You can chain these, ie `yaxis: + {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` but you + can only link axes of the same `type`. The linked axis + can have the opposite letter (to constrain the aspect + ratio) or the same letter (to match scales across + subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: + {scaleanchor: *y*}` or longer) are redundant and the + last constraint encountered will be ignored to avoid + possible inconsistent constraints via `scaleratio`. + Note that setting axes simultaneously in both a + `scaleanchor` and a `matches` constraint is currently + forbidden. + scaleratio + If this axis is linked to another by `scaleanchor`, + this determines the pixel to unit scale ratio. For + example, if this value is 10, then every unit on this + axis spans 10 times the number of pixels as a unit on + the linked axis. Use this for example to create an + elevation profile where the vertical scale is + exaggerated a fixed amount with respect to the + horizontal. + separatethousands + If "true", even 4-digit integers are separated + showdividers + Determines whether or not a dividers are drawn between + the category levels of this axis. Only has an effect on + "multicategory" axes. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Determines whether or not spikes (aka droplines) are + drawn for this axis. Note: This only takes affect when + hovermode = closest + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines whether a x (y) axis is positioned at the + "bottom" ("left") or "top" ("right") of the plotting + area. + spikecolor + Sets the spike color. If undefined, will use the series + color + spikedash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + spikemode + Determines the drawing mode for the spike line If + "toaxis", the line is drawn from the data point to the + axis the series is plotted on. If "across", the line + is drawn across the entire plot area, and supercedes + "toaxis". If "marker", then a marker dot is drawn on + the axis the series is plotted on + spikesnap + Determines whether spikelines are stuck to the cursor + or to the closest datapoints. + spikethickness + Sets the width (in px) of the zero line. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.xaxis.Tickformatstop instance + or dict with compatible properties + tickformatstopdefaults + When used in a template (as + layout.template.layout.xaxis.tickformatstopdefaults), + sets the default property values to use for elements of + layout.xaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + tickson + Determines where ticks and grid lines are drawn with + respect to their corresponding tick labels. Only has an + effect for axes of `type` "category" or + "multicategory". When set to "boundaries", ticks and + grid lines are drawn half a category to the left/bottom + of labels. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.xaxis.Title instance or dict + with compatible properties + titlefont + Deprecated: Please use layout.xaxis.title.font instead. + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + uirevision + Controls persistence of user-driven changes in axis + `range`, `autorange`, and `title` if in `editable: + true` configuration. Defaults to `layout.uirevision`. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + + Returns + ------- + XAxis + """ + super(XAxis, self).__init__('xaxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.XAxis +constructor must be a dict or +an instance of plotly.graph_objs.layout.XAxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (xaxis as v_xaxis) + + # Initialize validators + # --------------------- + self._validators['anchor'] = v_xaxis.AnchorValidator() + self._validators['automargin'] = v_xaxis.AutomarginValidator() + self._validators['autorange'] = v_xaxis.AutorangeValidator() + self._validators['calendar'] = v_xaxis.CalendarValidator() + self._validators['categoryarray'] = v_xaxis.CategoryarrayValidator() + self._validators['categoryarraysrc' + ] = v_xaxis.CategoryarraysrcValidator() + self._validators['categoryorder'] = v_xaxis.CategoryorderValidator() + self._validators['color'] = v_xaxis.ColorValidator() + self._validators['constrain'] = v_xaxis.ConstrainValidator() + self._validators['constraintoward'] = v_xaxis.ConstraintowardValidator( + ) + self._validators['dividercolor'] = v_xaxis.DividercolorValidator() + self._validators['dividerwidth'] = v_xaxis.DividerwidthValidator() + self._validators['domain'] = v_xaxis.DomainValidator() + self._validators['dtick'] = v_xaxis.DtickValidator() + self._validators['exponentformat'] = v_xaxis.ExponentformatValidator() + self._validators['fixedrange'] = v_xaxis.FixedrangeValidator() + self._validators['gridcolor'] = v_xaxis.GridcolorValidator() + self._validators['gridwidth'] = v_xaxis.GridwidthValidator() + self._validators['hoverformat'] = v_xaxis.HoverformatValidator() + self._validators['layer'] = v_xaxis.LayerValidator() + self._validators['linecolor'] = v_xaxis.LinecolorValidator() + self._validators['linewidth'] = v_xaxis.LinewidthValidator() + self._validators['matches'] = v_xaxis.MatchesValidator() + self._validators['mirror'] = v_xaxis.MirrorValidator() + self._validators['nticks'] = v_xaxis.NticksValidator() + self._validators['overlaying'] = v_xaxis.OverlayingValidator() + self._validators['position'] = v_xaxis.PositionValidator() + self._validators['range'] = v_xaxis.RangeValidator() + self._validators['rangemode'] = v_xaxis.RangemodeValidator() + self._validators['rangeselector'] = v_xaxis.RangeselectorValidator() + self._validators['rangeslider'] = v_xaxis.RangesliderValidator() + self._validators['scaleanchor'] = v_xaxis.ScaleanchorValidator() + self._validators['scaleratio'] = v_xaxis.ScaleratioValidator() + self._validators['separatethousands' + ] = v_xaxis.SeparatethousandsValidator() + self._validators['showdividers'] = v_xaxis.ShowdividersValidator() + self._validators['showexponent'] = v_xaxis.ShowexponentValidator() + self._validators['showgrid'] = v_xaxis.ShowgridValidator() + self._validators['showline'] = v_xaxis.ShowlineValidator() + self._validators['showspikes'] = v_xaxis.ShowspikesValidator() + self._validators['showticklabels'] = v_xaxis.ShowticklabelsValidator() + self._validators['showtickprefix'] = v_xaxis.ShowtickprefixValidator() + self._validators['showticksuffix'] = v_xaxis.ShowticksuffixValidator() + self._validators['side'] = v_xaxis.SideValidator() + self._validators['spikecolor'] = v_xaxis.SpikecolorValidator() + self._validators['spikedash'] = v_xaxis.SpikedashValidator() + self._validators['spikemode'] = v_xaxis.SpikemodeValidator() + self._validators['spikesnap'] = v_xaxis.SpikesnapValidator() + self._validators['spikethickness'] = v_xaxis.SpikethicknessValidator() + self._validators['tick0'] = v_xaxis.Tick0Validator() + self._validators['tickangle'] = v_xaxis.TickangleValidator() + self._validators['tickcolor'] = v_xaxis.TickcolorValidator() + self._validators['tickfont'] = v_xaxis.TickfontValidator() + self._validators['tickformat'] = v_xaxis.TickformatValidator() + self._validators['tickformatstops'] = v_xaxis.TickformatstopsValidator( + ) + self._validators['tickformatstopdefaults' + ] = v_xaxis.TickformatstopValidator() + self._validators['ticklen'] = v_xaxis.TicklenValidator() + self._validators['tickmode'] = v_xaxis.TickmodeValidator() + self._validators['tickprefix'] = v_xaxis.TickprefixValidator() + self._validators['ticks'] = v_xaxis.TicksValidator() + self._validators['tickson'] = v_xaxis.TicksonValidator() + self._validators['ticksuffix'] = v_xaxis.TicksuffixValidator() + self._validators['ticktext'] = v_xaxis.TicktextValidator() + self._validators['ticktextsrc'] = v_xaxis.TicktextsrcValidator() + self._validators['tickvals'] = v_xaxis.TickvalsValidator() + self._validators['tickvalssrc'] = v_xaxis.TickvalssrcValidator() + self._validators['tickwidth'] = v_xaxis.TickwidthValidator() + self._validators['title'] = v_xaxis.TitleValidator() + self._validators['type'] = v_xaxis.TypeValidator() + self._validators['uirevision'] = v_xaxis.UirevisionValidator() + self._validators['visible'] = v_xaxis.VisibleValidator() + self._validators['zeroline'] = v_xaxis.ZerolineValidator() + self._validators['zerolinecolor'] = v_xaxis.ZerolinecolorValidator() + self._validators['zerolinewidth'] = v_xaxis.ZerolinewidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('anchor', None) + self['anchor'] = anchor if anchor is not None else _v + _v = arg.pop('automargin', None) + self['automargin'] = automargin if automargin is not None else _v + _v = arg.pop('autorange', None) + self['autorange'] = autorange if autorange is not None else _v + _v = arg.pop('calendar', None) + self['calendar'] = calendar if calendar is not None else _v + _v = arg.pop('categoryarray', None) + self['categoryarray' + ] = categoryarray if categoryarray is not None else _v + _v = arg.pop('categoryarraysrc', None) + self['categoryarraysrc' + ] = categoryarraysrc if categoryarraysrc is not None else _v + _v = arg.pop('categoryorder', None) + self['categoryorder' + ] = categoryorder if categoryorder is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('constrain', None) + self['constrain'] = constrain if constrain is not None else _v + _v = arg.pop('constraintoward', None) + self['constraintoward' + ] = constraintoward if constraintoward is not None else _v + _v = arg.pop('dividercolor', None) + self['dividercolor'] = dividercolor if dividercolor is not None else _v + _v = arg.pop('dividerwidth', None) + self['dividerwidth'] = dividerwidth if dividerwidth is not None else _v + _v = arg.pop('domain', None) + self['domain'] = domain if domain is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('fixedrange', None) + self['fixedrange'] = fixedrange if fixedrange is not None else _v + _v = arg.pop('gridcolor', None) + self['gridcolor'] = gridcolor if gridcolor is not None else _v + _v = arg.pop('gridwidth', None) + self['gridwidth'] = gridwidth if gridwidth is not None else _v + _v = arg.pop('hoverformat', None) + self['hoverformat'] = hoverformat if hoverformat is not None else _v + _v = arg.pop('layer', None) + self['layer'] = layer if layer is not None else _v + _v = arg.pop('linecolor', None) + self['linecolor'] = linecolor if linecolor is not None else _v + _v = arg.pop('linewidth', None) + self['linewidth'] = linewidth if linewidth is not None else _v + _v = arg.pop('matches', None) + self['matches'] = matches if matches is not None else _v + _v = arg.pop('mirror', None) + self['mirror'] = mirror if mirror is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('overlaying', None) + self['overlaying'] = overlaying if overlaying is not None else _v + _v = arg.pop('position', None) + self['position'] = position if position is not None else _v + _v = arg.pop('range', None) + self['range'] = range if range is not None else _v + _v = arg.pop('rangemode', None) + self['rangemode'] = rangemode if rangemode is not None else _v + _v = arg.pop('rangeselector', None) + self['rangeselector' + ] = rangeselector if rangeselector is not None else _v + _v = arg.pop('rangeslider', None) + self['rangeslider'] = rangeslider if rangeslider is not None else _v + _v = arg.pop('scaleanchor', None) + self['scaleanchor'] = scaleanchor if scaleanchor is not None else _v + _v = arg.pop('scaleratio', None) + self['scaleratio'] = scaleratio if scaleratio is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showdividers', None) + self['showdividers'] = showdividers if showdividers is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showgrid', None) + self['showgrid'] = showgrid if showgrid is not None else _v + _v = arg.pop('showline', None) + self['showline'] = showline if showline is not None else _v + _v = arg.pop('showspikes', None) + self['showspikes'] = showspikes if showspikes is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('spikecolor', None) + self['spikecolor'] = spikecolor if spikecolor is not None else _v + _v = arg.pop('spikedash', None) + self['spikedash'] = spikedash if spikedash is not None else _v + _v = arg.pop('spikemode', None) + self['spikemode'] = spikemode if spikemode is not None else _v + _v = arg.pop('spikesnap', None) + self['spikesnap'] = spikesnap if spikesnap is not None else _v + _v = arg.pop('spikethickness', None) + self['spikethickness' + ] = spikethickness if spikethickness is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('tickson', None) + self['tickson'] = tickson if tickson is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('zeroline', None) + self['zeroline'] = zeroline if zeroline is not None else _v + _v = arg.pop('zerolinecolor', None) + self['zerolinecolor' + ] = zerolinecolor if zerolinecolor is not None else _v + _v = arg.pop('zerolinewidth', None) + self['zerolinewidth' + ] = zerolinewidth if zerolinewidth is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Updatemenu(_BaseLayoutHierarchyType): + + # active + # ------ + @property + 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] + + Returns + ------- + int + """ + return self['active'] + + @active.setter + def active(self, val): + self['active'] = val + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # buttons + # ------- + @property + def buttons(self): + """ + 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.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. + execute + When true, the API method is executed. When + false, all other behaviors are the same and + command execution is skipped. This may be + useful when hooking into, for example, the + `plotly_buttonclicked` method and executing the + API command manually without losing the benefit + of the updatemenu automatically binding to the + state of the plot through the specification of + `method` and `args`. + label + Sets the text label to appear on the button. + method + Sets the Plotly method to be called on click. + If the `skip` method is used, the API + updatemenu will function as normal but 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. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + visible + Determines whether or not this button is + visible. + + Returns + ------- + tuple[plotly.graph_objs.layout.updatemenu.Button] + """ + return self['buttons'] + + @buttons.setter + def buttons(self, val): + self['buttons'] = val + + # buttondefaults + # -------------- + @property + def buttondefaults(self): + """ + When used in a template (as + 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 plotly.graph_objs.layout.updatemenu.Button + - A dict of string/value properties that will be passed + to the Button constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.layout.updatemenu.Button + """ + return self['buttondefaults'] + + @buttondefaults.setter + def buttondefaults(self, val): + self['buttondefaults'] = val + + # direction + # --------- + @property + def direction(self): + """ + Determines the direction in which the buttons are laid out, + whether in a dropdown menu or a row/column of buttons. For + `left` and `up`, the buttons will still appear in left-to-right + or top-to-bottom order respectively. + + The 'direction' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'up', 'down'] + + Returns + ------- + Any + """ + return self['direction'] + + @direction.setter + def direction(self, val): + self['direction'] = val + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.updatemenu.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # pad + # --- + @property + 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 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. + l + The amount of padding (in px) on the left side + of the component. + r + The amount of padding (in px) on the right side + of the component. + t + The amount of padding (in px) along the top of + the component. + + Returns + ------- + plotly.graph_objs.layout.updatemenu.Pad + """ + return self['pad'] + + @pad.setter + def pad(self, val): + self['pad'] = val + + # showactive + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showactive'] + + @showactive.setter + def showactive(self, val): + self['showactive'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # type + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + active + Determines which button (by index starting from 0) is + considered active. + bgcolor + Sets the background color of the update menu buttons. + bordercolor + Sets the color of the border enclosing the update menu. + borderwidth + Sets the width (in px) of the border enclosing the + update menu. + buttons + plotly.graph_objs.layout.updatemenu.Button instance or + dict with compatible properties + buttondefaults + When used in a template (as + layout.template.layout.updatemenu.buttondefaults), sets + the default property values to use for elements of + layout.updatemenu.buttons + direction + Determines the direction in which the buttons are laid + out, whether in a dropdown menu or a row/column of + buttons. For `left` and `up`, the buttons will still + appear in left-to-right or top-to-bottom order + respectively. + font + Sets the font of the update menu button text. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + pad + Sets the padding around the buttons or dropdown menu. + showactive + Highlights active dropdown item or active button if + true. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Determines whether the buttons are accessible via a + dropdown menu or whether the buttons are stacked + horizontally or vertically + visible + Determines whether or not the update menu is visible. + x + Sets the x position (in normalized coordinates) of the + update menu. + xanchor + Sets the update menu's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the range selector. + y + Sets the y position (in normalized coordinates) of the + update menu. + yanchor + Sets the update menu's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the range selector. + """ + + def __init__( + self, + arg=None, + active=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + buttons=None, + buttondefaults=None, + direction=None, + font=None, + name=None, + pad=None, + showactive=None, + templateitemname=None, + type=None, + visible=None, + x=None, + xanchor=None, + y=None, + yanchor=None, + **kwargs + ): + """ + Construct a new Updatemenu object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Updatemenu + active + Determines which button (by index starting from 0) is + considered active. + bgcolor + Sets the background color of the update menu buttons. + bordercolor + Sets the color of the border enclosing the update menu. + borderwidth + Sets the width (in px) of the border enclosing the + update menu. + buttons + plotly.graph_objs.layout.updatemenu.Button instance or + dict with compatible properties + buttondefaults + When used in a template (as + layout.template.layout.updatemenu.buttondefaults), sets + the default property values to use for elements of + layout.updatemenu.buttons + direction + Determines the direction in which the buttons are laid + out, whether in a dropdown menu or a row/column of + buttons. For `left` and `up`, the buttons will still + appear in left-to-right or top-to-bottom order + respectively. + font + Sets the font of the update menu button text. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + pad + Sets the padding around the buttons or dropdown menu. + showactive + Highlights active dropdown item or active button if + true. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Determines whether the buttons are accessible via a + dropdown menu or whether the buttons are stacked + horizontally or vertically + visible + Determines whether or not the update menu is visible. + x + Sets the x position (in normalized coordinates) of the + update menu. + xanchor + Sets the update menu's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the range selector. + y + Sets the y position (in normalized coordinates) of the + update menu. + yanchor + Sets the update menu's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the range selector. + + Returns + ------- + Updatemenu + """ + super(Updatemenu, self).__init__('updatemenus') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Updatemenu +constructor must be a dict or +an instance of plotly.graph_objs.layout.Updatemenu""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (updatemenu as v_updatemenu) + + # Initialize validators + # --------------------- + self._validators['active'] = v_updatemenu.ActiveValidator() + self._validators['bgcolor'] = v_updatemenu.BgcolorValidator() + self._validators['bordercolor'] = v_updatemenu.BordercolorValidator() + self._validators['borderwidth'] = v_updatemenu.BorderwidthValidator() + self._validators['buttons'] = v_updatemenu.ButtonsValidator() + self._validators['buttondefaults'] = v_updatemenu.ButtonValidator() + self._validators['direction'] = v_updatemenu.DirectionValidator() + self._validators['font'] = v_updatemenu.FontValidator() + self._validators['name'] = v_updatemenu.NameValidator() + self._validators['pad'] = v_updatemenu.PadValidator() + self._validators['showactive'] = v_updatemenu.ShowactiveValidator() + self._validators['templateitemname' + ] = v_updatemenu.TemplateitemnameValidator() + self._validators['type'] = v_updatemenu.TypeValidator() + self._validators['visible'] = v_updatemenu.VisibleValidator() + self._validators['x'] = v_updatemenu.XValidator() + self._validators['xanchor'] = v_updatemenu.XanchorValidator() + self._validators['y'] = v_updatemenu.YValidator() + self._validators['yanchor'] = v_updatemenu.YanchorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('active', None) + self['active'] = active if active is not None else _v + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('buttons', None) + self['buttons'] = buttons if buttons is not None else _v + _v = arg.pop('buttondefaults', None) + self['buttondefaults' + ] = buttondefaults if buttondefaults is not None else _v + _v = arg.pop('direction', None) + self['direction'] = direction if direction is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('pad', None) + self['pad'] = pad if pad is not None else _v + _v = arg.pop('showactive', None) + self['showactive'] = showactive if showactive is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Transition(_BaseLayoutHierarchyType): + + # duration + # -------- + @property + 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] + + Returns + ------- + int|float + """ + return self['duration'] + + @duration.setter + def duration(self, val): + self['duration'] = val + + # easing + # ------ + @property + 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', + 'elastic', 'back', 'bounce', 'linear-in', 'quad-in', + 'cubic-in', 'sin-in', 'exp-in', 'circle-in', 'elastic-in', + 'back-in', 'bounce-in', 'linear-out', 'quad-out', + 'cubic-out', 'sin-out', 'exp-out', 'circle-out', + 'elastic-out', 'back-out', 'bounce-out', 'linear-in-out', + 'quad-in-out', 'cubic-in-out', 'sin-in-out', 'exp-in-out', + 'circle-in-out', 'elastic-in-out', 'back-in-out', + 'bounce-in-out'] + + Returns + ------- + Any + """ + return self['easing'] + + @easing.setter + def easing(self, val): + self['easing'] = val + + # ordering + # -------- + @property + 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'] + + Returns + ------- + Any + """ + return self['ordering'] + + @ordering.setter + def ordering(self, val): + self['ordering'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + duration + The duration of the transition, in milliseconds. If + equal to zero, updates are synchronous. + easing + The easing function used for the transition + ordering + Determines whether the figure's layout or traces + smoothly transitions during updates that make both + traces and layout change. + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Transition + duration + The duration of the transition, in milliseconds. If + equal to zero, updates are synchronous. + easing + The easing function used for the transition + ordering + Determines whether the figure's layout or traces + smoothly transitions during updates that make both + traces and layout change. + + Returns + ------- + Transition + """ + super(Transition, self).__init__('transition') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Transition +constructor must be a dict or +an instance of plotly.graph_objs.layout.Transition""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (transition as v_transition) + + # Initialize validators + # --------------------- + self._validators['duration'] = v_transition.DurationValidator() + self._validators['easing'] = v_transition.EasingValidator() + self._validators['ordering'] = v_transition.OrderingValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('duration', None) + self['duration'] = duration if duration is not None else _v + _v = arg.pop('easing', None) + self['easing'] = easing if easing is not None else _v + _v = arg.pop('ordering', None) + self['ordering'] = ordering if ordering is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + + # font + # ---- + @property + 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 plotly.graph_objs.layout.title.Font + - A dict of string/value properties that will be passed + to the Font constructor + + Supported dict properties: + + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # pad + # --- + @property + def pad(self): + """ + Sets the padding of the title. Each padding value only applies + when the corresponding `xanchor`/`yanchor` value is set + accordingly. E.g. for left padding to take effect, `xanchor` + must be set to "left". The same rule applies if + `xanchor`/`yanchor` is determined automatically. Padding is + muted if the respective anchor value is "middle*/*center". + + The 'pad' property is an instance of Pad + that may be specified as: + - An instance of 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. + l + The amount of padding (in px) on the left side + of the component. + r + The amount of padding (in px) on the right side + of the component. + t + The amount of padding (in px) along the top of + the component. + + Returns + ------- + plotly.graph_objs.layout.title.Pad + """ + return self['pad'] + + @pad.setter + def pad(self, val): + self['pad'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + def xanchor(self): + """ + Sets the title's horizontal alignment with respect to its x + position. "left" means that the title starts at x, "right" + means that the title ends at x and "center" means that the + title's center is at x. "auto" divides `xref` by three and + calculates the `xanchor` value automatically based on the value + of `x`. + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'left', 'center', 'right'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xref + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['xref'] + + @xref.setter + def xref(self, val): + self['xref'] = val + + # y + # - + @property + def y(self): + """ + Sets the y position with respect to `yref` in normalized + coordinates from 0 (bottom) to 1 (top). "auto" places the + baseline of the title onto the vertical center of the top + margin. + + The 'y' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + def yanchor(self): + """ + Sets the title's vertical alignment with respect to its y + position. "top" means that the title's cap line is at y, + "bottom" means that the title's baseline is at y and "middle" + means that the title's midline is at y. "auto" divides `yref` + by three and calculates the `yanchor` value automatically based + on the value of `y`. + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # yref + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['yref'] + + @yref.setter + def yref(self, val): + self['yref'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets the title font. Note that the title's font used to + be customized by the now deprecated `titlefont` + attribute. + pad + Sets the padding of the title. Each padding value only + applies when the corresponding `xanchor`/`yanchor` + value is set accordingly. E.g. for left padding to take + effect, `xanchor` must be set to "left". The same rule + applies if `xanchor`/`yanchor` is determined + automatically. Padding is muted if the respective + anchor value is "middle*/*center". + text + Sets the plot's title. Note that before the existence + of `title.text`, the title's contents used to be + defined as the `title` attribute itself. This behavior + has been deprecated. + x + Sets the x position with respect to `xref` in + normalized coordinates from 0 (left) to 1 (right). + xanchor + Sets the title's horizontal alignment with respect to + its x position. "left" means that the title starts at + x, "right" means that the title ends at x and "center" + means that the title's center is at x. "auto" divides + `xref` by three and calculates the `xanchor` value + automatically based on the value of `x`. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` in + normalized coordinates from 0 (bottom) to 1 (top). + "auto" places the baseline of the title onto the + vertical center of the top margin. + yanchor + Sets the title's vertical alignment with respect to its + y position. "top" means that the title's cap line is at + y, "bottom" means that the title's baseline is at y and + "middle" means that the title's midline is at y. "auto" + divides `yref` by three and calculates the `yanchor` + value automatically based on the value of `y`. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + font=None, + pad=None, + text=None, + x=None, + xanchor=None, + xref=None, + y=None, + yanchor=None, + yref=None, + **kwargs + ): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Title + font + Sets the title font. Note that the title's font used to + be customized by the now deprecated `titlefont` + attribute. + pad + Sets the padding of the title. Each padding value only + applies when the corresponding `xanchor`/`yanchor` + value is set accordingly. E.g. for left padding to take + effect, `xanchor` must be set to "left". The same rule + applies if `xanchor`/`yanchor` is determined + automatically. Padding is muted if the respective + anchor value is "middle*/*center". + text + Sets the plot's title. Note that before the existence + of `title.text`, the title's contents used to be + defined as the `title` attribute itself. This behavior + has been deprecated. + x + Sets the x position with respect to `xref` in + normalized coordinates from 0 (left) to 1 (right). + xanchor + Sets the title's horizontal alignment with respect to + its x position. "left" means that the title starts at + x, "right" means that the title ends at x and "center" + means that the title's center is at x. "auto" divides + `xref` by three and calculates the `xanchor` value + automatically based on the value of `x`. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` in + normalized coordinates from 0 (bottom) to 1 (top). + "auto" places the baseline of the title onto the + vertical center of the top margin. + yanchor + Sets the title's vertical alignment with respect to its + y position. "top" means that the title's cap line is at + y, "bottom" means that the title's baseline is at y and + "middle" means that the title's midline is at y. "auto" + divides `yref` by three and calculates the `yanchor` + value automatically based on the value of `y`. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Title +constructor must be a dict or +an instance of plotly.graph_objs.layout.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['pad'] = v_title.PadValidator() + self._validators['text'] = v_title.TextValidator() + self._validators['x'] = v_title.XValidator() + self._validators['xanchor'] = v_title.XanchorValidator() + self._validators['xref'] = v_title.XrefValidator() + self._validators['y'] = v_title.YValidator() + self._validators['yanchor'] = v_title.YanchorValidator() + self._validators['yref'] = v_title.YrefValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('pad', None) + self['pad'] = pad if pad is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xref', None) + self['xref'] = xref if xref is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('yref', None) + self['yref'] = yref if yref is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Ternary(_BaseLayoutHierarchyType): + + # aaxis + # ----- + @property + def aaxis(self): + """ + The 'aaxis' property is an instance of Aaxis + that may be specified as: + - An instance of 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 + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + layer + Sets the layer on which this axis is displayed. + If *above traces*, this axis is displayed above + all the subplot's traces If *below traces*, + this axis is displayed below all the subplot's + traces, but above the grid lines. Useful when + used together with scatter-like traces with + `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + 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. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.ternary.aaxis.Tickform + atstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.ternary.aaxis.tickformatstopdefaults), sets + the default property values to use for elements + of layout.ternary.aaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.ternary.aaxis.Title + instance or dict with compatible properties + titlefont + 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. + uirevision + Controls persistence of user-driven changes in + axis `min`, and `title` if in `editable: true` + configuration. Defaults to + `ternary.uirevision`. + + Returns + ------- + plotly.graph_objs.layout.ternary.Aaxis + """ + return self['aaxis'] + + @aaxis.setter + def aaxis(self, val): + self['aaxis'] = val + + # baxis + # ----- + @property + def baxis(self): + """ + The 'baxis' property is an instance of Baxis + that may be specified as: + - An instance of 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 + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + layer + Sets the layer on which this axis is displayed. + If *above traces*, this axis is displayed above + all the subplot's traces If *below traces*, + this axis is displayed below all the subplot's + traces, but above the grid lines. Useful when + used together with scatter-like traces with + `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + 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. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.ternary.baxis.Tickform + atstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.ternary.baxis.tickformatstopdefaults), sets + the default property values to use for elements + of layout.ternary.baxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.ternary.baxis.Title + instance or dict with compatible properties + titlefont + 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. + uirevision + Controls persistence of user-driven changes in + axis `min`, and `title` if in `editable: true` + configuration. Defaults to + `ternary.uirevision`. + + Returns + ------- + plotly.graph_objs.layout.ternary.Baxis + """ + return self['baxis'] + + @baxis.setter + def baxis(self, val): + self['baxis'] = val + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # caxis + # ----- + @property + def caxis(self): + """ + The 'caxis' property is an instance of Caxis + that may be specified as: + - An instance of 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 + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + layer + Sets the layer on which this axis is displayed. + If *above traces*, this axis is displayed above + all the subplot's traces If *below traces*, + this axis is displayed below all the subplot's + traces, but above the grid lines. Useful when + used together with scatter-like traces with + `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + 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. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.ternary.caxis.Tickform + atstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.ternary.caxis.tickformatstopdefaults), sets + the default property values to use for elements + of layout.ternary.caxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.ternary.caxis.Title + instance or dict with compatible properties + titlefont + 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. + uirevision + Controls persistence of user-driven changes in + axis `min`, and `title` if in `editable: true` + configuration. Defaults to + `ternary.uirevision`. + + Returns + ------- + plotly.graph_objs.layout.ternary.Caxis + """ + return self['caxis'] + + @caxis.setter + def caxis(self, val): + self['caxis'] = val + + # domain + # ------ + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of 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 + subplot . + row + If there is a layout grid, use the domain for + this row in the grid for this ternary subplot . + x + Sets the horizontal domain of this ternary + subplot (in plot fraction). + y + Sets the vertical domain of this ternary + subplot (in plot fraction). + + Returns + ------- + plotly.graph_objs.layout.ternary.Domain + """ + return self['domain'] + + @domain.setter + def domain(self, val): + self['domain'] = val + + # sum + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['sum'] + + @sum.setter + def sum(self, val): + self['sum'] = val + + # uirevision + # ---------- + @property + 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 + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + aaxis + plotly.graph_objs.layout.ternary.Aaxis instance or dict + with compatible properties + baxis + plotly.graph_objs.layout.ternary.Baxis instance or dict + with compatible properties + bgcolor + Set the background color of the subplot + caxis + plotly.graph_objs.layout.ternary.Caxis instance or dict + with compatible properties + domain + plotly.graph_objs.layout.ternary.Domain instance or + dict with compatible properties + sum + The number each triplet should sum to, and the maximum + range of each axis + uirevision + Controls persistence of user-driven changes in axis + `min` and `title`, if not overridden in the individual + axes. Defaults to `layout.uirevision`. + """ + + def __init__( + self, + arg=None, + aaxis=None, + baxis=None, + bgcolor=None, + caxis=None, + domain=None, + sum=None, + uirevision=None, + **kwargs + ): + """ + Construct a new Ternary object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Ternary + aaxis + plotly.graph_objs.layout.ternary.Aaxis instance or dict + with compatible properties + baxis + plotly.graph_objs.layout.ternary.Baxis instance or dict + with compatible properties + bgcolor + Set the background color of the subplot + caxis + plotly.graph_objs.layout.ternary.Caxis instance or dict + with compatible properties + domain + plotly.graph_objs.layout.ternary.Domain instance or + dict with compatible properties + sum + The number each triplet should sum to, and the maximum + range of each axis + uirevision + Controls persistence of user-driven changes in axis + `min` and `title`, if not overridden in the individual + axes. Defaults to `layout.uirevision`. + + Returns + ------- + Ternary + """ + super(Ternary, self).__init__('ternary') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Ternary +constructor must be a dict or +an instance of plotly.graph_objs.layout.Ternary""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (ternary as v_ternary) + + # Initialize validators + # --------------------- + self._validators['aaxis'] = v_ternary.AaxisValidator() + self._validators['baxis'] = v_ternary.BaxisValidator() + self._validators['bgcolor'] = v_ternary.BgcolorValidator() + self._validators['caxis'] = v_ternary.CaxisValidator() + self._validators['domain'] = v_ternary.DomainValidator() + self._validators['sum'] = v_ternary.SumValidator() + self._validators['uirevision'] = v_ternary.UirevisionValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('aaxis', None) + self['aaxis'] = aaxis if aaxis is not None else _v + _v = arg.pop('baxis', None) + self['baxis'] = baxis if baxis is not None else _v + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('caxis', None) + self['caxis'] = caxis if caxis is not None else _v + _v = arg.pop('domain', None) + self['domain'] = domain if domain is not None else _v + _v = arg.pop('sum', None) + self['sum'] = sum if sum is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Template(_BaseLayoutHierarchyType): + + # data + # ---- + @property + def data(self): + """ + The 'data' property is an instance of Data + that may be specified as: + - An instance of plotly.graph_objs.layout.template.Data + - A dict of string/value properties that will be passed + to the Data constructor + + Supported dict properties: + + area + plotly.graph_objs.layout.template.data.Area + instance or dict with compatible properties + barpolar + plotly.graph_objs.layout.template.data.Barpolar + instance or dict with compatible properties + bar + plotly.graph_objs.layout.template.data.Bar + instance or dict with compatible properties + box + plotly.graph_objs.layout.template.data.Box + instance or dict with compatible properties + candlestick + plotly.graph_objs.layout.template.data.Candlest + ick instance or dict with compatible properties + carpet + plotly.graph_objs.layout.template.data.Carpet + instance or dict with compatible properties + choropleth + plotly.graph_objs.layout.template.data.Chorople + th instance or dict with compatible properties + cone + plotly.graph_objs.layout.template.data.Cone + instance or dict with compatible properties + contourcarpet + plotly.graph_objs.layout.template.data.Contourc + arpet instance or dict with compatible + properties + contour + plotly.graph_objs.layout.template.data.Contour + instance or dict with compatible properties + heatmapgl + plotly.graph_objs.layout.template.data.Heatmapg + l instance or dict with compatible properties + heatmap + plotly.graph_objs.layout.template.data.Heatmap + instance or dict with compatible properties + histogram2dcontour + plotly.graph_objs.layout.template.data.Histogra + m2dContour instance or dict with compatible + properties + histogram2d + plotly.graph_objs.layout.template.data.Histogra + m2d instance or dict with compatible properties + histogram + plotly.graph_objs.layout.template.data.Histogra + m instance or dict with compatible properties + isosurface + plotly.graph_objs.layout.template.data.Isosurfa + ce instance or dict with compatible properties + mesh3d + plotly.graph_objs.layout.template.data.Mesh3d + instance or dict with compatible properties + ohlc + plotly.graph_objs.layout.template.data.Ohlc + instance or dict with compatible properties + parcats + plotly.graph_objs.layout.template.data.Parcats + instance or dict with compatible properties + parcoords + plotly.graph_objs.layout.template.data.Parcoord + s instance or dict with compatible properties + pie + plotly.graph_objs.layout.template.data.Pie + instance or dict with compatible properties + pointcloud + plotly.graph_objs.layout.template.data.Pointclo + ud instance or dict with compatible properties + sankey + plotly.graph_objs.layout.template.data.Sankey + instance or dict with compatible properties + scatter3d + plotly.graph_objs.layout.template.data.Scatter3 + d instance or dict with compatible properties + scattercarpet + plotly.graph_objs.layout.template.data.Scatterc + arpet instance or dict with compatible + properties + scattergeo + plotly.graph_objs.layout.template.data.Scatterg + eo instance or dict with compatible properties + scattergl + plotly.graph_objs.layout.template.data.Scatterg + l instance or dict with compatible properties + scattermapbox + plotly.graph_objs.layout.template.data.Scatterm + apbox instance or dict with compatible + properties + scatterpolargl + plotly.graph_objs.layout.template.data.Scatterp + olargl instance or dict with compatible + properties + scatterpolar + plotly.graph_objs.layout.template.data.Scatterp + olar instance or dict with compatible + properties + scatter + plotly.graph_objs.layout.template.data.Scatter + instance or dict with compatible properties + scatterternary + plotly.graph_objs.layout.template.data.Scattert + ernary instance or dict with compatible + properties + splom + plotly.graph_objs.layout.template.data.Splom + instance or dict with compatible properties + streamtube + plotly.graph_objs.layout.template.data.Streamtu + be instance or dict with compatible properties + surface + plotly.graph_objs.layout.template.data.Surface + instance or dict with compatible properties + table + plotly.graph_objs.layout.template.data.Table + instance or dict with compatible properties + violin + plotly.graph_objs.layout.template.data.Violin + instance or dict with compatible properties + + Returns + ------- + plotly.graph_objs.layout.template.Data + """ + return self['data'] + + @data.setter + def data(self, val): + self['data'] = val + + # layout + # ------ + @property + def layout(self): + """ + The 'layout' property is an instance of Layout + that may be specified as: + - An instance of plotly.graph_objs.layout.template.Layout + - A dict of string/value properties that will be passed + to the Layout constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.layout.template.Layout + """ + return self['layout'] + + @layout.setter + def layout(self, val): + self['layout'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + data + plotly.graph_objs.layout.template.Data instance or dict + with compatible properties + layout + plotly.graph_objs.layout.template.Layout instance or + dict with compatible properties + """ + + 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 + `layoutTemplate` is a dict matching the structure of + `figure.layout` and `traceTemplate` is a dict matching the + structure of the trace with type `trace_type` (e.g. 'scatter'). + Alternatively, this may be specified as an instance of + plotly.graph_objs.layout.Template. Trace templates are applied + cyclically to traces of each type. Container arrays (eg + `annotations`) have special handling: An object ending in + `defaults` (eg `annotationdefaults`) is applied to each array + item. But if an item has a `templateitemname` key we look in + the template array for an item with matching `name` and apply + that instead. If no matching `name` is found we mark the item + invisible. Any named template item not referenced is appended + to the end of the array, so this can be used to add a watermark + annotation or a logo image, for example. To omit one of these + items on the plot, make an item with matching + `templateitemname` and `visible: false`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Template + data + plotly.graph_objs.layout.template.Data instance or dict + with compatible properties + layout + plotly.graph_objs.layout.template.Layout instance or + dict with compatible properties + + Returns + ------- + Template + """ + super(Template, self).__init__('template') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Template +constructor must be a dict or +an instance of plotly.graph_objs.layout.Template""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (template as v_template) + + # Initialize validators + # --------------------- + self._validators['data'] = v_template.DataValidator() + self._validators['layout'] = v_template.LayoutValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('data', None) + self['data'] = data if data is not None else _v + _v = arg.pop('layout', None) + self['layout'] = layout if layout is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Slider(_BaseLayoutHierarchyType): + + # active + # ------ + @property + 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] + + Returns + ------- + int|float + """ + return self['active'] + + @active.setter + def active(self, val): + self['active'] = val + + # activebgcolor + # ------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['activebgcolor'] + + @activebgcolor.setter + def activebgcolor(self, val): + self['activebgcolor'] = val + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # currentvalue + # ------------ + @property + def currentvalue(self): + """ + The 'currentvalue' property is an instance of Currentvalue + that may be specified as: + - An instance of 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 + The amount of space, in pixels, between the + current value label and the slider. + prefix + When currentvalue.visible is true, this sets + the prefix of the label. + suffix + When currentvalue.visible is true, this sets + the suffix of the label. + visible + Shows the currently-selected value above the + slider. + xanchor + The alignment of the value readout relative to + the length of the slider. + + Returns + ------- + plotly.graph_objs.layout.slider.Currentvalue + """ + return self['currentvalue'] + + @currentvalue.setter + def currentvalue(self, val): + self['currentvalue'] = val + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.slider.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # minorticklen + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['minorticklen'] + + @minorticklen.setter + def minorticklen(self, val): + self['minorticklen'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # pad + # --- + @property + 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 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. + l + The amount of padding (in px) on the left side + of the component. + r + The amount of padding (in px) on the right side + of the component. + t + The amount of padding (in px) along the top of + the component. + + Returns + ------- + plotly.graph_objs.layout.slider.Pad + """ + return self['pad'] + + @pad.setter + def pad(self, val): + self['pad'] = val + + # steps + # ----- + @property + def steps(self): + """ + The 'steps' property is a tuple of instances of + Step that may be specified as: + - 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. + execute + When true, the API method is executed. When + false, all other behaviors are the same and + command execution is skipped. This may be + useful when hooking into, for example, the + `plotly_sliderchange` method and executing the + API command manually without losing the benefit + of the slider automatically binding to the + state of the plot through the specification of + `method` and `args`. + label + Sets the text label to appear on the slider + method + Sets the Plotly method to be called when the + slider value is changed. If the `skip` method + is used, the API slider will function as normal + but 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 slider events manually via JavaScript. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + Sets the value of the slider step, used to + refer to the step programatically. Defaults to + the slider label if not provided. + visible + Determines whether or not this step is included + in the slider. + + Returns + ------- + tuple[plotly.graph_objs.layout.slider.Step] + """ + return self['steps'] + + @steps.setter + def steps(self, val): + self['steps'] = val + + # stepdefaults + # ------------ + @property + 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 plotly.graph_objs.layout.slider.Step + - A dict of string/value properties that will be passed + to the Step constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.layout.slider.Step + """ + return self['stepdefaults'] + + @stepdefaults.setter + def stepdefaults(self, val): + self['stepdefaults'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # transition + # ---------- + @property + def transition(self): + """ + The 'transition' property is an instance of Transition + that may be specified as: + - An instance of 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 + Sets the easing function of the slider + transition + + Returns + ------- + plotly.graph_objs.layout.slider.Transition + """ + return self['transition'] + + @transition.setter + def transition(self, val): + self['transition'] = val + + # visible + # ------- + @property + def visible(self): + """ + Determines whether or not the slider is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + active + Determines which button (by index starting from 0) is + considered active. + activebgcolor + Sets the background color of the slider grip while + dragging. + bgcolor + Sets the background color of the slider. + bordercolor + Sets the color of the border enclosing the slider. + borderwidth + Sets the width (in px) of the border enclosing the + slider. + currentvalue + plotly.graph_objs.layout.slider.Currentvalue instance + or dict with compatible properties + font + Sets the font of the slider step labels. + len + Sets the length of the slider This measure excludes the + padding of both ends. That is, the slider's length is + this length minus the padding on both ends. + lenmode + Determines whether this slider length is set in units + of plot "fraction" or in *pixels. Use `len` to set the + value. + minorticklen + Sets the length in pixels of minor step tick marks + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + pad + Set the padding of the slider component along each + side. + steps + plotly.graph_objs.layout.slider.Step instance or dict + with compatible properties + stepdefaults + When used in a template (as + layout.template.layout.slider.stepdefaults), sets the + default property values to use for elements of + layout.slider.steps + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + tickcolor + Sets the color of the border enclosing the slider. + ticklen + Sets the length in pixels of step tick marks + tickwidth + Sets the tick width (in px). + transition + plotly.graph_objs.layout.slider.Transition instance or + dict with compatible properties + visible + Determines whether or not the slider is visible. + x + Sets the x position (in normalized coordinates) of the + slider. + xanchor + Sets the slider's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the range selector. + y + Sets the y position (in normalized coordinates) of the + slider. + yanchor + Sets the slider's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or + "bottom" of the range selector. + """ + + def __init__( + self, + arg=None, + active=None, + activebgcolor=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + currentvalue=None, + font=None, + len=None, + lenmode=None, + minorticklen=None, + name=None, + pad=None, + steps=None, + stepdefaults=None, + templateitemname=None, + tickcolor=None, + ticklen=None, + tickwidth=None, + transition=None, + visible=None, + x=None, + xanchor=None, + y=None, + yanchor=None, + **kwargs + ): + """ + Construct a new Slider object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Slider + active + Determines which button (by index starting from 0) is + considered active. + activebgcolor + Sets the background color of the slider grip while + dragging. + bgcolor + Sets the background color of the slider. + bordercolor + Sets the color of the border enclosing the slider. + borderwidth + Sets the width (in px) of the border enclosing the + slider. + currentvalue + plotly.graph_objs.layout.slider.Currentvalue instance + or dict with compatible properties + font + Sets the font of the slider step labels. + len + Sets the length of the slider This measure excludes the + padding of both ends. That is, the slider's length is + this length minus the padding on both ends. + lenmode + Determines whether this slider length is set in units + of plot "fraction" or in *pixels. Use `len` to set the + value. + minorticklen + Sets the length in pixels of minor step tick marks + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + pad + Set the padding of the slider component along each + side. + steps + plotly.graph_objs.layout.slider.Step instance or dict + with compatible properties + stepdefaults + When used in a template (as + layout.template.layout.slider.stepdefaults), sets the + default property values to use for elements of + layout.slider.steps + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + tickcolor + Sets the color of the border enclosing the slider. + ticklen + Sets the length in pixels of step tick marks + tickwidth + Sets the tick width (in px). + transition + plotly.graph_objs.layout.slider.Transition instance or + dict with compatible properties + visible + Determines whether or not the slider is visible. + x + Sets the x position (in normalized coordinates) of the + slider. + xanchor + Sets the slider's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the range selector. + y + Sets the y position (in normalized coordinates) of the + slider. + yanchor + Sets the slider's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or + "bottom" of the range selector. + + Returns + ------- + Slider + """ + super(Slider, self).__init__('sliders') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Slider +constructor must be a dict or +an instance of plotly.graph_objs.layout.Slider""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (slider as v_slider) + + # Initialize validators + # --------------------- + self._validators['active'] = v_slider.ActiveValidator() + self._validators['activebgcolor'] = v_slider.ActivebgcolorValidator() + self._validators['bgcolor'] = v_slider.BgcolorValidator() + self._validators['bordercolor'] = v_slider.BordercolorValidator() + self._validators['borderwidth'] = v_slider.BorderwidthValidator() + self._validators['currentvalue'] = v_slider.CurrentvalueValidator() + self._validators['font'] = v_slider.FontValidator() + self._validators['len'] = v_slider.LenValidator() + self._validators['lenmode'] = v_slider.LenmodeValidator() + self._validators['minorticklen'] = v_slider.MinorticklenValidator() + self._validators['name'] = v_slider.NameValidator() + self._validators['pad'] = v_slider.PadValidator() + self._validators['steps'] = v_slider.StepsValidator() + self._validators['stepdefaults'] = v_slider.StepValidator() + self._validators['templateitemname' + ] = v_slider.TemplateitemnameValidator() + self._validators['tickcolor'] = v_slider.TickcolorValidator() + self._validators['ticklen'] = v_slider.TicklenValidator() + self._validators['tickwidth'] = v_slider.TickwidthValidator() + self._validators['transition'] = v_slider.TransitionValidator() + self._validators['visible'] = v_slider.VisibleValidator() + self._validators['x'] = v_slider.XValidator() + self._validators['xanchor'] = v_slider.XanchorValidator() + self._validators['y'] = v_slider.YValidator() + self._validators['yanchor'] = v_slider.YanchorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('active', None) + self['active'] = active if active is not None else _v + _v = arg.pop('activebgcolor', None) + self['activebgcolor' + ] = activebgcolor if activebgcolor is not None else _v + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('currentvalue', None) + self['currentvalue'] = currentvalue if currentvalue is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('minorticklen', None) + self['minorticklen'] = minorticklen if minorticklen is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('pad', None) + self['pad'] = pad if pad is not None else _v + _v = arg.pop('steps', None) + self['steps'] = steps if steps is not None else _v + _v = arg.pop('stepdefaults', None) + self['stepdefaults'] = stepdefaults if stepdefaults is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('transition', None) + self['transition'] = transition if transition is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Shape(_BaseLayoutHierarchyType): + + # fillcolor + # --------- + @property + def fillcolor(self): + """ + Sets the color filling the shape's 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['fillcolor'] + + @fillcolor.setter + def fillcolor(self, val): + self['fillcolor'] = val + + # layer + # ----- + @property + 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'] + + Returns + ------- + Any + """ + return self['layer'] + + @layer.setter + def layer(self, val): + self['layer'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + plotly.graph_objs.layout.shape.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # path + # ---- + @property + def path(self): + """ + For `type` "path" - a valid SVG path with the pixel values + replaced by data values in `xsizemode`/`ysizemode` being + "scaled" and taken unmodified as pixels relative to `xanchor` + and `yanchor` in case of "pixel" size mode. There are a few + restrictions / quirks only absolute instructions, not relative. + So the allowed segments are: M, L, H, V, Q, C, T, S, and Z arcs + (A) are not allowed because radius rx and ry are relative. In + the future we could consider supporting relative commands, but + we would have to decide on how to handle date and log axes. + Note that even as is, Q and C Bezier paths that are smooth on + linear axes may not be smooth on log, and vice versa. no + chained "polybezier" commands - specify the segment type for + each one. On category axes, values are numbers scaled to the + serial numbers of categories because using the categories + themselves there would be no way to describe fractional + positions On data axes: because space and T are both normal + components of path strings, we can't use either to separate + date from time parts. Therefore we'll use underscore for this + purpose: 2015-02-21_13:45:56.789 + + The 'path' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['path'] + + @path.setter + def path(self, val): + self['path'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # type + # ---- + @property + def type(self): + """ + Specifies the shape type to be drawn. If "line", a line is + drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect to the axes' + sizing mode. If "circle", a circle is drawn from + ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius (|(`x0`+`x1`)/2 - + `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with respect to the axes' sizing + mode. If "rect", a rectangle is drawn linking (`x0`,`y0`), + (`x1`,`y0`), (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect + to the axes' sizing mode. If "path", draw a custom SVG path + using `path`. with respect to the axes' sizing mode. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['circle', 'rect', 'path', 'line'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # visible + # ------- + @property + def visible(self): + """ + Determines whether or not this shape is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x0 + # -- + @property + 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 + ------- + Any + """ + return self['x0'] + + @x0.setter + def x0(self, val): + self['x0'] = val + + # x1 + # -- + @property + 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 + ------- + Any + """ + return self['x1'] + + @x1.setter + def x1(self, val): + self['x1'] = val + + # xanchor + # ------- + @property + def xanchor(self): + """ + Only relevant in conjunction with `xsizemode` set to "pixel". + Specifies the anchor point on the x axis to which `x0`, `x1` + and x coordinates within `path` are relative to. E.g. useful to + attach a pixel sized shape to a certain data value. No effect + when `xsizemode` not set to "pixel". + + The 'xanchor' property accepts values of any type + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xref + # ---- + @property + def xref(self): + """ + Sets the shape's x coordinate axis. If set to an x axis id + (e.g. "x" or "x2"), the `x` position refers to an x coordinate. + If set to "paper", the `x` position refers to the distance from + the left side of the plotting area in normalized coordinates + where 0 (1) corresponds to the left (right) side. If the axis + `type` is "log", then you must take the log of your desired + range. If the axis `type` is "date", then you must convert the + date to unix time in milliseconds. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['paper'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + Any + """ + return self['xref'] + + @xref.setter + def xref(self, val): + self['xref'] = val + + # xsizemode + # --------- + @property + def xsizemode(self): + """ + Sets the shapes's sizing mode along the x axis. If set to + "scaled", `x0`, `x1` and x coordinates within `path` refer to + data values on the x axis or a fraction of the plot area's + width (`xref` set to "paper"). If set to "pixel", `xanchor` + specifies the x position in terms of data or plot fraction but + `x0`, `x1` and x coordinates within `path` are pixels relative + to `xanchor`. This way, the shape can have a fixed width while + maintaining a position relative to data or plot fraction. + + The 'xsizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['scaled', 'pixel'] + + Returns + ------- + Any + """ + return self['xsizemode'] + + @xsizemode.setter + def xsizemode(self, val): + self['xsizemode'] = val + + # y0 + # -- + @property + 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 + ------- + Any + """ + return self['y0'] + + @y0.setter + def y0(self, val): + self['y0'] = val + + # y1 + # -- + @property + 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 + ------- + Any + """ + return self['y1'] + + @y1.setter + def y1(self, val): + self['y1'] = val + + # yanchor + # ------- + @property + def yanchor(self): + """ + Only relevant in conjunction with `ysizemode` set to "pixel". + Specifies the anchor point on the y axis to which `y0`, `y1` + and y coordinates within `path` are relative to. E.g. useful to + attach a pixel sized shape to a certain data value. No effect + when `ysizemode` not set to "pixel". + + The 'yanchor' property accepts values of any type + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # yref + # ---- + @property + def yref(self): + """ + Sets the annotation's y coordinate axis. If set to an y axis id + (e.g. "y" or "y2"), the `y` position refers to an y coordinate + If set to "paper", the `y` position refers to the distance from + the bottom of the plotting area in normalized coordinates where + 0 (1) corresponds to the bottom (top). + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['paper'] + - A string that matches one of the following regular expressions: + ['^y([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + Any + """ + return self['yref'] + + @yref.setter + def yref(self, val): + self['yref'] = val + + # ysizemode + # --------- + @property + def ysizemode(self): + """ + Sets the shapes's sizing mode along the y axis. If set to + "scaled", `y0`, `y1` and y coordinates within `path` refer to + data values on the y axis or a fraction of the plot area's + height (`yref` set to "paper"). If set to "pixel", `yanchor` + specifies the y position in terms of data or plot fraction but + `y0`, `y1` and y coordinates within `path` are pixels relative + to `yanchor`. This way, the shape can have a fixed height while + maintaining a position relative to data or plot fraction. + + The 'ysizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['scaled', 'pixel'] + + Returns + ------- + Any + """ + return self['ysizemode'] + + @ysizemode.setter + def ysizemode(self, val): + self['ysizemode'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + fillcolor + Sets the color filling the shape's interior. + layer + Specifies whether shapes are drawn below or above + traces. + line + plotly.graph_objs.layout.shape.Line instance or dict + with compatible properties + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the shape. + path + For `type` "path" - a valid SVG path with the pixel + values replaced by data values in + `xsizemode`/`ysizemode` being "scaled" and taken + unmodified as pixels relative to `xanchor` and + `yanchor` in case of "pixel" size mode. There are a few + restrictions / quirks only absolute instructions, not + relative. So the allowed segments are: M, L, H, V, Q, + C, T, S, and Z arcs (A) are not allowed because radius + rx and ry are relative. In the future we could consider + supporting relative commands, but we would have to + decide on how to handle date and log axes. Note that + even as is, Q and C Bezier paths that are smooth on + linear axes may not be smooth on log, and vice versa. + no chained "polybezier" commands - specify the segment + type for each one. On category axes, values are numbers + scaled to the serial numbers of categories because + using the categories themselves there would be no way + to describe fractional positions On data axes: because + space and T are both normal components of path strings, + we can't use either to separate date from time parts. + Therefore we'll use underscore for this purpose: + 2015-02-21_13:45:56.789 + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Specifies the shape type to be drawn. If "line", a line + is drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect + to the axes' sizing mode. If "circle", a circle is + drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius + (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with + respect to the axes' sizing mode. If "rect", a + rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), + (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect to + the axes' sizing mode. If "path", draw a custom SVG + path using `path`. with respect to the axes' sizing + mode. + visible + Determines whether or not this shape is visible. + x0 + Sets the shape's starting x position. See `type` and + `xsizemode` for more info. + x1 + Sets the shape's end x position. See `type` and + `xsizemode` for more info. + xanchor + Only relevant in conjunction with `xsizemode` set to + "pixel". Specifies the anchor point on the x axis to + which `x0`, `x1` and x coordinates within `path` are + relative to. E.g. useful to attach a pixel sized shape + to a certain data value. No effect when `xsizemode` not + set to "pixel". + xref + Sets the shape's x coordinate axis. If set to an x axis + id (e.g. "x" or "x2"), the `x` position refers to an x + coordinate. If set to "paper", the `x` position refers + to the distance from the left side of the plotting area + in normalized coordinates where 0 (1) corresponds to + the left (right) side. If the axis `type` is "log", + then you must take the log of your desired range. If + the axis `type` is "date", then you must convert the + date to unix time in milliseconds. + xsizemode + Sets the shapes's sizing mode along the x axis. If set + to "scaled", `x0`, `x1` and x coordinates within `path` + refer to data values on the x axis or a fraction of the + plot area's width (`xref` set to "paper"). If set to + "pixel", `xanchor` specifies the x position in terms of + data or plot fraction but `x0`, `x1` and x coordinates + within `path` are pixels relative to `xanchor`. This + way, the shape can have a fixed width while maintaining + a position relative to data or plot fraction. + y0 + Sets the shape's starting y position. See `type` and + `ysizemode` for more info. + y1 + Sets the shape's end y position. See `type` and + `ysizemode` for more info. + yanchor + Only relevant in conjunction with `ysizemode` set to + "pixel". Specifies the anchor point on the y axis to + which `y0`, `y1` and y coordinates within `path` are + relative to. E.g. useful to attach a pixel sized shape + to a certain data value. No effect when `ysizemode` not + set to "pixel". + yref + Sets the annotation's y coordinate axis. If set to an y + axis id (e.g. "y" or "y2"), the `y` position refers to + an y coordinate If set to "paper", the `y` position + refers to the distance from the bottom of the plotting + area in normalized coordinates where 0 (1) corresponds + to the bottom (top). + ysizemode + Sets the shapes's sizing mode along the y axis. If set + to "scaled", `y0`, `y1` and y coordinates within `path` + refer to data values on the y axis or a fraction of the + plot area's height (`yref` set to "paper"). If set to + "pixel", `yanchor` specifies the y position in terms of + data or plot fraction but `y0`, `y1` and y coordinates + within `path` are pixels relative to `yanchor`. This + way, the shape can have a fixed height while + maintaining a position relative to data or plot + fraction. + """ + + def __init__( + self, + arg=None, + fillcolor=None, + layer=None, + line=None, + name=None, + opacity=None, + path=None, + templateitemname=None, + type=None, + visible=None, + x0=None, + x1=None, + xanchor=None, + xref=None, + xsizemode=None, + y0=None, + y1=None, + yanchor=None, + yref=None, + ysizemode=None, + **kwargs + ): + """ + Construct a new Shape object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Shape + fillcolor + Sets the color filling the shape's interior. + layer + Specifies whether shapes are drawn below or above + traces. + line + plotly.graph_objs.layout.shape.Line instance or dict + with compatible properties + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the shape. + path + For `type` "path" - a valid SVG path with the pixel + values replaced by data values in + `xsizemode`/`ysizemode` being "scaled" and taken + unmodified as pixels relative to `xanchor` and + `yanchor` in case of "pixel" size mode. There are a few + restrictions / quirks only absolute instructions, not + relative. So the allowed segments are: M, L, H, V, Q, + C, T, S, and Z arcs (A) are not allowed because radius + rx and ry are relative. In the future we could consider + supporting relative commands, but we would have to + decide on how to handle date and log axes. Note that + even as is, Q and C Bezier paths that are smooth on + linear axes may not be smooth on log, and vice versa. + no chained "polybezier" commands - specify the segment + type for each one. On category axes, values are numbers + scaled to the serial numbers of categories because + using the categories themselves there would be no way + to describe fractional positions On data axes: because + space and T are both normal components of path strings, + we can't use either to separate date from time parts. + Therefore we'll use underscore for this purpose: + 2015-02-21_13:45:56.789 + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Specifies the shape type to be drawn. If "line", a line + is drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect + to the axes' sizing mode. If "circle", a circle is + drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius + (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with + respect to the axes' sizing mode. If "rect", a + rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), + (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect to + the axes' sizing mode. If "path", draw a custom SVG + path using `path`. with respect to the axes' sizing + mode. + visible + Determines whether or not this shape is visible. + x0 + Sets the shape's starting x position. See `type` and + `xsizemode` for more info. + x1 + Sets the shape's end x position. See `type` and + `xsizemode` for more info. + xanchor + Only relevant in conjunction with `xsizemode` set to + "pixel". Specifies the anchor point on the x axis to + which `x0`, `x1` and x coordinates within `path` are + relative to. E.g. useful to attach a pixel sized shape + to a certain data value. No effect when `xsizemode` not + set to "pixel". + xref + Sets the shape's x coordinate axis. If set to an x axis + id (e.g. "x" or "x2"), the `x` position refers to an x + coordinate. If set to "paper", the `x` position refers + to the distance from the left side of the plotting area + in normalized coordinates where 0 (1) corresponds to + the left (right) side. If the axis `type` is "log", + then you must take the log of your desired range. If + the axis `type` is "date", then you must convert the + date to unix time in milliseconds. + xsizemode + Sets the shapes's sizing mode along the x axis. If set + to "scaled", `x0`, `x1` and x coordinates within `path` + refer to data values on the x axis or a fraction of the + plot area's width (`xref` set to "paper"). If set to + "pixel", `xanchor` specifies the x position in terms of + data or plot fraction but `x0`, `x1` and x coordinates + within `path` are pixels relative to `xanchor`. This + way, the shape can have a fixed width while maintaining + a position relative to data or plot fraction. + y0 + Sets the shape's starting y position. See `type` and + `ysizemode` for more info. + y1 + Sets the shape's end y position. See `type` and + `ysizemode` for more info. + yanchor + Only relevant in conjunction with `ysizemode` set to + "pixel". Specifies the anchor point on the y axis to + which `y0`, `y1` and y coordinates within `path` are + relative to. E.g. useful to attach a pixel sized shape + to a certain data value. No effect when `ysizemode` not + set to "pixel". + yref + Sets the annotation's y coordinate axis. If set to an y + axis id (e.g. "y" or "y2"), the `y` position refers to + an y coordinate If set to "paper", the `y` position + refers to the distance from the bottom of the plotting + area in normalized coordinates where 0 (1) corresponds + to the bottom (top). + ysizemode + Sets the shapes's sizing mode along the y axis. If set + to "scaled", `y0`, `y1` and y coordinates within `path` + refer to data values on the y axis or a fraction of the + plot area's height (`yref` set to "paper"). If set to + "pixel", `yanchor` specifies the y position in terms of + data or plot fraction but `y0`, `y1` and y coordinates + within `path` are pixels relative to `yanchor`. This + way, the shape can have a fixed height while + maintaining a position relative to data or plot + fraction. + + Returns + ------- + Shape + """ + super(Shape, self).__init__('shapes') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Shape +constructor must be a dict or +an instance of plotly.graph_objs.layout.Shape""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (shape as v_shape) + + # Initialize validators + # --------------------- + self._validators['fillcolor'] = v_shape.FillcolorValidator() + self._validators['layer'] = v_shape.LayerValidator() + self._validators['line'] = v_shape.LineValidator() + self._validators['name'] = v_shape.NameValidator() + self._validators['opacity'] = v_shape.OpacityValidator() + self._validators['path'] = v_shape.PathValidator() + self._validators['templateitemname' + ] = v_shape.TemplateitemnameValidator() + self._validators['type'] = v_shape.TypeValidator() + self._validators['visible'] = v_shape.VisibleValidator() + self._validators['x0'] = v_shape.X0Validator() + self._validators['x1'] = v_shape.X1Validator() + self._validators['xanchor'] = v_shape.XanchorValidator() + self._validators['xref'] = v_shape.XrefValidator() + self._validators['xsizemode'] = v_shape.XsizemodeValidator() + self._validators['y0'] = v_shape.Y0Validator() + self._validators['y1'] = v_shape.Y1Validator() + self._validators['yanchor'] = v_shape.YanchorValidator() + self._validators['yref'] = v_shape.YrefValidator() + self._validators['ysizemode'] = v_shape.YsizemodeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('fillcolor', None) + self['fillcolor'] = fillcolor if fillcolor is not None else _v + _v = arg.pop('layer', None) + self['layer'] = layer if layer is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('path', None) + self['path'] = path if path is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x0', None) + self['x0'] = x0 if x0 is not None else _v + _v = arg.pop('x1', None) + self['x1'] = x1 if x1 is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xref', None) + self['xref'] = xref if xref is not None else _v + _v = arg.pop('xsizemode', None) + self['xsizemode'] = xsizemode if xsizemode is not None else _v + _v = arg.pop('y0', None) + self['y0'] = y0 if y0 is not None else _v + _v = arg.pop('y1', None) + self['y1'] = y1 if y1 is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('yref', None) + self['yref'] = yref if yref is not None else _v + _v = arg.pop('ysizemode', None) + self['ysizemode'] = ysizemode if ysizemode is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Scene(_BaseLayoutHierarchyType): + + # annotations + # ----------- + @property + def annotations(self): + """ + The 'annotations' property is a tuple of instances of + Annotation that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.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` + spans more two or more lines (i.e. `text` + contains one or more
HTML tags) or if an + explicit width is set to override the text + width. + arrowcolor + Sets the color of the annotation arrow. + arrowhead + Sets the end annotation arrow head style. + arrowside + Sets the annotation arrow head position. + arrowsize + Sets the size of the end annotation arrow head, + relative to `arrowwidth`. A value of 1 + (default) gives a head about 3x as wide as the + line. + arrowwidth + Sets the width (in px) of annotation arrow + line. + ax + Sets the x component of the arrow tail about + the arrow head (in pixels). + ay + Sets the y component of the arrow tail about + the arrow head (in pixels). + bgcolor + Sets the background color of the annotation. + bordercolor + Sets the color of the border enclosing the + annotation `text`. + borderpad + Sets the padding (in px) between the `text` and + the enclosing border. + borderwidth + Sets the width (in px) of the border enclosing + the annotation `text`. + captureevents + Determines whether the annotation text box + captures mouse move and click events, or allows + those events to pass through to data points in + the plot that may be behind the annotation. By + default `captureevents` is False unless + `hovertext` is provided. If you use the event + `plotly_clickannotation` without `hovertext` + you must explicitly enable `captureevents`. + font + Sets the annotation text font. + height + Sets an explicit height for the text box. null + (default) lets the text set the box height. + Taller text will be clipped. + hoverlabel + plotly.graph_objs.layout.scene.annotation.Hover + label instance or dict with compatible + properties + hovertext + Sets text to appear when hovering over this + annotation. If omitted or blank, no hover label + will appear. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + opacity + Sets the opacity of the annotation (text + + arrow). + showarrow + Determines whether or not the annotation is + drawn with an arrow. If True, `text` is placed + near the arrow's tail. If False, `text` lines + up with the `x` and `y` provided. + standoff + Sets a distance, in pixels, to move the end + arrowhead away from the position it is pointing + at, for example to point at the edge of a + marker independent of zoom. Note that this + shortens the arrow from the `ax` / `ay` vector, + in contrast to `xshift` / `yshift` which moves + everything by this amount. + startarrowhead + Sets the start annotation arrow head style. + startarrowsize + Sets the size of the start annotation arrow + head, relative to `arrowwidth`. A value of 1 + (default) gives a head about 3x as wide as the + line. + startstandoff + Sets a distance, in pixels, to move the start + arrowhead away from the position it is pointing + at, for example to point at the edge of a + marker independent of zoom. Note that this + shortens the arrow from the `ax` / `ay` vector, + in contrast to `xshift` / `yshift` which moves + everything by this amount. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + text + Sets the text associated with this annotation. + Plotly uses a subset of HTML tags to do things + like newline (
), bold (), italics + (), hyperlinks (). + Tags , , are also + supported. + textangle + Sets the angle at which the `text` is drawn + with respect to the horizontal. + valign + Sets the vertical alignment of the `text` + within the box. Has an effect only if an + explicit height is set to override the text + height. + visible + Determines whether or not this annotation is + visible. + width + Sets an explicit width for the text box. null + (default) lets the text set the box width. + Wider text will be clipped. There is no + automatic wrapping; use
to start a new + line. + x + Sets the annotation's x position. + xanchor + Sets the text box's horizontal position anchor + This anchor binds the `x` position to the + "left", "center" or "right" of the annotation. + For example, if `x` is set to 1, `xref` to + "paper" and `xanchor` to "right" then the + right-most portion of the annotation lines up + with the right-most edge of the plotting area. + If "auto", the anchor is equivalent to "center" + for data-referenced annotations or if there is + an arrow, whereas for paper-referenced with no + arrow, the anchor picked corresponds to the + closest side. + xshift + Shifts the position of the whole annotation and + arrow to the right (positive) or left + (negative) by this many pixels. + y + Sets the annotation's y position. + yanchor + Sets the text box's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the annotation. + For example, if `y` is set to 1, `yref` to + "paper" and `yanchor` to "top" then the top- + most portion of the annotation lines up with + the top-most edge of the plotting area. If + "auto", the anchor is equivalent to "middle" + for data-referenced annotations or if there is + an arrow, whereas for paper-referenced with no + arrow, the anchor picked corresponds to the + closest side. + yshift + Shifts the position of the whole annotation and + arrow up (positive) or down (negative) by this + many pixels. + z + Sets the annotation's z position. + + Returns + ------- + tuple[plotly.graph_objs.layout.scene.Annotation] + """ + return self['annotations'] + + @annotations.setter + def annotations(self, val): + self['annotations'] = val + + # annotationdefaults + # ------------------ + @property + def annotationdefaults(self): + """ + When used in a template (as + 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 plotly.graph_objs.layout.scene.Annotation + - A dict of string/value properties that will be passed + to the Annotation constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.layout.scene.Annotation + """ + return self['annotationdefaults'] + + @annotationdefaults.setter + def annotationdefaults(self, val): + self['annotationdefaults'] = val + + # aspectmode + # ---------- + @property + def aspectmode(self): + """ + If "cube", this scene's axes are drawn as a cube, regardless of + the axes' ranges. If "data", this scene's axes are drawn in + proportion with the axes' ranges. If "manual", this scene's + axes are drawn in proportion with the input of "aspectratio" + (the default behavior if "aspectratio" is provided). If "auto", + this scene's axes are drawn using the results of "data" except + when one axis is more than four times the size of the two + others, where in that case the results of "cube" are used. + + The 'aspectmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'cube', 'data', 'manual'] + + Returns + ------- + Any + """ + return self['aspectmode'] + + @aspectmode.setter + def aspectmode(self, val): + self['aspectmode'] = val + + # aspectratio + # ----------- + @property + 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 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 + ------- + plotly.graph_objs.layout.scene.Aspectratio + """ + return self['aspectratio'] + + @aspectratio.setter + def aspectratio(self, val): + self['aspectratio'] = val + + # bgcolor + # ------- + @property + def bgcolor(self): + """ + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # camera + # ------ + @property + def camera(self): + """ + The 'camera' property is an instance of Camera + that may be specified as: + - An instance of 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 + translation (x,y,z) space about the center of + this scene. By default, there is no such + translation. + eye + Sets the (x,y,z) components of the 'eye' camera + vector. This vector determines the view point + about the origin of this scene. + projection + plotly.graph_objs.layout.scene.camera.Projectio + n instance or dict with compatible properties + up + 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 + that the z axis points up. + + Returns + ------- + plotly.graph_objs.layout.scene.Camera + """ + return self['camera'] + + @camera.setter + def camera(self, val): + self['camera'] = val + + # domain + # ------ + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of 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 + . + row + If there is a layout grid, use the domain for + this row in the grid for this scene subplot . + x + Sets the horizontal domain of this scene + subplot (in plot fraction). + y + Sets the vertical domain of this scene subplot + (in plot fraction). + + Returns + ------- + plotly.graph_objs.layout.scene.Domain + """ + return self['domain'] + + @domain.setter + def domain(self, val): + self['domain'] = val + + # dragmode + # -------- + @property + 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] + + Returns + ------- + Any + """ + return self['dragmode'] + + @dragmode.setter + def dragmode(self, val): + self['dragmode'] = val + + # hovermode + # --------- + @property + 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] + + Returns + ------- + Any + """ + return self['hovermode'] + + @hovermode.setter + def hovermode(self, val): + self['hovermode'] = val + + # uirevision + # ---------- + @property + 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 + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # xaxis + # ----- + @property + def xaxis(self): + """ + The 'xaxis' property is an instance of XAxis + that may be specified as: + - An instance of 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. + See `rangemode` for more info. If `range` is + provided, then `autorange` is set to False. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and + `tick0` if this is a date axis. This does not + set the calendar for interpreting data on this + axis, that's specified in the trace or via the + global `layout.calendar` + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + mirror + Determines if the axis lines or/and ticks are + mirrored to the opposite side of the plotting + area. If True, the axis lines are mirrored. If + "ticks", the axis lines and ticks are mirrored. + If False, mirroring is disable. If "all", axis + lines are mirrored on all shared-axes subplots. + If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + range + Sets the range of this axis. If the axis `type` + is "log", then you must take the log of your + desired range (e.g. to set the range from 1 to + 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, + like date data, though Date objects and unix + milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it + should be numbers, using the scale where each + category is assigned a serial number from zero + in the order it appears. + rangemode + If "normal", the range is computed in relation + to the extrema of the input data. If *tozero*`, + the range extends to 0, regardless of the input + data If "nonnegative", the range is non- + negative, regardless of the input data. Applies + only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a + background color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showspikes + Sets whether or not spikes starting from data + points to this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall + boundaries are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.scene.xaxis.Tickformat + stop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.scene.xaxis.tickformatstopdefaults), sets + the default property values to use for elements + of layout.scene.xaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.scene.xaxis.Title + instance or dict with compatible properties + titlefont + 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. + type + Sets the axis type. By default, plotly attempts + to determined the axis type by looking into the + data of the traces that referenced the axis in + question. + visible + A single toggle to hide the axis while + preserving interaction like dragging. Default + is true when a cheater plot is present on the + axis, otherwise false + zeroline + Determines whether or not a line is drawn at + along the 0 value of this axis. If True, the + zero line is drawn on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + + Returns + ------- + plotly.graph_objs.layout.scene.XAxis + """ + return self['xaxis'] + + @xaxis.setter + def xaxis(self, val): + self['xaxis'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + The 'yaxis' property is an instance of YAxis + that may be specified as: + - An instance of 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. + See `rangemode` for more info. If `range` is + provided, then `autorange` is set to False. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and + `tick0` if this is a date axis. This does not + set the calendar for interpreting data on this + axis, that's specified in the trace or via the + global `layout.calendar` + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + mirror + Determines if the axis lines or/and ticks are + mirrored to the opposite side of the plotting + area. If True, the axis lines are mirrored. If + "ticks", the axis lines and ticks are mirrored. + If False, mirroring is disable. If "all", axis + lines are mirrored on all shared-axes subplots. + If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + range + Sets the range of this axis. If the axis `type` + is "log", then you must take the log of your + desired range (e.g. to set the range from 1 to + 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, + like date data, though Date objects and unix + milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it + should be numbers, using the scale where each + category is assigned a serial number from zero + in the order it appears. + rangemode + If "normal", the range is computed in relation + to the extrema of the input data. If *tozero*`, + the range extends to 0, regardless of the input + data If "nonnegative", the range is non- + negative, regardless of the input data. Applies + only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a + background color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showspikes + Sets whether or not spikes starting from data + points to this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall + boundaries are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.scene.yaxis.Tickformat + stop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.scene.yaxis.tickformatstopdefaults), sets + the default property values to use for elements + of layout.scene.yaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.scene.yaxis.Title + instance or dict with compatible properties + titlefont + 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. + type + Sets the axis type. By default, plotly attempts + to determined the axis type by looking into the + data of the traces that referenced the axis in + question. + visible + A single toggle to hide the axis while + preserving interaction like dragging. Default + is true when a cheater plot is present on the + axis, otherwise false + zeroline + Determines whether or not a line is drawn at + along the 0 value of this axis. If True, the + zero line is drawn on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + + Returns + ------- + plotly.graph_objs.layout.scene.YAxis + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # zaxis + # ----- + @property + def zaxis(self): + """ + The 'zaxis' property is an instance of ZAxis + that may be specified as: + - An instance of 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. + See `rangemode` for more info. If `range` is + provided, then `autorange` is set to False. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and + `tick0` if this is a date axis. This does not + set the calendar for interpreting data on this + axis, that's specified in the trace or via the + global `layout.calendar` + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + mirror + Determines if the axis lines or/and ticks are + mirrored to the opposite side of the plotting + area. If True, the axis lines are mirrored. If + "ticks", the axis lines and ticks are mirrored. + If False, mirroring is disable. If "all", axis + lines are mirrored on all shared-axes subplots. + If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + range + Sets the range of this axis. If the axis `type` + is "log", then you must take the log of your + desired range (e.g. to set the range from 1 to + 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, + like date data, though Date objects and unix + milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it + should be numbers, using the scale where each + category is assigned a serial number from zero + in the order it appears. + rangemode + If "normal", the range is computed in relation + to the extrema of the input data. If *tozero*`, + the range extends to 0, regardless of the input + data If "nonnegative", the range is non- + negative, regardless of the input data. Applies + only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a + background color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showspikes + Sets whether or not spikes starting from data + points to this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall + boundaries are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.scene.zaxis.Tickformat + stop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.scene.zaxis.tickformatstopdefaults), sets + the default property values to use for elements + of layout.scene.zaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.scene.zaxis.Title + instance or dict with compatible properties + titlefont + 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. + type + Sets the axis type. By default, plotly attempts + to determined the axis type by looking into the + data of the traces that referenced the axis in + question. + visible + A single toggle to hide the axis while + preserving interaction like dragging. Default + is true when a cheater plot is present on the + axis, otherwise false + zeroline + Determines whether or not a line is drawn at + along the 0 value of this axis. If True, the + zero line is drawn on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + + Returns + ------- + plotly.graph_objs.layout.scene.ZAxis + """ + return self['zaxis'] + + @zaxis.setter + def zaxis(self, val): + self['zaxis'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + annotations + plotly.graph_objs.layout.scene.Annotation instance or + dict with compatible properties + annotationdefaults + When used in a template (as + layout.template.layout.scene.annotationdefaults), sets + the default property values to use for elements of + layout.scene.annotations + aspectmode + If "cube", this scene's axes are drawn as a cube, + regardless of the axes' ranges. If "data", this scene's + axes are drawn in proportion with the axes' ranges. If + "manual", this scene's axes are drawn in proportion + with the input of "aspectratio" (the default behavior + if "aspectratio" is provided). If "auto", this scene's + axes are drawn using the results of "data" except when + one axis is more than four times the size of the two + others, where in that case the results of "cube" are + used. + aspectratio + Sets this scene's axis aspectratio. + bgcolor + + camera + plotly.graph_objs.layout.scene.Camera instance or dict + with compatible properties + domain + plotly.graph_objs.layout.scene.Domain instance or dict + with compatible properties + dragmode + Determines the mode of drag interactions for this + scene. + hovermode + Determines the mode of hover interactions for this + scene. + uirevision + Controls persistence of user-driven changes in camera + attributes. Defaults to `layout.uirevision`. + xaxis + plotly.graph_objs.layout.scene.XAxis instance or dict + with compatible properties + yaxis + plotly.graph_objs.layout.scene.YAxis instance or dict + with compatible properties + zaxis + plotly.graph_objs.layout.scene.ZAxis instance or dict + with compatible properties + """ + + def __init__( + self, + arg=None, + annotations=None, + annotationdefaults=None, + aspectmode=None, + aspectratio=None, + bgcolor=None, + camera=None, + domain=None, + dragmode=None, + hovermode=None, + uirevision=None, + xaxis=None, + yaxis=None, + zaxis=None, + **kwargs + ): + """ + Construct a new Scene object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Scene + annotations + plotly.graph_objs.layout.scene.Annotation instance or + dict with compatible properties + annotationdefaults + When used in a template (as + layout.template.layout.scene.annotationdefaults), sets + the default property values to use for elements of + layout.scene.annotations + aspectmode + If "cube", this scene's axes are drawn as a cube, + regardless of the axes' ranges. If "data", this scene's + axes are drawn in proportion with the axes' ranges. If + "manual", this scene's axes are drawn in proportion + with the input of "aspectratio" (the default behavior + if "aspectratio" is provided). If "auto", this scene's + axes are drawn using the results of "data" except when + one axis is more than four times the size of the two + others, where in that case the results of "cube" are + used. + aspectratio + Sets this scene's axis aspectratio. + bgcolor + + camera + plotly.graph_objs.layout.scene.Camera instance or dict + with compatible properties + domain + plotly.graph_objs.layout.scene.Domain instance or dict + with compatible properties + dragmode + Determines the mode of drag interactions for this + scene. + hovermode + Determines the mode of hover interactions for this + scene. + uirevision + Controls persistence of user-driven changes in camera + attributes. Defaults to `layout.uirevision`. + xaxis + plotly.graph_objs.layout.scene.XAxis instance or dict + with compatible properties + yaxis + plotly.graph_objs.layout.scene.YAxis instance or dict + with compatible properties + zaxis + plotly.graph_objs.layout.scene.ZAxis instance or dict + with compatible properties + + Returns + ------- + Scene + """ + super(Scene, self).__init__('scene') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Scene +constructor must be a dict or +an instance of plotly.graph_objs.layout.Scene""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (scene as v_scene) + + # Initialize validators + # --------------------- + self._validators['annotations'] = v_scene.AnnotationsValidator() + self._validators['annotationdefaults'] = v_scene.AnnotationValidator() + self._validators['aspectmode'] = v_scene.AspectmodeValidator() + self._validators['aspectratio'] = v_scene.AspectratioValidator() + self._validators['bgcolor'] = v_scene.BgcolorValidator() + self._validators['camera'] = v_scene.CameraValidator() + self._validators['domain'] = v_scene.DomainValidator() + self._validators['dragmode'] = v_scene.DragmodeValidator() + self._validators['hovermode'] = v_scene.HovermodeValidator() + self._validators['uirevision'] = v_scene.UirevisionValidator() + self._validators['xaxis'] = v_scene.XAxisValidator() + self._validators['yaxis'] = v_scene.YAxisValidator() + self._validators['zaxis'] = v_scene.ZAxisValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('annotations', None) + self['annotations'] = annotations if annotations is not None else _v + _v = arg.pop('annotationdefaults', None) + self['annotationdefaults' + ] = annotationdefaults if annotationdefaults is not None else _v + _v = arg.pop('aspectmode', None) + self['aspectmode'] = aspectmode if aspectmode is not None else _v + _v = arg.pop('aspectratio', None) + self['aspectratio'] = aspectratio if aspectratio is not None else _v + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('camera', None) + self['camera'] = camera if camera is not None else _v + _v = arg.pop('domain', None) + self['domain'] = domain if domain is not None else _v + _v = arg.pop('dragmode', None) + self['dragmode'] = dragmode if dragmode is not None else _v + _v = arg.pop('hovermode', None) + self['hovermode'] = hovermode if hovermode is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('xaxis', None) + self['xaxis'] = xaxis if xaxis is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + _v = arg.pop('zaxis', None) + self['zaxis'] = zaxis if zaxis is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class RadialAxis(_BaseLayoutHierarchyType): + + # domain + # ------ + @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] + + Returns + ------- + list + """ + return self['domain'] + + @domain.setter + def domain(self, val): + self['domain'] = val + + # endpadding + # ---------- + @property + 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 + + Returns + ------- + int|float + """ + return self['endpadding'] + + @endpadding.setter + def endpadding(self, val): + self['endpadding'] = val + + # orientation + # ----------- + @property + 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 + + Returns + ------- + int|float + """ + return self['orientation'] + + @orientation.setter + def orientation(self, val): + self['orientation'] = val + + # range + # ----- + @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 + + Returns + ------- + list + """ + return self['range'] + + @range.setter + def range(self, val): + self['range'] = val + + # showline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showline'] + + @showline.setter + def showline(self, val): + self['showline'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickorientation + # --------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['tickorientation'] + + @tickorientation.setter + def tickorientation(self, val): + self['tickorientation'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + domain + Polar chart subplots are not supported yet. This key + has currently no effect. + endpadding + Legacy polar charts are deprecated! Please switch to + "polar" subplots. + orientation + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the orientation (an angle with + respect to the origin) of the radial axis. + range + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Defines the start and end point of + this radial axis. + showline + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Determines whether or not the line + bounding this radial axis will be shown on the figure. + showticklabels + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Determines whether or not the radial + axis ticks will feature tick labels. + tickcolor + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the color of the tick lines on + this radial axis. + ticklen + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the length of the tick lines on + this radial axis. + tickorientation + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the orientation (from the paper + perspective) of the radial axis tick labels. + ticksuffix + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the length of the tick lines on + this radial axis. + visible + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Determines whether or not this axis + will be visible. + """ + + def __init__( + self, + arg=None, + domain=None, + endpadding=None, + orientation=None, + range=None, + showline=None, + showticklabels=None, + tickcolor=None, + ticklen=None, + tickorientation=None, + ticksuffix=None, + visible=None, + **kwargs + ): + """ + Construct a new RadialAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.RadialAxis + domain + Polar chart subplots are not supported yet. This key + has currently no effect. + endpadding + Legacy polar charts are deprecated! Please switch to + "polar" subplots. + orientation + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the orientation (an angle with + respect to the origin) of the radial axis. + range + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Defines the start and end point of + this radial axis. + showline + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Determines whether or not the line + bounding this radial axis will be shown on the figure. + showticklabels + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Determines whether or not the radial + axis ticks will feature tick labels. + tickcolor + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the color of the tick lines on + this radial axis. + ticklen + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the length of the tick lines on + this radial axis. + tickorientation + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the orientation (from the paper + perspective) of the radial axis tick labels. + ticksuffix + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the length of the tick lines on + this radial axis. + visible + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Determines whether or not this axis + will be visible. + + Returns + ------- + RadialAxis + """ + super(RadialAxis, self).__init__('radialaxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.RadialAxis +constructor must be a dict or +an instance of plotly.graph_objs.layout.RadialAxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (radialaxis as v_radialaxis) + + # Initialize validators + # --------------------- + self._validators['domain'] = v_radialaxis.DomainValidator() + self._validators['endpadding'] = v_radialaxis.EndpaddingValidator() + self._validators['orientation'] = v_radialaxis.OrientationValidator() + self._validators['range'] = v_radialaxis.RangeValidator() + self._validators['showline'] = v_radialaxis.ShowlineValidator() + self._validators['showticklabels' + ] = v_radialaxis.ShowticklabelsValidator() + self._validators['tickcolor'] = v_radialaxis.TickcolorValidator() + self._validators['ticklen'] = v_radialaxis.TicklenValidator() + self._validators['tickorientation' + ] = v_radialaxis.TickorientationValidator() + self._validators['ticksuffix'] = v_radialaxis.TicksuffixValidator() + self._validators['visible'] = v_radialaxis.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('domain', None) + self['domain'] = domain if domain is not None else _v + _v = arg.pop('endpadding', None) + self['endpadding'] = endpadding if endpadding is not None else _v + _v = arg.pop('orientation', None) + self['orientation'] = orientation if orientation is not None else _v + _v = arg.pop('range', None) + self['range'] = range if range is not None else _v + _v = arg.pop('showline', None) + self['showline'] = showline if showline is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickorientation', None) + self['tickorientation' + ] = tickorientation if tickorientation is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Polar(_BaseLayoutHierarchyType): + + # angularaxis + # ----------- + @property + def angularaxis(self): + """ + The 'angularaxis' property is an instance of AngularAxis + that may be specified as: + - An instance of 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` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + direction + Sets the direction corresponding to positive + angles. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + layer + Sets the layer on which this axis is displayed. + If *above traces*, this axis is displayed above + all the subplot's traces If *below traces*, + this axis is displayed below all the subplot's + traces, but above the grid lines. Useful when + used together with scatter-like traces with + `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + period + Set the angular period. Has an effect only when + `angularaxis.type` is "category". + rotation + Sets that start position (in degrees) of the + angular axis By default, polar subplots with + `direction` set to "counterclockwise" get a + `rotation` of 0 which corresponds to 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), + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thetaunit + Sets the format unit of the formatted "theta" + values. Has an effect only when + `angularaxis.type` is "linear". + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.polar.angularaxis.Tick + formatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.polar.angularaxis.tickformatstopdefaults), + sets the default property values to use for + elements of + layout.polar.angularaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + type + Sets the angular axis type. If "linear", set + `thetaunit` to determine the unit in which axis + value are shown. If *category, use `period` to + set the number of integer coordinates around + polar axis. + uirevision + Controls persistence of user-driven changes in + axis `rotation`. Defaults to + `polar.uirevision`. + visible + A single toggle to hide the axis while + preserving interaction like dragging. Default + is true when a cheater plot is present on the + axis, otherwise false + + Returns + ------- + plotly.graph_objs.layout.polar.AngularAxis + """ + return self['angularaxis'] + + @angularaxis.setter + def angularaxis(self, val): + self['angularaxis'] = val + + # bargap + # ------ + @property + 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] + + Returns + ------- + int|float + """ + return self['bargap'] + + @bargap.setter + def bargap(self, val): + self['bargap'] = val + + # barmode + # ------- + @property + def barmode(self): + """ + Determines how bars at the same location coordinate are + displayed on the graph. With "stack", the bars are stacked on + top of one another With "overlay", the bars are plotted over + one another, you might need to an "opacity" to see multiple + bars. + + The 'barmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['stack', 'overlay'] + + Returns + ------- + Any + """ + return self['barmode'] + + @barmode.setter + def barmode(self, val): + self['barmode'] = val + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # domain + # ------ + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of 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 + . + row + If there is a layout grid, use the domain for + this row in the grid for this polar subplot . + x + Sets the horizontal domain of this polar + subplot (in plot fraction). + y + Sets the vertical domain of this polar subplot + (in plot fraction). + + Returns + ------- + plotly.graph_objs.layout.polar.Domain + """ + return self['domain'] + + @domain.setter + def domain(self, val): + self['domain'] = val + + # gridshape + # --------- + @property + def gridshape(self): + """ + Determines if the radial axis grid lines and angular axis line + are drawn as "circular" sectors or as "linear" (polygon) + sectors. Has an effect only when the angular axis has `type` + "category". Note that `radialaxis.angle` is snapped to the + angle of the closest vertex when `gridshape` is "circular" (so + that radial axis scale is the same as the data scale). + + The 'gridshape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['circular', 'linear'] + + Returns + ------- + Any + """ + return self['gridshape'] + + @gridshape.setter + def gridshape(self, val): + self['gridshape'] = val + + # hole + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['hole'] + + @hole.setter + def hole(self, val): + self['hole'] = val + + # radialaxis + # ---------- + @property + def radialaxis(self): + """ + The 'radialaxis' property is an instance of RadialAxis + that may be specified as: + - An instance of 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, + radial axis line on the theta=0 line + corresponds to a line pointing right (like what + mathematicians prefer). Defaults to the first + `polar.sector` angle. + autorange + Determines whether or not the range of this + axis is computed in relation to the input data. + See `rangemode` for more info. If `range` is + provided, then `autorange` is set to False. + calendar + Sets the calendar system to use for `range` and + `tick0` if this is a date axis. This does not + set the calendar for interpreting data on this + axis, that's specified in the trace or via the + global `layout.calendar` + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + layer + Sets the layer on which this axis is displayed. + If *above traces*, this axis is displayed above + all the subplot's traces If *below traces*, + this axis is displayed below all the subplot's + traces, but above the grid lines. Useful when + used together with scatter-like traces with + `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + range + Sets the range of this axis. If the axis `type` + is "log", then you must take the log of your + desired range (e.g. to set the range from 1 to + 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, + like date data, though Date objects and unix + milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it + should be numbers, using the scale where each + category is assigned a serial number from zero + in the order it appears. + rangemode + If *tozero*`, the range extends to 0, + regardless of the input data If "nonnegative", + the range is non-negative, regardless of the + input data. If "normal", the range is computed + in relation to the extrema of the input data + (same behavior as for cartesian axes). + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines on which side of radial axis line + the tick and tick labels appear. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.polar.radialaxis.Tickf + ormatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.polar.radialaxis.tickformatstopdefaults), + sets the default property values to use for + elements of + layout.polar.radialaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.polar.radialaxis.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + layout.polar.radialaxis.title.font instead. + Sets this axis' title font. Note that the + title's font used to be customized by the now + deprecated `titlefont` attribute. + type + Sets the axis type. By default, plotly attempts + to determined the axis type by looking into the + data of the traces that referenced the axis in + question. + uirevision + Controls persistence of user-driven changes in + axis `range`, `autorange`, `angle`, and `title` + if in `editable: true` configuration. Defaults + to `polar.uirevision`. + visible + A single toggle to hide the axis while + preserving interaction like dragging. Default + is true when a cheater plot is present on the + axis, otherwise false + + Returns + ------- + plotly.graph_objs.layout.polar.RadialAxis + """ + return self['radialaxis'] + + @radialaxis.setter + def radialaxis(self, val): + self['radialaxis'] = val + + # sector + # ------ + @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 + + Returns + ------- + list + """ + return self['sector'] + + @sector.setter + def sector(self, val): + self['sector'] = val + + # uirevision + # ---------- + @property + 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 + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + angularaxis + plotly.graph_objs.layout.polar.AngularAxis instance or + dict with compatible properties + bargap + Sets the gap between bars of adjacent location + coordinates. Values are unitless, they represent + fractions of the minimum difference in bar positions in + the data. + barmode + Determines how bars at the same location coordinate are + displayed on the graph. With "stack", the bars are + stacked on top of one another With "overlay", the bars + are plotted over one another, you might need to an + "opacity" to see multiple bars. + bgcolor + Set the background color of the subplot + domain + plotly.graph_objs.layout.polar.Domain instance or dict + with compatible properties + gridshape + Determines if the radial axis grid lines and angular + axis line are drawn as "circular" sectors or as + "linear" (polygon) sectors. Has an effect only when the + angular axis has `type` "category". Note that + `radialaxis.angle` is snapped to the angle of the + closest vertex when `gridshape` is "circular" (so that + radial axis scale is the same as the data scale). + hole + Sets the fraction of the radius to cut out of the polar + subplot. + radialaxis + plotly.graph_objs.layout.polar.RadialAxis instance or + dict with compatible properties + sector + Sets angular span of this polar subplot with two angles + (in degrees). Sector are assumed to be spanned in the + counterclockwise direction with 0 corresponding to + rightmost limit of the polar subplot. + uirevision + Controls persistence of user-driven changes in axis + attributes, if not overridden in the individual axes. + Defaults to `layout.uirevision`. + """ + + def __init__( + self, + arg=None, + angularaxis=None, + bargap=None, + barmode=None, + bgcolor=None, + domain=None, + gridshape=None, + hole=None, + radialaxis=None, + sector=None, + uirevision=None, + **kwargs + ): + """ + Construct a new Polar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Polar + angularaxis + plotly.graph_objs.layout.polar.AngularAxis instance or + dict with compatible properties + bargap + Sets the gap between bars of adjacent location + coordinates. Values are unitless, they represent + fractions of the minimum difference in bar positions in + the data. + barmode + Determines how bars at the same location coordinate are + displayed on the graph. With "stack", the bars are + stacked on top of one another With "overlay", the bars + are plotted over one another, you might need to an + "opacity" to see multiple bars. + bgcolor + Set the background color of the subplot + domain + plotly.graph_objs.layout.polar.Domain instance or dict + with compatible properties + gridshape + Determines if the radial axis grid lines and angular + axis line are drawn as "circular" sectors or as + "linear" (polygon) sectors. Has an effect only when the + angular axis has `type` "category". Note that + `radialaxis.angle` is snapped to the angle of the + closest vertex when `gridshape` is "circular" (so that + radial axis scale is the same as the data scale). + hole + Sets the fraction of the radius to cut out of the polar + subplot. + radialaxis + plotly.graph_objs.layout.polar.RadialAxis instance or + dict with compatible properties + sector + Sets angular span of this polar subplot with two angles + (in degrees). Sector are assumed to be spanned in the + counterclockwise direction with 0 corresponding to + rightmost limit of the polar subplot. + uirevision + Controls persistence of user-driven changes in axis + attributes, if not overridden in the individual axes. + Defaults to `layout.uirevision`. + + Returns + ------- + Polar + """ + super(Polar, self).__init__('polar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Polar +constructor must be a dict or +an instance of plotly.graph_objs.layout.Polar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (polar as v_polar) + + # Initialize validators + # --------------------- + self._validators['angularaxis'] = v_polar.AngularAxisValidator() + self._validators['bargap'] = v_polar.BargapValidator() + self._validators['barmode'] = v_polar.BarmodeValidator() + self._validators['bgcolor'] = v_polar.BgcolorValidator() + self._validators['domain'] = v_polar.DomainValidator() + self._validators['gridshape'] = v_polar.GridshapeValidator() + self._validators['hole'] = v_polar.HoleValidator() + self._validators['radialaxis'] = v_polar.RadialAxisValidator() + self._validators['sector'] = v_polar.SectorValidator() + self._validators['uirevision'] = v_polar.UirevisionValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('angularaxis', None) + self['angularaxis'] = angularaxis if angularaxis is not None else _v + _v = arg.pop('bargap', None) + self['bargap'] = bargap if bargap is not None else _v + _v = arg.pop('barmode', None) + self['barmode'] = barmode if barmode is not None else _v + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('domain', None) + self['domain'] = domain if domain is not None else _v + _v = arg.pop('gridshape', None) + self['gridshape'] = gridshape if gridshape is not None else _v + _v = arg.pop('hole', None) + self['hole'] = hole if hole is not None else _v + _v = arg.pop('radialaxis', None) + self['radialaxis'] = radialaxis if radialaxis is not None else _v + _v = arg.pop('sector', None) + self['sector'] = sector if sector is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Modebar(_BaseLayoutHierarchyType): + + # activecolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['activecolor'] + + @activecolor.setter + def activecolor(self, val): + self['activecolor'] = val + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # orientation + # ----------- + @property + 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'] + + Returns + ------- + Any + """ + return self['orientation'] + + @orientation.setter + def orientation(self, val): + self['orientation'] = val + + # uirevision + # ---------- + @property + def uirevision(self): + """ + Controls persistence of user-driven changes related to the + modebar, including `hovermode`, `dragmode`, and `showspikes` at + both the root level and inside subplots. Defaults to + `layout.uirevision`. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + activecolor + Sets the color of the active or hovered on icons in the + modebar. + bgcolor + Sets the background color of the modebar. + color + Sets the color of the icons in the modebar. + orientation + Sets the orientation of the modebar. + uirevision + Controls persistence of user-driven changes related to + the modebar, including `hovermode`, `dragmode`, and + `showspikes` at both the root level and inside + subplots. Defaults to `layout.uirevision`. + """ + + def __init__( + self, + arg=None, + activecolor=None, + bgcolor=None, + color=None, + orientation=None, + uirevision=None, + **kwargs + ): + """ + Construct a new Modebar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Modebar + activecolor + Sets the color of the active or hovered on icons in the + modebar. + bgcolor + Sets the background color of the modebar. + color + Sets the color of the icons in the modebar. + orientation + Sets the orientation of the modebar. + uirevision + Controls persistence of user-driven changes related to + the modebar, including `hovermode`, `dragmode`, and + `showspikes` at both the root level and inside + subplots. Defaults to `layout.uirevision`. + + Returns + ------- + Modebar + """ + super(Modebar, self).__init__('modebar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Modebar +constructor must be a dict or +an instance of plotly.graph_objs.layout.Modebar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (modebar as v_modebar) + + # Initialize validators + # --------------------- + self._validators['activecolor'] = v_modebar.ActivecolorValidator() + self._validators['bgcolor'] = v_modebar.BgcolorValidator() + self._validators['color'] = v_modebar.ColorValidator() + self._validators['orientation'] = v_modebar.OrientationValidator() + self._validators['uirevision'] = v_modebar.UirevisionValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('activecolor', None) + self['activecolor'] = activecolor if activecolor is not None else _v + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('orientation', None) + self['orientation'] = orientation if orientation is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Margin(_BaseLayoutHierarchyType): + + # autoexpand + # ---------- + @property + def autoexpand(self): + """ + The 'autoexpand' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autoexpand'] + + @autoexpand.setter + def autoexpand(self, val): + self['autoexpand'] = val + + # b + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['b'] + + @b.setter + def b(self, val): + self['b'] = val + + # l + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['l'] + + @l.setter + def l(self, val): + self['l'] = val + + # pad + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['pad'] + + @pad.setter + def pad(self, val): + self['pad'] = val + + # r + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['r'] + + @r.setter + def r(self, val): + self['r'] = val + + # t + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['t'] + + @t.setter + def t(self, val): + self['t'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autoexpand + + b + Sets the bottom margin (in px). + l + Sets the left margin (in px). + pad + Sets the amount of padding (in px) between the plotting + area and the axis lines + r + Sets the right margin (in px). + t + Sets the top margin (in px). + """ + + def __init__( + self, + arg=None, + autoexpand=None, + b=None, + l=None, + pad=None, + r=None, + t=None, + **kwargs + ): + """ + Construct a new Margin object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Margin + autoexpand + + b + Sets the bottom margin (in px). + l + Sets the left margin (in px). + pad + Sets the amount of padding (in px) between the plotting + area and the axis lines + r + Sets the right margin (in px). + t + Sets the top margin (in px). + + Returns + ------- + Margin + """ + super(Margin, self).__init__('margin') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Margin +constructor must be a dict or +an instance of plotly.graph_objs.layout.Margin""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (margin as v_margin) + + # Initialize validators + # --------------------- + self._validators['autoexpand'] = v_margin.AutoexpandValidator() + self._validators['b'] = v_margin.BValidator() + self._validators['l'] = v_margin.LValidator() + self._validators['pad'] = v_margin.PadValidator() + self._validators['r'] = v_margin.RValidator() + self._validators['t'] = v_margin.TValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autoexpand', None) + self['autoexpand'] = autoexpand if autoexpand is not None else _v + _v = arg.pop('b', None) + self['b'] = b if b is not None else _v + _v = arg.pop('l', None) + self['l'] = l if l is not None else _v + _v = arg.pop('pad', None) + self['pad'] = pad if pad is not None else _v + _v = arg.pop('r', None) + self['r'] = r if r is not None else _v + _v = arg.pop('t', None) + self['t'] = t if t is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Mapbox(_BaseLayoutHierarchyType): + + # accesstoken + # ----------- + @property + def accesstoken(self): + """ + Sets the mapbox access token to be used for this mapbox map. + Alternatively, the mapbox access token can be set in the + configuration options under `mapboxAccessToken`. + + The 'accesstoken' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['accesstoken'] + + @accesstoken.setter + def accesstoken(self, val): + self['accesstoken'] = val + + # bearing + # ------- + @property + 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 + + Returns + ------- + int|float + """ + return self['bearing'] + + @bearing.setter + def bearing(self, val): + self['bearing'] = val + + # center + # ------ + @property + def center(self): + """ + The 'center' property is an instance of Center + that may be specified as: + - An instance of 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). + lon + Sets the longitude of the center of the map (in + degrees East). + + Returns + ------- + plotly.graph_objs.layout.mapbox.Center + """ + return self['center'] + + @center.setter + def center(self, val): + self['center'] = val + + # domain + # ------ + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of 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 + . + row + If there is a layout grid, use the domain for + this row in the grid for this mapbox subplot . + x + Sets the horizontal domain of this mapbox + subplot (in plot fraction). + y + Sets the vertical domain of this mapbox subplot + (in plot fraction). + + Returns + ------- + plotly.graph_objs.layout.mapbox.Domain + """ + return self['domain'] + + @domain.setter + def domain(self, val): + self['domain'] = val + + # layers + # ------ + @property + def layers(self): + """ + The 'layers' property is a tuple of instances of + Layer that may be specified as: + - 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 + set to '', the layer will be inserted above + every existing layer. + circle + plotly.graph_objs.layout.mapbox.layer.Circle + instance or dict with compatible properties + color + Sets the primary layer color. If `type` is + "circle", color corresponds to the circle color + (mapbox.layer.paint.circle-color) If `type` is + "line", color corresponds to the line color + (mapbox.layer.paint.line-color) If `type` is + "fill", color 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) + fill + plotly.graph_objs.layout.mapbox.layer.Fill + instance or dict with compatible properties + line + plotly.graph_objs.layout.mapbox.layer.Line + instance or dict with compatible properties + maxzoom + Sets the maximum zoom level + (mapbox.layer.maxzoom). At zoom levels equal to + or greater than the maxzoom, the layer will be + hidden. + minzoom + Sets the minimum zoom level + (mapbox.layer.minzoom). At zoom levels less + than the minzoom, the layer will be hidden. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + opacity + Sets the opacity of the layer. If `type` is + "circle", opacity corresponds to the circle + opacity (mapbox.layer.paint.circle-opacity) If + `type` is "line", opacity corresponds to the + line opacity (mapbox.layer.paint.line-opacity) + If `type` is "fill", opacity corresponds to the + fill opacity (mapbox.layer.paint.fill-opacity) + If `type` is "symbol", opacity corresponds to + the icon/text opacity (mapbox.layer.paint.text- + opacity) + source + Sets the source data for this layer + (mapbox.layer.source). Source can be either a + URL, a geojson object (with `sourcetype` set to + "geojson") or an array of tile URLS (with + `sourcetype` set to "vector"). + sourcelayer + Specifies the layer to use from a vector tile + source (mapbox.layer.source-layer). Required + for "vector" source type that supports multiple + layers. + sourcetype + Sets the source type for this layer. Support + for "raster", "image" and "video" source types + is coming soon. + symbol + plotly.graph_objs.layout.mapbox.layer.Symbol + instance or dict with compatible properties + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + type + Sets the layer type (mapbox.layer.type). + Support for "raster", "background" types is + coming soon. Note that "line" and "fill" are + not compatible with Point GeoJSON geometries. + visible + Determines whether this layer is displayed + + Returns + ------- + tuple[plotly.graph_objs.layout.mapbox.Layer] + """ + return self['layers'] + + @layers.setter + def layers(self, val): + self['layers'] = val + + # layerdefaults + # ------------- + @property + 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 plotly.graph_objs.layout.mapbox.Layer + - A dict of string/value properties that will be passed + to the Layer constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.layout.mapbox.Layer + """ + return self['layerdefaults'] + + @layerdefaults.setter + def layerdefaults(self, val): + self['layerdefaults'] = val + + # pitch + # ----- + @property + 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 + + Returns + ------- + int|float + """ + return self['pitch'] + + @pitch.setter + def pitch(self, val): + self['pitch'] = val + + # style + # ----- + @property + def style(self): + """ + Sets the Mapbox map style. Either input one of the default + Mapbox style names or the URL to a custom style or a valid + Mapbox style JSON. + + The 'style' property accepts values of any type + + Returns + ------- + Any + """ + return self['style'] + + @style.setter + def style(self, val): + self['style'] = val + + # uirevision + # ---------- + @property + 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 + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # zoom + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['zoom'] + + @zoom.setter + def zoom(self, val): + self['zoom'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + accesstoken + Sets the mapbox access token to be used for this mapbox + map. Alternatively, the mapbox access token can be set + in the configuration options under `mapboxAccessToken`. + bearing + Sets the bearing angle of the map in degrees counter- + clockwise from North (mapbox.bearing). + center + plotly.graph_objs.layout.mapbox.Center instance or dict + with compatible properties + domain + plotly.graph_objs.layout.mapbox.Domain instance or dict + with compatible properties + layers + plotly.graph_objs.layout.mapbox.Layer instance or dict + with compatible properties + layerdefaults + When used in a template (as + layout.template.layout.mapbox.layerdefaults), sets the + default property values to use for elements of + layout.mapbox.layers + pitch + Sets the pitch angle of the map (in degrees, where 0 + means perpendicular to the surface of the map) + (mapbox.pitch). + style + Sets the Mapbox map style. Either input one of the + default Mapbox style names or the URL to a custom style + or a valid Mapbox style JSON. + uirevision + Controls persistence of user-driven changes in the + view: `center`, `zoom`, `bearing`, `pitch`. Defaults to + `layout.uirevision`. + zoom + Sets the zoom level of the map (mapbox.zoom). + """ + + def __init__( + self, + arg=None, + accesstoken=None, + bearing=None, + center=None, + domain=None, + layers=None, + layerdefaults=None, + pitch=None, + style=None, + uirevision=None, + zoom=None, + **kwargs + ): + """ + Construct a new Mapbox object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Mapbox + accesstoken + Sets the mapbox access token to be used for this mapbox + map. Alternatively, the mapbox access token can be set + in the configuration options under `mapboxAccessToken`. + bearing + Sets the bearing angle of the map in degrees counter- + clockwise from North (mapbox.bearing). + center + plotly.graph_objs.layout.mapbox.Center instance or dict + with compatible properties + domain + plotly.graph_objs.layout.mapbox.Domain instance or dict + with compatible properties + layers + plotly.graph_objs.layout.mapbox.Layer instance or dict + with compatible properties + layerdefaults + When used in a template (as + layout.template.layout.mapbox.layerdefaults), sets the + default property values to use for elements of + layout.mapbox.layers + pitch + Sets the pitch angle of the map (in degrees, where 0 + means perpendicular to the surface of the map) + (mapbox.pitch). + style + Sets the Mapbox map style. Either input one of the + default Mapbox style names or the URL to a custom style + or a valid Mapbox style JSON. + uirevision + Controls persistence of user-driven changes in the + view: `center`, `zoom`, `bearing`, `pitch`. Defaults to + `layout.uirevision`. + zoom + Sets the zoom level of the map (mapbox.zoom). + + Returns + ------- + Mapbox + """ + super(Mapbox, self).__init__('mapbox') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Mapbox +constructor must be a dict or +an instance of plotly.graph_objs.layout.Mapbox""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (mapbox as v_mapbox) + + # Initialize validators + # --------------------- + self._validators['accesstoken'] = v_mapbox.AccesstokenValidator() + self._validators['bearing'] = v_mapbox.BearingValidator() + self._validators['center'] = v_mapbox.CenterValidator() + self._validators['domain'] = v_mapbox.DomainValidator() + self._validators['layers'] = v_mapbox.LayersValidator() + self._validators['layerdefaults'] = v_mapbox.LayerValidator() + self._validators['pitch'] = v_mapbox.PitchValidator() + self._validators['style'] = v_mapbox.StyleValidator() + self._validators['uirevision'] = v_mapbox.UirevisionValidator() + self._validators['zoom'] = v_mapbox.ZoomValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('accesstoken', None) + self['accesstoken'] = accesstoken if accesstoken is not None else _v + _v = arg.pop('bearing', None) + self['bearing'] = bearing if bearing is not None else _v + _v = arg.pop('center', None) + self['center'] = center if center is not None else _v + _v = arg.pop('domain', None) + self['domain'] = domain if domain is not None else _v + _v = arg.pop('layers', None) + self['layers'] = layers if layers is not None else _v + _v = arg.pop('layerdefaults', None) + self['layerdefaults' + ] = layerdefaults if layerdefaults is not None else _v + _v = arg.pop('pitch', None) + self['pitch'] = pitch if pitch is not None else _v + _v = arg.pop('style', None) + self['style'] = style if style is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('zoom', None) + self['zoom'] = zoom if zoom is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Legend(_BaseLayoutHierarchyType): + + # bgcolor + # ------- + @property + def bgcolor(self): + """ + Sets the legend 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.legend.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # orientation + # ----------- + @property + 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'] + + Returns + ------- + Any + """ + return self['orientation'] + + @orientation.setter + def orientation(self, val): + self['orientation'] = val + + # tracegroupgap + # ------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tracegroupgap'] + + @tracegroupgap.setter + def tracegroupgap(self, val): + self['tracegroupgap'] = val + + # traceorder + # ---------- + @property + def traceorder(self): + """ + Determines the order at which the legend items are displayed. + If "normal", the items are displayed top-to-bottom in the same + order as the input data. If "reversed", the items are displayed + in the opposite order as "normal". If "grouped", the items are + displayed in groups (when a trace `legendgroup` is provided). + if "grouped+reversed", the items are displayed in the opposite + order as "grouped". + + The 'traceorder' property is a flaglist and may be specified + as a string containing: + - Any combination of ['reversed', 'grouped'] joined with '+' characters + (e.g. 'reversed+grouped') + OR exactly one of ['normal'] (e.g. 'normal') + + Returns + ------- + Any + """ + return self['traceorder'] + + @traceorder.setter + def traceorder(self, val): + self['traceorder'] = val + + # uirevision + # ---------- + @property + 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 + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # valign + # ------ + @property + 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'] + + Returns + ------- + Any + """ + return self['valign'] + + @valign.setter + def valign(self, val): + self['valign'] = val + + # x + # - + @property + def x(self): + """ + Sets the x position (in normalized coordinates) of the legend. + + The 'x' property is a number and may be specified as: + - An int or float in the interval [-2, 3] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + def xanchor(self): + """ + Sets the legend's horizontal position anchor. This anchor binds + the `x` position to the "left", "center" or "right" of the + legend. + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'left', 'center', 'right'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # y + # - + @property + def y(self): + """ + Sets the y position (in normalized coordinates) of the legend. + + The 'y' property is a number and may be specified as: + - An int or float in the interval [-2, 3] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + def yanchor(self): + """ + Sets the legend's vertical position anchor This anchor binds + the `y` position to the "top", "middle" or "bottom" of the + legend. + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the legend background color. + bordercolor + Sets the color of the border enclosing the legend. + borderwidth + Sets the width (in px) of the border enclosing the + legend. + font + Sets the font used to text the legend items. + orientation + Sets the orientation of the legend. + tracegroupgap + Sets the amount of vertical space (in px) between + legend groups. + traceorder + Determines the order at which the legend items are + displayed. If "normal", the items are displayed top-to- + bottom in the same order as the input data. If + "reversed", the items are displayed in the opposite + order as "normal". If "grouped", the items are + displayed in groups (when a trace `legendgroup` is + provided). if "grouped+reversed", the items are + displayed in the opposite order as "grouped". + uirevision + Controls persistence of legend-driven changes in trace + and pie label visibility. Defaults to + `layout.uirevision`. + valign + Sets the vertical alignment of the symbols with respect + to their associated text. + x + Sets the x position (in normalized coordinates) of the + legend. + xanchor + Sets the legend's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the legend. + y + Sets the y position (in normalized coordinates) of the + legend. + yanchor + Sets the legend's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or + "bottom" of the legend. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + font=None, + orientation=None, + tracegroupgap=None, + traceorder=None, + uirevision=None, + valign=None, + x=None, + xanchor=None, + y=None, + yanchor=None, + **kwargs + ): + """ + Construct a new Legend object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Legend + bgcolor + Sets the legend background color. + bordercolor + Sets the color of the border enclosing the legend. + borderwidth + Sets the width (in px) of the border enclosing the + legend. + font + Sets the font used to text the legend items. + orientation + Sets the orientation of the legend. + tracegroupgap + Sets the amount of vertical space (in px) between + legend groups. + traceorder + Determines the order at which the legend items are + displayed. If "normal", the items are displayed top-to- + bottom in the same order as the input data. If + "reversed", the items are displayed in the opposite + order as "normal". If "grouped", the items are + displayed in groups (when a trace `legendgroup` is + provided). if "grouped+reversed", the items are + displayed in the opposite order as "grouped". + uirevision + Controls persistence of legend-driven changes in trace + and pie label visibility. Defaults to + `layout.uirevision`. + valign + Sets the vertical alignment of the symbols with respect + to their associated text. + x + Sets the x position (in normalized coordinates) of the + legend. + xanchor + Sets the legend's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the legend. + y + Sets the y position (in normalized coordinates) of the + legend. + yanchor + Sets the legend's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or + "bottom" of the legend. + + Returns + ------- + Legend + """ + super(Legend, self).__init__('legend') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Legend +constructor must be a dict or +an instance of plotly.graph_objs.layout.Legend""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (legend as v_legend) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_legend.BgcolorValidator() + self._validators['bordercolor'] = v_legend.BordercolorValidator() + self._validators['borderwidth'] = v_legend.BorderwidthValidator() + self._validators['font'] = v_legend.FontValidator() + self._validators['orientation'] = v_legend.OrientationValidator() + self._validators['tracegroupgap'] = v_legend.TracegroupgapValidator() + self._validators['traceorder'] = v_legend.TraceorderValidator() + self._validators['uirevision'] = v_legend.UirevisionValidator() + self._validators['valign'] = v_legend.ValignValidator() + self._validators['x'] = v_legend.XValidator() + self._validators['xanchor'] = v_legend.XanchorValidator() + self._validators['y'] = v_legend.YValidator() + self._validators['yanchor'] = v_legend.YanchorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('orientation', None) + self['orientation'] = orientation if orientation is not None else _v + _v = arg.pop('tracegroupgap', None) + self['tracegroupgap' + ] = tracegroupgap if tracegroupgap is not None else _v + _v = arg.pop('traceorder', None) + self['traceorder'] = traceorder if traceorder is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('valign', None) + self['valign'] = valign if valign is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Image(_BaseLayoutHierarchyType): + + # layer + # ----- + @property + 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'] + + Returns + ------- + Any + """ + return self['layer'] + + @layer.setter + def layer(self, val): + self['layer'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # sizex + # ----- + @property + def sizex(self): + """ + Sets the image container size horizontally. The image will be + sized based on the `position` value. When `xref` is set to + `paper`, units are sized relative to the plot width. + + The 'sizex' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['sizex'] + + @sizex.setter + def sizex(self, val): + self['sizex'] = val + + # sizey + # ----- + @property + def sizey(self): + """ + Sets the image container size vertically. The image will be + sized based on the `position` value. When `yref` is set to + `paper`, units are sized relative to the plot height. + + The 'sizey' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['sizey'] + + @sizey.setter + def sizey(self, val): + self['sizey'] = val + + # sizing + # ------ + @property + 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'] + + Returns + ------- + Any + """ + return self['sizing'] + + @sizing.setter + def sizing(self, val): + self['sizing'] = val + + # source + # ------ + @property + 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') + - A data URI image string + (e.g. 'data:image/png;base64,iVBORw0KGgoAAAANSU') + - A PIL.Image.Image object which will be immediately converted + to a data URI image string + See http://pillow.readthedocs.io/en/latest/reference/Image.html + + Returns + ------- + str + """ + return self['source'] + + @source.setter + def source(self, val): + self['source'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # visible + # ------- + @property + def visible(self): + """ + Determines whether or not this image is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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 + ------- + Any + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xref + # ---- + @property + def xref(self): + """ + Sets the images's x coordinate axis. If set to a x axis id + (e.g. "x" or "x2"), the `x` position refers to an x data + coordinate If set to "paper", the `x` position refers to the + distance from the left of plot in normalized coordinates where + 0 (1) corresponds to the left (right). + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['paper'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + Any + """ + return self['xref'] + + @xref.setter + def xref(self, val): + self['xref'] = val + + # y + # - + @property + 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 + ------- + Any + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # yref + # ---- + @property + def yref(self): + """ + Sets the images's y coordinate axis. If set to a y axis id + (e.g. "y" or "y2"), the `y` position refers to a y data + coordinate. If set to "paper", the `y` position refers to the + distance from the bottom of the plot in normalized coordinates + where 0 (1) corresponds to the bottom (top). + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['paper'] + - A string that matches one of the following regular expressions: + ['^y([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + Any + """ + return self['yref'] + + @yref.setter + def yref(self, val): + self['yref'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + layer + Specifies whether images are drawn below or above + traces. When `xref` and `yref` are both set to `paper`, + image is drawn below the entire plot area. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the image. + sizex + Sets the image container size horizontally. The image + will be sized based on the `position` value. When + `xref` is set to `paper`, units are sized relative to + the plot width. + sizey + Sets the image container size vertically. The image + will be sized based on the `position` value. When + `yref` is set to `paper`, units are sized relative to + the plot height. + sizing + Specifies which dimension of the image to constrain. + source + Specifies the URL of the image to be used. The URL must + be accessible from the domain where the plot code is + run, and can be either relative or absolute. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + visible + Determines whether or not this image is visible. + x + Sets the image's x position. When `xref` is set to + `paper`, units are sized relative to the plot height. + See `xref` for more info + xanchor + Sets the anchor for the x position + xref + Sets the images's x coordinate axis. If set to a x axis + id (e.g. "x" or "x2"), the `x` position refers to an x + data coordinate If set to "paper", the `x` position + refers to the distance from the left of plot in + normalized coordinates where 0 (1) corresponds to the + left (right). + y + Sets the image's y position. When `yref` is set to + `paper`, units are sized relative to the plot height. + See `yref` for more info + yanchor + Sets the anchor for the y position. + yref + Sets the images's y coordinate axis. If set to a y axis + id (e.g. "y" or "y2"), the `y` position refers to a y + data coordinate. If set to "paper", the `y` position + refers to the distance from the bottom of the plot in + normalized coordinates where 0 (1) corresponds to the + bottom (top). + """ + + def __init__( + self, + arg=None, + layer=None, + name=None, + opacity=None, + sizex=None, + sizey=None, + sizing=None, + source=None, + templateitemname=None, + visible=None, + x=None, + xanchor=None, + xref=None, + y=None, + yanchor=None, + yref=None, + **kwargs + ): + """ + Construct a new Image object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Image + layer + Specifies whether images are drawn below or above + traces. When `xref` and `yref` are both set to `paper`, + image is drawn below the entire plot area. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the image. + sizex + Sets the image container size horizontally. The image + will be sized based on the `position` value. When + `xref` is set to `paper`, units are sized relative to + the plot width. + sizey + Sets the image container size vertically. The image + will be sized based on the `position` value. When + `yref` is set to `paper`, units are sized relative to + the plot height. + sizing + Specifies which dimension of the image to constrain. + source + Specifies the URL of the image to be used. The URL must + be accessible from the domain where the plot code is + run, and can be either relative or absolute. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + visible + Determines whether or not this image is visible. + x + Sets the image's x position. When `xref` is set to + `paper`, units are sized relative to the plot height. + See `xref` for more info + xanchor + Sets the anchor for the x position + xref + Sets the images's x coordinate axis. If set to a x axis + id (e.g. "x" or "x2"), the `x` position refers to an x + data coordinate If set to "paper", the `x` position + refers to the distance from the left of plot in + normalized coordinates where 0 (1) corresponds to the + left (right). + y + Sets the image's y position. When `yref` is set to + `paper`, units are sized relative to the plot height. + See `yref` for more info + yanchor + Sets the anchor for the y position. + yref + Sets the images's y coordinate axis. If set to a y axis + id (e.g. "y" or "y2"), the `y` position refers to a y + data coordinate. If set to "paper", the `y` position + refers to the distance from the bottom of the plot in + normalized coordinates where 0 (1) corresponds to the + bottom (top). + + Returns + ------- + Image + """ + super(Image, self).__init__('images') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Image +constructor must be a dict or +an instance of plotly.graph_objs.layout.Image""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (image as v_image) + + # Initialize validators + # --------------------- + self._validators['layer'] = v_image.LayerValidator() + self._validators['name'] = v_image.NameValidator() + self._validators['opacity'] = v_image.OpacityValidator() + self._validators['sizex'] = v_image.SizexValidator() + self._validators['sizey'] = v_image.SizeyValidator() + self._validators['sizing'] = v_image.SizingValidator() + self._validators['source'] = v_image.SourceValidator() + self._validators['templateitemname' + ] = v_image.TemplateitemnameValidator() + self._validators['visible'] = v_image.VisibleValidator() + self._validators['x'] = v_image.XValidator() + self._validators['xanchor'] = v_image.XanchorValidator() + self._validators['xref'] = v_image.XrefValidator() + self._validators['y'] = v_image.YValidator() + self._validators['yanchor'] = v_image.YanchorValidator() + self._validators['yref'] = v_image.YrefValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('layer', None) + self['layer'] = layer if layer is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('sizex', None) + self['sizex'] = sizex if sizex is not None else _v + _v = arg.pop('sizey', None) + self['sizey'] = sizey if sizey is not None else _v + _v = arg.pop('sizing', None) + self['sizing'] = sizing if sizing is not None else _v + _v = arg.pop('source', None) + self['source'] = source if source is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xref', None) + self['xref'] = xref if xref is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('yref', None) + self['yref'] = yref if yref is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseLayoutHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + + Returns + ------- + int + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of all hover labels on graph + bordercolor + Sets the border color of all hover labels on graph. + font + Sets the default hover label font used by all traces on + the graph. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + font=None, + namelength=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Hoverlabel + bgcolor + Sets the background color of all hover labels on graph + bordercolor + Sets the border color of all hover labels on graph. + font + Sets the default hover label font used by all traces on + the graph. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.layout.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Grid(_BaseLayoutHierarchyType): + + # columns + # ------- + @property + def columns(self): + """ + The number of columns in the grid. If you provide a 2D + `subplots` array, the length of its longest row is used as the + default. If you give an `xaxes` array, its length is used as + the default. But it's also possible to have a different length, + if you want to leave a row at the end for non-cartesian + subplots. + + 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] + + Returns + ------- + int + """ + return self['columns'] + + @columns.setter + def columns(self, val): + self['columns'] = val + + # domain + # ------ + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of 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 + end exactly at the domain edges, with no grout + around the edges. + y + 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 + ------- + plotly.graph_objs.layout.grid.Domain + """ + return self['domain'] + + @domain.setter + def domain(self, val): + self['domain'] = val + + # pattern + # ------- + @property + def pattern(self): + """ + If no `subplots`, `xaxes`, or `yaxes` are given but we do have + `rows` and `columns`, we can generate defaults using + consecutive axis IDs, in two ways: "coupled" gives one x axis + per column and one y axis per row. "independent" uses a new xy + pair for each cell, left-to-right across each row then + iterating rows according to `roworder`. + + The 'pattern' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['independent', 'coupled'] + + Returns + ------- + Any + """ + return self['pattern'] + + @pattern.setter + def pattern(self, val): + self['pattern'] = val + + # roworder + # -------- + @property + 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'] + + Returns + ------- + Any + """ + return self['roworder'] + + @roworder.setter + def roworder(self, val): + self['roworder'] = val + + # rows + # ---- + @property + def rows(self): + """ + The number of rows in the grid. If you provide a 2D `subplots` + array or a `yaxes` array, its length is used as the default. + But it's also possible to have a different length, if you want + to leave a row at the end for non-cartesian subplots. + + 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] + + Returns + ------- + int + """ + return self['rows'] + + @rows.setter + def rows(self, val): + self['rows'] = val + + # subplots + # -------- + @property + def subplots(self): + """ + Used for freeform grids, where some axes may be shared across + subplots but others are not. Each entry should be a cartesian + subplot id, like "xy" or "x3y2", or "" to leave that cell + empty. You may reuse x axes within the same column, and y axes + within the same row. Non-cartesian subplots and traces that + support `domain` can place themselves in this grid separately + using the `gridcell` attribute. + + 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: + - One of the following enumeration values: + [''] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?y([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + list + """ + return self['subplots'] + + @subplots.setter + def subplots(self, val): + self['subplots'] = val + + # xaxes + # ----- + @property + def xaxes(self): + """ + Used with `yaxes` when the x and y axes are shared across + columns and rows. Each entry should be an x axis id like "x", + "x2", etc., or "" to not put an x axis in that column. Entries + other than "" must be unique. Ignored if `subplots` is present. + If missing but `yaxes` is present, will generate consecutive + IDs. + + 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: + - One of the following enumeration values: + [''] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + list + """ + return self['xaxes'] + + @xaxes.setter + def xaxes(self, val): + self['xaxes'] = val + + # xgap + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xgap'] + + @xgap.setter + def xgap(self, val): + self['xgap'] = val + + # xside + # ----- + @property + 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'] + + Returns + ------- + Any + """ + return self['xside'] + + @xside.setter + def xside(self, val): + self['xside'] = val + + # yaxes + # ----- + @property + def yaxes(self): + """ + Used with `yaxes` when the x and y axes are shared across + columns and rows. Each entry should be an y axis id like "y", + "y2", etc., or "" to not put a y axis in that row. Entries + other than "" must be unique. Ignored if `subplots` is present. + If missing but `xaxes` is present, will generate consecutive + IDs. + + 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: + - One of the following enumeration values: + [''] + - A string that matches one of the following regular expressions: + ['^y([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + list + """ + return self['yaxes'] + + @yaxes.setter + def yaxes(self, val): + self['yaxes'] = val + + # ygap + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ygap'] + + @ygap.setter + def ygap(self, val): + self['ygap'] = val + + # yside + # ----- + @property + def yside(self): + """ + Sets where the y axis labels and titles go. "left" means the + very left edge of the grid. *left plot* is the leftmost plot + that each y axis is used in. "right" and *right plot* are + similar. + + The 'yside' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'left plot', 'right plot', 'right'] + + Returns + ------- + Any + """ + return self['yside'] + + @yside.setter + def yside(self, val): + self['yside'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + columns + The number of columns in the grid. If you provide a 2D + `subplots` array, the length of its longest row is used + as the default. If you give an `xaxes` array, its + length is used as the default. But it's also possible + to have a different length, if you want to leave a row + at the end for non-cartesian subplots. + domain + plotly.graph_objs.layout.grid.Domain instance or dict + with compatible properties + pattern + If no `subplots`, `xaxes`, or `yaxes` are given but we + do have `rows` and `columns`, we can generate defaults + using consecutive axis IDs, in two ways: "coupled" + gives one x axis per column and one y axis per row. + "independent" uses a new xy pair for each cell, left- + to-right across each row then iterating rows according + to `roworder`. + roworder + Is the first row the top or the bottom? Note that + columns are always enumerated from left to right. + rows + The number of rows in the grid. If you provide a 2D + `subplots` array or a `yaxes` array, its length is used + as the default. But it's also possible to have a + different length, if you want to leave a row at the end + for non-cartesian subplots. + subplots + Used for freeform grids, where some axes may be shared + across subplots but others are not. Each entry should + be a cartesian subplot id, like "xy" or "x3y2", or "" + to leave that cell empty. You may reuse x axes within + the same column, and y axes within the same row. Non- + cartesian subplots and traces that support `domain` can + place themselves in this grid separately using the + `gridcell` attribute. + xaxes + Used with `yaxes` when the x and y axes are shared + across columns and rows. Each entry should be an x axis + id like "x", "x2", etc., or "" to not put an x axis in + that column. Entries other than "" must be unique. + Ignored if `subplots` is present. If missing but + `yaxes` is present, will generate consecutive IDs. + xgap + Horizontal space between grid cells, expressed as a + fraction of the total width available to one cell. + Defaults to 0.1 for coupled-axes grids and 0.2 for + independent grids. + xside + Sets where the x axis labels and titles go. "bottom" + means the very bottom of the grid. "bottom plot" is the + lowest plot that each x axis is used in. "top" and "top + plot" are similar. + yaxes + Used with `yaxes` when the x and y axes are shared + across columns and rows. Each entry should be an y axis + id like "y", "y2", etc., or "" to not put a y axis in + that row. Entries other than "" must be unique. Ignored + if `subplots` is present. If missing but `xaxes` is + present, will generate consecutive IDs. + ygap + Vertical space between grid cells, expressed as a + fraction of the total height available to one cell. + Defaults to 0.1 for coupled-axes grids and 0.3 for + independent grids. + yside + Sets where the y axis labels and titles go. "left" + means the very left edge of the grid. *left plot* is + the leftmost plot that each y axis is used in. "right" + and *right plot* are similar. + """ + + def __init__( + self, + arg=None, + columns=None, + domain=None, + pattern=None, + roworder=None, + rows=None, + subplots=None, + xaxes=None, + xgap=None, + xside=None, + yaxes=None, + ygap=None, + yside=None, + **kwargs + ): + """ + Construct a new Grid object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Grid + columns + The number of columns in the grid. If you provide a 2D + `subplots` array, the length of its longest row is used + as the default. If you give an `xaxes` array, its + length is used as the default. But it's also possible + to have a different length, if you want to leave a row + at the end for non-cartesian subplots. + domain + plotly.graph_objs.layout.grid.Domain instance or dict + with compatible properties + pattern + If no `subplots`, `xaxes`, or `yaxes` are given but we + do have `rows` and `columns`, we can generate defaults + using consecutive axis IDs, in two ways: "coupled" + gives one x axis per column and one y axis per row. + "independent" uses a new xy pair for each cell, left- + to-right across each row then iterating rows according + to `roworder`. + roworder + Is the first row the top or the bottom? Note that + columns are always enumerated from left to right. + rows + The number of rows in the grid. If you provide a 2D + `subplots` array or a `yaxes` array, its length is used + as the default. But it's also possible to have a + different length, if you want to leave a row at the end + for non-cartesian subplots. + subplots + Used for freeform grids, where some axes may be shared + across subplots but others are not. Each entry should + be a cartesian subplot id, like "xy" or "x3y2", or "" + to leave that cell empty. You may reuse x axes within + the same column, and y axes within the same row. Non- + cartesian subplots and traces that support `domain` can + place themselves in this grid separately using the + `gridcell` attribute. + xaxes + Used with `yaxes` when the x and y axes are shared + across columns and rows. Each entry should be an x axis + id like "x", "x2", etc., or "" to not put an x axis in + that column. Entries other than "" must be unique. + Ignored if `subplots` is present. If missing but + `yaxes` is present, will generate consecutive IDs. + xgap + Horizontal space between grid cells, expressed as a + fraction of the total width available to one cell. + Defaults to 0.1 for coupled-axes grids and 0.2 for + independent grids. + xside + Sets where the x axis labels and titles go. "bottom" + means the very bottom of the grid. "bottom plot" is the + lowest plot that each x axis is used in. "top" and "top + plot" are similar. + yaxes + Used with `yaxes` when the x and y axes are shared + across columns and rows. Each entry should be an y axis + id like "y", "y2", etc., or "" to not put a y axis in + that row. Entries other than "" must be unique. Ignored + if `subplots` is present. If missing but `xaxes` is + present, will generate consecutive IDs. + ygap + Vertical space between grid cells, expressed as a + fraction of the total height available to one cell. + Defaults to 0.1 for coupled-axes grids and 0.3 for + independent grids. + yside + Sets where the y axis labels and titles go. "left" + means the very left edge of the grid. *left plot* is + the leftmost plot that each y axis is used in. "right" + and *right plot* are similar. + + Returns + ------- + Grid + """ + super(Grid, self).__init__('grid') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Grid +constructor must be a dict or +an instance of plotly.graph_objs.layout.Grid""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (grid as v_grid) + + # Initialize validators + # --------------------- + self._validators['columns'] = v_grid.ColumnsValidator() + self._validators['domain'] = v_grid.DomainValidator() + self._validators['pattern'] = v_grid.PatternValidator() + self._validators['roworder'] = v_grid.RoworderValidator() + self._validators['rows'] = v_grid.RowsValidator() + self._validators['subplots'] = v_grid.SubplotsValidator() + self._validators['xaxes'] = v_grid.XaxesValidator() + self._validators['xgap'] = v_grid.XgapValidator() + self._validators['xside'] = v_grid.XsideValidator() + self._validators['yaxes'] = v_grid.YaxesValidator() + self._validators['ygap'] = v_grid.YgapValidator() + self._validators['yside'] = v_grid.YsideValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('columns', None) + self['columns'] = columns if columns is not None else _v + _v = arg.pop('domain', None) + self['domain'] = domain if domain is not None else _v + _v = arg.pop('pattern', None) + self['pattern'] = pattern if pattern is not None else _v + _v = arg.pop('roworder', None) + self['roworder'] = roworder if roworder is not None else _v + _v = arg.pop('rows', None) + self['rows'] = rows if rows is not None else _v + _v = arg.pop('subplots', None) + self['subplots'] = subplots if subplots is not None else _v + _v = arg.pop('xaxes', None) + self['xaxes'] = xaxes if xaxes is not None else _v + _v = arg.pop('xgap', None) + self['xgap'] = xgap if xgap is not None else _v + _v = arg.pop('xside', None) + self['xside'] = xside if xside is not None else _v + _v = arg.pop('yaxes', None) + self['yaxes'] = yaxes if yaxes is not None else _v + _v = arg.pop('ygap', None) + self['ygap'] = ygap if ygap is not None else _v + _v = arg.pop('yside', None) + self['yside'] = yside if yside is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Geo(_BaseLayoutHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # center + # ------ + @property + def center(self): + """ + The 'center' property is an instance of Center + that may be specified as: + - An instance of 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 + lies at the middle of the latitude range by + default. + lon + Sets the longitude of the map's center. By + default, the map's longitude center lies at the + middle of the longitude range for scoped + projection and above `projection.rotation.lon` + otherwise. + + Returns + ------- + plotly.graph_objs.layout.geo.Center + """ + return self['center'] + + @center.setter + def center(self, val): + self['center'] = val + + # coastlinecolor + # -------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['coastlinecolor'] + + @coastlinecolor.setter + def coastlinecolor(self, val): + self['coastlinecolor'] = val + + # coastlinewidth + # -------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['coastlinewidth'] + + @coastlinewidth.setter + def coastlinewidth(self, val): + self['coastlinewidth'] = val + + # countrycolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['countrycolor'] + + @countrycolor.setter + def countrycolor(self, val): + self['countrycolor'] = val + + # countrywidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['countrywidth'] + + @countrywidth.setter + def countrywidth(self, val): + self['countrywidth'] = val + + # domain + # ------ + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of 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 . + 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. + row + If there is a layout grid, use the domain for + this row in the grid for this geo subplot . + 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. + x + 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. + y + 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 + ------- + plotly.graph_objs.layout.geo.Domain + """ + return self['domain'] + + @domain.setter + def domain(self, val): + self['domain'] = val + + # framecolor + # ---------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['framecolor'] + + @framecolor.setter + def framecolor(self, val): + self['framecolor'] = val + + # framewidth + # ---------- + @property + 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] + + Returns + ------- + int|float + """ + return self['framewidth'] + + @framewidth.setter + def framewidth(self, val): + self['framewidth'] = val + + # lakecolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['lakecolor'] + + @lakecolor.setter + def lakecolor(self, val): + self['lakecolor'] = val + + # landcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['landcolor'] + + @landcolor.setter + def landcolor(self, val): + self['landcolor'] = val + + # lataxis + # ------- + @property + def lataxis(self): + """ + The 'lataxis' property is an instance of Lataxis + that may be specified as: + - An instance of 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. + gridcolor + Sets the graticule's stroke color. + gridwidth + Sets the graticule's stroke width (in px). + range + Sets the range of this axis (in degrees), sets + the map's clipped coordinates. + showgrid + Sets whether or not graticule are shown on the + map. + tick0 + Sets the graticule's starting tick + longitude/latitude. + + Returns + ------- + plotly.graph_objs.layout.geo.Lataxis + """ + return self['lataxis'] + + @lataxis.setter + def lataxis(self, val): + self['lataxis'] = val + + # lonaxis + # ------- + @property + def lonaxis(self): + """ + The 'lonaxis' property is an instance of Lonaxis + that may be specified as: + - An instance of 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. + gridcolor + Sets the graticule's stroke color. + gridwidth + Sets the graticule's stroke width (in px). + range + Sets the range of this axis (in degrees), sets + the map's clipped coordinates. + showgrid + Sets whether or not graticule are shown on the + map. + tick0 + Sets the graticule's starting tick + longitude/latitude. + + Returns + ------- + plotly.graph_objs.layout.geo.Lonaxis + """ + return self['lonaxis'] + + @lonaxis.setter + def lonaxis(self, val): + self['lonaxis'] = val + + # oceancolor + # ---------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['oceancolor'] + + @oceancolor.setter + def oceancolor(self, val): + self['oceancolor'] = val + + # projection + # ---------- + @property + def projection(self): + """ + The 'projection' property is an instance of Projection + that may be specified as: + - An instance of 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 + intersects the sphere. + rotation + plotly.graph_objs.layout.geo.projection.Rotatio + n instance or dict with compatible properties + scale + 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. + type + Sets the projection type. + + Returns + ------- + plotly.graph_objs.layout.geo.Projection + """ + return self['projection'] + + @projection.setter + def projection(self, val): + self['projection'] = val + + # resolution + # ---------- + @property + 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] + + Returns + ------- + Any + """ + return self['resolution'] + + @resolution.setter + def resolution(self, val): + self['resolution'] = val + + # rivercolor + # ---------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['rivercolor'] + + @rivercolor.setter + def rivercolor(self, val): + self['rivercolor'] = val + + # riverwidth + # ---------- + @property + 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] + + Returns + ------- + int|float + """ + return self['riverwidth'] + + @riverwidth.setter + def riverwidth(self, val): + self['riverwidth'] = val + + # scope + # ----- + @property + 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 + america', 'south america'] + + Returns + ------- + Any + """ + return self['scope'] + + @scope.setter + def scope(self, val): + self['scope'] = val + + # showcoastlines + # -------------- + @property + def showcoastlines(self): + """ + Sets whether or not the coastlines are drawn. + + The 'showcoastlines' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['showcoastlines'] + + @showcoastlines.setter + def showcoastlines(self, val): + self['showcoastlines'] = val + + # showcountries + # ------------- + @property + def showcountries(self): + """ + Sets whether or not country boundaries are drawn. + + The 'showcountries' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['showcountries'] + + @showcountries.setter + def showcountries(self, val): + self['showcountries'] = val + + # showframe + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showframe'] + + @showframe.setter + def showframe(self, val): + self['showframe'] = val + + # showlakes + # --------- + @property + def showlakes(self): + """ + Sets whether or not lakes are drawn. + + The 'showlakes' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['showlakes'] + + @showlakes.setter + def showlakes(self, val): + self['showlakes'] = val + + # showland + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showland'] + + @showland.setter + def showland(self, val): + self['showland'] = val + + # showocean + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showocean'] + + @showocean.setter + def showocean(self, val): + self['showocean'] = val + + # showrivers + # ---------- + @property + def showrivers(self): + """ + Sets whether or not rivers are drawn. + + The 'showrivers' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['showrivers'] + + @showrivers.setter + def showrivers(self, val): + self['showrivers'] = val + + # showsubunits + # ------------ + @property + 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) + + Returns + ------- + bool + """ + return self['showsubunits'] + + @showsubunits.setter + def showsubunits(self, val): + self['showsubunits'] = val + + # subunitcolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['subunitcolor'] + + @subunitcolor.setter + def subunitcolor(self, val): + self['subunitcolor'] = val + + # subunitwidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['subunitwidth'] + + @subunitwidth.setter + def subunitwidth(self, val): + self['subunitwidth'] = val + + # uirevision + # ---------- + @property + 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 + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Set the background color of the map + center + plotly.graph_objs.layout.geo.Center instance or dict + with compatible properties + coastlinecolor + Sets the coastline color. + coastlinewidth + Sets the coastline stroke width (in px). + countrycolor + Sets line color of the country boundaries. + countrywidth + Sets line width (in px) of the country boundaries. + domain + plotly.graph_objs.layout.geo.Domain instance or dict + with compatible properties + framecolor + Sets the color the frame. + framewidth + Sets the stroke width (in px) of the frame. + lakecolor + Sets the color of the lakes. + landcolor + Sets the land mass color. + lataxis + plotly.graph_objs.layout.geo.Lataxis instance or dict + with compatible properties + lonaxis + plotly.graph_objs.layout.geo.Lonaxis instance or dict + with compatible properties + oceancolor + Sets the ocean color + projection + plotly.graph_objs.layout.geo.Projection instance or + dict with compatible properties + resolution + Sets the resolution of the base layers. The values have + units of km/mm e.g. 110 corresponds to a scale ratio of + 1:110,000,000. + rivercolor + Sets color of the rivers. + riverwidth + Sets the stroke width (in px) of the rivers. + scope + Set the scope of the map. + showcoastlines + Sets whether or not the coastlines are drawn. + showcountries + Sets whether or not country boundaries are drawn. + showframe + Sets whether or not a frame is drawn around the map. + showlakes + Sets whether or not lakes are drawn. + showland + Sets whether or not land masses are filled in color. + showocean + Sets whether or not oceans are filled in color. + showrivers + Sets whether or not rivers are drawn. + showsubunits + Sets whether or not boundaries of subunits within + countries (e.g. states, provinces) are drawn. + subunitcolor + Sets the color of the subunits boundaries. + subunitwidth + Sets the stroke width (in px) of the subunits + boundaries. + uirevision + Controls persistence of user-driven changes in the view + (projection and center). Defaults to + `layout.uirevision`. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + center=None, + coastlinecolor=None, + coastlinewidth=None, + countrycolor=None, + countrywidth=None, + domain=None, + framecolor=None, + framewidth=None, + lakecolor=None, + landcolor=None, + lataxis=None, + lonaxis=None, + oceancolor=None, + projection=None, + resolution=None, + rivercolor=None, + riverwidth=None, + scope=None, + showcoastlines=None, + showcountries=None, + showframe=None, + showlakes=None, + showland=None, + showocean=None, + showrivers=None, + showsubunits=None, + subunitcolor=None, + subunitwidth=None, + uirevision=None, + **kwargs + ): + """ + Construct a new Geo object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Geo + bgcolor + Set the background color of the map + center + plotly.graph_objs.layout.geo.Center instance or dict + with compatible properties + coastlinecolor + Sets the coastline color. + coastlinewidth + Sets the coastline stroke width (in px). + countrycolor + Sets line color of the country boundaries. + countrywidth + Sets line width (in px) of the country boundaries. + domain + plotly.graph_objs.layout.geo.Domain instance or dict + with compatible properties + framecolor + Sets the color the frame. + framewidth + Sets the stroke width (in px) of the frame. + lakecolor + Sets the color of the lakes. + landcolor + Sets the land mass color. + lataxis + plotly.graph_objs.layout.geo.Lataxis instance or dict + with compatible properties + lonaxis + plotly.graph_objs.layout.geo.Lonaxis instance or dict + with compatible properties + oceancolor + Sets the ocean color + projection + plotly.graph_objs.layout.geo.Projection instance or + dict with compatible properties + resolution + Sets the resolution of the base layers. The values have + units of km/mm e.g. 110 corresponds to a scale ratio of + 1:110,000,000. + rivercolor + Sets color of the rivers. + riverwidth + Sets the stroke width (in px) of the rivers. + scope + Set the scope of the map. + showcoastlines + Sets whether or not the coastlines are drawn. + showcountries + Sets whether or not country boundaries are drawn. + showframe + Sets whether or not a frame is drawn around the map. + showlakes + Sets whether or not lakes are drawn. + showland + Sets whether or not land masses are filled in color. + showocean + Sets whether or not oceans are filled in color. + showrivers + Sets whether or not rivers are drawn. + showsubunits + Sets whether or not boundaries of subunits within + countries (e.g. states, provinces) are drawn. + subunitcolor + Sets the color of the subunits boundaries. + subunitwidth + Sets the stroke width (in px) of the subunits + boundaries. + uirevision + Controls persistence of user-driven changes in the view + (projection and center). Defaults to + `layout.uirevision`. + + Returns + ------- + Geo + """ + super(Geo, self).__init__('geo') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Geo +constructor must be a dict or +an instance of plotly.graph_objs.layout.Geo""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (geo as v_geo) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_geo.BgcolorValidator() + self._validators['center'] = v_geo.CenterValidator() + self._validators['coastlinecolor'] = v_geo.CoastlinecolorValidator() + self._validators['coastlinewidth'] = v_geo.CoastlinewidthValidator() + self._validators['countrycolor'] = v_geo.CountrycolorValidator() + self._validators['countrywidth'] = v_geo.CountrywidthValidator() + self._validators['domain'] = v_geo.DomainValidator() + self._validators['framecolor'] = v_geo.FramecolorValidator() + self._validators['framewidth'] = v_geo.FramewidthValidator() + self._validators['lakecolor'] = v_geo.LakecolorValidator() + self._validators['landcolor'] = v_geo.LandcolorValidator() + self._validators['lataxis'] = v_geo.LataxisValidator() + self._validators['lonaxis'] = v_geo.LonaxisValidator() + self._validators['oceancolor'] = v_geo.OceancolorValidator() + self._validators['projection'] = v_geo.ProjectionValidator() + self._validators['resolution'] = v_geo.ResolutionValidator() + self._validators['rivercolor'] = v_geo.RivercolorValidator() + self._validators['riverwidth'] = v_geo.RiverwidthValidator() + self._validators['scope'] = v_geo.ScopeValidator() + self._validators['showcoastlines'] = v_geo.ShowcoastlinesValidator() + self._validators['showcountries'] = v_geo.ShowcountriesValidator() + self._validators['showframe'] = v_geo.ShowframeValidator() + self._validators['showlakes'] = v_geo.ShowlakesValidator() + self._validators['showland'] = v_geo.ShowlandValidator() + self._validators['showocean'] = v_geo.ShowoceanValidator() + self._validators['showrivers'] = v_geo.ShowriversValidator() + self._validators['showsubunits'] = v_geo.ShowsubunitsValidator() + self._validators['subunitcolor'] = v_geo.SubunitcolorValidator() + self._validators['subunitwidth'] = v_geo.SubunitwidthValidator() + self._validators['uirevision'] = v_geo.UirevisionValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('center', None) + self['center'] = center if center is not None else _v + _v = arg.pop('coastlinecolor', None) + self['coastlinecolor' + ] = coastlinecolor if coastlinecolor is not None else _v + _v = arg.pop('coastlinewidth', None) + self['coastlinewidth' + ] = coastlinewidth if coastlinewidth is not None else _v + _v = arg.pop('countrycolor', None) + self['countrycolor'] = countrycolor if countrycolor is not None else _v + _v = arg.pop('countrywidth', None) + self['countrywidth'] = countrywidth if countrywidth is not None else _v + _v = arg.pop('domain', None) + self['domain'] = domain if domain is not None else _v + _v = arg.pop('framecolor', None) + self['framecolor'] = framecolor if framecolor is not None else _v + _v = arg.pop('framewidth', None) + self['framewidth'] = framewidth if framewidth is not None else _v + _v = arg.pop('lakecolor', None) + self['lakecolor'] = lakecolor if lakecolor is not None else _v + _v = arg.pop('landcolor', None) + self['landcolor'] = landcolor if landcolor is not None else _v + _v = arg.pop('lataxis', None) + self['lataxis'] = lataxis if lataxis is not None else _v + _v = arg.pop('lonaxis', None) + self['lonaxis'] = lonaxis if lonaxis is not None else _v + _v = arg.pop('oceancolor', None) + self['oceancolor'] = oceancolor if oceancolor is not None else _v + _v = arg.pop('projection', None) + self['projection'] = projection if projection is not None else _v + _v = arg.pop('resolution', None) + self['resolution'] = resolution if resolution is not None else _v + _v = arg.pop('rivercolor', None) + self['rivercolor'] = rivercolor if rivercolor is not None else _v + _v = arg.pop('riverwidth', None) + self['riverwidth'] = riverwidth if riverwidth is not None else _v + _v = arg.pop('scope', None) + self['scope'] = scope if scope is not None else _v + _v = arg.pop('showcoastlines', None) + self['showcoastlines' + ] = showcoastlines if showcoastlines is not None else _v + _v = arg.pop('showcountries', None) + self['showcountries' + ] = showcountries if showcountries is not None else _v + _v = arg.pop('showframe', None) + self['showframe'] = showframe if showframe is not None else _v + _v = arg.pop('showlakes', None) + self['showlakes'] = showlakes if showlakes is not None else _v + _v = arg.pop('showland', None) + self['showland'] = showland if showland is not None else _v + _v = arg.pop('showocean', None) + self['showocean'] = showocean if showocean is not None else _v + _v = arg.pop('showrivers', None) + self['showrivers'] = showrivers if showrivers is not None else _v + _v = arg.pop('showsubunits', None) + self['showsubunits'] = showsubunits if showsubunits is not None else _v + _v = arg.pop('subunitcolor', None) + self['subunitcolor'] = subunitcolor if subunitcolor is not None else _v + _v = arg.pop('subunitwidth', None) + self['subunitwidth'] = subunitwidth if subunitwidth is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Colorscale(_BaseLayoutHierarchyType): + + # diverging + # --------- + @property + 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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['diverging'] + + @diverging.setter + def diverging(self, val): + self['diverging'] = val + + # sequential + # ---------- + @property + 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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['sequential'] + + @sequential.setter + def sequential(self, val): + self['sequential'] = val + + # sequentialminus + # --------------- + @property + 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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['sequentialminus'] + + @sequentialminus.setter + def sequentialminus(self, val): + self['sequentialminus'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + diverging + Sets the default diverging colorscale. Note that + `autocolorscale` must be true for this attribute to + work. + sequential + Sets the default sequential colorscale for positive + values. Note that `autocolorscale` must be true for + this attribute to work. + sequentialminus + Sets the default sequential colorscale for negative + values. Note that `autocolorscale` must be true for + this attribute to work. + """ + + def __init__( + self, + arg=None, + diverging=None, + sequential=None, + sequentialminus=None, + **kwargs + ): + """ + Construct a new Colorscale object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Colorscale + diverging + Sets the default diverging colorscale. Note that + `autocolorscale` must be true for this attribute to + work. + sequential + Sets the default sequential colorscale for positive + values. Note that `autocolorscale` must be true for + this attribute to work. + sequentialminus + Sets the default sequential colorscale for negative + values. Note that `autocolorscale` must be true for + this attribute to work. + + Returns + ------- + Colorscale + """ + super(Colorscale, self).__init__('colorscale') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Colorscale +constructor must be a dict or +an instance of plotly.graph_objs.layout.Colorscale""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (colorscale as v_colorscale) + + # Initialize validators + # --------------------- + self._validators['diverging'] = v_colorscale.DivergingValidator() + self._validators['sequential'] = v_colorscale.SequentialValidator() + self._validators['sequentialminus' + ] = v_colorscale.SequentialminusValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('diverging', None) + self['diverging'] = diverging if diverging is not None else _v + _v = arg.pop('sequential', None) + self['sequential'] = sequential if sequential is not None else _v + _v = arg.pop('sequentialminus', None) + self['sequentialminus' + ] = sequentialminus if sequentialminus is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Annotation(_BaseLayoutHierarchyType): + + # align + # ----- + @property + def align(self): + """ + Sets the horizontal alignment of the `text` within the box. Has + an effect only if `text` spans more 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'] + + Returns + ------- + Any + """ + return self['align'] + + @align.setter + def align(self, val): + self['align'] = val + + # arrowcolor + # ---------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['arrowcolor'] + + @arrowcolor.setter + def arrowcolor(self, val): + self['arrowcolor'] = val + + # arrowhead + # --------- + @property + 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] + + Returns + ------- + int + """ + return self['arrowhead'] + + @arrowhead.setter + def arrowhead(self, val): + self['arrowhead'] = val + + # arrowside + # --------- + @property + 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 + (e.g. 'end+start') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self['arrowside'] + + @arrowside.setter + def arrowside(self, val): + self['arrowside'] = val + + # arrowsize + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['arrowsize'] + + @arrowsize.setter + def arrowsize(self, val): + self['arrowsize'] = val + + # arrowwidth + # ---------- + @property + 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] + + Returns + ------- + int|float + """ + return self['arrowwidth'] + + @arrowwidth.setter + def arrowwidth(self, val): + self['arrowwidth'] = val + + # ax + # -- + @property + def ax(self): + """ + Sets the x component of the arrow tail about the arrow head. If + `axref` is `pixel`, a positive (negative) component + corresponds to an arrow pointing from right to left (left to + right). If `axref` is an axis, this is an absolute value on + that axis, like `x`, NOT a relative value. + + The 'ax' property accepts values of any type + + Returns + ------- + Any + """ + return self['ax'] + + @ax.setter + def ax(self, val): + self['ax'] = val + + # axref + # ----- + @property + def axref(self): + """ + Indicates in what terms the tail of the annotation (ax,ay) is + specified. If `pixel`, `ax` is a relative offset in pixels + from `x`. If set to an x axis id (e.g. "x" or "x2"), `ax` is + specified in the same terms as that axis. This is useful for + trendline annotations which should continue to indicate the + correct trend when zoomed. + + The 'axref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['pixel'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + Any + """ + return self['axref'] + + @axref.setter + def axref(self, val): + self['axref'] = val + + # ay + # -- + @property + def ay(self): + """ + Sets the y component of the arrow tail about the arrow head. If + `ayref` is `pixel`, a positive (negative) component + corresponds to an arrow pointing from bottom to top (top to + bottom). If `ayref` is an axis, this is an absolute value on + that axis, like `y`, NOT a relative value. + + The 'ay' property accepts values of any type + + Returns + ------- + Any + """ + return self['ay'] + + @ay.setter + def ay(self, val): + self['ay'] = val + + # ayref + # ----- + @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. + + The 'ayref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['pixel'] + - A string that matches one of the following regular expressions: + ['^y([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + Any + """ + return self['ayref'] + + @ayref.setter + def ayref(self, val): + self['ayref'] = val + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderpad + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderpad'] + + @borderpad.setter + def borderpad(self, val): + self['borderpad'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # captureevents + # ------------- + @property + def captureevents(self): + """ + Determines whether the annotation text box captures mouse move + and click events, or allows those events to pass through to + data points in the plot that may be behind the annotation. By + default `captureevents` is False unless `hovertext` is + provided. If you use the event `plotly_clickannotation` without + `hovertext` you must explicitly enable `captureevents`. + + The 'captureevents' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['captureevents'] + + @captureevents.setter + def captureevents(self, val): + self['captureevents'] = val + + # clicktoshow + # ----------- + @property + def clicktoshow(self): + """ + Makes this annotation respond to clicks on the plot. If you + click a data point that exactly matches the `x` and `y` values + of this annotation, and it is hidden (visible: false), it will + appear. In "onoff" mode, you must click the same point again to + make it disappear, so if you click multiple points, you can + show multiple annotations. In "onout" mode, a click anywhere + else in the plot (on another data point or not) will hide this + annotation. If you need to show/hide this annotation in + response to different `x` or `y` values, you can set `xclick` + and/or `yclick`. This is useful for example to label the side + of a bar. To label markers though, `standoff` is preferred over + `xclick` and `yclick`. + + The 'clicktoshow' property is an enumeration that may be specified as: + - One of the following enumeration values: + [False, 'onoff', 'onout'] + + Returns + ------- + Any + """ + return self['clicktoshow'] + + @clicktoshow.setter + def clicktoshow(self, val): + self['clicktoshow'] = val + + # font + # ---- + @property + def font(self): + """ + Sets the annotation text font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.annotation.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # height + # ------ + @property + 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] + + Returns + ------- + int|float + """ + return self['height'] + + @height.setter + def height(self, val): + self['height'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of 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 + opaque, or white if it was transparent. + bordercolor + Sets the border color of the hover label. By + default uses either dark grey or white, for + maximum contrast with `hoverlabel.bgcolor`. + font + Sets the hover label text font. By default uses + the global hover font and size, with color from + `hoverlabel.bordercolor`. + + Returns + ------- + plotly.graph_objs.layout.annotation.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertext + # --------- + @property + 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 + + Returns + ------- + str + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # showarrow + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showarrow'] + + @showarrow.setter + def showarrow(self, val): + self['showarrow'] = val + + # standoff + # -------- + @property + def standoff(self): + """ + Sets a distance, in pixels, to move the end arrowhead away from + the position it is pointing at, for example to point at the + edge of a marker independent of zoom. Note that this shortens + the arrow from the `ax` / `ay` vector, in contrast to `xshift` + / `yshift` which moves everything by this amount. + + The 'standoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self['standoff'] + + @standoff.setter + def standoff(self, val): + self['standoff'] = val + + # startarrowhead + # -------------- + @property + 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] + + Returns + ------- + int + """ + return self['startarrowhead'] + + @startarrowhead.setter + def startarrowhead(self, val): + self['startarrowhead'] = val + + # startarrowsize + # -------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['startarrowsize'] + + @startarrowsize.setter + def startarrowsize(self, val): + self['startarrowsize'] = val + + # startstandoff + # ------------- + @property + def startstandoff(self): + """ + Sets a distance, in pixels, to move the start arrowhead away + from the position it is pointing at, for example to point at + the edge of a marker independent of zoom. Note that this + shortens the arrow from the `ax` / `ay` vector, in contrast to + `xshift` / `yshift` which moves everything by this amount. + + The 'startstandoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self['startstandoff'] + + @startstandoff.setter + def startstandoff(self, val): + self['startstandoff'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # text + # ---- + @property + def text(self): + """ + Sets the text associated with this annotation. Plotly uses a + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['textangle'] + + @textangle.setter + def textangle(self, val): + self['textangle'] = val + + # valign + # ------ + @property + 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'] + + Returns + ------- + Any + """ + return self['valign'] + + @valign.setter + def valign(self, val): + self['valign'] = val + + # visible + # ------- + @property + def visible(self): + """ + Determines whether or not this annotation is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # x + # - + @property + def x(self): + """ + Sets the annotation's x position. If the axis `type` is "log", + then you must take the log of your desired range. If the axis + `type` is "date", it should be date strings, like date data, + though Date objects and unix milliseconds will be accepted and + converted to strings. If the axis `type` is "category", it + should be numbers, using the scale where each category is + assigned a serial number from zero in the order it appears. + + The 'x' property accepts values of any type + + Returns + ------- + Any + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + def xanchor(self): + """ + Sets the text box's horizontal position anchor This anchor + binds the `x` position to the "left", "center" or "right" of + the annotation. For example, if `x` is set to 1, `xref` to + "paper" and `xanchor` to "right" then the right-most portion of + the annotation lines up with the right-most edge of the + plotting area. If "auto", the anchor is equivalent to "center" + for data-referenced annotations or if there is an arrow, + whereas for paper-referenced with no arrow, the anchor picked + corresponds to the closest side. + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'left', 'center', 'right'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xclick + # ------ + @property + 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 + ------- + Any + """ + return self['xclick'] + + @xclick.setter + def xclick(self, val): + self['xclick'] = val + + # xref + # ---- + @property + def xref(self): + """ + Sets the annotation's x coordinate axis. If set to an x axis id + (e.g. "x" or "x2"), the `x` position refers to an x coordinate + If set to "paper", the `x` position refers to the distance from + the left side of the plotting area in normalized coordinates + where 0 (1) corresponds to the left (right) side. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['paper'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + Any + """ + return self['xref'] + + @xref.setter + def xref(self, val): + self['xref'] = val + + # xshift + # ------ + @property + 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 + + Returns + ------- + int|float + """ + return self['xshift'] + + @xshift.setter + def xshift(self, val): + self['xshift'] = val + + # y + # - + @property + def y(self): + """ + Sets the annotation's y position. If the axis `type` is "log", + then you must take the log of your desired range. If the axis + `type` is "date", it should be date strings, like date data, + though Date objects and unix milliseconds will be accepted and + converted to strings. If the axis `type` is "category", it + should be numbers, using the scale where each category is + assigned a serial number from zero in the order it appears. + + The 'y' property accepts values of any type + + Returns + ------- + Any + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + def yanchor(self): + """ + Sets the text box's vertical position anchor This anchor binds + the `y` position to the "top", "middle" or "bottom" of the + annotation. For example, if `y` is set to 1, `yref` to "paper" + and `yanchor` to "top" then the top-most portion of the + annotation lines up with the top-most edge of the plotting + area. If "auto", the anchor is equivalent to "middle" for data- + referenced annotations or if there is an arrow, whereas for + paper-referenced with no arrow, the anchor picked corresponds + to the closest side. + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # yclick + # ------ + @property + 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 + ------- + Any + """ + return self['yclick'] + + @yclick.setter + def yclick(self, val): + self['yclick'] = val + + # yref + # ---- + @property + def yref(self): + """ + Sets the annotation's y coordinate axis. If set to an y axis id + (e.g. "y" or "y2"), the `y` position refers to an y coordinate + If set to "paper", the `y` position refers to the distance from + the bottom of the plotting area in normalized coordinates where + 0 (1) corresponds to the bottom (top). + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['paper'] + - A string that matches one of the following regular expressions: + ['^y([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + Any + """ + return self['yref'] + + @yref.setter + def yref(self, val): + self['yref'] = val + + # yshift + # ------ + @property + 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 + + Returns + ------- + int|float + """ + return self['yshift'] + + @yshift.setter + def yshift(self, val): + self['yshift'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans more two or + more lines (i.e. `text` contains one or more
HTML + tags) or if an explicit width is set to override the + text width. + arrowcolor + Sets the color of the annotation arrow. + arrowhead + Sets the end annotation arrow head style. + arrowside + Sets the annotation arrow head position. + arrowsize + Sets the size of the end annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + arrowwidth + Sets the width (in px) of annotation arrow line. + ax + Sets the x component of the arrow tail about the arrow + head. If `axref` is `pixel`, a positive (negative) + component corresponds to an arrow pointing from right + to left (left to right). If `axref` is an axis, this is + an absolute value on that axis, like `x`, NOT a + relative value. + axref + Indicates in what terms the tail of the annotation + (ax,ay) is specified. If `pixel`, `ax` is a relative + offset in pixels from `x`. If set to an x axis id + (e.g. "x" or "x2"), `ax` is specified in the same + terms as that axis. This is useful for trendline + annotations which should continue to indicate the + correct trend when zoomed. + ay + Sets the y component of the arrow tail about the arrow + head. If `ayref` is `pixel`, a positive (negative) + component corresponds to an arrow pointing from bottom + to top (top to bottom). If `ayref` is an axis, this is + an absolute value on that axis, like `y`, NOT a + relative value. + ayref + Indicates in what terms the tail of the annotation + (ax,ay) is specified. If `pixel`, `ay` is a relative + offset in pixels from `y`. If set to a y axis id (e.g. + "y" or "y2"), `ay` is specified in the same terms as + that axis. This is useful for trendline annotations + which should continue to indicate the correct trend + when zoomed. + bgcolor + Sets the background color of the annotation. + bordercolor + Sets the color of the border enclosing the annotation + `text`. + borderpad + Sets the padding (in px) between the `text` and the + enclosing border. + borderwidth + Sets the width (in px) of the border enclosing the + annotation `text`. + captureevents + Determines whether the annotation text box captures + mouse move and click events, or allows those events to + pass through to data points in the plot that may be + behind the annotation. By default `captureevents` is + False unless `hovertext` is provided. If you use the + event `plotly_clickannotation` without `hovertext` you + must explicitly enable `captureevents`. + clicktoshow + Makes this annotation respond to clicks on the plot. If + you click a data point that exactly matches the `x` and + `y` values of this annotation, and it is hidden + (visible: false), it will appear. In "onoff" mode, you + must click the same point again to make it disappear, + so if you click multiple points, you can show multiple + annotations. In "onout" mode, a click anywhere else in + the plot (on another data point or not) will hide this + annotation. If you need to show/hide this annotation in + response to different `x` or `y` values, you can set + `xclick` and/or `yclick`. This is useful for example to + label the side of a bar. To label markers though, + `standoff` is preferred over `xclick` and `yclick`. + font + Sets the annotation text font. + height + Sets an explicit height for the text box. null + (default) lets the text set the box height. Taller text + will be clipped. + hoverlabel + plotly.graph_objs.layout.annotation.Hoverlabel instance + or dict with compatible properties + hovertext + Sets text to appear when hovering over this annotation. + If omitted or blank, no hover label will appear. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the annotation (text + arrow). + showarrow + Determines whether or not the annotation is drawn with + an arrow. If True, `text` is placed near the arrow's + tail. If False, `text` lines up with the `x` and `y` + provided. + standoff + Sets a distance, in pixels, to move the end arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + startarrowhead + Sets the start annotation arrow head style. + startarrowsize + Sets the size of the start annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + startstandoff + Sets a distance, in pixels, to move the start arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + text + Sets the text associated with this annotation. Plotly + uses a subset of HTML tags to do things like newline + (
), bold (), italics (), hyperlinks + (). Tags , , + are also supported. + textangle + Sets the angle at which the `text` is drawn with + respect to the horizontal. + valign + Sets the vertical alignment of the `text` within the + box. Has an effect only if an explicit height is set to + override the text height. + visible + Determines whether or not this annotation is visible. + width + Sets an explicit width for the text box. null (default) + lets the text set the box width. Wider text will be + clipped. There is no automatic wrapping; use
to + start a new line. + x + Sets the annotation's x position. If the axis `type` is + "log", then you must take the log of your desired + range. If the axis `type` is "date", it should be date + strings, like date data, though Date objects and unix + milliseconds will be accepted and converted to strings. + If the axis `type` is "category", it should be numbers, + using the scale where each category is assigned a + serial number from zero in the order it appears. + xanchor + Sets the text box's horizontal position anchor This + anchor binds the `x` position to the "left", "center" + or "right" of the annotation. For example, if `x` is + set to 1, `xref` to "paper" and `xanchor` to "right" + then the right-most portion of the annotation lines up + with the right-most edge of the plotting area. If + "auto", the anchor is equivalent to "center" for data- + referenced annotations or if there is an arrow, whereas + for paper-referenced with no arrow, the anchor picked + corresponds to the closest side. + xclick + Toggle this annotation when clicking a data point whose + `x` value is `xclick` rather than the annotation's `x` + value. + xref + Sets the annotation's x coordinate axis. If set to an x + axis id (e.g. "x" or "x2"), the `x` position refers to + an x coordinate If set to "paper", the `x` position + refers to the distance from the left side of the + plotting area in normalized coordinates where 0 (1) + corresponds to the left (right) side. + xshift + Shifts the position of the whole annotation and arrow + to the right (positive) or left (negative) by this many + pixels. + y + Sets the annotation's y position. If the axis `type` is + "log", then you must take the log of your desired + range. If the axis `type` is "date", it should be date + strings, like date data, though Date objects and unix + milliseconds will be accepted and converted to strings. + If the axis `type` is "category", it should be numbers, + using the scale where each category is assigned a + serial number from zero in the order it appears. + yanchor + Sets the text box's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the annotation. For example, if `y` is set + to 1, `yref` to "paper" and `yanchor` to "top" then the + top-most portion of the annotation lines up with the + top-most edge of the plotting area. If "auto", the + anchor is equivalent to "middle" for data-referenced + annotations or if there is an arrow, whereas for paper- + referenced with no arrow, the anchor picked corresponds + to the closest side. + yclick + Toggle this annotation when clicking a data point whose + `y` value is `yclick` rather than the annotation's `y` + value. + yref + Sets the annotation's y coordinate axis. If set to an y + axis id (e.g. "y" or "y2"), the `y` position refers to + an y coordinate If set to "paper", the `y` position + refers to the distance from the bottom of the plotting + area in normalized coordinates where 0 (1) corresponds + to the bottom (top). + yshift + Shifts the position of the whole annotation and arrow + up (positive) or down (negative) by this many pixels. + """ + + def __init__( + self, + arg=None, + align=None, + arrowcolor=None, + arrowhead=None, + arrowside=None, + arrowsize=None, + arrowwidth=None, + ax=None, + axref=None, + ay=None, + ayref=None, + bgcolor=None, + bordercolor=None, + borderpad=None, + borderwidth=None, + captureevents=None, + clicktoshow=None, + font=None, + height=None, + hoverlabel=None, + hovertext=None, + name=None, + opacity=None, + showarrow=None, + standoff=None, + startarrowhead=None, + startarrowsize=None, + startstandoff=None, + templateitemname=None, + text=None, + textangle=None, + valign=None, + visible=None, + width=None, + x=None, + xanchor=None, + xclick=None, + xref=None, + xshift=None, + y=None, + yanchor=None, + yclick=None, + yref=None, + yshift=None, + **kwargs + ): + """ + Construct a new Annotation object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.Annotation + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans more two or + more lines (i.e. `text` contains one or more
HTML + tags) or if an explicit width is set to override the + text width. + arrowcolor + Sets the color of the annotation arrow. + arrowhead + Sets the end annotation arrow head style. + arrowside + Sets the annotation arrow head position. + arrowsize + Sets the size of the end annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + arrowwidth + Sets the width (in px) of annotation arrow line. + ax + Sets the x component of the arrow tail about the arrow + head. If `axref` is `pixel`, a positive (negative) + component corresponds to an arrow pointing from right + to left (left to right). If `axref` is an axis, this is + an absolute value on that axis, like `x`, NOT a + relative value. + axref + Indicates in what terms the tail of the annotation + (ax,ay) is specified. If `pixel`, `ax` is a relative + offset in pixels from `x`. If set to an x axis id + (e.g. "x" or "x2"), `ax` is specified in the same + terms as that axis. This is useful for trendline + annotations which should continue to indicate the + correct trend when zoomed. + ay + Sets the y component of the arrow tail about the arrow + head. If `ayref` is `pixel`, a positive (negative) + component corresponds to an arrow pointing from bottom + to top (top to bottom). If `ayref` is an axis, this is + an absolute value on that axis, like `y`, NOT a + relative value. + ayref + Indicates in what terms the tail of the annotation + (ax,ay) is specified. If `pixel`, `ay` is a relative + offset in pixels from `y`. If set to a y axis id (e.g. + "y" or "y2"), `ay` is specified in the same terms as + that axis. This is useful for trendline annotations + which should continue to indicate the correct trend + when zoomed. + bgcolor + Sets the background color of the annotation. + bordercolor + Sets the color of the border enclosing the annotation + `text`. + borderpad + Sets the padding (in px) between the `text` and the + enclosing border. + borderwidth + Sets the width (in px) of the border enclosing the + annotation `text`. + captureevents + Determines whether the annotation text box captures + mouse move and click events, or allows those events to + pass through to data points in the plot that may be + behind the annotation. By default `captureevents` is + False unless `hovertext` is provided. If you use the + event `plotly_clickannotation` without `hovertext` you + must explicitly enable `captureevents`. + clicktoshow + Makes this annotation respond to clicks on the plot. If + you click a data point that exactly matches the `x` and + `y` values of this annotation, and it is hidden + (visible: false), it will appear. In "onoff" mode, you + must click the same point again to make it disappear, + so if you click multiple points, you can show multiple + annotations. In "onout" mode, a click anywhere else in + the plot (on another data point or not) will hide this + annotation. If you need to show/hide this annotation in + response to different `x` or `y` values, you can set + `xclick` and/or `yclick`. This is useful for example to + label the side of a bar. To label markers though, + `standoff` is preferred over `xclick` and `yclick`. + font + Sets the annotation text font. + height + Sets an explicit height for the text box. null + (default) lets the text set the box height. Taller text + will be clipped. + hoverlabel + plotly.graph_objs.layout.annotation.Hoverlabel instance + or dict with compatible properties + hovertext + Sets text to appear when hovering over this annotation. + If omitted or blank, no hover label will appear. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the annotation (text + arrow). + showarrow + Determines whether or not the annotation is drawn with + an arrow. If True, `text` is placed near the arrow's + tail. If False, `text` lines up with the `x` and `y` + provided. + standoff + Sets a distance, in pixels, to move the end arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + startarrowhead + Sets the start annotation arrow head style. + startarrowsize + Sets the size of the start annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + startstandoff + Sets a distance, in pixels, to move the start arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + text + Sets the text associated with this annotation. Plotly + uses a subset of HTML tags to do things like newline + (
), bold (), italics (), hyperlinks + (). Tags , , + are also supported. + textangle + Sets the angle at which the `text` is drawn with + respect to the horizontal. + valign + Sets the vertical alignment of the `text` within the + box. Has an effect only if an explicit height is set to + override the text height. + visible + Determines whether or not this annotation is visible. + width + Sets an explicit width for the text box. null (default) + lets the text set the box width. Wider text will be + clipped. There is no automatic wrapping; use
to + start a new line. + x + Sets the annotation's x position. If the axis `type` is + "log", then you must take the log of your desired + range. If the axis `type` is "date", it should be date + strings, like date data, though Date objects and unix + milliseconds will be accepted and converted to strings. + If the axis `type` is "category", it should be numbers, + using the scale where each category is assigned a + serial number from zero in the order it appears. + xanchor + Sets the text box's horizontal position anchor This + anchor binds the `x` position to the "left", "center" + or "right" of the annotation. For example, if `x` is + set to 1, `xref` to "paper" and `xanchor` to "right" + then the right-most portion of the annotation lines up + with the right-most edge of the plotting area. If + "auto", the anchor is equivalent to "center" for data- + referenced annotations or if there is an arrow, whereas + for paper-referenced with no arrow, the anchor picked + corresponds to the closest side. + xclick + Toggle this annotation when clicking a data point whose + `x` value is `xclick` rather than the annotation's `x` + value. + xref + Sets the annotation's x coordinate axis. If set to an x + axis id (e.g. "x" or "x2"), the `x` position refers to + an x coordinate If set to "paper", the `x` position + refers to the distance from the left side of the + plotting area in normalized coordinates where 0 (1) + corresponds to the left (right) side. + xshift + Shifts the position of the whole annotation and arrow + to the right (positive) or left (negative) by this many + pixels. + y + Sets the annotation's y position. If the axis `type` is + "log", then you must take the log of your desired + range. If the axis `type` is "date", it should be date + strings, like date data, though Date objects and unix + milliseconds will be accepted and converted to strings. + If the axis `type` is "category", it should be numbers, + using the scale where each category is assigned a + serial number from zero in the order it appears. + yanchor + Sets the text box's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the annotation. For example, if `y` is set + to 1, `yref` to "paper" and `yanchor` to "top" then the + top-most portion of the annotation lines up with the + top-most edge of the plotting area. If "auto", the + anchor is equivalent to "middle" for data-referenced + annotations or if there is an arrow, whereas for paper- + referenced with no arrow, the anchor picked corresponds + to the closest side. + yclick + Toggle this annotation when clicking a data point whose + `y` value is `yclick` rather than the annotation's `y` + value. + yref + Sets the annotation's y coordinate axis. If set to an y + axis id (e.g. "y" or "y2"), the `y` position refers to + an y coordinate If set to "paper", the `y` position + refers to the distance from the bottom of the plotting + area in normalized coordinates where 0 (1) corresponds + to the bottom (top). + yshift + Shifts the position of the whole annotation and arrow + up (positive) or down (negative) by this many pixels. + + Returns + ------- + Annotation + """ + super(Annotation, self).__init__('annotations') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.Annotation +constructor must be a dict or +an instance of plotly.graph_objs.layout.Annotation""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (annotation as v_annotation) + + # Initialize validators + # --------------------- + self._validators['align'] = v_annotation.AlignValidator() + self._validators['arrowcolor'] = v_annotation.ArrowcolorValidator() + self._validators['arrowhead'] = v_annotation.ArrowheadValidator() + self._validators['arrowside'] = v_annotation.ArrowsideValidator() + self._validators['arrowsize'] = v_annotation.ArrowsizeValidator() + self._validators['arrowwidth'] = v_annotation.ArrowwidthValidator() + self._validators['ax'] = v_annotation.AxValidator() + self._validators['axref'] = v_annotation.AxrefValidator() + self._validators['ay'] = v_annotation.AyValidator() + self._validators['ayref'] = v_annotation.AyrefValidator() + self._validators['bgcolor'] = v_annotation.BgcolorValidator() + self._validators['bordercolor'] = v_annotation.BordercolorValidator() + self._validators['borderpad'] = v_annotation.BorderpadValidator() + self._validators['borderwidth'] = v_annotation.BorderwidthValidator() + self._validators['captureevents' + ] = v_annotation.CaptureeventsValidator() + self._validators['clicktoshow'] = v_annotation.ClicktoshowValidator() + self._validators['font'] = v_annotation.FontValidator() + self._validators['height'] = v_annotation.HeightValidator() + self._validators['hoverlabel'] = v_annotation.HoverlabelValidator() + self._validators['hovertext'] = v_annotation.HovertextValidator() + self._validators['name'] = v_annotation.NameValidator() + self._validators['opacity'] = v_annotation.OpacityValidator() + self._validators['showarrow'] = v_annotation.ShowarrowValidator() + self._validators['standoff'] = v_annotation.StandoffValidator() + self._validators['startarrowhead' + ] = v_annotation.StartarrowheadValidator() + self._validators['startarrowsize' + ] = v_annotation.StartarrowsizeValidator() + self._validators['startstandoff' + ] = v_annotation.StartstandoffValidator() + self._validators['templateitemname' + ] = v_annotation.TemplateitemnameValidator() + self._validators['text'] = v_annotation.TextValidator() + self._validators['textangle'] = v_annotation.TextangleValidator() + self._validators['valign'] = v_annotation.ValignValidator() + self._validators['visible'] = v_annotation.VisibleValidator() + self._validators['width'] = v_annotation.WidthValidator() + self._validators['x'] = v_annotation.XValidator() + self._validators['xanchor'] = v_annotation.XanchorValidator() + self._validators['xclick'] = v_annotation.XclickValidator() + self._validators['xref'] = v_annotation.XrefValidator() + self._validators['xshift'] = v_annotation.XshiftValidator() + self._validators['y'] = v_annotation.YValidator() + self._validators['yanchor'] = v_annotation.YanchorValidator() + self._validators['yclick'] = v_annotation.YclickValidator() + self._validators['yref'] = v_annotation.YrefValidator() + self._validators['yshift'] = v_annotation.YshiftValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('align', None) + self['align'] = align if align is not None else _v + _v = arg.pop('arrowcolor', None) + self['arrowcolor'] = arrowcolor if arrowcolor is not None else _v + _v = arg.pop('arrowhead', None) + self['arrowhead'] = arrowhead if arrowhead is not None else _v + _v = arg.pop('arrowside', None) + self['arrowside'] = arrowside if arrowside is not None else _v + _v = arg.pop('arrowsize', None) + self['arrowsize'] = arrowsize if arrowsize is not None else _v + _v = arg.pop('arrowwidth', None) + self['arrowwidth'] = arrowwidth if arrowwidth is not None else _v + _v = arg.pop('ax', None) + self['ax'] = ax if ax is not None else _v + _v = arg.pop('axref', None) + self['axref'] = axref if axref is not None else _v + _v = arg.pop('ay', None) + self['ay'] = ay if ay is not None else _v + _v = arg.pop('ayref', None) + self['ayref'] = ayref if ayref is not None else _v + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderpad', None) + self['borderpad'] = borderpad if borderpad is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('captureevents', None) + self['captureevents' + ] = captureevents if captureevents is not None else _v + _v = arg.pop('clicktoshow', None) + self['clicktoshow'] = clicktoshow if clicktoshow is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('height', None) + self['height'] = height if height is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('showarrow', None) + self['showarrow'] = showarrow if showarrow is not None else _v + _v = arg.pop('standoff', None) + self['standoff'] = standoff if standoff is not None else _v + _v = arg.pop('startarrowhead', None) + self['startarrowhead' + ] = startarrowhead if startarrowhead is not None else _v + _v = arg.pop('startarrowsize', None) + self['startarrowsize' + ] = startarrowsize if startarrowsize is not None else _v + _v = arg.pop('startstandoff', None) + self['startstandoff' + ] = startstandoff if startstandoff is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textangle', None) + self['textangle'] = textangle if textangle is not None else _v + _v = arg.pop('valign', None) + self['valign'] = valign if valign is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xclick', None) + self['xclick'] = xclick if xclick is not None else _v + _v = arg.pop('xref', None) + self['xref'] = xref if xref is not None else _v + _v = arg.pop('xshift', None) + self['xshift'] = xshift if xshift is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('yclick', None) + self['yclick'] = yclick if yclick is not None else _v + _v = arg.pop('yref', None) + self['yref'] = yref if yref is not None else _v + _v = arg.pop('yshift', None) + self['yshift'] = yshift if yshift is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class AngularAxis(_BaseLayoutHierarchyType): + + # domain + # ------ + @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] + + Returns + ------- + list + """ + return self['domain'] + + @domain.setter + def domain(self, val): + self['domain'] = val + + # endpadding + # ---------- + @property + 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 + + Returns + ------- + int|float + """ + return self['endpadding'] + + @endpadding.setter + def endpadding(self, val): + self['endpadding'] = val + + # range + # ----- + @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 + + Returns + ------- + list + """ + return self['range'] + + @range.setter + def range(self, val): + self['range'] = val + + # showline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showline'] + + @showline.setter + def showline(self, val): + self['showline'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickorientation + # --------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['tickorientation'] + + @tickorientation.setter + def tickorientation(self, val): + self['tickorientation'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + domain + Polar chart subplots are not supported yet. This key + has currently no effect. + endpadding + Legacy polar charts are deprecated! Please switch to + "polar" subplots. + range + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Defines the start and end point of + this angular axis. + showline + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Determines whether or not the line + bounding this angular axis will be shown on the figure. + showticklabels + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Determines whether or not the angular + axis ticks will feature tick labels. + tickcolor + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the color of the tick lines on + this angular axis. + ticklen + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the length of the tick lines on + this angular axis. + tickorientation + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the orientation (from the paper + perspective) of the angular axis tick labels. + ticksuffix + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the length of the tick lines on + this angular axis. + visible + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Determines whether or not this axis + will be visible. + """ + + def __init__( + self, + arg=None, + domain=None, + endpadding=None, + range=None, + showline=None, + showticklabels=None, + tickcolor=None, + ticklen=None, + tickorientation=None, + ticksuffix=None, + visible=None, + **kwargs + ): + """ + Construct a new AngularAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.AngularAxis + domain + Polar chart subplots are not supported yet. This key + has currently no effect. + endpadding + Legacy polar charts are deprecated! Please switch to + "polar" subplots. + range + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Defines the start and end point of + this angular axis. + showline + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Determines whether or not the line + bounding this angular axis will be shown on the figure. + showticklabels + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Determines whether or not the angular + axis ticks will feature tick labels. + tickcolor + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the color of the tick lines on + this angular axis. + ticklen + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the length of the tick lines on + this angular axis. + tickorientation + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the orientation (from the paper + perspective) of the angular axis tick labels. + ticksuffix + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Sets the length of the tick lines on + this angular axis. + visible + Legacy polar charts are deprecated! Please switch to + "polar" subplots. Determines whether or not this axis + will be visible. + + Returns + ------- + AngularAxis + """ + super(AngularAxis, self).__init__('angularaxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.AngularAxis +constructor must be a dict or +an instance of plotly.graph_objs.layout.AngularAxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout import (angularaxis as v_angularaxis) + + # Initialize validators + # --------------------- + self._validators['domain'] = v_angularaxis.DomainValidator() + self._validators['endpadding'] = v_angularaxis.EndpaddingValidator() + self._validators['range'] = v_angularaxis.RangeValidator() + self._validators['showline'] = v_angularaxis.ShowlineValidator() + self._validators['showticklabels' + ] = v_angularaxis.ShowticklabelsValidator() + self._validators['tickcolor'] = v_angularaxis.TickcolorValidator() + self._validators['ticklen'] = v_angularaxis.TicklenValidator() + self._validators['tickorientation' + ] = v_angularaxis.TickorientationValidator() + self._validators['ticksuffix'] = v_angularaxis.TicksuffixValidator() + self._validators['visible'] = v_angularaxis.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('domain', None) + self['domain'] = domain if domain is not None else _v + _v = arg.pop('endpadding', None) + self['endpadding'] = endpadding if endpadding is not None else _v + _v = arg.pop('range', None) + self['range'] = range if range is not None else _v + _v = arg.pop('showline', None) + self['showline'] = showline if showline is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickorientation', None) + self['tickorientation' + ] = tickorientation if tickorientation is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout import yaxis -from ._xaxis import XAxis from plotly.graph_objs.layout import xaxis -from ._updatemenu import Updatemenu from plotly.graph_objs.layout import updatemenu -from ._transition import Transition -from ._title import Title from plotly.graph_objs.layout import title -from ._ternary import Ternary from plotly.graph_objs.layout import ternary -from ._template import Template from plotly.graph_objs.layout import template -from ._slider import Slider from plotly.graph_objs.layout import slider -from ._shape import Shape from plotly.graph_objs.layout import shape -from ._scene import Scene from plotly.graph_objs.layout import scene -from ._radialaxis import RadialAxis -from ._polar import Polar from plotly.graph_objs.layout import polar -from ._modebar import Modebar -from ._margin import Margin -from ._mapbox import Mapbox from plotly.graph_objs.layout import mapbox -from ._legend import Legend from plotly.graph_objs.layout import legend -from ._image import Image -from ._hoverlabel import Hoverlabel from plotly.graph_objs.layout import hoverlabel -from ._grid import Grid from plotly.graph_objs.layout import grid -from ._geo import Geo from plotly.graph_objs.layout import geo -from ._font import Font -from ._colorscale import Colorscale -from ._annotation import Annotation from plotly.graph_objs.layout import annotation -from ._angularaxis import AngularAxis diff --git a/plotly/graph_objs/layout/_angularaxis.py b/plotly/graph_objs/layout/_angularaxis.py deleted file mode 100644 index c3476752ef9..00000000000 --- a/plotly/graph_objs/layout/_angularaxis.py +++ /dev/null @@ -1,463 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class AngularAxis(BaseLayoutHierarchyType): - - # domain - # ------ - @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] - - Returns - ------- - list - """ - return self['domain'] - - @domain.setter - def domain(self, val): - self['domain'] = val - - # endpadding - # ---------- - @property - 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 - - Returns - ------- - int|float - """ - return self['endpadding'] - - @endpadding.setter - def endpadding(self, val): - self['endpadding'] = val - - # range - # ----- - @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 - - Returns - ------- - list - """ - return self['range'] - - @range.setter - def range(self, val): - self['range'] = val - - # showline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showline'] - - @showline.setter - def showline(self, val): - self['showline'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickorientation - # --------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['tickorientation'] - - @tickorientation.setter - def tickorientation(self, val): - self['tickorientation'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - domain - Polar chart subplots are not supported yet. This key - has currently no effect. - endpadding - Legacy polar charts are deprecated! Please switch to - "polar" subplots. - range - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Defines the start and end point of - this angular axis. - showline - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Determines whether or not the line - bounding this angular axis will be shown on the figure. - showticklabels - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Determines whether or not the angular - axis ticks will feature tick labels. - tickcolor - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the color of the tick lines on - this angular axis. - ticklen - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the length of the tick lines on - this angular axis. - tickorientation - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the orientation (from the paper - perspective) of the angular axis tick labels. - ticksuffix - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the length of the tick lines on - this angular axis. - visible - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Determines whether or not this axis - will be visible. - """ - - def __init__( - self, - arg=None, - domain=None, - endpadding=None, - range=None, - showline=None, - showticklabels=None, - tickcolor=None, - ticklen=None, - tickorientation=None, - ticksuffix=None, - visible=None, - **kwargs - ): - """ - Construct a new AngularAxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.AngularAxis - domain - Polar chart subplots are not supported yet. This key - has currently no effect. - endpadding - Legacy polar charts are deprecated! Please switch to - "polar" subplots. - range - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Defines the start and end point of - this angular axis. - showline - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Determines whether or not the line - bounding this angular axis will be shown on the figure. - showticklabels - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Determines whether or not the angular - axis ticks will feature tick labels. - tickcolor - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the color of the tick lines on - this angular axis. - ticklen - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the length of the tick lines on - this angular axis. - tickorientation - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the orientation (from the paper - perspective) of the angular axis tick labels. - ticksuffix - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the length of the tick lines on - this angular axis. - visible - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Determines whether or not this axis - will be visible. - - Returns - ------- - AngularAxis - """ - super(AngularAxis, self).__init__('angularaxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.AngularAxis -constructor must be a dict or -an instance of plotly.graph_objs.layout.AngularAxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (angularaxis as v_angularaxis) - - # Initialize validators - # --------------------- - self._validators['domain'] = v_angularaxis.DomainValidator() - self._validators['endpadding'] = v_angularaxis.EndpaddingValidator() - self._validators['range'] = v_angularaxis.RangeValidator() - self._validators['showline'] = v_angularaxis.ShowlineValidator() - self._validators['showticklabels' - ] = v_angularaxis.ShowticklabelsValidator() - self._validators['tickcolor'] = v_angularaxis.TickcolorValidator() - self._validators['ticklen'] = v_angularaxis.TicklenValidator() - self._validators['tickorientation' - ] = v_angularaxis.TickorientationValidator() - self._validators['ticksuffix'] = v_angularaxis.TicksuffixValidator() - self._validators['visible'] = v_angularaxis.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('domain', None) - self['domain'] = domain if domain is not None else _v - _v = arg.pop('endpadding', None) - self['endpadding'] = endpadding if endpadding is not None else _v - _v = arg.pop('range', None) - self['range'] = range if range is not None else _v - _v = arg.pop('showline', None) - self['showline'] = showline if showline is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickorientation', None) - self['tickorientation' - ] = tickorientation if tickorientation is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_annotation.py b/plotly/graph_objs/layout/_annotation.py deleted file mode 100644 index f43e7d3509a..00000000000 --- a/plotly/graph_objs/layout/_annotation.py +++ /dev/null @@ -1,1870 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Annotation(BaseLayoutHierarchyType): - - # align - # ----- - @property - def align(self): - """ - Sets the horizontal alignment of the `text` within the box. Has - an effect only if `text` spans more 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'] - - Returns - ------- - Any - """ - return self['align'] - - @align.setter - def align(self, val): - self['align'] = val - - # arrowcolor - # ---------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['arrowcolor'] - - @arrowcolor.setter - def arrowcolor(self, val): - self['arrowcolor'] = val - - # arrowhead - # --------- - @property - 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] - - Returns - ------- - int - """ - return self['arrowhead'] - - @arrowhead.setter - def arrowhead(self, val): - self['arrowhead'] = val - - # arrowside - # --------- - @property - 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 - (e.g. 'end+start') - OR exactly one of ['none'] (e.g. 'none') - - Returns - ------- - Any - """ - return self['arrowside'] - - @arrowside.setter - def arrowside(self, val): - self['arrowside'] = val - - # arrowsize - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['arrowsize'] - - @arrowsize.setter - def arrowsize(self, val): - self['arrowsize'] = val - - # arrowwidth - # ---------- - @property - 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] - - Returns - ------- - int|float - """ - return self['arrowwidth'] - - @arrowwidth.setter - def arrowwidth(self, val): - self['arrowwidth'] = val - - # ax - # -- - @property - def ax(self): - """ - Sets the x component of the arrow tail about the arrow head. If - `axref` is `pixel`, a positive (negative) component - corresponds to an arrow pointing from right to left (left to - right). If `axref` is an axis, this is an absolute value on - that axis, like `x`, NOT a relative value. - - The 'ax' property accepts values of any type - - Returns - ------- - Any - """ - return self['ax'] - - @ax.setter - def ax(self, val): - self['ax'] = val - - # axref - # ----- - @property - def axref(self): - """ - Indicates in what terms the tail of the annotation (ax,ay) is - specified. If `pixel`, `ax` is a relative offset in pixels - from `x`. If set to an x axis id (e.g. "x" or "x2"), `ax` is - specified in the same terms as that axis. This is useful for - trendline annotations which should continue to indicate the - correct trend when zoomed. - - The 'axref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['pixel'] - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - Any - """ - return self['axref'] - - @axref.setter - def axref(self, val): - self['axref'] = val - - # ay - # -- - @property - def ay(self): - """ - Sets the y component of the arrow tail about the arrow head. If - `ayref` is `pixel`, a positive (negative) component - corresponds to an arrow pointing from bottom to top (top to - bottom). If `ayref` is an axis, this is an absolute value on - that axis, like `y`, NOT a relative value. - - The 'ay' property accepts values of any type - - Returns - ------- - Any - """ - return self['ay'] - - @ay.setter - def ay(self, val): - self['ay'] = val - - # ayref - # ----- - @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. - - The 'ayref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['pixel'] - - A string that matches one of the following regular expressions: - ['^y([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - Any - """ - return self['ayref'] - - @ayref.setter - def ayref(self, val): - self['ayref'] = val - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderpad - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderpad'] - - @borderpad.setter - def borderpad(self, val): - self['borderpad'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # captureevents - # ------------- - @property - def captureevents(self): - """ - Determines whether the annotation text box captures mouse move - and click events, or allows those events to pass through to - data points in the plot that may be behind the annotation. By - default `captureevents` is False unless `hovertext` is - provided. If you use the event `plotly_clickannotation` without - `hovertext` you must explicitly enable `captureevents`. - - The 'captureevents' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['captureevents'] - - @captureevents.setter - def captureevents(self, val): - self['captureevents'] = val - - # clicktoshow - # ----------- - @property - def clicktoshow(self): - """ - Makes this annotation respond to clicks on the plot. If you - click a data point that exactly matches the `x` and `y` values - of this annotation, and it is hidden (visible: false), it will - appear. In "onoff" mode, you must click the same point again to - make it disappear, so if you click multiple points, you can - show multiple annotations. In "onout" mode, a click anywhere - else in the plot (on another data point or not) will hide this - annotation. If you need to show/hide this annotation in - response to different `x` or `y` values, you can set `xclick` - and/or `yclick`. This is useful for example to label the side - of a bar. To label markers though, `standoff` is preferred over - `xclick` and `yclick`. - - The 'clicktoshow' property is an enumeration that may be specified as: - - One of the following enumeration values: - [False, 'onoff', 'onout'] - - Returns - ------- - Any - """ - return self['clicktoshow'] - - @clicktoshow.setter - def clicktoshow(self, val): - self['clicktoshow'] = val - - # font - # ---- - @property - def font(self): - """ - Sets the annotation text font. - - The 'font' property is an instance of Font - that may be specified as: - - An instance of 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.annotation.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # height - # ------ - @property - 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] - - Returns - ------- - int|float - """ - return self['height'] - - @height.setter - def height(self, val): - self['height'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of 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 - opaque, or white if it was transparent. - bordercolor - Sets the border color of the hover label. By - default uses either dark grey or white, for - maximum contrast with `hoverlabel.bgcolor`. - font - Sets the hover label text font. By default uses - the global hover font and size, with color from - `hoverlabel.bordercolor`. - - Returns - ------- - plotly.graph_objs.layout.annotation.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertext - # --------- - @property - 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 - - Returns - ------- - str - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # showarrow - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showarrow'] - - @showarrow.setter - def showarrow(self, val): - self['showarrow'] = val - - # standoff - # -------- - @property - def standoff(self): - """ - Sets a distance, in pixels, to move the end arrowhead away from - the position it is pointing at, for example to point at the - edge of a marker independent of zoom. Note that this shortens - the arrow from the `ax` / `ay` vector, in contrast to `xshift` - / `yshift` which moves everything by this amount. - - The 'standoff' property is a number and may be specified as: - - An int or float in the interval [0, inf] - - Returns - ------- - int|float - """ - return self['standoff'] - - @standoff.setter - def standoff(self, val): - self['standoff'] = val - - # startarrowhead - # -------------- - @property - 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] - - Returns - ------- - int - """ - return self['startarrowhead'] - - @startarrowhead.setter - def startarrowhead(self, val): - self['startarrowhead'] = val - - # startarrowsize - # -------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['startarrowsize'] - - @startarrowsize.setter - def startarrowsize(self, val): - self['startarrowsize'] = val - - # startstandoff - # ------------- - @property - def startstandoff(self): - """ - Sets a distance, in pixels, to move the start arrowhead away - from the position it is pointing at, for example to point at - the edge of a marker independent of zoom. Note that this - shortens the arrow from the `ax` / `ay` vector, in contrast to - `xshift` / `yshift` which moves everything by this amount. - - The 'startstandoff' property is a number and may be specified as: - - An int or float in the interval [0, inf] - - Returns - ------- - int|float - """ - return self['startstandoff'] - - @startstandoff.setter - def startstandoff(self, val): - self['startstandoff'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # text - # ---- - @property - def text(self): - """ - Sets the text associated with this annotation. Plotly uses a - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['textangle'] - - @textangle.setter - def textangle(self, val): - self['textangle'] = val - - # valign - # ------ - @property - 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'] - - Returns - ------- - Any - """ - return self['valign'] - - @valign.setter - def valign(self, val): - self['valign'] = val - - # visible - # ------- - @property - def visible(self): - """ - Determines whether or not this annotation is visible. - - The 'visible' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # x - # - - @property - def x(self): - """ - Sets the annotation's x position. If the axis `type` is "log", - then you must take the log of your desired range. If the axis - `type` is "date", it should be date strings, like date data, - though Date objects and unix milliseconds will be accepted and - converted to strings. If the axis `type` is "category", it - should be numbers, using the scale where each category is - assigned a serial number from zero in the order it appears. - - The 'x' property accepts values of any type - - Returns - ------- - Any - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - def xanchor(self): - """ - Sets the text box's horizontal position anchor This anchor - binds the `x` position to the "left", "center" or "right" of - the annotation. For example, if `x` is set to 1, `xref` to - "paper" and `xanchor` to "right" then the right-most portion of - the annotation lines up with the right-most edge of the - plotting area. If "auto", the anchor is equivalent to "center" - for data-referenced annotations or if there is an arrow, - whereas for paper-referenced with no arrow, the anchor picked - corresponds to the closest side. - - The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'left', 'center', 'right'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xclick - # ------ - @property - 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 - ------- - Any - """ - return self['xclick'] - - @xclick.setter - def xclick(self, val): - self['xclick'] = val - - # xref - # ---- - @property - def xref(self): - """ - Sets the annotation's x coordinate axis. If set to an x axis id - (e.g. "x" or "x2"), the `x` position refers to an x coordinate - If set to "paper", the `x` position refers to the distance from - the left side of the plotting area in normalized coordinates - where 0 (1) corresponds to the left (right) side. - - The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['paper'] - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - Any - """ - return self['xref'] - - @xref.setter - def xref(self, val): - self['xref'] = val - - # xshift - # ------ - @property - 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 - - Returns - ------- - int|float - """ - return self['xshift'] - - @xshift.setter - def xshift(self, val): - self['xshift'] = val - - # y - # - - @property - def y(self): - """ - Sets the annotation's y position. If the axis `type` is "log", - then you must take the log of your desired range. If the axis - `type` is "date", it should be date strings, like date data, - though Date objects and unix milliseconds will be accepted and - converted to strings. If the axis `type` is "category", it - should be numbers, using the scale where each category is - assigned a serial number from zero in the order it appears. - - The 'y' property accepts values of any type - - Returns - ------- - Any - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - def yanchor(self): - """ - Sets the text box's vertical position anchor This anchor binds - the `y` position to the "top", "middle" or "bottom" of the - annotation. For example, if `y` is set to 1, `yref` to "paper" - and `yanchor` to "top" then the top-most portion of the - annotation lines up with the top-most edge of the plotting - area. If "auto", the anchor is equivalent to "middle" for data- - referenced annotations or if there is an arrow, whereas for - paper-referenced with no arrow, the anchor picked corresponds - to the closest side. - - The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'top', 'middle', 'bottom'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # yclick - # ------ - @property - 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 - ------- - Any - """ - return self['yclick'] - - @yclick.setter - def yclick(self, val): - self['yclick'] = val - - # yref - # ---- - @property - def yref(self): - """ - Sets the annotation's y coordinate axis. If set to an y axis id - (e.g. "y" or "y2"), the `y` position refers to an y coordinate - If set to "paper", the `y` position refers to the distance from - the bottom of the plotting area in normalized coordinates where - 0 (1) corresponds to the bottom (top). - - The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['paper'] - - A string that matches one of the following regular expressions: - ['^y([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - Any - """ - return self['yref'] - - @yref.setter - def yref(self, val): - self['yref'] = val - - # yshift - # ------ - @property - 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 - - Returns - ------- - int|float - """ - return self['yshift'] - - @yshift.setter - def yshift(self, val): - self['yshift'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - align - Sets the horizontal alignment of the `text` within the - box. Has an effect only if `text` spans more two or - more lines (i.e. `text` contains one or more
HTML - tags) or if an explicit width is set to override the - text width. - arrowcolor - Sets the color of the annotation arrow. - arrowhead - Sets the end annotation arrow head style. - arrowside - Sets the annotation arrow head position. - arrowsize - Sets the size of the end annotation arrow head, - relative to `arrowwidth`. A value of 1 (default) gives - a head about 3x as wide as the line. - arrowwidth - Sets the width (in px) of annotation arrow line. - ax - Sets the x component of the arrow tail about the arrow - head. If `axref` is `pixel`, a positive (negative) - component corresponds to an arrow pointing from right - to left (left to right). If `axref` is an axis, this is - an absolute value on that axis, like `x`, NOT a - relative value. - axref - Indicates in what terms the tail of the annotation - (ax,ay) is specified. If `pixel`, `ax` is a relative - offset in pixels from `x`. If set to an x axis id - (e.g. "x" or "x2"), `ax` is specified in the same - terms as that axis. This is useful for trendline - annotations which should continue to indicate the - correct trend when zoomed. - ay - Sets the y component of the arrow tail about the arrow - head. If `ayref` is `pixel`, a positive (negative) - component corresponds to an arrow pointing from bottom - to top (top to bottom). If `ayref` is an axis, this is - an absolute value on that axis, like `y`, NOT a - relative value. - ayref - Indicates in what terms the tail of the annotation - (ax,ay) is specified. If `pixel`, `ay` is a relative - offset in pixels from `y`. If set to a y axis id (e.g. - "y" or "y2"), `ay` is specified in the same terms as - that axis. This is useful for trendline annotations - which should continue to indicate the correct trend - when zoomed. - bgcolor - Sets the background color of the annotation. - bordercolor - Sets the color of the border enclosing the annotation - `text`. - borderpad - Sets the padding (in px) between the `text` and the - enclosing border. - borderwidth - Sets the width (in px) of the border enclosing the - annotation `text`. - captureevents - Determines whether the annotation text box captures - mouse move and click events, or allows those events to - pass through to data points in the plot that may be - behind the annotation. By default `captureevents` is - False unless `hovertext` is provided. If you use the - event `plotly_clickannotation` without `hovertext` you - must explicitly enable `captureevents`. - clicktoshow - Makes this annotation respond to clicks on the plot. If - you click a data point that exactly matches the `x` and - `y` values of this annotation, and it is hidden - (visible: false), it will appear. In "onoff" mode, you - must click the same point again to make it disappear, - so if you click multiple points, you can show multiple - annotations. In "onout" mode, a click anywhere else in - the plot (on another data point or not) will hide this - annotation. If you need to show/hide this annotation in - response to different `x` or `y` values, you can set - `xclick` and/or `yclick`. This is useful for example to - label the side of a bar. To label markers though, - `standoff` is preferred over `xclick` and `yclick`. - font - Sets the annotation text font. - height - Sets an explicit height for the text box. null - (default) lets the text set the box height. Taller text - will be clipped. - hoverlabel - plotly.graph_objs.layout.annotation.Hoverlabel instance - or dict with compatible properties - hovertext - Sets text to appear when hovering over this annotation. - If omitted or blank, no hover label will appear. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - opacity - Sets the opacity of the annotation (text + arrow). - showarrow - Determines whether or not the annotation is drawn with - an arrow. If True, `text` is placed near the arrow's - tail. If False, `text` lines up with the `x` and `y` - provided. - standoff - Sets a distance, in pixels, to move the end arrowhead - away from the position it is pointing at, for example - to point at the edge of a marker independent of zoom. - Note that this shortens the arrow from the `ax` / `ay` - vector, in contrast to `xshift` / `yshift` which moves - everything by this amount. - startarrowhead - Sets the start annotation arrow head style. - startarrowsize - Sets the size of the start annotation arrow head, - relative to `arrowwidth`. A value of 1 (default) gives - a head about 3x as wide as the line. - startstandoff - Sets a distance, in pixels, to move the start arrowhead - away from the position it is pointing at, for example - to point at the edge of a marker independent of zoom. - Note that this shortens the arrow from the `ax` / `ay` - vector, in contrast to `xshift` / `yshift` which moves - everything by this amount. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - text - Sets the text associated with this annotation. Plotly - uses a subset of HTML tags to do things like newline - (
), bold (), italics (), hyperlinks - (). Tags , , - are also supported. - textangle - Sets the angle at which the `text` is drawn with - respect to the horizontal. - valign - Sets the vertical alignment of the `text` within the - box. Has an effect only if an explicit height is set to - override the text height. - visible - Determines whether or not this annotation is visible. - width - Sets an explicit width for the text box. null (default) - lets the text set the box width. Wider text will be - clipped. There is no automatic wrapping; use
to - start a new line. - x - Sets the annotation's x position. If the axis `type` is - "log", then you must take the log of your desired - range. If the axis `type` is "date", it should be date - strings, like date data, though Date objects and unix - milliseconds will be accepted and converted to strings. - If the axis `type` is "category", it should be numbers, - using the scale where each category is assigned a - serial number from zero in the order it appears. - xanchor - Sets the text box's horizontal position anchor This - anchor binds the `x` position to the "left", "center" - or "right" of the annotation. For example, if `x` is - set to 1, `xref` to "paper" and `xanchor` to "right" - then the right-most portion of the annotation lines up - with the right-most edge of the plotting area. If - "auto", the anchor is equivalent to "center" for data- - referenced annotations or if there is an arrow, whereas - for paper-referenced with no arrow, the anchor picked - corresponds to the closest side. - xclick - Toggle this annotation when clicking a data point whose - `x` value is `xclick` rather than the annotation's `x` - value. - xref - Sets the annotation's x coordinate axis. If set to an x - axis id (e.g. "x" or "x2"), the `x` position refers to - an x coordinate If set to "paper", the `x` position - refers to the distance from the left side of the - plotting area in normalized coordinates where 0 (1) - corresponds to the left (right) side. - xshift - Shifts the position of the whole annotation and arrow - to the right (positive) or left (negative) by this many - pixels. - y - Sets the annotation's y position. If the axis `type` is - "log", then you must take the log of your desired - range. If the axis `type` is "date", it should be date - strings, like date data, though Date objects and unix - milliseconds will be accepted and converted to strings. - If the axis `type` is "category", it should be numbers, - using the scale where each category is assigned a - serial number from zero in the order it appears. - yanchor - Sets the text box's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the annotation. For example, if `y` is set - to 1, `yref` to "paper" and `yanchor` to "top" then the - top-most portion of the annotation lines up with the - top-most edge of the plotting area. If "auto", the - anchor is equivalent to "middle" for data-referenced - annotations or if there is an arrow, whereas for paper- - referenced with no arrow, the anchor picked corresponds - to the closest side. - yclick - Toggle this annotation when clicking a data point whose - `y` value is `yclick` rather than the annotation's `y` - value. - yref - Sets the annotation's y coordinate axis. If set to an y - axis id (e.g. "y" or "y2"), the `y` position refers to - an y coordinate If set to "paper", the `y` position - refers to the distance from the bottom of the plotting - area in normalized coordinates where 0 (1) corresponds - to the bottom (top). - yshift - Shifts the position of the whole annotation and arrow - up (positive) or down (negative) by this many pixels. - """ - - def __init__( - self, - arg=None, - align=None, - arrowcolor=None, - arrowhead=None, - arrowside=None, - arrowsize=None, - arrowwidth=None, - ax=None, - axref=None, - ay=None, - ayref=None, - bgcolor=None, - bordercolor=None, - borderpad=None, - borderwidth=None, - captureevents=None, - clicktoshow=None, - font=None, - height=None, - hoverlabel=None, - hovertext=None, - name=None, - opacity=None, - showarrow=None, - standoff=None, - startarrowhead=None, - startarrowsize=None, - startstandoff=None, - templateitemname=None, - text=None, - textangle=None, - valign=None, - visible=None, - width=None, - x=None, - xanchor=None, - xclick=None, - xref=None, - xshift=None, - y=None, - yanchor=None, - yclick=None, - yref=None, - yshift=None, - **kwargs - ): - """ - Construct a new Annotation object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Annotation - align - Sets the horizontal alignment of the `text` within the - box. Has an effect only if `text` spans more two or - more lines (i.e. `text` contains one or more
HTML - tags) or if an explicit width is set to override the - text width. - arrowcolor - Sets the color of the annotation arrow. - arrowhead - Sets the end annotation arrow head style. - arrowside - Sets the annotation arrow head position. - arrowsize - Sets the size of the end annotation arrow head, - relative to `arrowwidth`. A value of 1 (default) gives - a head about 3x as wide as the line. - arrowwidth - Sets the width (in px) of annotation arrow line. - ax - Sets the x component of the arrow tail about the arrow - head. If `axref` is `pixel`, a positive (negative) - component corresponds to an arrow pointing from right - to left (left to right). If `axref` is an axis, this is - an absolute value on that axis, like `x`, NOT a - relative value. - axref - Indicates in what terms the tail of the annotation - (ax,ay) is specified. If `pixel`, `ax` is a relative - offset in pixels from `x`. If set to an x axis id - (e.g. "x" or "x2"), `ax` is specified in the same - terms as that axis. This is useful for trendline - annotations which should continue to indicate the - correct trend when zoomed. - ay - Sets the y component of the arrow tail about the arrow - head. If `ayref` is `pixel`, a positive (negative) - component corresponds to an arrow pointing from bottom - to top (top to bottom). If `ayref` is an axis, this is - an absolute value on that axis, like `y`, NOT a - relative value. - ayref - Indicates in what terms the tail of the annotation - (ax,ay) is specified. If `pixel`, `ay` is a relative - offset in pixels from `y`. If set to a y axis id (e.g. - "y" or "y2"), `ay` is specified in the same terms as - that axis. This is useful for trendline annotations - which should continue to indicate the correct trend - when zoomed. - bgcolor - Sets the background color of the annotation. - bordercolor - Sets the color of the border enclosing the annotation - `text`. - borderpad - Sets the padding (in px) between the `text` and the - enclosing border. - borderwidth - Sets the width (in px) of the border enclosing the - annotation `text`. - captureevents - Determines whether the annotation text box captures - mouse move and click events, or allows those events to - pass through to data points in the plot that may be - behind the annotation. By default `captureevents` is - False unless `hovertext` is provided. If you use the - event `plotly_clickannotation` without `hovertext` you - must explicitly enable `captureevents`. - clicktoshow - Makes this annotation respond to clicks on the plot. If - you click a data point that exactly matches the `x` and - `y` values of this annotation, and it is hidden - (visible: false), it will appear. In "onoff" mode, you - must click the same point again to make it disappear, - so if you click multiple points, you can show multiple - annotations. In "onout" mode, a click anywhere else in - the plot (on another data point or not) will hide this - annotation. If you need to show/hide this annotation in - response to different `x` or `y` values, you can set - `xclick` and/or `yclick`. This is useful for example to - label the side of a bar. To label markers though, - `standoff` is preferred over `xclick` and `yclick`. - font - Sets the annotation text font. - height - Sets an explicit height for the text box. null - (default) lets the text set the box height. Taller text - will be clipped. - hoverlabel - plotly.graph_objs.layout.annotation.Hoverlabel instance - or dict with compatible properties - hovertext - Sets text to appear when hovering over this annotation. - If omitted or blank, no hover label will appear. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - opacity - Sets the opacity of the annotation (text + arrow). - showarrow - Determines whether or not the annotation is drawn with - an arrow. If True, `text` is placed near the arrow's - tail. If False, `text` lines up with the `x` and `y` - provided. - standoff - Sets a distance, in pixels, to move the end arrowhead - away from the position it is pointing at, for example - to point at the edge of a marker independent of zoom. - Note that this shortens the arrow from the `ax` / `ay` - vector, in contrast to `xshift` / `yshift` which moves - everything by this amount. - startarrowhead - Sets the start annotation arrow head style. - startarrowsize - Sets the size of the start annotation arrow head, - relative to `arrowwidth`. A value of 1 (default) gives - a head about 3x as wide as the line. - startstandoff - Sets a distance, in pixels, to move the start arrowhead - away from the position it is pointing at, for example - to point at the edge of a marker independent of zoom. - Note that this shortens the arrow from the `ax` / `ay` - vector, in contrast to `xshift` / `yshift` which moves - everything by this amount. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - text - Sets the text associated with this annotation. Plotly - uses a subset of HTML tags to do things like newline - (
), bold (), italics (), hyperlinks - (). Tags , , - are also supported. - textangle - Sets the angle at which the `text` is drawn with - respect to the horizontal. - valign - Sets the vertical alignment of the `text` within the - box. Has an effect only if an explicit height is set to - override the text height. - visible - Determines whether or not this annotation is visible. - width - Sets an explicit width for the text box. null (default) - lets the text set the box width. Wider text will be - clipped. There is no automatic wrapping; use
to - start a new line. - x - Sets the annotation's x position. If the axis `type` is - "log", then you must take the log of your desired - range. If the axis `type` is "date", it should be date - strings, like date data, though Date objects and unix - milliseconds will be accepted and converted to strings. - If the axis `type` is "category", it should be numbers, - using the scale where each category is assigned a - serial number from zero in the order it appears. - xanchor - Sets the text box's horizontal position anchor This - anchor binds the `x` position to the "left", "center" - or "right" of the annotation. For example, if `x` is - set to 1, `xref` to "paper" and `xanchor` to "right" - then the right-most portion of the annotation lines up - with the right-most edge of the plotting area. If - "auto", the anchor is equivalent to "center" for data- - referenced annotations or if there is an arrow, whereas - for paper-referenced with no arrow, the anchor picked - corresponds to the closest side. - xclick - Toggle this annotation when clicking a data point whose - `x` value is `xclick` rather than the annotation's `x` - value. - xref - Sets the annotation's x coordinate axis. If set to an x - axis id (e.g. "x" or "x2"), the `x` position refers to - an x coordinate If set to "paper", the `x` position - refers to the distance from the left side of the - plotting area in normalized coordinates where 0 (1) - corresponds to the left (right) side. - xshift - Shifts the position of the whole annotation and arrow - to the right (positive) or left (negative) by this many - pixels. - y - Sets the annotation's y position. If the axis `type` is - "log", then you must take the log of your desired - range. If the axis `type` is "date", it should be date - strings, like date data, though Date objects and unix - milliseconds will be accepted and converted to strings. - If the axis `type` is "category", it should be numbers, - using the scale where each category is assigned a - serial number from zero in the order it appears. - yanchor - Sets the text box's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the annotation. For example, if `y` is set - to 1, `yref` to "paper" and `yanchor` to "top" then the - top-most portion of the annotation lines up with the - top-most edge of the plotting area. If "auto", the - anchor is equivalent to "middle" for data-referenced - annotations or if there is an arrow, whereas for paper- - referenced with no arrow, the anchor picked corresponds - to the closest side. - yclick - Toggle this annotation when clicking a data point whose - `y` value is `yclick` rather than the annotation's `y` - value. - yref - Sets the annotation's y coordinate axis. If set to an y - axis id (e.g. "y" or "y2"), the `y` position refers to - an y coordinate If set to "paper", the `y` position - refers to the distance from the bottom of the plotting - area in normalized coordinates where 0 (1) corresponds - to the bottom (top). - yshift - Shifts the position of the whole annotation and arrow - up (positive) or down (negative) by this many pixels. - - Returns - ------- - Annotation - """ - super(Annotation, self).__init__('annotations') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Annotation -constructor must be a dict or -an instance of plotly.graph_objs.layout.Annotation""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (annotation as v_annotation) - - # Initialize validators - # --------------------- - self._validators['align'] = v_annotation.AlignValidator() - self._validators['arrowcolor'] = v_annotation.ArrowcolorValidator() - self._validators['arrowhead'] = v_annotation.ArrowheadValidator() - self._validators['arrowside'] = v_annotation.ArrowsideValidator() - self._validators['arrowsize'] = v_annotation.ArrowsizeValidator() - self._validators['arrowwidth'] = v_annotation.ArrowwidthValidator() - self._validators['ax'] = v_annotation.AxValidator() - self._validators['axref'] = v_annotation.AxrefValidator() - self._validators['ay'] = v_annotation.AyValidator() - self._validators['ayref'] = v_annotation.AyrefValidator() - self._validators['bgcolor'] = v_annotation.BgcolorValidator() - self._validators['bordercolor'] = v_annotation.BordercolorValidator() - self._validators['borderpad'] = v_annotation.BorderpadValidator() - self._validators['borderwidth'] = v_annotation.BorderwidthValidator() - self._validators['captureevents' - ] = v_annotation.CaptureeventsValidator() - self._validators['clicktoshow'] = v_annotation.ClicktoshowValidator() - self._validators['font'] = v_annotation.FontValidator() - self._validators['height'] = v_annotation.HeightValidator() - self._validators['hoverlabel'] = v_annotation.HoverlabelValidator() - self._validators['hovertext'] = v_annotation.HovertextValidator() - self._validators['name'] = v_annotation.NameValidator() - self._validators['opacity'] = v_annotation.OpacityValidator() - self._validators['showarrow'] = v_annotation.ShowarrowValidator() - self._validators['standoff'] = v_annotation.StandoffValidator() - self._validators['startarrowhead' - ] = v_annotation.StartarrowheadValidator() - self._validators['startarrowsize' - ] = v_annotation.StartarrowsizeValidator() - self._validators['startstandoff' - ] = v_annotation.StartstandoffValidator() - self._validators['templateitemname' - ] = v_annotation.TemplateitemnameValidator() - self._validators['text'] = v_annotation.TextValidator() - self._validators['textangle'] = v_annotation.TextangleValidator() - self._validators['valign'] = v_annotation.ValignValidator() - self._validators['visible'] = v_annotation.VisibleValidator() - self._validators['width'] = v_annotation.WidthValidator() - self._validators['x'] = v_annotation.XValidator() - self._validators['xanchor'] = v_annotation.XanchorValidator() - self._validators['xclick'] = v_annotation.XclickValidator() - self._validators['xref'] = v_annotation.XrefValidator() - self._validators['xshift'] = v_annotation.XshiftValidator() - self._validators['y'] = v_annotation.YValidator() - self._validators['yanchor'] = v_annotation.YanchorValidator() - self._validators['yclick'] = v_annotation.YclickValidator() - self._validators['yref'] = v_annotation.YrefValidator() - self._validators['yshift'] = v_annotation.YshiftValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('align', None) - self['align'] = align if align is not None else _v - _v = arg.pop('arrowcolor', None) - self['arrowcolor'] = arrowcolor if arrowcolor is not None else _v - _v = arg.pop('arrowhead', None) - self['arrowhead'] = arrowhead if arrowhead is not None else _v - _v = arg.pop('arrowside', None) - self['arrowside'] = arrowside if arrowside is not None else _v - _v = arg.pop('arrowsize', None) - self['arrowsize'] = arrowsize if arrowsize is not None else _v - _v = arg.pop('arrowwidth', None) - self['arrowwidth'] = arrowwidth if arrowwidth is not None else _v - _v = arg.pop('ax', None) - self['ax'] = ax if ax is not None else _v - _v = arg.pop('axref', None) - self['axref'] = axref if axref is not None else _v - _v = arg.pop('ay', None) - self['ay'] = ay if ay is not None else _v - _v = arg.pop('ayref', None) - self['ayref'] = ayref if ayref is not None else _v - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderpad', None) - self['borderpad'] = borderpad if borderpad is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('captureevents', None) - self['captureevents' - ] = captureevents if captureevents is not None else _v - _v = arg.pop('clicktoshow', None) - self['clicktoshow'] = clicktoshow if clicktoshow is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('height', None) - self['height'] = height if height is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('showarrow', None) - self['showarrow'] = showarrow if showarrow is not None else _v - _v = arg.pop('standoff', None) - self['standoff'] = standoff if standoff is not None else _v - _v = arg.pop('startarrowhead', None) - self['startarrowhead' - ] = startarrowhead if startarrowhead is not None else _v - _v = arg.pop('startarrowsize', None) - self['startarrowsize' - ] = startarrowsize if startarrowsize is not None else _v - _v = arg.pop('startstandoff', None) - self['startstandoff' - ] = startstandoff if startstandoff is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textangle', None) - self['textangle'] = textangle if textangle is not None else _v - _v = arg.pop('valign', None) - self['valign'] = valign if valign is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xclick', None) - self['xclick'] = xclick if xclick is not None else _v - _v = arg.pop('xref', None) - self['xref'] = xref if xref is not None else _v - _v = arg.pop('xshift', None) - self['xshift'] = xshift if xshift is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('yclick', None) - self['yclick'] = yclick if yclick is not None else _v - _v = arg.pop('yref', None) - self['yref'] = yref if yref is not None else _v - _v = arg.pop('yshift', None) - self['yshift'] = yshift if yshift is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_colorscale.py b/plotly/graph_objs/layout/_colorscale.py deleted file mode 100644 index 28132898718..00000000000 --- a/plotly/graph_objs/layout/_colorscale.py +++ /dev/null @@ -1,203 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Colorscale(BaseLayoutHierarchyType): - - # diverging - # --------- - @property - 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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['diverging'] - - @diverging.setter - def diverging(self, val): - self['diverging'] = val - - # sequential - # ---------- - @property - 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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['sequential'] - - @sequential.setter - def sequential(self, val): - self['sequential'] = val - - # sequentialminus - # --------------- - @property - 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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['sequentialminus'] - - @sequentialminus.setter - def sequentialminus(self, val): - self['sequentialminus'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - diverging - Sets the default diverging colorscale. Note that - `autocolorscale` must be true for this attribute to - work. - sequential - Sets the default sequential colorscale for positive - values. Note that `autocolorscale` must be true for - this attribute to work. - sequentialminus - Sets the default sequential colorscale for negative - values. Note that `autocolorscale` must be true for - this attribute to work. - """ - - def __init__( - self, - arg=None, - diverging=None, - sequential=None, - sequentialminus=None, - **kwargs - ): - """ - Construct a new Colorscale object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Colorscale - diverging - Sets the default diverging colorscale. Note that - `autocolorscale` must be true for this attribute to - work. - sequential - Sets the default sequential colorscale for positive - values. Note that `autocolorscale` must be true for - this attribute to work. - sequentialminus - Sets the default sequential colorscale for negative - values. Note that `autocolorscale` must be true for - this attribute to work. - - Returns - ------- - Colorscale - """ - super(Colorscale, self).__init__('colorscale') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Colorscale -constructor must be a dict or -an instance of plotly.graph_objs.layout.Colorscale""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (colorscale as v_colorscale) - - # Initialize validators - # --------------------- - self._validators['diverging'] = v_colorscale.DivergingValidator() - self._validators['sequential'] = v_colorscale.SequentialValidator() - self._validators['sequentialminus' - ] = v_colorscale.SequentialminusValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('diverging', None) - self['diverging'] = diverging if diverging is not None else _v - _v = arg.pop('sequential', None) - self['sequential'] = sequential if sequential is not None else _v - _v = arg.pop('sequentialminus', None) - self['sequentialminus' - ] = sequentialminus if sequentialminus is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_font.py b/plotly/graph_objs/layout/_font.py deleted file mode 100644 index f829f86e06e..00000000000 --- a/plotly/graph_objs/layout/_font.py +++ /dev/null @@ -1,226 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_geo.py b/plotly/graph_objs/layout/_geo.py deleted file mode 100644 index e0706650357..00000000000 --- a/plotly/graph_objs/layout/_geo.py +++ /dev/null @@ -1,1401 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Geo(BaseLayoutHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # center - # ------ - @property - def center(self): - """ - The 'center' property is an instance of Center - that may be specified as: - - An instance of 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 - lies at the middle of the latitude range by - default. - lon - Sets the longitude of the map's center. By - default, the map's longitude center lies at the - middle of the longitude range for scoped - projection and above `projection.rotation.lon` - otherwise. - - Returns - ------- - plotly.graph_objs.layout.geo.Center - """ - return self['center'] - - @center.setter - def center(self, val): - self['center'] = val - - # coastlinecolor - # -------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['coastlinecolor'] - - @coastlinecolor.setter - def coastlinecolor(self, val): - self['coastlinecolor'] = val - - # coastlinewidth - # -------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['coastlinewidth'] - - @coastlinewidth.setter - def coastlinewidth(self, val): - self['coastlinewidth'] = val - - # countrycolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['countrycolor'] - - @countrycolor.setter - def countrycolor(self, val): - self['countrycolor'] = val - - # countrywidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['countrywidth'] - - @countrywidth.setter - def countrywidth(self, val): - self['countrywidth'] = val - - # domain - # ------ - @property - def domain(self): - """ - The 'domain' property is an instance of Domain - that may be specified as: - - An instance of 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 . - 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. - row - If there is a layout grid, use the domain for - this row in the grid for this geo subplot . - 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. - x - 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. - y - 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 - ------- - plotly.graph_objs.layout.geo.Domain - """ - return self['domain'] - - @domain.setter - def domain(self, val): - self['domain'] = val - - # framecolor - # ---------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['framecolor'] - - @framecolor.setter - def framecolor(self, val): - self['framecolor'] = val - - # framewidth - # ---------- - @property - 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] - - Returns - ------- - int|float - """ - return self['framewidth'] - - @framewidth.setter - def framewidth(self, val): - self['framewidth'] = val - - # lakecolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['lakecolor'] - - @lakecolor.setter - def lakecolor(self, val): - self['lakecolor'] = val - - # landcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['landcolor'] - - @landcolor.setter - def landcolor(self, val): - self['landcolor'] = val - - # lataxis - # ------- - @property - def lataxis(self): - """ - The 'lataxis' property is an instance of Lataxis - that may be specified as: - - An instance of 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. - gridcolor - Sets the graticule's stroke color. - gridwidth - Sets the graticule's stroke width (in px). - range - Sets the range of this axis (in degrees), sets - the map's clipped coordinates. - showgrid - Sets whether or not graticule are shown on the - map. - tick0 - Sets the graticule's starting tick - longitude/latitude. - - Returns - ------- - plotly.graph_objs.layout.geo.Lataxis - """ - return self['lataxis'] - - @lataxis.setter - def lataxis(self, val): - self['lataxis'] = val - - # lonaxis - # ------- - @property - def lonaxis(self): - """ - The 'lonaxis' property is an instance of Lonaxis - that may be specified as: - - An instance of 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. - gridcolor - Sets the graticule's stroke color. - gridwidth - Sets the graticule's stroke width (in px). - range - Sets the range of this axis (in degrees), sets - the map's clipped coordinates. - showgrid - Sets whether or not graticule are shown on the - map. - tick0 - Sets the graticule's starting tick - longitude/latitude. - - Returns - ------- - plotly.graph_objs.layout.geo.Lonaxis - """ - return self['lonaxis'] - - @lonaxis.setter - def lonaxis(self, val): - self['lonaxis'] = val - - # oceancolor - # ---------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['oceancolor'] - - @oceancolor.setter - def oceancolor(self, val): - self['oceancolor'] = val - - # projection - # ---------- - @property - def projection(self): - """ - The 'projection' property is an instance of Projection - that may be specified as: - - An instance of 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 - intersects the sphere. - rotation - plotly.graph_objs.layout.geo.projection.Rotatio - n instance or dict with compatible properties - scale - 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. - type - Sets the projection type. - - Returns - ------- - plotly.graph_objs.layout.geo.Projection - """ - return self['projection'] - - @projection.setter - def projection(self, val): - self['projection'] = val - - # resolution - # ---------- - @property - 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] - - Returns - ------- - Any - """ - return self['resolution'] - - @resolution.setter - def resolution(self, val): - self['resolution'] = val - - # rivercolor - # ---------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['rivercolor'] - - @rivercolor.setter - def rivercolor(self, val): - self['rivercolor'] = val - - # riverwidth - # ---------- - @property - 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] - - Returns - ------- - int|float - """ - return self['riverwidth'] - - @riverwidth.setter - def riverwidth(self, val): - self['riverwidth'] = val - - # scope - # ----- - @property - 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 - america', 'south america'] - - Returns - ------- - Any - """ - return self['scope'] - - @scope.setter - def scope(self, val): - self['scope'] = val - - # showcoastlines - # -------------- - @property - def showcoastlines(self): - """ - Sets whether or not the coastlines are drawn. - - The 'showcoastlines' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['showcoastlines'] - - @showcoastlines.setter - def showcoastlines(self, val): - self['showcoastlines'] = val - - # showcountries - # ------------- - @property - def showcountries(self): - """ - Sets whether or not country boundaries are drawn. - - The 'showcountries' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['showcountries'] - - @showcountries.setter - def showcountries(self, val): - self['showcountries'] = val - - # showframe - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showframe'] - - @showframe.setter - def showframe(self, val): - self['showframe'] = val - - # showlakes - # --------- - @property - def showlakes(self): - """ - Sets whether or not lakes are drawn. - - The 'showlakes' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['showlakes'] - - @showlakes.setter - def showlakes(self, val): - self['showlakes'] = val - - # showland - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showland'] - - @showland.setter - def showland(self, val): - self['showland'] = val - - # showocean - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showocean'] - - @showocean.setter - def showocean(self, val): - self['showocean'] = val - - # showrivers - # ---------- - @property - def showrivers(self): - """ - Sets whether or not rivers are drawn. - - The 'showrivers' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['showrivers'] - - @showrivers.setter - def showrivers(self, val): - self['showrivers'] = val - - # showsubunits - # ------------ - @property - 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) - - Returns - ------- - bool - """ - return self['showsubunits'] - - @showsubunits.setter - def showsubunits(self, val): - self['showsubunits'] = val - - # subunitcolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['subunitcolor'] - - @subunitcolor.setter - def subunitcolor(self, val): - self['subunitcolor'] = val - - # subunitwidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['subunitwidth'] - - @subunitwidth.setter - def subunitwidth(self, val): - self['subunitwidth'] = val - - # uirevision - # ---------- - @property - 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 - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Set the background color of the map - center - plotly.graph_objs.layout.geo.Center instance or dict - with compatible properties - coastlinecolor - Sets the coastline color. - coastlinewidth - Sets the coastline stroke width (in px). - countrycolor - Sets line color of the country boundaries. - countrywidth - Sets line width (in px) of the country boundaries. - domain - plotly.graph_objs.layout.geo.Domain instance or dict - with compatible properties - framecolor - Sets the color the frame. - framewidth - Sets the stroke width (in px) of the frame. - lakecolor - Sets the color of the lakes. - landcolor - Sets the land mass color. - lataxis - plotly.graph_objs.layout.geo.Lataxis instance or dict - with compatible properties - lonaxis - plotly.graph_objs.layout.geo.Lonaxis instance or dict - with compatible properties - oceancolor - Sets the ocean color - projection - plotly.graph_objs.layout.geo.Projection instance or - dict with compatible properties - resolution - Sets the resolution of the base layers. The values have - units of km/mm e.g. 110 corresponds to a scale ratio of - 1:110,000,000. - rivercolor - Sets color of the rivers. - riverwidth - Sets the stroke width (in px) of the rivers. - scope - Set the scope of the map. - showcoastlines - Sets whether or not the coastlines are drawn. - showcountries - Sets whether or not country boundaries are drawn. - showframe - Sets whether or not a frame is drawn around the map. - showlakes - Sets whether or not lakes are drawn. - showland - Sets whether or not land masses are filled in color. - showocean - Sets whether or not oceans are filled in color. - showrivers - Sets whether or not rivers are drawn. - showsubunits - Sets whether or not boundaries of subunits within - countries (e.g. states, provinces) are drawn. - subunitcolor - Sets the color of the subunits boundaries. - subunitwidth - Sets the stroke width (in px) of the subunits - boundaries. - uirevision - Controls persistence of user-driven changes in the view - (projection and center). Defaults to - `layout.uirevision`. - """ - - def __init__( - self, - arg=None, - bgcolor=None, - center=None, - coastlinecolor=None, - coastlinewidth=None, - countrycolor=None, - countrywidth=None, - domain=None, - framecolor=None, - framewidth=None, - lakecolor=None, - landcolor=None, - lataxis=None, - lonaxis=None, - oceancolor=None, - projection=None, - resolution=None, - rivercolor=None, - riverwidth=None, - scope=None, - showcoastlines=None, - showcountries=None, - showframe=None, - showlakes=None, - showland=None, - showocean=None, - showrivers=None, - showsubunits=None, - subunitcolor=None, - subunitwidth=None, - uirevision=None, - **kwargs - ): - """ - Construct a new Geo object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Geo - bgcolor - Set the background color of the map - center - plotly.graph_objs.layout.geo.Center instance or dict - with compatible properties - coastlinecolor - Sets the coastline color. - coastlinewidth - Sets the coastline stroke width (in px). - countrycolor - Sets line color of the country boundaries. - countrywidth - Sets line width (in px) of the country boundaries. - domain - plotly.graph_objs.layout.geo.Domain instance or dict - with compatible properties - framecolor - Sets the color the frame. - framewidth - Sets the stroke width (in px) of the frame. - lakecolor - Sets the color of the lakes. - landcolor - Sets the land mass color. - lataxis - plotly.graph_objs.layout.geo.Lataxis instance or dict - with compatible properties - lonaxis - plotly.graph_objs.layout.geo.Lonaxis instance or dict - with compatible properties - oceancolor - Sets the ocean color - projection - plotly.graph_objs.layout.geo.Projection instance or - dict with compatible properties - resolution - Sets the resolution of the base layers. The values have - units of km/mm e.g. 110 corresponds to a scale ratio of - 1:110,000,000. - rivercolor - Sets color of the rivers. - riverwidth - Sets the stroke width (in px) of the rivers. - scope - Set the scope of the map. - showcoastlines - Sets whether or not the coastlines are drawn. - showcountries - Sets whether or not country boundaries are drawn. - showframe - Sets whether or not a frame is drawn around the map. - showlakes - Sets whether or not lakes are drawn. - showland - Sets whether or not land masses are filled in color. - showocean - Sets whether or not oceans are filled in color. - showrivers - Sets whether or not rivers are drawn. - showsubunits - Sets whether or not boundaries of subunits within - countries (e.g. states, provinces) are drawn. - subunitcolor - Sets the color of the subunits boundaries. - subunitwidth - Sets the stroke width (in px) of the subunits - boundaries. - uirevision - Controls persistence of user-driven changes in the view - (projection and center). Defaults to - `layout.uirevision`. - - Returns - ------- - Geo - """ - super(Geo, self).__init__('geo') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Geo -constructor must be a dict or -an instance of plotly.graph_objs.layout.Geo""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (geo as v_geo) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_geo.BgcolorValidator() - self._validators['center'] = v_geo.CenterValidator() - self._validators['coastlinecolor'] = v_geo.CoastlinecolorValidator() - self._validators['coastlinewidth'] = v_geo.CoastlinewidthValidator() - self._validators['countrycolor'] = v_geo.CountrycolorValidator() - self._validators['countrywidth'] = v_geo.CountrywidthValidator() - self._validators['domain'] = v_geo.DomainValidator() - self._validators['framecolor'] = v_geo.FramecolorValidator() - self._validators['framewidth'] = v_geo.FramewidthValidator() - self._validators['lakecolor'] = v_geo.LakecolorValidator() - self._validators['landcolor'] = v_geo.LandcolorValidator() - self._validators['lataxis'] = v_geo.LataxisValidator() - self._validators['lonaxis'] = v_geo.LonaxisValidator() - self._validators['oceancolor'] = v_geo.OceancolorValidator() - self._validators['projection'] = v_geo.ProjectionValidator() - self._validators['resolution'] = v_geo.ResolutionValidator() - self._validators['rivercolor'] = v_geo.RivercolorValidator() - self._validators['riverwidth'] = v_geo.RiverwidthValidator() - self._validators['scope'] = v_geo.ScopeValidator() - self._validators['showcoastlines'] = v_geo.ShowcoastlinesValidator() - self._validators['showcountries'] = v_geo.ShowcountriesValidator() - self._validators['showframe'] = v_geo.ShowframeValidator() - self._validators['showlakes'] = v_geo.ShowlakesValidator() - self._validators['showland'] = v_geo.ShowlandValidator() - self._validators['showocean'] = v_geo.ShowoceanValidator() - self._validators['showrivers'] = v_geo.ShowriversValidator() - self._validators['showsubunits'] = v_geo.ShowsubunitsValidator() - self._validators['subunitcolor'] = v_geo.SubunitcolorValidator() - self._validators['subunitwidth'] = v_geo.SubunitwidthValidator() - self._validators['uirevision'] = v_geo.UirevisionValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('center', None) - self['center'] = center if center is not None else _v - _v = arg.pop('coastlinecolor', None) - self['coastlinecolor' - ] = coastlinecolor if coastlinecolor is not None else _v - _v = arg.pop('coastlinewidth', None) - self['coastlinewidth' - ] = coastlinewidth if coastlinewidth is not None else _v - _v = arg.pop('countrycolor', None) - self['countrycolor'] = countrycolor if countrycolor is not None else _v - _v = arg.pop('countrywidth', None) - self['countrywidth'] = countrywidth if countrywidth is not None else _v - _v = arg.pop('domain', None) - self['domain'] = domain if domain is not None else _v - _v = arg.pop('framecolor', None) - self['framecolor'] = framecolor if framecolor is not None else _v - _v = arg.pop('framewidth', None) - self['framewidth'] = framewidth if framewidth is not None else _v - _v = arg.pop('lakecolor', None) - self['lakecolor'] = lakecolor if lakecolor is not None else _v - _v = arg.pop('landcolor', None) - self['landcolor'] = landcolor if landcolor is not None else _v - _v = arg.pop('lataxis', None) - self['lataxis'] = lataxis if lataxis is not None else _v - _v = arg.pop('lonaxis', None) - self['lonaxis'] = lonaxis if lonaxis is not None else _v - _v = arg.pop('oceancolor', None) - self['oceancolor'] = oceancolor if oceancolor is not None else _v - _v = arg.pop('projection', None) - self['projection'] = projection if projection is not None else _v - _v = arg.pop('resolution', None) - self['resolution'] = resolution if resolution is not None else _v - _v = arg.pop('rivercolor', None) - self['rivercolor'] = rivercolor if rivercolor is not None else _v - _v = arg.pop('riverwidth', None) - self['riverwidth'] = riverwidth if riverwidth is not None else _v - _v = arg.pop('scope', None) - self['scope'] = scope if scope is not None else _v - _v = arg.pop('showcoastlines', None) - self['showcoastlines' - ] = showcoastlines if showcoastlines is not None else _v - _v = arg.pop('showcountries', None) - self['showcountries' - ] = showcountries if showcountries is not None else _v - _v = arg.pop('showframe', None) - self['showframe'] = showframe if showframe is not None else _v - _v = arg.pop('showlakes', None) - self['showlakes'] = showlakes if showlakes is not None else _v - _v = arg.pop('showland', None) - self['showland'] = showland if showland is not None else _v - _v = arg.pop('showocean', None) - self['showocean'] = showocean if showocean is not None else _v - _v = arg.pop('showrivers', None) - self['showrivers'] = showrivers if showrivers is not None else _v - _v = arg.pop('showsubunits', None) - self['showsubunits'] = showsubunits if showsubunits is not None else _v - _v = arg.pop('subunitcolor', None) - self['subunitcolor'] = subunitcolor if subunitcolor is not None else _v - _v = arg.pop('subunitwidth', None) - self['subunitwidth'] = subunitwidth if subunitwidth is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_grid.py b/plotly/graph_objs/layout/_grid.py deleted file mode 100644 index a61b972d1f5..00000000000 --- a/plotly/graph_objs/layout/_grid.py +++ /dev/null @@ -1,578 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Grid(BaseLayoutHierarchyType): - - # columns - # ------- - @property - def columns(self): - """ - The number of columns in the grid. If you provide a 2D - `subplots` array, the length of its longest row is used as the - default. If you give an `xaxes` array, its length is used as - the default. But it's also possible to have a different length, - if you want to leave a row at the end for non-cartesian - subplots. - - 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] - - Returns - ------- - int - """ - return self['columns'] - - @columns.setter - def columns(self, val): - self['columns'] = val - - # domain - # ------ - @property - def domain(self): - """ - The 'domain' property is an instance of Domain - that may be specified as: - - An instance of 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 - end exactly at the domain edges, with no grout - around the edges. - y - 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 - ------- - plotly.graph_objs.layout.grid.Domain - """ - return self['domain'] - - @domain.setter - def domain(self, val): - self['domain'] = val - - # pattern - # ------- - @property - def pattern(self): - """ - If no `subplots`, `xaxes`, or `yaxes` are given but we do have - `rows` and `columns`, we can generate defaults using - consecutive axis IDs, in two ways: "coupled" gives one x axis - per column and one y axis per row. "independent" uses a new xy - pair for each cell, left-to-right across each row then - iterating rows according to `roworder`. - - The 'pattern' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['independent', 'coupled'] - - Returns - ------- - Any - """ - return self['pattern'] - - @pattern.setter - def pattern(self, val): - self['pattern'] = val - - # roworder - # -------- - @property - 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'] - - Returns - ------- - Any - """ - return self['roworder'] - - @roworder.setter - def roworder(self, val): - self['roworder'] = val - - # rows - # ---- - @property - def rows(self): - """ - The number of rows in the grid. If you provide a 2D `subplots` - array or a `yaxes` array, its length is used as the default. - But it's also possible to have a different length, if you want - to leave a row at the end for non-cartesian subplots. - - 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] - - Returns - ------- - int - """ - return self['rows'] - - @rows.setter - def rows(self, val): - self['rows'] = val - - # subplots - # -------- - @property - def subplots(self): - """ - Used for freeform grids, where some axes may be shared across - subplots but others are not. Each entry should be a cartesian - subplot id, like "xy" or "x3y2", or "" to leave that cell - empty. You may reuse x axes within the same column, and y axes - within the same row. Non-cartesian subplots and traces that - support `domain` can place themselves in this grid separately - using the `gridcell` attribute. - - 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: - - One of the following enumeration values: - [''] - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?y([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - list - """ - return self['subplots'] - - @subplots.setter - def subplots(self, val): - self['subplots'] = val - - # xaxes - # ----- - @property - def xaxes(self): - """ - Used with `yaxes` when the x and y axes are shared across - columns and rows. Each entry should be an x axis id like "x", - "x2", etc., or "" to not put an x axis in that column. Entries - other than "" must be unique. Ignored if `subplots` is present. - If missing but `yaxes` is present, will generate consecutive - IDs. - - 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: - - One of the following enumeration values: - [''] - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - list - """ - return self['xaxes'] - - @xaxes.setter - def xaxes(self, val): - self['xaxes'] = val - - # xgap - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xgap'] - - @xgap.setter - def xgap(self, val): - self['xgap'] = val - - # xside - # ----- - @property - 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'] - - Returns - ------- - Any - """ - return self['xside'] - - @xside.setter - def xside(self, val): - self['xside'] = val - - # yaxes - # ----- - @property - def yaxes(self): - """ - Used with `yaxes` when the x and y axes are shared across - columns and rows. Each entry should be an y axis id like "y", - "y2", etc., or "" to not put a y axis in that row. Entries - other than "" must be unique. Ignored if `subplots` is present. - If missing but `xaxes` is present, will generate consecutive - IDs. - - 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: - - One of the following enumeration values: - [''] - - A string that matches one of the following regular expressions: - ['^y([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - list - """ - return self['yaxes'] - - @yaxes.setter - def yaxes(self, val): - self['yaxes'] = val - - # ygap - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ygap'] - - @ygap.setter - def ygap(self, val): - self['ygap'] = val - - # yside - # ----- - @property - def yside(self): - """ - Sets where the y axis labels and titles go. "left" means the - very left edge of the grid. *left plot* is the leftmost plot - that each y axis is used in. "right" and *right plot* are - similar. - - The 'yside' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'left plot', 'right plot', 'right'] - - Returns - ------- - Any - """ - return self['yside'] - - @yside.setter - def yside(self, val): - self['yside'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - columns - The number of columns in the grid. If you provide a 2D - `subplots` array, the length of its longest row is used - as the default. If you give an `xaxes` array, its - length is used as the default. But it's also possible - to have a different length, if you want to leave a row - at the end for non-cartesian subplots. - domain - plotly.graph_objs.layout.grid.Domain instance or dict - with compatible properties - pattern - If no `subplots`, `xaxes`, or `yaxes` are given but we - do have `rows` and `columns`, we can generate defaults - using consecutive axis IDs, in two ways: "coupled" - gives one x axis per column and one y axis per row. - "independent" uses a new xy pair for each cell, left- - to-right across each row then iterating rows according - to `roworder`. - roworder - Is the first row the top or the bottom? Note that - columns are always enumerated from left to right. - rows - The number of rows in the grid. If you provide a 2D - `subplots` array or a `yaxes` array, its length is used - as the default. But it's also possible to have a - different length, if you want to leave a row at the end - for non-cartesian subplots. - subplots - Used for freeform grids, where some axes may be shared - across subplots but others are not. Each entry should - be a cartesian subplot id, like "xy" or "x3y2", or "" - to leave that cell empty. You may reuse x axes within - the same column, and y axes within the same row. Non- - cartesian subplots and traces that support `domain` can - place themselves in this grid separately using the - `gridcell` attribute. - xaxes - Used with `yaxes` when the x and y axes are shared - across columns and rows. Each entry should be an x axis - id like "x", "x2", etc., or "" to not put an x axis in - that column. Entries other than "" must be unique. - Ignored if `subplots` is present. If missing but - `yaxes` is present, will generate consecutive IDs. - xgap - Horizontal space between grid cells, expressed as a - fraction of the total width available to one cell. - Defaults to 0.1 for coupled-axes grids and 0.2 for - independent grids. - xside - Sets where the x axis labels and titles go. "bottom" - means the very bottom of the grid. "bottom plot" is the - lowest plot that each x axis is used in. "top" and "top - plot" are similar. - yaxes - Used with `yaxes` when the x and y axes are shared - across columns and rows. Each entry should be an y axis - id like "y", "y2", etc., or "" to not put a y axis in - that row. Entries other than "" must be unique. Ignored - if `subplots` is present. If missing but `xaxes` is - present, will generate consecutive IDs. - ygap - Vertical space between grid cells, expressed as a - fraction of the total height available to one cell. - Defaults to 0.1 for coupled-axes grids and 0.3 for - independent grids. - yside - Sets where the y axis labels and titles go. "left" - means the very left edge of the grid. *left plot* is - the leftmost plot that each y axis is used in. "right" - and *right plot* are similar. - """ - - def __init__( - self, - arg=None, - columns=None, - domain=None, - pattern=None, - roworder=None, - rows=None, - subplots=None, - xaxes=None, - xgap=None, - xside=None, - yaxes=None, - ygap=None, - yside=None, - **kwargs - ): - """ - Construct a new Grid object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Grid - columns - The number of columns in the grid. If you provide a 2D - `subplots` array, the length of its longest row is used - as the default. If you give an `xaxes` array, its - length is used as the default. But it's also possible - to have a different length, if you want to leave a row - at the end for non-cartesian subplots. - domain - plotly.graph_objs.layout.grid.Domain instance or dict - with compatible properties - pattern - If no `subplots`, `xaxes`, or `yaxes` are given but we - do have `rows` and `columns`, we can generate defaults - using consecutive axis IDs, in two ways: "coupled" - gives one x axis per column and one y axis per row. - "independent" uses a new xy pair for each cell, left- - to-right across each row then iterating rows according - to `roworder`. - roworder - Is the first row the top or the bottom? Note that - columns are always enumerated from left to right. - rows - The number of rows in the grid. If you provide a 2D - `subplots` array or a `yaxes` array, its length is used - as the default. But it's also possible to have a - different length, if you want to leave a row at the end - for non-cartesian subplots. - subplots - Used for freeform grids, where some axes may be shared - across subplots but others are not. Each entry should - be a cartesian subplot id, like "xy" or "x3y2", or "" - to leave that cell empty. You may reuse x axes within - the same column, and y axes within the same row. Non- - cartesian subplots and traces that support `domain` can - place themselves in this grid separately using the - `gridcell` attribute. - xaxes - Used with `yaxes` when the x and y axes are shared - across columns and rows. Each entry should be an x axis - id like "x", "x2", etc., or "" to not put an x axis in - that column. Entries other than "" must be unique. - Ignored if `subplots` is present. If missing but - `yaxes` is present, will generate consecutive IDs. - xgap - Horizontal space between grid cells, expressed as a - fraction of the total width available to one cell. - Defaults to 0.1 for coupled-axes grids and 0.2 for - independent grids. - xside - Sets where the x axis labels and titles go. "bottom" - means the very bottom of the grid. "bottom plot" is the - lowest plot that each x axis is used in. "top" and "top - plot" are similar. - yaxes - Used with `yaxes` when the x and y axes are shared - across columns and rows. Each entry should be an y axis - id like "y", "y2", etc., or "" to not put a y axis in - that row. Entries other than "" must be unique. Ignored - if `subplots` is present. If missing but `xaxes` is - present, will generate consecutive IDs. - ygap - Vertical space between grid cells, expressed as a - fraction of the total height available to one cell. - Defaults to 0.1 for coupled-axes grids and 0.3 for - independent grids. - yside - Sets where the y axis labels and titles go. "left" - means the very left edge of the grid. *left plot* is - the leftmost plot that each y axis is used in. "right" - and *right plot* are similar. - - Returns - ------- - Grid - """ - super(Grid, self).__init__('grid') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Grid -constructor must be a dict or -an instance of plotly.graph_objs.layout.Grid""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (grid as v_grid) - - # Initialize validators - # --------------------- - self._validators['columns'] = v_grid.ColumnsValidator() - self._validators['domain'] = v_grid.DomainValidator() - self._validators['pattern'] = v_grid.PatternValidator() - self._validators['roworder'] = v_grid.RoworderValidator() - self._validators['rows'] = v_grid.RowsValidator() - self._validators['subplots'] = v_grid.SubplotsValidator() - self._validators['xaxes'] = v_grid.XaxesValidator() - self._validators['xgap'] = v_grid.XgapValidator() - self._validators['xside'] = v_grid.XsideValidator() - self._validators['yaxes'] = v_grid.YaxesValidator() - self._validators['ygap'] = v_grid.YgapValidator() - self._validators['yside'] = v_grid.YsideValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('columns', None) - self['columns'] = columns if columns is not None else _v - _v = arg.pop('domain', None) - self['domain'] = domain if domain is not None else _v - _v = arg.pop('pattern', None) - self['pattern'] = pattern if pattern is not None else _v - _v = arg.pop('roworder', None) - self['roworder'] = roworder if roworder is not None else _v - _v = arg.pop('rows', None) - self['rows'] = rows if rows is not None else _v - _v = arg.pop('subplots', None) - self['subplots'] = subplots if subplots is not None else _v - _v = arg.pop('xaxes', None) - self['xaxes'] = xaxes if xaxes is not None else _v - _v = arg.pop('xgap', None) - self['xgap'] = xgap if xgap is not None else _v - _v = arg.pop('xside', None) - self['xside'] = xside if xside is not None else _v - _v = arg.pop('yaxes', None) - self['yaxes'] = yaxes if yaxes is not None else _v - _v = arg.pop('ygap', None) - self['ygap'] = ygap if ygap is not None else _v - _v = arg.pop('yside', None) - self['yside'] = yside if yside is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_hoverlabel.py b/plotly/graph_objs/layout/_hoverlabel.py deleted file mode 100644 index 52e45b3d86d..00000000000 --- a/plotly/graph_objs/layout/_hoverlabel.py +++ /dev/null @@ -1,312 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Hoverlabel(BaseLayoutHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the default length (in number of characters) of the trace - name in the hover labels for all traces. -1 shows the whole - name regardless of length. 0-3 shows the first 0-3 characters, - and an integer >3 will show the whole name if it is less than - that many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - Returns - ------- - int - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of all hover labels on graph - bordercolor - Sets the border color of all hover labels on graph. - font - Sets the default hover label font used by all traces on - the graph. - namelength - Sets the default length (in number of characters) of - the trace name in the hover labels for all traces. -1 - shows the whole name regardless of length. 0-3 shows - the first 0-3 characters, and an integer >3 will show - the whole name if it is less than that many characters, - but if it is longer, will truncate to `namelength - 3` - characters and add an ellipsis. - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - font=None, - namelength=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Hoverlabel - bgcolor - Sets the background color of all hover labels on graph - bordercolor - Sets the border color of all hover labels on graph. - font - Sets the default hover label font used by all traces on - the graph. - namelength - Sets the default length (in number of characters) of - the trace name in the hover labels for all traces. -1 - shows the whole name regardless of length. 0-3 shows - the first 0-3 characters, and an integer >3 will show - the whole name if it is less than that many characters, - but if it is longer, will truncate to `namelength - 3` - characters and add an ellipsis. - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.layout.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_image.py b/plotly/graph_objs/layout/_image.py deleted file mode 100644 index b89ba8b2e4b..00000000000 --- a/plotly/graph_objs/layout/_image.py +++ /dev/null @@ -1,625 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Image(BaseLayoutHierarchyType): - - # layer - # ----- - @property - 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'] - - Returns - ------- - Any - """ - return self['layer'] - - @layer.setter - def layer(self, val): - self['layer'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # sizex - # ----- - @property - def sizex(self): - """ - Sets the image container size horizontally. The image will be - sized based on the `position` value. When `xref` is set to - `paper`, units are sized relative to the plot width. - - The 'sizex' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['sizex'] - - @sizex.setter - def sizex(self, val): - self['sizex'] = val - - # sizey - # ----- - @property - def sizey(self): - """ - Sets the image container size vertically. The image will be - sized based on the `position` value. When `yref` is set to - `paper`, units are sized relative to the plot height. - - The 'sizey' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['sizey'] - - @sizey.setter - def sizey(self, val): - self['sizey'] = val - - # sizing - # ------ - @property - 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'] - - Returns - ------- - Any - """ - return self['sizing'] - - @sizing.setter - def sizing(self, val): - self['sizing'] = val - - # source - # ------ - @property - 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') - - A data URI image string - (e.g. 'data:image/png;base64,iVBORw0KGgoAAAANSU') - - A PIL.Image.Image object which will be immediately converted - to a data URI image string - See http://pillow.readthedocs.io/en/latest/reference/Image.html - - Returns - ------- - str - """ - return self['source'] - - @source.setter - def source(self, val): - self['source'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # visible - # ------- - @property - def visible(self): - """ - Determines whether or not this image is visible. - - The 'visible' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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 - ------- - Any - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xref - # ---- - @property - def xref(self): - """ - Sets the images's x coordinate axis. If set to a x axis id - (e.g. "x" or "x2"), the `x` position refers to an x data - coordinate If set to "paper", the `x` position refers to the - distance from the left of plot in normalized coordinates where - 0 (1) corresponds to the left (right). - - The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['paper'] - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - Any - """ - return self['xref'] - - @xref.setter - def xref(self, val): - self['xref'] = val - - # y - # - - @property - 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 - ------- - Any - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # yref - # ---- - @property - def yref(self): - """ - Sets the images's y coordinate axis. If set to a y axis id - (e.g. "y" or "y2"), the `y` position refers to a y data - coordinate. If set to "paper", the `y` position refers to the - distance from the bottom of the plot in normalized coordinates - where 0 (1) corresponds to the bottom (top). - - The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['paper'] - - A string that matches one of the following regular expressions: - ['^y([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - Any - """ - return self['yref'] - - @yref.setter - def yref(self, val): - self['yref'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - layer - Specifies whether images are drawn below or above - traces. When `xref` and `yref` are both set to `paper`, - image is drawn below the entire plot area. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - opacity - Sets the opacity of the image. - sizex - Sets the image container size horizontally. The image - will be sized based on the `position` value. When - `xref` is set to `paper`, units are sized relative to - the plot width. - sizey - Sets the image container size vertically. The image - will be sized based on the `position` value. When - `yref` is set to `paper`, units are sized relative to - the plot height. - sizing - Specifies which dimension of the image to constrain. - source - Specifies the URL of the image to be used. The URL must - be accessible from the domain where the plot code is - run, and can be either relative or absolute. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - visible - Determines whether or not this image is visible. - x - Sets the image's x position. When `xref` is set to - `paper`, units are sized relative to the plot height. - See `xref` for more info - xanchor - Sets the anchor for the x position - xref - Sets the images's x coordinate axis. If set to a x axis - id (e.g. "x" or "x2"), the `x` position refers to an x - data coordinate If set to "paper", the `x` position - refers to the distance from the left of plot in - normalized coordinates where 0 (1) corresponds to the - left (right). - y - Sets the image's y position. When `yref` is set to - `paper`, units are sized relative to the plot height. - See `yref` for more info - yanchor - Sets the anchor for the y position. - yref - Sets the images's y coordinate axis. If set to a y axis - id (e.g. "y" or "y2"), the `y` position refers to a y - data coordinate. If set to "paper", the `y` position - refers to the distance from the bottom of the plot in - normalized coordinates where 0 (1) corresponds to the - bottom (top). - """ - - def __init__( - self, - arg=None, - layer=None, - name=None, - opacity=None, - sizex=None, - sizey=None, - sizing=None, - source=None, - templateitemname=None, - visible=None, - x=None, - xanchor=None, - xref=None, - y=None, - yanchor=None, - yref=None, - **kwargs - ): - """ - Construct a new Image object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Image - layer - Specifies whether images are drawn below or above - traces. When `xref` and `yref` are both set to `paper`, - image is drawn below the entire plot area. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - opacity - Sets the opacity of the image. - sizex - Sets the image container size horizontally. The image - will be sized based on the `position` value. When - `xref` is set to `paper`, units are sized relative to - the plot width. - sizey - Sets the image container size vertically. The image - will be sized based on the `position` value. When - `yref` is set to `paper`, units are sized relative to - the plot height. - sizing - Specifies which dimension of the image to constrain. - source - Specifies the URL of the image to be used. The URL must - be accessible from the domain where the plot code is - run, and can be either relative or absolute. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - visible - Determines whether or not this image is visible. - x - Sets the image's x position. When `xref` is set to - `paper`, units are sized relative to the plot height. - See `xref` for more info - xanchor - Sets the anchor for the x position - xref - Sets the images's x coordinate axis. If set to a x axis - id (e.g. "x" or "x2"), the `x` position refers to an x - data coordinate If set to "paper", the `x` position - refers to the distance from the left of plot in - normalized coordinates where 0 (1) corresponds to the - left (right). - y - Sets the image's y position. When `yref` is set to - `paper`, units are sized relative to the plot height. - See `yref` for more info - yanchor - Sets the anchor for the y position. - yref - Sets the images's y coordinate axis. If set to a y axis - id (e.g. "y" or "y2"), the `y` position refers to a y - data coordinate. If set to "paper", the `y` position - refers to the distance from the bottom of the plot in - normalized coordinates where 0 (1) corresponds to the - bottom (top). - - Returns - ------- - Image - """ - super(Image, self).__init__('images') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Image -constructor must be a dict or -an instance of plotly.graph_objs.layout.Image""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (image as v_image) - - # Initialize validators - # --------------------- - self._validators['layer'] = v_image.LayerValidator() - self._validators['name'] = v_image.NameValidator() - self._validators['opacity'] = v_image.OpacityValidator() - self._validators['sizex'] = v_image.SizexValidator() - self._validators['sizey'] = v_image.SizeyValidator() - self._validators['sizing'] = v_image.SizingValidator() - self._validators['source'] = v_image.SourceValidator() - self._validators['templateitemname' - ] = v_image.TemplateitemnameValidator() - self._validators['visible'] = v_image.VisibleValidator() - self._validators['x'] = v_image.XValidator() - self._validators['xanchor'] = v_image.XanchorValidator() - self._validators['xref'] = v_image.XrefValidator() - self._validators['y'] = v_image.YValidator() - self._validators['yanchor'] = v_image.YanchorValidator() - self._validators['yref'] = v_image.YrefValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('layer', None) - self['layer'] = layer if layer is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('sizex', None) - self['sizex'] = sizex if sizex is not None else _v - _v = arg.pop('sizey', None) - self['sizey'] = sizey if sizey is not None else _v - _v = arg.pop('sizing', None) - self['sizing'] = sizing if sizing is not None else _v - _v = arg.pop('source', None) - self['source'] = source if source is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xref', None) - self['xref'] = xref if xref is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('yref', None) - self['yref'] = yref if yref is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_legend.py b/plotly/graph_objs/layout/_legend.py deleted file mode 100644 index ad71d38d127..00000000000 --- a/plotly/graph_objs/layout/_legend.py +++ /dev/null @@ -1,599 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Legend(BaseLayoutHierarchyType): - - # bgcolor - # ------- - @property - def bgcolor(self): - """ - Sets the legend 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.legend.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # orientation - # ----------- - @property - 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'] - - Returns - ------- - Any - """ - return self['orientation'] - - @orientation.setter - def orientation(self, val): - self['orientation'] = val - - # tracegroupgap - # ------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tracegroupgap'] - - @tracegroupgap.setter - def tracegroupgap(self, val): - self['tracegroupgap'] = val - - # traceorder - # ---------- - @property - def traceorder(self): - """ - Determines the order at which the legend items are displayed. - If "normal", the items are displayed top-to-bottom in the same - order as the input data. If "reversed", the items are displayed - in the opposite order as "normal". If "grouped", the items are - displayed in groups (when a trace `legendgroup` is provided). - if "grouped+reversed", the items are displayed in the opposite - order as "grouped". - - The 'traceorder' property is a flaglist and may be specified - as a string containing: - - Any combination of ['reversed', 'grouped'] joined with '+' characters - (e.g. 'reversed+grouped') - OR exactly one of ['normal'] (e.g. 'normal') - - Returns - ------- - Any - """ - return self['traceorder'] - - @traceorder.setter - def traceorder(self, val): - self['traceorder'] = val - - # uirevision - # ---------- - @property - 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 - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # valign - # ------ - @property - 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'] - - Returns - ------- - Any - """ - return self['valign'] - - @valign.setter - def valign(self, val): - self['valign'] = val - - # x - # - - @property - def x(self): - """ - Sets the x position (in normalized coordinates) of the legend. - - The 'x' property is a number and may be specified as: - - An int or float in the interval [-2, 3] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - def xanchor(self): - """ - Sets the legend's horizontal position anchor. This anchor binds - the `x` position to the "left", "center" or "right" of the - legend. - - The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'left', 'center', 'right'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # y - # - - @property - def y(self): - """ - Sets the y position (in normalized coordinates) of the legend. - - The 'y' property is a number and may be specified as: - - An int or float in the interval [-2, 3] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - def yanchor(self): - """ - Sets the legend's vertical position anchor This anchor binds - the `y` position to the "top", "middle" or "bottom" of the - legend. - - The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'top', 'middle', 'bottom'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the legend background color. - bordercolor - Sets the color of the border enclosing the legend. - borderwidth - Sets the width (in px) of the border enclosing the - legend. - font - Sets the font used to text the legend items. - orientation - Sets the orientation of the legend. - tracegroupgap - Sets the amount of vertical space (in px) between - legend groups. - traceorder - Determines the order at which the legend items are - displayed. If "normal", the items are displayed top-to- - bottom in the same order as the input data. If - "reversed", the items are displayed in the opposite - order as "normal". If "grouped", the items are - displayed in groups (when a trace `legendgroup` is - provided). if "grouped+reversed", the items are - displayed in the opposite order as "grouped". - uirevision - Controls persistence of legend-driven changes in trace - and pie label visibility. Defaults to - `layout.uirevision`. - valign - Sets the vertical alignment of the symbols with respect - to their associated text. - x - Sets the x position (in normalized coordinates) of the - legend. - xanchor - Sets the legend's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the legend. - y - Sets the y position (in normalized coordinates) of the - legend. - yanchor - Sets the legend's vertical position anchor This anchor - binds the `y` position to the "top", "middle" or - "bottom" of the legend. - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - font=None, - orientation=None, - tracegroupgap=None, - traceorder=None, - uirevision=None, - valign=None, - x=None, - xanchor=None, - y=None, - yanchor=None, - **kwargs - ): - """ - Construct a new Legend object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Legend - bgcolor - Sets the legend background color. - bordercolor - Sets the color of the border enclosing the legend. - borderwidth - Sets the width (in px) of the border enclosing the - legend. - font - Sets the font used to text the legend items. - orientation - Sets the orientation of the legend. - tracegroupgap - Sets the amount of vertical space (in px) between - legend groups. - traceorder - Determines the order at which the legend items are - displayed. If "normal", the items are displayed top-to- - bottom in the same order as the input data. If - "reversed", the items are displayed in the opposite - order as "normal". If "grouped", the items are - displayed in groups (when a trace `legendgroup` is - provided). if "grouped+reversed", the items are - displayed in the opposite order as "grouped". - uirevision - Controls persistence of legend-driven changes in trace - and pie label visibility. Defaults to - `layout.uirevision`. - valign - Sets the vertical alignment of the symbols with respect - to their associated text. - x - Sets the x position (in normalized coordinates) of the - legend. - xanchor - Sets the legend's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the legend. - y - Sets the y position (in normalized coordinates) of the - legend. - yanchor - Sets the legend's vertical position anchor This anchor - binds the `y` position to the "top", "middle" or - "bottom" of the legend. - - Returns - ------- - Legend - """ - super(Legend, self).__init__('legend') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Legend -constructor must be a dict or -an instance of plotly.graph_objs.layout.Legend""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (legend as v_legend) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_legend.BgcolorValidator() - self._validators['bordercolor'] = v_legend.BordercolorValidator() - self._validators['borderwidth'] = v_legend.BorderwidthValidator() - self._validators['font'] = v_legend.FontValidator() - self._validators['orientation'] = v_legend.OrientationValidator() - self._validators['tracegroupgap'] = v_legend.TracegroupgapValidator() - self._validators['traceorder'] = v_legend.TraceorderValidator() - self._validators['uirevision'] = v_legend.UirevisionValidator() - self._validators['valign'] = v_legend.ValignValidator() - self._validators['x'] = v_legend.XValidator() - self._validators['xanchor'] = v_legend.XanchorValidator() - self._validators['y'] = v_legend.YValidator() - self._validators['yanchor'] = v_legend.YanchorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('orientation', None) - self['orientation'] = orientation if orientation is not None else _v - _v = arg.pop('tracegroupgap', None) - self['tracegroupgap' - ] = tracegroupgap if tracegroupgap is not None else _v - _v = arg.pop('traceorder', None) - self['traceorder'] = traceorder if traceorder is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('valign', None) - self['valign'] = valign if valign is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_mapbox.py b/plotly/graph_objs/layout/_mapbox.py deleted file mode 100644 index d095826059f..00000000000 --- a/plotly/graph_objs/layout/_mapbox.py +++ /dev/null @@ -1,521 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Mapbox(BaseLayoutHierarchyType): - - # accesstoken - # ----------- - @property - def accesstoken(self): - """ - Sets the mapbox access token to be used for this mapbox map. - Alternatively, the mapbox access token can be set in the - configuration options under `mapboxAccessToken`. - - The 'accesstoken' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['accesstoken'] - - @accesstoken.setter - def accesstoken(self, val): - self['accesstoken'] = val - - # bearing - # ------- - @property - 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 - - Returns - ------- - int|float - """ - return self['bearing'] - - @bearing.setter - def bearing(self, val): - self['bearing'] = val - - # center - # ------ - @property - def center(self): - """ - The 'center' property is an instance of Center - that may be specified as: - - An instance of 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). - lon - Sets the longitude of the center of the map (in - degrees East). - - Returns - ------- - plotly.graph_objs.layout.mapbox.Center - """ - return self['center'] - - @center.setter - def center(self, val): - self['center'] = val - - # domain - # ------ - @property - def domain(self): - """ - The 'domain' property is an instance of Domain - that may be specified as: - - An instance of 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 - . - row - If there is a layout grid, use the domain for - this row in the grid for this mapbox subplot . - x - Sets the horizontal domain of this mapbox - subplot (in plot fraction). - y - Sets the vertical domain of this mapbox subplot - (in plot fraction). - - Returns - ------- - plotly.graph_objs.layout.mapbox.Domain - """ - return self['domain'] - - @domain.setter - def domain(self, val): - self['domain'] = val - - # layers - # ------ - @property - def layers(self): - """ - The 'layers' property is a tuple of instances of - Layer that may be specified as: - - 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 - set to '', the layer will be inserted above - every existing layer. - circle - plotly.graph_objs.layout.mapbox.layer.Circle - instance or dict with compatible properties - color - Sets the primary layer color. If `type` is - "circle", color corresponds to the circle color - (mapbox.layer.paint.circle-color) If `type` is - "line", color corresponds to the line color - (mapbox.layer.paint.line-color) If `type` is - "fill", color 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) - fill - plotly.graph_objs.layout.mapbox.layer.Fill - instance or dict with compatible properties - line - plotly.graph_objs.layout.mapbox.layer.Line - instance or dict with compatible properties - maxzoom - Sets the maximum zoom level - (mapbox.layer.maxzoom). At zoom levels equal to - or greater than the maxzoom, the layer will be - hidden. - minzoom - Sets the minimum zoom level - (mapbox.layer.minzoom). At zoom levels less - than the minzoom, the layer will be hidden. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - opacity - Sets the opacity of the layer. If `type` is - "circle", opacity corresponds to the circle - opacity (mapbox.layer.paint.circle-opacity) If - `type` is "line", opacity corresponds to the - line opacity (mapbox.layer.paint.line-opacity) - If `type` is "fill", opacity corresponds to the - fill opacity (mapbox.layer.paint.fill-opacity) - If `type` is "symbol", opacity corresponds to - the icon/text opacity (mapbox.layer.paint.text- - opacity) - source - Sets the source data for this layer - (mapbox.layer.source). Source can be either a - URL, a geojson object (with `sourcetype` set to - "geojson") or an array of tile URLS (with - `sourcetype` set to "vector"). - sourcelayer - Specifies the layer to use from a vector tile - source (mapbox.layer.source-layer). Required - for "vector" source type that supports multiple - layers. - sourcetype - Sets the source type for this layer. Support - for "raster", "image" and "video" source types - is coming soon. - symbol - plotly.graph_objs.layout.mapbox.layer.Symbol - instance or dict with compatible properties - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - type - Sets the layer type (mapbox.layer.type). - Support for "raster", "background" types is - coming soon. Note that "line" and "fill" are - not compatible with Point GeoJSON geometries. - visible - Determines whether this layer is displayed - - Returns - ------- - tuple[plotly.graph_objs.layout.mapbox.Layer] - """ - return self['layers'] - - @layers.setter - def layers(self, val): - self['layers'] = val - - # layerdefaults - # ------------- - @property - 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 plotly.graph_objs.layout.mapbox.Layer - - A dict of string/value properties that will be passed - to the Layer constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.layout.mapbox.Layer - """ - return self['layerdefaults'] - - @layerdefaults.setter - def layerdefaults(self, val): - self['layerdefaults'] = val - - # pitch - # ----- - @property - 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 - - Returns - ------- - int|float - """ - return self['pitch'] - - @pitch.setter - def pitch(self, val): - self['pitch'] = val - - # style - # ----- - @property - def style(self): - """ - Sets the Mapbox map style. Either input one of the default - Mapbox style names or the URL to a custom style or a valid - Mapbox style JSON. - - The 'style' property accepts values of any type - - Returns - ------- - Any - """ - return self['style'] - - @style.setter - def style(self, val): - self['style'] = val - - # uirevision - # ---------- - @property - 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 - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # zoom - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['zoom'] - - @zoom.setter - def zoom(self, val): - self['zoom'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - accesstoken - Sets the mapbox access token to be used for this mapbox - map. Alternatively, the mapbox access token can be set - in the configuration options under `mapboxAccessToken`. - bearing - Sets the bearing angle of the map in degrees counter- - clockwise from North (mapbox.bearing). - center - plotly.graph_objs.layout.mapbox.Center instance or dict - with compatible properties - domain - plotly.graph_objs.layout.mapbox.Domain instance or dict - with compatible properties - layers - plotly.graph_objs.layout.mapbox.Layer instance or dict - with compatible properties - layerdefaults - When used in a template (as - layout.template.layout.mapbox.layerdefaults), sets the - default property values to use for elements of - layout.mapbox.layers - pitch - Sets the pitch angle of the map (in degrees, where 0 - means perpendicular to the surface of the map) - (mapbox.pitch). - style - Sets the Mapbox map style. Either input one of the - default Mapbox style names or the URL to a custom style - or a valid Mapbox style JSON. - uirevision - Controls persistence of user-driven changes in the - view: `center`, `zoom`, `bearing`, `pitch`. Defaults to - `layout.uirevision`. - zoom - Sets the zoom level of the map (mapbox.zoom). - """ - - def __init__( - self, - arg=None, - accesstoken=None, - bearing=None, - center=None, - domain=None, - layers=None, - layerdefaults=None, - pitch=None, - style=None, - uirevision=None, - zoom=None, - **kwargs - ): - """ - Construct a new Mapbox object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Mapbox - accesstoken - Sets the mapbox access token to be used for this mapbox - map. Alternatively, the mapbox access token can be set - in the configuration options under `mapboxAccessToken`. - bearing - Sets the bearing angle of the map in degrees counter- - clockwise from North (mapbox.bearing). - center - plotly.graph_objs.layout.mapbox.Center instance or dict - with compatible properties - domain - plotly.graph_objs.layout.mapbox.Domain instance or dict - with compatible properties - layers - plotly.graph_objs.layout.mapbox.Layer instance or dict - with compatible properties - layerdefaults - When used in a template (as - layout.template.layout.mapbox.layerdefaults), sets the - default property values to use for elements of - layout.mapbox.layers - pitch - Sets the pitch angle of the map (in degrees, where 0 - means perpendicular to the surface of the map) - (mapbox.pitch). - style - Sets the Mapbox map style. Either input one of the - default Mapbox style names or the URL to a custom style - or a valid Mapbox style JSON. - uirevision - Controls persistence of user-driven changes in the - view: `center`, `zoom`, `bearing`, `pitch`. Defaults to - `layout.uirevision`. - zoom - Sets the zoom level of the map (mapbox.zoom). - - Returns - ------- - Mapbox - """ - super(Mapbox, self).__init__('mapbox') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Mapbox -constructor must be a dict or -an instance of plotly.graph_objs.layout.Mapbox""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (mapbox as v_mapbox) - - # Initialize validators - # --------------------- - self._validators['accesstoken'] = v_mapbox.AccesstokenValidator() - self._validators['bearing'] = v_mapbox.BearingValidator() - self._validators['center'] = v_mapbox.CenterValidator() - self._validators['domain'] = v_mapbox.DomainValidator() - self._validators['layers'] = v_mapbox.LayersValidator() - self._validators['layerdefaults'] = v_mapbox.LayerValidator() - self._validators['pitch'] = v_mapbox.PitchValidator() - self._validators['style'] = v_mapbox.StyleValidator() - self._validators['uirevision'] = v_mapbox.UirevisionValidator() - self._validators['zoom'] = v_mapbox.ZoomValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('accesstoken', None) - self['accesstoken'] = accesstoken if accesstoken is not None else _v - _v = arg.pop('bearing', None) - self['bearing'] = bearing if bearing is not None else _v - _v = arg.pop('center', None) - self['center'] = center if center is not None else _v - _v = arg.pop('domain', None) - self['domain'] = domain if domain is not None else _v - _v = arg.pop('layers', None) - self['layers'] = layers if layers is not None else _v - _v = arg.pop('layerdefaults', None) - self['layerdefaults' - ] = layerdefaults if layerdefaults is not None else _v - _v = arg.pop('pitch', None) - self['pitch'] = pitch if pitch is not None else _v - _v = arg.pop('style', None) - self['style'] = style if style is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('zoom', None) - self['zoom'] = zoom if zoom is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_margin.py b/plotly/graph_objs/layout/_margin.py deleted file mode 100644 index 18cb33c28db..00000000000 --- a/plotly/graph_objs/layout/_margin.py +++ /dev/null @@ -1,245 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Margin(BaseLayoutHierarchyType): - - # autoexpand - # ---------- - @property - def autoexpand(self): - """ - The 'autoexpand' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autoexpand'] - - @autoexpand.setter - def autoexpand(self, val): - self['autoexpand'] = val - - # b - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['b'] - - @b.setter - def b(self, val): - self['b'] = val - - # l - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['l'] - - @l.setter - def l(self, val): - self['l'] = val - - # pad - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['pad'] - - @pad.setter - def pad(self, val): - self['pad'] = val - - # r - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['r'] - - @r.setter - def r(self, val): - self['r'] = val - - # t - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['t'] - - @t.setter - def t(self, val): - self['t'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autoexpand - - b - Sets the bottom margin (in px). - l - Sets the left margin (in px). - pad - Sets the amount of padding (in px) between the plotting - area and the axis lines - r - Sets the right margin (in px). - t - Sets the top margin (in px). - """ - - def __init__( - self, - arg=None, - autoexpand=None, - b=None, - l=None, - pad=None, - r=None, - t=None, - **kwargs - ): - """ - Construct a new Margin object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Margin - autoexpand - - b - Sets the bottom margin (in px). - l - Sets the left margin (in px). - pad - Sets the amount of padding (in px) between the plotting - area and the axis lines - r - Sets the right margin (in px). - t - Sets the top margin (in px). - - Returns - ------- - Margin - """ - super(Margin, self).__init__('margin') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Margin -constructor must be a dict or -an instance of plotly.graph_objs.layout.Margin""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (margin as v_margin) - - # Initialize validators - # --------------------- - self._validators['autoexpand'] = v_margin.AutoexpandValidator() - self._validators['b'] = v_margin.BValidator() - self._validators['l'] = v_margin.LValidator() - self._validators['pad'] = v_margin.PadValidator() - self._validators['r'] = v_margin.RValidator() - self._validators['t'] = v_margin.TValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autoexpand', None) - self['autoexpand'] = autoexpand if autoexpand is not None else _v - _v = arg.pop('b', None) - self['b'] = b if b is not None else _v - _v = arg.pop('l', None) - self['l'] = l if l is not None else _v - _v = arg.pop('pad', None) - self['pad'] = pad if pad is not None else _v - _v = arg.pop('r', None) - self['r'] = r if r is not None else _v - _v = arg.pop('t', None) - self['t'] = t if t is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_modebar.py b/plotly/graph_objs/layout/_modebar.py deleted file mode 100644 index 50765bf5808..00000000000 --- a/plotly/graph_objs/layout/_modebar.py +++ /dev/null @@ -1,345 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Modebar(BaseLayoutHierarchyType): - - # activecolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['activecolor'] - - @activecolor.setter - def activecolor(self, val): - self['activecolor'] = val - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # orientation - # ----------- - @property - 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'] - - Returns - ------- - Any - """ - return self['orientation'] - - @orientation.setter - def orientation(self, val): - self['orientation'] = val - - # uirevision - # ---------- - @property - def uirevision(self): - """ - Controls persistence of user-driven changes related to the - modebar, including `hovermode`, `dragmode`, and `showspikes` at - both the root level and inside subplots. Defaults to - `layout.uirevision`. - - The 'uirevision' property accepts values of any type - - Returns - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - activecolor - Sets the color of the active or hovered on icons in the - modebar. - bgcolor - Sets the background color of the modebar. - color - Sets the color of the icons in the modebar. - orientation - Sets the orientation of the modebar. - uirevision - Controls persistence of user-driven changes related to - the modebar, including `hovermode`, `dragmode`, and - `showspikes` at both the root level and inside - subplots. Defaults to `layout.uirevision`. - """ - - def __init__( - self, - arg=None, - activecolor=None, - bgcolor=None, - color=None, - orientation=None, - uirevision=None, - **kwargs - ): - """ - Construct a new Modebar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Modebar - activecolor - Sets the color of the active or hovered on icons in the - modebar. - bgcolor - Sets the background color of the modebar. - color - Sets the color of the icons in the modebar. - orientation - Sets the orientation of the modebar. - uirevision - Controls persistence of user-driven changes related to - the modebar, including `hovermode`, `dragmode`, and - `showspikes` at both the root level and inside - subplots. Defaults to `layout.uirevision`. - - Returns - ------- - Modebar - """ - super(Modebar, self).__init__('modebar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Modebar -constructor must be a dict or -an instance of plotly.graph_objs.layout.Modebar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (modebar as v_modebar) - - # Initialize validators - # --------------------- - self._validators['activecolor'] = v_modebar.ActivecolorValidator() - self._validators['bgcolor'] = v_modebar.BgcolorValidator() - self._validators['color'] = v_modebar.ColorValidator() - self._validators['orientation'] = v_modebar.OrientationValidator() - self._validators['uirevision'] = v_modebar.UirevisionValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('activecolor', None) - self['activecolor'] = activecolor if activecolor is not None else _v - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('orientation', None) - self['orientation'] = orientation if orientation is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_polar.py b/plotly/graph_objs/layout/_polar.py deleted file mode 100644 index 8670e2b969e..00000000000 --- a/plotly/graph_objs/layout/_polar.py +++ /dev/null @@ -1,999 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Polar(BaseLayoutHierarchyType): - - # angularaxis - # ----------- - @property - def angularaxis(self): - """ - The 'angularaxis' property is an instance of AngularAxis - that may be specified as: - - An instance of 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` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - direction - Sets the direction corresponding to positive - angles. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - layer - Sets the layer on which this axis is displayed. - If *above traces*, this axis is displayed above - all the subplot's traces If *below traces*, - this axis is displayed below all the subplot's - traces, but above the grid lines. Useful when - used together with scatter-like traces with - `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - period - Set the angular period. Has an effect only when - `angularaxis.type` is "category". - rotation - Sets that start position (in degrees) of the - angular axis By default, polar subplots with - `direction` set to "counterclockwise" get a - `rotation` of 0 which corresponds to 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), - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thetaunit - Sets the format unit of the formatted "theta" - values. Has an effect only when - `angularaxis.type` is "linear". - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.polar.angularaxis.Tick - formatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.polar.angularaxis.tickformatstopdefaults), - sets the default property values to use for - elements of - layout.polar.angularaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - type - Sets the angular axis type. If "linear", set - `thetaunit` to determine the unit in which axis - value are shown. If *category, use `period` to - set the number of integer coordinates around - polar axis. - uirevision - Controls persistence of user-driven changes in - axis `rotation`. Defaults to - `polar.uirevision`. - visible - A single toggle to hide the axis while - preserving interaction like dragging. Default - is true when a cheater plot is present on the - axis, otherwise false - - Returns - ------- - plotly.graph_objs.layout.polar.AngularAxis - """ - return self['angularaxis'] - - @angularaxis.setter - def angularaxis(self, val): - self['angularaxis'] = val - - # bargap - # ------ - @property - 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] - - Returns - ------- - int|float - """ - return self['bargap'] - - @bargap.setter - def bargap(self, val): - self['bargap'] = val - - # barmode - # ------- - @property - def barmode(self): - """ - Determines how bars at the same location coordinate are - displayed on the graph. With "stack", the bars are stacked on - top of one another With "overlay", the bars are plotted over - one another, you might need to an "opacity" to see multiple - bars. - - The 'barmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['stack', 'overlay'] - - Returns - ------- - Any - """ - return self['barmode'] - - @barmode.setter - def barmode(self, val): - self['barmode'] = val - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # domain - # ------ - @property - def domain(self): - """ - The 'domain' property is an instance of Domain - that may be specified as: - - An instance of 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 - . - row - If there is a layout grid, use the domain for - this row in the grid for this polar subplot . - x - Sets the horizontal domain of this polar - subplot (in plot fraction). - y - Sets the vertical domain of this polar subplot - (in plot fraction). - - Returns - ------- - plotly.graph_objs.layout.polar.Domain - """ - return self['domain'] - - @domain.setter - def domain(self, val): - self['domain'] = val - - # gridshape - # --------- - @property - def gridshape(self): - """ - Determines if the radial axis grid lines and angular axis line - are drawn as "circular" sectors or as "linear" (polygon) - sectors. Has an effect only when the angular axis has `type` - "category". Note that `radialaxis.angle` is snapped to the - angle of the closest vertex when `gridshape` is "circular" (so - that radial axis scale is the same as the data scale). - - The 'gridshape' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['circular', 'linear'] - - Returns - ------- - Any - """ - return self['gridshape'] - - @gridshape.setter - def gridshape(self, val): - self['gridshape'] = val - - # hole - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['hole'] - - @hole.setter - def hole(self, val): - self['hole'] = val - - # radialaxis - # ---------- - @property - def radialaxis(self): - """ - The 'radialaxis' property is an instance of RadialAxis - that may be specified as: - - An instance of 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, - radial axis line on the theta=0 line - corresponds to a line pointing right (like what - mathematicians prefer). Defaults to the first - `polar.sector` angle. - autorange - Determines whether or not the range of this - axis is computed in relation to the input data. - See `rangemode` for more info. If `range` is - provided, then `autorange` is set to False. - calendar - Sets the calendar system to use for `range` and - `tick0` if this is a date axis. This does not - set the calendar for interpreting data on this - axis, that's specified in the trace or via the - global `layout.calendar` - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - layer - Sets the layer on which this axis is displayed. - If *above traces*, this axis is displayed above - all the subplot's traces If *below traces*, - this axis is displayed below all the subplot's - traces, but above the grid lines. Useful when - used together with scatter-like traces with - `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - range - Sets the range of this axis. If the axis `type` - is "log", then you must take the log of your - desired range (e.g. to set the range from 1 to - 100, set the range from 0 to 2). If the axis - `type` is "date", it should be date strings, - like date data, though Date objects and unix - milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it - should be numbers, using the scale where each - category is assigned a serial number from zero - in the order it appears. - rangemode - If *tozero*`, the range extends to 0, - regardless of the input data If "nonnegative", - the range is non-negative, regardless of the - input data. If "normal", the range is computed - in relation to the extrema of the input data - (same behavior as for cartesian axes). - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - side - Determines on which side of radial axis line - the tick and tick labels appear. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.polar.radialaxis.Tickf - ormatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.polar.radialaxis.tickformatstopdefaults), - sets the default property values to use for - elements of - layout.polar.radialaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.polar.radialaxis.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - layout.polar.radialaxis.title.font instead. - Sets this axis' title font. Note that the - title's font used to be customized by the now - deprecated `titlefont` attribute. - type - Sets the axis type. By default, plotly attempts - to determined the axis type by looking into the - data of the traces that referenced the axis in - question. - uirevision - Controls persistence of user-driven changes in - axis `range`, `autorange`, `angle`, and `title` - if in `editable: true` configuration. Defaults - to `polar.uirevision`. - visible - A single toggle to hide the axis while - preserving interaction like dragging. Default - is true when a cheater plot is present on the - axis, otherwise false - - Returns - ------- - plotly.graph_objs.layout.polar.RadialAxis - """ - return self['radialaxis'] - - @radialaxis.setter - def radialaxis(self, val): - self['radialaxis'] = val - - # sector - # ------ - @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 - - Returns - ------- - list - """ - return self['sector'] - - @sector.setter - def sector(self, val): - self['sector'] = val - - # uirevision - # ---------- - @property - 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 - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - angularaxis - plotly.graph_objs.layout.polar.AngularAxis instance or - dict with compatible properties - bargap - Sets the gap between bars of adjacent location - coordinates. Values are unitless, they represent - fractions of the minimum difference in bar positions in - the data. - barmode - Determines how bars at the same location coordinate are - displayed on the graph. With "stack", the bars are - stacked on top of one another With "overlay", the bars - are plotted over one another, you might need to an - "opacity" to see multiple bars. - bgcolor - Set the background color of the subplot - domain - plotly.graph_objs.layout.polar.Domain instance or dict - with compatible properties - gridshape - Determines if the radial axis grid lines and angular - axis line are drawn as "circular" sectors or as - "linear" (polygon) sectors. Has an effect only when the - angular axis has `type` "category". Note that - `radialaxis.angle` is snapped to the angle of the - closest vertex when `gridshape` is "circular" (so that - radial axis scale is the same as the data scale). - hole - Sets the fraction of the radius to cut out of the polar - subplot. - radialaxis - plotly.graph_objs.layout.polar.RadialAxis instance or - dict with compatible properties - sector - Sets angular span of this polar subplot with two angles - (in degrees). Sector are assumed to be spanned in the - counterclockwise direction with 0 corresponding to - rightmost limit of the polar subplot. - uirevision - Controls persistence of user-driven changes in axis - attributes, if not overridden in the individual axes. - Defaults to `layout.uirevision`. - """ - - def __init__( - self, - arg=None, - angularaxis=None, - bargap=None, - barmode=None, - bgcolor=None, - domain=None, - gridshape=None, - hole=None, - radialaxis=None, - sector=None, - uirevision=None, - **kwargs - ): - """ - Construct a new Polar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Polar - angularaxis - plotly.graph_objs.layout.polar.AngularAxis instance or - dict with compatible properties - bargap - Sets the gap between bars of adjacent location - coordinates. Values are unitless, they represent - fractions of the minimum difference in bar positions in - the data. - barmode - Determines how bars at the same location coordinate are - displayed on the graph. With "stack", the bars are - stacked on top of one another With "overlay", the bars - are plotted over one another, you might need to an - "opacity" to see multiple bars. - bgcolor - Set the background color of the subplot - domain - plotly.graph_objs.layout.polar.Domain instance or dict - with compatible properties - gridshape - Determines if the radial axis grid lines and angular - axis line are drawn as "circular" sectors or as - "linear" (polygon) sectors. Has an effect only when the - angular axis has `type` "category". Note that - `radialaxis.angle` is snapped to the angle of the - closest vertex when `gridshape` is "circular" (so that - radial axis scale is the same as the data scale). - hole - Sets the fraction of the radius to cut out of the polar - subplot. - radialaxis - plotly.graph_objs.layout.polar.RadialAxis instance or - dict with compatible properties - sector - Sets angular span of this polar subplot with two angles - (in degrees). Sector are assumed to be spanned in the - counterclockwise direction with 0 corresponding to - rightmost limit of the polar subplot. - uirevision - Controls persistence of user-driven changes in axis - attributes, if not overridden in the individual axes. - Defaults to `layout.uirevision`. - - Returns - ------- - Polar - """ - super(Polar, self).__init__('polar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Polar -constructor must be a dict or -an instance of plotly.graph_objs.layout.Polar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (polar as v_polar) - - # Initialize validators - # --------------------- - self._validators['angularaxis'] = v_polar.AngularAxisValidator() - self._validators['bargap'] = v_polar.BargapValidator() - self._validators['barmode'] = v_polar.BarmodeValidator() - self._validators['bgcolor'] = v_polar.BgcolorValidator() - self._validators['domain'] = v_polar.DomainValidator() - self._validators['gridshape'] = v_polar.GridshapeValidator() - self._validators['hole'] = v_polar.HoleValidator() - self._validators['radialaxis'] = v_polar.RadialAxisValidator() - self._validators['sector'] = v_polar.SectorValidator() - self._validators['uirevision'] = v_polar.UirevisionValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('angularaxis', None) - self['angularaxis'] = angularaxis if angularaxis is not None else _v - _v = arg.pop('bargap', None) - self['bargap'] = bargap if bargap is not None else _v - _v = arg.pop('barmode', None) - self['barmode'] = barmode if barmode is not None else _v - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('domain', None) - self['domain'] = domain if domain is not None else _v - _v = arg.pop('gridshape', None) - self['gridshape'] = gridshape if gridshape is not None else _v - _v = arg.pop('hole', None) - self['hole'] = hole if hole is not None else _v - _v = arg.pop('radialaxis', None) - self['radialaxis'] = radialaxis if radialaxis is not None else _v - _v = arg.pop('sector', None) - self['sector'] = sector if sector is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_radialaxis.py b/plotly/graph_objs/layout/_radialaxis.py deleted file mode 100644 index 3fadece8ae3..00000000000 --- a/plotly/graph_objs/layout/_radialaxis.py +++ /dev/null @@ -1,496 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class RadialAxis(BaseLayoutHierarchyType): - - # domain - # ------ - @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] - - Returns - ------- - list - """ - return self['domain'] - - @domain.setter - def domain(self, val): - self['domain'] = val - - # endpadding - # ---------- - @property - 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 - - Returns - ------- - int|float - """ - return self['endpadding'] - - @endpadding.setter - def endpadding(self, val): - self['endpadding'] = val - - # orientation - # ----------- - @property - 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 - - Returns - ------- - int|float - """ - return self['orientation'] - - @orientation.setter - def orientation(self, val): - self['orientation'] = val - - # range - # ----- - @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 - - Returns - ------- - list - """ - return self['range'] - - @range.setter - def range(self, val): - self['range'] = val - - # showline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showline'] - - @showline.setter - def showline(self, val): - self['showline'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickorientation - # --------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['tickorientation'] - - @tickorientation.setter - def tickorientation(self, val): - self['tickorientation'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - domain - Polar chart subplots are not supported yet. This key - has currently no effect. - endpadding - Legacy polar charts are deprecated! Please switch to - "polar" subplots. - orientation - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the orientation (an angle with - respect to the origin) of the radial axis. - range - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Defines the start and end point of - this radial axis. - showline - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Determines whether or not the line - bounding this radial axis will be shown on the figure. - showticklabels - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Determines whether or not the radial - axis ticks will feature tick labels. - tickcolor - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the color of the tick lines on - this radial axis. - ticklen - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the length of the tick lines on - this radial axis. - tickorientation - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the orientation (from the paper - perspective) of the radial axis tick labels. - ticksuffix - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the length of the tick lines on - this radial axis. - visible - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Determines whether or not this axis - will be visible. - """ - - def __init__( - self, - arg=None, - domain=None, - endpadding=None, - orientation=None, - range=None, - showline=None, - showticklabels=None, - tickcolor=None, - ticklen=None, - tickorientation=None, - ticksuffix=None, - visible=None, - **kwargs - ): - """ - Construct a new RadialAxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.RadialAxis - domain - Polar chart subplots are not supported yet. This key - has currently no effect. - endpadding - Legacy polar charts are deprecated! Please switch to - "polar" subplots. - orientation - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the orientation (an angle with - respect to the origin) of the radial axis. - range - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Defines the start and end point of - this radial axis. - showline - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Determines whether or not the line - bounding this radial axis will be shown on the figure. - showticklabels - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Determines whether or not the radial - axis ticks will feature tick labels. - tickcolor - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the color of the tick lines on - this radial axis. - ticklen - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the length of the tick lines on - this radial axis. - tickorientation - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the orientation (from the paper - perspective) of the radial axis tick labels. - ticksuffix - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Sets the length of the tick lines on - this radial axis. - visible - Legacy polar charts are deprecated! Please switch to - "polar" subplots. Determines whether or not this axis - will be visible. - - Returns - ------- - RadialAxis - """ - super(RadialAxis, self).__init__('radialaxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.RadialAxis -constructor must be a dict or -an instance of plotly.graph_objs.layout.RadialAxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (radialaxis as v_radialaxis) - - # Initialize validators - # --------------------- - self._validators['domain'] = v_radialaxis.DomainValidator() - self._validators['endpadding'] = v_radialaxis.EndpaddingValidator() - self._validators['orientation'] = v_radialaxis.OrientationValidator() - self._validators['range'] = v_radialaxis.RangeValidator() - self._validators['showline'] = v_radialaxis.ShowlineValidator() - self._validators['showticklabels' - ] = v_radialaxis.ShowticklabelsValidator() - self._validators['tickcolor'] = v_radialaxis.TickcolorValidator() - self._validators['ticklen'] = v_radialaxis.TicklenValidator() - self._validators['tickorientation' - ] = v_radialaxis.TickorientationValidator() - self._validators['ticksuffix'] = v_radialaxis.TicksuffixValidator() - self._validators['visible'] = v_radialaxis.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('domain', None) - self['domain'] = domain if domain is not None else _v - _v = arg.pop('endpadding', None) - self['endpadding'] = endpadding if endpadding is not None else _v - _v = arg.pop('orientation', None) - self['orientation'] = orientation if orientation is not None else _v - _v = arg.pop('range', None) - self['range'] = range if range is not None else _v - _v = arg.pop('showline', None) - self['showline'] = showline if showline is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickorientation', None) - self['tickorientation' - ] = tickorientation if tickorientation is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_scene.py b/plotly/graph_objs/layout/_scene.py deleted file mode 100644 index 44158a63fd3..00000000000 --- a/plotly/graph_objs/layout/_scene.py +++ /dev/null @@ -1,1625 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Scene(BaseLayoutHierarchyType): - - # annotations - # ----------- - @property - def annotations(self): - """ - The 'annotations' property is a tuple of instances of - Annotation that may be specified as: - - A list or tuple of instances of plotly.graph_objs.layout.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` - spans more two or more lines (i.e. `text` - contains one or more
HTML tags) or if an - explicit width is set to override the text - width. - arrowcolor - Sets the color of the annotation arrow. - arrowhead - Sets the end annotation arrow head style. - arrowside - Sets the annotation arrow head position. - arrowsize - Sets the size of the end annotation arrow head, - relative to `arrowwidth`. A value of 1 - (default) gives a head about 3x as wide as the - line. - arrowwidth - Sets the width (in px) of annotation arrow - line. - ax - Sets the x component of the arrow tail about - the arrow head (in pixels). - ay - Sets the y component of the arrow tail about - the arrow head (in pixels). - bgcolor - Sets the background color of the annotation. - bordercolor - Sets the color of the border enclosing the - annotation `text`. - borderpad - Sets the padding (in px) between the `text` and - the enclosing border. - borderwidth - Sets the width (in px) of the border enclosing - the annotation `text`. - captureevents - Determines whether the annotation text box - captures mouse move and click events, or allows - those events to pass through to data points in - the plot that may be behind the annotation. By - default `captureevents` is False unless - `hovertext` is provided. If you use the event - `plotly_clickannotation` without `hovertext` - you must explicitly enable `captureevents`. - font - Sets the annotation text font. - height - Sets an explicit height for the text box. null - (default) lets the text set the box height. - Taller text will be clipped. - hoverlabel - plotly.graph_objs.layout.scene.annotation.Hover - label instance or dict with compatible - properties - hovertext - Sets text to appear when hovering over this - annotation. If omitted or blank, no hover label - will appear. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - opacity - Sets the opacity of the annotation (text + - arrow). - showarrow - Determines whether or not the annotation is - drawn with an arrow. If True, `text` is placed - near the arrow's tail. If False, `text` lines - up with the `x` and `y` provided. - standoff - Sets a distance, in pixels, to move the end - arrowhead away from the position it is pointing - at, for example to point at the edge of a - marker independent of zoom. Note that this - shortens the arrow from the `ax` / `ay` vector, - in contrast to `xshift` / `yshift` which moves - everything by this amount. - startarrowhead - Sets the start annotation arrow head style. - startarrowsize - Sets the size of the start annotation arrow - head, relative to `arrowwidth`. A value of 1 - (default) gives a head about 3x as wide as the - line. - startstandoff - Sets a distance, in pixels, to move the start - arrowhead away from the position it is pointing - at, for example to point at the edge of a - marker independent of zoom. Note that this - shortens the arrow from the `ax` / `ay` vector, - in contrast to `xshift` / `yshift` which moves - everything by this amount. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - text - Sets the text associated with this annotation. - Plotly uses a subset of HTML tags to do things - like newline (
), bold (), italics - (), hyperlinks (). - Tags , , are also - supported. - textangle - Sets the angle at which the `text` is drawn - with respect to the horizontal. - valign - Sets the vertical alignment of the `text` - within the box. Has an effect only if an - explicit height is set to override the text - height. - visible - Determines whether or not this annotation is - visible. - width - Sets an explicit width for the text box. null - (default) lets the text set the box width. - Wider text will be clipped. There is no - automatic wrapping; use
to start a new - line. - x - Sets the annotation's x position. - xanchor - Sets the text box's horizontal position anchor - This anchor binds the `x` position to the - "left", "center" or "right" of the annotation. - For example, if `x` is set to 1, `xref` to - "paper" and `xanchor` to "right" then the - right-most portion of the annotation lines up - with the right-most edge of the plotting area. - If "auto", the anchor is equivalent to "center" - for data-referenced annotations or if there is - an arrow, whereas for paper-referenced with no - arrow, the anchor picked corresponds to the - closest side. - xshift - Shifts the position of the whole annotation and - arrow to the right (positive) or left - (negative) by this many pixels. - y - Sets the annotation's y position. - yanchor - Sets the text box's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the annotation. - For example, if `y` is set to 1, `yref` to - "paper" and `yanchor` to "top" then the top- - most portion of the annotation lines up with - the top-most edge of the plotting area. If - "auto", the anchor is equivalent to "middle" - for data-referenced annotations or if there is - an arrow, whereas for paper-referenced with no - arrow, the anchor picked corresponds to the - closest side. - yshift - Shifts the position of the whole annotation and - arrow up (positive) or down (negative) by this - many pixels. - z - Sets the annotation's z position. - - Returns - ------- - tuple[plotly.graph_objs.layout.scene.Annotation] - """ - return self['annotations'] - - @annotations.setter - def annotations(self, val): - self['annotations'] = val - - # annotationdefaults - # ------------------ - @property - def annotationdefaults(self): - """ - When used in a template (as - 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 plotly.graph_objs.layout.scene.Annotation - - A dict of string/value properties that will be passed - to the Annotation constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.layout.scene.Annotation - """ - return self['annotationdefaults'] - - @annotationdefaults.setter - def annotationdefaults(self, val): - self['annotationdefaults'] = val - - # aspectmode - # ---------- - @property - def aspectmode(self): - """ - If "cube", this scene's axes are drawn as a cube, regardless of - the axes' ranges. If "data", this scene's axes are drawn in - proportion with the axes' ranges. If "manual", this scene's - axes are drawn in proportion with the input of "aspectratio" - (the default behavior if "aspectratio" is provided). If "auto", - this scene's axes are drawn using the results of "data" except - when one axis is more than four times the size of the two - others, where in that case the results of "cube" are used. - - The 'aspectmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'cube', 'data', 'manual'] - - Returns - ------- - Any - """ - return self['aspectmode'] - - @aspectmode.setter - def aspectmode(self, val): - self['aspectmode'] = val - - # aspectratio - # ----------- - @property - 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 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 - ------- - plotly.graph_objs.layout.scene.Aspectratio - """ - return self['aspectratio'] - - @aspectratio.setter - def aspectratio(self, val): - self['aspectratio'] = val - - # bgcolor - # ------- - @property - def bgcolor(self): - """ - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # camera - # ------ - @property - def camera(self): - """ - The 'camera' property is an instance of Camera - that may be specified as: - - An instance of 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 - translation (x,y,z) space about the center of - this scene. By default, there is no such - translation. - eye - Sets the (x,y,z) components of the 'eye' camera - vector. This vector determines the view point - about the origin of this scene. - projection - plotly.graph_objs.layout.scene.camera.Projectio - n instance or dict with compatible properties - up - 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 - that the z axis points up. - - Returns - ------- - plotly.graph_objs.layout.scene.Camera - """ - return self['camera'] - - @camera.setter - def camera(self, val): - self['camera'] = val - - # domain - # ------ - @property - def domain(self): - """ - The 'domain' property is an instance of Domain - that may be specified as: - - An instance of 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 - . - row - If there is a layout grid, use the domain for - this row in the grid for this scene subplot . - x - Sets the horizontal domain of this scene - subplot (in plot fraction). - y - Sets the vertical domain of this scene subplot - (in plot fraction). - - Returns - ------- - plotly.graph_objs.layout.scene.Domain - """ - return self['domain'] - - @domain.setter - def domain(self, val): - self['domain'] = val - - # dragmode - # -------- - @property - 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] - - Returns - ------- - Any - """ - return self['dragmode'] - - @dragmode.setter - def dragmode(self, val): - self['dragmode'] = val - - # hovermode - # --------- - @property - 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] - - Returns - ------- - Any - """ - return self['hovermode'] - - @hovermode.setter - def hovermode(self, val): - self['hovermode'] = val - - # uirevision - # ---------- - @property - 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 - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # xaxis - # ----- - @property - def xaxis(self): - """ - The 'xaxis' property is an instance of XAxis - that may be specified as: - - An instance of 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. - See `rangemode` for more info. If `range` is - provided, then `autorange` is set to False. - backgroundcolor - Sets the background color of this axis' wall. - calendar - Sets the calendar system to use for `range` and - `tick0` if this is a date axis. This does not - set the calendar for interpreting data on this - axis, that's specified in the trace or via the - global `layout.calendar` - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - mirror - Determines if the axis lines or/and ticks are - mirrored to the opposite side of the plotting - area. If True, the axis lines are mirrored. If - "ticks", the axis lines and ticks are mirrored. - If False, mirroring is disable. If "all", axis - lines are mirrored on all shared-axes subplots. - If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - range - Sets the range of this axis. If the axis `type` - is "log", then you must take the log of your - desired range (e.g. to set the range from 1 to - 100, set the range from 0 to 2). If the axis - `type` is "date", it should be date strings, - like date data, though Date objects and unix - milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it - should be numbers, using the scale where each - category is assigned a serial number from zero - in the order it appears. - rangemode - If "normal", the range is computed in relation - to the extrema of the input data. If *tozero*`, - the range extends to 0, regardless of the input - data If "nonnegative", the range is non- - negative, regardless of the input data. Applies - only to linear axes. - separatethousands - If "true", even 4-digit integers are separated - showaxeslabels - Sets whether or not this axis is labeled - showbackground - Sets whether or not this axis' wall has a - background color. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showspikes - Sets whether or not spikes starting from data - points to this axis' wall are shown on hover. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - spikecolor - Sets the color of the spikes. - spikesides - Sets whether or not spikes extending from the - projection data points to this axis' wall - boundaries are shown on hover. - spikethickness - Sets the thickness (in px) of the spikes. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.scene.xaxis.Tickformat - stop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.scene.xaxis.tickformatstopdefaults), sets - the default property values to use for elements - of layout.scene.xaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.scene.xaxis.Title - instance or dict with compatible properties - titlefont - 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. - type - Sets the axis type. By default, plotly attempts - to determined the axis type by looking into the - data of the traces that referenced the axis in - question. - visible - A single toggle to hide the axis while - preserving interaction like dragging. Default - is true when a cheater plot is present on the - axis, otherwise false - zeroline - Determines whether or not a line is drawn at - along the 0 value of this axis. If True, the - zero line is drawn on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. - - Returns - ------- - plotly.graph_objs.layout.scene.XAxis - """ - return self['xaxis'] - - @xaxis.setter - def xaxis(self, val): - self['xaxis'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - The 'yaxis' property is an instance of YAxis - that may be specified as: - - An instance of 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. - See `rangemode` for more info. If `range` is - provided, then `autorange` is set to False. - backgroundcolor - Sets the background color of this axis' wall. - calendar - Sets the calendar system to use for `range` and - `tick0` if this is a date axis. This does not - set the calendar for interpreting data on this - axis, that's specified in the trace or via the - global `layout.calendar` - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - mirror - Determines if the axis lines or/and ticks are - mirrored to the opposite side of the plotting - area. If True, the axis lines are mirrored. If - "ticks", the axis lines and ticks are mirrored. - If False, mirroring is disable. If "all", axis - lines are mirrored on all shared-axes subplots. - If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - range - Sets the range of this axis. If the axis `type` - is "log", then you must take the log of your - desired range (e.g. to set the range from 1 to - 100, set the range from 0 to 2). If the axis - `type` is "date", it should be date strings, - like date data, though Date objects and unix - milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it - should be numbers, using the scale where each - category is assigned a serial number from zero - in the order it appears. - rangemode - If "normal", the range is computed in relation - to the extrema of the input data. If *tozero*`, - the range extends to 0, regardless of the input - data If "nonnegative", the range is non- - negative, regardless of the input data. Applies - only to linear axes. - separatethousands - If "true", even 4-digit integers are separated - showaxeslabels - Sets whether or not this axis is labeled - showbackground - Sets whether or not this axis' wall has a - background color. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showspikes - Sets whether or not spikes starting from data - points to this axis' wall are shown on hover. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - spikecolor - Sets the color of the spikes. - spikesides - Sets whether or not spikes extending from the - projection data points to this axis' wall - boundaries are shown on hover. - spikethickness - Sets the thickness (in px) of the spikes. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.scene.yaxis.Tickformat - stop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.scene.yaxis.tickformatstopdefaults), sets - the default property values to use for elements - of layout.scene.yaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.scene.yaxis.Title - instance or dict with compatible properties - titlefont - 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. - type - Sets the axis type. By default, plotly attempts - to determined the axis type by looking into the - data of the traces that referenced the axis in - question. - visible - A single toggle to hide the axis while - preserving interaction like dragging. Default - is true when a cheater plot is present on the - axis, otherwise false - zeroline - Determines whether or not a line is drawn at - along the 0 value of this axis. If True, the - zero line is drawn on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. - - Returns - ------- - plotly.graph_objs.layout.scene.YAxis - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # zaxis - # ----- - @property - def zaxis(self): - """ - The 'zaxis' property is an instance of ZAxis - that may be specified as: - - An instance of 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. - See `rangemode` for more info. If `range` is - provided, then `autorange` is set to False. - backgroundcolor - Sets the background color of this axis' wall. - calendar - Sets the calendar system to use for `range` and - `tick0` if this is a date axis. This does not - set the calendar for interpreting data on this - axis, that's specified in the trace or via the - global `layout.calendar` - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - mirror - Determines if the axis lines or/and ticks are - mirrored to the opposite side of the plotting - area. If True, the axis lines are mirrored. If - "ticks", the axis lines and ticks are mirrored. - If False, mirroring is disable. If "all", axis - lines are mirrored on all shared-axes subplots. - If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - range - Sets the range of this axis. If the axis `type` - is "log", then you must take the log of your - desired range (e.g. to set the range from 1 to - 100, set the range from 0 to 2). If the axis - `type` is "date", it should be date strings, - like date data, though Date objects and unix - milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it - should be numbers, using the scale where each - category is assigned a serial number from zero - in the order it appears. - rangemode - If "normal", the range is computed in relation - to the extrema of the input data. If *tozero*`, - the range extends to 0, regardless of the input - data If "nonnegative", the range is non- - negative, regardless of the input data. Applies - only to linear axes. - separatethousands - If "true", even 4-digit integers are separated - showaxeslabels - Sets whether or not this axis is labeled - showbackground - Sets whether or not this axis' wall has a - background color. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showspikes - Sets whether or not spikes starting from data - points to this axis' wall are shown on hover. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - spikecolor - Sets the color of the spikes. - spikesides - Sets whether or not spikes extending from the - projection data points to this axis' wall - boundaries are shown on hover. - spikethickness - Sets the thickness (in px) of the spikes. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.scene.zaxis.Tickformat - stop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.scene.zaxis.tickformatstopdefaults), sets - the default property values to use for elements - of layout.scene.zaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.scene.zaxis.Title - instance or dict with compatible properties - titlefont - 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. - type - Sets the axis type. By default, plotly attempts - to determined the axis type by looking into the - data of the traces that referenced the axis in - question. - visible - A single toggle to hide the axis while - preserving interaction like dragging. Default - is true when a cheater plot is present on the - axis, otherwise false - zeroline - Determines whether or not a line is drawn at - along the 0 value of this axis. If True, the - zero line is drawn on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. - - Returns - ------- - plotly.graph_objs.layout.scene.ZAxis - """ - return self['zaxis'] - - @zaxis.setter - def zaxis(self, val): - self['zaxis'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - annotations - plotly.graph_objs.layout.scene.Annotation instance or - dict with compatible properties - annotationdefaults - When used in a template (as - layout.template.layout.scene.annotationdefaults), sets - the default property values to use for elements of - layout.scene.annotations - aspectmode - If "cube", this scene's axes are drawn as a cube, - regardless of the axes' ranges. If "data", this scene's - axes are drawn in proportion with the axes' ranges. If - "manual", this scene's axes are drawn in proportion - with the input of "aspectratio" (the default behavior - if "aspectratio" is provided). If "auto", this scene's - axes are drawn using the results of "data" except when - one axis is more than four times the size of the two - others, where in that case the results of "cube" are - used. - aspectratio - Sets this scene's axis aspectratio. - bgcolor - - camera - plotly.graph_objs.layout.scene.Camera instance or dict - with compatible properties - domain - plotly.graph_objs.layout.scene.Domain instance or dict - with compatible properties - dragmode - Determines the mode of drag interactions for this - scene. - hovermode - Determines the mode of hover interactions for this - scene. - uirevision - Controls persistence of user-driven changes in camera - attributes. Defaults to `layout.uirevision`. - xaxis - plotly.graph_objs.layout.scene.XAxis instance or dict - with compatible properties - yaxis - plotly.graph_objs.layout.scene.YAxis instance or dict - with compatible properties - zaxis - plotly.graph_objs.layout.scene.ZAxis instance or dict - with compatible properties - """ - - def __init__( - self, - arg=None, - annotations=None, - annotationdefaults=None, - aspectmode=None, - aspectratio=None, - bgcolor=None, - camera=None, - domain=None, - dragmode=None, - hovermode=None, - uirevision=None, - xaxis=None, - yaxis=None, - zaxis=None, - **kwargs - ): - """ - Construct a new Scene object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Scene - annotations - plotly.graph_objs.layout.scene.Annotation instance or - dict with compatible properties - annotationdefaults - When used in a template (as - layout.template.layout.scene.annotationdefaults), sets - the default property values to use for elements of - layout.scene.annotations - aspectmode - If "cube", this scene's axes are drawn as a cube, - regardless of the axes' ranges. If "data", this scene's - axes are drawn in proportion with the axes' ranges. If - "manual", this scene's axes are drawn in proportion - with the input of "aspectratio" (the default behavior - if "aspectratio" is provided). If "auto", this scene's - axes are drawn using the results of "data" except when - one axis is more than four times the size of the two - others, where in that case the results of "cube" are - used. - aspectratio - Sets this scene's axis aspectratio. - bgcolor - - camera - plotly.graph_objs.layout.scene.Camera instance or dict - with compatible properties - domain - plotly.graph_objs.layout.scene.Domain instance or dict - with compatible properties - dragmode - Determines the mode of drag interactions for this - scene. - hovermode - Determines the mode of hover interactions for this - scene. - uirevision - Controls persistence of user-driven changes in camera - attributes. Defaults to `layout.uirevision`. - xaxis - plotly.graph_objs.layout.scene.XAxis instance or dict - with compatible properties - yaxis - plotly.graph_objs.layout.scene.YAxis instance or dict - with compatible properties - zaxis - plotly.graph_objs.layout.scene.ZAxis instance or dict - with compatible properties - - Returns - ------- - Scene - """ - super(Scene, self).__init__('scene') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Scene -constructor must be a dict or -an instance of plotly.graph_objs.layout.Scene""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (scene as v_scene) - - # Initialize validators - # --------------------- - self._validators['annotations'] = v_scene.AnnotationsValidator() - self._validators['annotationdefaults'] = v_scene.AnnotationValidator() - self._validators['aspectmode'] = v_scene.AspectmodeValidator() - self._validators['aspectratio'] = v_scene.AspectratioValidator() - self._validators['bgcolor'] = v_scene.BgcolorValidator() - self._validators['camera'] = v_scene.CameraValidator() - self._validators['domain'] = v_scene.DomainValidator() - self._validators['dragmode'] = v_scene.DragmodeValidator() - self._validators['hovermode'] = v_scene.HovermodeValidator() - self._validators['uirevision'] = v_scene.UirevisionValidator() - self._validators['xaxis'] = v_scene.XAxisValidator() - self._validators['yaxis'] = v_scene.YAxisValidator() - self._validators['zaxis'] = v_scene.ZAxisValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('annotations', None) - self['annotations'] = annotations if annotations is not None else _v - _v = arg.pop('annotationdefaults', None) - self['annotationdefaults' - ] = annotationdefaults if annotationdefaults is not None else _v - _v = arg.pop('aspectmode', None) - self['aspectmode'] = aspectmode if aspectmode is not None else _v - _v = arg.pop('aspectratio', None) - self['aspectratio'] = aspectratio if aspectratio is not None else _v - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('camera', None) - self['camera'] = camera if camera is not None else _v - _v = arg.pop('domain', None) - self['domain'] = domain if domain is not None else _v - _v = arg.pop('dragmode', None) - self['dragmode'] = dragmode if dragmode is not None else _v - _v = arg.pop('hovermode', None) - self['hovermode'] = hovermode if hovermode is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('xaxis', None) - self['xaxis'] = xaxis if xaxis is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - _v = arg.pop('zaxis', None) - self['zaxis'] = zaxis if zaxis is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_shape.py b/plotly/graph_objs/layout/_shape.py deleted file mode 100644 index d3b0b756b97..00000000000 --- a/plotly/graph_objs/layout/_shape.py +++ /dev/null @@ -1,929 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Shape(BaseLayoutHierarchyType): - - # fillcolor - # --------- - @property - def fillcolor(self): - """ - Sets the color filling the shape's 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['fillcolor'] - - @fillcolor.setter - def fillcolor(self, val): - self['fillcolor'] = val - - # layer - # ----- - @property - 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'] - - Returns - ------- - Any - """ - return self['layer'] - - @layer.setter - def layer(self, val): - self['layer'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - width - Sets the line width (in px). - - Returns - ------- - plotly.graph_objs.layout.shape.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # path - # ---- - @property - def path(self): - """ - For `type` "path" - a valid SVG path with the pixel values - replaced by data values in `xsizemode`/`ysizemode` being - "scaled" and taken unmodified as pixels relative to `xanchor` - and `yanchor` in case of "pixel" size mode. There are a few - restrictions / quirks only absolute instructions, not relative. - So the allowed segments are: M, L, H, V, Q, C, T, S, and Z arcs - (A) are not allowed because radius rx and ry are relative. In - the future we could consider supporting relative commands, but - we would have to decide on how to handle date and log axes. - Note that even as is, Q and C Bezier paths that are smooth on - linear axes may not be smooth on log, and vice versa. no - chained "polybezier" commands - specify the segment type for - each one. On category axes, values are numbers scaled to the - serial numbers of categories because using the categories - themselves there would be no way to describe fractional - positions On data axes: because space and T are both normal - components of path strings, we can't use either to separate - date from time parts. Therefore we'll use underscore for this - purpose: 2015-02-21_13:45:56.789 - - The 'path' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['path'] - - @path.setter - def path(self, val): - self['path'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # type - # ---- - @property - def type(self): - """ - Specifies the shape type to be drawn. If "line", a line is - drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect to the axes' - sizing mode. If "circle", a circle is drawn from - ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius (|(`x0`+`x1`)/2 - - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with respect to the axes' sizing - mode. If "rect", a rectangle is drawn linking (`x0`,`y0`), - (`x1`,`y0`), (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect - to the axes' sizing mode. If "path", draw a custom SVG path - using `path`. with respect to the axes' sizing mode. - - The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['circle', 'rect', 'path', 'line'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # visible - # ------- - @property - def visible(self): - """ - Determines whether or not this shape is visible. - - The 'visible' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x0 - # -- - @property - 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 - ------- - Any - """ - return self['x0'] - - @x0.setter - def x0(self, val): - self['x0'] = val - - # x1 - # -- - @property - 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 - ------- - Any - """ - return self['x1'] - - @x1.setter - def x1(self, val): - self['x1'] = val - - # xanchor - # ------- - @property - def xanchor(self): - """ - Only relevant in conjunction with `xsizemode` set to "pixel". - Specifies the anchor point on the x axis to which `x0`, `x1` - and x coordinates within `path` are relative to. E.g. useful to - attach a pixel sized shape to a certain data value. No effect - when `xsizemode` not set to "pixel". - - The 'xanchor' property accepts values of any type - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xref - # ---- - @property - def xref(self): - """ - Sets the shape's x coordinate axis. If set to an x axis id - (e.g. "x" or "x2"), the `x` position refers to an x coordinate. - If set to "paper", the `x` position refers to the distance from - the left side of the plotting area in normalized coordinates - where 0 (1) corresponds to the left (right) side. If the axis - `type` is "log", then you must take the log of your desired - range. If the axis `type` is "date", then you must convert the - date to unix time in milliseconds. - - The 'xref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['paper'] - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - Any - """ - return self['xref'] - - @xref.setter - def xref(self, val): - self['xref'] = val - - # xsizemode - # --------- - @property - def xsizemode(self): - """ - Sets the shapes's sizing mode along the x axis. If set to - "scaled", `x0`, `x1` and x coordinates within `path` refer to - data values on the x axis or a fraction of the plot area's - width (`xref` set to "paper"). If set to "pixel", `xanchor` - specifies the x position in terms of data or plot fraction but - `x0`, `x1` and x coordinates within `path` are pixels relative - to `xanchor`. This way, the shape can have a fixed width while - maintaining a position relative to data or plot fraction. - - The 'xsizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['scaled', 'pixel'] - - Returns - ------- - Any - """ - return self['xsizemode'] - - @xsizemode.setter - def xsizemode(self, val): - self['xsizemode'] = val - - # y0 - # -- - @property - 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 - ------- - Any - """ - return self['y0'] - - @y0.setter - def y0(self, val): - self['y0'] = val - - # y1 - # -- - @property - 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 - ------- - Any - """ - return self['y1'] - - @y1.setter - def y1(self, val): - self['y1'] = val - - # yanchor - # ------- - @property - def yanchor(self): - """ - Only relevant in conjunction with `ysizemode` set to "pixel". - Specifies the anchor point on the y axis to which `y0`, `y1` - and y coordinates within `path` are relative to. E.g. useful to - attach a pixel sized shape to a certain data value. No effect - when `ysizemode` not set to "pixel". - - The 'yanchor' property accepts values of any type - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # yref - # ---- - @property - def yref(self): - """ - Sets the annotation's y coordinate axis. If set to an y axis id - (e.g. "y" or "y2"), the `y` position refers to an y coordinate - If set to "paper", the `y` position refers to the distance from - the bottom of the plotting area in normalized coordinates where - 0 (1) corresponds to the bottom (top). - - The 'yref' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['paper'] - - A string that matches one of the following regular expressions: - ['^y([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - Any - """ - return self['yref'] - - @yref.setter - def yref(self, val): - self['yref'] = val - - # ysizemode - # --------- - @property - def ysizemode(self): - """ - Sets the shapes's sizing mode along the y axis. If set to - "scaled", `y0`, `y1` and y coordinates within `path` refer to - data values on the y axis or a fraction of the plot area's - height (`yref` set to "paper"). If set to "pixel", `yanchor` - specifies the y position in terms of data or plot fraction but - `y0`, `y1` and y coordinates within `path` are pixels relative - to `yanchor`. This way, the shape can have a fixed height while - maintaining a position relative to data or plot fraction. - - The 'ysizemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['scaled', 'pixel'] - - Returns - ------- - Any - """ - return self['ysizemode'] - - @ysizemode.setter - def ysizemode(self, val): - self['ysizemode'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - fillcolor - Sets the color filling the shape's interior. - layer - Specifies whether shapes are drawn below or above - traces. - line - plotly.graph_objs.layout.shape.Line instance or dict - with compatible properties - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - opacity - Sets the opacity of the shape. - path - For `type` "path" - a valid SVG path with the pixel - values replaced by data values in - `xsizemode`/`ysizemode` being "scaled" and taken - unmodified as pixels relative to `xanchor` and - `yanchor` in case of "pixel" size mode. There are a few - restrictions / quirks only absolute instructions, not - relative. So the allowed segments are: M, L, H, V, Q, - C, T, S, and Z arcs (A) are not allowed because radius - rx and ry are relative. In the future we could consider - supporting relative commands, but we would have to - decide on how to handle date and log axes. Note that - even as is, Q and C Bezier paths that are smooth on - linear axes may not be smooth on log, and vice versa. - no chained "polybezier" commands - specify the segment - type for each one. On category axes, values are numbers - scaled to the serial numbers of categories because - using the categories themselves there would be no way - to describe fractional positions On data axes: because - space and T are both normal components of path strings, - we can't use either to separate date from time parts. - Therefore we'll use underscore for this purpose: - 2015-02-21_13:45:56.789 - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - type - Specifies the shape type to be drawn. If "line", a line - is drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect - to the axes' sizing mode. If "circle", a circle is - drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius - (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with - respect to the axes' sizing mode. If "rect", a - rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), - (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect to - the axes' sizing mode. If "path", draw a custom SVG - path using `path`. with respect to the axes' sizing - mode. - visible - Determines whether or not this shape is visible. - x0 - Sets the shape's starting x position. See `type` and - `xsizemode` for more info. - x1 - Sets the shape's end x position. See `type` and - `xsizemode` for more info. - xanchor - Only relevant in conjunction with `xsizemode` set to - "pixel". Specifies the anchor point on the x axis to - which `x0`, `x1` and x coordinates within `path` are - relative to. E.g. useful to attach a pixel sized shape - to a certain data value. No effect when `xsizemode` not - set to "pixel". - xref - Sets the shape's x coordinate axis. If set to an x axis - id (e.g. "x" or "x2"), the `x` position refers to an x - coordinate. If set to "paper", the `x` position refers - to the distance from the left side of the plotting area - in normalized coordinates where 0 (1) corresponds to - the left (right) side. If the axis `type` is "log", - then you must take the log of your desired range. If - the axis `type` is "date", then you must convert the - date to unix time in milliseconds. - xsizemode - Sets the shapes's sizing mode along the x axis. If set - to "scaled", `x0`, `x1` and x coordinates within `path` - refer to data values on the x axis or a fraction of the - plot area's width (`xref` set to "paper"). If set to - "pixel", `xanchor` specifies the x position in terms of - data or plot fraction but `x0`, `x1` and x coordinates - within `path` are pixels relative to `xanchor`. This - way, the shape can have a fixed width while maintaining - a position relative to data or plot fraction. - y0 - Sets the shape's starting y position. See `type` and - `ysizemode` for more info. - y1 - Sets the shape's end y position. See `type` and - `ysizemode` for more info. - yanchor - Only relevant in conjunction with `ysizemode` set to - "pixel". Specifies the anchor point on the y axis to - which `y0`, `y1` and y coordinates within `path` are - relative to. E.g. useful to attach a pixel sized shape - to a certain data value. No effect when `ysizemode` not - set to "pixel". - yref - Sets the annotation's y coordinate axis. If set to an y - axis id (e.g. "y" or "y2"), the `y` position refers to - an y coordinate If set to "paper", the `y` position - refers to the distance from the bottom of the plotting - area in normalized coordinates where 0 (1) corresponds - to the bottom (top). - ysizemode - Sets the shapes's sizing mode along the y axis. If set - to "scaled", `y0`, `y1` and y coordinates within `path` - refer to data values on the y axis or a fraction of the - plot area's height (`yref` set to "paper"). If set to - "pixel", `yanchor` specifies the y position in terms of - data or plot fraction but `y0`, `y1` and y coordinates - within `path` are pixels relative to `yanchor`. This - way, the shape can have a fixed height while - maintaining a position relative to data or plot - fraction. - """ - - def __init__( - self, - arg=None, - fillcolor=None, - layer=None, - line=None, - name=None, - opacity=None, - path=None, - templateitemname=None, - type=None, - visible=None, - x0=None, - x1=None, - xanchor=None, - xref=None, - xsizemode=None, - y0=None, - y1=None, - yanchor=None, - yref=None, - ysizemode=None, - **kwargs - ): - """ - Construct a new Shape object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Shape - fillcolor - Sets the color filling the shape's interior. - layer - Specifies whether shapes are drawn below or above - traces. - line - plotly.graph_objs.layout.shape.Line instance or dict - with compatible properties - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - opacity - Sets the opacity of the shape. - path - For `type` "path" - a valid SVG path with the pixel - values replaced by data values in - `xsizemode`/`ysizemode` being "scaled" and taken - unmodified as pixels relative to `xanchor` and - `yanchor` in case of "pixel" size mode. There are a few - restrictions / quirks only absolute instructions, not - relative. So the allowed segments are: M, L, H, V, Q, - C, T, S, and Z arcs (A) are not allowed because radius - rx and ry are relative. In the future we could consider - supporting relative commands, but we would have to - decide on how to handle date and log axes. Note that - even as is, Q and C Bezier paths that are smooth on - linear axes may not be smooth on log, and vice versa. - no chained "polybezier" commands - specify the segment - type for each one. On category axes, values are numbers - scaled to the serial numbers of categories because - using the categories themselves there would be no way - to describe fractional positions On data axes: because - space and T are both normal components of path strings, - we can't use either to separate date from time parts. - Therefore we'll use underscore for this purpose: - 2015-02-21_13:45:56.789 - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - type - Specifies the shape type to be drawn. If "line", a line - is drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect - to the axes' sizing mode. If "circle", a circle is - drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius - (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with - respect to the axes' sizing mode. If "rect", a - rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), - (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect to - the axes' sizing mode. If "path", draw a custom SVG - path using `path`. with respect to the axes' sizing - mode. - visible - Determines whether or not this shape is visible. - x0 - Sets the shape's starting x position. See `type` and - `xsizemode` for more info. - x1 - Sets the shape's end x position. See `type` and - `xsizemode` for more info. - xanchor - Only relevant in conjunction with `xsizemode` set to - "pixel". Specifies the anchor point on the x axis to - which `x0`, `x1` and x coordinates within `path` are - relative to. E.g. useful to attach a pixel sized shape - to a certain data value. No effect when `xsizemode` not - set to "pixel". - xref - Sets the shape's x coordinate axis. If set to an x axis - id (e.g. "x" or "x2"), the `x` position refers to an x - coordinate. If set to "paper", the `x` position refers - to the distance from the left side of the plotting area - in normalized coordinates where 0 (1) corresponds to - the left (right) side. If the axis `type` is "log", - then you must take the log of your desired range. If - the axis `type` is "date", then you must convert the - date to unix time in milliseconds. - xsizemode - Sets the shapes's sizing mode along the x axis. If set - to "scaled", `x0`, `x1` and x coordinates within `path` - refer to data values on the x axis or a fraction of the - plot area's width (`xref` set to "paper"). If set to - "pixel", `xanchor` specifies the x position in terms of - data or plot fraction but `x0`, `x1` and x coordinates - within `path` are pixels relative to `xanchor`. This - way, the shape can have a fixed width while maintaining - a position relative to data or plot fraction. - y0 - Sets the shape's starting y position. See `type` and - `ysizemode` for more info. - y1 - Sets the shape's end y position. See `type` and - `ysizemode` for more info. - yanchor - Only relevant in conjunction with `ysizemode` set to - "pixel". Specifies the anchor point on the y axis to - which `y0`, `y1` and y coordinates within `path` are - relative to. E.g. useful to attach a pixel sized shape - to a certain data value. No effect when `ysizemode` not - set to "pixel". - yref - Sets the annotation's y coordinate axis. If set to an y - axis id (e.g. "y" or "y2"), the `y` position refers to - an y coordinate If set to "paper", the `y` position - refers to the distance from the bottom of the plotting - area in normalized coordinates where 0 (1) corresponds - to the bottom (top). - ysizemode - Sets the shapes's sizing mode along the y axis. If set - to "scaled", `y0`, `y1` and y coordinates within `path` - refer to data values on the y axis or a fraction of the - plot area's height (`yref` set to "paper"). If set to - "pixel", `yanchor` specifies the y position in terms of - data or plot fraction but `y0`, `y1` and y coordinates - within `path` are pixels relative to `yanchor`. This - way, the shape can have a fixed height while - maintaining a position relative to data or plot - fraction. - - Returns - ------- - Shape - """ - super(Shape, self).__init__('shapes') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Shape -constructor must be a dict or -an instance of plotly.graph_objs.layout.Shape""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (shape as v_shape) - - # Initialize validators - # --------------------- - self._validators['fillcolor'] = v_shape.FillcolorValidator() - self._validators['layer'] = v_shape.LayerValidator() - self._validators['line'] = v_shape.LineValidator() - self._validators['name'] = v_shape.NameValidator() - self._validators['opacity'] = v_shape.OpacityValidator() - self._validators['path'] = v_shape.PathValidator() - self._validators['templateitemname' - ] = v_shape.TemplateitemnameValidator() - self._validators['type'] = v_shape.TypeValidator() - self._validators['visible'] = v_shape.VisibleValidator() - self._validators['x0'] = v_shape.X0Validator() - self._validators['x1'] = v_shape.X1Validator() - self._validators['xanchor'] = v_shape.XanchorValidator() - self._validators['xref'] = v_shape.XrefValidator() - self._validators['xsizemode'] = v_shape.XsizemodeValidator() - self._validators['y0'] = v_shape.Y0Validator() - self._validators['y1'] = v_shape.Y1Validator() - self._validators['yanchor'] = v_shape.YanchorValidator() - self._validators['yref'] = v_shape.YrefValidator() - self._validators['ysizemode'] = v_shape.YsizemodeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('fillcolor', None) - self['fillcolor'] = fillcolor if fillcolor is not None else _v - _v = arg.pop('layer', None) - self['layer'] = layer if layer is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('path', None) - self['path'] = path if path is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x0', None) - self['x0'] = x0 if x0 is not None else _v - _v = arg.pop('x1', None) - self['x1'] = x1 if x1 is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xref', None) - self['xref'] = xref if xref is not None else _v - _v = arg.pop('xsizemode', None) - self['xsizemode'] = xsizemode if xsizemode is not None else _v - _v = arg.pop('y0', None) - self['y0'] = y0 if y0 is not None else _v - _v = arg.pop('y1', None) - self['y1'] = y1 if y1 is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('yref', None) - self['yref'] = yref if yref is not None else _v - _v = arg.pop('ysizemode', None) - self['ysizemode'] = ysizemode if ysizemode is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_slider.py b/plotly/graph_objs/layout/_slider.py deleted file mode 100644 index 9cfcfe82f18..00000000000 --- a/plotly/graph_objs/layout/_slider.py +++ /dev/null @@ -1,1138 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Slider(BaseLayoutHierarchyType): - - # active - # ------ - @property - 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] - - Returns - ------- - int|float - """ - return self['active'] - - @active.setter - def active(self, val): - self['active'] = val - - # activebgcolor - # ------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['activebgcolor'] - - @activebgcolor.setter - def activebgcolor(self, val): - self['activebgcolor'] = val - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # currentvalue - # ------------ - @property - def currentvalue(self): - """ - The 'currentvalue' property is an instance of Currentvalue - that may be specified as: - - An instance of 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 - The amount of space, in pixels, between the - current value label and the slider. - prefix - When currentvalue.visible is true, this sets - the prefix of the label. - suffix - When currentvalue.visible is true, this sets - the suffix of the label. - visible - Shows the currently-selected value above the - slider. - xanchor - The alignment of the value readout relative to - the length of the slider. - - Returns - ------- - plotly.graph_objs.layout.slider.Currentvalue - """ - return self['currentvalue'] - - @currentvalue.setter - def currentvalue(self, val): - self['currentvalue'] = val - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.slider.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # minorticklen - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['minorticklen'] - - @minorticklen.setter - def minorticklen(self, val): - self['minorticklen'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # pad - # --- - @property - 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 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. - l - The amount of padding (in px) on the left side - of the component. - r - The amount of padding (in px) on the right side - of the component. - t - The amount of padding (in px) along the top of - the component. - - Returns - ------- - plotly.graph_objs.layout.slider.Pad - """ - return self['pad'] - - @pad.setter - def pad(self, val): - self['pad'] = val - - # steps - # ----- - @property - def steps(self): - """ - The 'steps' property is a tuple of instances of - Step that may be specified as: - - 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. - execute - When true, the API method is executed. When - false, all other behaviors are the same and - command execution is skipped. This may be - useful when hooking into, for example, the - `plotly_sliderchange` method and executing the - API command manually without losing the benefit - of the slider automatically binding to the - state of the plot through the specification of - `method` and `args`. - label - Sets the text label to appear on the slider - method - Sets the Plotly method to be called when the - slider value is changed. If the `skip` method - is used, the API slider will function as normal - but 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 slider events manually via JavaScript. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - Sets the value of the slider step, used to - refer to the step programatically. Defaults to - the slider label if not provided. - visible - Determines whether or not this step is included - in the slider. - - Returns - ------- - tuple[plotly.graph_objs.layout.slider.Step] - """ - return self['steps'] - - @steps.setter - def steps(self, val): - self['steps'] = val - - # stepdefaults - # ------------ - @property - 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 plotly.graph_objs.layout.slider.Step - - A dict of string/value properties that will be passed - to the Step constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.layout.slider.Step - """ - return self['stepdefaults'] - - @stepdefaults.setter - def stepdefaults(self, val): - self['stepdefaults'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # transition - # ---------- - @property - def transition(self): - """ - The 'transition' property is an instance of Transition - that may be specified as: - - An instance of 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 - Sets the easing function of the slider - transition - - Returns - ------- - plotly.graph_objs.layout.slider.Transition - """ - return self['transition'] - - @transition.setter - def transition(self, val): - self['transition'] = val - - # visible - # ------- - @property - def visible(self): - """ - Determines whether or not the slider is visible. - - The 'visible' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - active - Determines which button (by index starting from 0) is - considered active. - activebgcolor - Sets the background color of the slider grip while - dragging. - bgcolor - Sets the background color of the slider. - bordercolor - Sets the color of the border enclosing the slider. - borderwidth - Sets the width (in px) of the border enclosing the - slider. - currentvalue - plotly.graph_objs.layout.slider.Currentvalue instance - or dict with compatible properties - font - Sets the font of the slider step labels. - len - Sets the length of the slider This measure excludes the - padding of both ends. That is, the slider's length is - this length minus the padding on both ends. - lenmode - Determines whether this slider length is set in units - of plot "fraction" or in *pixels. Use `len` to set the - value. - minorticklen - Sets the length in pixels of minor step tick marks - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - pad - Set the padding of the slider component along each - side. - steps - plotly.graph_objs.layout.slider.Step instance or dict - with compatible properties - stepdefaults - When used in a template (as - layout.template.layout.slider.stepdefaults), sets the - default property values to use for elements of - layout.slider.steps - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - tickcolor - Sets the color of the border enclosing the slider. - ticklen - Sets the length in pixels of step tick marks - tickwidth - Sets the tick width (in px). - transition - plotly.graph_objs.layout.slider.Transition instance or - dict with compatible properties - visible - Determines whether or not the slider is visible. - x - Sets the x position (in normalized coordinates) of the - slider. - xanchor - Sets the slider's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the range selector. - y - Sets the y position (in normalized coordinates) of the - slider. - yanchor - Sets the slider's vertical position anchor This anchor - binds the `y` position to the "top", "middle" or - "bottom" of the range selector. - """ - - def __init__( - self, - arg=None, - active=None, - activebgcolor=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - currentvalue=None, - font=None, - len=None, - lenmode=None, - minorticklen=None, - name=None, - pad=None, - steps=None, - stepdefaults=None, - templateitemname=None, - tickcolor=None, - ticklen=None, - tickwidth=None, - transition=None, - visible=None, - x=None, - xanchor=None, - y=None, - yanchor=None, - **kwargs - ): - """ - Construct a new Slider object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Slider - active - Determines which button (by index starting from 0) is - considered active. - activebgcolor - Sets the background color of the slider grip while - dragging. - bgcolor - Sets the background color of the slider. - bordercolor - Sets the color of the border enclosing the slider. - borderwidth - Sets the width (in px) of the border enclosing the - slider. - currentvalue - plotly.graph_objs.layout.slider.Currentvalue instance - or dict with compatible properties - font - Sets the font of the slider step labels. - len - Sets the length of the slider This measure excludes the - padding of both ends. That is, the slider's length is - this length minus the padding on both ends. - lenmode - Determines whether this slider length is set in units - of plot "fraction" or in *pixels. Use `len` to set the - value. - minorticklen - Sets the length in pixels of minor step tick marks - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - pad - Set the padding of the slider component along each - side. - steps - plotly.graph_objs.layout.slider.Step instance or dict - with compatible properties - stepdefaults - When used in a template (as - layout.template.layout.slider.stepdefaults), sets the - default property values to use for elements of - layout.slider.steps - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - tickcolor - Sets the color of the border enclosing the slider. - ticklen - Sets the length in pixels of step tick marks - tickwidth - Sets the tick width (in px). - transition - plotly.graph_objs.layout.slider.Transition instance or - dict with compatible properties - visible - Determines whether or not the slider is visible. - x - Sets the x position (in normalized coordinates) of the - slider. - xanchor - Sets the slider's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the range selector. - y - Sets the y position (in normalized coordinates) of the - slider. - yanchor - Sets the slider's vertical position anchor This anchor - binds the `y` position to the "top", "middle" or - "bottom" of the range selector. - - Returns - ------- - Slider - """ - super(Slider, self).__init__('sliders') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Slider -constructor must be a dict or -an instance of plotly.graph_objs.layout.Slider""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (slider as v_slider) - - # Initialize validators - # --------------------- - self._validators['active'] = v_slider.ActiveValidator() - self._validators['activebgcolor'] = v_slider.ActivebgcolorValidator() - self._validators['bgcolor'] = v_slider.BgcolorValidator() - self._validators['bordercolor'] = v_slider.BordercolorValidator() - self._validators['borderwidth'] = v_slider.BorderwidthValidator() - self._validators['currentvalue'] = v_slider.CurrentvalueValidator() - self._validators['font'] = v_slider.FontValidator() - self._validators['len'] = v_slider.LenValidator() - self._validators['lenmode'] = v_slider.LenmodeValidator() - self._validators['minorticklen'] = v_slider.MinorticklenValidator() - self._validators['name'] = v_slider.NameValidator() - self._validators['pad'] = v_slider.PadValidator() - self._validators['steps'] = v_slider.StepsValidator() - self._validators['stepdefaults'] = v_slider.StepValidator() - self._validators['templateitemname' - ] = v_slider.TemplateitemnameValidator() - self._validators['tickcolor'] = v_slider.TickcolorValidator() - self._validators['ticklen'] = v_slider.TicklenValidator() - self._validators['tickwidth'] = v_slider.TickwidthValidator() - self._validators['transition'] = v_slider.TransitionValidator() - self._validators['visible'] = v_slider.VisibleValidator() - self._validators['x'] = v_slider.XValidator() - self._validators['xanchor'] = v_slider.XanchorValidator() - self._validators['y'] = v_slider.YValidator() - self._validators['yanchor'] = v_slider.YanchorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('active', None) - self['active'] = active if active is not None else _v - _v = arg.pop('activebgcolor', None) - self['activebgcolor' - ] = activebgcolor if activebgcolor is not None else _v - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('currentvalue', None) - self['currentvalue'] = currentvalue if currentvalue is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('minorticklen', None) - self['minorticklen'] = minorticklen if minorticklen is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('pad', None) - self['pad'] = pad if pad is not None else _v - _v = arg.pop('steps', None) - self['steps'] = steps if steps is not None else _v - _v = arg.pop('stepdefaults', None) - self['stepdefaults'] = stepdefaults if stepdefaults is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('transition', None) - self['transition'] = transition if transition is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_template.py b/plotly/graph_objs/layout/_template.py deleted file mode 100644 index 73fa583d3ea..00000000000 --- a/plotly/graph_objs/layout/_template.py +++ /dev/null @@ -1,275 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Template(BaseLayoutHierarchyType): - - # data - # ---- - @property - def data(self): - """ - The 'data' property is an instance of Data - that may be specified as: - - An instance of plotly.graph_objs.layout.template.Data - - A dict of string/value properties that will be passed - to the Data constructor - - Supported dict properties: - - area - plotly.graph_objs.layout.template.data.Area - instance or dict with compatible properties - barpolar - plotly.graph_objs.layout.template.data.Barpolar - instance or dict with compatible properties - bar - plotly.graph_objs.layout.template.data.Bar - instance or dict with compatible properties - box - plotly.graph_objs.layout.template.data.Box - instance or dict with compatible properties - candlestick - plotly.graph_objs.layout.template.data.Candlest - ick instance or dict with compatible properties - carpet - plotly.graph_objs.layout.template.data.Carpet - instance or dict with compatible properties - choropleth - plotly.graph_objs.layout.template.data.Chorople - th instance or dict with compatible properties - cone - plotly.graph_objs.layout.template.data.Cone - instance or dict with compatible properties - contourcarpet - plotly.graph_objs.layout.template.data.Contourc - arpet instance or dict with compatible - properties - contour - plotly.graph_objs.layout.template.data.Contour - instance or dict with compatible properties - heatmapgl - plotly.graph_objs.layout.template.data.Heatmapg - l instance or dict with compatible properties - heatmap - plotly.graph_objs.layout.template.data.Heatmap - instance or dict with compatible properties - histogram2dcontour - plotly.graph_objs.layout.template.data.Histogra - m2dContour instance or dict with compatible - properties - histogram2d - plotly.graph_objs.layout.template.data.Histogra - m2d instance or dict with compatible properties - histogram - plotly.graph_objs.layout.template.data.Histogra - m instance or dict with compatible properties - isosurface - plotly.graph_objs.layout.template.data.Isosurfa - ce instance or dict with compatible properties - mesh3d - plotly.graph_objs.layout.template.data.Mesh3d - instance or dict with compatible properties - ohlc - plotly.graph_objs.layout.template.data.Ohlc - instance or dict with compatible properties - parcats - plotly.graph_objs.layout.template.data.Parcats - instance or dict with compatible properties - parcoords - plotly.graph_objs.layout.template.data.Parcoord - s instance or dict with compatible properties - pie - plotly.graph_objs.layout.template.data.Pie - instance or dict with compatible properties - pointcloud - plotly.graph_objs.layout.template.data.Pointclo - ud instance or dict with compatible properties - sankey - plotly.graph_objs.layout.template.data.Sankey - instance or dict with compatible properties - scatter3d - plotly.graph_objs.layout.template.data.Scatter3 - d instance or dict with compatible properties - scattercarpet - plotly.graph_objs.layout.template.data.Scatterc - arpet instance or dict with compatible - properties - scattergeo - plotly.graph_objs.layout.template.data.Scatterg - eo instance or dict with compatible properties - scattergl - plotly.graph_objs.layout.template.data.Scatterg - l instance or dict with compatible properties - scattermapbox - plotly.graph_objs.layout.template.data.Scatterm - apbox instance or dict with compatible - properties - scatterpolargl - plotly.graph_objs.layout.template.data.Scatterp - olargl instance or dict with compatible - properties - scatterpolar - plotly.graph_objs.layout.template.data.Scatterp - olar instance or dict with compatible - properties - scatter - plotly.graph_objs.layout.template.data.Scatter - instance or dict with compatible properties - scatterternary - plotly.graph_objs.layout.template.data.Scattert - ernary instance or dict with compatible - properties - splom - plotly.graph_objs.layout.template.data.Splom - instance or dict with compatible properties - streamtube - plotly.graph_objs.layout.template.data.Streamtu - be instance or dict with compatible properties - surface - plotly.graph_objs.layout.template.data.Surface - instance or dict with compatible properties - table - plotly.graph_objs.layout.template.data.Table - instance or dict with compatible properties - violin - plotly.graph_objs.layout.template.data.Violin - instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.layout.template.Data - """ - return self['data'] - - @data.setter - def data(self, val): - self['data'] = val - - # layout - # ------ - @property - def layout(self): - """ - The 'layout' property is an instance of Layout - that may be specified as: - - An instance of plotly.graph_objs.layout.template.Layout - - A dict of string/value properties that will be passed - to the Layout constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.layout.template.Layout - """ - return self['layout'] - - @layout.setter - def layout(self, val): - self['layout'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - data - plotly.graph_objs.layout.template.Data instance or dict - with compatible properties - layout - plotly.graph_objs.layout.template.Layout instance or - dict with compatible properties - """ - - 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 - `layoutTemplate` is a dict matching the structure of - `figure.layout` and `traceTemplate` is a dict matching the - structure of the trace with type `trace_type` (e.g. 'scatter'). - Alternatively, this may be specified as an instance of - plotly.graph_objs.layout.Template. Trace templates are applied - cyclically to traces of each type. Container arrays (eg - `annotations`) have special handling: An object ending in - `defaults` (eg `annotationdefaults`) is applied to each array - item. But if an item has a `templateitemname` key we look in - the template array for an item with matching `name` and apply - that instead. If no matching `name` is found we mark the item - invisible. Any named template item not referenced is appended - to the end of the array, so this can be used to add a watermark - annotation or a logo image, for example. To omit one of these - items on the plot, make an item with matching - `templateitemname` and `visible: false`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Template - data - plotly.graph_objs.layout.template.Data instance or dict - with compatible properties - layout - plotly.graph_objs.layout.template.Layout instance or - dict with compatible properties - - Returns - ------- - Template - """ - super(Template, self).__init__('template') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Template -constructor must be a dict or -an instance of plotly.graph_objs.layout.Template""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (template as v_template) - - # Initialize validators - # --------------------- - self._validators['data'] = v_template.DataValidator() - self._validators['layout'] = v_template.LayoutValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('data', None) - self['data'] = data if data is not None else _v - _v = arg.pop('layout', None) - self['layout'] = layout if layout is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_ternary.py b/plotly/graph_objs/layout/_ternary.py deleted file mode 100644 index fa7c14ea539..00000000000 --- a/plotly/graph_objs/layout/_ternary.py +++ /dev/null @@ -1,965 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Ternary(BaseLayoutHierarchyType): - - # aaxis - # ----- - @property - def aaxis(self): - """ - The 'aaxis' property is an instance of Aaxis - that may be specified as: - - An instance of 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 - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - layer - Sets the layer on which this axis is displayed. - If *above traces*, this axis is displayed above - all the subplot's traces If *below traces*, - this axis is displayed below all the subplot's - traces, but above the grid lines. Useful when - used together with scatter-like traces with - `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - min - 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. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.ternary.aaxis.Tickform - atstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.ternary.aaxis.tickformatstopdefaults), sets - the default property values to use for elements - of layout.ternary.aaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.ternary.aaxis.Title - instance or dict with compatible properties - titlefont - 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. - uirevision - Controls persistence of user-driven changes in - axis `min`, and `title` if in `editable: true` - configuration. Defaults to - `ternary.uirevision`. - - Returns - ------- - plotly.graph_objs.layout.ternary.Aaxis - """ - return self['aaxis'] - - @aaxis.setter - def aaxis(self, val): - self['aaxis'] = val - - # baxis - # ----- - @property - def baxis(self): - """ - The 'baxis' property is an instance of Baxis - that may be specified as: - - An instance of 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 - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - layer - Sets the layer on which this axis is displayed. - If *above traces*, this axis is displayed above - all the subplot's traces If *below traces*, - this axis is displayed below all the subplot's - traces, but above the grid lines. Useful when - used together with scatter-like traces with - `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - min - 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. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.ternary.baxis.Tickform - atstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.ternary.baxis.tickformatstopdefaults), sets - the default property values to use for elements - of layout.ternary.baxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.ternary.baxis.Title - instance or dict with compatible properties - titlefont - 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. - uirevision - Controls persistence of user-driven changes in - axis `min`, and `title` if in `editable: true` - configuration. Defaults to - `ternary.uirevision`. - - Returns - ------- - plotly.graph_objs.layout.ternary.Baxis - """ - return self['baxis'] - - @baxis.setter - def baxis(self, val): - self['baxis'] = val - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # caxis - # ----- - @property - def caxis(self): - """ - The 'caxis' property is an instance of Caxis - that may be specified as: - - An instance of 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 - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - layer - Sets the layer on which this axis is displayed. - If *above traces*, this axis is displayed above - all the subplot's traces If *below traces*, - this axis is displayed below all the subplot's - traces, but above the grid lines. Useful when - used together with scatter-like traces with - `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - min - 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. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.ternary.caxis.Tickform - atstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.ternary.caxis.tickformatstopdefaults), sets - the default property values to use for elements - of layout.ternary.caxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.ternary.caxis.Title - instance or dict with compatible properties - titlefont - 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. - uirevision - Controls persistence of user-driven changes in - axis `min`, and `title` if in `editable: true` - configuration. Defaults to - `ternary.uirevision`. - - Returns - ------- - plotly.graph_objs.layout.ternary.Caxis - """ - return self['caxis'] - - @caxis.setter - def caxis(self, val): - self['caxis'] = val - - # domain - # ------ - @property - def domain(self): - """ - The 'domain' property is an instance of Domain - that may be specified as: - - An instance of 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 - subplot . - row - If there is a layout grid, use the domain for - this row in the grid for this ternary subplot . - x - Sets the horizontal domain of this ternary - subplot (in plot fraction). - y - Sets the vertical domain of this ternary - subplot (in plot fraction). - - Returns - ------- - plotly.graph_objs.layout.ternary.Domain - """ - return self['domain'] - - @domain.setter - def domain(self, val): - self['domain'] = val - - # sum - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['sum'] - - @sum.setter - def sum(self, val): - self['sum'] = val - - # uirevision - # ---------- - @property - 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 - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - aaxis - plotly.graph_objs.layout.ternary.Aaxis instance or dict - with compatible properties - baxis - plotly.graph_objs.layout.ternary.Baxis instance or dict - with compatible properties - bgcolor - Set the background color of the subplot - caxis - plotly.graph_objs.layout.ternary.Caxis instance or dict - with compatible properties - domain - plotly.graph_objs.layout.ternary.Domain instance or - dict with compatible properties - sum - The number each triplet should sum to, and the maximum - range of each axis - uirevision - Controls persistence of user-driven changes in axis - `min` and `title`, if not overridden in the individual - axes. Defaults to `layout.uirevision`. - """ - - def __init__( - self, - arg=None, - aaxis=None, - baxis=None, - bgcolor=None, - caxis=None, - domain=None, - sum=None, - uirevision=None, - **kwargs - ): - """ - Construct a new Ternary object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Ternary - aaxis - plotly.graph_objs.layout.ternary.Aaxis instance or dict - with compatible properties - baxis - plotly.graph_objs.layout.ternary.Baxis instance or dict - with compatible properties - bgcolor - Set the background color of the subplot - caxis - plotly.graph_objs.layout.ternary.Caxis instance or dict - with compatible properties - domain - plotly.graph_objs.layout.ternary.Domain instance or - dict with compatible properties - sum - The number each triplet should sum to, and the maximum - range of each axis - uirevision - Controls persistence of user-driven changes in axis - `min` and `title`, if not overridden in the individual - axes. Defaults to `layout.uirevision`. - - Returns - ------- - Ternary - """ - super(Ternary, self).__init__('ternary') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Ternary -constructor must be a dict or -an instance of plotly.graph_objs.layout.Ternary""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (ternary as v_ternary) - - # Initialize validators - # --------------------- - self._validators['aaxis'] = v_ternary.AaxisValidator() - self._validators['baxis'] = v_ternary.BaxisValidator() - self._validators['bgcolor'] = v_ternary.BgcolorValidator() - self._validators['caxis'] = v_ternary.CaxisValidator() - self._validators['domain'] = v_ternary.DomainValidator() - self._validators['sum'] = v_ternary.SumValidator() - self._validators['uirevision'] = v_ternary.UirevisionValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('aaxis', None) - self['aaxis'] = aaxis if aaxis is not None else _v - _v = arg.pop('baxis', None) - self['baxis'] = baxis if baxis is not None else _v - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('caxis', None) - self['caxis'] = caxis if caxis is not None else _v - _v = arg.pop('domain', None) - self['domain'] = domain if domain is not None else _v - _v = arg.pop('sum', None) - self['sum'] = sum if sum is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_title.py b/plotly/graph_objs/layout/_title.py deleted file mode 100644 index 7f31aa63635..00000000000 --- a/plotly/graph_objs/layout/_title.py +++ /dev/null @@ -1,460 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Title(BaseLayoutHierarchyType): - - # font - # ---- - @property - 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 plotly.graph_objs.layout.title.Font - - A dict of string/value properties that will be passed - to the Font constructor - - Supported dict properties: - - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # pad - # --- - @property - def pad(self): - """ - Sets the padding of the title. Each padding value only applies - when the corresponding `xanchor`/`yanchor` value is set - accordingly. E.g. for left padding to take effect, `xanchor` - must be set to "left". The same rule applies if - `xanchor`/`yanchor` is determined automatically. Padding is - muted if the respective anchor value is "middle*/*center". - - The 'pad' property is an instance of Pad - that may be specified as: - - An instance of 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. - l - The amount of padding (in px) on the left side - of the component. - r - The amount of padding (in px) on the right side - of the component. - t - The amount of padding (in px) along the top of - the component. - - Returns - ------- - plotly.graph_objs.layout.title.Pad - """ - return self['pad'] - - @pad.setter - def pad(self, val): - self['pad'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - def xanchor(self): - """ - Sets the title's horizontal alignment with respect to its x - position. "left" means that the title starts at x, "right" - means that the title ends at x and "center" means that the - title's center is at x. "auto" divides `xref` by three and - calculates the `xanchor` value automatically based on the value - of `x`. - - The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'left', 'center', 'right'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xref - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['xref'] - - @xref.setter - def xref(self, val): - self['xref'] = val - - # y - # - - @property - def y(self): - """ - Sets the y position with respect to `yref` in normalized - coordinates from 0 (bottom) to 1 (top). "auto" places the - baseline of the title onto the vertical center of the top - margin. - - The 'y' property is a number and may be specified as: - - An int or float in the interval [0, 1] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - def yanchor(self): - """ - Sets the title's vertical alignment with respect to its y - position. "top" means that the title's cap line is at y, - "bottom" means that the title's baseline is at y and "middle" - means that the title's midline is at y. "auto" divides `yref` - by three and calculates the `yanchor` value automatically based - on the value of `y`. - - The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'top', 'middle', 'bottom'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # yref - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['yref'] - - @yref.setter - def yref(self, val): - self['yref'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets the title font. Note that the title's font used to - be customized by the now deprecated `titlefont` - attribute. - pad - Sets the padding of the title. Each padding value only - applies when the corresponding `xanchor`/`yanchor` - value is set accordingly. E.g. for left padding to take - effect, `xanchor` must be set to "left". The same rule - applies if `xanchor`/`yanchor` is determined - automatically. Padding is muted if the respective - anchor value is "middle*/*center". - text - Sets the plot's title. Note that before the existence - of `title.text`, the title's contents used to be - defined as the `title` attribute itself. This behavior - has been deprecated. - x - Sets the x position with respect to `xref` in - normalized coordinates from 0 (left) to 1 (right). - xanchor - Sets the title's horizontal alignment with respect to - its x position. "left" means that the title starts at - x, "right" means that the title ends at x and "center" - means that the title's center is at x. "auto" divides - `xref` by three and calculates the `xanchor` value - automatically based on the value of `x`. - xref - Sets the container `x` refers to. "container" spans the - entire `width` of the plot. "paper" refers to the width - of the plotting area only. - y - Sets the y position with respect to `yref` in - normalized coordinates from 0 (bottom) to 1 (top). - "auto" places the baseline of the title onto the - vertical center of the top margin. - yanchor - Sets the title's vertical alignment with respect to its - y position. "top" means that the title's cap line is at - y, "bottom" means that the title's baseline is at y and - "middle" means that the title's midline is at y. "auto" - divides `yref` by three and calculates the `yanchor` - value automatically based on the value of `y`. - yref - Sets the container `y` refers to. "container" spans the - entire `height` of the plot. "paper" refers to the - height of the plotting area only. - """ - - def __init__( - self, - arg=None, - font=None, - pad=None, - text=None, - x=None, - xanchor=None, - xref=None, - y=None, - yanchor=None, - yref=None, - **kwargs - ): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Title - font - Sets the title font. Note that the title's font used to - be customized by the now deprecated `titlefont` - attribute. - pad - Sets the padding of the title. Each padding value only - applies when the corresponding `xanchor`/`yanchor` - value is set accordingly. E.g. for left padding to take - effect, `xanchor` must be set to "left". The same rule - applies if `xanchor`/`yanchor` is determined - automatically. Padding is muted if the respective - anchor value is "middle*/*center". - text - Sets the plot's title. Note that before the existence - of `title.text`, the title's contents used to be - defined as the `title` attribute itself. This behavior - has been deprecated. - x - Sets the x position with respect to `xref` in - normalized coordinates from 0 (left) to 1 (right). - xanchor - Sets the title's horizontal alignment with respect to - its x position. "left" means that the title starts at - x, "right" means that the title ends at x and "center" - means that the title's center is at x. "auto" divides - `xref` by three and calculates the `xanchor` value - automatically based on the value of `x`. - xref - Sets the container `x` refers to. "container" spans the - entire `width` of the plot. "paper" refers to the width - of the plotting area only. - y - Sets the y position with respect to `yref` in - normalized coordinates from 0 (bottom) to 1 (top). - "auto" places the baseline of the title onto the - vertical center of the top margin. - yanchor - Sets the title's vertical alignment with respect to its - y position. "top" means that the title's cap line is at - y, "bottom" means that the title's baseline is at y and - "middle" means that the title's midline is at y. "auto" - divides `yref` by three and calculates the `yanchor` - value automatically based on the value of `y`. - yref - Sets the container `y` refers to. "container" spans the - entire `height` of the plot. "paper" refers to the - height of the plotting area only. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Title -constructor must be a dict or -an instance of plotly.graph_objs.layout.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['pad'] = v_title.PadValidator() - self._validators['text'] = v_title.TextValidator() - self._validators['x'] = v_title.XValidator() - self._validators['xanchor'] = v_title.XanchorValidator() - self._validators['xref'] = v_title.XrefValidator() - self._validators['y'] = v_title.YValidator() - self._validators['yanchor'] = v_title.YanchorValidator() - self._validators['yref'] = v_title.YrefValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('pad', None) - self['pad'] = pad if pad is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xref', None) - self['xref'] = xref if xref is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('yref', None) - self['yref'] = yref if yref is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_transition.py b/plotly/graph_objs/layout/_transition.py deleted file mode 100644 index cb1200b8a37..00000000000 --- a/plotly/graph_objs/layout/_transition.py +++ /dev/null @@ -1,176 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Transition(BaseLayoutHierarchyType): - - # duration - # -------- - @property - 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] - - Returns - ------- - int|float - """ - return self['duration'] - - @duration.setter - def duration(self, val): - self['duration'] = val - - # easing - # ------ - @property - 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', - 'elastic', 'back', 'bounce', 'linear-in', 'quad-in', - 'cubic-in', 'sin-in', 'exp-in', 'circle-in', 'elastic-in', - 'back-in', 'bounce-in', 'linear-out', 'quad-out', - 'cubic-out', 'sin-out', 'exp-out', 'circle-out', - 'elastic-out', 'back-out', 'bounce-out', 'linear-in-out', - 'quad-in-out', 'cubic-in-out', 'sin-in-out', 'exp-in-out', - 'circle-in-out', 'elastic-in-out', 'back-in-out', - 'bounce-in-out'] - - Returns - ------- - Any - """ - return self['easing'] - - @easing.setter - def easing(self, val): - self['easing'] = val - - # ordering - # -------- - @property - 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'] - - Returns - ------- - Any - """ - return self['ordering'] - - @ordering.setter - def ordering(self, val): - self['ordering'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - duration - The duration of the transition, in milliseconds. If - equal to zero, updates are synchronous. - easing - The easing function used for the transition - ordering - Determines whether the figure's layout or traces - smoothly transitions during updates that make both - traces and layout change. - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Transition - duration - The duration of the transition, in milliseconds. If - equal to zero, updates are synchronous. - easing - The easing function used for the transition - ordering - Determines whether the figure's layout or traces - smoothly transitions during updates that make both - traces and layout change. - - Returns - ------- - Transition - """ - super(Transition, self).__init__('transition') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Transition -constructor must be a dict or -an instance of plotly.graph_objs.layout.Transition""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (transition as v_transition) - - # Initialize validators - # --------------------- - self._validators['duration'] = v_transition.DurationValidator() - self._validators['easing'] = v_transition.EasingValidator() - self._validators['ordering'] = v_transition.OrderingValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('duration', None) - self['duration'] = duration if duration is not None else _v - _v = arg.pop('easing', None) - self['easing'] = easing if easing is not None else _v - _v = arg.pop('ordering', None) - self['ordering'] = ordering if ordering is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_updatemenu.py b/plotly/graph_objs/layout/_updatemenu.py deleted file mode 100644 index ca434b484f7..00000000000 --- a/plotly/graph_objs/layout/_updatemenu.py +++ /dev/null @@ -1,863 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Updatemenu(BaseLayoutHierarchyType): - - # active - # ------ - @property - 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] - - Returns - ------- - int - """ - return self['active'] - - @active.setter - def active(self, val): - self['active'] = val - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # buttons - # ------- - @property - def buttons(self): - """ - 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.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. - execute - When true, the API method is executed. When - false, all other behaviors are the same and - command execution is skipped. This may be - useful when hooking into, for example, the - `plotly_buttonclicked` method and executing the - API command manually without losing the benefit - of the updatemenu automatically binding to the - state of the plot through the specification of - `method` and `args`. - label - Sets the text label to appear on the button. - method - Sets the Plotly method to be called on click. - If the `skip` method is used, the API - updatemenu will function as normal but 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. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - visible - Determines whether or not this button is - visible. - - Returns - ------- - tuple[plotly.graph_objs.layout.updatemenu.Button] - """ - return self['buttons'] - - @buttons.setter - def buttons(self, val): - self['buttons'] = val - - # buttondefaults - # -------------- - @property - def buttondefaults(self): - """ - When used in a template (as - 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 plotly.graph_objs.layout.updatemenu.Button - - A dict of string/value properties that will be passed - to the Button constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.layout.updatemenu.Button - """ - return self['buttondefaults'] - - @buttondefaults.setter - def buttondefaults(self, val): - self['buttondefaults'] = val - - # direction - # --------- - @property - def direction(self): - """ - Determines the direction in which the buttons are laid out, - whether in a dropdown menu or a row/column of buttons. For - `left` and `up`, the buttons will still appear in left-to-right - or top-to-bottom order respectively. - - The 'direction' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'right', 'up', 'down'] - - Returns - ------- - Any - """ - return self['direction'] - - @direction.setter - def direction(self, val): - self['direction'] = val - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.updatemenu.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # pad - # --- - @property - 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 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. - l - The amount of padding (in px) on the left side - of the component. - r - The amount of padding (in px) on the right side - of the component. - t - The amount of padding (in px) along the top of - the component. - - Returns - ------- - plotly.graph_objs.layout.updatemenu.Pad - """ - return self['pad'] - - @pad.setter - def pad(self, val): - self['pad'] = val - - # showactive - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showactive'] - - @showactive.setter - def showactive(self, val): - self['showactive'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # type - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - active - Determines which button (by index starting from 0) is - considered active. - bgcolor - Sets the background color of the update menu buttons. - bordercolor - Sets the color of the border enclosing the update menu. - borderwidth - Sets the width (in px) of the border enclosing the - update menu. - buttons - plotly.graph_objs.layout.updatemenu.Button instance or - dict with compatible properties - buttondefaults - When used in a template (as - layout.template.layout.updatemenu.buttondefaults), sets - the default property values to use for elements of - layout.updatemenu.buttons - direction - Determines the direction in which the buttons are laid - out, whether in a dropdown menu or a row/column of - buttons. For `left` and `up`, the buttons will still - appear in left-to-right or top-to-bottom order - respectively. - font - Sets the font of the update menu button text. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - pad - Sets the padding around the buttons or dropdown menu. - showactive - Highlights active dropdown item or active button if - true. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - type - Determines whether the buttons are accessible via a - dropdown menu or whether the buttons are stacked - horizontally or vertically - visible - Determines whether or not the update menu is visible. - x - Sets the x position (in normalized coordinates) of the - update menu. - xanchor - Sets the update menu's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the range selector. - y - Sets the y position (in normalized coordinates) of the - update menu. - yanchor - Sets the update menu's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the range selector. - """ - - def __init__( - self, - arg=None, - active=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - buttons=None, - buttondefaults=None, - direction=None, - font=None, - name=None, - pad=None, - showactive=None, - templateitemname=None, - type=None, - visible=None, - x=None, - xanchor=None, - y=None, - yanchor=None, - **kwargs - ): - """ - Construct a new Updatemenu object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.Updatemenu - active - Determines which button (by index starting from 0) is - considered active. - bgcolor - Sets the background color of the update menu buttons. - bordercolor - Sets the color of the border enclosing the update menu. - borderwidth - Sets the width (in px) of the border enclosing the - update menu. - buttons - plotly.graph_objs.layout.updatemenu.Button instance or - dict with compatible properties - buttondefaults - When used in a template (as - layout.template.layout.updatemenu.buttondefaults), sets - the default property values to use for elements of - layout.updatemenu.buttons - direction - Determines the direction in which the buttons are laid - out, whether in a dropdown menu or a row/column of - buttons. For `left` and `up`, the buttons will still - appear in left-to-right or top-to-bottom order - respectively. - font - Sets the font of the update menu button text. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - pad - Sets the padding around the buttons or dropdown menu. - showactive - Highlights active dropdown item or active button if - true. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - type - Determines whether the buttons are accessible via a - dropdown menu or whether the buttons are stacked - horizontally or vertically - visible - Determines whether or not the update menu is visible. - x - Sets the x position (in normalized coordinates) of the - update menu. - xanchor - Sets the update menu's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the range selector. - y - Sets the y position (in normalized coordinates) of the - update menu. - yanchor - Sets the update menu's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the range selector. - - Returns - ------- - Updatemenu - """ - super(Updatemenu, self).__init__('updatemenus') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.Updatemenu -constructor must be a dict or -an instance of plotly.graph_objs.layout.Updatemenu""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (updatemenu as v_updatemenu) - - # Initialize validators - # --------------------- - self._validators['active'] = v_updatemenu.ActiveValidator() - self._validators['bgcolor'] = v_updatemenu.BgcolorValidator() - self._validators['bordercolor'] = v_updatemenu.BordercolorValidator() - self._validators['borderwidth'] = v_updatemenu.BorderwidthValidator() - self._validators['buttons'] = v_updatemenu.ButtonsValidator() - self._validators['buttondefaults'] = v_updatemenu.ButtonValidator() - self._validators['direction'] = v_updatemenu.DirectionValidator() - self._validators['font'] = v_updatemenu.FontValidator() - self._validators['name'] = v_updatemenu.NameValidator() - self._validators['pad'] = v_updatemenu.PadValidator() - self._validators['showactive'] = v_updatemenu.ShowactiveValidator() - self._validators['templateitemname' - ] = v_updatemenu.TemplateitemnameValidator() - self._validators['type'] = v_updatemenu.TypeValidator() - self._validators['visible'] = v_updatemenu.VisibleValidator() - self._validators['x'] = v_updatemenu.XValidator() - self._validators['xanchor'] = v_updatemenu.XanchorValidator() - self._validators['y'] = v_updatemenu.YValidator() - self._validators['yanchor'] = v_updatemenu.YanchorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('active', None) - self['active'] = active if active is not None else _v - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('buttons', None) - self['buttons'] = buttons if buttons is not None else _v - _v = arg.pop('buttondefaults', None) - self['buttondefaults' - ] = buttondefaults if buttondefaults is not None else _v - _v = arg.pop('direction', None) - self['direction'] = direction if direction is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('pad', None) - self['pad'] = pad if pad is not None else _v - _v = arg.pop('showactive', None) - self['showactive'] = showactive if showactive is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_xaxis.py b/plotly/graph_objs/layout/_xaxis.py deleted file mode 100644 index b7f75bcc9a3..00000000000 --- a/plotly/graph_objs/layout/_xaxis.py +++ /dev/null @@ -1,3314 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class XAxis(BaseLayoutHierarchyType): - - # anchor - # ------ - @property - 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'] - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?$', '^y([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - Any - """ - return self['anchor'] - - @anchor.setter - def anchor(self, val): - self['anchor'] = val - - # automargin - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['automargin'] - - @automargin.setter - def automargin(self, val): - self['automargin'] = val - - # autorange - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['autorange'] - - @autorange.setter - def autorange(self, val): - self['autorange'] = val - - # calendar - # -------- - @property - def calendar(self): - """ - Sets the calendar system to use for `range` and `tick0` if this - is a date axis. This does not set the calendar for interpreting - data on this axis, that's specified in the trace or via the - global `layout.calendar` - - The 'calendar' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['gregorian', 'chinese', 'coptic', 'discworld', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['calendar'] - - @calendar.setter - def calendar(self, val): - self['calendar'] = val - - # categoryarray - # ------------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['categoryarray'] - - @categoryarray.setter - def categoryarray(self, val): - self['categoryarray'] = val - - # categoryarraysrc - # ---------------- - @property - def categoryarraysrc(self): - """ - Sets the source reference on plot.ly for categoryarray . - - The 'categoryarraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['categoryarraysrc'] - - @categoryarraysrc.setter - def categoryarraysrc(self, val): - self['categoryarraysrc'] = val - - # categoryorder - # ------------- - @property - def categoryorder(self): - """ - Specifies the ordering logic for the case of categorical - variables. By default, plotly uses "trace", which specifies the - order that is present in the data supplied. Set `categoryorder` - to *category ascending* or *category descending* if order - should be determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" to derive the - ordering from the attribute `categoryarray`. If a category is - not found in the `categoryarray` array, the sorting behavior - for that attribute will be identical to the "trace" mode. The - unspecified categories will follow the categories in - `categoryarray`. - - The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array'] - - Returns - ------- - Any - """ - return self['categoryorder'] - - @categoryorder.setter - def categoryorder(self, val): - self['categoryorder'] = val - - # color - # ----- - @property - def color(self): - """ - Sets default for all colors associated with this axis all at - once: line, font, tick, and grid colors. Grid color is - lightened by blending this with the plot background Individual - pieces can override this. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # constrain - # --------- - @property - def constrain(self): - """ - If this axis needs to be compressed (either due to its own - `scaleanchor` and `scaleratio` or those of the other axis), - determines how that happens: by increasing the "range" - (default), or by decreasing the "domain". - - The 'constrain' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['range', 'domain'] - - Returns - ------- - Any - """ - return self['constrain'] - - @constrain.setter - def constrain(self, val): - self['constrain'] = val - - # constraintoward - # --------------- - @property - def constraintoward(self): - """ - If this axis needs to be compressed (either due to its own - `scaleanchor` and `scaleratio` or those of the other axis), - determines which direction we push the originally specified - plot area. Options are "left", "center" (default), and "right" - for x axes, and "top", "middle" (default), and "bottom" for y - axes. - - The 'constraintoward' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right', 'top', 'middle', 'bottom'] - - Returns - ------- - Any - """ - return self['constraintoward'] - - @constraintoward.setter - def constraintoward(self, val): - self['constraintoward'] = val - - # dividercolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['dividercolor'] - - @dividercolor.setter - def dividercolor(self, val): - self['dividercolor'] = val - - # dividerwidth - # ------------ - @property - 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 - - Returns - ------- - int|float - """ - return self['dividerwidth'] - - @dividerwidth.setter - def dividerwidth(self, val): - self['dividerwidth'] = val - - # domain - # ------ - @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] - - Returns - ------- - list - """ - return self['domain'] - - @domain.setter - def domain(self, val): - self['domain'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # fixedrange - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['fixedrange'] - - @fixedrange.setter - def fixedrange(self, val): - self['fixedrange'] = val - - # gridcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['gridcolor'] - - @gridcolor.setter - def gridcolor(self, val): - self['gridcolor'] = val - - # gridwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['gridwidth'] - - @gridwidth.setter - def gridwidth(self, val): - self['gridwidth'] = val - - # hoverformat - # ----------- - @property - def hoverformat(self): - """ - Sets the hover text formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'hoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['hoverformat'] - - @hoverformat.setter - def hoverformat(self, val): - self['hoverformat'] = val - - # layer - # ----- - @property - def layer(self): - """ - Sets the layer on which this axis is displayed. If *above - traces*, this axis is displayed above all the subplot's traces - If *below traces*, this axis is displayed below all the - subplot's traces, but above the grid lines. Useful when used - together with scatter-like traces with `cliponaxis` set to - False to show markers and/or text nodes above this axis. - - The 'layer' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['above traces', 'below traces'] - - Returns - ------- - Any - """ - return self['layer'] - - @layer.setter - def layer(self, val): - self['layer'] = val - - # linecolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['linecolor'] - - @linecolor.setter - def linecolor(self, val): - self['linecolor'] = val - - # linewidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['linewidth'] - - @linewidth.setter - def linewidth(self, val): - self['linewidth'] = val - - # matches - # ------- - @property - def matches(self): - """ - If set to another axis id (e.g. `x2`, `y`), the range of this - axis will match the range of the corresponding axis in data- - coordinates space. Moreover, matching axes share auto-range - values, category lists and histogram auto-bins. Note that - setting axes simultaneously in both a `scaleanchor` and a - `matches` constraint is currently forbidden. Moreover, note - that matching axes must have the same `type`. - - 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]+)?$', '^y([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - Any - """ - return self['matches'] - - @matches.setter - def matches(self, val): - self['matches'] = val - - # mirror - # ------ - @property - def mirror(self): - """ - Determines if the axis lines or/and ticks are mirrored to the - opposite side of the plotting area. If True, the axis lines are - mirrored. If "ticks", the axis lines and ticks are mirrored. If - False, mirroring is disable. If "all", axis lines are mirrored - on all shared-axes subplots. If "allticks", axis lines and - ticks are mirrored on all shared-axes subplots. - - The 'mirror' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, 'ticks', False, 'all', 'allticks'] - - Returns - ------- - Any - """ - return self['mirror'] - - @mirror.setter - def mirror(self, val): - self['mirror'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # overlaying - # ---------- - @property - def overlaying(self): - """ - If set a same-letter axis id, this axis is overlaid on top of - the corresponding same-letter axis, with traces and axes - visible for both axes. If False, this axis does not overlay any - same-letter axes. In this case, for axes with overlapping - domains only the highest-numbered axis will be visible. - - The 'overlaying' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['free'] - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?$', '^y([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - Any - """ - return self['overlaying'] - - @overlaying.setter - def overlaying(self, val): - self['overlaying'] = val - - # position - # -------- - @property - 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] - - Returns - ------- - int|float - """ - return self['position'] - - @position.setter - def position(self, val): - self['position'] = val - - # range - # ----- - @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 - - Returns - ------- - list - """ - return self['range'] - - @range.setter - def range(self, val): - self['range'] = val - - # rangemode - # --------- - @property - def rangemode(self): - """ - If "normal", the range is computed in relation to the extrema - of the input data. If *tozero*`, the range extends to 0, - regardless of the input data If "nonnegative", the range is - non-negative, regardless of the input data. Applies only to - linear axes. - - The 'rangemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'tozero', 'nonnegative'] - - Returns - ------- - Any - """ - return self['rangemode'] - - @rangemode.setter - def rangemode(self, val): - self['rangemode'] = val - - # rangeselector - # ------------- - @property - def rangeselector(self): - """ - The 'rangeselector' property is an instance of Rangeselector - that may be specified as: - - An instance of 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. - bgcolor - Sets the background color of the range selector - buttons. - bordercolor - Sets the color of the border enclosing the - range selector. - borderwidth - Sets the width (in px) of the border enclosing - the range selector. - buttons - Sets the specifications for each buttons. By - default, a range selector comes with no - buttons. - buttondefaults - When used in a template (as layout.template.lay - out.xaxis.rangeselector.buttondefaults), sets - the default property values to use for elements - of layout.xaxis.rangeselector.buttons - font - Sets the font of the range selector button - text. - visible - 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". - x - Sets the x position (in normalized coordinates) - of the range selector. - xanchor - Sets the range selector's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the range - selector. - y - Sets the y position (in normalized coordinates) - of the range selector. - yanchor - Sets the range selector's vertical position - anchor This anchor binds the `y` position to - the "top", "middle" or "bottom" of the range - selector. - - Returns - ------- - plotly.graph_objs.layout.xaxis.Rangeselector - """ - return self['rangeselector'] - - @rangeselector.setter - def rangeselector(self, val): - self['rangeselector'] = val - - # rangeslider - # ----------- - @property - def rangeslider(self): - """ - The 'rangeslider' property is an instance of Rangeslider - that may be specified as: - - An instance of 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 - data. If `range` is provided, then `autorange` - is set to False. - bgcolor - Sets the background color of the range slider. - bordercolor - Sets the border color of the range slider. - borderwidth - Sets the border width of the range slider. - range - 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. - thickness - The height of the range slider as a fraction of - the total plot area height. - visible - Determines whether or not the range slider will - be visible. If visible, perpendicular axes will - be set to `fixedrange` - yaxis - plotly.graph_objs.layout.xaxis.rangeslider.YAxi - s instance or dict with compatible properties - - Returns - ------- - plotly.graph_objs.layout.xaxis.Rangeslider - """ - return self['rangeslider'] - - @rangeslider.setter - def rangeslider(self, val): - self['rangeslider'] = val - - # scaleanchor - # ----------- - @property - def scaleanchor(self): - """ - If set to another axis id (e.g. `x2`, `y`), the range of this - axis changes together with the range of the corresponding axis - such that the scale of pixels per unit is in a constant ratio. - Both axes are still zoomable, but when you zoom one, the other - will zoom the same amount, keeping a fixed midpoint. - `constrain` and `constraintoward` determine how we enforce the - constraint. You can chain these, ie `yaxis: {scaleanchor: *x*}, - xaxis2: {scaleanchor: *y*}` but you can only link axes of the - same `type`. The linked axis can have the opposite letter (to - constrain the aspect ratio) or the same letter (to match scales - across subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: - {scaleanchor: *y*}` or longer) are redundant and the last - constraint encountered will be ignored to avoid possible - inconsistent constraints via `scaleratio`. Note that setting - axes simultaneously in both a `scaleanchor` and a `matches` - constraint is currently forbidden. - - 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]+)?$', '^y([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - Any - """ - return self['scaleanchor'] - - @scaleanchor.setter - def scaleanchor(self, val): - self['scaleanchor'] = val - - # scaleratio - # ---------- - @property - def scaleratio(self): - """ - If this axis is linked to another by `scaleanchor`, this - determines the pixel to unit scale ratio. For example, if this - value is 10, then every unit on this axis spans 10 times the - number of pixels as a unit on the linked axis. Use this for - example to create an elevation profile where the vertical scale - is exaggerated a fixed amount with respect to the horizontal. - - The 'scaleratio' property is a number and may be specified as: - - An int or float in the interval [0, inf] - - Returns - ------- - int|float - """ - return self['scaleratio'] - - @scaleratio.setter - def scaleratio(self, val): - self['scaleratio'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showdividers - # ------------ - @property - 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) - - Returns - ------- - bool - """ - return self['showdividers'] - - @showdividers.setter - def showdividers(self, val): - self['showdividers'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showgrid - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showgrid'] - - @showgrid.setter - def showgrid(self, val): - self['showgrid'] = val - - # showline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showline'] - - @showline.setter - def showline(self, val): - self['showline'] = val - - # showspikes - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showspikes'] - - @showspikes.setter - def showspikes(self, val): - self['showspikes'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # spikecolor - # ---------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['spikecolor'] - - @spikecolor.setter - def spikecolor(self, val): - self['spikecolor'] = val - - # spikedash - # --------- - @property - def spikedash(self): - """ - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - - The 'spikedash' property is a string and must be specified as: - - One of the following strings: - ['solid', 'dot', 'dash', 'longdash', 'dashdot', - 'longdashdot'] - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['spikedash'] - - @spikedash.setter - def spikedash(self, val): - self['spikedash'] = val - - # spikemode - # --------- - @property - def spikemode(self): - """ - Determines the drawing mode for the spike line If "toaxis", the - line is drawn from the data point to the axis the series is - plotted on. If "across", the line is drawn across the entire - plot area, and supercedes "toaxis". If "marker", then a marker - dot is drawn on the axis the series is plotted on - - The 'spikemode' property is a flaglist and may be specified - as a string containing: - - Any combination of ['toaxis', 'across', 'marker'] joined with '+' characters - (e.g. 'toaxis+across') - - Returns - ------- - Any - """ - return self['spikemode'] - - @spikemode.setter - def spikemode(self, val): - self['spikemode'] = val - - # spikesnap - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['spikesnap'] - - @spikesnap.setter - def spikesnap(self, val): - self['spikesnap'] = val - - # spikethickness - # -------------- - @property - 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 - - Returns - ------- - int|float - """ - return self['spikethickness'] - - @spikethickness.setter - def spikethickness(self, val): - self['spikethickness'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - def tickfont(self): - """ - Sets the tick font. - - The 'tickfont' property is an instance of Tickfont - that may be specified as: - - An instance of 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.xaxis.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.layout.xaxis.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as - 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 plotly.graph_objs.layout.xaxis.Tickformatstop - - A dict of string/value properties that will be passed - to the Tickformatstop constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.layout.xaxis.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # tickson - # ------- - @property - def tickson(self): - """ - Determines where ticks and grid lines are drawn with respect to - their corresponding tick labels. Only has an effect for axes of - `type` "category" or "multicategory". When set to "boundaries", - ticks and grid lines are drawn half a category to the - left/bottom of labels. - - The 'tickson' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['labels', 'boundaries'] - - Returns - ------- - Any - """ - return self['tickson'] - - @tickson.setter - def tickson(self, val): - self['tickson'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - text - 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. - - Returns - ------- - plotly.graph_objs.layout.xaxis.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # type - # ---- - @property - 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', - 'multicategory'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # uirevision - # ---------- - @property - 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 - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # zeroline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['zeroline'] - - @zeroline.setter - def zeroline(self, val): - self['zeroline'] = val - - # zerolinecolor - # ------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['zerolinecolor'] - - @zerolinecolor.setter - def zerolinecolor(self, val): - self['zerolinecolor'] = val - - # zerolinewidth - # ------------- - @property - 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 - - Returns - ------- - int|float - """ - return self['zerolinewidth'] - - @zerolinewidth.setter - def zerolinewidth(self, val): - self['zerolinewidth'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - anchor - If set to an opposite-letter axis id (e.g. `x2`, `y`), - this axis is bound to the corresponding opposite-letter - axis. If set to "free", this axis' position is - determined by `position`. - automargin - Determines whether long tick labels automatically grow - the figure margins. - autorange - Determines whether or not the range of this axis is - computed in relation to the input data. See `rangemode` - for more info. If `range` is provided, then `autorange` - is set to False. - calendar - Sets the calendar system to use for `range` and `tick0` - if this is a date axis. This does not set the calendar - for interpreting data on this axis, that's specified in - the trace or via the global `layout.calendar` - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - constrain - If this axis needs to be compressed (either due to its - own `scaleanchor` and `scaleratio` or those of the - other axis), determines how that happens: by increasing - the "range" (default), or by decreasing the "domain". - constraintoward - If this axis needs to be compressed (either due to its - own `scaleanchor` and `scaleratio` or those of the - other axis), determines which direction we push the - originally specified plot area. Options are "left", - "center" (default), and "right" for x axes, and "top", - "middle" (default), and "bottom" for y axes. - dividercolor - Sets the color of the dividers Only has an effect on - "multicategory" axes. - dividerwidth - Sets the width (in px) of the dividers Only has an - effect on "multicategory" axes. - domain - Sets the domain of this axis (in plot fraction). - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - fixedrange - Determines whether or not this axis is zoom-able. If - true, then zoom is disabled. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - layer - Sets the layer on which this axis is displayed. If - *above traces*, this axis is displayed above all the - subplot's traces If *below traces*, this axis is - displayed below all the subplot's traces, but above the - grid lines. Useful when used together with scatter-like - traces with `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - matches - If set to another axis id (e.g. `x2`, `y`), the range - of this axis will match the range of the corresponding - axis in data-coordinates space. Moreover, matching axes - share auto-range values, category lists and histogram - auto-bins. Note that setting axes simultaneously in - both a `scaleanchor` and a `matches` constraint is - currently forbidden. Moreover, note that matching axes - must have the same `type`. - mirror - Determines if the axis lines or/and ticks are mirrored - to the opposite side of the plotting area. If True, the - axis lines are mirrored. If "ticks", the axis lines and - ticks are mirrored. If False, mirroring is disable. If - "all", axis lines are mirrored on all shared-axes - subplots. If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - overlaying - If set a same-letter axis id, this axis is overlaid on - top of the corresponding same-letter axis, with traces - and axes visible for both axes. If False, this axis - does not overlay any same-letter axes. In this case, - for axes with overlapping domains only the highest- - numbered axis will be visible. - position - Sets the position of this axis in the plotting space - (in normalized coordinates). Only has an effect if - `anchor` is set to "free". - range - Sets the range of this axis. If the axis `type` is - "log", then you must take the log of your desired range - (e.g. to set the range from 1 to 100, set the range - from 0 to 2). If the axis `type` is "date", it should - be date strings, like date data, though Date objects - and unix milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order it - appears. - rangemode - If "normal", the range is computed in relation to the - extrema of the input data. If *tozero*`, the range - extends to 0, regardless of the input data If - "nonnegative", the range is non-negative, regardless of - the input data. Applies only to linear axes. - rangeselector - plotly.graph_objs.layout.xaxis.Rangeselector instance - or dict with compatible properties - rangeslider - plotly.graph_objs.layout.xaxis.Rangeslider instance or - dict with compatible properties - scaleanchor - If set to another axis id (e.g. `x2`, `y`), the range - of this axis changes together with the range of the - corresponding axis such that the scale of pixels per - unit is in a constant ratio. Both axes are still - zoomable, but when you zoom one, the other will zoom - the same amount, keeping a fixed midpoint. `constrain` - and `constraintoward` determine how we enforce the - constraint. You can chain these, ie `yaxis: - {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` but you - can only link axes of the same `type`. The linked axis - can have the opposite letter (to constrain the aspect - ratio) or the same letter (to match scales across - subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: - {scaleanchor: *y*}` or longer) are redundant and the - last constraint encountered will be ignored to avoid - possible inconsistent constraints via `scaleratio`. - Note that setting axes simultaneously in both a - `scaleanchor` and a `matches` constraint is currently - forbidden. - scaleratio - If this axis is linked to another by `scaleanchor`, - this determines the pixel to unit scale ratio. For - example, if this value is 10, then every unit on this - axis spans 10 times the number of pixels as a unit on - the linked axis. Use this for example to create an - elevation profile where the vertical scale is - exaggerated a fixed amount with respect to the - horizontal. - separatethousands - If "true", even 4-digit integers are separated - showdividers - Determines whether or not a dividers are drawn between - the category levels of this axis. Only has an effect on - "multicategory" axes. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showspikes - Determines whether or not spikes (aka droplines) are - drawn for this axis. Note: This only takes affect when - hovermode = closest - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - side - Determines whether a x (y) axis is positioned at the - "bottom" ("left") or "top" ("right") of the plotting - area. - spikecolor - Sets the spike color. If undefined, will use the series - color - spikedash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - spikemode - Determines the drawing mode for the spike line If - "toaxis", the line is drawn from the data point to the - axis the series is plotted on. If "across", the line - is drawn across the entire plot area, and supercedes - "toaxis". If "marker", then a marker dot is drawn on - the axis the series is plotted on - spikesnap - Determines whether spikelines are stuck to the cursor - or to the closest datapoints. - spikethickness - Sets the width (in px) of the zero line. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.xaxis.Tickformatstop instance - or dict with compatible properties - tickformatstopdefaults - When used in a template (as - layout.template.layout.xaxis.tickformatstopdefaults), - sets the default property values to use for elements of - layout.xaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - tickson - Determines where ticks and grid lines are drawn with - respect to their corresponding tick labels. Only has an - effect for axes of `type` "category" or - "multicategory". When set to "boundaries", ticks and - grid lines are drawn half a category to the left/bottom - of labels. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.xaxis.Title instance or dict - with compatible properties - titlefont - Deprecated: Please use layout.xaxis.title.font instead. - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - type - Sets the axis type. By default, plotly attempts to - determined the axis type by looking into the data of - the traces that referenced the axis in question. - uirevision - Controls persistence of user-driven changes in axis - `range`, `autorange`, and `title` if in `editable: - true` configuration. Defaults to `layout.uirevision`. - visible - A single toggle to hide the axis while preserving - interaction like dragging. Default is true when a - cheater plot is present on the axis, otherwise false - zeroline - Determines whether or not a line is drawn at along the - 0 value of this axis. If True, the zero line is drawn - on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. - """ - - _mapped_properties = {'titlefont': ('title', 'font')} - - def __init__( - self, - arg=None, - anchor=None, - automargin=None, - autorange=None, - calendar=None, - categoryarray=None, - categoryarraysrc=None, - categoryorder=None, - color=None, - constrain=None, - constraintoward=None, - dividercolor=None, - dividerwidth=None, - domain=None, - dtick=None, - exponentformat=None, - fixedrange=None, - gridcolor=None, - gridwidth=None, - hoverformat=None, - layer=None, - linecolor=None, - linewidth=None, - matches=None, - mirror=None, - nticks=None, - overlaying=None, - position=None, - range=None, - rangemode=None, - rangeselector=None, - rangeslider=None, - scaleanchor=None, - scaleratio=None, - separatethousands=None, - showdividers=None, - showexponent=None, - showgrid=None, - showline=None, - showspikes=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - side=None, - spikecolor=None, - spikedash=None, - spikemode=None, - spikesnap=None, - spikethickness=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - tickson=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - type=None, - uirevision=None, - visible=None, - zeroline=None, - zerolinecolor=None, - zerolinewidth=None, - **kwargs - ): - """ - Construct a new XAxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.XAxis - anchor - If set to an opposite-letter axis id (e.g. `x2`, `y`), - this axis is bound to the corresponding opposite-letter - axis. If set to "free", this axis' position is - determined by `position`. - automargin - Determines whether long tick labels automatically grow - the figure margins. - autorange - Determines whether or not the range of this axis is - computed in relation to the input data. See `rangemode` - for more info. If `range` is provided, then `autorange` - is set to False. - calendar - Sets the calendar system to use for `range` and `tick0` - if this is a date axis. This does not set the calendar - for interpreting data on this axis, that's specified in - the trace or via the global `layout.calendar` - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - constrain - If this axis needs to be compressed (either due to its - own `scaleanchor` and `scaleratio` or those of the - other axis), determines how that happens: by increasing - the "range" (default), or by decreasing the "domain". - constraintoward - If this axis needs to be compressed (either due to its - own `scaleanchor` and `scaleratio` or those of the - other axis), determines which direction we push the - originally specified plot area. Options are "left", - "center" (default), and "right" for x axes, and "top", - "middle" (default), and "bottom" for y axes. - dividercolor - Sets the color of the dividers Only has an effect on - "multicategory" axes. - dividerwidth - Sets the width (in px) of the dividers Only has an - effect on "multicategory" axes. - domain - Sets the domain of this axis (in plot fraction). - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - fixedrange - Determines whether or not this axis is zoom-able. If - true, then zoom is disabled. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - layer - Sets the layer on which this axis is displayed. If - *above traces*, this axis is displayed above all the - subplot's traces If *below traces*, this axis is - displayed below all the subplot's traces, but above the - grid lines. Useful when used together with scatter-like - traces with `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - matches - If set to another axis id (e.g. `x2`, `y`), the range - of this axis will match the range of the corresponding - axis in data-coordinates space. Moreover, matching axes - share auto-range values, category lists and histogram - auto-bins. Note that setting axes simultaneously in - both a `scaleanchor` and a `matches` constraint is - currently forbidden. Moreover, note that matching axes - must have the same `type`. - mirror - Determines if the axis lines or/and ticks are mirrored - to the opposite side of the plotting area. If True, the - axis lines are mirrored. If "ticks", the axis lines and - ticks are mirrored. If False, mirroring is disable. If - "all", axis lines are mirrored on all shared-axes - subplots. If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - overlaying - If set a same-letter axis id, this axis is overlaid on - top of the corresponding same-letter axis, with traces - and axes visible for both axes. If False, this axis - does not overlay any same-letter axes. In this case, - for axes with overlapping domains only the highest- - numbered axis will be visible. - position - Sets the position of this axis in the plotting space - (in normalized coordinates). Only has an effect if - `anchor` is set to "free". - range - Sets the range of this axis. If the axis `type` is - "log", then you must take the log of your desired range - (e.g. to set the range from 1 to 100, set the range - from 0 to 2). If the axis `type` is "date", it should - be date strings, like date data, though Date objects - and unix milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order it - appears. - rangemode - If "normal", the range is computed in relation to the - extrema of the input data. If *tozero*`, the range - extends to 0, regardless of the input data If - "nonnegative", the range is non-negative, regardless of - the input data. Applies only to linear axes. - rangeselector - plotly.graph_objs.layout.xaxis.Rangeselector instance - or dict with compatible properties - rangeslider - plotly.graph_objs.layout.xaxis.Rangeslider instance or - dict with compatible properties - scaleanchor - If set to another axis id (e.g. `x2`, `y`), the range - of this axis changes together with the range of the - corresponding axis such that the scale of pixels per - unit is in a constant ratio. Both axes are still - zoomable, but when you zoom one, the other will zoom - the same amount, keeping a fixed midpoint. `constrain` - and `constraintoward` determine how we enforce the - constraint. You can chain these, ie `yaxis: - {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` but you - can only link axes of the same `type`. The linked axis - can have the opposite letter (to constrain the aspect - ratio) or the same letter (to match scales across - subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: - {scaleanchor: *y*}` or longer) are redundant and the - last constraint encountered will be ignored to avoid - possible inconsistent constraints via `scaleratio`. - Note that setting axes simultaneously in both a - `scaleanchor` and a `matches` constraint is currently - forbidden. - scaleratio - If this axis is linked to another by `scaleanchor`, - this determines the pixel to unit scale ratio. For - example, if this value is 10, then every unit on this - axis spans 10 times the number of pixels as a unit on - the linked axis. Use this for example to create an - elevation profile where the vertical scale is - exaggerated a fixed amount with respect to the - horizontal. - separatethousands - If "true", even 4-digit integers are separated - showdividers - Determines whether or not a dividers are drawn between - the category levels of this axis. Only has an effect on - "multicategory" axes. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showspikes - Determines whether or not spikes (aka droplines) are - drawn for this axis. Note: This only takes affect when - hovermode = closest - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - side - Determines whether a x (y) axis is positioned at the - "bottom" ("left") or "top" ("right") of the plotting - area. - spikecolor - Sets the spike color. If undefined, will use the series - color - spikedash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - spikemode - Determines the drawing mode for the spike line If - "toaxis", the line is drawn from the data point to the - axis the series is plotted on. If "across", the line - is drawn across the entire plot area, and supercedes - "toaxis". If "marker", then a marker dot is drawn on - the axis the series is plotted on - spikesnap - Determines whether spikelines are stuck to the cursor - or to the closest datapoints. - spikethickness - Sets the width (in px) of the zero line. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.xaxis.Tickformatstop instance - or dict with compatible properties - tickformatstopdefaults - When used in a template (as - layout.template.layout.xaxis.tickformatstopdefaults), - sets the default property values to use for elements of - layout.xaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - tickson - Determines where ticks and grid lines are drawn with - respect to their corresponding tick labels. Only has an - effect for axes of `type` "category" or - "multicategory". When set to "boundaries", ticks and - grid lines are drawn half a category to the left/bottom - of labels. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.xaxis.Title instance or dict - with compatible properties - titlefont - Deprecated: Please use layout.xaxis.title.font instead. - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - type - Sets the axis type. By default, plotly attempts to - determined the axis type by looking into the data of - the traces that referenced the axis in question. - uirevision - Controls persistence of user-driven changes in axis - `range`, `autorange`, and `title` if in `editable: - true` configuration. Defaults to `layout.uirevision`. - visible - A single toggle to hide the axis while preserving - interaction like dragging. Default is true when a - cheater plot is present on the axis, otherwise false - zeroline - Determines whether or not a line is drawn at along the - 0 value of this axis. If True, the zero line is drawn - on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. - - Returns - ------- - XAxis - """ - super(XAxis, self).__init__('xaxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.XAxis -constructor must be a dict or -an instance of plotly.graph_objs.layout.XAxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (xaxis as v_xaxis) - - # Initialize validators - # --------------------- - self._validators['anchor'] = v_xaxis.AnchorValidator() - self._validators['automargin'] = v_xaxis.AutomarginValidator() - self._validators['autorange'] = v_xaxis.AutorangeValidator() - self._validators['calendar'] = v_xaxis.CalendarValidator() - self._validators['categoryarray'] = v_xaxis.CategoryarrayValidator() - self._validators['categoryarraysrc' - ] = v_xaxis.CategoryarraysrcValidator() - self._validators['categoryorder'] = v_xaxis.CategoryorderValidator() - self._validators['color'] = v_xaxis.ColorValidator() - self._validators['constrain'] = v_xaxis.ConstrainValidator() - self._validators['constraintoward'] = v_xaxis.ConstraintowardValidator( - ) - self._validators['dividercolor'] = v_xaxis.DividercolorValidator() - self._validators['dividerwidth'] = v_xaxis.DividerwidthValidator() - self._validators['domain'] = v_xaxis.DomainValidator() - self._validators['dtick'] = v_xaxis.DtickValidator() - self._validators['exponentformat'] = v_xaxis.ExponentformatValidator() - self._validators['fixedrange'] = v_xaxis.FixedrangeValidator() - self._validators['gridcolor'] = v_xaxis.GridcolorValidator() - self._validators['gridwidth'] = v_xaxis.GridwidthValidator() - self._validators['hoverformat'] = v_xaxis.HoverformatValidator() - self._validators['layer'] = v_xaxis.LayerValidator() - self._validators['linecolor'] = v_xaxis.LinecolorValidator() - self._validators['linewidth'] = v_xaxis.LinewidthValidator() - self._validators['matches'] = v_xaxis.MatchesValidator() - self._validators['mirror'] = v_xaxis.MirrorValidator() - self._validators['nticks'] = v_xaxis.NticksValidator() - self._validators['overlaying'] = v_xaxis.OverlayingValidator() - self._validators['position'] = v_xaxis.PositionValidator() - self._validators['range'] = v_xaxis.RangeValidator() - self._validators['rangemode'] = v_xaxis.RangemodeValidator() - self._validators['rangeselector'] = v_xaxis.RangeselectorValidator() - self._validators['rangeslider'] = v_xaxis.RangesliderValidator() - self._validators['scaleanchor'] = v_xaxis.ScaleanchorValidator() - self._validators['scaleratio'] = v_xaxis.ScaleratioValidator() - self._validators['separatethousands' - ] = v_xaxis.SeparatethousandsValidator() - self._validators['showdividers'] = v_xaxis.ShowdividersValidator() - self._validators['showexponent'] = v_xaxis.ShowexponentValidator() - self._validators['showgrid'] = v_xaxis.ShowgridValidator() - self._validators['showline'] = v_xaxis.ShowlineValidator() - self._validators['showspikes'] = v_xaxis.ShowspikesValidator() - self._validators['showticklabels'] = v_xaxis.ShowticklabelsValidator() - self._validators['showtickprefix'] = v_xaxis.ShowtickprefixValidator() - self._validators['showticksuffix'] = v_xaxis.ShowticksuffixValidator() - self._validators['side'] = v_xaxis.SideValidator() - self._validators['spikecolor'] = v_xaxis.SpikecolorValidator() - self._validators['spikedash'] = v_xaxis.SpikedashValidator() - self._validators['spikemode'] = v_xaxis.SpikemodeValidator() - self._validators['spikesnap'] = v_xaxis.SpikesnapValidator() - self._validators['spikethickness'] = v_xaxis.SpikethicknessValidator() - self._validators['tick0'] = v_xaxis.Tick0Validator() - self._validators['tickangle'] = v_xaxis.TickangleValidator() - self._validators['tickcolor'] = v_xaxis.TickcolorValidator() - self._validators['tickfont'] = v_xaxis.TickfontValidator() - self._validators['tickformat'] = v_xaxis.TickformatValidator() - self._validators['tickformatstops'] = v_xaxis.TickformatstopsValidator( - ) - self._validators['tickformatstopdefaults' - ] = v_xaxis.TickformatstopValidator() - self._validators['ticklen'] = v_xaxis.TicklenValidator() - self._validators['tickmode'] = v_xaxis.TickmodeValidator() - self._validators['tickprefix'] = v_xaxis.TickprefixValidator() - self._validators['ticks'] = v_xaxis.TicksValidator() - self._validators['tickson'] = v_xaxis.TicksonValidator() - self._validators['ticksuffix'] = v_xaxis.TicksuffixValidator() - self._validators['ticktext'] = v_xaxis.TicktextValidator() - self._validators['ticktextsrc'] = v_xaxis.TicktextsrcValidator() - self._validators['tickvals'] = v_xaxis.TickvalsValidator() - self._validators['tickvalssrc'] = v_xaxis.TickvalssrcValidator() - self._validators['tickwidth'] = v_xaxis.TickwidthValidator() - self._validators['title'] = v_xaxis.TitleValidator() - self._validators['type'] = v_xaxis.TypeValidator() - self._validators['uirevision'] = v_xaxis.UirevisionValidator() - self._validators['visible'] = v_xaxis.VisibleValidator() - self._validators['zeroline'] = v_xaxis.ZerolineValidator() - self._validators['zerolinecolor'] = v_xaxis.ZerolinecolorValidator() - self._validators['zerolinewidth'] = v_xaxis.ZerolinewidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('anchor', None) - self['anchor'] = anchor if anchor is not None else _v - _v = arg.pop('automargin', None) - self['automargin'] = automargin if automargin is not None else _v - _v = arg.pop('autorange', None) - self['autorange'] = autorange if autorange is not None else _v - _v = arg.pop('calendar', None) - self['calendar'] = calendar if calendar is not None else _v - _v = arg.pop('categoryarray', None) - self['categoryarray' - ] = categoryarray if categoryarray is not None else _v - _v = arg.pop('categoryarraysrc', None) - self['categoryarraysrc' - ] = categoryarraysrc if categoryarraysrc is not None else _v - _v = arg.pop('categoryorder', None) - self['categoryorder' - ] = categoryorder if categoryorder is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('constrain', None) - self['constrain'] = constrain if constrain is not None else _v - _v = arg.pop('constraintoward', None) - self['constraintoward' - ] = constraintoward if constraintoward is not None else _v - _v = arg.pop('dividercolor', None) - self['dividercolor'] = dividercolor if dividercolor is not None else _v - _v = arg.pop('dividerwidth', None) - self['dividerwidth'] = dividerwidth if dividerwidth is not None else _v - _v = arg.pop('domain', None) - self['domain'] = domain if domain is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('fixedrange', None) - self['fixedrange'] = fixedrange if fixedrange is not None else _v - _v = arg.pop('gridcolor', None) - self['gridcolor'] = gridcolor if gridcolor is not None else _v - _v = arg.pop('gridwidth', None) - self['gridwidth'] = gridwidth if gridwidth is not None else _v - _v = arg.pop('hoverformat', None) - self['hoverformat'] = hoverformat if hoverformat is not None else _v - _v = arg.pop('layer', None) - self['layer'] = layer if layer is not None else _v - _v = arg.pop('linecolor', None) - self['linecolor'] = linecolor if linecolor is not None else _v - _v = arg.pop('linewidth', None) - self['linewidth'] = linewidth if linewidth is not None else _v - _v = arg.pop('matches', None) - self['matches'] = matches if matches is not None else _v - _v = arg.pop('mirror', None) - self['mirror'] = mirror if mirror is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('overlaying', None) - self['overlaying'] = overlaying if overlaying is not None else _v - _v = arg.pop('position', None) - self['position'] = position if position is not None else _v - _v = arg.pop('range', None) - self['range'] = range if range is not None else _v - _v = arg.pop('rangemode', None) - self['rangemode'] = rangemode if rangemode is not None else _v - _v = arg.pop('rangeselector', None) - self['rangeselector' - ] = rangeselector if rangeselector is not None else _v - _v = arg.pop('rangeslider', None) - self['rangeslider'] = rangeslider if rangeslider is not None else _v - _v = arg.pop('scaleanchor', None) - self['scaleanchor'] = scaleanchor if scaleanchor is not None else _v - _v = arg.pop('scaleratio', None) - self['scaleratio'] = scaleratio if scaleratio is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showdividers', None) - self['showdividers'] = showdividers if showdividers is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showgrid', None) - self['showgrid'] = showgrid if showgrid is not None else _v - _v = arg.pop('showline', None) - self['showline'] = showline if showline is not None else _v - _v = arg.pop('showspikes', None) - self['showspikes'] = showspikes if showspikes is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('spikecolor', None) - self['spikecolor'] = spikecolor if spikecolor is not None else _v - _v = arg.pop('spikedash', None) - self['spikedash'] = spikedash if spikedash is not None else _v - _v = arg.pop('spikemode', None) - self['spikemode'] = spikemode if spikemode is not None else _v - _v = arg.pop('spikesnap', None) - self['spikesnap'] = spikesnap if spikesnap is not None else _v - _v = arg.pop('spikethickness', None) - self['spikethickness' - ] = spikethickness if spikethickness is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('tickson', None) - self['tickson'] = tickson if tickson is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('zeroline', None) - self['zeroline'] = zeroline if zeroline is not None else _v - _v = arg.pop('zerolinecolor', None) - self['zerolinecolor' - ] = zerolinecolor if zerolinecolor is not None else _v - _v = arg.pop('zerolinewidth', None) - self['zerolinewidth' - ] = zerolinewidth if zerolinewidth is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/_yaxis.py b/plotly/graph_objs/layout/_yaxis.py deleted file mode 100644 index 4dc75eac8cb..00000000000 --- a/plotly/graph_objs/layout/_yaxis.py +++ /dev/null @@ -1,3167 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class YAxis(BaseLayoutHierarchyType): - - # anchor - # ------ - @property - 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'] - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?$', '^y([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - Any - """ - return self['anchor'] - - @anchor.setter - def anchor(self, val): - self['anchor'] = val - - # automargin - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['automargin'] - - @automargin.setter - def automargin(self, val): - self['automargin'] = val - - # autorange - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['autorange'] - - @autorange.setter - def autorange(self, val): - self['autorange'] = val - - # calendar - # -------- - @property - def calendar(self): - """ - Sets the calendar system to use for `range` and `tick0` if this - is a date axis. This does not set the calendar for interpreting - data on this axis, that's specified in the trace or via the - global `layout.calendar` - - The 'calendar' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['gregorian', 'chinese', 'coptic', 'discworld', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['calendar'] - - @calendar.setter - def calendar(self, val): - self['calendar'] = val - - # categoryarray - # ------------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['categoryarray'] - - @categoryarray.setter - def categoryarray(self, val): - self['categoryarray'] = val - - # categoryarraysrc - # ---------------- - @property - def categoryarraysrc(self): - """ - Sets the source reference on plot.ly for categoryarray . - - The 'categoryarraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['categoryarraysrc'] - - @categoryarraysrc.setter - def categoryarraysrc(self, val): - self['categoryarraysrc'] = val - - # categoryorder - # ------------- - @property - def categoryorder(self): - """ - Specifies the ordering logic for the case of categorical - variables. By default, plotly uses "trace", which specifies the - order that is present in the data supplied. Set `categoryorder` - to *category ascending* or *category descending* if order - should be determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" to derive the - ordering from the attribute `categoryarray`. If a category is - not found in the `categoryarray` array, the sorting behavior - for that attribute will be identical to the "trace" mode. The - unspecified categories will follow the categories in - `categoryarray`. - - The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array'] - - Returns - ------- - Any - """ - return self['categoryorder'] - - @categoryorder.setter - def categoryorder(self, val): - self['categoryorder'] = val - - # color - # ----- - @property - def color(self): - """ - Sets default for all colors associated with this axis all at - once: line, font, tick, and grid colors. Grid color is - lightened by blending this with the plot background Individual - pieces can override this. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # constrain - # --------- - @property - def constrain(self): - """ - If this axis needs to be compressed (either due to its own - `scaleanchor` and `scaleratio` or those of the other axis), - determines how that happens: by increasing the "range" - (default), or by decreasing the "domain". - - The 'constrain' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['range', 'domain'] - - Returns - ------- - Any - """ - return self['constrain'] - - @constrain.setter - def constrain(self, val): - self['constrain'] = val - - # constraintoward - # --------------- - @property - def constraintoward(self): - """ - If this axis needs to be compressed (either due to its own - `scaleanchor` and `scaleratio` or those of the other axis), - determines which direction we push the originally specified - plot area. Options are "left", "center" (default), and "right" - for x axes, and "top", "middle" (default), and "bottom" for y - axes. - - The 'constraintoward' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['left', 'center', 'right', 'top', 'middle', 'bottom'] - - Returns - ------- - Any - """ - return self['constraintoward'] - - @constraintoward.setter - def constraintoward(self, val): - self['constraintoward'] = val - - # dividercolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['dividercolor'] - - @dividercolor.setter - def dividercolor(self, val): - self['dividercolor'] = val - - # dividerwidth - # ------------ - @property - 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 - - Returns - ------- - int|float - """ - return self['dividerwidth'] - - @dividerwidth.setter - def dividerwidth(self, val): - self['dividerwidth'] = val - - # domain - # ------ - @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] - - Returns - ------- - list - """ - return self['domain'] - - @domain.setter - def domain(self, val): - self['domain'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # fixedrange - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['fixedrange'] - - @fixedrange.setter - def fixedrange(self, val): - self['fixedrange'] = val - - # gridcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['gridcolor'] - - @gridcolor.setter - def gridcolor(self, val): - self['gridcolor'] = val - - # gridwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['gridwidth'] - - @gridwidth.setter - def gridwidth(self, val): - self['gridwidth'] = val - - # hoverformat - # ----------- - @property - def hoverformat(self): - """ - Sets the hover text formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'hoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['hoverformat'] - - @hoverformat.setter - def hoverformat(self, val): - self['hoverformat'] = val - - # layer - # ----- - @property - def layer(self): - """ - Sets the layer on which this axis is displayed. If *above - traces*, this axis is displayed above all the subplot's traces - If *below traces*, this axis is displayed below all the - subplot's traces, but above the grid lines. Useful when used - together with scatter-like traces with `cliponaxis` set to - False to show markers and/or text nodes above this axis. - - The 'layer' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['above traces', 'below traces'] - - Returns - ------- - Any - """ - return self['layer'] - - @layer.setter - def layer(self, val): - self['layer'] = val - - # linecolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['linecolor'] - - @linecolor.setter - def linecolor(self, val): - self['linecolor'] = val - - # linewidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['linewidth'] - - @linewidth.setter - def linewidth(self, val): - self['linewidth'] = val - - # matches - # ------- - @property - def matches(self): - """ - If set to another axis id (e.g. `x2`, `y`), the range of this - axis will match the range of the corresponding axis in data- - coordinates space. Moreover, matching axes share auto-range - values, category lists and histogram auto-bins. Note that - setting axes simultaneously in both a `scaleanchor` and a - `matches` constraint is currently forbidden. Moreover, note - that matching axes must have the same `type`. - - 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]+)?$', '^y([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - Any - """ - return self['matches'] - - @matches.setter - def matches(self, val): - self['matches'] = val - - # mirror - # ------ - @property - def mirror(self): - """ - Determines if the axis lines or/and ticks are mirrored to the - opposite side of the plotting area. If True, the axis lines are - mirrored. If "ticks", the axis lines and ticks are mirrored. If - False, mirroring is disable. If "all", axis lines are mirrored - on all shared-axes subplots. If "allticks", axis lines and - ticks are mirrored on all shared-axes subplots. - - The 'mirror' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, 'ticks', False, 'all', 'allticks'] - - Returns - ------- - Any - """ - return self['mirror'] - - @mirror.setter - def mirror(self, val): - self['mirror'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # overlaying - # ---------- - @property - def overlaying(self): - """ - If set a same-letter axis id, this axis is overlaid on top of - the corresponding same-letter axis, with traces and axes - visible for both axes. If False, this axis does not overlay any - same-letter axes. In this case, for axes with overlapping - domains only the highest-numbered axis will be visible. - - The 'overlaying' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['free'] - - A string that matches one of the following regular expressions: - ['^x([2-9]|[1-9][0-9]+)?$', '^y([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - Any - """ - return self['overlaying'] - - @overlaying.setter - def overlaying(self, val): - self['overlaying'] = val - - # position - # -------- - @property - 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] - - Returns - ------- - int|float - """ - return self['position'] - - @position.setter - def position(self, val): - self['position'] = val - - # range - # ----- - @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 - - Returns - ------- - list - """ - return self['range'] - - @range.setter - def range(self, val): - self['range'] = val - - # rangemode - # --------- - @property - def rangemode(self): - """ - If "normal", the range is computed in relation to the extrema - of the input data. If *tozero*`, the range extends to 0, - regardless of the input data If "nonnegative", the range is - non-negative, regardless of the input data. Applies only to - linear axes. - - The 'rangemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'tozero', 'nonnegative'] - - Returns - ------- - Any - """ - return self['rangemode'] - - @rangemode.setter - def rangemode(self, val): - self['rangemode'] = val - - # scaleanchor - # ----------- - @property - def scaleanchor(self): - """ - If set to another axis id (e.g. `x2`, `y`), the range of this - axis changes together with the range of the corresponding axis - such that the scale of pixels per unit is in a constant ratio. - Both axes are still zoomable, but when you zoom one, the other - will zoom the same amount, keeping a fixed midpoint. - `constrain` and `constraintoward` determine how we enforce the - constraint. You can chain these, ie `yaxis: {scaleanchor: *x*}, - xaxis2: {scaleanchor: *y*}` but you can only link axes of the - same `type`. The linked axis can have the opposite letter (to - constrain the aspect ratio) or the same letter (to match scales - across subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: - {scaleanchor: *y*}` or longer) are redundant and the last - constraint encountered will be ignored to avoid possible - inconsistent constraints via `scaleratio`. Note that setting - axes simultaneously in both a `scaleanchor` and a `matches` - constraint is currently forbidden. - - 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]+)?$', '^y([2-9]|[1-9][0-9]+)?$'] - - Returns - ------- - Any - """ - return self['scaleanchor'] - - @scaleanchor.setter - def scaleanchor(self, val): - self['scaleanchor'] = val - - # scaleratio - # ---------- - @property - def scaleratio(self): - """ - If this axis is linked to another by `scaleanchor`, this - determines the pixel to unit scale ratio. For example, if this - value is 10, then every unit on this axis spans 10 times the - number of pixels as a unit on the linked axis. Use this for - example to create an elevation profile where the vertical scale - is exaggerated a fixed amount with respect to the horizontal. - - The 'scaleratio' property is a number and may be specified as: - - An int or float in the interval [0, inf] - - Returns - ------- - int|float - """ - return self['scaleratio'] - - @scaleratio.setter - def scaleratio(self, val): - self['scaleratio'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showdividers - # ------------ - @property - 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) - - Returns - ------- - bool - """ - return self['showdividers'] - - @showdividers.setter - def showdividers(self, val): - self['showdividers'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showgrid - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showgrid'] - - @showgrid.setter - def showgrid(self, val): - self['showgrid'] = val - - # showline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showline'] - - @showline.setter - def showline(self, val): - self['showline'] = val - - # showspikes - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showspikes'] - - @showspikes.setter - def showspikes(self, val): - self['showspikes'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # spikecolor - # ---------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['spikecolor'] - - @spikecolor.setter - def spikecolor(self, val): - self['spikecolor'] = val - - # spikedash - # --------- - @property - def spikedash(self): - """ - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - - The 'spikedash' property is a string and must be specified as: - - One of the following strings: - ['solid', 'dot', 'dash', 'longdash', 'dashdot', - 'longdashdot'] - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['spikedash'] - - @spikedash.setter - def spikedash(self, val): - self['spikedash'] = val - - # spikemode - # --------- - @property - def spikemode(self): - """ - Determines the drawing mode for the spike line If "toaxis", the - line is drawn from the data point to the axis the series is - plotted on. If "across", the line is drawn across the entire - plot area, and supercedes "toaxis". If "marker", then a marker - dot is drawn on the axis the series is plotted on - - The 'spikemode' property is a flaglist and may be specified - as a string containing: - - Any combination of ['toaxis', 'across', 'marker'] joined with '+' characters - (e.g. 'toaxis+across') - - Returns - ------- - Any - """ - return self['spikemode'] - - @spikemode.setter - def spikemode(self, val): - self['spikemode'] = val - - # spikesnap - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['spikesnap'] - - @spikesnap.setter - def spikesnap(self, val): - self['spikesnap'] = val - - # spikethickness - # -------------- - @property - 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 - - Returns - ------- - int|float - """ - return self['spikethickness'] - - @spikethickness.setter - def spikethickness(self, val): - self['spikethickness'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - def tickfont(self): - """ - Sets the tick font. - - The 'tickfont' property is an instance of Tickfont - that may be specified as: - - An instance of 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.yaxis.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.layout.yaxis.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as - 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 plotly.graph_objs.layout.yaxis.Tickformatstop - - A dict of string/value properties that will be passed - to the Tickformatstop constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.layout.yaxis.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # tickson - # ------- - @property - def tickson(self): - """ - Determines where ticks and grid lines are drawn with respect to - their corresponding tick labels. Only has an effect for axes of - `type` "category" or "multicategory". When set to "boundaries", - ticks and grid lines are drawn half a category to the - left/bottom of labels. - - The 'tickson' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['labels', 'boundaries'] - - Returns - ------- - Any - """ - return self['tickson'] - - @tickson.setter - def tickson(self, val): - self['tickson'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - text - 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. - - Returns - ------- - plotly.graph_objs.layout.yaxis.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # type - # ---- - @property - 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', - 'multicategory'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # uirevision - # ---------- - @property - 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 - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # zeroline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['zeroline'] - - @zeroline.setter - def zeroline(self, val): - self['zeroline'] = val - - # zerolinecolor - # ------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['zerolinecolor'] - - @zerolinecolor.setter - def zerolinecolor(self, val): - self['zerolinecolor'] = val - - # zerolinewidth - # ------------- - @property - 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 - - Returns - ------- - int|float - """ - return self['zerolinewidth'] - - @zerolinewidth.setter - def zerolinewidth(self, val): - self['zerolinewidth'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - anchor - If set to an opposite-letter axis id (e.g. `x2`, `y`), - this axis is bound to the corresponding opposite-letter - axis. If set to "free", this axis' position is - determined by `position`. - automargin - Determines whether long tick labels automatically grow - the figure margins. - autorange - Determines whether or not the range of this axis is - computed in relation to the input data. See `rangemode` - for more info. If `range` is provided, then `autorange` - is set to False. - calendar - Sets the calendar system to use for `range` and `tick0` - if this is a date axis. This does not set the calendar - for interpreting data on this axis, that's specified in - the trace or via the global `layout.calendar` - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - constrain - If this axis needs to be compressed (either due to its - own `scaleanchor` and `scaleratio` or those of the - other axis), determines how that happens: by increasing - the "range" (default), or by decreasing the "domain". - constraintoward - If this axis needs to be compressed (either due to its - own `scaleanchor` and `scaleratio` or those of the - other axis), determines which direction we push the - originally specified plot area. Options are "left", - "center" (default), and "right" for x axes, and "top", - "middle" (default), and "bottom" for y axes. - dividercolor - Sets the color of the dividers Only has an effect on - "multicategory" axes. - dividerwidth - Sets the width (in px) of the dividers Only has an - effect on "multicategory" axes. - domain - Sets the domain of this axis (in plot fraction). - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - fixedrange - Determines whether or not this axis is zoom-able. If - true, then zoom is disabled. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - layer - Sets the layer on which this axis is displayed. If - *above traces*, this axis is displayed above all the - subplot's traces If *below traces*, this axis is - displayed below all the subplot's traces, but above the - grid lines. Useful when used together with scatter-like - traces with `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - matches - If set to another axis id (e.g. `x2`, `y`), the range - of this axis will match the range of the corresponding - axis in data-coordinates space. Moreover, matching axes - share auto-range values, category lists and histogram - auto-bins. Note that setting axes simultaneously in - both a `scaleanchor` and a `matches` constraint is - currently forbidden. Moreover, note that matching axes - must have the same `type`. - mirror - Determines if the axis lines or/and ticks are mirrored - to the opposite side of the plotting area. If True, the - axis lines are mirrored. If "ticks", the axis lines and - ticks are mirrored. If False, mirroring is disable. If - "all", axis lines are mirrored on all shared-axes - subplots. If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - overlaying - If set a same-letter axis id, this axis is overlaid on - top of the corresponding same-letter axis, with traces - and axes visible for both axes. If False, this axis - does not overlay any same-letter axes. In this case, - for axes with overlapping domains only the highest- - numbered axis will be visible. - position - Sets the position of this axis in the plotting space - (in normalized coordinates). Only has an effect if - `anchor` is set to "free". - range - Sets the range of this axis. If the axis `type` is - "log", then you must take the log of your desired range - (e.g. to set the range from 1 to 100, set the range - from 0 to 2). If the axis `type` is "date", it should - be date strings, like date data, though Date objects - and unix milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order it - appears. - rangemode - If "normal", the range is computed in relation to the - extrema of the input data. If *tozero*`, the range - extends to 0, regardless of the input data If - "nonnegative", the range is non-negative, regardless of - the input data. Applies only to linear axes. - scaleanchor - If set to another axis id (e.g. `x2`, `y`), the range - of this axis changes together with the range of the - corresponding axis such that the scale of pixels per - unit is in a constant ratio. Both axes are still - zoomable, but when you zoom one, the other will zoom - the same amount, keeping a fixed midpoint. `constrain` - and `constraintoward` determine how we enforce the - constraint. You can chain these, ie `yaxis: - {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` but you - can only link axes of the same `type`. The linked axis - can have the opposite letter (to constrain the aspect - ratio) or the same letter (to match scales across - subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: - {scaleanchor: *y*}` or longer) are redundant and the - last constraint encountered will be ignored to avoid - possible inconsistent constraints via `scaleratio`. - Note that setting axes simultaneously in both a - `scaleanchor` and a `matches` constraint is currently - forbidden. - scaleratio - If this axis is linked to another by `scaleanchor`, - this determines the pixel to unit scale ratio. For - example, if this value is 10, then every unit on this - axis spans 10 times the number of pixels as a unit on - the linked axis. Use this for example to create an - elevation profile where the vertical scale is - exaggerated a fixed amount with respect to the - horizontal. - separatethousands - If "true", even 4-digit integers are separated - showdividers - Determines whether or not a dividers are drawn between - the category levels of this axis. Only has an effect on - "multicategory" axes. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showspikes - Determines whether or not spikes (aka droplines) are - drawn for this axis. Note: This only takes affect when - hovermode = closest - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - side - Determines whether a x (y) axis is positioned at the - "bottom" ("left") or "top" ("right") of the plotting - area. - spikecolor - Sets the spike color. If undefined, will use the series - color - spikedash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - spikemode - Determines the drawing mode for the spike line If - "toaxis", the line is drawn from the data point to the - axis the series is plotted on. If "across", the line - is drawn across the entire plot area, and supercedes - "toaxis". If "marker", then a marker dot is drawn on - the axis the series is plotted on - spikesnap - Determines whether spikelines are stuck to the cursor - or to the closest datapoints. - spikethickness - Sets the width (in px) of the zero line. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.yaxis.Tickformatstop instance - or dict with compatible properties - tickformatstopdefaults - When used in a template (as - layout.template.layout.yaxis.tickformatstopdefaults), - sets the default property values to use for elements of - layout.yaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - tickson - Determines where ticks and grid lines are drawn with - respect to their corresponding tick labels. Only has an - effect for axes of `type` "category" or - "multicategory". When set to "boundaries", ticks and - grid lines are drawn half a category to the left/bottom - of labels. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.yaxis.Title instance or dict - with compatible properties - titlefont - Deprecated: Please use layout.yaxis.title.font instead. - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - type - Sets the axis type. By default, plotly attempts to - determined the axis type by looking into the data of - the traces that referenced the axis in question. - uirevision - Controls persistence of user-driven changes in axis - `range`, `autorange`, and `title` if in `editable: - true` configuration. Defaults to `layout.uirevision`. - visible - A single toggle to hide the axis while preserving - interaction like dragging. Default is true when a - cheater plot is present on the axis, otherwise false - zeroline - Determines whether or not a line is drawn at along the - 0 value of this axis. If True, the zero line is drawn - on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. - """ - - _mapped_properties = {'titlefont': ('title', 'font')} - - def __init__( - self, - arg=None, - anchor=None, - automargin=None, - autorange=None, - calendar=None, - categoryarray=None, - categoryarraysrc=None, - categoryorder=None, - color=None, - constrain=None, - constraintoward=None, - dividercolor=None, - dividerwidth=None, - domain=None, - dtick=None, - exponentformat=None, - fixedrange=None, - gridcolor=None, - gridwidth=None, - hoverformat=None, - layer=None, - linecolor=None, - linewidth=None, - matches=None, - mirror=None, - nticks=None, - overlaying=None, - position=None, - range=None, - rangemode=None, - scaleanchor=None, - scaleratio=None, - separatethousands=None, - showdividers=None, - showexponent=None, - showgrid=None, - showline=None, - showspikes=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - side=None, - spikecolor=None, - spikedash=None, - spikemode=None, - spikesnap=None, - spikethickness=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - tickson=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - type=None, - uirevision=None, - visible=None, - zeroline=None, - zerolinecolor=None, - zerolinewidth=None, - **kwargs - ): - """ - Construct a new YAxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.YAxis - anchor - If set to an opposite-letter axis id (e.g. `x2`, `y`), - this axis is bound to the corresponding opposite-letter - axis. If set to "free", this axis' position is - determined by `position`. - automargin - Determines whether long tick labels automatically grow - the figure margins. - autorange - Determines whether or not the range of this axis is - computed in relation to the input data. See `rangemode` - for more info. If `range` is provided, then `autorange` - is set to False. - calendar - Sets the calendar system to use for `range` and `tick0` - if this is a date axis. This does not set the calendar - for interpreting data on this axis, that's specified in - the trace or via the global `layout.calendar` - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - constrain - If this axis needs to be compressed (either due to its - own `scaleanchor` and `scaleratio` or those of the - other axis), determines how that happens: by increasing - the "range" (default), or by decreasing the "domain". - constraintoward - If this axis needs to be compressed (either due to its - own `scaleanchor` and `scaleratio` or those of the - other axis), determines which direction we push the - originally specified plot area. Options are "left", - "center" (default), and "right" for x axes, and "top", - "middle" (default), and "bottom" for y axes. - dividercolor - Sets the color of the dividers Only has an effect on - "multicategory" axes. - dividerwidth - Sets the width (in px) of the dividers Only has an - effect on "multicategory" axes. - domain - Sets the domain of this axis (in plot fraction). - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - fixedrange - Determines whether or not this axis is zoom-able. If - true, then zoom is disabled. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - layer - Sets the layer on which this axis is displayed. If - *above traces*, this axis is displayed above all the - subplot's traces If *below traces*, this axis is - displayed below all the subplot's traces, but above the - grid lines. Useful when used together with scatter-like - traces with `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - matches - If set to another axis id (e.g. `x2`, `y`), the range - of this axis will match the range of the corresponding - axis in data-coordinates space. Moreover, matching axes - share auto-range values, category lists and histogram - auto-bins. Note that setting axes simultaneously in - both a `scaleanchor` and a `matches` constraint is - currently forbidden. Moreover, note that matching axes - must have the same `type`. - mirror - Determines if the axis lines or/and ticks are mirrored - to the opposite side of the plotting area. If True, the - axis lines are mirrored. If "ticks", the axis lines and - ticks are mirrored. If False, mirroring is disable. If - "all", axis lines are mirrored on all shared-axes - subplots. If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - overlaying - If set a same-letter axis id, this axis is overlaid on - top of the corresponding same-letter axis, with traces - and axes visible for both axes. If False, this axis - does not overlay any same-letter axes. In this case, - for axes with overlapping domains only the highest- - numbered axis will be visible. - position - Sets the position of this axis in the plotting space - (in normalized coordinates). Only has an effect if - `anchor` is set to "free". - range - Sets the range of this axis. If the axis `type` is - "log", then you must take the log of your desired range - (e.g. to set the range from 1 to 100, set the range - from 0 to 2). If the axis `type` is "date", it should - be date strings, like date data, though Date objects - and unix milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order it - appears. - rangemode - If "normal", the range is computed in relation to the - extrema of the input data. If *tozero*`, the range - extends to 0, regardless of the input data If - "nonnegative", the range is non-negative, regardless of - the input data. Applies only to linear axes. - scaleanchor - If set to another axis id (e.g. `x2`, `y`), the range - of this axis changes together with the range of the - corresponding axis such that the scale of pixels per - unit is in a constant ratio. Both axes are still - zoomable, but when you zoom one, the other will zoom - the same amount, keeping a fixed midpoint. `constrain` - and `constraintoward` determine how we enforce the - constraint. You can chain these, ie `yaxis: - {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` but you - can only link axes of the same `type`. The linked axis - can have the opposite letter (to constrain the aspect - ratio) or the same letter (to match scales across - subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: - {scaleanchor: *y*}` or longer) are redundant and the - last constraint encountered will be ignored to avoid - possible inconsistent constraints via `scaleratio`. - Note that setting axes simultaneously in both a - `scaleanchor` and a `matches` constraint is currently - forbidden. - scaleratio - If this axis is linked to another by `scaleanchor`, - this determines the pixel to unit scale ratio. For - example, if this value is 10, then every unit on this - axis spans 10 times the number of pixels as a unit on - the linked axis. Use this for example to create an - elevation profile where the vertical scale is - exaggerated a fixed amount with respect to the - horizontal. - separatethousands - If "true", even 4-digit integers are separated - showdividers - Determines whether or not a dividers are drawn between - the category levels of this axis. Only has an effect on - "multicategory" axes. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showspikes - Determines whether or not spikes (aka droplines) are - drawn for this axis. Note: This only takes affect when - hovermode = closest - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - side - Determines whether a x (y) axis is positioned at the - "bottom" ("left") or "top" ("right") of the plotting - area. - spikecolor - Sets the spike color. If undefined, will use the series - color - spikedash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - spikemode - Determines the drawing mode for the spike line If - "toaxis", the line is drawn from the data point to the - axis the series is plotted on. If "across", the line - is drawn across the entire plot area, and supercedes - "toaxis". If "marker", then a marker dot is drawn on - the axis the series is plotted on - spikesnap - Determines whether spikelines are stuck to the cursor - or to the closest datapoints. - spikethickness - Sets the width (in px) of the zero line. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.yaxis.Tickformatstop instance - or dict with compatible properties - tickformatstopdefaults - When used in a template (as - layout.template.layout.yaxis.tickformatstopdefaults), - sets the default property values to use for elements of - layout.yaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - tickson - Determines where ticks and grid lines are drawn with - respect to their corresponding tick labels. Only has an - effect for axes of `type` "category" or - "multicategory". When set to "boundaries", ticks and - grid lines are drawn half a category to the left/bottom - of labels. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.yaxis.Title instance or dict - with compatible properties - titlefont - Deprecated: Please use layout.yaxis.title.font instead. - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - type - Sets the axis type. By default, plotly attempts to - determined the axis type by looking into the data of - the traces that referenced the axis in question. - uirevision - Controls persistence of user-driven changes in axis - `range`, `autorange`, and `title` if in `editable: - true` configuration. Defaults to `layout.uirevision`. - visible - A single toggle to hide the axis while preserving - interaction like dragging. Default is true when a - cheater plot is present on the axis, otherwise false - zeroline - Determines whether or not a line is drawn at along the - 0 value of this axis. If True, the zero line is drawn - on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. - - Returns - ------- - YAxis - """ - super(YAxis, self).__init__('yaxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.YAxis -constructor must be a dict or -an instance of plotly.graph_objs.layout.YAxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout import (yaxis as v_yaxis) - - # Initialize validators - # --------------------- - self._validators['anchor'] = v_yaxis.AnchorValidator() - self._validators['automargin'] = v_yaxis.AutomarginValidator() - self._validators['autorange'] = v_yaxis.AutorangeValidator() - self._validators['calendar'] = v_yaxis.CalendarValidator() - self._validators['categoryarray'] = v_yaxis.CategoryarrayValidator() - self._validators['categoryarraysrc' - ] = v_yaxis.CategoryarraysrcValidator() - self._validators['categoryorder'] = v_yaxis.CategoryorderValidator() - self._validators['color'] = v_yaxis.ColorValidator() - self._validators['constrain'] = v_yaxis.ConstrainValidator() - self._validators['constraintoward'] = v_yaxis.ConstraintowardValidator( - ) - self._validators['dividercolor'] = v_yaxis.DividercolorValidator() - self._validators['dividerwidth'] = v_yaxis.DividerwidthValidator() - self._validators['domain'] = v_yaxis.DomainValidator() - self._validators['dtick'] = v_yaxis.DtickValidator() - self._validators['exponentformat'] = v_yaxis.ExponentformatValidator() - self._validators['fixedrange'] = v_yaxis.FixedrangeValidator() - self._validators['gridcolor'] = v_yaxis.GridcolorValidator() - self._validators['gridwidth'] = v_yaxis.GridwidthValidator() - self._validators['hoverformat'] = v_yaxis.HoverformatValidator() - self._validators['layer'] = v_yaxis.LayerValidator() - self._validators['linecolor'] = v_yaxis.LinecolorValidator() - self._validators['linewidth'] = v_yaxis.LinewidthValidator() - self._validators['matches'] = v_yaxis.MatchesValidator() - self._validators['mirror'] = v_yaxis.MirrorValidator() - self._validators['nticks'] = v_yaxis.NticksValidator() - self._validators['overlaying'] = v_yaxis.OverlayingValidator() - self._validators['position'] = v_yaxis.PositionValidator() - self._validators['range'] = v_yaxis.RangeValidator() - self._validators['rangemode'] = v_yaxis.RangemodeValidator() - self._validators['scaleanchor'] = v_yaxis.ScaleanchorValidator() - self._validators['scaleratio'] = v_yaxis.ScaleratioValidator() - self._validators['separatethousands' - ] = v_yaxis.SeparatethousandsValidator() - self._validators['showdividers'] = v_yaxis.ShowdividersValidator() - self._validators['showexponent'] = v_yaxis.ShowexponentValidator() - self._validators['showgrid'] = v_yaxis.ShowgridValidator() - self._validators['showline'] = v_yaxis.ShowlineValidator() - self._validators['showspikes'] = v_yaxis.ShowspikesValidator() - self._validators['showticklabels'] = v_yaxis.ShowticklabelsValidator() - self._validators['showtickprefix'] = v_yaxis.ShowtickprefixValidator() - self._validators['showticksuffix'] = v_yaxis.ShowticksuffixValidator() - self._validators['side'] = v_yaxis.SideValidator() - self._validators['spikecolor'] = v_yaxis.SpikecolorValidator() - self._validators['spikedash'] = v_yaxis.SpikedashValidator() - self._validators['spikemode'] = v_yaxis.SpikemodeValidator() - self._validators['spikesnap'] = v_yaxis.SpikesnapValidator() - self._validators['spikethickness'] = v_yaxis.SpikethicknessValidator() - self._validators['tick0'] = v_yaxis.Tick0Validator() - self._validators['tickangle'] = v_yaxis.TickangleValidator() - self._validators['tickcolor'] = v_yaxis.TickcolorValidator() - self._validators['tickfont'] = v_yaxis.TickfontValidator() - self._validators['tickformat'] = v_yaxis.TickformatValidator() - self._validators['tickformatstops'] = v_yaxis.TickformatstopsValidator( - ) - self._validators['tickformatstopdefaults' - ] = v_yaxis.TickformatstopValidator() - self._validators['ticklen'] = v_yaxis.TicklenValidator() - self._validators['tickmode'] = v_yaxis.TickmodeValidator() - self._validators['tickprefix'] = v_yaxis.TickprefixValidator() - self._validators['ticks'] = v_yaxis.TicksValidator() - self._validators['tickson'] = v_yaxis.TicksonValidator() - self._validators['ticksuffix'] = v_yaxis.TicksuffixValidator() - self._validators['ticktext'] = v_yaxis.TicktextValidator() - self._validators['ticktextsrc'] = v_yaxis.TicktextsrcValidator() - self._validators['tickvals'] = v_yaxis.TickvalsValidator() - self._validators['tickvalssrc'] = v_yaxis.TickvalssrcValidator() - self._validators['tickwidth'] = v_yaxis.TickwidthValidator() - self._validators['title'] = v_yaxis.TitleValidator() - self._validators['type'] = v_yaxis.TypeValidator() - self._validators['uirevision'] = v_yaxis.UirevisionValidator() - self._validators['visible'] = v_yaxis.VisibleValidator() - self._validators['zeroline'] = v_yaxis.ZerolineValidator() - self._validators['zerolinecolor'] = v_yaxis.ZerolinecolorValidator() - self._validators['zerolinewidth'] = v_yaxis.ZerolinewidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('anchor', None) - self['anchor'] = anchor if anchor is not None else _v - _v = arg.pop('automargin', None) - self['automargin'] = automargin if automargin is not None else _v - _v = arg.pop('autorange', None) - self['autorange'] = autorange if autorange is not None else _v - _v = arg.pop('calendar', None) - self['calendar'] = calendar if calendar is not None else _v - _v = arg.pop('categoryarray', None) - self['categoryarray' - ] = categoryarray if categoryarray is not None else _v - _v = arg.pop('categoryarraysrc', None) - self['categoryarraysrc' - ] = categoryarraysrc if categoryarraysrc is not None else _v - _v = arg.pop('categoryorder', None) - self['categoryorder' - ] = categoryorder if categoryorder is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('constrain', None) - self['constrain'] = constrain if constrain is not None else _v - _v = arg.pop('constraintoward', None) - self['constraintoward' - ] = constraintoward if constraintoward is not None else _v - _v = arg.pop('dividercolor', None) - self['dividercolor'] = dividercolor if dividercolor is not None else _v - _v = arg.pop('dividerwidth', None) - self['dividerwidth'] = dividerwidth if dividerwidth is not None else _v - _v = arg.pop('domain', None) - self['domain'] = domain if domain is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('fixedrange', None) - self['fixedrange'] = fixedrange if fixedrange is not None else _v - _v = arg.pop('gridcolor', None) - self['gridcolor'] = gridcolor if gridcolor is not None else _v - _v = arg.pop('gridwidth', None) - self['gridwidth'] = gridwidth if gridwidth is not None else _v - _v = arg.pop('hoverformat', None) - self['hoverformat'] = hoverformat if hoverformat is not None else _v - _v = arg.pop('layer', None) - self['layer'] = layer if layer is not None else _v - _v = arg.pop('linecolor', None) - self['linecolor'] = linecolor if linecolor is not None else _v - _v = arg.pop('linewidth', None) - self['linewidth'] = linewidth if linewidth is not None else _v - _v = arg.pop('matches', None) - self['matches'] = matches if matches is not None else _v - _v = arg.pop('mirror', None) - self['mirror'] = mirror if mirror is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('overlaying', None) - self['overlaying'] = overlaying if overlaying is not None else _v - _v = arg.pop('position', None) - self['position'] = position if position is not None else _v - _v = arg.pop('range', None) - self['range'] = range if range is not None else _v - _v = arg.pop('rangemode', None) - self['rangemode'] = rangemode if rangemode is not None else _v - _v = arg.pop('scaleanchor', None) - self['scaleanchor'] = scaleanchor if scaleanchor is not None else _v - _v = arg.pop('scaleratio', None) - self['scaleratio'] = scaleratio if scaleratio is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showdividers', None) - self['showdividers'] = showdividers if showdividers is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showgrid', None) - self['showgrid'] = showgrid if showgrid is not None else _v - _v = arg.pop('showline', None) - self['showline'] = showline if showline is not None else _v - _v = arg.pop('showspikes', None) - self['showspikes'] = showspikes if showspikes is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('spikecolor', None) - self['spikecolor'] = spikecolor if spikecolor is not None else _v - _v = arg.pop('spikedash', None) - self['spikedash'] = spikedash if spikedash is not None else _v - _v = arg.pop('spikemode', None) - self['spikemode'] = spikemode if spikemode is not None else _v - _v = arg.pop('spikesnap', None) - self['spikesnap'] = spikesnap if spikesnap is not None else _v - _v = arg.pop('spikethickness', None) - self['spikethickness' - ] = spikethickness if spikethickness is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('tickson', None) - self['tickson'] = tickson if tickson is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('zeroline', None) - self['zeroline'] = zeroline if zeroline is not None else _v - _v = arg.pop('zerolinecolor', None) - self['zerolinecolor' - ] = zerolinecolor if zerolinecolor is not None else _v - _v = arg.pop('zerolinewidth', None) - self['zerolinewidth' - ] = zerolinewidth if zerolinewidth is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/annotation/__init__.py b/plotly/graph_objs/layout/annotation/__init__.py index 76631345ed6..63f35ab30cf 100644 --- a/plotly/graph_objs/layout/annotation/__init__.py +++ b/plotly/graph_objs/layout/annotation/__init__.py @@ -1,3 +1,510 @@ -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseLayoutHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.annotation.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.annotation' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover label. By + default uses the annotation's `bgcolor` made opaque, or + white if it was transparent. + bordercolor + Sets the border color of the hover label. By default + uses either dark grey or white, for maximum contrast + with `hoverlabel.bgcolor`. + font + Sets the hover label text font. By default uses the + global hover font and size, with color from + `hoverlabel.bordercolor`. + """ + + def __init__( + self, arg=None, bgcolor=None, bordercolor=None, font=None, **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.annotation.Hoverlabel + bgcolor + Sets the background color of the hover label. By + default uses the annotation's `bgcolor` made opaque, or + white if it was transparent. + bordercolor + Sets the border color of the hover label. By default + uses either dark grey or white, for maximum contrast + with `hoverlabel.bgcolor`. + font + Sets the hover label text font. By default uses the + global hover font and size, with color from + `hoverlabel.bordercolor`. + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.annotation.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.layout.annotation.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.annotation import ( + hoverlabel as v_hoverlabel + ) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.annotation' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): + """ + Construct a new Font object + + Sets the annotation text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.annotation.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.annotation.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.annotation.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.annotation import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.annotation import hoverlabel -from ._font import Font diff --git a/plotly/graph_objs/layout/annotation/_font.py b/plotly/graph_objs/layout/annotation/_font.py deleted file mode 100644 index 10bbdac969c..00000000000 --- a/plotly/graph_objs/layout/annotation/_font.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.annotation' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): - """ - Construct a new Font object - - Sets the annotation text font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.annotation.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.annotation.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.annotation.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.annotation import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/annotation/_hoverlabel.py b/plotly/graph_objs/layout/annotation/_hoverlabel.py deleted file mode 100644 index 403ce114c9b..00000000000 --- a/plotly/graph_objs/layout/annotation/_hoverlabel.py +++ /dev/null @@ -1,278 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Hoverlabel(BaseLayoutHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.annotation.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.annotation' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover label. By - default uses the annotation's `bgcolor` made opaque, or - white if it was transparent. - bordercolor - Sets the border color of the hover label. By default - uses either dark grey or white, for maximum contrast - with `hoverlabel.bgcolor`. - font - Sets the hover label text font. By default uses the - global hover font and size, with color from - `hoverlabel.bordercolor`. - """ - - def __init__( - self, arg=None, bgcolor=None, bordercolor=None, font=None, **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.annotation.Hoverlabel - bgcolor - Sets the background color of the hover label. By - default uses the annotation's `bgcolor` made opaque, or - white if it was transparent. - bordercolor - Sets the border color of the hover label. By default - uses either dark grey or white, for maximum contrast - with `hoverlabel.bgcolor`. - font - Sets the hover label text font. By default uses the - global hover font and size, with color from - `hoverlabel.bordercolor`. - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.annotation.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.layout.annotation.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.annotation import ( - hoverlabel as v_hoverlabel - ) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/annotation/hoverlabel/__init__.py b/plotly/graph_objs/layout/annotation/hoverlabel/__init__.py index c37b8b5cd28..d80aec78b82 100644 --- a/plotly/graph_objs/layout/annotation/hoverlabel/__init__.py +++ b/plotly/graph_objs/layout/annotation/hoverlabel/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.annotation.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.annotation.hoverlabel.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.annotation.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.annotation.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.annotation.hoverlabel import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/annotation/hoverlabel/_font.py b/plotly/graph_objs/layout/annotation/hoverlabel/_font.py deleted file mode 100644 index d53ffdc70d4..00000000000 --- a/plotly/graph_objs/layout/annotation/hoverlabel/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.annotation.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.annotation.hoverlabel.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.annotation.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.annotation.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.annotation.hoverlabel import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/geo/__init__.py b/plotly/graph_objs/layout/geo/__init__.py index 189826eba24..1c530c74fc6 100644 --- a/plotly/graph_objs/layout/geo/__init__.py +++ b/plotly/graph_objs/layout/geo/__init__.py @@ -1,6 +1,1200 @@ -from ._projection import Projection + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Projection(_BaseLayoutHierarchyType): + + # parallels + # --------- + @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 + + Returns + ------- + list + """ + return self['parallels'] + + @parallels.setter + def parallels(self, val): + self['parallels'] = val + + # rotation + # -------- + @property + def rotation(self): + """ + The 'rotation' property is an instance of Rotation + that may be specified as: + - An instance of 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). + lon + Rotates the map along parallels (in degrees + East). Defaults to the center of the + `lonaxis.range` values. + roll + Roll the map (in degrees) For example, a roll + of 180 makes the map appear upside down. + + Returns + ------- + plotly.graph_objs.layout.geo.projection.Rotation + """ + return self['rotation'] + + @rotation.setter + def rotation(self, val): + self['rotation'] = val + + # scale + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['scale'] + + @scale.setter + def scale(self, val): + self['scale'] = val + + # type + # ---- + @property + 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 + earth', 'kavrayskiy7', 'miller', 'robinson', 'eckert4', + 'azimuthal equal area', 'azimuthal equidistant', 'conic + equal area', 'conic conformal', 'conic equidistant', + 'gnomonic', 'stereographic', 'mollweide', 'hammer', + 'transverse mercator', 'albers usa', 'winkel tripel', + 'aitoff', 'sinusoidal'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.geo' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + parallels + For conic projection types only. Sets the parallels + (tangent, secant) where the cone intersects the sphere. + rotation + plotly.graph_objs.layout.geo.projection.Rotation + instance or dict with compatible properties + scale + 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. + type + Sets the projection type. + """ + + def __init__( + self, + arg=None, + parallels=None, + rotation=None, + scale=None, + type=None, + **kwargs + ): + """ + Construct a new Projection object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.geo.Projection + parallels + For conic projection types only. Sets the parallels + (tangent, secant) where the cone intersects the sphere. + rotation + plotly.graph_objs.layout.geo.projection.Rotation + instance or dict with compatible properties + scale + 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. + type + Sets the projection type. + + Returns + ------- + Projection + """ + super(Projection, self).__init__('projection') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.geo.Projection +constructor must be a dict or +an instance of plotly.graph_objs.layout.geo.Projection""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.geo import (projection as v_projection) + + # Initialize validators + # --------------------- + self._validators['parallels'] = v_projection.ParallelsValidator() + self._validators['rotation'] = v_projection.RotationValidator() + self._validators['scale'] = v_projection.ScaleValidator() + self._validators['type'] = v_projection.TypeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('parallels', None) + self['parallels'] = parallels if parallels is not None else _v + _v = arg.pop('rotation', None) + self['rotation'] = rotation if rotation is not None else _v + _v = arg.pop('scale', None) + self['scale'] = scale if scale is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Lonaxis(_BaseLayoutHierarchyType): + + # dtick + # ----- + @property + 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 + + Returns + ------- + int|float + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # gridcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['gridcolor'] + + @gridcolor.setter + def gridcolor(self, val): + self['gridcolor'] = val + + # gridwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['gridwidth'] + + @gridwidth.setter + def gridwidth(self, val): + self['gridwidth'] = val + + # range + # ----- + @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 + + Returns + ------- + list + """ + return self['range'] + + @range.setter + def range(self, val): + self['range'] = val + + # showgrid + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showgrid'] + + @showgrid.setter + def showgrid(self, val): + self['showgrid'] = val + + # tick0 + # ----- + @property + 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 + + Returns + ------- + int|float + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.geo' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtick + Sets the graticule's longitude/latitude tick step. + gridcolor + Sets the graticule's stroke color. + gridwidth + Sets the graticule's stroke width (in px). + range + Sets the range of this axis (in degrees), sets the + map's clipped coordinates. + showgrid + Sets whether or not graticule are shown on the map. + tick0 + Sets the graticule's starting tick longitude/latitude. + """ + + def __init__( + self, + arg=None, + dtick=None, + gridcolor=None, + gridwidth=None, + range=None, + showgrid=None, + tick0=None, + **kwargs + ): + """ + Construct a new Lonaxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.geo.Lonaxis + dtick + Sets the graticule's longitude/latitude tick step. + gridcolor + Sets the graticule's stroke color. + gridwidth + Sets the graticule's stroke width (in px). + range + Sets the range of this axis (in degrees), sets the + map's clipped coordinates. + showgrid + Sets whether or not graticule are shown on the map. + tick0 + Sets the graticule's starting tick longitude/latitude. + + Returns + ------- + Lonaxis + """ + super(Lonaxis, self).__init__('lonaxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.geo.Lonaxis +constructor must be a dict or +an instance of plotly.graph_objs.layout.geo.Lonaxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.geo import (lonaxis as v_lonaxis) + + # Initialize validators + # --------------------- + self._validators['dtick'] = v_lonaxis.DtickValidator() + self._validators['gridcolor'] = v_lonaxis.GridcolorValidator() + self._validators['gridwidth'] = v_lonaxis.GridwidthValidator() + self._validators['range'] = v_lonaxis.RangeValidator() + self._validators['showgrid'] = v_lonaxis.ShowgridValidator() + self._validators['tick0'] = v_lonaxis.Tick0Validator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('gridcolor', None) + self['gridcolor'] = gridcolor if gridcolor is not None else _v + _v = arg.pop('gridwidth', None) + self['gridwidth'] = gridwidth if gridwidth is not None else _v + _v = arg.pop('range', None) + self['range'] = range if range is not None else _v + _v = arg.pop('showgrid', None) + self['showgrid'] = showgrid if showgrid is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Lataxis(_BaseLayoutHierarchyType): + + # dtick + # ----- + @property + 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 + + Returns + ------- + int|float + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # gridcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['gridcolor'] + + @gridcolor.setter + def gridcolor(self, val): + self['gridcolor'] = val + + # gridwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['gridwidth'] + + @gridwidth.setter + def gridwidth(self, val): + self['gridwidth'] = val + + # range + # ----- + @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 + + Returns + ------- + list + """ + return self['range'] + + @range.setter + def range(self, val): + self['range'] = val + + # showgrid + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showgrid'] + + @showgrid.setter + def showgrid(self, val): + self['showgrid'] = val + + # tick0 + # ----- + @property + 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 + + Returns + ------- + int|float + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.geo' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtick + Sets the graticule's longitude/latitude tick step. + gridcolor + Sets the graticule's stroke color. + gridwidth + Sets the graticule's stroke width (in px). + range + Sets the range of this axis (in degrees), sets the + map's clipped coordinates. + showgrid + Sets whether or not graticule are shown on the map. + tick0 + Sets the graticule's starting tick longitude/latitude. + """ + + def __init__( + self, + arg=None, + dtick=None, + gridcolor=None, + gridwidth=None, + range=None, + showgrid=None, + tick0=None, + **kwargs + ): + """ + Construct a new Lataxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.geo.Lataxis + dtick + Sets the graticule's longitude/latitude tick step. + gridcolor + Sets the graticule's stroke color. + gridwidth + Sets the graticule's stroke width (in px). + range + Sets the range of this axis (in degrees), sets the + map's clipped coordinates. + showgrid + Sets whether or not graticule are shown on the map. + tick0 + Sets the graticule's starting tick longitude/latitude. + + Returns + ------- + Lataxis + """ + super(Lataxis, self).__init__('lataxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.geo.Lataxis +constructor must be a dict or +an instance of plotly.graph_objs.layout.geo.Lataxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.geo import (lataxis as v_lataxis) + + # Initialize validators + # --------------------- + self._validators['dtick'] = v_lataxis.DtickValidator() + self._validators['gridcolor'] = v_lataxis.GridcolorValidator() + self._validators['gridwidth'] = v_lataxis.GridwidthValidator() + self._validators['range'] = v_lataxis.RangeValidator() + self._validators['showgrid'] = v_lataxis.ShowgridValidator() + self._validators['tick0'] = v_lataxis.Tick0Validator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('gridcolor', None) + self['gridcolor'] = gridcolor if gridcolor is not None else _v + _v = arg.pop('gridwidth', None) + self['gridwidth'] = gridwidth if gridwidth is not None else _v + _v = arg.pop('range', None) + self['range'] = range if range is not None else _v + _v = arg.pop('showgrid', None) + self['showgrid'] = showgrid if showgrid is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Domain(_BaseLayoutHierarchyType): + + # column + # ------ + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this geo subplot . 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 '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] + + Returns + ------- + int + """ + return self['column'] + + @column.setter + def column(self, val): + self['column'] = val + + # row + # --- + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this geo subplot . 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 '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] + + Returns + ------- + int + """ + return self['row'] + + @row.setter + def row(self, val): + self['row'] = val + + # x + # - + @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] + + Returns + ------- + list + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @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] + + Returns + ------- + list + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.geo' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this geo subplot . 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. + row + If there is a layout grid, use the domain for this row + in the grid for this geo subplot . 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. + x + 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. + y + 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. + """ + + def __init__( + self, arg=None, column=None, row=None, x=None, y=None, **kwargs + ): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.geo.Domain + column + If there is a layout grid, use the domain for this + column in the grid for this geo subplot . 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. + row + If there is a layout grid, use the domain for this row + in the grid for this geo subplot . 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. + x + 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. + y + 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 + ------- + Domain + """ + super(Domain, self).__init__('domain') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.geo.Domain +constructor must be a dict or +an instance of plotly.graph_objs.layout.geo.Domain""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.geo import (domain as v_domain) + + # Initialize validators + # --------------------- + self._validators['column'] = v_domain.ColumnValidator() + self._validators['row'] = v_domain.RowValidator() + self._validators['x'] = v_domain.XValidator() + self._validators['y'] = v_domain.YValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('column', None) + self['column'] = column if column is not None else _v + _v = arg.pop('row', None) + self['row'] = row if row is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Center(_BaseLayoutHierarchyType): + + # lat + # --- + @property + 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 + + Returns + ------- + int|float + """ + return self['lat'] + + @lat.setter + def lat(self, val): + self['lat'] = val + + # lon + # --- + @property + def lon(self): + """ + Sets the longitude of the map's center. By default, the map's + 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 + + Returns + ------- + int|float + """ + return self['lon'] + + @lon.setter + def lon(self, val): + self['lon'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.geo' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + lat + 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. + lon + Sets the longitude of the map's center. By default, the + map's longitude center lies at the middle of the + longitude range for scoped projection and above + `projection.rotation.lon` otherwise. + """ + + def __init__(self, arg=None, lat=None, lon=None, **kwargs): + """ + Construct a new Center object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.geo.Center + lat + 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. + lon + Sets the longitude of the map's center. By default, the + map's longitude center lies at the middle of the + longitude range for scoped projection and above + `projection.rotation.lon` otherwise. + + Returns + ------- + Center + """ + super(Center, self).__init__('center') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.geo.Center +constructor must be a dict or +an instance of plotly.graph_objs.layout.geo.Center""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.geo import (center as v_center) + + # Initialize validators + # --------------------- + self._validators['lat'] = v_center.LatValidator() + self._validators['lon'] = v_center.LonValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('lat', None) + self['lat'] = lat if lat is not None else _v + _v = arg.pop('lon', None) + self['lon'] = lon if lon is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.geo import projection -from ._lonaxis import Lonaxis -from ._lataxis import Lataxis -from ._domain import Domain -from ._center import Center diff --git a/plotly/graph_objs/layout/geo/_center.py b/plotly/graph_objs/layout/geo/_center.py deleted file mode 100644 index d697b3ebf7d..00000000000 --- a/plotly/graph_objs/layout/geo/_center.py +++ /dev/null @@ -1,141 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Center(BaseLayoutHierarchyType): - - # lat - # --- - @property - 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 - - Returns - ------- - int|float - """ - return self['lat'] - - @lat.setter - def lat(self, val): - self['lat'] = val - - # lon - # --- - @property - def lon(self): - """ - Sets the longitude of the map's center. By default, the map's - 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 - - Returns - ------- - int|float - """ - return self['lon'] - - @lon.setter - def lon(self, val): - self['lon'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.geo' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - lat - 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. - lon - Sets the longitude of the map's center. By default, the - map's longitude center lies at the middle of the - longitude range for scoped projection and above - `projection.rotation.lon` otherwise. - """ - - def __init__(self, arg=None, lat=None, lon=None, **kwargs): - """ - Construct a new Center object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.geo.Center - lat - 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. - lon - Sets the longitude of the map's center. By default, the - map's longitude center lies at the middle of the - longitude range for scoped projection and above - `projection.rotation.lon` otherwise. - - Returns - ------- - Center - """ - super(Center, self).__init__('center') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.geo.Center -constructor must be a dict or -an instance of plotly.graph_objs.layout.geo.Center""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.geo import (center as v_center) - - # Initialize validators - # --------------------- - self._validators['lat'] = v_center.LatValidator() - self._validators['lon'] = v_center.LonValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('lat', None) - self['lat'] = lat if lat is not None else _v - _v = arg.pop('lon', None) - self['lon'] = lon if lon is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/geo/_domain.py b/plotly/graph_objs/layout/geo/_domain.py deleted file mode 100644 index ff5bc9e6177..00000000000 --- a/plotly/graph_objs/layout/geo/_domain.py +++ /dev/null @@ -1,240 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Domain(BaseLayoutHierarchyType): - - # column - # ------ - @property - def column(self): - """ - If there is a layout grid, use the domain for this column in - the grid for this geo subplot . 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 '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] - - Returns - ------- - int - """ - return self['column'] - - @column.setter - def column(self, val): - self['column'] = val - - # row - # --- - @property - def row(self): - """ - If there is a layout grid, use the domain for this row in the - grid for this geo subplot . 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 '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] - - Returns - ------- - int - """ - return self['row'] - - @row.setter - def row(self, val): - self['row'] = val - - # x - # - - @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] - - Returns - ------- - list - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @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] - - Returns - ------- - list - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.geo' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - column - If there is a layout grid, use the domain for this - column in the grid for this geo subplot . 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. - row - If there is a layout grid, use the domain for this row - in the grid for this geo subplot . 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. - x - 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. - y - 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. - """ - - def __init__( - self, arg=None, column=None, row=None, x=None, y=None, **kwargs - ): - """ - Construct a new Domain object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.geo.Domain - column - If there is a layout grid, use the domain for this - column in the grid for this geo subplot . 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. - row - If there is a layout grid, use the domain for this row - in the grid for this geo subplot . 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. - x - 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. - y - 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 - ------- - Domain - """ - super(Domain, self).__init__('domain') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.geo.Domain -constructor must be a dict or -an instance of plotly.graph_objs.layout.geo.Domain""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.geo import (domain as v_domain) - - # Initialize validators - # --------------------- - self._validators['column'] = v_domain.ColumnValidator() - self._validators['row'] = v_domain.RowValidator() - self._validators['x'] = v_domain.XValidator() - self._validators['y'] = v_domain.YValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('column', None) - self['column'] = column if column is not None else _v - _v = arg.pop('row', None) - self['row'] = row if row is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/geo/_lataxis.py b/plotly/graph_objs/layout/geo/_lataxis.py deleted file mode 100644 index ba7fb16562d..00000000000 --- a/plotly/graph_objs/layout/geo/_lataxis.py +++ /dev/null @@ -1,291 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Lataxis(BaseLayoutHierarchyType): - - # dtick - # ----- - @property - 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 - - Returns - ------- - int|float - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # gridcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['gridcolor'] - - @gridcolor.setter - def gridcolor(self, val): - self['gridcolor'] = val - - # gridwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['gridwidth'] - - @gridwidth.setter - def gridwidth(self, val): - self['gridwidth'] = val - - # range - # ----- - @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 - - Returns - ------- - list - """ - return self['range'] - - @range.setter - def range(self, val): - self['range'] = val - - # showgrid - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showgrid'] - - @showgrid.setter - def showgrid(self, val): - self['showgrid'] = val - - # tick0 - # ----- - @property - 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 - - Returns - ------- - int|float - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.geo' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtick - Sets the graticule's longitude/latitude tick step. - gridcolor - Sets the graticule's stroke color. - gridwidth - Sets the graticule's stroke width (in px). - range - Sets the range of this axis (in degrees), sets the - map's clipped coordinates. - showgrid - Sets whether or not graticule are shown on the map. - tick0 - Sets the graticule's starting tick longitude/latitude. - """ - - def __init__( - self, - arg=None, - dtick=None, - gridcolor=None, - gridwidth=None, - range=None, - showgrid=None, - tick0=None, - **kwargs - ): - """ - Construct a new Lataxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.geo.Lataxis - dtick - Sets the graticule's longitude/latitude tick step. - gridcolor - Sets the graticule's stroke color. - gridwidth - Sets the graticule's stroke width (in px). - range - Sets the range of this axis (in degrees), sets the - map's clipped coordinates. - showgrid - Sets whether or not graticule are shown on the map. - tick0 - Sets the graticule's starting tick longitude/latitude. - - Returns - ------- - Lataxis - """ - super(Lataxis, self).__init__('lataxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.geo.Lataxis -constructor must be a dict or -an instance of plotly.graph_objs.layout.geo.Lataxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.geo import (lataxis as v_lataxis) - - # Initialize validators - # --------------------- - self._validators['dtick'] = v_lataxis.DtickValidator() - self._validators['gridcolor'] = v_lataxis.GridcolorValidator() - self._validators['gridwidth'] = v_lataxis.GridwidthValidator() - self._validators['range'] = v_lataxis.RangeValidator() - self._validators['showgrid'] = v_lataxis.ShowgridValidator() - self._validators['tick0'] = v_lataxis.Tick0Validator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('gridcolor', None) - self['gridcolor'] = gridcolor if gridcolor is not None else _v - _v = arg.pop('gridwidth', None) - self['gridwidth'] = gridwidth if gridwidth is not None else _v - _v = arg.pop('range', None) - self['range'] = range if range is not None else _v - _v = arg.pop('showgrid', None) - self['showgrid'] = showgrid if showgrid is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/geo/_lonaxis.py b/plotly/graph_objs/layout/geo/_lonaxis.py deleted file mode 100644 index 2d07ad45af5..00000000000 --- a/plotly/graph_objs/layout/geo/_lonaxis.py +++ /dev/null @@ -1,291 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Lonaxis(BaseLayoutHierarchyType): - - # dtick - # ----- - @property - 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 - - Returns - ------- - int|float - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # gridcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['gridcolor'] - - @gridcolor.setter - def gridcolor(self, val): - self['gridcolor'] = val - - # gridwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['gridwidth'] - - @gridwidth.setter - def gridwidth(self, val): - self['gridwidth'] = val - - # range - # ----- - @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 - - Returns - ------- - list - """ - return self['range'] - - @range.setter - def range(self, val): - self['range'] = val - - # showgrid - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showgrid'] - - @showgrid.setter - def showgrid(self, val): - self['showgrid'] = val - - # tick0 - # ----- - @property - 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 - - Returns - ------- - int|float - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.geo' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtick - Sets the graticule's longitude/latitude tick step. - gridcolor - Sets the graticule's stroke color. - gridwidth - Sets the graticule's stroke width (in px). - range - Sets the range of this axis (in degrees), sets the - map's clipped coordinates. - showgrid - Sets whether or not graticule are shown on the map. - tick0 - Sets the graticule's starting tick longitude/latitude. - """ - - def __init__( - self, - arg=None, - dtick=None, - gridcolor=None, - gridwidth=None, - range=None, - showgrid=None, - tick0=None, - **kwargs - ): - """ - Construct a new Lonaxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.geo.Lonaxis - dtick - Sets the graticule's longitude/latitude tick step. - gridcolor - Sets the graticule's stroke color. - gridwidth - Sets the graticule's stroke width (in px). - range - Sets the range of this axis (in degrees), sets the - map's clipped coordinates. - showgrid - Sets whether or not graticule are shown on the map. - tick0 - Sets the graticule's starting tick longitude/latitude. - - Returns - ------- - Lonaxis - """ - super(Lonaxis, self).__init__('lonaxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.geo.Lonaxis -constructor must be a dict or -an instance of plotly.graph_objs.layout.geo.Lonaxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.geo import (lonaxis as v_lonaxis) - - # Initialize validators - # --------------------- - self._validators['dtick'] = v_lonaxis.DtickValidator() - self._validators['gridcolor'] = v_lonaxis.GridcolorValidator() - self._validators['gridwidth'] = v_lonaxis.GridwidthValidator() - self._validators['range'] = v_lonaxis.RangeValidator() - self._validators['showgrid'] = v_lonaxis.ShowgridValidator() - self._validators['tick0'] = v_lonaxis.Tick0Validator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('gridcolor', None) - self['gridcolor'] = gridcolor if gridcolor is not None else _v - _v = arg.pop('gridwidth', None) - self['gridwidth'] = gridwidth if gridwidth is not None else _v - _v = arg.pop('range', None) - self['range'] = range if range is not None else _v - _v = arg.pop('showgrid', None) - self['showgrid'] = showgrid if showgrid is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/geo/_projection.py b/plotly/graph_objs/layout/geo/_projection.py deleted file mode 100644 index 237faf49cb5..00000000000 --- a/plotly/graph_objs/layout/geo/_projection.py +++ /dev/null @@ -1,224 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Projection(BaseLayoutHierarchyType): - - # parallels - # --------- - @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 - - Returns - ------- - list - """ - return self['parallels'] - - @parallels.setter - def parallels(self, val): - self['parallels'] = val - - # rotation - # -------- - @property - def rotation(self): - """ - The 'rotation' property is an instance of Rotation - that may be specified as: - - An instance of 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). - lon - Rotates the map along parallels (in degrees - East). Defaults to the center of the - `lonaxis.range` values. - roll - Roll the map (in degrees) For example, a roll - of 180 makes the map appear upside down. - - Returns - ------- - plotly.graph_objs.layout.geo.projection.Rotation - """ - return self['rotation'] - - @rotation.setter - def rotation(self, val): - self['rotation'] = val - - # scale - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['scale'] - - @scale.setter - def scale(self, val): - self['scale'] = val - - # type - # ---- - @property - 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 - earth', 'kavrayskiy7', 'miller', 'robinson', 'eckert4', - 'azimuthal equal area', 'azimuthal equidistant', 'conic - equal area', 'conic conformal', 'conic equidistant', - 'gnomonic', 'stereographic', 'mollweide', 'hammer', - 'transverse mercator', 'albers usa', 'winkel tripel', - 'aitoff', 'sinusoidal'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.geo' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - parallels - For conic projection types only. Sets the parallels - (tangent, secant) where the cone intersects the sphere. - rotation - plotly.graph_objs.layout.geo.projection.Rotation - instance or dict with compatible properties - scale - 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. - type - Sets the projection type. - """ - - def __init__( - self, - arg=None, - parallels=None, - rotation=None, - scale=None, - type=None, - **kwargs - ): - """ - Construct a new Projection object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.geo.Projection - parallels - For conic projection types only. Sets the parallels - (tangent, secant) where the cone intersects the sphere. - rotation - plotly.graph_objs.layout.geo.projection.Rotation - instance or dict with compatible properties - scale - 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. - type - Sets the projection type. - - Returns - ------- - Projection - """ - super(Projection, self).__init__('projection') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.geo.Projection -constructor must be a dict or -an instance of plotly.graph_objs.layout.geo.Projection""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.geo import (projection as v_projection) - - # Initialize validators - # --------------------- - self._validators['parallels'] = v_projection.ParallelsValidator() - self._validators['rotation'] = v_projection.RotationValidator() - self._validators['scale'] = v_projection.ScaleValidator() - self._validators['type'] = v_projection.TypeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('parallels', None) - self['parallels'] = parallels if parallels is not None else _v - _v = arg.pop('rotation', None) - self['rotation'] = rotation if rotation is not None else _v - _v = arg.pop('scale', None) - self['scale'] = scale if scale is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/geo/projection/__init__.py b/plotly/graph_objs/layout/geo/projection/__init__.py index 366702a7bea..be637299cf0 100644 --- a/plotly/graph_objs/layout/geo/projection/__init__.py +++ b/plotly/graph_objs/layout/geo/projection/__init__.py @@ -1 +1,164 @@ -from ._rotation import Rotation + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Rotation(_BaseLayoutHierarchyType): + + # lat + # --- + @property + 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 + + Returns + ------- + int|float + """ + return self['lat'] + + @lat.setter + def lat(self, val): + self['lat'] = val + + # lon + # --- + @property + 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 + + Returns + ------- + int|float + """ + return self['lon'] + + @lon.setter + def lon(self, val): + self['lon'] = val + + # roll + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['roll'] + + @roll.setter + def roll(self, val): + self['roll'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.geo.projection' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + lat + Rotates the map along meridians (in degrees North). + lon + Rotates the map along parallels (in degrees East). + Defaults to the center of the `lonaxis.range` values. + roll + Roll the map (in degrees) For example, a roll of 180 + makes the map appear upside down. + """ + + def __init__(self, arg=None, lat=None, lon=None, roll=None, **kwargs): + """ + Construct a new Rotation object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.geo.projection.Rotation + lat + Rotates the map along meridians (in degrees North). + lon + Rotates the map along parallels (in degrees East). + Defaults to the center of the `lonaxis.range` values. + roll + Roll the map (in degrees) For example, a roll of 180 + makes the map appear upside down. + + Returns + ------- + Rotation + """ + super(Rotation, self).__init__('rotation') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.geo.projection.Rotation +constructor must be a dict or +an instance of plotly.graph_objs.layout.geo.projection.Rotation""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.geo.projection import ( + rotation as v_rotation + ) + + # Initialize validators + # --------------------- + self._validators['lat'] = v_rotation.LatValidator() + self._validators['lon'] = v_rotation.LonValidator() + self._validators['roll'] = v_rotation.RollValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('lat', None) + self['lat'] = lat if lat is not None else _v + _v = arg.pop('lon', None) + self['lon'] = lon if lon is not None else _v + _v = arg.pop('roll', None) + self['roll'] = roll if roll is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/geo/projection/_rotation.py b/plotly/graph_objs/layout/geo/projection/_rotation.py deleted file mode 100644 index 735d5f3a63f..00000000000 --- a/plotly/graph_objs/layout/geo/projection/_rotation.py +++ /dev/null @@ -1,162 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Rotation(BaseLayoutHierarchyType): - - # lat - # --- - @property - 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 - - Returns - ------- - int|float - """ - return self['lat'] - - @lat.setter - def lat(self, val): - self['lat'] = val - - # lon - # --- - @property - 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 - - Returns - ------- - int|float - """ - return self['lon'] - - @lon.setter - def lon(self, val): - self['lon'] = val - - # roll - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['roll'] - - @roll.setter - def roll(self, val): - self['roll'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.geo.projection' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - lat - Rotates the map along meridians (in degrees North). - lon - Rotates the map along parallels (in degrees East). - Defaults to the center of the `lonaxis.range` values. - roll - Roll the map (in degrees) For example, a roll of 180 - makes the map appear upside down. - """ - - def __init__(self, arg=None, lat=None, lon=None, roll=None, **kwargs): - """ - Construct a new Rotation object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.geo.projection.Rotation - lat - Rotates the map along meridians (in degrees North). - lon - Rotates the map along parallels (in degrees East). - Defaults to the center of the `lonaxis.range` values. - roll - Roll the map (in degrees) For example, a roll of 180 - makes the map appear upside down. - - Returns - ------- - Rotation - """ - super(Rotation, self).__init__('rotation') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.geo.projection.Rotation -constructor must be a dict or -an instance of plotly.graph_objs.layout.geo.projection.Rotation""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.geo.projection import ( - rotation as v_rotation - ) - - # Initialize validators - # --------------------- - self._validators['lat'] = v_rotation.LatValidator() - self._validators['lon'] = v_rotation.LonValidator() - self._validators['roll'] = v_rotation.RollValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('lat', None) - self['lat'] = lat if lat is not None else _v - _v = arg.pop('lon', None) - self['lon'] = lon if lon is not None else _v - _v = arg.pop('roll', None) - self['roll'] = roll if roll is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/grid/__init__.py b/plotly/graph_objs/layout/grid/__init__.py index ee28990c0dd..a4021fabc34 100644 --- a/plotly/graph_objs/layout/grid/__init__.py +++ b/plotly/graph_objs/layout/grid/__init__.py @@ -1 +1,150 @@ -from ._domain import Domain + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Domain(_BaseLayoutHierarchyType): + + # x + # - + @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] + + Returns + ------- + list + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @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] + + Returns + ------- + list + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.grid' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + 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. + y + 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. + """ + + def __init__(self, arg=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.grid.Domain + x + 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. + y + 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 + ------- + Domain + """ + super(Domain, self).__init__('domain') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.grid.Domain +constructor must be a dict or +an instance of plotly.graph_objs.layout.grid.Domain""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.grid import (domain as v_domain) + + # Initialize validators + # --------------------- + self._validators['x'] = v_domain.XValidator() + self._validators['y'] = v_domain.YValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/grid/_domain.py b/plotly/graph_objs/layout/grid/_domain.py deleted file mode 100644 index aa2e7b4a7fc..00000000000 --- a/plotly/graph_objs/layout/grid/_domain.py +++ /dev/null @@ -1,148 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Domain(BaseLayoutHierarchyType): - - # x - # - - @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] - - Returns - ------- - list - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @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] - - Returns - ------- - list - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.grid' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - 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. - y - 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. - """ - - def __init__(self, arg=None, x=None, y=None, **kwargs): - """ - Construct a new Domain object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.grid.Domain - x - 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. - y - 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 - ------- - Domain - """ - super(Domain, self).__init__('domain') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.grid.Domain -constructor must be a dict or -an instance of plotly.graph_objs.layout.grid.Domain""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.grid import (domain as v_domain) - - # Initialize validators - # --------------------- - self._validators['x'] = v_domain.XValidator() - self._validators['y'] = v_domain.YValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/hoverlabel/__init__.py b/plotly/graph_objs/layout/hoverlabel/__init__.py index c37b8b5cd28..ee274653e0f 100644 --- a/plotly/graph_objs/layout/hoverlabel/__init__.py +++ b/plotly/graph_objs/layout/hoverlabel/__init__.py @@ -1 +1,228 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.hoverlabel.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/hoverlabel/_font.py b/plotly/graph_objs/layout/hoverlabel/_font.py deleted file mode 100644 index 5bbc62a6484..00000000000 --- a/plotly/graph_objs/layout/hoverlabel/_font.py +++ /dev/null @@ -1,226 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.hoverlabel.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/legend/__init__.py b/plotly/graph_objs/layout/legend/__init__.py index c37b8b5cd28..30b65f8d194 100644 --- a/plotly/graph_objs/layout/legend/__init__.py +++ b/plotly/graph_objs/layout/legend/__init__.py @@ -1 +1,227 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.legend' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.legend.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.legend.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.legend.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.legend import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/legend/_font.py b/plotly/graph_objs/layout/legend/_font.py deleted file mode 100644 index a7a04c262d8..00000000000 --- a/plotly/graph_objs/layout/legend/_font.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.legend' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.legend.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.legend.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.legend.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.legend import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/mapbox/__init__.py b/plotly/graph_objs/layout/mapbox/__init__.py index 704e3c09d03..e9077b21558 100644 --- a/plotly/graph_objs/layout/mapbox/__init__.py +++ b/plotly/graph_objs/layout/mapbox/__init__.py @@ -1,4 +1,1121 @@ -from ._layer import Layer + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Layer(_BaseLayoutHierarchyType): + + # below + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['below'] + + @below.setter + def below(self, val): + self['below'] = val + + # circle + # ------ + @property + def circle(self): + """ + The 'circle' property is an instance of Circle + that may be specified as: + - An instance of 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 + effect only when `type` is set to "circle". + + Returns + ------- + plotly.graph_objs.layout.mapbox.layer.Circle + """ + return self['circle'] + + @circle.setter + def circle(self, val): + self['circle'] = val + + # color + # ----- + @property + def color(self): + """ + Sets the primary layer color. If `type` is "circle", color + corresponds to the circle color (mapbox.layer.paint.circle- + color) If `type` is "line", color corresponds to the line color + (mapbox.layer.paint.line-color) If `type` is "fill", color + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # fill + # ---- + @property + def fill(self): + """ + The 'fill' property is an instance of Fill + that may be specified as: + - An instance of 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 + effect only when `type` is set to "fill". + + Returns + ------- + plotly.graph_objs.layout.mapbox.layer.Fill + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + effect only when `type` is set to "line". + dashsrc + Sets the source reference on plot.ly for dash + . + width + Sets the line width (mapbox.layer.paint.line- + width). Has an effect only when `type` is set + to "line". + + Returns + ------- + plotly.graph_objs.layout.mapbox.layer.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # maxzoom + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxzoom'] + + @maxzoom.setter + def maxzoom(self, val): + self['maxzoom'] = val + + # minzoom + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['minzoom'] + + @minzoom.setter + def minzoom(self, val): + self['minzoom'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + def opacity(self): + """ + Sets the opacity of the layer. If `type` is "circle", opacity + corresponds to the circle opacity (mapbox.layer.paint.circle- + opacity) If `type` is "line", opacity corresponds to the line + opacity (mapbox.layer.paint.line-opacity) If `type` is "fill", + opacity corresponds to the fill opacity + (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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # source + # ------ + @property + def source(self): + """ + Sets the source data for this layer (mapbox.layer.source). + Source can be either a URL, a geojson object (with `sourcetype` + set to "geojson") or an array of tile URLS (with `sourcetype` + set to "vector"). + + The 'source' property accepts values of any type + + Returns + ------- + Any + """ + return self['source'] + + @source.setter + def source(self, val): + self['source'] = val + + # sourcelayer + # ----------- + @property + 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 + + Returns + ------- + str + """ + return self['sourcelayer'] + + @sourcelayer.setter + def sourcelayer(self, val): + self['sourcelayer'] = val + + # sourcetype + # ---------- + @property + def sourcetype(self): + """ + Sets the source type for this layer. Support for "raster", + "image" and "video" source types is coming soon. + + The 'sourcetype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['geojson', 'vector'] + + Returns + ------- + Any + """ + return self['sourcetype'] + + @sourcetype.setter + def sourcetype(self, val): + self['sourcetype'] = val + + # symbol + # ------ + @property + def symbol(self): + """ + The 'symbol' property is an instance of Symbol + that may be specified as: + - An instance of 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: + https://www.mapbox.com/maki-icons/ + iconsize + Sets the symbol icon size + (mapbox.layer.layout.icon-size). Has an effect + only when `type` is set to "symbol". + placement + Sets the symbol and/or text placement + (mapbox.layer.layout.symbol-placement). If + `placement` is "point", the label is placed + where the geometry is located If `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 + text + Sets the symbol text (mapbox.layer.layout.text- + field). + textfont + Sets the icon text font + (color=mapbox.layer.paint.text-color, + size=mapbox.layer.layout.text-size). Has an + effect only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with + respects to the (x,y) coordinates. + + Returns + ------- + plotly.graph_objs.layout.mapbox.layer.Symbol + """ + return self['symbol'] + + @symbol.setter + def symbol(self, val): + self['symbol'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # type + # ---- + @property + def type(self): + """ + Sets the layer type (mapbox.layer.type). Support for "raster", + "background" types is coming soon. Note that "line" and "fill" + are not compatible with Point GeoJSON geometries. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['circle', 'line', 'fill', 'symbol'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # visible + # ------- + @property + def visible(self): + """ + Determines whether this layer is displayed + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.mapbox' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + below + 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. + circle + plotly.graph_objs.layout.mapbox.layer.Circle instance + or dict with compatible properties + color + Sets the primary layer color. If `type` is "circle", + color corresponds to the circle color + (mapbox.layer.paint.circle-color) If `type` is "line", + color corresponds to the line color + (mapbox.layer.paint.line-color) If `type` is "fill", + color 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) + fill + plotly.graph_objs.layout.mapbox.layer.Fill instance or + dict with compatible properties + line + plotly.graph_objs.layout.mapbox.layer.Line instance or + dict with compatible properties + maxzoom + Sets the maximum zoom level (mapbox.layer.maxzoom). At + zoom levels equal to or greater than the maxzoom, the + layer will be hidden. + minzoom + Sets the minimum zoom level (mapbox.layer.minzoom). At + zoom levels less than the minzoom, the layer will be + hidden. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the layer. If `type` is "circle", + opacity corresponds to the circle opacity + (mapbox.layer.paint.circle-opacity) If `type` is + "line", opacity corresponds to the line opacity + (mapbox.layer.paint.line-opacity) If `type` is "fill", + opacity corresponds to the fill opacity + (mapbox.layer.paint.fill-opacity) If `type` is + "symbol", opacity corresponds to the icon/text opacity + (mapbox.layer.paint.text-opacity) + source + Sets the source data for this layer + (mapbox.layer.source). Source can be either a URL, a + geojson object (with `sourcetype` set to "geojson") or + an array of tile URLS (with `sourcetype` set to + "vector"). + sourcelayer + Specifies the layer to use from a vector tile source + (mapbox.layer.source-layer). Required for "vector" + source type that supports multiple layers. + sourcetype + Sets the source type for this layer. Support for + "raster", "image" and "video" source types is coming + soon. + symbol + plotly.graph_objs.layout.mapbox.layer.Symbol instance + or dict with compatible properties + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Sets the layer type (mapbox.layer.type). Support for + "raster", "background" types is coming soon. Note that + "line" and "fill" are not compatible with Point GeoJSON + geometries. + visible + Determines whether this layer is displayed + """ + + def __init__( + self, + arg=None, + below=None, + circle=None, + color=None, + fill=None, + line=None, + maxzoom=None, + minzoom=None, + name=None, + opacity=None, + source=None, + sourcelayer=None, + sourcetype=None, + symbol=None, + templateitemname=None, + type=None, + visible=None, + **kwargs + ): + """ + Construct a new Layer object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.mapbox.Layer + below + 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. + circle + plotly.graph_objs.layout.mapbox.layer.Circle instance + or dict with compatible properties + color + Sets the primary layer color. If `type` is "circle", + color corresponds to the circle color + (mapbox.layer.paint.circle-color) If `type` is "line", + color corresponds to the line color + (mapbox.layer.paint.line-color) If `type` is "fill", + color 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) + fill + plotly.graph_objs.layout.mapbox.layer.Fill instance or + dict with compatible properties + line + plotly.graph_objs.layout.mapbox.layer.Line instance or + dict with compatible properties + maxzoom + Sets the maximum zoom level (mapbox.layer.maxzoom). At + zoom levels equal to or greater than the maxzoom, the + layer will be hidden. + minzoom + Sets the minimum zoom level (mapbox.layer.minzoom). At + zoom levels less than the minzoom, the layer will be + hidden. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the layer. If `type` is "circle", + opacity corresponds to the circle opacity + (mapbox.layer.paint.circle-opacity) If `type` is + "line", opacity corresponds to the line opacity + (mapbox.layer.paint.line-opacity) If `type` is "fill", + opacity corresponds to the fill opacity + (mapbox.layer.paint.fill-opacity) If `type` is + "symbol", opacity corresponds to the icon/text opacity + (mapbox.layer.paint.text-opacity) + source + Sets the source data for this layer + (mapbox.layer.source). Source can be either a URL, a + geojson object (with `sourcetype` set to "geojson") or + an array of tile URLS (with `sourcetype` set to + "vector"). + sourcelayer + Specifies the layer to use from a vector tile source + (mapbox.layer.source-layer). Required for "vector" + source type that supports multiple layers. + sourcetype + Sets the source type for this layer. Support for + "raster", "image" and "video" source types is coming + soon. + symbol + plotly.graph_objs.layout.mapbox.layer.Symbol instance + or dict with compatible properties + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Sets the layer type (mapbox.layer.type). Support for + "raster", "background" types is coming soon. Note that + "line" and "fill" are not compatible with Point GeoJSON + geometries. + visible + Determines whether this layer is displayed + + Returns + ------- + Layer + """ + super(Layer, self).__init__('layers') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.mapbox.Layer +constructor must be a dict or +an instance of plotly.graph_objs.layout.mapbox.Layer""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.mapbox import (layer as v_layer) + + # Initialize validators + # --------------------- + self._validators['below'] = v_layer.BelowValidator() + self._validators['circle'] = v_layer.CircleValidator() + self._validators['color'] = v_layer.ColorValidator() + self._validators['fill'] = v_layer.FillValidator() + self._validators['line'] = v_layer.LineValidator() + self._validators['maxzoom'] = v_layer.MaxzoomValidator() + self._validators['minzoom'] = v_layer.MinzoomValidator() + self._validators['name'] = v_layer.NameValidator() + self._validators['opacity'] = v_layer.OpacityValidator() + self._validators['source'] = v_layer.SourceValidator() + self._validators['sourcelayer'] = v_layer.SourcelayerValidator() + self._validators['sourcetype'] = v_layer.SourcetypeValidator() + self._validators['symbol'] = v_layer.SymbolValidator() + self._validators['templateitemname' + ] = v_layer.TemplateitemnameValidator() + self._validators['type'] = v_layer.TypeValidator() + self._validators['visible'] = v_layer.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('below', None) + self['below'] = below if below is not None else _v + _v = arg.pop('circle', None) + self['circle'] = circle if circle is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('maxzoom', None) + self['maxzoom'] = maxzoom if maxzoom is not None else _v + _v = arg.pop('minzoom', None) + self['minzoom'] = minzoom if minzoom is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('source', None) + self['source'] = source if source is not None else _v + _v = arg.pop('sourcelayer', None) + self['sourcelayer'] = sourcelayer if sourcelayer is not None else _v + _v = arg.pop('sourcetype', None) + self['sourcetype'] = sourcetype if sourcetype is not None else _v + _v = arg.pop('symbol', None) + self['symbol'] = symbol if symbol is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Domain(_BaseLayoutHierarchyType): + + # column + # ------ + @property + 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] + + Returns + ------- + int + """ + return self['column'] + + @column.setter + def column(self, val): + self['column'] = val + + # row + # --- + @property + 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] + + Returns + ------- + int + """ + return self['row'] + + @row.setter + def row(self, val): + self['row'] = val + + # x + # - + @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] + + Returns + ------- + list + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @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] + + Returns + ------- + list + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.mapbox' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this mapbox subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this mapbox subplot . + x + Sets the horizontal domain of this mapbox subplot (in + plot fraction). + y + Sets the vertical domain of this mapbox subplot (in + plot fraction). + """ + + def __init__( + self, arg=None, column=None, row=None, x=None, y=None, **kwargs + ): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.mapbox.Domain + column + If there is a layout grid, use the domain for this + column in the grid for this mapbox subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this mapbox subplot . + x + Sets the horizontal domain of this mapbox subplot (in + plot fraction). + y + Sets the vertical domain of this mapbox subplot (in + plot fraction). + + Returns + ------- + Domain + """ + super(Domain, self).__init__('domain') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.mapbox.Domain +constructor must be a dict or +an instance of plotly.graph_objs.layout.mapbox.Domain""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.mapbox import (domain as v_domain) + + # Initialize validators + # --------------------- + self._validators['column'] = v_domain.ColumnValidator() + self._validators['row'] = v_domain.RowValidator() + self._validators['x'] = v_domain.XValidator() + self._validators['y'] = v_domain.YValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('column', None) + self['column'] = column if column is not None else _v + _v = arg.pop('row', None) + self['row'] = row if row is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Center(_BaseLayoutHierarchyType): + + # lat + # --- + @property + 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 + + Returns + ------- + int|float + """ + return self['lat'] + + @lat.setter + def lat(self, val): + self['lat'] = val + + # lon + # --- + @property + 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 + + Returns + ------- + int|float + """ + return self['lon'] + + @lon.setter + def lon(self, val): + self['lon'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.mapbox' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + lat + Sets the latitude of the center of the map (in degrees + North). + lon + Sets the longitude of the center of the map (in degrees + East). + """ + + def __init__(self, arg=None, lat=None, lon=None, **kwargs): + """ + Construct a new Center object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.mapbox.Center + lat + Sets the latitude of the center of the map (in degrees + North). + lon + Sets the longitude of the center of the map (in degrees + East). + + Returns + ------- + Center + """ + super(Center, self).__init__('center') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.mapbox.Center +constructor must be a dict or +an instance of plotly.graph_objs.layout.mapbox.Center""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.mapbox import (center as v_center) + + # Initialize validators + # --------------------- + self._validators['lat'] = v_center.LatValidator() + self._validators['lon'] = v_center.LonValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('lat', None) + self['lat'] = lat if lat is not None else _v + _v = arg.pop('lon', None) + self['lon'] = lon if lon is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.mapbox import layer -from ._domain import Domain -from ._center import Center diff --git a/plotly/graph_objs/layout/mapbox/_center.py b/plotly/graph_objs/layout/mapbox/_center.py deleted file mode 100644 index 5b1f70e8dbc..00000000000 --- a/plotly/graph_objs/layout/mapbox/_center.py +++ /dev/null @@ -1,130 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Center(BaseLayoutHierarchyType): - - # lat - # --- - @property - 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 - - Returns - ------- - int|float - """ - return self['lat'] - - @lat.setter - def lat(self, val): - self['lat'] = val - - # lon - # --- - @property - 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 - - Returns - ------- - int|float - """ - return self['lon'] - - @lon.setter - def lon(self, val): - self['lon'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.mapbox' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - lat - Sets the latitude of the center of the map (in degrees - North). - lon - Sets the longitude of the center of the map (in degrees - East). - """ - - def __init__(self, arg=None, lat=None, lon=None, **kwargs): - """ - Construct a new Center object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.mapbox.Center - lat - Sets the latitude of the center of the map (in degrees - North). - lon - Sets the longitude of the center of the map (in degrees - East). - - Returns - ------- - Center - """ - super(Center, self).__init__('center') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.mapbox.Center -constructor must be a dict or -an instance of plotly.graph_objs.layout.mapbox.Center""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.mapbox import (center as v_center) - - # Initialize validators - # --------------------- - self._validators['lat'] = v_center.LatValidator() - self._validators['lon'] = v_center.LonValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('lat', None) - self['lat'] = lat if lat is not None else _v - _v = arg.pop('lon', None) - self['lon'] = lon if lon is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/mapbox/_domain.py b/plotly/graph_objs/layout/mapbox/_domain.py deleted file mode 100644 index a26f9e6a424..00000000000 --- a/plotly/graph_objs/layout/mapbox/_domain.py +++ /dev/null @@ -1,206 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Domain(BaseLayoutHierarchyType): - - # column - # ------ - @property - 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] - - Returns - ------- - int - """ - return self['column'] - - @column.setter - def column(self, val): - self['column'] = val - - # row - # --- - @property - 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] - - Returns - ------- - int - """ - return self['row'] - - @row.setter - def row(self, val): - self['row'] = val - - # x - # - - @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] - - Returns - ------- - list - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @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] - - Returns - ------- - list - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.mapbox' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - column - If there is a layout grid, use the domain for this - column in the grid for this mapbox subplot . - row - If there is a layout grid, use the domain for this row - in the grid for this mapbox subplot . - x - Sets the horizontal domain of this mapbox subplot (in - plot fraction). - y - Sets the vertical domain of this mapbox subplot (in - plot fraction). - """ - - def __init__( - self, arg=None, column=None, row=None, x=None, y=None, **kwargs - ): - """ - Construct a new Domain object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.mapbox.Domain - column - If there is a layout grid, use the domain for this - column in the grid for this mapbox subplot . - row - If there is a layout grid, use the domain for this row - in the grid for this mapbox subplot . - x - Sets the horizontal domain of this mapbox subplot (in - plot fraction). - y - Sets the vertical domain of this mapbox subplot (in - plot fraction). - - Returns - ------- - Domain - """ - super(Domain, self).__init__('domain') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.mapbox.Domain -constructor must be a dict or -an instance of plotly.graph_objs.layout.mapbox.Domain""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.mapbox import (domain as v_domain) - - # Initialize validators - # --------------------- - self._validators['column'] = v_domain.ColumnValidator() - self._validators['row'] = v_domain.RowValidator() - self._validators['x'] = v_domain.XValidator() - self._validators['y'] = v_domain.YValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('column', None) - self['column'] = column if column is not None else _v - _v = arg.pop('row', None) - self['row'] = row if row is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/mapbox/_layer.py b/plotly/graph_objs/layout/mapbox/_layer.py deleted file mode 100644 index 803c26b574a..00000000000 --- a/plotly/graph_objs/layout/mapbox/_layer.py +++ /dev/null @@ -1,776 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Layer(BaseLayoutHierarchyType): - - # below - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['below'] - - @below.setter - def below(self, val): - self['below'] = val - - # circle - # ------ - @property - def circle(self): - """ - The 'circle' property is an instance of Circle - that may be specified as: - - An instance of 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 - effect only when `type` is set to "circle". - - Returns - ------- - plotly.graph_objs.layout.mapbox.layer.Circle - """ - return self['circle'] - - @circle.setter - def circle(self, val): - self['circle'] = val - - # color - # ----- - @property - def color(self): - """ - Sets the primary layer color. If `type` is "circle", color - corresponds to the circle color (mapbox.layer.paint.circle- - color) If `type` is "line", color corresponds to the line color - (mapbox.layer.paint.line-color) If `type` is "fill", color - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # fill - # ---- - @property - def fill(self): - """ - The 'fill' property is an instance of Fill - that may be specified as: - - An instance of 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 - effect only when `type` is set to "fill". - - Returns - ------- - plotly.graph_objs.layout.mapbox.layer.Fill - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - effect only when `type` is set to "line". - dashsrc - Sets the source reference on plot.ly for dash - . - width - Sets the line width (mapbox.layer.paint.line- - width). Has an effect only when `type` is set - to "line". - - Returns - ------- - plotly.graph_objs.layout.mapbox.layer.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # maxzoom - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxzoom'] - - @maxzoom.setter - def maxzoom(self, val): - self['maxzoom'] = val - - # minzoom - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['minzoom'] - - @minzoom.setter - def minzoom(self, val): - self['minzoom'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - def opacity(self): - """ - Sets the opacity of the layer. If `type` is "circle", opacity - corresponds to the circle opacity (mapbox.layer.paint.circle- - opacity) If `type` is "line", opacity corresponds to the line - opacity (mapbox.layer.paint.line-opacity) If `type` is "fill", - opacity corresponds to the fill opacity - (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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # source - # ------ - @property - def source(self): - """ - Sets the source data for this layer (mapbox.layer.source). - Source can be either a URL, a geojson object (with `sourcetype` - set to "geojson") or an array of tile URLS (with `sourcetype` - set to "vector"). - - The 'source' property accepts values of any type - - Returns - ------- - Any - """ - return self['source'] - - @source.setter - def source(self, val): - self['source'] = val - - # sourcelayer - # ----------- - @property - 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 - - Returns - ------- - str - """ - return self['sourcelayer'] - - @sourcelayer.setter - def sourcelayer(self, val): - self['sourcelayer'] = val - - # sourcetype - # ---------- - @property - def sourcetype(self): - """ - Sets the source type for this layer. Support for "raster", - "image" and "video" source types is coming soon. - - The 'sourcetype' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['geojson', 'vector'] - - Returns - ------- - Any - """ - return self['sourcetype'] - - @sourcetype.setter - def sourcetype(self, val): - self['sourcetype'] = val - - # symbol - # ------ - @property - def symbol(self): - """ - The 'symbol' property is an instance of Symbol - that may be specified as: - - An instance of 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: - https://www.mapbox.com/maki-icons/ - iconsize - Sets the symbol icon size - (mapbox.layer.layout.icon-size). Has an effect - only when `type` is set to "symbol". - placement - Sets the symbol and/or text placement - (mapbox.layer.layout.symbol-placement). If - `placement` is "point", the label is placed - where the geometry is located If `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 - text - Sets the symbol text (mapbox.layer.layout.text- - field). - textfont - Sets the icon text font - (color=mapbox.layer.paint.text-color, - size=mapbox.layer.layout.text-size). Has an - effect only when `type` is set to "symbol". - textposition - Sets the positions of the `text` elements with - respects to the (x,y) coordinates. - - Returns - ------- - plotly.graph_objs.layout.mapbox.layer.Symbol - """ - return self['symbol'] - - @symbol.setter - def symbol(self, val): - self['symbol'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # type - # ---- - @property - def type(self): - """ - Sets the layer type (mapbox.layer.type). Support for "raster", - "background" types is coming soon. Note that "line" and "fill" - are not compatible with Point GeoJSON geometries. - - The 'type' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['circle', 'line', 'fill', 'symbol'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # visible - # ------- - @property - def visible(self): - """ - Determines whether this layer is displayed - - The 'visible' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.mapbox' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - below - 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. - circle - plotly.graph_objs.layout.mapbox.layer.Circle instance - or dict with compatible properties - color - Sets the primary layer color. If `type` is "circle", - color corresponds to the circle color - (mapbox.layer.paint.circle-color) If `type` is "line", - color corresponds to the line color - (mapbox.layer.paint.line-color) If `type` is "fill", - color 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) - fill - plotly.graph_objs.layout.mapbox.layer.Fill instance or - dict with compatible properties - line - plotly.graph_objs.layout.mapbox.layer.Line instance or - dict with compatible properties - maxzoom - Sets the maximum zoom level (mapbox.layer.maxzoom). At - zoom levels equal to or greater than the maxzoom, the - layer will be hidden. - minzoom - Sets the minimum zoom level (mapbox.layer.minzoom). At - zoom levels less than the minzoom, the layer will be - hidden. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - opacity - Sets the opacity of the layer. If `type` is "circle", - opacity corresponds to the circle opacity - (mapbox.layer.paint.circle-opacity) If `type` is - "line", opacity corresponds to the line opacity - (mapbox.layer.paint.line-opacity) If `type` is "fill", - opacity corresponds to the fill opacity - (mapbox.layer.paint.fill-opacity) If `type` is - "symbol", opacity corresponds to the icon/text opacity - (mapbox.layer.paint.text-opacity) - source - Sets the source data for this layer - (mapbox.layer.source). Source can be either a URL, a - geojson object (with `sourcetype` set to "geojson") or - an array of tile URLS (with `sourcetype` set to - "vector"). - sourcelayer - Specifies the layer to use from a vector tile source - (mapbox.layer.source-layer). Required for "vector" - source type that supports multiple layers. - sourcetype - Sets the source type for this layer. Support for - "raster", "image" and "video" source types is coming - soon. - symbol - plotly.graph_objs.layout.mapbox.layer.Symbol instance - or dict with compatible properties - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - type - Sets the layer type (mapbox.layer.type). Support for - "raster", "background" types is coming soon. Note that - "line" and "fill" are not compatible with Point GeoJSON - geometries. - visible - Determines whether this layer is displayed - """ - - def __init__( - self, - arg=None, - below=None, - circle=None, - color=None, - fill=None, - line=None, - maxzoom=None, - minzoom=None, - name=None, - opacity=None, - source=None, - sourcelayer=None, - sourcetype=None, - symbol=None, - templateitemname=None, - type=None, - visible=None, - **kwargs - ): - """ - Construct a new Layer object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.mapbox.Layer - below - 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. - circle - plotly.graph_objs.layout.mapbox.layer.Circle instance - or dict with compatible properties - color - Sets the primary layer color. If `type` is "circle", - color corresponds to the circle color - (mapbox.layer.paint.circle-color) If `type` is "line", - color corresponds to the line color - (mapbox.layer.paint.line-color) If `type` is "fill", - color 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) - fill - plotly.graph_objs.layout.mapbox.layer.Fill instance or - dict with compatible properties - line - plotly.graph_objs.layout.mapbox.layer.Line instance or - dict with compatible properties - maxzoom - Sets the maximum zoom level (mapbox.layer.maxzoom). At - zoom levels equal to or greater than the maxzoom, the - layer will be hidden. - minzoom - Sets the minimum zoom level (mapbox.layer.minzoom). At - zoom levels less than the minzoom, the layer will be - hidden. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - opacity - Sets the opacity of the layer. If `type` is "circle", - opacity corresponds to the circle opacity - (mapbox.layer.paint.circle-opacity) If `type` is - "line", opacity corresponds to the line opacity - (mapbox.layer.paint.line-opacity) If `type` is "fill", - opacity corresponds to the fill opacity - (mapbox.layer.paint.fill-opacity) If `type` is - "symbol", opacity corresponds to the icon/text opacity - (mapbox.layer.paint.text-opacity) - source - Sets the source data for this layer - (mapbox.layer.source). Source can be either a URL, a - geojson object (with `sourcetype` set to "geojson") or - an array of tile URLS (with `sourcetype` set to - "vector"). - sourcelayer - Specifies the layer to use from a vector tile source - (mapbox.layer.source-layer). Required for "vector" - source type that supports multiple layers. - sourcetype - Sets the source type for this layer. Support for - "raster", "image" and "video" source types is coming - soon. - symbol - plotly.graph_objs.layout.mapbox.layer.Symbol instance - or dict with compatible properties - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - type - Sets the layer type (mapbox.layer.type). Support for - "raster", "background" types is coming soon. Note that - "line" and "fill" are not compatible with Point GeoJSON - geometries. - visible - Determines whether this layer is displayed - - Returns - ------- - Layer - """ - super(Layer, self).__init__('layers') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.mapbox.Layer -constructor must be a dict or -an instance of plotly.graph_objs.layout.mapbox.Layer""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.mapbox import (layer as v_layer) - - # Initialize validators - # --------------------- - self._validators['below'] = v_layer.BelowValidator() - self._validators['circle'] = v_layer.CircleValidator() - self._validators['color'] = v_layer.ColorValidator() - self._validators['fill'] = v_layer.FillValidator() - self._validators['line'] = v_layer.LineValidator() - self._validators['maxzoom'] = v_layer.MaxzoomValidator() - self._validators['minzoom'] = v_layer.MinzoomValidator() - self._validators['name'] = v_layer.NameValidator() - self._validators['opacity'] = v_layer.OpacityValidator() - self._validators['source'] = v_layer.SourceValidator() - self._validators['sourcelayer'] = v_layer.SourcelayerValidator() - self._validators['sourcetype'] = v_layer.SourcetypeValidator() - self._validators['symbol'] = v_layer.SymbolValidator() - self._validators['templateitemname' - ] = v_layer.TemplateitemnameValidator() - self._validators['type'] = v_layer.TypeValidator() - self._validators['visible'] = v_layer.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('below', None) - self['below'] = below if below is not None else _v - _v = arg.pop('circle', None) - self['circle'] = circle if circle is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('maxzoom', None) - self['maxzoom'] = maxzoom if maxzoom is not None else _v - _v = arg.pop('minzoom', None) - self['minzoom'] = minzoom if minzoom is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('source', None) - self['source'] = source if source is not None else _v - _v = arg.pop('sourcelayer', None) - self['sourcelayer'] = sourcelayer if sourcelayer is not None else _v - _v = arg.pop('sourcetype', None) - self['sourcetype'] = sourcetype if sourcetype is not None else _v - _v = arg.pop('symbol', None) - self['symbol'] = symbol if symbol is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/mapbox/layer/__init__.py b/plotly/graph_objs/layout/mapbox/layer/__init__.py index 872430a71b4..2a0528842a2 100644 --- a/plotly/graph_objs/layout/mapbox/layer/__init__.py +++ b/plotly/graph_objs/layout/mapbox/layer/__init__.py @@ -1,5 +1,734 @@ -from ._symbol import Symbol + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Symbol(_BaseLayoutHierarchyType): + + # icon + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['icon'] + + @icon.setter + def icon(self, val): + self['icon'] = val + + # iconsize + # -------- + @property + 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 + + Returns + ------- + int|float + """ + return self['iconsize'] + + @iconsize.setter + def iconsize(self, val): + self['iconsize'] = val + + # placement + # --------- + @property + def placement(self): + """ + Sets the symbol and/or text placement + (mapbox.layer.layout.symbol-placement). If `placement` is + "point", the label is placed where the geometry is located If + `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'] + + Returns + ------- + Any + """ + return self['placement'] + + @placement.setter + def placement(self, val): + self['placement'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.mapbox.layer.symbol.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # textposition + # ------------ + @property + 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', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + + Returns + ------- + Any + """ + return self['textposition'] + + @textposition.setter + def textposition(self, val): + self['textposition'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.mapbox.layer' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + icon + Sets the symbol icon image (mapbox.layer.layout.icon- + image). Full list: https://www.mapbox.com/maki-icons/ + iconsize + Sets the symbol icon size (mapbox.layer.layout.icon- + size). Has an effect only when `type` is set to + "symbol". + placement + Sets the symbol and/or text placement + (mapbox.layer.layout.symbol-placement). If `placement` + is "point", the label is placed where the geometry is + located If `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 + text + Sets the symbol text (mapbox.layer.layout.text-field). + textfont + Sets the icon text font (color=mapbox.layer.paint.text- + color, size=mapbox.layer.layout.text-size). Has an + effect only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + """ + + def __init__( + self, + arg=None, + icon=None, + iconsize=None, + placement=None, + text=None, + textfont=None, + textposition=None, + **kwargs + ): + """ + Construct a new Symbol object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.mapbox.layer.Symbol + icon + Sets the symbol icon image (mapbox.layer.layout.icon- + image). Full list: https://www.mapbox.com/maki-icons/ + iconsize + Sets the symbol icon size (mapbox.layer.layout.icon- + size). Has an effect only when `type` is set to + "symbol". + placement + Sets the symbol and/or text placement + (mapbox.layer.layout.symbol-placement). If `placement` + is "point", the label is placed where the geometry is + located If `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 + text + Sets the symbol text (mapbox.layer.layout.text-field). + textfont + Sets the icon text font (color=mapbox.layer.paint.text- + color, size=mapbox.layer.layout.text-size). Has an + effect only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + + Returns + ------- + Symbol + """ + super(Symbol, self).__init__('symbol') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.mapbox.layer.Symbol +constructor must be a dict or +an instance of plotly.graph_objs.layout.mapbox.layer.Symbol""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.mapbox.layer import (symbol as v_symbol) + + # Initialize validators + # --------------------- + self._validators['icon'] = v_symbol.IconValidator() + self._validators['iconsize'] = v_symbol.IconsizeValidator() + self._validators['placement'] = v_symbol.PlacementValidator() + self._validators['text'] = v_symbol.TextValidator() + self._validators['textfont'] = v_symbol.TextfontValidator() + self._validators['textposition'] = v_symbol.TextpositionValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('icon', None) + self['icon'] = icon if icon is not None else _v + _v = arg.pop('iconsize', None) + self['iconsize'] = iconsize if iconsize is not None else _v + _v = arg.pop('placement', None) + self['placement'] = placement if placement is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + _v = arg.pop('textposition', None) + self['textposition'] = textposition if textposition is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Line(_BaseLayoutHierarchyType): + + # dash + # ---- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['dash'] + + @dash.setter + def dash(self, val): + self['dash'] = val + + # dashsrc + # ------- + @property + def dashsrc(self): + """ + Sets the source reference on plot.ly for dash . + + The 'dashsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['dashsrc'] + + @dashsrc.setter + def dashsrc(self, val): + self['dashsrc'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.mapbox.layer' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dash + Sets the length of dashes and gaps + (mapbox.layer.paint.line-dasharray). Has an effect only + when `type` is set to "line". + dashsrc + Sets the source reference on plot.ly for dash . + width + Sets the line width (mapbox.layer.paint.line-width). + Has an effect only when `type` is set to "line". + """ + + def __init__( + self, arg=None, dash=None, dashsrc=None, width=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.mapbox.layer.Line + dash + Sets the length of dashes and gaps + (mapbox.layer.paint.line-dasharray). Has an effect only + when `type` is set to "line". + dashsrc + Sets the source reference on plot.ly for dash . + width + Sets the line width (mapbox.layer.paint.line-width). + Has an effect only when `type` is set to "line". + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.mapbox.layer.Line +constructor must be a dict or +an instance of plotly.graph_objs.layout.mapbox.layer.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.mapbox.layer import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['dash'] = v_line.DashValidator() + self._validators['dashsrc'] = v_line.DashsrcValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dash', None) + self['dash'] = dash if dash is not None else _v + _v = arg.pop('dashsrc', None) + self['dashsrc'] = dashsrc if dashsrc is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Fill(_BaseLayoutHierarchyType): + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.mapbox.layer' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + outlinecolor + Sets the fill outline color (mapbox.layer.paint.fill- + outline-color). Has an effect only when `type` is set + to "fill". + """ + + def __init__(self, arg=None, outlinecolor=None, **kwargs): + """ + Construct a new Fill object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.mapbox.layer.Fill + outlinecolor + Sets the fill outline color (mapbox.layer.paint.fill- + outline-color). Has an effect only when `type` is set + to "fill". + + Returns + ------- + Fill + """ + super(Fill, self).__init__('fill') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.mapbox.layer.Fill +constructor must be a dict or +an instance of plotly.graph_objs.layout.mapbox.layer.Fill""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.mapbox.layer import (fill as v_fill) + + # Initialize validators + # --------------------- + self._validators['outlinecolor'] = v_fill.OutlinecolorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Circle(_BaseLayoutHierarchyType): + + # radius + # ------ + @property + 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 + + Returns + ------- + int|float + """ + return self['radius'] + + @radius.setter + def radius(self, val): + self['radius'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.mapbox.layer' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + radius + Sets the circle radius (mapbox.layer.paint.circle- + radius). Has an effect only when `type` is set to + "circle". + """ + + def __init__(self, arg=None, radius=None, **kwargs): + """ + Construct a new Circle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.mapbox.layer.Circle + radius + Sets the circle radius (mapbox.layer.paint.circle- + radius). Has an effect only when `type` is set to + "circle". + + Returns + ------- + Circle + """ + super(Circle, self).__init__('circle') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.mapbox.layer.Circle +constructor must be a dict or +an instance of plotly.graph_objs.layout.mapbox.layer.Circle""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.mapbox.layer import (circle as v_circle) + + # Initialize validators + # --------------------- + self._validators['radius'] = v_circle.RadiusValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('radius', None) + self['radius'] = radius if radius is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.mapbox.layer import symbol -from ._line import Line -from ._fill import Fill -from ._circle import Circle diff --git a/plotly/graph_objs/layout/mapbox/layer/_circle.py b/plotly/graph_objs/layout/mapbox/layer/_circle.py deleted file mode 100644 index 93ee42907e9..00000000000 --- a/plotly/graph_objs/layout/mapbox/layer/_circle.py +++ /dev/null @@ -1,105 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Circle(BaseLayoutHierarchyType): - - # radius - # ------ - @property - 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 - - Returns - ------- - int|float - """ - return self['radius'] - - @radius.setter - def radius(self, val): - self['radius'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.mapbox.layer' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - radius - Sets the circle radius (mapbox.layer.paint.circle- - radius). Has an effect only when `type` is set to - "circle". - """ - - def __init__(self, arg=None, radius=None, **kwargs): - """ - Construct a new Circle object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.mapbox.layer.Circle - radius - Sets the circle radius (mapbox.layer.paint.circle- - radius). Has an effect only when `type` is set to - "circle". - - Returns - ------- - Circle - """ - super(Circle, self).__init__('circle') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.mapbox.layer.Circle -constructor must be a dict or -an instance of plotly.graph_objs.layout.mapbox.layer.Circle""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.mapbox.layer import (circle as v_circle) - - # Initialize validators - # --------------------- - self._validators['radius'] = v_circle.RadiusValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('radius', None) - self['radius'] = radius if radius is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/mapbox/layer/_fill.py b/plotly/graph_objs/layout/mapbox/layer/_fill.py deleted file mode 100644 index aa9c5b7f350..00000000000 --- a/plotly/graph_objs/layout/mapbox/layer/_fill.py +++ /dev/null @@ -1,144 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Fill(BaseLayoutHierarchyType): - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.mapbox.layer' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - outlinecolor - Sets the fill outline color (mapbox.layer.paint.fill- - outline-color). Has an effect only when `type` is set - to "fill". - """ - - def __init__(self, arg=None, outlinecolor=None, **kwargs): - """ - Construct a new Fill object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.mapbox.layer.Fill - outlinecolor - Sets the fill outline color (mapbox.layer.paint.fill- - outline-color). Has an effect only when `type` is set - to "fill". - - Returns - ------- - Fill - """ - super(Fill, self).__init__('fill') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.mapbox.layer.Fill -constructor must be a dict or -an instance of plotly.graph_objs.layout.mapbox.layer.Fill""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.mapbox.layer import (fill as v_fill) - - # Initialize validators - # --------------------- - self._validators['outlinecolor'] = v_fill.OutlinecolorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/mapbox/layer/_line.py b/plotly/graph_objs/layout/mapbox/layer/_line.py deleted file mode 100644 index cfa2eb420dd..00000000000 --- a/plotly/graph_objs/layout/mapbox/layer/_line.py +++ /dev/null @@ -1,164 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Line(BaseLayoutHierarchyType): - - # dash - # ---- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['dash'] - - @dash.setter - def dash(self, val): - self['dash'] = val - - # dashsrc - # ------- - @property - def dashsrc(self): - """ - Sets the source reference on plot.ly for dash . - - The 'dashsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['dashsrc'] - - @dashsrc.setter - def dashsrc(self, val): - self['dashsrc'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.mapbox.layer' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dash - Sets the length of dashes and gaps - (mapbox.layer.paint.line-dasharray). Has an effect only - when `type` is set to "line". - dashsrc - Sets the source reference on plot.ly for dash . - width - Sets the line width (mapbox.layer.paint.line-width). - Has an effect only when `type` is set to "line". - """ - - def __init__( - self, arg=None, dash=None, dashsrc=None, width=None, **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.mapbox.layer.Line - dash - Sets the length of dashes and gaps - (mapbox.layer.paint.line-dasharray). Has an effect only - when `type` is set to "line". - dashsrc - Sets the source reference on plot.ly for dash . - width - Sets the line width (mapbox.layer.paint.line-width). - Has an effect only when `type` is set to "line". - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.mapbox.layer.Line -constructor must be a dict or -an instance of plotly.graph_objs.layout.mapbox.layer.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.mapbox.layer import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['dash'] = v_line.DashValidator() - self._validators['dashsrc'] = v_line.DashsrcValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dash', None) - self['dash'] = dash if dash is not None else _v - _v = arg.pop('dashsrc', None) - self['dashsrc'] = dashsrc if dashsrc is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/mapbox/layer/_symbol.py b/plotly/graph_objs/layout/mapbox/layer/_symbol.py deleted file mode 100644 index ba17d1b910c..00000000000 --- a/plotly/graph_objs/layout/mapbox/layer/_symbol.py +++ /dev/null @@ -1,310 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Symbol(BaseLayoutHierarchyType): - - # icon - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['icon'] - - @icon.setter - def icon(self, val): - self['icon'] = val - - # iconsize - # -------- - @property - 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 - - Returns - ------- - int|float - """ - return self['iconsize'] - - @iconsize.setter - def iconsize(self, val): - self['iconsize'] = val - - # placement - # --------- - @property - def placement(self): - """ - Sets the symbol and/or text placement - (mapbox.layer.layout.symbol-placement). If `placement` is - "point", the label is placed where the geometry is located If - `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'] - - Returns - ------- - Any - """ - return self['placement'] - - @placement.setter - def placement(self, val): - self['placement'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.mapbox.layer.symbol.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # textposition - # ------------ - @property - 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', - 'middle center', 'middle right', 'bottom left', 'bottom - center', 'bottom right'] - - Returns - ------- - Any - """ - return self['textposition'] - - @textposition.setter - def textposition(self, val): - self['textposition'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.mapbox.layer' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - icon - Sets the symbol icon image (mapbox.layer.layout.icon- - image). Full list: https://www.mapbox.com/maki-icons/ - iconsize - Sets the symbol icon size (mapbox.layer.layout.icon- - size). Has an effect only when `type` is set to - "symbol". - placement - Sets the symbol and/or text placement - (mapbox.layer.layout.symbol-placement). If `placement` - is "point", the label is placed where the geometry is - located If `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 - text - Sets the symbol text (mapbox.layer.layout.text-field). - textfont - Sets the icon text font (color=mapbox.layer.paint.text- - color, size=mapbox.layer.layout.text-size). Has an - effect only when `type` is set to "symbol". - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - """ - - def __init__( - self, - arg=None, - icon=None, - iconsize=None, - placement=None, - text=None, - textfont=None, - textposition=None, - **kwargs - ): - """ - Construct a new Symbol object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.mapbox.layer.Symbol - icon - Sets the symbol icon image (mapbox.layer.layout.icon- - image). Full list: https://www.mapbox.com/maki-icons/ - iconsize - Sets the symbol icon size (mapbox.layer.layout.icon- - size). Has an effect only when `type` is set to - "symbol". - placement - Sets the symbol and/or text placement - (mapbox.layer.layout.symbol-placement). If `placement` - is "point", the label is placed where the geometry is - located If `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 - text - Sets the symbol text (mapbox.layer.layout.text-field). - textfont - Sets the icon text font (color=mapbox.layer.paint.text- - color, size=mapbox.layer.layout.text-size). Has an - effect only when `type` is set to "symbol". - textposition - Sets the positions of the `text` elements with respects - to the (x,y) coordinates. - - Returns - ------- - Symbol - """ - super(Symbol, self).__init__('symbol') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.mapbox.layer.Symbol -constructor must be a dict or -an instance of plotly.graph_objs.layout.mapbox.layer.Symbol""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.mapbox.layer import (symbol as v_symbol) - - # Initialize validators - # --------------------- - self._validators['icon'] = v_symbol.IconValidator() - self._validators['iconsize'] = v_symbol.IconsizeValidator() - self._validators['placement'] = v_symbol.PlacementValidator() - self._validators['text'] = v_symbol.TextValidator() - self._validators['textfont'] = v_symbol.TextfontValidator() - self._validators['textposition'] = v_symbol.TextpositionValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('icon', None) - self['icon'] = icon if icon is not None else _v - _v = arg.pop('iconsize', None) - self['iconsize'] = iconsize if iconsize is not None else _v - _v = arg.pop('placement', None) - self['placement'] = placement if placement is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - _v = arg.pop('textposition', None) - self['textposition'] = textposition if textposition is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/mapbox/layer/symbol/__init__.py b/plotly/graph_objs/layout/mapbox/layer/symbol/__init__.py index 67cdef05e2c..ce53c754159 100644 --- a/plotly/graph_objs/layout/mapbox/layer/symbol/__init__.py +++ b/plotly/graph_objs/layout/mapbox/layer/symbol/__init__.py @@ -1 +1,232 @@ -from ._textfont import Textfont + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Textfont(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.mapbox.layer.symbol' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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". + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.mapbox.layer.symbol.Textfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.mapbox.layer.symbol.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.layout.mapbox.layer.symbol.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.mapbox.layer.symbol import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + self._validators['family'] = v_textfont.FamilyValidator() + self._validators['size'] = v_textfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/mapbox/layer/symbol/_textfont.py b/plotly/graph_objs/layout/mapbox/layer/symbol/_textfont.py deleted file mode 100644 index 23b6852fac1..00000000000 --- a/plotly/graph_objs/layout/mapbox/layer/symbol/_textfont.py +++ /dev/null @@ -1,230 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Textfont(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.mapbox.layer.symbol' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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". - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.mapbox.layer.symbol.Textfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.mapbox.layer.symbol.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.layout.mapbox.layer.symbol.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.mapbox.layer.symbol import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - self._validators['family'] = v_textfont.FamilyValidator() - self._validators['size'] = v_textfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/polar/__init__.py b/plotly/graph_objs/layout/polar/__init__.py index 5687b0ceb71..3cc827ee1fe 100644 --- a/plotly/graph_objs/layout/polar/__init__.py +++ b/plotly/graph_objs/layout/polar/__init__.py @@ -1,5 +1,4276 @@ -from ._radialaxis import RadialAxis + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class RadialAxis(_BaseLayoutHierarchyType): + + # angle + # ----- + @property + def angle(self): + """ + Sets the angle (in degrees) from which the radial axis is + drawn. Note that by default, radial axis line on the theta=0 + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['angle'] + + @angle.setter + def angle(self, val): + self['angle'] = val + + # autorange + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['autorange'] + + @autorange.setter + def autorange(self, val): + self['autorange'] = val + + # calendar + # -------- + @property + def calendar(self): + """ + Sets the calendar system to use for `range` and `tick0` if this + is a date axis. This does not set the calendar for interpreting + data on this axis, that's specified in the trace or via the + global `layout.calendar` + + The 'calendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['gregorian', 'chinese', 'coptic', 'discworld', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['calendar'] + + @calendar.setter + def calendar(self, val): + self['calendar'] = val + + # categoryarray + # ------------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['categoryarray'] + + @categoryarray.setter + def categoryarray(self, val): + self['categoryarray'] = val + + # categoryarraysrc + # ---------------- + @property + def categoryarraysrc(self): + """ + Sets the source reference on plot.ly for categoryarray . + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['categoryarraysrc'] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self['categoryarraysrc'] = val + + # categoryorder + # ------------- + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array'] + + Returns + ------- + Any + """ + return self['categoryorder'] + + @categoryorder.setter + def categoryorder(self, val): + self['categoryorder'] = val + + # color + # ----- + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # gridcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['gridcolor'] + + @gridcolor.setter + def gridcolor(self, val): + self['gridcolor'] = val + + # gridwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['gridwidth'] + + @gridwidth.setter + def gridwidth(self, val): + self['gridwidth'] = val + + # hoverformat + # ----------- + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['hoverformat'] + + @hoverformat.setter + def hoverformat(self, val): + self['hoverformat'] = val + + # layer + # ----- + @property + def layer(self): + """ + Sets the layer on which this axis is displayed. If *above + traces*, this axis is displayed above all the subplot's traces + If *below traces*, this axis is displayed below all the + subplot's traces, but above the grid lines. Useful when used + together with scatter-like traces with `cliponaxis` set to + False to show markers and/or text nodes above this axis. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['above traces', 'below traces'] + + Returns + ------- + Any + """ + return self['layer'] + + @layer.setter + def layer(self, val): + self['layer'] = val + + # linecolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['linecolor'] + + @linecolor.setter + def linecolor(self, val): + self['linecolor'] = val + + # linewidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['linewidth'] + + @linewidth.setter + def linewidth(self, val): + self['linewidth'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # range + # ----- + @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 + + Returns + ------- + list + """ + return self['range'] + + @range.setter + def range(self, val): + self['range'] = val + + # rangemode + # --------- + @property + def rangemode(self): + """ + If *tozero*`, the range extends to 0, regardless of the input + data If "nonnegative", the range is non-negative, regardless of + 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'] + + Returns + ------- + Any + """ + return self['rangemode'] + + @rangemode.setter + def rangemode(self, val): + self['rangemode'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showgrid + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showgrid'] + + @showgrid.setter + def showgrid(self, val): + self['showgrid'] = val + + # showline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showline'] + + @showline.setter + def showline(self, val): + self['showline'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.polar.radialaxis.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.layout.polar.radialaxis.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + 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 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 + ------- + plotly.graph_objs.layout.polar.radialaxis.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + text + 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. + + Returns + ------- + plotly.graph_objs.layout.polar.radialaxis.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use layout.polar.radialaxis.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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # type + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # uirevision + # ---------- + @property + 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 + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.polar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + angle + Sets the angle (in degrees) from which the radial axis + is drawn. Note that by default, radial axis line on the + theta=0 line corresponds to a line pointing right (like + what mathematicians prefer). Defaults to the first + `polar.sector` angle. + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If *tozero*`, the range extends to 0, regardless of the + input data If "nonnegative", the range is non-negative, + regardless of the input data. If "normal", the range is + computed in relation to the extrema of the input data + (same behavior as for cartesian axes). + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines on which side of radial axis line the tick + and tick labels appear. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.polar.radialaxis.Tickformatsto + p instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.pola + r.radialaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.polar.radialaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.polar.radialaxis.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + layout.polar.radialaxis.title.font instead. Sets this + axis' title font. Note that the title's font used to be + customized by the now deprecated `titlefont` attribute. + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + uirevision + Controls persistence of user-driven changes in axis + `range`, `autorange`, `angle`, and `title` if in + `editable: true` configuration. Defaults to + `polar.uirevision`. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + """ + + _mapped_properties = {'titlefont': ('title', 'font')} + + def __init__( + self, + arg=None, + angle=None, + autorange=None, + calendar=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + color=None, + dtick=None, + exponentformat=None, + gridcolor=None, + gridwidth=None, + hoverformat=None, + layer=None, + linecolor=None, + linewidth=None, + nticks=None, + range=None, + rangemode=None, + separatethousands=None, + showexponent=None, + showgrid=None, + showline=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + side=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + type=None, + uirevision=None, + visible=None, + **kwargs + ): + """ + Construct a new RadialAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.polar.RadialAxis + angle + Sets the angle (in degrees) from which the radial axis + is drawn. Note that by default, radial axis line on the + theta=0 line corresponds to a line pointing right (like + what mathematicians prefer). Defaults to the first + `polar.sector` angle. + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If *tozero*`, the range extends to 0, regardless of the + input data If "nonnegative", the range is non-negative, + regardless of the input data. If "normal", the range is + computed in relation to the extrema of the input data + (same behavior as for cartesian axes). + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines on which side of radial axis line the tick + and tick labels appear. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.polar.radialaxis.Tickformatsto + p instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.pola + r.radialaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.polar.radialaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.polar.radialaxis.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + layout.polar.radialaxis.title.font instead. Sets this + axis' title font. Note that the title's font used to be + customized by the now deprecated `titlefont` attribute. + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + uirevision + Controls persistence of user-driven changes in axis + `range`, `autorange`, `angle`, and `title` if in + `editable: true` configuration. Defaults to + `polar.uirevision`. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + + Returns + ------- + RadialAxis + """ + super(RadialAxis, self).__init__('radialaxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.polar.RadialAxis +constructor must be a dict or +an instance of plotly.graph_objs.layout.polar.RadialAxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.polar import (radialaxis as v_radialaxis) + + # Initialize validators + # --------------------- + self._validators['angle'] = v_radialaxis.AngleValidator() + self._validators['autorange'] = v_radialaxis.AutorangeValidator() + self._validators['calendar'] = v_radialaxis.CalendarValidator() + self._validators['categoryarray' + ] = v_radialaxis.CategoryarrayValidator() + self._validators['categoryarraysrc' + ] = v_radialaxis.CategoryarraysrcValidator() + self._validators['categoryorder' + ] = v_radialaxis.CategoryorderValidator() + self._validators['color'] = v_radialaxis.ColorValidator() + self._validators['dtick'] = v_radialaxis.DtickValidator() + self._validators['exponentformat' + ] = v_radialaxis.ExponentformatValidator() + self._validators['gridcolor'] = v_radialaxis.GridcolorValidator() + self._validators['gridwidth'] = v_radialaxis.GridwidthValidator() + self._validators['hoverformat'] = v_radialaxis.HoverformatValidator() + self._validators['layer'] = v_radialaxis.LayerValidator() + self._validators['linecolor'] = v_radialaxis.LinecolorValidator() + self._validators['linewidth'] = v_radialaxis.LinewidthValidator() + self._validators['nticks'] = v_radialaxis.NticksValidator() + self._validators['range'] = v_radialaxis.RangeValidator() + self._validators['rangemode'] = v_radialaxis.RangemodeValidator() + self._validators['separatethousands' + ] = v_radialaxis.SeparatethousandsValidator() + self._validators['showexponent'] = v_radialaxis.ShowexponentValidator() + self._validators['showgrid'] = v_radialaxis.ShowgridValidator() + self._validators['showline'] = v_radialaxis.ShowlineValidator() + self._validators['showticklabels' + ] = v_radialaxis.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_radialaxis.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_radialaxis.ShowticksuffixValidator() + self._validators['side'] = v_radialaxis.SideValidator() + self._validators['tick0'] = v_radialaxis.Tick0Validator() + self._validators['tickangle'] = v_radialaxis.TickangleValidator() + self._validators['tickcolor'] = v_radialaxis.TickcolorValidator() + self._validators['tickfont'] = v_radialaxis.TickfontValidator() + self._validators['tickformat'] = v_radialaxis.TickformatValidator() + self._validators['tickformatstops' + ] = v_radialaxis.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_radialaxis.TickformatstopValidator() + self._validators['ticklen'] = v_radialaxis.TicklenValidator() + self._validators['tickmode'] = v_radialaxis.TickmodeValidator() + self._validators['tickprefix'] = v_radialaxis.TickprefixValidator() + self._validators['ticks'] = v_radialaxis.TicksValidator() + self._validators['ticksuffix'] = v_radialaxis.TicksuffixValidator() + self._validators['ticktext'] = v_radialaxis.TicktextValidator() + self._validators['ticktextsrc'] = v_radialaxis.TicktextsrcValidator() + self._validators['tickvals'] = v_radialaxis.TickvalsValidator() + self._validators['tickvalssrc'] = v_radialaxis.TickvalssrcValidator() + self._validators['tickwidth'] = v_radialaxis.TickwidthValidator() + self._validators['title'] = v_radialaxis.TitleValidator() + self._validators['type'] = v_radialaxis.TypeValidator() + self._validators['uirevision'] = v_radialaxis.UirevisionValidator() + self._validators['visible'] = v_radialaxis.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('angle', None) + self['angle'] = angle if angle is not None else _v + _v = arg.pop('autorange', None) + self['autorange'] = autorange if autorange is not None else _v + _v = arg.pop('calendar', None) + self['calendar'] = calendar if calendar is not None else _v + _v = arg.pop('categoryarray', None) + self['categoryarray' + ] = categoryarray if categoryarray is not None else _v + _v = arg.pop('categoryarraysrc', None) + self['categoryarraysrc' + ] = categoryarraysrc if categoryarraysrc is not None else _v + _v = arg.pop('categoryorder', None) + self['categoryorder' + ] = categoryorder if categoryorder is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('gridcolor', None) + self['gridcolor'] = gridcolor if gridcolor is not None else _v + _v = arg.pop('gridwidth', None) + self['gridwidth'] = gridwidth if gridwidth is not None else _v + _v = arg.pop('hoverformat', None) + self['hoverformat'] = hoverformat if hoverformat is not None else _v + _v = arg.pop('layer', None) + self['layer'] = layer if layer is not None else _v + _v = arg.pop('linecolor', None) + self['linecolor'] = linecolor if linecolor is not None else _v + _v = arg.pop('linewidth', None) + self['linewidth'] = linewidth if linewidth is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('range', None) + self['range'] = range if range is not None else _v + _v = arg.pop('rangemode', None) + self['rangemode'] = rangemode if rangemode is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showgrid', None) + self['showgrid'] = showgrid if showgrid is not None else _v + _v = arg.pop('showline', None) + self['showline'] = showline if showline is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Domain(_BaseLayoutHierarchyType): + + # column + # ------ + @property + 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] + + Returns + ------- + int + """ + return self['column'] + + @column.setter + def column(self, val): + self['column'] = val + + # row + # --- + @property + 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] + + Returns + ------- + int + """ + return self['row'] + + @row.setter + def row(self, val): + self['row'] = val + + # x + # - + @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] + + Returns + ------- + list + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @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] + + Returns + ------- + list + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.polar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this polar subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this polar subplot . + x + Sets the horizontal domain of this polar subplot (in + plot fraction). + y + Sets the vertical domain of this polar subplot (in plot + fraction). + """ + + def __init__( + self, arg=None, column=None, row=None, x=None, y=None, **kwargs + ): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.polar.Domain + column + If there is a layout grid, use the domain for this + column in the grid for this polar subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this polar subplot . + x + Sets the horizontal domain of this polar subplot (in + plot fraction). + y + Sets the vertical domain of this polar subplot (in plot + fraction). + + Returns + ------- + Domain + """ + super(Domain, self).__init__('domain') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.polar.Domain +constructor must be a dict or +an instance of plotly.graph_objs.layout.polar.Domain""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.polar import (domain as v_domain) + + # Initialize validators + # --------------------- + self._validators['column'] = v_domain.ColumnValidator() + self._validators['row'] = v_domain.RowValidator() + self._validators['x'] = v_domain.XValidator() + self._validators['y'] = v_domain.YValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('column', None) + self['column'] = column if column is not None else _v + _v = arg.pop('row', None) + self['row'] = row if row is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class AngularAxis(_BaseLayoutHierarchyType): + + # categoryarray + # ------------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['categoryarray'] + + @categoryarray.setter + def categoryarray(self, val): + self['categoryarray'] = val + + # categoryarraysrc + # ---------------- + @property + def categoryarraysrc(self): + """ + Sets the source reference on plot.ly for categoryarray . + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['categoryarraysrc'] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self['categoryarraysrc'] = val + + # categoryorder + # ------------- + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array'] + + Returns + ------- + Any + """ + return self['categoryorder'] + + @categoryorder.setter + def categoryorder(self, val): + self['categoryorder'] = val + + # color + # ----- + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # direction + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['direction'] + + @direction.setter + def direction(self, val): + self['direction'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # gridcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['gridcolor'] + + @gridcolor.setter + def gridcolor(self, val): + self['gridcolor'] = val + + # gridwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['gridwidth'] + + @gridwidth.setter + def gridwidth(self, val): + self['gridwidth'] = val + + # hoverformat + # ----------- + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['hoverformat'] + + @hoverformat.setter + def hoverformat(self, val): + self['hoverformat'] = val + + # layer + # ----- + @property + def layer(self): + """ + Sets the layer on which this axis is displayed. If *above + traces*, this axis is displayed above all the subplot's traces + If *below traces*, this axis is displayed below all the + subplot's traces, but above the grid lines. Useful when used + together with scatter-like traces with `cliponaxis` set to + False to show markers and/or text nodes above this axis. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['above traces', 'below traces'] + + Returns + ------- + Any + """ + return self['layer'] + + @layer.setter + def layer(self, val): + self['layer'] = val + + # linecolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['linecolor'] + + @linecolor.setter + def linecolor(self, val): + self['linecolor'] = val + + # linewidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['linewidth'] + + @linewidth.setter + def linewidth(self, val): + self['linewidth'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # period + # ------ + @property + 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] + + Returns + ------- + int|float + """ + return self['period'] + + @period.setter + def period(self, val): + self['period'] = val + + # rotation + # -------- + @property + def rotation(self): + """ + Sets that start position (in degrees) of the angular axis By + default, polar subplots with `direction` set to + "counterclockwise" get a `rotation` of 0 which corresponds to + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['rotation'] + + @rotation.setter + def rotation(self, val): + self['rotation'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showgrid + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showgrid'] + + @showgrid.setter + def showgrid(self, val): + self['showgrid'] = val + + # showline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showline'] + + @showline.setter + def showline(self, val): + self['showline'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thetaunit + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thetaunit'] + + @thetaunit.setter + def thetaunit(self, val): + self['thetaunit'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.polar.angularaxis.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.layout.polar.angularaxis.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + 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 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 + ------- + plotly.graph_objs.layout.polar.angularaxis.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # type + # ---- + @property + def type(self): + """ + Sets the angular axis type. If "linear", set `thetaunit` to + 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # uirevision + # ---------- + @property + 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 + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.polar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + direction + Sets the direction corresponding to positive angles. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + period + Set the angular period. Has an effect only when + `angularaxis.type` is "category". + rotation + Sets that start position (in degrees) of the angular + axis By default, polar subplots with `direction` set to + "counterclockwise" get a `rotation` of 0 which + corresponds to 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), + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thetaunit + Sets the format unit of the formatted "theta" values. + Has an effect only when `angularaxis.type` is "linear". + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.polar.angularaxis.Tickformatst + op instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.pola + r.angularaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.polar.angularaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + type + Sets the angular axis type. If "linear", set + `thetaunit` to determine the unit in which axis value + are shown. If *category, use `period` to set the number + of integer coordinates around polar axis. + uirevision + Controls persistence of user-driven changes in axis + `rotation`. Defaults to `polar.uirevision`. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + """ + + def __init__( + self, + arg=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + color=None, + direction=None, + dtick=None, + exponentformat=None, + gridcolor=None, + gridwidth=None, + hoverformat=None, + layer=None, + linecolor=None, + linewidth=None, + nticks=None, + period=None, + rotation=None, + separatethousands=None, + showexponent=None, + showgrid=None, + showline=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thetaunit=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + type=None, + uirevision=None, + visible=None, + **kwargs + ): + """ + Construct a new AngularAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.polar.AngularAxis + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + direction + Sets the direction corresponding to positive angles. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + period + Set the angular period. Has an effect only when + `angularaxis.type` is "category". + rotation + Sets that start position (in degrees) of the angular + axis By default, polar subplots with `direction` set to + "counterclockwise" get a `rotation` of 0 which + corresponds to 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), + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thetaunit + Sets the format unit of the formatted "theta" values. + Has an effect only when `angularaxis.type` is "linear". + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.polar.angularaxis.Tickformatst + op instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.pola + r.angularaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.polar.angularaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + type + Sets the angular axis type. If "linear", set + `thetaunit` to determine the unit in which axis value + are shown. If *category, use `period` to set the number + of integer coordinates around polar axis. + uirevision + Controls persistence of user-driven changes in axis + `rotation`. Defaults to `polar.uirevision`. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + + Returns + ------- + AngularAxis + """ + super(AngularAxis, self).__init__('angularaxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.polar.AngularAxis +constructor must be a dict or +an instance of plotly.graph_objs.layout.polar.AngularAxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.polar import ( + angularaxis as v_angularaxis + ) + + # Initialize validators + # --------------------- + self._validators['categoryarray' + ] = v_angularaxis.CategoryarrayValidator() + self._validators['categoryarraysrc' + ] = v_angularaxis.CategoryarraysrcValidator() + self._validators['categoryorder' + ] = v_angularaxis.CategoryorderValidator() + self._validators['color'] = v_angularaxis.ColorValidator() + self._validators['direction'] = v_angularaxis.DirectionValidator() + self._validators['dtick'] = v_angularaxis.DtickValidator() + self._validators['exponentformat' + ] = v_angularaxis.ExponentformatValidator() + self._validators['gridcolor'] = v_angularaxis.GridcolorValidator() + self._validators['gridwidth'] = v_angularaxis.GridwidthValidator() + self._validators['hoverformat'] = v_angularaxis.HoverformatValidator() + self._validators['layer'] = v_angularaxis.LayerValidator() + self._validators['linecolor'] = v_angularaxis.LinecolorValidator() + self._validators['linewidth'] = v_angularaxis.LinewidthValidator() + self._validators['nticks'] = v_angularaxis.NticksValidator() + self._validators['period'] = v_angularaxis.PeriodValidator() + self._validators['rotation'] = v_angularaxis.RotationValidator() + self._validators['separatethousands' + ] = v_angularaxis.SeparatethousandsValidator() + self._validators['showexponent'] = v_angularaxis.ShowexponentValidator( + ) + self._validators['showgrid'] = v_angularaxis.ShowgridValidator() + self._validators['showline'] = v_angularaxis.ShowlineValidator() + self._validators['showticklabels' + ] = v_angularaxis.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_angularaxis.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_angularaxis.ShowticksuffixValidator() + self._validators['thetaunit'] = v_angularaxis.ThetaunitValidator() + self._validators['tick0'] = v_angularaxis.Tick0Validator() + self._validators['tickangle'] = v_angularaxis.TickangleValidator() + self._validators['tickcolor'] = v_angularaxis.TickcolorValidator() + self._validators['tickfont'] = v_angularaxis.TickfontValidator() + self._validators['tickformat'] = v_angularaxis.TickformatValidator() + self._validators['tickformatstops' + ] = v_angularaxis.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_angularaxis.TickformatstopValidator() + self._validators['ticklen'] = v_angularaxis.TicklenValidator() + self._validators['tickmode'] = v_angularaxis.TickmodeValidator() + self._validators['tickprefix'] = v_angularaxis.TickprefixValidator() + self._validators['ticks'] = v_angularaxis.TicksValidator() + self._validators['ticksuffix'] = v_angularaxis.TicksuffixValidator() + self._validators['ticktext'] = v_angularaxis.TicktextValidator() + self._validators['ticktextsrc'] = v_angularaxis.TicktextsrcValidator() + self._validators['tickvals'] = v_angularaxis.TickvalsValidator() + self._validators['tickvalssrc'] = v_angularaxis.TickvalssrcValidator() + self._validators['tickwidth'] = v_angularaxis.TickwidthValidator() + self._validators['type'] = v_angularaxis.TypeValidator() + self._validators['uirevision'] = v_angularaxis.UirevisionValidator() + self._validators['visible'] = v_angularaxis.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('categoryarray', None) + self['categoryarray' + ] = categoryarray if categoryarray is not None else _v + _v = arg.pop('categoryarraysrc', None) + self['categoryarraysrc' + ] = categoryarraysrc if categoryarraysrc is not None else _v + _v = arg.pop('categoryorder', None) + self['categoryorder' + ] = categoryorder if categoryorder is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('direction', None) + self['direction'] = direction if direction is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('gridcolor', None) + self['gridcolor'] = gridcolor if gridcolor is not None else _v + _v = arg.pop('gridwidth', None) + self['gridwidth'] = gridwidth if gridwidth is not None else _v + _v = arg.pop('hoverformat', None) + self['hoverformat'] = hoverformat if hoverformat is not None else _v + _v = arg.pop('layer', None) + self['layer'] = layer if layer is not None else _v + _v = arg.pop('linecolor', None) + self['linecolor'] = linecolor if linecolor is not None else _v + _v = arg.pop('linewidth', None) + self['linewidth'] = linewidth if linewidth is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('period', None) + self['period'] = period if period is not None else _v + _v = arg.pop('rotation', None) + self['rotation'] = rotation if rotation is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showgrid', None) + self['showgrid'] = showgrid if showgrid is not None else _v + _v = arg.pop('showline', None) + self['showline'] = showline if showline is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thetaunit', None) + self['thetaunit'] = thetaunit if thetaunit is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.polar import radialaxis -from ._domain import Domain -from ._angularaxis import AngularAxis from plotly.graph_objs.layout.polar import angularaxis diff --git a/plotly/graph_objs/layout/polar/_angularaxis.py b/plotly/graph_objs/layout/polar/_angularaxis.py deleted file mode 100644 index 79ab099cc89..00000000000 --- a/plotly/graph_objs/layout/polar/_angularaxis.py +++ /dev/null @@ -1,1921 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class AngularAxis(BaseLayoutHierarchyType): - - # categoryarray - # ------------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['categoryarray'] - - @categoryarray.setter - def categoryarray(self, val): - self['categoryarray'] = val - - # categoryarraysrc - # ---------------- - @property - def categoryarraysrc(self): - """ - Sets the source reference on plot.ly for categoryarray . - - The 'categoryarraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['categoryarraysrc'] - - @categoryarraysrc.setter - def categoryarraysrc(self, val): - self['categoryarraysrc'] = val - - # categoryorder - # ------------- - @property - def categoryorder(self): - """ - Specifies the ordering logic for the case of categorical - variables. By default, plotly uses "trace", which specifies the - order that is present in the data supplied. Set `categoryorder` - to *category ascending* or *category descending* if order - should be determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" to derive the - ordering from the attribute `categoryarray`. If a category is - not found in the `categoryarray` array, the sorting behavior - for that attribute will be identical to the "trace" mode. The - unspecified categories will follow the categories in - `categoryarray`. - - The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array'] - - Returns - ------- - Any - """ - return self['categoryorder'] - - @categoryorder.setter - def categoryorder(self, val): - self['categoryorder'] = val - - # color - # ----- - @property - def color(self): - """ - Sets default for all colors associated with this axis all at - once: line, font, tick, and grid colors. Grid color is - lightened by blending this with the plot background Individual - pieces can override this. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # direction - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['direction'] - - @direction.setter - def direction(self, val): - self['direction'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # gridcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['gridcolor'] - - @gridcolor.setter - def gridcolor(self, val): - self['gridcolor'] = val - - # gridwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['gridwidth'] - - @gridwidth.setter - def gridwidth(self, val): - self['gridwidth'] = val - - # hoverformat - # ----------- - @property - def hoverformat(self): - """ - Sets the hover text formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'hoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['hoverformat'] - - @hoverformat.setter - def hoverformat(self, val): - self['hoverformat'] = val - - # layer - # ----- - @property - def layer(self): - """ - Sets the layer on which this axis is displayed. If *above - traces*, this axis is displayed above all the subplot's traces - If *below traces*, this axis is displayed below all the - subplot's traces, but above the grid lines. Useful when used - together with scatter-like traces with `cliponaxis` set to - False to show markers and/or text nodes above this axis. - - The 'layer' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['above traces', 'below traces'] - - Returns - ------- - Any - """ - return self['layer'] - - @layer.setter - def layer(self, val): - self['layer'] = val - - # linecolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['linecolor'] - - @linecolor.setter - def linecolor(self, val): - self['linecolor'] = val - - # linewidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['linewidth'] - - @linewidth.setter - def linewidth(self, val): - self['linewidth'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # period - # ------ - @property - 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] - - Returns - ------- - int|float - """ - return self['period'] - - @period.setter - def period(self, val): - self['period'] = val - - # rotation - # -------- - @property - def rotation(self): - """ - Sets that start position (in degrees) of the angular axis By - default, polar subplots with `direction` set to - "counterclockwise" get a `rotation` of 0 which corresponds to - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['rotation'] - - @rotation.setter - def rotation(self, val): - self['rotation'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showgrid - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showgrid'] - - @showgrid.setter - def showgrid(self, val): - self['showgrid'] = val - - # showline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showline'] - - @showline.setter - def showline(self, val): - self['showline'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thetaunit - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thetaunit'] - - @thetaunit.setter - def thetaunit(self, val): - self['thetaunit'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - def tickfont(self): - """ - Sets the tick font. - - The 'tickfont' property is an instance of Tickfont - that may be specified as: - - An instance of 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.polar.angularaxis.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.layout.polar.angularaxis.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - 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 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 - ------- - plotly.graph_objs.layout.polar.angularaxis.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # type - # ---- - @property - def type(self): - """ - Sets the angular axis type. If "linear", set `thetaunit` to - 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # uirevision - # ---------- - @property - 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 - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.polar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - direction - Sets the direction corresponding to positive angles. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - layer - Sets the layer on which this axis is displayed. If - *above traces*, this axis is displayed above all the - subplot's traces If *below traces*, this axis is - displayed below all the subplot's traces, but above the - grid lines. Useful when used together with scatter-like - traces with `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - period - Set the angular period. Has an effect only when - `angularaxis.type` is "category". - rotation - Sets that start position (in degrees) of the angular - axis By default, polar subplots with `direction` set to - "counterclockwise" get a `rotation` of 0 which - corresponds to 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), - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thetaunit - Sets the format unit of the formatted "theta" values. - Has an effect only when `angularaxis.type` is "linear". - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.polar.angularaxis.Tickformatst - op instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.layout.pola - r.angularaxis.tickformatstopdefaults), sets the default - property values to use for elements of - layout.polar.angularaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - type - Sets the angular axis type. If "linear", set - `thetaunit` to determine the unit in which axis value - are shown. If *category, use `period` to set the number - of integer coordinates around polar axis. - uirevision - Controls persistence of user-driven changes in axis - `rotation`. Defaults to `polar.uirevision`. - visible - A single toggle to hide the axis while preserving - interaction like dragging. Default is true when a - cheater plot is present on the axis, otherwise false - """ - - def __init__( - self, - arg=None, - categoryarray=None, - categoryarraysrc=None, - categoryorder=None, - color=None, - direction=None, - dtick=None, - exponentformat=None, - gridcolor=None, - gridwidth=None, - hoverformat=None, - layer=None, - linecolor=None, - linewidth=None, - nticks=None, - period=None, - rotation=None, - separatethousands=None, - showexponent=None, - showgrid=None, - showline=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thetaunit=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - type=None, - uirevision=None, - visible=None, - **kwargs - ): - """ - Construct a new AngularAxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.polar.AngularAxis - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - direction - Sets the direction corresponding to positive angles. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - layer - Sets the layer on which this axis is displayed. If - *above traces*, this axis is displayed above all the - subplot's traces If *below traces*, this axis is - displayed below all the subplot's traces, but above the - grid lines. Useful when used together with scatter-like - traces with `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - period - Set the angular period. Has an effect only when - `angularaxis.type` is "category". - rotation - Sets that start position (in degrees) of the angular - axis By default, polar subplots with `direction` set to - "counterclockwise" get a `rotation` of 0 which - corresponds to 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), - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thetaunit - Sets the format unit of the formatted "theta" values. - Has an effect only when `angularaxis.type` is "linear". - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.polar.angularaxis.Tickformatst - op instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.layout.pola - r.angularaxis.tickformatstopdefaults), sets the default - property values to use for elements of - layout.polar.angularaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - type - Sets the angular axis type. If "linear", set - `thetaunit` to determine the unit in which axis value - are shown. If *category, use `period` to set the number - of integer coordinates around polar axis. - uirevision - Controls persistence of user-driven changes in axis - `rotation`. Defaults to `polar.uirevision`. - visible - A single toggle to hide the axis while preserving - interaction like dragging. Default is true when a - cheater plot is present on the axis, otherwise false - - Returns - ------- - AngularAxis - """ - super(AngularAxis, self).__init__('angularaxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.polar.AngularAxis -constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.AngularAxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.polar import ( - angularaxis as v_angularaxis - ) - - # Initialize validators - # --------------------- - self._validators['categoryarray' - ] = v_angularaxis.CategoryarrayValidator() - self._validators['categoryarraysrc' - ] = v_angularaxis.CategoryarraysrcValidator() - self._validators['categoryorder' - ] = v_angularaxis.CategoryorderValidator() - self._validators['color'] = v_angularaxis.ColorValidator() - self._validators['direction'] = v_angularaxis.DirectionValidator() - self._validators['dtick'] = v_angularaxis.DtickValidator() - self._validators['exponentformat' - ] = v_angularaxis.ExponentformatValidator() - self._validators['gridcolor'] = v_angularaxis.GridcolorValidator() - self._validators['gridwidth'] = v_angularaxis.GridwidthValidator() - self._validators['hoverformat'] = v_angularaxis.HoverformatValidator() - self._validators['layer'] = v_angularaxis.LayerValidator() - self._validators['linecolor'] = v_angularaxis.LinecolorValidator() - self._validators['linewidth'] = v_angularaxis.LinewidthValidator() - self._validators['nticks'] = v_angularaxis.NticksValidator() - self._validators['period'] = v_angularaxis.PeriodValidator() - self._validators['rotation'] = v_angularaxis.RotationValidator() - self._validators['separatethousands' - ] = v_angularaxis.SeparatethousandsValidator() - self._validators['showexponent'] = v_angularaxis.ShowexponentValidator( - ) - self._validators['showgrid'] = v_angularaxis.ShowgridValidator() - self._validators['showline'] = v_angularaxis.ShowlineValidator() - self._validators['showticklabels' - ] = v_angularaxis.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_angularaxis.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_angularaxis.ShowticksuffixValidator() - self._validators['thetaunit'] = v_angularaxis.ThetaunitValidator() - self._validators['tick0'] = v_angularaxis.Tick0Validator() - self._validators['tickangle'] = v_angularaxis.TickangleValidator() - self._validators['tickcolor'] = v_angularaxis.TickcolorValidator() - self._validators['tickfont'] = v_angularaxis.TickfontValidator() - self._validators['tickformat'] = v_angularaxis.TickformatValidator() - self._validators['tickformatstops' - ] = v_angularaxis.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_angularaxis.TickformatstopValidator() - self._validators['ticklen'] = v_angularaxis.TicklenValidator() - self._validators['tickmode'] = v_angularaxis.TickmodeValidator() - self._validators['tickprefix'] = v_angularaxis.TickprefixValidator() - self._validators['ticks'] = v_angularaxis.TicksValidator() - self._validators['ticksuffix'] = v_angularaxis.TicksuffixValidator() - self._validators['ticktext'] = v_angularaxis.TicktextValidator() - self._validators['ticktextsrc'] = v_angularaxis.TicktextsrcValidator() - self._validators['tickvals'] = v_angularaxis.TickvalsValidator() - self._validators['tickvalssrc'] = v_angularaxis.TickvalssrcValidator() - self._validators['tickwidth'] = v_angularaxis.TickwidthValidator() - self._validators['type'] = v_angularaxis.TypeValidator() - self._validators['uirevision'] = v_angularaxis.UirevisionValidator() - self._validators['visible'] = v_angularaxis.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('categoryarray', None) - self['categoryarray' - ] = categoryarray if categoryarray is not None else _v - _v = arg.pop('categoryarraysrc', None) - self['categoryarraysrc' - ] = categoryarraysrc if categoryarraysrc is not None else _v - _v = arg.pop('categoryorder', None) - self['categoryorder' - ] = categoryorder if categoryorder is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('direction', None) - self['direction'] = direction if direction is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('gridcolor', None) - self['gridcolor'] = gridcolor if gridcolor is not None else _v - _v = arg.pop('gridwidth', None) - self['gridwidth'] = gridwidth if gridwidth is not None else _v - _v = arg.pop('hoverformat', None) - self['hoverformat'] = hoverformat if hoverformat is not None else _v - _v = arg.pop('layer', None) - self['layer'] = layer if layer is not None else _v - _v = arg.pop('linecolor', None) - self['linecolor'] = linecolor if linecolor is not None else _v - _v = arg.pop('linewidth', None) - self['linewidth'] = linewidth if linewidth is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('period', None) - self['period'] = period if period is not None else _v - _v = arg.pop('rotation', None) - self['rotation'] = rotation if rotation is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showgrid', None) - self['showgrid'] = showgrid if showgrid is not None else _v - _v = arg.pop('showline', None) - self['showline'] = showline if showline is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thetaunit', None) - self['thetaunit'] = thetaunit if thetaunit is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/polar/_domain.py b/plotly/graph_objs/layout/polar/_domain.py deleted file mode 100644 index 078efa681e4..00000000000 --- a/plotly/graph_objs/layout/polar/_domain.py +++ /dev/null @@ -1,206 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Domain(BaseLayoutHierarchyType): - - # column - # ------ - @property - 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] - - Returns - ------- - int - """ - return self['column'] - - @column.setter - def column(self, val): - self['column'] = val - - # row - # --- - @property - 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] - - Returns - ------- - int - """ - return self['row'] - - @row.setter - def row(self, val): - self['row'] = val - - # x - # - - @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] - - Returns - ------- - list - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @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] - - Returns - ------- - list - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.polar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - column - If there is a layout grid, use the domain for this - column in the grid for this polar subplot . - row - If there is a layout grid, use the domain for this row - in the grid for this polar subplot . - x - Sets the horizontal domain of this polar subplot (in - plot fraction). - y - Sets the vertical domain of this polar subplot (in plot - fraction). - """ - - def __init__( - self, arg=None, column=None, row=None, x=None, y=None, **kwargs - ): - """ - Construct a new Domain object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.polar.Domain - column - If there is a layout grid, use the domain for this - column in the grid for this polar subplot . - row - If there is a layout grid, use the domain for this row - in the grid for this polar subplot . - x - Sets the horizontal domain of this polar subplot (in - plot fraction). - y - Sets the vertical domain of this polar subplot (in plot - fraction). - - Returns - ------- - Domain - """ - super(Domain, self).__init__('domain') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.polar.Domain -constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.Domain""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.polar import (domain as v_domain) - - # Initialize validators - # --------------------- - self._validators['column'] = v_domain.ColumnValidator() - self._validators['row'] = v_domain.RowValidator() - self._validators['x'] = v_domain.XValidator() - self._validators['y'] = v_domain.YValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('column', None) - self['column'] = column if column is not None else _v - _v = arg.pop('row', None) - self['row'] = row if row is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/polar/_radialaxis.py b/plotly/graph_objs/layout/polar/_radialaxis.py deleted file mode 100644 index fb00891edc2..00000000000 --- a/plotly/graph_objs/layout/polar/_radialaxis.py +++ /dev/null @@ -1,2139 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class RadialAxis(BaseLayoutHierarchyType): - - # angle - # ----- - @property - def angle(self): - """ - Sets the angle (in degrees) from which the radial axis is - drawn. Note that by default, radial axis line on the theta=0 - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['angle'] - - @angle.setter - def angle(self, val): - self['angle'] = val - - # autorange - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['autorange'] - - @autorange.setter - def autorange(self, val): - self['autorange'] = val - - # calendar - # -------- - @property - def calendar(self): - """ - Sets the calendar system to use for `range` and `tick0` if this - is a date axis. This does not set the calendar for interpreting - data on this axis, that's specified in the trace or via the - global `layout.calendar` - - The 'calendar' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['gregorian', 'chinese', 'coptic', 'discworld', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['calendar'] - - @calendar.setter - def calendar(self, val): - self['calendar'] = val - - # categoryarray - # ------------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['categoryarray'] - - @categoryarray.setter - def categoryarray(self, val): - self['categoryarray'] = val - - # categoryarraysrc - # ---------------- - @property - def categoryarraysrc(self): - """ - Sets the source reference on plot.ly for categoryarray . - - The 'categoryarraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['categoryarraysrc'] - - @categoryarraysrc.setter - def categoryarraysrc(self, val): - self['categoryarraysrc'] = val - - # categoryorder - # ------------- - @property - def categoryorder(self): - """ - Specifies the ordering logic for the case of categorical - variables. By default, plotly uses "trace", which specifies the - order that is present in the data supplied. Set `categoryorder` - to *category ascending* or *category descending* if order - should be determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" to derive the - ordering from the attribute `categoryarray`. If a category is - not found in the `categoryarray` array, the sorting behavior - for that attribute will be identical to the "trace" mode. The - unspecified categories will follow the categories in - `categoryarray`. - - The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array'] - - Returns - ------- - Any - """ - return self['categoryorder'] - - @categoryorder.setter - def categoryorder(self, val): - self['categoryorder'] = val - - # color - # ----- - @property - def color(self): - """ - Sets default for all colors associated with this axis all at - once: line, font, tick, and grid colors. Grid color is - lightened by blending this with the plot background Individual - pieces can override this. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # gridcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['gridcolor'] - - @gridcolor.setter - def gridcolor(self, val): - self['gridcolor'] = val - - # gridwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['gridwidth'] - - @gridwidth.setter - def gridwidth(self, val): - self['gridwidth'] = val - - # hoverformat - # ----------- - @property - def hoverformat(self): - """ - Sets the hover text formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'hoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['hoverformat'] - - @hoverformat.setter - def hoverformat(self, val): - self['hoverformat'] = val - - # layer - # ----- - @property - def layer(self): - """ - Sets the layer on which this axis is displayed. If *above - traces*, this axis is displayed above all the subplot's traces - If *below traces*, this axis is displayed below all the - subplot's traces, but above the grid lines. Useful when used - together with scatter-like traces with `cliponaxis` set to - False to show markers and/or text nodes above this axis. - - The 'layer' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['above traces', 'below traces'] - - Returns - ------- - Any - """ - return self['layer'] - - @layer.setter - def layer(self, val): - self['layer'] = val - - # linecolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['linecolor'] - - @linecolor.setter - def linecolor(self, val): - self['linecolor'] = val - - # linewidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['linewidth'] - - @linewidth.setter - def linewidth(self, val): - self['linewidth'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # range - # ----- - @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 - - Returns - ------- - list - """ - return self['range'] - - @range.setter - def range(self, val): - self['range'] = val - - # rangemode - # --------- - @property - def rangemode(self): - """ - If *tozero*`, the range extends to 0, regardless of the input - data If "nonnegative", the range is non-negative, regardless of - 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'] - - Returns - ------- - Any - """ - return self['rangemode'] - - @rangemode.setter - def rangemode(self, val): - self['rangemode'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showgrid - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showgrid'] - - @showgrid.setter - def showgrid(self, val): - self['showgrid'] = val - - # showline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showline'] - - @showline.setter - def showline(self, val): - self['showline'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - def tickfont(self): - """ - Sets the tick font. - - The 'tickfont' property is an instance of Tickfont - that may be specified as: - - An instance of 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.polar.radialaxis.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.layout.polar.radialaxis.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - 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 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 - ------- - plotly.graph_objs.layout.polar.radialaxis.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - text - 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. - - Returns - ------- - plotly.graph_objs.layout.polar.radialaxis.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use layout.polar.radialaxis.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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # type - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # uirevision - # ---------- - @property - 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 - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.polar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - angle - Sets the angle (in degrees) from which the radial axis - is drawn. Note that by default, radial axis line on the - theta=0 line corresponds to a line pointing right (like - what mathematicians prefer). Defaults to the first - `polar.sector` angle. - autorange - Determines whether or not the range of this axis is - computed in relation to the input data. See `rangemode` - for more info. If `range` is provided, then `autorange` - is set to False. - calendar - Sets the calendar system to use for `range` and `tick0` - if this is a date axis. This does not set the calendar - for interpreting data on this axis, that's specified in - the trace or via the global `layout.calendar` - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - layer - Sets the layer on which this axis is displayed. If - *above traces*, this axis is displayed above all the - subplot's traces If *below traces*, this axis is - displayed below all the subplot's traces, but above the - grid lines. Useful when used together with scatter-like - traces with `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - range - Sets the range of this axis. If the axis `type` is - "log", then you must take the log of your desired range - (e.g. to set the range from 1 to 100, set the range - from 0 to 2). If the axis `type` is "date", it should - be date strings, like date data, though Date objects - and unix milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order it - appears. - rangemode - If *tozero*`, the range extends to 0, regardless of the - input data If "nonnegative", the range is non-negative, - regardless of the input data. If "normal", the range is - computed in relation to the extrema of the input data - (same behavior as for cartesian axes). - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - side - Determines on which side of radial axis line the tick - and tick labels appear. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.polar.radialaxis.Tickformatsto - p instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.layout.pola - r.radialaxis.tickformatstopdefaults), sets the default - property values to use for elements of - layout.polar.radialaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.polar.radialaxis.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - layout.polar.radialaxis.title.font instead. Sets this - axis' title font. Note that the title's font used to be - customized by the now deprecated `titlefont` attribute. - type - Sets the axis type. By default, plotly attempts to - determined the axis type by looking into the data of - the traces that referenced the axis in question. - uirevision - Controls persistence of user-driven changes in axis - `range`, `autorange`, `angle`, and `title` if in - `editable: true` configuration. Defaults to - `polar.uirevision`. - visible - A single toggle to hide the axis while preserving - interaction like dragging. Default is true when a - cheater plot is present on the axis, otherwise false - """ - - _mapped_properties = {'titlefont': ('title', 'font')} - - def __init__( - self, - arg=None, - angle=None, - autorange=None, - calendar=None, - categoryarray=None, - categoryarraysrc=None, - categoryorder=None, - color=None, - dtick=None, - exponentformat=None, - gridcolor=None, - gridwidth=None, - hoverformat=None, - layer=None, - linecolor=None, - linewidth=None, - nticks=None, - range=None, - rangemode=None, - separatethousands=None, - showexponent=None, - showgrid=None, - showline=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - side=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - type=None, - uirevision=None, - visible=None, - **kwargs - ): - """ - Construct a new RadialAxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.polar.RadialAxis - angle - Sets the angle (in degrees) from which the radial axis - is drawn. Note that by default, radial axis line on the - theta=0 line corresponds to a line pointing right (like - what mathematicians prefer). Defaults to the first - `polar.sector` angle. - autorange - Determines whether or not the range of this axis is - computed in relation to the input data. See `rangemode` - for more info. If `range` is provided, then `autorange` - is set to False. - calendar - Sets the calendar system to use for `range` and `tick0` - if this is a date axis. This does not set the calendar - for interpreting data on this axis, that's specified in - the trace or via the global `layout.calendar` - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - layer - Sets the layer on which this axis is displayed. If - *above traces*, this axis is displayed above all the - subplot's traces If *below traces*, this axis is - displayed below all the subplot's traces, but above the - grid lines. Useful when used together with scatter-like - traces with `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - range - Sets the range of this axis. If the axis `type` is - "log", then you must take the log of your desired range - (e.g. to set the range from 1 to 100, set the range - from 0 to 2). If the axis `type` is "date", it should - be date strings, like date data, though Date objects - and unix milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order it - appears. - rangemode - If *tozero*`, the range extends to 0, regardless of the - input data If "nonnegative", the range is non-negative, - regardless of the input data. If "normal", the range is - computed in relation to the extrema of the input data - (same behavior as for cartesian axes). - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - side - Determines on which side of radial axis line the tick - and tick labels appear. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.polar.radialaxis.Tickformatsto - p instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.layout.pola - r.radialaxis.tickformatstopdefaults), sets the default - property values to use for elements of - layout.polar.radialaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.polar.radialaxis.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - layout.polar.radialaxis.title.font instead. Sets this - axis' title font. Note that the title's font used to be - customized by the now deprecated `titlefont` attribute. - type - Sets the axis type. By default, plotly attempts to - determined the axis type by looking into the data of - the traces that referenced the axis in question. - uirevision - Controls persistence of user-driven changes in axis - `range`, `autorange`, `angle`, and `title` if in - `editable: true` configuration. Defaults to - `polar.uirevision`. - visible - A single toggle to hide the axis while preserving - interaction like dragging. Default is true when a - cheater plot is present on the axis, otherwise false - - Returns - ------- - RadialAxis - """ - super(RadialAxis, self).__init__('radialaxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.polar.RadialAxis -constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.RadialAxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.polar import (radialaxis as v_radialaxis) - - # Initialize validators - # --------------------- - self._validators['angle'] = v_radialaxis.AngleValidator() - self._validators['autorange'] = v_radialaxis.AutorangeValidator() - self._validators['calendar'] = v_radialaxis.CalendarValidator() - self._validators['categoryarray' - ] = v_radialaxis.CategoryarrayValidator() - self._validators['categoryarraysrc' - ] = v_radialaxis.CategoryarraysrcValidator() - self._validators['categoryorder' - ] = v_radialaxis.CategoryorderValidator() - self._validators['color'] = v_radialaxis.ColorValidator() - self._validators['dtick'] = v_radialaxis.DtickValidator() - self._validators['exponentformat' - ] = v_radialaxis.ExponentformatValidator() - self._validators['gridcolor'] = v_radialaxis.GridcolorValidator() - self._validators['gridwidth'] = v_radialaxis.GridwidthValidator() - self._validators['hoverformat'] = v_radialaxis.HoverformatValidator() - self._validators['layer'] = v_radialaxis.LayerValidator() - self._validators['linecolor'] = v_radialaxis.LinecolorValidator() - self._validators['linewidth'] = v_radialaxis.LinewidthValidator() - self._validators['nticks'] = v_radialaxis.NticksValidator() - self._validators['range'] = v_radialaxis.RangeValidator() - self._validators['rangemode'] = v_radialaxis.RangemodeValidator() - self._validators['separatethousands' - ] = v_radialaxis.SeparatethousandsValidator() - self._validators['showexponent'] = v_radialaxis.ShowexponentValidator() - self._validators['showgrid'] = v_radialaxis.ShowgridValidator() - self._validators['showline'] = v_radialaxis.ShowlineValidator() - self._validators['showticklabels' - ] = v_radialaxis.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_radialaxis.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_radialaxis.ShowticksuffixValidator() - self._validators['side'] = v_radialaxis.SideValidator() - self._validators['tick0'] = v_radialaxis.Tick0Validator() - self._validators['tickangle'] = v_radialaxis.TickangleValidator() - self._validators['tickcolor'] = v_radialaxis.TickcolorValidator() - self._validators['tickfont'] = v_radialaxis.TickfontValidator() - self._validators['tickformat'] = v_radialaxis.TickformatValidator() - self._validators['tickformatstops' - ] = v_radialaxis.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_radialaxis.TickformatstopValidator() - self._validators['ticklen'] = v_radialaxis.TicklenValidator() - self._validators['tickmode'] = v_radialaxis.TickmodeValidator() - self._validators['tickprefix'] = v_radialaxis.TickprefixValidator() - self._validators['ticks'] = v_radialaxis.TicksValidator() - self._validators['ticksuffix'] = v_radialaxis.TicksuffixValidator() - self._validators['ticktext'] = v_radialaxis.TicktextValidator() - self._validators['ticktextsrc'] = v_radialaxis.TicktextsrcValidator() - self._validators['tickvals'] = v_radialaxis.TickvalsValidator() - self._validators['tickvalssrc'] = v_radialaxis.TickvalssrcValidator() - self._validators['tickwidth'] = v_radialaxis.TickwidthValidator() - self._validators['title'] = v_radialaxis.TitleValidator() - self._validators['type'] = v_radialaxis.TypeValidator() - self._validators['uirevision'] = v_radialaxis.UirevisionValidator() - self._validators['visible'] = v_radialaxis.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('angle', None) - self['angle'] = angle if angle is not None else _v - _v = arg.pop('autorange', None) - self['autorange'] = autorange if autorange is not None else _v - _v = arg.pop('calendar', None) - self['calendar'] = calendar if calendar is not None else _v - _v = arg.pop('categoryarray', None) - self['categoryarray' - ] = categoryarray if categoryarray is not None else _v - _v = arg.pop('categoryarraysrc', None) - self['categoryarraysrc' - ] = categoryarraysrc if categoryarraysrc is not None else _v - _v = arg.pop('categoryorder', None) - self['categoryorder' - ] = categoryorder if categoryorder is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('gridcolor', None) - self['gridcolor'] = gridcolor if gridcolor is not None else _v - _v = arg.pop('gridwidth', None) - self['gridwidth'] = gridwidth if gridwidth is not None else _v - _v = arg.pop('hoverformat', None) - self['hoverformat'] = hoverformat if hoverformat is not None else _v - _v = arg.pop('layer', None) - self['layer'] = layer if layer is not None else _v - _v = arg.pop('linecolor', None) - self['linecolor'] = linecolor if linecolor is not None else _v - _v = arg.pop('linewidth', None) - self['linewidth'] = linewidth if linewidth is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('range', None) - self['range'] = range if range is not None else _v - _v = arg.pop('rangemode', None) - self['rangemode'] = rangemode if rangemode is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showgrid', None) - self['showgrid'] = showgrid if showgrid is not None else _v - _v = arg.pop('showline', None) - self['showline'] = showline if showline is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/polar/angularaxis/__init__.py b/plotly/graph_objs/layout/polar/angularaxis/__init__.py index 774b737ce0e..61a606fdc6d 100644 --- a/plotly/graph_objs/layout/polar/angularaxis/__init__.py +++ b/plotly/graph_objs/layout/polar/angularaxis/__init__.py @@ -1,2 +1,516 @@ -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.polar.angularaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.polar.angularax + is.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.polar.angularaxis.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.layout.polar.angularaxis.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.polar.angularaxis import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.polar.angularaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.polar.angularaxis.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.polar.angularaxis.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.layout.polar.angularaxis.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.polar.angularaxis import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/polar/angularaxis/_tickfont.py b/plotly/graph_objs/layout/polar/angularaxis/_tickfont.py deleted file mode 100644 index 5827386e32b..00000000000 --- a/plotly/graph_objs/layout/polar/angularaxis/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickfont(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.polar.angularaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): - """ - Construct a new Tickfont object - - Sets the tick font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.polar.angularaxis.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.polar.angularaxis.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.angularaxis.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.polar.angularaxis import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py b/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py deleted file mode 100644 index a39b86cd4e8..00000000000 --- a/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickformatstop(BaseLayoutHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.polar.angularaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.polar.angularax - is.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.polar.angularaxis.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.angularaxis.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.polar.angularaxis import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/polar/radialaxis/__init__.py b/plotly/graph_objs/layout/polar/radialaxis/__init__.py index 376e961c8bd..c99d0a06f5f 100644 --- a/plotly/graph_objs/layout/polar/radialaxis/__init__.py +++ b/plotly/graph_objs/layout/polar/radialaxis/__init__.py @@ -1,4 +1,689 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.polar.radialaxis.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.polar.radialaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.polar.radialaxis.Title + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.polar.radialaxis.Title +constructor must be a dict or +an instance of plotly.graph_objs.layout.polar.radialaxis.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.polar.radialaxis import ( + title as v_title + ) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.polar.radialaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.polar.radialaxi + s.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.polar.radialaxis.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.layout.polar.radialaxis.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.polar.radialaxis import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.polar.radialaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.polar.radialaxis.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.polar.radialaxis.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.layout.polar.radialaxis.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.polar.radialaxis import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.polar.radialaxis import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/layout/polar/radialaxis/_tickfont.py b/plotly/graph_objs/layout/polar/radialaxis/_tickfont.py deleted file mode 100644 index fdf3dd393bc..00000000000 --- a/plotly/graph_objs/layout/polar/radialaxis/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickfont(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.polar.radialaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): - """ - Construct a new Tickfont object - - Sets the tick font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.polar.radialaxis.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.polar.radialaxis.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.radialaxis.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.polar.radialaxis import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py b/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py deleted file mode 100644 index 45d43106b9b..00000000000 --- a/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickformatstop(BaseLayoutHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.polar.radialaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.polar.radialaxi - s.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.polar.radialaxis.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.radialaxis.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.polar.radialaxis import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/polar/radialaxis/_title.py b/plotly/graph_objs/layout/polar/radialaxis/_title.py deleted file mode 100644 index 39caeb2e519..00000000000 --- a/plotly/graph_objs/layout/polar/radialaxis/_title.py +++ /dev/null @@ -1,168 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Title(BaseLayoutHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.polar.radialaxis.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.polar.radialaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - """ - - def __init__(self, arg=None, font=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.polar.radialaxis.Title - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.polar.radialaxis.Title -constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.radialaxis.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.polar.radialaxis import ( - title as v_title - ) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/polar/radialaxis/title/__init__.py b/plotly/graph_objs/layout/polar/radialaxis/title/__init__.py index c37b8b5cd28..24f72b1080c 100644 --- a/plotly/graph_objs/layout/polar/radialaxis/title/__init__.py +++ b/plotly/graph_objs/layout/polar/radialaxis/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.polar.radialaxis.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.polar.radialaxis.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.polar.radialaxis.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.polar.radialaxis.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.polar.radialaxis.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/polar/radialaxis/title/_font.py b/plotly/graph_objs/layout/polar/radialaxis/title/_font.py deleted file mode 100644 index a97e09c4097..00000000000 --- a/plotly/graph_objs/layout/polar/radialaxis/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.polar.radialaxis.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.polar.radialaxis.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.polar.radialaxis.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.polar.radialaxis.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.polar.radialaxis.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/__init__.py b/plotly/graph_objs/layout/scene/__init__.py index 8a315af1d50..cd8f002e3ad 100644 --- a/plotly/graph_objs/layout/scene/__init__.py +++ b/plotly/graph_objs/layout/scene/__init__.py @@ -1,12 +1,9486 @@ -from ._zaxis import ZAxis + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class ZAxis(_BaseLayoutHierarchyType): + + # autorange + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['autorange'] + + @autorange.setter + def autorange(self, val): + self['autorange'] = val + + # backgroundcolor + # --------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['backgroundcolor'] + + @backgroundcolor.setter + def backgroundcolor(self, val): + self['backgroundcolor'] = val + + # calendar + # -------- + @property + def calendar(self): + """ + Sets the calendar system to use for `range` and `tick0` if this + is a date axis. This does not set the calendar for interpreting + data on this axis, that's specified in the trace or via the + global `layout.calendar` + + The 'calendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['gregorian', 'chinese', 'coptic', 'discworld', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['calendar'] + + @calendar.setter + def calendar(self, val): + self['calendar'] = val + + # categoryarray + # ------------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['categoryarray'] + + @categoryarray.setter + def categoryarray(self, val): + self['categoryarray'] = val + + # categoryarraysrc + # ---------------- + @property + def categoryarraysrc(self): + """ + Sets the source reference on plot.ly for categoryarray . + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['categoryarraysrc'] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self['categoryarraysrc'] = val + + # categoryorder + # ------------- + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array'] + + Returns + ------- + Any + """ + return self['categoryorder'] + + @categoryorder.setter + def categoryorder(self, val): + self['categoryorder'] = val + + # color + # ----- + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # gridcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['gridcolor'] + + @gridcolor.setter + def gridcolor(self, val): + self['gridcolor'] = val + + # gridwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['gridwidth'] + + @gridwidth.setter + def gridwidth(self, val): + self['gridwidth'] = val + + # hoverformat + # ----------- + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['hoverformat'] + + @hoverformat.setter + def hoverformat(self, val): + self['hoverformat'] = val + + # linecolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['linecolor'] + + @linecolor.setter + def linecolor(self, val): + self['linecolor'] = val + + # linewidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['linewidth'] + + @linewidth.setter + def linewidth(self, val): + self['linewidth'] = val + + # mirror + # ------ + @property + def mirror(self): + """ + Determines if the axis lines or/and ticks are mirrored to the + opposite side of the plotting area. If True, the axis lines are + mirrored. If "ticks", the axis lines and ticks are mirrored. If + False, mirroring is disable. If "all", axis lines are mirrored + on all shared-axes subplots. If "allticks", axis lines and + ticks are mirrored on all shared-axes subplots. + + The 'mirror' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, 'ticks', False, 'all', 'allticks'] + + Returns + ------- + Any + """ + return self['mirror'] + + @mirror.setter + def mirror(self, val): + self['mirror'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # range + # ----- + @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 + + Returns + ------- + list + """ + return self['range'] + + @range.setter + def range(self, val): + self['range'] = val + + # rangemode + # --------- + @property + def rangemode(self): + """ + If "normal", the range is computed in relation to the extrema + of the input data. If *tozero*`, the range extends to 0, + regardless of the input data If "nonnegative", the range is + non-negative, regardless of the input data. Applies only to + linear axes. + + The 'rangemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'tozero', 'nonnegative'] + + Returns + ------- + Any + """ + return self['rangemode'] + + @rangemode.setter + def rangemode(self, val): + self['rangemode'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showaxeslabels + # -------------- + @property + def showaxeslabels(self): + """ + Sets whether or not this axis is labeled + + The 'showaxeslabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['showaxeslabels'] + + @showaxeslabels.setter + def showaxeslabels(self, val): + self['showaxeslabels'] = val + + # showbackground + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showbackground'] + + @showbackground.setter + def showbackground(self, val): + self['showbackground'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showgrid + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showgrid'] + + @showgrid.setter + def showgrid(self, val): + self['showgrid'] = val + + # showline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showline'] + + @showline.setter + def showline(self, val): + self['showline'] = val + + # showspikes + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showspikes'] + + @showspikes.setter + def showspikes(self, val): + self['showspikes'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # spikecolor + # ---------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['spikecolor'] + + @spikecolor.setter + def spikecolor(self, val): + self['spikecolor'] = val + + # spikesides + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['spikesides'] + + @spikesides.setter + def spikesides(self, val): + self['spikesides'] = val + + # spikethickness + # -------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['spikethickness'] + + @spikethickness.setter + def spikethickness(self, val): + self['spikethickness'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.scene.zaxis.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.layout.scene.zaxis.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + 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 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 + ------- + plotly.graph_objs.layout.scene.zaxis.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + text + 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. + + Returns + ------- + plotly.graph_objs.layout.scene.zaxis.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # type + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # zeroline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['zeroline'] + + @zeroline.setter + def zeroline(self, val): + self['zeroline'] = val + + # zerolinecolor + # ------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['zerolinecolor'] + + @zerolinecolor.setter + def zerolinecolor(self, val): + self['zerolinecolor'] = val + + # zerolinewidth + # ------------- + @property + 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 + + Returns + ------- + int|float + """ + return self['zerolinewidth'] + + @zerolinewidth.setter + def zerolinewidth(self, val): + self['zerolinewidth'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If *tozero*`, the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a background + color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Sets whether or not spikes starting from data points to + this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall boundaries + are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.scene.zaxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.scen + e.zaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.scene.zaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.scene.zaxis.Title instance or + dict with compatible properties + titlefont + 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. + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + """ + + _mapped_properties = {'titlefont': ('title', 'font')} + + def __init__( + self, + arg=None, + autorange=None, + backgroundcolor=None, + calendar=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + color=None, + dtick=None, + exponentformat=None, + gridcolor=None, + gridwidth=None, + hoverformat=None, + linecolor=None, + linewidth=None, + mirror=None, + nticks=None, + range=None, + rangemode=None, + separatethousands=None, + showaxeslabels=None, + showbackground=None, + showexponent=None, + showgrid=None, + showline=None, + showspikes=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + spikecolor=None, + spikesides=None, + spikethickness=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + type=None, + visible=None, + zeroline=None, + zerolinecolor=None, + zerolinewidth=None, + **kwargs + ): + """ + Construct a new ZAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.scene.ZAxis + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If *tozero*`, the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a background + color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Sets whether or not spikes starting from data points to + this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall boundaries + are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.scene.zaxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.scen + e.zaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.scene.zaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.scene.zaxis.Title instance or + dict with compatible properties + titlefont + 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. + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + + Returns + ------- + ZAxis + """ + super(ZAxis, self).__init__('zaxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.ZAxis +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.ZAxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene import (zaxis as v_zaxis) + + # Initialize validators + # --------------------- + self._validators['autorange'] = v_zaxis.AutorangeValidator() + self._validators['backgroundcolor'] = v_zaxis.BackgroundcolorValidator( + ) + self._validators['calendar'] = v_zaxis.CalendarValidator() + self._validators['categoryarray'] = v_zaxis.CategoryarrayValidator() + self._validators['categoryarraysrc' + ] = v_zaxis.CategoryarraysrcValidator() + self._validators['categoryorder'] = v_zaxis.CategoryorderValidator() + self._validators['color'] = v_zaxis.ColorValidator() + self._validators['dtick'] = v_zaxis.DtickValidator() + self._validators['exponentformat'] = v_zaxis.ExponentformatValidator() + self._validators['gridcolor'] = v_zaxis.GridcolorValidator() + self._validators['gridwidth'] = v_zaxis.GridwidthValidator() + self._validators['hoverformat'] = v_zaxis.HoverformatValidator() + self._validators['linecolor'] = v_zaxis.LinecolorValidator() + self._validators['linewidth'] = v_zaxis.LinewidthValidator() + self._validators['mirror'] = v_zaxis.MirrorValidator() + self._validators['nticks'] = v_zaxis.NticksValidator() + self._validators['range'] = v_zaxis.RangeValidator() + self._validators['rangemode'] = v_zaxis.RangemodeValidator() + self._validators['separatethousands' + ] = v_zaxis.SeparatethousandsValidator() + self._validators['showaxeslabels'] = v_zaxis.ShowaxeslabelsValidator() + self._validators['showbackground'] = v_zaxis.ShowbackgroundValidator() + self._validators['showexponent'] = v_zaxis.ShowexponentValidator() + self._validators['showgrid'] = v_zaxis.ShowgridValidator() + self._validators['showline'] = v_zaxis.ShowlineValidator() + self._validators['showspikes'] = v_zaxis.ShowspikesValidator() + self._validators['showticklabels'] = v_zaxis.ShowticklabelsValidator() + self._validators['showtickprefix'] = v_zaxis.ShowtickprefixValidator() + self._validators['showticksuffix'] = v_zaxis.ShowticksuffixValidator() + self._validators['spikecolor'] = v_zaxis.SpikecolorValidator() + self._validators['spikesides'] = v_zaxis.SpikesidesValidator() + self._validators['spikethickness'] = v_zaxis.SpikethicknessValidator() + self._validators['tick0'] = v_zaxis.Tick0Validator() + self._validators['tickangle'] = v_zaxis.TickangleValidator() + self._validators['tickcolor'] = v_zaxis.TickcolorValidator() + self._validators['tickfont'] = v_zaxis.TickfontValidator() + self._validators['tickformat'] = v_zaxis.TickformatValidator() + self._validators['tickformatstops'] = v_zaxis.TickformatstopsValidator( + ) + self._validators['tickformatstopdefaults' + ] = v_zaxis.TickformatstopValidator() + self._validators['ticklen'] = v_zaxis.TicklenValidator() + self._validators['tickmode'] = v_zaxis.TickmodeValidator() + self._validators['tickprefix'] = v_zaxis.TickprefixValidator() + self._validators['ticks'] = v_zaxis.TicksValidator() + self._validators['ticksuffix'] = v_zaxis.TicksuffixValidator() + self._validators['ticktext'] = v_zaxis.TicktextValidator() + self._validators['ticktextsrc'] = v_zaxis.TicktextsrcValidator() + self._validators['tickvals'] = v_zaxis.TickvalsValidator() + self._validators['tickvalssrc'] = v_zaxis.TickvalssrcValidator() + self._validators['tickwidth'] = v_zaxis.TickwidthValidator() + self._validators['title'] = v_zaxis.TitleValidator() + self._validators['type'] = v_zaxis.TypeValidator() + self._validators['visible'] = v_zaxis.VisibleValidator() + self._validators['zeroline'] = v_zaxis.ZerolineValidator() + self._validators['zerolinecolor'] = v_zaxis.ZerolinecolorValidator() + self._validators['zerolinewidth'] = v_zaxis.ZerolinewidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autorange', None) + self['autorange'] = autorange if autorange is not None else _v + _v = arg.pop('backgroundcolor', None) + self['backgroundcolor' + ] = backgroundcolor if backgroundcolor is not None else _v + _v = arg.pop('calendar', None) + self['calendar'] = calendar if calendar is not None else _v + _v = arg.pop('categoryarray', None) + self['categoryarray' + ] = categoryarray if categoryarray is not None else _v + _v = arg.pop('categoryarraysrc', None) + self['categoryarraysrc' + ] = categoryarraysrc if categoryarraysrc is not None else _v + _v = arg.pop('categoryorder', None) + self['categoryorder' + ] = categoryorder if categoryorder is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('gridcolor', None) + self['gridcolor'] = gridcolor if gridcolor is not None else _v + _v = arg.pop('gridwidth', None) + self['gridwidth'] = gridwidth if gridwidth is not None else _v + _v = arg.pop('hoverformat', None) + self['hoverformat'] = hoverformat if hoverformat is not None else _v + _v = arg.pop('linecolor', None) + self['linecolor'] = linecolor if linecolor is not None else _v + _v = arg.pop('linewidth', None) + self['linewidth'] = linewidth if linewidth is not None else _v + _v = arg.pop('mirror', None) + self['mirror'] = mirror if mirror is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('range', None) + self['range'] = range if range is not None else _v + _v = arg.pop('rangemode', None) + self['rangemode'] = rangemode if rangemode is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showaxeslabels', None) + self['showaxeslabels' + ] = showaxeslabels if showaxeslabels is not None else _v + _v = arg.pop('showbackground', None) + self['showbackground' + ] = showbackground if showbackground is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showgrid', None) + self['showgrid'] = showgrid if showgrid is not None else _v + _v = arg.pop('showline', None) + self['showline'] = showline if showline is not None else _v + _v = arg.pop('showspikes', None) + self['showspikes'] = showspikes if showspikes is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('spikecolor', None) + self['spikecolor'] = spikecolor if spikecolor is not None else _v + _v = arg.pop('spikesides', None) + self['spikesides'] = spikesides if spikesides is not None else _v + _v = arg.pop('spikethickness', None) + self['spikethickness' + ] = spikethickness if spikethickness is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('zeroline', None) + self['zeroline'] = zeroline if zeroline is not None else _v + _v = arg.pop('zerolinecolor', None) + self['zerolinecolor' + ] = zerolinecolor if zerolinecolor is not None else _v + _v = arg.pop('zerolinewidth', None) + self['zerolinewidth' + ] = zerolinewidth if zerolinewidth is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class YAxis(_BaseLayoutHierarchyType): + + # autorange + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['autorange'] + + @autorange.setter + def autorange(self, val): + self['autorange'] = val + + # backgroundcolor + # --------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['backgroundcolor'] + + @backgroundcolor.setter + def backgroundcolor(self, val): + self['backgroundcolor'] = val + + # calendar + # -------- + @property + def calendar(self): + """ + Sets the calendar system to use for `range` and `tick0` if this + is a date axis. This does not set the calendar for interpreting + data on this axis, that's specified in the trace or via the + global `layout.calendar` + + The 'calendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['gregorian', 'chinese', 'coptic', 'discworld', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['calendar'] + + @calendar.setter + def calendar(self, val): + self['calendar'] = val + + # categoryarray + # ------------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['categoryarray'] + + @categoryarray.setter + def categoryarray(self, val): + self['categoryarray'] = val + + # categoryarraysrc + # ---------------- + @property + def categoryarraysrc(self): + """ + Sets the source reference on plot.ly for categoryarray . + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['categoryarraysrc'] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self['categoryarraysrc'] = val + + # categoryorder + # ------------- + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array'] + + Returns + ------- + Any + """ + return self['categoryorder'] + + @categoryorder.setter + def categoryorder(self, val): + self['categoryorder'] = val + + # color + # ----- + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # gridcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['gridcolor'] + + @gridcolor.setter + def gridcolor(self, val): + self['gridcolor'] = val + + # gridwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['gridwidth'] + + @gridwidth.setter + def gridwidth(self, val): + self['gridwidth'] = val + + # hoverformat + # ----------- + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['hoverformat'] + + @hoverformat.setter + def hoverformat(self, val): + self['hoverformat'] = val + + # linecolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['linecolor'] + + @linecolor.setter + def linecolor(self, val): + self['linecolor'] = val + + # linewidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['linewidth'] + + @linewidth.setter + def linewidth(self, val): + self['linewidth'] = val + + # mirror + # ------ + @property + def mirror(self): + """ + Determines if the axis lines or/and ticks are mirrored to the + opposite side of the plotting area. If True, the axis lines are + mirrored. If "ticks", the axis lines and ticks are mirrored. If + False, mirroring is disable. If "all", axis lines are mirrored + on all shared-axes subplots. If "allticks", axis lines and + ticks are mirrored on all shared-axes subplots. + + The 'mirror' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, 'ticks', False, 'all', 'allticks'] + + Returns + ------- + Any + """ + return self['mirror'] + + @mirror.setter + def mirror(self, val): + self['mirror'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # range + # ----- + @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 + + Returns + ------- + list + """ + return self['range'] + + @range.setter + def range(self, val): + self['range'] = val + + # rangemode + # --------- + @property + def rangemode(self): + """ + If "normal", the range is computed in relation to the extrema + of the input data. If *tozero*`, the range extends to 0, + regardless of the input data If "nonnegative", the range is + non-negative, regardless of the input data. Applies only to + linear axes. + + The 'rangemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'tozero', 'nonnegative'] + + Returns + ------- + Any + """ + return self['rangemode'] + + @rangemode.setter + def rangemode(self, val): + self['rangemode'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showaxeslabels + # -------------- + @property + def showaxeslabels(self): + """ + Sets whether or not this axis is labeled + + The 'showaxeslabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['showaxeslabels'] + + @showaxeslabels.setter + def showaxeslabels(self, val): + self['showaxeslabels'] = val + + # showbackground + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showbackground'] + + @showbackground.setter + def showbackground(self, val): + self['showbackground'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showgrid + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showgrid'] + + @showgrid.setter + def showgrid(self, val): + self['showgrid'] = val + + # showline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showline'] + + @showline.setter + def showline(self, val): + self['showline'] = val + + # showspikes + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showspikes'] + + @showspikes.setter + def showspikes(self, val): + self['showspikes'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # spikecolor + # ---------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['spikecolor'] + + @spikecolor.setter + def spikecolor(self, val): + self['spikecolor'] = val + + # spikesides + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['spikesides'] + + @spikesides.setter + def spikesides(self, val): + self['spikesides'] = val + + # spikethickness + # -------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['spikethickness'] + + @spikethickness.setter + def spikethickness(self, val): + self['spikethickness'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.scene.yaxis.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.layout.scene.yaxis.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + 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 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 + ------- + plotly.graph_objs.layout.scene.yaxis.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + text + 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. + + Returns + ------- + plotly.graph_objs.layout.scene.yaxis.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # type + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # zeroline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['zeroline'] + + @zeroline.setter + def zeroline(self, val): + self['zeroline'] = val + + # zerolinecolor + # ------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['zerolinecolor'] + + @zerolinecolor.setter + def zerolinecolor(self, val): + self['zerolinecolor'] = val + + # zerolinewidth + # ------------- + @property + 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 + + Returns + ------- + int|float + """ + return self['zerolinewidth'] + + @zerolinewidth.setter + def zerolinewidth(self, val): + self['zerolinewidth'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If *tozero*`, the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a background + color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Sets whether or not spikes starting from data points to + this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall boundaries + are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.scene.yaxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.scen + e.yaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.scene.yaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.scene.yaxis.Title instance or + dict with compatible properties + titlefont + 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. + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + """ + + _mapped_properties = {'titlefont': ('title', 'font')} + + def __init__( + self, + arg=None, + autorange=None, + backgroundcolor=None, + calendar=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + color=None, + dtick=None, + exponentformat=None, + gridcolor=None, + gridwidth=None, + hoverformat=None, + linecolor=None, + linewidth=None, + mirror=None, + nticks=None, + range=None, + rangemode=None, + separatethousands=None, + showaxeslabels=None, + showbackground=None, + showexponent=None, + showgrid=None, + showline=None, + showspikes=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + spikecolor=None, + spikesides=None, + spikethickness=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + type=None, + visible=None, + zeroline=None, + zerolinecolor=None, + zerolinewidth=None, + **kwargs + ): + """ + Construct a new YAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.scene.YAxis + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If *tozero*`, the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a background + color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Sets whether or not spikes starting from data points to + this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall boundaries + are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.scene.yaxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.scen + e.yaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.scene.yaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.scene.yaxis.Title instance or + dict with compatible properties + titlefont + 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. + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + + Returns + ------- + YAxis + """ + super(YAxis, self).__init__('yaxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.YAxis +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.YAxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene import (yaxis as v_yaxis) + + # Initialize validators + # --------------------- + self._validators['autorange'] = v_yaxis.AutorangeValidator() + self._validators['backgroundcolor'] = v_yaxis.BackgroundcolorValidator( + ) + self._validators['calendar'] = v_yaxis.CalendarValidator() + self._validators['categoryarray'] = v_yaxis.CategoryarrayValidator() + self._validators['categoryarraysrc' + ] = v_yaxis.CategoryarraysrcValidator() + self._validators['categoryorder'] = v_yaxis.CategoryorderValidator() + self._validators['color'] = v_yaxis.ColorValidator() + self._validators['dtick'] = v_yaxis.DtickValidator() + self._validators['exponentformat'] = v_yaxis.ExponentformatValidator() + self._validators['gridcolor'] = v_yaxis.GridcolorValidator() + self._validators['gridwidth'] = v_yaxis.GridwidthValidator() + self._validators['hoverformat'] = v_yaxis.HoverformatValidator() + self._validators['linecolor'] = v_yaxis.LinecolorValidator() + self._validators['linewidth'] = v_yaxis.LinewidthValidator() + self._validators['mirror'] = v_yaxis.MirrorValidator() + self._validators['nticks'] = v_yaxis.NticksValidator() + self._validators['range'] = v_yaxis.RangeValidator() + self._validators['rangemode'] = v_yaxis.RangemodeValidator() + self._validators['separatethousands' + ] = v_yaxis.SeparatethousandsValidator() + self._validators['showaxeslabels'] = v_yaxis.ShowaxeslabelsValidator() + self._validators['showbackground'] = v_yaxis.ShowbackgroundValidator() + self._validators['showexponent'] = v_yaxis.ShowexponentValidator() + self._validators['showgrid'] = v_yaxis.ShowgridValidator() + self._validators['showline'] = v_yaxis.ShowlineValidator() + self._validators['showspikes'] = v_yaxis.ShowspikesValidator() + self._validators['showticklabels'] = v_yaxis.ShowticklabelsValidator() + self._validators['showtickprefix'] = v_yaxis.ShowtickprefixValidator() + self._validators['showticksuffix'] = v_yaxis.ShowticksuffixValidator() + self._validators['spikecolor'] = v_yaxis.SpikecolorValidator() + self._validators['spikesides'] = v_yaxis.SpikesidesValidator() + self._validators['spikethickness'] = v_yaxis.SpikethicknessValidator() + self._validators['tick0'] = v_yaxis.Tick0Validator() + self._validators['tickangle'] = v_yaxis.TickangleValidator() + self._validators['tickcolor'] = v_yaxis.TickcolorValidator() + self._validators['tickfont'] = v_yaxis.TickfontValidator() + self._validators['tickformat'] = v_yaxis.TickformatValidator() + self._validators['tickformatstops'] = v_yaxis.TickformatstopsValidator( + ) + self._validators['tickformatstopdefaults' + ] = v_yaxis.TickformatstopValidator() + self._validators['ticklen'] = v_yaxis.TicklenValidator() + self._validators['tickmode'] = v_yaxis.TickmodeValidator() + self._validators['tickprefix'] = v_yaxis.TickprefixValidator() + self._validators['ticks'] = v_yaxis.TicksValidator() + self._validators['ticksuffix'] = v_yaxis.TicksuffixValidator() + self._validators['ticktext'] = v_yaxis.TicktextValidator() + self._validators['ticktextsrc'] = v_yaxis.TicktextsrcValidator() + self._validators['tickvals'] = v_yaxis.TickvalsValidator() + self._validators['tickvalssrc'] = v_yaxis.TickvalssrcValidator() + self._validators['tickwidth'] = v_yaxis.TickwidthValidator() + self._validators['title'] = v_yaxis.TitleValidator() + self._validators['type'] = v_yaxis.TypeValidator() + self._validators['visible'] = v_yaxis.VisibleValidator() + self._validators['zeroline'] = v_yaxis.ZerolineValidator() + self._validators['zerolinecolor'] = v_yaxis.ZerolinecolorValidator() + self._validators['zerolinewidth'] = v_yaxis.ZerolinewidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autorange', None) + self['autorange'] = autorange if autorange is not None else _v + _v = arg.pop('backgroundcolor', None) + self['backgroundcolor' + ] = backgroundcolor if backgroundcolor is not None else _v + _v = arg.pop('calendar', None) + self['calendar'] = calendar if calendar is not None else _v + _v = arg.pop('categoryarray', None) + self['categoryarray' + ] = categoryarray if categoryarray is not None else _v + _v = arg.pop('categoryarraysrc', None) + self['categoryarraysrc' + ] = categoryarraysrc if categoryarraysrc is not None else _v + _v = arg.pop('categoryorder', None) + self['categoryorder' + ] = categoryorder if categoryorder is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('gridcolor', None) + self['gridcolor'] = gridcolor if gridcolor is not None else _v + _v = arg.pop('gridwidth', None) + self['gridwidth'] = gridwidth if gridwidth is not None else _v + _v = arg.pop('hoverformat', None) + self['hoverformat'] = hoverformat if hoverformat is not None else _v + _v = arg.pop('linecolor', None) + self['linecolor'] = linecolor if linecolor is not None else _v + _v = arg.pop('linewidth', None) + self['linewidth'] = linewidth if linewidth is not None else _v + _v = arg.pop('mirror', None) + self['mirror'] = mirror if mirror is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('range', None) + self['range'] = range if range is not None else _v + _v = arg.pop('rangemode', None) + self['rangemode'] = rangemode if rangemode is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showaxeslabels', None) + self['showaxeslabels' + ] = showaxeslabels if showaxeslabels is not None else _v + _v = arg.pop('showbackground', None) + self['showbackground' + ] = showbackground if showbackground is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showgrid', None) + self['showgrid'] = showgrid if showgrid is not None else _v + _v = arg.pop('showline', None) + self['showline'] = showline if showline is not None else _v + _v = arg.pop('showspikes', None) + self['showspikes'] = showspikes if showspikes is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('spikecolor', None) + self['spikecolor'] = spikecolor if spikecolor is not None else _v + _v = arg.pop('spikesides', None) + self['spikesides'] = spikesides if spikesides is not None else _v + _v = arg.pop('spikethickness', None) + self['spikethickness' + ] = spikethickness if spikethickness is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('zeroline', None) + self['zeroline'] = zeroline if zeroline is not None else _v + _v = arg.pop('zerolinecolor', None) + self['zerolinecolor' + ] = zerolinecolor if zerolinecolor is not None else _v + _v = arg.pop('zerolinewidth', None) + self['zerolinewidth' + ] = zerolinewidth if zerolinewidth is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class XAxis(_BaseLayoutHierarchyType): + + # autorange + # --------- + @property + 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'] + + Returns + ------- + Any + """ + return self['autorange'] + + @autorange.setter + def autorange(self, val): + self['autorange'] = val + + # backgroundcolor + # --------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['backgroundcolor'] + + @backgroundcolor.setter + def backgroundcolor(self, val): + self['backgroundcolor'] = val + + # calendar + # -------- + @property + def calendar(self): + """ + Sets the calendar system to use for `range` and `tick0` if this + is a date axis. This does not set the calendar for interpreting + data on this axis, that's specified in the trace or via the + global `layout.calendar` + + The 'calendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['gregorian', 'chinese', 'coptic', 'discworld', + 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', + 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self['calendar'] + + @calendar.setter + def calendar(self, val): + self['calendar'] = val + + # categoryarray + # ------------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['categoryarray'] + + @categoryarray.setter + def categoryarray(self, val): + self['categoryarray'] = val + + # categoryarraysrc + # ---------------- + @property + def categoryarraysrc(self): + """ + Sets the source reference on plot.ly for categoryarray . + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['categoryarraysrc'] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self['categoryarraysrc'] = val + + # categoryorder + # ------------- + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array'] + + Returns + ------- + Any + """ + return self['categoryorder'] + + @categoryorder.setter + def categoryorder(self, val): + self['categoryorder'] = val + + # color + # ----- + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # gridcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['gridcolor'] + + @gridcolor.setter + def gridcolor(self, val): + self['gridcolor'] = val + + # gridwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['gridwidth'] + + @gridwidth.setter + def gridwidth(self, val): + self['gridwidth'] = val + + # hoverformat + # ----------- + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['hoverformat'] + + @hoverformat.setter + def hoverformat(self, val): + self['hoverformat'] = val + + # linecolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['linecolor'] + + @linecolor.setter + def linecolor(self, val): + self['linecolor'] = val + + # linewidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['linewidth'] + + @linewidth.setter + def linewidth(self, val): + self['linewidth'] = val + + # mirror + # ------ + @property + def mirror(self): + """ + Determines if the axis lines or/and ticks are mirrored to the + opposite side of the plotting area. If True, the axis lines are + mirrored. If "ticks", the axis lines and ticks are mirrored. If + False, mirroring is disable. If "all", axis lines are mirrored + on all shared-axes subplots. If "allticks", axis lines and + ticks are mirrored on all shared-axes subplots. + + The 'mirror' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, 'ticks', False, 'all', 'allticks'] + + Returns + ------- + Any + """ + return self['mirror'] + + @mirror.setter + def mirror(self, val): + self['mirror'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # range + # ----- + @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 + + Returns + ------- + list + """ + return self['range'] + + @range.setter + def range(self, val): + self['range'] = val + + # rangemode + # --------- + @property + def rangemode(self): + """ + If "normal", the range is computed in relation to the extrema + of the input data. If *tozero*`, the range extends to 0, + regardless of the input data If "nonnegative", the range is + non-negative, regardless of the input data. Applies only to + linear axes. + + The 'rangemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'tozero', 'nonnegative'] + + Returns + ------- + Any + """ + return self['rangemode'] + + @rangemode.setter + def rangemode(self, val): + self['rangemode'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showaxeslabels + # -------------- + @property + def showaxeslabels(self): + """ + Sets whether or not this axis is labeled + + The 'showaxeslabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['showaxeslabels'] + + @showaxeslabels.setter + def showaxeslabels(self, val): + self['showaxeslabels'] = val + + # showbackground + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showbackground'] + + @showbackground.setter + def showbackground(self, val): + self['showbackground'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showgrid + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showgrid'] + + @showgrid.setter + def showgrid(self, val): + self['showgrid'] = val + + # showline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showline'] + + @showline.setter + def showline(self, val): + self['showline'] = val + + # showspikes + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['showspikes'] + + @showspikes.setter + def showspikes(self, val): + self['showspikes'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # spikecolor + # ---------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['spikecolor'] + + @spikecolor.setter + def spikecolor(self, val): + self['spikecolor'] = val + + # spikesides + # ---------- + @property + 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) + + Returns + ------- + bool + """ + return self['spikesides'] + + @spikesides.setter + def spikesides(self, val): + self['spikesides'] = val + + # spikethickness + # -------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['spikethickness'] + + @spikethickness.setter + def spikethickness(self, val): + self['spikethickness'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.scene.xaxis.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.layout.scene.xaxis.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + 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 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 + ------- + plotly.graph_objs.layout.scene.xaxis.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + text + 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. + + Returns + ------- + plotly.graph_objs.layout.scene.xaxis.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # type + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # zeroline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['zeroline'] + + @zeroline.setter + def zeroline(self, val): + self['zeroline'] = val + + # zerolinecolor + # ------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['zerolinecolor'] + + @zerolinecolor.setter + def zerolinecolor(self, val): + self['zerolinecolor'] = val + + # zerolinewidth + # ------------- + @property + 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 + + Returns + ------- + int|float + """ + return self['zerolinewidth'] + + @zerolinewidth.setter + def zerolinewidth(self, val): + self['zerolinewidth'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If *tozero*`, the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a background + color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Sets whether or not spikes starting from data points to + this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall boundaries + are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.scene.xaxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.scen + e.xaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.scene.xaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.scene.xaxis.Title instance or + dict with compatible properties + titlefont + 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. + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + """ + + _mapped_properties = {'titlefont': ('title', 'font')} + + def __init__( + self, + arg=None, + autorange=None, + backgroundcolor=None, + calendar=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + color=None, + dtick=None, + exponentformat=None, + gridcolor=None, + gridwidth=None, + hoverformat=None, + linecolor=None, + linewidth=None, + mirror=None, + nticks=None, + range=None, + rangemode=None, + separatethousands=None, + showaxeslabels=None, + showbackground=None, + showexponent=None, + showgrid=None, + showline=None, + showspikes=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + spikecolor=None, + spikesides=None, + spikethickness=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + type=None, + visible=None, + zeroline=None, + zerolinecolor=None, + zerolinewidth=None, + **kwargs + ): + """ + Construct a new XAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.scene.XAxis + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If *tozero*`, the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a background + color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Sets whether or not spikes starting from data points to + this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall boundaries + are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.scene.xaxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.scen + e.xaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.scene.xaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.scene.xaxis.Title instance or + dict with compatible properties + titlefont + 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. + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + + Returns + ------- + XAxis + """ + super(XAxis, self).__init__('xaxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.XAxis +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.XAxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene import (xaxis as v_xaxis) + + # Initialize validators + # --------------------- + self._validators['autorange'] = v_xaxis.AutorangeValidator() + self._validators['backgroundcolor'] = v_xaxis.BackgroundcolorValidator( + ) + self._validators['calendar'] = v_xaxis.CalendarValidator() + self._validators['categoryarray'] = v_xaxis.CategoryarrayValidator() + self._validators['categoryarraysrc' + ] = v_xaxis.CategoryarraysrcValidator() + self._validators['categoryorder'] = v_xaxis.CategoryorderValidator() + self._validators['color'] = v_xaxis.ColorValidator() + self._validators['dtick'] = v_xaxis.DtickValidator() + self._validators['exponentformat'] = v_xaxis.ExponentformatValidator() + self._validators['gridcolor'] = v_xaxis.GridcolorValidator() + self._validators['gridwidth'] = v_xaxis.GridwidthValidator() + self._validators['hoverformat'] = v_xaxis.HoverformatValidator() + self._validators['linecolor'] = v_xaxis.LinecolorValidator() + self._validators['linewidth'] = v_xaxis.LinewidthValidator() + self._validators['mirror'] = v_xaxis.MirrorValidator() + self._validators['nticks'] = v_xaxis.NticksValidator() + self._validators['range'] = v_xaxis.RangeValidator() + self._validators['rangemode'] = v_xaxis.RangemodeValidator() + self._validators['separatethousands' + ] = v_xaxis.SeparatethousandsValidator() + self._validators['showaxeslabels'] = v_xaxis.ShowaxeslabelsValidator() + self._validators['showbackground'] = v_xaxis.ShowbackgroundValidator() + self._validators['showexponent'] = v_xaxis.ShowexponentValidator() + self._validators['showgrid'] = v_xaxis.ShowgridValidator() + self._validators['showline'] = v_xaxis.ShowlineValidator() + self._validators['showspikes'] = v_xaxis.ShowspikesValidator() + self._validators['showticklabels'] = v_xaxis.ShowticklabelsValidator() + self._validators['showtickprefix'] = v_xaxis.ShowtickprefixValidator() + self._validators['showticksuffix'] = v_xaxis.ShowticksuffixValidator() + self._validators['spikecolor'] = v_xaxis.SpikecolorValidator() + self._validators['spikesides'] = v_xaxis.SpikesidesValidator() + self._validators['spikethickness'] = v_xaxis.SpikethicknessValidator() + self._validators['tick0'] = v_xaxis.Tick0Validator() + self._validators['tickangle'] = v_xaxis.TickangleValidator() + self._validators['tickcolor'] = v_xaxis.TickcolorValidator() + self._validators['tickfont'] = v_xaxis.TickfontValidator() + self._validators['tickformat'] = v_xaxis.TickformatValidator() + self._validators['tickformatstops'] = v_xaxis.TickformatstopsValidator( + ) + self._validators['tickformatstopdefaults' + ] = v_xaxis.TickformatstopValidator() + self._validators['ticklen'] = v_xaxis.TicklenValidator() + self._validators['tickmode'] = v_xaxis.TickmodeValidator() + self._validators['tickprefix'] = v_xaxis.TickprefixValidator() + self._validators['ticks'] = v_xaxis.TicksValidator() + self._validators['ticksuffix'] = v_xaxis.TicksuffixValidator() + self._validators['ticktext'] = v_xaxis.TicktextValidator() + self._validators['ticktextsrc'] = v_xaxis.TicktextsrcValidator() + self._validators['tickvals'] = v_xaxis.TickvalsValidator() + self._validators['tickvalssrc'] = v_xaxis.TickvalssrcValidator() + self._validators['tickwidth'] = v_xaxis.TickwidthValidator() + self._validators['title'] = v_xaxis.TitleValidator() + self._validators['type'] = v_xaxis.TypeValidator() + self._validators['visible'] = v_xaxis.VisibleValidator() + self._validators['zeroline'] = v_xaxis.ZerolineValidator() + self._validators['zerolinecolor'] = v_xaxis.ZerolinecolorValidator() + self._validators['zerolinewidth'] = v_xaxis.ZerolinewidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autorange', None) + self['autorange'] = autorange if autorange is not None else _v + _v = arg.pop('backgroundcolor', None) + self['backgroundcolor' + ] = backgroundcolor if backgroundcolor is not None else _v + _v = arg.pop('calendar', None) + self['calendar'] = calendar if calendar is not None else _v + _v = arg.pop('categoryarray', None) + self['categoryarray' + ] = categoryarray if categoryarray is not None else _v + _v = arg.pop('categoryarraysrc', None) + self['categoryarraysrc' + ] = categoryarraysrc if categoryarraysrc is not None else _v + _v = arg.pop('categoryorder', None) + self['categoryorder' + ] = categoryorder if categoryorder is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('gridcolor', None) + self['gridcolor'] = gridcolor if gridcolor is not None else _v + _v = arg.pop('gridwidth', None) + self['gridwidth'] = gridwidth if gridwidth is not None else _v + _v = arg.pop('hoverformat', None) + self['hoverformat'] = hoverformat if hoverformat is not None else _v + _v = arg.pop('linecolor', None) + self['linecolor'] = linecolor if linecolor is not None else _v + _v = arg.pop('linewidth', None) + self['linewidth'] = linewidth if linewidth is not None else _v + _v = arg.pop('mirror', None) + self['mirror'] = mirror if mirror is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('range', None) + self['range'] = range if range is not None else _v + _v = arg.pop('rangemode', None) + self['rangemode'] = rangemode if rangemode is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showaxeslabels', None) + self['showaxeslabels' + ] = showaxeslabels if showaxeslabels is not None else _v + _v = arg.pop('showbackground', None) + self['showbackground' + ] = showbackground if showbackground is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showgrid', None) + self['showgrid'] = showgrid if showgrid is not None else _v + _v = arg.pop('showline', None) + self['showline'] = showline if showline is not None else _v + _v = arg.pop('showspikes', None) + self['showspikes'] = showspikes if showspikes is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('spikecolor', None) + self['spikecolor'] = spikecolor if spikecolor is not None else _v + _v = arg.pop('spikesides', None) + self['spikesides'] = spikesides if spikesides is not None else _v + _v = arg.pop('spikethickness', None) + self['spikethickness' + ] = spikethickness if spikethickness is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('zeroline', None) + self['zeroline'] = zeroline if zeroline is not None else _v + _v = arg.pop('zerolinecolor', None) + self['zerolinecolor' + ] = zerolinecolor if zerolinecolor is not None else _v + _v = arg.pop('zerolinewidth', None) + self['zerolinewidth' + ] = zerolinewidth if zerolinewidth is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Domain(_BaseLayoutHierarchyType): + + # column + # ------ + @property + 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] + + Returns + ------- + int + """ + return self['column'] + + @column.setter + def column(self, val): + self['column'] = val + + # row + # --- + @property + 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] + + Returns + ------- + int + """ + return self['row'] + + @row.setter + def row(self, val): + self['row'] = val + + # x + # - + @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] + + Returns + ------- + list + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @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] + + Returns + ------- + list + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this scene subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this scene subplot . + x + Sets the horizontal domain of this scene subplot (in + plot fraction). + y + Sets the vertical domain of this scene subplot (in plot + fraction). + """ + + def __init__( + self, arg=None, column=None, row=None, x=None, y=None, **kwargs + ): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.scene.Domain + column + If there is a layout grid, use the domain for this + column in the grid for this scene subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this scene subplot . + x + Sets the horizontal domain of this scene subplot (in + plot fraction). + y + Sets the vertical domain of this scene subplot (in plot + fraction). + + Returns + ------- + Domain + """ + super(Domain, self).__init__('domain') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.Domain +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.Domain""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene import (domain as v_domain) + + # Initialize validators + # --------------------- + self._validators['column'] = v_domain.ColumnValidator() + self._validators['row'] = v_domain.RowValidator() + self._validators['x'] = v_domain.XValidator() + self._validators['y'] = v_domain.YValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('column', None) + self['column'] = column if column is not None else _v + _v = arg.pop('row', None) + self['row'] = row if row is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Camera(_BaseLayoutHierarchyType): + + # center + # ------ + @property + 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 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 + ------- + plotly.graph_objs.layout.scene.camera.Center + """ + return self['center'] + + @center.setter + def center(self, val): + self['center'] = val + + # eye + # --- + @property + 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 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 + ------- + plotly.graph_objs.layout.scene.camera.Eye + """ + return self['eye'] + + @eye.setter + def eye(self, val): + self['eye'] = val + + # projection + # ---------- + @property + def projection(self): + """ + The 'projection' property is an instance of Projection + that may be specified as: + - An instance of 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 + "orthographic". The default is "perspective". + + Returns + ------- + plotly.graph_objs.layout.scene.camera.Projection + """ + return self['projection'] + + @projection.setter + def projection(self, val): + self['projection'] = val + + # up + # -- + @property + def up(self): + """ + 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 + that the z axis points up. + + The 'up' property is an instance of Up + that may be specified as: + - An instance of 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 + ------- + plotly.graph_objs.layout.scene.camera.Up + """ + return self['up'] + + @up.setter + def up(self, val): + self['up'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + center + 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. + eye + Sets the (x,y,z) components of the 'eye' camera vector. + This vector determines the view point about the origin + of this scene. + projection + plotly.graph_objs.layout.scene.camera.Projection + instance or dict with compatible properties + up + 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 that the z axis points up. + """ + + def __init__( + self, + arg=None, + center=None, + eye=None, + projection=None, + up=None, + **kwargs + ): + """ + Construct a new Camera object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.scene.Camera + center + 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. + eye + Sets the (x,y,z) components of the 'eye' camera vector. + This vector determines the view point about the origin + of this scene. + projection + plotly.graph_objs.layout.scene.camera.Projection + instance or dict with compatible properties + up + 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 that the z axis points up. + + Returns + ------- + Camera + """ + super(Camera, self).__init__('camera') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.Camera +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.Camera""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene import (camera as v_camera) + + # Initialize validators + # --------------------- + self._validators['center'] = v_camera.CenterValidator() + self._validators['eye'] = v_camera.EyeValidator() + self._validators['projection'] = v_camera.ProjectionValidator() + self._validators['up'] = v_camera.UpValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('center', None) + self['center'] = center if center is not None else _v + _v = arg.pop('eye', None) + self['eye'] = eye if eye is not None else _v + _v = arg.pop('projection', None) + self['projection'] = projection if projection is not None else _v + _v = arg.pop('up', None) + self['up'] = up if up is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Aspectratio(_BaseLayoutHierarchyType): + + # x + # - + @property + def x(self): + """ + The 'x' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @property + def y(self): + """ + The 'y' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # z + # - + @property + def z(self): + """ + The 'z' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + + y + + z + + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Aspectratio object + + Sets this scene's axis aspectratio. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.Aspectratio + x + + y + + z + + + Returns + ------- + Aspectratio + """ + super(Aspectratio, self).__init__('aspectratio') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.Aspectratio +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.Aspectratio""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene import ( + aspectratio as v_aspectratio + ) + + # Initialize validators + # --------------------- + self._validators['x'] = v_aspectratio.XValidator() + self._validators['y'] = v_aspectratio.YValidator() + self._validators['z'] = v_aspectratio.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Annotation(_BaseLayoutHierarchyType): + + # align + # ----- + @property + def align(self): + """ + Sets the horizontal alignment of the `text` within the box. Has + an effect only if `text` spans more 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'] + + Returns + ------- + Any + """ + return self['align'] + + @align.setter + def align(self, val): + self['align'] = val + + # arrowcolor + # ---------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['arrowcolor'] + + @arrowcolor.setter + def arrowcolor(self, val): + self['arrowcolor'] = val + + # arrowhead + # --------- + @property + 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] + + Returns + ------- + int + """ + return self['arrowhead'] + + @arrowhead.setter + def arrowhead(self, val): + self['arrowhead'] = val + + # arrowside + # --------- + @property + 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 + (e.g. 'end+start') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self['arrowside'] + + @arrowside.setter + def arrowside(self, val): + self['arrowside'] = val + + # arrowsize + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['arrowsize'] + + @arrowsize.setter + def arrowsize(self, val): + self['arrowsize'] = val + + # arrowwidth + # ---------- + @property + 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] + + Returns + ------- + int|float + """ + return self['arrowwidth'] + + @arrowwidth.setter + def arrowwidth(self, val): + self['arrowwidth'] = val + + # ax + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['ax'] + + @ax.setter + def ax(self, val): + self['ax'] = val + + # ay + # -- + @property + 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 + + Returns + ------- + int|float + """ + return self['ay'] + + @ay.setter + def ay(self, val): + self['ay'] = val + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderpad + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderpad'] + + @borderpad.setter + def borderpad(self, val): + self['borderpad'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # captureevents + # ------------- + @property + def captureevents(self): + """ + Determines whether the annotation text box captures mouse move + and click events, or allows those events to pass through to + data points in the plot that may be behind the annotation. By + default `captureevents` is False unless `hovertext` is + provided. If you use the event `plotly_clickannotation` without + `hovertext` you must explicitly enable `captureevents`. + + The 'captureevents' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['captureevents'] + + @captureevents.setter + def captureevents(self, val): + self['captureevents'] = val + + # font + # ---- + @property + def font(self): + """ + Sets the annotation text font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.scene.annotation.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # height + # ------ + @property + 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] + + Returns + ------- + int|float + """ + return self['height'] + + @height.setter + def height(self, val): + self['height'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of 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 + opaque, or white if it was transparent. + bordercolor + Sets the border color of the hover label. By + default uses either dark grey or white, for + maximum contrast with `hoverlabel.bgcolor`. + font + Sets the hover label text font. By default uses + the global hover font and size, with color from + `hoverlabel.bordercolor`. + + Returns + ------- + plotly.graph_objs.layout.scene.annotation.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertext + # --------- + @property + 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 + + Returns + ------- + str + """ + return self['hovertext'] + + @hovertext.setter + def hovertext(self, val): + self['hovertext'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # showarrow + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showarrow'] + + @showarrow.setter + def showarrow(self, val): + self['showarrow'] = val + + # standoff + # -------- + @property + def standoff(self): + """ + Sets a distance, in pixels, to move the end arrowhead away from + the position it is pointing at, for example to point at the + edge of a marker independent of zoom. Note that this shortens + the arrow from the `ax` / `ay` vector, in contrast to `xshift` + / `yshift` which moves everything by this amount. + + The 'standoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self['standoff'] + + @standoff.setter + def standoff(self, val): + self['standoff'] = val + + # startarrowhead + # -------------- + @property + 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] + + Returns + ------- + int + """ + return self['startarrowhead'] + + @startarrowhead.setter + def startarrowhead(self, val): + self['startarrowhead'] = val + + # startarrowsize + # -------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['startarrowsize'] + + @startarrowsize.setter + def startarrowsize(self, val): + self['startarrowsize'] = val + + # startstandoff + # ------------- + @property + def startstandoff(self): + """ + Sets a distance, in pixels, to move the start arrowhead away + from the position it is pointing at, for example to point at + the edge of a marker independent of zoom. Note that this + shortens the arrow from the `ax` / `ay` vector, in contrast to + `xshift` / `yshift` which moves everything by this amount. + + The 'startstandoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self['startstandoff'] + + @startstandoff.setter + def startstandoff(self, val): + self['startstandoff'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # text + # ---- + @property + def text(self): + """ + Sets the text associated with this annotation. Plotly uses a + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # textangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['textangle'] + + @textangle.setter + def textangle(self, val): + self['textangle'] = val + + # valign + # ------ + @property + 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'] + + Returns + ------- + Any + """ + return self['valign'] + + @valign.setter + def valign(self, val): + self['valign'] = val + + # visible + # ------- + @property + def visible(self): + """ + Determines whether or not this annotation is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # x + # - + @property + def x(self): + """ + Sets the annotation's x position. + + The 'x' property accepts values of any type + + Returns + ------- + Any + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + def xanchor(self): + """ + Sets the text box's horizontal position anchor This anchor + binds the `x` position to the "left", "center" or "right" of + the annotation. For example, if `x` is set to 1, `xref` to + "paper" and `xanchor` to "right" then the right-most portion of + the annotation lines up with the right-most edge of the + plotting area. If "auto", the anchor is equivalent to "center" + for data-referenced annotations or if there is an arrow, + whereas for paper-referenced with no arrow, the anchor picked + corresponds to the closest side. + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'left', 'center', 'right'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xshift + # ------ + @property + 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 + + Returns + ------- + int|float + """ + return self['xshift'] + + @xshift.setter + def xshift(self, val): + self['xshift'] = val + + # y + # - + @property + def y(self): + """ + Sets the annotation's y position. + + The 'y' property accepts values of any type + + Returns + ------- + Any + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + def yanchor(self): + """ + Sets the text box's vertical position anchor This anchor binds + the `y` position to the "top", "middle" or "bottom" of the + annotation. For example, if `y` is set to 1, `yref` to "paper" + and `yanchor` to "top" then the top-most portion of the + annotation lines up with the top-most edge of the plotting + area. If "auto", the anchor is equivalent to "middle" for data- + referenced annotations or if there is an arrow, whereas for + paper-referenced with no arrow, the anchor picked corresponds + to the closest side. + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # yshift + # ------ + @property + 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 + + Returns + ------- + int|float + """ + return self['yshift'] + + @yshift.setter + def yshift(self, val): + self['yshift'] = val + + # z + # - + @property + def z(self): + """ + Sets the annotation's z position. + + The 'z' property accepts values of any type + + Returns + ------- + Any + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans more two or + more lines (i.e. `text` contains one or more
HTML + tags) or if an explicit width is set to override the + text width. + arrowcolor + Sets the color of the annotation arrow. + arrowhead + Sets the end annotation arrow head style. + arrowside + Sets the annotation arrow head position. + arrowsize + Sets the size of the end annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + arrowwidth + Sets the width (in px) of annotation arrow line. + ax + Sets the x component of the arrow tail about the arrow + head (in pixels). + ay + Sets the y component of the arrow tail about the arrow + head (in pixels). + bgcolor + Sets the background color of the annotation. + bordercolor + Sets the color of the border enclosing the annotation + `text`. + borderpad + Sets the padding (in px) between the `text` and the + enclosing border. + borderwidth + Sets the width (in px) of the border enclosing the + annotation `text`. + captureevents + Determines whether the annotation text box captures + mouse move and click events, or allows those events to + pass through to data points in the plot that may be + behind the annotation. By default `captureevents` is + False unless `hovertext` is provided. If you use the + event `plotly_clickannotation` without `hovertext` you + must explicitly enable `captureevents`. + font + Sets the annotation text font. + height + Sets an explicit height for the text box. null + (default) lets the text set the box height. Taller text + will be clipped. + hoverlabel + plotly.graph_objs.layout.scene.annotation.Hoverlabel + instance or dict with compatible properties + hovertext + Sets text to appear when hovering over this annotation. + If omitted or blank, no hover label will appear. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the annotation (text + arrow). + showarrow + Determines whether or not the annotation is drawn with + an arrow. If True, `text` is placed near the arrow's + tail. If False, `text` lines up with the `x` and `y` + provided. + standoff + Sets a distance, in pixels, to move the end arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + startarrowhead + Sets the start annotation arrow head style. + startarrowsize + Sets the size of the start annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + startstandoff + Sets a distance, in pixels, to move the start arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + text + Sets the text associated with this annotation. Plotly + uses a subset of HTML tags to do things like newline + (
), bold (), italics (), hyperlinks + (). Tags , , + are also supported. + textangle + Sets the angle at which the `text` is drawn with + respect to the horizontal. + valign + Sets the vertical alignment of the `text` within the + box. Has an effect only if an explicit height is set to + override the text height. + visible + Determines whether or not this annotation is visible. + width + Sets an explicit width for the text box. null (default) + lets the text set the box width. Wider text will be + clipped. There is no automatic wrapping; use
to + start a new line. + x + Sets the annotation's x position. + xanchor + Sets the text box's horizontal position anchor This + anchor binds the `x` position to the "left", "center" + or "right" of the annotation. For example, if `x` is + set to 1, `xref` to "paper" and `xanchor` to "right" + then the right-most portion of the annotation lines up + with the right-most edge of the plotting area. If + "auto", the anchor is equivalent to "center" for data- + referenced annotations or if there is an arrow, whereas + for paper-referenced with no arrow, the anchor picked + corresponds to the closest side. + xshift + Shifts the position of the whole annotation and arrow + to the right (positive) or left (negative) by this many + pixels. + y + Sets the annotation's y position. + yanchor + Sets the text box's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the annotation. For example, if `y` is set + to 1, `yref` to "paper" and `yanchor` to "top" then the + top-most portion of the annotation lines up with the + top-most edge of the plotting area. If "auto", the + anchor is equivalent to "middle" for data-referenced + annotations or if there is an arrow, whereas for paper- + referenced with no arrow, the anchor picked corresponds + to the closest side. + yshift + Shifts the position of the whole annotation and arrow + up (positive) or down (negative) by this many pixels. + z + Sets the annotation's z position. + """ + + def __init__( + self, + arg=None, + align=None, + arrowcolor=None, + arrowhead=None, + arrowside=None, + arrowsize=None, + arrowwidth=None, + ax=None, + ay=None, + bgcolor=None, + bordercolor=None, + borderpad=None, + borderwidth=None, + captureevents=None, + font=None, + height=None, + hoverlabel=None, + hovertext=None, + name=None, + opacity=None, + showarrow=None, + standoff=None, + startarrowhead=None, + startarrowsize=None, + startstandoff=None, + templateitemname=None, + text=None, + textangle=None, + valign=None, + visible=None, + width=None, + x=None, + xanchor=None, + xshift=None, + y=None, + yanchor=None, + yshift=None, + z=None, + **kwargs + ): + """ + Construct a new Annotation object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.Annotation + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans more two or + more lines (i.e. `text` contains one or more
HTML + tags) or if an explicit width is set to override the + text width. + arrowcolor + Sets the color of the annotation arrow. + arrowhead + Sets the end annotation arrow head style. + arrowside + Sets the annotation arrow head position. + arrowsize + Sets the size of the end annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + arrowwidth + Sets the width (in px) of annotation arrow line. + ax + Sets the x component of the arrow tail about the arrow + head (in pixels). + ay + Sets the y component of the arrow tail about the arrow + head (in pixels). + bgcolor + Sets the background color of the annotation. + bordercolor + Sets the color of the border enclosing the annotation + `text`. + borderpad + Sets the padding (in px) between the `text` and the + enclosing border. + borderwidth + Sets the width (in px) of the border enclosing the + annotation `text`. + captureevents + Determines whether the annotation text box captures + mouse move and click events, or allows those events to + pass through to data points in the plot that may be + behind the annotation. By default `captureevents` is + False unless `hovertext` is provided. If you use the + event `plotly_clickannotation` without `hovertext` you + must explicitly enable `captureevents`. + font + Sets the annotation text font. + height + Sets an explicit height for the text box. null + (default) lets the text set the box height. Taller text + will be clipped. + hoverlabel + plotly.graph_objs.layout.scene.annotation.Hoverlabel + instance or dict with compatible properties + hovertext + Sets text to appear when hovering over this annotation. + If omitted or blank, no hover label will appear. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the annotation (text + arrow). + showarrow + Determines whether or not the annotation is drawn with + an arrow. If True, `text` is placed near the arrow's + tail. If False, `text` lines up with the `x` and `y` + provided. + standoff + Sets a distance, in pixels, to move the end arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + startarrowhead + Sets the start annotation arrow head style. + startarrowsize + Sets the size of the start annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + startstandoff + Sets a distance, in pixels, to move the start arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + text + Sets the text associated with this annotation. Plotly + uses a subset of HTML tags to do things like newline + (
), bold (), italics (), hyperlinks + (). Tags , , + are also supported. + textangle + Sets the angle at which the `text` is drawn with + respect to the horizontal. + valign + Sets the vertical alignment of the `text` within the + box. Has an effect only if an explicit height is set to + override the text height. + visible + Determines whether or not this annotation is visible. + width + Sets an explicit width for the text box. null (default) + lets the text set the box width. Wider text will be + clipped. There is no automatic wrapping; use
to + start a new line. + x + Sets the annotation's x position. + xanchor + Sets the text box's horizontal position anchor This + anchor binds the `x` position to the "left", "center" + or "right" of the annotation. For example, if `x` is + set to 1, `xref` to "paper" and `xanchor` to "right" + then the right-most portion of the annotation lines up + with the right-most edge of the plotting area. If + "auto", the anchor is equivalent to "center" for data- + referenced annotations or if there is an arrow, whereas + for paper-referenced with no arrow, the anchor picked + corresponds to the closest side. + xshift + Shifts the position of the whole annotation and arrow + to the right (positive) or left (negative) by this many + pixels. + y + Sets the annotation's y position. + yanchor + Sets the text box's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the annotation. For example, if `y` is set + to 1, `yref` to "paper" and `yanchor` to "top" then the + top-most portion of the annotation lines up with the + top-most edge of the plotting area. If "auto", the + anchor is equivalent to "middle" for data-referenced + annotations or if there is an arrow, whereas for paper- + referenced with no arrow, the anchor picked corresponds + to the closest side. + yshift + Shifts the position of the whole annotation and arrow + up (positive) or down (negative) by this many pixels. + z + Sets the annotation's z position. + + Returns + ------- + Annotation + """ + super(Annotation, self).__init__('annotations') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.Annotation +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.Annotation""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene import (annotation as v_annotation) + + # Initialize validators + # --------------------- + self._validators['align'] = v_annotation.AlignValidator() + self._validators['arrowcolor'] = v_annotation.ArrowcolorValidator() + self._validators['arrowhead'] = v_annotation.ArrowheadValidator() + self._validators['arrowside'] = v_annotation.ArrowsideValidator() + self._validators['arrowsize'] = v_annotation.ArrowsizeValidator() + self._validators['arrowwidth'] = v_annotation.ArrowwidthValidator() + self._validators['ax'] = v_annotation.AxValidator() + self._validators['ay'] = v_annotation.AyValidator() + self._validators['bgcolor'] = v_annotation.BgcolorValidator() + self._validators['bordercolor'] = v_annotation.BordercolorValidator() + self._validators['borderpad'] = v_annotation.BorderpadValidator() + self._validators['borderwidth'] = v_annotation.BorderwidthValidator() + self._validators['captureevents' + ] = v_annotation.CaptureeventsValidator() + self._validators['font'] = v_annotation.FontValidator() + self._validators['height'] = v_annotation.HeightValidator() + self._validators['hoverlabel'] = v_annotation.HoverlabelValidator() + self._validators['hovertext'] = v_annotation.HovertextValidator() + self._validators['name'] = v_annotation.NameValidator() + self._validators['opacity'] = v_annotation.OpacityValidator() + self._validators['showarrow'] = v_annotation.ShowarrowValidator() + self._validators['standoff'] = v_annotation.StandoffValidator() + self._validators['startarrowhead' + ] = v_annotation.StartarrowheadValidator() + self._validators['startarrowsize' + ] = v_annotation.StartarrowsizeValidator() + self._validators['startstandoff' + ] = v_annotation.StartstandoffValidator() + self._validators['templateitemname' + ] = v_annotation.TemplateitemnameValidator() + self._validators['text'] = v_annotation.TextValidator() + self._validators['textangle'] = v_annotation.TextangleValidator() + self._validators['valign'] = v_annotation.ValignValidator() + self._validators['visible'] = v_annotation.VisibleValidator() + self._validators['width'] = v_annotation.WidthValidator() + self._validators['x'] = v_annotation.XValidator() + self._validators['xanchor'] = v_annotation.XanchorValidator() + self._validators['xshift'] = v_annotation.XshiftValidator() + self._validators['y'] = v_annotation.YValidator() + self._validators['yanchor'] = v_annotation.YanchorValidator() + self._validators['yshift'] = v_annotation.YshiftValidator() + self._validators['z'] = v_annotation.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('align', None) + self['align'] = align if align is not None else _v + _v = arg.pop('arrowcolor', None) + self['arrowcolor'] = arrowcolor if arrowcolor is not None else _v + _v = arg.pop('arrowhead', None) + self['arrowhead'] = arrowhead if arrowhead is not None else _v + _v = arg.pop('arrowside', None) + self['arrowside'] = arrowside if arrowside is not None else _v + _v = arg.pop('arrowsize', None) + self['arrowsize'] = arrowsize if arrowsize is not None else _v + _v = arg.pop('arrowwidth', None) + self['arrowwidth'] = arrowwidth if arrowwidth is not None else _v + _v = arg.pop('ax', None) + self['ax'] = ax if ax is not None else _v + _v = arg.pop('ay', None) + self['ay'] = ay if ay is not None else _v + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderpad', None) + self['borderpad'] = borderpad if borderpad is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('captureevents', None) + self['captureevents' + ] = captureevents if captureevents is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('height', None) + self['height'] = height if height is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertext', None) + self['hovertext'] = hovertext if hovertext is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('showarrow', None) + self['showarrow'] = showarrow if showarrow is not None else _v + _v = arg.pop('standoff', None) + self['standoff'] = standoff if standoff is not None else _v + _v = arg.pop('startarrowhead', None) + self['startarrowhead' + ] = startarrowhead if startarrowhead is not None else _v + _v = arg.pop('startarrowsize', None) + self['startarrowsize' + ] = startarrowsize if startarrowsize is not None else _v + _v = arg.pop('startstandoff', None) + self['startstandoff' + ] = startstandoff if startstandoff is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + _v = arg.pop('textangle', None) + self['textangle'] = textangle if textangle is not None else _v + _v = arg.pop('valign', None) + self['valign'] = valign if valign is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xshift', None) + self['xshift'] = xshift if xshift is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('yshift', None) + self['yshift'] = yshift if yshift is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.scene import zaxis -from ._yaxis import YAxis from plotly.graph_objs.layout.scene import yaxis -from ._xaxis import XAxis from plotly.graph_objs.layout.scene import xaxis -from ._domain import Domain -from ._camera import Camera from plotly.graph_objs.layout.scene import camera -from ._aspectratio import Aspectratio -from ._annotation import Annotation from plotly.graph_objs.layout.scene import annotation diff --git a/plotly/graph_objs/layout/scene/_annotation.py b/plotly/graph_objs/layout/scene/_annotation.py deleted file mode 100644 index 70e99060161..00000000000 --- a/plotly/graph_objs/layout/scene/_annotation.py +++ /dev/null @@ -1,1524 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Annotation(BaseLayoutHierarchyType): - - # align - # ----- - @property - def align(self): - """ - Sets the horizontal alignment of the `text` within the box. Has - an effect only if `text` spans more 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'] - - Returns - ------- - Any - """ - return self['align'] - - @align.setter - def align(self, val): - self['align'] = val - - # arrowcolor - # ---------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['arrowcolor'] - - @arrowcolor.setter - def arrowcolor(self, val): - self['arrowcolor'] = val - - # arrowhead - # --------- - @property - 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] - - Returns - ------- - int - """ - return self['arrowhead'] - - @arrowhead.setter - def arrowhead(self, val): - self['arrowhead'] = val - - # arrowside - # --------- - @property - 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 - (e.g. 'end+start') - OR exactly one of ['none'] (e.g. 'none') - - Returns - ------- - Any - """ - return self['arrowside'] - - @arrowside.setter - def arrowside(self, val): - self['arrowside'] = val - - # arrowsize - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['arrowsize'] - - @arrowsize.setter - def arrowsize(self, val): - self['arrowsize'] = val - - # arrowwidth - # ---------- - @property - 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] - - Returns - ------- - int|float - """ - return self['arrowwidth'] - - @arrowwidth.setter - def arrowwidth(self, val): - self['arrowwidth'] = val - - # ax - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['ax'] - - @ax.setter - def ax(self, val): - self['ax'] = val - - # ay - # -- - @property - 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 - - Returns - ------- - int|float - """ - return self['ay'] - - @ay.setter - def ay(self, val): - self['ay'] = val - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderpad - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderpad'] - - @borderpad.setter - def borderpad(self, val): - self['borderpad'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # captureevents - # ------------- - @property - def captureevents(self): - """ - Determines whether the annotation text box captures mouse move - and click events, or allows those events to pass through to - data points in the plot that may be behind the annotation. By - default `captureevents` is False unless `hovertext` is - provided. If you use the event `plotly_clickannotation` without - `hovertext` you must explicitly enable `captureevents`. - - The 'captureevents' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['captureevents'] - - @captureevents.setter - def captureevents(self, val): - self['captureevents'] = val - - # font - # ---- - @property - def font(self): - """ - Sets the annotation text font. - - The 'font' property is an instance of Font - that may be specified as: - - An instance of 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.scene.annotation.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # height - # ------ - @property - 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] - - Returns - ------- - int|float - """ - return self['height'] - - @height.setter - def height(self, val): - self['height'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of 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 - opaque, or white if it was transparent. - bordercolor - Sets the border color of the hover label. By - default uses either dark grey or white, for - maximum contrast with `hoverlabel.bgcolor`. - font - Sets the hover label text font. By default uses - the global hover font and size, with color from - `hoverlabel.bordercolor`. - - Returns - ------- - plotly.graph_objs.layout.scene.annotation.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertext - # --------- - @property - 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 - - Returns - ------- - str - """ - return self['hovertext'] - - @hovertext.setter - def hovertext(self, val): - self['hovertext'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # showarrow - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showarrow'] - - @showarrow.setter - def showarrow(self, val): - self['showarrow'] = val - - # standoff - # -------- - @property - def standoff(self): - """ - Sets a distance, in pixels, to move the end arrowhead away from - the position it is pointing at, for example to point at the - edge of a marker independent of zoom. Note that this shortens - the arrow from the `ax` / `ay` vector, in contrast to `xshift` - / `yshift` which moves everything by this amount. - - The 'standoff' property is a number and may be specified as: - - An int or float in the interval [0, inf] - - Returns - ------- - int|float - """ - return self['standoff'] - - @standoff.setter - def standoff(self, val): - self['standoff'] = val - - # startarrowhead - # -------------- - @property - 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] - - Returns - ------- - int - """ - return self['startarrowhead'] - - @startarrowhead.setter - def startarrowhead(self, val): - self['startarrowhead'] = val - - # startarrowsize - # -------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['startarrowsize'] - - @startarrowsize.setter - def startarrowsize(self, val): - self['startarrowsize'] = val - - # startstandoff - # ------------- - @property - def startstandoff(self): - """ - Sets a distance, in pixels, to move the start arrowhead away - from the position it is pointing at, for example to point at - the edge of a marker independent of zoom. Note that this - shortens the arrow from the `ax` / `ay` vector, in contrast to - `xshift` / `yshift` which moves everything by this amount. - - The 'startstandoff' property is a number and may be specified as: - - An int or float in the interval [0, inf] - - Returns - ------- - int|float - """ - return self['startstandoff'] - - @startstandoff.setter - def startstandoff(self, val): - self['startstandoff'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # text - # ---- - @property - def text(self): - """ - Sets the text associated with this annotation. Plotly uses a - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # textangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['textangle'] - - @textangle.setter - def textangle(self, val): - self['textangle'] = val - - # valign - # ------ - @property - 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'] - - Returns - ------- - Any - """ - return self['valign'] - - @valign.setter - def valign(self, val): - self['valign'] = val - - # visible - # ------- - @property - def visible(self): - """ - Determines whether or not this annotation is visible. - - The 'visible' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # x - # - - @property - def x(self): - """ - Sets the annotation's x position. - - The 'x' property accepts values of any type - - Returns - ------- - Any - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - def xanchor(self): - """ - Sets the text box's horizontal position anchor This anchor - binds the `x` position to the "left", "center" or "right" of - the annotation. For example, if `x` is set to 1, `xref` to - "paper" and `xanchor` to "right" then the right-most portion of - the annotation lines up with the right-most edge of the - plotting area. If "auto", the anchor is equivalent to "center" - for data-referenced annotations or if there is an arrow, - whereas for paper-referenced with no arrow, the anchor picked - corresponds to the closest side. - - The 'xanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'left', 'center', 'right'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xshift - # ------ - @property - 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 - - Returns - ------- - int|float - """ - return self['xshift'] - - @xshift.setter - def xshift(self, val): - self['xshift'] = val - - # y - # - - @property - def y(self): - """ - Sets the annotation's y position. - - The 'y' property accepts values of any type - - Returns - ------- - Any - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - def yanchor(self): - """ - Sets the text box's vertical position anchor This anchor binds - the `y` position to the "top", "middle" or "bottom" of the - annotation. For example, if `y` is set to 1, `yref` to "paper" - and `yanchor` to "top" then the top-most portion of the - annotation lines up with the top-most edge of the plotting - area. If "auto", the anchor is equivalent to "middle" for data- - referenced annotations or if there is an arrow, whereas for - paper-referenced with no arrow, the anchor picked corresponds - to the closest side. - - The 'yanchor' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'top', 'middle', 'bottom'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # yshift - # ------ - @property - 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 - - Returns - ------- - int|float - """ - return self['yshift'] - - @yshift.setter - def yshift(self, val): - self['yshift'] = val - - # z - # - - @property - def z(self): - """ - Sets the annotation's z position. - - The 'z' property accepts values of any type - - Returns - ------- - Any - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - align - Sets the horizontal alignment of the `text` within the - box. Has an effect only if `text` spans more two or - more lines (i.e. `text` contains one or more
HTML - tags) or if an explicit width is set to override the - text width. - arrowcolor - Sets the color of the annotation arrow. - arrowhead - Sets the end annotation arrow head style. - arrowside - Sets the annotation arrow head position. - arrowsize - Sets the size of the end annotation arrow head, - relative to `arrowwidth`. A value of 1 (default) gives - a head about 3x as wide as the line. - arrowwidth - Sets the width (in px) of annotation arrow line. - ax - Sets the x component of the arrow tail about the arrow - head (in pixels). - ay - Sets the y component of the arrow tail about the arrow - head (in pixels). - bgcolor - Sets the background color of the annotation. - bordercolor - Sets the color of the border enclosing the annotation - `text`. - borderpad - Sets the padding (in px) between the `text` and the - enclosing border. - borderwidth - Sets the width (in px) of the border enclosing the - annotation `text`. - captureevents - Determines whether the annotation text box captures - mouse move and click events, or allows those events to - pass through to data points in the plot that may be - behind the annotation. By default `captureevents` is - False unless `hovertext` is provided. If you use the - event `plotly_clickannotation` without `hovertext` you - must explicitly enable `captureevents`. - font - Sets the annotation text font. - height - Sets an explicit height for the text box. null - (default) lets the text set the box height. Taller text - will be clipped. - hoverlabel - plotly.graph_objs.layout.scene.annotation.Hoverlabel - instance or dict with compatible properties - hovertext - Sets text to appear when hovering over this annotation. - If omitted or blank, no hover label will appear. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - opacity - Sets the opacity of the annotation (text + arrow). - showarrow - Determines whether or not the annotation is drawn with - an arrow. If True, `text` is placed near the arrow's - tail. If False, `text` lines up with the `x` and `y` - provided. - standoff - Sets a distance, in pixels, to move the end arrowhead - away from the position it is pointing at, for example - to point at the edge of a marker independent of zoom. - Note that this shortens the arrow from the `ax` / `ay` - vector, in contrast to `xshift` / `yshift` which moves - everything by this amount. - startarrowhead - Sets the start annotation arrow head style. - startarrowsize - Sets the size of the start annotation arrow head, - relative to `arrowwidth`. A value of 1 (default) gives - a head about 3x as wide as the line. - startstandoff - Sets a distance, in pixels, to move the start arrowhead - away from the position it is pointing at, for example - to point at the edge of a marker independent of zoom. - Note that this shortens the arrow from the `ax` / `ay` - vector, in contrast to `xshift` / `yshift` which moves - everything by this amount. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - text - Sets the text associated with this annotation. Plotly - uses a subset of HTML tags to do things like newline - (
), bold (), italics (), hyperlinks - (). Tags , , - are also supported. - textangle - Sets the angle at which the `text` is drawn with - respect to the horizontal. - valign - Sets the vertical alignment of the `text` within the - box. Has an effect only if an explicit height is set to - override the text height. - visible - Determines whether or not this annotation is visible. - width - Sets an explicit width for the text box. null (default) - lets the text set the box width. Wider text will be - clipped. There is no automatic wrapping; use
to - start a new line. - x - Sets the annotation's x position. - xanchor - Sets the text box's horizontal position anchor This - anchor binds the `x` position to the "left", "center" - or "right" of the annotation. For example, if `x` is - set to 1, `xref` to "paper" and `xanchor` to "right" - then the right-most portion of the annotation lines up - with the right-most edge of the plotting area. If - "auto", the anchor is equivalent to "center" for data- - referenced annotations or if there is an arrow, whereas - for paper-referenced with no arrow, the anchor picked - corresponds to the closest side. - xshift - Shifts the position of the whole annotation and arrow - to the right (positive) or left (negative) by this many - pixels. - y - Sets the annotation's y position. - yanchor - Sets the text box's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the annotation. For example, if `y` is set - to 1, `yref` to "paper" and `yanchor` to "top" then the - top-most portion of the annotation lines up with the - top-most edge of the plotting area. If "auto", the - anchor is equivalent to "middle" for data-referenced - annotations or if there is an arrow, whereas for paper- - referenced with no arrow, the anchor picked corresponds - to the closest side. - yshift - Shifts the position of the whole annotation and arrow - up (positive) or down (negative) by this many pixels. - z - Sets the annotation's z position. - """ - - def __init__( - self, - arg=None, - align=None, - arrowcolor=None, - arrowhead=None, - arrowside=None, - arrowsize=None, - arrowwidth=None, - ax=None, - ay=None, - bgcolor=None, - bordercolor=None, - borderpad=None, - borderwidth=None, - captureevents=None, - font=None, - height=None, - hoverlabel=None, - hovertext=None, - name=None, - opacity=None, - showarrow=None, - standoff=None, - startarrowhead=None, - startarrowsize=None, - startstandoff=None, - templateitemname=None, - text=None, - textangle=None, - valign=None, - visible=None, - width=None, - x=None, - xanchor=None, - xshift=None, - y=None, - yanchor=None, - yshift=None, - z=None, - **kwargs - ): - """ - Construct a new Annotation object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.Annotation - align - Sets the horizontal alignment of the `text` within the - box. Has an effect only if `text` spans more two or - more lines (i.e. `text` contains one or more
HTML - tags) or if an explicit width is set to override the - text width. - arrowcolor - Sets the color of the annotation arrow. - arrowhead - Sets the end annotation arrow head style. - arrowside - Sets the annotation arrow head position. - arrowsize - Sets the size of the end annotation arrow head, - relative to `arrowwidth`. A value of 1 (default) gives - a head about 3x as wide as the line. - arrowwidth - Sets the width (in px) of annotation arrow line. - ax - Sets the x component of the arrow tail about the arrow - head (in pixels). - ay - Sets the y component of the arrow tail about the arrow - head (in pixels). - bgcolor - Sets the background color of the annotation. - bordercolor - Sets the color of the border enclosing the annotation - `text`. - borderpad - Sets the padding (in px) between the `text` and the - enclosing border. - borderwidth - Sets the width (in px) of the border enclosing the - annotation `text`. - captureevents - Determines whether the annotation text box captures - mouse move and click events, or allows those events to - pass through to data points in the plot that may be - behind the annotation. By default `captureevents` is - False unless `hovertext` is provided. If you use the - event `plotly_clickannotation` without `hovertext` you - must explicitly enable `captureevents`. - font - Sets the annotation text font. - height - Sets an explicit height for the text box. null - (default) lets the text set the box height. Taller text - will be clipped. - hoverlabel - plotly.graph_objs.layout.scene.annotation.Hoverlabel - instance or dict with compatible properties - hovertext - Sets text to appear when hovering over this annotation. - If omitted or blank, no hover label will appear. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - opacity - Sets the opacity of the annotation (text + arrow). - showarrow - Determines whether or not the annotation is drawn with - an arrow. If True, `text` is placed near the arrow's - tail. If False, `text` lines up with the `x` and `y` - provided. - standoff - Sets a distance, in pixels, to move the end arrowhead - away from the position it is pointing at, for example - to point at the edge of a marker independent of zoom. - Note that this shortens the arrow from the `ax` / `ay` - vector, in contrast to `xshift` / `yshift` which moves - everything by this amount. - startarrowhead - Sets the start annotation arrow head style. - startarrowsize - Sets the size of the start annotation arrow head, - relative to `arrowwidth`. A value of 1 (default) gives - a head about 3x as wide as the line. - startstandoff - Sets a distance, in pixels, to move the start arrowhead - away from the position it is pointing at, for example - to point at the edge of a marker independent of zoom. - Note that this shortens the arrow from the `ax` / `ay` - vector, in contrast to `xshift` / `yshift` which moves - everything by this amount. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - text - Sets the text associated with this annotation. Plotly - uses a subset of HTML tags to do things like newline - (
), bold (), italics (), hyperlinks - (). Tags , , - are also supported. - textangle - Sets the angle at which the `text` is drawn with - respect to the horizontal. - valign - Sets the vertical alignment of the `text` within the - box. Has an effect only if an explicit height is set to - override the text height. - visible - Determines whether or not this annotation is visible. - width - Sets an explicit width for the text box. null (default) - lets the text set the box width. Wider text will be - clipped. There is no automatic wrapping; use
to - start a new line. - x - Sets the annotation's x position. - xanchor - Sets the text box's horizontal position anchor This - anchor binds the `x` position to the "left", "center" - or "right" of the annotation. For example, if `x` is - set to 1, `xref` to "paper" and `xanchor` to "right" - then the right-most portion of the annotation lines up - with the right-most edge of the plotting area. If - "auto", the anchor is equivalent to "center" for data- - referenced annotations or if there is an arrow, whereas - for paper-referenced with no arrow, the anchor picked - corresponds to the closest side. - xshift - Shifts the position of the whole annotation and arrow - to the right (positive) or left (negative) by this many - pixels. - y - Sets the annotation's y position. - yanchor - Sets the text box's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the annotation. For example, if `y` is set - to 1, `yref` to "paper" and `yanchor` to "top" then the - top-most portion of the annotation lines up with the - top-most edge of the plotting area. If "auto", the - anchor is equivalent to "middle" for data-referenced - annotations or if there is an arrow, whereas for paper- - referenced with no arrow, the anchor picked corresponds - to the closest side. - yshift - Shifts the position of the whole annotation and arrow - up (positive) or down (negative) by this many pixels. - z - Sets the annotation's z position. - - Returns - ------- - Annotation - """ - super(Annotation, self).__init__('annotations') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.Annotation -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.Annotation""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene import (annotation as v_annotation) - - # Initialize validators - # --------------------- - self._validators['align'] = v_annotation.AlignValidator() - self._validators['arrowcolor'] = v_annotation.ArrowcolorValidator() - self._validators['arrowhead'] = v_annotation.ArrowheadValidator() - self._validators['arrowside'] = v_annotation.ArrowsideValidator() - self._validators['arrowsize'] = v_annotation.ArrowsizeValidator() - self._validators['arrowwidth'] = v_annotation.ArrowwidthValidator() - self._validators['ax'] = v_annotation.AxValidator() - self._validators['ay'] = v_annotation.AyValidator() - self._validators['bgcolor'] = v_annotation.BgcolorValidator() - self._validators['bordercolor'] = v_annotation.BordercolorValidator() - self._validators['borderpad'] = v_annotation.BorderpadValidator() - self._validators['borderwidth'] = v_annotation.BorderwidthValidator() - self._validators['captureevents' - ] = v_annotation.CaptureeventsValidator() - self._validators['font'] = v_annotation.FontValidator() - self._validators['height'] = v_annotation.HeightValidator() - self._validators['hoverlabel'] = v_annotation.HoverlabelValidator() - self._validators['hovertext'] = v_annotation.HovertextValidator() - self._validators['name'] = v_annotation.NameValidator() - self._validators['opacity'] = v_annotation.OpacityValidator() - self._validators['showarrow'] = v_annotation.ShowarrowValidator() - self._validators['standoff'] = v_annotation.StandoffValidator() - self._validators['startarrowhead' - ] = v_annotation.StartarrowheadValidator() - self._validators['startarrowsize' - ] = v_annotation.StartarrowsizeValidator() - self._validators['startstandoff' - ] = v_annotation.StartstandoffValidator() - self._validators['templateitemname' - ] = v_annotation.TemplateitemnameValidator() - self._validators['text'] = v_annotation.TextValidator() - self._validators['textangle'] = v_annotation.TextangleValidator() - self._validators['valign'] = v_annotation.ValignValidator() - self._validators['visible'] = v_annotation.VisibleValidator() - self._validators['width'] = v_annotation.WidthValidator() - self._validators['x'] = v_annotation.XValidator() - self._validators['xanchor'] = v_annotation.XanchorValidator() - self._validators['xshift'] = v_annotation.XshiftValidator() - self._validators['y'] = v_annotation.YValidator() - self._validators['yanchor'] = v_annotation.YanchorValidator() - self._validators['yshift'] = v_annotation.YshiftValidator() - self._validators['z'] = v_annotation.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('align', None) - self['align'] = align if align is not None else _v - _v = arg.pop('arrowcolor', None) - self['arrowcolor'] = arrowcolor if arrowcolor is not None else _v - _v = arg.pop('arrowhead', None) - self['arrowhead'] = arrowhead if arrowhead is not None else _v - _v = arg.pop('arrowside', None) - self['arrowside'] = arrowside if arrowside is not None else _v - _v = arg.pop('arrowsize', None) - self['arrowsize'] = arrowsize if arrowsize is not None else _v - _v = arg.pop('arrowwidth', None) - self['arrowwidth'] = arrowwidth if arrowwidth is not None else _v - _v = arg.pop('ax', None) - self['ax'] = ax if ax is not None else _v - _v = arg.pop('ay', None) - self['ay'] = ay if ay is not None else _v - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderpad', None) - self['borderpad'] = borderpad if borderpad is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('captureevents', None) - self['captureevents' - ] = captureevents if captureevents is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('height', None) - self['height'] = height if height is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertext', None) - self['hovertext'] = hovertext if hovertext is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('showarrow', None) - self['showarrow'] = showarrow if showarrow is not None else _v - _v = arg.pop('standoff', None) - self['standoff'] = standoff if standoff is not None else _v - _v = arg.pop('startarrowhead', None) - self['startarrowhead' - ] = startarrowhead if startarrowhead is not None else _v - _v = arg.pop('startarrowsize', None) - self['startarrowsize' - ] = startarrowsize if startarrowsize is not None else _v - _v = arg.pop('startstandoff', None) - self['startstandoff' - ] = startstandoff if startstandoff is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - _v = arg.pop('textangle', None) - self['textangle'] = textangle if textangle is not None else _v - _v = arg.pop('valign', None) - self['valign'] = valign if valign is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xshift', None) - self['xshift'] = xshift if xshift is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('yshift', None) - self['yshift'] = yshift if yshift is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/_aspectratio.py b/plotly/graph_objs/layout/scene/_aspectratio.py deleted file mode 100644 index 8d612df9b06..00000000000 --- a/plotly/graph_objs/layout/scene/_aspectratio.py +++ /dev/null @@ -1,152 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Aspectratio(BaseLayoutHierarchyType): - - # x - # - - @property - def x(self): - """ - The 'x' property is a number and may be specified as: - - An int or float in the interval [0, inf] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @property - def y(self): - """ - The 'y' property is a number and may be specified as: - - An int or float in the interval [0, inf] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # z - # - - @property - def z(self): - """ - The 'z' property is a number and may be specified as: - - An int or float in the interval [0, inf] - - Returns - ------- - int|float - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - - y - - z - - """ - - def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): - """ - Construct a new Aspectratio object - - Sets this scene's axis aspectratio. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.Aspectratio - x - - y - - z - - - Returns - ------- - Aspectratio - """ - super(Aspectratio, self).__init__('aspectratio') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.Aspectratio -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.Aspectratio""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene import ( - aspectratio as v_aspectratio - ) - - # Initialize validators - # --------------------- - self._validators['x'] = v_aspectratio.XValidator() - self._validators['y'] = v_aspectratio.YValidator() - self._validators['z'] = v_aspectratio.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/_camera.py b/plotly/graph_objs/layout/scene/_camera.py deleted file mode 100644 index 8befbe8263d..00000000000 --- a/plotly/graph_objs/layout/scene/_camera.py +++ /dev/null @@ -1,254 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Camera(BaseLayoutHierarchyType): - - # center - # ------ - @property - 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 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 - ------- - plotly.graph_objs.layout.scene.camera.Center - """ - return self['center'] - - @center.setter - def center(self, val): - self['center'] = val - - # eye - # --- - @property - 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 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 - ------- - plotly.graph_objs.layout.scene.camera.Eye - """ - return self['eye'] - - @eye.setter - def eye(self, val): - self['eye'] = val - - # projection - # ---------- - @property - def projection(self): - """ - The 'projection' property is an instance of Projection - that may be specified as: - - An instance of 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 - "orthographic". The default is "perspective". - - Returns - ------- - plotly.graph_objs.layout.scene.camera.Projection - """ - return self['projection'] - - @projection.setter - def projection(self, val): - self['projection'] = val - - # up - # -- - @property - def up(self): - """ - 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 - that the z axis points up. - - The 'up' property is an instance of Up - that may be specified as: - - An instance of 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 - ------- - plotly.graph_objs.layout.scene.camera.Up - """ - return self['up'] - - @up.setter - def up(self, val): - self['up'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - center - 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. - eye - Sets the (x,y,z) components of the 'eye' camera vector. - This vector determines the view point about the origin - of this scene. - projection - plotly.graph_objs.layout.scene.camera.Projection - instance or dict with compatible properties - up - 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 that the z axis points up. - """ - - def __init__( - self, - arg=None, - center=None, - eye=None, - projection=None, - up=None, - **kwargs - ): - """ - Construct a new Camera object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.scene.Camera - center - 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. - eye - Sets the (x,y,z) components of the 'eye' camera vector. - This vector determines the view point about the origin - of this scene. - projection - plotly.graph_objs.layout.scene.camera.Projection - instance or dict with compatible properties - up - 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 that the z axis points up. - - Returns - ------- - Camera - """ - super(Camera, self).__init__('camera') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.Camera -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.Camera""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene import (camera as v_camera) - - # Initialize validators - # --------------------- - self._validators['center'] = v_camera.CenterValidator() - self._validators['eye'] = v_camera.EyeValidator() - self._validators['projection'] = v_camera.ProjectionValidator() - self._validators['up'] = v_camera.UpValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('center', None) - self['center'] = center if center is not None else _v - _v = arg.pop('eye', None) - self['eye'] = eye if eye is not None else _v - _v = arg.pop('projection', None) - self['projection'] = projection if projection is not None else _v - _v = arg.pop('up', None) - self['up'] = up if up is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/_domain.py b/plotly/graph_objs/layout/scene/_domain.py deleted file mode 100644 index 37276ef8e25..00000000000 --- a/plotly/graph_objs/layout/scene/_domain.py +++ /dev/null @@ -1,206 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Domain(BaseLayoutHierarchyType): - - # column - # ------ - @property - 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] - - Returns - ------- - int - """ - return self['column'] - - @column.setter - def column(self, val): - self['column'] = val - - # row - # --- - @property - 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] - - Returns - ------- - int - """ - return self['row'] - - @row.setter - def row(self, val): - self['row'] = val - - # x - # - - @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] - - Returns - ------- - list - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @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] - - Returns - ------- - list - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - column - If there is a layout grid, use the domain for this - column in the grid for this scene subplot . - row - If there is a layout grid, use the domain for this row - in the grid for this scene subplot . - x - Sets the horizontal domain of this scene subplot (in - plot fraction). - y - Sets the vertical domain of this scene subplot (in plot - fraction). - """ - - def __init__( - self, arg=None, column=None, row=None, x=None, y=None, **kwargs - ): - """ - Construct a new Domain object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.scene.Domain - column - If there is a layout grid, use the domain for this - column in the grid for this scene subplot . - row - If there is a layout grid, use the domain for this row - in the grid for this scene subplot . - x - Sets the horizontal domain of this scene subplot (in - plot fraction). - y - Sets the vertical domain of this scene subplot (in plot - fraction). - - Returns - ------- - Domain - """ - super(Domain, self).__init__('domain') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.Domain -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.Domain""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene import (domain as v_domain) - - # Initialize validators - # --------------------- - self._validators['column'] = v_domain.ColumnValidator() - self._validators['row'] = v_domain.RowValidator() - self._validators['x'] = v_domain.XValidator() - self._validators['y'] = v_domain.YValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('column', None) - self['column'] = column if column is not None else _v - _v = arg.pop('row', None) - self['row'] = row if row is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/_xaxis.py b/plotly/graph_objs/layout/scene/_xaxis.py deleted file mode 100644 index 266ecb9c611..00000000000 --- a/plotly/graph_objs/layout/scene/_xaxis.py +++ /dev/null @@ -1,2443 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class XAxis(BaseLayoutHierarchyType): - - # autorange - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['autorange'] - - @autorange.setter - def autorange(self, val): - self['autorange'] = val - - # backgroundcolor - # --------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['backgroundcolor'] - - @backgroundcolor.setter - def backgroundcolor(self, val): - self['backgroundcolor'] = val - - # calendar - # -------- - @property - def calendar(self): - """ - Sets the calendar system to use for `range` and `tick0` if this - is a date axis. This does not set the calendar for interpreting - data on this axis, that's specified in the trace or via the - global `layout.calendar` - - The 'calendar' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['gregorian', 'chinese', 'coptic', 'discworld', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['calendar'] - - @calendar.setter - def calendar(self, val): - self['calendar'] = val - - # categoryarray - # ------------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['categoryarray'] - - @categoryarray.setter - def categoryarray(self, val): - self['categoryarray'] = val - - # categoryarraysrc - # ---------------- - @property - def categoryarraysrc(self): - """ - Sets the source reference on plot.ly for categoryarray . - - The 'categoryarraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['categoryarraysrc'] - - @categoryarraysrc.setter - def categoryarraysrc(self, val): - self['categoryarraysrc'] = val - - # categoryorder - # ------------- - @property - def categoryorder(self): - """ - Specifies the ordering logic for the case of categorical - variables. By default, plotly uses "trace", which specifies the - order that is present in the data supplied. Set `categoryorder` - to *category ascending* or *category descending* if order - should be determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" to derive the - ordering from the attribute `categoryarray`. If a category is - not found in the `categoryarray` array, the sorting behavior - for that attribute will be identical to the "trace" mode. The - unspecified categories will follow the categories in - `categoryarray`. - - The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array'] - - Returns - ------- - Any - """ - return self['categoryorder'] - - @categoryorder.setter - def categoryorder(self, val): - self['categoryorder'] = val - - # color - # ----- - @property - def color(self): - """ - Sets default for all colors associated with this axis all at - once: line, font, tick, and grid colors. Grid color is - lightened by blending this with the plot background Individual - pieces can override this. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # gridcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['gridcolor'] - - @gridcolor.setter - def gridcolor(self, val): - self['gridcolor'] = val - - # gridwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['gridwidth'] - - @gridwidth.setter - def gridwidth(self, val): - self['gridwidth'] = val - - # hoverformat - # ----------- - @property - def hoverformat(self): - """ - Sets the hover text formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'hoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['hoverformat'] - - @hoverformat.setter - def hoverformat(self, val): - self['hoverformat'] = val - - # linecolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['linecolor'] - - @linecolor.setter - def linecolor(self, val): - self['linecolor'] = val - - # linewidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['linewidth'] - - @linewidth.setter - def linewidth(self, val): - self['linewidth'] = val - - # mirror - # ------ - @property - def mirror(self): - """ - Determines if the axis lines or/and ticks are mirrored to the - opposite side of the plotting area. If True, the axis lines are - mirrored. If "ticks", the axis lines and ticks are mirrored. If - False, mirroring is disable. If "all", axis lines are mirrored - on all shared-axes subplots. If "allticks", axis lines and - ticks are mirrored on all shared-axes subplots. - - The 'mirror' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, 'ticks', False, 'all', 'allticks'] - - Returns - ------- - Any - """ - return self['mirror'] - - @mirror.setter - def mirror(self, val): - self['mirror'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # range - # ----- - @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 - - Returns - ------- - list - """ - return self['range'] - - @range.setter - def range(self, val): - self['range'] = val - - # rangemode - # --------- - @property - def rangemode(self): - """ - If "normal", the range is computed in relation to the extrema - of the input data. If *tozero*`, the range extends to 0, - regardless of the input data If "nonnegative", the range is - non-negative, regardless of the input data. Applies only to - linear axes. - - The 'rangemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'tozero', 'nonnegative'] - - Returns - ------- - Any - """ - return self['rangemode'] - - @rangemode.setter - def rangemode(self, val): - self['rangemode'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showaxeslabels - # -------------- - @property - def showaxeslabels(self): - """ - Sets whether or not this axis is labeled - - The 'showaxeslabels' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['showaxeslabels'] - - @showaxeslabels.setter - def showaxeslabels(self, val): - self['showaxeslabels'] = val - - # showbackground - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showbackground'] - - @showbackground.setter - def showbackground(self, val): - self['showbackground'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showgrid - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showgrid'] - - @showgrid.setter - def showgrid(self, val): - self['showgrid'] = val - - # showline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showline'] - - @showline.setter - def showline(self, val): - self['showline'] = val - - # showspikes - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showspikes'] - - @showspikes.setter - def showspikes(self, val): - self['showspikes'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # spikecolor - # ---------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['spikecolor'] - - @spikecolor.setter - def spikecolor(self, val): - self['spikecolor'] = val - - # spikesides - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['spikesides'] - - @spikesides.setter - def spikesides(self, val): - self['spikesides'] = val - - # spikethickness - # -------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['spikethickness'] - - @spikethickness.setter - def spikethickness(self, val): - self['spikethickness'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - def tickfont(self): - """ - Sets the tick font. - - The 'tickfont' property is an instance of Tickfont - that may be specified as: - - An instance of 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.scene.xaxis.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.layout.scene.xaxis.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as - 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 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 - ------- - plotly.graph_objs.layout.scene.xaxis.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - text - 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. - - Returns - ------- - plotly.graph_objs.layout.scene.xaxis.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # type - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # zeroline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['zeroline'] - - @zeroline.setter - def zeroline(self, val): - self['zeroline'] = val - - # zerolinecolor - # ------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['zerolinecolor'] - - @zerolinecolor.setter - def zerolinecolor(self, val): - self['zerolinecolor'] = val - - # zerolinewidth - # ------------- - @property - 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 - - Returns - ------- - int|float - """ - return self['zerolinewidth'] - - @zerolinewidth.setter - def zerolinewidth(self, val): - self['zerolinewidth'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autorange - Determines whether or not the range of this axis is - computed in relation to the input data. See `rangemode` - for more info. If `range` is provided, then `autorange` - is set to False. - backgroundcolor - Sets the background color of this axis' wall. - calendar - Sets the calendar system to use for `range` and `tick0` - if this is a date axis. This does not set the calendar - for interpreting data on this axis, that's specified in - the trace or via the global `layout.calendar` - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - mirror - Determines if the axis lines or/and ticks are mirrored - to the opposite side of the plotting area. If True, the - axis lines are mirrored. If "ticks", the axis lines and - ticks are mirrored. If False, mirroring is disable. If - "all", axis lines are mirrored on all shared-axes - subplots. If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - range - Sets the range of this axis. If the axis `type` is - "log", then you must take the log of your desired range - (e.g. to set the range from 1 to 100, set the range - from 0 to 2). If the axis `type` is "date", it should - be date strings, like date data, though Date objects - and unix milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order it - appears. - rangemode - If "normal", the range is computed in relation to the - extrema of the input data. If *tozero*`, the range - extends to 0, regardless of the input data If - "nonnegative", the range is non-negative, regardless of - the input data. Applies only to linear axes. - separatethousands - If "true", even 4-digit integers are separated - showaxeslabels - Sets whether or not this axis is labeled - showbackground - Sets whether or not this axis' wall has a background - color. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showspikes - Sets whether or not spikes starting from data points to - this axis' wall are shown on hover. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - spikecolor - Sets the color of the spikes. - spikesides - Sets whether or not spikes extending from the - projection data points to this axis' wall boundaries - are shown on hover. - spikethickness - Sets the thickness (in px) of the spikes. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.scene.xaxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.layout.scen - e.xaxis.tickformatstopdefaults), sets the default - property values to use for elements of - layout.scene.xaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.scene.xaxis.Title instance or - dict with compatible properties - titlefont - 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. - type - Sets the axis type. By default, plotly attempts to - determined the axis type by looking into the data of - the traces that referenced the axis in question. - visible - A single toggle to hide the axis while preserving - interaction like dragging. Default is true when a - cheater plot is present on the axis, otherwise false - zeroline - Determines whether or not a line is drawn at along the - 0 value of this axis. If True, the zero line is drawn - on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. - """ - - _mapped_properties = {'titlefont': ('title', 'font')} - - def __init__( - self, - arg=None, - autorange=None, - backgroundcolor=None, - calendar=None, - categoryarray=None, - categoryarraysrc=None, - categoryorder=None, - color=None, - dtick=None, - exponentformat=None, - gridcolor=None, - gridwidth=None, - hoverformat=None, - linecolor=None, - linewidth=None, - mirror=None, - nticks=None, - range=None, - rangemode=None, - separatethousands=None, - showaxeslabels=None, - showbackground=None, - showexponent=None, - showgrid=None, - showline=None, - showspikes=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - spikecolor=None, - spikesides=None, - spikethickness=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - type=None, - visible=None, - zeroline=None, - zerolinecolor=None, - zerolinewidth=None, - **kwargs - ): - """ - Construct a new XAxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.scene.XAxis - autorange - Determines whether or not the range of this axis is - computed in relation to the input data. See `rangemode` - for more info. If `range` is provided, then `autorange` - is set to False. - backgroundcolor - Sets the background color of this axis' wall. - calendar - Sets the calendar system to use for `range` and `tick0` - if this is a date axis. This does not set the calendar - for interpreting data on this axis, that's specified in - the trace or via the global `layout.calendar` - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - mirror - Determines if the axis lines or/and ticks are mirrored - to the opposite side of the plotting area. If True, the - axis lines are mirrored. If "ticks", the axis lines and - ticks are mirrored. If False, mirroring is disable. If - "all", axis lines are mirrored on all shared-axes - subplots. If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - range - Sets the range of this axis. If the axis `type` is - "log", then you must take the log of your desired range - (e.g. to set the range from 1 to 100, set the range - from 0 to 2). If the axis `type` is "date", it should - be date strings, like date data, though Date objects - and unix milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order it - appears. - rangemode - If "normal", the range is computed in relation to the - extrema of the input data. If *tozero*`, the range - extends to 0, regardless of the input data If - "nonnegative", the range is non-negative, regardless of - the input data. Applies only to linear axes. - separatethousands - If "true", even 4-digit integers are separated - showaxeslabels - Sets whether or not this axis is labeled - showbackground - Sets whether or not this axis' wall has a background - color. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showspikes - Sets whether or not spikes starting from data points to - this axis' wall are shown on hover. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - spikecolor - Sets the color of the spikes. - spikesides - Sets whether or not spikes extending from the - projection data points to this axis' wall boundaries - are shown on hover. - spikethickness - Sets the thickness (in px) of the spikes. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.scene.xaxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.layout.scen - e.xaxis.tickformatstopdefaults), sets the default - property values to use for elements of - layout.scene.xaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.scene.xaxis.Title instance or - dict with compatible properties - titlefont - 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. - type - Sets the axis type. By default, plotly attempts to - determined the axis type by looking into the data of - the traces that referenced the axis in question. - visible - A single toggle to hide the axis while preserving - interaction like dragging. Default is true when a - cheater plot is present on the axis, otherwise false - zeroline - Determines whether or not a line is drawn at along the - 0 value of this axis. If True, the zero line is drawn - on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. - - Returns - ------- - XAxis - """ - super(XAxis, self).__init__('xaxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.XAxis -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.XAxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene import (xaxis as v_xaxis) - - # Initialize validators - # --------------------- - self._validators['autorange'] = v_xaxis.AutorangeValidator() - self._validators['backgroundcolor'] = v_xaxis.BackgroundcolorValidator( - ) - self._validators['calendar'] = v_xaxis.CalendarValidator() - self._validators['categoryarray'] = v_xaxis.CategoryarrayValidator() - self._validators['categoryarraysrc' - ] = v_xaxis.CategoryarraysrcValidator() - self._validators['categoryorder'] = v_xaxis.CategoryorderValidator() - self._validators['color'] = v_xaxis.ColorValidator() - self._validators['dtick'] = v_xaxis.DtickValidator() - self._validators['exponentformat'] = v_xaxis.ExponentformatValidator() - self._validators['gridcolor'] = v_xaxis.GridcolorValidator() - self._validators['gridwidth'] = v_xaxis.GridwidthValidator() - self._validators['hoverformat'] = v_xaxis.HoverformatValidator() - self._validators['linecolor'] = v_xaxis.LinecolorValidator() - self._validators['linewidth'] = v_xaxis.LinewidthValidator() - self._validators['mirror'] = v_xaxis.MirrorValidator() - self._validators['nticks'] = v_xaxis.NticksValidator() - self._validators['range'] = v_xaxis.RangeValidator() - self._validators['rangemode'] = v_xaxis.RangemodeValidator() - self._validators['separatethousands' - ] = v_xaxis.SeparatethousandsValidator() - self._validators['showaxeslabels'] = v_xaxis.ShowaxeslabelsValidator() - self._validators['showbackground'] = v_xaxis.ShowbackgroundValidator() - self._validators['showexponent'] = v_xaxis.ShowexponentValidator() - self._validators['showgrid'] = v_xaxis.ShowgridValidator() - self._validators['showline'] = v_xaxis.ShowlineValidator() - self._validators['showspikes'] = v_xaxis.ShowspikesValidator() - self._validators['showticklabels'] = v_xaxis.ShowticklabelsValidator() - self._validators['showtickprefix'] = v_xaxis.ShowtickprefixValidator() - self._validators['showticksuffix'] = v_xaxis.ShowticksuffixValidator() - self._validators['spikecolor'] = v_xaxis.SpikecolorValidator() - self._validators['spikesides'] = v_xaxis.SpikesidesValidator() - self._validators['spikethickness'] = v_xaxis.SpikethicknessValidator() - self._validators['tick0'] = v_xaxis.Tick0Validator() - self._validators['tickangle'] = v_xaxis.TickangleValidator() - self._validators['tickcolor'] = v_xaxis.TickcolorValidator() - self._validators['tickfont'] = v_xaxis.TickfontValidator() - self._validators['tickformat'] = v_xaxis.TickformatValidator() - self._validators['tickformatstops'] = v_xaxis.TickformatstopsValidator( - ) - self._validators['tickformatstopdefaults' - ] = v_xaxis.TickformatstopValidator() - self._validators['ticklen'] = v_xaxis.TicklenValidator() - self._validators['tickmode'] = v_xaxis.TickmodeValidator() - self._validators['tickprefix'] = v_xaxis.TickprefixValidator() - self._validators['ticks'] = v_xaxis.TicksValidator() - self._validators['ticksuffix'] = v_xaxis.TicksuffixValidator() - self._validators['ticktext'] = v_xaxis.TicktextValidator() - self._validators['ticktextsrc'] = v_xaxis.TicktextsrcValidator() - self._validators['tickvals'] = v_xaxis.TickvalsValidator() - self._validators['tickvalssrc'] = v_xaxis.TickvalssrcValidator() - self._validators['tickwidth'] = v_xaxis.TickwidthValidator() - self._validators['title'] = v_xaxis.TitleValidator() - self._validators['type'] = v_xaxis.TypeValidator() - self._validators['visible'] = v_xaxis.VisibleValidator() - self._validators['zeroline'] = v_xaxis.ZerolineValidator() - self._validators['zerolinecolor'] = v_xaxis.ZerolinecolorValidator() - self._validators['zerolinewidth'] = v_xaxis.ZerolinewidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autorange', None) - self['autorange'] = autorange if autorange is not None else _v - _v = arg.pop('backgroundcolor', None) - self['backgroundcolor' - ] = backgroundcolor if backgroundcolor is not None else _v - _v = arg.pop('calendar', None) - self['calendar'] = calendar if calendar is not None else _v - _v = arg.pop('categoryarray', None) - self['categoryarray' - ] = categoryarray if categoryarray is not None else _v - _v = arg.pop('categoryarraysrc', None) - self['categoryarraysrc' - ] = categoryarraysrc if categoryarraysrc is not None else _v - _v = arg.pop('categoryorder', None) - self['categoryorder' - ] = categoryorder if categoryorder is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('gridcolor', None) - self['gridcolor'] = gridcolor if gridcolor is not None else _v - _v = arg.pop('gridwidth', None) - self['gridwidth'] = gridwidth if gridwidth is not None else _v - _v = arg.pop('hoverformat', None) - self['hoverformat'] = hoverformat if hoverformat is not None else _v - _v = arg.pop('linecolor', None) - self['linecolor'] = linecolor if linecolor is not None else _v - _v = arg.pop('linewidth', None) - self['linewidth'] = linewidth if linewidth is not None else _v - _v = arg.pop('mirror', None) - self['mirror'] = mirror if mirror is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('range', None) - self['range'] = range if range is not None else _v - _v = arg.pop('rangemode', None) - self['rangemode'] = rangemode if rangemode is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showaxeslabels', None) - self['showaxeslabels' - ] = showaxeslabels if showaxeslabels is not None else _v - _v = arg.pop('showbackground', None) - self['showbackground' - ] = showbackground if showbackground is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showgrid', None) - self['showgrid'] = showgrid if showgrid is not None else _v - _v = arg.pop('showline', None) - self['showline'] = showline if showline is not None else _v - _v = arg.pop('showspikes', None) - self['showspikes'] = showspikes if showspikes is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('spikecolor', None) - self['spikecolor'] = spikecolor if spikecolor is not None else _v - _v = arg.pop('spikesides', None) - self['spikesides'] = spikesides if spikesides is not None else _v - _v = arg.pop('spikethickness', None) - self['spikethickness' - ] = spikethickness if spikethickness is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('zeroline', None) - self['zeroline'] = zeroline if zeroline is not None else _v - _v = arg.pop('zerolinecolor', None) - self['zerolinecolor' - ] = zerolinecolor if zerolinecolor is not None else _v - _v = arg.pop('zerolinewidth', None) - self['zerolinewidth' - ] = zerolinewidth if zerolinewidth is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/_yaxis.py b/plotly/graph_objs/layout/scene/_yaxis.py deleted file mode 100644 index 7e0721acb19..00000000000 --- a/plotly/graph_objs/layout/scene/_yaxis.py +++ /dev/null @@ -1,2443 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class YAxis(BaseLayoutHierarchyType): - - # autorange - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['autorange'] - - @autorange.setter - def autorange(self, val): - self['autorange'] = val - - # backgroundcolor - # --------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['backgroundcolor'] - - @backgroundcolor.setter - def backgroundcolor(self, val): - self['backgroundcolor'] = val - - # calendar - # -------- - @property - def calendar(self): - """ - Sets the calendar system to use for `range` and `tick0` if this - is a date axis. This does not set the calendar for interpreting - data on this axis, that's specified in the trace or via the - global `layout.calendar` - - The 'calendar' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['gregorian', 'chinese', 'coptic', 'discworld', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['calendar'] - - @calendar.setter - def calendar(self, val): - self['calendar'] = val - - # categoryarray - # ------------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['categoryarray'] - - @categoryarray.setter - def categoryarray(self, val): - self['categoryarray'] = val - - # categoryarraysrc - # ---------------- - @property - def categoryarraysrc(self): - """ - Sets the source reference on plot.ly for categoryarray . - - The 'categoryarraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['categoryarraysrc'] - - @categoryarraysrc.setter - def categoryarraysrc(self, val): - self['categoryarraysrc'] = val - - # categoryorder - # ------------- - @property - def categoryorder(self): - """ - Specifies the ordering logic for the case of categorical - variables. By default, plotly uses "trace", which specifies the - order that is present in the data supplied. Set `categoryorder` - to *category ascending* or *category descending* if order - should be determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" to derive the - ordering from the attribute `categoryarray`. If a category is - not found in the `categoryarray` array, the sorting behavior - for that attribute will be identical to the "trace" mode. The - unspecified categories will follow the categories in - `categoryarray`. - - The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array'] - - Returns - ------- - Any - """ - return self['categoryorder'] - - @categoryorder.setter - def categoryorder(self, val): - self['categoryorder'] = val - - # color - # ----- - @property - def color(self): - """ - Sets default for all colors associated with this axis all at - once: line, font, tick, and grid colors. Grid color is - lightened by blending this with the plot background Individual - pieces can override this. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # gridcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['gridcolor'] - - @gridcolor.setter - def gridcolor(self, val): - self['gridcolor'] = val - - # gridwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['gridwidth'] - - @gridwidth.setter - def gridwidth(self, val): - self['gridwidth'] = val - - # hoverformat - # ----------- - @property - def hoverformat(self): - """ - Sets the hover text formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'hoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['hoverformat'] - - @hoverformat.setter - def hoverformat(self, val): - self['hoverformat'] = val - - # linecolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['linecolor'] - - @linecolor.setter - def linecolor(self, val): - self['linecolor'] = val - - # linewidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['linewidth'] - - @linewidth.setter - def linewidth(self, val): - self['linewidth'] = val - - # mirror - # ------ - @property - def mirror(self): - """ - Determines if the axis lines or/and ticks are mirrored to the - opposite side of the plotting area. If True, the axis lines are - mirrored. If "ticks", the axis lines and ticks are mirrored. If - False, mirroring is disable. If "all", axis lines are mirrored - on all shared-axes subplots. If "allticks", axis lines and - ticks are mirrored on all shared-axes subplots. - - The 'mirror' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, 'ticks', False, 'all', 'allticks'] - - Returns - ------- - Any - """ - return self['mirror'] - - @mirror.setter - def mirror(self, val): - self['mirror'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # range - # ----- - @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 - - Returns - ------- - list - """ - return self['range'] - - @range.setter - def range(self, val): - self['range'] = val - - # rangemode - # --------- - @property - def rangemode(self): - """ - If "normal", the range is computed in relation to the extrema - of the input data. If *tozero*`, the range extends to 0, - regardless of the input data If "nonnegative", the range is - non-negative, regardless of the input data. Applies only to - linear axes. - - The 'rangemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'tozero', 'nonnegative'] - - Returns - ------- - Any - """ - return self['rangemode'] - - @rangemode.setter - def rangemode(self, val): - self['rangemode'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showaxeslabels - # -------------- - @property - def showaxeslabels(self): - """ - Sets whether or not this axis is labeled - - The 'showaxeslabels' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['showaxeslabels'] - - @showaxeslabels.setter - def showaxeslabels(self, val): - self['showaxeslabels'] = val - - # showbackground - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showbackground'] - - @showbackground.setter - def showbackground(self, val): - self['showbackground'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showgrid - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showgrid'] - - @showgrid.setter - def showgrid(self, val): - self['showgrid'] = val - - # showline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showline'] - - @showline.setter - def showline(self, val): - self['showline'] = val - - # showspikes - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showspikes'] - - @showspikes.setter - def showspikes(self, val): - self['showspikes'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # spikecolor - # ---------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['spikecolor'] - - @spikecolor.setter - def spikecolor(self, val): - self['spikecolor'] = val - - # spikesides - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['spikesides'] - - @spikesides.setter - def spikesides(self, val): - self['spikesides'] = val - - # spikethickness - # -------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['spikethickness'] - - @spikethickness.setter - def spikethickness(self, val): - self['spikethickness'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - def tickfont(self): - """ - Sets the tick font. - - The 'tickfont' property is an instance of Tickfont - that may be specified as: - - An instance of 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.scene.yaxis.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.layout.scene.yaxis.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as - 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 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 - ------- - plotly.graph_objs.layout.scene.yaxis.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - text - 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. - - Returns - ------- - plotly.graph_objs.layout.scene.yaxis.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # type - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # zeroline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['zeroline'] - - @zeroline.setter - def zeroline(self, val): - self['zeroline'] = val - - # zerolinecolor - # ------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['zerolinecolor'] - - @zerolinecolor.setter - def zerolinecolor(self, val): - self['zerolinecolor'] = val - - # zerolinewidth - # ------------- - @property - 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 - - Returns - ------- - int|float - """ - return self['zerolinewidth'] - - @zerolinewidth.setter - def zerolinewidth(self, val): - self['zerolinewidth'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autorange - Determines whether or not the range of this axis is - computed in relation to the input data. See `rangemode` - for more info. If `range` is provided, then `autorange` - is set to False. - backgroundcolor - Sets the background color of this axis' wall. - calendar - Sets the calendar system to use for `range` and `tick0` - if this is a date axis. This does not set the calendar - for interpreting data on this axis, that's specified in - the trace or via the global `layout.calendar` - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - mirror - Determines if the axis lines or/and ticks are mirrored - to the opposite side of the plotting area. If True, the - axis lines are mirrored. If "ticks", the axis lines and - ticks are mirrored. If False, mirroring is disable. If - "all", axis lines are mirrored on all shared-axes - subplots. If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - range - Sets the range of this axis. If the axis `type` is - "log", then you must take the log of your desired range - (e.g. to set the range from 1 to 100, set the range - from 0 to 2). If the axis `type` is "date", it should - be date strings, like date data, though Date objects - and unix milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order it - appears. - rangemode - If "normal", the range is computed in relation to the - extrema of the input data. If *tozero*`, the range - extends to 0, regardless of the input data If - "nonnegative", the range is non-negative, regardless of - the input data. Applies only to linear axes. - separatethousands - If "true", even 4-digit integers are separated - showaxeslabels - Sets whether or not this axis is labeled - showbackground - Sets whether or not this axis' wall has a background - color. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showspikes - Sets whether or not spikes starting from data points to - this axis' wall are shown on hover. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - spikecolor - Sets the color of the spikes. - spikesides - Sets whether or not spikes extending from the - projection data points to this axis' wall boundaries - are shown on hover. - spikethickness - Sets the thickness (in px) of the spikes. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.scene.yaxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.layout.scen - e.yaxis.tickformatstopdefaults), sets the default - property values to use for elements of - layout.scene.yaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.scene.yaxis.Title instance or - dict with compatible properties - titlefont - 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. - type - Sets the axis type. By default, plotly attempts to - determined the axis type by looking into the data of - the traces that referenced the axis in question. - visible - A single toggle to hide the axis while preserving - interaction like dragging. Default is true when a - cheater plot is present on the axis, otherwise false - zeroline - Determines whether or not a line is drawn at along the - 0 value of this axis. If True, the zero line is drawn - on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. - """ - - _mapped_properties = {'titlefont': ('title', 'font')} - - def __init__( - self, - arg=None, - autorange=None, - backgroundcolor=None, - calendar=None, - categoryarray=None, - categoryarraysrc=None, - categoryorder=None, - color=None, - dtick=None, - exponentformat=None, - gridcolor=None, - gridwidth=None, - hoverformat=None, - linecolor=None, - linewidth=None, - mirror=None, - nticks=None, - range=None, - rangemode=None, - separatethousands=None, - showaxeslabels=None, - showbackground=None, - showexponent=None, - showgrid=None, - showline=None, - showspikes=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - spikecolor=None, - spikesides=None, - spikethickness=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - type=None, - visible=None, - zeroline=None, - zerolinecolor=None, - zerolinewidth=None, - **kwargs - ): - """ - Construct a new YAxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.scene.YAxis - autorange - Determines whether or not the range of this axis is - computed in relation to the input data. See `rangemode` - for more info. If `range` is provided, then `autorange` - is set to False. - backgroundcolor - Sets the background color of this axis' wall. - calendar - Sets the calendar system to use for `range` and `tick0` - if this is a date axis. This does not set the calendar - for interpreting data on this axis, that's specified in - the trace or via the global `layout.calendar` - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - mirror - Determines if the axis lines or/and ticks are mirrored - to the opposite side of the plotting area. If True, the - axis lines are mirrored. If "ticks", the axis lines and - ticks are mirrored. If False, mirroring is disable. If - "all", axis lines are mirrored on all shared-axes - subplots. If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - range - Sets the range of this axis. If the axis `type` is - "log", then you must take the log of your desired range - (e.g. to set the range from 1 to 100, set the range - from 0 to 2). If the axis `type` is "date", it should - be date strings, like date data, though Date objects - and unix milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order it - appears. - rangemode - If "normal", the range is computed in relation to the - extrema of the input data. If *tozero*`, the range - extends to 0, regardless of the input data If - "nonnegative", the range is non-negative, regardless of - the input data. Applies only to linear axes. - separatethousands - If "true", even 4-digit integers are separated - showaxeslabels - Sets whether or not this axis is labeled - showbackground - Sets whether or not this axis' wall has a background - color. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showspikes - Sets whether or not spikes starting from data points to - this axis' wall are shown on hover. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - spikecolor - Sets the color of the spikes. - spikesides - Sets whether or not spikes extending from the - projection data points to this axis' wall boundaries - are shown on hover. - spikethickness - Sets the thickness (in px) of the spikes. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.scene.yaxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.layout.scen - e.yaxis.tickformatstopdefaults), sets the default - property values to use for elements of - layout.scene.yaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.scene.yaxis.Title instance or - dict with compatible properties - titlefont - 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. - type - Sets the axis type. By default, plotly attempts to - determined the axis type by looking into the data of - the traces that referenced the axis in question. - visible - A single toggle to hide the axis while preserving - interaction like dragging. Default is true when a - cheater plot is present on the axis, otherwise false - zeroline - Determines whether or not a line is drawn at along the - 0 value of this axis. If True, the zero line is drawn - on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. - - Returns - ------- - YAxis - """ - super(YAxis, self).__init__('yaxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.YAxis -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.YAxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene import (yaxis as v_yaxis) - - # Initialize validators - # --------------------- - self._validators['autorange'] = v_yaxis.AutorangeValidator() - self._validators['backgroundcolor'] = v_yaxis.BackgroundcolorValidator( - ) - self._validators['calendar'] = v_yaxis.CalendarValidator() - self._validators['categoryarray'] = v_yaxis.CategoryarrayValidator() - self._validators['categoryarraysrc' - ] = v_yaxis.CategoryarraysrcValidator() - self._validators['categoryorder'] = v_yaxis.CategoryorderValidator() - self._validators['color'] = v_yaxis.ColorValidator() - self._validators['dtick'] = v_yaxis.DtickValidator() - self._validators['exponentformat'] = v_yaxis.ExponentformatValidator() - self._validators['gridcolor'] = v_yaxis.GridcolorValidator() - self._validators['gridwidth'] = v_yaxis.GridwidthValidator() - self._validators['hoverformat'] = v_yaxis.HoverformatValidator() - self._validators['linecolor'] = v_yaxis.LinecolorValidator() - self._validators['linewidth'] = v_yaxis.LinewidthValidator() - self._validators['mirror'] = v_yaxis.MirrorValidator() - self._validators['nticks'] = v_yaxis.NticksValidator() - self._validators['range'] = v_yaxis.RangeValidator() - self._validators['rangemode'] = v_yaxis.RangemodeValidator() - self._validators['separatethousands' - ] = v_yaxis.SeparatethousandsValidator() - self._validators['showaxeslabels'] = v_yaxis.ShowaxeslabelsValidator() - self._validators['showbackground'] = v_yaxis.ShowbackgroundValidator() - self._validators['showexponent'] = v_yaxis.ShowexponentValidator() - self._validators['showgrid'] = v_yaxis.ShowgridValidator() - self._validators['showline'] = v_yaxis.ShowlineValidator() - self._validators['showspikes'] = v_yaxis.ShowspikesValidator() - self._validators['showticklabels'] = v_yaxis.ShowticklabelsValidator() - self._validators['showtickprefix'] = v_yaxis.ShowtickprefixValidator() - self._validators['showticksuffix'] = v_yaxis.ShowticksuffixValidator() - self._validators['spikecolor'] = v_yaxis.SpikecolorValidator() - self._validators['spikesides'] = v_yaxis.SpikesidesValidator() - self._validators['spikethickness'] = v_yaxis.SpikethicknessValidator() - self._validators['tick0'] = v_yaxis.Tick0Validator() - self._validators['tickangle'] = v_yaxis.TickangleValidator() - self._validators['tickcolor'] = v_yaxis.TickcolorValidator() - self._validators['tickfont'] = v_yaxis.TickfontValidator() - self._validators['tickformat'] = v_yaxis.TickformatValidator() - self._validators['tickformatstops'] = v_yaxis.TickformatstopsValidator( - ) - self._validators['tickformatstopdefaults' - ] = v_yaxis.TickformatstopValidator() - self._validators['ticklen'] = v_yaxis.TicklenValidator() - self._validators['tickmode'] = v_yaxis.TickmodeValidator() - self._validators['tickprefix'] = v_yaxis.TickprefixValidator() - self._validators['ticks'] = v_yaxis.TicksValidator() - self._validators['ticksuffix'] = v_yaxis.TicksuffixValidator() - self._validators['ticktext'] = v_yaxis.TicktextValidator() - self._validators['ticktextsrc'] = v_yaxis.TicktextsrcValidator() - self._validators['tickvals'] = v_yaxis.TickvalsValidator() - self._validators['tickvalssrc'] = v_yaxis.TickvalssrcValidator() - self._validators['tickwidth'] = v_yaxis.TickwidthValidator() - self._validators['title'] = v_yaxis.TitleValidator() - self._validators['type'] = v_yaxis.TypeValidator() - self._validators['visible'] = v_yaxis.VisibleValidator() - self._validators['zeroline'] = v_yaxis.ZerolineValidator() - self._validators['zerolinecolor'] = v_yaxis.ZerolinecolorValidator() - self._validators['zerolinewidth'] = v_yaxis.ZerolinewidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autorange', None) - self['autorange'] = autorange if autorange is not None else _v - _v = arg.pop('backgroundcolor', None) - self['backgroundcolor' - ] = backgroundcolor if backgroundcolor is not None else _v - _v = arg.pop('calendar', None) - self['calendar'] = calendar if calendar is not None else _v - _v = arg.pop('categoryarray', None) - self['categoryarray' - ] = categoryarray if categoryarray is not None else _v - _v = arg.pop('categoryarraysrc', None) - self['categoryarraysrc' - ] = categoryarraysrc if categoryarraysrc is not None else _v - _v = arg.pop('categoryorder', None) - self['categoryorder' - ] = categoryorder if categoryorder is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('gridcolor', None) - self['gridcolor'] = gridcolor if gridcolor is not None else _v - _v = arg.pop('gridwidth', None) - self['gridwidth'] = gridwidth if gridwidth is not None else _v - _v = arg.pop('hoverformat', None) - self['hoverformat'] = hoverformat if hoverformat is not None else _v - _v = arg.pop('linecolor', None) - self['linecolor'] = linecolor if linecolor is not None else _v - _v = arg.pop('linewidth', None) - self['linewidth'] = linewidth if linewidth is not None else _v - _v = arg.pop('mirror', None) - self['mirror'] = mirror if mirror is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('range', None) - self['range'] = range if range is not None else _v - _v = arg.pop('rangemode', None) - self['rangemode'] = rangemode if rangemode is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showaxeslabels', None) - self['showaxeslabels' - ] = showaxeslabels if showaxeslabels is not None else _v - _v = arg.pop('showbackground', None) - self['showbackground' - ] = showbackground if showbackground is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showgrid', None) - self['showgrid'] = showgrid if showgrid is not None else _v - _v = arg.pop('showline', None) - self['showline'] = showline if showline is not None else _v - _v = arg.pop('showspikes', None) - self['showspikes'] = showspikes if showspikes is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('spikecolor', None) - self['spikecolor'] = spikecolor if spikecolor is not None else _v - _v = arg.pop('spikesides', None) - self['spikesides'] = spikesides if spikesides is not None else _v - _v = arg.pop('spikethickness', None) - self['spikethickness' - ] = spikethickness if spikethickness is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('zeroline', None) - self['zeroline'] = zeroline if zeroline is not None else _v - _v = arg.pop('zerolinecolor', None) - self['zerolinecolor' - ] = zerolinecolor if zerolinecolor is not None else _v - _v = arg.pop('zerolinewidth', None) - self['zerolinewidth' - ] = zerolinewidth if zerolinewidth is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/_zaxis.py b/plotly/graph_objs/layout/scene/_zaxis.py deleted file mode 100644 index e08d3a839fe..00000000000 --- a/plotly/graph_objs/layout/scene/_zaxis.py +++ /dev/null @@ -1,2443 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class ZAxis(BaseLayoutHierarchyType): - - # autorange - # --------- - @property - 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'] - - Returns - ------- - Any - """ - return self['autorange'] - - @autorange.setter - def autorange(self, val): - self['autorange'] = val - - # backgroundcolor - # --------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['backgroundcolor'] - - @backgroundcolor.setter - def backgroundcolor(self, val): - self['backgroundcolor'] = val - - # calendar - # -------- - @property - def calendar(self): - """ - Sets the calendar system to use for `range` and `tick0` if this - is a date axis. This does not set the calendar for interpreting - data on this axis, that's specified in the trace or via the - global `layout.calendar` - - The 'calendar' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['gregorian', 'chinese', 'coptic', 'discworld', - 'ethiopian', 'hebrew', 'islamic', 'julian', 'mayan', - 'nanakshahi', 'nepali', 'persian', 'jalali', 'taiwan', - 'thai', 'ummalqura'] - - Returns - ------- - Any - """ - return self['calendar'] - - @calendar.setter - def calendar(self, val): - self['calendar'] = val - - # categoryarray - # ------------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['categoryarray'] - - @categoryarray.setter - def categoryarray(self, val): - self['categoryarray'] = val - - # categoryarraysrc - # ---------------- - @property - def categoryarraysrc(self): - """ - Sets the source reference on plot.ly for categoryarray . - - The 'categoryarraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['categoryarraysrc'] - - @categoryarraysrc.setter - def categoryarraysrc(self, val): - self['categoryarraysrc'] = val - - # categoryorder - # ------------- - @property - def categoryorder(self): - """ - Specifies the ordering logic for the case of categorical - variables. By default, plotly uses "trace", which specifies the - order that is present in the data supplied. Set `categoryorder` - to *category ascending* or *category descending* if order - should be determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" to derive the - ordering from the attribute `categoryarray`. If a category is - not found in the `categoryarray` array, the sorting behavior - for that attribute will be identical to the "trace" mode. The - unspecified categories will follow the categories in - `categoryarray`. - - The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array'] - - Returns - ------- - Any - """ - return self['categoryorder'] - - @categoryorder.setter - def categoryorder(self, val): - self['categoryorder'] = val - - # color - # ----- - @property - def color(self): - """ - Sets default for all colors associated with this axis all at - once: line, font, tick, and grid colors. Grid color is - lightened by blending this with the plot background Individual - pieces can override this. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # gridcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['gridcolor'] - - @gridcolor.setter - def gridcolor(self, val): - self['gridcolor'] = val - - # gridwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['gridwidth'] - - @gridwidth.setter - def gridwidth(self, val): - self['gridwidth'] = val - - # hoverformat - # ----------- - @property - def hoverformat(self): - """ - Sets the hover text formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'hoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['hoverformat'] - - @hoverformat.setter - def hoverformat(self, val): - self['hoverformat'] = val - - # linecolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['linecolor'] - - @linecolor.setter - def linecolor(self, val): - self['linecolor'] = val - - # linewidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['linewidth'] - - @linewidth.setter - def linewidth(self, val): - self['linewidth'] = val - - # mirror - # ------ - @property - def mirror(self): - """ - Determines if the axis lines or/and ticks are mirrored to the - opposite side of the plotting area. If True, the axis lines are - mirrored. If "ticks", the axis lines and ticks are mirrored. If - False, mirroring is disable. If "all", axis lines are mirrored - on all shared-axes subplots. If "allticks", axis lines and - ticks are mirrored on all shared-axes subplots. - - The 'mirror' property is an enumeration that may be specified as: - - One of the following enumeration values: - [True, 'ticks', False, 'all', 'allticks'] - - Returns - ------- - Any - """ - return self['mirror'] - - @mirror.setter - def mirror(self, val): - self['mirror'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # range - # ----- - @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 - - Returns - ------- - list - """ - return self['range'] - - @range.setter - def range(self, val): - self['range'] = val - - # rangemode - # --------- - @property - def rangemode(self): - """ - If "normal", the range is computed in relation to the extrema - of the input data. If *tozero*`, the range extends to 0, - regardless of the input data If "nonnegative", the range is - non-negative, regardless of the input data. Applies only to - linear axes. - - The 'rangemode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['normal', 'tozero', 'nonnegative'] - - Returns - ------- - Any - """ - return self['rangemode'] - - @rangemode.setter - def rangemode(self, val): - self['rangemode'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showaxeslabels - # -------------- - @property - def showaxeslabels(self): - """ - Sets whether or not this axis is labeled - - The 'showaxeslabels' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['showaxeslabels'] - - @showaxeslabels.setter - def showaxeslabels(self, val): - self['showaxeslabels'] = val - - # showbackground - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showbackground'] - - @showbackground.setter - def showbackground(self, val): - self['showbackground'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showgrid - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showgrid'] - - @showgrid.setter - def showgrid(self, val): - self['showgrid'] = val - - # showline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showline'] - - @showline.setter - def showline(self, val): - self['showline'] = val - - # showspikes - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['showspikes'] - - @showspikes.setter - def showspikes(self, val): - self['showspikes'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # spikecolor - # ---------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['spikecolor'] - - @spikecolor.setter - def spikecolor(self, val): - self['spikecolor'] = val - - # spikesides - # ---------- - @property - 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) - - Returns - ------- - bool - """ - return self['spikesides'] - - @spikesides.setter - def spikesides(self, val): - self['spikesides'] = val - - # spikethickness - # -------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['spikethickness'] - - @spikethickness.setter - def spikethickness(self, val): - self['spikethickness'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - def tickfont(self): - """ - Sets the tick font. - - The 'tickfont' property is an instance of Tickfont - that may be specified as: - - An instance of 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.scene.zaxis.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.layout.scene.zaxis.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as - 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 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 - ------- - plotly.graph_objs.layout.scene.zaxis.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - text - 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. - - Returns - ------- - plotly.graph_objs.layout.scene.zaxis.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # type - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # zeroline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['zeroline'] - - @zeroline.setter - def zeroline(self, val): - self['zeroline'] = val - - # zerolinecolor - # ------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['zerolinecolor'] - - @zerolinecolor.setter - def zerolinecolor(self, val): - self['zerolinecolor'] = val - - # zerolinewidth - # ------------- - @property - 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 - - Returns - ------- - int|float - """ - return self['zerolinewidth'] - - @zerolinewidth.setter - def zerolinewidth(self, val): - self['zerolinewidth'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autorange - Determines whether or not the range of this axis is - computed in relation to the input data. See `rangemode` - for more info. If `range` is provided, then `autorange` - is set to False. - backgroundcolor - Sets the background color of this axis' wall. - calendar - Sets the calendar system to use for `range` and `tick0` - if this is a date axis. This does not set the calendar - for interpreting data on this axis, that's specified in - the trace or via the global `layout.calendar` - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - mirror - Determines if the axis lines or/and ticks are mirrored - to the opposite side of the plotting area. If True, the - axis lines are mirrored. If "ticks", the axis lines and - ticks are mirrored. If False, mirroring is disable. If - "all", axis lines are mirrored on all shared-axes - subplots. If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - range - Sets the range of this axis. If the axis `type` is - "log", then you must take the log of your desired range - (e.g. to set the range from 1 to 100, set the range - from 0 to 2). If the axis `type` is "date", it should - be date strings, like date data, though Date objects - and unix milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order it - appears. - rangemode - If "normal", the range is computed in relation to the - extrema of the input data. If *tozero*`, the range - extends to 0, regardless of the input data If - "nonnegative", the range is non-negative, regardless of - the input data. Applies only to linear axes. - separatethousands - If "true", even 4-digit integers are separated - showaxeslabels - Sets whether or not this axis is labeled - showbackground - Sets whether or not this axis' wall has a background - color. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showspikes - Sets whether or not spikes starting from data points to - this axis' wall are shown on hover. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - spikecolor - Sets the color of the spikes. - spikesides - Sets whether or not spikes extending from the - projection data points to this axis' wall boundaries - are shown on hover. - spikethickness - Sets the thickness (in px) of the spikes. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.scene.zaxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.layout.scen - e.zaxis.tickformatstopdefaults), sets the default - property values to use for elements of - layout.scene.zaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.scene.zaxis.Title instance or - dict with compatible properties - titlefont - 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. - type - Sets the axis type. By default, plotly attempts to - determined the axis type by looking into the data of - the traces that referenced the axis in question. - visible - A single toggle to hide the axis while preserving - interaction like dragging. Default is true when a - cheater plot is present on the axis, otherwise false - zeroline - Determines whether or not a line is drawn at along the - 0 value of this axis. If True, the zero line is drawn - on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. - """ - - _mapped_properties = {'titlefont': ('title', 'font')} - - def __init__( - self, - arg=None, - autorange=None, - backgroundcolor=None, - calendar=None, - categoryarray=None, - categoryarraysrc=None, - categoryorder=None, - color=None, - dtick=None, - exponentformat=None, - gridcolor=None, - gridwidth=None, - hoverformat=None, - linecolor=None, - linewidth=None, - mirror=None, - nticks=None, - range=None, - rangemode=None, - separatethousands=None, - showaxeslabels=None, - showbackground=None, - showexponent=None, - showgrid=None, - showline=None, - showspikes=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - spikecolor=None, - spikesides=None, - spikethickness=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - type=None, - visible=None, - zeroline=None, - zerolinecolor=None, - zerolinewidth=None, - **kwargs - ): - """ - Construct a new ZAxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.scene.ZAxis - autorange - Determines whether or not the range of this axis is - computed in relation to the input data. See `rangemode` - for more info. If `range` is provided, then `autorange` - is set to False. - backgroundcolor - Sets the background color of this axis' wall. - calendar - Sets the calendar system to use for `range` and `tick0` - if this is a date axis. This does not set the calendar - for interpreting data on this axis, that's specified in - the trace or via the global `layout.calendar` - categoryarray - Sets the order in which categories on this axis appear. - Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses "trace", - which specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - mirror - Determines if the axis lines or/and ticks are mirrored - to the opposite side of the plotting area. If True, the - axis lines are mirrored. If "ticks", the axis lines and - ticks are mirrored. If False, mirroring is disable. If - "all", axis lines are mirrored on all shared-axes - subplots. If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - range - Sets the range of this axis. If the axis `type` is - "log", then you must take the log of your desired range - (e.g. to set the range from 1 to 100, set the range - from 0 to 2). If the axis `type` is "date", it should - be date strings, like date data, though Date objects - and unix milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order it - appears. - rangemode - If "normal", the range is computed in relation to the - extrema of the input data. If *tozero*`, the range - extends to 0, regardless of the input data If - "nonnegative", the range is non-negative, regardless of - the input data. Applies only to linear axes. - separatethousands - If "true", even 4-digit integers are separated - showaxeslabels - Sets whether or not this axis is labeled - showbackground - Sets whether or not this axis' wall has a background - color. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showspikes - Sets whether or not spikes starting from data points to - this axis' wall are shown on hover. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - spikecolor - Sets the color of the spikes. - spikesides - Sets whether or not spikes extending from the - projection data points to this axis' wall boundaries - are shown on hover. - spikethickness - Sets the thickness (in px) of the spikes. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.scene.zaxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.layout.scen - e.zaxis.tickformatstopdefaults), sets the default - property values to use for elements of - layout.scene.zaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.scene.zaxis.Title instance or - dict with compatible properties - titlefont - 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. - type - Sets the axis type. By default, plotly attempts to - determined the axis type by looking into the data of - the traces that referenced the axis in question. - visible - A single toggle to hide the axis while preserving - interaction like dragging. Default is true when a - cheater plot is present on the axis, otherwise false - zeroline - Determines whether or not a line is drawn at along the - 0 value of this axis. If True, the zero line is drawn - on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. - - Returns - ------- - ZAxis - """ - super(ZAxis, self).__init__('zaxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.ZAxis -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.ZAxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene import (zaxis as v_zaxis) - - # Initialize validators - # --------------------- - self._validators['autorange'] = v_zaxis.AutorangeValidator() - self._validators['backgroundcolor'] = v_zaxis.BackgroundcolorValidator( - ) - self._validators['calendar'] = v_zaxis.CalendarValidator() - self._validators['categoryarray'] = v_zaxis.CategoryarrayValidator() - self._validators['categoryarraysrc' - ] = v_zaxis.CategoryarraysrcValidator() - self._validators['categoryorder'] = v_zaxis.CategoryorderValidator() - self._validators['color'] = v_zaxis.ColorValidator() - self._validators['dtick'] = v_zaxis.DtickValidator() - self._validators['exponentformat'] = v_zaxis.ExponentformatValidator() - self._validators['gridcolor'] = v_zaxis.GridcolorValidator() - self._validators['gridwidth'] = v_zaxis.GridwidthValidator() - self._validators['hoverformat'] = v_zaxis.HoverformatValidator() - self._validators['linecolor'] = v_zaxis.LinecolorValidator() - self._validators['linewidth'] = v_zaxis.LinewidthValidator() - self._validators['mirror'] = v_zaxis.MirrorValidator() - self._validators['nticks'] = v_zaxis.NticksValidator() - self._validators['range'] = v_zaxis.RangeValidator() - self._validators['rangemode'] = v_zaxis.RangemodeValidator() - self._validators['separatethousands' - ] = v_zaxis.SeparatethousandsValidator() - self._validators['showaxeslabels'] = v_zaxis.ShowaxeslabelsValidator() - self._validators['showbackground'] = v_zaxis.ShowbackgroundValidator() - self._validators['showexponent'] = v_zaxis.ShowexponentValidator() - self._validators['showgrid'] = v_zaxis.ShowgridValidator() - self._validators['showline'] = v_zaxis.ShowlineValidator() - self._validators['showspikes'] = v_zaxis.ShowspikesValidator() - self._validators['showticklabels'] = v_zaxis.ShowticklabelsValidator() - self._validators['showtickprefix'] = v_zaxis.ShowtickprefixValidator() - self._validators['showticksuffix'] = v_zaxis.ShowticksuffixValidator() - self._validators['spikecolor'] = v_zaxis.SpikecolorValidator() - self._validators['spikesides'] = v_zaxis.SpikesidesValidator() - self._validators['spikethickness'] = v_zaxis.SpikethicknessValidator() - self._validators['tick0'] = v_zaxis.Tick0Validator() - self._validators['tickangle'] = v_zaxis.TickangleValidator() - self._validators['tickcolor'] = v_zaxis.TickcolorValidator() - self._validators['tickfont'] = v_zaxis.TickfontValidator() - self._validators['tickformat'] = v_zaxis.TickformatValidator() - self._validators['tickformatstops'] = v_zaxis.TickformatstopsValidator( - ) - self._validators['tickformatstopdefaults' - ] = v_zaxis.TickformatstopValidator() - self._validators['ticklen'] = v_zaxis.TicklenValidator() - self._validators['tickmode'] = v_zaxis.TickmodeValidator() - self._validators['tickprefix'] = v_zaxis.TickprefixValidator() - self._validators['ticks'] = v_zaxis.TicksValidator() - self._validators['ticksuffix'] = v_zaxis.TicksuffixValidator() - self._validators['ticktext'] = v_zaxis.TicktextValidator() - self._validators['ticktextsrc'] = v_zaxis.TicktextsrcValidator() - self._validators['tickvals'] = v_zaxis.TickvalsValidator() - self._validators['tickvalssrc'] = v_zaxis.TickvalssrcValidator() - self._validators['tickwidth'] = v_zaxis.TickwidthValidator() - self._validators['title'] = v_zaxis.TitleValidator() - self._validators['type'] = v_zaxis.TypeValidator() - self._validators['visible'] = v_zaxis.VisibleValidator() - self._validators['zeroline'] = v_zaxis.ZerolineValidator() - self._validators['zerolinecolor'] = v_zaxis.ZerolinecolorValidator() - self._validators['zerolinewidth'] = v_zaxis.ZerolinewidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autorange', None) - self['autorange'] = autorange if autorange is not None else _v - _v = arg.pop('backgroundcolor', None) - self['backgroundcolor' - ] = backgroundcolor if backgroundcolor is not None else _v - _v = arg.pop('calendar', None) - self['calendar'] = calendar if calendar is not None else _v - _v = arg.pop('categoryarray', None) - self['categoryarray' - ] = categoryarray if categoryarray is not None else _v - _v = arg.pop('categoryarraysrc', None) - self['categoryarraysrc' - ] = categoryarraysrc if categoryarraysrc is not None else _v - _v = arg.pop('categoryorder', None) - self['categoryorder' - ] = categoryorder if categoryorder is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('gridcolor', None) - self['gridcolor'] = gridcolor if gridcolor is not None else _v - _v = arg.pop('gridwidth', None) - self['gridwidth'] = gridwidth if gridwidth is not None else _v - _v = arg.pop('hoverformat', None) - self['hoverformat'] = hoverformat if hoverformat is not None else _v - _v = arg.pop('linecolor', None) - self['linecolor'] = linecolor if linecolor is not None else _v - _v = arg.pop('linewidth', None) - self['linewidth'] = linewidth if linewidth is not None else _v - _v = arg.pop('mirror', None) - self['mirror'] = mirror if mirror is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('range', None) - self['range'] = range if range is not None else _v - _v = arg.pop('rangemode', None) - self['rangemode'] = rangemode if rangemode is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showaxeslabels', None) - self['showaxeslabels' - ] = showaxeslabels if showaxeslabels is not None else _v - _v = arg.pop('showbackground', None) - self['showbackground' - ] = showbackground if showbackground is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showgrid', None) - self['showgrid'] = showgrid if showgrid is not None else _v - _v = arg.pop('showline', None) - self['showline'] = showline if showline is not None else _v - _v = arg.pop('showspikes', None) - self['showspikes'] = showspikes if showspikes is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('spikecolor', None) - self['spikecolor'] = spikecolor if spikecolor is not None else _v - _v = arg.pop('spikesides', None) - self['spikesides'] = spikesides if spikesides is not None else _v - _v = arg.pop('spikethickness', None) - self['spikethickness' - ] = spikethickness if spikethickness is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('zeroline', None) - self['zeroline'] = zeroline if zeroline is not None else _v - _v = arg.pop('zerolinecolor', None) - self['zerolinecolor' - ] = zerolinecolor if zerolinecolor is not None else _v - _v = arg.pop('zerolinewidth', None) - self['zerolinewidth' - ] = zerolinewidth if zerolinewidth is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/annotation/__init__.py b/plotly/graph_objs/layout/scene/annotation/__init__.py index 54fab678b0f..12053c5da9f 100644 --- a/plotly/graph_objs/layout/scene/annotation/__init__.py +++ b/plotly/graph_objs/layout/scene/annotation/__init__.py @@ -1,3 +1,511 @@ -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseLayoutHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.scene.annotation.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.annotation' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover label. By + default uses the annotation's `bgcolor` made opaque, or + white if it was transparent. + bordercolor + Sets the border color of the hover label. By default + uses either dark grey or white, for maximum contrast + with `hoverlabel.bgcolor`. + font + Sets the hover label text font. By default uses the + global hover font and size, with color from + `hoverlabel.bordercolor`. + """ + + def __init__( + self, arg=None, bgcolor=None, bordercolor=None, font=None, **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.annotation.Hoverlabel + bgcolor + Sets the background color of the hover label. By + default uses the annotation's `bgcolor` made opaque, or + white if it was transparent. + bordercolor + Sets the border color of the hover label. By default + uses either dark grey or white, for maximum contrast + with `hoverlabel.bgcolor`. + font + Sets the hover label text font. By default uses the + global hover font and size, with color from + `hoverlabel.bordercolor`. + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.annotation.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.annotation.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.annotation import ( + hoverlabel as v_hoverlabel + ) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.annotation' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): + """ + Construct a new Font object + + Sets the annotation text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.annotation.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.annotation.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.annotation.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.annotation import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.scene.annotation import hoverlabel -from ._font import Font diff --git a/plotly/graph_objs/layout/scene/annotation/_font.py b/plotly/graph_objs/layout/scene/annotation/_font.py deleted file mode 100644 index 5c948b41b9b..00000000000 --- a/plotly/graph_objs/layout/scene/annotation/_font.py +++ /dev/null @@ -1,226 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.annotation' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): - """ - Construct a new Font object - - Sets the annotation text font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.annotation.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.annotation.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.annotation.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.annotation import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/annotation/_hoverlabel.py b/plotly/graph_objs/layout/scene/annotation/_hoverlabel.py deleted file mode 100644 index b1c1744d2b7..00000000000 --- a/plotly/graph_objs/layout/scene/annotation/_hoverlabel.py +++ /dev/null @@ -1,278 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Hoverlabel(BaseLayoutHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.scene.annotation.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.annotation' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover label. By - default uses the annotation's `bgcolor` made opaque, or - white if it was transparent. - bordercolor - Sets the border color of the hover label. By default - uses either dark grey or white, for maximum contrast - with `hoverlabel.bgcolor`. - font - Sets the hover label text font. By default uses the - global hover font and size, with color from - `hoverlabel.bordercolor`. - """ - - def __init__( - self, arg=None, bgcolor=None, bordercolor=None, font=None, **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.annotation.Hoverlabel - bgcolor - Sets the background color of the hover label. By - default uses the annotation's `bgcolor` made opaque, or - white if it was transparent. - bordercolor - Sets the border color of the hover label. By default - uses either dark grey or white, for maximum contrast - with `hoverlabel.bgcolor`. - font - Sets the hover label text font. By default uses the - global hover font and size, with color from - `hoverlabel.bordercolor`. - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.annotation.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.annotation.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.annotation import ( - hoverlabel as v_hoverlabel - ) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/annotation/hoverlabel/__init__.py b/plotly/graph_objs/layout/scene/annotation/hoverlabel/__init__.py index c37b8b5cd28..da5958a5e29 100644 --- a/plotly/graph_objs/layout/scene/annotation/hoverlabel/__init__.py +++ b/plotly/graph_objs/layout/scene/annotation/hoverlabel/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.annotation.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.scene.annotatio + n.hoverlabel.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.annotation.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.annotation.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.annotation.hoverlabel import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/annotation/hoverlabel/_font.py b/plotly/graph_objs/layout/scene/annotation/hoverlabel/_font.py deleted file mode 100644 index 626ab85458a..00000000000 --- a/plotly/graph_objs/layout/scene/annotation/hoverlabel/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.annotation.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.scene.annotatio - n.hoverlabel.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.annotation.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.annotation.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.annotation.hoverlabel import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/camera/__init__.py b/plotly/graph_objs/layout/scene/camera/__init__.py index d731c814d73..da56f3ac8ac 100644 --- a/plotly/graph_objs/layout/scene/camera/__init__.py +++ b/plotly/graph_objs/layout/scene/camera/__init__.py @@ -1,4 +1,572 @@ -from ._up import Up -from ._projection import Projection -from ._eye import Eye -from ._center import Center + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Up(_BaseLayoutHierarchyType): + + # x + # - + @property + def x(self): + """ + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @property + def y(self): + """ + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # z + # - + @property + def z(self): + """ + The 'z' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.camera' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + + y + + z + + """ + + 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 + that the z axis points up. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.scene.camera.Up + x + + y + + z + + + Returns + ------- + Up + """ + super(Up, self).__init__('up') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.camera.Up +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.camera.Up""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.camera import (up as v_up) + + # Initialize validators + # --------------------- + self._validators['x'] = v_up.XValidator() + self._validators['y'] = v_up.YValidator() + self._validators['z'] = v_up.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Projection(_BaseLayoutHierarchyType): + + # type + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.camera' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + type + Sets the projection type. The projection type could be + either "perspective" or "orthographic". The default is + "perspective". + """ + + def __init__(self, arg=None, type=None, **kwargs): + """ + Construct a new Projection object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.camera.Projection + type + Sets the projection type. The projection type could be + either "perspective" or "orthographic". The default is + "perspective". + + Returns + ------- + Projection + """ + super(Projection, self).__init__('projection') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.camera.Projection +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.camera.Projection""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.camera import ( + projection as v_projection + ) + + # Initialize validators + # --------------------- + self._validators['type'] = v_projection.TypeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Eye(_BaseLayoutHierarchyType): + + # x + # - + @property + def x(self): + """ + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @property + def y(self): + """ + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # z + # - + @property + def z(self): + """ + The 'z' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.camera' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + + y + + z + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.camera.Eye + x + + y + + z + + + Returns + ------- + Eye + """ + super(Eye, self).__init__('eye') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.camera.Eye +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.camera.Eye""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.camera import (eye as v_eye) + + # Initialize validators + # --------------------- + self._validators['x'] = v_eye.XValidator() + self._validators['y'] = v_eye.YValidator() + self._validators['z'] = v_eye.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Center(_BaseLayoutHierarchyType): + + # x + # - + @property + def x(self): + """ + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @property + def y(self): + """ + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # z + # - + @property + def z(self): + """ + The 'z' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.camera' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + + y + + z + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.camera.Center + x + + y + + z + + + Returns + ------- + Center + """ + super(Center, self).__init__('center') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.camera.Center +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.camera.Center""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.camera import (center as v_center) + + # Initialize validators + # --------------------- + self._validators['x'] = v_center.XValidator() + self._validators['y'] = v_center.YValidator() + self._validators['z'] = v_center.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/camera/_center.py b/plotly/graph_objs/layout/scene/camera/_center.py deleted file mode 100644 index 3037ca76af6..00000000000 --- a/plotly/graph_objs/layout/scene/camera/_center.py +++ /dev/null @@ -1,152 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Center(BaseLayoutHierarchyType): - - # x - # - - @property - def x(self): - """ - The 'x' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @property - def y(self): - """ - The 'y' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # z - # - - @property - def z(self): - """ - The 'z' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.camera' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - - y - - z - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.camera.Center - x - - y - - z - - - Returns - ------- - Center - """ - super(Center, self).__init__('center') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.camera.Center -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.camera.Center""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.camera import (center as v_center) - - # Initialize validators - # --------------------- - self._validators['x'] = v_center.XValidator() - self._validators['y'] = v_center.YValidator() - self._validators['z'] = v_center.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/camera/_eye.py b/plotly/graph_objs/layout/scene/camera/_eye.py deleted file mode 100644 index cb89ae1893a..00000000000 --- a/plotly/graph_objs/layout/scene/camera/_eye.py +++ /dev/null @@ -1,152 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Eye(BaseLayoutHierarchyType): - - # x - # - - @property - def x(self): - """ - The 'x' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @property - def y(self): - """ - The 'y' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # z - # - - @property - def z(self): - """ - The 'z' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.camera' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - - y - - z - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.camera.Eye - x - - y - - z - - - Returns - ------- - Eye - """ - super(Eye, self).__init__('eye') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.camera.Eye -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.camera.Eye""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.camera import (eye as v_eye) - - # Initialize validators - # --------------------- - self._validators['x'] = v_eye.XValidator() - self._validators['y'] = v_eye.YValidator() - self._validators['z'] = v_eye.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/camera/_projection.py b/plotly/graph_objs/layout/scene/camera/_projection.py deleted file mode 100644 index ec6491dff85..00000000000 --- a/plotly/graph_objs/layout/scene/camera/_projection.py +++ /dev/null @@ -1,108 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Projection(BaseLayoutHierarchyType): - - # type - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.camera' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - type - Sets the projection type. The projection type could be - either "perspective" or "orthographic". The default is - "perspective". - """ - - def __init__(self, arg=None, type=None, **kwargs): - """ - Construct a new Projection object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.camera.Projection - type - Sets the projection type. The projection type could be - either "perspective" or "orthographic". The default is - "perspective". - - Returns - ------- - Projection - """ - super(Projection, self).__init__('projection') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.camera.Projection -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.camera.Projection""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.camera import ( - projection as v_projection - ) - - # Initialize validators - # --------------------- - self._validators['type'] = v_projection.TypeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/camera/_up.py b/plotly/graph_objs/layout/scene/camera/_up.py deleted file mode 100644 index 215c6582f8d..00000000000 --- a/plotly/graph_objs/layout/scene/camera/_up.py +++ /dev/null @@ -1,152 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Up(BaseLayoutHierarchyType): - - # x - # - - @property - def x(self): - """ - The 'x' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @property - def y(self): - """ - The 'y' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # z - # - - @property - def z(self): - """ - The 'z' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.camera' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - - y - - z - - """ - - 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 - that the z axis points up. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.scene.camera.Up - x - - y - - z - - - Returns - ------- - Up - """ - super(Up, self).__init__('up') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.camera.Up -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.camera.Up""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.camera import (up as v_up) - - # Initialize validators - # --------------------- - self._validators['x'] = v_up.XValidator() - self._validators['y'] = v_up.YValidator() - self._validators['z'] = v_up.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/xaxis/__init__.py b/plotly/graph_objs/layout/scene/xaxis/__init__.py index 309df7879df..6c06a0bfba9 100644 --- a/plotly/graph_objs/layout/scene/xaxis/__init__.py +++ b/plotly/graph_objs/layout/scene/xaxis/__init__.py @@ -1,4 +1,687 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.scene.xaxis.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.xaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.xaxis.Title + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.xaxis.Title +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.xaxis.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.xaxis import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.xaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.xaxis.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.xaxis.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.xaxis.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.xaxis import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.xaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.xaxis.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.xaxis.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.xaxis.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.xaxis import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.scene.xaxis import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/layout/scene/xaxis/_tickfont.py b/plotly/graph_objs/layout/scene/xaxis/_tickfont.py deleted file mode 100644 index 24f25066d48..00000000000 --- a/plotly/graph_objs/layout/scene/xaxis/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickfont(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.xaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): - """ - Construct a new Tickfont object - - Sets the tick font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.xaxis.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.xaxis.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.xaxis.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.xaxis import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py b/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py deleted file mode 100644 index e92735e3405..00000000000 --- a/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickformatstop(BaseLayoutHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.xaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.xaxis.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.xaxis.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.xaxis.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.xaxis import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/xaxis/_title.py b/plotly/graph_objs/layout/scene/xaxis/_title.py deleted file mode 100644 index e36002e8f36..00000000000 --- a/plotly/graph_objs/layout/scene/xaxis/_title.py +++ /dev/null @@ -1,166 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Title(BaseLayoutHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.scene.xaxis.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.xaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - """ - - def __init__(self, arg=None, font=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.xaxis.Title - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.xaxis.Title -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.xaxis.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.xaxis import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/xaxis/title/__init__.py b/plotly/graph_objs/layout/scene/xaxis/title/__init__.py index c37b8b5cd28..c543ff36bfa 100644 --- a/plotly/graph_objs/layout/scene/xaxis/title/__init__.py +++ b/plotly/graph_objs/layout/scene/xaxis/title/__init__.py @@ -1 +1,229 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.xaxis.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.xaxis.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.xaxis.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.xaxis.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.xaxis.title import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/xaxis/title/_font.py b/plotly/graph_objs/layout/scene/xaxis/title/_font.py deleted file mode 100644 index 6943672759b..00000000000 --- a/plotly/graph_objs/layout/scene/xaxis/title/_font.py +++ /dev/null @@ -1,227 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.xaxis.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.xaxis.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.xaxis.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.xaxis.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.xaxis.title import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/yaxis/__init__.py b/plotly/graph_objs/layout/scene/yaxis/__init__.py index 25a9982a63f..f20bc1b616f 100644 --- a/plotly/graph_objs/layout/scene/yaxis/__init__.py +++ b/plotly/graph_objs/layout/scene/yaxis/__init__.py @@ -1,4 +1,687 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.scene.yaxis.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.yaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.yaxis.Title + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.yaxis.Title +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.yaxis.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.yaxis import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.yaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.yaxis.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.yaxis.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.yaxis.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.yaxis import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.yaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.yaxis.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.yaxis.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.yaxis.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.yaxis import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.scene.yaxis import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/layout/scene/yaxis/_tickfont.py b/plotly/graph_objs/layout/scene/yaxis/_tickfont.py deleted file mode 100644 index 3b12827bbd4..00000000000 --- a/plotly/graph_objs/layout/scene/yaxis/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickfont(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.yaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): - """ - Construct a new Tickfont object - - Sets the tick font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.yaxis.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.yaxis.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.yaxis.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.yaxis import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py b/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py deleted file mode 100644 index eed2a871347..00000000000 --- a/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickformatstop(BaseLayoutHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.yaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.yaxis.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.yaxis.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.yaxis.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.yaxis import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/yaxis/_title.py b/plotly/graph_objs/layout/scene/yaxis/_title.py deleted file mode 100644 index 912ce9bef98..00000000000 --- a/plotly/graph_objs/layout/scene/yaxis/_title.py +++ /dev/null @@ -1,166 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Title(BaseLayoutHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.scene.yaxis.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.yaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - """ - - def __init__(self, arg=None, font=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.yaxis.Title - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.yaxis.Title -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.yaxis.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.yaxis import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/yaxis/title/__init__.py b/plotly/graph_objs/layout/scene/yaxis/title/__init__.py index c37b8b5cd28..73b1770ea9f 100644 --- a/plotly/graph_objs/layout/scene/yaxis/title/__init__.py +++ b/plotly/graph_objs/layout/scene/yaxis/title/__init__.py @@ -1 +1,229 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.yaxis.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.yaxis.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.yaxis.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.yaxis.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.yaxis.title import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/yaxis/title/_font.py b/plotly/graph_objs/layout/scene/yaxis/title/_font.py deleted file mode 100644 index ba839492088..00000000000 --- a/plotly/graph_objs/layout/scene/yaxis/title/_font.py +++ /dev/null @@ -1,227 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.yaxis.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.yaxis.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.yaxis.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.yaxis.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.yaxis.title import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/zaxis/__init__.py b/plotly/graph_objs/layout/scene/zaxis/__init__.py index 0122dcd3486..50727b21d70 100644 --- a/plotly/graph_objs/layout/scene/zaxis/__init__.py +++ b/plotly/graph_objs/layout/scene/zaxis/__init__.py @@ -1,4 +1,687 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.scene.zaxis.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.zaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.zaxis.Title + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.zaxis.Title +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.zaxis.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.zaxis import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.zaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.zaxis.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.zaxis.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.zaxis.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.zaxis import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.zaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.zaxis.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.zaxis.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.zaxis.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.zaxis import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.scene.zaxis import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/layout/scene/zaxis/_tickfont.py b/plotly/graph_objs/layout/scene/zaxis/_tickfont.py deleted file mode 100644 index 64cf5f2178e..00000000000 --- a/plotly/graph_objs/layout/scene/zaxis/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickfont(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.zaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): - """ - Construct a new Tickfont object - - Sets the tick font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.zaxis.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.zaxis.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.zaxis.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.zaxis import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py b/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py deleted file mode 100644 index a64ce2f9a51..00000000000 --- a/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickformatstop(BaseLayoutHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.zaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.zaxis.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.zaxis.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.zaxis.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.zaxis import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/zaxis/_title.py b/plotly/graph_objs/layout/scene/zaxis/_title.py deleted file mode 100644 index 3d39a7fd36b..00000000000 --- a/plotly/graph_objs/layout/scene/zaxis/_title.py +++ /dev/null @@ -1,166 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Title(BaseLayoutHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.scene.zaxis.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.zaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - """ - - def __init__(self, arg=None, font=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.zaxis.Title - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.zaxis.Title -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.zaxis.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.zaxis import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/zaxis/title/__init__.py b/plotly/graph_objs/layout/scene/zaxis/title/__init__.py index c37b8b5cd28..9aa56e73a35 100644 --- a/plotly/graph_objs/layout/scene/zaxis/title/__init__.py +++ b/plotly/graph_objs/layout/scene/zaxis/title/__init__.py @@ -1 +1,229 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.scene.zaxis.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.scene.zaxis.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.scene.zaxis.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.scene.zaxis.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.scene.zaxis.title import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/scene/zaxis/title/_font.py b/plotly/graph_objs/layout/scene/zaxis/title/_font.py deleted file mode 100644 index 18f4c035764..00000000000 --- a/plotly/graph_objs/layout/scene/zaxis/title/_font.py +++ /dev/null @@ -1,227 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.scene.zaxis.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.scene.zaxis.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.scene.zaxis.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.scene.zaxis.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.scene.zaxis.title import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/shape/__init__.py b/plotly/graph_objs/layout/shape/__init__.py index 471a5835d71..4b473f7efed 100644 --- a/plotly/graph_objs/layout/shape/__init__.py +++ b/plotly/graph_objs/layout/shape/__init__.py @@ -1 +1,206 @@ -from ._line import Line + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Line(_BaseLayoutHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dash + # ---- + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is a string and must be specified as: + - One of the following strings: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', + 'longdashdot'] + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['dash'] + + @dash.setter + def dash(self, val): + self['dash'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.shape' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.shape.Line + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.shape.Line +constructor must be a dict or +an instance of plotly.graph_objs.layout.shape.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.shape import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['dash'] = v_line.DashValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dash', None) + self['dash'] = dash if dash is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/shape/_line.py b/plotly/graph_objs/layout/shape/_line.py deleted file mode 100644 index d1a0e9f745b..00000000000 --- a/plotly/graph_objs/layout/shape/_line.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Line(BaseLayoutHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dash - # ---- - @property - def dash(self): - """ - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - - The 'dash' property is a string and must be specified as: - - One of the following strings: - ['solid', 'dot', 'dash', 'longdash', 'dashdot', - 'longdashdot'] - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['dash'] - - @dash.setter - def dash(self, val): - self['dash'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.shape' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - width - Sets the line width (in px). - """ - - def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.shape.Line - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - width - Sets the line width (in px). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.shape.Line -constructor must be a dict or -an instance of plotly.graph_objs.layout.shape.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.shape import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['dash'] = v_line.DashValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dash', None) - self['dash'] = dash if dash is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/slider/__init__.py b/plotly/graph_objs/layout/slider/__init__.py index b951d547d54..c00ad5d418b 100644 --- a/plotly/graph_objs/layout/slider/__init__.py +++ b/plotly/graph_objs/layout/slider/__init__.py @@ -1,6 +1,1253 @@ -from ._transition import Transition -from ._step import Step -from ._pad import Pad -from ._font import Font -from ._currentvalue import Currentvalue + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Transition(_BaseLayoutHierarchyType): + + # duration + # -------- + @property + 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] + + Returns + ------- + int|float + """ + return self['duration'] + + @duration.setter + def duration(self, val): + self['duration'] = val + + # easing + # ------ + @property + 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', + 'elastic', 'back', 'bounce', 'linear-in', 'quad-in', + 'cubic-in', 'sin-in', 'exp-in', 'circle-in', 'elastic-in', + 'back-in', 'bounce-in', 'linear-out', 'quad-out', + 'cubic-out', 'sin-out', 'exp-out', 'circle-out', + 'elastic-out', 'back-out', 'bounce-out', 'linear-in-out', + 'quad-in-out', 'cubic-in-out', 'sin-in-out', 'exp-in-out', + 'circle-in-out', 'elastic-in-out', 'back-in-out', + 'bounce-in-out'] + + Returns + ------- + Any + """ + return self['easing'] + + @easing.setter + def easing(self, val): + self['easing'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.slider' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + duration + Sets the duration of the slider transition + easing + Sets the easing function of the slider transition + """ + + def __init__(self, arg=None, duration=None, easing=None, **kwargs): + """ + Construct a new Transition object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.slider.Transition + duration + Sets the duration of the slider transition + easing + Sets the easing function of the slider transition + + Returns + ------- + Transition + """ + super(Transition, self).__init__('transition') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.slider.Transition +constructor must be a dict or +an instance of plotly.graph_objs.layout.slider.Transition""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.slider import ( + transition as v_transition + ) + + # Initialize validators + # --------------------- + self._validators['duration'] = v_transition.DurationValidator() + self._validators['easing'] = v_transition.EasingValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('duration', None) + self['duration'] = duration if duration is not None else _v + _v = arg.pop('easing', None) + self['easing'] = easing if easing is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Step(_BaseLayoutHierarchyType): + + # args + # ---- + @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 + + Returns + ------- + list + """ + return self['args'] + + @args.setter + def args(self, val): + self['args'] = val + + # execute + # ------- + @property + def execute(self): + """ + When true, the API method is executed. When false, all other + behaviors are the same and command execution is skipped. This + may be useful when hooking into, for example, the + `plotly_sliderchange` method and executing the API command + 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) + + Returns + ------- + bool + """ + return self['execute'] + + @execute.setter + def execute(self, val): + self['execute'] = val + + # label + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['label'] + + @label.setter + def label(self, val): + self['label'] = val + + # method + # ------ + @property + def method(self): + """ + Sets the Plotly method to be called when the slider value is + changed. If the `skip` method is used, the API slider will + function as normal but 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 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'] + + Returns + ------- + Any + """ + return self['method'] + + @method.setter + def method(self, val): + self['method'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.slider' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + args + Sets the arguments values to be passed to the Plotly + method set in `method` on slide. + execute + When true, the API method is executed. When false, all + other behaviors are the same and command execution is + skipped. This may be useful when hooking into, for + example, the `plotly_sliderchange` method and executing + the API command manually without losing the benefit of + the slider automatically binding to the state of the + plot through the specification of `method` and `args`. + label + Sets the text label to appear on the slider + method + Sets the Plotly method to be called when the slider + value is changed. If the `skip` method is used, the API + slider will function as normal but 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 slider events manually via JavaScript. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + Sets the value of the slider step, used to refer to the + step programatically. Defaults to the slider label if + not provided. + visible + Determines whether or not this step is included in the + slider. + """ + + def __init__( + self, + arg=None, + args=None, + execute=None, + label=None, + method=None, + name=None, + templateitemname=None, + value=None, + visible=None, + **kwargs + ): + """ + Construct a new Step object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.slider.Step + args + Sets the arguments values to be passed to the Plotly + method set in `method` on slide. + execute + When true, the API method is executed. When false, all + other behaviors are the same and command execution is + skipped. This may be useful when hooking into, for + example, the `plotly_sliderchange` method and executing + the API command manually without losing the benefit of + the slider automatically binding to the state of the + plot through the specification of `method` and `args`. + label + Sets the text label to appear on the slider + method + Sets the Plotly method to be called when the slider + value is changed. If the `skip` method is used, the API + slider will function as normal but 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 slider events manually via JavaScript. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + Sets the value of the slider step, used to refer to the + step programatically. Defaults to the slider label if + not provided. + visible + Determines whether or not this step is included in the + slider. + + Returns + ------- + Step + """ + super(Step, self).__init__('steps') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.slider.Step +constructor must be a dict or +an instance of plotly.graph_objs.layout.slider.Step""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.slider import (step as v_step) + + # Initialize validators + # --------------------- + self._validators['args'] = v_step.ArgsValidator() + self._validators['execute'] = v_step.ExecuteValidator() + self._validators['label'] = v_step.LabelValidator() + self._validators['method'] = v_step.MethodValidator() + self._validators['name'] = v_step.NameValidator() + self._validators['templateitemname' + ] = v_step.TemplateitemnameValidator() + self._validators['value'] = v_step.ValueValidator() + self._validators['visible'] = v_step.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('args', None) + self['args'] = args if args is not None else _v + _v = arg.pop('execute', None) + self['execute'] = execute if execute is not None else _v + _v = arg.pop('label', None) + self['label'] = label if label is not None else _v + _v = arg.pop('method', None) + self['method'] = method if method is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Pad(_BaseLayoutHierarchyType): + + # b + # - + @property + 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 + + Returns + ------- + int|float + """ + return self['b'] + + @b.setter + def b(self, val): + self['b'] = val + + # l + # - + @property + 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 + + Returns + ------- + int|float + """ + return self['l'] + + @l.setter + def l(self, val): + self['l'] = val + + # r + # - + @property + 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 + + Returns + ------- + int|float + """ + return self['r'] + + @r.setter + def r(self, val): + self['r'] = val + + # t + # - + @property + 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 + + Returns + ------- + int|float + """ + return self['t'] + + @t.setter + def t(self, val): + self['t'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.slider' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + b + The amount of padding (in px) along the bottom of the + component. + l + The amount of padding (in px) on the left side of the + component. + r + The amount of padding (in px) on the right side of the + component. + t + The amount of padding (in px) along the top of the + component. + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.slider.Pad + b + The amount of padding (in px) along the bottom of the + component. + l + The amount of padding (in px) on the left side of the + component. + r + The amount of padding (in px) on the right side of the + component. + t + The amount of padding (in px) along the top of the + component. + + Returns + ------- + Pad + """ + super(Pad, self).__init__('pad') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.slider.Pad +constructor must be a dict or +an instance of plotly.graph_objs.layout.slider.Pad""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.slider import (pad as v_pad) + + # Initialize validators + # --------------------- + self._validators['b'] = v_pad.BValidator() + self._validators['l'] = v_pad.LValidator() + self._validators['r'] = v_pad.RValidator() + self._validators['t'] = v_pad.TValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('b', None) + self['b'] = b if b is not None else _v + _v = arg.pop('l', None) + self['l'] = l if l is not None else _v + _v = arg.pop('r', None) + self['r'] = r if r is not None else _v + _v = arg.pop('t', None) + self['t'] = t if t is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.slider' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.slider.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.slider.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.slider.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.slider import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Currentvalue(_BaseLayoutHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.slider.currentvalue.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # offset + # ------ + @property + 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 + + Returns + ------- + int|float + """ + return self['offset'] + + @offset.setter + def offset(self, val): + self['offset'] = val + + # prefix + # ------ + @property + 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 + + Returns + ------- + str + """ + return self['prefix'] + + @prefix.setter + def prefix(self, val): + self['prefix'] = val + + # suffix + # ------ + @property + 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 + + Returns + ------- + str + """ + return self['suffix'] + + @suffix.setter + def suffix(self, val): + self['suffix'] = val + + # visible + # ------- + @property + def visible(self): + """ + Shows the currently-selected value above the slider. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.slider' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets the font of the current value label text. + offset + The amount of space, in pixels, between the current + value label and the slider. + prefix + When currentvalue.visible is true, this sets the prefix + of the label. + suffix + When currentvalue.visible is true, this sets the suffix + of the label. + visible + Shows the currently-selected value above the slider. + xanchor + The alignment of the value readout relative to the + length of the slider. + """ + + def __init__( + self, + arg=None, + font=None, + offset=None, + prefix=None, + suffix=None, + visible=None, + xanchor=None, + **kwargs + ): + """ + Construct a new Currentvalue object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.slider.Currentvalue + font + Sets the font of the current value label text. + offset + The amount of space, in pixels, between the current + value label and the slider. + prefix + When currentvalue.visible is true, this sets the prefix + of the label. + suffix + When currentvalue.visible is true, this sets the suffix + of the label. + visible + Shows the currently-selected value above the slider. + xanchor + The alignment of the value readout relative to the + length of the slider. + + Returns + ------- + Currentvalue + """ + super(Currentvalue, self).__init__('currentvalue') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.slider.Currentvalue +constructor must be a dict or +an instance of plotly.graph_objs.layout.slider.Currentvalue""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.slider import ( + currentvalue as v_currentvalue + ) + + # Initialize validators + # --------------------- + self._validators['font'] = v_currentvalue.FontValidator() + self._validators['offset'] = v_currentvalue.OffsetValidator() + self._validators['prefix'] = v_currentvalue.PrefixValidator() + self._validators['suffix'] = v_currentvalue.SuffixValidator() + self._validators['visible'] = v_currentvalue.VisibleValidator() + self._validators['xanchor'] = v_currentvalue.XanchorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('offset', None) + self['offset'] = offset if offset is not None else _v + _v = arg.pop('prefix', None) + self['prefix'] = prefix if prefix is not None else _v + _v = arg.pop('suffix', None) + self['suffix'] = suffix if suffix is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.slider import currentvalue diff --git a/plotly/graph_objs/layout/slider/_currentvalue.py b/plotly/graph_objs/layout/slider/_currentvalue.py deleted file mode 100644 index 75b1c016dd4..00000000000 --- a/plotly/graph_objs/layout/slider/_currentvalue.py +++ /dev/null @@ -1,287 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Currentvalue(BaseLayoutHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.slider.currentvalue.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # offset - # ------ - @property - 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 - - Returns - ------- - int|float - """ - return self['offset'] - - @offset.setter - def offset(self, val): - self['offset'] = val - - # prefix - # ------ - @property - 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 - - Returns - ------- - str - """ - return self['prefix'] - - @prefix.setter - def prefix(self, val): - self['prefix'] = val - - # suffix - # ------ - @property - 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 - - Returns - ------- - str - """ - return self['suffix'] - - @suffix.setter - def suffix(self, val): - self['suffix'] = val - - # visible - # ------- - @property - def visible(self): - """ - Shows the currently-selected value above the slider. - - The 'visible' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.slider' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets the font of the current value label text. - offset - The amount of space, in pixels, between the current - value label and the slider. - prefix - When currentvalue.visible is true, this sets the prefix - of the label. - suffix - When currentvalue.visible is true, this sets the suffix - of the label. - visible - Shows the currently-selected value above the slider. - xanchor - The alignment of the value readout relative to the - length of the slider. - """ - - def __init__( - self, - arg=None, - font=None, - offset=None, - prefix=None, - suffix=None, - visible=None, - xanchor=None, - **kwargs - ): - """ - Construct a new Currentvalue object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.slider.Currentvalue - font - Sets the font of the current value label text. - offset - The amount of space, in pixels, between the current - value label and the slider. - prefix - When currentvalue.visible is true, this sets the prefix - of the label. - suffix - When currentvalue.visible is true, this sets the suffix - of the label. - visible - Shows the currently-selected value above the slider. - xanchor - The alignment of the value readout relative to the - length of the slider. - - Returns - ------- - Currentvalue - """ - super(Currentvalue, self).__init__('currentvalue') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.slider.Currentvalue -constructor must be a dict or -an instance of plotly.graph_objs.layout.slider.Currentvalue""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.slider import ( - currentvalue as v_currentvalue - ) - - # Initialize validators - # --------------------- - self._validators['font'] = v_currentvalue.FontValidator() - self._validators['offset'] = v_currentvalue.OffsetValidator() - self._validators['prefix'] = v_currentvalue.PrefixValidator() - self._validators['suffix'] = v_currentvalue.SuffixValidator() - self._validators['visible'] = v_currentvalue.VisibleValidator() - self._validators['xanchor'] = v_currentvalue.XanchorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('offset', None) - self['offset'] = offset if offset is not None else _v - _v = arg.pop('prefix', None) - self['prefix'] = prefix if prefix is not None else _v - _v = arg.pop('suffix', None) - self['suffix'] = suffix if suffix is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/slider/_font.py b/plotly/graph_objs/layout/slider/_font.py deleted file mode 100644 index a1294ba049e..00000000000 --- a/plotly/graph_objs/layout/slider/_font.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.slider' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.slider.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.slider.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.slider.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.slider import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/slider/_pad.py b/plotly/graph_objs/layout/slider/_pad.py deleted file mode 100644 index f85e9f0cb2d..00000000000 --- a/plotly/graph_objs/layout/slider/_pad.py +++ /dev/null @@ -1,193 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Pad(BaseLayoutHierarchyType): - - # b - # - - @property - 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 - - Returns - ------- - int|float - """ - return self['b'] - - @b.setter - def b(self, val): - self['b'] = val - - # l - # - - @property - 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 - - Returns - ------- - int|float - """ - return self['l'] - - @l.setter - def l(self, val): - self['l'] = val - - # r - # - - @property - 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 - - Returns - ------- - int|float - """ - return self['r'] - - @r.setter - def r(self, val): - self['r'] = val - - # t - # - - @property - 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 - - Returns - ------- - int|float - """ - return self['t'] - - @t.setter - def t(self, val): - self['t'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.slider' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - b - The amount of padding (in px) along the bottom of the - component. - l - The amount of padding (in px) on the left side of the - component. - r - The amount of padding (in px) on the right side of the - component. - t - The amount of padding (in px) along the top of the - component. - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.slider.Pad - b - The amount of padding (in px) along the bottom of the - component. - l - The amount of padding (in px) on the left side of the - component. - r - The amount of padding (in px) on the right side of the - component. - t - The amount of padding (in px) along the top of the - component. - - Returns - ------- - Pad - """ - super(Pad, self).__init__('pad') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.slider.Pad -constructor must be a dict or -an instance of plotly.graph_objs.layout.slider.Pad""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.slider import (pad as v_pad) - - # Initialize validators - # --------------------- - self._validators['b'] = v_pad.BValidator() - self._validators['l'] = v_pad.LValidator() - self._validators['r'] = v_pad.RValidator() - self._validators['t'] = v_pad.TValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('b', None) - self['b'] = b if b is not None else _v - _v = arg.pop('l', None) - self['l'] = l if l is not None else _v - _v = arg.pop('r', None) - self['r'] = r if r is not None else _v - _v = arg.pop('t', None) - self['t'] = t if t is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/slider/_step.py b/plotly/graph_objs/layout/slider/_step.py deleted file mode 100644 index c552265939e..00000000000 --- a/plotly/graph_objs/layout/slider/_step.py +++ /dev/null @@ -1,397 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Step(BaseLayoutHierarchyType): - - # args - # ---- - @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 - - Returns - ------- - list - """ - return self['args'] - - @args.setter - def args(self, val): - self['args'] = val - - # execute - # ------- - @property - def execute(self): - """ - When true, the API method is executed. When false, all other - behaviors are the same and command execution is skipped. This - may be useful when hooking into, for example, the - `plotly_sliderchange` method and executing the API command - 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) - - Returns - ------- - bool - """ - return self['execute'] - - @execute.setter - def execute(self, val): - self['execute'] = val - - # label - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['label'] - - @label.setter - def label(self, val): - self['label'] = val - - # method - # ------ - @property - def method(self): - """ - Sets the Plotly method to be called when the slider value is - changed. If the `skip` method is used, the API slider will - function as normal but 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 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'] - - Returns - ------- - Any - """ - return self['method'] - - @method.setter - def method(self, val): - self['method'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.slider' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - args - Sets the arguments values to be passed to the Plotly - method set in `method` on slide. - execute - When true, the API method is executed. When false, all - other behaviors are the same and command execution is - skipped. This may be useful when hooking into, for - example, the `plotly_sliderchange` method and executing - the API command manually without losing the benefit of - the slider automatically binding to the state of the - plot through the specification of `method` and `args`. - label - Sets the text label to appear on the slider - method - Sets the Plotly method to be called when the slider - value is changed. If the `skip` method is used, the API - slider will function as normal but 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 slider events manually via JavaScript. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - Sets the value of the slider step, used to refer to the - step programatically. Defaults to the slider label if - not provided. - visible - Determines whether or not this step is included in the - slider. - """ - - def __init__( - self, - arg=None, - args=None, - execute=None, - label=None, - method=None, - name=None, - templateitemname=None, - value=None, - visible=None, - **kwargs - ): - """ - Construct a new Step object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.slider.Step - args - Sets the arguments values to be passed to the Plotly - method set in `method` on slide. - execute - When true, the API method is executed. When false, all - other behaviors are the same and command execution is - skipped. This may be useful when hooking into, for - example, the `plotly_sliderchange` method and executing - the API command manually without losing the benefit of - the slider automatically binding to the state of the - plot through the specification of `method` and `args`. - label - Sets the text label to appear on the slider - method - Sets the Plotly method to be called when the slider - value is changed. If the `skip` method is used, the API - slider will function as normal but 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 slider events manually via JavaScript. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - Sets the value of the slider step, used to refer to the - step programatically. Defaults to the slider label if - not provided. - visible - Determines whether or not this step is included in the - slider. - - Returns - ------- - Step - """ - super(Step, self).__init__('steps') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.slider.Step -constructor must be a dict or -an instance of plotly.graph_objs.layout.slider.Step""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.slider import (step as v_step) - - # Initialize validators - # --------------------- - self._validators['args'] = v_step.ArgsValidator() - self._validators['execute'] = v_step.ExecuteValidator() - self._validators['label'] = v_step.LabelValidator() - self._validators['method'] = v_step.MethodValidator() - self._validators['name'] = v_step.NameValidator() - self._validators['templateitemname' - ] = v_step.TemplateitemnameValidator() - self._validators['value'] = v_step.ValueValidator() - self._validators['visible'] = v_step.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('args', None) - self['args'] = args if args is not None else _v - _v = arg.pop('execute', None) - self['execute'] = execute if execute is not None else _v - _v = arg.pop('label', None) - self['label'] = label if label is not None else _v - _v = arg.pop('method', None) - self['method'] = method if method is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/slider/_transition.py b/plotly/graph_objs/layout/slider/_transition.py deleted file mode 100644 index 93ea685185b..00000000000 --- a/plotly/graph_objs/layout/slider/_transition.py +++ /dev/null @@ -1,138 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Transition(BaseLayoutHierarchyType): - - # duration - # -------- - @property - 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] - - Returns - ------- - int|float - """ - return self['duration'] - - @duration.setter - def duration(self, val): - self['duration'] = val - - # easing - # ------ - @property - 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', - 'elastic', 'back', 'bounce', 'linear-in', 'quad-in', - 'cubic-in', 'sin-in', 'exp-in', 'circle-in', 'elastic-in', - 'back-in', 'bounce-in', 'linear-out', 'quad-out', - 'cubic-out', 'sin-out', 'exp-out', 'circle-out', - 'elastic-out', 'back-out', 'bounce-out', 'linear-in-out', - 'quad-in-out', 'cubic-in-out', 'sin-in-out', 'exp-in-out', - 'circle-in-out', 'elastic-in-out', 'back-in-out', - 'bounce-in-out'] - - Returns - ------- - Any - """ - return self['easing'] - - @easing.setter - def easing(self, val): - self['easing'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.slider' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - duration - Sets the duration of the slider transition - easing - Sets the easing function of the slider transition - """ - - def __init__(self, arg=None, duration=None, easing=None, **kwargs): - """ - Construct a new Transition object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.slider.Transition - duration - Sets the duration of the slider transition - easing - Sets the easing function of the slider transition - - Returns - ------- - Transition - """ - super(Transition, self).__init__('transition') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.slider.Transition -constructor must be a dict or -an instance of plotly.graph_objs.layout.slider.Transition""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.slider import ( - transition as v_transition - ) - - # Initialize validators - # --------------------- - self._validators['duration'] = v_transition.DurationValidator() - self._validators['easing'] = v_transition.EasingValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('duration', None) - self['duration'] = duration if duration is not None else _v - _v = arg.pop('easing', None) - self['easing'] = easing if easing is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/slider/currentvalue/__init__.py b/plotly/graph_objs/layout/slider/currentvalue/__init__.py index c37b8b5cd28..4a62b355b3f 100644 --- a/plotly/graph_objs/layout/slider/currentvalue/__init__.py +++ b/plotly/graph_objs/layout/slider/currentvalue/__init__.py @@ -1 +1,230 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.slider.currentvalue' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.slider.currentvalue.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.slider.currentvalue.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.slider.currentvalue.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.slider.currentvalue import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/slider/currentvalue/_font.py b/plotly/graph_objs/layout/slider/currentvalue/_font.py deleted file mode 100644 index 5c162d11a0a..00000000000 --- a/plotly/graph_objs/layout/slider/currentvalue/_font.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.slider.currentvalue' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.slider.currentvalue.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.slider.currentvalue.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.slider.currentvalue.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.slider.currentvalue import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/template/__init__.py b/plotly/graph_objs/layout/template/__init__.py index 48e419ded9b..7fe189e7b06 100644 --- a/plotly/graph_objs/layout/template/__init__.py +++ b/plotly/graph_objs/layout/template/__init__.py @@ -1,3 +1,1312 @@ -from ._layout import Layout -from ._data import Data + + +from plotly.graph_objs import Layout + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Data(_BaseLayoutHierarchyType): + + # area + # ---- + @property + def area(self): + """ + The 'area' property is a tuple of instances of + Area that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Area] + """ + return self['area'] + + @area.setter + def area(self, val): + self['area'] = val + + # barpolar + # -------- + @property + def barpolar(self): + """ + The 'barpolar' property is a tuple of instances of + Barpolar that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Barpolar] + """ + return self['barpolar'] + + @barpolar.setter + def barpolar(self, val): + self['barpolar'] = val + + # bar + # --- + @property + def bar(self): + """ + The 'bar' property is a tuple of instances of + Bar that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Bar] + """ + return self['bar'] + + @bar.setter + def bar(self, val): + self['bar'] = val + + # box + # --- + @property + def box(self): + """ + The 'box' property is a tuple of instances of + Box that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Box] + """ + return self['box'] + + @box.setter + def box(self, val): + self['box'] = val + + # candlestick + # ----------- + @property + def candlestick(self): + """ + The 'candlestick' property is a tuple of instances of + Candlestick that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Candlestick] + """ + return self['candlestick'] + + @candlestick.setter + def candlestick(self, val): + self['candlestick'] = val + + # carpet + # ------ + @property + def carpet(self): + """ + The 'carpet' property is a tuple of instances of + Carpet that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Carpet] + """ + return self['carpet'] + + @carpet.setter + def carpet(self, val): + self['carpet'] = val + + # choropleth + # ---------- + @property + def choropleth(self): + """ + The 'choropleth' property is a tuple of instances of + Choropleth that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Choropleth] + """ + return self['choropleth'] + + @choropleth.setter + def choropleth(self, val): + self['choropleth'] = val + + # cone + # ---- + @property + def cone(self): + """ + The 'cone' property is a tuple of instances of + Cone that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Cone] + """ + return self['cone'] + + @cone.setter + def cone(self, val): + self['cone'] = val + + # contourcarpet + # ------------- + @property + def contourcarpet(self): + """ + The 'contourcarpet' property is a tuple of instances of + Contourcarpet that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Contourcarpet] + """ + return self['contourcarpet'] + + @contourcarpet.setter + def contourcarpet(self, val): + self['contourcarpet'] = val + + # contour + # ------- + @property + def contour(self): + """ + The 'contour' property is a tuple of instances of + Contour that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Contour] + """ + return self['contour'] + + @contour.setter + def contour(self, val): + self['contour'] = val + + # heatmapgl + # --------- + @property + def heatmapgl(self): + """ + The 'heatmapgl' property is a tuple of instances of + Heatmapgl that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Heatmapgl] + """ + return self['heatmapgl'] + + @heatmapgl.setter + def heatmapgl(self, val): + self['heatmapgl'] = val + + # heatmap + # ------- + @property + def heatmap(self): + """ + The 'heatmap' property is a tuple of instances of + Heatmap that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Heatmap] + """ + return self['heatmap'] + + @heatmap.setter + def heatmap(self, val): + self['heatmap'] = val + + # histogram2dcontour + # ------------------ + @property + def histogram2dcontour(self): + """ + The 'histogram2dcontour' property is a tuple of instances of + Histogram2dContour that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Histogram2dContour] + """ + return self['histogram2dcontour'] + + @histogram2dcontour.setter + def histogram2dcontour(self, val): + self['histogram2dcontour'] = val + + # histogram2d + # ----------- + @property + def histogram2d(self): + """ + The 'histogram2d' property is a tuple of instances of + Histogram2d that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Histogram2d] + """ + return self['histogram2d'] + + @histogram2d.setter + def histogram2d(self, val): + self['histogram2d'] = val + + # histogram + # --------- + @property + def histogram(self): + """ + The 'histogram' property is a tuple of instances of + Histogram that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Histogram] + """ + return self['histogram'] + + @histogram.setter + def histogram(self, val): + self['histogram'] = val + + # isosurface + # ---------- + @property + def isosurface(self): + """ + The 'isosurface' property is a tuple of instances of + Isosurface that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Isosurface] + """ + return self['isosurface'] + + @isosurface.setter + def isosurface(self, val): + self['isosurface'] = val + + # mesh3d + # ------ + @property + def mesh3d(self): + """ + The 'mesh3d' property is a tuple of instances of + Mesh3d that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Mesh3d] + """ + return self['mesh3d'] + + @mesh3d.setter + def mesh3d(self, val): + self['mesh3d'] = val + + # ohlc + # ---- + @property + def ohlc(self): + """ + The 'ohlc' property is a tuple of instances of + Ohlc that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Ohlc] + """ + return self['ohlc'] + + @ohlc.setter + def ohlc(self, val): + self['ohlc'] = val + + # parcats + # ------- + @property + def parcats(self): + """ + The 'parcats' property is a tuple of instances of + Parcats that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Parcats] + """ + return self['parcats'] + + @parcats.setter + def parcats(self, val): + self['parcats'] = val + + # parcoords + # --------- + @property + def parcoords(self): + """ + The 'parcoords' property is a tuple of instances of + Parcoords that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Parcoords] + """ + return self['parcoords'] + + @parcoords.setter + def parcoords(self, val): + self['parcoords'] = val + + # pie + # --- + @property + def pie(self): + """ + The 'pie' property is a tuple of instances of + Pie that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Pie] + """ + return self['pie'] + + @pie.setter + def pie(self, val): + self['pie'] = val + + # pointcloud + # ---------- + @property + def pointcloud(self): + """ + The 'pointcloud' property is a tuple of instances of + Pointcloud that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Pointcloud] + """ + return self['pointcloud'] + + @pointcloud.setter + def pointcloud(self, val): + self['pointcloud'] = val + + # sankey + # ------ + @property + def sankey(self): + """ + The 'sankey' property is a tuple of instances of + Sankey that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Sankey] + """ + return self['sankey'] + + @sankey.setter + def sankey(self, val): + self['sankey'] = val + + # scatter3d + # --------- + @property + def scatter3d(self): + """ + The 'scatter3d' property is a tuple of instances of + Scatter3d that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Scatter3d] + """ + return self['scatter3d'] + + @scatter3d.setter + def scatter3d(self, val): + self['scatter3d'] = val + + # scattercarpet + # ------------- + @property + def scattercarpet(self): + """ + The 'scattercarpet' property is a tuple of instances of + Scattercarpet that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Scattercarpet] + """ + return self['scattercarpet'] + + @scattercarpet.setter + def scattercarpet(self, val): + self['scattercarpet'] = val + + # scattergeo + # ---------- + @property + def scattergeo(self): + """ + The 'scattergeo' property is a tuple of instances of + Scattergeo that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Scattergeo] + """ + return self['scattergeo'] + + @scattergeo.setter + def scattergeo(self, val): + self['scattergeo'] = val + + # scattergl + # --------- + @property + def scattergl(self): + """ + The 'scattergl' property is a tuple of instances of + Scattergl that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Scattergl] + """ + return self['scattergl'] + + @scattergl.setter + def scattergl(self, val): + self['scattergl'] = val + + # scattermapbox + # ------------- + @property + def scattermapbox(self): + """ + The 'scattermapbox' property is a tuple of instances of + Scattermapbox that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Scattermapbox] + """ + return self['scattermapbox'] + + @scattermapbox.setter + def scattermapbox(self, val): + self['scattermapbox'] = val + + # scatterpolargl + # -------------- + @property + def scatterpolargl(self): + """ + The 'scatterpolargl' property is a tuple of instances of + Scatterpolargl that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Scatterpolargl] + """ + return self['scatterpolargl'] + + @scatterpolargl.setter + def scatterpolargl(self, val): + self['scatterpolargl'] = val + + # scatterpolar + # ------------ + @property + def scatterpolar(self): + """ + The 'scatterpolar' property is a tuple of instances of + Scatterpolar that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Scatterpolar] + """ + return self['scatterpolar'] + + @scatterpolar.setter + def scatterpolar(self, val): + self['scatterpolar'] = val + + # scatter + # ------- + @property + def scatter(self): + """ + The 'scatter' property is a tuple of instances of + Scatter that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Scatter] + """ + return self['scatter'] + + @scatter.setter + def scatter(self, val): + self['scatter'] = val + + # scatterternary + # -------------- + @property + def scatterternary(self): + """ + The 'scatterternary' property is a tuple of instances of + Scatterternary that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Scatterternary] + """ + return self['scatterternary'] + + @scatterternary.setter + def scatterternary(self, val): + self['scatterternary'] = val + + # splom + # ----- + @property + def splom(self): + """ + The 'splom' property is a tuple of instances of + Splom that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Splom] + """ + return self['splom'] + + @splom.setter + def splom(self, val): + self['splom'] = val + + # streamtube + # ---------- + @property + def streamtube(self): + """ + The 'streamtube' property is a tuple of instances of + Streamtube that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Streamtube] + """ + return self['streamtube'] + + @streamtube.setter + def streamtube(self, val): + self['streamtube'] = val + + # surface + # ------- + @property + def surface(self): + """ + The 'surface' property is a tuple of instances of + Surface that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Surface] + """ + return self['surface'] + + @surface.setter + def surface(self, val): + self['surface'] = val + + # table + # ----- + @property + def table(self): + """ + The 'table' property is a tuple of instances of + Table that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Table] + """ + return self['table'] + + @table.setter + def table(self, val): + self['table'] = val + + # violin + # ------ + @property + def violin(self): + """ + The 'violin' property is a tuple of instances of + Violin that may be specified as: + - 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 + ------- + tuple[plotly.graph_objs.layout.template.data.Violin] + """ + return self['violin'] + + @violin.setter + def violin(self, val): + self['violin'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.template' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + area + plotly.graph_objs.layout.template.data.Area instance or + dict with compatible properties + barpolar + plotly.graph_objs.layout.template.data.Barpolar + instance or dict with compatible properties + bar + plotly.graph_objs.layout.template.data.Bar instance or + dict with compatible properties + box + plotly.graph_objs.layout.template.data.Box instance or + dict with compatible properties + candlestick + plotly.graph_objs.layout.template.data.Candlestick + instance or dict with compatible properties + carpet + plotly.graph_objs.layout.template.data.Carpet instance + or dict with compatible properties + choropleth + plotly.graph_objs.layout.template.data.Choropleth + instance or dict with compatible properties + cone + plotly.graph_objs.layout.template.data.Cone instance or + dict with compatible properties + contourcarpet + plotly.graph_objs.layout.template.data.Contourcarpet + instance or dict with compatible properties + contour + plotly.graph_objs.layout.template.data.Contour instance + or dict with compatible properties + heatmapgl + plotly.graph_objs.layout.template.data.Heatmapgl + instance or dict with compatible properties + heatmap + plotly.graph_objs.layout.template.data.Heatmap instance + or dict with compatible properties + histogram2dcontour + plotly.graph_objs.layout.template.data.Histogram2dConto + ur instance or dict with compatible properties + histogram2d + plotly.graph_objs.layout.template.data.Histogram2d + instance or dict with compatible properties + histogram + plotly.graph_objs.layout.template.data.Histogram + instance or dict with compatible properties + isosurface + plotly.graph_objs.layout.template.data.Isosurface + instance or dict with compatible properties + mesh3d + plotly.graph_objs.layout.template.data.Mesh3d instance + or dict with compatible properties + ohlc + plotly.graph_objs.layout.template.data.Ohlc instance or + dict with compatible properties + parcats + plotly.graph_objs.layout.template.data.Parcats instance + or dict with compatible properties + parcoords + plotly.graph_objs.layout.template.data.Parcoords + instance or dict with compatible properties + pie + plotly.graph_objs.layout.template.data.Pie instance or + dict with compatible properties + pointcloud + plotly.graph_objs.layout.template.data.Pointcloud + instance or dict with compatible properties + sankey + plotly.graph_objs.layout.template.data.Sankey instance + or dict with compatible properties + scatter3d + plotly.graph_objs.layout.template.data.Scatter3d + instance or dict with compatible properties + scattercarpet + plotly.graph_objs.layout.template.data.Scattercarpet + instance or dict with compatible properties + scattergeo + plotly.graph_objs.layout.template.data.Scattergeo + instance or dict with compatible properties + scattergl + plotly.graph_objs.layout.template.data.Scattergl + instance or dict with compatible properties + scattermapbox + plotly.graph_objs.layout.template.data.Scattermapbox + instance or dict with compatible properties + scatterpolargl + plotly.graph_objs.layout.template.data.Scatterpolargl + instance or dict with compatible properties + scatterpolar + plotly.graph_objs.layout.template.data.Scatterpolar + instance or dict with compatible properties + scatter + plotly.graph_objs.layout.template.data.Scatter instance + or dict with compatible properties + scatterternary + plotly.graph_objs.layout.template.data.Scatterternary + instance or dict with compatible properties + splom + plotly.graph_objs.layout.template.data.Splom instance + or dict with compatible properties + streamtube + plotly.graph_objs.layout.template.data.Streamtube + instance or dict with compatible properties + surface + plotly.graph_objs.layout.template.data.Surface instance + or dict with compatible properties + table + plotly.graph_objs.layout.template.data.Table instance + or dict with compatible properties + violin + plotly.graph_objs.layout.template.data.Violin instance + or dict with compatible properties + """ + + def __init__( + self, + arg=None, + area=None, + barpolar=None, + bar=None, + box=None, + candlestick=None, + carpet=None, + choropleth=None, + cone=None, + contourcarpet=None, + contour=None, + heatmapgl=None, + heatmap=None, + histogram2dcontour=None, + histogram2d=None, + histogram=None, + isosurface=None, + mesh3d=None, + ohlc=None, + parcats=None, + parcoords=None, + pie=None, + pointcloud=None, + sankey=None, + scatter3d=None, + scattercarpet=None, + scattergeo=None, + scattergl=None, + scattermapbox=None, + scatterpolargl=None, + scatterpolar=None, + scatter=None, + scatterternary=None, + splom=None, + streamtube=None, + surface=None, + table=None, + violin=None, + **kwargs + ): + """ + Construct a new Data object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.template.Data + area + plotly.graph_objs.layout.template.data.Area instance or + dict with compatible properties + barpolar + plotly.graph_objs.layout.template.data.Barpolar + instance or dict with compatible properties + bar + plotly.graph_objs.layout.template.data.Bar instance or + dict with compatible properties + box + plotly.graph_objs.layout.template.data.Box instance or + dict with compatible properties + candlestick + plotly.graph_objs.layout.template.data.Candlestick + instance or dict with compatible properties + carpet + plotly.graph_objs.layout.template.data.Carpet instance + or dict with compatible properties + choropleth + plotly.graph_objs.layout.template.data.Choropleth + instance or dict with compatible properties + cone + plotly.graph_objs.layout.template.data.Cone instance or + dict with compatible properties + contourcarpet + plotly.graph_objs.layout.template.data.Contourcarpet + instance or dict with compatible properties + contour + plotly.graph_objs.layout.template.data.Contour instance + or dict with compatible properties + heatmapgl + plotly.graph_objs.layout.template.data.Heatmapgl + instance or dict with compatible properties + heatmap + plotly.graph_objs.layout.template.data.Heatmap instance + or dict with compatible properties + histogram2dcontour + plotly.graph_objs.layout.template.data.Histogram2dConto + ur instance or dict with compatible properties + histogram2d + plotly.graph_objs.layout.template.data.Histogram2d + instance or dict with compatible properties + histogram + plotly.graph_objs.layout.template.data.Histogram + instance or dict with compatible properties + isosurface + plotly.graph_objs.layout.template.data.Isosurface + instance or dict with compatible properties + mesh3d + plotly.graph_objs.layout.template.data.Mesh3d instance + or dict with compatible properties + ohlc + plotly.graph_objs.layout.template.data.Ohlc instance or + dict with compatible properties + parcats + plotly.graph_objs.layout.template.data.Parcats instance + or dict with compatible properties + parcoords + plotly.graph_objs.layout.template.data.Parcoords + instance or dict with compatible properties + pie + plotly.graph_objs.layout.template.data.Pie instance or + dict with compatible properties + pointcloud + plotly.graph_objs.layout.template.data.Pointcloud + instance or dict with compatible properties + sankey + plotly.graph_objs.layout.template.data.Sankey instance + or dict with compatible properties + scatter3d + plotly.graph_objs.layout.template.data.Scatter3d + instance or dict with compatible properties + scattercarpet + plotly.graph_objs.layout.template.data.Scattercarpet + instance or dict with compatible properties + scattergeo + plotly.graph_objs.layout.template.data.Scattergeo + instance or dict with compatible properties + scattergl + plotly.graph_objs.layout.template.data.Scattergl + instance or dict with compatible properties + scattermapbox + plotly.graph_objs.layout.template.data.Scattermapbox + instance or dict with compatible properties + scatterpolargl + plotly.graph_objs.layout.template.data.Scatterpolargl + instance or dict with compatible properties + scatterpolar + plotly.graph_objs.layout.template.data.Scatterpolar + instance or dict with compatible properties + scatter + plotly.graph_objs.layout.template.data.Scatter instance + or dict with compatible properties + scatterternary + plotly.graph_objs.layout.template.data.Scatterternary + instance or dict with compatible properties + splom + plotly.graph_objs.layout.template.data.Splom instance + or dict with compatible properties + streamtube + plotly.graph_objs.layout.template.data.Streamtube + instance or dict with compatible properties + surface + plotly.graph_objs.layout.template.data.Surface instance + or dict with compatible properties + table + plotly.graph_objs.layout.template.data.Table instance + or dict with compatible properties + violin + plotly.graph_objs.layout.template.data.Violin instance + or dict with compatible properties + + Returns + ------- + Data + """ + super(Data, self).__init__('data') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.template.Data +constructor must be a dict or +an instance of plotly.graph_objs.layout.template.Data""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.template import (data as v_data) + + # Initialize validators + # --------------------- + self._validators['area'] = v_data.AreasValidator() + self._validators['barpolar'] = v_data.BarpolarsValidator() + self._validators['bar'] = v_data.BarsValidator() + self._validators['box'] = v_data.BoxsValidator() + self._validators['candlestick'] = v_data.CandlesticksValidator() + self._validators['carpet'] = v_data.CarpetsValidator() + self._validators['choropleth'] = v_data.ChoroplethsValidator() + self._validators['cone'] = v_data.ConesValidator() + self._validators['contourcarpet'] = v_data.ContourcarpetsValidator() + self._validators['contour'] = v_data.ContoursValidator() + self._validators['heatmapgl'] = v_data.HeatmapglsValidator() + self._validators['heatmap'] = v_data.HeatmapsValidator() + self._validators['histogram2dcontour' + ] = v_data.Histogram2dContoursValidator() + self._validators['histogram2d'] = v_data.Histogram2dsValidator() + self._validators['histogram'] = v_data.HistogramsValidator() + self._validators['isosurface'] = v_data.IsosurfacesValidator() + self._validators['mesh3d'] = v_data.Mesh3dsValidator() + self._validators['ohlc'] = v_data.OhlcsValidator() + self._validators['parcats'] = v_data.ParcatssValidator() + self._validators['parcoords'] = v_data.ParcoordssValidator() + self._validators['pie'] = v_data.PiesValidator() + self._validators['pointcloud'] = v_data.PointcloudsValidator() + self._validators['sankey'] = v_data.SankeysValidator() + self._validators['scatter3d'] = v_data.Scatter3dsValidator() + self._validators['scattercarpet'] = v_data.ScattercarpetsValidator() + self._validators['scattergeo'] = v_data.ScattergeosValidator() + self._validators['scattergl'] = v_data.ScatterglsValidator() + self._validators['scattermapbox'] = v_data.ScattermapboxsValidator() + self._validators['scatterpolargl'] = v_data.ScatterpolarglsValidator() + self._validators['scatterpolar'] = v_data.ScatterpolarsValidator() + self._validators['scatter'] = v_data.ScattersValidator() + self._validators['scatterternary'] = v_data.ScatterternarysValidator() + self._validators['splom'] = v_data.SplomsValidator() + self._validators['streamtube'] = v_data.StreamtubesValidator() + self._validators['surface'] = v_data.SurfacesValidator() + self._validators['table'] = v_data.TablesValidator() + self._validators['violin'] = v_data.ViolinsValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('area', None) + self['area'] = area if area is not None else _v + _v = arg.pop('barpolar', None) + self['barpolar'] = barpolar if barpolar is not None else _v + _v = arg.pop('bar', None) + self['bar'] = bar if bar is not None else _v + _v = arg.pop('box', None) + self['box'] = box if box is not None else _v + _v = arg.pop('candlestick', None) + self['candlestick'] = candlestick if candlestick is not None else _v + _v = arg.pop('carpet', None) + self['carpet'] = carpet if carpet is not None else _v + _v = arg.pop('choropleth', None) + self['choropleth'] = choropleth if choropleth is not None else _v + _v = arg.pop('cone', None) + self['cone'] = cone if cone is not None else _v + _v = arg.pop('contourcarpet', None) + self['contourcarpet' + ] = contourcarpet if contourcarpet is not None else _v + _v = arg.pop('contour', None) + self['contour'] = contour if contour is not None else _v + _v = arg.pop('heatmapgl', None) + self['heatmapgl'] = heatmapgl if heatmapgl is not None else _v + _v = arg.pop('heatmap', None) + self['heatmap'] = heatmap if heatmap is not None else _v + _v = arg.pop('histogram2dcontour', None) + self['histogram2dcontour' + ] = histogram2dcontour if histogram2dcontour is not None else _v + _v = arg.pop('histogram2d', None) + self['histogram2d'] = histogram2d if histogram2d is not None else _v + _v = arg.pop('histogram', None) + self['histogram'] = histogram if histogram is not None else _v + _v = arg.pop('isosurface', None) + self['isosurface'] = isosurface if isosurface is not None else _v + _v = arg.pop('mesh3d', None) + self['mesh3d'] = mesh3d if mesh3d is not None else _v + _v = arg.pop('ohlc', None) + self['ohlc'] = ohlc if ohlc is not None else _v + _v = arg.pop('parcats', None) + self['parcats'] = parcats if parcats is not None else _v + _v = arg.pop('parcoords', None) + self['parcoords'] = parcoords if parcoords is not None else _v + _v = arg.pop('pie', None) + self['pie'] = pie if pie is not None else _v + _v = arg.pop('pointcloud', None) + self['pointcloud'] = pointcloud if pointcloud is not None else _v + _v = arg.pop('sankey', None) + self['sankey'] = sankey if sankey is not None else _v + _v = arg.pop('scatter3d', None) + self['scatter3d'] = scatter3d if scatter3d is not None else _v + _v = arg.pop('scattercarpet', None) + self['scattercarpet' + ] = scattercarpet if scattercarpet is not None else _v + _v = arg.pop('scattergeo', None) + self['scattergeo'] = scattergeo if scattergeo is not None else _v + _v = arg.pop('scattergl', None) + self['scattergl'] = scattergl if scattergl is not None else _v + _v = arg.pop('scattermapbox', None) + self['scattermapbox' + ] = scattermapbox if scattermapbox is not None else _v + _v = arg.pop('scatterpolargl', None) + self['scatterpolargl' + ] = scatterpolargl if scatterpolargl is not None else _v + _v = arg.pop('scatterpolar', None) + self['scatterpolar'] = scatterpolar if scatterpolar is not None else _v + _v = arg.pop('scatter', None) + self['scatter'] = scatter if scatter is not None else _v + _v = arg.pop('scatterternary', None) + self['scatterternary' + ] = scatterternary if scatterternary is not None else _v + _v = arg.pop('splom', None) + self['splom'] = splom if splom is not None else _v + _v = arg.pop('streamtube', None) + self['streamtube'] = streamtube if streamtube is not None else _v + _v = arg.pop('surface', None) + self['surface'] = surface if surface is not None else _v + _v = arg.pop('table', None) + self['table'] = table if table is not None else _v + _v = arg.pop('violin', None) + self['violin'] = violin if violin is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.template import data diff --git a/plotly/graph_objs/layout/template/_data.py b/plotly/graph_objs/layout/template/_data.py deleted file mode 100644 index 18ae866ecc1..00000000000 --- a/plotly/graph_objs/layout/template/_data.py +++ /dev/null @@ -1,1304 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Data(BaseLayoutHierarchyType): - - # area - # ---- - @property - def area(self): - """ - The 'area' property is a tuple of instances of - Area that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Area] - """ - return self['area'] - - @area.setter - def area(self, val): - self['area'] = val - - # barpolar - # -------- - @property - def barpolar(self): - """ - The 'barpolar' property is a tuple of instances of - Barpolar that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Barpolar] - """ - return self['barpolar'] - - @barpolar.setter - def barpolar(self, val): - self['barpolar'] = val - - # bar - # --- - @property - def bar(self): - """ - The 'bar' property is a tuple of instances of - Bar that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Bar] - """ - return self['bar'] - - @bar.setter - def bar(self, val): - self['bar'] = val - - # box - # --- - @property - def box(self): - """ - The 'box' property is a tuple of instances of - Box that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Box] - """ - return self['box'] - - @box.setter - def box(self, val): - self['box'] = val - - # candlestick - # ----------- - @property - def candlestick(self): - """ - The 'candlestick' property is a tuple of instances of - Candlestick that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Candlestick] - """ - return self['candlestick'] - - @candlestick.setter - def candlestick(self, val): - self['candlestick'] = val - - # carpet - # ------ - @property - def carpet(self): - """ - The 'carpet' property is a tuple of instances of - Carpet that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Carpet] - """ - return self['carpet'] - - @carpet.setter - def carpet(self, val): - self['carpet'] = val - - # choropleth - # ---------- - @property - def choropleth(self): - """ - The 'choropleth' property is a tuple of instances of - Choropleth that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Choropleth] - """ - return self['choropleth'] - - @choropleth.setter - def choropleth(self, val): - self['choropleth'] = val - - # cone - # ---- - @property - def cone(self): - """ - The 'cone' property is a tuple of instances of - Cone that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Cone] - """ - return self['cone'] - - @cone.setter - def cone(self, val): - self['cone'] = val - - # contourcarpet - # ------------- - @property - def contourcarpet(self): - """ - The 'contourcarpet' property is a tuple of instances of - Contourcarpet that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Contourcarpet] - """ - return self['contourcarpet'] - - @contourcarpet.setter - def contourcarpet(self, val): - self['contourcarpet'] = val - - # contour - # ------- - @property - def contour(self): - """ - The 'contour' property is a tuple of instances of - Contour that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Contour] - """ - return self['contour'] - - @contour.setter - def contour(self, val): - self['contour'] = val - - # heatmapgl - # --------- - @property - def heatmapgl(self): - """ - The 'heatmapgl' property is a tuple of instances of - Heatmapgl that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Heatmapgl] - """ - return self['heatmapgl'] - - @heatmapgl.setter - def heatmapgl(self, val): - self['heatmapgl'] = val - - # heatmap - # ------- - @property - def heatmap(self): - """ - The 'heatmap' property is a tuple of instances of - Heatmap that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Heatmap] - """ - return self['heatmap'] - - @heatmap.setter - def heatmap(self, val): - self['heatmap'] = val - - # histogram2dcontour - # ------------------ - @property - def histogram2dcontour(self): - """ - The 'histogram2dcontour' property is a tuple of instances of - Histogram2dContour that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Histogram2dContour] - """ - return self['histogram2dcontour'] - - @histogram2dcontour.setter - def histogram2dcontour(self, val): - self['histogram2dcontour'] = val - - # histogram2d - # ----------- - @property - def histogram2d(self): - """ - The 'histogram2d' property is a tuple of instances of - Histogram2d that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Histogram2d] - """ - return self['histogram2d'] - - @histogram2d.setter - def histogram2d(self, val): - self['histogram2d'] = val - - # histogram - # --------- - @property - def histogram(self): - """ - The 'histogram' property is a tuple of instances of - Histogram that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Histogram] - """ - return self['histogram'] - - @histogram.setter - def histogram(self, val): - self['histogram'] = val - - # isosurface - # ---------- - @property - def isosurface(self): - """ - The 'isosurface' property is a tuple of instances of - Isosurface that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Isosurface] - """ - return self['isosurface'] - - @isosurface.setter - def isosurface(self, val): - self['isosurface'] = val - - # mesh3d - # ------ - @property - def mesh3d(self): - """ - The 'mesh3d' property is a tuple of instances of - Mesh3d that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Mesh3d] - """ - return self['mesh3d'] - - @mesh3d.setter - def mesh3d(self, val): - self['mesh3d'] = val - - # ohlc - # ---- - @property - def ohlc(self): - """ - The 'ohlc' property is a tuple of instances of - Ohlc that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Ohlc] - """ - return self['ohlc'] - - @ohlc.setter - def ohlc(self, val): - self['ohlc'] = val - - # parcats - # ------- - @property - def parcats(self): - """ - The 'parcats' property is a tuple of instances of - Parcats that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Parcats] - """ - return self['parcats'] - - @parcats.setter - def parcats(self, val): - self['parcats'] = val - - # parcoords - # --------- - @property - def parcoords(self): - """ - The 'parcoords' property is a tuple of instances of - Parcoords that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Parcoords] - """ - return self['parcoords'] - - @parcoords.setter - def parcoords(self, val): - self['parcoords'] = val - - # pie - # --- - @property - def pie(self): - """ - The 'pie' property is a tuple of instances of - Pie that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Pie] - """ - return self['pie'] - - @pie.setter - def pie(self, val): - self['pie'] = val - - # pointcloud - # ---------- - @property - def pointcloud(self): - """ - The 'pointcloud' property is a tuple of instances of - Pointcloud that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Pointcloud] - """ - return self['pointcloud'] - - @pointcloud.setter - def pointcloud(self, val): - self['pointcloud'] = val - - # sankey - # ------ - @property - def sankey(self): - """ - The 'sankey' property is a tuple of instances of - Sankey that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Sankey] - """ - return self['sankey'] - - @sankey.setter - def sankey(self, val): - self['sankey'] = val - - # scatter3d - # --------- - @property - def scatter3d(self): - """ - The 'scatter3d' property is a tuple of instances of - Scatter3d that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Scatter3d] - """ - return self['scatter3d'] - - @scatter3d.setter - def scatter3d(self, val): - self['scatter3d'] = val - - # scattercarpet - # ------------- - @property - def scattercarpet(self): - """ - The 'scattercarpet' property is a tuple of instances of - Scattercarpet that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Scattercarpet] - """ - return self['scattercarpet'] - - @scattercarpet.setter - def scattercarpet(self, val): - self['scattercarpet'] = val - - # scattergeo - # ---------- - @property - def scattergeo(self): - """ - The 'scattergeo' property is a tuple of instances of - Scattergeo that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Scattergeo] - """ - return self['scattergeo'] - - @scattergeo.setter - def scattergeo(self, val): - self['scattergeo'] = val - - # scattergl - # --------- - @property - def scattergl(self): - """ - The 'scattergl' property is a tuple of instances of - Scattergl that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Scattergl] - """ - return self['scattergl'] - - @scattergl.setter - def scattergl(self, val): - self['scattergl'] = val - - # scattermapbox - # ------------- - @property - def scattermapbox(self): - """ - The 'scattermapbox' property is a tuple of instances of - Scattermapbox that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Scattermapbox] - """ - return self['scattermapbox'] - - @scattermapbox.setter - def scattermapbox(self, val): - self['scattermapbox'] = val - - # scatterpolargl - # -------------- - @property - def scatterpolargl(self): - """ - The 'scatterpolargl' property is a tuple of instances of - Scatterpolargl that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Scatterpolargl] - """ - return self['scatterpolargl'] - - @scatterpolargl.setter - def scatterpolargl(self, val): - self['scatterpolargl'] = val - - # scatterpolar - # ------------ - @property - def scatterpolar(self): - """ - The 'scatterpolar' property is a tuple of instances of - Scatterpolar that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Scatterpolar] - """ - return self['scatterpolar'] - - @scatterpolar.setter - def scatterpolar(self, val): - self['scatterpolar'] = val - - # scatter - # ------- - @property - def scatter(self): - """ - The 'scatter' property is a tuple of instances of - Scatter that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Scatter] - """ - return self['scatter'] - - @scatter.setter - def scatter(self, val): - self['scatter'] = val - - # scatterternary - # -------------- - @property - def scatterternary(self): - """ - The 'scatterternary' property is a tuple of instances of - Scatterternary that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Scatterternary] - """ - return self['scatterternary'] - - @scatterternary.setter - def scatterternary(self, val): - self['scatterternary'] = val - - # splom - # ----- - @property - def splom(self): - """ - The 'splom' property is a tuple of instances of - Splom that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Splom] - """ - return self['splom'] - - @splom.setter - def splom(self, val): - self['splom'] = val - - # streamtube - # ---------- - @property - def streamtube(self): - """ - The 'streamtube' property is a tuple of instances of - Streamtube that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Streamtube] - """ - return self['streamtube'] - - @streamtube.setter - def streamtube(self, val): - self['streamtube'] = val - - # surface - # ------- - @property - def surface(self): - """ - The 'surface' property is a tuple of instances of - Surface that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Surface] - """ - return self['surface'] - - @surface.setter - def surface(self, val): - self['surface'] = val - - # table - # ----- - @property - def table(self): - """ - The 'table' property is a tuple of instances of - Table that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Table] - """ - return self['table'] - - @table.setter - def table(self, val): - self['table'] = val - - # violin - # ------ - @property - def violin(self): - """ - The 'violin' property is a tuple of instances of - Violin that may be specified as: - - 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 - ------- - tuple[plotly.graph_objs.layout.template.data.Violin] - """ - return self['violin'] - - @violin.setter - def violin(self, val): - self['violin'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.template' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - area - plotly.graph_objs.layout.template.data.Area instance or - dict with compatible properties - barpolar - plotly.graph_objs.layout.template.data.Barpolar - instance or dict with compatible properties - bar - plotly.graph_objs.layout.template.data.Bar instance or - dict with compatible properties - box - plotly.graph_objs.layout.template.data.Box instance or - dict with compatible properties - candlestick - plotly.graph_objs.layout.template.data.Candlestick - instance or dict with compatible properties - carpet - plotly.graph_objs.layout.template.data.Carpet instance - or dict with compatible properties - choropleth - plotly.graph_objs.layout.template.data.Choropleth - instance or dict with compatible properties - cone - plotly.graph_objs.layout.template.data.Cone instance or - dict with compatible properties - contourcarpet - plotly.graph_objs.layout.template.data.Contourcarpet - instance or dict with compatible properties - contour - plotly.graph_objs.layout.template.data.Contour instance - or dict with compatible properties - heatmapgl - plotly.graph_objs.layout.template.data.Heatmapgl - instance or dict with compatible properties - heatmap - plotly.graph_objs.layout.template.data.Heatmap instance - or dict with compatible properties - histogram2dcontour - plotly.graph_objs.layout.template.data.Histogram2dConto - ur instance or dict with compatible properties - histogram2d - plotly.graph_objs.layout.template.data.Histogram2d - instance or dict with compatible properties - histogram - plotly.graph_objs.layout.template.data.Histogram - instance or dict with compatible properties - isosurface - plotly.graph_objs.layout.template.data.Isosurface - instance or dict with compatible properties - mesh3d - plotly.graph_objs.layout.template.data.Mesh3d instance - or dict with compatible properties - ohlc - plotly.graph_objs.layout.template.data.Ohlc instance or - dict with compatible properties - parcats - plotly.graph_objs.layout.template.data.Parcats instance - or dict with compatible properties - parcoords - plotly.graph_objs.layout.template.data.Parcoords - instance or dict with compatible properties - pie - plotly.graph_objs.layout.template.data.Pie instance or - dict with compatible properties - pointcloud - plotly.graph_objs.layout.template.data.Pointcloud - instance or dict with compatible properties - sankey - plotly.graph_objs.layout.template.data.Sankey instance - or dict with compatible properties - scatter3d - plotly.graph_objs.layout.template.data.Scatter3d - instance or dict with compatible properties - scattercarpet - plotly.graph_objs.layout.template.data.Scattercarpet - instance or dict with compatible properties - scattergeo - plotly.graph_objs.layout.template.data.Scattergeo - instance or dict with compatible properties - scattergl - plotly.graph_objs.layout.template.data.Scattergl - instance or dict with compatible properties - scattermapbox - plotly.graph_objs.layout.template.data.Scattermapbox - instance or dict with compatible properties - scatterpolargl - plotly.graph_objs.layout.template.data.Scatterpolargl - instance or dict with compatible properties - scatterpolar - plotly.graph_objs.layout.template.data.Scatterpolar - instance or dict with compatible properties - scatter - plotly.graph_objs.layout.template.data.Scatter instance - or dict with compatible properties - scatterternary - plotly.graph_objs.layout.template.data.Scatterternary - instance or dict with compatible properties - splom - plotly.graph_objs.layout.template.data.Splom instance - or dict with compatible properties - streamtube - plotly.graph_objs.layout.template.data.Streamtube - instance or dict with compatible properties - surface - plotly.graph_objs.layout.template.data.Surface instance - or dict with compatible properties - table - plotly.graph_objs.layout.template.data.Table instance - or dict with compatible properties - violin - plotly.graph_objs.layout.template.data.Violin instance - or dict with compatible properties - """ - - def __init__( - self, - arg=None, - area=None, - barpolar=None, - bar=None, - box=None, - candlestick=None, - carpet=None, - choropleth=None, - cone=None, - contourcarpet=None, - contour=None, - heatmapgl=None, - heatmap=None, - histogram2dcontour=None, - histogram2d=None, - histogram=None, - isosurface=None, - mesh3d=None, - ohlc=None, - parcats=None, - parcoords=None, - pie=None, - pointcloud=None, - sankey=None, - scatter3d=None, - scattercarpet=None, - scattergeo=None, - scattergl=None, - scattermapbox=None, - scatterpolargl=None, - scatterpolar=None, - scatter=None, - scatterternary=None, - splom=None, - streamtube=None, - surface=None, - table=None, - violin=None, - **kwargs - ): - """ - Construct a new Data object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.template.Data - area - plotly.graph_objs.layout.template.data.Area instance or - dict with compatible properties - barpolar - plotly.graph_objs.layout.template.data.Barpolar - instance or dict with compatible properties - bar - plotly.graph_objs.layout.template.data.Bar instance or - dict with compatible properties - box - plotly.graph_objs.layout.template.data.Box instance or - dict with compatible properties - candlestick - plotly.graph_objs.layout.template.data.Candlestick - instance or dict with compatible properties - carpet - plotly.graph_objs.layout.template.data.Carpet instance - or dict with compatible properties - choropleth - plotly.graph_objs.layout.template.data.Choropleth - instance or dict with compatible properties - cone - plotly.graph_objs.layout.template.data.Cone instance or - dict with compatible properties - contourcarpet - plotly.graph_objs.layout.template.data.Contourcarpet - instance or dict with compatible properties - contour - plotly.graph_objs.layout.template.data.Contour instance - or dict with compatible properties - heatmapgl - plotly.graph_objs.layout.template.data.Heatmapgl - instance or dict with compatible properties - heatmap - plotly.graph_objs.layout.template.data.Heatmap instance - or dict with compatible properties - histogram2dcontour - plotly.graph_objs.layout.template.data.Histogram2dConto - ur instance or dict with compatible properties - histogram2d - plotly.graph_objs.layout.template.data.Histogram2d - instance or dict with compatible properties - histogram - plotly.graph_objs.layout.template.data.Histogram - instance or dict with compatible properties - isosurface - plotly.graph_objs.layout.template.data.Isosurface - instance or dict with compatible properties - mesh3d - plotly.graph_objs.layout.template.data.Mesh3d instance - or dict with compatible properties - ohlc - plotly.graph_objs.layout.template.data.Ohlc instance or - dict with compatible properties - parcats - plotly.graph_objs.layout.template.data.Parcats instance - or dict with compatible properties - parcoords - plotly.graph_objs.layout.template.data.Parcoords - instance or dict with compatible properties - pie - plotly.graph_objs.layout.template.data.Pie instance or - dict with compatible properties - pointcloud - plotly.graph_objs.layout.template.data.Pointcloud - instance or dict with compatible properties - sankey - plotly.graph_objs.layout.template.data.Sankey instance - or dict with compatible properties - scatter3d - plotly.graph_objs.layout.template.data.Scatter3d - instance or dict with compatible properties - scattercarpet - plotly.graph_objs.layout.template.data.Scattercarpet - instance or dict with compatible properties - scattergeo - plotly.graph_objs.layout.template.data.Scattergeo - instance or dict with compatible properties - scattergl - plotly.graph_objs.layout.template.data.Scattergl - instance or dict with compatible properties - scattermapbox - plotly.graph_objs.layout.template.data.Scattermapbox - instance or dict with compatible properties - scatterpolargl - plotly.graph_objs.layout.template.data.Scatterpolargl - instance or dict with compatible properties - scatterpolar - plotly.graph_objs.layout.template.data.Scatterpolar - instance or dict with compatible properties - scatter - plotly.graph_objs.layout.template.data.Scatter instance - or dict with compatible properties - scatterternary - plotly.graph_objs.layout.template.data.Scatterternary - instance or dict with compatible properties - splom - plotly.graph_objs.layout.template.data.Splom instance - or dict with compatible properties - streamtube - plotly.graph_objs.layout.template.data.Streamtube - instance or dict with compatible properties - surface - plotly.graph_objs.layout.template.data.Surface instance - or dict with compatible properties - table - plotly.graph_objs.layout.template.data.Table instance - or dict with compatible properties - violin - plotly.graph_objs.layout.template.data.Violin instance - or dict with compatible properties - - Returns - ------- - Data - """ - super(Data, self).__init__('data') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.template.Data -constructor must be a dict or -an instance of plotly.graph_objs.layout.template.Data""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.template import (data as v_data) - - # Initialize validators - # --------------------- - self._validators['area'] = v_data.AreasValidator() - self._validators['barpolar'] = v_data.BarpolarsValidator() - self._validators['bar'] = v_data.BarsValidator() - self._validators['box'] = v_data.BoxsValidator() - self._validators['candlestick'] = v_data.CandlesticksValidator() - self._validators['carpet'] = v_data.CarpetsValidator() - self._validators['choropleth'] = v_data.ChoroplethsValidator() - self._validators['cone'] = v_data.ConesValidator() - self._validators['contourcarpet'] = v_data.ContourcarpetsValidator() - self._validators['contour'] = v_data.ContoursValidator() - self._validators['heatmapgl'] = v_data.HeatmapglsValidator() - self._validators['heatmap'] = v_data.HeatmapsValidator() - self._validators['histogram2dcontour' - ] = v_data.Histogram2dContoursValidator() - self._validators['histogram2d'] = v_data.Histogram2dsValidator() - self._validators['histogram'] = v_data.HistogramsValidator() - self._validators['isosurface'] = v_data.IsosurfacesValidator() - self._validators['mesh3d'] = v_data.Mesh3dsValidator() - self._validators['ohlc'] = v_data.OhlcsValidator() - self._validators['parcats'] = v_data.ParcatssValidator() - self._validators['parcoords'] = v_data.ParcoordssValidator() - self._validators['pie'] = v_data.PiesValidator() - self._validators['pointcloud'] = v_data.PointcloudsValidator() - self._validators['sankey'] = v_data.SankeysValidator() - self._validators['scatter3d'] = v_data.Scatter3dsValidator() - self._validators['scattercarpet'] = v_data.ScattercarpetsValidator() - self._validators['scattergeo'] = v_data.ScattergeosValidator() - self._validators['scattergl'] = v_data.ScatterglsValidator() - self._validators['scattermapbox'] = v_data.ScattermapboxsValidator() - self._validators['scatterpolargl'] = v_data.ScatterpolarglsValidator() - self._validators['scatterpolar'] = v_data.ScatterpolarsValidator() - self._validators['scatter'] = v_data.ScattersValidator() - self._validators['scatterternary'] = v_data.ScatterternarysValidator() - self._validators['splom'] = v_data.SplomsValidator() - self._validators['streamtube'] = v_data.StreamtubesValidator() - self._validators['surface'] = v_data.SurfacesValidator() - self._validators['table'] = v_data.TablesValidator() - self._validators['violin'] = v_data.ViolinsValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('area', None) - self['area'] = area if area is not None else _v - _v = arg.pop('barpolar', None) - self['barpolar'] = barpolar if barpolar is not None else _v - _v = arg.pop('bar', None) - self['bar'] = bar if bar is not None else _v - _v = arg.pop('box', None) - self['box'] = box if box is not None else _v - _v = arg.pop('candlestick', None) - self['candlestick'] = candlestick if candlestick is not None else _v - _v = arg.pop('carpet', None) - self['carpet'] = carpet if carpet is not None else _v - _v = arg.pop('choropleth', None) - self['choropleth'] = choropleth if choropleth is not None else _v - _v = arg.pop('cone', None) - self['cone'] = cone if cone is not None else _v - _v = arg.pop('contourcarpet', None) - self['contourcarpet' - ] = contourcarpet if contourcarpet is not None else _v - _v = arg.pop('contour', None) - self['contour'] = contour if contour is not None else _v - _v = arg.pop('heatmapgl', None) - self['heatmapgl'] = heatmapgl if heatmapgl is not None else _v - _v = arg.pop('heatmap', None) - self['heatmap'] = heatmap if heatmap is not None else _v - _v = arg.pop('histogram2dcontour', None) - self['histogram2dcontour' - ] = histogram2dcontour if histogram2dcontour is not None else _v - _v = arg.pop('histogram2d', None) - self['histogram2d'] = histogram2d if histogram2d is not None else _v - _v = arg.pop('histogram', None) - self['histogram'] = histogram if histogram is not None else _v - _v = arg.pop('isosurface', None) - self['isosurface'] = isosurface if isosurface is not None else _v - _v = arg.pop('mesh3d', None) - self['mesh3d'] = mesh3d if mesh3d is not None else _v - _v = arg.pop('ohlc', None) - self['ohlc'] = ohlc if ohlc is not None else _v - _v = arg.pop('parcats', None) - self['parcats'] = parcats if parcats is not None else _v - _v = arg.pop('parcoords', None) - self['parcoords'] = parcoords if parcoords is not None else _v - _v = arg.pop('pie', None) - self['pie'] = pie if pie is not None else _v - _v = arg.pop('pointcloud', None) - self['pointcloud'] = pointcloud if pointcloud is not None else _v - _v = arg.pop('sankey', None) - self['sankey'] = sankey if sankey is not None else _v - _v = arg.pop('scatter3d', None) - self['scatter3d'] = scatter3d if scatter3d is not None else _v - _v = arg.pop('scattercarpet', None) - self['scattercarpet' - ] = scattercarpet if scattercarpet is not None else _v - _v = arg.pop('scattergeo', None) - self['scattergeo'] = scattergeo if scattergeo is not None else _v - _v = arg.pop('scattergl', None) - self['scattergl'] = scattergl if scattergl is not None else _v - _v = arg.pop('scattermapbox', None) - self['scattermapbox' - ] = scattermapbox if scattermapbox is not None else _v - _v = arg.pop('scatterpolargl', None) - self['scatterpolargl' - ] = scatterpolargl if scatterpolargl is not None else _v - _v = arg.pop('scatterpolar', None) - self['scatterpolar'] = scatterpolar if scatterpolar is not None else _v - _v = arg.pop('scatter', None) - self['scatter'] = scatter if scatter is not None else _v - _v = arg.pop('scatterternary', None) - self['scatterternary' - ] = scatterternary if scatterternary is not None else _v - _v = arg.pop('splom', None) - self['splom'] = splom if splom is not None else _v - _v = arg.pop('streamtube', None) - self['streamtube'] = streamtube if streamtube is not None else _v - _v = arg.pop('surface', None) - self['surface'] = surface if surface is not None else _v - _v = arg.pop('table', None) - self['table'] = table if table is not None else _v - _v = arg.pop('violin', None) - self['violin'] = violin if violin is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/template/_layout.py b/plotly/graph_objs/layout/template/_layout.py deleted file mode 100644 index 058b60b807d..00000000000 --- a/plotly/graph_objs/layout/template/_layout.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Layout diff --git a/plotly/graph_objs/layout/template/data/__init__.py b/plotly/graph_objs/layout/template/data/__init__.py index 65557532b44..5fa1861e571 100644 --- a/plotly/graph_objs/layout/template/data/__init__.py +++ b/plotly/graph_objs/layout/template/data/__init__.py @@ -1,37 +1,111 @@ -from ._violin import Violin -from ._table import Table -from ._surface import Surface -from ._streamtube import Streamtube -from ._splom import Splom -from ._scatterternary import Scatterternary -from ._scatter import Scatter -from ._scatterpolar import Scatterpolar -from ._scatterpolargl import Scatterpolargl -from ._scattermapbox import Scattermapbox -from ._scattergl import Scattergl -from ._scattergeo import Scattergeo -from ._scattercarpet import Scattercarpet -from ._scatter3d import Scatter3d -from ._sankey import Sankey -from ._pointcloud import Pointcloud -from ._pie import Pie -from ._parcoords import Parcoords -from ._parcats import Parcats -from ._ohlc import Ohlc -from ._mesh3d import Mesh3d -from ._isosurface import Isosurface -from ._histogram import Histogram -from ._histogram2d import Histogram2d -from ._histogram2dcontour import Histogram2dContour -from ._heatmap import Heatmap -from ._heatmapgl import Heatmapgl -from ._contour import Contour -from ._contourcarpet import Contourcarpet -from ._cone import Cone -from ._choropleth import Choropleth -from ._carpet import Carpet -from ._candlestick import Candlestick -from ._box import Box -from ._bar import Bar -from ._barpolar import Barpolar -from ._area import Area + + +from plotly.graph_objs import Violin + + +from plotly.graph_objs import Table + + +from plotly.graph_objs import Surface + + +from plotly.graph_objs import Streamtube + + +from plotly.graph_objs import Splom + + +from plotly.graph_objs import Scatterternary + + +from plotly.graph_objs import Scatter + + +from plotly.graph_objs import Scatterpolar + + +from plotly.graph_objs import Scatterpolargl + + +from plotly.graph_objs import Scattermapbox + + +from plotly.graph_objs import Scattergl + + +from plotly.graph_objs import Scattergeo + + +from plotly.graph_objs import Scattercarpet + + +from plotly.graph_objs import Scatter3d + + +from plotly.graph_objs import Sankey + + +from plotly.graph_objs import Pointcloud + + +from plotly.graph_objs import Pie + + +from plotly.graph_objs import Parcoords + + +from plotly.graph_objs import Parcats + + +from plotly.graph_objs import Ohlc + + +from plotly.graph_objs import Mesh3d + + +from plotly.graph_objs import Isosurface + + +from plotly.graph_objs import Histogram + + +from plotly.graph_objs import Histogram2d + + +from plotly.graph_objs import Histogram2dContour + + +from plotly.graph_objs import Heatmap + + +from plotly.graph_objs import Heatmapgl + + +from plotly.graph_objs import Contour + + +from plotly.graph_objs import Contourcarpet + + +from plotly.graph_objs import Cone + + +from plotly.graph_objs import Choropleth + + +from plotly.graph_objs import Carpet + + +from plotly.graph_objs import Candlestick + + +from plotly.graph_objs import Box + + +from plotly.graph_objs import Bar + + +from plotly.graph_objs import Barpolar + + +from plotly.graph_objs import Area diff --git a/plotly/graph_objs/layout/template/data/_area.py b/plotly/graph_objs/layout/template/data/_area.py deleted file mode 100644 index ad21bdf3e8d..00000000000 --- a/plotly/graph_objs/layout/template/data/_area.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Area diff --git a/plotly/graph_objs/layout/template/data/_bar.py b/plotly/graph_objs/layout/template/data/_bar.py deleted file mode 100644 index 5a800e64085..00000000000 --- a/plotly/graph_objs/layout/template/data/_bar.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Bar diff --git a/plotly/graph_objs/layout/template/data/_barpolar.py b/plotly/graph_objs/layout/template/data/_barpolar.py deleted file mode 100644 index 18abed8bbb6..00000000000 --- a/plotly/graph_objs/layout/template/data/_barpolar.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Barpolar diff --git a/plotly/graph_objs/layout/template/data/_box.py b/plotly/graph_objs/layout/template/data/_box.py deleted file mode 100644 index ffdd1d92139..00000000000 --- a/plotly/graph_objs/layout/template/data/_box.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Box diff --git a/plotly/graph_objs/layout/template/data/_candlestick.py b/plotly/graph_objs/layout/template/data/_candlestick.py deleted file mode 100644 index 5d11b448593..00000000000 --- a/plotly/graph_objs/layout/template/data/_candlestick.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Candlestick diff --git a/plotly/graph_objs/layout/template/data/_carpet.py b/plotly/graph_objs/layout/template/data/_carpet.py deleted file mode 100644 index b923d73904d..00000000000 --- a/plotly/graph_objs/layout/template/data/_carpet.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Carpet diff --git a/plotly/graph_objs/layout/template/data/_choropleth.py b/plotly/graph_objs/layout/template/data/_choropleth.py deleted file mode 100644 index 733e12709cc..00000000000 --- a/plotly/graph_objs/layout/template/data/_choropleth.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Choropleth diff --git a/plotly/graph_objs/layout/template/data/_cone.py b/plotly/graph_objs/layout/template/data/_cone.py deleted file mode 100644 index 7a284527a8d..00000000000 --- a/plotly/graph_objs/layout/template/data/_cone.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Cone diff --git a/plotly/graph_objs/layout/template/data/_contour.py b/plotly/graph_objs/layout/template/data/_contour.py deleted file mode 100644 index e474909a4d2..00000000000 --- a/plotly/graph_objs/layout/template/data/_contour.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Contour diff --git a/plotly/graph_objs/layout/template/data/_contourcarpet.py b/plotly/graph_objs/layout/template/data/_contourcarpet.py deleted file mode 100644 index 6240faf5100..00000000000 --- a/plotly/graph_objs/layout/template/data/_contourcarpet.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Contourcarpet diff --git a/plotly/graph_objs/layout/template/data/_heatmap.py b/plotly/graph_objs/layout/template/data/_heatmap.py deleted file mode 100644 index 6098ee83e70..00000000000 --- a/plotly/graph_objs/layout/template/data/_heatmap.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Heatmap diff --git a/plotly/graph_objs/layout/template/data/_heatmapgl.py b/plotly/graph_objs/layout/template/data/_heatmapgl.py deleted file mode 100644 index 625f2797d24..00000000000 --- a/plotly/graph_objs/layout/template/data/_heatmapgl.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Heatmapgl diff --git a/plotly/graph_objs/layout/template/data/_histogram.py b/plotly/graph_objs/layout/template/data/_histogram.py deleted file mode 100644 index 7ba4c6df2fe..00000000000 --- a/plotly/graph_objs/layout/template/data/_histogram.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Histogram diff --git a/plotly/graph_objs/layout/template/data/_histogram2d.py b/plotly/graph_objs/layout/template/data/_histogram2d.py deleted file mode 100644 index 710f7f99296..00000000000 --- a/plotly/graph_objs/layout/template/data/_histogram2d.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Histogram2d diff --git a/plotly/graph_objs/layout/template/data/_histogram2dcontour.py b/plotly/graph_objs/layout/template/data/_histogram2dcontour.py deleted file mode 100644 index 94af41aa922..00000000000 --- a/plotly/graph_objs/layout/template/data/_histogram2dcontour.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Histogram2dContour diff --git a/plotly/graph_objs/layout/template/data/_isosurface.py b/plotly/graph_objs/layout/template/data/_isosurface.py deleted file mode 100644 index 5a7885ab64b..00000000000 --- a/plotly/graph_objs/layout/template/data/_isosurface.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Isosurface diff --git a/plotly/graph_objs/layout/template/data/_mesh3d.py b/plotly/graph_objs/layout/template/data/_mesh3d.py deleted file mode 100644 index 2172a23bd4b..00000000000 --- a/plotly/graph_objs/layout/template/data/_mesh3d.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Mesh3d diff --git a/plotly/graph_objs/layout/template/data/_ohlc.py b/plotly/graph_objs/layout/template/data/_ohlc.py deleted file mode 100644 index d3f857428cc..00000000000 --- a/plotly/graph_objs/layout/template/data/_ohlc.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Ohlc diff --git a/plotly/graph_objs/layout/template/data/_parcats.py b/plotly/graph_objs/layout/template/data/_parcats.py deleted file mode 100644 index 9b0290bcce8..00000000000 --- a/plotly/graph_objs/layout/template/data/_parcats.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Parcats diff --git a/plotly/graph_objs/layout/template/data/_parcoords.py b/plotly/graph_objs/layout/template/data/_parcoords.py deleted file mode 100644 index ccf5629c54f..00000000000 --- a/plotly/graph_objs/layout/template/data/_parcoords.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Parcoords diff --git a/plotly/graph_objs/layout/template/data/_pie.py b/plotly/graph_objs/layout/template/data/_pie.py deleted file mode 100644 index 0625fd28881..00000000000 --- a/plotly/graph_objs/layout/template/data/_pie.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Pie diff --git a/plotly/graph_objs/layout/template/data/_pointcloud.py b/plotly/graph_objs/layout/template/data/_pointcloud.py deleted file mode 100644 index af62ef6313d..00000000000 --- a/plotly/graph_objs/layout/template/data/_pointcloud.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Pointcloud diff --git a/plotly/graph_objs/layout/template/data/_sankey.py b/plotly/graph_objs/layout/template/data/_sankey.py deleted file mode 100644 index b572f657ce9..00000000000 --- a/plotly/graph_objs/layout/template/data/_sankey.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Sankey diff --git a/plotly/graph_objs/layout/template/data/_scatter.py b/plotly/graph_objs/layout/template/data/_scatter.py deleted file mode 100644 index afcfab30afa..00000000000 --- a/plotly/graph_objs/layout/template/data/_scatter.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Scatter diff --git a/plotly/graph_objs/layout/template/data/_scatter3d.py b/plotly/graph_objs/layout/template/data/_scatter3d.py deleted file mode 100644 index 93146220e39..00000000000 --- a/plotly/graph_objs/layout/template/data/_scatter3d.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Scatter3d diff --git a/plotly/graph_objs/layout/template/data/_scattercarpet.py b/plotly/graph_objs/layout/template/data/_scattercarpet.py deleted file mode 100644 index 26d87ca7c1c..00000000000 --- a/plotly/graph_objs/layout/template/data/_scattercarpet.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Scattercarpet diff --git a/plotly/graph_objs/layout/template/data/_scattergeo.py b/plotly/graph_objs/layout/template/data/_scattergeo.py deleted file mode 100644 index 34308e1a081..00000000000 --- a/plotly/graph_objs/layout/template/data/_scattergeo.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Scattergeo diff --git a/plotly/graph_objs/layout/template/data/_scattergl.py b/plotly/graph_objs/layout/template/data/_scattergl.py deleted file mode 100644 index 30bd3712b80..00000000000 --- a/plotly/graph_objs/layout/template/data/_scattergl.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Scattergl diff --git a/plotly/graph_objs/layout/template/data/_scattermapbox.py b/plotly/graph_objs/layout/template/data/_scattermapbox.py deleted file mode 100644 index 6c3333aa945..00000000000 --- a/plotly/graph_objs/layout/template/data/_scattermapbox.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Scattermapbox diff --git a/plotly/graph_objs/layout/template/data/_scatterpolar.py b/plotly/graph_objs/layout/template/data/_scatterpolar.py deleted file mode 100644 index e1417b23810..00000000000 --- a/plotly/graph_objs/layout/template/data/_scatterpolar.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Scatterpolar diff --git a/plotly/graph_objs/layout/template/data/_scatterpolargl.py b/plotly/graph_objs/layout/template/data/_scatterpolargl.py deleted file mode 100644 index 60b023a581b..00000000000 --- a/plotly/graph_objs/layout/template/data/_scatterpolargl.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Scatterpolargl diff --git a/plotly/graph_objs/layout/template/data/_scatterternary.py b/plotly/graph_objs/layout/template/data/_scatterternary.py deleted file mode 100644 index 2221eadd54d..00000000000 --- a/plotly/graph_objs/layout/template/data/_scatterternary.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Scatterternary diff --git a/plotly/graph_objs/layout/template/data/_splom.py b/plotly/graph_objs/layout/template/data/_splom.py deleted file mode 100644 index 0909cdfd9dd..00000000000 --- a/plotly/graph_objs/layout/template/data/_splom.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Splom diff --git a/plotly/graph_objs/layout/template/data/_streamtube.py b/plotly/graph_objs/layout/template/data/_streamtube.py deleted file mode 100644 index 8b23c3161cb..00000000000 --- a/plotly/graph_objs/layout/template/data/_streamtube.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Streamtube diff --git a/plotly/graph_objs/layout/template/data/_surface.py b/plotly/graph_objs/layout/template/data/_surface.py deleted file mode 100644 index cfaa55d7385..00000000000 --- a/plotly/graph_objs/layout/template/data/_surface.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Surface diff --git a/plotly/graph_objs/layout/template/data/_table.py b/plotly/graph_objs/layout/template/data/_table.py deleted file mode 100644 index 2b6d4ad1e57..00000000000 --- a/plotly/graph_objs/layout/template/data/_table.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Table diff --git a/plotly/graph_objs/layout/template/data/_violin.py b/plotly/graph_objs/layout/template/data/_violin.py deleted file mode 100644 index 23221b66776..00000000000 --- a/plotly/graph_objs/layout/template/data/_violin.py +++ /dev/null @@ -1 +0,0 @@ -from plotly.graph_objs import Violin diff --git a/plotly/graph_objs/layout/ternary/__init__.py b/plotly/graph_objs/layout/ternary/__init__.py index 02c5549ed69..f9ed4ba71eb 100644 --- a/plotly/graph_objs/layout/ternary/__init__.py +++ b/plotly/graph_objs/layout/ternary/__init__.py @@ -1,7 +1,5373 @@ -from ._domain import Domain -from ._caxis import Caxis + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Domain(_BaseLayoutHierarchyType): + + # column + # ------ + @property + 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] + + Returns + ------- + int + """ + return self['column'] + + @column.setter + def column(self, val): + self['column'] = val + + # row + # --- + @property + 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] + + Returns + ------- + int + """ + return self['row'] + + @row.setter + def row(self, val): + self['row'] = val + + # x + # - + @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] + + Returns + ------- + list + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @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] + + Returns + ------- + list + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.ternary' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this ternary subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this ternary subplot . + x + Sets the horizontal domain of this ternary subplot (in + plot fraction). + y + Sets the vertical domain of this ternary subplot (in + plot fraction). + """ + + def __init__( + self, arg=None, column=None, row=None, x=None, y=None, **kwargs + ): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.ternary.Domain + column + If there is a layout grid, use the domain for this + column in the grid for this ternary subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this ternary subplot . + x + Sets the horizontal domain of this ternary subplot (in + plot fraction). + y + Sets the vertical domain of this ternary subplot (in + plot fraction). + + Returns + ------- + Domain + """ + super(Domain, self).__init__('domain') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.ternary.Domain +constructor must be a dict or +an instance of plotly.graph_objs.layout.ternary.Domain""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.ternary import (domain as v_domain) + + # Initialize validators + # --------------------- + self._validators['column'] = v_domain.ColumnValidator() + self._validators['row'] = v_domain.RowValidator() + self._validators['x'] = v_domain.XValidator() + self._validators['y'] = v_domain.YValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('column', None) + self['column'] = column if column is not None else _v + _v = arg.pop('row', None) + self['row'] = row if row is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Caxis(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # gridcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['gridcolor'] + + @gridcolor.setter + def gridcolor(self, val): + self['gridcolor'] = val + + # gridwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['gridwidth'] + + @gridwidth.setter + def gridwidth(self, val): + self['gridwidth'] = val + + # hoverformat + # ----------- + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['hoverformat'] + + @hoverformat.setter + def hoverformat(self, val): + self['hoverformat'] = val + + # layer + # ----- + @property + def layer(self): + """ + Sets the layer on which this axis is displayed. If *above + traces*, this axis is displayed above all the subplot's traces + If *below traces*, this axis is displayed below all the + subplot's traces, but above the grid lines. Useful when used + together with scatter-like traces with `cliponaxis` set to + False to show markers and/or text nodes above this axis. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['above traces', 'below traces'] + + Returns + ------- + Any + """ + return self['layer'] + + @layer.setter + def layer(self, val): + self['layer'] = val + + # linecolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['linecolor'] + + @linecolor.setter + def linecolor(self, val): + self['linecolor'] = val + + # linewidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['linewidth'] + + @linewidth.setter + def linewidth(self, val): + self['linewidth'] = val + + # min + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['min'] + + @min.setter + def min(self, val): + self['min'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showgrid + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showgrid'] + + @showgrid.setter + def showgrid(self, val): + self['showgrid'] = val + + # showline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showline'] + + @showline.setter + def showline(self, val): + self['showline'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.ternary.caxis.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.layout.ternary.caxis.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + 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 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 + ------- + plotly.graph_objs.layout.ternary.caxis.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + text + 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. + + Returns + ------- + plotly.graph_objs.layout.ternary.caxis.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # uirevision + # ---------- + @property + 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 + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.ternary' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + 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. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.ternary.caxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.tern + ary.caxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.ternary.caxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.ternary.caxis.Title instance + or dict with compatible properties + titlefont + 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. + uirevision + Controls persistence of user-driven changes in axis + `min`, and `title` if in `editable: true` + configuration. Defaults to `ternary.uirevision`. + """ + + _mapped_properties = {'titlefont': ('title', 'font')} + + def __init__( + self, + arg=None, + color=None, + dtick=None, + exponentformat=None, + gridcolor=None, + gridwidth=None, + hoverformat=None, + layer=None, + linecolor=None, + linewidth=None, + min=None, + nticks=None, + separatethousands=None, + showexponent=None, + showgrid=None, + showline=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + uirevision=None, + **kwargs + ): + """ + Construct a new Caxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.ternary.Caxis + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + 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. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.ternary.caxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.tern + ary.caxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.ternary.caxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.ternary.caxis.Title instance + or dict with compatible properties + titlefont + 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. + uirevision + Controls persistence of user-driven changes in axis + `min`, and `title` if in `editable: true` + configuration. Defaults to `ternary.uirevision`. + + Returns + ------- + Caxis + """ + super(Caxis, self).__init__('caxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.ternary.Caxis +constructor must be a dict or +an instance of plotly.graph_objs.layout.ternary.Caxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.ternary import (caxis as v_caxis) + + # Initialize validators + # --------------------- + self._validators['color'] = v_caxis.ColorValidator() + self._validators['dtick'] = v_caxis.DtickValidator() + self._validators['exponentformat'] = v_caxis.ExponentformatValidator() + self._validators['gridcolor'] = v_caxis.GridcolorValidator() + self._validators['gridwidth'] = v_caxis.GridwidthValidator() + self._validators['hoverformat'] = v_caxis.HoverformatValidator() + self._validators['layer'] = v_caxis.LayerValidator() + self._validators['linecolor'] = v_caxis.LinecolorValidator() + self._validators['linewidth'] = v_caxis.LinewidthValidator() + self._validators['min'] = v_caxis.MinValidator() + self._validators['nticks'] = v_caxis.NticksValidator() + self._validators['separatethousands' + ] = v_caxis.SeparatethousandsValidator() + self._validators['showexponent'] = v_caxis.ShowexponentValidator() + self._validators['showgrid'] = v_caxis.ShowgridValidator() + self._validators['showline'] = v_caxis.ShowlineValidator() + self._validators['showticklabels'] = v_caxis.ShowticklabelsValidator() + self._validators['showtickprefix'] = v_caxis.ShowtickprefixValidator() + self._validators['showticksuffix'] = v_caxis.ShowticksuffixValidator() + self._validators['tick0'] = v_caxis.Tick0Validator() + self._validators['tickangle'] = v_caxis.TickangleValidator() + self._validators['tickcolor'] = v_caxis.TickcolorValidator() + self._validators['tickfont'] = v_caxis.TickfontValidator() + self._validators['tickformat'] = v_caxis.TickformatValidator() + self._validators['tickformatstops'] = v_caxis.TickformatstopsValidator( + ) + self._validators['tickformatstopdefaults' + ] = v_caxis.TickformatstopValidator() + self._validators['ticklen'] = v_caxis.TicklenValidator() + self._validators['tickmode'] = v_caxis.TickmodeValidator() + self._validators['tickprefix'] = v_caxis.TickprefixValidator() + self._validators['ticks'] = v_caxis.TicksValidator() + self._validators['ticksuffix'] = v_caxis.TicksuffixValidator() + self._validators['ticktext'] = v_caxis.TicktextValidator() + self._validators['ticktextsrc'] = v_caxis.TicktextsrcValidator() + self._validators['tickvals'] = v_caxis.TickvalsValidator() + self._validators['tickvalssrc'] = v_caxis.TickvalssrcValidator() + self._validators['tickwidth'] = v_caxis.TickwidthValidator() + self._validators['title'] = v_caxis.TitleValidator() + self._validators['uirevision'] = v_caxis.UirevisionValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('gridcolor', None) + self['gridcolor'] = gridcolor if gridcolor is not None else _v + _v = arg.pop('gridwidth', None) + self['gridwidth'] = gridwidth if gridwidth is not None else _v + _v = arg.pop('hoverformat', None) + self['hoverformat'] = hoverformat if hoverformat is not None else _v + _v = arg.pop('layer', None) + self['layer'] = layer if layer is not None else _v + _v = arg.pop('linecolor', None) + self['linecolor'] = linecolor if linecolor is not None else _v + _v = arg.pop('linewidth', None) + self['linewidth'] = linewidth if linewidth is not None else _v + _v = arg.pop('min', None) + self['min'] = min if min is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showgrid', None) + self['showgrid'] = showgrid if showgrid is not None else _v + _v = arg.pop('showline', None) + self['showline'] = showline if showline is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Baxis(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # gridcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['gridcolor'] + + @gridcolor.setter + def gridcolor(self, val): + self['gridcolor'] = val + + # gridwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['gridwidth'] + + @gridwidth.setter + def gridwidth(self, val): + self['gridwidth'] = val + + # hoverformat + # ----------- + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['hoverformat'] + + @hoverformat.setter + def hoverformat(self, val): + self['hoverformat'] = val + + # layer + # ----- + @property + def layer(self): + """ + Sets the layer on which this axis is displayed. If *above + traces*, this axis is displayed above all the subplot's traces + If *below traces*, this axis is displayed below all the + subplot's traces, but above the grid lines. Useful when used + together with scatter-like traces with `cliponaxis` set to + False to show markers and/or text nodes above this axis. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['above traces', 'below traces'] + + Returns + ------- + Any + """ + return self['layer'] + + @layer.setter + def layer(self, val): + self['layer'] = val + + # linecolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['linecolor'] + + @linecolor.setter + def linecolor(self, val): + self['linecolor'] = val + + # linewidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['linewidth'] + + @linewidth.setter + def linewidth(self, val): + self['linewidth'] = val + + # min + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['min'] + + @min.setter + def min(self, val): + self['min'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showgrid + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showgrid'] + + @showgrid.setter + def showgrid(self, val): + self['showgrid'] = val + + # showline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showline'] + + @showline.setter + def showline(self, val): + self['showline'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.ternary.baxis.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.layout.ternary.baxis.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + 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 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 + ------- + plotly.graph_objs.layout.ternary.baxis.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + text + 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. + + Returns + ------- + plotly.graph_objs.layout.ternary.baxis.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # uirevision + # ---------- + @property + 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 + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.ternary' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + 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. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.ternary.baxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.tern + ary.baxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.ternary.baxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.ternary.baxis.Title instance + or dict with compatible properties + titlefont + 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. + uirevision + Controls persistence of user-driven changes in axis + `min`, and `title` if in `editable: true` + configuration. Defaults to `ternary.uirevision`. + """ + + _mapped_properties = {'titlefont': ('title', 'font')} + + def __init__( + self, + arg=None, + color=None, + dtick=None, + exponentformat=None, + gridcolor=None, + gridwidth=None, + hoverformat=None, + layer=None, + linecolor=None, + linewidth=None, + min=None, + nticks=None, + separatethousands=None, + showexponent=None, + showgrid=None, + showline=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + uirevision=None, + **kwargs + ): + """ + Construct a new Baxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.ternary.Baxis + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + 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. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.ternary.baxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.tern + ary.baxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.ternary.baxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.ternary.baxis.Title instance + or dict with compatible properties + titlefont + 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. + uirevision + Controls persistence of user-driven changes in axis + `min`, and `title` if in `editable: true` + configuration. Defaults to `ternary.uirevision`. + + Returns + ------- + Baxis + """ + super(Baxis, self).__init__('baxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.ternary.Baxis +constructor must be a dict or +an instance of plotly.graph_objs.layout.ternary.Baxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.ternary import (baxis as v_baxis) + + # Initialize validators + # --------------------- + self._validators['color'] = v_baxis.ColorValidator() + self._validators['dtick'] = v_baxis.DtickValidator() + self._validators['exponentformat'] = v_baxis.ExponentformatValidator() + self._validators['gridcolor'] = v_baxis.GridcolorValidator() + self._validators['gridwidth'] = v_baxis.GridwidthValidator() + self._validators['hoverformat'] = v_baxis.HoverformatValidator() + self._validators['layer'] = v_baxis.LayerValidator() + self._validators['linecolor'] = v_baxis.LinecolorValidator() + self._validators['linewidth'] = v_baxis.LinewidthValidator() + self._validators['min'] = v_baxis.MinValidator() + self._validators['nticks'] = v_baxis.NticksValidator() + self._validators['separatethousands' + ] = v_baxis.SeparatethousandsValidator() + self._validators['showexponent'] = v_baxis.ShowexponentValidator() + self._validators['showgrid'] = v_baxis.ShowgridValidator() + self._validators['showline'] = v_baxis.ShowlineValidator() + self._validators['showticklabels'] = v_baxis.ShowticklabelsValidator() + self._validators['showtickprefix'] = v_baxis.ShowtickprefixValidator() + self._validators['showticksuffix'] = v_baxis.ShowticksuffixValidator() + self._validators['tick0'] = v_baxis.Tick0Validator() + self._validators['tickangle'] = v_baxis.TickangleValidator() + self._validators['tickcolor'] = v_baxis.TickcolorValidator() + self._validators['tickfont'] = v_baxis.TickfontValidator() + self._validators['tickformat'] = v_baxis.TickformatValidator() + self._validators['tickformatstops'] = v_baxis.TickformatstopsValidator( + ) + self._validators['tickformatstopdefaults' + ] = v_baxis.TickformatstopValidator() + self._validators['ticklen'] = v_baxis.TicklenValidator() + self._validators['tickmode'] = v_baxis.TickmodeValidator() + self._validators['tickprefix'] = v_baxis.TickprefixValidator() + self._validators['ticks'] = v_baxis.TicksValidator() + self._validators['ticksuffix'] = v_baxis.TicksuffixValidator() + self._validators['ticktext'] = v_baxis.TicktextValidator() + self._validators['ticktextsrc'] = v_baxis.TicktextsrcValidator() + self._validators['tickvals'] = v_baxis.TickvalsValidator() + self._validators['tickvalssrc'] = v_baxis.TickvalssrcValidator() + self._validators['tickwidth'] = v_baxis.TickwidthValidator() + self._validators['title'] = v_baxis.TitleValidator() + self._validators['uirevision'] = v_baxis.UirevisionValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('gridcolor', None) + self['gridcolor'] = gridcolor if gridcolor is not None else _v + _v = arg.pop('gridwidth', None) + self['gridwidth'] = gridwidth if gridwidth is not None else _v + _v = arg.pop('hoverformat', None) + self['hoverformat'] = hoverformat if hoverformat is not None else _v + _v = arg.pop('layer', None) + self['layer'] = layer if layer is not None else _v + _v = arg.pop('linecolor', None) + self['linecolor'] = linecolor if linecolor is not None else _v + _v = arg.pop('linewidth', None) + self['linewidth'] = linewidth if linewidth is not None else _v + _v = arg.pop('min', None) + self['min'] = min if min is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showgrid', None) + self['showgrid'] = showgrid if showgrid is not None else _v + _v = arg.pop('showline', None) + self['showline'] = showline if showline is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Aaxis(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # gridcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['gridcolor'] + + @gridcolor.setter + def gridcolor(self, val): + self['gridcolor'] = val + + # gridwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['gridwidth'] + + @gridwidth.setter + def gridwidth(self, val): + self['gridwidth'] = val + + # hoverformat + # ----------- + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['hoverformat'] + + @hoverformat.setter + def hoverformat(self, val): + self['hoverformat'] = val + + # layer + # ----- + @property + def layer(self): + """ + Sets the layer on which this axis is displayed. If *above + traces*, this axis is displayed above all the subplot's traces + If *below traces*, this axis is displayed below all the + subplot's traces, but above the grid lines. Useful when used + together with scatter-like traces with `cliponaxis` set to + False to show markers and/or text nodes above this axis. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['above traces', 'below traces'] + + Returns + ------- + Any + """ + return self['layer'] + + @layer.setter + def layer(self, val): + self['layer'] = val + + # linecolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['linecolor'] + + @linecolor.setter + def linecolor(self, val): + self['linecolor'] = val + + # linewidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['linewidth'] + + @linewidth.setter + def linewidth(self, val): + self['linewidth'] = val + + # min + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['min'] + + @min.setter + def min(self, val): + self['min'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showgrid + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showgrid'] + + @showgrid.setter + def showgrid(self, val): + self['showgrid'] = val + + # showline + # -------- + @property + 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) + + Returns + ------- + bool + """ + return self['showline'] + + @showline.setter + def showline(self, val): + self['showline'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.ternary.aaxis.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.layout.ternary.aaxis.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + 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 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 + ------- + plotly.graph_objs.layout.ternary.aaxis.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + text + 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. + + Returns + ------- + plotly.graph_objs.layout.ternary.aaxis.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # uirevision + # ---------- + @property + 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 + ------- + Any + """ + return self['uirevision'] + + @uirevision.setter + def uirevision(self, val): + self['uirevision'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.ternary' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + 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. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.ternary.aaxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.tern + ary.aaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.ternary.aaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.ternary.aaxis.Title instance + or dict with compatible properties + titlefont + 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. + uirevision + Controls persistence of user-driven changes in axis + `min`, and `title` if in `editable: true` + configuration. Defaults to `ternary.uirevision`. + """ + + _mapped_properties = {'titlefont': ('title', 'font')} + + def __init__( + self, + arg=None, + color=None, + dtick=None, + exponentformat=None, + gridcolor=None, + gridwidth=None, + hoverformat=None, + layer=None, + linecolor=None, + linewidth=None, + min=None, + nticks=None, + separatethousands=None, + showexponent=None, + showgrid=None, + showline=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + uirevision=None, + **kwargs + ): + """ + Construct a new Aaxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.ternary.Aaxis + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + 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. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.ternary.aaxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.tern + ary.aaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.ternary.aaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.ternary.aaxis.Title instance + or dict with compatible properties + titlefont + 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. + uirevision + Controls persistence of user-driven changes in axis + `min`, and `title` if in `editable: true` + configuration. Defaults to `ternary.uirevision`. + + Returns + ------- + Aaxis + """ + super(Aaxis, self).__init__('aaxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.ternary.Aaxis +constructor must be a dict or +an instance of plotly.graph_objs.layout.ternary.Aaxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.ternary import (aaxis as v_aaxis) + + # Initialize validators + # --------------------- + self._validators['color'] = v_aaxis.ColorValidator() + self._validators['dtick'] = v_aaxis.DtickValidator() + self._validators['exponentformat'] = v_aaxis.ExponentformatValidator() + self._validators['gridcolor'] = v_aaxis.GridcolorValidator() + self._validators['gridwidth'] = v_aaxis.GridwidthValidator() + self._validators['hoverformat'] = v_aaxis.HoverformatValidator() + self._validators['layer'] = v_aaxis.LayerValidator() + self._validators['linecolor'] = v_aaxis.LinecolorValidator() + self._validators['linewidth'] = v_aaxis.LinewidthValidator() + self._validators['min'] = v_aaxis.MinValidator() + self._validators['nticks'] = v_aaxis.NticksValidator() + self._validators['separatethousands' + ] = v_aaxis.SeparatethousandsValidator() + self._validators['showexponent'] = v_aaxis.ShowexponentValidator() + self._validators['showgrid'] = v_aaxis.ShowgridValidator() + self._validators['showline'] = v_aaxis.ShowlineValidator() + self._validators['showticklabels'] = v_aaxis.ShowticklabelsValidator() + self._validators['showtickprefix'] = v_aaxis.ShowtickprefixValidator() + self._validators['showticksuffix'] = v_aaxis.ShowticksuffixValidator() + self._validators['tick0'] = v_aaxis.Tick0Validator() + self._validators['tickangle'] = v_aaxis.TickangleValidator() + self._validators['tickcolor'] = v_aaxis.TickcolorValidator() + self._validators['tickfont'] = v_aaxis.TickfontValidator() + self._validators['tickformat'] = v_aaxis.TickformatValidator() + self._validators['tickformatstops'] = v_aaxis.TickformatstopsValidator( + ) + self._validators['tickformatstopdefaults' + ] = v_aaxis.TickformatstopValidator() + self._validators['ticklen'] = v_aaxis.TicklenValidator() + self._validators['tickmode'] = v_aaxis.TickmodeValidator() + self._validators['tickprefix'] = v_aaxis.TickprefixValidator() + self._validators['ticks'] = v_aaxis.TicksValidator() + self._validators['ticksuffix'] = v_aaxis.TicksuffixValidator() + self._validators['ticktext'] = v_aaxis.TicktextValidator() + self._validators['ticktextsrc'] = v_aaxis.TicktextsrcValidator() + self._validators['tickvals'] = v_aaxis.TickvalsValidator() + self._validators['tickvalssrc'] = v_aaxis.TickvalssrcValidator() + self._validators['tickwidth'] = v_aaxis.TickwidthValidator() + self._validators['title'] = v_aaxis.TitleValidator() + self._validators['uirevision'] = v_aaxis.UirevisionValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('gridcolor', None) + self['gridcolor'] = gridcolor if gridcolor is not None else _v + _v = arg.pop('gridwidth', None) + self['gridwidth'] = gridwidth if gridwidth is not None else _v + _v = arg.pop('hoverformat', None) + self['hoverformat'] = hoverformat if hoverformat is not None else _v + _v = arg.pop('layer', None) + self['layer'] = layer if layer is not None else _v + _v = arg.pop('linecolor', None) + self['linecolor'] = linecolor if linecolor is not None else _v + _v = arg.pop('linewidth', None) + self['linewidth'] = linewidth if linewidth is not None else _v + _v = arg.pop('min', None) + self['min'] = min if min is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showgrid', None) + self['showgrid'] = showgrid if showgrid is not None else _v + _v = arg.pop('showline', None) + self['showline'] = showline if showline is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('uirevision', None) + self['uirevision'] = uirevision if uirevision is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.ternary import caxis -from ._baxis import Baxis from plotly.graph_objs.layout.ternary import baxis -from ._aaxis import Aaxis from plotly.graph_objs.layout.ternary import aaxis diff --git a/plotly/graph_objs/layout/ternary/_aaxis.py b/plotly/graph_objs/layout/ternary/_aaxis.py deleted file mode 100644 index ac6b020fb78..00000000000 --- a/plotly/graph_objs/layout/ternary/_aaxis.py +++ /dev/null @@ -1,1718 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Aaxis(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - Sets default for all colors associated with this axis all at - once: line, font, tick, and grid colors. Grid color is - lightened by blending this with the plot background Individual - pieces can override this. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # gridcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['gridcolor'] - - @gridcolor.setter - def gridcolor(self, val): - self['gridcolor'] = val - - # gridwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['gridwidth'] - - @gridwidth.setter - def gridwidth(self, val): - self['gridwidth'] = val - - # hoverformat - # ----------- - @property - def hoverformat(self): - """ - Sets the hover text formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'hoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['hoverformat'] - - @hoverformat.setter - def hoverformat(self, val): - self['hoverformat'] = val - - # layer - # ----- - @property - def layer(self): - """ - Sets the layer on which this axis is displayed. If *above - traces*, this axis is displayed above all the subplot's traces - If *below traces*, this axis is displayed below all the - subplot's traces, but above the grid lines. Useful when used - together with scatter-like traces with `cliponaxis` set to - False to show markers and/or text nodes above this axis. - - The 'layer' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['above traces', 'below traces'] - - Returns - ------- - Any - """ - return self['layer'] - - @layer.setter - def layer(self, val): - self['layer'] = val - - # linecolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['linecolor'] - - @linecolor.setter - def linecolor(self, val): - self['linecolor'] = val - - # linewidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['linewidth'] - - @linewidth.setter - def linewidth(self, val): - self['linewidth'] = val - - # min - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['min'] - - @min.setter - def min(self, val): - self['min'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showgrid - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showgrid'] - - @showgrid.setter - def showgrid(self, val): - self['showgrid'] = val - - # showline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showline'] - - @showline.setter - def showline(self, val): - self['showline'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - def tickfont(self): - """ - Sets the tick font. - - The 'tickfont' property is an instance of Tickfont - that may be specified as: - - An instance of 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.ternary.aaxis.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.layout.ternary.aaxis.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as - 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 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 - ------- - plotly.graph_objs.layout.ternary.aaxis.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - text - 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. - - Returns - ------- - plotly.graph_objs.layout.ternary.aaxis.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # uirevision - # ---------- - @property - 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 - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.ternary' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - layer - Sets the layer on which this axis is displayed. If - *above traces*, this axis is displayed above all the - subplot's traces If *below traces*, this axis is - displayed below all the subplot's traces, but above the - grid lines. Useful when used together with scatter-like - traces with `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - min - 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. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.ternary.aaxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.layout.tern - ary.aaxis.tickformatstopdefaults), sets the default - property values to use for elements of - layout.ternary.aaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.ternary.aaxis.Title instance - or dict with compatible properties - titlefont - 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. - uirevision - Controls persistence of user-driven changes in axis - `min`, and `title` if in `editable: true` - configuration. Defaults to `ternary.uirevision`. - """ - - _mapped_properties = {'titlefont': ('title', 'font')} - - def __init__( - self, - arg=None, - color=None, - dtick=None, - exponentformat=None, - gridcolor=None, - gridwidth=None, - hoverformat=None, - layer=None, - linecolor=None, - linewidth=None, - min=None, - nticks=None, - separatethousands=None, - showexponent=None, - showgrid=None, - showline=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - uirevision=None, - **kwargs - ): - """ - Construct a new Aaxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.ternary.Aaxis - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - layer - Sets the layer on which this axis is displayed. If - *above traces*, this axis is displayed above all the - subplot's traces If *below traces*, this axis is - displayed below all the subplot's traces, but above the - grid lines. Useful when used together with scatter-like - traces with `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - min - 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. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.ternary.aaxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.layout.tern - ary.aaxis.tickformatstopdefaults), sets the default - property values to use for elements of - layout.ternary.aaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.ternary.aaxis.Title instance - or dict with compatible properties - titlefont - 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. - uirevision - Controls persistence of user-driven changes in axis - `min`, and `title` if in `editable: true` - configuration. Defaults to `ternary.uirevision`. - - Returns - ------- - Aaxis - """ - super(Aaxis, self).__init__('aaxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.ternary.Aaxis -constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.Aaxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.ternary import (aaxis as v_aaxis) - - # Initialize validators - # --------------------- - self._validators['color'] = v_aaxis.ColorValidator() - self._validators['dtick'] = v_aaxis.DtickValidator() - self._validators['exponentformat'] = v_aaxis.ExponentformatValidator() - self._validators['gridcolor'] = v_aaxis.GridcolorValidator() - self._validators['gridwidth'] = v_aaxis.GridwidthValidator() - self._validators['hoverformat'] = v_aaxis.HoverformatValidator() - self._validators['layer'] = v_aaxis.LayerValidator() - self._validators['linecolor'] = v_aaxis.LinecolorValidator() - self._validators['linewidth'] = v_aaxis.LinewidthValidator() - self._validators['min'] = v_aaxis.MinValidator() - self._validators['nticks'] = v_aaxis.NticksValidator() - self._validators['separatethousands' - ] = v_aaxis.SeparatethousandsValidator() - self._validators['showexponent'] = v_aaxis.ShowexponentValidator() - self._validators['showgrid'] = v_aaxis.ShowgridValidator() - self._validators['showline'] = v_aaxis.ShowlineValidator() - self._validators['showticklabels'] = v_aaxis.ShowticklabelsValidator() - self._validators['showtickprefix'] = v_aaxis.ShowtickprefixValidator() - self._validators['showticksuffix'] = v_aaxis.ShowticksuffixValidator() - self._validators['tick0'] = v_aaxis.Tick0Validator() - self._validators['tickangle'] = v_aaxis.TickangleValidator() - self._validators['tickcolor'] = v_aaxis.TickcolorValidator() - self._validators['tickfont'] = v_aaxis.TickfontValidator() - self._validators['tickformat'] = v_aaxis.TickformatValidator() - self._validators['tickformatstops'] = v_aaxis.TickformatstopsValidator( - ) - self._validators['tickformatstopdefaults' - ] = v_aaxis.TickformatstopValidator() - self._validators['ticklen'] = v_aaxis.TicklenValidator() - self._validators['tickmode'] = v_aaxis.TickmodeValidator() - self._validators['tickprefix'] = v_aaxis.TickprefixValidator() - self._validators['ticks'] = v_aaxis.TicksValidator() - self._validators['ticksuffix'] = v_aaxis.TicksuffixValidator() - self._validators['ticktext'] = v_aaxis.TicktextValidator() - self._validators['ticktextsrc'] = v_aaxis.TicktextsrcValidator() - self._validators['tickvals'] = v_aaxis.TickvalsValidator() - self._validators['tickvalssrc'] = v_aaxis.TickvalssrcValidator() - self._validators['tickwidth'] = v_aaxis.TickwidthValidator() - self._validators['title'] = v_aaxis.TitleValidator() - self._validators['uirevision'] = v_aaxis.UirevisionValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('gridcolor', None) - self['gridcolor'] = gridcolor if gridcolor is not None else _v - _v = arg.pop('gridwidth', None) - self['gridwidth'] = gridwidth if gridwidth is not None else _v - _v = arg.pop('hoverformat', None) - self['hoverformat'] = hoverformat if hoverformat is not None else _v - _v = arg.pop('layer', None) - self['layer'] = layer if layer is not None else _v - _v = arg.pop('linecolor', None) - self['linecolor'] = linecolor if linecolor is not None else _v - _v = arg.pop('linewidth', None) - self['linewidth'] = linewidth if linewidth is not None else _v - _v = arg.pop('min', None) - self['min'] = min if min is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showgrid', None) - self['showgrid'] = showgrid if showgrid is not None else _v - _v = arg.pop('showline', None) - self['showline'] = showline if showline is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/_baxis.py b/plotly/graph_objs/layout/ternary/_baxis.py deleted file mode 100644 index 9aab0eda564..00000000000 --- a/plotly/graph_objs/layout/ternary/_baxis.py +++ /dev/null @@ -1,1718 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Baxis(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - Sets default for all colors associated with this axis all at - once: line, font, tick, and grid colors. Grid color is - lightened by blending this with the plot background Individual - pieces can override this. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # gridcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['gridcolor'] - - @gridcolor.setter - def gridcolor(self, val): - self['gridcolor'] = val - - # gridwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['gridwidth'] - - @gridwidth.setter - def gridwidth(self, val): - self['gridwidth'] = val - - # hoverformat - # ----------- - @property - def hoverformat(self): - """ - Sets the hover text formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'hoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['hoverformat'] - - @hoverformat.setter - def hoverformat(self, val): - self['hoverformat'] = val - - # layer - # ----- - @property - def layer(self): - """ - Sets the layer on which this axis is displayed. If *above - traces*, this axis is displayed above all the subplot's traces - If *below traces*, this axis is displayed below all the - subplot's traces, but above the grid lines. Useful when used - together with scatter-like traces with `cliponaxis` set to - False to show markers and/or text nodes above this axis. - - The 'layer' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['above traces', 'below traces'] - - Returns - ------- - Any - """ - return self['layer'] - - @layer.setter - def layer(self, val): - self['layer'] = val - - # linecolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['linecolor'] - - @linecolor.setter - def linecolor(self, val): - self['linecolor'] = val - - # linewidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['linewidth'] - - @linewidth.setter - def linewidth(self, val): - self['linewidth'] = val - - # min - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['min'] - - @min.setter - def min(self, val): - self['min'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showgrid - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showgrid'] - - @showgrid.setter - def showgrid(self, val): - self['showgrid'] = val - - # showline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showline'] - - @showline.setter - def showline(self, val): - self['showline'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - def tickfont(self): - """ - Sets the tick font. - - The 'tickfont' property is an instance of Tickfont - that may be specified as: - - An instance of 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.ternary.baxis.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.layout.ternary.baxis.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as - 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 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 - ------- - plotly.graph_objs.layout.ternary.baxis.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - text - 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. - - Returns - ------- - plotly.graph_objs.layout.ternary.baxis.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # uirevision - # ---------- - @property - 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 - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.ternary' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - layer - Sets the layer on which this axis is displayed. If - *above traces*, this axis is displayed above all the - subplot's traces If *below traces*, this axis is - displayed below all the subplot's traces, but above the - grid lines. Useful when used together with scatter-like - traces with `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - min - 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. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.ternary.baxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.layout.tern - ary.baxis.tickformatstopdefaults), sets the default - property values to use for elements of - layout.ternary.baxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.ternary.baxis.Title instance - or dict with compatible properties - titlefont - 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. - uirevision - Controls persistence of user-driven changes in axis - `min`, and `title` if in `editable: true` - configuration. Defaults to `ternary.uirevision`. - """ - - _mapped_properties = {'titlefont': ('title', 'font')} - - def __init__( - self, - arg=None, - color=None, - dtick=None, - exponentformat=None, - gridcolor=None, - gridwidth=None, - hoverformat=None, - layer=None, - linecolor=None, - linewidth=None, - min=None, - nticks=None, - separatethousands=None, - showexponent=None, - showgrid=None, - showline=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - uirevision=None, - **kwargs - ): - """ - Construct a new Baxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.ternary.Baxis - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - layer - Sets the layer on which this axis is displayed. If - *above traces*, this axis is displayed above all the - subplot's traces If *below traces*, this axis is - displayed below all the subplot's traces, but above the - grid lines. Useful when used together with scatter-like - traces with `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - min - 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. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.ternary.baxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.layout.tern - ary.baxis.tickformatstopdefaults), sets the default - property values to use for elements of - layout.ternary.baxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.ternary.baxis.Title instance - or dict with compatible properties - titlefont - 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. - uirevision - Controls persistence of user-driven changes in axis - `min`, and `title` if in `editable: true` - configuration. Defaults to `ternary.uirevision`. - - Returns - ------- - Baxis - """ - super(Baxis, self).__init__('baxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.ternary.Baxis -constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.Baxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.ternary import (baxis as v_baxis) - - # Initialize validators - # --------------------- - self._validators['color'] = v_baxis.ColorValidator() - self._validators['dtick'] = v_baxis.DtickValidator() - self._validators['exponentformat'] = v_baxis.ExponentformatValidator() - self._validators['gridcolor'] = v_baxis.GridcolorValidator() - self._validators['gridwidth'] = v_baxis.GridwidthValidator() - self._validators['hoverformat'] = v_baxis.HoverformatValidator() - self._validators['layer'] = v_baxis.LayerValidator() - self._validators['linecolor'] = v_baxis.LinecolorValidator() - self._validators['linewidth'] = v_baxis.LinewidthValidator() - self._validators['min'] = v_baxis.MinValidator() - self._validators['nticks'] = v_baxis.NticksValidator() - self._validators['separatethousands' - ] = v_baxis.SeparatethousandsValidator() - self._validators['showexponent'] = v_baxis.ShowexponentValidator() - self._validators['showgrid'] = v_baxis.ShowgridValidator() - self._validators['showline'] = v_baxis.ShowlineValidator() - self._validators['showticklabels'] = v_baxis.ShowticklabelsValidator() - self._validators['showtickprefix'] = v_baxis.ShowtickprefixValidator() - self._validators['showticksuffix'] = v_baxis.ShowticksuffixValidator() - self._validators['tick0'] = v_baxis.Tick0Validator() - self._validators['tickangle'] = v_baxis.TickangleValidator() - self._validators['tickcolor'] = v_baxis.TickcolorValidator() - self._validators['tickfont'] = v_baxis.TickfontValidator() - self._validators['tickformat'] = v_baxis.TickformatValidator() - self._validators['tickformatstops'] = v_baxis.TickformatstopsValidator( - ) - self._validators['tickformatstopdefaults' - ] = v_baxis.TickformatstopValidator() - self._validators['ticklen'] = v_baxis.TicklenValidator() - self._validators['tickmode'] = v_baxis.TickmodeValidator() - self._validators['tickprefix'] = v_baxis.TickprefixValidator() - self._validators['ticks'] = v_baxis.TicksValidator() - self._validators['ticksuffix'] = v_baxis.TicksuffixValidator() - self._validators['ticktext'] = v_baxis.TicktextValidator() - self._validators['ticktextsrc'] = v_baxis.TicktextsrcValidator() - self._validators['tickvals'] = v_baxis.TickvalsValidator() - self._validators['tickvalssrc'] = v_baxis.TickvalssrcValidator() - self._validators['tickwidth'] = v_baxis.TickwidthValidator() - self._validators['title'] = v_baxis.TitleValidator() - self._validators['uirevision'] = v_baxis.UirevisionValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('gridcolor', None) - self['gridcolor'] = gridcolor if gridcolor is not None else _v - _v = arg.pop('gridwidth', None) - self['gridwidth'] = gridwidth if gridwidth is not None else _v - _v = arg.pop('hoverformat', None) - self['hoverformat'] = hoverformat if hoverformat is not None else _v - _v = arg.pop('layer', None) - self['layer'] = layer if layer is not None else _v - _v = arg.pop('linecolor', None) - self['linecolor'] = linecolor if linecolor is not None else _v - _v = arg.pop('linewidth', None) - self['linewidth'] = linewidth if linewidth is not None else _v - _v = arg.pop('min', None) - self['min'] = min if min is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showgrid', None) - self['showgrid'] = showgrid if showgrid is not None else _v - _v = arg.pop('showline', None) - self['showline'] = showline if showline is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/_caxis.py b/plotly/graph_objs/layout/ternary/_caxis.py deleted file mode 100644 index e943fb5e579..00000000000 --- a/plotly/graph_objs/layout/ternary/_caxis.py +++ /dev/null @@ -1,1718 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Caxis(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - Sets default for all colors associated with this axis all at - once: line, font, tick, and grid colors. Grid color is - lightened by blending this with the plot background Individual - pieces can override this. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # gridcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['gridcolor'] - - @gridcolor.setter - def gridcolor(self, val): - self['gridcolor'] = val - - # gridwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['gridwidth'] - - @gridwidth.setter - def gridwidth(self, val): - self['gridwidth'] = val - - # hoverformat - # ----------- - @property - def hoverformat(self): - """ - Sets the hover text formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'hoverformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['hoverformat'] - - @hoverformat.setter - def hoverformat(self, val): - self['hoverformat'] = val - - # layer - # ----- - @property - def layer(self): - """ - Sets the layer on which this axis is displayed. If *above - traces*, this axis is displayed above all the subplot's traces - If *below traces*, this axis is displayed below all the - subplot's traces, but above the grid lines. Useful when used - together with scatter-like traces with `cliponaxis` set to - False to show markers and/or text nodes above this axis. - - The 'layer' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['above traces', 'below traces'] - - Returns - ------- - Any - """ - return self['layer'] - - @layer.setter - def layer(self, val): - self['layer'] = val - - # linecolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['linecolor'] - - @linecolor.setter - def linecolor(self, val): - self['linecolor'] = val - - # linewidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['linewidth'] - - @linewidth.setter - def linewidth(self, val): - self['linewidth'] = val - - # min - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['min'] - - @min.setter - def min(self, val): - self['min'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showgrid - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showgrid'] - - @showgrid.setter - def showgrid(self, val): - self['showgrid'] = val - - # showline - # -------- - @property - 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) - - Returns - ------- - bool - """ - return self['showline'] - - @showline.setter - def showline(self, val): - self['showline'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - def tickfont(self): - """ - Sets the tick font. - - The 'tickfont' property is an instance of Tickfont - that may be specified as: - - An instance of 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.ternary.caxis.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.layout.ternary.caxis.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as - 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 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 - ------- - plotly.graph_objs.layout.ternary.caxis.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - text - 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. - - Returns - ------- - plotly.graph_objs.layout.ternary.caxis.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # uirevision - # ---------- - @property - 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 - ------- - Any - """ - return self['uirevision'] - - @uirevision.setter - def uirevision(self, val): - self['uirevision'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.ternary' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - layer - Sets the layer on which this axis is displayed. If - *above traces*, this axis is displayed above all the - subplot's traces If *below traces*, this axis is - displayed below all the subplot's traces, but above the - grid lines. Useful when used together with scatter-like - traces with `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - min - 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. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.ternary.caxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.layout.tern - ary.caxis.tickformatstopdefaults), sets the default - property values to use for elements of - layout.ternary.caxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.ternary.caxis.Title instance - or dict with compatible properties - titlefont - 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. - uirevision - Controls persistence of user-driven changes in axis - `min`, and `title` if in `editable: true` - configuration. Defaults to `ternary.uirevision`. - """ - - _mapped_properties = {'titlefont': ('title', 'font')} - - def __init__( - self, - arg=None, - color=None, - dtick=None, - exponentformat=None, - gridcolor=None, - gridwidth=None, - hoverformat=None, - layer=None, - linecolor=None, - linewidth=None, - min=None, - nticks=None, - separatethousands=None, - showexponent=None, - showgrid=None, - showline=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - uirevision=None, - **kwargs - ): - """ - Construct a new Caxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.ternary.Caxis - color - Sets default for all colors associated with this axis - all at once: line, font, tick, and grid colors. Grid - color is lightened by blending this with the plot - background Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - layer - Sets the layer on which this axis is displayed. If - *above traces*, this axis is displayed above all the - subplot's traces If *below traces*, this axis is - displayed below all the subplot's traces, but above the - grid lines. Useful when used together with scatter-like - traces with `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - min - 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. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showgrid - Determines whether or not grid lines are drawn. If - True, the grid lines are drawn at every tick mark. - showline - Determines whether or not a line bounding this axis is - drawn. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.ternary.caxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.layout.tern - ary.caxis.tickformatstopdefaults), sets the default - property values to use for elements of - layout.ternary.caxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.ternary.caxis.Title instance - or dict with compatible properties - titlefont - 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. - uirevision - Controls persistence of user-driven changes in axis - `min`, and `title` if in `editable: true` - configuration. Defaults to `ternary.uirevision`. - - Returns - ------- - Caxis - """ - super(Caxis, self).__init__('caxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.ternary.Caxis -constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.Caxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.ternary import (caxis as v_caxis) - - # Initialize validators - # --------------------- - self._validators['color'] = v_caxis.ColorValidator() - self._validators['dtick'] = v_caxis.DtickValidator() - self._validators['exponentformat'] = v_caxis.ExponentformatValidator() - self._validators['gridcolor'] = v_caxis.GridcolorValidator() - self._validators['gridwidth'] = v_caxis.GridwidthValidator() - self._validators['hoverformat'] = v_caxis.HoverformatValidator() - self._validators['layer'] = v_caxis.LayerValidator() - self._validators['linecolor'] = v_caxis.LinecolorValidator() - self._validators['linewidth'] = v_caxis.LinewidthValidator() - self._validators['min'] = v_caxis.MinValidator() - self._validators['nticks'] = v_caxis.NticksValidator() - self._validators['separatethousands' - ] = v_caxis.SeparatethousandsValidator() - self._validators['showexponent'] = v_caxis.ShowexponentValidator() - self._validators['showgrid'] = v_caxis.ShowgridValidator() - self._validators['showline'] = v_caxis.ShowlineValidator() - self._validators['showticklabels'] = v_caxis.ShowticklabelsValidator() - self._validators['showtickprefix'] = v_caxis.ShowtickprefixValidator() - self._validators['showticksuffix'] = v_caxis.ShowticksuffixValidator() - self._validators['tick0'] = v_caxis.Tick0Validator() - self._validators['tickangle'] = v_caxis.TickangleValidator() - self._validators['tickcolor'] = v_caxis.TickcolorValidator() - self._validators['tickfont'] = v_caxis.TickfontValidator() - self._validators['tickformat'] = v_caxis.TickformatValidator() - self._validators['tickformatstops'] = v_caxis.TickformatstopsValidator( - ) - self._validators['tickformatstopdefaults' - ] = v_caxis.TickformatstopValidator() - self._validators['ticklen'] = v_caxis.TicklenValidator() - self._validators['tickmode'] = v_caxis.TickmodeValidator() - self._validators['tickprefix'] = v_caxis.TickprefixValidator() - self._validators['ticks'] = v_caxis.TicksValidator() - self._validators['ticksuffix'] = v_caxis.TicksuffixValidator() - self._validators['ticktext'] = v_caxis.TicktextValidator() - self._validators['ticktextsrc'] = v_caxis.TicktextsrcValidator() - self._validators['tickvals'] = v_caxis.TickvalsValidator() - self._validators['tickvalssrc'] = v_caxis.TickvalssrcValidator() - self._validators['tickwidth'] = v_caxis.TickwidthValidator() - self._validators['title'] = v_caxis.TitleValidator() - self._validators['uirevision'] = v_caxis.UirevisionValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('gridcolor', None) - self['gridcolor'] = gridcolor if gridcolor is not None else _v - _v = arg.pop('gridwidth', None) - self['gridwidth'] = gridwidth if gridwidth is not None else _v - _v = arg.pop('hoverformat', None) - self['hoverformat'] = hoverformat if hoverformat is not None else _v - _v = arg.pop('layer', None) - self['layer'] = layer if layer is not None else _v - _v = arg.pop('linecolor', None) - self['linecolor'] = linecolor if linecolor is not None else _v - _v = arg.pop('linewidth', None) - self['linewidth'] = linewidth if linewidth is not None else _v - _v = arg.pop('min', None) - self['min'] = min if min is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showgrid', None) - self['showgrid'] = showgrid if showgrid is not None else _v - _v = arg.pop('showline', None) - self['showline'] = showline if showline is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('uirevision', None) - self['uirevision'] = uirevision if uirevision is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/_domain.py b/plotly/graph_objs/layout/ternary/_domain.py deleted file mode 100644 index 91f54c39bb8..00000000000 --- a/plotly/graph_objs/layout/ternary/_domain.py +++ /dev/null @@ -1,206 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Domain(BaseLayoutHierarchyType): - - # column - # ------ - @property - 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] - - Returns - ------- - int - """ - return self['column'] - - @column.setter - def column(self, val): - self['column'] = val - - # row - # --- - @property - 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] - - Returns - ------- - int - """ - return self['row'] - - @row.setter - def row(self, val): - self['row'] = val - - # x - # - - @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] - - Returns - ------- - list - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @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] - - Returns - ------- - list - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.ternary' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - column - If there is a layout grid, use the domain for this - column in the grid for this ternary subplot . - row - If there is a layout grid, use the domain for this row - in the grid for this ternary subplot . - x - Sets the horizontal domain of this ternary subplot (in - plot fraction). - y - Sets the vertical domain of this ternary subplot (in - plot fraction). - """ - - def __init__( - self, arg=None, column=None, row=None, x=None, y=None, **kwargs - ): - """ - Construct a new Domain object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.ternary.Domain - column - If there is a layout grid, use the domain for this - column in the grid for this ternary subplot . - row - If there is a layout grid, use the domain for this row - in the grid for this ternary subplot . - x - Sets the horizontal domain of this ternary subplot (in - plot fraction). - y - Sets the vertical domain of this ternary subplot (in - plot fraction). - - Returns - ------- - Domain - """ - super(Domain, self).__init__('domain') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.ternary.Domain -constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.Domain""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.ternary import (domain as v_domain) - - # Initialize validators - # --------------------- - self._validators['column'] = v_domain.ColumnValidator() - self._validators['row'] = v_domain.RowValidator() - self._validators['x'] = v_domain.XValidator() - self._validators['y'] = v_domain.YValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('column', None) - self['column'] = column if column is not None else _v - _v = arg.pop('row', None) - self['row'] = row if row is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/aaxis/__init__.py b/plotly/graph_objs/layout/ternary/aaxis/__init__.py index 797a36fb417..8a8a655de44 100644 --- a/plotly/graph_objs/layout/ternary/aaxis/__init__.py +++ b/plotly/graph_objs/layout/ternary/aaxis/__init__.py @@ -1,4 +1,687 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.ternary.aaxis.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.ternary.aaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.ternary.aaxis.Title + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.ternary.aaxis.Title +constructor must be a dict or +an instance of plotly.graph_objs.layout.ternary.aaxis.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.ternary.aaxis import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.ternary.aaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.ternary.aaxis.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.ternary.aaxis.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.layout.ternary.aaxis.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.ternary.aaxis import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.ternary.aaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.ternary.aaxis.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.ternary.aaxis.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.layout.ternary.aaxis.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.ternary.aaxis import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.ternary.aaxis import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/layout/ternary/aaxis/_tickfont.py b/plotly/graph_objs/layout/ternary/aaxis/_tickfont.py deleted file mode 100644 index 5a0ca771451..00000000000 --- a/plotly/graph_objs/layout/ternary/aaxis/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickfont(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.ternary.aaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): - """ - Construct a new Tickfont object - - Sets the tick font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.aaxis.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.ternary.aaxis.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.aaxis.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.ternary.aaxis import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py b/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py deleted file mode 100644 index 18e350ae5fd..00000000000 --- a/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickformatstop(BaseLayoutHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.ternary.aaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.aaxis.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.ternary.aaxis.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.aaxis.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.ternary.aaxis import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/aaxis/_title.py b/plotly/graph_objs/layout/ternary/aaxis/_title.py deleted file mode 100644 index 4f6b1e482db..00000000000 --- a/plotly/graph_objs/layout/ternary/aaxis/_title.py +++ /dev/null @@ -1,166 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Title(BaseLayoutHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.ternary.aaxis.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.ternary.aaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - """ - - def __init__(self, arg=None, font=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.aaxis.Title - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.ternary.aaxis.Title -constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.aaxis.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.ternary.aaxis import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/aaxis/title/__init__.py b/plotly/graph_objs/layout/ternary/aaxis/title/__init__.py index c37b8b5cd28..00b8456ca6e 100644 --- a/plotly/graph_objs/layout/ternary/aaxis/title/__init__.py +++ b/plotly/graph_objs/layout/ternary/aaxis/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.ternary.aaxis.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.ternary.aaxis.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.ternary.aaxis.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.ternary.aaxis.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.ternary.aaxis.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/aaxis/title/_font.py b/plotly/graph_objs/layout/ternary/aaxis/title/_font.py deleted file mode 100644 index 916332bd080..00000000000 --- a/plotly/graph_objs/layout/ternary/aaxis/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.ternary.aaxis.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.aaxis.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.ternary.aaxis.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.aaxis.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.ternary.aaxis.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/baxis/__init__.py b/plotly/graph_objs/layout/ternary/baxis/__init__.py index 09e40023630..1ac6e19103c 100644 --- a/plotly/graph_objs/layout/ternary/baxis/__init__.py +++ b/plotly/graph_objs/layout/ternary/baxis/__init__.py @@ -1,4 +1,687 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.ternary.baxis.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.ternary.baxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.ternary.baxis.Title + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.ternary.baxis.Title +constructor must be a dict or +an instance of plotly.graph_objs.layout.ternary.baxis.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.ternary.baxis import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.ternary.baxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.ternary.baxis.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.ternary.baxis.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.layout.ternary.baxis.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.ternary.baxis import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.ternary.baxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.ternary.baxis.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.ternary.baxis.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.layout.ternary.baxis.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.ternary.baxis import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.ternary.baxis import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/layout/ternary/baxis/_tickfont.py b/plotly/graph_objs/layout/ternary/baxis/_tickfont.py deleted file mode 100644 index 2efdef95f19..00000000000 --- a/plotly/graph_objs/layout/ternary/baxis/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickfont(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.ternary.baxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): - """ - Construct a new Tickfont object - - Sets the tick font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.baxis.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.ternary.baxis.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.baxis.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.ternary.baxis import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py b/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py deleted file mode 100644 index d87923b4118..00000000000 --- a/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickformatstop(BaseLayoutHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.ternary.baxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.baxis.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.ternary.baxis.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.baxis.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.ternary.baxis import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/baxis/_title.py b/plotly/graph_objs/layout/ternary/baxis/_title.py deleted file mode 100644 index 34911a10951..00000000000 --- a/plotly/graph_objs/layout/ternary/baxis/_title.py +++ /dev/null @@ -1,166 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Title(BaseLayoutHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.ternary.baxis.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.ternary.baxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - """ - - def __init__(self, arg=None, font=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.baxis.Title - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.ternary.baxis.Title -constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.baxis.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.ternary.baxis import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/baxis/title/__init__.py b/plotly/graph_objs/layout/ternary/baxis/title/__init__.py index c37b8b5cd28..2b60b64e90b 100644 --- a/plotly/graph_objs/layout/ternary/baxis/title/__init__.py +++ b/plotly/graph_objs/layout/ternary/baxis/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.ternary.baxis.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.ternary.baxis.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.ternary.baxis.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.ternary.baxis.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.ternary.baxis.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/baxis/title/_font.py b/plotly/graph_objs/layout/ternary/baxis/title/_font.py deleted file mode 100644 index 2e44940b128..00000000000 --- a/plotly/graph_objs/layout/ternary/baxis/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.ternary.baxis.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.baxis.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.ternary.baxis.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.baxis.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.ternary.baxis.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/caxis/__init__.py b/plotly/graph_objs/layout/ternary/caxis/__init__.py index a215ae6c78d..6ae7eb113ef 100644 --- a/plotly/graph_objs/layout/ternary/caxis/__init__.py +++ b/plotly/graph_objs/layout/ternary/caxis/__init__.py @@ -1,4 +1,687 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.ternary.caxis.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.ternary.caxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.ternary.caxis.Title + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.ternary.caxis.Title +constructor must be a dict or +an instance of plotly.graph_objs.layout.ternary.caxis.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.ternary.caxis import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.ternary.caxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.ternary.caxis.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.ternary.caxis.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.layout.ternary.caxis.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.ternary.caxis import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.ternary.caxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.ternary.caxis.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.ternary.caxis.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.layout.ternary.caxis.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.ternary.caxis import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.ternary.caxis import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/layout/ternary/caxis/_tickfont.py b/plotly/graph_objs/layout/ternary/caxis/_tickfont.py deleted file mode 100644 index 67532daee7d..00000000000 --- a/plotly/graph_objs/layout/ternary/caxis/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickfont(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.ternary.caxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): - """ - Construct a new Tickfont object - - Sets the tick font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.caxis.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.ternary.caxis.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.caxis.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.ternary.caxis import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py b/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py deleted file mode 100644 index bc08483e738..00000000000 --- a/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickformatstop(BaseLayoutHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.ternary.caxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.caxis.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.ternary.caxis.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.caxis.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.ternary.caxis import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/caxis/_title.py b/plotly/graph_objs/layout/ternary/caxis/_title.py deleted file mode 100644 index b73d016d24b..00000000000 --- a/plotly/graph_objs/layout/ternary/caxis/_title.py +++ /dev/null @@ -1,166 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Title(BaseLayoutHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.ternary.caxis.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.ternary.caxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - """ - - def __init__(self, arg=None, font=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.caxis.Title - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.ternary.caxis.Title -constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.caxis.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.ternary.caxis import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/caxis/title/__init__.py b/plotly/graph_objs/layout/ternary/caxis/title/__init__.py index c37b8b5cd28..63ed26a2bee 100644 --- a/plotly/graph_objs/layout/ternary/caxis/title/__init__.py +++ b/plotly/graph_objs/layout/ternary/caxis/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.ternary.caxis.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.ternary.caxis.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.ternary.caxis.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.ternary.caxis.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.ternary.caxis.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/ternary/caxis/title/_font.py b/plotly/graph_objs/layout/ternary/caxis/title/_font.py deleted file mode 100644 index 8cc20a3db25..00000000000 --- a/plotly/graph_objs/layout/ternary/caxis/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.ternary.caxis.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.ternary.caxis.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.ternary.caxis.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.ternary.caxis.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.ternary.caxis.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/title/__init__.py b/plotly/graph_objs/layout/title/__init__.py index c00f0bcfd58..4332a471ec4 100644 --- a/plotly/graph_objs/layout/title/__init__.py +++ b/plotly/graph_objs/layout/title/__init__.py @@ -1,2 +1,428 @@ -from ._pad import Pad -from ._font import Font + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Pad(_BaseLayoutHierarchyType): + + # b + # - + @property + 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 + + Returns + ------- + int|float + """ + return self['b'] + + @b.setter + def b(self, val): + self['b'] = val + + # l + # - + @property + 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 + + Returns + ------- + int|float + """ + return self['l'] + + @l.setter + def l(self, val): + self['l'] = val + + # r + # - + @property + 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 + + Returns + ------- + int|float + """ + return self['r'] + + @r.setter + def r(self, val): + self['r'] = val + + # t + # - + @property + 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 + + Returns + ------- + int|float + """ + return self['t'] + + @t.setter + def t(self, val): + self['t'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + b + The amount of padding (in px) along the bottom of the + component. + l + The amount of padding (in px) on the left side of the + component. + r + The amount of padding (in px) on the right side of the + component. + t + The amount of padding (in px) along the top of the + component. + """ + + 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` + 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". + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.title.Pad + b + The amount of padding (in px) along the bottom of the + component. + l + The amount of padding (in px) on the left side of the + component. + r + The amount of padding (in px) on the right side of the + component. + t + The amount of padding (in px) along the top of the + component. + + Returns + ------- + Pad + """ + super(Pad, self).__init__('pad') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.title.Pad +constructor must be a dict or +an instance of plotly.graph_objs.layout.title.Pad""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.title import (pad as v_pad) + + # Initialize validators + # --------------------- + self._validators['b'] = v_pad.BValidator() + self._validators['l'] = v_pad.LValidator() + self._validators['r'] = v_pad.RValidator() + self._validators['t'] = v_pad.TValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('b', None) + self['b'] = b if b is not None else _v + _v = arg.pop('l', None) + self['l'] = l if l is not None else _v + _v = arg.pop('r', None) + self['r'] = r if r is not None else _v + _v = arg.pop('t', None) + self['t'] = t if t is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.title import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/title/_font.py b/plotly/graph_objs/layout/title/_font.py deleted file mode 100644 index 9c4ec542b6e..00000000000 --- a/plotly/graph_objs/layout/title/_font.py +++ /dev/null @@ -1,226 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.title import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/title/_pad.py b/plotly/graph_objs/layout/title/_pad.py deleted file mode 100644 index 01d2ffd2489..00000000000 --- a/plotly/graph_objs/layout/title/_pad.py +++ /dev/null @@ -1,198 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Pad(BaseLayoutHierarchyType): - - # b - # - - @property - 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 - - Returns - ------- - int|float - """ - return self['b'] - - @b.setter - def b(self, val): - self['b'] = val - - # l - # - - @property - 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 - - Returns - ------- - int|float - """ - return self['l'] - - @l.setter - def l(self, val): - self['l'] = val - - # r - # - - @property - 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 - - Returns - ------- - int|float - """ - return self['r'] - - @r.setter - def r(self, val): - self['r'] = val - - # t - # - - @property - 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 - - Returns - ------- - int|float - """ - return self['t'] - - @t.setter - def t(self, val): - self['t'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - b - The amount of padding (in px) along the bottom of the - component. - l - The amount of padding (in px) on the left side of the - component. - r - The amount of padding (in px) on the right side of the - component. - t - The amount of padding (in px) along the top of the - component. - """ - - 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` - 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". - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.title.Pad - b - The amount of padding (in px) along the bottom of the - component. - l - The amount of padding (in px) on the left side of the - component. - r - The amount of padding (in px) on the right side of the - component. - t - The amount of padding (in px) along the top of the - component. - - Returns - ------- - Pad - """ - super(Pad, self).__init__('pad') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.title.Pad -constructor must be a dict or -an instance of plotly.graph_objs.layout.title.Pad""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.title import (pad as v_pad) - - # Initialize validators - # --------------------- - self._validators['b'] = v_pad.BValidator() - self._validators['l'] = v_pad.LValidator() - self._validators['r'] = v_pad.RValidator() - self._validators['t'] = v_pad.TValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('b', None) - self['b'] = b if b is not None else _v - _v = arg.pop('l', None) - self['l'] = l if l is not None else _v - _v = arg.pop('r', None) - self['r'] = r if r is not None else _v - _v = arg.pop('t', None) - self['t'] = t if t is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/updatemenu/__init__.py b/plotly/graph_objs/layout/updatemenu/__init__.py index 61834a378eb..457e00ed5ae 100644 --- a/plotly/graph_objs/layout/updatemenu/__init__.py +++ b/plotly/graph_objs/layout/updatemenu/__init__.py @@ -1,3 +1,787 @@ -from ._pad import Pad -from ._font import Font -from ._button import Button + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Pad(_BaseLayoutHierarchyType): + + # b + # - + @property + 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 + + Returns + ------- + int|float + """ + return self['b'] + + @b.setter + def b(self, val): + self['b'] = val + + # l + # - + @property + 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 + + Returns + ------- + int|float + """ + return self['l'] + + @l.setter + def l(self, val): + self['l'] = val + + # r + # - + @property + 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 + + Returns + ------- + int|float + """ + return self['r'] + + @r.setter + def r(self, val): + self['r'] = val + + # t + # - + @property + 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 + + Returns + ------- + int|float + """ + return self['t'] + + @t.setter + def t(self, val): + self['t'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.updatemenu' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + b + The amount of padding (in px) along the bottom of the + component. + l + The amount of padding (in px) on the left side of the + component. + r + The amount of padding (in px) on the right side of the + component. + t + The amount of padding (in px) along the top of the + component. + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.updatemenu.Pad + b + The amount of padding (in px) along the bottom of the + component. + l + The amount of padding (in px) on the left side of the + component. + r + The amount of padding (in px) on the right side of the + component. + t + The amount of padding (in px) along the top of the + component. + + Returns + ------- + Pad + """ + super(Pad, self).__init__('pad') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.updatemenu.Pad +constructor must be a dict or +an instance of plotly.graph_objs.layout.updatemenu.Pad""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.updatemenu import (pad as v_pad) + + # Initialize validators + # --------------------- + self._validators['b'] = v_pad.BValidator() + self._validators['l'] = v_pad.LValidator() + self._validators['r'] = v_pad.RValidator() + self._validators['t'] = v_pad.TValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('b', None) + self['b'] = b if b is not None else _v + _v = arg.pop('l', None) + self['l'] = l if l is not None else _v + _v = arg.pop('r', None) + self['r'] = r if r is not None else _v + _v = arg.pop('t', None) + self['t'] = t if t is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.updatemenu' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.updatemenu.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.updatemenu.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.updatemenu.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.updatemenu import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Button(_BaseLayoutHierarchyType): + + # args + # ---- + @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 + + Returns + ------- + list + """ + return self['args'] + + @args.setter + def args(self, val): + self['args'] = val + + # execute + # ------- + @property + def execute(self): + """ + When true, the API method is executed. When false, all other + behaviors are the same and command execution is skipped. This + may be useful when hooking into, for example, the + `plotly_buttonclicked` method and executing the API command + 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) + + Returns + ------- + bool + """ + return self['execute'] + + @execute.setter + def execute(self, val): + self['execute'] = val + + # label + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['label'] + + @label.setter + def label(self, val): + self['label'] = val + + # method + # ------ + @property + def method(self): + """ + Sets the Plotly method to be called on click. If the `skip` + method is used, the API updatemenu will function as normal but + 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'] + + Returns + ------- + Any + """ + return self['method'] + + @method.setter + def method(self, val): + self['method'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # visible + # ------- + @property + def visible(self): + """ + Determines whether or not this button is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.updatemenu' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + args + Sets the arguments values to be passed to the Plotly + method set in `method` on click. + execute + When true, the API method is executed. When false, all + other behaviors are the same and command execution is + skipped. This may be useful when hooking into, for + example, the `plotly_buttonclicked` method and + executing the API command manually without losing the + benefit of the updatemenu automatically binding to the + state of the plot through the specification of `method` + and `args`. + label + Sets the text label to appear on the button. + method + Sets the Plotly method to be called on click. If the + `skip` method is used, the API updatemenu will function + as normal but 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. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + visible + Determines whether or not this button is visible. + """ + + def __init__( + self, + arg=None, + args=None, + execute=None, + label=None, + method=None, + name=None, + templateitemname=None, + visible=None, + **kwargs + ): + """ + Construct a new Button object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.updatemenu.Button + args + Sets the arguments values to be passed to the Plotly + method set in `method` on click. + execute + When true, the API method is executed. When false, all + other behaviors are the same and command execution is + skipped. This may be useful when hooking into, for + example, the `plotly_buttonclicked` method and + executing the API command manually without losing the + benefit of the updatemenu automatically binding to the + state of the plot through the specification of `method` + and `args`. + label + Sets the text label to appear on the button. + method + Sets the Plotly method to be called on click. If the + `skip` method is used, the API updatemenu will function + as normal but 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. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + visible + Determines whether or not this button is visible. + + Returns + ------- + Button + """ + super(Button, self).__init__('buttons') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.updatemenu.Button +constructor must be a dict or +an instance of plotly.graph_objs.layout.updatemenu.Button""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.updatemenu import (button as v_button) + + # Initialize validators + # --------------------- + self._validators['args'] = v_button.ArgsValidator() + self._validators['execute'] = v_button.ExecuteValidator() + self._validators['label'] = v_button.LabelValidator() + self._validators['method'] = v_button.MethodValidator() + self._validators['name'] = v_button.NameValidator() + self._validators['templateitemname' + ] = v_button.TemplateitemnameValidator() + self._validators['visible'] = v_button.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('args', None) + self['args'] = args if args is not None else _v + _v = arg.pop('execute', None) + self['execute'] = execute if execute is not None else _v + _v = arg.pop('label', None) + self['label'] = label if label is not None else _v + _v = arg.pop('method', None) + self['method'] = method if method is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/updatemenu/_button.py b/plotly/graph_objs/layout/updatemenu/_button.py deleted file mode 100644 index 339c3e81143..00000000000 --- a/plotly/graph_objs/layout/updatemenu/_button.py +++ /dev/null @@ -1,363 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Button(BaseLayoutHierarchyType): - - # args - # ---- - @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 - - Returns - ------- - list - """ - return self['args'] - - @args.setter - def args(self, val): - self['args'] = val - - # execute - # ------- - @property - def execute(self): - """ - When true, the API method is executed. When false, all other - behaviors are the same and command execution is skipped. This - may be useful when hooking into, for example, the - `plotly_buttonclicked` method and executing the API command - 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) - - Returns - ------- - bool - """ - return self['execute'] - - @execute.setter - def execute(self, val): - self['execute'] = val - - # label - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['label'] - - @label.setter - def label(self, val): - self['label'] = val - - # method - # ------ - @property - def method(self): - """ - Sets the Plotly method to be called on click. If the `skip` - method is used, the API updatemenu will function as normal but - 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'] - - Returns - ------- - Any - """ - return self['method'] - - @method.setter - def method(self, val): - self['method'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # visible - # ------- - @property - def visible(self): - """ - Determines whether or not this button is visible. - - The 'visible' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.updatemenu' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - args - Sets the arguments values to be passed to the Plotly - method set in `method` on click. - execute - When true, the API method is executed. When false, all - other behaviors are the same and command execution is - skipped. This may be useful when hooking into, for - example, the `plotly_buttonclicked` method and - executing the API command manually without losing the - benefit of the updatemenu automatically binding to the - state of the plot through the specification of `method` - and `args`. - label - Sets the text label to appear on the button. - method - Sets the Plotly method to be called on click. If the - `skip` method is used, the API updatemenu will function - as normal but 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. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - visible - Determines whether or not this button is visible. - """ - - def __init__( - self, - arg=None, - args=None, - execute=None, - label=None, - method=None, - name=None, - templateitemname=None, - visible=None, - **kwargs - ): - """ - Construct a new Button object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.updatemenu.Button - args - Sets the arguments values to be passed to the Plotly - method set in `method` on click. - execute - When true, the API method is executed. When false, all - other behaviors are the same and command execution is - skipped. This may be useful when hooking into, for - example, the `plotly_buttonclicked` method and - executing the API command manually without losing the - benefit of the updatemenu automatically binding to the - state of the plot through the specification of `method` - and `args`. - label - Sets the text label to appear on the button. - method - Sets the Plotly method to be called on click. If the - `skip` method is used, the API updatemenu will function - as normal but 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. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - visible - Determines whether or not this button is visible. - - Returns - ------- - Button - """ - super(Button, self).__init__('buttons') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.updatemenu.Button -constructor must be a dict or -an instance of plotly.graph_objs.layout.updatemenu.Button""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.updatemenu import (button as v_button) - - # Initialize validators - # --------------------- - self._validators['args'] = v_button.ArgsValidator() - self._validators['execute'] = v_button.ExecuteValidator() - self._validators['label'] = v_button.LabelValidator() - self._validators['method'] = v_button.MethodValidator() - self._validators['name'] = v_button.NameValidator() - self._validators['templateitemname' - ] = v_button.TemplateitemnameValidator() - self._validators['visible'] = v_button.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('args', None) - self['args'] = args if args is not None else _v - _v = arg.pop('execute', None) - self['execute'] = execute if execute is not None else _v - _v = arg.pop('label', None) - self['label'] = label if label is not None else _v - _v = arg.pop('method', None) - self['method'] = method if method is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/updatemenu/_font.py b/plotly/graph_objs/layout/updatemenu/_font.py deleted file mode 100644 index e2c6ca2220b..00000000000 --- a/plotly/graph_objs/layout/updatemenu/_font.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.updatemenu' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.updatemenu.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.updatemenu.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.updatemenu.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.updatemenu import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/updatemenu/_pad.py b/plotly/graph_objs/layout/updatemenu/_pad.py deleted file mode 100644 index f01ed1c1e11..00000000000 --- a/plotly/graph_objs/layout/updatemenu/_pad.py +++ /dev/null @@ -1,193 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Pad(BaseLayoutHierarchyType): - - # b - # - - @property - 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 - - Returns - ------- - int|float - """ - return self['b'] - - @b.setter - def b(self, val): - self['b'] = val - - # l - # - - @property - 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 - - Returns - ------- - int|float - """ - return self['l'] - - @l.setter - def l(self, val): - self['l'] = val - - # r - # - - @property - 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 - - Returns - ------- - int|float - """ - return self['r'] - - @r.setter - def r(self, val): - self['r'] = val - - # t - # - - @property - 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 - - Returns - ------- - int|float - """ - return self['t'] - - @t.setter - def t(self, val): - self['t'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.updatemenu' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - b - The amount of padding (in px) along the bottom of the - component. - l - The amount of padding (in px) on the left side of the - component. - r - The amount of padding (in px) on the right side of the - component. - t - The amount of padding (in px) along the top of the - component. - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.updatemenu.Pad - b - The amount of padding (in px) along the bottom of the - component. - l - The amount of padding (in px) on the left side of the - component. - r - The amount of padding (in px) on the right side of the - component. - t - The amount of padding (in px) along the top of the - component. - - Returns - ------- - Pad - """ - super(Pad, self).__init__('pad') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.updatemenu.Pad -constructor must be a dict or -an instance of plotly.graph_objs.layout.updatemenu.Pad""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.updatemenu import (pad as v_pad) - - # Initialize validators - # --------------------- - self._validators['b'] = v_pad.BValidator() - self._validators['l'] = v_pad.LValidator() - self._validators['r'] = v_pad.RValidator() - self._validators['t'] = v_pad.TValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('b', None) - self['b'] = b if b is not None else _v - _v = arg.pop('l', None) - self['l'] = l if l is not None else _v - _v = arg.pop('r', None) - self['r'] = r if r is not None else _v - _v = arg.pop('t', None) - self['t'] = t if t is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/xaxis/__init__.py b/plotly/graph_objs/layout/xaxis/__init__.py index 819f09594bd..2aeb83cccf6 100644 --- a/plotly/graph_objs/layout/xaxis/__init__.py +++ b/plotly/graph_objs/layout/xaxis/__init__.py @@ -1,8 +1,1792 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.xaxis.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.xaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.xaxis.Title + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.xaxis.Title +constructor must be a dict or +an instance of plotly.graph_objs.layout.xaxis.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.xaxis import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.xaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.xaxis.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.xaxis.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.layout.xaxis.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.xaxis import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.xaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.xaxis.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.xaxis.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.layout.xaxis.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.xaxis import (tickfont as v_tickfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Rangeslider(_BaseLayoutHierarchyType): + + # autorange + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['autorange'] + + @autorange.setter + def autorange(self, val): + self['autorange'] = val + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # range + # ----- + @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 + + Returns + ------- + list + """ + return self['range'] + + @range.setter + def range(self, val): + self['range'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # yaxis + # ----- + @property + def yaxis(self): + """ + The 'yaxis' property is an instance of YAxis + that may be specified as: + - An instance of 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. + rangemode + Determines whether or not the range of this + axis in the rangeslider use the same value than + in the main plot when 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. + + Returns + ------- + plotly.graph_objs.layout.xaxis.rangeslider.YAxis + """ + return self['yaxis'] + + @yaxis.setter + def yaxis(self, val): + self['yaxis'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.xaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autorange + 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. + bgcolor + Sets the background color of the range slider. + bordercolor + Sets the border color of the range slider. + borderwidth + Sets the border width of the range slider. + range + 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. + thickness + The height of the range slider as a fraction of the + total plot area height. + visible + Determines whether or not the range slider will be + visible. If visible, perpendicular axes will be set to + `fixedrange` + yaxis + plotly.graph_objs.layout.xaxis.rangeslider.YAxis + instance or dict with compatible properties + """ + + def __init__( + self, + arg=None, + autorange=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + range=None, + thickness=None, + visible=None, + yaxis=None, + **kwargs + ): + """ + Construct a new Rangeslider object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.xaxis.Rangeslider + autorange + 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. + bgcolor + Sets the background color of the range slider. + bordercolor + Sets the border color of the range slider. + borderwidth + Sets the border width of the range slider. + range + 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. + thickness + The height of the range slider as a fraction of the + total plot area height. + visible + Determines whether or not the range slider will be + visible. If visible, perpendicular axes will be set to + `fixedrange` + yaxis + plotly.graph_objs.layout.xaxis.rangeslider.YAxis + instance or dict with compatible properties + + Returns + ------- + Rangeslider + """ + super(Rangeslider, self).__init__('rangeslider') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.xaxis.Rangeslider +constructor must be a dict or +an instance of plotly.graph_objs.layout.xaxis.Rangeslider""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.xaxis import ( + rangeslider as v_rangeslider + ) + + # Initialize validators + # --------------------- + self._validators['autorange'] = v_rangeslider.AutorangeValidator() + self._validators['bgcolor'] = v_rangeslider.BgcolorValidator() + self._validators['bordercolor'] = v_rangeslider.BordercolorValidator() + self._validators['borderwidth'] = v_rangeslider.BorderwidthValidator() + self._validators['range'] = v_rangeslider.RangeValidator() + self._validators['thickness'] = v_rangeslider.ThicknessValidator() + self._validators['visible'] = v_rangeslider.VisibleValidator() + self._validators['yaxis'] = v_rangeslider.YAxisValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autorange', None) + self['autorange'] = autorange if autorange is not None else _v + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('range', None) + self['range'] = range if range is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('yaxis', None) + self['yaxis'] = yaxis if yaxis is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Rangeselector(_BaseLayoutHierarchyType): + + # activecolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['activecolor'] + + @activecolor.setter + def activecolor(self, val): + self['activecolor'] = val + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # buttons + # ------- + @property + 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 + interval. + label + Sets the text label to appear on the button. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + step + The unit of measurement that the `count` value + will set the range by. + stepmode + Sets the range update mode. If "backward", the + range update shifts the start of range back + "count" times "step" milliseconds. If "todate", + the range update shifts the start of range back + to the first timestamp from "count" times + "step" milliseconds back. For example, with + `step` set to "year" and `count` set to 1 the + range update shifts the start of the range back + to January 01 of the current year. Month and + year "todate" are currently available only for + the built-in (Gregorian) calendar. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + visible + Determines whether or not this button is + visible. + + Returns + ------- + tuple[plotly.graph_objs.layout.xaxis.rangeselector.Button] + """ + return self['buttons'] + + @buttons.setter + def buttons(self, val): + self['buttons'] = val + + # buttondefaults + # -------------- + @property + def buttondefaults(self): + """ + When used in a template (as + 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 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 + ------- + plotly.graph_objs.layout.xaxis.rangeselector.Button + """ + return self['buttondefaults'] + + @buttondefaults.setter + def buttondefaults(self, val): + self['buttondefaults'] = val + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.xaxis.rangeselector.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.xaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + activecolor + Sets the background color of the active range selector + button. + bgcolor + Sets the background color of the range selector + buttons. + bordercolor + Sets the color of the border enclosing the range + selector. + borderwidth + Sets the width (in px) of the border enclosing the + range selector. + buttons + Sets the specifications for each buttons. By default, a + range selector comes with no buttons. + buttondefaults + When used in a template (as layout.template.layout.xaxi + s.rangeselector.buttondefaults), sets the default + property values to use for elements of + layout.xaxis.rangeselector.buttons + font + Sets the font of the range selector button text. + visible + 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". + x + Sets the x position (in normalized coordinates) of the + range selector. + xanchor + Sets the range selector's horizontal position anchor. + This anchor binds the `x` position to the "left", + "center" or "right" of the range selector. + y + Sets the y position (in normalized coordinates) of the + range selector. + yanchor + Sets the range selector's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the range selector. + """ + + def __init__( + self, + arg=None, + activecolor=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + buttons=None, + buttondefaults=None, + font=None, + visible=None, + x=None, + xanchor=None, + y=None, + yanchor=None, + **kwargs + ): + """ + Construct a new Rangeselector object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.xaxis.Rangeselector + activecolor + Sets the background color of the active range selector + button. + bgcolor + Sets the background color of the range selector + buttons. + bordercolor + Sets the color of the border enclosing the range + selector. + borderwidth + Sets the width (in px) of the border enclosing the + range selector. + buttons + Sets the specifications for each buttons. By default, a + range selector comes with no buttons. + buttondefaults + When used in a template (as layout.template.layout.xaxi + s.rangeselector.buttondefaults), sets the default + property values to use for elements of + layout.xaxis.rangeselector.buttons + font + Sets the font of the range selector button text. + visible + 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". + x + Sets the x position (in normalized coordinates) of the + range selector. + xanchor + Sets the range selector's horizontal position anchor. + This anchor binds the `x` position to the "left", + "center" or "right" of the range selector. + y + Sets the y position (in normalized coordinates) of the + range selector. + yanchor + Sets the range selector's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the range selector. + + Returns + ------- + Rangeselector + """ + super(Rangeselector, self).__init__('rangeselector') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.xaxis.Rangeselector +constructor must be a dict or +an instance of plotly.graph_objs.layout.xaxis.Rangeselector""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.xaxis import ( + rangeselector as v_rangeselector + ) + + # Initialize validators + # --------------------- + self._validators['activecolor'] = v_rangeselector.ActivecolorValidator( + ) + self._validators['bgcolor'] = v_rangeselector.BgcolorValidator() + self._validators['bordercolor'] = v_rangeselector.BordercolorValidator( + ) + self._validators['borderwidth'] = v_rangeselector.BorderwidthValidator( + ) + self._validators['buttons'] = v_rangeselector.ButtonsValidator() + self._validators['buttondefaults'] = v_rangeselector.ButtonValidator() + self._validators['font'] = v_rangeselector.FontValidator() + self._validators['visible'] = v_rangeselector.VisibleValidator() + self._validators['x'] = v_rangeselector.XValidator() + self._validators['xanchor'] = v_rangeselector.XanchorValidator() + self._validators['y'] = v_rangeselector.YValidator() + self._validators['yanchor'] = v_rangeselector.YanchorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('activecolor', None) + self['activecolor'] = activecolor if activecolor is not None else _v + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('buttons', None) + self['buttons'] = buttons if buttons is not None else _v + _v = arg.pop('buttondefaults', None) + self['buttondefaults' + ] = buttondefaults if buttondefaults is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.xaxis import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont -from ._rangeslider import Rangeslider from plotly.graph_objs.layout.xaxis import rangeslider -from ._rangeselector import Rangeselector from plotly.graph_objs.layout.xaxis import rangeselector diff --git a/plotly/graph_objs/layout/xaxis/_rangeselector.py b/plotly/graph_objs/layout/xaxis/_rangeselector.py deleted file mode 100644 index c97da985c8a..00000000000 --- a/plotly/graph_objs/layout/xaxis/_rangeselector.py +++ /dev/null @@ -1,664 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Rangeselector(BaseLayoutHierarchyType): - - # activecolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['activecolor'] - - @activecolor.setter - def activecolor(self, val): - self['activecolor'] = val - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # buttons - # ------- - @property - 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 - interval. - label - Sets the text label to appear on the button. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - step - The unit of measurement that the `count` value - will set the range by. - stepmode - Sets the range update mode. If "backward", the - range update shifts the start of range back - "count" times "step" milliseconds. If "todate", - the range update shifts the start of range back - to the first timestamp from "count" times - "step" milliseconds back. For example, with - `step` set to "year" and `count` set to 1 the - range update shifts the start of the range back - to January 01 of the current year. Month and - year "todate" are currently available only for - the built-in (Gregorian) calendar. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - visible - Determines whether or not this button is - visible. - - Returns - ------- - tuple[plotly.graph_objs.layout.xaxis.rangeselector.Button] - """ - return self['buttons'] - - @buttons.setter - def buttons(self, val): - self['buttons'] = val - - # buttondefaults - # -------------- - @property - def buttondefaults(self): - """ - When used in a template (as - 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 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 - ------- - plotly.graph_objs.layout.xaxis.rangeselector.Button - """ - return self['buttondefaults'] - - @buttondefaults.setter - def buttondefaults(self, val): - self['buttondefaults'] = val - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.xaxis.rangeselector.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.xaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - activecolor - Sets the background color of the active range selector - button. - bgcolor - Sets the background color of the range selector - buttons. - bordercolor - Sets the color of the border enclosing the range - selector. - borderwidth - Sets the width (in px) of the border enclosing the - range selector. - buttons - Sets the specifications for each buttons. By default, a - range selector comes with no buttons. - buttondefaults - When used in a template (as layout.template.layout.xaxi - s.rangeselector.buttondefaults), sets the default - property values to use for elements of - layout.xaxis.rangeselector.buttons - font - Sets the font of the range selector button text. - visible - 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". - x - Sets the x position (in normalized coordinates) of the - range selector. - xanchor - Sets the range selector's horizontal position anchor. - This anchor binds the `x` position to the "left", - "center" or "right" of the range selector. - y - Sets the y position (in normalized coordinates) of the - range selector. - yanchor - Sets the range selector's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the range selector. - """ - - def __init__( - self, - arg=None, - activecolor=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - buttons=None, - buttondefaults=None, - font=None, - visible=None, - x=None, - xanchor=None, - y=None, - yanchor=None, - **kwargs - ): - """ - Construct a new Rangeselector object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.xaxis.Rangeselector - activecolor - Sets the background color of the active range selector - button. - bgcolor - Sets the background color of the range selector - buttons. - bordercolor - Sets the color of the border enclosing the range - selector. - borderwidth - Sets the width (in px) of the border enclosing the - range selector. - buttons - Sets the specifications for each buttons. By default, a - range selector comes with no buttons. - buttondefaults - When used in a template (as layout.template.layout.xaxi - s.rangeselector.buttondefaults), sets the default - property values to use for elements of - layout.xaxis.rangeselector.buttons - font - Sets the font of the range selector button text. - visible - 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". - x - Sets the x position (in normalized coordinates) of the - range selector. - xanchor - Sets the range selector's horizontal position anchor. - This anchor binds the `x` position to the "left", - "center" or "right" of the range selector. - y - Sets the y position (in normalized coordinates) of the - range selector. - yanchor - Sets the range selector's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the range selector. - - Returns - ------- - Rangeselector - """ - super(Rangeselector, self).__init__('rangeselector') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.xaxis.Rangeselector -constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.Rangeselector""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.xaxis import ( - rangeselector as v_rangeselector - ) - - # Initialize validators - # --------------------- - self._validators['activecolor'] = v_rangeselector.ActivecolorValidator( - ) - self._validators['bgcolor'] = v_rangeselector.BgcolorValidator() - self._validators['bordercolor'] = v_rangeselector.BordercolorValidator( - ) - self._validators['borderwidth'] = v_rangeselector.BorderwidthValidator( - ) - self._validators['buttons'] = v_rangeselector.ButtonsValidator() - self._validators['buttondefaults'] = v_rangeselector.ButtonValidator() - self._validators['font'] = v_rangeselector.FontValidator() - self._validators['visible'] = v_rangeselector.VisibleValidator() - self._validators['x'] = v_rangeselector.XValidator() - self._validators['xanchor'] = v_rangeselector.XanchorValidator() - self._validators['y'] = v_rangeselector.YValidator() - self._validators['yanchor'] = v_rangeselector.YanchorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('activecolor', None) - self['activecolor'] = activecolor if activecolor is not None else _v - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('buttons', None) - self['buttons'] = buttons if buttons is not None else _v - _v = arg.pop('buttondefaults', None) - self['buttondefaults' - ] = buttondefaults if buttondefaults is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/xaxis/_rangeslider.py b/plotly/graph_objs/layout/xaxis/_rangeslider.py deleted file mode 100644 index 49a316ab790..00000000000 --- a/plotly/graph_objs/layout/xaxis/_rangeslider.py +++ /dev/null @@ -1,439 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Rangeslider(BaseLayoutHierarchyType): - - # autorange - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['autorange'] - - @autorange.setter - def autorange(self, val): - self['autorange'] = val - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # range - # ----- - @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 - - Returns - ------- - list - """ - return self['range'] - - @range.setter - def range(self, val): - self['range'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # yaxis - # ----- - @property - def yaxis(self): - """ - The 'yaxis' property is an instance of YAxis - that may be specified as: - - An instance of 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. - rangemode - Determines whether or not the range of this - axis in the rangeslider use the same value than - in the main plot when 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. - - Returns - ------- - plotly.graph_objs.layout.xaxis.rangeslider.YAxis - """ - return self['yaxis'] - - @yaxis.setter - def yaxis(self, val): - self['yaxis'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.xaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autorange - 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. - bgcolor - Sets the background color of the range slider. - bordercolor - Sets the border color of the range slider. - borderwidth - Sets the border width of the range slider. - range - 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. - thickness - The height of the range slider as a fraction of the - total plot area height. - visible - Determines whether or not the range slider will be - visible. If visible, perpendicular axes will be set to - `fixedrange` - yaxis - plotly.graph_objs.layout.xaxis.rangeslider.YAxis - instance or dict with compatible properties - """ - - def __init__( - self, - arg=None, - autorange=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - range=None, - thickness=None, - visible=None, - yaxis=None, - **kwargs - ): - """ - Construct a new Rangeslider object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.xaxis.Rangeslider - autorange - 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. - bgcolor - Sets the background color of the range slider. - bordercolor - Sets the border color of the range slider. - borderwidth - Sets the border width of the range slider. - range - 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. - thickness - The height of the range slider as a fraction of the - total plot area height. - visible - Determines whether or not the range slider will be - visible. If visible, perpendicular axes will be set to - `fixedrange` - yaxis - plotly.graph_objs.layout.xaxis.rangeslider.YAxis - instance or dict with compatible properties - - Returns - ------- - Rangeslider - """ - super(Rangeslider, self).__init__('rangeslider') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.xaxis.Rangeslider -constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.Rangeslider""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.xaxis import ( - rangeslider as v_rangeslider - ) - - # Initialize validators - # --------------------- - self._validators['autorange'] = v_rangeslider.AutorangeValidator() - self._validators['bgcolor'] = v_rangeslider.BgcolorValidator() - self._validators['bordercolor'] = v_rangeslider.BordercolorValidator() - self._validators['borderwidth'] = v_rangeslider.BorderwidthValidator() - self._validators['range'] = v_rangeslider.RangeValidator() - self._validators['thickness'] = v_rangeslider.ThicknessValidator() - self._validators['visible'] = v_rangeslider.VisibleValidator() - self._validators['yaxis'] = v_rangeslider.YAxisValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autorange', None) - self['autorange'] = autorange if autorange is not None else _v - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('range', None) - self['range'] = range if range is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('yaxis', None) - self['yaxis'] = yaxis if yaxis is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/xaxis/_tickfont.py b/plotly/graph_objs/layout/xaxis/_tickfont.py deleted file mode 100644 index 6869ad53d4b..00000000000 --- a/plotly/graph_objs/layout/xaxis/_tickfont.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickfont(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.xaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): - """ - Construct a new Tickfont object - - Sets the tick font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.xaxis.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.xaxis.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.xaxis import (tickfont as v_tickfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/xaxis/_tickformatstop.py b/plotly/graph_objs/layout/xaxis/_tickformatstop.py deleted file mode 100644 index 5c6cea67c94..00000000000 --- a/plotly/graph_objs/layout/xaxis/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickformatstop(BaseLayoutHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.xaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.xaxis.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.xaxis.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.xaxis import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/xaxis/_title.py b/plotly/graph_objs/layout/xaxis/_title.py deleted file mode 100644 index 16a2858e35a..00000000000 --- a/plotly/graph_objs/layout/xaxis/_title.py +++ /dev/null @@ -1,165 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Title(BaseLayoutHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.xaxis.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.xaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - """ - - def __init__(self, arg=None, font=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.xaxis.Title - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.xaxis.Title -constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.xaxis import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/xaxis/rangeselector/__init__.py b/plotly/graph_objs/layout/xaxis/rangeselector/__init__.py index 1cf74165a97..e7116006cb7 100644 --- a/plotly/graph_objs/layout/xaxis/rangeselector/__init__.py +++ b/plotly/graph_objs/layout/xaxis/rangeselector/__init__.py @@ -1,2 +1,593 @@ -from ._font import Font -from ._button import Button + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.xaxis.rangeselector' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.xaxis.rangeselector.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.xaxis.rangeselector.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.xaxis.rangeselector.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.xaxis.rangeselector import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Button(_BaseLayoutHierarchyType): + + # count + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['count'] + + @count.setter + def count(self, val): + self['count'] = val + + # label + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['label'] + + @label.setter + def label(self, val): + self['label'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # step + # ---- + @property + 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', + 'all'] + + Returns + ------- + Any + """ + return self['step'] + + @step.setter + def step(self, val): + self['step'] = val + + # stepmode + # -------- + @property + def stepmode(self): + """ + Sets the range update mode. If "backward", the range update + shifts the start of range back "count" times "step" + milliseconds. If "todate", the range update shifts the start of + range back to the first timestamp from "count" times "step" + milliseconds back. For example, with `step` set to "year" and + `count` set to 1 the range update shifts the start of the range + 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'] + + Returns + ------- + Any + """ + return self['stepmode'] + + @stepmode.setter + def stepmode(self, val): + self['stepmode'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # visible + # ------- + @property + def visible(self): + """ + Determines whether or not this button is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.xaxis.rangeselector' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + count + Sets the number of steps to take to update the range. + Use with `step` to specify the update interval. + label + Sets the text label to appear on the button. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + step + The unit of measurement that the `count` value will set + the range by. + stepmode + Sets the range update mode. If "backward", the range + update shifts the start of range back "count" times + "step" milliseconds. If "todate", the range update + shifts the start of range back to the first timestamp + from "count" times "step" milliseconds back. For + example, with `step` set to "year" and `count` set to 1 + the range update shifts the start of the range back to + January 01 of the current year. Month and year "todate" + are currently available only for the built-in + (Gregorian) calendar. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + visible + Determines whether or not this button is visible. + """ + + def __init__( + self, + arg=None, + count=None, + label=None, + name=None, + step=None, + stepmode=None, + templateitemname=None, + visible=None, + **kwargs + ): + """ + Construct a new Button object + + Sets the specifications for each buttons. By default, a range + selector comes with no buttons. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.xaxis.rangeselector.Button + count + Sets the number of steps to take to update the range. + Use with `step` to specify the update interval. + label + Sets the text label to appear on the button. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + step + The unit of measurement that the `count` value will set + the range by. + stepmode + Sets the range update mode. If "backward", the range + update shifts the start of range back "count" times + "step" milliseconds. If "todate", the range update + shifts the start of range back to the first timestamp + from "count" times "step" milliseconds back. For + example, with `step` set to "year" and `count` set to 1 + the range update shifts the start of the range back to + January 01 of the current year. Month and year "todate" + are currently available only for the built-in + (Gregorian) calendar. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + visible + Determines whether or not this button is visible. + + Returns + ------- + Button + """ + super(Button, self).__init__('buttons') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.xaxis.rangeselector.Button +constructor must be a dict or +an instance of plotly.graph_objs.layout.xaxis.rangeselector.Button""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.xaxis.rangeselector import ( + button as v_button + ) + + # Initialize validators + # --------------------- + self._validators['count'] = v_button.CountValidator() + self._validators['label'] = v_button.LabelValidator() + self._validators['name'] = v_button.NameValidator() + self._validators['step'] = v_button.StepValidator() + self._validators['stepmode'] = v_button.StepmodeValidator() + self._validators['templateitemname' + ] = v_button.TemplateitemnameValidator() + self._validators['visible'] = v_button.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('count', None) + self['count'] = count if count is not None else _v + _v = arg.pop('label', None) + self['label'] = label if label is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('step', None) + self['step'] = step if step is not None else _v + _v = arg.pop('stepmode', None) + self['stepmode'] = stepmode if stepmode is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/xaxis/rangeselector/_button.py b/plotly/graph_objs/layout/xaxis/rangeselector/_button.py deleted file mode 100644 index 15ace1fe6b8..00000000000 --- a/plotly/graph_objs/layout/xaxis/rangeselector/_button.py +++ /dev/null @@ -1,361 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Button(BaseLayoutHierarchyType): - - # count - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['count'] - - @count.setter - def count(self, val): - self['count'] = val - - # label - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['label'] - - @label.setter - def label(self, val): - self['label'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # step - # ---- - @property - 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', - 'all'] - - Returns - ------- - Any - """ - return self['step'] - - @step.setter - def step(self, val): - self['step'] = val - - # stepmode - # -------- - @property - def stepmode(self): - """ - Sets the range update mode. If "backward", the range update - shifts the start of range back "count" times "step" - milliseconds. If "todate", the range update shifts the start of - range back to the first timestamp from "count" times "step" - milliseconds back. For example, with `step` set to "year" and - `count` set to 1 the range update shifts the start of the range - 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'] - - Returns - ------- - Any - """ - return self['stepmode'] - - @stepmode.setter - def stepmode(self, val): - self['stepmode'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # visible - # ------- - @property - def visible(self): - """ - Determines whether or not this button is visible. - - The 'visible' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.xaxis.rangeselector' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - count - Sets the number of steps to take to update the range. - Use with `step` to specify the update interval. - label - Sets the text label to appear on the button. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - step - The unit of measurement that the `count` value will set - the range by. - stepmode - Sets the range update mode. If "backward", the range - update shifts the start of range back "count" times - "step" milliseconds. If "todate", the range update - shifts the start of range back to the first timestamp - from "count" times "step" milliseconds back. For - example, with `step` set to "year" and `count` set to 1 - the range update shifts the start of the range back to - January 01 of the current year. Month and year "todate" - are currently available only for the built-in - (Gregorian) calendar. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - visible - Determines whether or not this button is visible. - """ - - def __init__( - self, - arg=None, - count=None, - label=None, - name=None, - step=None, - stepmode=None, - templateitemname=None, - visible=None, - **kwargs - ): - """ - Construct a new Button object - - Sets the specifications for each buttons. By default, a range - selector comes with no buttons. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.xaxis.rangeselector.Button - count - Sets the number of steps to take to update the range. - Use with `step` to specify the update interval. - label - Sets the text label to appear on the button. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - step - The unit of measurement that the `count` value will set - the range by. - stepmode - Sets the range update mode. If "backward", the range - update shifts the start of range back "count" times - "step" milliseconds. If "todate", the range update - shifts the start of range back to the first timestamp - from "count" times "step" milliseconds back. For - example, with `step` set to "year" and `count` set to 1 - the range update shifts the start of the range back to - January 01 of the current year. Month and year "todate" - are currently available only for the built-in - (Gregorian) calendar. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - visible - Determines whether or not this button is visible. - - Returns - ------- - Button - """ - super(Button, self).__init__('buttons') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.xaxis.rangeselector.Button -constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.rangeselector.Button""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.xaxis.rangeselector import ( - button as v_button - ) - - # Initialize validators - # --------------------- - self._validators['count'] = v_button.CountValidator() - self._validators['label'] = v_button.LabelValidator() - self._validators['name'] = v_button.NameValidator() - self._validators['step'] = v_button.StepValidator() - self._validators['stepmode'] = v_button.StepmodeValidator() - self._validators['templateitemname' - ] = v_button.TemplateitemnameValidator() - self._validators['visible'] = v_button.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('count', None) - self['count'] = count if count is not None else _v - _v = arg.pop('label', None) - self['label'] = label if label is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('step', None) - self['step'] = step if step is not None else _v - _v = arg.pop('stepmode', None) - self['stepmode'] = stepmode if stepmode is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/xaxis/rangeselector/_font.py b/plotly/graph_objs/layout/xaxis/rangeselector/_font.py deleted file mode 100644 index 7893375d54f..00000000000 --- a/plotly/graph_objs/layout/xaxis/rangeselector/_font.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.xaxis.rangeselector' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.xaxis.rangeselector.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.xaxis.rangeselector.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.rangeselector.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.xaxis.rangeselector import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/xaxis/rangeslider/__init__.py b/plotly/graph_objs/layout/xaxis/rangeslider/__init__.py index 6e17affa818..0711912515a 100644 --- a/plotly/graph_objs/layout/xaxis/rangeslider/__init__.py +++ b/plotly/graph_objs/layout/xaxis/rangeslider/__init__.py @@ -1 +1,149 @@ -from ._yaxis import YAxis + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class YAxis(_BaseLayoutHierarchyType): + + # range + # ----- + @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 + + Returns + ------- + list + """ + return self['range'] + + @range.setter + def range(self, val): + self['range'] = val + + # rangemode + # --------- + @property + def rangemode(self): + """ + Determines whether or not the range of this axis in the + rangeslider use the same value than in the main plot when + 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'] + + Returns + ------- + Any + """ + return self['rangemode'] + + @rangemode.setter + def rangemode(self, val): + self['rangemode'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.xaxis.rangeslider' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + range + Sets the range of this axis for the rangeslider. + rangemode + Determines whether or not the range of this axis in the + rangeslider use the same value than in the main plot + when 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. + """ + + def __init__(self, arg=None, range=None, rangemode=None, **kwargs): + """ + Construct a new YAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.xaxis.rangeslider.YAxis + range + Sets the range of this axis for the rangeslider. + rangemode + Determines whether or not the range of this axis in the + rangeslider use the same value than in the main plot + when 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. + + Returns + ------- + YAxis + """ + super(YAxis, self).__init__('yaxis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.xaxis.rangeslider.YAxis +constructor must be a dict or +an instance of plotly.graph_objs.layout.xaxis.rangeslider.YAxis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.xaxis.rangeslider import ( + yaxis as v_yaxis + ) + + # Initialize validators + # --------------------- + self._validators['range'] = v_yaxis.RangeValidator() + self._validators['rangemode'] = v_yaxis.RangemodeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('range', None) + self['range'] = range if range is not None else _v + _v = arg.pop('rangemode', None) + self['rangemode'] = rangemode if rangemode is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/xaxis/rangeslider/_yaxis.py b/plotly/graph_objs/layout/xaxis/rangeslider/_yaxis.py deleted file mode 100644 index 231e022da37..00000000000 --- a/plotly/graph_objs/layout/xaxis/rangeslider/_yaxis.py +++ /dev/null @@ -1,147 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class YAxis(BaseLayoutHierarchyType): - - # range - # ----- - @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 - - Returns - ------- - list - """ - return self['range'] - - @range.setter - def range(self, val): - self['range'] = val - - # rangemode - # --------- - @property - def rangemode(self): - """ - Determines whether or not the range of this axis in the - rangeslider use the same value than in the main plot when - 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'] - - Returns - ------- - Any - """ - return self['rangemode'] - - @rangemode.setter - def rangemode(self, val): - self['rangemode'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.xaxis.rangeslider' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - range - Sets the range of this axis for the rangeslider. - rangemode - Determines whether or not the range of this axis in the - rangeslider use the same value than in the main plot - when 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. - """ - - def __init__(self, arg=None, range=None, rangemode=None, **kwargs): - """ - Construct a new YAxis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.xaxis.rangeslider.YAxis - range - Sets the range of this axis for the rangeslider. - rangemode - Determines whether or not the range of this axis in the - rangeslider use the same value than in the main plot - when 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. - - Returns - ------- - YAxis - """ - super(YAxis, self).__init__('yaxis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.xaxis.rangeslider.YAxis -constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.rangeslider.YAxis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.xaxis.rangeslider import ( - yaxis as v_yaxis - ) - - # Initialize validators - # --------------------- - self._validators['range'] = v_yaxis.RangeValidator() - self._validators['rangemode'] = v_yaxis.RangemodeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('range', None) - self['range'] = range if range is not None else _v - _v = arg.pop('rangemode', None) - self['rangemode'] = rangemode if rangemode is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/xaxis/title/__init__.py b/plotly/graph_objs/layout/xaxis/title/__init__.py index c37b8b5cd28..6cf5448728d 100644 --- a/plotly/graph_objs/layout/xaxis/title/__init__.py +++ b/plotly/graph_objs/layout/xaxis/title/__init__.py @@ -1 +1,229 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.xaxis.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.xaxis.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.xaxis.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.xaxis.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.xaxis.title import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/xaxis/title/_font.py b/plotly/graph_objs/layout/xaxis/title/_font.py deleted file mode 100644 index 592edc29df7..00000000000 --- a/plotly/graph_objs/layout/xaxis/title/_font.py +++ /dev/null @@ -1,227 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.xaxis.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.xaxis.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.xaxis.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.xaxis.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.xaxis.title import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/yaxis/__init__.py b/plotly/graph_objs/layout/yaxis/__init__.py index b0a99b77702..111aad2e745 100644 --- a/plotly/graph_objs/layout/yaxis/__init__.py +++ b/plotly/graph_objs/layout/yaxis/__init__.py @@ -1,4 +1,683 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.layout.yaxis.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.yaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.yaxis.Title + font + Sets this axis' title font. Note that the title's font + used to be customized by the now deprecated `titlefont` + attribute. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.yaxis.Title +constructor must be a dict or +an instance of plotly.graph_objs.layout.yaxis.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.yaxis import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.yaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.yaxis.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.yaxis.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.layout.yaxis.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.yaxis import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.yaxis' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.layout.yaxis.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.yaxis.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.layout.yaxis.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.yaxis import (tickfont as v_tickfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.layout.yaxis import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/layout/yaxis/_tickfont.py b/plotly/graph_objs/layout/yaxis/_tickfont.py deleted file mode 100644 index 0623f602efe..00000000000 --- a/plotly/graph_objs/layout/yaxis/_tickfont.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickfont(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.yaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): - """ - Construct a new Tickfont object - - Sets the tick font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.yaxis.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.yaxis.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.layout.yaxis.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.yaxis import (tickfont as v_tickfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/yaxis/_tickformatstop.py b/plotly/graph_objs/layout/yaxis/_tickformatstop.py deleted file mode 100644 index 478c05894c9..00000000000 --- a/plotly/graph_objs/layout/yaxis/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Tickformatstop(BaseLayoutHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.yaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.yaxis.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.yaxis.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.layout.yaxis.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.yaxis import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/yaxis/_title.py b/plotly/graph_objs/layout/yaxis/_title.py deleted file mode 100644 index f0090e5a2e8..00000000000 --- a/plotly/graph_objs/layout/yaxis/_title.py +++ /dev/null @@ -1,165 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Title(BaseLayoutHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.layout.yaxis.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.yaxis' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - """ - - def __init__(self, arg=None, font=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.layout.yaxis.Title - font - Sets this axis' title font. Note that the title's font - used to be customized by the now deprecated `titlefont` - attribute. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.yaxis.Title -constructor must be a dict or -an instance of plotly.graph_objs.layout.yaxis.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.yaxis import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/layout/yaxis/title/__init__.py b/plotly/graph_objs/layout/yaxis/title/__init__.py index c37b8b5cd28..b2f48fe10b6 100644 --- a/plotly/graph_objs/layout/yaxis/title/__init__.py +++ b/plotly/graph_objs/layout/yaxis/title/__init__.py @@ -1 +1,229 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'layout.yaxis.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.layout.yaxis.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.layout.yaxis.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.layout.yaxis.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.layout.yaxis.title import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/layout/yaxis/title/_font.py b/plotly/graph_objs/layout/yaxis/title/_font.py deleted file mode 100644 index 9ce8c750a3f..00000000000 --- a/plotly/graph_objs/layout/yaxis/title/_font.py +++ /dev/null @@ -1,227 +0,0 @@ -from plotly.basedatatypes import BaseLayoutHierarchyType -import copy - - -class Font(BaseLayoutHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'layout.yaxis.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.layout.yaxis.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.layout.yaxis.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.layout.yaxis.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.layout.yaxis.title import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/mesh3d/__init__.py b/plotly/graph_objs/mesh3d/__init__.py index d9d1852c54d..6224afabdd9 100644 --- a/plotly/graph_objs/mesh3d/__init__.py +++ b/plotly/graph_objs/mesh3d/__init__.py @@ -1,8 +1,3086 @@ -from ._stream import Stream -from ._lightposition import Lightposition -from ._lighting import Lighting -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'mesh3d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.mesh3d.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.mesh3d.Stream +constructor must be a dict or +an instance of plotly.graph_objs.mesh3d.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.mesh3d import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lightposition(_BaseTraceHierarchyType): + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # z + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'mesh3d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Lightposition object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.mesh3d.Lightposition + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + + Returns + ------- + Lightposition + """ + super(Lightposition, self).__init__('lightposition') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.mesh3d.Lightposition +constructor must be a dict or +an instance of plotly.graph_objs.mesh3d.Lightposition""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.mesh3d import (lightposition as v_lightposition) + + # Initialize validators + # --------------------- + self._validators['x'] = v_lightposition.XValidator() + self._validators['y'] = v_lightposition.YValidator() + self._validators['z'] = v_lightposition.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lighting(_BaseTraceHierarchyType): + + # ambient + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ambient'] + + @ambient.setter + def ambient(self, val): + self['ambient'] = val + + # diffuse + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['diffuse'] + + @diffuse.setter + def diffuse(self, val): + self['diffuse'] = val + + # facenormalsepsilon + # ------------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['facenormalsepsilon'] + + @facenormalsepsilon.setter + def facenormalsepsilon(self, val): + self['facenormalsepsilon'] = val + + # fresnel + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['fresnel'] + + @fresnel.setter + def fresnel(self, val): + self['fresnel'] = val + + # roughness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['roughness'] + + @roughness.setter + def roughness(self, val): + self['roughness'] = val + + # specular + # -------- + @property + 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] + + Returns + ------- + int|float + """ + return self['specular'] + + @specular.setter + def specular(self, val): + self['specular'] = val + + # vertexnormalsepsilon + # -------------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['vertexnormalsepsilon'] + + @vertexnormalsepsilon.setter + def vertexnormalsepsilon(self, val): + self['vertexnormalsepsilon'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'mesh3d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + """ + + def __init__( + self, + arg=None, + ambient=None, + diffuse=None, + facenormalsepsilon=None, + fresnel=None, + roughness=None, + specular=None, + vertexnormalsepsilon=None, + **kwargs + ): + """ + Construct a new Lighting object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.mesh3d.Lighting + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + + Returns + ------- + Lighting + """ + super(Lighting, self).__init__('lighting') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.mesh3d.Lighting +constructor must be a dict or +an instance of plotly.graph_objs.mesh3d.Lighting""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.mesh3d import (lighting as v_lighting) + + # Initialize validators + # --------------------- + self._validators['ambient'] = v_lighting.AmbientValidator() + self._validators['diffuse'] = v_lighting.DiffuseValidator() + self._validators['facenormalsepsilon' + ] = v_lighting.FacenormalsepsilonValidator() + self._validators['fresnel'] = v_lighting.FresnelValidator() + self._validators['roughness'] = v_lighting.RoughnessValidator() + self._validators['specular'] = v_lighting.SpecularValidator() + self._validators['vertexnormalsepsilon' + ] = v_lighting.VertexnormalsepsilonValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('ambient', None) + self['ambient'] = ambient if ambient is not None else _v + _v = arg.pop('diffuse', None) + self['diffuse'] = diffuse if diffuse is not None else _v + _v = arg.pop('facenormalsepsilon', None) + self['facenormalsepsilon' + ] = facenormalsepsilon if facenormalsepsilon is not None else _v + _v = arg.pop('fresnel', None) + self['fresnel'] = fresnel if fresnel is not None else _v + _v = arg.pop('roughness', None) + self['roughness'] = roughness if roughness is not None else _v + _v = arg.pop('specular', None) + self['specular'] = specular if specular is not None else _v + _v = arg.pop('vertexnormalsepsilon', None) + self[ + 'vertexnormalsepsilon' + ] = vertexnormalsepsilon if vertexnormalsepsilon is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.mesh3d.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'mesh3d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.mesh3d.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.mesh3d.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.mesh3d.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.mesh3d import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Contour(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # show + # ---- + @property + 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) + + Returns + ------- + bool + """ + return self['show'] + + @show.setter + def show(self, val): + self['show'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'mesh3d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour lines. + show + Sets whether or not dynamic contours are shown on hover + width + Sets the width of the contour lines. + """ + + def __init__(self, arg=None, color=None, show=None, width=None, **kwargs): + """ + Construct a new Contour object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.mesh3d.Contour + color + Sets the color of the contour lines. + show + Sets whether or not dynamic contours are shown on hover + width + Sets the width of the contour lines. + + Returns + ------- + Contour + """ + super(Contour, self).__init__('contour') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.mesh3d.Contour +constructor must be a dict or +an instance of plotly.graph_objs.mesh3d.Contour""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.mesh3d import (contour as v_contour) + + # Initialize validators + # --------------------- + self._validators['color'] = v_contour.ColorValidator() + self._validators['show'] = v_contour.ShowValidator() + self._validators['width'] = v_contour.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('show', None) + self['show'] = show if show is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.mesh3d.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.mesh3d.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + 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 plotly.graph_objs.mesh3d.colorbar.Tickformatstop + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.mesh3d.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.mesh3d.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use mesh3d.colorbar.title.side instead. + Determines the location of color bar's title with respect to + the color bar. Note that the title's location used to be set by + the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'mesh3d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.mesh3d.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.mesh3d + .colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + mesh3d.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.mesh3d.colorbar.Title instance or + dict with compatible properties + titlefont + Deprecated: Please use mesh3d.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use mesh3d.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.mesh3d.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.mesh3d.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.mesh3d + .colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + mesh3d.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.mesh3d.colorbar.Title instance or + dict with compatible properties + titlefont + Deprecated: Please use mesh3d.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use mesh3d.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.mesh3d.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.mesh3d.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.mesh3d import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.mesh3d import hoverlabel -from ._contour import Contour -from ._colorbar import ColorBar from plotly.graph_objs.mesh3d import colorbar diff --git a/plotly/graph_objs/mesh3d/_colorbar.py b/plotly/graph_objs/mesh3d/_colorbar.py deleted file mode 100644 index eac81079582..00000000000 --- a/plotly/graph_objs/mesh3d/_colorbar.py +++ /dev/null @@ -1,1863 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.mesh3d.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.mesh3d.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as - 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 plotly.graph_objs.mesh3d.colorbar.Tickformatstop - - A dict of string/value properties that will be passed - to the Tickformatstop constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.mesh3d.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.mesh3d.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use mesh3d.colorbar.title.side instead. - Determines the location of color bar's title with respect to - the color bar. Note that the title's location used to be set by - the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'mesh3d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.mesh3d.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.mesh3d - .colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - mesh3d.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.mesh3d.colorbar.Title instance or - dict with compatible properties - titlefont - Deprecated: Please use mesh3d.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use mesh3d.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.mesh3d.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.mesh3d.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.mesh3d - .colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - mesh3d.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.mesh3d.colorbar.Title instance or - dict with compatible properties - titlefont - Deprecated: Please use mesh3d.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use mesh3d.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.mesh3d.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.mesh3d import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/mesh3d/_contour.py b/plotly/graph_objs/mesh3d/_contour.py deleted file mode 100644 index 053709539ee..00000000000 --- a/plotly/graph_objs/mesh3d/_contour.py +++ /dev/null @@ -1,192 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Contour(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # show - # ---- - @property - 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) - - Returns - ------- - bool - """ - return self['show'] - - @show.setter - def show(self, val): - self['show'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'mesh3d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the color of the contour lines. - show - Sets whether or not dynamic contours are shown on hover - width - Sets the width of the contour lines. - """ - - def __init__(self, arg=None, color=None, show=None, width=None, **kwargs): - """ - Construct a new Contour object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.mesh3d.Contour - color - Sets the color of the contour lines. - show - Sets whether or not dynamic contours are shown on hover - width - Sets the width of the contour lines. - - Returns - ------- - Contour - """ - super(Contour, self).__init__('contour') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.mesh3d.Contour -constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.Contour""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.mesh3d import (contour as v_contour) - - # Initialize validators - # --------------------- - self._validators['color'] = v_contour.ColorValidator() - self._validators['show'] = v_contour.ShowValidator() - self._validators['width'] = v_contour.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('show', None) - self['show'] = show if show is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/mesh3d/_hoverlabel.py b/plotly/graph_objs/mesh3d/_hoverlabel.py deleted file mode 100644 index f8a218ccf6f..00000000000 --- a/plotly/graph_objs/mesh3d/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.mesh3d.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'mesh3d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.mesh3d.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.mesh3d.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.mesh3d import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/mesh3d/_lighting.py b/plotly/graph_objs/mesh3d/_lighting.py deleted file mode 100644 index 3885f484519..00000000000 --- a/plotly/graph_objs/mesh3d/_lighting.py +++ /dev/null @@ -1,303 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Lighting(BaseTraceHierarchyType): - - # ambient - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ambient'] - - @ambient.setter - def ambient(self, val): - self['ambient'] = val - - # diffuse - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['diffuse'] - - @diffuse.setter - def diffuse(self, val): - self['diffuse'] = val - - # facenormalsepsilon - # ------------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['facenormalsepsilon'] - - @facenormalsepsilon.setter - def facenormalsepsilon(self, val): - self['facenormalsepsilon'] = val - - # fresnel - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['fresnel'] - - @fresnel.setter - def fresnel(self, val): - self['fresnel'] = val - - # roughness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['roughness'] - - @roughness.setter - def roughness(self, val): - self['roughness'] = val - - # specular - # -------- - @property - 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] - - Returns - ------- - int|float - """ - return self['specular'] - - @specular.setter - def specular(self, val): - self['specular'] = val - - # vertexnormalsepsilon - # -------------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['vertexnormalsepsilon'] - - @vertexnormalsepsilon.setter - def vertexnormalsepsilon(self, val): - self['vertexnormalsepsilon'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'mesh3d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - ambient - Ambient light increases overall color visibility but - can wash out the image. - diffuse - Represents the extent that incident rays are reflected - in a range of angles. - facenormalsepsilon - Epsilon for face normals calculation avoids math issues - arising from degenerate geometry. - fresnel - Represents the reflectance as a dependency of the - viewing angle; e.g. paper is reflective when viewing it - from the edge of the paper (almost 90 degrees), causing - shine. - roughness - Alters specular reflection; the rougher the surface, - the wider and less contrasty the shine. - specular - Represents the level that incident rays are reflected - in a single direction, causing shine. - vertexnormalsepsilon - Epsilon for vertex normals calculation avoids math - issues arising from degenerate geometry. - """ - - def __init__( - self, - arg=None, - ambient=None, - diffuse=None, - facenormalsepsilon=None, - fresnel=None, - roughness=None, - specular=None, - vertexnormalsepsilon=None, - **kwargs - ): - """ - Construct a new Lighting object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.mesh3d.Lighting - ambient - Ambient light increases overall color visibility but - can wash out the image. - diffuse - Represents the extent that incident rays are reflected - in a range of angles. - facenormalsepsilon - Epsilon for face normals calculation avoids math issues - arising from degenerate geometry. - fresnel - Represents the reflectance as a dependency of the - viewing angle; e.g. paper is reflective when viewing it - from the edge of the paper (almost 90 degrees), causing - shine. - roughness - Alters specular reflection; the rougher the surface, - the wider and less contrasty the shine. - specular - Represents the level that incident rays are reflected - in a single direction, causing shine. - vertexnormalsepsilon - Epsilon for vertex normals calculation avoids math - issues arising from degenerate geometry. - - Returns - ------- - Lighting - """ - super(Lighting, self).__init__('lighting') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.mesh3d.Lighting -constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.Lighting""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.mesh3d import (lighting as v_lighting) - - # Initialize validators - # --------------------- - self._validators['ambient'] = v_lighting.AmbientValidator() - self._validators['diffuse'] = v_lighting.DiffuseValidator() - self._validators['facenormalsepsilon' - ] = v_lighting.FacenormalsepsilonValidator() - self._validators['fresnel'] = v_lighting.FresnelValidator() - self._validators['roughness'] = v_lighting.RoughnessValidator() - self._validators['specular'] = v_lighting.SpecularValidator() - self._validators['vertexnormalsepsilon' - ] = v_lighting.VertexnormalsepsilonValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('ambient', None) - self['ambient'] = ambient if ambient is not None else _v - _v = arg.pop('diffuse', None) - self['diffuse'] = diffuse if diffuse is not None else _v - _v = arg.pop('facenormalsepsilon', None) - self['facenormalsepsilon' - ] = facenormalsepsilon if facenormalsepsilon is not None else _v - _v = arg.pop('fresnel', None) - self['fresnel'] = fresnel if fresnel is not None else _v - _v = arg.pop('roughness', None) - self['roughness'] = roughness if roughness is not None else _v - _v = arg.pop('specular', None) - self['specular'] = specular if specular is not None else _v - _v = arg.pop('vertexnormalsepsilon', None) - self[ - 'vertexnormalsepsilon' - ] = vertexnormalsepsilon if vertexnormalsepsilon is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/mesh3d/_lightposition.py b/plotly/graph_objs/mesh3d/_lightposition.py deleted file mode 100644 index 56918eeb9cb..00000000000 --- a/plotly/graph_objs/mesh3d/_lightposition.py +++ /dev/null @@ -1,159 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Lightposition(BaseTraceHierarchyType): - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # z - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'mesh3d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - Numeric vector, representing the X coordinate for each - vertex. - y - Numeric vector, representing the Y coordinate for each - vertex. - z - Numeric vector, representing the Z coordinate for each - vertex. - """ - - def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): - """ - Construct a new Lightposition object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.mesh3d.Lightposition - x - Numeric vector, representing the X coordinate for each - vertex. - y - Numeric vector, representing the Y coordinate for each - vertex. - z - Numeric vector, representing the Z coordinate for each - vertex. - - Returns - ------- - Lightposition - """ - super(Lightposition, self).__init__('lightposition') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.mesh3d.Lightposition -constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.Lightposition""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.mesh3d import (lightposition as v_lightposition) - - # Initialize validators - # --------------------- - self._validators['x'] = v_lightposition.XValidator() - self._validators['y'] = v_lightposition.YValidator() - self._validators['z'] = v_lightposition.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/mesh3d/_stream.py b/plotly/graph_objs/mesh3d/_stream.py deleted file mode 100644 index 0caf395397c..00000000000 --- a/plotly/graph_objs/mesh3d/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'mesh3d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.mesh3d.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.mesh3d.Stream -constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.mesh3d import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/mesh3d/colorbar/__init__.py b/plotly/graph_objs/mesh3d/colorbar/__init__.py index e589348d646..b9d97536a0f 100644 --- a/plotly/graph_objs/mesh3d/colorbar/__init__.py +++ b/plotly/graph_objs/mesh3d/colorbar/__init__.py @@ -1,4 +1,720 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.mesh3d.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'mesh3d.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.mesh3d.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.mesh3d.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.mesh3d.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.mesh3d.colorbar import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'mesh3d.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.mesh3d.colorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.mesh3d.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.mesh3d.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.mesh3d.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'mesh3d.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.mesh3d.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.mesh3d.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.mesh3d.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.mesh3d.colorbar import (tickfont as v_tickfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.mesh3d.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/mesh3d/colorbar/_tickfont.py b/plotly/graph_objs/mesh3d/colorbar/_tickfont.py deleted file mode 100644 index d91a2e59ea7..00000000000 --- a/plotly/graph_objs/mesh3d/colorbar/_tickfont.py +++ /dev/null @@ -1,226 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'mesh3d.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.mesh3d.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.mesh3d.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.mesh3d.colorbar import (tickfont as v_tickfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py b/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py deleted file mode 100644 index 72b1e789df5..00000000000 --- a/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'mesh3d.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.mesh3d.colorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.mesh3d.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.mesh3d.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/mesh3d/colorbar/_title.py b/plotly/graph_objs/mesh3d/colorbar/_title.py deleted file mode 100644 index fbc123a1073..00000000000 --- a/plotly/graph_objs/mesh3d/colorbar/_title.py +++ /dev/null @@ -1,201 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.mesh3d.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'mesh3d.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.mesh3d.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.mesh3d.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.mesh3d.colorbar import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/mesh3d/colorbar/title/__init__.py b/plotly/graph_objs/mesh3d/colorbar/title/__init__.py index c37b8b5cd28..ae5ed5657c1 100644 --- a/plotly/graph_objs/mesh3d/colorbar/title/__init__.py +++ b/plotly/graph_objs/mesh3d/colorbar/title/__init__.py @@ -1 +1,229 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'mesh3d.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.mesh3d.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.mesh3d.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.mesh3d.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.mesh3d.colorbar.title import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/mesh3d/colorbar/title/_font.py b/plotly/graph_objs/mesh3d/colorbar/title/_font.py deleted file mode 100644 index c563d566939..00000000000 --- a/plotly/graph_objs/mesh3d/colorbar/title/_font.py +++ /dev/null @@ -1,227 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'mesh3d.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.mesh3d.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.mesh3d.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.mesh3d.colorbar.title import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/mesh3d/hoverlabel/__init__.py b/plotly/graph_objs/mesh3d/hoverlabel/__init__.py index c37b8b5cd28..25ce4d3c4f5 100644 --- a/plotly/graph_objs/mesh3d/hoverlabel/__init__.py +++ b/plotly/graph_objs/mesh3d/hoverlabel/__init__.py @@ -1 +1,321 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'mesh3d.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.mesh3d.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.mesh3d.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.mesh3d.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.mesh3d.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/mesh3d/hoverlabel/_font.py b/plotly/graph_objs/mesh3d/hoverlabel/_font.py deleted file mode 100644 index db0ace11ce2..00000000000 --- a/plotly/graph_objs/mesh3d/hoverlabel/_font.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'mesh3d.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.mesh3d.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.mesh3d.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.mesh3d.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.mesh3d.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/ohlc/__init__.py b/plotly/graph_objs/ohlc/__init__.py index 54774dbc511..4acf048de9c 100644 --- a/plotly/graph_objs/ohlc/__init__.py +++ b/plotly/graph_objs/ohlc/__init__.py @@ -1,8 +1,977 @@ -from ._stream import Stream -from ._line import Line -from ._increasing import Increasing + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'ohlc' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.ohlc.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.ohlc.Stream +constructor must be a dict or +an instance of plotly.graph_objs.ohlc.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.ohlc import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # dash + # ---- + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). Note that this style setting can also be + set per direction via `increasing.line.dash` and + `decreasing.line.dash`. + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self['dash'] + + @dash.setter + def dash(self, val): + self['dash'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'ohlc' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). Note that this style setting can + also be set per direction via `increasing.line.dash` + and `decreasing.line.dash`. + width + [object Object] Note that this style setting can also + be set per direction via `increasing.line.width` and + `decreasing.line.width`. + """ + + def __init__(self, arg=None, dash=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.ohlc.Line + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). Note that this style setting can + also be set per direction via `increasing.line.dash` + and `decreasing.line.dash`. + width + [object Object] Note that this style setting can also + be set per direction via `increasing.line.width` and + `decreasing.line.width`. + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.ohlc.Line +constructor must be a dict or +an instance of plotly.graph_objs.ohlc.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.ohlc import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['dash'] = v_line.DashValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dash', None) + self['dash'] = dash if dash is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Increasing(_BaseTraceHierarchyType): + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + plotly.graph_objs.ohlc.increasing.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'ohlc' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + line + plotly.graph_objs.ohlc.increasing.Line instance or dict + with compatible properties + """ + + def __init__(self, arg=None, line=None, **kwargs): + """ + Construct a new Increasing object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.ohlc.Increasing + line + plotly.graph_objs.ohlc.increasing.Line instance or dict + with compatible properties + + Returns + ------- + Increasing + """ + super(Increasing, self).__init__('increasing') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.ohlc.Increasing +constructor must be a dict or +an instance of plotly.graph_objs.ohlc.Increasing""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.ohlc import (increasing as v_increasing) + + # Initialize validators + # --------------------- + self._validators['line'] = v_increasing.LineValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.ohlc.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # split + # ----- + @property + 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) + + Returns + ------- + bool + """ + return self['split'] + + @split.setter + def split(self, val): + self['split'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'ohlc' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + split + Show hover information (open, close, high, low) in + separate labels. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + split=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.ohlc.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + split + Show hover information (open, close, high, low) in + separate labels. + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.ohlc.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.ohlc.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.ohlc import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + self._validators['split'] = v_hoverlabel.SplitValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + _v = arg.pop('split', None) + self['split'] = split if split is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Decreasing(_BaseTraceHierarchyType): + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + plotly.graph_objs.ohlc.decreasing.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'ohlc' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + line + plotly.graph_objs.ohlc.decreasing.Line instance or dict + with compatible properties + """ + + def __init__(self, arg=None, line=None, **kwargs): + """ + Construct a new Decreasing object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.ohlc.Decreasing + line + plotly.graph_objs.ohlc.decreasing.Line instance or dict + with compatible properties + + Returns + ------- + Decreasing + """ + super(Decreasing, self).__init__('decreasing') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.ohlc.Decreasing +constructor must be a dict or +an instance of plotly.graph_objs.ohlc.Decreasing""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.ohlc import (decreasing as v_decreasing) + + # Initialize validators + # --------------------- + self._validators['line'] = v_decreasing.LineValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.ohlc import increasing -from ._hoverlabel import Hoverlabel from plotly.graph_objs.ohlc import hoverlabel -from ._decreasing import Decreasing from plotly.graph_objs.ohlc import decreasing diff --git a/plotly/graph_objs/ohlc/_decreasing.py b/plotly/graph_objs/ohlc/_decreasing.py deleted file mode 100644 index 4e853e86c01..00000000000 --- a/plotly/graph_objs/ohlc/_decreasing.py +++ /dev/null @@ -1,114 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Decreasing(BaseTraceHierarchyType): - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - width - Sets the line width (in px). - - Returns - ------- - plotly.graph_objs.ohlc.decreasing.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'ohlc' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - line - plotly.graph_objs.ohlc.decreasing.Line instance or dict - with compatible properties - """ - - def __init__(self, arg=None, line=None, **kwargs): - """ - Construct a new Decreasing object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.ohlc.Decreasing - line - plotly.graph_objs.ohlc.decreasing.Line instance or dict - with compatible properties - - Returns - ------- - Decreasing - """ - super(Decreasing, self).__init__('decreasing') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.ohlc.Decreasing -constructor must be a dict or -an instance of plotly.graph_objs.ohlc.Decreasing""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.ohlc import (decreasing as v_decreasing) - - # Initialize validators - # --------------------- - self._validators['line'] = v_decreasing.LineValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/ohlc/_hoverlabel.py b/plotly/graph_objs/ohlc/_hoverlabel.py deleted file mode 100644 index 2e23708f411..00000000000 --- a/plotly/graph_objs/ohlc/_hoverlabel.py +++ /dev/null @@ -1,445 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.ohlc.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # split - # ----- - @property - 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) - - Returns - ------- - bool - """ - return self['split'] - - @split.setter - def split(self, val): - self['split'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'ohlc' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - split - Show hover information (open, close, high, low) in - separate labels. - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - split=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.ohlc.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - split - Show hover information (open, close, high, low) in - separate labels. - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.ohlc.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.ohlc.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.ohlc import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - self._validators['split'] = v_hoverlabel.SplitValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - _v = arg.pop('split', None) - self['split'] = split if split is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/ohlc/_increasing.py b/plotly/graph_objs/ohlc/_increasing.py deleted file mode 100644 index f1ea3e20be2..00000000000 --- a/plotly/graph_objs/ohlc/_increasing.py +++ /dev/null @@ -1,114 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Increasing(BaseTraceHierarchyType): - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - width - Sets the line width (in px). - - Returns - ------- - plotly.graph_objs.ohlc.increasing.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'ohlc' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - line - plotly.graph_objs.ohlc.increasing.Line instance or dict - with compatible properties - """ - - def __init__(self, arg=None, line=None, **kwargs): - """ - Construct a new Increasing object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.ohlc.Increasing - line - plotly.graph_objs.ohlc.increasing.Line instance or dict - with compatible properties - - Returns - ------- - Increasing - """ - super(Increasing, self).__init__('increasing') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.ohlc.Increasing -constructor must be a dict or -an instance of plotly.graph_objs.ohlc.Increasing""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.ohlc import (increasing as v_increasing) - - # Initialize validators - # --------------------- - self._validators['line'] = v_increasing.LineValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/ohlc/_line.py b/plotly/graph_objs/ohlc/_line.py deleted file mode 100644 index d8b5ed052ed..00000000000 --- a/plotly/graph_objs/ohlc/_line.py +++ /dev/null @@ -1,150 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # dash - # ---- - @property - def dash(self): - """ - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). Note that this style setting can also be - set per direction via `increasing.line.dash` and - `decreasing.line.dash`. - - The 'dash' property is an enumeration that may be specified as: - - One of the following dash styles: - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - - A string containing a dash length list in pixels or percentages - (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) - - Returns - ------- - str - """ - return self['dash'] - - @dash.setter - def dash(self, val): - self['dash'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'ohlc' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). Note that this style setting can - also be set per direction via `increasing.line.dash` - and `decreasing.line.dash`. - width - [object Object] Note that this style setting can also - be set per direction via `increasing.line.width` and - `decreasing.line.width`. - """ - - def __init__(self, arg=None, dash=None, width=None, **kwargs): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.ohlc.Line - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). Note that this style setting can - also be set per direction via `increasing.line.dash` - and `decreasing.line.dash`. - width - [object Object] Note that this style setting can also - be set per direction via `increasing.line.width` and - `decreasing.line.width`. - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.ohlc.Line -constructor must be a dict or -an instance of plotly.graph_objs.ohlc.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.ohlc import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['dash'] = v_line.DashValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dash', None) - self['dash'] = dash if dash is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/ohlc/_stream.py b/plotly/graph_objs/ohlc/_stream.py deleted file mode 100644 index 1187e488dcd..00000000000 --- a/plotly/graph_objs/ohlc/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'ohlc' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.ohlc.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.ohlc.Stream -constructor must be a dict or -an instance of plotly.graph_objs.ohlc.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.ohlc import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/ohlc/decreasing/__init__.py b/plotly/graph_objs/ohlc/decreasing/__init__.py index 471a5835d71..a039791f472 100644 --- a/plotly/graph_objs/ohlc/decreasing/__init__.py +++ b/plotly/graph_objs/ohlc/decreasing/__init__.py @@ -1 +1,206 @@ -from ._line import Line + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dash + # ---- + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self['dash'] + + @dash.setter + def dash(self, val): + self['dash'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'ohlc.decreasing' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.ohlc.decreasing.Line + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.ohlc.decreasing.Line +constructor must be a dict or +an instance of plotly.graph_objs.ohlc.decreasing.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.ohlc.decreasing import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['dash'] = v_line.DashValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dash', None) + self['dash'] = dash if dash is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/ohlc/decreasing/_line.py b/plotly/graph_objs/ohlc/decreasing/_line.py deleted file mode 100644 index 4058a4ab0c3..00000000000 --- a/plotly/graph_objs/ohlc/decreasing/_line.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dash - # ---- - @property - def dash(self): - """ - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - - The 'dash' property is an enumeration that may be specified as: - - One of the following dash styles: - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - - A string containing a dash length list in pixels or percentages - (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) - - Returns - ------- - str - """ - return self['dash'] - - @dash.setter - def dash(self, val): - self['dash'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'ohlc.decreasing' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - width - Sets the line width (in px). - """ - - def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.ohlc.decreasing.Line - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - width - Sets the line width (in px). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.ohlc.decreasing.Line -constructor must be a dict or -an instance of plotly.graph_objs.ohlc.decreasing.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.ohlc.decreasing import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['dash'] = v_line.DashValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dash', None) - self['dash'] = dash if dash is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/ohlc/hoverlabel/__init__.py b/plotly/graph_objs/ohlc/hoverlabel/__init__.py index c37b8b5cd28..a12c8b152bf 100644 --- a/plotly/graph_objs/ohlc/hoverlabel/__init__.py +++ b/plotly/graph_objs/ohlc/hoverlabel/__init__.py @@ -1 +1,321 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'ohlc.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.ohlc.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.ohlc.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.ohlc.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.ohlc.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/ohlc/hoverlabel/_font.py b/plotly/graph_objs/ohlc/hoverlabel/_font.py deleted file mode 100644 index 3bfd9e85e24..00000000000 --- a/plotly/graph_objs/ohlc/hoverlabel/_font.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'ohlc.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.ohlc.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.ohlc.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.ohlc.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.ohlc.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/ohlc/increasing/__init__.py b/plotly/graph_objs/ohlc/increasing/__init__.py index 471a5835d71..8412bd53c91 100644 --- a/plotly/graph_objs/ohlc/increasing/__init__.py +++ b/plotly/graph_objs/ohlc/increasing/__init__.py @@ -1 +1,206 @@ -from ._line import Line + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dash + # ---- + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self['dash'] + + @dash.setter + def dash(self, val): + self['dash'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'ohlc.increasing' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.ohlc.increasing.Line + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.ohlc.increasing.Line +constructor must be a dict or +an instance of plotly.graph_objs.ohlc.increasing.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.ohlc.increasing import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['dash'] = v_line.DashValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dash', None) + self['dash'] = dash if dash is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/ohlc/increasing/_line.py b/plotly/graph_objs/ohlc/increasing/_line.py deleted file mode 100644 index 39a2287ef13..00000000000 --- a/plotly/graph_objs/ohlc/increasing/_line.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dash - # ---- - @property - def dash(self): - """ - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - - The 'dash' property is an enumeration that may be specified as: - - One of the following dash styles: - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - - A string containing a dash length list in pixels or percentages - (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) - - Returns - ------- - str - """ - return self['dash'] - - @dash.setter - def dash(self, val): - self['dash'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'ohlc.increasing' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - width - Sets the line width (in px). - """ - - def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.ohlc.increasing.Line - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - width - Sets the line width (in px). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.ohlc.increasing.Line -constructor must be a dict or -an instance of plotly.graph_objs.ohlc.increasing.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.ohlc.increasing import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['dash'] = v_line.DashValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dash', None) - self['dash'] = dash if dash is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcats/__init__.py b/plotly/graph_objs/parcats/__init__.py index d2295843e34..d7eabba44d6 100644 --- a/plotly/graph_objs/parcats/__init__.py +++ b/plotly/graph_objs/parcats/__init__.py @@ -1,7 +1,2130 @@ -from ._tickfont import Tickfont -from ._stream import Stream -from ._line import Line + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcats' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.parcats.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcats.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.parcats.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcats import (tickfont as v_tickfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcats' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.parcats.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcats.Stream +constructor must be a dict or +an instance of plotly.graph_objs.parcats.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcats import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in `line.color`is set + to a numerical array. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `line.color`) or the bounds + set in `line.cmin` and `line.cmax` Has an effect only if in + `line.color`is set to a numerical array. Defaults to `false` + when `line.cmin` and `line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `line.color`is set to a numerical array. Value should have + the same units as in `line.color` and if set, `line.cmin` must + be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `line.cmin` + and/or `line.cmax` to be equidistant to this point. Has an + effect only if in `line.color`is set to a numerical array. + Value should have the same units as in `line.color`. Has no + effect when `line.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `line.color`is set to a numerical array. Value should have + the same units as in `line.color` and if set, `line.cmax` must + be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets thelinecolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to `line.cmin` + and `line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to parcats.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of 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 + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.parcats.line.colorbar.Tickfor + matstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.parcats.line.colorbar.tickformatstopdefaults) + , sets the default property values to use for + elements of + parcats.line.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.parcats.line.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + parcats.line.colorbar.title.font instead. Sets + this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + parcats.line.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.parcats.line.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `line.color`is + set to a numerical array. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At minimum, a mapping for + the lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, + use`line.cmin` and `line.cmax`. Alternatively, `colorscale` may + be a palette name string of the following list: Greys,YlGnBu,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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + variables `count` and `probability`. Anything contained in tag + `` is displayed in the secondary box, for example + "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `line.color`is set to a numerical array. If true, `line.cmin` + will correspond to the last color in the array and `line.cmax` + will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # shape + # ----- + @property + 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'] + + Returns + ------- + Any + """ + return self['shape'] + + @shape.setter + def shape(self, val): + self['shape'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcats' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in + `line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `line.color`) + or the bounds set in `line.cmin` and `line.cmax` Has + an effect only if in `line.color`is set to a numerical + array. Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `line.color`is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `line.cmin` and/or `line.cmax` to be equidistant to + this point. Has an effect only if in `line.color`is set + to a numerical array. Value should have the same units + as in `line.color`. Has no effect when `line.cauto` is + `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `line.color`is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmax` must be set as well. + color + Sets thelinecolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `line.cmin` and `line.cmax` if + set. + colorbar + plotly.graph_objs.parcats.line.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named color + string. At minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, `[[0, + 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`line.cmin` + and `line.cmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,P + ortland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividi + s. + colorsrc + Sets the source reference on plot.ly for color . + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variables `count` and `probability`. + Anything contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". + reversescale + Reverses the color mapping if true. Has an effect only + if in `line.color`is set to a numerical array. If true, + `line.cmin` will correspond to the last color in the + array and `line.cmax` will correspond to the first + color. + shape + Sets the shape of the paths. If `linear`, paths are + composed of straight lines. If `hspline`, paths are + composed of horizontal curved splines + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `line.color`is set + to a numerical array. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorbar=None, + colorscale=None, + colorsrc=None, + hovertemplate=None, + reversescale=None, + shape=None, + showscale=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.parcats.Line + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in + `line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `line.color`) + or the bounds set in `line.cmin` and `line.cmax` Has + an effect only if in `line.color`is set to a numerical + array. Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `line.color`is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `line.cmin` and/or `line.cmax` to be equidistant to + this point. Has an effect only if in `line.color`is set + to a numerical array. Value should have the same units + as in `line.color`. Has no effect when `line.cauto` is + `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `line.color`is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmax` must be set as well. + color + Sets thelinecolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `line.cmin` and `line.cmax` if + set. + colorbar + plotly.graph_objs.parcats.line.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named color + string. At minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, `[[0, + 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`line.cmin` + and `line.cmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,P + ortland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividi + s. + colorsrc + Sets the source reference on plot.ly for color . + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variables `count` and `probability`. + Anything contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". + reversescale + Reverses the color mapping if true. Has an effect only + if in `line.color`is set to a numerical array. If true, + `line.cmin` will correspond to the last color in the + array and `line.cmax` will correspond to the first + color. + shape + Sets the shape of the paths. If `linear`, paths are + composed of straight lines. If `hspline`, paths are + composed of horizontal curved splines + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `line.color`is set + to a numerical array. + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcats.Line +constructor must be a dict or +an instance of plotly.graph_objs.parcats.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcats import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() + self._validators['cauto'] = v_line.CautoValidator() + self._validators['cmax'] = v_line.CmaxValidator() + self._validators['cmid'] = v_line.CmidValidator() + self._validators['cmin'] = v_line.CminValidator() + self._validators['color'] = v_line.ColorValidator() + self._validators['colorbar'] = v_line.ColorBarValidator() + self._validators['colorscale'] = v_line.ColorscaleValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['hovertemplate'] = v_line.HovertemplateValidator() + self._validators['reversescale'] = v_line.ReversescaleValidator() + self._validators['shape'] = v_line.ShapeValidator() + self._validators['showscale'] = v_line.ShowscaleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('shape', None) + self['shape'] = shape if shape is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Labelfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcats' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.parcats.Labelfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Labelfont + """ + super(Labelfont, self).__init__('labelfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcats.Labelfont +constructor must be a dict or +an instance of plotly.graph_objs.parcats.Labelfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcats import (labelfont as v_labelfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_labelfont.ColorValidator() + self._validators['family'] = v_labelfont.FamilyValidator() + self._validators['size'] = v_labelfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Domain(_BaseTraceHierarchyType): + + # column + # ------ + @property + 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] + + Returns + ------- + int + """ + return self['column'] + + @column.setter + def column(self, val): + self['column'] = val + + # row + # --- + @property + 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] + + Returns + ------- + int + """ + return self['row'] + + @row.setter + def row(self, val): + self['row'] = val + + # x + # - + @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] + + Returns + ------- + list + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @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] + + Returns + ------- + list + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcats' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this parcats trace . + row + If there is a layout grid, use the domain for this row + in the grid for this parcats trace . + x + Sets the horizontal domain of this parcats trace (in + plot fraction). + y + Sets the vertical domain of this parcats trace (in plot + fraction). + """ + + def __init__( + self, arg=None, column=None, row=None, x=None, y=None, **kwargs + ): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.parcats.Domain + column + If there is a layout grid, use the domain for this + column in the grid for this parcats trace . + row + If there is a layout grid, use the domain for this row + in the grid for this parcats trace . + x + Sets the horizontal domain of this parcats trace (in + plot fraction). + y + Sets the vertical domain of this parcats trace (in plot + fraction). + + Returns + ------- + Domain + """ + super(Domain, self).__init__('domain') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcats.Domain +constructor must be a dict or +an instance of plotly.graph_objs.parcats.Domain""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcats import (domain as v_domain) + + # Initialize validators + # --------------------- + self._validators['column'] = v_domain.ColumnValidator() + self._validators['row'] = v_domain.RowValidator() + self._validators['x'] = v_domain.XValidator() + self._validators['y'] = v_domain.YValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('column', None) + self['column'] = column if column is not None else _v + _v = arg.pop('row', None) + self['row'] = row if row is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Dimension(_BaseTraceHierarchyType): + + # categoryarray + # ------------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['categoryarray'] + + @categoryarray.setter + def categoryarray(self, val): + self['categoryarray'] = val + + # categoryarraysrc + # ---------------- + @property + def categoryarraysrc(self): + """ + Sets the source reference on plot.ly for categoryarray . + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['categoryarraysrc'] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self['categoryarraysrc'] = val + + # categoryorder + # ------------- + @property + def categoryorder(self): + """ + Specifies the ordering logic for the categories in the + dimension. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array'] + + Returns + ------- + Any + """ + return self['categoryorder'] + + @categoryorder.setter + def categoryorder(self, val): + self['categoryorder'] = val + + # displayindex + # ------------ + @property + 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) + + Returns + ------- + int + """ + return self['displayindex'] + + @displayindex.setter + def displayindex(self, val): + self['displayindex'] = val + + # label + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['label'] + + @label.setter + def label(self, val): + self['label'] = val + + # ticktext + # -------- + @property + def ticktext(self): + """ + Sets alternative tick labels for the categories in this + dimension. Only has an effect if `categoryorder` is set to + "array". Should be an array the same length as `categoryarray` + Used with `categoryorder`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # values + # ------ + @property + def values(self): + """ + Dimension values. `values[n]` represents the category value of + the `n`th point in the dataset, therefore the `values` vector + for all dimensions must be the same (longer vectors will be + truncated). + + The 'values' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['values'] + + @values.setter + def values(self, val): + self['values'] = val + + # valuessrc + # --------- + @property + def valuessrc(self): + """ + Sets the source reference on plot.ly for values . + + The 'valuessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['valuessrc'] + + @valuessrc.setter + def valuessrc(self, val): + self['valuessrc'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcats' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + categoryarray + Sets the order in which categories in this dimension + appear. Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the categories in the + dimension. By default, plotly uses "trace", which + specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + displayindex + The display index of dimension, from left to right, + zero indexed, defaults to dimension index. + label + The shown name of the dimension. + ticktext + Sets alternative tick labels for the categories in this + dimension. Only has an effect if `categoryorder` is set + to "array". Should be an array the same length as + `categoryarray` Used with `categoryorder`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + values + Dimension values. `values[n]` represents the category + value of the `n`th point in the dataset, therefore the + `values` vector for all dimensions must be the same + (longer vectors will be truncated). + valuessrc + Sets the source reference on plot.ly for values . + visible + Shows the dimension when set to `true` (the default). + Hides the dimension for `false`. + """ + + def __init__( + self, + arg=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + displayindex=None, + label=None, + ticktext=None, + ticktextsrc=None, + values=None, + valuessrc=None, + visible=None, + **kwargs + ): + """ + Construct a new Dimension object + + The dimensions (variables) of the parallel categories diagram. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.parcats.Dimension + categoryarray + Sets the order in which categories in this dimension + appear. Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for categoryarray + . + categoryorder + Specifies the ordering logic for the categories in the + dimension. By default, plotly uses "trace", which + specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + displayindex + The display index of dimension, from left to right, + zero indexed, defaults to dimension index. + label + The shown name of the dimension. + ticktext + Sets alternative tick labels for the categories in this + dimension. Only has an effect if `categoryorder` is set + to "array". Should be an array the same length as + `categoryarray` Used with `categoryorder`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + values + Dimension values. `values[n]` represents the category + value of the `n`th point in the dataset, therefore the + `values` vector for all dimensions must be the same + (longer vectors will be truncated). + valuessrc + Sets the source reference on plot.ly for values . + visible + Shows the dimension when set to `true` (the default). + Hides the dimension for `false`. + + Returns + ------- + Dimension + """ + super(Dimension, self).__init__('dimensions') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcats.Dimension +constructor must be a dict or +an instance of plotly.graph_objs.parcats.Dimension""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcats import (dimension as v_dimension) + + # Initialize validators + # --------------------- + self._validators['categoryarray'] = v_dimension.CategoryarrayValidator( + ) + self._validators['categoryarraysrc' + ] = v_dimension.CategoryarraysrcValidator() + self._validators['categoryorder'] = v_dimension.CategoryorderValidator( + ) + self._validators['displayindex'] = v_dimension.DisplayindexValidator() + self._validators['label'] = v_dimension.LabelValidator() + self._validators['ticktext'] = v_dimension.TicktextValidator() + self._validators['ticktextsrc'] = v_dimension.TicktextsrcValidator() + self._validators['values'] = v_dimension.ValuesValidator() + self._validators['valuessrc'] = v_dimension.ValuessrcValidator() + self._validators['visible'] = v_dimension.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('categoryarray', None) + self['categoryarray' + ] = categoryarray if categoryarray is not None else _v + _v = arg.pop('categoryarraysrc', None) + self['categoryarraysrc' + ] = categoryarraysrc if categoryarraysrc is not None else _v + _v = arg.pop('categoryorder', None) + self['categoryorder' + ] = categoryorder if categoryorder is not None else _v + _v = arg.pop('displayindex', None) + self['displayindex'] = displayindex if displayindex is not None else _v + _v = arg.pop('label', None) + self['label'] = label if label is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('values', None) + self['values'] = values if values is not None else _v + _v = arg.pop('valuessrc', None) + self['valuessrc'] = valuessrc if valuessrc is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.parcats import line -from ._labelfont import Labelfont -from ._domain import Domain -from ._dimension import Dimension diff --git a/plotly/graph_objs/parcats/_dimension.py b/plotly/graph_objs/parcats/_dimension.py deleted file mode 100644 index c09bf3ca2a8..00000000000 --- a/plotly/graph_objs/parcats/_dimension.py +++ /dev/null @@ -1,431 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Dimension(BaseTraceHierarchyType): - - # categoryarray - # ------------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['categoryarray'] - - @categoryarray.setter - def categoryarray(self, val): - self['categoryarray'] = val - - # categoryarraysrc - # ---------------- - @property - def categoryarraysrc(self): - """ - Sets the source reference on plot.ly for categoryarray . - - The 'categoryarraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['categoryarraysrc'] - - @categoryarraysrc.setter - def categoryarraysrc(self, val): - self['categoryarraysrc'] = val - - # categoryorder - # ------------- - @property - def categoryorder(self): - """ - Specifies the ordering logic for the categories in the - dimension. By default, plotly uses "trace", which specifies the - order that is present in the data supplied. Set `categoryorder` - to *category ascending* or *category descending* if order - should be determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" to derive the - ordering from the attribute `categoryarray`. If a category is - not found in the `categoryarray` array, the sorting behavior - for that attribute will be identical to the "trace" mode. The - unspecified categories will follow the categories in - `categoryarray`. - - The 'categoryorder' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['trace', 'category ascending', 'category descending', - 'array'] - - Returns - ------- - Any - """ - return self['categoryorder'] - - @categoryorder.setter - def categoryorder(self, val): - self['categoryorder'] = val - - # displayindex - # ------------ - @property - 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) - - Returns - ------- - int - """ - return self['displayindex'] - - @displayindex.setter - def displayindex(self, val): - self['displayindex'] = val - - # label - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['label'] - - @label.setter - def label(self, val): - self['label'] = val - - # ticktext - # -------- - @property - def ticktext(self): - """ - Sets alternative tick labels for the categories in this - dimension. Only has an effect if `categoryorder` is set to - "array". Should be an array the same length as `categoryarray` - Used with `categoryorder`. - - The 'ticktext' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # values - # ------ - @property - def values(self): - """ - Dimension values. `values[n]` represents the category value of - the `n`th point in the dataset, therefore the `values` vector - for all dimensions must be the same (longer vectors will be - truncated). - - The 'values' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['values'] - - @values.setter - def values(self, val): - self['values'] = val - - # valuessrc - # --------- - @property - def valuessrc(self): - """ - Sets the source reference on plot.ly for values . - - The 'valuessrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['valuessrc'] - - @valuessrc.setter - def valuessrc(self, val): - self['valuessrc'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcats' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - categoryarray - Sets the order in which categories in this dimension - appear. Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the categories in the - dimension. By default, plotly uses "trace", which - specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - displayindex - The display index of dimension, from left to right, - zero indexed, defaults to dimension index. - label - The shown name of the dimension. - ticktext - Sets alternative tick labels for the categories in this - dimension. Only has an effect if `categoryorder` is set - to "array". Should be an array the same length as - `categoryarray` Used with `categoryorder`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - values - Dimension values. `values[n]` represents the category - value of the `n`th point in the dataset, therefore the - `values` vector for all dimensions must be the same - (longer vectors will be truncated). - valuessrc - Sets the source reference on plot.ly for values . - visible - Shows the dimension when set to `true` (the default). - Hides the dimension for `false`. - """ - - def __init__( - self, - arg=None, - categoryarray=None, - categoryarraysrc=None, - categoryorder=None, - displayindex=None, - label=None, - ticktext=None, - ticktextsrc=None, - values=None, - valuessrc=None, - visible=None, - **kwargs - ): - """ - Construct a new Dimension object - - The dimensions (variables) of the parallel categories diagram. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcats.Dimension - categoryarray - Sets the order in which categories in this dimension - appear. Only has an effect if `categoryorder` is set to - "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for categoryarray - . - categoryorder - Specifies the ordering logic for the categories in the - dimension. By default, plotly uses "trace", which - specifies the order that is present in the data - supplied. Set `categoryorder` to *category ascending* - or *category descending* if order should be determined - by the alphanumerical order of the category names. Set - `categoryorder` to "array" to derive the ordering from - the attribute `categoryarray`. If a category is not - found in the `categoryarray` array, the sorting - behavior for that attribute will be identical to the - "trace" mode. The unspecified categories will follow - the categories in `categoryarray`. - displayindex - The display index of dimension, from left to right, - zero indexed, defaults to dimension index. - label - The shown name of the dimension. - ticktext - Sets alternative tick labels for the categories in this - dimension. Only has an effect if `categoryorder` is set - to "array". Should be an array the same length as - `categoryarray` Used with `categoryorder`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - values - Dimension values. `values[n]` represents the category - value of the `n`th point in the dataset, therefore the - `values` vector for all dimensions must be the same - (longer vectors will be truncated). - valuessrc - Sets the source reference on plot.ly for values . - visible - Shows the dimension when set to `true` (the default). - Hides the dimension for `false`. - - Returns - ------- - Dimension - """ - super(Dimension, self).__init__('dimensions') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcats.Dimension -constructor must be a dict or -an instance of plotly.graph_objs.parcats.Dimension""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcats import (dimension as v_dimension) - - # Initialize validators - # --------------------- - self._validators['categoryarray'] = v_dimension.CategoryarrayValidator( - ) - self._validators['categoryarraysrc' - ] = v_dimension.CategoryarraysrcValidator() - self._validators['categoryorder'] = v_dimension.CategoryorderValidator( - ) - self._validators['displayindex'] = v_dimension.DisplayindexValidator() - self._validators['label'] = v_dimension.LabelValidator() - self._validators['ticktext'] = v_dimension.TicktextValidator() - self._validators['ticktextsrc'] = v_dimension.TicktextsrcValidator() - self._validators['values'] = v_dimension.ValuesValidator() - self._validators['valuessrc'] = v_dimension.ValuessrcValidator() - self._validators['visible'] = v_dimension.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('categoryarray', None) - self['categoryarray' - ] = categoryarray if categoryarray is not None else _v - _v = arg.pop('categoryarraysrc', None) - self['categoryarraysrc' - ] = categoryarraysrc if categoryarraysrc is not None else _v - _v = arg.pop('categoryorder', None) - self['categoryorder' - ] = categoryorder if categoryorder is not None else _v - _v = arg.pop('displayindex', None) - self['displayindex'] = displayindex if displayindex is not None else _v - _v = arg.pop('label', None) - self['label'] = label if label is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('values', None) - self['values'] = values if values is not None else _v - _v = arg.pop('valuessrc', None) - self['valuessrc'] = valuessrc if valuessrc is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcats/_domain.py b/plotly/graph_objs/parcats/_domain.py deleted file mode 100644 index 4f1d725bc4a..00000000000 --- a/plotly/graph_objs/parcats/_domain.py +++ /dev/null @@ -1,206 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Domain(BaseTraceHierarchyType): - - # column - # ------ - @property - 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] - - Returns - ------- - int - """ - return self['column'] - - @column.setter - def column(self, val): - self['column'] = val - - # row - # --- - @property - 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] - - Returns - ------- - int - """ - return self['row'] - - @row.setter - def row(self, val): - self['row'] = val - - # x - # - - @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] - - Returns - ------- - list - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @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] - - Returns - ------- - list - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcats' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - column - If there is a layout grid, use the domain for this - column in the grid for this parcats trace . - row - If there is a layout grid, use the domain for this row - in the grid for this parcats trace . - x - Sets the horizontal domain of this parcats trace (in - plot fraction). - y - Sets the vertical domain of this parcats trace (in plot - fraction). - """ - - def __init__( - self, arg=None, column=None, row=None, x=None, y=None, **kwargs - ): - """ - Construct a new Domain object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcats.Domain - column - If there is a layout grid, use the domain for this - column in the grid for this parcats trace . - row - If there is a layout grid, use the domain for this row - in the grid for this parcats trace . - x - Sets the horizontal domain of this parcats trace (in - plot fraction). - y - Sets the vertical domain of this parcats trace (in plot - fraction). - - Returns - ------- - Domain - """ - super(Domain, self).__init__('domain') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcats.Domain -constructor must be a dict or -an instance of plotly.graph_objs.parcats.Domain""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcats import (domain as v_domain) - - # Initialize validators - # --------------------- - self._validators['column'] = v_domain.ColumnValidator() - self._validators['row'] = v_domain.RowValidator() - self._validators['x'] = v_domain.XValidator() - self._validators['y'] = v_domain.YValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('column', None) - self['column'] = column if column is not None else _v - _v = arg.pop('row', None) - self['row'] = row if row is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcats/_labelfont.py b/plotly/graph_objs/parcats/_labelfont.py deleted file mode 100644 index 55067dcbe4c..00000000000 --- a/plotly/graph_objs/parcats/_labelfont.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Labelfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcats' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcats.Labelfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Labelfont - """ - super(Labelfont, self).__init__('labelfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcats.Labelfont -constructor must be a dict or -an instance of plotly.graph_objs.parcats.Labelfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcats import (labelfont as v_labelfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_labelfont.ColorValidator() - self._validators['family'] = v_labelfont.FamilyValidator() - self._validators['size'] = v_labelfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcats/_line.py b/plotly/graph_objs/parcats/_line.py deleted file mode 100644 index 2c20051c2d3..00000000000 --- a/plotly/graph_objs/parcats/_line.py +++ /dev/null @@ -1,889 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `line.colorscale`. Has an effect only if in `line.color`is set - to a numerical array. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be chosen - according to whether numbers in the `color` array are all - positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `line.color`) or the bounds - set in `line.cmin` and `line.cmax` Has an effect only if in - `line.color`is set to a numerical array. Defaults to `false` - when `line.cmin` and `line.cmax` are set by the user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - in `line.color`is set to a numerical array. Value should have - the same units as in `line.color` and if set, `line.cmin` must - be set as well. - - The 'cmax' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling `line.cmin` - and/or `line.cmax` to be equidistant to this point. Has an - effect only if in `line.color`is set to a numerical array. - Value should have the same units as in `line.color`. Has no - effect when `line.cauto` is `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - in `line.color`is set to a numerical array. Value should have - the same units as in `line.color` and if set, `line.cmax` must - be set as well. - - The 'cmin' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets thelinecolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to `line.cmin` - and `line.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to parcats.line.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of 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 - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.parcats.line.colorbar.Tickfor - matstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.parcats.line.colorbar.tickformatstopdefaults) - , sets the default property values to use for - elements of - parcats.line.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.parcats.line.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - parcats.line.colorbar.title.font instead. Sets - this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - parcats.line.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.parcats.line.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in `line.color`is - set to a numerical array. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At minimum, a mapping for - the lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color space, - use`line.cmin` and `line.cmax`. Alternatively, `colorscale` may - be a palette name string of the following list: Greys,YlGnBu,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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - variables `count` and `probability`. Anything contained in tag - `` is displayed in the secondary box, for example - "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `line.color`is set to a numerical array. If true, `line.cmin` - will correspond to the last color in the array and `line.cmax` - will correspond to the first color. - - The 'reversescale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # shape - # ----- - @property - 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'] - - Returns - ------- - Any - """ - return self['shape'] - - @shape.setter - def shape(self, val): - self['shape'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcats' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `line.colorscale`. Has an effect only if in - `line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `line.color`) - or the bounds set in `line.cmin` and `line.cmax` Has - an effect only if in `line.color`is set to a numerical - array. Defaults to `false` when `line.cmin` and - `line.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `line.color`is set to a numerical array. - Value should have the same units as in `line.color` and - if set, `line.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `line.cmin` and/or `line.cmax` to be equidistant to - this point. Has an effect only if in `line.color`is set - to a numerical array. Value should have the same units - as in `line.color`. Has no effect when `line.cauto` is - `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `line.color`is set to a numerical array. - Value should have the same units as in `line.color` and - if set, `line.cmax` must be set as well. - color - Sets thelinecolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `line.cmin` and `line.cmax` if - set. - colorbar - plotly.graph_objs.parcats.line.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named color - string. At minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, `[[0, - 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`line.cmin` - and `line.cmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,P - ortland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividi - s. - colorsrc - Sets the source reference on plot.ly for color . - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variables `count` and `probability`. - Anything contained in tag `` is displayed in the - secondary box, for example - "{fullData.name}". - reversescale - Reverses the color mapping if true. Has an effect only - if in `line.color`is set to a numerical array. If true, - `line.cmin` will correspond to the last color in the - array and `line.cmax` will correspond to the first - color. - shape - Sets the shape of the paths. If `linear`, paths are - composed of straight lines. If `hspline`, paths are - composed of horizontal curved splines - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `line.color`is set - to a numerical array. - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorbar=None, - colorscale=None, - colorsrc=None, - hovertemplate=None, - reversescale=None, - shape=None, - showscale=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcats.Line - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `line.colorscale`. Has an effect only if in - `line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `line.color`) - or the bounds set in `line.cmin` and `line.cmax` Has - an effect only if in `line.color`is set to a numerical - array. Defaults to `false` when `line.cmin` and - `line.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `line.color`is set to a numerical array. - Value should have the same units as in `line.color` and - if set, `line.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `line.cmin` and/or `line.cmax` to be equidistant to - this point. Has an effect only if in `line.color`is set - to a numerical array. Value should have the same units - as in `line.color`. Has no effect when `line.cauto` is - `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `line.color`is set to a numerical array. - Value should have the same units as in `line.color` and - if set, `line.cmax` must be set as well. - color - Sets thelinecolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `line.cmin` and `line.cmax` if - set. - colorbar - plotly.graph_objs.parcats.line.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named color - string. At minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, `[[0, - 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`line.cmin` - and `line.cmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,P - ortland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividi - s. - colorsrc - Sets the source reference on plot.ly for color . - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variables `count` and `probability`. - Anything contained in tag `` is displayed in the - secondary box, for example - "{fullData.name}". - reversescale - Reverses the color mapping if true. Has an effect only - if in `line.color`is set to a numerical array. If true, - `line.cmin` will correspond to the last color in the - array and `line.cmax` will correspond to the first - color. - shape - Sets the shape of the paths. If `linear`, paths are - composed of straight lines. If `hspline`, paths are - composed of horizontal curved splines - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `line.color`is set - to a numerical array. - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcats.Line -constructor must be a dict or -an instance of plotly.graph_objs.parcats.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcats import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() - self._validators['cauto'] = v_line.CautoValidator() - self._validators['cmax'] = v_line.CmaxValidator() - self._validators['cmid'] = v_line.CmidValidator() - self._validators['cmin'] = v_line.CminValidator() - self._validators['color'] = v_line.ColorValidator() - self._validators['colorbar'] = v_line.ColorBarValidator() - self._validators['colorscale'] = v_line.ColorscaleValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['hovertemplate'] = v_line.HovertemplateValidator() - self._validators['reversescale'] = v_line.ReversescaleValidator() - self._validators['shape'] = v_line.ShapeValidator() - self._validators['showscale'] = v_line.ShowscaleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('shape', None) - self['shape'] = shape if shape is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcats/_stream.py b/plotly/graph_objs/parcats/_stream.py deleted file mode 100644 index c55e621f723..00000000000 --- a/plotly/graph_objs/parcats/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcats' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcats.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcats.Stream -constructor must be a dict or -an instance of plotly.graph_objs.parcats.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcats import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcats/_tickfont.py b/plotly/graph_objs/parcats/_tickfont.py deleted file mode 100644 index 910f8f64752..00000000000 --- a/plotly/graph_objs/parcats/_tickfont.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcats' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcats.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcats.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.parcats.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcats import (tickfont as v_tickfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcats/line/__init__.py b/plotly/graph_objs/parcats/line/__init__.py index 351d29d9d3f..3191a9e1c85 100644 --- a/plotly/graph_objs/parcats/line/__init__.py +++ b/plotly/graph_objs/parcats/line/__init__.py @@ -1,2 +1,1869 @@ -from ._colorbar import ColorBar + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.parcats.line.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.parcats.line.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.parcats.line.c + 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 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 + ------- + plotly.graph_objs.parcats.line.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.parcats.line.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use parcats.line.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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use parcats.line.colorbar.title.side + instead. Determines the location of color bar's title with + respect to the color bar. Note that the title's location used + to be set by the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcats.line' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.parcats.line.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.parcat + s.line.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + parcats.line.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.parcats.line.colorbar.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use parcats.line.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use parcats.line.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.parcats.line.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.parcats.line.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.parcat + s.line.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + parcats.line.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.parcats.line.colorbar.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use parcats.line.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use parcats.line.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcats.line.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.parcats.line.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcats.line import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.parcats.line import colorbar diff --git a/plotly/graph_objs/parcats/line/_colorbar.py b/plotly/graph_objs/parcats/line/_colorbar.py deleted file mode 100644 index bd93e4aa133..00000000000 --- a/plotly/graph_objs/parcats/line/_colorbar.py +++ /dev/null @@ -1,1864 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.parcats.line.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.parcats.line.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.parcats.line.c - 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 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 - ------- - plotly.graph_objs.parcats.line.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.parcats.line.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use parcats.line.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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use parcats.line.colorbar.title.side - instead. Determines the location of color bar's title with - respect to the color bar. Note that the title's location used - to be set by the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcats.line' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.parcats.line.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.parcat - s.line.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - parcats.line.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.parcats.line.colorbar.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use parcats.line.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use parcats.line.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcats.line.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.parcats.line.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.parcat - s.line.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - parcats.line.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.parcats.line.colorbar.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use parcats.line.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use parcats.line.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcats.line.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.parcats.line.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcats.line import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcats/line/colorbar/__init__.py b/plotly/graph_objs/parcats/line/colorbar/__init__.py index 15bddd053bd..60e0f6d26c4 100644 --- a/plotly/graph_objs/parcats/line/colorbar/__init__.py +++ b/plotly/graph_objs/parcats/line/colorbar/__init__.py @@ -1,4 +1,723 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.parcats.line.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcats.line.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.parcats.line.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcats.line.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.parcats.line.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcats.line.colorbar import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcats.line.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.parcats.line.colorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcats.line.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.parcats.line.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcats.line.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcats.line.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.parcats.line.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcats.line.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.parcats.line.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcats.line.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.parcats.line.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/parcats/line/colorbar/_tickfont.py b/plotly/graph_objs/parcats/line/colorbar/_tickfont.py deleted file mode 100644 index 0d9c2515cc7..00000000000 --- a/plotly/graph_objs/parcats/line/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcats.line.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.parcats.line.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcats.line.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.parcats.line.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcats.line.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcats/line/colorbar/_tickformatstop.py b/plotly/graph_objs/parcats/line/colorbar/_tickformatstop.py deleted file mode 100644 index 2b8d0dec2c2..00000000000 --- a/plotly/graph_objs/parcats/line/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcats.line.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.parcats.line.colorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcats.line.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.parcats.line.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcats.line.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcats/line/colorbar/_title.py b/plotly/graph_objs/parcats/line/colorbar/_title.py deleted file mode 100644 index 67291a7f7e0..00000000000 --- a/plotly/graph_objs/parcats/line/colorbar/_title.py +++ /dev/null @@ -1,202 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.parcats.line.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcats.line.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.parcats.line.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcats.line.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.parcats.line.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcats.line.colorbar import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcats/line/colorbar/title/__init__.py b/plotly/graph_objs/parcats/line/colorbar/title/__init__.py index c37b8b5cd28..64571204292 100644 --- a/plotly/graph_objs/parcats/line/colorbar/title/__init__.py +++ b/plotly/graph_objs/parcats/line/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcats.line.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.parcats.line.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcats.line.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.parcats.line.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcats.line.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/parcats/line/colorbar/title/_font.py b/plotly/graph_objs/parcats/line/colorbar/title/_font.py deleted file mode 100644 index 7665101c6f9..00000000000 --- a/plotly/graph_objs/parcats/line/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcats.line.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.parcats.line.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcats.line.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.parcats.line.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcats.line.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcoords/__init__.py b/plotly/graph_objs/parcoords/__init__.py index 7a8247fc86e..b5793d07487 100644 --- a/plotly/graph_objs/parcoords/__init__.py +++ b/plotly/graph_objs/parcoords/__init__.py @@ -1,8 +1,2411 @@ -from ._tickfont import Tickfont -from ._stream import Stream -from ._rangefont import Rangefont -from ._line import Line + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcoords' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.parcoords.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcoords.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.parcoords.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcoords import (tickfont as v_tickfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcoords' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.parcoords.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcoords.Stream +constructor must be a dict or +an instance of plotly.graph_objs.parcoords.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcoords import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Rangefont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcoords' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.parcoords.Rangefont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Rangefont + """ + super(Rangefont, self).__init__('rangefont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcoords.Rangefont +constructor must be a dict or +an instance of plotly.graph_objs.parcoords.Rangefont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcoords import (rangefont as v_rangefont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_rangefont.ColorValidator() + self._validators['family'] = v_rangefont.FamilyValidator() + self._validators['size'] = v_rangefont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in `line.color`is set + to a numerical array. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `line.color`) or the bounds + set in `line.cmin` and `line.cmax` Has an effect only if in + `line.color`is set to a numerical array. Defaults to `false` + when `line.cmin` and `line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `line.color`is set to a numerical array. Value should have + the same units as in `line.color` and if set, `line.cmin` must + be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `line.cmin` + and/or `line.cmax` to be equidistant to this point. Has an + effect only if in `line.color`is set to a numerical array. + Value should have the same units as in `line.color`. Has no + effect when `line.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `line.color`is set to a numerical array. Value should have + the same units as in `line.color` and if set, `line.cmax` must + be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets thelinecolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to `line.cmin` + and `line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to parcoords.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of 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 + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.parcoords.line.colorbar.Tickf + ormatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.parcoords.line.colorbar.tickformatstopdefault + s), sets the default property values to use for + elements of + parcoords.line.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.parcoords.line.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + parcoords.line.colorbar.title.font instead. + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + parcoords.line.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.parcoords.line.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `line.color`is + set to a numerical array. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At minimum, a mapping for + the lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, + use`line.cmin` and `line.cmax`. Alternatively, `colorscale` may + be a palette name string of the following list: Greys,YlGnBu,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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `line.color`is set to a numerical array. If true, `line.cmin` + will correspond to the last color in the array and `line.cmax` + will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcoords' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in + `line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `line.color`) + or the bounds set in `line.cmin` and `line.cmax` Has + an effect only if in `line.color`is set to a numerical + array. Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `line.color`is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `line.cmin` and/or `line.cmax` to be equidistant to + this point. Has an effect only if in `line.color`is set + to a numerical array. Value should have the same units + as in `line.color`. Has no effect when `line.cauto` is + `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `line.color`is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmax` must be set as well. + color + Sets thelinecolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `line.cmin` and `line.cmax` if + set. + colorbar + plotly.graph_objs.parcoords.line.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named color + string. At minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, `[[0, + 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`line.cmin` + and `line.cmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,P + ortland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividi + s. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `line.color`is set to a numerical array. If true, + `line.cmin` will correspond to the last color in the + array and `line.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `line.color`is set + to a numerical array. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorbar=None, + colorscale=None, + colorsrc=None, + reversescale=None, + showscale=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.parcoords.Line + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in + `line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `line.color`) + or the bounds set in `line.cmin` and `line.cmax` Has + an effect only if in `line.color`is set to a numerical + array. Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `line.color`is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `line.cmin` and/or `line.cmax` to be equidistant to + this point. Has an effect only if in `line.color`is set + to a numerical array. Value should have the same units + as in `line.color`. Has no effect when `line.cauto` is + `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `line.color`is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmax` must be set as well. + color + Sets thelinecolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `line.cmin` and `line.cmax` if + set. + colorbar + plotly.graph_objs.parcoords.line.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named color + string. At minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, `[[0, + 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`line.cmin` + and `line.cmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,P + ortland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividi + s. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `line.color`is set to a numerical array. If true, + `line.cmin` will correspond to the last color in the + array and `line.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `line.color`is set + to a numerical array. + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcoords.Line +constructor must be a dict or +an instance of plotly.graph_objs.parcoords.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcoords import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() + self._validators['cauto'] = v_line.CautoValidator() + self._validators['cmax'] = v_line.CmaxValidator() + self._validators['cmid'] = v_line.CmidValidator() + self._validators['cmin'] = v_line.CminValidator() + self._validators['color'] = v_line.ColorValidator() + self._validators['colorbar'] = v_line.ColorBarValidator() + self._validators['colorscale'] = v_line.ColorscaleValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['reversescale'] = v_line.ReversescaleValidator() + self._validators['showscale'] = v_line.ShowscaleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Labelfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcoords' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.parcoords.Labelfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Labelfont + """ + super(Labelfont, self).__init__('labelfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcoords.Labelfont +constructor must be a dict or +an instance of plotly.graph_objs.parcoords.Labelfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcoords import (labelfont as v_labelfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_labelfont.ColorValidator() + self._validators['family'] = v_labelfont.FamilyValidator() + self._validators['size'] = v_labelfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Domain(_BaseTraceHierarchyType): + + # column + # ------ + @property + 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] + + Returns + ------- + int + """ + return self['column'] + + @column.setter + def column(self, val): + self['column'] = val + + # row + # --- + @property + 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] + + Returns + ------- + int + """ + return self['row'] + + @row.setter + def row(self, val): + self['row'] = val + + # x + # - + @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] + + Returns + ------- + list + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @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] + + Returns + ------- + list + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcoords' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this parcoords trace . + row + If there is a layout grid, use the domain for this row + in the grid for this parcoords trace . + x + Sets the horizontal domain of this parcoords trace (in + plot fraction). + y + Sets the vertical domain of this parcoords trace (in + plot fraction). + """ + + def __init__( + self, arg=None, column=None, row=None, x=None, y=None, **kwargs + ): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.parcoords.Domain + column + If there is a layout grid, use the domain for this + column in the grid for this parcoords trace . + row + If there is a layout grid, use the domain for this row + in the grid for this parcoords trace . + x + Sets the horizontal domain of this parcoords trace (in + plot fraction). + y + Sets the vertical domain of this parcoords trace (in + plot fraction). + + Returns + ------- + Domain + """ + super(Domain, self).__init__('domain') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcoords.Domain +constructor must be a dict or +an instance of plotly.graph_objs.parcoords.Domain""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcoords import (domain as v_domain) + + # Initialize validators + # --------------------- + self._validators['column'] = v_domain.ColumnValidator() + self._validators['row'] = v_domain.RowValidator() + self._validators['x'] = v_domain.XValidator() + self._validators['y'] = v_domain.YValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('column', None) + self['column'] = column if column is not None else _v + _v = arg.pop('row', None) + self['row'] = row if row is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Dimension(_BaseTraceHierarchyType): + + # constraintrange + # --------------- + @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 + """ + return self['constraintrange'] + + @constraintrange.setter + def constraintrange(self, val): + self['constraintrange'] = val + + # label + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['label'] + + @label.setter + def label(self, val): + self['label'] = val + + # multiselect + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['multiselect'] + + @multiselect.setter + def multiselect(self, val): + self['multiselect'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # range + # ----- + @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 + + Returns + ------- + list + """ + return self['range'] + + @range.setter + def range(self, val): + self['range'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + language which is similar to those of Python. See https://githu + b.com/d3/d3-format/blob/master/README.md#locale_format + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # values + # ------ + @property + def values(self): + """ + Dimension values. `values[n]` represents the value of the `n`th + point in the dataset, therefore the `values` vector for all + dimensions must be the same (longer vectors will be truncated). + Each value must be a finite number. + + The 'values' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['values'] + + @values.setter + def values(self, val): + self['values'] = val + + # valuessrc + # --------- + @property + def valuessrc(self): + """ + Sets the source reference on plot.ly for values . + + The 'valuessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['valuessrc'] + + @valuessrc.setter + def valuessrc(self, val): + self['valuessrc'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcoords' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + constraintrange + The domain range to which the filter on the dimension + is constrained. Must be an array of `[fromValue, + toValue]` with `fromValue <= toValue`, or if + `multiselect` is not disabled, you may give an array of + arrays, where each inner array is `[fromValue, + toValue]`. + label + The shown name of the dimension. + multiselect + Do we allow multiple selection ranges or just a single + range? + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + range + The domain range that represents the full, shown axis + extent. Defaults to the `values` extent. Must be an + array of `[fromValue, toValue]` with finite numbers as + elements. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-language which is similar to those of Python. See + https://github.com/d3/d3-format/blob/master/README.md#l + ocale_format + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + values + Dimension values. `values[n]` represents the value of + the `n`th point in the dataset, therefore the `values` + vector for all dimensions must be the same (longer + vectors will be truncated). Each value must be a finite + number. + valuessrc + Sets the source reference on plot.ly for values . + visible + Shows the dimension when set to `true` (the default). + Hides the dimension for `false`. + """ + + def __init__( + self, + arg=None, + constraintrange=None, + label=None, + multiselect=None, + name=None, + range=None, + templateitemname=None, + tickformat=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + values=None, + valuessrc=None, + visible=None, + **kwargs + ): + """ + Construct a new Dimension object + + The dimensions (variables) of the parallel coordinates chart. + 2..60 dimensions are supported. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.parcoords.Dimension + constraintrange + The domain range to which the filter on the dimension + is constrained. Must be an array of `[fromValue, + toValue]` with `fromValue <= toValue`, or if + `multiselect` is not disabled, you may give an array of + arrays, where each inner array is `[fromValue, + toValue]`. + label + The shown name of the dimension. + multiselect + Do we allow multiple selection ranges or just a single + range? + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + range + The domain range that represents the full, shown axis + extent. Defaults to the `values` extent. Must be an + array of `[fromValue, toValue]` with finite numbers as + elements. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-language which is similar to those of Python. See + https://github.com/d3/d3-format/blob/master/README.md#l + ocale_format + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + values + Dimension values. `values[n]` represents the value of + the `n`th point in the dataset, therefore the `values` + vector for all dimensions must be the same (longer + vectors will be truncated). Each value must be a finite + number. + valuessrc + Sets the source reference on plot.ly for values . + visible + Shows the dimension when set to `true` (the default). + Hides the dimension for `false`. + + Returns + ------- + Dimension + """ + super(Dimension, self).__init__('dimensions') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcoords.Dimension +constructor must be a dict or +an instance of plotly.graph_objs.parcoords.Dimension""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcoords import (dimension as v_dimension) + + # Initialize validators + # --------------------- + self._validators['constraintrange' + ] = v_dimension.ConstraintrangeValidator() + self._validators['label'] = v_dimension.LabelValidator() + self._validators['multiselect'] = v_dimension.MultiselectValidator() + self._validators['name'] = v_dimension.NameValidator() + self._validators['range'] = v_dimension.RangeValidator() + self._validators['templateitemname' + ] = v_dimension.TemplateitemnameValidator() + self._validators['tickformat'] = v_dimension.TickformatValidator() + self._validators['ticktext'] = v_dimension.TicktextValidator() + self._validators['ticktextsrc'] = v_dimension.TicktextsrcValidator() + self._validators['tickvals'] = v_dimension.TickvalsValidator() + self._validators['tickvalssrc'] = v_dimension.TickvalssrcValidator() + self._validators['values'] = v_dimension.ValuesValidator() + self._validators['valuessrc'] = v_dimension.ValuessrcValidator() + self._validators['visible'] = v_dimension.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('constraintrange', None) + self['constraintrange' + ] = constraintrange if constraintrange is not None else _v + _v = arg.pop('label', None) + self['label'] = label if label is not None else _v + _v = arg.pop('multiselect', None) + self['multiselect'] = multiselect if multiselect is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('range', None) + self['range'] = range if range is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('values', None) + self['values'] = values if values is not None else _v + _v = arg.pop('valuessrc', None) + self['valuessrc'] = valuessrc if valuessrc is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.parcoords import line -from ._labelfont import Labelfont -from ._domain import Domain -from ._dimension import Dimension diff --git a/plotly/graph_objs/parcoords/_dimension.py b/plotly/graph_objs/parcoords/_dimension.py deleted file mode 100644 index 84c7472c45a..00000000000 --- a/plotly/graph_objs/parcoords/_dimension.py +++ /dev/null @@ -1,595 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Dimension(BaseTraceHierarchyType): - - # constraintrange - # --------------- - @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 - """ - return self['constraintrange'] - - @constraintrange.setter - def constraintrange(self, val): - self['constraintrange'] = val - - # label - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['label'] - - @label.setter - def label(self, val): - self['label'] = val - - # multiselect - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['multiselect'] - - @multiselect.setter - def multiselect(self, val): - self['multiselect'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # range - # ----- - @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 - - Returns - ------- - list - """ - return self['range'] - - @range.setter - def range(self, val): - self['range'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - language which is similar to those of Python. See https://githu - b.com/d3/d3-format/blob/master/README.md#locale_format - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # values - # ------ - @property - def values(self): - """ - Dimension values. `values[n]` represents the value of the `n`th - point in the dataset, therefore the `values` vector for all - dimensions must be the same (longer vectors will be truncated). - Each value must be a finite number. - - The 'values' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['values'] - - @values.setter - def values(self, val): - self['values'] = val - - # valuessrc - # --------- - @property - def valuessrc(self): - """ - Sets the source reference on plot.ly for values . - - The 'valuessrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['valuessrc'] - - @valuessrc.setter - def valuessrc(self, val): - self['valuessrc'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcoords' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - constraintrange - The domain range to which the filter on the dimension - is constrained. Must be an array of `[fromValue, - toValue]` with `fromValue <= toValue`, or if - `multiselect` is not disabled, you may give an array of - arrays, where each inner array is `[fromValue, - toValue]`. - label - The shown name of the dimension. - multiselect - Do we allow multiple selection ranges or just a single - range? - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - range - The domain range that represents the full, shown axis - extent. Defaults to the `values` extent. Must be an - array of `[fromValue, toValue]` with finite numbers as - elements. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-language which is similar to those of Python. See - https://github.com/d3/d3-format/blob/master/README.md#l - ocale_format - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - values - Dimension values. `values[n]` represents the value of - the `n`th point in the dataset, therefore the `values` - vector for all dimensions must be the same (longer - vectors will be truncated). Each value must be a finite - number. - valuessrc - Sets the source reference on plot.ly for values . - visible - Shows the dimension when set to `true` (the default). - Hides the dimension for `false`. - """ - - def __init__( - self, - arg=None, - constraintrange=None, - label=None, - multiselect=None, - name=None, - range=None, - templateitemname=None, - tickformat=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - values=None, - valuessrc=None, - visible=None, - **kwargs - ): - """ - Construct a new Dimension object - - The dimensions (variables) of the parallel coordinates chart. - 2..60 dimensions are supported. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcoords.Dimension - constraintrange - The domain range to which the filter on the dimension - is constrained. Must be an array of `[fromValue, - toValue]` with `fromValue <= toValue`, or if - `multiselect` is not disabled, you may give an array of - arrays, where each inner array is `[fromValue, - toValue]`. - label - The shown name of the dimension. - multiselect - Do we allow multiple selection ranges or just a single - range? - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - range - The domain range that represents the full, shown axis - extent. Defaults to the `values` extent. Must be an - array of `[fromValue, toValue]` with finite numbers as - elements. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - tickformat - Sets the tick label formatting rule using d3 formatting - mini-language which is similar to those of Python. See - https://github.com/d3/d3-format/blob/master/README.md#l - ocale_format - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - values - Dimension values. `values[n]` represents the value of - the `n`th point in the dataset, therefore the `values` - vector for all dimensions must be the same (longer - vectors will be truncated). Each value must be a finite - number. - valuessrc - Sets the source reference on plot.ly for values . - visible - Shows the dimension when set to `true` (the default). - Hides the dimension for `false`. - - Returns - ------- - Dimension - """ - super(Dimension, self).__init__('dimensions') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcoords.Dimension -constructor must be a dict or -an instance of plotly.graph_objs.parcoords.Dimension""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcoords import (dimension as v_dimension) - - # Initialize validators - # --------------------- - self._validators['constraintrange' - ] = v_dimension.ConstraintrangeValidator() - self._validators['label'] = v_dimension.LabelValidator() - self._validators['multiselect'] = v_dimension.MultiselectValidator() - self._validators['name'] = v_dimension.NameValidator() - self._validators['range'] = v_dimension.RangeValidator() - self._validators['templateitemname' - ] = v_dimension.TemplateitemnameValidator() - self._validators['tickformat'] = v_dimension.TickformatValidator() - self._validators['ticktext'] = v_dimension.TicktextValidator() - self._validators['ticktextsrc'] = v_dimension.TicktextsrcValidator() - self._validators['tickvals'] = v_dimension.TickvalsValidator() - self._validators['tickvalssrc'] = v_dimension.TickvalssrcValidator() - self._validators['values'] = v_dimension.ValuesValidator() - self._validators['valuessrc'] = v_dimension.ValuessrcValidator() - self._validators['visible'] = v_dimension.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('constraintrange', None) - self['constraintrange' - ] = constraintrange if constraintrange is not None else _v - _v = arg.pop('label', None) - self['label'] = label if label is not None else _v - _v = arg.pop('multiselect', None) - self['multiselect'] = multiselect if multiselect is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('range', None) - self['range'] = range if range is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('values', None) - self['values'] = values if values is not None else _v - _v = arg.pop('valuessrc', None) - self['valuessrc'] = valuessrc if valuessrc is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcoords/_domain.py b/plotly/graph_objs/parcoords/_domain.py deleted file mode 100644 index 3bc60f0cc64..00000000000 --- a/plotly/graph_objs/parcoords/_domain.py +++ /dev/null @@ -1,206 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Domain(BaseTraceHierarchyType): - - # column - # ------ - @property - 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] - - Returns - ------- - int - """ - return self['column'] - - @column.setter - def column(self, val): - self['column'] = val - - # row - # --- - @property - 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] - - Returns - ------- - int - """ - return self['row'] - - @row.setter - def row(self, val): - self['row'] = val - - # x - # - - @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] - - Returns - ------- - list - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @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] - - Returns - ------- - list - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcoords' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - column - If there is a layout grid, use the domain for this - column in the grid for this parcoords trace . - row - If there is a layout grid, use the domain for this row - in the grid for this parcoords trace . - x - Sets the horizontal domain of this parcoords trace (in - plot fraction). - y - Sets the vertical domain of this parcoords trace (in - plot fraction). - """ - - def __init__( - self, arg=None, column=None, row=None, x=None, y=None, **kwargs - ): - """ - Construct a new Domain object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcoords.Domain - column - If there is a layout grid, use the domain for this - column in the grid for this parcoords trace . - row - If there is a layout grid, use the domain for this row - in the grid for this parcoords trace . - x - Sets the horizontal domain of this parcoords trace (in - plot fraction). - y - Sets the vertical domain of this parcoords trace (in - plot fraction). - - Returns - ------- - Domain - """ - super(Domain, self).__init__('domain') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcoords.Domain -constructor must be a dict or -an instance of plotly.graph_objs.parcoords.Domain""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcoords import (domain as v_domain) - - # Initialize validators - # --------------------- - self._validators['column'] = v_domain.ColumnValidator() - self._validators['row'] = v_domain.RowValidator() - self._validators['x'] = v_domain.XValidator() - self._validators['y'] = v_domain.YValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('column', None) - self['column'] = column if column is not None else _v - _v = arg.pop('row', None) - self['row'] = row if row is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcoords/_labelfont.py b/plotly/graph_objs/parcoords/_labelfont.py deleted file mode 100644 index 357ca9ab42b..00000000000 --- a/plotly/graph_objs/parcoords/_labelfont.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Labelfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcoords' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcoords.Labelfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Labelfont - """ - super(Labelfont, self).__init__('labelfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcoords.Labelfont -constructor must be a dict or -an instance of plotly.graph_objs.parcoords.Labelfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcoords import (labelfont as v_labelfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_labelfont.ColorValidator() - self._validators['family'] = v_labelfont.FamilyValidator() - self._validators['size'] = v_labelfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcoords/_line.py b/plotly/graph_objs/parcoords/_line.py deleted file mode 100644 index d24459c9652..00000000000 --- a/plotly/graph_objs/parcoords/_line.py +++ /dev/null @@ -1,779 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `line.colorscale`. Has an effect only if in `line.color`is set - to a numerical array. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be chosen - according to whether numbers in the `color` array are all - positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `line.color`) or the bounds - set in `line.cmin` and `line.cmax` Has an effect only if in - `line.color`is set to a numerical array. Defaults to `false` - when `line.cmin` and `line.cmax` are set by the user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - in `line.color`is set to a numerical array. Value should have - the same units as in `line.color` and if set, `line.cmin` must - be set as well. - - The 'cmax' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling `line.cmin` - and/or `line.cmax` to be equidistant to this point. Has an - effect only if in `line.color`is set to a numerical array. - Value should have the same units as in `line.color`. Has no - effect when `line.cauto` is `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - in `line.color`is set to a numerical array. Value should have - the same units as in `line.color` and if set, `line.cmax` must - be set as well. - - The 'cmin' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets thelinecolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to `line.cmin` - and `line.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to parcoords.line.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of 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 - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.parcoords.line.colorbar.Tickf - ormatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.parcoords.line.colorbar.tickformatstopdefault - s), sets the default property values to use for - elements of - parcoords.line.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.parcoords.line.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - parcoords.line.colorbar.title.font instead. - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - parcoords.line.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.parcoords.line.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in `line.color`is - set to a numerical array. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At minimum, a mapping for - the lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color space, - use`line.cmin` and `line.cmax`. Alternatively, `colorscale` may - be a palette name string of the following list: Greys,YlGnBu,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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `line.color`is set to a numerical array. If true, `line.cmin` - will correspond to the last color in the array and `line.cmax` - will correspond to the first color. - - The 'reversescale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcoords' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `line.colorscale`. Has an effect only if in - `line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `line.color`) - or the bounds set in `line.cmin` and `line.cmax` Has - an effect only if in `line.color`is set to a numerical - array. Defaults to `false` when `line.cmin` and - `line.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `line.color`is set to a numerical array. - Value should have the same units as in `line.color` and - if set, `line.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `line.cmin` and/or `line.cmax` to be equidistant to - this point. Has an effect only if in `line.color`is set - to a numerical array. Value should have the same units - as in `line.color`. Has no effect when `line.cauto` is - `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `line.color`is set to a numerical array. - Value should have the same units as in `line.color` and - if set, `line.cmax` must be set as well. - color - Sets thelinecolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `line.cmin` and `line.cmax` if - set. - colorbar - plotly.graph_objs.parcoords.line.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named color - string. At minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, `[[0, - 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`line.cmin` - and `line.cmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,P - ortland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividi - s. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `line.color`is set to a numerical array. If true, - `line.cmin` will correspond to the last color in the - array and `line.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `line.color`is set - to a numerical array. - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorbar=None, - colorscale=None, - colorsrc=None, - reversescale=None, - showscale=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcoords.Line - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `line.colorscale`. Has an effect only if in - `line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `line.color`) - or the bounds set in `line.cmin` and `line.cmax` Has - an effect only if in `line.color`is set to a numerical - array. Defaults to `false` when `line.cmin` and - `line.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `line.color`is set to a numerical array. - Value should have the same units as in `line.color` and - if set, `line.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `line.cmin` and/or `line.cmax` to be equidistant to - this point. Has an effect only if in `line.color`is set - to a numerical array. Value should have the same units - as in `line.color`. Has no effect when `line.cauto` is - `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `line.color`is set to a numerical array. - Value should have the same units as in `line.color` and - if set, `line.cmax` must be set as well. - color - Sets thelinecolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `line.cmin` and `line.cmax` if - set. - colorbar - plotly.graph_objs.parcoords.line.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named color - string. At minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, `[[0, - 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`line.cmin` - and `line.cmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,P - ortland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividi - s. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `line.color`is set to a numerical array. If true, - `line.cmin` will correspond to the last color in the - array and `line.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `line.color`is set - to a numerical array. - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcoords.Line -constructor must be a dict or -an instance of plotly.graph_objs.parcoords.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcoords import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() - self._validators['cauto'] = v_line.CautoValidator() - self._validators['cmax'] = v_line.CmaxValidator() - self._validators['cmid'] = v_line.CmidValidator() - self._validators['cmin'] = v_line.CminValidator() - self._validators['color'] = v_line.ColorValidator() - self._validators['colorbar'] = v_line.ColorBarValidator() - self._validators['colorscale'] = v_line.ColorscaleValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['reversescale'] = v_line.ReversescaleValidator() - self._validators['showscale'] = v_line.ShowscaleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcoords/_rangefont.py b/plotly/graph_objs/parcoords/_rangefont.py deleted file mode 100644 index fd2107e0beb..00000000000 --- a/plotly/graph_objs/parcoords/_rangefont.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Rangefont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcoords' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcoords.Rangefont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Rangefont - """ - super(Rangefont, self).__init__('rangefont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcoords.Rangefont -constructor must be a dict or -an instance of plotly.graph_objs.parcoords.Rangefont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcoords import (rangefont as v_rangefont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_rangefont.ColorValidator() - self._validators['family'] = v_rangefont.FamilyValidator() - self._validators['size'] = v_rangefont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcoords/_stream.py b/plotly/graph_objs/parcoords/_stream.py deleted file mode 100644 index f6661a624a4..00000000000 --- a/plotly/graph_objs/parcoords/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcoords' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcoords.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcoords.Stream -constructor must be a dict or -an instance of plotly.graph_objs.parcoords.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcoords import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcoords/_tickfont.py b/plotly/graph_objs/parcoords/_tickfont.py deleted file mode 100644 index 0d7f3b36837..00000000000 --- a/plotly/graph_objs/parcoords/_tickfont.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcoords' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcoords.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcoords.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.parcoords.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcoords import (tickfont as v_tickfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcoords/line/__init__.py b/plotly/graph_objs/parcoords/line/__init__.py index 3f3e799a407..2c498d10ee0 100644 --- a/plotly/graph_objs/parcoords/line/__init__.py +++ b/plotly/graph_objs/parcoords/line/__init__.py @@ -1,2 +1,1870 @@ -from ._colorbar import ColorBar + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.parcoords.line.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.parcoords.line.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.parcoords.line + .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 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 + ------- + plotly.graph_objs.parcoords.line.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.parcoords.line.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use parcoords.line.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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use parcoords.line.colorbar.title.side + instead. Determines the location of color bar's title with + respect to the color bar. Note that the title's location used + to be set by the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcoords.line' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.parcoords.line.colorbar.Tickformatsto + p instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.parcoo + rds.line.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + parcoords.line.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.parcoords.line.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + parcoords.line.colorbar.title.font instead. Sets this + color bar's title font. Note that the title's font used + to be set by the now deprecated `titlefont` attribute. + titleside + Deprecated: Please use + parcoords.line.colorbar.title.side instead. Determines + the location of color bar's title with respect to the + color bar. Note that the title's location used to be + set by the now deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.parcoords.line.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.parcoords.line.colorbar.Tickformatsto + p instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.parcoo + rds.line.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + parcoords.line.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.parcoords.line.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + parcoords.line.colorbar.title.font instead. Sets this + color bar's title font. Note that the title's font used + to be set by the now deprecated `titlefont` attribute. + titleside + Deprecated: Please use + parcoords.line.colorbar.title.side instead. Determines + the location of color bar's title with respect to the + color bar. Note that the title's location used to be + set by the now deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcoords.line.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.parcoords.line.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcoords.line import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.parcoords.line import colorbar diff --git a/plotly/graph_objs/parcoords/line/_colorbar.py b/plotly/graph_objs/parcoords/line/_colorbar.py deleted file mode 100644 index 74ee5748aa1..00000000000 --- a/plotly/graph_objs/parcoords/line/_colorbar.py +++ /dev/null @@ -1,1865 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.parcoords.line.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.parcoords.line.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.parcoords.line - .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 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 - ------- - plotly.graph_objs.parcoords.line.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.parcoords.line.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use parcoords.line.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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use parcoords.line.colorbar.title.side - instead. Determines the location of color bar's title with - respect to the color bar. Note that the title's location used - to be set by the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcoords.line' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.parcoords.line.colorbar.Tickformatsto - p instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.parcoo - rds.line.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - parcoords.line.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.parcoords.line.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - parcoords.line.colorbar.title.font instead. Sets this - color bar's title font. Note that the title's font used - to be set by the now deprecated `titlefont` attribute. - titleside - Deprecated: Please use - parcoords.line.colorbar.title.side instead. Determines - the location of color bar's title with respect to the - color bar. Note that the title's location used to be - set by the now deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.parcoords.line.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.parcoords.line.colorbar.Tickformatsto - p instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.parcoo - rds.line.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - parcoords.line.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.parcoords.line.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - parcoords.line.colorbar.title.font instead. Sets this - color bar's title font. Note that the title's font used - to be set by the now deprecated `titlefont` attribute. - titleside - Deprecated: Please use - parcoords.line.colorbar.title.side instead. Determines - the location of color bar's title with respect to the - color bar. Note that the title's location used to be - set by the now deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcoords.line.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.parcoords.line.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcoords.line import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcoords/line/colorbar/__init__.py b/plotly/graph_objs/parcoords/line/colorbar/__init__.py index f55b1f6c9b8..dafbdef3b2a 100644 --- a/plotly/graph_objs/parcoords/line/colorbar/__init__.py +++ b/plotly/graph_objs/parcoords/line/colorbar/__init__.py @@ -1,4 +1,725 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.parcoords.line.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcoords.line.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.parcoords.line.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcoords.line.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.parcoords.line.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcoords.line.colorbar import ( + title as v_title + ) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcoords.line.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.parcoords.line.colorba + r.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcoords.line.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.parcoords.line.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcoords.line.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcoords.line.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.parcoords.line.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcoords.line.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.parcoords.line.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcoords.line.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.parcoords.line.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/parcoords/line/colorbar/_tickfont.py b/plotly/graph_objs/parcoords/line/colorbar/_tickfont.py deleted file mode 100644 index a24df04f1b7..00000000000 --- a/plotly/graph_objs/parcoords/line/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcoords.line.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.parcoords.line.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcoords.line.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.parcoords.line.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcoords.line.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py b/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py deleted file mode 100644 index c217c6917bf..00000000000 --- a/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcoords.line.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.parcoords.line.colorba - r.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcoords.line.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.parcoords.line.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcoords.line.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcoords/line/colorbar/_title.py b/plotly/graph_objs/parcoords/line/colorbar/_title.py deleted file mode 100644 index 407588c45e3..00000000000 --- a/plotly/graph_objs/parcoords/line/colorbar/_title.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.parcoords.line.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcoords.line.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.parcoords.line.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcoords.line.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.parcoords.line.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcoords.line.colorbar import ( - title as v_title - ) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/parcoords/line/colorbar/title/__init__.py b/plotly/graph_objs/parcoords/line/colorbar/title/__init__.py index c37b8b5cd28..3ec41444808 100644 --- a/plotly/graph_objs/parcoords/line/colorbar/title/__init__.py +++ b/plotly/graph_objs/parcoords/line/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'parcoords.line.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.parcoords.line.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.parcoords.line.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.parcoords.line.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.parcoords.line.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/parcoords/line/colorbar/title/_font.py b/plotly/graph_objs/parcoords/line/colorbar/title/_font.py deleted file mode 100644 index 51c83331e10..00000000000 --- a/plotly/graph_objs/parcoords/line/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'parcoords.line.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.parcoords.line.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.parcoords.line.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.parcoords.line.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.parcoords.line.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/pie/__init__.py b/plotly/graph_objs/pie/__init__.py index 11688dc794e..5d284c21da9 100644 --- a/plotly/graph_objs/pie/__init__.py +++ b/plotly/graph_objs/pie/__init__.py @@ -1,11 +1,2132 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.pie.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # position + # -------- + @property + 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', + 'bottom left', 'bottom center', 'bottom right'] + + Returns + ------- + Any + """ + return self['position'] + + @position.setter + def position(self, val): + self['position'] = val + + # text + # ---- + @property + def text(self): + """ + Sets the title of the pie chart. If it is empty, no title is + displayed. Note that before the existence of `title.text`, the + title's contents used to be defined as the `title` attribute + itself. This behavior has been deprecated. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'pie' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets the font used for `title`. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + position + Specifies the location of the `title`. Note that the + title's position used to be set by the now deprecated + `titleposition` attribute. + text + Sets the title of the pie chart. If it is empty, no + title is displayed. Note that before the existence of + `title.text`, the title's contents used to be defined + as the `title` attribute itself. This behavior has been + deprecated. + """ + + def __init__( + self, arg=None, font=None, position=None, text=None, **kwargs + ): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.pie.Title + font + Sets the font used for `title`. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + position + Specifies the location of the `title`. Note that the + title's position used to be set by the now deprecated + `titleposition` attribute. + text + Sets the title of the pie chart. If it is empty, no + title is displayed. Note that before the existence of + `title.text`, the title's contents used to be defined + as the `title` attribute itself. This behavior has been + deprecated. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.pie.Title +constructor must be a dict or +an instance of plotly.graph_objs.pie.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.pie import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['position'] = v_title.PositionValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('position', None) + self['position'] = position if position is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'pie' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Textfont object + + Sets the font used for `textinfo`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.pie.Textfont + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.pie.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.pie.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.pie import (textfont as v_textfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + self._validators['colorsrc'] = v_textfont.ColorsrcValidator() + self._validators['family'] = v_textfont.FamilyValidator() + self._validators['familysrc'] = v_textfont.FamilysrcValidator() + self._validators['size'] = v_textfont.SizeValidator() + self._validators['sizesrc'] = v_textfont.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'pie' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.pie.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.pie.Stream +constructor must be a dict or +an instance of plotly.graph_objs.pie.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.pie import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Outsidetextfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'pie' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Outsidetextfont object + + Sets the font used for `textinfo` lying outside the pie. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.pie.Outsidetextfont + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Outsidetextfont + """ + super(Outsidetextfont, self).__init__('outsidetextfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.pie.Outsidetextfont +constructor must be a dict or +an instance of plotly.graph_objs.pie.Outsidetextfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.pie import ( + outsidetextfont as v_outsidetextfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_outsidetextfont.ColorValidator() + self._validators['colorsrc'] = v_outsidetextfont.ColorsrcValidator() + self._validators['family'] = v_outsidetextfont.FamilyValidator() + self._validators['familysrc'] = v_outsidetextfont.FamilysrcValidator() + self._validators['size'] = v_outsidetextfont.SizeValidator() + self._validators['sizesrc'] = v_outsidetextfont.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # colors + # ------ + @property + def colors(self): + """ + Sets the color of each sector of this pie chart. 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 + + Returns + ------- + numpy.ndarray + """ + return self['colors'] + + @colors.setter + def colors(self, val): + self['colors'] = val + + # colorssrc + # --------- + @property + def colorssrc(self): + """ + Sets the source reference on plot.ly for colors . + + The 'colorssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorssrc'] + + @colorssrc.setter + def colorssrc(self, val): + self['colorssrc'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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. + colorsrc + Sets the source reference on plot.ly for color + . + width + Sets the width (in px) of the line enclosing + each sector. + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.pie.marker.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'pie' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + colors + Sets the color of each sector of this pie chart. If not + specified, the default trace color set is used to pick + the sector colors. + colorssrc + Sets the source reference on plot.ly for colors . + line + plotly.graph_objs.pie.marker.Line instance or dict with + compatible properties + """ + + def __init__( + self, arg=None, colors=None, colorssrc=None, line=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.pie.Marker + colors + Sets the color of each sector of this pie chart. If not + specified, the default trace color set is used to pick + the sector colors. + colorssrc + Sets the source reference on plot.ly for colors . + line + plotly.graph_objs.pie.marker.Line instance or dict with + compatible properties + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.pie.Marker +constructor must be a dict or +an instance of plotly.graph_objs.pie.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.pie import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['colors'] = v_marker.ColorsValidator() + self._validators['colorssrc'] = v_marker.ColorssrcValidator() + self._validators['line'] = v_marker.LineValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('colors', None) + self['colors'] = colors if colors is not None else _v + _v = arg.pop('colorssrc', None) + self['colorssrc'] = colorssrc if colorssrc is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Insidetextfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'pie' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Insidetextfont object + + Sets the font used for `textinfo` lying inside the pie. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.pie.Insidetextfont + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Insidetextfont + """ + super(Insidetextfont, self).__init__('insidetextfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.pie.Insidetextfont +constructor must be a dict or +an instance of plotly.graph_objs.pie.Insidetextfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.pie import (insidetextfont as v_insidetextfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_insidetextfont.ColorValidator() + self._validators['colorsrc'] = v_insidetextfont.ColorsrcValidator() + self._validators['family'] = v_insidetextfont.FamilyValidator() + self._validators['familysrc'] = v_insidetextfont.FamilysrcValidator() + self._validators['size'] = v_insidetextfont.SizeValidator() + self._validators['sizesrc'] = v_insidetextfont.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.pie.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'pie' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.pie.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.pie.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.pie.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.pie import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Domain(_BaseTraceHierarchyType): + + # column + # ------ + @property + 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] + + Returns + ------- + int + """ + return self['column'] + + @column.setter + def column(self, val): + self['column'] = val + + # row + # --- + @property + 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] + + Returns + ------- + int + """ + return self['row'] + + @row.setter + def row(self, val): + self['row'] = val + + # x + # - + @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] + + Returns + ------- + list + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @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] + + Returns + ------- + list + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'pie' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this pie trace . + row + If there is a layout grid, use the domain for this row + in the grid for this pie trace . + x + Sets the horizontal domain of this pie trace (in plot + fraction). + y + Sets the vertical domain of this pie trace (in plot + fraction). + """ + + def __init__( + self, arg=None, column=None, row=None, x=None, y=None, **kwargs + ): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.pie.Domain + column + If there is a layout grid, use the domain for this + column in the grid for this pie trace . + row + If there is a layout grid, use the domain for this row + in the grid for this pie trace . + x + Sets the horizontal domain of this pie trace (in plot + fraction). + y + Sets the vertical domain of this pie trace (in plot + fraction). + + Returns + ------- + Domain + """ + super(Domain, self).__init__('domain') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.pie.Domain +constructor must be a dict or +an instance of plotly.graph_objs.pie.Domain""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.pie import (domain as v_domain) + + # Initialize validators + # --------------------- + self._validators['column'] = v_domain.ColumnValidator() + self._validators['row'] = v_domain.RowValidator() + self._validators['x'] = v_domain.XValidator() + self._validators['y'] = v_domain.YValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('column', None) + self['column'] = column if column is not None else _v + _v = arg.pop('row', None) + self['row'] = row if row is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.pie import title -from ._textfont import Textfont -from ._stream import Stream -from ._outsidetextfont import Outsidetextfont -from ._marker import Marker from plotly.graph_objs.pie import marker -from ._insidetextfont import Insidetextfont -from ._hoverlabel import Hoverlabel from plotly.graph_objs.pie import hoverlabel -from ._domain import Domain diff --git a/plotly/graph_objs/pie/_domain.py b/plotly/graph_objs/pie/_domain.py deleted file mode 100644 index a3a70d47f6d..00000000000 --- a/plotly/graph_objs/pie/_domain.py +++ /dev/null @@ -1,205 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Domain(BaseTraceHierarchyType): - - # column - # ------ - @property - 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] - - Returns - ------- - int - """ - return self['column'] - - @column.setter - def column(self, val): - self['column'] = val - - # row - # --- - @property - 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] - - Returns - ------- - int - """ - return self['row'] - - @row.setter - def row(self, val): - self['row'] = val - - # x - # - - @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] - - Returns - ------- - list - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @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] - - Returns - ------- - list - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'pie' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - column - If there is a layout grid, use the domain for this - column in the grid for this pie trace . - row - If there is a layout grid, use the domain for this row - in the grid for this pie trace . - x - Sets the horizontal domain of this pie trace (in plot - fraction). - y - Sets the vertical domain of this pie trace (in plot - fraction). - """ - - def __init__( - self, arg=None, column=None, row=None, x=None, y=None, **kwargs - ): - """ - Construct a new Domain object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.Domain - column - If there is a layout grid, use the domain for this - column in the grid for this pie trace . - row - If there is a layout grid, use the domain for this row - in the grid for this pie trace . - x - Sets the horizontal domain of this pie trace (in plot - fraction). - y - Sets the vertical domain of this pie trace (in plot - fraction). - - Returns - ------- - Domain - """ - super(Domain, self).__init__('domain') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.pie.Domain -constructor must be a dict or -an instance of plotly.graph_objs.pie.Domain""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.pie import (domain as v_domain) - - # Initialize validators - # --------------------- - self._validators['column'] = v_domain.ColumnValidator() - self._validators['row'] = v_domain.RowValidator() - self._validators['x'] = v_domain.XValidator() - self._validators['y'] = v_domain.YValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('column', None) - self['column'] = column if column is not None else _v - _v = arg.pop('row', None) - self['row'] = row if row is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/pie/_hoverlabel.py b/plotly/graph_objs/pie/_hoverlabel.py deleted file mode 100644 index 5c941ddbf2d..00000000000 --- a/plotly/graph_objs/pie/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.pie.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'pie' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.pie.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.pie.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.pie import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/pie/_insidetextfont.py b/plotly/graph_objs/pie/_insidetextfont.py deleted file mode 100644 index 23fecbcb7cb..00000000000 --- a/plotly/graph_objs/pie/_insidetextfont.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Insidetextfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'pie' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Insidetextfont object - - Sets the font used for `textinfo` lying inside the pie. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.Insidetextfont - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Insidetextfont - """ - super(Insidetextfont, self).__init__('insidetextfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.pie.Insidetextfont -constructor must be a dict or -an instance of plotly.graph_objs.pie.Insidetextfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.pie import (insidetextfont as v_insidetextfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_insidetextfont.ColorValidator() - self._validators['colorsrc'] = v_insidetextfont.ColorsrcValidator() - self._validators['family'] = v_insidetextfont.FamilyValidator() - self._validators['familysrc'] = v_insidetextfont.FamilysrcValidator() - self._validators['size'] = v_insidetextfont.SizeValidator() - self._validators['sizesrc'] = v_insidetextfont.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/pie/_marker.py b/plotly/graph_objs/pie/_marker.py deleted file mode 100644 index a373978cd73..00000000000 --- a/plotly/graph_objs/pie/_marker.py +++ /dev/null @@ -1,179 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # colors - # ------ - @property - def colors(self): - """ - Sets the color of each sector of this pie chart. 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 - - Returns - ------- - numpy.ndarray - """ - return self['colors'] - - @colors.setter - def colors(self, val): - self['colors'] = val - - # colorssrc - # --------- - @property - def colorssrc(self): - """ - Sets the source reference on plot.ly for colors . - - The 'colorssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorssrc'] - - @colorssrc.setter - def colorssrc(self, val): - self['colorssrc'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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. - colorsrc - Sets the source reference on plot.ly for color - . - width - Sets the width (in px) of the line enclosing - each sector. - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.pie.marker.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'pie' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - colors - Sets the color of each sector of this pie chart. If not - specified, the default trace color set is used to pick - the sector colors. - colorssrc - Sets the source reference on plot.ly for colors . - line - plotly.graph_objs.pie.marker.Line instance or dict with - compatible properties - """ - - def __init__( - self, arg=None, colors=None, colorssrc=None, line=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.Marker - colors - Sets the color of each sector of this pie chart. If not - specified, the default trace color set is used to pick - the sector colors. - colorssrc - Sets the source reference on plot.ly for colors . - line - plotly.graph_objs.pie.marker.Line instance or dict with - compatible properties - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.pie.Marker -constructor must be a dict or -an instance of plotly.graph_objs.pie.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.pie import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['colors'] = v_marker.ColorsValidator() - self._validators['colorssrc'] = v_marker.ColorssrcValidator() - self._validators['line'] = v_marker.LineValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('colors', None) - self['colors'] = colors if colors is not None else _v - _v = arg.pop('colorssrc', None) - self['colorssrc'] = colorssrc if colorssrc is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/pie/_outsidetextfont.py b/plotly/graph_objs/pie/_outsidetextfont.py deleted file mode 100644 index 85d24bbbb26..00000000000 --- a/plotly/graph_objs/pie/_outsidetextfont.py +++ /dev/null @@ -1,321 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Outsidetextfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'pie' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Outsidetextfont object - - Sets the font used for `textinfo` lying outside the pie. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.Outsidetextfont - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Outsidetextfont - """ - super(Outsidetextfont, self).__init__('outsidetextfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.pie.Outsidetextfont -constructor must be a dict or -an instance of plotly.graph_objs.pie.Outsidetextfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.pie import ( - outsidetextfont as v_outsidetextfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_outsidetextfont.ColorValidator() - self._validators['colorsrc'] = v_outsidetextfont.ColorsrcValidator() - self._validators['family'] = v_outsidetextfont.FamilyValidator() - self._validators['familysrc'] = v_outsidetextfont.FamilysrcValidator() - self._validators['size'] = v_outsidetextfont.SizeValidator() - self._validators['sizesrc'] = v_outsidetextfont.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/pie/_stream.py b/plotly/graph_objs/pie/_stream.py deleted file mode 100644 index 2ff9a415e06..00000000000 --- a/plotly/graph_objs/pie/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'pie' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.pie.Stream -constructor must be a dict or -an instance of plotly.graph_objs.pie.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.pie import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/pie/_textfont.py b/plotly/graph_objs/pie/_textfont.py deleted file mode 100644 index e5556d9ebd4..00000000000 --- a/plotly/graph_objs/pie/_textfont.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'pie' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Textfont object - - Sets the font used for `textinfo`. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.Textfont - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.pie.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.pie.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.pie import (textfont as v_textfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - self._validators['colorsrc'] = v_textfont.ColorsrcValidator() - self._validators['family'] = v_textfont.FamilyValidator() - self._validators['familysrc'] = v_textfont.FamilysrcValidator() - self._validators['size'] = v_textfont.SizeValidator() - self._validators['sizesrc'] = v_textfont.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/pie/_title.py b/plotly/graph_objs/pie/_title.py deleted file mode 100644 index 17d88aa8b4e..00000000000 --- a/plotly/graph_objs/pie/_title.py +++ /dev/null @@ -1,215 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.pie.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # position - # -------- - @property - 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', - 'bottom left', 'bottom center', 'bottom right'] - - Returns - ------- - Any - """ - return self['position'] - - @position.setter - def position(self, val): - self['position'] = val - - # text - # ---- - @property - def text(self): - """ - Sets the title of the pie chart. If it is empty, no title is - displayed. Note that before the existence of `title.text`, the - title's contents used to be defined as the `title` attribute - itself. This behavior has been deprecated. - - The 'text' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'pie' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets the font used for `title`. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - position - Specifies the location of the `title`. Note that the - title's position used to be set by the now deprecated - `titleposition` attribute. - text - Sets the title of the pie chart. If it is empty, no - title is displayed. Note that before the existence of - `title.text`, the title's contents used to be defined - as the `title` attribute itself. This behavior has been - deprecated. - """ - - def __init__( - self, arg=None, font=None, position=None, text=None, **kwargs - ): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.Title - font - Sets the font used for `title`. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - position - Specifies the location of the `title`. Note that the - title's position used to be set by the now deprecated - `titleposition` attribute. - text - Sets the title of the pie chart. If it is empty, no - title is displayed. Note that before the existence of - `title.text`, the title's contents used to be defined - as the `title` attribute itself. This behavior has been - deprecated. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.pie.Title -constructor must be a dict or -an instance of plotly.graph_objs.pie.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.pie import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['position'] = v_title.PositionValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('position', None) - self['position'] = position if position is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/pie/hoverlabel/__init__.py b/plotly/graph_objs/pie/hoverlabel/__init__.py index c37b8b5cd28..8d9285fdfca 100644 --- a/plotly/graph_objs/pie/hoverlabel/__init__.py +++ b/plotly/graph_objs/pie/hoverlabel/__init__.py @@ -1 +1,321 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'pie.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.pie.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.pie.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.pie.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.pie.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/pie/hoverlabel/_font.py b/plotly/graph_objs/pie/hoverlabel/_font.py deleted file mode 100644 index c2211ff91f2..00000000000 --- a/plotly/graph_objs/pie/hoverlabel/_font.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'pie.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.pie.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.pie.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.pie.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/pie/marker/__init__.py b/plotly/graph_objs/pie/marker/__init__.py index 471a5835d71..6d253ce6924 100644 --- a/plotly/graph_objs/pie/marker/__init__.py +++ b/plotly/graph_objs/pie/marker/__init__.py @@ -1 +1,233 @@ -from ._line import Line + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'pie.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the line enclosing each sector. + colorsrc + Sets the source reference on plot.ly for color . + width + Sets the width (in px) of the line enclosing each + sector. + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.pie.marker.Line + color + Sets the color of the line enclosing each sector. + colorsrc + Sets the source reference on plot.ly for color . + width + Sets the width (in px) of the line enclosing each + sector. + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.pie.marker.Line +constructor must be a dict or +an instance of plotly.graph_objs.pie.marker.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.pie.marker import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/pie/marker/_line.py b/plotly/graph_objs/pie/marker/_line.py deleted file mode 100644 index d12a4134845..00000000000 --- a/plotly/graph_objs/pie/marker/_line.py +++ /dev/null @@ -1,231 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'pie.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the color of the line enclosing each sector. - colorsrc - Sets the source reference on plot.ly for color . - width - Sets the width (in px) of the line enclosing each - sector. - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.marker.Line - color - Sets the color of the line enclosing each sector. - colorsrc - Sets the source reference on plot.ly for color . - width - Sets the width (in px) of the line enclosing each - sector. - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.pie.marker.Line -constructor must be a dict or -an instance of plotly.graph_objs.pie.marker.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.pie.marker import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/pie/title/__init__.py b/plotly/graph_objs/pie/title/__init__.py index c37b8b5cd28..f5a1a1c30c5 100644 --- a/plotly/graph_objs/pie/title/__init__.py +++ b/plotly/graph_objs/pie/title/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'pie.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.pie.title.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.pie.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.pie.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.pie.title import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/pie/title/_font.py b/plotly/graph_objs/pie/title/_font.py deleted file mode 100644 index 83d6c16d033..00000000000 --- a/plotly/graph_objs/pie/title/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'pie.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pie.title.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.pie.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.pie.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.pie.title import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/pointcloud/__init__.py b/plotly/graph_objs/pointcloud/__init__.py index 2c793275e8c..e0380d5772e 100644 --- a/plotly/graph_objs/pointcloud/__init__.py +++ b/plotly/graph_objs/pointcloud/__init__.py @@ -1,5 +1,901 @@ -from ._stream import Stream -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'pointcloud' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.pointcloud.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.pointcloud.Stream +constructor must be a dict or +an instance of plotly.graph_objs.pointcloud.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.pointcloud import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # blend + # ----- + @property + def blend(self): + """ + Determines if colors are blended together for a translucency + effect in case `opacity` is specified as a value less then `1`. + Setting `blend` to `true` reduces zoom/pan speed if used with + large numbers of points. + + The 'blend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['blend'] + + @blend.setter + def blend(self, val): + self['blend'] = val + + # border + # ------ + @property + def border(self): + """ + The 'border' property is an instance of Border + that may be specified as: + - An instance of 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. + color + 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. + + Returns + ------- + plotly.graph_objs.pointcloud.marker.Border + """ + return self['border'] + + @border.setter + def border(self, val): + self['border'] = val + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + def opacity(self): + """ + Sets the marker opacity. The default value is `1` (fully + opaque). If the markers are not fully opaque and there are + hundreds of thousands of points, it may cause slower zooming + and panning. Opacity fades the color even if `blend` is left on + `false` even if there is no translucency effect in that case. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # sizemax + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['sizemax'] + + @sizemax.setter + def sizemax(self, val): + self['sizemax'] = val + + # sizemin + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['sizemin'] + + @sizemin.setter + def sizemin(self, val): + self['sizemin'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'pointcloud' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + blend + Determines if colors are blended together for a + translucency effect in case `opacity` is specified as a + value less then `1`. Setting `blend` to `true` reduces + zoom/pan speed if used with large numbers of points. + border + plotly.graph_objs.pointcloud.marker.Border instance or + dict with compatible properties + color + Sets the marker fill color. It accepts a specific + color.If the color is not fully opaque and there are + hundreds of thousandsof points, it may cause slower + zooming and panning. + opacity + Sets the marker opacity. The default value is `1` + (fully opaque). If the markers are not fully opaque and + there are hundreds of thousands of points, it may cause + slower zooming and panning. Opacity fades the color + even if `blend` is left on `false` even if there is no + translucency effect in that case. + sizemax + Sets the maximum size (in px) of the rendered marker + points. Effective when the `pointcloud` shows only few + points. + sizemin + Sets the minimum size (in px) of the rendered marker + points, effective when the `pointcloud` shows a million + or more points. + """ + + def __init__( + self, + arg=None, + blend=None, + border=None, + color=None, + opacity=None, + sizemax=None, + sizemin=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.pointcloud.Marker + blend + Determines if colors are blended together for a + translucency effect in case `opacity` is specified as a + value less then `1`. Setting `blend` to `true` reduces + zoom/pan speed if used with large numbers of points. + border + plotly.graph_objs.pointcloud.marker.Border instance or + dict with compatible properties + color + Sets the marker fill color. It accepts a specific + color.If the color is not fully opaque and there are + hundreds of thousandsof points, it may cause slower + zooming and panning. + opacity + Sets the marker opacity. The default value is `1` + (fully opaque). If the markers are not fully opaque and + there are hundreds of thousands of points, it may cause + slower zooming and panning. Opacity fades the color + even if `blend` is left on `false` even if there is no + translucency effect in that case. + sizemax + Sets the maximum size (in px) of the rendered marker + points. Effective when the `pointcloud` shows only few + points. + sizemin + Sets the minimum size (in px) of the rendered marker + points, effective when the `pointcloud` shows a million + or more points. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.pointcloud.Marker +constructor must be a dict or +an instance of plotly.graph_objs.pointcloud.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.pointcloud import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['blend'] = v_marker.BlendValidator() + self._validators['border'] = v_marker.BorderValidator() + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['sizemax'] = v_marker.SizemaxValidator() + self._validators['sizemin'] = v_marker.SizeminValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('blend', None) + self['blend'] = blend if blend is not None else _v + _v = arg.pop('border', None) + self['border'] = border if border is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('sizemax', None) + self['sizemax'] = sizemax if sizemax is not None else _v + _v = arg.pop('sizemin', None) + self['sizemin'] = sizemin if sizemin is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.pointcloud.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'pointcloud' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.pointcloud.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.pointcloud.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.pointcloud.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.pointcloud import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.pointcloud import marker -from ._hoverlabel import Hoverlabel from plotly.graph_objs.pointcloud import hoverlabel diff --git a/plotly/graph_objs/pointcloud/_hoverlabel.py b/plotly/graph_objs/pointcloud/_hoverlabel.py deleted file mode 100644 index f4da2353b22..00000000000 --- a/plotly/graph_objs/pointcloud/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.pointcloud.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'pointcloud' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pointcloud.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.pointcloud.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.pointcloud.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.pointcloud import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/pointcloud/_marker.py b/plotly/graph_objs/pointcloud/_marker.py deleted file mode 100644 index 2e8aa80d123..00000000000 --- a/plotly/graph_objs/pointcloud/_marker.py +++ /dev/null @@ -1,338 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # blend - # ----- - @property - def blend(self): - """ - Determines if colors are blended together for a translucency - effect in case `opacity` is specified as a value less then `1`. - Setting `blend` to `true` reduces zoom/pan speed if used with - large numbers of points. - - The 'blend' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['blend'] - - @blend.setter - def blend(self, val): - self['blend'] = val - - # border - # ------ - @property - def border(self): - """ - The 'border' property is an instance of Border - that may be specified as: - - An instance of 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. - color - 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. - - Returns - ------- - plotly.graph_objs.pointcloud.marker.Border - """ - return self['border'] - - @border.setter - def border(self, val): - self['border'] = val - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - def opacity(self): - """ - Sets the marker opacity. The default value is `1` (fully - opaque). If the markers are not fully opaque and there are - hundreds of thousands of points, it may cause slower zooming - and panning. Opacity fades the color even if `blend` is left on - `false` even if there is no translucency effect in that case. - - The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # sizemax - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['sizemax'] - - @sizemax.setter - def sizemax(self, val): - self['sizemax'] = val - - # sizemin - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['sizemin'] - - @sizemin.setter - def sizemin(self, val): - self['sizemin'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'pointcloud' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - blend - Determines if colors are blended together for a - translucency effect in case `opacity` is specified as a - value less then `1`. Setting `blend` to `true` reduces - zoom/pan speed if used with large numbers of points. - border - plotly.graph_objs.pointcloud.marker.Border instance or - dict with compatible properties - color - Sets the marker fill color. It accepts a specific - color.If the color is not fully opaque and there are - hundreds of thousandsof points, it may cause slower - zooming and panning. - opacity - Sets the marker opacity. The default value is `1` - (fully opaque). If the markers are not fully opaque and - there are hundreds of thousands of points, it may cause - slower zooming and panning. Opacity fades the color - even if `blend` is left on `false` even if there is no - translucency effect in that case. - sizemax - Sets the maximum size (in px) of the rendered marker - points. Effective when the `pointcloud` shows only few - points. - sizemin - Sets the minimum size (in px) of the rendered marker - points, effective when the `pointcloud` shows a million - or more points. - """ - - def __init__( - self, - arg=None, - blend=None, - border=None, - color=None, - opacity=None, - sizemax=None, - sizemin=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pointcloud.Marker - blend - Determines if colors are blended together for a - translucency effect in case `opacity` is specified as a - value less then `1`. Setting `blend` to `true` reduces - zoom/pan speed if used with large numbers of points. - border - plotly.graph_objs.pointcloud.marker.Border instance or - dict with compatible properties - color - Sets the marker fill color. It accepts a specific - color.If the color is not fully opaque and there are - hundreds of thousandsof points, it may cause slower - zooming and panning. - opacity - Sets the marker opacity. The default value is `1` - (fully opaque). If the markers are not fully opaque and - there are hundreds of thousands of points, it may cause - slower zooming and panning. Opacity fades the color - even if `blend` is left on `false` even if there is no - translucency effect in that case. - sizemax - Sets the maximum size (in px) of the rendered marker - points. Effective when the `pointcloud` shows only few - points. - sizemin - Sets the minimum size (in px) of the rendered marker - points, effective when the `pointcloud` shows a million - or more points. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.pointcloud.Marker -constructor must be a dict or -an instance of plotly.graph_objs.pointcloud.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.pointcloud import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['blend'] = v_marker.BlendValidator() - self._validators['border'] = v_marker.BorderValidator() - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['sizemax'] = v_marker.SizemaxValidator() - self._validators['sizemin'] = v_marker.SizeminValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('blend', None) - self['blend'] = blend if blend is not None else _v - _v = arg.pop('border', None) - self['border'] = border if border is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('sizemax', None) - self['sizemax'] = sizemax if sizemax is not None else _v - _v = arg.pop('sizemin', None) - self['sizemin'] = sizemin if sizemin is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/pointcloud/_stream.py b/plotly/graph_objs/pointcloud/_stream.py deleted file mode 100644 index 43f6c654416..00000000000 --- a/plotly/graph_objs/pointcloud/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'pointcloud' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.pointcloud.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.pointcloud.Stream -constructor must be a dict or -an instance of plotly.graph_objs.pointcloud.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.pointcloud import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/pointcloud/hoverlabel/__init__.py b/plotly/graph_objs/pointcloud/hoverlabel/__init__.py index c37b8b5cd28..98f3dae9f4b 100644 --- a/plotly/graph_objs/pointcloud/hoverlabel/__init__.py +++ b/plotly/graph_objs/pointcloud/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'pointcloud.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.pointcloud.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.pointcloud.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.pointcloud.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.pointcloud.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/pointcloud/hoverlabel/_font.py b/plotly/graph_objs/pointcloud/hoverlabel/_font.py deleted file mode 100644 index 81c3c7cc4e6..00000000000 --- a/plotly/graph_objs/pointcloud/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'pointcloud.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.pointcloud.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.pointcloud.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.pointcloud.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.pointcloud.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/pointcloud/marker/__init__.py b/plotly/graph_objs/pointcloud/marker/__init__.py index be1ce108645..134f5ec7f63 100644 --- a/plotly/graph_objs/pointcloud/marker/__init__.py +++ b/plotly/graph_objs/pointcloud/marker/__init__.py @@ -1 +1,179 @@ -from ._border import Border + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Border(_BaseTraceHierarchyType): + + # arearatio + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['arearatio'] + + @arearatio.setter + def arearatio(self, val): + self['arearatio'] = val + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'pointcloud.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + arearatio + Specifies what fraction of the marker area is covered + with the border. + color + 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. + """ + + def __init__(self, arg=None, arearatio=None, color=None, **kwargs): + """ + Construct a new Border object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.pointcloud.marker.Border + arearatio + Specifies what fraction of the marker area is covered + with the border. + color + 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. + + Returns + ------- + Border + """ + super(Border, self).__init__('border') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.pointcloud.marker.Border +constructor must be a dict or +an instance of plotly.graph_objs.pointcloud.marker.Border""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.pointcloud.marker import (border as v_border) + + # Initialize validators + # --------------------- + self._validators['arearatio'] = v_border.ArearatioValidator() + self._validators['color'] = v_border.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('arearatio', None) + self['arearatio'] = arearatio if arearatio is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/pointcloud/marker/_border.py b/plotly/graph_objs/pointcloud/marker/_border.py deleted file mode 100644 index bef180ed653..00000000000 --- a/plotly/graph_objs/pointcloud/marker/_border.py +++ /dev/null @@ -1,177 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Border(BaseTraceHierarchyType): - - # arearatio - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['arearatio'] - - @arearatio.setter - def arearatio(self, val): - self['arearatio'] = val - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'pointcloud.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - arearatio - Specifies what fraction of the marker area is covered - with the border. - color - 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. - """ - - def __init__(self, arg=None, arearatio=None, color=None, **kwargs): - """ - Construct a new Border object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.pointcloud.marker.Border - arearatio - Specifies what fraction of the marker area is covered - with the border. - color - 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. - - Returns - ------- - Border - """ - super(Border, self).__init__('border') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.pointcloud.marker.Border -constructor must be a dict or -an instance of plotly.graph_objs.pointcloud.marker.Border""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.pointcloud.marker import (border as v_border) - - # Initialize validators - # --------------------- - self._validators['arearatio'] = v_border.ArearatioValidator() - self._validators['color'] = v_border.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('arearatio', None) - self['arearatio'] = arearatio if arearatio is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/__init__.py b/plotly/graph_objs/sankey/__init__.py index 4e567948c45..53f99d8c266 100644 --- a/plotly/graph_objs/sankey/__init__.py +++ b/plotly/graph_objs/sankey/__init__.py @@ -1,9 +1,2373 @@ -from ._textfont import Textfont -from ._stream import Stream -from ._node import Node + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'sankey' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): + """ + Construct a new Textfont object + + Sets the font for node labels + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.sankey.Textfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.sankey.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.sankey.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.sankey import (textfont as v_textfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + self._validators['family'] = v_textfont.FamilyValidator() + self._validators['size'] = v_textfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'sankey' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.sankey.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.sankey.Stream +constructor must be a dict or +an instance of plotly.graph_objs.sankey.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.sankey import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Node(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + Sets the `node` color. It can be a single value, or an array + for specifying color for each `node`. If `node.color` is + omitted, then the default `Plotly` color palette will be cycled + through to have a variety of colors. These defaults are not + fully opaque, to allow some visibility of what is beneath the + node. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # groups + # ------ + @property + 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: + - An int or float + + Returns + ------- + list + """ + return self['groups'] + + @groups.setter + def groups(self, val): + self['groups'] = val + + # hoverinfo + # --------- + @property + def hoverinfo(self): + """ + Determines which trace information appear when hovering nodes. + If `none` or `skip` are set, no information is displayed upon + hovering. But, if `none` is set, click and hover events are + still fired. + + The 'hoverinfo' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'none', 'skip'] + + Returns + ------- + Any + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.sankey.node.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.sankey.node.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + variables `value` and `label`. Anything contained in tag + `` is displayed in the secondary box, for example + "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # label + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['label'] + + @label.setter + def label(self, val): + self['label'] = val + + # labelsrc + # -------- + @property + def labelsrc(self): + """ + Sets the source reference on plot.ly for label . + + The 'labelsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['labelsrc'] + + @labelsrc.setter + def labelsrc(self, val): + self['labelsrc'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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`. + colorsrc + Sets the source reference on plot.ly for color + . + width + Sets the width (in px) of the `line` around + each `node`. + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.sankey.node.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # pad + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['pad'] + + @pad.setter + def pad(self, val): + self['pad'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'sankey' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the `node` color. It can be a single value, or an + array for specifying color for each `node`. If + `node.color` is omitted, then the default `Plotly` + color palette will be cycled through to have a variety + of colors. These defaults are not fully opaque, to + allow some visibility of what is beneath the node. + colorsrc + Sets the source reference on plot.ly for color . + groups + Groups of nodes. Each group is defined by an array with + the indices of the nodes it contains. Multiple groups + can be specified. + hoverinfo + Determines which trace information appear when hovering + nodes. If `none` or `skip` are set, no information is + displayed upon hovering. But, if `none` is set, click + and hover events are still fired. + hoverlabel + plotly.graph_objs.sankey.node.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variables `value` and `label`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + label + The shown name of the node. + labelsrc + Sets the source reference on plot.ly for label . + line + plotly.graph_objs.sankey.node.Line instance or dict + with compatible properties + pad + Sets the padding (in px) between the `nodes`. + thickness + Sets the thickness (in px) of the `nodes`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + groups=None, + hoverinfo=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + label=None, + labelsrc=None, + line=None, + pad=None, + thickness=None, + **kwargs + ): + """ + Construct a new Node object + + The nodes of the Sankey plot. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.sankey.Node + color + Sets the `node` color. It can be a single value, or an + array for specifying color for each `node`. If + `node.color` is omitted, then the default `Plotly` + color palette will be cycled through to have a variety + of colors. These defaults are not fully opaque, to + allow some visibility of what is beneath the node. + colorsrc + Sets the source reference on plot.ly for color . + groups + Groups of nodes. Each group is defined by an array with + the indices of the nodes it contains. Multiple groups + can be specified. + hoverinfo + Determines which trace information appear when hovering + nodes. If `none` or `skip` are set, no information is + displayed upon hovering. But, if `none` is set, click + and hover events are still fired. + hoverlabel + plotly.graph_objs.sankey.node.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variables `value` and `label`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + label + The shown name of the node. + labelsrc + Sets the source reference on plot.ly for label . + line + plotly.graph_objs.sankey.node.Line instance or dict + with compatible properties + pad + Sets the padding (in px) between the `nodes`. + thickness + Sets the thickness (in px) of the `nodes`. + + Returns + ------- + Node + """ + super(Node, self).__init__('node') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.sankey.Node +constructor must be a dict or +an instance of plotly.graph_objs.sankey.Node""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.sankey import (node as v_node) + + # Initialize validators + # --------------------- + self._validators['color'] = v_node.ColorValidator() + self._validators['colorsrc'] = v_node.ColorsrcValidator() + self._validators['groups'] = v_node.GroupsValidator() + self._validators['hoverinfo'] = v_node.HoverinfoValidator() + self._validators['hoverlabel'] = v_node.HoverlabelValidator() + self._validators['hovertemplate'] = v_node.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_node.HovertemplatesrcValidator() + self._validators['label'] = v_node.LabelValidator() + self._validators['labelsrc'] = v_node.LabelsrcValidator() + self._validators['line'] = v_node.LineValidator() + self._validators['pad'] = v_node.PadValidator() + self._validators['thickness'] = v_node.ThicknessValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('groups', None) + self['groups'] = groups if groups is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('label', None) + self['label'] = label if label is not None else _v + _v = arg.pop('labelsrc', None) + self['labelsrc'] = labelsrc if labelsrc is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('pad', None) + self['pad'] = pad if pad is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Link(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorscales + # ----------- + @property + def colorscales(self): + """ + The 'colorscales' property is a tuple of instances of + Colorscale that may be specified as: + - 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 + Sets the lower bound of the color domain. + colorscale + Sets the colorscale. The colorscale must be an + array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named + color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. + For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and + `cmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Grey + s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, + Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth + ,Electric,Viridis,Cividis. + label + The label of the links to color based on their + concentration within a flow. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + + Returns + ------- + tuple[plotly.graph_objs.sankey.link.Colorscale] + """ + return self['colorscales'] + + @colorscales.setter + def colorscales(self, val): + self['colorscales'] = val + + # colorscaledefaults + # ------------------ + @property + def colorscaledefaults(self): + """ + When used in a template (as + 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 plotly.graph_objs.sankey.link.Colorscale + - A dict of string/value properties that will be passed + to the Colorscale constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.sankey.link.Colorscale + """ + return self['colorscaledefaults'] + + @colorscaledefaults.setter + def colorscaledefaults(self, val): + self['colorscaledefaults'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # hoverinfo + # --------- + @property + def hoverinfo(self): + """ + Determines which trace information appear when hovering links. + If `none` or `skip` are set, no information is displayed upon + hovering. But, if `none` is set, click and hover events are + still fired. + + The 'hoverinfo' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'none', 'skip'] + + Returns + ------- + Any + """ + return self['hoverinfo'] + + @hoverinfo.setter + def hoverinfo(self, val): + self['hoverinfo'] = val + + # hoverlabel + # ---------- + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of plotly.graph_objs.sankey.link.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 labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + + Returns + ------- + plotly.graph_objs.sankey.link.Hoverlabel + """ + return self['hoverlabel'] + + @hoverlabel.setter + def hoverlabel(self, val): + self['hoverlabel'] = val + + # hovertemplate + # ------------- + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{y:$.2f}". See http + s://github.com/d3/d3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The variables available + in `hovertemplate` are the ones emitted as event data described + at this link https://plot.ly/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + variables `value` and `label`. Anything contained in tag + `` is displayed in the secondary box, for example + "{fullData.name}". + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['hovertemplate'] + + @hovertemplate.setter + def hovertemplate(self, val): + self['hovertemplate'] = val + + # hovertemplatesrc + # ---------------- + @property + def hovertemplatesrc(self): + """ + Sets the source reference on plot.ly for hovertemplate . + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['hovertemplatesrc'] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self['hovertemplatesrc'] = val + + # label + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['label'] + + @label.setter + def label(self, val): + self['label'] = val + + # labelsrc + # -------- + @property + def labelsrc(self): + """ + Sets the source reference on plot.ly for label . + + The 'labelsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['labelsrc'] + + @labelsrc.setter + def labelsrc(self, val): + self['labelsrc'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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`. + colorsrc + Sets the source reference on plot.ly for color + . + width + Sets the width (in px) of the `line` around + each `link`. + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.sankey.link.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # source + # ------ + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['source'] + + @source.setter + def source(self, val): + self['source'] = val + + # sourcesrc + # --------- + @property + def sourcesrc(self): + """ + Sets the source reference on plot.ly for source . + + The 'sourcesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sourcesrc'] + + @sourcesrc.setter + def sourcesrc(self, val): + self['sourcesrc'] = val + + # target + # ------ + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['target'] + + @target.setter + def target(self, val): + self['target'] = val + + # targetsrc + # --------- + @property + def targetsrc(self): + """ + Sets the source reference on plot.ly for target . + + The 'targetsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['targetsrc'] + + @targetsrc.setter + def targetsrc(self, val): + self['targetsrc'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # valuesrc + # -------- + @property + def valuesrc(self): + """ + Sets the source reference on plot.ly for value . + + The 'valuesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['valuesrc'] + + @valuesrc.setter + def valuesrc(self, val): + self['valuesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'sankey' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the `link` color. It can be a single value, or an + array for specifying color for each `link`. If + `link.color` is omitted, then by default, a translucent + grey link will be used. + colorscales + plotly.graph_objs.sankey.link.Colorscale instance or + dict with compatible properties + colorscaledefaults + When used in a template (as + layout.template.data.sankey.link.colorscaledefaults), + sets the default property values to use for elements of + sankey.link.colorscales + colorsrc + Sets the source reference on plot.ly for color . + hoverinfo + Determines which trace information appear when hovering + links. If `none` or `skip` are set, no information is + displayed upon hovering. But, if `none` is set, click + and hover events are still fired. + hoverlabel + plotly.graph_objs.sankey.link.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variables `value` and `label`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + label + The shown name of the link. + labelsrc + Sets the source reference on plot.ly for label . + line + plotly.graph_objs.sankey.link.Line instance or dict + with compatible properties + source + An integer number `[0..nodes.length - 1]` that + represents the source node. + sourcesrc + Sets the source reference on plot.ly for source . + target + An integer number `[0..nodes.length - 1]` that + represents the target node. + targetsrc + Sets the source reference on plot.ly for target . + value + A numeric value representing the flow volume value. + valuesrc + Sets the source reference on plot.ly for value . + """ + + def __init__( + self, + arg=None, + color=None, + colorscales=None, + colorscaledefaults=None, + colorsrc=None, + hoverinfo=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + label=None, + labelsrc=None, + line=None, + source=None, + sourcesrc=None, + target=None, + targetsrc=None, + value=None, + valuesrc=None, + **kwargs + ): + """ + Construct a new Link object + + The links of the Sankey plot. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.sankey.Link + color + Sets the `link` color. It can be a single value, or an + array for specifying color for each `link`. If + `link.color` is omitted, then by default, a translucent + grey link will be used. + colorscales + plotly.graph_objs.sankey.link.Colorscale instance or + dict with compatible properties + colorscaledefaults + When used in a template (as + layout.template.data.sankey.link.colorscaledefaults), + sets the default property values to use for elements of + sankey.link.colorscales + colorsrc + Sets the source reference on plot.ly for color . + hoverinfo + Determines which trace information appear when hovering + links. If `none` or `skip` are set, no information is + displayed upon hovering. But, if `none` is set, click + and hover events are still fired. + hoverlabel + plotly.graph_objs.sankey.link.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}". Numbers are formatted using + d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d3-format + /blob/master/README.md#locale_format for details on the + formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plot.ly/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified + per-point (the ones that are `arrayOk: true`) are + available. variables `value` and `label`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for hovertemplate + . + label + The shown name of the link. + labelsrc + Sets the source reference on plot.ly for label . + line + plotly.graph_objs.sankey.link.Line instance or dict + with compatible properties + source + An integer number `[0..nodes.length - 1]` that + represents the source node. + sourcesrc + Sets the source reference on plot.ly for source . + target + An integer number `[0..nodes.length - 1]` that + represents the target node. + targetsrc + Sets the source reference on plot.ly for target . + value + A numeric value representing the flow volume value. + valuesrc + Sets the source reference on plot.ly for value . + + Returns + ------- + Link + """ + super(Link, self).__init__('link') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.sankey.Link +constructor must be a dict or +an instance of plotly.graph_objs.sankey.Link""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.sankey import (link as v_link) + + # Initialize validators + # --------------------- + self._validators['color'] = v_link.ColorValidator() + self._validators['colorscales'] = v_link.ColorscalesValidator() + self._validators['colorscaledefaults'] = v_link.ColorscaleValidator() + self._validators['colorsrc'] = v_link.ColorsrcValidator() + self._validators['hoverinfo'] = v_link.HoverinfoValidator() + self._validators['hoverlabel'] = v_link.HoverlabelValidator() + self._validators['hovertemplate'] = v_link.HovertemplateValidator() + self._validators['hovertemplatesrc' + ] = v_link.HovertemplatesrcValidator() + self._validators['label'] = v_link.LabelValidator() + self._validators['labelsrc'] = v_link.LabelsrcValidator() + self._validators['line'] = v_link.LineValidator() + self._validators['source'] = v_link.SourceValidator() + self._validators['sourcesrc'] = v_link.SourcesrcValidator() + self._validators['target'] = v_link.TargetValidator() + self._validators['targetsrc'] = v_link.TargetsrcValidator() + self._validators['value'] = v_link.ValueValidator() + self._validators['valuesrc'] = v_link.ValuesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorscales', None) + self['colorscales'] = colorscales if colorscales is not None else _v + _v = arg.pop('colorscaledefaults', None) + self['colorscaledefaults' + ] = colorscaledefaults if colorscaledefaults is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('hoverinfo', None) + self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v + _v = arg.pop('hoverlabel', None) + self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v + _v = arg.pop('hovertemplate', None) + self['hovertemplate' + ] = hovertemplate if hovertemplate is not None else _v + _v = arg.pop('hovertemplatesrc', None) + self['hovertemplatesrc' + ] = hovertemplatesrc if hovertemplatesrc is not None else _v + _v = arg.pop('label', None) + self['label'] = label if label is not None else _v + _v = arg.pop('labelsrc', None) + self['labelsrc'] = labelsrc if labelsrc is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('source', None) + self['source'] = source if source is not None else _v + _v = arg.pop('sourcesrc', None) + self['sourcesrc'] = sourcesrc if sourcesrc is not None else _v + _v = arg.pop('target', None) + self['target'] = target if target is not None else _v + _v = arg.pop('targetsrc', None) + self['targetsrc'] = targetsrc if targetsrc is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + _v = arg.pop('valuesrc', None) + self['valuesrc'] = valuesrc if valuesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.sankey.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'sankey' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.sankey.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.sankey.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.sankey.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.sankey import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Domain(_BaseTraceHierarchyType): + + # column + # ------ + @property + 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] + + Returns + ------- + int + """ + return self['column'] + + @column.setter + def column(self, val): + self['column'] = val + + # row + # --- + @property + 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] + + Returns + ------- + int + """ + return self['row'] + + @row.setter + def row(self, val): + self['row'] = val + + # x + # - + @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] + + Returns + ------- + list + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @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] + + Returns + ------- + list + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'sankey' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this sankey trace . + row + If there is a layout grid, use the domain for this row + in the grid for this sankey trace . + x + Sets the horizontal domain of this sankey trace (in + plot fraction). + y + Sets the vertical domain of this sankey trace (in plot + fraction). + """ + + def __init__( + self, arg=None, column=None, row=None, x=None, y=None, **kwargs + ): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.sankey.Domain + column + If there is a layout grid, use the domain for this + column in the grid for this sankey trace . + row + If there is a layout grid, use the domain for this row + in the grid for this sankey trace . + x + Sets the horizontal domain of this sankey trace (in + plot fraction). + y + Sets the vertical domain of this sankey trace (in plot + fraction). + + Returns + ------- + Domain + """ + super(Domain, self).__init__('domain') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.sankey.Domain +constructor must be a dict or +an instance of plotly.graph_objs.sankey.Domain""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.sankey import (domain as v_domain) + + # Initialize validators + # --------------------- + self._validators['column'] = v_domain.ColumnValidator() + self._validators['row'] = v_domain.RowValidator() + self._validators['x'] = v_domain.XValidator() + self._validators['y'] = v_domain.YValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('column', None) + self['column'] = column if column is not None else _v + _v = arg.pop('row', None) + self['row'] = row if row is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.sankey import node -from ._link import Link from plotly.graph_objs.sankey import link -from ._hoverlabel import Hoverlabel from plotly.graph_objs.sankey import hoverlabel -from ._domain import Domain diff --git a/plotly/graph_objs/sankey/_domain.py b/plotly/graph_objs/sankey/_domain.py deleted file mode 100644 index f2059269833..00000000000 --- a/plotly/graph_objs/sankey/_domain.py +++ /dev/null @@ -1,206 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Domain(BaseTraceHierarchyType): - - # column - # ------ - @property - 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] - - Returns - ------- - int - """ - return self['column'] - - @column.setter - def column(self, val): - self['column'] = val - - # row - # --- - @property - 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] - - Returns - ------- - int - """ - return self['row'] - - @row.setter - def row(self, val): - self['row'] = val - - # x - # - - @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] - - Returns - ------- - list - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @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] - - Returns - ------- - list - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'sankey' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - column - If there is a layout grid, use the domain for this - column in the grid for this sankey trace . - row - If there is a layout grid, use the domain for this row - in the grid for this sankey trace . - x - Sets the horizontal domain of this sankey trace (in - plot fraction). - y - Sets the vertical domain of this sankey trace (in plot - fraction). - """ - - def __init__( - self, arg=None, column=None, row=None, x=None, y=None, **kwargs - ): - """ - Construct a new Domain object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.Domain - column - If there is a layout grid, use the domain for this - column in the grid for this sankey trace . - row - If there is a layout grid, use the domain for this row - in the grid for this sankey trace . - x - Sets the horizontal domain of this sankey trace (in - plot fraction). - y - Sets the vertical domain of this sankey trace (in plot - fraction). - - Returns - ------- - Domain - """ - super(Domain, self).__init__('domain') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.sankey.Domain -constructor must be a dict or -an instance of plotly.graph_objs.sankey.Domain""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.sankey import (domain as v_domain) - - # Initialize validators - # --------------------- - self._validators['column'] = v_domain.ColumnValidator() - self._validators['row'] = v_domain.RowValidator() - self._validators['x'] = v_domain.XValidator() - self._validators['y'] = v_domain.YValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('column', None) - self['column'] = column if column is not None else _v - _v = arg.pop('row', None) - self['row'] = row if row is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/_hoverlabel.py b/plotly/graph_objs/sankey/_hoverlabel.py deleted file mode 100644 index aff64010858..00000000000 --- a/plotly/graph_objs/sankey/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.sankey.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'sankey' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.sankey.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.sankey.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.sankey import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/_link.py b/plotly/graph_objs/sankey/_link.py deleted file mode 100644 index 671abfcb73e..00000000000 --- a/plotly/graph_objs/sankey/_link.py +++ /dev/null @@ -1,783 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Link(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorscales - # ----------- - @property - def colorscales(self): - """ - The 'colorscales' property is a tuple of instances of - Colorscale that may be specified as: - - 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 - Sets the lower bound of the color domain. - colorscale - Sets the colorscale. The colorscale must be an - array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named - color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. - For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and - `cmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Grey - s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, - Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth - ,Electric,Viridis,Cividis. - label - The label of the links to color based on their - concentration within a flow. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - - Returns - ------- - tuple[plotly.graph_objs.sankey.link.Colorscale] - """ - return self['colorscales'] - - @colorscales.setter - def colorscales(self, val): - self['colorscales'] = val - - # colorscaledefaults - # ------------------ - @property - def colorscaledefaults(self): - """ - When used in a template (as - 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 plotly.graph_objs.sankey.link.Colorscale - - A dict of string/value properties that will be passed - to the Colorscale constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.sankey.link.Colorscale - """ - return self['colorscaledefaults'] - - @colorscaledefaults.setter - def colorscaledefaults(self, val): - self['colorscaledefaults'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # hoverinfo - # --------- - @property - def hoverinfo(self): - """ - Determines which trace information appear when hovering links. - If `none` or `skip` are set, no information is displayed upon - hovering. But, if `none` is set, click and hover events are - still fired. - - The 'hoverinfo' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'none', 'skip'] - - Returns - ------- - Any - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.sankey.link.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.sankey.link.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - variables `value` and `label`. Anything contained in tag - `` is displayed in the secondary box, for example - "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # label - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['label'] - - @label.setter - def label(self, val): - self['label'] = val - - # labelsrc - # -------- - @property - def labelsrc(self): - """ - Sets the source reference on plot.ly for label . - - The 'labelsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['labelsrc'] - - @labelsrc.setter - def labelsrc(self, val): - self['labelsrc'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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`. - colorsrc - Sets the source reference on plot.ly for color - . - width - Sets the width (in px) of the `line` around - each `link`. - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.sankey.link.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # source - # ------ - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['source'] - - @source.setter - def source(self, val): - self['source'] = val - - # sourcesrc - # --------- - @property - def sourcesrc(self): - """ - Sets the source reference on plot.ly for source . - - The 'sourcesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sourcesrc'] - - @sourcesrc.setter - def sourcesrc(self, val): - self['sourcesrc'] = val - - # target - # ------ - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['target'] - - @target.setter - def target(self, val): - self['target'] = val - - # targetsrc - # --------- - @property - def targetsrc(self): - """ - Sets the source reference on plot.ly for target . - - The 'targetsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['targetsrc'] - - @targetsrc.setter - def targetsrc(self, val): - self['targetsrc'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # valuesrc - # -------- - @property - def valuesrc(self): - """ - Sets the source reference on plot.ly for value . - - The 'valuesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['valuesrc'] - - @valuesrc.setter - def valuesrc(self, val): - self['valuesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'sankey' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the `link` color. It can be a single value, or an - array for specifying color for each `link`. If - `link.color` is omitted, then by default, a translucent - grey link will be used. - colorscales - plotly.graph_objs.sankey.link.Colorscale instance or - dict with compatible properties - colorscaledefaults - When used in a template (as - layout.template.data.sankey.link.colorscaledefaults), - sets the default property values to use for elements of - sankey.link.colorscales - colorsrc - Sets the source reference on plot.ly for color . - hoverinfo - Determines which trace information appear when hovering - links. If `none` or `skip` are set, no information is - displayed upon hovering. But, if `none` is set, click - and hover events are still fired. - hoverlabel - plotly.graph_objs.sankey.link.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variables `value` and `label`. Anything - contained in tag `` is displayed in the - secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - label - The shown name of the link. - labelsrc - Sets the source reference on plot.ly for label . - line - plotly.graph_objs.sankey.link.Line instance or dict - with compatible properties - source - An integer number `[0..nodes.length - 1]` that - represents the source node. - sourcesrc - Sets the source reference on plot.ly for source . - target - An integer number `[0..nodes.length - 1]` that - represents the target node. - targetsrc - Sets the source reference on plot.ly for target . - value - A numeric value representing the flow volume value. - valuesrc - Sets the source reference on plot.ly for value . - """ - - def __init__( - self, - arg=None, - color=None, - colorscales=None, - colorscaledefaults=None, - colorsrc=None, - hoverinfo=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - label=None, - labelsrc=None, - line=None, - source=None, - sourcesrc=None, - target=None, - targetsrc=None, - value=None, - valuesrc=None, - **kwargs - ): - """ - Construct a new Link object - - The links of the Sankey plot. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.Link - color - Sets the `link` color. It can be a single value, or an - array for specifying color for each `link`. If - `link.color` is omitted, then by default, a translucent - grey link will be used. - colorscales - plotly.graph_objs.sankey.link.Colorscale instance or - dict with compatible properties - colorscaledefaults - When used in a template (as - layout.template.data.sankey.link.colorscaledefaults), - sets the default property values to use for elements of - sankey.link.colorscales - colorsrc - Sets the source reference on plot.ly for color . - hoverinfo - Determines which trace information appear when hovering - links. If `none` or `skip` are set, no information is - displayed upon hovering. But, if `none` is set, click - and hover events are still fired. - hoverlabel - plotly.graph_objs.sankey.link.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variables `value` and `label`. Anything - contained in tag `` is displayed in the - secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - label - The shown name of the link. - labelsrc - Sets the source reference on plot.ly for label . - line - plotly.graph_objs.sankey.link.Line instance or dict - with compatible properties - source - An integer number `[0..nodes.length - 1]` that - represents the source node. - sourcesrc - Sets the source reference on plot.ly for source . - target - An integer number `[0..nodes.length - 1]` that - represents the target node. - targetsrc - Sets the source reference on plot.ly for target . - value - A numeric value representing the flow volume value. - valuesrc - Sets the source reference on plot.ly for value . - - Returns - ------- - Link - """ - super(Link, self).__init__('link') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.sankey.Link -constructor must be a dict or -an instance of plotly.graph_objs.sankey.Link""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.sankey import (link as v_link) - - # Initialize validators - # --------------------- - self._validators['color'] = v_link.ColorValidator() - self._validators['colorscales'] = v_link.ColorscalesValidator() - self._validators['colorscaledefaults'] = v_link.ColorscaleValidator() - self._validators['colorsrc'] = v_link.ColorsrcValidator() - self._validators['hoverinfo'] = v_link.HoverinfoValidator() - self._validators['hoverlabel'] = v_link.HoverlabelValidator() - self._validators['hovertemplate'] = v_link.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_link.HovertemplatesrcValidator() - self._validators['label'] = v_link.LabelValidator() - self._validators['labelsrc'] = v_link.LabelsrcValidator() - self._validators['line'] = v_link.LineValidator() - self._validators['source'] = v_link.SourceValidator() - self._validators['sourcesrc'] = v_link.SourcesrcValidator() - self._validators['target'] = v_link.TargetValidator() - self._validators['targetsrc'] = v_link.TargetsrcValidator() - self._validators['value'] = v_link.ValueValidator() - self._validators['valuesrc'] = v_link.ValuesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorscales', None) - self['colorscales'] = colorscales if colorscales is not None else _v - _v = arg.pop('colorscaledefaults', None) - self['colorscaledefaults' - ] = colorscaledefaults if colorscaledefaults is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('label', None) - self['label'] = label if label is not None else _v - _v = arg.pop('labelsrc', None) - self['labelsrc'] = labelsrc if labelsrc is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('source', None) - self['source'] = source if source is not None else _v - _v = arg.pop('sourcesrc', None) - self['sourcesrc'] = sourcesrc if sourcesrc is not None else _v - _v = arg.pop('target', None) - self['target'] = target if target is not None else _v - _v = arg.pop('targetsrc', None) - self['targetsrc'] = targetsrc if targetsrc is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - _v = arg.pop('valuesrc', None) - self['valuesrc'] = valuesrc if valuesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/_node.py b/plotly/graph_objs/sankey/_node.py deleted file mode 100644 index e6a305d6b30..00000000000 --- a/plotly/graph_objs/sankey/_node.py +++ /dev/null @@ -1,589 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Node(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - Sets the `node` color. It can be a single value, or an array - for specifying color for each `node`. If `node.color` is - omitted, then the default `Plotly` color palette will be cycled - through to have a variety of colors. These defaults are not - fully opaque, to allow some visibility of what is beneath the - node. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # groups - # ------ - @property - 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: - - An int or float - - Returns - ------- - list - """ - return self['groups'] - - @groups.setter - def groups(self, val): - self['groups'] = val - - # hoverinfo - # --------- - @property - def hoverinfo(self): - """ - Determines which trace information appear when hovering nodes. - If `none` or `skip` are set, no information is displayed upon - hovering. But, if `none` is set, click and hover events are - still fired. - - The 'hoverinfo' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'none', 'skip'] - - Returns - ------- - Any - """ - return self['hoverinfo'] - - @hoverinfo.setter - def hoverinfo(self, val): - self['hoverinfo'] = val - - # hoverlabel - # ---------- - @property - def hoverlabel(self): - """ - The 'hoverlabel' property is an instance of Hoverlabel - that may be specified as: - - An instance of plotly.graph_objs.sankey.node.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 labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - - Returns - ------- - plotly.graph_objs.sankey.node.Hoverlabel - """ - return self['hoverlabel'] - - @hoverlabel.setter - def hoverlabel(self, val): - self['hoverlabel'] = val - - # hovertemplate - # ------------- - @property - def hovertemplate(self): - """ - Template string used for rendering the information that appear - on hover box. Note that this will override `hoverinfo`. - Variables are inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's syntax - %{variable:d3-format}, for example "Price: %{y:$.2f}". See http - s://github.com/d3/d3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The variables available - in `hovertemplate` are the ones emitted as event data described - at this link https://plot.ly/javascript/plotlyjs-events/#event- - data. Additionally, every attributes that can be specified per- - point (the ones that are `arrayOk: true`) are available. - variables `value` and `label`. Anything contained in tag - `` is displayed in the secondary box, for example - "{fullData.name}". - - The 'hovertemplate' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['hovertemplate'] - - @hovertemplate.setter - def hovertemplate(self, val): - self['hovertemplate'] = val - - # hovertemplatesrc - # ---------------- - @property - def hovertemplatesrc(self): - """ - Sets the source reference on plot.ly for hovertemplate . - - The 'hovertemplatesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['hovertemplatesrc'] - - @hovertemplatesrc.setter - def hovertemplatesrc(self, val): - self['hovertemplatesrc'] = val - - # label - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['label'] - - @label.setter - def label(self, val): - self['label'] = val - - # labelsrc - # -------- - @property - def labelsrc(self): - """ - Sets the source reference on plot.ly for label . - - The 'labelsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['labelsrc'] - - @labelsrc.setter - def labelsrc(self, val): - self['labelsrc'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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`. - colorsrc - Sets the source reference on plot.ly for color - . - width - Sets the width (in px) of the `line` around - each `node`. - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.sankey.node.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # pad - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['pad'] - - @pad.setter - def pad(self, val): - self['pad'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'sankey' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the `node` color. It can be a single value, or an - array for specifying color for each `node`. If - `node.color` is omitted, then the default `Plotly` - color palette will be cycled through to have a variety - of colors. These defaults are not fully opaque, to - allow some visibility of what is beneath the node. - colorsrc - Sets the source reference on plot.ly for color . - groups - Groups of nodes. Each group is defined by an array with - the indices of the nodes it contains. Multiple groups - can be specified. - hoverinfo - Determines which trace information appear when hovering - nodes. If `none` or `skip` are set, no information is - displayed upon hovering. But, if `none` is set, click - and hover events are still fired. - hoverlabel - plotly.graph_objs.sankey.node.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variables `value` and `label`. Anything - contained in tag `` is displayed in the - secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - label - The shown name of the node. - labelsrc - Sets the source reference on plot.ly for label . - line - plotly.graph_objs.sankey.node.Line instance or dict - with compatible properties - pad - Sets the padding (in px) between the `nodes`. - thickness - Sets the thickness (in px) of the `nodes`. - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - groups=None, - hoverinfo=None, - hoverlabel=None, - hovertemplate=None, - hovertemplatesrc=None, - label=None, - labelsrc=None, - line=None, - pad=None, - thickness=None, - **kwargs - ): - """ - Construct a new Node object - - The nodes of the Sankey plot. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.Node - color - Sets the `node` color. It can be a single value, or an - array for specifying color for each `node`. If - `node.color` is omitted, then the default `Plotly` - color palette will be cycled through to have a variety - of colors. These defaults are not fully opaque, to - allow some visibility of what is beneath the node. - colorsrc - Sets the source reference on plot.ly for color . - groups - Groups of nodes. Each group is defined by an array with - the indices of the nodes it contains. Multiple groups - can be specified. - hoverinfo - Determines which trace information appear when hovering - nodes. If `none` or `skip` are set, no information is - displayed upon hovering. But, if `none` is set, click - and hover events are still fired. - hoverlabel - plotly.graph_objs.sankey.node.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the information that - appear on hover box. Note that this will override - `hoverinfo`. Variables are inserted using %{variable}, - for example "y: %{y}". Numbers are formatted using - d3-format's syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d3-format - /blob/master/README.md#locale_format for details on the - formatting syntax. The variables available in - `hovertemplate` are the ones emitted as event data - described at this link - https://plot.ly/javascript/plotlyjs-events/#event-data. - Additionally, every attributes that can be specified - per-point (the ones that are `arrayOk: true`) are - available. variables `value` and `label`. Anything - contained in tag `` is displayed in the - secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for hovertemplate - . - label - The shown name of the node. - labelsrc - Sets the source reference on plot.ly for label . - line - plotly.graph_objs.sankey.node.Line instance or dict - with compatible properties - pad - Sets the padding (in px) between the `nodes`. - thickness - Sets the thickness (in px) of the `nodes`. - - Returns - ------- - Node - """ - super(Node, self).__init__('node') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.sankey.Node -constructor must be a dict or -an instance of plotly.graph_objs.sankey.Node""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.sankey import (node as v_node) - - # Initialize validators - # --------------------- - self._validators['color'] = v_node.ColorValidator() - self._validators['colorsrc'] = v_node.ColorsrcValidator() - self._validators['groups'] = v_node.GroupsValidator() - self._validators['hoverinfo'] = v_node.HoverinfoValidator() - self._validators['hoverlabel'] = v_node.HoverlabelValidator() - self._validators['hovertemplate'] = v_node.HovertemplateValidator() - self._validators['hovertemplatesrc' - ] = v_node.HovertemplatesrcValidator() - self._validators['label'] = v_node.LabelValidator() - self._validators['labelsrc'] = v_node.LabelsrcValidator() - self._validators['line'] = v_node.LineValidator() - self._validators['pad'] = v_node.PadValidator() - self._validators['thickness'] = v_node.ThicknessValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('groups', None) - self['groups'] = groups if groups is not None else _v - _v = arg.pop('hoverinfo', None) - self['hoverinfo'] = hoverinfo if hoverinfo is not None else _v - _v = arg.pop('hoverlabel', None) - self['hoverlabel'] = hoverlabel if hoverlabel is not None else _v - _v = arg.pop('hovertemplate', None) - self['hovertemplate' - ] = hovertemplate if hovertemplate is not None else _v - _v = arg.pop('hovertemplatesrc', None) - self['hovertemplatesrc' - ] = hovertemplatesrc if hovertemplatesrc is not None else _v - _v = arg.pop('label', None) - self['label'] = label if label is not None else _v - _v = arg.pop('labelsrc', None) - self['labelsrc'] = labelsrc if labelsrc is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('pad', None) - self['pad'] = pad if pad is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/_stream.py b/plotly/graph_objs/sankey/_stream.py deleted file mode 100644 index ddfe52738b7..00000000000 --- a/plotly/graph_objs/sankey/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'sankey' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.sankey.Stream -constructor must be a dict or -an instance of plotly.graph_objs.sankey.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.sankey import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/_textfont.py b/plotly/graph_objs/sankey/_textfont.py deleted file mode 100644 index e1de371fb6c..00000000000 --- a/plotly/graph_objs/sankey/_textfont.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'sankey' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - def __init__(self, arg=None, color=None, family=None, size=None, **kwargs): - """ - Construct a new Textfont object - - Sets the font for node labels - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.Textfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.sankey.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.sankey.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.sankey import (textfont as v_textfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - self._validators['family'] = v_textfont.FamilyValidator() - self._validators['size'] = v_textfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/hoverlabel/__init__.py b/plotly/graph_objs/sankey/hoverlabel/__init__.py index c37b8b5cd28..a804f3e1d19 100644 --- a/plotly/graph_objs/sankey/hoverlabel/__init__.py +++ b/plotly/graph_objs/sankey/hoverlabel/__init__.py @@ -1 +1,321 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'sankey.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.sankey.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.sankey.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.sankey.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.sankey.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/hoverlabel/_font.py b/plotly/graph_objs/sankey/hoverlabel/_font.py deleted file mode 100644 index 73514fe5c9b..00000000000 --- a/plotly/graph_objs/sankey/hoverlabel/_font.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'sankey.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.sankey.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.sankey.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.sankey.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/link/__init__.py b/plotly/graph_objs/sankey/link/__init__.py index f5d03b1148d..1bc8a17c0a9 100644 --- a/plotly/graph_objs/sankey/link/__init__.py +++ b/plotly/graph_objs/sankey/link/__init__.py @@ -1,4 +1,986 @@ -from ._line import Line -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'sankey.link' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the `line` around each `link`. + colorsrc + Sets the source reference on plot.ly for color . + width + Sets the width (in px) of the `line` around each + `link`. + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.sankey.link.Line + color + Sets the color of the `line` around each `link`. + colorsrc + Sets the source reference on plot.ly for color . + width + Sets the width (in px) of the `line` around each + `link`. + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.sankey.link.Line +constructor must be a dict or +an instance of plotly.graph_objs.sankey.link.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.sankey.link import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.sankey.link.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'sankey.link' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.sankey.link.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.sankey.link.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.sankey.link.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.sankey.link import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Colorscale(_BaseTraceHierarchyType): + + # cmax + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmin + # ---- + @property + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. The colorscale must be an array containing + arrays mapping a normalized value to an rgb, rgba, hex, hsl, + hsv, or named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # label + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['label'] + + @label.setter + def label(self, val): + self['label'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'sankey.link' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + cmax + Sets the upper bound of the color domain. + cmin + Sets the lower bound of the color domain. + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + label + The label of the links to color based on their + concentration within a flow. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + """ + + def __init__( + self, + arg=None, + cmax=None, + cmin=None, + colorscale=None, + label=None, + name=None, + templateitemname=None, + **kwargs + ): + """ + Construct a new Colorscale object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.sankey.link.Colorscale + cmax + Sets the upper bound of the color domain. + cmin + Sets the lower bound of the color domain. + colorscale + Sets the colorscale. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At minimum, + a mapping for the lowest (0) and highest (1) values are + required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + label + The label of the links to color based on their + concentration within a flow. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + + Returns + ------- + Colorscale + """ + super(Colorscale, self).__init__('colorscales') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.sankey.link.Colorscale +constructor must be a dict or +an instance of plotly.graph_objs.sankey.link.Colorscale""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.sankey.link import (colorscale as v_colorscale) + + # Initialize validators + # --------------------- + self._validators['cmax'] = v_colorscale.CmaxValidator() + self._validators['cmin'] = v_colorscale.CminValidator() + self._validators['colorscale'] = v_colorscale.ColorscaleValidator() + self._validators['label'] = v_colorscale.LabelValidator() + self._validators['name'] = v_colorscale.NameValidator() + self._validators['templateitemname' + ] = v_colorscale.TemplateitemnameValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('label', None) + self['label'] = label if label is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.sankey.link import hoverlabel -from ._colorscale import Colorscale diff --git a/plotly/graph_objs/sankey/link/_colorscale.py b/plotly/graph_objs/sankey/link/_colorscale.py deleted file mode 100644 index fe6006e33cf..00000000000 --- a/plotly/graph_objs/sankey/link/_colorscale.py +++ /dev/null @@ -1,332 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Colorscale(BaseTraceHierarchyType): - - # cmax - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmin - # ---- - @property - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. The colorscale must be an array containing - arrays mapping a normalized value to an rgb, rgba, hex, hsl, - hsv, or named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # label - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['label'] - - @label.setter - def label(self, val): - self['label'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'sankey.link' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - cmax - Sets the upper bound of the color domain. - cmin - Sets the lower bound of the color domain. - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - label - The label of the links to color based on their - concentration within a flow. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - """ - - def __init__( - self, - arg=None, - cmax=None, - cmin=None, - colorscale=None, - label=None, - name=None, - templateitemname=None, - **kwargs - ): - """ - Construct a new Colorscale object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.link.Colorscale - cmax - Sets the upper bound of the color domain. - cmin - Sets the lower bound of the color domain. - colorscale - Sets the colorscale. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At minimum, - a mapping for the lowest (0) and highest (1) values are - required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and `cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - label - The label of the links to color based on their - concentration within a flow. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - - Returns - ------- - Colorscale - """ - super(Colorscale, self).__init__('colorscales') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.sankey.link.Colorscale -constructor must be a dict or -an instance of plotly.graph_objs.sankey.link.Colorscale""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.sankey.link import (colorscale as v_colorscale) - - # Initialize validators - # --------------------- - self._validators['cmax'] = v_colorscale.CmaxValidator() - self._validators['cmin'] = v_colorscale.CminValidator() - self._validators['colorscale'] = v_colorscale.ColorscaleValidator() - self._validators['label'] = v_colorscale.LabelValidator() - self._validators['name'] = v_colorscale.NameValidator() - self._validators['templateitemname' - ] = v_colorscale.TemplateitemnameValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('label', None) - self['label'] = label if label is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/link/_hoverlabel.py b/plotly/graph_objs/sankey/link/_hoverlabel.py deleted file mode 100644 index 5db2f87d8e1..00000000000 --- a/plotly/graph_objs/sankey/link/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.sankey.link.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'sankey.link' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.link.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.sankey.link.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.sankey.link.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.sankey.link import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/link/_line.py b/plotly/graph_objs/sankey/link/_line.py deleted file mode 100644 index 6d9281523eb..00000000000 --- a/plotly/graph_objs/sankey/link/_line.py +++ /dev/null @@ -1,231 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'sankey.link' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the color of the `line` around each `link`. - colorsrc - Sets the source reference on plot.ly for color . - width - Sets the width (in px) of the `line` around each - `link`. - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.link.Line - color - Sets the color of the `line` around each `link`. - colorsrc - Sets the source reference on plot.ly for color . - width - Sets the width (in px) of the `line` around each - `link`. - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.sankey.link.Line -constructor must be a dict or -an instance of plotly.graph_objs.sankey.link.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.sankey.link import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/link/hoverlabel/__init__.py b/plotly/graph_objs/sankey/link/hoverlabel/__init__.py index c37b8b5cd28..b433236b6fc 100644 --- a/plotly/graph_objs/sankey/link/hoverlabel/__init__.py +++ b/plotly/graph_objs/sankey/link/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'sankey.link.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.sankey.link.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.sankey.link.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.sankey.link.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.sankey.link.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/link/hoverlabel/_font.py b/plotly/graph_objs/sankey/link/hoverlabel/_font.py deleted file mode 100644 index e9a9c849c07..00000000000 --- a/plotly/graph_objs/sankey/link/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'sankey.link.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.sankey.link.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.sankey.link.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.sankey.link.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.sankey.link.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/node/__init__.py b/plotly/graph_objs/sankey/node/__init__.py index 3adadb271a2..2931a85c89b 100644 --- a/plotly/graph_objs/sankey/node/__init__.py +++ b/plotly/graph_objs/sankey/node/__init__.py @@ -1,3 +1,652 @@ -from ._line import Line -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'sankey.node' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the `line` around each `node`. + colorsrc + Sets the source reference on plot.ly for color . + width + Sets the width (in px) of the `line` around each + `node`. + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.sankey.node.Line + color + Sets the color of the `line` around each `node`. + colorsrc + Sets the source reference on plot.ly for color . + width + Sets the width (in px) of the `line` around each + `node`. + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.sankey.node.Line +constructor must be a dict or +an instance of plotly.graph_objs.sankey.node.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.sankey.node import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.sankey.node.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'sankey.node' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.sankey.node.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.sankey.node.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.sankey.node.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.sankey.node import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.sankey.node import hoverlabel diff --git a/plotly/graph_objs/sankey/node/_hoverlabel.py b/plotly/graph_objs/sankey/node/_hoverlabel.py deleted file mode 100644 index 8acfb15b5fd..00000000000 --- a/plotly/graph_objs/sankey/node/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.sankey.node.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'sankey.node' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.node.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.sankey.node.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.sankey.node.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.sankey.node import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/node/_line.py b/plotly/graph_objs/sankey/node/_line.py deleted file mode 100644 index 7c88b3cb9b8..00000000000 --- a/plotly/graph_objs/sankey/node/_line.py +++ /dev/null @@ -1,231 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'sankey.node' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the color of the `line` around each `node`. - colorsrc - Sets the source reference on plot.ly for color . - width - Sets the width (in px) of the `line` around each - `node`. - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.sankey.node.Line - color - Sets the color of the `line` around each `node`. - colorsrc - Sets the source reference on plot.ly for color . - width - Sets the width (in px) of the `line` around each - `node`. - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.sankey.node.Line -constructor must be a dict or -an instance of plotly.graph_objs.sankey.node.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.sankey.node import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/node/hoverlabel/__init__.py b/plotly/graph_objs/sankey/node/hoverlabel/__init__.py index c37b8b5cd28..f64bd1b8635 100644 --- a/plotly/graph_objs/sankey/node/hoverlabel/__init__.py +++ b/plotly/graph_objs/sankey/node/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'sankey.node.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.sankey.node.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.sankey.node.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.sankey.node.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.sankey.node.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/sankey/node/hoverlabel/_font.py b/plotly/graph_objs/sankey/node/hoverlabel/_font.py deleted file mode 100644 index e9aeab9bd7c..00000000000 --- a/plotly/graph_objs/sankey/node/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'sankey.node.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.sankey.node.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.sankey.node.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.sankey.node.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.sankey.node.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/__init__.py b/plotly/graph_objs/scatter/__init__.py index 8e2223f8c2c..f433999f3a4 100644 --- a/plotly/graph_objs/scatter/__init__.py +++ b/plotly/graph_objs/scatter/__init__.py @@ -1,13 +1,3996 @@ -from ._unselected import Unselected + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. + + Returns + ------- + plotly.graph_objs.scatter.unselected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.scatter.unselected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.scatter.unselected.Marker instance or + dict with compatible properties + textfont + plotly.graph_objs.scatter.unselected.Textfont instance + or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter.Unselected + marker + plotly.graph_objs.scatter.unselected.Marker instance or + dict with compatible properties + textfont + plotly.graph_objs.scatter.unselected.Textfont instance + or dict with compatible properties + + Returns + ------- + Unselected + """ + super(Unselected, self).__init__('unselected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.Unselected +constructor must be a dict or +an instance of plotly.graph_objs.scatter.Unselected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter import (unselected as v_unselected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_unselected.MarkerValidator() + self._validators['textfont'] = v_unselected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter.Textfont + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scatter.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter import (textfont as v_textfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + self._validators['colorsrc'] = v_textfont.ColorsrcValidator() + self._validators['family'] = v_textfont.FamilyValidator() + self._validators['familysrc'] = v_textfont.FamilysrcValidator() + self._validators['size'] = v_textfont.SizeValidator() + self._validators['sizesrc'] = v_textfont.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.Stream +constructor must be a dict or +an instance of plotly.graph_objs.scatter.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + plotly.graph_objs.scatter.selected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.scatter.selected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.scatter.selected.Marker instance or + dict with compatible properties + textfont + plotly.graph_objs.scatter.selected.Textfont instance or + dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter.Selected + marker + plotly.graph_objs.scatter.selected.Marker instance or + dict with compatible properties + textfont + plotly.graph_objs.scatter.selected.Textfont instance or + dict with compatible properties + + Returns + ------- + Selected + """ + super(Selected, self).__init__('selected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.Selected +constructor must be a dict or +an instance of plotly.graph_objs.scatter.Selected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter import (selected as v_selected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_selected.MarkerValidator() + self._validators['textfont'] = v_selected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color`is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` array are + all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmin` + must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmax` + must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarkercolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scatter.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of 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 + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scatter.marker.colorbar.Tickf + ormatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scatter.marker.colorbar.tickformatstopdefault + s), sets the default property values to use for + elements of + scatter.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatter.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + scatter.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. + titleside + Deprecated: Please use + scatter.marker.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.scatter.marker.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color`is + set to a numerical array. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At minimum, a mapping for + the lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Greys,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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # gradient + # -------- + @property + def gradient(self): + """ + The 'gradient' property is an instance of Gradient + that may be specified as: + - An instance of 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 + horizontal, or the bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color + . + type + Sets the type of gradient used to fill the + markers + typesrc + Sets the source reference on plot.ly for type + . + + Returns + ------- + plotly.graph_objs.scatter.marker.Gradient + """ + return self['gradient'] + + @gradient.setter + def gradient(self, val): + self['gradient'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.scatter.marker.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # maxdisplayed + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['maxdisplayed'] + + @maxdisplayed.setter + def maxdisplayed(self, val): + self['maxdisplayed'] = val + + # opacity + # ------- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # opacitysrc + # ---------- + @property + def opacitysrc(self): + """ + Sets the source reference on plot.ly for opacity . + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['opacitysrc'] + + @opacitysrc.setter + def opacitysrc(self, val): + self['opacitysrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color`is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # size + # ---- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizemin + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['sizemin'] + + @sizemin.setter + def sizemin(self, val): + self['sizemin'] = val + + # sizemode + # -------- + @property + 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'] + + Returns + ------- + Any + """ + return self['sizemode'] + + @sizemode.setter + def sizemode(self, val): + self['sizemode'] = val + + # sizeref + # ------- + @property + 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 + + Returns + ------- + int|float + """ + return self['sizeref'] + + @sizeref.setter + def sizeref(self, val): + self['sizeref'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # symbol + # ------ + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', + 315, 'hexagon2-open-dot', 16, 'octagon', 116, + 'octagon-open', 216, 'octagon-dot', 316, + 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, + 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, + 'hexagram-open', 218, 'hexagram-dot', 318, + 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', + 120, 'star-triangle-down-open', 220, + 'star-triangle-down-dot', 320, + 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, + 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, + 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, + 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, + 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, + 'line-nw-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['symbol'] + + @symbol.setter + def symbol(self, val): + self['symbol'] = val + + # symbolsrc + # --------- + @property + def symbolsrc(self): + """ + Sets the source reference on plot.ly for symbol . + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['symbolsrc'] + + @symbolsrc.setter + def symbolsrc(self, val): + self['symbolsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scatter.marker.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + gradient + plotly.graph_objs.scatter.marker.Gradient instance or + dict with compatible properties + line + plotly.graph_objs.scatter.marker.Line instance or dict + with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorbar=None, + colorscale=None, + colorsrc=None, + gradient=None, + line=None, + maxdisplayed=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter.Marker + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scatter.marker.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + gradient + plotly.graph_objs.scatter.marker.Gradient instance or + dict with compatible properties + line + plotly.graph_objs.scatter.marker.Line instance or dict + with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scatter.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() + self._validators['cauto'] = v_marker.CautoValidator() + self._validators['cmax'] = v_marker.CmaxValidator() + self._validators['cmid'] = v_marker.CmidValidator() + self._validators['cmin'] = v_marker.CminValidator() + self._validators['color'] = v_marker.ColorValidator() + self._validators['colorbar'] = v_marker.ColorBarValidator() + self._validators['colorscale'] = v_marker.ColorscaleValidator() + self._validators['colorsrc'] = v_marker.ColorsrcValidator() + self._validators['gradient'] = v_marker.GradientValidator() + self._validators['line'] = v_marker.LineValidator() + self._validators['maxdisplayed'] = v_marker.MaxdisplayedValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() + self._validators['reversescale'] = v_marker.ReversescaleValidator() + self._validators['showscale'] = v_marker.ShowscaleValidator() + self._validators['size'] = v_marker.SizeValidator() + self._validators['sizemin'] = v_marker.SizeminValidator() + self._validators['sizemode'] = v_marker.SizemodeValidator() + self._validators['sizeref'] = v_marker.SizerefValidator() + self._validators['sizesrc'] = v_marker.SizesrcValidator() + self._validators['symbol'] = v_marker.SymbolValidator() + self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('gradient', None) + self['gradient'] = gradient if gradient is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('maxdisplayed', None) + self['maxdisplayed'] = maxdisplayed if maxdisplayed is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('opacitysrc', None) + self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizemin', None) + self['sizemin'] = sizemin if sizemin is not None else _v + _v = arg.pop('sizemode', None) + self['sizemode'] = sizemode if sizemode is not None else _v + _v = arg.pop('sizeref', None) + self['sizeref'] = sizeref if sizeref is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + _v = arg.pop('symbol', None) + self['symbol'] = symbol if symbol is not None else _v + _v = arg.pop('symbolsrc', None) + self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dash + # ---- + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self['dash'] + + @dash.setter + def dash(self, val): + self['dash'] = val + + # shape + # ----- + @property + 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'] + + Returns + ------- + Any + """ + return self['shape'] + + @shape.setter + def shape(self, val): + self['shape'] = val + + # simplify + # -------- + @property + def simplify(self): + """ + Simplifies lines by removing nearly-collinear points. When + transitioning lines, it may be desirable to disable this so + that the number of points along the resulting SVG path is + unaffected. + + The 'simplify' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['simplify'] + + @simplify.setter + def simplify(self, val): + self['simplify'] = val + + # smoothing + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['smoothing'] + + @smoothing.setter + def smoothing(self, val): + self['smoothing'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + simplify + Simplifies lines by removing nearly-collinear points. + When transitioning lines, it may be desirable to + disable this so that the number of points along the + resulting SVG path is unaffected. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + """ + + def __init__( + self, + arg=None, + color=None, + dash=None, + shape=None, + simplify=None, + smoothing=None, + width=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter.Line + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + simplify + Simplifies lines by removing nearly-collinear points. + When transitioning lines, it may be desirable to + disable this so that the number of points along the + resulting SVG path is unaffected. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.Line +constructor must be a dict or +an instance of plotly.graph_objs.scatter.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['dash'] = v_line.DashValidator() + self._validators['shape'] = v_line.ShapeValidator() + self._validators['simplify'] = v_line.SimplifyValidator() + self._validators['smoothing'] = v_line.SmoothingValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dash', None) + self['dash'] = dash if dash is not None else _v + _v = arg.pop('shape', None) + self['shape'] = shape if shape is not None else _v + _v = arg.pop('simplify', None) + self['simplify'] = simplify if simplify is not None else _v + _v = arg.pop('smoothing', None) + self['smoothing'] = smoothing if smoothing is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scatter.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.scatter.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorY(_BaseTraceHierarchyType): + + # array + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['array'] + + @array.setter + def array(self, val): + self['array'] = val + + # arrayminus + # ---------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['arrayminus'] + + @arrayminus.setter + def arrayminus(self, val): + self['arrayminus'] = val + + # arrayminussrc + # ------------- + @property + def arrayminussrc(self): + """ + Sets the source reference on plot.ly for arrayminus . + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arrayminussrc'] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self['arrayminussrc'] = val + + # arraysrc + # -------- + @property + def arraysrc(self): + """ + Sets the source reference on plot.ly for array . + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arraysrc'] + + @arraysrc.setter + def arraysrc(self, val): + self['arraysrc'] = val + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # symmetric + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['symmetric'] + + @symmetric.setter + def symmetric(self, val): + self['symmetric'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # traceref + # -------- + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['traceref'] + + @traceref.setter + def traceref(self, val): + self['traceref'] = val + + # tracerefminus + # ------------- + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['tracerefminus'] + + @tracerefminus.setter + def tracerefminus(self, val): + self['tracerefminus'] = val + + # type + # ---- + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the sqaure of + the underlying data. If "array", 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # value + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # valueminus + # ---------- + @property + def valueminus(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 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] + + Returns + ------- + int|float + """ + return self['valueminus'] + + @valueminus.setter + def valueminus(self, val): + self['valueminus'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs + ): + """ + Construct a new ErrorY object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter.ErrorY + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorY + """ + super(ErrorY, self).__init__('error_y') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.ErrorY +constructor must be a dict or +an instance of plotly.graph_objs.scatter.ErrorY""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter import (error_y as v_error_y) + + # Initialize validators + # --------------------- + self._validators['array'] = v_error_y.ArrayValidator() + self._validators['arrayminus'] = v_error_y.ArrayminusValidator() + self._validators['arrayminussrc'] = v_error_y.ArrayminussrcValidator() + self._validators['arraysrc'] = v_error_y.ArraysrcValidator() + self._validators['color'] = v_error_y.ColorValidator() + self._validators['symmetric'] = v_error_y.SymmetricValidator() + self._validators['thickness'] = v_error_y.ThicknessValidator() + self._validators['traceref'] = v_error_y.TracerefValidator() + self._validators['tracerefminus'] = v_error_y.TracerefminusValidator() + self._validators['type'] = v_error_y.TypeValidator() + self._validators['value'] = v_error_y.ValueValidator() + self._validators['valueminus'] = v_error_y.ValueminusValidator() + self._validators['visible'] = v_error_y.VisibleValidator() + self._validators['width'] = v_error_y.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('array', None) + self['array'] = array if array is not None else _v + _v = arg.pop('arrayminus', None) + self['arrayminus'] = arrayminus if arrayminus is not None else _v + _v = arg.pop('arrayminussrc', None) + self['arrayminussrc' + ] = arrayminussrc if arrayminussrc is not None else _v + _v = arg.pop('arraysrc', None) + self['arraysrc'] = arraysrc if arraysrc is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('symmetric', None) + self['symmetric'] = symmetric if symmetric is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('traceref', None) + self['traceref'] = traceref if traceref is not None else _v + _v = arg.pop('tracerefminus', None) + self['tracerefminus' + ] = tracerefminus if tracerefminus is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + _v = arg.pop('valueminus', None) + self['valueminus'] = valueminus if valueminus is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorX(_BaseTraceHierarchyType): + + # array + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['array'] + + @array.setter + def array(self, val): + self['array'] = val + + # arrayminus + # ---------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['arrayminus'] + + @arrayminus.setter + def arrayminus(self, val): + self['arrayminus'] = val + + # arrayminussrc + # ------------- + @property + def arrayminussrc(self): + """ + Sets the source reference on plot.ly for arrayminus . + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arrayminussrc'] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self['arrayminussrc'] = val + + # arraysrc + # -------- + @property + def arraysrc(self): + """ + Sets the source reference on plot.ly for array . + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arraysrc'] + + @arraysrc.setter + def arraysrc(self, val): + self['arraysrc'] = val + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # copy_ystyle + # ----------- + @property + def copy_ystyle(self): + """ + The 'copy_ystyle' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['copy_ystyle'] + + @copy_ystyle.setter + def copy_ystyle(self, val): + self['copy_ystyle'] = val + + # symmetric + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['symmetric'] + + @symmetric.setter + def symmetric(self, val): + self['symmetric'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # traceref + # -------- + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['traceref'] + + @traceref.setter + def traceref(self, val): + self['traceref'] = val + + # tracerefminus + # ------------- + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['tracerefminus'] + + @tracerefminus.setter + def tracerefminus(self, val): + self['tracerefminus'] = val + + # type + # ---- + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the sqaure of + the underlying data. If "array", 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # value + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # valueminus + # ---------- + @property + def valueminus(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 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] + + Returns + ------- + int|float + """ + return self['valueminus'] + + @valueminus.setter + def valueminus(self, val): + self['valueminus'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + copy_ystyle=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs + ): + """ + Construct a new ErrorX object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter.ErrorX + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorX + """ + super(ErrorX, self).__init__('error_x') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.ErrorX +constructor must be a dict or +an instance of plotly.graph_objs.scatter.ErrorX""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter import (error_x as v_error_x) + + # Initialize validators + # --------------------- + self._validators['array'] = v_error_x.ArrayValidator() + self._validators['arrayminus'] = v_error_x.ArrayminusValidator() + self._validators['arrayminussrc'] = v_error_x.ArrayminussrcValidator() + self._validators['arraysrc'] = v_error_x.ArraysrcValidator() + self._validators['color'] = v_error_x.ColorValidator() + self._validators['copy_ystyle'] = v_error_x.CopyYstyleValidator() + self._validators['symmetric'] = v_error_x.SymmetricValidator() + self._validators['thickness'] = v_error_x.ThicknessValidator() + self._validators['traceref'] = v_error_x.TracerefValidator() + self._validators['tracerefminus'] = v_error_x.TracerefminusValidator() + self._validators['type'] = v_error_x.TypeValidator() + self._validators['value'] = v_error_x.ValueValidator() + self._validators['valueminus'] = v_error_x.ValueminusValidator() + self._validators['visible'] = v_error_x.VisibleValidator() + self._validators['width'] = v_error_x.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('array', None) + self['array'] = array if array is not None else _v + _v = arg.pop('arrayminus', None) + self['arrayminus'] = arrayminus if arrayminus is not None else _v + _v = arg.pop('arrayminussrc', None) + self['arrayminussrc' + ] = arrayminussrc if arrayminussrc is not None else _v + _v = arg.pop('arraysrc', None) + self['arraysrc'] = arraysrc if arraysrc is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('copy_ystyle', None) + self['copy_ystyle'] = copy_ystyle if copy_ystyle is not None else _v + _v = arg.pop('symmetric', None) + self['symmetric'] = symmetric if symmetric is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('traceref', None) + self['traceref'] = traceref if traceref is not None else _v + _v = arg.pop('tracerefminus', None) + self['tracerefminus' + ] = tracerefminus if tracerefminus is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + _v = arg.pop('valueminus', None) + self['valueminus'] = valueminus if valueminus is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scatter import unselected -from ._textfont import Textfont -from ._stream import Stream -from ._selected import Selected from plotly.graph_objs.scatter import selected -from ._marker import Marker from plotly.graph_objs.scatter import marker -from ._line import Line -from ._hoverlabel import Hoverlabel from plotly.graph_objs.scatter import hoverlabel -from ._error_y import ErrorY -from ._error_x import ErrorX diff --git a/plotly/graph_objs/scatter/_error_x.py b/plotly/graph_objs/scatter/_error_x.py deleted file mode 100644 index aaa3f79dafc..00000000000 --- a/plotly/graph_objs/scatter/_error_x.py +++ /dev/null @@ -1,597 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ErrorX(BaseTraceHierarchyType): - - # array - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['array'] - - @array.setter - def array(self, val): - self['array'] = val - - # arrayminus - # ---------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['arrayminus'] - - @arrayminus.setter - def arrayminus(self, val): - self['arrayminus'] = val - - # arrayminussrc - # ------------- - @property - def arrayminussrc(self): - """ - Sets the source reference on plot.ly for arrayminus . - - The 'arrayminussrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arrayminussrc'] - - @arrayminussrc.setter - def arrayminussrc(self, val): - self['arrayminussrc'] = val - - # arraysrc - # -------- - @property - def arraysrc(self): - """ - Sets the source reference on plot.ly for array . - - The 'arraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arraysrc'] - - @arraysrc.setter - def arraysrc(self, val): - self['arraysrc'] = val - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # copy_ystyle - # ----------- - @property - def copy_ystyle(self): - """ - The 'copy_ystyle' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['copy_ystyle'] - - @copy_ystyle.setter - def copy_ystyle(self, val): - self['copy_ystyle'] = val - - # symmetric - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['symmetric'] - - @symmetric.setter - def symmetric(self, val): - self['symmetric'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # traceref - # -------- - @property - def traceref(self): - """ - The 'traceref' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['traceref'] - - @traceref.setter - def traceref(self, val): - self['traceref'] = val - - # tracerefminus - # ------------- - @property - def tracerefminus(self): - """ - The 'tracerefminus' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['tracerefminus'] - - @tracerefminus.setter - def tracerefminus(self, val): - self['tracerefminus'] = val - - # type - # ---- - @property - def type(self): - """ - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. Set this - constant in `value`. If "percent", the bar lengths correspond - to a percentage of underlying data. Set this percentage in - `value`. If "sqrt", the bar lengths correspond to the sqaure of - the underlying data. If "array", 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # value - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # valueminus - # ---------- - @property - def valueminus(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 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] - - Returns - ------- - int|float - """ - return self['valueminus'] - - @valueminus.setter - def valueminus(self, val): - self['valueminus'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - copy_ystyle - - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - """ - - def __init__( - self, - arg=None, - array=None, - arrayminus=None, - arrayminussrc=None, - arraysrc=None, - color=None, - copy_ystyle=None, - symmetric=None, - thickness=None, - traceref=None, - tracerefminus=None, - type=None, - value=None, - valueminus=None, - visible=None, - width=None, - **kwargs - ): - """ - Construct a new ErrorX object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.ErrorX - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - copy_ystyle - - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - - Returns - ------- - ErrorX - """ - super(ErrorX, self).__init__('error_x') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.ErrorX -constructor must be a dict or -an instance of plotly.graph_objs.scatter.ErrorX""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter import (error_x as v_error_x) - - # Initialize validators - # --------------------- - self._validators['array'] = v_error_x.ArrayValidator() - self._validators['arrayminus'] = v_error_x.ArrayminusValidator() - self._validators['arrayminussrc'] = v_error_x.ArrayminussrcValidator() - self._validators['arraysrc'] = v_error_x.ArraysrcValidator() - self._validators['color'] = v_error_x.ColorValidator() - self._validators['copy_ystyle'] = v_error_x.CopyYstyleValidator() - self._validators['symmetric'] = v_error_x.SymmetricValidator() - self._validators['thickness'] = v_error_x.ThicknessValidator() - self._validators['traceref'] = v_error_x.TracerefValidator() - self._validators['tracerefminus'] = v_error_x.TracerefminusValidator() - self._validators['type'] = v_error_x.TypeValidator() - self._validators['value'] = v_error_x.ValueValidator() - self._validators['valueminus'] = v_error_x.ValueminusValidator() - self._validators['visible'] = v_error_x.VisibleValidator() - self._validators['width'] = v_error_x.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('array', None) - self['array'] = array if array is not None else _v - _v = arg.pop('arrayminus', None) - self['arrayminus'] = arrayminus if arrayminus is not None else _v - _v = arg.pop('arrayminussrc', None) - self['arrayminussrc' - ] = arrayminussrc if arrayminussrc is not None else _v - _v = arg.pop('arraysrc', None) - self['arraysrc'] = arraysrc if arraysrc is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('copy_ystyle', None) - self['copy_ystyle'] = copy_ystyle if copy_ystyle is not None else _v - _v = arg.pop('symmetric', None) - self['symmetric'] = symmetric if symmetric is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('traceref', None) - self['traceref'] = traceref if traceref is not None else _v - _v = arg.pop('tracerefminus', None) - self['tracerefminus' - ] = tracerefminus if tracerefminus is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - _v = arg.pop('valueminus', None) - self['valueminus'] = valueminus if valueminus is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/_error_y.py b/plotly/graph_objs/scatter/_error_y.py deleted file mode 100644 index 714f0513b2f..00000000000 --- a/plotly/graph_objs/scatter/_error_y.py +++ /dev/null @@ -1,571 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ErrorY(BaseTraceHierarchyType): - - # array - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['array'] - - @array.setter - def array(self, val): - self['array'] = val - - # arrayminus - # ---------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['arrayminus'] - - @arrayminus.setter - def arrayminus(self, val): - self['arrayminus'] = val - - # arrayminussrc - # ------------- - @property - def arrayminussrc(self): - """ - Sets the source reference on plot.ly for arrayminus . - - The 'arrayminussrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arrayminussrc'] - - @arrayminussrc.setter - def arrayminussrc(self, val): - self['arrayminussrc'] = val - - # arraysrc - # -------- - @property - def arraysrc(self): - """ - Sets the source reference on plot.ly for array . - - The 'arraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arraysrc'] - - @arraysrc.setter - def arraysrc(self, val): - self['arraysrc'] = val - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # symmetric - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['symmetric'] - - @symmetric.setter - def symmetric(self, val): - self['symmetric'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # traceref - # -------- - @property - def traceref(self): - """ - The 'traceref' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['traceref'] - - @traceref.setter - def traceref(self, val): - self['traceref'] = val - - # tracerefminus - # ------------- - @property - def tracerefminus(self): - """ - The 'tracerefminus' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['tracerefminus'] - - @tracerefminus.setter - def tracerefminus(self, val): - self['tracerefminus'] = val - - # type - # ---- - @property - def type(self): - """ - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. Set this - constant in `value`. If "percent", the bar lengths correspond - to a percentage of underlying data. Set this percentage in - `value`. If "sqrt", the bar lengths correspond to the sqaure of - the underlying data. If "array", 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # value - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # valueminus - # ---------- - @property - def valueminus(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 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] - - Returns - ------- - int|float - """ - return self['valueminus'] - - @valueminus.setter - def valueminus(self, val): - self['valueminus'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - """ - - def __init__( - self, - arg=None, - array=None, - arrayminus=None, - arrayminussrc=None, - arraysrc=None, - color=None, - symmetric=None, - thickness=None, - traceref=None, - tracerefminus=None, - type=None, - value=None, - valueminus=None, - visible=None, - width=None, - **kwargs - ): - """ - Construct a new ErrorY object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.ErrorY - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - - Returns - ------- - ErrorY - """ - super(ErrorY, self).__init__('error_y') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.ErrorY -constructor must be a dict or -an instance of plotly.graph_objs.scatter.ErrorY""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter import (error_y as v_error_y) - - # Initialize validators - # --------------------- - self._validators['array'] = v_error_y.ArrayValidator() - self._validators['arrayminus'] = v_error_y.ArrayminusValidator() - self._validators['arrayminussrc'] = v_error_y.ArrayminussrcValidator() - self._validators['arraysrc'] = v_error_y.ArraysrcValidator() - self._validators['color'] = v_error_y.ColorValidator() - self._validators['symmetric'] = v_error_y.SymmetricValidator() - self._validators['thickness'] = v_error_y.ThicknessValidator() - self._validators['traceref'] = v_error_y.TracerefValidator() - self._validators['tracerefminus'] = v_error_y.TracerefminusValidator() - self._validators['type'] = v_error_y.TypeValidator() - self._validators['value'] = v_error_y.ValueValidator() - self._validators['valueminus'] = v_error_y.ValueminusValidator() - self._validators['visible'] = v_error_y.VisibleValidator() - self._validators['width'] = v_error_y.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('array', None) - self['array'] = array if array is not None else _v - _v = arg.pop('arrayminus', None) - self['arrayminus'] = arrayminus if arrayminus is not None else _v - _v = arg.pop('arrayminussrc', None) - self['arrayminussrc' - ] = arrayminussrc if arrayminussrc is not None else _v - _v = arg.pop('arraysrc', None) - self['arraysrc'] = arraysrc if arraysrc is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('symmetric', None) - self['symmetric'] = symmetric if symmetric is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('traceref', None) - self['traceref'] = traceref if traceref is not None else _v - _v = arg.pop('tracerefminus', None) - self['tracerefminus' - ] = tracerefminus if tracerefminus is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - _v = arg.pop('valueminus', None) - self['valueminus'] = valueminus if valueminus is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/_hoverlabel.py b/plotly/graph_objs/scatter/_hoverlabel.py deleted file mode 100644 index 6646bb40acd..00000000000 --- a/plotly/graph_objs/scatter/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scatter.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.scatter.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/_line.py b/plotly/graph_objs/scatter/_line.py deleted file mode 100644 index b27f3cdaeec..00000000000 --- a/plotly/graph_objs/scatter/_line.py +++ /dev/null @@ -1,317 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dash - # ---- - @property - def dash(self): - """ - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - - The 'dash' property is an enumeration that may be specified as: - - One of the following dash styles: - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - - A string containing a dash length list in pixels or percentages - (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) - - Returns - ------- - str - """ - return self['dash'] - - @dash.setter - def dash(self, val): - self['dash'] = val - - # shape - # ----- - @property - 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'] - - Returns - ------- - Any - """ - return self['shape'] - - @shape.setter - def shape(self, val): - self['shape'] = val - - # simplify - # -------- - @property - def simplify(self): - """ - Simplifies lines by removing nearly-collinear points. When - transitioning lines, it may be desirable to disable this so - that the number of points along the resulting SVG path is - unaffected. - - The 'simplify' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['simplify'] - - @simplify.setter - def simplify(self, val): - self['simplify'] = val - - # smoothing - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['smoothing'] - - @smoothing.setter - def smoothing(self, val): - self['smoothing'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - shape - Determines the line shape. With "spline" the lines are - drawn using spline interpolation. The other available - values correspond to step-wise line shapes. - simplify - Simplifies lines by removing nearly-collinear points. - When transitioning lines, it may be desirable to - disable this so that the number of points along the - resulting SVG path is unaffected. - smoothing - Has an effect only if `shape` is set to "spline" Sets - the amount of smoothing. 0 corresponds to no smoothing - (equivalent to a "linear" shape). - width - Sets the line width (in px). - """ - - def __init__( - self, - arg=None, - color=None, - dash=None, - shape=None, - simplify=None, - smoothing=None, - width=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.Line - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - shape - Determines the line shape. With "spline" the lines are - drawn using spline interpolation. The other available - values correspond to step-wise line shapes. - simplify - Simplifies lines by removing nearly-collinear points. - When transitioning lines, it may be desirable to - disable this so that the number of points along the - resulting SVG path is unaffected. - smoothing - Has an effect only if `shape` is set to "spline" Sets - the amount of smoothing. 0 corresponds to no smoothing - (equivalent to a "linear" shape). - width - Sets the line width (in px). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.Line -constructor must be a dict or -an instance of plotly.graph_objs.scatter.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['dash'] = v_line.DashValidator() - self._validators['shape'] = v_line.ShapeValidator() - self._validators['simplify'] = v_line.SimplifyValidator() - self._validators['smoothing'] = v_line.SmoothingValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dash', None) - self['dash'] = dash if dash is not None else _v - _v = arg.pop('shape', None) - self['shape'] = shape if shape is not None else _v - _v = arg.pop('simplify', None) - self['simplify'] = simplify if simplify is not None else _v - _v = arg.pop('smoothing', None) - self['smoothing'] = smoothing if smoothing is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/_marker.py b/plotly/graph_objs/scatter/_marker.py deleted file mode 100644 index db3609302e9..00000000000 --- a/plotly/graph_objs/scatter/_marker.py +++ /dev/null @@ -1,1319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in `marker.color`is - set to a numerical array. In case `colorscale` is unspecified - or `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` array are - all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.color`) or the - bounds set in `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical array. Defaults - to `false` when `marker.cmin` and `marker.cmax` are set by the - user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmin` - must be set as well. - - The 'cmax' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling `marker.cmin` - and/or `marker.cmax` to be equidistant to this point. Has an - effect only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color`. Has no - effect when `marker.cauto` is `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmax` - must be set as well. - - The 'cmin' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarkercolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scatter.marker.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of 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 - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scatter.marker.colorbar.Tickf - ormatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scatter.marker.colorbar.tickformatstopdefault - s), sets the default property values to use for - elements of - scatter.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatter.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - scatter.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. - titleside - Deprecated: Please use - scatter.marker.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.scatter.marker.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in `marker.color`is - set to a numerical array. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At minimum, a mapping for - the lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` - may be a palette name string of the following list: Greys,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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # gradient - # -------- - @property - def gradient(self): - """ - The 'gradient' property is an instance of Gradient - that may be specified as: - - An instance of 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 - horizontal, or the bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color - . - type - Sets the type of gradient used to fill the - markers - typesrc - Sets the source reference on plot.ly for type - . - - Returns - ------- - plotly.graph_objs.scatter.marker.Gradient - """ - return self['gradient'] - - @gradient.setter - def gradient(self, val): - self['gradient'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.scatter.marker.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # maxdisplayed - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['maxdisplayed'] - - @maxdisplayed.setter - def maxdisplayed(self, val): - self['maxdisplayed'] = val - - # opacity - # ------- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # opacitysrc - # ---------- - @property - def opacitysrc(self): - """ - Sets the source reference on plot.ly for opacity . - - The 'opacitysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['opacitysrc'] - - @opacitysrc.setter - def opacitysrc(self, val): - self['opacitysrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.color`is set to a numerical array. If true, - `marker.cmin` will correspond to the last color in the array - and `marker.cmax` will correspond to the first color. - - The 'reversescale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # size - # ---- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizemin - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['sizemin'] - - @sizemin.setter - def sizemin(self, val): - self['sizemin'] = val - - # sizemode - # -------- - @property - 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'] - - Returns - ------- - Any - """ - return self['sizemode'] - - @sizemode.setter - def sizemode(self, val): - self['sizemode'] = val - - # sizeref - # ------- - @property - 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 - - Returns - ------- - int|float - """ - return self['sizeref'] - - @sizeref.setter - def sizeref(self, val): - self['sizeref'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # symbol - # ------ - @property - def symbol(self): - """ - Sets the marker symbol type. Adding 100 is equivalent to - appending "-open" to a symbol name. Adding 200 is equivalent to - appending "-dot" to a symbol name. Adding 300 is equivalent to - appending "-open-dot" or "dot-open" to a symbol name. - - The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', - 315, 'hexagon2-open-dot', 16, 'octagon', 116, - 'octagon-open', 216, 'octagon-dot', 316, - 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, - 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, - 'hexagram-open', 218, 'hexagram-dot', 318, - 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', - 120, 'star-triangle-down-open', 220, - 'star-triangle-down-dot', 320, - 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, - 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, - 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, - 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, - 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, - 'line-nw-open'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['symbol'] - - @symbol.setter - def symbol(self, val): - self['symbol'] = val - - # symbolsrc - # --------- - @property - def symbolsrc(self): - """ - Sets the source reference on plot.ly for symbol . - - The 'symbolsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['symbolsrc'] - - @symbolsrc.setter - def symbolsrc(self, val): - self['symbolsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scatter.marker.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - gradient - plotly.graph_objs.scatter.marker.Gradient instance or - dict with compatible properties - line - plotly.graph_objs.scatter.marker.Line instance or dict - with compatible properties - maxdisplayed - Sets a maximum number of points to be drawn on the - graph. 0 corresponds to no limit. - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorbar=None, - colorscale=None, - colorsrc=None, - gradient=None, - line=None, - maxdisplayed=None, - opacity=None, - opacitysrc=None, - reversescale=None, - showscale=None, - size=None, - sizemin=None, - sizemode=None, - sizeref=None, - sizesrc=None, - symbol=None, - symbolsrc=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.Marker - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scatter.marker.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - gradient - plotly.graph_objs.scatter.marker.Gradient instance or - dict with compatible properties - line - plotly.graph_objs.scatter.marker.Line instance or dict - with compatible properties - maxdisplayed - Sets a maximum number of points to be drawn on the - graph. 0 corresponds to no limit. - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scatter.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() - self._validators['cauto'] = v_marker.CautoValidator() - self._validators['cmax'] = v_marker.CmaxValidator() - self._validators['cmid'] = v_marker.CmidValidator() - self._validators['cmin'] = v_marker.CminValidator() - self._validators['color'] = v_marker.ColorValidator() - self._validators['colorbar'] = v_marker.ColorBarValidator() - self._validators['colorscale'] = v_marker.ColorscaleValidator() - self._validators['colorsrc'] = v_marker.ColorsrcValidator() - self._validators['gradient'] = v_marker.GradientValidator() - self._validators['line'] = v_marker.LineValidator() - self._validators['maxdisplayed'] = v_marker.MaxdisplayedValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() - self._validators['reversescale'] = v_marker.ReversescaleValidator() - self._validators['showscale'] = v_marker.ShowscaleValidator() - self._validators['size'] = v_marker.SizeValidator() - self._validators['sizemin'] = v_marker.SizeminValidator() - self._validators['sizemode'] = v_marker.SizemodeValidator() - self._validators['sizeref'] = v_marker.SizerefValidator() - self._validators['sizesrc'] = v_marker.SizesrcValidator() - self._validators['symbol'] = v_marker.SymbolValidator() - self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('gradient', None) - self['gradient'] = gradient if gradient is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('maxdisplayed', None) - self['maxdisplayed'] = maxdisplayed if maxdisplayed is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('opacitysrc', None) - self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizemin', None) - self['sizemin'] = sizemin if sizemin is not None else _v - _v = arg.pop('sizemode', None) - self['sizemode'] = sizemode if sizemode is not None else _v - _v = arg.pop('sizeref', None) - self['sizeref'] = sizeref if sizeref is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - _v = arg.pop('symbol', None) - self['symbol'] = symbol if symbol is not None else _v - _v = arg.pop('symbolsrc', None) - self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/_selected.py b/plotly/graph_objs/scatter/_selected.py deleted file mode 100644 index 23dfd0eebc0..00000000000 --- a/plotly/graph_objs/scatter/_selected.py +++ /dev/null @@ -1,146 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Selected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - plotly.graph_objs.scatter.selected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.scatter.selected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.scatter.selected.Marker instance or - dict with compatible properties - textfont - plotly.graph_objs.scatter.selected.Textfont instance or - dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Selected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.Selected - marker - plotly.graph_objs.scatter.selected.Marker instance or - dict with compatible properties - textfont - plotly.graph_objs.scatter.selected.Textfont instance or - dict with compatible properties - - Returns - ------- - Selected - """ - super(Selected, self).__init__('selected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.Selected -constructor must be a dict or -an instance of plotly.graph_objs.scatter.Selected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter import (selected as v_selected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_selected.MarkerValidator() - self._validators['textfont'] = v_selected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/_stream.py b/plotly/graph_objs/scatter/_stream.py deleted file mode 100644 index 24ff7d1a7b4..00000000000 --- a/plotly/graph_objs/scatter/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.Stream -constructor must be a dict or -an instance of plotly.graph_objs.scatter.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/_textfont.py b/plotly/graph_objs/scatter/_textfont.py deleted file mode 100644 index ad5a8a71647..00000000000 --- a/plotly/graph_objs/scatter/_textfont.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Textfont object - - Sets the text font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.Textfont - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scatter.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter import (textfont as v_textfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - self._validators['colorsrc'] = v_textfont.ColorsrcValidator() - self._validators['family'] = v_textfont.FamilyValidator() - self._validators['familysrc'] = v_textfont.FamilysrcValidator() - self._validators['size'] = v_textfont.SizeValidator() - self._validators['sizesrc'] = v_textfont.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/_unselected.py b/plotly/graph_objs/scatter/_unselected.py deleted file mode 100644 index 57f456522fa..00000000000 --- a/plotly/graph_objs/scatter/_unselected.py +++ /dev/null @@ -1,150 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Unselected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. - - Returns - ------- - plotly.graph_objs.scatter.unselected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.scatter.unselected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.scatter.unselected.Marker instance or - dict with compatible properties - textfont - plotly.graph_objs.scatter.unselected.Textfont instance - or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Unselected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.Unselected - marker - plotly.graph_objs.scatter.unselected.Marker instance or - dict with compatible properties - textfont - plotly.graph_objs.scatter.unselected.Textfont instance - or dict with compatible properties - - Returns - ------- - Unselected - """ - super(Unselected, self).__init__('unselected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.Unselected -constructor must be a dict or -an instance of plotly.graph_objs.scatter.Unselected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter import (unselected as v_unselected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_unselected.MarkerValidator() - self._validators['textfont'] = v_unselected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/hoverlabel/__init__.py b/plotly/graph_objs/scatter/hoverlabel/__init__.py index c37b8b5cd28..882f243fe40 100644 --- a/plotly/graph_objs/scatter/hoverlabel/__init__.py +++ b/plotly/graph_objs/scatter/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatter.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.scatter.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/hoverlabel/_font.py b/plotly/graph_objs/scatter/hoverlabel/_font.py deleted file mode 100644 index b5f9b9c42ef..00000000000 --- a/plotly/graph_objs/scatter/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.scatter.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/marker/__init__.py b/plotly/graph_objs/scatter/marker/__init__.py index 0e592070814..3a0d91f1b69 100644 --- a/plotly/graph_objs/scatter/marker/__init__.py +++ b/plotly/graph_objs/scatter/marker/__init__.py @@ -1,4 +1,2682 @@ -from ._line import Line -from ._gradient import Gradient -from ._colorbar import ColorBar + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + 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) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color`is + 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 + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarker.linecolor. It accepts either a specific color or + an array of numbers that are mapped to the colorscale relative + to the max and min values of the array or relative to + `marker.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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scatter.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized value + to an rgb, rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and highest (1) values + are required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color`is set to a numerical array. If true, + `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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter.marker.Line + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.marker.Line +constructor must be a dict or +an instance of plotly.graph_objs.scatter.marker.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter.marker import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() + self._validators['cauto'] = v_line.CautoValidator() + self._validators['cmax'] = v_line.CmaxValidator() + self._validators['cmid'] = v_line.CmidValidator() + self._validators['cmin'] = v_line.CminValidator() + self._validators['color'] = v_line.ColorValidator() + self._validators['colorscale'] = v_line.ColorscaleValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['reversescale'] = v_line.ReversescaleValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Gradient(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # type + # ---- + @property + 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'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # typesrc + # ------- + @property + def typesrc(self): + """ + Sets the source reference on plot.ly for type . + + The 'typesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['typesrc'] + + @typesrc.setter + def typesrc(self, val): + self['typesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color . + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on plot.ly for type . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + type=None, + typesrc=None, + **kwargs + ): + """ + Construct a new Gradient object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatter.marker.Gradient + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color . + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on plot.ly for type . + + Returns + ------- + Gradient + """ + super(Gradient, self).__init__('gradient') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.marker.Gradient +constructor must be a dict or +an instance of plotly.graph_objs.scatter.marker.Gradient""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter.marker import (gradient as v_gradient) + + # Initialize validators + # --------------------- + self._validators['color'] = v_gradient.ColorValidator() + self._validators['colorsrc'] = v_gradient.ColorsrcValidator() + self._validators['type'] = v_gradient.TypeValidator() + self._validators['typesrc'] = v_gradient.TypesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('typesrc', None) + self['typesrc'] = typesrc if typesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scatter.marker.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.scatter.marker.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scatter.marker + .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 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 + ------- + plotly.graph_objs.scatter.marker.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.scatter.marker.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use scatter.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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use scatter.marker.colorbar.title.side + instead. Determines the location of color bar's title with + respect to the color bar. Note that the title's location used + to be set by the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scatter.marker.colorbar.Tickformatsto + p instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + r.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scatter.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatter.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + scatter.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. + titleside + Deprecated: Please use + scatter.marker.colorbar.title.side instead. Determines + the location of color bar's title with respect to the + color bar. Note that the title's location used to be + set by the now deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatter.marker.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scatter.marker.colorbar.Tickformatsto + p instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + r.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scatter.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatter.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + scatter.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. + titleside + Deprecated: Please use + scatter.marker.colorbar.title.side instead. Determines + the location of color bar's title with respect to the + color bar. Note that the title's location used to be + set by the now deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.marker.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.scatter.marker.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter.marker import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scatter.marker import colorbar diff --git a/plotly/graph_objs/scatter/marker/_colorbar.py b/plotly/graph_objs/scatter/marker/_colorbar.py deleted file mode 100644 index 2fe99cc359f..00000000000 --- a/plotly/graph_objs/scatter/marker/_colorbar.py +++ /dev/null @@ -1,1865 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scatter.marker.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.scatter.marker.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.scatter.marker - .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 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 - ------- - plotly.graph_objs.scatter.marker.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.scatter.marker.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use scatter.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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use scatter.marker.colorbar.title.side - instead. Determines the location of color bar's title with - respect to the color bar. Note that the title's location used - to be set by the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scatter.marker.colorbar.Tickformatsto - p instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - r.marker.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - scatter.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatter.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - scatter.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. - titleside - Deprecated: Please use - scatter.marker.colorbar.title.side instead. Determines - the location of color bar's title with respect to the - color bar. Note that the title's location used to be - set by the now deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter.marker.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scatter.marker.colorbar.Tickformatsto - p instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - r.marker.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - scatter.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatter.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - scatter.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. - titleside - Deprecated: Please use - scatter.marker.colorbar.title.side instead. Determines - the location of color bar's title with respect to the - color bar. Note that the title's location used to be - set by the now deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.marker.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.scatter.marker.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter.marker import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/marker/_gradient.py b/plotly/graph_objs/scatter/marker/_gradient.py deleted file mode 100644 index 96ac5070ed6..00000000000 --- a/plotly/graph_objs/scatter/marker/_gradient.py +++ /dev/null @@ -1,236 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Gradient(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # type - # ---- - @property - 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'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # typesrc - # ------- - @property - def typesrc(self): - """ - Sets the source reference on plot.ly for type . - - The 'typesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['typesrc'] - - @typesrc.setter - def typesrc(self, val): - self['typesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the final color of the gradient fill: the center - color for radial, the right for horizontal, or the - bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color . - type - Sets the type of gradient used to fill the markers - typesrc - Sets the source reference on plot.ly for type . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - type=None, - typesrc=None, - **kwargs - ): - """ - Construct a new Gradient object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter.marker.Gradient - color - Sets the final color of the gradient fill: the center - color for radial, the right for horizontal, or the - bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color . - type - Sets the type of gradient used to fill the markers - typesrc - Sets the source reference on plot.ly for type . - - Returns - ------- - Gradient - """ - super(Gradient, self).__init__('gradient') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.marker.Gradient -constructor must be a dict or -an instance of plotly.graph_objs.scatter.marker.Gradient""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter.marker import (gradient as v_gradient) - - # Initialize validators - # --------------------- - self._validators['color'] = v_gradient.ColorValidator() - self._validators['colorsrc'] = v_gradient.ColorsrcValidator() - self._validators['type'] = v_gradient.TypeValidator() - self._validators['typesrc'] = v_gradient.TypesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('typesrc', None) - self['typesrc'] = typesrc if typesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/marker/_line.py b/plotly/graph_objs/scatter/marker/_line.py deleted file mode 100644 index b8634129508..00000000000 --- a/plotly/graph_objs/scatter/marker/_line.py +++ /dev/null @@ -1,572 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is true, the - default palette will be chosen according to whether numbers in - the `color` array are all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.line.color`) or the - bounds set in `marker.line.cmin` and `marker.line.cmax` Has an - 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) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be equidistant - to this point. Has an effect only if in `marker.line.color`is - 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 - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarker.linecolor. It accepts either a specific color or - an array of numbers that are mapped to the colorscale relative - to the max and min values of the array or relative to - `marker.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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scatter.marker.line.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized value - to an rgb, rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and highest (1) values - are required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the colorscale in - color space, use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.line.color`is set to a numerical array. If true, - `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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorscale=None, - colorsrc=None, - reversescale=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.marker.Line - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.marker.Line -constructor must be a dict or -an instance of plotly.graph_objs.scatter.marker.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter.marker import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() - self._validators['cauto'] = v_line.CautoValidator() - self._validators['cmax'] = v_line.CmaxValidator() - self._validators['cmid'] = v_line.CmidValidator() - self._validators['cmin'] = v_line.CminValidator() - self._validators['color'] = v_line.ColorValidator() - self._validators['colorscale'] = v_line.ColorscaleValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['reversescale'] = v_line.ReversescaleValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/marker/colorbar/__init__.py b/plotly/graph_objs/scatter/marker/colorbar/__init__.py index 02e7f940c04..95378c14472 100644 --- a/plotly/graph_objs/scatter/marker/colorbar/__init__.py +++ b/plotly/graph_objs/scatter/marker/colorbar/__init__.py @@ -1,4 +1,725 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scatter.marker.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatter.marker.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.marker.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.scatter.marker.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter.marker.colorbar import ( + title as v_title + ) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter.marker.colorba + r.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.scatter.marker.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter.marker.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatter.marker.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.marker.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.scatter.marker.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter.marker.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scatter.marker.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/scatter/marker/colorbar/_tickfont.py b/plotly/graph_objs/scatter/marker/colorbar/_tickfont.py deleted file mode 100644 index 7358fb05654..00000000000 --- a/plotly/graph_objs/scatter/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter.marker.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.marker.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.scatter.marker.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter.marker.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py deleted file mode 100644 index ad1e618d346..00000000000 --- a/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter.marker.colorba - r.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.marker.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.scatter.marker.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter.marker.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/marker/colorbar/_title.py b/plotly/graph_objs/scatter/marker/colorbar/_title.py deleted file mode 100644 index bbca881ce08..00000000000 --- a/plotly/graph_objs/scatter/marker/colorbar/_title.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scatter.marker.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter.marker.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.marker.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.scatter.marker.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter.marker.colorbar import ( - title as v_title - ) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/marker/colorbar/title/__init__.py b/plotly/graph_objs/scatter/marker/colorbar/title/__init__.py index c37b8b5cd28..164279a4d87 100644 --- a/plotly/graph_objs/scatter/marker/colorbar/title/__init__.py +++ b/plotly/graph_objs/scatter/marker/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter.marker.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatter.marker.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.marker.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.scatter.marker.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter.marker.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/marker/colorbar/title/_font.py b/plotly/graph_objs/scatter/marker/colorbar/title/_font.py deleted file mode 100644 index 0f926398b51..00000000000 --- a/plotly/graph_objs/scatter/marker/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter.marker.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter.marker.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.marker.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.scatter.marker.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter.marker.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/selected/__init__.py b/plotly/graph_objs/scatter/selected/__init__.py index adba53218ca..a4d60b1b811 100644 --- a/plotly/graph_objs/scatter/selected/__init__.py +++ b/plotly/graph_objs/scatter/selected/__init__.py @@ -1,2 +1,338 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatter.selected.Textfont + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.selected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scatter.selected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter.selected import (textfont as v_textfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatter.selected.Marker + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.selected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scatter.selected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter.selected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/selected/_marker.py b/plotly/graph_objs/scatter/selected/_marker.py deleted file mode 100644 index cb2fdbeb087..00000000000 --- a/plotly/graph_objs/scatter/selected/_marker.py +++ /dev/null @@ -1,195 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter.selected.Marker - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.selected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scatter.selected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter.selected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/selected/_textfont.py b/plotly/graph_objs/scatter/selected/_textfont.py deleted file mode 100644 index 0ddfc04c045..00000000000 --- a/plotly/graph_objs/scatter/selected/_textfont.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of selected points. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter.selected.Textfont - color - Sets the text font color of selected points. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.selected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scatter.selected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter.selected import (textfont as v_textfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/unselected/__init__.py b/plotly/graph_objs/scatter/unselected/__init__.py index adba53218ca..364f7f58881 100644 --- a/plotly/graph_objs/scatter/unselected/__init__.py +++ b/plotly/graph_objs/scatter/unselected/__init__.py @@ -1,2 +1,352 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatter.unselected.Textfont + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.unselected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scatter.unselected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter.unselected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatter.unselected.Marker + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter.unselected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scatter.unselected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter.unselected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/unselected/_marker.py b/plotly/graph_objs/scatter/unselected/_marker.py deleted file mode 100644 index 50eb7da2414..00000000000 --- a/plotly/graph_objs/scatter/unselected/_marker.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter.unselected.Marker - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.unselected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scatter.unselected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter.unselected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter/unselected/_textfont.py b/plotly/graph_objs/scatter/unselected/_textfont.py deleted file mode 100644 index 9f38a14e56a..00000000000 --- a/plotly/graph_objs/scatter/unselected/_textfont.py +++ /dev/null @@ -1,144 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of unselected points, applied - only when a selection exists. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter.unselected.Textfont - color - Sets the text font color of unselected points, applied - only when a selection exists. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter.unselected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scatter.unselected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter.unselected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/__init__.py b/plotly/graph_objs/scatter3d/__init__.py index d4e7a5481ca..42e7bc8ce31 100644 --- a/plotly/graph_objs/scatter3d/__init__.py +++ b/plotly/graph_objs/scatter3d/__init__.py @@ -1,12 +1,4568 @@ -from ._textfont import Textfont -from ._stream import Stream -from ._projection import Projection + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter3d.Textfont + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d import (textfont as v_textfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + self._validators['colorsrc'] = v_textfont.ColorsrcValidator() + self._validators['family'] = v_textfont.FamilyValidator() + self._validators['size'] = v_textfont.SizeValidator() + self._validators['sizesrc'] = v_textfont.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter3d.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.Stream +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Projection(_BaseTraceHierarchyType): + + # x + # - + @property + def x(self): + """ + The 'x' property is an instance of X + that may be specified as: + - An instance of 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 + Sets the scale factor determining the size of + the projection marker points. + show + Sets whether or not projections are shown along + the x axis. + + Returns + ------- + plotly.graph_objs.scatter3d.projection.X + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @property + def y(self): + """ + The 'y' property is an instance of Y + that may be specified as: + - An instance of 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 + Sets the scale factor determining the size of + the projection marker points. + show + Sets whether or not projections are shown along + the y axis. + + Returns + ------- + plotly.graph_objs.scatter3d.projection.Y + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # z + # - + @property + def z(self): + """ + The 'z' property is an instance of Z + that may be specified as: + - An instance of 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 + Sets the scale factor determining the size of + the projection marker points. + show + Sets whether or not projections are shown along + the z axis. + + Returns + ------- + plotly.graph_objs.scatter3d.projection.Z + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + plotly.graph_objs.scatter3d.projection.X instance or + dict with compatible properties + y + plotly.graph_objs.scatter3d.projection.Y instance or + dict with compatible properties + z + plotly.graph_objs.scatter3d.projection.Z instance or + dict with compatible properties + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Projection object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter3d.Projection + x + plotly.graph_objs.scatter3d.projection.X instance or + dict with compatible properties + y + plotly.graph_objs.scatter3d.projection.Y instance or + dict with compatible properties + z + plotly.graph_objs.scatter3d.projection.Z instance or + dict with compatible properties + + Returns + ------- + Projection + """ + super(Projection, self).__init__('projection') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.Projection +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.Projection""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d import (projection as v_projection) + + # Initialize validators + # --------------------- + self._validators['x'] = v_projection.XValidator() + self._validators['y'] = v_projection.YValidator() + self._validators['z'] = v_projection.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color`is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` array are + all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmin` + must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmax` + must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarkercolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scatter3d.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of 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 + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scatter3d.marker.colorbar.Tic + kformatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scatter3d.marker.colorbar.tickformatstopdefau + lts), sets the default property values to use + for elements of + scatter3d.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatter3d.marker.colorbar.Tit + le instance or dict with compatible properties + titlefont + Deprecated: Please use + scatter3d.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. + titleside + Deprecated: Please use + scatter3d.marker.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.scatter3d.marker.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color`is + set to a numerical array. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At minimum, a mapping for + the lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Greys,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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + + Returns + ------- + plotly.graph_objs.scatter3d.marker.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # opacity + # ------- + @property + def opacity(self): + """ + Sets the marker opacity. Note that the marker opacity for + scatter3d traces must be a scalar value for performance + reasons. To set a blending opacity value (i.e. which is not + transparent), set "marker.color" to an rgba color and use its + alpha channel. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color`is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # size + # ---- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizemin + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['sizemin'] + + @sizemin.setter + def sizemin(self, val): + self['sizemin'] = val + + # sizemode + # -------- + @property + 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'] + + Returns + ------- + Any + """ + return self['sizemode'] + + @sizemode.setter + def sizemode(self, val): + self['sizemode'] = val + + # sizeref + # ------- + @property + 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 + + Returns + ------- + int|float + """ + return self['sizeref'] + + @sizeref.setter + def sizeref(self, val): + self['sizeref'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # symbol + # ------ + @property + 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', + 'diamond', 'diamond-open', 'cross', 'x'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['symbol'] + + @symbol.setter + def symbol(self, val): + self['symbol'] = val + + # symbolsrc + # --------- + @property + def symbolsrc(self): + """ + Sets the source reference on plot.ly for symbol . + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['symbolsrc'] + + @symbolsrc.setter + def symbolsrc(self, val): + self['symbolsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scatter3d.marker.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + line + plotly.graph_objs.scatter3d.marker.Line instance or + dict with compatible properties + opacity + Sets the marker opacity. Note that the marker opacity + for scatter3d traces must be a scalar value for + performance reasons. To set a blending opacity value + (i.e. which is not transparent), set "marker.color" to + an rgba color and use its alpha channel. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. + symbolsrc + Sets the source reference on plot.ly for symbol . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorbar=None, + colorscale=None, + colorsrc=None, + line=None, + opacity=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter3d.Marker + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scatter3d.marker.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + line + plotly.graph_objs.scatter3d.marker.Line instance or + dict with compatible properties + opacity + Sets the marker opacity. Note that the marker opacity + for scatter3d traces must be a scalar value for + performance reasons. To set a blending opacity value + (i.e. which is not transparent), set "marker.color" to + an rgba color and use its alpha channel. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. + symbolsrc + Sets the source reference on plot.ly for symbol . + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() + self._validators['cauto'] = v_marker.CautoValidator() + self._validators['cmax'] = v_marker.CmaxValidator() + self._validators['cmid'] = v_marker.CmidValidator() + self._validators['cmin'] = v_marker.CminValidator() + self._validators['color'] = v_marker.ColorValidator() + self._validators['colorbar'] = v_marker.ColorBarValidator() + self._validators['colorscale'] = v_marker.ColorscaleValidator() + self._validators['colorsrc'] = v_marker.ColorsrcValidator() + self._validators['line'] = v_marker.LineValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['reversescale'] = v_marker.ReversescaleValidator() + self._validators['showscale'] = v_marker.ShowscaleValidator() + self._validators['size'] = v_marker.SizeValidator() + self._validators['sizemin'] = v_marker.SizeminValidator() + self._validators['sizemode'] = v_marker.SizemodeValidator() + self._validators['sizeref'] = v_marker.SizerefValidator() + self._validators['sizesrc'] = v_marker.SizesrcValidator() + self._validators['symbol'] = v_marker.SymbolValidator() + self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizemin', None) + self['sizemin'] = sizemin if sizemin is not None else _v + _v = arg.pop('sizemode', None) + self['sizemode'] = sizemode if sizemode is not None else _v + _v = arg.pop('sizeref', None) + self['sizeref'] = sizeref if sizeref is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + _v = arg.pop('symbol', None) + self['symbol'] = symbol if symbol is not None else _v + _v = arg.pop('symbolsrc', None) + self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in `line.color`is set + to a numerical array. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `line.color`) or the bounds + set in `line.cmin` and `line.cmax` Has an effect only if in + `line.color`is set to a numerical array. Defaults to `false` + when `line.cmin` and `line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `line.color`is set to a numerical array. Value should have + the same units as in `line.color` and if set, `line.cmin` must + be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `line.cmin` + and/or `line.cmax` to be equidistant to this point. Has an + effect only if in `line.color`is set to a numerical array. + Value should have the same units as in `line.color`. Has no + effect when `line.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `line.color`is set to a numerical array. Value should have + the same units as in `line.color` and if set, `line.cmax` must + be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets thelinecolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to `line.cmin` + and `line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scatter3d.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `line.color`is + set to a numerical array. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At minimum, a mapping for + the lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, + use`line.cmin` and `line.cmax`. Alternatively, `colorscale` may + be a palette name string of the following list: Greys,YlGnBu,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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # dash + # ---- + @property + 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', + 'longdashdot'] + + Returns + ------- + Any + """ + return self['dash'] + + @dash.setter + def dash(self, val): + self['dash'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `line.color`is set to a numerical array. If true, `line.cmin` + will correspond to the last color in the array and `line.cmax` + will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in + `line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `line.color`) + or the bounds set in `line.cmin` and `line.cmax` Has + an effect only if in `line.color`is set to a numerical + array. Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `line.color`is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `line.cmin` and/or `line.cmax` to be equidistant to + this point. Has an effect only if in `line.color`is set + to a numerical array. Value should have the same units + as in `line.color`. Has no effect when `line.cauto` is + `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `line.color`is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmax` must be set as well. + color + Sets thelinecolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `line.cmin` and `line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named color + string. At minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, `[[0, + 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`line.cmin` + and `line.cmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,P + ortland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividi + s. + colorsrc + Sets the source reference on plot.ly for color . + dash + Sets the dash style of the lines. + reversescale + Reverses the color mapping if true. Has an effect only + if in `line.color`is set to a numerical array. If true, + `line.cmin` will correspond to the last color in the + array and `line.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `line.color`is set + to a numerical array. + width + Sets the line width (in px). + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorscale=None, + colorsrc=None, + dash=None, + reversescale=None, + showscale=None, + width=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter3d.Line + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in + `line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `line.color`) + or the bounds set in `line.cmin` and `line.cmax` Has + an effect only if in `line.color`is set to a numerical + array. Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `line.color`is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `line.cmin` and/or `line.cmax` to be equidistant to + this point. Has an effect only if in `line.color`is set + to a numerical array. Value should have the same units + as in `line.color`. Has no effect when `line.cauto` is + `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `line.color`is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmax` must be set as well. + color + Sets thelinecolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `line.cmin` and `line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named color + string. At minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, `[[0, + 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use`line.cmin` + and `line.cmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,P + ortland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividi + s. + colorsrc + Sets the source reference on plot.ly for color . + dash + Sets the dash style of the lines. + reversescale + Reverses the color mapping if true. Has an effect only + if in `line.color`is set to a numerical array. If true, + `line.cmin` will correspond to the last color in the + array and `line.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `line.color`is set + to a numerical array. + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.Line +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() + self._validators['cauto'] = v_line.CautoValidator() + self._validators['cmax'] = v_line.CmaxValidator() + self._validators['cmid'] = v_line.CmidValidator() + self._validators['cmin'] = v_line.CminValidator() + self._validators['color'] = v_line.ColorValidator() + self._validators['colorscale'] = v_line.ColorscaleValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['dash'] = v_line.DashValidator() + self._validators['reversescale'] = v_line.ReversescaleValidator() + self._validators['showscale'] = v_line.ShowscaleValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('dash', None) + self['dash'] = dash if dash is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scatter3d.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter3d.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorZ(_BaseTraceHierarchyType): + + # array + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['array'] + + @array.setter + def array(self, val): + self['array'] = val + + # arrayminus + # ---------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['arrayminus'] + + @arrayminus.setter + def arrayminus(self, val): + self['arrayminus'] = val + + # arrayminussrc + # ------------- + @property + def arrayminussrc(self): + """ + Sets the source reference on plot.ly for arrayminus . + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arrayminussrc'] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self['arrayminussrc'] = val + + # arraysrc + # -------- + @property + def arraysrc(self): + """ + Sets the source reference on plot.ly for array . + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arraysrc'] + + @arraysrc.setter + def arraysrc(self, val): + self['arraysrc'] = val + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # symmetric + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['symmetric'] + + @symmetric.setter + def symmetric(self, val): + self['symmetric'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # traceref + # -------- + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['traceref'] + + @traceref.setter + def traceref(self, val): + self['traceref'] = val + + # tracerefminus + # ------------- + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['tracerefminus'] + + @tracerefminus.setter + def tracerefminus(self, val): + self['tracerefminus'] = val + + # type + # ---- + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the sqaure of + the underlying data. If "array", 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # value + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # valueminus + # ---------- + @property + def valueminus(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 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] + + Returns + ------- + int|float + """ + return self['valueminus'] + + @valueminus.setter + def valueminus(self, val): + self['valueminus'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs + ): + """ + Construct a new ErrorZ object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter3d.ErrorZ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorZ + """ + super(ErrorZ, self).__init__('error_z') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.ErrorZ +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.ErrorZ""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d import (error_z as v_error_z) + + # Initialize validators + # --------------------- + self._validators['array'] = v_error_z.ArrayValidator() + self._validators['arrayminus'] = v_error_z.ArrayminusValidator() + self._validators['arrayminussrc'] = v_error_z.ArrayminussrcValidator() + self._validators['arraysrc'] = v_error_z.ArraysrcValidator() + self._validators['color'] = v_error_z.ColorValidator() + self._validators['symmetric'] = v_error_z.SymmetricValidator() + self._validators['thickness'] = v_error_z.ThicknessValidator() + self._validators['traceref'] = v_error_z.TracerefValidator() + self._validators['tracerefminus'] = v_error_z.TracerefminusValidator() + self._validators['type'] = v_error_z.TypeValidator() + self._validators['value'] = v_error_z.ValueValidator() + self._validators['valueminus'] = v_error_z.ValueminusValidator() + self._validators['visible'] = v_error_z.VisibleValidator() + self._validators['width'] = v_error_z.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('array', None) + self['array'] = array if array is not None else _v + _v = arg.pop('arrayminus', None) + self['arrayminus'] = arrayminus if arrayminus is not None else _v + _v = arg.pop('arrayminussrc', None) + self['arrayminussrc' + ] = arrayminussrc if arrayminussrc is not None else _v + _v = arg.pop('arraysrc', None) + self['arraysrc'] = arraysrc if arraysrc is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('symmetric', None) + self['symmetric'] = symmetric if symmetric is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('traceref', None) + self['traceref'] = traceref if traceref is not None else _v + _v = arg.pop('tracerefminus', None) + self['tracerefminus' + ] = tracerefminus if tracerefminus is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + _v = arg.pop('valueminus', None) + self['valueminus'] = valueminus if valueminus is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorY(_BaseTraceHierarchyType): + + # array + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['array'] + + @array.setter + def array(self, val): + self['array'] = val + + # arrayminus + # ---------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['arrayminus'] + + @arrayminus.setter + def arrayminus(self, val): + self['arrayminus'] = val + + # arrayminussrc + # ------------- + @property + def arrayminussrc(self): + """ + Sets the source reference on plot.ly for arrayminus . + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arrayminussrc'] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self['arrayminussrc'] = val + + # arraysrc + # -------- + @property + def arraysrc(self): + """ + Sets the source reference on plot.ly for array . + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arraysrc'] + + @arraysrc.setter + def arraysrc(self, val): + self['arraysrc'] = val + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # copy_zstyle + # ----------- + @property + def copy_zstyle(self): + """ + The 'copy_zstyle' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['copy_zstyle'] + + @copy_zstyle.setter + def copy_zstyle(self, val): + self['copy_zstyle'] = val + + # symmetric + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['symmetric'] + + @symmetric.setter + def symmetric(self, val): + self['symmetric'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # traceref + # -------- + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['traceref'] + + @traceref.setter + def traceref(self, val): + self['traceref'] = val + + # tracerefminus + # ------------- + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['tracerefminus'] + + @tracerefminus.setter + def tracerefminus(self, val): + self['tracerefminus'] = val + + # type + # ---- + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the sqaure of + the underlying data. If "array", 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # value + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # valueminus + # ---------- + @property + def valueminus(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 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] + + Returns + ------- + int|float + """ + return self['valueminus'] + + @valueminus.setter + def valueminus(self, val): + self['valueminus'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + copy_zstyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + copy_zstyle=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs + ): + """ + Construct a new ErrorY object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter3d.ErrorY + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + copy_zstyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorY + """ + super(ErrorY, self).__init__('error_y') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.ErrorY +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.ErrorY""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d import (error_y as v_error_y) + + # Initialize validators + # --------------------- + self._validators['array'] = v_error_y.ArrayValidator() + self._validators['arrayminus'] = v_error_y.ArrayminusValidator() + self._validators['arrayminussrc'] = v_error_y.ArrayminussrcValidator() + self._validators['arraysrc'] = v_error_y.ArraysrcValidator() + self._validators['color'] = v_error_y.ColorValidator() + self._validators['copy_zstyle'] = v_error_y.CopyZstyleValidator() + self._validators['symmetric'] = v_error_y.SymmetricValidator() + self._validators['thickness'] = v_error_y.ThicknessValidator() + self._validators['traceref'] = v_error_y.TracerefValidator() + self._validators['tracerefminus'] = v_error_y.TracerefminusValidator() + self._validators['type'] = v_error_y.TypeValidator() + self._validators['value'] = v_error_y.ValueValidator() + self._validators['valueminus'] = v_error_y.ValueminusValidator() + self._validators['visible'] = v_error_y.VisibleValidator() + self._validators['width'] = v_error_y.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('array', None) + self['array'] = array if array is not None else _v + _v = arg.pop('arrayminus', None) + self['arrayminus'] = arrayminus if arrayminus is not None else _v + _v = arg.pop('arrayminussrc', None) + self['arrayminussrc' + ] = arrayminussrc if arrayminussrc is not None else _v + _v = arg.pop('arraysrc', None) + self['arraysrc'] = arraysrc if arraysrc is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('copy_zstyle', None) + self['copy_zstyle'] = copy_zstyle if copy_zstyle is not None else _v + _v = arg.pop('symmetric', None) + self['symmetric'] = symmetric if symmetric is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('traceref', None) + self['traceref'] = traceref if traceref is not None else _v + _v = arg.pop('tracerefminus', None) + self['tracerefminus' + ] = tracerefminus if tracerefminus is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + _v = arg.pop('valueminus', None) + self['valueminus'] = valueminus if valueminus is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorX(_BaseTraceHierarchyType): + + # array + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['array'] + + @array.setter + def array(self, val): + self['array'] = val + + # arrayminus + # ---------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['arrayminus'] + + @arrayminus.setter + def arrayminus(self, val): + self['arrayminus'] = val + + # arrayminussrc + # ------------- + @property + def arrayminussrc(self): + """ + Sets the source reference on plot.ly for arrayminus . + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arrayminussrc'] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self['arrayminussrc'] = val + + # arraysrc + # -------- + @property + def arraysrc(self): + """ + Sets the source reference on plot.ly for array . + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arraysrc'] + + @arraysrc.setter + def arraysrc(self, val): + self['arraysrc'] = val + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # copy_zstyle + # ----------- + @property + def copy_zstyle(self): + """ + The 'copy_zstyle' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['copy_zstyle'] + + @copy_zstyle.setter + def copy_zstyle(self, val): + self['copy_zstyle'] = val + + # symmetric + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['symmetric'] + + @symmetric.setter + def symmetric(self, val): + self['symmetric'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # traceref + # -------- + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['traceref'] + + @traceref.setter + def traceref(self, val): + self['traceref'] = val + + # tracerefminus + # ------------- + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['tracerefminus'] + + @tracerefminus.setter + def tracerefminus(self, val): + self['tracerefminus'] = val + + # type + # ---- + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the sqaure of + the underlying data. If "array", 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # value + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # valueminus + # ---------- + @property + def valueminus(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 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] + + Returns + ------- + int|float + """ + return self['valueminus'] + + @valueminus.setter + def valueminus(self, val): + self['valueminus'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + copy_zstyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + copy_zstyle=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs + ): + """ + Construct a new ErrorX object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter3d.ErrorX + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + copy_zstyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorX + """ + super(ErrorX, self).__init__('error_x') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.ErrorX +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.ErrorX""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d import (error_x as v_error_x) + + # Initialize validators + # --------------------- + self._validators['array'] = v_error_x.ArrayValidator() + self._validators['arrayminus'] = v_error_x.ArrayminusValidator() + self._validators['arrayminussrc'] = v_error_x.ArrayminussrcValidator() + self._validators['arraysrc'] = v_error_x.ArraysrcValidator() + self._validators['color'] = v_error_x.ColorValidator() + self._validators['copy_zstyle'] = v_error_x.CopyZstyleValidator() + self._validators['symmetric'] = v_error_x.SymmetricValidator() + self._validators['thickness'] = v_error_x.ThicknessValidator() + self._validators['traceref'] = v_error_x.TracerefValidator() + self._validators['tracerefminus'] = v_error_x.TracerefminusValidator() + self._validators['type'] = v_error_x.TypeValidator() + self._validators['value'] = v_error_x.ValueValidator() + self._validators['valueminus'] = v_error_x.ValueminusValidator() + self._validators['visible'] = v_error_x.VisibleValidator() + self._validators['width'] = v_error_x.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('array', None) + self['array'] = array if array is not None else _v + _v = arg.pop('arrayminus', None) + self['arrayminus'] = arrayminus if arrayminus is not None else _v + _v = arg.pop('arrayminussrc', None) + self['arrayminussrc' + ] = arrayminussrc if arrayminussrc is not None else _v + _v = arg.pop('arraysrc', None) + self['arraysrc'] = arraysrc if arraysrc is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('copy_zstyle', None) + self['copy_zstyle'] = copy_zstyle if copy_zstyle is not None else _v + _v = arg.pop('symmetric', None) + self['symmetric'] = symmetric if symmetric is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('traceref', None) + self['traceref'] = traceref if traceref is not None else _v + _v = arg.pop('tracerefminus', None) + self['tracerefminus' + ] = tracerefminus if tracerefminus is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + _v = arg.pop('valueminus', None) + self['valueminus'] = valueminus if valueminus is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scatter3d import projection -from ._marker import Marker from plotly.graph_objs.scatter3d import marker -from ._line import Line -from ._hoverlabel import Hoverlabel from plotly.graph_objs.scatter3d import hoverlabel -from ._error_z import ErrorZ -from ._error_y import ErrorY -from ._error_x import ErrorX diff --git a/plotly/graph_objs/scatter3d/_error_x.py b/plotly/graph_objs/scatter3d/_error_x.py deleted file mode 100644 index c1f7cf8e8a5..00000000000 --- a/plotly/graph_objs/scatter3d/_error_x.py +++ /dev/null @@ -1,597 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ErrorX(BaseTraceHierarchyType): - - # array - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['array'] - - @array.setter - def array(self, val): - self['array'] = val - - # arrayminus - # ---------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['arrayminus'] - - @arrayminus.setter - def arrayminus(self, val): - self['arrayminus'] = val - - # arrayminussrc - # ------------- - @property - def arrayminussrc(self): - """ - Sets the source reference on plot.ly for arrayminus . - - The 'arrayminussrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arrayminussrc'] - - @arrayminussrc.setter - def arrayminussrc(self, val): - self['arrayminussrc'] = val - - # arraysrc - # -------- - @property - def arraysrc(self): - """ - Sets the source reference on plot.ly for array . - - The 'arraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arraysrc'] - - @arraysrc.setter - def arraysrc(self, val): - self['arraysrc'] = val - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # copy_zstyle - # ----------- - @property - def copy_zstyle(self): - """ - The 'copy_zstyle' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['copy_zstyle'] - - @copy_zstyle.setter - def copy_zstyle(self, val): - self['copy_zstyle'] = val - - # symmetric - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['symmetric'] - - @symmetric.setter - def symmetric(self, val): - self['symmetric'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # traceref - # -------- - @property - def traceref(self): - """ - The 'traceref' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['traceref'] - - @traceref.setter - def traceref(self, val): - self['traceref'] = val - - # tracerefminus - # ------------- - @property - def tracerefminus(self): - """ - The 'tracerefminus' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['tracerefminus'] - - @tracerefminus.setter - def tracerefminus(self, val): - self['tracerefminus'] = val - - # type - # ---- - @property - def type(self): - """ - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. Set this - constant in `value`. If "percent", the bar lengths correspond - to a percentage of underlying data. Set this percentage in - `value`. If "sqrt", the bar lengths correspond to the sqaure of - the underlying data. If "array", 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # value - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # valueminus - # ---------- - @property - def valueminus(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 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] - - Returns - ------- - int|float - """ - return self['valueminus'] - - @valueminus.setter - def valueminus(self, val): - self['valueminus'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - copy_zstyle - - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - """ - - def __init__( - self, - arg=None, - array=None, - arrayminus=None, - arrayminussrc=None, - arraysrc=None, - color=None, - copy_zstyle=None, - symmetric=None, - thickness=None, - traceref=None, - tracerefminus=None, - type=None, - value=None, - valueminus=None, - visible=None, - width=None, - **kwargs - ): - """ - Construct a new ErrorX object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.ErrorX - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - copy_zstyle - - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - - Returns - ------- - ErrorX - """ - super(ErrorX, self).__init__('error_x') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.ErrorX -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.ErrorX""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d import (error_x as v_error_x) - - # Initialize validators - # --------------------- - self._validators['array'] = v_error_x.ArrayValidator() - self._validators['arrayminus'] = v_error_x.ArrayminusValidator() - self._validators['arrayminussrc'] = v_error_x.ArrayminussrcValidator() - self._validators['arraysrc'] = v_error_x.ArraysrcValidator() - self._validators['color'] = v_error_x.ColorValidator() - self._validators['copy_zstyle'] = v_error_x.CopyZstyleValidator() - self._validators['symmetric'] = v_error_x.SymmetricValidator() - self._validators['thickness'] = v_error_x.ThicknessValidator() - self._validators['traceref'] = v_error_x.TracerefValidator() - self._validators['tracerefminus'] = v_error_x.TracerefminusValidator() - self._validators['type'] = v_error_x.TypeValidator() - self._validators['value'] = v_error_x.ValueValidator() - self._validators['valueminus'] = v_error_x.ValueminusValidator() - self._validators['visible'] = v_error_x.VisibleValidator() - self._validators['width'] = v_error_x.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('array', None) - self['array'] = array if array is not None else _v - _v = arg.pop('arrayminus', None) - self['arrayminus'] = arrayminus if arrayminus is not None else _v - _v = arg.pop('arrayminussrc', None) - self['arrayminussrc' - ] = arrayminussrc if arrayminussrc is not None else _v - _v = arg.pop('arraysrc', None) - self['arraysrc'] = arraysrc if arraysrc is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('copy_zstyle', None) - self['copy_zstyle'] = copy_zstyle if copy_zstyle is not None else _v - _v = arg.pop('symmetric', None) - self['symmetric'] = symmetric if symmetric is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('traceref', None) - self['traceref'] = traceref if traceref is not None else _v - _v = arg.pop('tracerefminus', None) - self['tracerefminus' - ] = tracerefminus if tracerefminus is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - _v = arg.pop('valueminus', None) - self['valueminus'] = valueminus if valueminus is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/_error_y.py b/plotly/graph_objs/scatter3d/_error_y.py deleted file mode 100644 index c295ecb6bdc..00000000000 --- a/plotly/graph_objs/scatter3d/_error_y.py +++ /dev/null @@ -1,597 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ErrorY(BaseTraceHierarchyType): - - # array - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['array'] - - @array.setter - def array(self, val): - self['array'] = val - - # arrayminus - # ---------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['arrayminus'] - - @arrayminus.setter - def arrayminus(self, val): - self['arrayminus'] = val - - # arrayminussrc - # ------------- - @property - def arrayminussrc(self): - """ - Sets the source reference on plot.ly for arrayminus . - - The 'arrayminussrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arrayminussrc'] - - @arrayminussrc.setter - def arrayminussrc(self, val): - self['arrayminussrc'] = val - - # arraysrc - # -------- - @property - def arraysrc(self): - """ - Sets the source reference on plot.ly for array . - - The 'arraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arraysrc'] - - @arraysrc.setter - def arraysrc(self, val): - self['arraysrc'] = val - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # copy_zstyle - # ----------- - @property - def copy_zstyle(self): - """ - The 'copy_zstyle' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['copy_zstyle'] - - @copy_zstyle.setter - def copy_zstyle(self, val): - self['copy_zstyle'] = val - - # symmetric - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['symmetric'] - - @symmetric.setter - def symmetric(self, val): - self['symmetric'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # traceref - # -------- - @property - def traceref(self): - """ - The 'traceref' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['traceref'] - - @traceref.setter - def traceref(self, val): - self['traceref'] = val - - # tracerefminus - # ------------- - @property - def tracerefminus(self): - """ - The 'tracerefminus' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['tracerefminus'] - - @tracerefminus.setter - def tracerefminus(self, val): - self['tracerefminus'] = val - - # type - # ---- - @property - def type(self): - """ - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. Set this - constant in `value`. If "percent", the bar lengths correspond - to a percentage of underlying data. Set this percentage in - `value`. If "sqrt", the bar lengths correspond to the sqaure of - the underlying data. If "array", 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # value - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # valueminus - # ---------- - @property - def valueminus(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 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] - - Returns - ------- - int|float - """ - return self['valueminus'] - - @valueminus.setter - def valueminus(self, val): - self['valueminus'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - copy_zstyle - - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - """ - - def __init__( - self, - arg=None, - array=None, - arrayminus=None, - arrayminussrc=None, - arraysrc=None, - color=None, - copy_zstyle=None, - symmetric=None, - thickness=None, - traceref=None, - tracerefminus=None, - type=None, - value=None, - valueminus=None, - visible=None, - width=None, - **kwargs - ): - """ - Construct a new ErrorY object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.ErrorY - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - copy_zstyle - - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - - Returns - ------- - ErrorY - """ - super(ErrorY, self).__init__('error_y') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.ErrorY -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.ErrorY""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d import (error_y as v_error_y) - - # Initialize validators - # --------------------- - self._validators['array'] = v_error_y.ArrayValidator() - self._validators['arrayminus'] = v_error_y.ArrayminusValidator() - self._validators['arrayminussrc'] = v_error_y.ArrayminussrcValidator() - self._validators['arraysrc'] = v_error_y.ArraysrcValidator() - self._validators['color'] = v_error_y.ColorValidator() - self._validators['copy_zstyle'] = v_error_y.CopyZstyleValidator() - self._validators['symmetric'] = v_error_y.SymmetricValidator() - self._validators['thickness'] = v_error_y.ThicknessValidator() - self._validators['traceref'] = v_error_y.TracerefValidator() - self._validators['tracerefminus'] = v_error_y.TracerefminusValidator() - self._validators['type'] = v_error_y.TypeValidator() - self._validators['value'] = v_error_y.ValueValidator() - self._validators['valueminus'] = v_error_y.ValueminusValidator() - self._validators['visible'] = v_error_y.VisibleValidator() - self._validators['width'] = v_error_y.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('array', None) - self['array'] = array if array is not None else _v - _v = arg.pop('arrayminus', None) - self['arrayminus'] = arrayminus if arrayminus is not None else _v - _v = arg.pop('arrayminussrc', None) - self['arrayminussrc' - ] = arrayminussrc if arrayminussrc is not None else _v - _v = arg.pop('arraysrc', None) - self['arraysrc'] = arraysrc if arraysrc is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('copy_zstyle', None) - self['copy_zstyle'] = copy_zstyle if copy_zstyle is not None else _v - _v = arg.pop('symmetric', None) - self['symmetric'] = symmetric if symmetric is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('traceref', None) - self['traceref'] = traceref if traceref is not None else _v - _v = arg.pop('tracerefminus', None) - self['tracerefminus' - ] = tracerefminus if tracerefminus is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - _v = arg.pop('valueminus', None) - self['valueminus'] = valueminus if valueminus is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/_error_z.py b/plotly/graph_objs/scatter3d/_error_z.py deleted file mode 100644 index 5027ff1570f..00000000000 --- a/plotly/graph_objs/scatter3d/_error_z.py +++ /dev/null @@ -1,571 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ErrorZ(BaseTraceHierarchyType): - - # array - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['array'] - - @array.setter - def array(self, val): - self['array'] = val - - # arrayminus - # ---------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['arrayminus'] - - @arrayminus.setter - def arrayminus(self, val): - self['arrayminus'] = val - - # arrayminussrc - # ------------- - @property - def arrayminussrc(self): - """ - Sets the source reference on plot.ly for arrayminus . - - The 'arrayminussrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arrayminussrc'] - - @arrayminussrc.setter - def arrayminussrc(self, val): - self['arrayminussrc'] = val - - # arraysrc - # -------- - @property - def arraysrc(self): - """ - Sets the source reference on plot.ly for array . - - The 'arraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arraysrc'] - - @arraysrc.setter - def arraysrc(self, val): - self['arraysrc'] = val - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # symmetric - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['symmetric'] - - @symmetric.setter - def symmetric(self, val): - self['symmetric'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # traceref - # -------- - @property - def traceref(self): - """ - The 'traceref' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['traceref'] - - @traceref.setter - def traceref(self, val): - self['traceref'] = val - - # tracerefminus - # ------------- - @property - def tracerefminus(self): - """ - The 'tracerefminus' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['tracerefminus'] - - @tracerefminus.setter - def tracerefminus(self, val): - self['tracerefminus'] = val - - # type - # ---- - @property - def type(self): - """ - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. Set this - constant in `value`. If "percent", the bar lengths correspond - to a percentage of underlying data. Set this percentage in - `value`. If "sqrt", the bar lengths correspond to the sqaure of - the underlying data. If "array", 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # value - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # valueminus - # ---------- - @property - def valueminus(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 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] - - Returns - ------- - int|float - """ - return self['valueminus'] - - @valueminus.setter - def valueminus(self, val): - self['valueminus'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - """ - - def __init__( - self, - arg=None, - array=None, - arrayminus=None, - arrayminussrc=None, - arraysrc=None, - color=None, - symmetric=None, - thickness=None, - traceref=None, - tracerefminus=None, - type=None, - value=None, - valueminus=None, - visible=None, - width=None, - **kwargs - ): - """ - Construct a new ErrorZ object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.ErrorZ - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - - Returns - ------- - ErrorZ - """ - super(ErrorZ, self).__init__('error_z') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.ErrorZ -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.ErrorZ""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d import (error_z as v_error_z) - - # Initialize validators - # --------------------- - self._validators['array'] = v_error_z.ArrayValidator() - self._validators['arrayminus'] = v_error_z.ArrayminusValidator() - self._validators['arrayminussrc'] = v_error_z.ArrayminussrcValidator() - self._validators['arraysrc'] = v_error_z.ArraysrcValidator() - self._validators['color'] = v_error_z.ColorValidator() - self._validators['symmetric'] = v_error_z.SymmetricValidator() - self._validators['thickness'] = v_error_z.ThicknessValidator() - self._validators['traceref'] = v_error_z.TracerefValidator() - self._validators['tracerefminus'] = v_error_z.TracerefminusValidator() - self._validators['type'] = v_error_z.TypeValidator() - self._validators['value'] = v_error_z.ValueValidator() - self._validators['valueminus'] = v_error_z.ValueminusValidator() - self._validators['visible'] = v_error_z.VisibleValidator() - self._validators['width'] = v_error_z.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('array', None) - self['array'] = array if array is not None else _v - _v = arg.pop('arrayminus', None) - self['arrayminus'] = arrayminus if arrayminus is not None else _v - _v = arg.pop('arrayminussrc', None) - self['arrayminussrc' - ] = arrayminussrc if arrayminussrc is not None else _v - _v = arg.pop('arraysrc', None) - self['arraysrc'] = arraysrc if arraysrc is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('symmetric', None) - self['symmetric'] = symmetric if symmetric is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('traceref', None) - self['traceref'] = traceref if traceref is not None else _v - _v = arg.pop('tracerefminus', None) - self['tracerefminus' - ] = tracerefminus if tracerefminus is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - _v = arg.pop('valueminus', None) - self['valueminus'] = valueminus if valueminus is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/_hoverlabel.py b/plotly/graph_objs/scatter3d/_hoverlabel.py deleted file mode 100644 index 9b94b473fce..00000000000 --- a/plotly/graph_objs/scatter3d/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scatter3d.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/_line.py b/plotly/graph_objs/scatter3d/_line.py deleted file mode 100644 index b96efcc61f6..00000000000 --- a/plotly/graph_objs/scatter3d/_line.py +++ /dev/null @@ -1,593 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `line.colorscale`. Has an effect only if in `line.color`is set - to a numerical array. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette will be chosen - according to whether numbers in the `color` array are all - positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `line.color`) or the bounds - set in `line.cmin` and `line.cmax` Has an effect only if in - `line.color`is set to a numerical array. Defaults to `false` - when `line.cmin` and `line.cmax` are set by the user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - in `line.color`is set to a numerical array. Value should have - the same units as in `line.color` and if set, `line.cmin` must - be set as well. - - The 'cmax' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling `line.cmin` - and/or `line.cmax` to be equidistant to this point. Has an - effect only if in `line.color`is set to a numerical array. - Value should have the same units as in `line.color`. Has no - effect when `line.cauto` is `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - in `line.color`is set to a numerical array. Value should have - the same units as in `line.color` and if set, `line.cmax` must - be set as well. - - The 'cmin' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets thelinecolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to `line.cmin` - and `line.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scatter3d.line.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in `line.color`is - set to a numerical array. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At minimum, a mapping for - the lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color space, - use`line.cmin` and `line.cmax`. Alternatively, `colorscale` may - be a palette name string of the following list: Greys,YlGnBu,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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # dash - # ---- - @property - 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', - 'longdashdot'] - - Returns - ------- - Any - """ - return self['dash'] - - @dash.setter - def dash(self, val): - self['dash'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `line.color`is set to a numerical array. If true, `line.cmin` - will correspond to the last color in the array and `line.cmax` - will correspond to the first color. - - The 'reversescale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `line.colorscale`. Has an effect only if in - `line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `line.color`) - or the bounds set in `line.cmin` and `line.cmax` Has - an effect only if in `line.color`is set to a numerical - array. Defaults to `false` when `line.cmin` and - `line.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `line.color`is set to a numerical array. - Value should have the same units as in `line.color` and - if set, `line.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `line.cmin` and/or `line.cmax` to be equidistant to - this point. Has an effect only if in `line.color`is set - to a numerical array. Value should have the same units - as in `line.color`. Has no effect when `line.cauto` is - `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `line.color`is set to a numerical array. - Value should have the same units as in `line.color` and - if set, `line.cmax` must be set as well. - color - Sets thelinecolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `line.cmin` and `line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named color - string. At minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, `[[0, - 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`line.cmin` - and `line.cmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,P - ortland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividi - s. - colorsrc - Sets the source reference on plot.ly for color . - dash - Sets the dash style of the lines. - reversescale - Reverses the color mapping if true. Has an effect only - if in `line.color`is set to a numerical array. If true, - `line.cmin` will correspond to the last color in the - array and `line.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `line.color`is set - to a numerical array. - width - Sets the line width (in px). - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorscale=None, - colorsrc=None, - dash=None, - reversescale=None, - showscale=None, - width=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.Line - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `line.colorscale`. Has an effect only if in - `line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `line.color`) - or the bounds set in `line.cmin` and `line.cmax` Has - an effect only if in `line.color`is set to a numerical - array. Defaults to `false` when `line.cmin` and - `line.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `line.color`is set to a numerical array. - Value should have the same units as in `line.color` and - if set, `line.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `line.cmin` and/or `line.cmax` to be equidistant to - this point. Has an effect only if in `line.color`is set - to a numerical array. Value should have the same units - as in `line.color`. Has no effect when `line.cauto` is - `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `line.color`is set to a numerical array. - Value should have the same units as in `line.color` and - if set, `line.cmax` must be set as well. - color - Sets thelinecolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `line.cmin` and `line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named color - string. At minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, `[[0, - 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To control the - bounds of the colorscale in color space, use`line.cmin` - and `line.cmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,P - ortland,Jet,Hot,Blackbody,Earth,Electric,Viridis,Cividi - s. - colorsrc - Sets the source reference on plot.ly for color . - dash - Sets the dash style of the lines. - reversescale - Reverses the color mapping if true. Has an effect only - if in `line.color`is set to a numerical array. If true, - `line.cmin` will correspond to the last color in the - array and `line.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `line.color`is set - to a numerical array. - width - Sets the line width (in px). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.Line -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() - self._validators['cauto'] = v_line.CautoValidator() - self._validators['cmax'] = v_line.CmaxValidator() - self._validators['cmid'] = v_line.CmidValidator() - self._validators['cmin'] = v_line.CminValidator() - self._validators['color'] = v_line.ColorValidator() - self._validators['colorscale'] = v_line.ColorscaleValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['dash'] = v_line.DashValidator() - self._validators['reversescale'] = v_line.ReversescaleValidator() - self._validators['showscale'] = v_line.ShowscaleValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('dash', None) - self['dash'] = dash if dash is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/_marker.py b/plotly/graph_objs/scatter3d/_marker.py deleted file mode 100644 index 6b4ae33e605..00000000000 --- a/plotly/graph_objs/scatter3d/_marker.py +++ /dev/null @@ -1,1151 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in `marker.color`is - set to a numerical array. In case `colorscale` is unspecified - or `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` array are - all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.color`) or the - bounds set in `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical array. Defaults - to `false` when `marker.cmin` and `marker.cmax` are set by the - user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmin` - must be set as well. - - The 'cmax' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling `marker.cmin` - and/or `marker.cmax` to be equidistant to this point. Has an - effect only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color`. Has no - effect when `marker.cauto` is `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmax` - must be set as well. - - The 'cmin' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarkercolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scatter3d.marker.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of 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 - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scatter3d.marker.colorbar.Tic - kformatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scatter3d.marker.colorbar.tickformatstopdefau - lts), sets the default property values to use - for elements of - scatter3d.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatter3d.marker.colorbar.Tit - le instance or dict with compatible properties - titlefont - Deprecated: Please use - scatter3d.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. - titleside - Deprecated: Please use - scatter3d.marker.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.scatter3d.marker.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in `marker.color`is - set to a numerical array. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At minimum, a mapping for - the lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` - may be a palette name string of the following list: Greys,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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - - Returns - ------- - plotly.graph_objs.scatter3d.marker.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # opacity - # ------- - @property - def opacity(self): - """ - Sets the marker opacity. Note that the marker opacity for - scatter3d traces must be a scalar value for performance - reasons. To set a blending opacity value (i.e. which is not - transparent), set "marker.color" to an rgba color and use its - alpha channel. - - The 'opacity' property is a number and may be specified as: - - An int or float in the interval [0, 1] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.color`is set to a numerical array. If true, - `marker.cmin` will correspond to the last color in the array - and `marker.cmax` will correspond to the first color. - - The 'reversescale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # size - # ---- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizemin - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['sizemin'] - - @sizemin.setter - def sizemin(self, val): - self['sizemin'] = val - - # sizemode - # -------- - @property - 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'] - - Returns - ------- - Any - """ - return self['sizemode'] - - @sizemode.setter - def sizemode(self, val): - self['sizemode'] = val - - # sizeref - # ------- - @property - 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 - - Returns - ------- - int|float - """ - return self['sizeref'] - - @sizeref.setter - def sizeref(self, val): - self['sizeref'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # symbol - # ------ - @property - 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', - 'diamond', 'diamond-open', 'cross', 'x'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['symbol'] - - @symbol.setter - def symbol(self, val): - self['symbol'] = val - - # symbolsrc - # --------- - @property - def symbolsrc(self): - """ - Sets the source reference on plot.ly for symbol . - - The 'symbolsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['symbolsrc'] - - @symbolsrc.setter - def symbolsrc(self, val): - self['symbolsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scatter3d.marker.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - line - plotly.graph_objs.scatter3d.marker.Line instance or - dict with compatible properties - opacity - Sets the marker opacity. Note that the marker opacity - for scatter3d traces must be a scalar value for - performance reasons. To set a blending opacity value - (i.e. which is not transparent), set "marker.color" to - an rgba color and use its alpha channel. - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. - symbolsrc - Sets the source reference on plot.ly for symbol . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorbar=None, - colorscale=None, - colorsrc=None, - line=None, - opacity=None, - reversescale=None, - showscale=None, - size=None, - sizemin=None, - sizemode=None, - sizeref=None, - sizesrc=None, - symbol=None, - symbolsrc=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.Marker - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scatter3d.marker.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - line - plotly.graph_objs.scatter3d.marker.Line instance or - dict with compatible properties - opacity - Sets the marker opacity. Note that the marker opacity - for scatter3d traces must be a scalar value for - performance reasons. To set a blending opacity value - (i.e. which is not transparent), set "marker.color" to - an rgba color and use its alpha channel. - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. - symbolsrc - Sets the source reference on plot.ly for symbol . - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() - self._validators['cauto'] = v_marker.CautoValidator() - self._validators['cmax'] = v_marker.CmaxValidator() - self._validators['cmid'] = v_marker.CmidValidator() - self._validators['cmin'] = v_marker.CminValidator() - self._validators['color'] = v_marker.ColorValidator() - self._validators['colorbar'] = v_marker.ColorBarValidator() - self._validators['colorscale'] = v_marker.ColorscaleValidator() - self._validators['colorsrc'] = v_marker.ColorsrcValidator() - self._validators['line'] = v_marker.LineValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['reversescale'] = v_marker.ReversescaleValidator() - self._validators['showscale'] = v_marker.ShowscaleValidator() - self._validators['size'] = v_marker.SizeValidator() - self._validators['sizemin'] = v_marker.SizeminValidator() - self._validators['sizemode'] = v_marker.SizemodeValidator() - self._validators['sizeref'] = v_marker.SizerefValidator() - self._validators['sizesrc'] = v_marker.SizesrcValidator() - self._validators['symbol'] = v_marker.SymbolValidator() - self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizemin', None) - self['sizemin'] = sizemin if sizemin is not None else _v - _v = arg.pop('sizemode', None) - self['sizemode'] = sizemode if sizemode is not None else _v - _v = arg.pop('sizeref', None) - self['sizeref'] = sizeref if sizeref is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - _v = arg.pop('symbol', None) - self['symbol'] = symbol if symbol is not None else _v - _v = arg.pop('symbolsrc', None) - self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/_projection.py b/plotly/graph_objs/scatter3d/_projection.py deleted file mode 100644 index 5961121fff1..00000000000 --- a/plotly/graph_objs/scatter3d/_projection.py +++ /dev/null @@ -1,195 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Projection(BaseTraceHierarchyType): - - # x - # - - @property - def x(self): - """ - The 'x' property is an instance of X - that may be specified as: - - An instance of 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 - Sets the scale factor determining the size of - the projection marker points. - show - Sets whether or not projections are shown along - the x axis. - - Returns - ------- - plotly.graph_objs.scatter3d.projection.X - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @property - def y(self): - """ - The 'y' property is an instance of Y - that may be specified as: - - An instance of 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 - Sets the scale factor determining the size of - the projection marker points. - show - Sets whether or not projections are shown along - the y axis. - - Returns - ------- - plotly.graph_objs.scatter3d.projection.Y - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # z - # - - @property - def z(self): - """ - The 'z' property is an instance of Z - that may be specified as: - - An instance of 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 - Sets the scale factor determining the size of - the projection marker points. - show - Sets whether or not projections are shown along - the z axis. - - Returns - ------- - plotly.graph_objs.scatter3d.projection.Z - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - plotly.graph_objs.scatter3d.projection.X instance or - dict with compatible properties - y - plotly.graph_objs.scatter3d.projection.Y instance or - dict with compatible properties - z - plotly.graph_objs.scatter3d.projection.Z instance or - dict with compatible properties - """ - - def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): - """ - Construct a new Projection object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.Projection - x - plotly.graph_objs.scatter3d.projection.X instance or - dict with compatible properties - y - plotly.graph_objs.scatter3d.projection.Y instance or - dict with compatible properties - z - plotly.graph_objs.scatter3d.projection.Z instance or - dict with compatible properties - - Returns - ------- - Projection - """ - super(Projection, self).__init__('projection') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.Projection -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.Projection""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d import (projection as v_projection) - - # Initialize validators - # --------------------- - self._validators['x'] = v_projection.XValidator() - self._validators['y'] = v_projection.YValidator() - self._validators['z'] = v_projection.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/_stream.py b/plotly/graph_objs/scatter3d/_stream.py deleted file mode 100644 index 4fe5022121a..00000000000 --- a/plotly/graph_objs/scatter3d/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.Stream -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/_textfont.py b/plotly/graph_objs/scatter3d/_textfont.py deleted file mode 100644 index 323050f19e5..00000000000 --- a/plotly/graph_objs/scatter3d/_textfont.py +++ /dev/null @@ -1,288 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.Textfont - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d import (textfont as v_textfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - self._validators['colorsrc'] = v_textfont.ColorsrcValidator() - self._validators['family'] = v_textfont.FamilyValidator() - self._validators['size'] = v_textfont.SizeValidator() - self._validators['sizesrc'] = v_textfont.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/hoverlabel/__init__.py b/plotly/graph_objs/scatter3d/hoverlabel/__init__.py index c37b8b5cd28..ddcb9048106 100644 --- a/plotly/graph_objs/scatter3d/hoverlabel/__init__.py +++ b/plotly/graph_objs/scatter3d/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatter3d.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/hoverlabel/_font.py b/plotly/graph_objs/scatter3d/hoverlabel/_font.py deleted file mode 100644 index b5555ef8643..00000000000 --- a/plotly/graph_objs/scatter3d/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter3d.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/marker/__init__.py b/plotly/graph_objs/scatter3d/marker/__init__.py index b7529bfadda..7b62d9fb80f 100644 --- a/plotly/graph_objs/scatter3d/marker/__init__.py +++ b/plotly/graph_objs/scatter3d/marker/__init__.py @@ -1,3 +1,2417 @@ -from ._line import Line -from ._colorbar import ColorBar + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + 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) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color`is + 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 + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarker.linecolor. It accepts either a specific color or + an array of numbers that are mapped to the colorscale relative + to the max and min values of the array or relative to + `marker.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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scatter3d.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized value + to an rgb, rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and highest (1) values + are required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color`is set to a numerical array. If true, + `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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter3d.marker.Line + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.marker.Line +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.marker.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d.marker import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() + self._validators['cauto'] = v_line.CautoValidator() + self._validators['cmax'] = v_line.CmaxValidator() + self._validators['cmid'] = v_line.CmidValidator() + self._validators['cmin'] = v_line.CminValidator() + self._validators['color'] = v_line.ColorValidator() + self._validators['colorscale'] = v_line.ColorscaleValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['reversescale'] = v_line.ReversescaleValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scatter3d.marker.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scatter3d.mark + 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 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 + ------- + plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.scatter3d.marker.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use scatter3d.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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use scatter3d.marker.colorbar.title.side + instead. Determines the location of color bar's title with + respect to the color bar. Note that the title's location used + to be set by the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scatter3d.marker.colorbar.Tickformats + top instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + r3d.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scatter3d.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatter3d.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + scatter3d.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. + titleside + Deprecated: Please use + scatter3d.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatter3d.marker.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scatter3d.marker.colorbar.Tickformats + top instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + r3d.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scatter3d.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatter3d.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + scatter3d.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. + titleside + Deprecated: Please use + scatter3d.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.marker.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.marker.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d.marker import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scatter3d.marker import colorbar diff --git a/plotly/graph_objs/scatter3d/marker/_colorbar.py b/plotly/graph_objs/scatter3d/marker/_colorbar.py deleted file mode 100644 index 5583c00104e..00000000000 --- a/plotly/graph_objs/scatter3d/marker/_colorbar.py +++ /dev/null @@ -1,1867 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scatter3d.marker.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.scatter3d.mark - 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 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 - ------- - plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.scatter3d.marker.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use scatter3d.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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use scatter3d.marker.colorbar.title.side - instead. Determines the location of color bar's title with - respect to the color bar. Note that the title's location used - to be set by the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scatter3d.marker.colorbar.Tickformats - top instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - r3d.marker.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - scatter3d.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatter3d.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - scatter3d.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. - titleside - Deprecated: Please use - scatter3d.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter3d.marker.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scatter3d.marker.colorbar.Tickformats - top instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - r3d.marker.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - scatter3d.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatter3d.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - scatter3d.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. - titleside - Deprecated: Please use - scatter3d.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.marker.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.marker.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d.marker import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/marker/_line.py b/plotly/graph_objs/scatter3d/marker/_line.py deleted file mode 100644 index 89b0990c0f7..00000000000 --- a/plotly/graph_objs/scatter3d/marker/_line.py +++ /dev/null @@ -1,543 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is true, the - default palette will be chosen according to whether numbers in - the `color` array are all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.line.color`) or the - bounds set in `marker.line.cmin` and `marker.line.cmax` Has an - 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) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be equidistant - to this point. Has an effect only if in `marker.line.color`is - 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 - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarker.linecolor. It accepts either a specific color or - an array of numbers that are mapped to the colorscale relative - to the max and min values of the array or relative to - `marker.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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scatter3d.marker.line.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized value - to an rgb, rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and highest (1) values - are required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the colorscale in - color space, use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.line.color`is set to a numerical array. If true, - `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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorscale=None, - colorsrc=None, - reversescale=None, - width=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.marker.Line - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.marker.Line -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.marker.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d.marker import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() - self._validators['cauto'] = v_line.CautoValidator() - self._validators['cmax'] = v_line.CmaxValidator() - self._validators['cmid'] = v_line.CmidValidator() - self._validators['cmin'] = v_line.CminValidator() - self._validators['color'] = v_line.ColorValidator() - self._validators['colorscale'] = v_line.ColorscaleValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['reversescale'] = v_line.ReversescaleValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/marker/colorbar/__init__.py b/plotly/graph_objs/scatter3d/marker/colorbar/__init__.py index aff8969d4d6..31f8ad27869 100644 --- a/plotly/graph_objs/scatter3d/marker/colorbar/__init__.py +++ b/plotly/graph_objs/scatter3d/marker/colorbar/__init__.py @@ -1,4 +1,725 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scatter3d.marker.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatter3d.marker.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.marker.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.marker.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d.marker.colorbar import ( + title as v_title + ) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter3d.marker.color + bar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d.marker.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatter3d.marker.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.marker.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.marker.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d.marker.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scatter3d.marker.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/scatter3d/marker/colorbar/_tickfont.py b/plotly/graph_objs/scatter3d/marker/colorbar/_tickfont.py deleted file mode 100644 index 40e2b010561..00000000000 --- a/plotly/graph_objs/scatter3d/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter3d.marker.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.marker.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.marker.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d.marker.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py deleted file mode 100644 index 267a937ce3a..00000000000 --- a/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.marker.color - bar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d.marker.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/marker/colorbar/_title.py b/plotly/graph_objs/scatter3d/marker/colorbar/_title.py deleted file mode 100644 index 62fecc4cf20..00000000000 --- a/plotly/graph_objs/scatter3d/marker/colorbar/_title.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scatter3d.marker.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter3d.marker.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.marker.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.marker.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d.marker.colorbar import ( - title as v_title - ) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/marker/colorbar/title/__init__.py b/plotly/graph_objs/scatter3d/marker/colorbar/title/__init__.py index c37b8b5cd28..72fb5ec4f57 100644 --- a/plotly/graph_objs/scatter3d/marker/colorbar/title/__init__.py +++ b/plotly/graph_objs/scatter3d/marker/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d.marker.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatter3d.marker.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.marker.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.marker.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d.marker.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/marker/colorbar/title/_font.py b/plotly/graph_objs/scatter3d/marker/colorbar/title/_font.py deleted file mode 100644 index fdfef190625..00000000000 --- a/plotly/graph_objs/scatter3d/marker/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d.marker.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatter3d.marker.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.marker.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.marker.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d.marker.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/projection/__init__.py b/plotly/graph_objs/scatter3d/projection/__init__.py index a9611dfd9fb..77326c76fdc 100644 --- a/plotly/graph_objs/scatter3d/projection/__init__.py +++ b/plotly/graph_objs/scatter3d/projection/__init__.py @@ -1,3 +1,486 @@ -from ._z import Z -from ._y import Y -from ._x import X + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Z(_BaseTraceHierarchyType): + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # scale + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['scale'] + + @scale.setter + def scale(self, val): + self['scale'] = val + + # show + # ---- + @property + 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) + + Returns + ------- + bool + """ + return self['show'] + + @show.setter + def show(self, val): + self['show'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d.projection' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + opacity + Sets the projection color. + scale + Sets the scale factor determining the size of the + projection marker points. + show + Sets whether or not projections are shown along the z + axis. + """ + + def __init__( + self, arg=None, opacity=None, scale=None, show=None, **kwargs + ): + """ + Construct a new Z object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter3d.projection.Z + opacity + Sets the projection color. + scale + Sets the scale factor determining the size of the + projection marker points. + show + Sets whether or not projections are shown along the z + axis. + + Returns + ------- + Z + """ + super(Z, self).__init__('z') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.projection.Z +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.projection.Z""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d.projection import (z as v_z) + + # Initialize validators + # --------------------- + self._validators['opacity'] = v_z.OpacityValidator() + self._validators['scale'] = v_z.ScaleValidator() + self._validators['show'] = v_z.ShowValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('scale', None) + self['scale'] = scale if scale is not None else _v + _v = arg.pop('show', None) + self['show'] = show if show is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Y(_BaseTraceHierarchyType): + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # scale + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['scale'] + + @scale.setter + def scale(self, val): + self['scale'] = val + + # show + # ---- + @property + 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) + + Returns + ------- + bool + """ + return self['show'] + + @show.setter + def show(self, val): + self['show'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d.projection' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + opacity + Sets the projection color. + scale + Sets the scale factor determining the size of the + projection marker points. + show + Sets whether or not projections are shown along the y + axis. + """ + + def __init__( + self, arg=None, opacity=None, scale=None, show=None, **kwargs + ): + """ + Construct a new Y object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter3d.projection.Y + opacity + Sets the projection color. + scale + Sets the scale factor determining the size of the + projection marker points. + show + Sets whether or not projections are shown along the y + axis. + + Returns + ------- + Y + """ + super(Y, self).__init__('y') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.projection.Y +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.projection.Y""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d.projection import (y as v_y) + + # Initialize validators + # --------------------- + self._validators['opacity'] = v_y.OpacityValidator() + self._validators['scale'] = v_y.ScaleValidator() + self._validators['show'] = v_y.ShowValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('scale', None) + self['scale'] = scale if scale is not None else _v + _v = arg.pop('show', None) + self['show'] = show if show is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class X(_BaseTraceHierarchyType): + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # scale + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['scale'] + + @scale.setter + def scale(self, val): + self['scale'] = val + + # show + # ---- + @property + 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) + + Returns + ------- + bool + """ + return self['show'] + + @show.setter + def show(self, val): + self['show'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatter3d.projection' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + opacity + Sets the projection color. + scale + Sets the scale factor determining the size of the + projection marker points. + show + Sets whether or not projections are shown along the x + axis. + """ + + def __init__( + self, arg=None, opacity=None, scale=None, show=None, **kwargs + ): + """ + Construct a new X object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatter3d.projection.X + opacity + Sets the projection color. + scale + Sets the scale factor determining the size of the + projection marker points. + show + Sets whether or not projections are shown along the x + axis. + + Returns + ------- + X + """ + super(X, self).__init__('x') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatter3d.projection.X +constructor must be a dict or +an instance of plotly.graph_objs.scatter3d.projection.X""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatter3d.projection import (x as v_x) + + # Initialize validators + # --------------------- + self._validators['opacity'] = v_x.OpacityValidator() + self._validators['scale'] = v_x.ScaleValidator() + self._validators['show'] = v_x.ShowValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('scale', None) + self['scale'] = scale if scale is not None else _v + _v = arg.pop('show', None) + self['show'] = show if show is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/projection/_x.py b/plotly/graph_objs/scatter3d/projection/_x.py deleted file mode 100644 index efcdc4bb0a7..00000000000 --- a/plotly/graph_objs/scatter3d/projection/_x.py +++ /dev/null @@ -1,160 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class X(BaseTraceHierarchyType): - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # scale - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['scale'] - - @scale.setter - def scale(self, val): - self['scale'] = val - - # show - # ---- - @property - 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) - - Returns - ------- - bool - """ - return self['show'] - - @show.setter - def show(self, val): - self['show'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d.projection' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - opacity - Sets the projection color. - scale - Sets the scale factor determining the size of the - projection marker points. - show - Sets whether or not projections are shown along the x - axis. - """ - - def __init__( - self, arg=None, opacity=None, scale=None, show=None, **kwargs - ): - """ - Construct a new X object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.projection.X - opacity - Sets the projection color. - scale - Sets the scale factor determining the size of the - projection marker points. - show - Sets whether or not projections are shown along the x - axis. - - Returns - ------- - X - """ - super(X, self).__init__('x') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.projection.X -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.projection.X""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d.projection import (x as v_x) - - # Initialize validators - # --------------------- - self._validators['opacity'] = v_x.OpacityValidator() - self._validators['scale'] = v_x.ScaleValidator() - self._validators['show'] = v_x.ShowValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('scale', None) - self['scale'] = scale if scale is not None else _v - _v = arg.pop('show', None) - self['show'] = show if show is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/projection/_y.py b/plotly/graph_objs/scatter3d/projection/_y.py deleted file mode 100644 index 3cdc5088c40..00000000000 --- a/plotly/graph_objs/scatter3d/projection/_y.py +++ /dev/null @@ -1,160 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Y(BaseTraceHierarchyType): - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # scale - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['scale'] - - @scale.setter - def scale(self, val): - self['scale'] = val - - # show - # ---- - @property - 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) - - Returns - ------- - bool - """ - return self['show'] - - @show.setter - def show(self, val): - self['show'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d.projection' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - opacity - Sets the projection color. - scale - Sets the scale factor determining the size of the - projection marker points. - show - Sets whether or not projections are shown along the y - axis. - """ - - def __init__( - self, arg=None, opacity=None, scale=None, show=None, **kwargs - ): - """ - Construct a new Y object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.projection.Y - opacity - Sets the projection color. - scale - Sets the scale factor determining the size of the - projection marker points. - show - Sets whether or not projections are shown along the y - axis. - - Returns - ------- - Y - """ - super(Y, self).__init__('y') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.projection.Y -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.projection.Y""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d.projection import (y as v_y) - - # Initialize validators - # --------------------- - self._validators['opacity'] = v_y.OpacityValidator() - self._validators['scale'] = v_y.ScaleValidator() - self._validators['show'] = v_y.ShowValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('scale', None) - self['scale'] = scale if scale is not None else _v - _v = arg.pop('show', None) - self['show'] = show if show is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatter3d/projection/_z.py b/plotly/graph_objs/scatter3d/projection/_z.py deleted file mode 100644 index 7a507be6da1..00000000000 --- a/plotly/graph_objs/scatter3d/projection/_z.py +++ /dev/null @@ -1,160 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Z(BaseTraceHierarchyType): - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # scale - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['scale'] - - @scale.setter - def scale(self, val): - self['scale'] = val - - # show - # ---- - @property - 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) - - Returns - ------- - bool - """ - return self['show'] - - @show.setter - def show(self, val): - self['show'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatter3d.projection' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - opacity - Sets the projection color. - scale - Sets the scale factor determining the size of the - projection marker points. - show - Sets whether or not projections are shown along the z - axis. - """ - - def __init__( - self, arg=None, opacity=None, scale=None, show=None, **kwargs - ): - """ - Construct a new Z object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatter3d.projection.Z - opacity - Sets the projection color. - scale - Sets the scale factor determining the size of the - projection marker points. - show - Sets whether or not projections are shown along the z - axis. - - Returns - ------- - Z - """ - super(Z, self).__init__('z') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatter3d.projection.Z -constructor must be a dict or -an instance of plotly.graph_objs.scatter3d.projection.Z""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatter3d.projection import (z as v_z) - - # Initialize validators - # --------------------- - self._validators['opacity'] = v_z.OpacityValidator() - self._validators['scale'] = v_z.ScaleValidator() - self._validators['show'] = v_z.ShowValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('scale', None) - self['scale'] = scale if scale is not None else _v - _v = arg.pop('show', None) - self['show'] = show if show is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/__init__.py b/plotly/graph_objs/scattercarpet/__init__.py index a0bfe9a608a..5a2e04f2a84 100644 --- a/plotly/graph_objs/scattercarpet/__init__.py +++ b/plotly/graph_objs/scattercarpet/__init__.py @@ -1,11 +1,2794 @@ -from ._unselected import Unselected + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. + + Returns + ------- + plotly.graph_objs.scattercarpet.unselected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.scattercarpet.unselected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.scattercarpet.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scattercarpet.unselected.Textfont + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattercarpet.Unselected + marker + plotly.graph_objs.scattercarpet.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scattercarpet.unselected.Textfont + instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super(Unselected, self).__init__('unselected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.Unselected +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.Unselected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet import ( + unselected as v_unselected + ) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_unselected.MarkerValidator() + self._validators['textfont'] = v_unselected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattercarpet.Textfont + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet import (textfont as v_textfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + self._validators['colorsrc'] = v_textfont.ColorsrcValidator() + self._validators['family'] = v_textfont.FamilyValidator() + self._validators['familysrc'] = v_textfont.FamilysrcValidator() + self._validators['size'] = v_textfont.SizeValidator() + self._validators['sizesrc'] = v_textfont.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattercarpet.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.Stream +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + plotly.graph_objs.scattercarpet.selected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.scattercarpet.selected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.scattercarpet.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scattercarpet.selected.Textfont + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattercarpet.Selected + marker + plotly.graph_objs.scattercarpet.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scattercarpet.selected.Textfont + instance or dict with compatible properties + + Returns + ------- + Selected + """ + super(Selected, self).__init__('selected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.Selected +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.Selected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet import (selected as v_selected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_selected.MarkerValidator() + self._validators['textfont'] = v_selected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color`is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` array are + all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmin` + must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmax` + must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarkercolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scattercarpet.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of 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 + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scattercarpet.marker.colorbar + .Tickformatstop instance or dict with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scattercarpet.marker.colorbar.tickformatstopd + efaults), sets the default property values to + use for elements of + scattercarpet.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scattercarpet.marker.colorbar + .Title instance or dict with compatible + properties + titlefont + Deprecated: Please use + scattercarpet.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. + titleside + Deprecated: Please use + scattercarpet.marker.colorbar.title.side + instead. Determines the location of color bar's + title with respect to the color bar. Note that + the title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.scattercarpet.marker.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color`is + set to a numerical array. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At minimum, a mapping for + the lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Greys,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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # gradient + # -------- + @property + def gradient(self): + """ + The 'gradient' property is an instance of Gradient + that may be specified as: + - An instance of 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 + horizontal, or the bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color + . + type + Sets the type of gradient used to fill the + markers + typesrc + Sets the source reference on plot.ly for type + . + + Returns + ------- + plotly.graph_objs.scattercarpet.marker.Gradient + """ + return self['gradient'] + + @gradient.setter + def gradient(self, val): + self['gradient'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.scattercarpet.marker.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # maxdisplayed + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['maxdisplayed'] + + @maxdisplayed.setter + def maxdisplayed(self, val): + self['maxdisplayed'] = val + + # opacity + # ------- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # opacitysrc + # ---------- + @property + def opacitysrc(self): + """ + Sets the source reference on plot.ly for opacity . + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['opacitysrc'] + + @opacitysrc.setter + def opacitysrc(self, val): + self['opacitysrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color`is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # size + # ---- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizemin + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['sizemin'] + + @sizemin.setter + def sizemin(self, val): + self['sizemin'] = val + + # sizemode + # -------- + @property + 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'] + + Returns + ------- + Any + """ + return self['sizemode'] + + @sizemode.setter + def sizemode(self, val): + self['sizemode'] = val + + # sizeref + # ------- + @property + 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 + + Returns + ------- + int|float + """ + return self['sizeref'] + + @sizeref.setter + def sizeref(self, val): + self['sizeref'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # symbol + # ------ + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', + 315, 'hexagon2-open-dot', 16, 'octagon', 116, + 'octagon-open', 216, 'octagon-dot', 316, + 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, + 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, + 'hexagram-open', 218, 'hexagram-dot', 318, + 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', + 120, 'star-triangle-down-open', 220, + 'star-triangle-down-dot', 320, + 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, + 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, + 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, + 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, + 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, + 'line-nw-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['symbol'] + + @symbol.setter + def symbol(self, val): + self['symbol'] = val + + # symbolsrc + # --------- + @property + def symbolsrc(self): + """ + Sets the source reference on plot.ly for symbol . + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['symbolsrc'] + + @symbolsrc.setter + def symbolsrc(self, val): + self['symbolsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scattercarpet.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + gradient + plotly.graph_objs.scattercarpet.marker.Gradient + instance or dict with compatible properties + line + plotly.graph_objs.scattercarpet.marker.Line instance or + dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorbar=None, + colorscale=None, + colorsrc=None, + gradient=None, + line=None, + maxdisplayed=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattercarpet.Marker + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scattercarpet.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + gradient + plotly.graph_objs.scattercarpet.marker.Gradient + instance or dict with compatible properties + line + plotly.graph_objs.scattercarpet.marker.Line instance or + dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() + self._validators['cauto'] = v_marker.CautoValidator() + self._validators['cmax'] = v_marker.CmaxValidator() + self._validators['cmid'] = v_marker.CmidValidator() + self._validators['cmin'] = v_marker.CminValidator() + self._validators['color'] = v_marker.ColorValidator() + self._validators['colorbar'] = v_marker.ColorBarValidator() + self._validators['colorscale'] = v_marker.ColorscaleValidator() + self._validators['colorsrc'] = v_marker.ColorsrcValidator() + self._validators['gradient'] = v_marker.GradientValidator() + self._validators['line'] = v_marker.LineValidator() + self._validators['maxdisplayed'] = v_marker.MaxdisplayedValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() + self._validators['reversescale'] = v_marker.ReversescaleValidator() + self._validators['showscale'] = v_marker.ShowscaleValidator() + self._validators['size'] = v_marker.SizeValidator() + self._validators['sizemin'] = v_marker.SizeminValidator() + self._validators['sizemode'] = v_marker.SizemodeValidator() + self._validators['sizeref'] = v_marker.SizerefValidator() + self._validators['sizesrc'] = v_marker.SizesrcValidator() + self._validators['symbol'] = v_marker.SymbolValidator() + self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('gradient', None) + self['gradient'] = gradient if gradient is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('maxdisplayed', None) + self['maxdisplayed'] = maxdisplayed if maxdisplayed is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('opacitysrc', None) + self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizemin', None) + self['sizemin'] = sizemin if sizemin is not None else _v + _v = arg.pop('sizemode', None) + self['sizemode'] = sizemode if sizemode is not None else _v + _v = arg.pop('sizeref', None) + self['sizeref'] = sizeref if sizeref is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + _v = arg.pop('symbol', None) + self['symbol'] = symbol if symbol is not None else _v + _v = arg.pop('symbolsrc', None) + self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dash + # ---- + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self['dash'] + + @dash.setter + def dash(self, val): + self['dash'] = val + + # shape + # ----- + @property + 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'] + + Returns + ------- + Any + """ + return self['shape'] + + @shape.setter + def shape(self, val): + self['shape'] = val + + # smoothing + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['smoothing'] + + @smoothing.setter + def smoothing(self, val): + self['smoothing'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + """ + + def __init__( + self, + arg=None, + color=None, + dash=None, + shape=None, + smoothing=None, + width=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattercarpet.Line + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.Line +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['dash'] = v_line.DashValidator() + self._validators['shape'] = v_line.ShapeValidator() + self._validators['smoothing'] = v_line.SmoothingValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dash', None) + self['dash'] = dash if dash is not None else _v + _v = arg.pop('shape', None) + self['shape'] = shape if shape is not None else _v + _v = arg.pop('smoothing', None) + self['smoothing'] = smoothing if smoothing is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scattercarpet.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattercarpet.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet import ( + hoverlabel as v_hoverlabel + ) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scattercarpet import unselected -from ._textfont import Textfont -from ._stream import Stream -from ._selected import Selected from plotly.graph_objs.scattercarpet import selected -from ._marker import Marker from plotly.graph_objs.scattercarpet import marker -from ._line import Line -from ._hoverlabel import Hoverlabel from plotly.graph_objs.scattercarpet import hoverlabel diff --git a/plotly/graph_objs/scattercarpet/_hoverlabel.py b/plotly/graph_objs/scattercarpet/_hoverlabel.py deleted file mode 100644 index bdf5ab11776..00000000000 --- a/plotly/graph_objs/scattercarpet/_hoverlabel.py +++ /dev/null @@ -1,417 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scattercarpet.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet import ( - hoverlabel as v_hoverlabel - ) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/_line.py b/plotly/graph_objs/scattercarpet/_line.py deleted file mode 100644 index 8b6452ad8c5..00000000000 --- a/plotly/graph_objs/scattercarpet/_line.py +++ /dev/null @@ -1,280 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dash - # ---- - @property - def dash(self): - """ - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - - The 'dash' property is an enumeration that may be specified as: - - One of the following dash styles: - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - - A string containing a dash length list in pixels or percentages - (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) - - Returns - ------- - str - """ - return self['dash'] - - @dash.setter - def dash(self, val): - self['dash'] = val - - # shape - # ----- - @property - 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'] - - Returns - ------- - Any - """ - return self['shape'] - - @shape.setter - def shape(self, val): - self['shape'] = val - - # smoothing - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['smoothing'] - - @smoothing.setter - def smoothing(self, val): - self['smoothing'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - shape - Determines the line shape. With "spline" the lines are - drawn using spline interpolation. The other available - values correspond to step-wise line shapes. - smoothing - Has an effect only if `shape` is set to "spline" Sets - the amount of smoothing. 0 corresponds to no smoothing - (equivalent to a "linear" shape). - width - Sets the line width (in px). - """ - - def __init__( - self, - arg=None, - color=None, - dash=None, - shape=None, - smoothing=None, - width=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattercarpet.Line - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - shape - Determines the line shape. With "spline" the lines are - drawn using spline interpolation. The other available - values correspond to step-wise line shapes. - smoothing - Has an effect only if `shape` is set to "spline" Sets - the amount of smoothing. 0 corresponds to no smoothing - (equivalent to a "linear" shape). - width - Sets the line width (in px). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.Line -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['dash'] = v_line.DashValidator() - self._validators['shape'] = v_line.ShapeValidator() - self._validators['smoothing'] = v_line.SmoothingValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dash', None) - self['dash'] = dash if dash is not None else _v - _v = arg.pop('shape', None) - self['shape'] = shape if shape is not None else _v - _v = arg.pop('smoothing', None) - self['smoothing'] = smoothing if smoothing is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/_marker.py b/plotly/graph_objs/scattercarpet/_marker.py deleted file mode 100644 index 97fa8c8d8db..00000000000 --- a/plotly/graph_objs/scattercarpet/_marker.py +++ /dev/null @@ -1,1320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in `marker.color`is - set to a numerical array. In case `colorscale` is unspecified - or `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` array are - all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.color`) or the - bounds set in `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical array. Defaults - to `false` when `marker.cmin` and `marker.cmax` are set by the - user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmin` - must be set as well. - - The 'cmax' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling `marker.cmin` - and/or `marker.cmax` to be equidistant to this point. Has an - effect only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color`. Has no - effect when `marker.cauto` is `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmax` - must be set as well. - - The 'cmin' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarkercolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scattercarpet.marker.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of 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 - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scattercarpet.marker.colorbar - .Tickformatstop instance or dict with - compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scattercarpet.marker.colorbar.tickformatstopd - efaults), sets the default property values to - use for elements of - scattercarpet.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scattercarpet.marker.colorbar - .Title instance or dict with compatible - properties - titlefont - Deprecated: Please use - scattercarpet.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. - titleside - Deprecated: Please use - scattercarpet.marker.colorbar.title.side - instead. Determines the location of color bar's - title with respect to the color bar. Note that - the title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.scattercarpet.marker.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in `marker.color`is - set to a numerical array. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At minimum, a mapping for - the lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` - may be a palette name string of the following list: Greys,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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # gradient - # -------- - @property - def gradient(self): - """ - The 'gradient' property is an instance of Gradient - that may be specified as: - - An instance of 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 - horizontal, or the bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color - . - type - Sets the type of gradient used to fill the - markers - typesrc - Sets the source reference on plot.ly for type - . - - Returns - ------- - plotly.graph_objs.scattercarpet.marker.Gradient - """ - return self['gradient'] - - @gradient.setter - def gradient(self, val): - self['gradient'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.scattercarpet.marker.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # maxdisplayed - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['maxdisplayed'] - - @maxdisplayed.setter - def maxdisplayed(self, val): - self['maxdisplayed'] = val - - # opacity - # ------- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # opacitysrc - # ---------- - @property - def opacitysrc(self): - """ - Sets the source reference on plot.ly for opacity . - - The 'opacitysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['opacitysrc'] - - @opacitysrc.setter - def opacitysrc(self, val): - self['opacitysrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.color`is set to a numerical array. If true, - `marker.cmin` will correspond to the last color in the array - and `marker.cmax` will correspond to the first color. - - The 'reversescale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # size - # ---- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizemin - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['sizemin'] - - @sizemin.setter - def sizemin(self, val): - self['sizemin'] = val - - # sizemode - # -------- - @property - 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'] - - Returns - ------- - Any - """ - return self['sizemode'] - - @sizemode.setter - def sizemode(self, val): - self['sizemode'] = val - - # sizeref - # ------- - @property - 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 - - Returns - ------- - int|float - """ - return self['sizeref'] - - @sizeref.setter - def sizeref(self, val): - self['sizeref'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # symbol - # ------ - @property - def symbol(self): - """ - Sets the marker symbol type. Adding 100 is equivalent to - appending "-open" to a symbol name. Adding 200 is equivalent to - appending "-dot" to a symbol name. Adding 300 is equivalent to - appending "-open-dot" or "dot-open" to a symbol name. - - The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', - 315, 'hexagon2-open-dot', 16, 'octagon', 116, - 'octagon-open', 216, 'octagon-dot', 316, - 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, - 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, - 'hexagram-open', 218, 'hexagram-dot', 318, - 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', - 120, 'star-triangle-down-open', 220, - 'star-triangle-down-dot', 320, - 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, - 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, - 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, - 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, - 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, - 'line-nw-open'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['symbol'] - - @symbol.setter - def symbol(self, val): - self['symbol'] = val - - # symbolsrc - # --------- - @property - def symbolsrc(self): - """ - Sets the source reference on plot.ly for symbol . - - The 'symbolsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['symbolsrc'] - - @symbolsrc.setter - def symbolsrc(self, val): - self['symbolsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scattercarpet.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - gradient - plotly.graph_objs.scattercarpet.marker.Gradient - instance or dict with compatible properties - line - plotly.graph_objs.scattercarpet.marker.Line instance or - dict with compatible properties - maxdisplayed - Sets a maximum number of points to be drawn on the - graph. 0 corresponds to no limit. - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorbar=None, - colorscale=None, - colorsrc=None, - gradient=None, - line=None, - maxdisplayed=None, - opacity=None, - opacitysrc=None, - reversescale=None, - showscale=None, - size=None, - sizemin=None, - sizemode=None, - sizeref=None, - sizesrc=None, - symbol=None, - symbolsrc=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattercarpet.Marker - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scattercarpet.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - gradient - plotly.graph_objs.scattercarpet.marker.Gradient - instance or dict with compatible properties - line - plotly.graph_objs.scattercarpet.marker.Line instance or - dict with compatible properties - maxdisplayed - Sets a maximum number of points to be drawn on the - graph. 0 corresponds to no limit. - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() - self._validators['cauto'] = v_marker.CautoValidator() - self._validators['cmax'] = v_marker.CmaxValidator() - self._validators['cmid'] = v_marker.CmidValidator() - self._validators['cmin'] = v_marker.CminValidator() - self._validators['color'] = v_marker.ColorValidator() - self._validators['colorbar'] = v_marker.ColorBarValidator() - self._validators['colorscale'] = v_marker.ColorscaleValidator() - self._validators['colorsrc'] = v_marker.ColorsrcValidator() - self._validators['gradient'] = v_marker.GradientValidator() - self._validators['line'] = v_marker.LineValidator() - self._validators['maxdisplayed'] = v_marker.MaxdisplayedValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() - self._validators['reversescale'] = v_marker.ReversescaleValidator() - self._validators['showscale'] = v_marker.ShowscaleValidator() - self._validators['size'] = v_marker.SizeValidator() - self._validators['sizemin'] = v_marker.SizeminValidator() - self._validators['sizemode'] = v_marker.SizemodeValidator() - self._validators['sizeref'] = v_marker.SizerefValidator() - self._validators['sizesrc'] = v_marker.SizesrcValidator() - self._validators['symbol'] = v_marker.SymbolValidator() - self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('gradient', None) - self['gradient'] = gradient if gradient is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('maxdisplayed', None) - self['maxdisplayed'] = maxdisplayed if maxdisplayed is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('opacitysrc', None) - self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizemin', None) - self['sizemin'] = sizemin if sizemin is not None else _v - _v = arg.pop('sizemode', None) - self['sizemode'] = sizemode if sizemode is not None else _v - _v = arg.pop('sizeref', None) - self['sizeref'] = sizeref if sizeref is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - _v = arg.pop('symbol', None) - self['symbol'] = symbol if symbol is not None else _v - _v = arg.pop('symbolsrc', None) - self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/_selected.py b/plotly/graph_objs/scattercarpet/_selected.py deleted file mode 100644 index 0588b84f10e..00000000000 --- a/plotly/graph_objs/scattercarpet/_selected.py +++ /dev/null @@ -1,146 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Selected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - plotly.graph_objs.scattercarpet.selected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.scattercarpet.selected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.scattercarpet.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scattercarpet.selected.Textfont - instance or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Selected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattercarpet.Selected - marker - plotly.graph_objs.scattercarpet.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scattercarpet.selected.Textfont - instance or dict with compatible properties - - Returns - ------- - Selected - """ - super(Selected, self).__init__('selected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.Selected -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.Selected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet import (selected as v_selected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_selected.MarkerValidator() - self._validators['textfont'] = v_selected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/_stream.py b/plotly/graph_objs/scattercarpet/_stream.py deleted file mode 100644 index 042b46ddce6..00000000000 --- a/plotly/graph_objs/scattercarpet/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattercarpet.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.Stream -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/_textfont.py b/plotly/graph_objs/scattercarpet/_textfont.py deleted file mode 100644 index 24aaa26bd53..00000000000 --- a/plotly/graph_objs/scattercarpet/_textfont.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Textfont object - - Sets the text font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattercarpet.Textfont - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet import (textfont as v_textfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - self._validators['colorsrc'] = v_textfont.ColorsrcValidator() - self._validators['family'] = v_textfont.FamilyValidator() - self._validators['familysrc'] = v_textfont.FamilysrcValidator() - self._validators['size'] = v_textfont.SizeValidator() - self._validators['sizesrc'] = v_textfont.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/_unselected.py b/plotly/graph_objs/scattercarpet/_unselected.py deleted file mode 100644 index fd8e8013264..00000000000 --- a/plotly/graph_objs/scattercarpet/_unselected.py +++ /dev/null @@ -1,153 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Unselected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. - - Returns - ------- - plotly.graph_objs.scattercarpet.unselected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.scattercarpet.unselected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.scattercarpet.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scattercarpet.unselected.Textfont - instance or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Unselected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.Unselected - marker - plotly.graph_objs.scattercarpet.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scattercarpet.unselected.Textfont - instance or dict with compatible properties - - Returns - ------- - Unselected - """ - super(Unselected, self).__init__('unselected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.Unselected -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.Unselected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet import ( - unselected as v_unselected - ) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_unselected.MarkerValidator() - self._validators['textfont'] = v_unselected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/hoverlabel/__init__.py b/plotly/graph_objs/scattercarpet/hoverlabel/__init__.py index c37b8b5cd28..fea081575bb 100644 --- a/plotly/graph_objs/scattercarpet/hoverlabel/__init__.py +++ b/plotly/graph_objs/scattercarpet/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattercarpet.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/hoverlabel/_font.py b/plotly/graph_objs/scattercarpet/hoverlabel/_font.py deleted file mode 100644 index 0f365681dcd..00000000000 --- a/plotly/graph_objs/scattercarpet/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/marker/__init__.py b/plotly/graph_objs/scattercarpet/marker/__init__.py index 5d2ebb72ce0..835b725c92a 100644 --- a/plotly/graph_objs/scattercarpet/marker/__init__.py +++ b/plotly/graph_objs/scattercarpet/marker/__init__.py @@ -1,4 +1,2691 @@ -from ._line import Line -from ._gradient import Gradient -from ._colorbar import ColorBar + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + 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) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color`is + 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 + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarker.linecolor. It accepts either a specific color or + an array of numbers that are mapped to the colorscale relative + to the max and min values of the array or relative to + `marker.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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scattercarpet.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized value + to an rgb, rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and highest (1) values + are required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color`is set to a numerical array. If true, + `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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattercarpet.marker.Line + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.marker.Line +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.marker.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet.marker import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() + self._validators['cauto'] = v_line.CautoValidator() + self._validators['cmax'] = v_line.CmaxValidator() + self._validators['cmid'] = v_line.CmidValidator() + self._validators['cmin'] = v_line.CminValidator() + self._validators['color'] = v_line.ColorValidator() + self._validators['colorscale'] = v_line.ColorscaleValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['reversescale'] = v_line.ReversescaleValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Gradient(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # type + # ---- + @property + 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'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # typesrc + # ------- + @property + def typesrc(self): + """ + Sets the source reference on plot.ly for type . + + The 'typesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['typesrc'] + + @typesrc.setter + def typesrc(self, val): + self['typesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color . + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on plot.ly for type . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + type=None, + typesrc=None, + **kwargs + ): + """ + Construct a new Gradient object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattercarpet.marker.Gradient + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color . + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on plot.ly for type . + + Returns + ------- + Gradient + """ + super(Gradient, self).__init__('gradient') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.marker.Gradient +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.marker.Gradient""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet.marker import ( + gradient as v_gradient + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_gradient.ColorValidator() + self._validators['colorsrc'] = v_gradient.ColorsrcValidator() + self._validators['type'] = v_gradient.TypeValidator() + self._validators['typesrc'] = v_gradient.TypesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('typesrc', None) + self['typesrc'] = typesrc if typesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scattercarpet.marker.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scattercarpet. + 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 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 + ------- + plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.scattercarpet.marker.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use scattercarpet.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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use scattercarpet.marker.colorbar.title.side + instead. Determines the location of color bar's title with + respect to the color bar. Note that the title's location used + to be set by the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scattercarpet.marker.colorbar.Tickfor + matstop instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rcarpet.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scattercarpet.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scattercarpet.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + scattercarpet.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. + titleside + Deprecated: Please use + scattercarpet.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattercarpet.marker.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scattercarpet.marker.colorbar.Tickfor + matstop instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rcarpet.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scattercarpet.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scattercarpet.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + scattercarpet.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. + titleside + Deprecated: Please use + scattercarpet.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.marker.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.marker.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet.marker import ( + colorbar as v_colorbar + ) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scattercarpet.marker import colorbar diff --git a/plotly/graph_objs/scattercarpet/marker/_colorbar.py b/plotly/graph_objs/scattercarpet/marker/_colorbar.py deleted file mode 100644 index 2fa7731a4cd..00000000000 --- a/plotly/graph_objs/scattercarpet/marker/_colorbar.py +++ /dev/null @@ -1,1871 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scattercarpet.marker.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.scattercarpet. - 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 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 - ------- - plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.scattercarpet.marker.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use scattercarpet.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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use scattercarpet.marker.colorbar.title.side - instead. Determines the location of color bar's title with - respect to the color bar. Note that the title's location used - to be set by the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scattercarpet.marker.colorbar.Tickfor - matstop instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - rcarpet.marker.colorbar.tickformatstopdefaults), sets - the default property values to use for elements of - scattercarpet.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scattercarpet.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - scattercarpet.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. - titleside - Deprecated: Please use - scattercarpet.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.marker.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scattercarpet.marker.colorbar.Tickfor - matstop instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - rcarpet.marker.colorbar.tickformatstopdefaults), sets - the default property values to use for elements of - scattercarpet.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scattercarpet.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - scattercarpet.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. - titleside - Deprecated: Please use - scattercarpet.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.marker.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.marker.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet.marker import ( - colorbar as v_colorbar - ) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/marker/_gradient.py b/plotly/graph_objs/scattercarpet/marker/_gradient.py deleted file mode 100644 index 0a0b03efde8..00000000000 --- a/plotly/graph_objs/scattercarpet/marker/_gradient.py +++ /dev/null @@ -1,238 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Gradient(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # type - # ---- - @property - 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'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # typesrc - # ------- - @property - def typesrc(self): - """ - Sets the source reference on plot.ly for type . - - The 'typesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['typesrc'] - - @typesrc.setter - def typesrc(self, val): - self['typesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the final color of the gradient fill: the center - color for radial, the right for horizontal, or the - bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color . - type - Sets the type of gradient used to fill the markers - typesrc - Sets the source reference on plot.ly for type . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - type=None, - typesrc=None, - **kwargs - ): - """ - Construct a new Gradient object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.marker.Gradient - color - Sets the final color of the gradient fill: the center - color for radial, the right for horizontal, or the - bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color . - type - Sets the type of gradient used to fill the markers - typesrc - Sets the source reference on plot.ly for type . - - Returns - ------- - Gradient - """ - super(Gradient, self).__init__('gradient') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.marker.Gradient -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.marker.Gradient""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet.marker import ( - gradient as v_gradient - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_gradient.ColorValidator() - self._validators['colorsrc'] = v_gradient.ColorsrcValidator() - self._validators['type'] = v_gradient.TypeValidator() - self._validators['typesrc'] = v_gradient.TypesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('typesrc', None) - self['typesrc'] = typesrc if typesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/marker/_line.py b/plotly/graph_objs/scattercarpet/marker/_line.py deleted file mode 100644 index 7261acbe4c6..00000000000 --- a/plotly/graph_objs/scattercarpet/marker/_line.py +++ /dev/null @@ -1,573 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is true, the - default palette will be chosen according to whether numbers in - the `color` array are all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.line.color`) or the - bounds set in `marker.line.cmin` and `marker.line.cmax` Has an - 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) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be equidistant - to this point. Has an effect only if in `marker.line.color`is - 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 - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarker.linecolor. It accepts either a specific color or - an array of numbers that are mapped to the colorscale relative - to the max and min values of the array or relative to - `marker.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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scattercarpet.marker.line.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized value - to an rgb, rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and highest (1) values - are required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the colorscale in - color space, use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.line.color`is set to a numerical array. If true, - `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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorscale=None, - colorsrc=None, - reversescale=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.marker.Line - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.marker.Line -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.marker.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet.marker import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() - self._validators['cauto'] = v_line.CautoValidator() - self._validators['cmax'] = v_line.CmaxValidator() - self._validators['cmid'] = v_line.CmidValidator() - self._validators['cmin'] = v_line.CminValidator() - self._validators['color'] = v_line.ColorValidator() - self._validators['colorscale'] = v_line.ColorscaleValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['reversescale'] = v_line.ReversescaleValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/marker/colorbar/__init__.py b/plotly/graph_objs/scattercarpet/marker/colorbar/__init__.py index 3b90a49e78a..26847cac4a4 100644 --- a/plotly/graph_objs/scattercarpet/marker/colorbar/__init__.py +++ b/plotly/graph_objs/scattercarpet/marker/colorbar/__init__.py @@ -1,4 +1,725 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scattercarpet.marker.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattercarpet.marker.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.marker.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.marker.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet.marker.colorbar import ( + title as v_title + ) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattercarpet.marker.c + olorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet.marker.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattercarpet.marker.c + olorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.marker.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.marker.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet.marker.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scattercarpet.marker.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/scattercarpet/marker/colorbar/_tickfont.py b/plotly/graph_objs/scattercarpet/marker/colorbar/_tickfont.py deleted file mode 100644 index 39b349f3ff3..00000000000 --- a/plotly/graph_objs/scattercarpet/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattercarpet.marker.c - olorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.marker.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.marker.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet.marker.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py deleted file mode 100644 index 503c6adc843..00000000000 --- a/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattercarpet.marker.c - olorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet.marker.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/marker/colorbar/_title.py b/plotly/graph_objs/scattercarpet/marker/colorbar/_title.py deleted file mode 100644 index 5782a26acf9..00000000000 --- a/plotly/graph_objs/scattercarpet/marker/colorbar/_title.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scattercarpet.marker.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.marker.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.marker.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.marker.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet.marker.colorbar import ( - title as v_title - ) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/marker/colorbar/title/__init__.py b/plotly/graph_objs/scattercarpet/marker/colorbar/title/__init__.py index c37b8b5cd28..a75b3134863 100644 --- a/plotly/graph_objs/scattercarpet/marker/colorbar/title/__init__.py +++ b/plotly/graph_objs/scattercarpet/marker/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet.marker.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattercarpet.marker.c + olorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.marker.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.marker.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet.marker.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/marker/colorbar/title/_font.py b/plotly/graph_objs/scattercarpet/marker/colorbar/title/_font.py deleted file mode 100644 index f03fdaa883c..00000000000 --- a/plotly/graph_objs/scattercarpet/marker/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet.marker.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattercarpet.marker.c - olorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.marker.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.marker.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet.marker.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/selected/__init__.py b/plotly/graph_objs/scattercarpet/selected/__init__.py index adba53218ca..40105acc077 100644 --- a/plotly/graph_objs/scattercarpet/selected/__init__.py +++ b/plotly/graph_objs/scattercarpet/selected/__init__.py @@ -1,2 +1,342 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattercarpet.selected.Textfont + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.selected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.selected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet.selected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattercarpet.selected.Marker + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.selected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.selected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet.selected import ( + marker as v_marker + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/selected/_marker.py b/plotly/graph_objs/scattercarpet/selected/_marker.py deleted file mode 100644 index 06da8d3f81b..00000000000 --- a/plotly/graph_objs/scattercarpet/selected/_marker.py +++ /dev/null @@ -1,197 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.selected.Marker - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.selected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.selected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet.selected import ( - marker as v_marker - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/selected/_textfont.py b/plotly/graph_objs/scattercarpet/selected/_textfont.py deleted file mode 100644 index c16be8e3c61..00000000000 --- a/plotly/graph_objs/scattercarpet/selected/_textfont.py +++ /dev/null @@ -1,141 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of selected points. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.selected.Textfont - color - Sets the text font color of selected points. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.selected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.selected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet.selected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/unselected/__init__.py b/plotly/graph_objs/scattercarpet/unselected/__init__.py index adba53218ca..0ae41d229ff 100644 --- a/plotly/graph_objs/scattercarpet/unselected/__init__.py +++ b/plotly/graph_objs/scattercarpet/unselected/__init__.py @@ -1,2 +1,354 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattercarpet.unselected.Textfont + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.unselected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.unselected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet.unselected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattercarpet.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattercarpet.unselected.Marker + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattercarpet.unselected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scattercarpet.unselected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattercarpet.unselected import ( + marker as v_marker + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/unselected/_marker.py b/plotly/graph_objs/scattercarpet/unselected/_marker.py deleted file mode 100644 index 687aa4c316d..00000000000 --- a/plotly/graph_objs/scattercarpet/unselected/_marker.py +++ /dev/null @@ -1,206 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.unselected.Marker - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.unselected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.unselected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet.unselected import ( - marker as v_marker - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattercarpet/unselected/_textfont.py b/plotly/graph_objs/scattercarpet/unselected/_textfont.py deleted file mode 100644 index 1eed26817d9..00000000000 --- a/plotly/graph_objs/scattercarpet/unselected/_textfont.py +++ /dev/null @@ -1,144 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattercarpet.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of unselected points, applied - only when a selection exists. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattercarpet.unselected.Textfont - color - Sets the text font color of unselected points, applied - only when a selection exists. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattercarpet.unselected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scattercarpet.unselected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattercarpet.unselected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/__init__.py b/plotly/graph_objs/scattergeo/__init__.py index a8d91a37507..7e5ca0d8fce 100644 --- a/plotly/graph_objs/scattergeo/__init__.py +++ b/plotly/graph_objs/scattergeo/__init__.py @@ -1,11 +1,2680 @@ -from ._unselected import Unselected + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. + + Returns + ------- + plotly.graph_objs.scattergeo.unselected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.scattergeo.unselected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.scattergeo.unselected.Marker instance + or dict with compatible properties + textfont + plotly.graph_objs.scattergeo.unselected.Textfont + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergeo.Unselected + marker + plotly.graph_objs.scattergeo.unselected.Marker instance + or dict with compatible properties + textfont + plotly.graph_objs.scattergeo.unselected.Textfont + instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super(Unselected, self).__init__('unselected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.Unselected +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.Unselected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo import (unselected as v_unselected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_unselected.MarkerValidator() + self._validators['textfont'] = v_unselected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergeo.Textfont + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo import (textfont as v_textfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + self._validators['colorsrc'] = v_textfont.ColorsrcValidator() + self._validators['family'] = v_textfont.FamilyValidator() + self._validators['familysrc'] = v_textfont.FamilysrcValidator() + self._validators['size'] = v_textfont.SizeValidator() + self._validators['sizesrc'] = v_textfont.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergeo.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.Stream +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + plotly.graph_objs.scattergeo.selected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.scattergeo.selected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.scattergeo.selected.Marker instance + or dict with compatible properties + textfont + plotly.graph_objs.scattergeo.selected.Textfont instance + or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergeo.Selected + marker + plotly.graph_objs.scattergeo.selected.Marker instance + or dict with compatible properties + textfont + plotly.graph_objs.scattergeo.selected.Textfont instance + or dict with compatible properties + + Returns + ------- + Selected + """ + super(Selected, self).__init__('selected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.Selected +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.Selected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo import (selected as v_selected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_selected.MarkerValidator() + self._validators['textfont'] = v_selected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color`is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` array are + all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmin` + must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmax` + must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarkercolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scattergeo.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of 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 + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scattergeo.marker.colorbar.Ti + ckformatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scattergeo.marker.colorbar.tickformatstopdefa + ults), sets the default property values to use + for elements of + scattergeo.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scattergeo.marker.colorbar.Ti + tle instance or dict with compatible properties + titlefont + Deprecated: Please use + scattergeo.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. + titleside + Deprecated: Please use + scattergeo.marker.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.scattergeo.marker.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color`is + set to a numerical array. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At minimum, a mapping for + the lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Greys,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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # gradient + # -------- + @property + def gradient(self): + """ + The 'gradient' property is an instance of Gradient + that may be specified as: + - An instance of 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 + horizontal, or the bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color + . + type + Sets the type of gradient used to fill the + markers + typesrc + Sets the source reference on plot.ly for type + . + + Returns + ------- + plotly.graph_objs.scattergeo.marker.Gradient + """ + return self['gradient'] + + @gradient.setter + def gradient(self, val): + self['gradient'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.scattergeo.marker.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # opacity + # ------- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # opacitysrc + # ---------- + @property + def opacitysrc(self): + """ + Sets the source reference on plot.ly for opacity . + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['opacitysrc'] + + @opacitysrc.setter + def opacitysrc(self, val): + self['opacitysrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color`is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # size + # ---- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizemin + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['sizemin'] + + @sizemin.setter + def sizemin(self, val): + self['sizemin'] = val + + # sizemode + # -------- + @property + 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'] + + Returns + ------- + Any + """ + return self['sizemode'] + + @sizemode.setter + def sizemode(self, val): + self['sizemode'] = val + + # sizeref + # ------- + @property + 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 + + Returns + ------- + int|float + """ + return self['sizeref'] + + @sizeref.setter + def sizeref(self, val): + self['sizeref'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # symbol + # ------ + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', + 315, 'hexagon2-open-dot', 16, 'octagon', 116, + 'octagon-open', 216, 'octagon-dot', 316, + 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, + 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, + 'hexagram-open', 218, 'hexagram-dot', 318, + 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', + 120, 'star-triangle-down-open', 220, + 'star-triangle-down-dot', 320, + 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, + 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, + 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, + 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, + 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, + 'line-nw-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['symbol'] + + @symbol.setter + def symbol(self, val): + self['symbol'] = val + + # symbolsrc + # --------- + @property + def symbolsrc(self): + """ + Sets the source reference on plot.ly for symbol . + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['symbolsrc'] + + @symbolsrc.setter + def symbolsrc(self, val): + self['symbolsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scattergeo.marker.ColorBar instance + or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + gradient + plotly.graph_objs.scattergeo.marker.Gradient instance + or dict with compatible properties + line + plotly.graph_objs.scattergeo.marker.Line instance or + dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorbar=None, + colorscale=None, + colorsrc=None, + gradient=None, + line=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergeo.Marker + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scattergeo.marker.ColorBar instance + or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + gradient + plotly.graph_objs.scattergeo.marker.Gradient instance + or dict with compatible properties + line + plotly.graph_objs.scattergeo.marker.Line instance or + dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() + self._validators['cauto'] = v_marker.CautoValidator() + self._validators['cmax'] = v_marker.CmaxValidator() + self._validators['cmid'] = v_marker.CmidValidator() + self._validators['cmin'] = v_marker.CminValidator() + self._validators['color'] = v_marker.ColorValidator() + self._validators['colorbar'] = v_marker.ColorBarValidator() + self._validators['colorscale'] = v_marker.ColorscaleValidator() + self._validators['colorsrc'] = v_marker.ColorsrcValidator() + self._validators['gradient'] = v_marker.GradientValidator() + self._validators['line'] = v_marker.LineValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() + self._validators['reversescale'] = v_marker.ReversescaleValidator() + self._validators['showscale'] = v_marker.ShowscaleValidator() + self._validators['size'] = v_marker.SizeValidator() + self._validators['sizemin'] = v_marker.SizeminValidator() + self._validators['sizemode'] = v_marker.SizemodeValidator() + self._validators['sizeref'] = v_marker.SizerefValidator() + self._validators['sizesrc'] = v_marker.SizesrcValidator() + self._validators['symbol'] = v_marker.SymbolValidator() + self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('gradient', None) + self['gradient'] = gradient if gradient is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('opacitysrc', None) + self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizemin', None) + self['sizemin'] = sizemin if sizemin is not None else _v + _v = arg.pop('sizemode', None) + self['sizemode'] = sizemode if sizemode is not None else _v + _v = arg.pop('sizeref', None) + self['sizeref'] = sizeref if sizeref is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + _v = arg.pop('symbol', None) + self['symbol'] = symbol if symbol is not None else _v + _v = arg.pop('symbolsrc', None) + self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dash + # ---- + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self['dash'] + + @dash.setter + def dash(self, val): + self['dash'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergeo.Line + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.Line +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['dash'] = v_line.DashValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dash', None) + self['dash'] = dash if dash is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scattergeo.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergeo.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scattergeo import unselected -from ._textfont import Textfont -from ._stream import Stream -from ._selected import Selected from plotly.graph_objs.scattergeo import selected -from ._marker import Marker from plotly.graph_objs.scattergeo import marker -from ._line import Line -from ._hoverlabel import Hoverlabel from plotly.graph_objs.scattergeo import hoverlabel diff --git a/plotly/graph_objs/scattergeo/_hoverlabel.py b/plotly/graph_objs/scattergeo/_hoverlabel.py deleted file mode 100644 index 62d23a30c44..00000000000 --- a/plotly/graph_objs/scattergeo/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scattergeo.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/_line.py b/plotly/graph_objs/scattergeo/_line.py deleted file mode 100644 index 15552573da5..00000000000 --- a/plotly/graph_objs/scattergeo/_line.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dash - # ---- - @property - def dash(self): - """ - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - - The 'dash' property is an enumeration that may be specified as: - - One of the following dash styles: - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - - A string containing a dash length list in pixels or percentages - (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) - - Returns - ------- - str - """ - return self['dash'] - - @dash.setter - def dash(self, val): - self['dash'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - width - Sets the line width (in px). - """ - - def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.Line - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - width - Sets the line width (in px). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.Line -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['dash'] = v_line.DashValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dash', None) - self['dash'] = dash if dash is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/_marker.py b/plotly/graph_objs/scattergeo/_marker.py deleted file mode 100644 index 22cb4574645..00000000000 --- a/plotly/graph_objs/scattergeo/_marker.py +++ /dev/null @@ -1,1288 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in `marker.color`is - set to a numerical array. In case `colorscale` is unspecified - or `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` array are - all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.color`) or the - bounds set in `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical array. Defaults - to `false` when `marker.cmin` and `marker.cmax` are set by the - user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmin` - must be set as well. - - The 'cmax' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling `marker.cmin` - and/or `marker.cmax` to be equidistant to this point. Has an - effect only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color`. Has no - effect when `marker.cauto` is `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmax` - must be set as well. - - The 'cmin' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarkercolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scattergeo.marker.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of 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 - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scattergeo.marker.colorbar.Ti - ckformatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scattergeo.marker.colorbar.tickformatstopdefa - ults), sets the default property values to use - for elements of - scattergeo.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scattergeo.marker.colorbar.Ti - tle instance or dict with compatible properties - titlefont - Deprecated: Please use - scattergeo.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. - titleside - Deprecated: Please use - scattergeo.marker.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.scattergeo.marker.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in `marker.color`is - set to a numerical array. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At minimum, a mapping for - the lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` - may be a palette name string of the following list: Greys,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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # gradient - # -------- - @property - def gradient(self): - """ - The 'gradient' property is an instance of Gradient - that may be specified as: - - An instance of 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 - horizontal, or the bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color - . - type - Sets the type of gradient used to fill the - markers - typesrc - Sets the source reference on plot.ly for type - . - - Returns - ------- - plotly.graph_objs.scattergeo.marker.Gradient - """ - return self['gradient'] - - @gradient.setter - def gradient(self, val): - self['gradient'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.scattergeo.marker.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # opacity - # ------- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # opacitysrc - # ---------- - @property - def opacitysrc(self): - """ - Sets the source reference on plot.ly for opacity . - - The 'opacitysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['opacitysrc'] - - @opacitysrc.setter - def opacitysrc(self, val): - self['opacitysrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.color`is set to a numerical array. If true, - `marker.cmin` will correspond to the last color in the array - and `marker.cmax` will correspond to the first color. - - The 'reversescale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # size - # ---- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizemin - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['sizemin'] - - @sizemin.setter - def sizemin(self, val): - self['sizemin'] = val - - # sizemode - # -------- - @property - 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'] - - Returns - ------- - Any - """ - return self['sizemode'] - - @sizemode.setter - def sizemode(self, val): - self['sizemode'] = val - - # sizeref - # ------- - @property - 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 - - Returns - ------- - int|float - """ - return self['sizeref'] - - @sizeref.setter - def sizeref(self, val): - self['sizeref'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # symbol - # ------ - @property - def symbol(self): - """ - Sets the marker symbol type. Adding 100 is equivalent to - appending "-open" to a symbol name. Adding 200 is equivalent to - appending "-dot" to a symbol name. Adding 300 is equivalent to - appending "-open-dot" or "dot-open" to a symbol name. - - The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', - 315, 'hexagon2-open-dot', 16, 'octagon', 116, - 'octagon-open', 216, 'octagon-dot', 316, - 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, - 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, - 'hexagram-open', 218, 'hexagram-dot', 318, - 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', - 120, 'star-triangle-down-open', 220, - 'star-triangle-down-dot', 320, - 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, - 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, - 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, - 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, - 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, - 'line-nw-open'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['symbol'] - - @symbol.setter - def symbol(self, val): - self['symbol'] = val - - # symbolsrc - # --------- - @property - def symbolsrc(self): - """ - Sets the source reference on plot.ly for symbol . - - The 'symbolsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['symbolsrc'] - - @symbolsrc.setter - def symbolsrc(self, val): - self['symbolsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scattergeo.marker.ColorBar instance - or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - gradient - plotly.graph_objs.scattergeo.marker.Gradient instance - or dict with compatible properties - line - plotly.graph_objs.scattergeo.marker.Line instance or - dict with compatible properties - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorbar=None, - colorscale=None, - colorsrc=None, - gradient=None, - line=None, - opacity=None, - opacitysrc=None, - reversescale=None, - showscale=None, - size=None, - sizemin=None, - sizemode=None, - sizeref=None, - sizesrc=None, - symbol=None, - symbolsrc=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.Marker - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scattergeo.marker.ColorBar instance - or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - gradient - plotly.graph_objs.scattergeo.marker.Gradient instance - or dict with compatible properties - line - plotly.graph_objs.scattergeo.marker.Line instance or - dict with compatible properties - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() - self._validators['cauto'] = v_marker.CautoValidator() - self._validators['cmax'] = v_marker.CmaxValidator() - self._validators['cmid'] = v_marker.CmidValidator() - self._validators['cmin'] = v_marker.CminValidator() - self._validators['color'] = v_marker.ColorValidator() - self._validators['colorbar'] = v_marker.ColorBarValidator() - self._validators['colorscale'] = v_marker.ColorscaleValidator() - self._validators['colorsrc'] = v_marker.ColorsrcValidator() - self._validators['gradient'] = v_marker.GradientValidator() - self._validators['line'] = v_marker.LineValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() - self._validators['reversescale'] = v_marker.ReversescaleValidator() - self._validators['showscale'] = v_marker.ShowscaleValidator() - self._validators['size'] = v_marker.SizeValidator() - self._validators['sizemin'] = v_marker.SizeminValidator() - self._validators['sizemode'] = v_marker.SizemodeValidator() - self._validators['sizeref'] = v_marker.SizerefValidator() - self._validators['sizesrc'] = v_marker.SizesrcValidator() - self._validators['symbol'] = v_marker.SymbolValidator() - self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('gradient', None) - self['gradient'] = gradient if gradient is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('opacitysrc', None) - self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizemin', None) - self['sizemin'] = sizemin if sizemin is not None else _v - _v = arg.pop('sizemode', None) - self['sizemode'] = sizemode if sizemode is not None else _v - _v = arg.pop('sizeref', None) - self['sizeref'] = sizeref if sizeref is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - _v = arg.pop('symbol', None) - self['symbol'] = symbol if symbol is not None else _v - _v = arg.pop('symbolsrc', None) - self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/_selected.py b/plotly/graph_objs/scattergeo/_selected.py deleted file mode 100644 index 716c1b80a08..00000000000 --- a/plotly/graph_objs/scattergeo/_selected.py +++ /dev/null @@ -1,146 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Selected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - plotly.graph_objs.scattergeo.selected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.scattergeo.selected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.scattergeo.selected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objs.scattergeo.selected.Textfont instance - or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Selected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.Selected - marker - plotly.graph_objs.scattergeo.selected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objs.scattergeo.selected.Textfont instance - or dict with compatible properties - - Returns - ------- - Selected - """ - super(Selected, self).__init__('selected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.Selected -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.Selected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo import (selected as v_selected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_selected.MarkerValidator() - self._validators['textfont'] = v_selected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/_stream.py b/plotly/graph_objs/scattergeo/_stream.py deleted file mode 100644 index d414979833f..00000000000 --- a/plotly/graph_objs/scattergeo/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.Stream -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/_textfont.py b/plotly/graph_objs/scattergeo/_textfont.py deleted file mode 100644 index 1533ac10dc5..00000000000 --- a/plotly/graph_objs/scattergeo/_textfont.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Textfont object - - Sets the text font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.Textfont - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo import (textfont as v_textfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - self._validators['colorsrc'] = v_textfont.ColorsrcValidator() - self._validators['family'] = v_textfont.FamilyValidator() - self._validators['familysrc'] = v_textfont.FamilysrcValidator() - self._validators['size'] = v_textfont.SizeValidator() - self._validators['sizesrc'] = v_textfont.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/_unselected.py b/plotly/graph_objs/scattergeo/_unselected.py deleted file mode 100644 index 4188e93daec..00000000000 --- a/plotly/graph_objs/scattergeo/_unselected.py +++ /dev/null @@ -1,150 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Unselected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. - - Returns - ------- - plotly.graph_objs.scattergeo.unselected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.scattergeo.unselected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.scattergeo.unselected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objs.scattergeo.unselected.Textfont - instance or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Unselected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.Unselected - marker - plotly.graph_objs.scattergeo.unselected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objs.scattergeo.unselected.Textfont - instance or dict with compatible properties - - Returns - ------- - Unselected - """ - super(Unselected, self).__init__('unselected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.Unselected -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.Unselected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo import (unselected as v_unselected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_unselected.MarkerValidator() - self._validators['textfont'] = v_unselected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/hoverlabel/__init__.py b/plotly/graph_objs/scattergeo/hoverlabel/__init__.py index c37b8b5cd28..bdee1364e74 100644 --- a/plotly/graph_objs/scattergeo/hoverlabel/__init__.py +++ b/plotly/graph_objs/scattergeo/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergeo.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/hoverlabel/_font.py b/plotly/graph_objs/scattergeo/hoverlabel/_font.py deleted file mode 100644 index e790b784732..00000000000 --- a/plotly/graph_objs/scattergeo/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergeo.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/marker/__init__.py b/plotly/graph_objs/scattergeo/marker/__init__.py index 6359f441e58..5d051c99954 100644 --- a/plotly/graph_objs/scattergeo/marker/__init__.py +++ b/plotly/graph_objs/scattergeo/marker/__init__.py @@ -1,4 +1,2690 @@ -from ._line import Line -from ._gradient import Gradient -from ._colorbar import ColorBar + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + 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) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color`is + 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 + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarker.linecolor. It accepts either a specific color or + an array of numbers that are mapped to the colorscale relative + to the max and min values of the array or relative to + `marker.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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scattergeo.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized value + to an rgb, rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and highest (1) values + are required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color`is set to a numerical array. If true, + `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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergeo.marker.Line + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.marker.Line +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.marker.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo.marker import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() + self._validators['cauto'] = v_line.CautoValidator() + self._validators['cmax'] = v_line.CmaxValidator() + self._validators['cmid'] = v_line.CmidValidator() + self._validators['cmin'] = v_line.CminValidator() + self._validators['color'] = v_line.ColorValidator() + self._validators['colorscale'] = v_line.ColorscaleValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['reversescale'] = v_line.ReversescaleValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Gradient(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # type + # ---- + @property + 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'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # typesrc + # ------- + @property + def typesrc(self): + """ + Sets the source reference on plot.ly for type . + + The 'typesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['typesrc'] + + @typesrc.setter + def typesrc(self, val): + self['typesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color . + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on plot.ly for type . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + type=None, + typesrc=None, + **kwargs + ): + """ + Construct a new Gradient object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergeo.marker.Gradient + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color . + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on plot.ly for type . + + Returns + ------- + Gradient + """ + super(Gradient, self).__init__('gradient') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.marker.Gradient +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.marker.Gradient""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo.marker import ( + gradient as v_gradient + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_gradient.ColorValidator() + self._validators['colorsrc'] = v_gradient.ColorsrcValidator() + self._validators['type'] = v_gradient.TypeValidator() + self._validators['typesrc'] = v_gradient.TypesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('typesrc', None) + self['typesrc'] = typesrc if typesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scattergeo.marker.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scattergeo.mar + 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 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 + ------- + plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.scattergeo.marker.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use scattergeo.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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use scattergeo.marker.colorbar.title.side + instead. Determines the location of color bar's title with + respect to the color bar. Note that the title's location used + to be set by the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scattergeo.marker.colorbar.Tickformat + stop instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rgeo.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scattergeo.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scattergeo.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + scattergeo.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. + titleside + Deprecated: Please use + scattergeo.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergeo.marker.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scattergeo.marker.colorbar.Tickformat + stop instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rgeo.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scattergeo.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scattergeo.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + scattergeo.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. + titleside + Deprecated: Please use + scattergeo.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.marker.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.marker.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo.marker import ( + colorbar as v_colorbar + ) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scattergeo.marker import colorbar diff --git a/plotly/graph_objs/scattergeo/marker/_colorbar.py b/plotly/graph_objs/scattergeo/marker/_colorbar.py deleted file mode 100644 index 8487e105018..00000000000 --- a/plotly/graph_objs/scattergeo/marker/_colorbar.py +++ /dev/null @@ -1,1871 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scattergeo.marker.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.scattergeo.mar - 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 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 - ------- - plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.scattergeo.marker.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use scattergeo.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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use scattergeo.marker.colorbar.title.side - instead. Determines the location of color bar's title with - respect to the color bar. Note that the title's location used - to be set by the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scattergeo.marker.colorbar.Tickformat - stop instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - rgeo.marker.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - scattergeo.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scattergeo.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - scattergeo.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. - titleside - Deprecated: Please use - scattergeo.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergeo.marker.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scattergeo.marker.colorbar.Tickformat - stop instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - rgeo.marker.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - scattergeo.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scattergeo.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - scattergeo.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. - titleside - Deprecated: Please use - scattergeo.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.marker.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.marker.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo.marker import ( - colorbar as v_colorbar - ) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/marker/_gradient.py b/plotly/graph_objs/scattergeo/marker/_gradient.py deleted file mode 100644 index 3db99cc7dc2..00000000000 --- a/plotly/graph_objs/scattergeo/marker/_gradient.py +++ /dev/null @@ -1,238 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Gradient(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # type - # ---- - @property - 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'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # typesrc - # ------- - @property - def typesrc(self): - """ - Sets the source reference on plot.ly for type . - - The 'typesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['typesrc'] - - @typesrc.setter - def typesrc(self, val): - self['typesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the final color of the gradient fill: the center - color for radial, the right for horizontal, or the - bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color . - type - Sets the type of gradient used to fill the markers - typesrc - Sets the source reference on plot.ly for type . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - type=None, - typesrc=None, - **kwargs - ): - """ - Construct a new Gradient object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergeo.marker.Gradient - color - Sets the final color of the gradient fill: the center - color for radial, the right for horizontal, or the - bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color . - type - Sets the type of gradient used to fill the markers - typesrc - Sets the source reference on plot.ly for type . - - Returns - ------- - Gradient - """ - super(Gradient, self).__init__('gradient') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.marker.Gradient -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.marker.Gradient""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo.marker import ( - gradient as v_gradient - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_gradient.ColorValidator() - self._validators['colorsrc'] = v_gradient.ColorsrcValidator() - self._validators['type'] = v_gradient.TypeValidator() - self._validators['typesrc'] = v_gradient.TypesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('typesrc', None) - self['typesrc'] = typesrc if typesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/marker/_line.py b/plotly/graph_objs/scattergeo/marker/_line.py deleted file mode 100644 index ed8caf23161..00000000000 --- a/plotly/graph_objs/scattergeo/marker/_line.py +++ /dev/null @@ -1,572 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is true, the - default palette will be chosen according to whether numbers in - the `color` array are all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.line.color`) or the - bounds set in `marker.line.cmin` and `marker.line.cmax` Has an - 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) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be equidistant - to this point. Has an effect only if in `marker.line.color`is - 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 - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarker.linecolor. It accepts either a specific color or - an array of numbers that are mapped to the colorscale relative - to the max and min values of the array or relative to - `marker.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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scattergeo.marker.line.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized value - to an rgb, rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and highest (1) values - are required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the colorscale in - color space, use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.line.color`is set to a numerical array. If true, - `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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorscale=None, - colorsrc=None, - reversescale=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.marker.Line - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.marker.Line -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.marker.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo.marker import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() - self._validators['cauto'] = v_line.CautoValidator() - self._validators['cmax'] = v_line.CmaxValidator() - self._validators['cmid'] = v_line.CmidValidator() - self._validators['cmin'] = v_line.CminValidator() - self._validators['color'] = v_line.ColorValidator() - self._validators['colorscale'] = v_line.ColorscaleValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['reversescale'] = v_line.ReversescaleValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/marker/colorbar/__init__.py b/plotly/graph_objs/scattergeo/marker/colorbar/__init__.py index badbdc11b3c..2a82db48415 100644 --- a/plotly/graph_objs/scattergeo/marker/colorbar/__init__.py +++ b/plotly/graph_objs/scattergeo/marker/colorbar/__init__.py @@ -1,4 +1,725 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scattergeo.marker.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergeo.marker.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.marker.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.marker.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo.marker.colorbar import ( + title as v_title + ) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergeo.marker.colo + rbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo.marker.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergeo.marker.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.marker.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.marker.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo.marker.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scattergeo.marker.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/scattergeo/marker/colorbar/_tickfont.py b/plotly/graph_objs/scattergeo/marker/colorbar/_tickfont.py deleted file mode 100644 index d6f45e69a85..00000000000 --- a/plotly/graph_objs/scattergeo/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergeo.marker.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.marker.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.marker.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo.marker.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py deleted file mode 100644 index f8c012e7b83..00000000000 --- a/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergeo.marker.colo - rbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo.marker.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/marker/colorbar/_title.py b/plotly/graph_objs/scattergeo/marker/colorbar/_title.py deleted file mode 100644 index 8c088c1f863..00000000000 --- a/plotly/graph_objs/scattergeo/marker/colorbar/_title.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scattergeo.marker.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergeo.marker.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.marker.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.marker.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo.marker.colorbar import ( - title as v_title - ) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/marker/colorbar/title/__init__.py b/plotly/graph_objs/scattergeo/marker/colorbar/title/__init__.py index c37b8b5cd28..78c3919bdd8 100644 --- a/plotly/graph_objs/scattergeo/marker/colorbar/title/__init__.py +++ b/plotly/graph_objs/scattergeo/marker/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo.marker.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergeo.marker.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.marker.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.marker.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo.marker.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/marker/colorbar/title/_font.py b/plotly/graph_objs/scattergeo/marker/colorbar/title/_font.py deleted file mode 100644 index 5ef2ee10b53..00000000000 --- a/plotly/graph_objs/scattergeo/marker/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo.marker.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergeo.marker.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.marker.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.marker.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo.marker.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/selected/__init__.py b/plotly/graph_objs/scattergeo/selected/__init__.py index adba53218ca..be6eeaee637 100644 --- a/plotly/graph_objs/scattergeo/selected/__init__.py +++ b/plotly/graph_objs/scattergeo/selected/__init__.py @@ -1,2 +1,340 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergeo.selected.Textfont + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.selected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.selected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo.selected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergeo.selected.Marker + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.selected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.selected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo.selected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/selected/_marker.py b/plotly/graph_objs/scattergeo/selected/_marker.py deleted file mode 100644 index 1ecf55b9532..00000000000 --- a/plotly/graph_objs/scattergeo/selected/_marker.py +++ /dev/null @@ -1,195 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergeo.selected.Marker - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.selected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.selected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo.selected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/selected/_textfont.py b/plotly/graph_objs/scattergeo/selected/_textfont.py deleted file mode 100644 index aee0f07c868..00000000000 --- a/plotly/graph_objs/scattergeo/selected/_textfont.py +++ /dev/null @@ -1,141 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of selected points. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergeo.selected.Textfont - color - Sets the text font color of selected points. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.selected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.selected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo.selected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/unselected/__init__.py b/plotly/graph_objs/scattergeo/unselected/__init__.py index adba53218ca..a2ad9f660e4 100644 --- a/plotly/graph_objs/scattergeo/unselected/__init__.py +++ b/plotly/graph_objs/scattergeo/unselected/__init__.py @@ -1,2 +1,354 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergeo.unselected.Textfont + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.unselected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.unselected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo.unselected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergeo.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergeo.unselected.Marker + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergeo.unselected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scattergeo.unselected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergeo.unselected import ( + marker as v_marker + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/unselected/_marker.py b/plotly/graph_objs/scattergeo/unselected/_marker.py deleted file mode 100644 index d568af79244..00000000000 --- a/plotly/graph_objs/scattergeo/unselected/_marker.py +++ /dev/null @@ -1,206 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergeo.unselected.Marker - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.unselected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.unselected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo.unselected import ( - marker as v_marker - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergeo/unselected/_textfont.py b/plotly/graph_objs/scattergeo/unselected/_textfont.py deleted file mode 100644 index d2f5b4fbef4..00000000000 --- a/plotly/graph_objs/scattergeo/unselected/_textfont.py +++ /dev/null @@ -1,144 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergeo.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of unselected points, applied - only when a selection exists. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergeo.unselected.Textfont - color - Sets the text font color of unselected points, applied - only when a selection exists. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergeo.unselected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scattergeo.unselected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergeo.unselected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/__init__.py b/plotly/graph_objs/scattergl/__init__.py index ce088198ef3..474156db31b 100644 --- a/plotly/graph_objs/scattergl/__init__.py +++ b/plotly/graph_objs/scattergl/__init__.py @@ -1,13 +1,3834 @@ -from ._unselected import Unselected + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. + + Returns + ------- + plotly.graph_objs.scattergl.unselected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.scattergl.unselected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.scattergl.unselected.Marker instance + or dict with compatible properties + textfont + plotly.graph_objs.scattergl.unselected.Textfont + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergl.Unselected + marker + plotly.graph_objs.scattergl.unselected.Marker instance + or dict with compatible properties + textfont + plotly.graph_objs.scattergl.unselected.Textfont + instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super(Unselected, self).__init__('unselected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.Unselected +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.Unselected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl import (unselected as v_unselected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_unselected.MarkerValidator() + self._validators['textfont'] = v_unselected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergl.Textfont + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl import (textfont as v_textfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + self._validators['colorsrc'] = v_textfont.ColorsrcValidator() + self._validators['family'] = v_textfont.FamilyValidator() + self._validators['familysrc'] = v_textfont.FamilysrcValidator() + self._validators['size'] = v_textfont.SizeValidator() + self._validators['sizesrc'] = v_textfont.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergl.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.Stream +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + plotly.graph_objs.scattergl.selected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.scattergl.selected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.scattergl.selected.Marker instance or + dict with compatible properties + textfont + plotly.graph_objs.scattergl.selected.Textfont instance + or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergl.Selected + marker + plotly.graph_objs.scattergl.selected.Marker instance or + dict with compatible properties + textfont + plotly.graph_objs.scattergl.selected.Textfont instance + or dict with compatible properties + + Returns + ------- + Selected + """ + super(Selected, self).__init__('selected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.Selected +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.Selected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl import (selected as v_selected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_selected.MarkerValidator() + self._validators['textfont'] = v_selected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color`is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` array are + all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmin` + must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmax` + must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarkercolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scattergl.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of 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 + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scattergl.marker.colorbar.Tic + kformatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scattergl.marker.colorbar.tickformatstopdefau + lts), sets the default property values to use + for elements of + scattergl.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scattergl.marker.colorbar.Tit + le instance or dict with compatible properties + titlefont + Deprecated: Please use + scattergl.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. + titleside + Deprecated: Please use + scattergl.marker.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.scattergl.marker.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color`is + set to a numerical array. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At minimum, a mapping for + the lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Greys,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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.scattergl.marker.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # opacity + # ------- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # opacitysrc + # ---------- + @property + def opacitysrc(self): + """ + Sets the source reference on plot.ly for opacity . + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['opacitysrc'] + + @opacitysrc.setter + def opacitysrc(self, val): + self['opacitysrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color`is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # size + # ---- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizemin + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['sizemin'] + + @sizemin.setter + def sizemin(self, val): + self['sizemin'] = val + + # sizemode + # -------- + @property + 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'] + + Returns + ------- + Any + """ + return self['sizemode'] + + @sizemode.setter + def sizemode(self, val): + self['sizemode'] = val + + # sizeref + # ------- + @property + 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 + + Returns + ------- + int|float + """ + return self['sizeref'] + + @sizeref.setter + def sizeref(self, val): + self['sizeref'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # symbol + # ------ + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', + 315, 'hexagon2-open-dot', 16, 'octagon', 116, + 'octagon-open', 216, 'octagon-dot', 316, + 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, + 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, + 'hexagram-open', 218, 'hexagram-dot', 318, + 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', + 120, 'star-triangle-down-open', 220, + 'star-triangle-down-dot', 320, + 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, + 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, + 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, + 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, + 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, + 'line-nw-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['symbol'] + + @symbol.setter + def symbol(self, val): + self['symbol'] = val + + # symbolsrc + # --------- + @property + def symbolsrc(self): + """ + Sets the source reference on plot.ly for symbol . + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['symbolsrc'] + + @symbolsrc.setter + def symbolsrc(self, val): + self['symbolsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scattergl.marker.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + line + plotly.graph_objs.scattergl.marker.Line instance or + dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorbar=None, + colorscale=None, + colorsrc=None, + line=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergl.Marker + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scattergl.marker.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + line + plotly.graph_objs.scattergl.marker.Line instance or + dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() + self._validators['cauto'] = v_marker.CautoValidator() + self._validators['cmax'] = v_marker.CmaxValidator() + self._validators['cmid'] = v_marker.CmidValidator() + self._validators['cmin'] = v_marker.CminValidator() + self._validators['color'] = v_marker.ColorValidator() + self._validators['colorbar'] = v_marker.ColorBarValidator() + self._validators['colorscale'] = v_marker.ColorscaleValidator() + self._validators['colorsrc'] = v_marker.ColorsrcValidator() + self._validators['line'] = v_marker.LineValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() + self._validators['reversescale'] = v_marker.ReversescaleValidator() + self._validators['showscale'] = v_marker.ShowscaleValidator() + self._validators['size'] = v_marker.SizeValidator() + self._validators['sizemin'] = v_marker.SizeminValidator() + self._validators['sizemode'] = v_marker.SizemodeValidator() + self._validators['sizeref'] = v_marker.SizerefValidator() + self._validators['sizesrc'] = v_marker.SizesrcValidator() + self._validators['symbol'] = v_marker.SymbolValidator() + self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('opacitysrc', None) + self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizemin', None) + self['sizemin'] = sizemin if sizemin is not None else _v + _v = arg.pop('sizemode', None) + self['sizemode'] = sizemode if sizemode is not None else _v + _v = arg.pop('sizeref', None) + self['sizeref'] = sizeref if sizeref is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + _v = arg.pop('symbol', None) + self['symbol'] = symbol if symbol is not None else _v + _v = arg.pop('symbolsrc', None) + self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dash + # ---- + @property + 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', + 'longdashdot'] + + Returns + ------- + Any + """ + return self['dash'] + + @dash.setter + def dash(self, val): + self['dash'] = val + + # shape + # ----- + @property + 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'] + + Returns + ------- + Any + """ + return self['shape'] + + @shape.setter + def shape(self, val): + self['shape'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the style of the lines. + shape + Determines the line shape. The values correspond to + step-wise line shapes. + width + Sets the line width (in px). + """ + + def __init__( + self, + arg=None, + color=None, + dash=None, + shape=None, + width=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergl.Line + color + Sets the line color. + dash + Sets the style of the lines. + shape + Determines the line shape. The values correspond to + step-wise line shapes. + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.Line +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['dash'] = v_line.DashValidator() + self._validators['shape'] = v_line.ShapeValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dash', None) + self['dash'] = dash if dash is not None else _v + _v = arg.pop('shape', None) + self['shape'] = shape if shape is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scattergl.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergl.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorY(_BaseTraceHierarchyType): + + # array + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['array'] + + @array.setter + def array(self, val): + self['array'] = val + + # arrayminus + # ---------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['arrayminus'] + + @arrayminus.setter + def arrayminus(self, val): + self['arrayminus'] = val + + # arrayminussrc + # ------------- + @property + def arrayminussrc(self): + """ + Sets the source reference on plot.ly for arrayminus . + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arrayminussrc'] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self['arrayminussrc'] = val + + # arraysrc + # -------- + @property + def arraysrc(self): + """ + Sets the source reference on plot.ly for array . + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arraysrc'] + + @arraysrc.setter + def arraysrc(self, val): + self['arraysrc'] = val + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # symmetric + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['symmetric'] + + @symmetric.setter + def symmetric(self, val): + self['symmetric'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # traceref + # -------- + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['traceref'] + + @traceref.setter + def traceref(self, val): + self['traceref'] = val + + # tracerefminus + # ------------- + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['tracerefminus'] + + @tracerefminus.setter + def tracerefminus(self, val): + self['tracerefminus'] = val + + # type + # ---- + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the sqaure of + the underlying data. If "array", 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # value + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # valueminus + # ---------- + @property + def valueminus(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 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] + + Returns + ------- + int|float + """ + return self['valueminus'] + + @valueminus.setter + def valueminus(self, val): + self['valueminus'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs + ): + """ + Construct a new ErrorY object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergl.ErrorY + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorY + """ + super(ErrorY, self).__init__('error_y') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.ErrorY +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.ErrorY""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl import (error_y as v_error_y) + + # Initialize validators + # --------------------- + self._validators['array'] = v_error_y.ArrayValidator() + self._validators['arrayminus'] = v_error_y.ArrayminusValidator() + self._validators['arrayminussrc'] = v_error_y.ArrayminussrcValidator() + self._validators['arraysrc'] = v_error_y.ArraysrcValidator() + self._validators['color'] = v_error_y.ColorValidator() + self._validators['symmetric'] = v_error_y.SymmetricValidator() + self._validators['thickness'] = v_error_y.ThicknessValidator() + self._validators['traceref'] = v_error_y.TracerefValidator() + self._validators['tracerefminus'] = v_error_y.TracerefminusValidator() + self._validators['type'] = v_error_y.TypeValidator() + self._validators['value'] = v_error_y.ValueValidator() + self._validators['valueminus'] = v_error_y.ValueminusValidator() + self._validators['visible'] = v_error_y.VisibleValidator() + self._validators['width'] = v_error_y.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('array', None) + self['array'] = array if array is not None else _v + _v = arg.pop('arrayminus', None) + self['arrayminus'] = arrayminus if arrayminus is not None else _v + _v = arg.pop('arrayminussrc', None) + self['arrayminussrc' + ] = arrayminussrc if arrayminussrc is not None else _v + _v = arg.pop('arraysrc', None) + self['arraysrc'] = arraysrc if arraysrc is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('symmetric', None) + self['symmetric'] = symmetric if symmetric is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('traceref', None) + self['traceref'] = traceref if traceref is not None else _v + _v = arg.pop('tracerefminus', None) + self['tracerefminus' + ] = tracerefminus if tracerefminus is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + _v = arg.pop('valueminus', None) + self['valueminus'] = valueminus if valueminus is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorX(_BaseTraceHierarchyType): + + # array + # ----- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['array'] + + @array.setter + def array(self, val): + self['array'] = val + + # arrayminus + # ---------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['arrayminus'] + + @arrayminus.setter + def arrayminus(self, val): + self['arrayminus'] = val + + # arrayminussrc + # ------------- + @property + def arrayminussrc(self): + """ + Sets the source reference on plot.ly for arrayminus . + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arrayminussrc'] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self['arrayminussrc'] = val + + # arraysrc + # -------- + @property + def arraysrc(self): + """ + Sets the source reference on plot.ly for array . + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['arraysrc'] + + @arraysrc.setter + def arraysrc(self, val): + self['arraysrc'] = val + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # copy_ystyle + # ----------- + @property + def copy_ystyle(self): + """ + The 'copy_ystyle' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['copy_ystyle'] + + @copy_ystyle.setter + def copy_ystyle(self, val): + self['copy_ystyle'] = val + + # symmetric + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['symmetric'] + + @symmetric.setter + def symmetric(self, val): + self['symmetric'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # traceref + # -------- + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['traceref'] + + @traceref.setter + def traceref(self, val): + self['traceref'] = val + + # tracerefminus + # ------------- + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self['tracerefminus'] + + @tracerefminus.setter + def tracerefminus(self, val): + self['tracerefminus'] = val + + # type + # ---- + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the sqaure of + the underlying data. If "array", 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # value + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # valueminus + # ---------- + @property + def valueminus(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 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] + + Returns + ------- + int|float + """ + return self['valueminus'] + + @valueminus.setter + def valueminus(self, val): + self['valueminus'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + copy_ystyle=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs + ): + """ + Construct a new ErrorX object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergl.ErrorX + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on plot.ly for arrayminus . + arraysrc + Sets the source reference on plot.ly for array . + color + Sets the stoke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + *constant`, the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the underlying + data. If "array", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorX + """ + super(ErrorX, self).__init__('error_x') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.ErrorX +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.ErrorX""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl import (error_x as v_error_x) + + # Initialize validators + # --------------------- + self._validators['array'] = v_error_x.ArrayValidator() + self._validators['arrayminus'] = v_error_x.ArrayminusValidator() + self._validators['arrayminussrc'] = v_error_x.ArrayminussrcValidator() + self._validators['arraysrc'] = v_error_x.ArraysrcValidator() + self._validators['color'] = v_error_x.ColorValidator() + self._validators['copy_ystyle'] = v_error_x.CopyYstyleValidator() + self._validators['symmetric'] = v_error_x.SymmetricValidator() + self._validators['thickness'] = v_error_x.ThicknessValidator() + self._validators['traceref'] = v_error_x.TracerefValidator() + self._validators['tracerefminus'] = v_error_x.TracerefminusValidator() + self._validators['type'] = v_error_x.TypeValidator() + self._validators['value'] = v_error_x.ValueValidator() + self._validators['valueminus'] = v_error_x.ValueminusValidator() + self._validators['visible'] = v_error_x.VisibleValidator() + self._validators['width'] = v_error_x.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('array', None) + self['array'] = array if array is not None else _v + _v = arg.pop('arrayminus', None) + self['arrayminus'] = arrayminus if arrayminus is not None else _v + _v = arg.pop('arrayminussrc', None) + self['arrayminussrc' + ] = arrayminussrc if arrayminussrc is not None else _v + _v = arg.pop('arraysrc', None) + self['arraysrc'] = arraysrc if arraysrc is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('copy_ystyle', None) + self['copy_ystyle'] = copy_ystyle if copy_ystyle is not None else _v + _v = arg.pop('symmetric', None) + self['symmetric'] = symmetric if symmetric is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('traceref', None) + self['traceref'] = traceref if traceref is not None else _v + _v = arg.pop('tracerefminus', None) + self['tracerefminus' + ] = tracerefminus if tracerefminus is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + _v = arg.pop('valueminus', None) + self['valueminus'] = valueminus if valueminus is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scattergl import unselected -from ._textfont import Textfont -from ._stream import Stream -from ._selected import Selected from plotly.graph_objs.scattergl import selected -from ._marker import Marker from plotly.graph_objs.scattergl import marker -from ._line import Line -from ._hoverlabel import Hoverlabel from plotly.graph_objs.scattergl import hoverlabel -from ._error_y import ErrorY -from ._error_x import ErrorX diff --git a/plotly/graph_objs/scattergl/_error_x.py b/plotly/graph_objs/scattergl/_error_x.py deleted file mode 100644 index d986717cfd9..00000000000 --- a/plotly/graph_objs/scattergl/_error_x.py +++ /dev/null @@ -1,597 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ErrorX(BaseTraceHierarchyType): - - # array - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['array'] - - @array.setter - def array(self, val): - self['array'] = val - - # arrayminus - # ---------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['arrayminus'] - - @arrayminus.setter - def arrayminus(self, val): - self['arrayminus'] = val - - # arrayminussrc - # ------------- - @property - def arrayminussrc(self): - """ - Sets the source reference on plot.ly for arrayminus . - - The 'arrayminussrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arrayminussrc'] - - @arrayminussrc.setter - def arrayminussrc(self, val): - self['arrayminussrc'] = val - - # arraysrc - # -------- - @property - def arraysrc(self): - """ - Sets the source reference on plot.ly for array . - - The 'arraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arraysrc'] - - @arraysrc.setter - def arraysrc(self, val): - self['arraysrc'] = val - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # copy_ystyle - # ----------- - @property - def copy_ystyle(self): - """ - The 'copy_ystyle' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['copy_ystyle'] - - @copy_ystyle.setter - def copy_ystyle(self, val): - self['copy_ystyle'] = val - - # symmetric - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['symmetric'] - - @symmetric.setter - def symmetric(self, val): - self['symmetric'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # traceref - # -------- - @property - def traceref(self): - """ - The 'traceref' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['traceref'] - - @traceref.setter - def traceref(self, val): - self['traceref'] = val - - # tracerefminus - # ------------- - @property - def tracerefminus(self): - """ - The 'tracerefminus' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['tracerefminus'] - - @tracerefminus.setter - def tracerefminus(self, val): - self['tracerefminus'] = val - - # type - # ---- - @property - def type(self): - """ - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. Set this - constant in `value`. If "percent", the bar lengths correspond - to a percentage of underlying data. Set this percentage in - `value`. If "sqrt", the bar lengths correspond to the sqaure of - the underlying data. If "array", 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # value - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # valueminus - # ---------- - @property - def valueminus(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 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] - - Returns - ------- - int|float - """ - return self['valueminus'] - - @valueminus.setter - def valueminus(self, val): - self['valueminus'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - copy_ystyle - - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - """ - - def __init__( - self, - arg=None, - array=None, - arrayminus=None, - arrayminussrc=None, - arraysrc=None, - color=None, - copy_ystyle=None, - symmetric=None, - thickness=None, - traceref=None, - tracerefminus=None, - type=None, - value=None, - valueminus=None, - visible=None, - width=None, - **kwargs - ): - """ - Construct a new ErrorX object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.ErrorX - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - copy_ystyle - - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - - Returns - ------- - ErrorX - """ - super(ErrorX, self).__init__('error_x') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.ErrorX -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.ErrorX""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl import (error_x as v_error_x) - - # Initialize validators - # --------------------- - self._validators['array'] = v_error_x.ArrayValidator() - self._validators['arrayminus'] = v_error_x.ArrayminusValidator() - self._validators['arrayminussrc'] = v_error_x.ArrayminussrcValidator() - self._validators['arraysrc'] = v_error_x.ArraysrcValidator() - self._validators['color'] = v_error_x.ColorValidator() - self._validators['copy_ystyle'] = v_error_x.CopyYstyleValidator() - self._validators['symmetric'] = v_error_x.SymmetricValidator() - self._validators['thickness'] = v_error_x.ThicknessValidator() - self._validators['traceref'] = v_error_x.TracerefValidator() - self._validators['tracerefminus'] = v_error_x.TracerefminusValidator() - self._validators['type'] = v_error_x.TypeValidator() - self._validators['value'] = v_error_x.ValueValidator() - self._validators['valueminus'] = v_error_x.ValueminusValidator() - self._validators['visible'] = v_error_x.VisibleValidator() - self._validators['width'] = v_error_x.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('array', None) - self['array'] = array if array is not None else _v - _v = arg.pop('arrayminus', None) - self['arrayminus'] = arrayminus if arrayminus is not None else _v - _v = arg.pop('arrayminussrc', None) - self['arrayminussrc' - ] = arrayminussrc if arrayminussrc is not None else _v - _v = arg.pop('arraysrc', None) - self['arraysrc'] = arraysrc if arraysrc is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('copy_ystyle', None) - self['copy_ystyle'] = copy_ystyle if copy_ystyle is not None else _v - _v = arg.pop('symmetric', None) - self['symmetric'] = symmetric if symmetric is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('traceref', None) - self['traceref'] = traceref if traceref is not None else _v - _v = arg.pop('tracerefminus', None) - self['tracerefminus' - ] = tracerefminus if tracerefminus is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - _v = arg.pop('valueminus', None) - self['valueminus'] = valueminus if valueminus is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/_error_y.py b/plotly/graph_objs/scattergl/_error_y.py deleted file mode 100644 index aae0a3fbe40..00000000000 --- a/plotly/graph_objs/scattergl/_error_y.py +++ /dev/null @@ -1,571 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ErrorY(BaseTraceHierarchyType): - - # array - # ----- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['array'] - - @array.setter - def array(self, val): - self['array'] = val - - # arrayminus - # ---------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['arrayminus'] - - @arrayminus.setter - def arrayminus(self, val): - self['arrayminus'] = val - - # arrayminussrc - # ------------- - @property - def arrayminussrc(self): - """ - Sets the source reference on plot.ly for arrayminus . - - The 'arrayminussrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arrayminussrc'] - - @arrayminussrc.setter - def arrayminussrc(self, val): - self['arrayminussrc'] = val - - # arraysrc - # -------- - @property - def arraysrc(self): - """ - Sets the source reference on plot.ly for array . - - The 'arraysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['arraysrc'] - - @arraysrc.setter - def arraysrc(self, val): - self['arraysrc'] = val - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # symmetric - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['symmetric'] - - @symmetric.setter - def symmetric(self, val): - self['symmetric'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # traceref - # -------- - @property - def traceref(self): - """ - The 'traceref' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['traceref'] - - @traceref.setter - def traceref(self, val): - self['traceref'] = val - - # tracerefminus - # ------------- - @property - def tracerefminus(self): - """ - The 'tracerefminus' property is a integer and may be specified as: - - An int (or float that will be cast to an int) - in the interval [0, 9223372036854775807] - - Returns - ------- - int - """ - return self['tracerefminus'] - - @tracerefminus.setter - def tracerefminus(self, val): - self['tracerefminus'] = val - - # type - # ---- - @property - def type(self): - """ - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. Set this - constant in `value`. If "percent", the bar lengths correspond - to a percentage of underlying data. Set this percentage in - `value`. If "sqrt", the bar lengths correspond to the sqaure of - the underlying data. If "array", 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # value - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # valueminus - # ---------- - @property - def valueminus(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 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] - - Returns - ------- - int|float - """ - return self['valueminus'] - - @valueminus.setter - def valueminus(self, val): - self['valueminus'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - """ - - def __init__( - self, - arg=None, - array=None, - arrayminus=None, - arrayminussrc=None, - arraysrc=None, - color=None, - symmetric=None, - thickness=None, - traceref=None, - tracerefminus=None, - type=None, - value=None, - valueminus=None, - visible=None, - width=None, - **kwargs - ): - """ - Construct a new ErrorY object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.ErrorY - array - Sets the data corresponding the length of each error - bar. Values are plotted relative to the underlying - data. - arrayminus - Sets the data corresponding the length of each error - bar in the bottom (left) direction for vertical - (horizontal) bars Values are plotted relative to the - underlying data. - arrayminussrc - Sets the source reference on plot.ly for arrayminus . - arraysrc - Sets the source reference on plot.ly for array . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have the same - length in both direction (top/bottom for vertical bars, - left/right for horizontal bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error bars. If - *constant`, the bar lengths are of a constant value. - Set this constant in `value`. If "percent", the bar - lengths correspond to a percentage of underlying data. - Set this percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the underlying - data. If "array", the bar lengths are set with data set - `array`. - value - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars. - valueminus - Sets the value of either the percentage (if `type` is - set to "percent") or the constant (if `type` is set to - "constant") corresponding to the lengths of the error - bars in the bottom (left) direction for vertical - (horizontal) bars - visible - Determines whether or not this set of error bars is - visible. - width - Sets the width (in px) of the cross-bar at both ends of - the error bars. - - Returns - ------- - ErrorY - """ - super(ErrorY, self).__init__('error_y') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.ErrorY -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.ErrorY""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl import (error_y as v_error_y) - - # Initialize validators - # --------------------- - self._validators['array'] = v_error_y.ArrayValidator() - self._validators['arrayminus'] = v_error_y.ArrayminusValidator() - self._validators['arrayminussrc'] = v_error_y.ArrayminussrcValidator() - self._validators['arraysrc'] = v_error_y.ArraysrcValidator() - self._validators['color'] = v_error_y.ColorValidator() - self._validators['symmetric'] = v_error_y.SymmetricValidator() - self._validators['thickness'] = v_error_y.ThicknessValidator() - self._validators['traceref'] = v_error_y.TracerefValidator() - self._validators['tracerefminus'] = v_error_y.TracerefminusValidator() - self._validators['type'] = v_error_y.TypeValidator() - self._validators['value'] = v_error_y.ValueValidator() - self._validators['valueminus'] = v_error_y.ValueminusValidator() - self._validators['visible'] = v_error_y.VisibleValidator() - self._validators['width'] = v_error_y.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('array', None) - self['array'] = array if array is not None else _v - _v = arg.pop('arrayminus', None) - self['arrayminus'] = arrayminus if arrayminus is not None else _v - _v = arg.pop('arrayminussrc', None) - self['arrayminussrc' - ] = arrayminussrc if arrayminussrc is not None else _v - _v = arg.pop('arraysrc', None) - self['arraysrc'] = arraysrc if arraysrc is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('symmetric', None) - self['symmetric'] = symmetric if symmetric is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('traceref', None) - self['traceref'] = traceref if traceref is not None else _v - _v = arg.pop('tracerefminus', None) - self['tracerefminus' - ] = tracerefminus if tracerefminus is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - _v = arg.pop('valueminus', None) - self['valueminus'] = valueminus if valueminus is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/_hoverlabel.py b/plotly/graph_objs/scattergl/_hoverlabel.py deleted file mode 100644 index 84414e9a102..00000000000 --- a/plotly/graph_objs/scattergl/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scattergl.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/_line.py b/plotly/graph_objs/scattergl/_line.py deleted file mode 100644 index 12b79fc0905..00000000000 --- a/plotly/graph_objs/scattergl/_line.py +++ /dev/null @@ -1,233 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dash - # ---- - @property - 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', - 'longdashdot'] - - Returns - ------- - Any - """ - return self['dash'] - - @dash.setter - def dash(self, val): - self['dash'] = val - - # shape - # ----- - @property - 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'] - - Returns - ------- - Any - """ - return self['shape'] - - @shape.setter - def shape(self, val): - self['shape'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the line color. - dash - Sets the style of the lines. - shape - Determines the line shape. The values correspond to - step-wise line shapes. - width - Sets the line width (in px). - """ - - def __init__( - self, - arg=None, - color=None, - dash=None, - shape=None, - width=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.Line - color - Sets the line color. - dash - Sets the style of the lines. - shape - Determines the line shape. The values correspond to - step-wise line shapes. - width - Sets the line width (in px). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.Line -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['dash'] = v_line.DashValidator() - self._validators['shape'] = v_line.ShapeValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dash', None) - self['dash'] = dash if dash is not None else _v - _v = arg.pop('shape', None) - self['shape'] = shape if shape is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/_marker.py b/plotly/graph_objs/scattergl/_marker.py deleted file mode 100644 index bec9afaec46..00000000000 --- a/plotly/graph_objs/scattergl/_marker.py +++ /dev/null @@ -1,1241 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in `marker.color`is - set to a numerical array. In case `colorscale` is unspecified - or `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` array are - all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.color`) or the - bounds set in `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical array. Defaults - to `false` when `marker.cmin` and `marker.cmax` are set by the - user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmin` - must be set as well. - - The 'cmax' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling `marker.cmin` - and/or `marker.cmax` to be equidistant to this point. Has an - effect only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color`. Has no - effect when `marker.cauto` is `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmax` - must be set as well. - - The 'cmin' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarkercolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scattergl.marker.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of 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 - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scattergl.marker.colorbar.Tic - kformatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scattergl.marker.colorbar.tickformatstopdefau - lts), sets the default property values to use - for elements of - scattergl.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scattergl.marker.colorbar.Tit - le instance or dict with compatible properties - titlefont - Deprecated: Please use - scattergl.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. - titleside - Deprecated: Please use - scattergl.marker.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.scattergl.marker.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in `marker.color`is - set to a numerical array. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At minimum, a mapping for - the lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` - may be a palette name string of the following list: Greys,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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.scattergl.marker.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # opacity - # ------- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # opacitysrc - # ---------- - @property - def opacitysrc(self): - """ - Sets the source reference on plot.ly for opacity . - - The 'opacitysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['opacitysrc'] - - @opacitysrc.setter - def opacitysrc(self, val): - self['opacitysrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.color`is set to a numerical array. If true, - `marker.cmin` will correspond to the last color in the array - and `marker.cmax` will correspond to the first color. - - The 'reversescale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # size - # ---- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizemin - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['sizemin'] - - @sizemin.setter - def sizemin(self, val): - self['sizemin'] = val - - # sizemode - # -------- - @property - 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'] - - Returns - ------- - Any - """ - return self['sizemode'] - - @sizemode.setter - def sizemode(self, val): - self['sizemode'] = val - - # sizeref - # ------- - @property - 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 - - Returns - ------- - int|float - """ - return self['sizeref'] - - @sizeref.setter - def sizeref(self, val): - self['sizeref'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # symbol - # ------ - @property - def symbol(self): - """ - Sets the marker symbol type. Adding 100 is equivalent to - appending "-open" to a symbol name. Adding 200 is equivalent to - appending "-dot" to a symbol name. Adding 300 is equivalent to - appending "-open-dot" or "dot-open" to a symbol name. - - The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', - 315, 'hexagon2-open-dot', 16, 'octagon', 116, - 'octagon-open', 216, 'octagon-dot', 316, - 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, - 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, - 'hexagram-open', 218, 'hexagram-dot', 318, - 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', - 120, 'star-triangle-down-open', 220, - 'star-triangle-down-dot', 320, - 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, - 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, - 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, - 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, - 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, - 'line-nw-open'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['symbol'] - - @symbol.setter - def symbol(self, val): - self['symbol'] = val - - # symbolsrc - # --------- - @property - def symbolsrc(self): - """ - Sets the source reference on plot.ly for symbol . - - The 'symbolsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['symbolsrc'] - - @symbolsrc.setter - def symbolsrc(self, val): - self['symbolsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scattergl.marker.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - line - plotly.graph_objs.scattergl.marker.Line instance or - dict with compatible properties - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorbar=None, - colorscale=None, - colorsrc=None, - line=None, - opacity=None, - opacitysrc=None, - reversescale=None, - showscale=None, - size=None, - sizemin=None, - sizemode=None, - sizeref=None, - sizesrc=None, - symbol=None, - symbolsrc=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.Marker - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scattergl.marker.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - line - plotly.graph_objs.scattergl.marker.Line instance or - dict with compatible properties - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() - self._validators['cauto'] = v_marker.CautoValidator() - self._validators['cmax'] = v_marker.CmaxValidator() - self._validators['cmid'] = v_marker.CmidValidator() - self._validators['cmin'] = v_marker.CminValidator() - self._validators['color'] = v_marker.ColorValidator() - self._validators['colorbar'] = v_marker.ColorBarValidator() - self._validators['colorscale'] = v_marker.ColorscaleValidator() - self._validators['colorsrc'] = v_marker.ColorsrcValidator() - self._validators['line'] = v_marker.LineValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() - self._validators['reversescale'] = v_marker.ReversescaleValidator() - self._validators['showscale'] = v_marker.ShowscaleValidator() - self._validators['size'] = v_marker.SizeValidator() - self._validators['sizemin'] = v_marker.SizeminValidator() - self._validators['sizemode'] = v_marker.SizemodeValidator() - self._validators['sizeref'] = v_marker.SizerefValidator() - self._validators['sizesrc'] = v_marker.SizesrcValidator() - self._validators['symbol'] = v_marker.SymbolValidator() - self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('opacitysrc', None) - self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizemin', None) - self['sizemin'] = sizemin if sizemin is not None else _v - _v = arg.pop('sizemode', None) - self['sizemode'] = sizemode if sizemode is not None else _v - _v = arg.pop('sizeref', None) - self['sizeref'] = sizeref if sizeref is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - _v = arg.pop('symbol', None) - self['symbol'] = symbol if symbol is not None else _v - _v = arg.pop('symbolsrc', None) - self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/_selected.py b/plotly/graph_objs/scattergl/_selected.py deleted file mode 100644 index 60d933f3df7..00000000000 --- a/plotly/graph_objs/scattergl/_selected.py +++ /dev/null @@ -1,146 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Selected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - plotly.graph_objs.scattergl.selected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.scattergl.selected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.scattergl.selected.Marker instance or - dict with compatible properties - textfont - plotly.graph_objs.scattergl.selected.Textfont instance - or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Selected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.Selected - marker - plotly.graph_objs.scattergl.selected.Marker instance or - dict with compatible properties - textfont - plotly.graph_objs.scattergl.selected.Textfont instance - or dict with compatible properties - - Returns - ------- - Selected - """ - super(Selected, self).__init__('selected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.Selected -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.Selected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl import (selected as v_selected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_selected.MarkerValidator() - self._validators['textfont'] = v_selected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/_stream.py b/plotly/graph_objs/scattergl/_stream.py deleted file mode 100644 index 64d39052bfd..00000000000 --- a/plotly/graph_objs/scattergl/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.Stream -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/_textfont.py b/plotly/graph_objs/scattergl/_textfont.py deleted file mode 100644 index 20c229a3acd..00000000000 --- a/plotly/graph_objs/scattergl/_textfont.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Textfont object - - Sets the text font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.Textfont - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl import (textfont as v_textfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - self._validators['colorsrc'] = v_textfont.ColorsrcValidator() - self._validators['family'] = v_textfont.FamilyValidator() - self._validators['familysrc'] = v_textfont.FamilysrcValidator() - self._validators['size'] = v_textfont.SizeValidator() - self._validators['sizesrc'] = v_textfont.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/_unselected.py b/plotly/graph_objs/scattergl/_unselected.py deleted file mode 100644 index 0e62f97d2a9..00000000000 --- a/plotly/graph_objs/scattergl/_unselected.py +++ /dev/null @@ -1,150 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Unselected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. - - Returns - ------- - plotly.graph_objs.scattergl.unselected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.scattergl.unselected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.scattergl.unselected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objs.scattergl.unselected.Textfont - instance or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Unselected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.Unselected - marker - plotly.graph_objs.scattergl.unselected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objs.scattergl.unselected.Textfont - instance or dict with compatible properties - - Returns - ------- - Unselected - """ - super(Unselected, self).__init__('unselected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.Unselected -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.Unselected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl import (unselected as v_unselected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_unselected.MarkerValidator() - self._validators['textfont'] = v_unselected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/hoverlabel/__init__.py b/plotly/graph_objs/scattergl/hoverlabel/__init__.py index c37b8b5cd28..67560af6c1a 100644 --- a/plotly/graph_objs/scattergl/hoverlabel/__init__.py +++ b/plotly/graph_objs/scattergl/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergl.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/hoverlabel/_font.py b/plotly/graph_objs/scattergl/hoverlabel/_font.py deleted file mode 100644 index bcc7ae4acda..00000000000 --- a/plotly/graph_objs/scattergl/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergl.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/marker/__init__.py b/plotly/graph_objs/scattergl/marker/__init__.py index 977c8947b3d..d39597c2786 100644 --- a/plotly/graph_objs/scattergl/marker/__init__.py +++ b/plotly/graph_objs/scattergl/marker/__init__.py @@ -1,3 +1,2446 @@ -from ._line import Line -from ._colorbar import ColorBar + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + 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) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color`is + 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 + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarker.linecolor. It accepts either a specific color or + an array of numbers that are mapped to the colorscale relative + to the max and min values of the array or relative to + `marker.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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scattergl.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized value + to an rgb, rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and highest (1) values + are required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color`is set to a numerical array. If true, + `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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergl.marker.Line + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.marker.Line +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.marker.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl.marker import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() + self._validators['cauto'] = v_line.CautoValidator() + self._validators['cmax'] = v_line.CmaxValidator() + self._validators['cmid'] = v_line.CmidValidator() + self._validators['cmin'] = v_line.CminValidator() + self._validators['color'] = v_line.ColorValidator() + self._validators['colorscale'] = v_line.ColorscaleValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['reversescale'] = v_line.ReversescaleValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scattergl.marker.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scattergl.mark + 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 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 + ------- + plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.scattergl.marker.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use scattergl.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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use scattergl.marker.colorbar.title.side + instead. Determines the location of color bar's title with + respect to the color bar. Note that the title's location used + to be set by the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scattergl.marker.colorbar.Tickformats + top instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rgl.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scattergl.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scattergl.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + scattergl.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. + titleside + Deprecated: Please use + scattergl.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergl.marker.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scattergl.marker.colorbar.Tickformats + top instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rgl.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scattergl.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scattergl.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + scattergl.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. + titleside + Deprecated: Please use + scattergl.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.marker.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.marker.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl.marker import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scattergl.marker import colorbar diff --git a/plotly/graph_objs/scattergl/marker/_colorbar.py b/plotly/graph_objs/scattergl/marker/_colorbar.py deleted file mode 100644 index d45fc622cc0..00000000000 --- a/plotly/graph_objs/scattergl/marker/_colorbar.py +++ /dev/null @@ -1,1867 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scattergl.marker.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.scattergl.mark - 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 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 - ------- - plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.scattergl.marker.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use scattergl.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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use scattergl.marker.colorbar.title.side - instead. Determines the location of color bar's title with - respect to the color bar. Note that the title's location used - to be set by the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scattergl.marker.colorbar.Tickformats - top instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - rgl.marker.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - scattergl.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scattergl.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - scattergl.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. - titleside - Deprecated: Please use - scattergl.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergl.marker.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scattergl.marker.colorbar.Tickformats - top instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - rgl.marker.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - scattergl.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scattergl.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - scattergl.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. - titleside - Deprecated: Please use - scattergl.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.marker.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.marker.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl.marker import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/marker/_line.py b/plotly/graph_objs/scattergl/marker/_line.py deleted file mode 100644 index bd524d63de6..00000000000 --- a/plotly/graph_objs/scattergl/marker/_line.py +++ /dev/null @@ -1,572 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is true, the - default palette will be chosen according to whether numbers in - the `color` array are all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.line.color`) or the - bounds set in `marker.line.cmin` and `marker.line.cmax` Has an - 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) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be equidistant - to this point. Has an effect only if in `marker.line.color`is - 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 - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarker.linecolor. It accepts either a specific color or - an array of numbers that are mapped to the colorscale relative - to the max and min values of the array or relative to - `marker.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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scattergl.marker.line.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized value - to an rgb, rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and highest (1) values - are required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the colorscale in - color space, use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.line.color`is set to a numerical array. If true, - `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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorscale=None, - colorsrc=None, - reversescale=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.marker.Line - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.marker.Line -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.marker.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl.marker import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() - self._validators['cauto'] = v_line.CautoValidator() - self._validators['cmax'] = v_line.CmaxValidator() - self._validators['cmid'] = v_line.CmidValidator() - self._validators['cmin'] = v_line.CminValidator() - self._validators['color'] = v_line.ColorValidator() - self._validators['colorscale'] = v_line.ColorscaleValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['reversescale'] = v_line.ReversescaleValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/marker/colorbar/__init__.py b/plotly/graph_objs/scattergl/marker/colorbar/__init__.py index a1e384aef0e..ed9abc2cf42 100644 --- a/plotly/graph_objs/scattergl/marker/colorbar/__init__.py +++ b/plotly/graph_objs/scattergl/marker/colorbar/__init__.py @@ -1,4 +1,725 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scattergl.marker.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergl.marker.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.marker.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.marker.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl.marker.colorbar import ( + title as v_title + ) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattergl.marker.color + bar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl.marker.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergl.marker.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.marker.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.marker.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl.marker.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scattergl.marker.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/scattergl/marker/colorbar/_tickfont.py b/plotly/graph_objs/scattergl/marker/colorbar/_tickfont.py deleted file mode 100644 index a7c0ac7aca4..00000000000 --- a/plotly/graph_objs/scattergl/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergl.marker.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.marker.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.marker.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl.marker.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py deleted file mode 100644 index e9ad6438995..00000000000 --- a/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattergl.marker.color - bar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl.marker.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/marker/colorbar/_title.py b/plotly/graph_objs/scattergl/marker/colorbar/_title.py deleted file mode 100644 index e706651a48d..00000000000 --- a/plotly/graph_objs/scattergl/marker/colorbar/_title.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scattergl.marker.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergl.marker.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.marker.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.marker.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl.marker.colorbar import ( - title as v_title - ) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/marker/colorbar/title/__init__.py b/plotly/graph_objs/scattergl/marker/colorbar/title/__init__.py index c37b8b5cd28..fd3a7e71991 100644 --- a/plotly/graph_objs/scattergl/marker/colorbar/title/__init__.py +++ b/plotly/graph_objs/scattergl/marker/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl.marker.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergl.marker.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.marker.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.marker.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl.marker.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/marker/colorbar/title/_font.py b/plotly/graph_objs/scattergl/marker/colorbar/title/_font.py deleted file mode 100644 index 076e2a6015f..00000000000 --- a/plotly/graph_objs/scattergl/marker/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl.marker.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergl.marker.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.marker.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.marker.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl.marker.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/selected/__init__.py b/plotly/graph_objs/scattergl/selected/__init__.py index adba53218ca..94186bc0c0a 100644 --- a/plotly/graph_objs/scattergl/selected/__init__.py +++ b/plotly/graph_objs/scattergl/selected/__init__.py @@ -1,2 +1,340 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergl.selected.Textfont + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.selected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.selected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl.selected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergl.selected.Marker + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.selected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.selected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl.selected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/selected/_marker.py b/plotly/graph_objs/scattergl/selected/_marker.py deleted file mode 100644 index c67c23724b0..00000000000 --- a/plotly/graph_objs/scattergl/selected/_marker.py +++ /dev/null @@ -1,195 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergl.selected.Marker - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.selected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.selected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl.selected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/selected/_textfont.py b/plotly/graph_objs/scattergl/selected/_textfont.py deleted file mode 100644 index 4e2b9a1e8b6..00000000000 --- a/plotly/graph_objs/scattergl/selected/_textfont.py +++ /dev/null @@ -1,141 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of selected points. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergl.selected.Textfont - color - Sets the text font color of selected points. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.selected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.selected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl.selected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/unselected/__init__.py b/plotly/graph_objs/scattergl/unselected/__init__.py index adba53218ca..e9c2632d64f 100644 --- a/plotly/graph_objs/scattergl/unselected/__init__.py +++ b/plotly/graph_objs/scattergl/unselected/__init__.py @@ -1,2 +1,352 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergl.unselected.Textfont + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.unselected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.unselected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl.unselected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattergl.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattergl.unselected.Marker + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattergl.unselected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scattergl.unselected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattergl.unselected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/unselected/_marker.py b/plotly/graph_objs/scattergl/unselected/_marker.py deleted file mode 100644 index 6ddfcca3c70..00000000000 --- a/plotly/graph_objs/scattergl/unselected/_marker.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergl.unselected.Marker - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.unselected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.unselected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl.unselected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattergl/unselected/_textfont.py b/plotly/graph_objs/scattergl/unselected/_textfont.py deleted file mode 100644 index e8029092a27..00000000000 --- a/plotly/graph_objs/scattergl/unselected/_textfont.py +++ /dev/null @@ -1,144 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattergl.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of unselected points, applied - only when a selection exists. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattergl.unselected.Textfont - color - Sets the text font color of unselected points, applied - only when a selection exists. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattergl.unselected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scattergl.unselected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattergl.unselected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/__init__.py b/plotly/graph_objs/scattermapbox/__init__.py index 61c48854a1a..e47f32c5b16 100644 --- a/plotly/graph_objs/scattermapbox/__init__.py +++ b/plotly/graph_objs/scattermapbox/__init__.py @@ -1,11 +1,2262 @@ -from ._unselected import Unselected + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. + + Returns + ------- + plotly.graph_objs.scattermapbox.unselected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattermapbox' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.scattermapbox.unselected.Marker + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattermapbox.Unselected + marker + plotly.graph_objs.scattermapbox.unselected.Marker + instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super(Unselected, self).__init__('unselected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattermapbox.Unselected +constructor must be a dict or +an instance of plotly.graph_objs.scattermapbox.Unselected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattermapbox import ( + unselected as v_unselected + ) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_unselected.MarkerValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattermapbox' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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". + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattermapbox.Textfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattermapbox.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scattermapbox.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattermapbox import (textfont as v_textfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + self._validators['family'] = v_textfont.FamilyValidator() + self._validators['size'] = v_textfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattermapbox' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattermapbox.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattermapbox.Stream +constructor must be a dict or +an instance of plotly.graph_objs.scattermapbox.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattermapbox import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + plotly.graph_objs.scattermapbox.selected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattermapbox' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.scattermapbox.selected.Marker + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattermapbox.Selected + marker + plotly.graph_objs.scattermapbox.selected.Marker + instance or dict with compatible properties + + Returns + ------- + Selected + """ + super(Selected, self).__init__('selected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattermapbox.Selected +constructor must be a dict or +an instance of plotly.graph_objs.scattermapbox.Selected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattermapbox import (selected as v_selected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_selected.MarkerValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color`is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` array are + all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmin` + must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmax` + must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarkercolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scattermapbox.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of 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 + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scattermapbox.marker.colorbar + .Tickformatstop instance or dict with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scattermapbox.marker.colorbar.tickformatstopd + efaults), sets the default property values to + use for elements of + scattermapbox.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scattermapbox.marker.colorbar + .Title instance or dict with compatible + properties + titlefont + Deprecated: Please use + scattermapbox.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. + titleside + Deprecated: Please use + scattermapbox.marker.colorbar.title.side + instead. Determines the location of color bar's + title with respect to the color bar. Note that + the title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.scattermapbox.marker.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color`is + set to a numerical array. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At minimum, a mapping for + the lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Greys,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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # opacity + # ------- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # opacitysrc + # ---------- + @property + def opacitysrc(self): + """ + Sets the source reference on plot.ly for opacity . + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['opacitysrc'] + + @opacitysrc.setter + def opacitysrc(self, val): + self['opacitysrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color`is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # size + # ---- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizemin + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['sizemin'] + + @sizemin.setter + def sizemin(self, val): + self['sizemin'] = val + + # sizemode + # -------- + @property + 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'] + + Returns + ------- + Any + """ + return self['sizemode'] + + @sizemode.setter + def sizemode(self, val): + self['sizemode'] = val + + # sizeref + # ------- + @property + 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 + + Returns + ------- + int|float + """ + return self['sizeref'] + + @sizeref.setter + def sizeref(self, val): + self['sizeref'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # symbol + # ------ + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['symbol'] + + @symbol.setter + def symbol(self, val): + self['symbol'] = val + + # symbolsrc + # --------- + @property + def symbolsrc(self): + """ + Sets the source reference on plot.ly for symbol . + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['symbolsrc'] + + @symbolsrc.setter + def symbolsrc(self, val): + self['symbolsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattermapbox' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scattermapbox.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol. Full list: + https://www.mapbox.com/maki-icons/ Note that the array + `marker.color` and `marker.size` are only available for + "circle" symbols. + symbolsrc + Sets the source reference on plot.ly for symbol . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorbar=None, + colorscale=None, + colorsrc=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattermapbox.Marker + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scattermapbox.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol. Full list: + https://www.mapbox.com/maki-icons/ Note that the array + `marker.color` and `marker.size` are only available for + "circle" symbols. + symbolsrc + Sets the source reference on plot.ly for symbol . + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattermapbox.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scattermapbox.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattermapbox import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() + self._validators['cauto'] = v_marker.CautoValidator() + self._validators['cmax'] = v_marker.CmaxValidator() + self._validators['cmid'] = v_marker.CmidValidator() + self._validators['cmin'] = v_marker.CminValidator() + self._validators['color'] = v_marker.ColorValidator() + self._validators['colorbar'] = v_marker.ColorBarValidator() + self._validators['colorscale'] = v_marker.ColorscaleValidator() + self._validators['colorsrc'] = v_marker.ColorsrcValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() + self._validators['reversescale'] = v_marker.ReversescaleValidator() + self._validators['showscale'] = v_marker.ShowscaleValidator() + self._validators['size'] = v_marker.SizeValidator() + self._validators['sizemin'] = v_marker.SizeminValidator() + self._validators['sizemode'] = v_marker.SizemodeValidator() + self._validators['sizeref'] = v_marker.SizerefValidator() + self._validators['sizesrc'] = v_marker.SizesrcValidator() + self._validators['symbol'] = v_marker.SymbolValidator() + self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('opacitysrc', None) + self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizemin', None) + self['sizemin'] = sizemin if sizemin is not None else _v + _v = arg.pop('sizemode', None) + self['sizemode'] = sizemode if sizemode is not None else _v + _v = arg.pop('sizeref', None) + self['sizeref'] = sizeref if sizeref is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + _v = arg.pop('symbol', None) + self['symbol'] = symbol if symbol is not None else _v + _v = arg.pop('symbolsrc', None) + self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattermapbox' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattermapbox.Line + color + Sets the line color. + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattermapbox.Line +constructor must be a dict or +an instance of plotly.graph_objs.scattermapbox.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattermapbox import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scattermapbox.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattermapbox' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattermapbox.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattermapbox.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.scattermapbox.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattermapbox import ( + hoverlabel as v_hoverlabel + ) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scattermapbox import unselected -from ._textfont import Textfont -from ._stream import Stream -from ._selected import Selected from plotly.graph_objs.scattermapbox import selected -from ._marker import Marker from plotly.graph_objs.scattermapbox import marker -from ._line import Line -from ._hoverlabel import Hoverlabel from plotly.graph_objs.scattermapbox import hoverlabel diff --git a/plotly/graph_objs/scattermapbox/_hoverlabel.py b/plotly/graph_objs/scattermapbox/_hoverlabel.py deleted file mode 100644 index 4919da951dc..00000000000 --- a/plotly/graph_objs/scattermapbox/_hoverlabel.py +++ /dev/null @@ -1,417 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scattermapbox.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattermapbox' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattermapbox.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattermapbox.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattermapbox import ( - hoverlabel as v_hoverlabel - ) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/_line.py b/plotly/graph_objs/scattermapbox/_line.py deleted file mode 100644 index 96f5c91e05c..00000000000 --- a/plotly/graph_objs/scattermapbox/_line.py +++ /dev/null @@ -1,165 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattermapbox' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the line color. - width - Sets the line width (in px). - """ - - def __init__(self, arg=None, color=None, width=None, **kwargs): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattermapbox.Line - color - Sets the line color. - width - Sets the line width (in px). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattermapbox.Line -constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattermapbox import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/_marker.py b/plotly/graph_objs/scattermapbox/_marker.py deleted file mode 100644 index 8ba29b4b3a7..00000000000 --- a/plotly/graph_objs/scattermapbox/_marker.py +++ /dev/null @@ -1,1066 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in `marker.color`is - set to a numerical array. In case `colorscale` is unspecified - or `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` array are - all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.color`) or the - bounds set in `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical array. Defaults - to `false` when `marker.cmin` and `marker.cmax` are set by the - user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmin` - must be set as well. - - The 'cmax' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling `marker.cmin` - and/or `marker.cmax` to be equidistant to this point. Has an - effect only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color`. Has no - effect when `marker.cauto` is `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmax` - must be set as well. - - The 'cmin' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarkercolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scattermapbox.marker.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of 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 - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scattermapbox.marker.colorbar - .Tickformatstop instance or dict with - compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scattermapbox.marker.colorbar.tickformatstopd - efaults), sets the default property values to - use for elements of - scattermapbox.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scattermapbox.marker.colorbar - .Title instance or dict with compatible - properties - titlefont - Deprecated: Please use - scattermapbox.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. - titleside - Deprecated: Please use - scattermapbox.marker.colorbar.title.side - instead. Determines the location of color bar's - title with respect to the color bar. Note that - the title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.scattermapbox.marker.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in `marker.color`is - set to a numerical array. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At minimum, a mapping for - the lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` - may be a palette name string of the following list: Greys,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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # opacity - # ------- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # opacitysrc - # ---------- - @property - def opacitysrc(self): - """ - Sets the source reference on plot.ly for opacity . - - The 'opacitysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['opacitysrc'] - - @opacitysrc.setter - def opacitysrc(self, val): - self['opacitysrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.color`is set to a numerical array. If true, - `marker.cmin` will correspond to the last color in the array - and `marker.cmax` will correspond to the first color. - - The 'reversescale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # size - # ---- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizemin - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['sizemin'] - - @sizemin.setter - def sizemin(self, val): - self['sizemin'] = val - - # sizemode - # -------- - @property - 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'] - - Returns - ------- - Any - """ - return self['sizemode'] - - @sizemode.setter - def sizemode(self, val): - self['sizemode'] = val - - # sizeref - # ------- - @property - 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 - - Returns - ------- - int|float - """ - return self['sizeref'] - - @sizeref.setter - def sizeref(self, val): - self['sizeref'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # symbol - # ------ - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['symbol'] - - @symbol.setter - def symbol(self, val): - self['symbol'] = val - - # symbolsrc - # --------- - @property - def symbolsrc(self): - """ - Sets the source reference on plot.ly for symbol . - - The 'symbolsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['symbolsrc'] - - @symbolsrc.setter - def symbolsrc(self, val): - self['symbolsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattermapbox' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scattermapbox.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol. Full list: - https://www.mapbox.com/maki-icons/ Note that the array - `marker.color` and `marker.size` are only available for - "circle" symbols. - symbolsrc - Sets the source reference on plot.ly for symbol . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorbar=None, - colorscale=None, - colorsrc=None, - opacity=None, - opacitysrc=None, - reversescale=None, - showscale=None, - size=None, - sizemin=None, - sizemode=None, - sizeref=None, - sizesrc=None, - symbol=None, - symbolsrc=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattermapbox.Marker - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scattermapbox.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol. Full list: - https://www.mapbox.com/maki-icons/ Note that the array - `marker.color` and `marker.size` are only available for - "circle" symbols. - symbolsrc - Sets the source reference on plot.ly for symbol . - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattermapbox.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattermapbox import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() - self._validators['cauto'] = v_marker.CautoValidator() - self._validators['cmax'] = v_marker.CmaxValidator() - self._validators['cmid'] = v_marker.CmidValidator() - self._validators['cmin'] = v_marker.CminValidator() - self._validators['color'] = v_marker.ColorValidator() - self._validators['colorbar'] = v_marker.ColorBarValidator() - self._validators['colorscale'] = v_marker.ColorscaleValidator() - self._validators['colorsrc'] = v_marker.ColorsrcValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() - self._validators['reversescale'] = v_marker.ReversescaleValidator() - self._validators['showscale'] = v_marker.ShowscaleValidator() - self._validators['size'] = v_marker.SizeValidator() - self._validators['sizemin'] = v_marker.SizeminValidator() - self._validators['sizemode'] = v_marker.SizemodeValidator() - self._validators['sizeref'] = v_marker.SizerefValidator() - self._validators['sizesrc'] = v_marker.SizesrcValidator() - self._validators['symbol'] = v_marker.SymbolValidator() - self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('opacitysrc', None) - self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizemin', None) - self['sizemin'] = sizemin if sizemin is not None else _v - _v = arg.pop('sizemode', None) - self['sizemode'] = sizemode if sizemode is not None else _v - _v = arg.pop('sizeref', None) - self['sizeref'] = sizeref if sizeref is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - _v = arg.pop('symbol', None) - self['symbol'] = symbol if symbol is not None else _v - _v = arg.pop('symbolsrc', None) - self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/_selected.py b/plotly/graph_objs/scattermapbox/_selected.py deleted file mode 100644 index d830c425b5f..00000000000 --- a/plotly/graph_objs/scattermapbox/_selected.py +++ /dev/null @@ -1,111 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Selected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - plotly.graph_objs.scattermapbox.selected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattermapbox' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.scattermapbox.selected.Marker - instance or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, **kwargs): - """ - Construct a new Selected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattermapbox.Selected - marker - plotly.graph_objs.scattermapbox.selected.Marker - instance or dict with compatible properties - - Returns - ------- - Selected - """ - super(Selected, self).__init__('selected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattermapbox.Selected -constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.Selected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattermapbox import (selected as v_selected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_selected.MarkerValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/_stream.py b/plotly/graph_objs/scattermapbox/_stream.py deleted file mode 100644 index 581ea86ecdb..00000000000 --- a/plotly/graph_objs/scattermapbox/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattermapbox' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattermapbox.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattermapbox.Stream -constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattermapbox import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/_textfont.py b/plotly/graph_objs/scattermapbox/_textfont.py deleted file mode 100644 index 983c2e2c094..00000000000 --- a/plotly/graph_objs/scattermapbox/_textfont.py +++ /dev/null @@ -1,227 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattermapbox' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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". - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattermapbox.Textfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattermapbox.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattermapbox import (textfont as v_textfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - self._validators['family'] = v_textfont.FamilyValidator() - self._validators['size'] = v_textfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/_unselected.py b/plotly/graph_objs/scattermapbox/_unselected.py deleted file mode 100644 index 097cc5fde6e..00000000000 --- a/plotly/graph_objs/scattermapbox/_unselected.py +++ /dev/null @@ -1,117 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Unselected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. - - Returns - ------- - plotly.graph_objs.scattermapbox.unselected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattermapbox' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.scattermapbox.unselected.Marker - instance or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, **kwargs): - """ - Construct a new Unselected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattermapbox.Unselected - marker - plotly.graph_objs.scattermapbox.unselected.Marker - instance or dict with compatible properties - - Returns - ------- - Unselected - """ - super(Unselected, self).__init__('unselected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattermapbox.Unselected -constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.Unselected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattermapbox import ( - unselected as v_unselected - ) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_unselected.MarkerValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/hoverlabel/__init__.py b/plotly/graph_objs/scattermapbox/hoverlabel/__init__.py index c37b8b5cd28..ec9f824b122 100644 --- a/plotly/graph_objs/scattermapbox/hoverlabel/__init__.py +++ b/plotly/graph_objs/scattermapbox/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattermapbox.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattermapbox.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattermapbox.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.scattermapbox.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattermapbox.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/hoverlabel/_font.py b/plotly/graph_objs/scattermapbox/hoverlabel/_font.py deleted file mode 100644 index ff8ff0f455c..00000000000 --- a/plotly/graph_objs/scattermapbox/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattermapbox.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattermapbox.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattermapbox.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattermapbox.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/marker/__init__.py b/plotly/graph_objs/scattermapbox/marker/__init__.py index cb92c8b0bbc..25930e13080 100644 --- a/plotly/graph_objs/scattermapbox/marker/__init__.py +++ b/plotly/graph_objs/scattermapbox/marker/__init__.py @@ -1,2 +1,1876 @@ -from ._colorbar import ColorBar + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scattermapbox. + 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 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 + ------- + plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.scattermapbox.marker.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use scattermapbox.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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use scattermapbox.marker.colorbar.title.side + instead. Determines the location of color bar's title with + respect to the color bar. Note that the title's location used + to be set by the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattermapbox.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scattermapbox.marker.colorbar.Tickfor + matstop instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rmapbox.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scattermapbox.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scattermapbox.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + scattermapbox.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. + titleside + Deprecated: Please use + scattermapbox.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattermapbox.marker.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scattermapbox.marker.colorbar.Tickfor + matstop instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rmapbox.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scattermapbox.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scattermapbox.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + scattermapbox.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. + titleside + Deprecated: Please use + scattermapbox.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattermapbox.marker.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.scattermapbox.marker.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattermapbox.marker import ( + colorbar as v_colorbar + ) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scattermapbox.marker import colorbar diff --git a/plotly/graph_objs/scattermapbox/marker/_colorbar.py b/plotly/graph_objs/scattermapbox/marker/_colorbar.py deleted file mode 100644 index 1bdb0989cf5..00000000000 --- a/plotly/graph_objs/scattermapbox/marker/_colorbar.py +++ /dev/null @@ -1,1871 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.scattermapbox. - 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 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 - ------- - plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.scattermapbox.marker.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use scattermapbox.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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use scattermapbox.marker.colorbar.title.side - instead. Determines the location of color bar's title with - respect to the color bar. Note that the title's location used - to be set by the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattermapbox.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scattermapbox.marker.colorbar.Tickfor - matstop instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - rmapbox.marker.colorbar.tickformatstopdefaults), sets - the default property values to use for elements of - scattermapbox.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scattermapbox.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - scattermapbox.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. - titleside - Deprecated: Please use - scattermapbox.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattermapbox.marker.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scattermapbox.marker.colorbar.Tickfor - matstop instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - rmapbox.marker.colorbar.tickformatstopdefaults), sets - the default property values to use for elements of - scattermapbox.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scattermapbox.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - scattermapbox.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. - titleside - Deprecated: Please use - scattermapbox.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattermapbox.marker.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.marker.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattermapbox.marker import ( - colorbar as v_colorbar - ) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/marker/colorbar/__init__.py b/plotly/graph_objs/scattermapbox/marker/colorbar/__init__.py index 209f2c36229..57e76f9c131 100644 --- a/plotly/graph_objs/scattermapbox/marker/colorbar/__init__.py +++ b/plotly/graph_objs/scattermapbox/marker/colorbar/__init__.py @@ -1,4 +1,725 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scattermapbox.marker.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattermapbox.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattermapbox.marker.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattermapbox.marker.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.scattermapbox.marker.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattermapbox.marker.colorbar import ( + title as v_title + ) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattermapbox.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattermapbox.marker.c + olorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattermapbox.marker.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattermapbox.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattermapbox.marker.c + olorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattermapbox.marker.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scattermapbox.marker.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/scattermapbox/marker/colorbar/_tickfont.py b/plotly/graph_objs/scattermapbox/marker/colorbar/_tickfont.py deleted file mode 100644 index 19b16288a9b..00000000000 --- a/plotly/graph_objs/scattermapbox/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattermapbox.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattermapbox.marker.c - olorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattermapbox.marker.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py deleted file mode 100644 index 88483bcb4d4..00000000000 --- a/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattermapbox.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattermapbox.marker.c - olorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattermapbox.marker.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/marker/colorbar/_title.py b/plotly/graph_objs/scattermapbox/marker/colorbar/_title.py deleted file mode 100644 index 492cf5c296c..00000000000 --- a/plotly/graph_objs/scattermapbox/marker/colorbar/_title.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scattermapbox.marker.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattermapbox.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattermapbox.marker.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattermapbox.marker.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.marker.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattermapbox.marker.colorbar import ( - title as v_title - ) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/marker/colorbar/title/__init__.py b/plotly/graph_objs/scattermapbox/marker/colorbar/title/__init__.py index c37b8b5cd28..9f986b9be58 100644 --- a/plotly/graph_objs/scattermapbox/marker/colorbar/title/__init__.py +++ b/plotly/graph_objs/scattermapbox/marker/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattermapbox.marker.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scattermapbox.marker.c + olorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattermapbox.marker.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.scattermapbox.marker.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattermapbox.marker.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/marker/colorbar/title/_font.py b/plotly/graph_objs/scattermapbox/marker/colorbar/title/_font.py deleted file mode 100644 index d97dc42c6d9..00000000000 --- a/plotly/graph_objs/scattermapbox/marker/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattermapbox.marker.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scattermapbox.marker.c - olorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattermapbox.marker.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.marker.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattermapbox.marker.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/selected/__init__.py b/plotly/graph_objs/scattermapbox/selected/__init__.py index 0bda16c3500..830a35190bd 100644 --- a/plotly/graph_objs/scattermapbox/selected/__init__.py +++ b/plotly/graph_objs/scattermapbox/selected/__init__.py @@ -1 +1,199 @@ -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattermapbox.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattermapbox.selected.Marker + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattermapbox.selected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scattermapbox.selected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattermapbox.selected import ( + marker as v_marker + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/selected/_marker.py b/plotly/graph_objs/scattermapbox/selected/_marker.py deleted file mode 100644 index fd0c6218ebd..00000000000 --- a/plotly/graph_objs/scattermapbox/selected/_marker.py +++ /dev/null @@ -1,197 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattermapbox.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattermapbox.selected.Marker - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattermapbox.selected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.selected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattermapbox.selected import ( - marker as v_marker - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/unselected/__init__.py b/plotly/graph_objs/scattermapbox/unselected/__init__.py index 0bda16c3500..bdaebca54c4 100644 --- a/plotly/graph_objs/scattermapbox/unselected/__init__.py +++ b/plotly/graph_objs/scattermapbox/unselected/__init__.py @@ -1 +1,208 @@ -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scattermapbox.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scattermapbox.unselected.Marker + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scattermapbox.unselected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scattermapbox.unselected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scattermapbox.unselected import ( + marker as v_marker + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scattermapbox/unselected/_marker.py b/plotly/graph_objs/scattermapbox/unselected/_marker.py deleted file mode 100644 index 88a467df948..00000000000 --- a/plotly/graph_objs/scattermapbox/unselected/_marker.py +++ /dev/null @@ -1,206 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scattermapbox.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scattermapbox.unselected.Marker - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scattermapbox.unselected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scattermapbox.unselected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scattermapbox.unselected import ( - marker as v_marker - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/__init__.py b/plotly/graph_objs/scatterpolar/__init__.py index 0ee49c4eb33..5e530cd2513 100644 --- a/plotly/graph_objs/scatterpolar/__init__.py +++ b/plotly/graph_objs/scatterpolar/__init__.py @@ -1,11 +1,2790 @@ -from ._unselected import Unselected + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. + + Returns + ------- + plotly.graph_objs.scatterpolar.unselected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.scatterpolar.unselected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.scatterpolar.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scatterpolar.unselected.Textfont + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolar.Unselected + marker + plotly.graph_objs.scatterpolar.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scatterpolar.unselected.Textfont + instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super(Unselected, self).__init__('unselected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.Unselected +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.Unselected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar import (unselected as v_unselected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_unselected.MarkerValidator() + self._validators['textfont'] = v_unselected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterpolar.Textfont + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar import (textfont as v_textfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + self._validators['colorsrc'] = v_textfont.ColorsrcValidator() + self._validators['family'] = v_textfont.FamilyValidator() + self._validators['familysrc'] = v_textfont.FamilysrcValidator() + self._validators['size'] = v_textfont.SizeValidator() + self._validators['sizesrc'] = v_textfont.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterpolar.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.Stream +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + plotly.graph_objs.scatterpolar.selected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.scatterpolar.selected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.scatterpolar.selected.Marker instance + or dict with compatible properties + textfont + plotly.graph_objs.scatterpolar.selected.Textfont + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterpolar.Selected + marker + plotly.graph_objs.scatterpolar.selected.Marker instance + or dict with compatible properties + textfont + plotly.graph_objs.scatterpolar.selected.Textfont + instance or dict with compatible properties + + Returns + ------- + Selected + """ + super(Selected, self).__init__('selected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.Selected +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.Selected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar import (selected as v_selected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_selected.MarkerValidator() + self._validators['textfont'] = v_selected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color`is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` array are + all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmin` + must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmax` + must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarkercolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scatterpolar.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of 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 + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scatterpolar.marker.colorbar. + Tickformatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scatterpolar.marker.colorbar.tickformatstopde + faults), sets the default property values to + use for elements of + scatterpolar.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatterpolar.marker.colorbar. + Title instance or dict with compatible + properties + titlefont + Deprecated: Please use + scatterpolar.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. + titleside + Deprecated: Please use + scatterpolar.marker.colorbar.title.side + instead. Determines the location of color bar's + title with respect to the color bar. Note that + the title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.scatterpolar.marker.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color`is + set to a numerical array. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At minimum, a mapping for + the lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Greys,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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # gradient + # -------- + @property + def gradient(self): + """ + The 'gradient' property is an instance of Gradient + that may be specified as: + - An instance of 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 + horizontal, or the bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color + . + type + Sets the type of gradient used to fill the + markers + typesrc + Sets the source reference on plot.ly for type + . + + Returns + ------- + plotly.graph_objs.scatterpolar.marker.Gradient + """ + return self['gradient'] + + @gradient.setter + def gradient(self, val): + self['gradient'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.scatterpolar.marker.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # maxdisplayed + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['maxdisplayed'] + + @maxdisplayed.setter + def maxdisplayed(self, val): + self['maxdisplayed'] = val + + # opacity + # ------- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # opacitysrc + # ---------- + @property + def opacitysrc(self): + """ + Sets the source reference on plot.ly for opacity . + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['opacitysrc'] + + @opacitysrc.setter + def opacitysrc(self, val): + self['opacitysrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color`is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # size + # ---- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizemin + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['sizemin'] + + @sizemin.setter + def sizemin(self, val): + self['sizemin'] = val + + # sizemode + # -------- + @property + 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'] + + Returns + ------- + Any + """ + return self['sizemode'] + + @sizemode.setter + def sizemode(self, val): + self['sizemode'] = val + + # sizeref + # ------- + @property + 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 + + Returns + ------- + int|float + """ + return self['sizeref'] + + @sizeref.setter + def sizeref(self, val): + self['sizeref'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # symbol + # ------ + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', + 315, 'hexagon2-open-dot', 16, 'octagon', 116, + 'octagon-open', 216, 'octagon-dot', 316, + 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, + 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, + 'hexagram-open', 218, 'hexagram-dot', 318, + 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', + 120, 'star-triangle-down-open', 220, + 'star-triangle-down-dot', 320, + 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, + 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, + 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, + 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, + 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, + 'line-nw-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['symbol'] + + @symbol.setter + def symbol(self, val): + self['symbol'] = val + + # symbolsrc + # --------- + @property + def symbolsrc(self): + """ + Sets the source reference on plot.ly for symbol . + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['symbolsrc'] + + @symbolsrc.setter + def symbolsrc(self, val): + self['symbolsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scatterpolar.marker.ColorBar instance + or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + gradient + plotly.graph_objs.scatterpolar.marker.Gradient instance + or dict with compatible properties + line + plotly.graph_objs.scatterpolar.marker.Line instance or + dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorbar=None, + colorscale=None, + colorsrc=None, + gradient=None, + line=None, + maxdisplayed=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterpolar.Marker + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scatterpolar.marker.ColorBar instance + or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + gradient + plotly.graph_objs.scatterpolar.marker.Gradient instance + or dict with compatible properties + line + plotly.graph_objs.scatterpolar.marker.Line instance or + dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() + self._validators['cauto'] = v_marker.CautoValidator() + self._validators['cmax'] = v_marker.CmaxValidator() + self._validators['cmid'] = v_marker.CmidValidator() + self._validators['cmin'] = v_marker.CminValidator() + self._validators['color'] = v_marker.ColorValidator() + self._validators['colorbar'] = v_marker.ColorBarValidator() + self._validators['colorscale'] = v_marker.ColorscaleValidator() + self._validators['colorsrc'] = v_marker.ColorsrcValidator() + self._validators['gradient'] = v_marker.GradientValidator() + self._validators['line'] = v_marker.LineValidator() + self._validators['maxdisplayed'] = v_marker.MaxdisplayedValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() + self._validators['reversescale'] = v_marker.ReversescaleValidator() + self._validators['showscale'] = v_marker.ShowscaleValidator() + self._validators['size'] = v_marker.SizeValidator() + self._validators['sizemin'] = v_marker.SizeminValidator() + self._validators['sizemode'] = v_marker.SizemodeValidator() + self._validators['sizeref'] = v_marker.SizerefValidator() + self._validators['sizesrc'] = v_marker.SizesrcValidator() + self._validators['symbol'] = v_marker.SymbolValidator() + self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('gradient', None) + self['gradient'] = gradient if gradient is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('maxdisplayed', None) + self['maxdisplayed'] = maxdisplayed if maxdisplayed is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('opacitysrc', None) + self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizemin', None) + self['sizemin'] = sizemin if sizemin is not None else _v + _v = arg.pop('sizemode', None) + self['sizemode'] = sizemode if sizemode is not None else _v + _v = arg.pop('sizeref', None) + self['sizeref'] = sizeref if sizeref is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + _v = arg.pop('symbol', None) + self['symbol'] = symbol if symbol is not None else _v + _v = arg.pop('symbolsrc', None) + self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dash + # ---- + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self['dash'] + + @dash.setter + def dash(self, val): + self['dash'] = val + + # shape + # ----- + @property + 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'] + + Returns + ------- + Any + """ + return self['shape'] + + @shape.setter + def shape(self, val): + self['shape'] = val + + # smoothing + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['smoothing'] + + @smoothing.setter + def smoothing(self, val): + self['smoothing'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + """ + + def __init__( + self, + arg=None, + color=None, + dash=None, + shape=None, + smoothing=None, + width=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterpolar.Line + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.Line +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['dash'] = v_line.DashValidator() + self._validators['shape'] = v_line.ShapeValidator() + self._validators['smoothing'] = v_line.SmoothingValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dash', None) + self['dash'] = dash if dash is not None else _v + _v = arg.pop('shape', None) + self['shape'] = shape if shape is not None else _v + _v = arg.pop('smoothing', None) + self['smoothing'] = smoothing if smoothing is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scatterpolar.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolar.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scatterpolar import unselected -from ._textfont import Textfont -from ._stream import Stream -from ._selected import Selected from plotly.graph_objs.scatterpolar import selected -from ._marker import Marker from plotly.graph_objs.scatterpolar import marker -from ._line import Line -from ._hoverlabel import Hoverlabel from plotly.graph_objs.scatterpolar import hoverlabel diff --git a/plotly/graph_objs/scatterpolar/_hoverlabel.py b/plotly/graph_objs/scatterpolar/_hoverlabel.py deleted file mode 100644 index 361148fb21c..00000000000 --- a/plotly/graph_objs/scatterpolar/_hoverlabel.py +++ /dev/null @@ -1,415 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scatterpolar.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/_line.py b/plotly/graph_objs/scatterpolar/_line.py deleted file mode 100644 index 2421a0579ae..00000000000 --- a/plotly/graph_objs/scatterpolar/_line.py +++ /dev/null @@ -1,280 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dash - # ---- - @property - def dash(self): - """ - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - - The 'dash' property is an enumeration that may be specified as: - - One of the following dash styles: - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - - A string containing a dash length list in pixels or percentages - (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) - - Returns - ------- - str - """ - return self['dash'] - - @dash.setter - def dash(self, val): - self['dash'] = val - - # shape - # ----- - @property - 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'] - - Returns - ------- - Any - """ - return self['shape'] - - @shape.setter - def shape(self, val): - self['shape'] = val - - # smoothing - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['smoothing'] - - @smoothing.setter - def smoothing(self, val): - self['smoothing'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - shape - Determines the line shape. With "spline" the lines are - drawn using spline interpolation. The other available - values correspond to step-wise line shapes. - smoothing - Has an effect only if `shape` is set to "spline" Sets - the amount of smoothing. 0 corresponds to no smoothing - (equivalent to a "linear" shape). - width - Sets the line width (in px). - """ - - def __init__( - self, - arg=None, - color=None, - dash=None, - shape=None, - smoothing=None, - width=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolar.Line - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - shape - Determines the line shape. With "spline" the lines are - drawn using spline interpolation. The other available - values correspond to step-wise line shapes. - smoothing - Has an effect only if `shape` is set to "spline" Sets - the amount of smoothing. 0 corresponds to no smoothing - (equivalent to a "linear" shape). - width - Sets the line width (in px). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.Line -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['dash'] = v_line.DashValidator() - self._validators['shape'] = v_line.ShapeValidator() - self._validators['smoothing'] = v_line.SmoothingValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dash', None) - self['dash'] = dash if dash is not None else _v - _v = arg.pop('shape', None) - self['shape'] = shape if shape is not None else _v - _v = arg.pop('smoothing', None) - self['smoothing'] = smoothing if smoothing is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/_marker.py b/plotly/graph_objs/scatterpolar/_marker.py deleted file mode 100644 index acceed13377..00000000000 --- a/plotly/graph_objs/scatterpolar/_marker.py +++ /dev/null @@ -1,1320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in `marker.color`is - set to a numerical array. In case `colorscale` is unspecified - or `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` array are - all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.color`) or the - bounds set in `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical array. Defaults - to `false` when `marker.cmin` and `marker.cmax` are set by the - user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmin` - must be set as well. - - The 'cmax' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling `marker.cmin` - and/or `marker.cmax` to be equidistant to this point. Has an - effect only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color`. Has no - effect when `marker.cauto` is `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmax` - must be set as well. - - The 'cmin' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarkercolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scatterpolar.marker.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of 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 - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scatterpolar.marker.colorbar. - Tickformatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scatterpolar.marker.colorbar.tickformatstopde - faults), sets the default property values to - use for elements of - scatterpolar.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatterpolar.marker.colorbar. - Title instance or dict with compatible - properties - titlefont - Deprecated: Please use - scatterpolar.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. - titleside - Deprecated: Please use - scatterpolar.marker.colorbar.title.side - instead. Determines the location of color bar's - title with respect to the color bar. Note that - the title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.scatterpolar.marker.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in `marker.color`is - set to a numerical array. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At minimum, a mapping for - the lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` - may be a palette name string of the following list: Greys,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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # gradient - # -------- - @property - def gradient(self): - """ - The 'gradient' property is an instance of Gradient - that may be specified as: - - An instance of 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 - horizontal, or the bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color - . - type - Sets the type of gradient used to fill the - markers - typesrc - Sets the source reference on plot.ly for type - . - - Returns - ------- - plotly.graph_objs.scatterpolar.marker.Gradient - """ - return self['gradient'] - - @gradient.setter - def gradient(self, val): - self['gradient'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.scatterpolar.marker.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # maxdisplayed - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['maxdisplayed'] - - @maxdisplayed.setter - def maxdisplayed(self, val): - self['maxdisplayed'] = val - - # opacity - # ------- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # opacitysrc - # ---------- - @property - def opacitysrc(self): - """ - Sets the source reference on plot.ly for opacity . - - The 'opacitysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['opacitysrc'] - - @opacitysrc.setter - def opacitysrc(self, val): - self['opacitysrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.color`is set to a numerical array. If true, - `marker.cmin` will correspond to the last color in the array - and `marker.cmax` will correspond to the first color. - - The 'reversescale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # size - # ---- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizemin - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['sizemin'] - - @sizemin.setter - def sizemin(self, val): - self['sizemin'] = val - - # sizemode - # -------- - @property - 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'] - - Returns - ------- - Any - """ - return self['sizemode'] - - @sizemode.setter - def sizemode(self, val): - self['sizemode'] = val - - # sizeref - # ------- - @property - 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 - - Returns - ------- - int|float - """ - return self['sizeref'] - - @sizeref.setter - def sizeref(self, val): - self['sizeref'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # symbol - # ------ - @property - def symbol(self): - """ - Sets the marker symbol type. Adding 100 is equivalent to - appending "-open" to a symbol name. Adding 200 is equivalent to - appending "-dot" to a symbol name. Adding 300 is equivalent to - appending "-open-dot" or "dot-open" to a symbol name. - - The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', - 315, 'hexagon2-open-dot', 16, 'octagon', 116, - 'octagon-open', 216, 'octagon-dot', 316, - 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, - 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, - 'hexagram-open', 218, 'hexagram-dot', 318, - 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', - 120, 'star-triangle-down-open', 220, - 'star-triangle-down-dot', 320, - 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, - 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, - 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, - 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, - 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, - 'line-nw-open'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['symbol'] - - @symbol.setter - def symbol(self, val): - self['symbol'] = val - - # symbolsrc - # --------- - @property - def symbolsrc(self): - """ - Sets the source reference on plot.ly for symbol . - - The 'symbolsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['symbolsrc'] - - @symbolsrc.setter - def symbolsrc(self, val): - self['symbolsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scatterpolar.marker.ColorBar instance - or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - gradient - plotly.graph_objs.scatterpolar.marker.Gradient instance - or dict with compatible properties - line - plotly.graph_objs.scatterpolar.marker.Line instance or - dict with compatible properties - maxdisplayed - Sets a maximum number of points to be drawn on the - graph. 0 corresponds to no limit. - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorbar=None, - colorscale=None, - colorsrc=None, - gradient=None, - line=None, - maxdisplayed=None, - opacity=None, - opacitysrc=None, - reversescale=None, - showscale=None, - size=None, - sizemin=None, - sizemode=None, - sizeref=None, - sizesrc=None, - symbol=None, - symbolsrc=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolar.Marker - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scatterpolar.marker.ColorBar instance - or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - gradient - plotly.graph_objs.scatterpolar.marker.Gradient instance - or dict with compatible properties - line - plotly.graph_objs.scatterpolar.marker.Line instance or - dict with compatible properties - maxdisplayed - Sets a maximum number of points to be drawn on the - graph. 0 corresponds to no limit. - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() - self._validators['cauto'] = v_marker.CautoValidator() - self._validators['cmax'] = v_marker.CmaxValidator() - self._validators['cmid'] = v_marker.CmidValidator() - self._validators['cmin'] = v_marker.CminValidator() - self._validators['color'] = v_marker.ColorValidator() - self._validators['colorbar'] = v_marker.ColorBarValidator() - self._validators['colorscale'] = v_marker.ColorscaleValidator() - self._validators['colorsrc'] = v_marker.ColorsrcValidator() - self._validators['gradient'] = v_marker.GradientValidator() - self._validators['line'] = v_marker.LineValidator() - self._validators['maxdisplayed'] = v_marker.MaxdisplayedValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() - self._validators['reversescale'] = v_marker.ReversescaleValidator() - self._validators['showscale'] = v_marker.ShowscaleValidator() - self._validators['size'] = v_marker.SizeValidator() - self._validators['sizemin'] = v_marker.SizeminValidator() - self._validators['sizemode'] = v_marker.SizemodeValidator() - self._validators['sizeref'] = v_marker.SizerefValidator() - self._validators['sizesrc'] = v_marker.SizesrcValidator() - self._validators['symbol'] = v_marker.SymbolValidator() - self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('gradient', None) - self['gradient'] = gradient if gradient is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('maxdisplayed', None) - self['maxdisplayed'] = maxdisplayed if maxdisplayed is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('opacitysrc', None) - self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizemin', None) - self['sizemin'] = sizemin if sizemin is not None else _v - _v = arg.pop('sizemode', None) - self['sizemode'] = sizemode if sizemode is not None else _v - _v = arg.pop('sizeref', None) - self['sizeref'] = sizeref if sizeref is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - _v = arg.pop('symbol', None) - self['symbol'] = symbol if symbol is not None else _v - _v = arg.pop('symbolsrc', None) - self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/_selected.py b/plotly/graph_objs/scatterpolar/_selected.py deleted file mode 100644 index 67928eefe5e..00000000000 --- a/plotly/graph_objs/scatterpolar/_selected.py +++ /dev/null @@ -1,146 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Selected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - plotly.graph_objs.scatterpolar.selected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.scatterpolar.selected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.scatterpolar.selected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objs.scatterpolar.selected.Textfont - instance or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Selected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolar.Selected - marker - plotly.graph_objs.scatterpolar.selected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objs.scatterpolar.selected.Textfont - instance or dict with compatible properties - - Returns - ------- - Selected - """ - super(Selected, self).__init__('selected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.Selected -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.Selected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar import (selected as v_selected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_selected.MarkerValidator() - self._validators['textfont'] = v_selected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/_stream.py b/plotly/graph_objs/scatterpolar/_stream.py deleted file mode 100644 index a7d5ea8a82c..00000000000 --- a/plotly/graph_objs/scatterpolar/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolar.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.Stream -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/_textfont.py b/plotly/graph_objs/scatterpolar/_textfont.py deleted file mode 100644 index 3dbecd20e25..00000000000 --- a/plotly/graph_objs/scatterpolar/_textfont.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Textfont object - - Sets the text font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolar.Textfont - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar import (textfont as v_textfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - self._validators['colorsrc'] = v_textfont.ColorsrcValidator() - self._validators['family'] = v_textfont.FamilyValidator() - self._validators['familysrc'] = v_textfont.FamilysrcValidator() - self._validators['size'] = v_textfont.SizeValidator() - self._validators['sizesrc'] = v_textfont.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/_unselected.py b/plotly/graph_objs/scatterpolar/_unselected.py deleted file mode 100644 index 801fc82ae68..00000000000 --- a/plotly/graph_objs/scatterpolar/_unselected.py +++ /dev/null @@ -1,151 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Unselected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. - - Returns - ------- - plotly.graph_objs.scatterpolar.unselected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.scatterpolar.unselected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.scatterpolar.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scatterpolar.unselected.Textfont - instance or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Unselected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.Unselected - marker - plotly.graph_objs.scatterpolar.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scatterpolar.unselected.Textfont - instance or dict with compatible properties - - Returns - ------- - Unselected - """ - super(Unselected, self).__init__('unselected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.Unselected -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.Unselected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar import (unselected as v_unselected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_unselected.MarkerValidator() - self._validators['textfont'] = v_unselected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/hoverlabel/__init__.py b/plotly/graph_objs/scatterpolar/hoverlabel/__init__.py index c37b8b5cd28..58d1452ade3 100644 --- a/plotly/graph_objs/scatterpolar/hoverlabel/__init__.py +++ b/plotly/graph_objs/scatterpolar/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolar.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/hoverlabel/_font.py b/plotly/graph_objs/scatterpolar/hoverlabel/_font.py deleted file mode 100644 index 9f976f8167a..00000000000 --- a/plotly/graph_objs/scatterpolar/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/marker/__init__.py b/plotly/graph_objs/scatterpolar/marker/__init__.py index b6b87dc145e..88cddae6b23 100644 --- a/plotly/graph_objs/scatterpolar/marker/__init__.py +++ b/plotly/graph_objs/scatterpolar/marker/__init__.py @@ -1,4 +1,2691 @@ -from ._line import Line -from ._gradient import Gradient -from ._colorbar import ColorBar + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + 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) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color`is + 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 + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarker.linecolor. It accepts either a specific color or + an array of numbers that are mapped to the colorscale relative + to the max and min values of the array or relative to + `marker.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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scatterpolar.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized value + to an rgb, rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and highest (1) values + are required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color`is set to a numerical array. If true, + `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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolar.marker.Line + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.marker.Line +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.marker.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar.marker import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() + self._validators['cauto'] = v_line.CautoValidator() + self._validators['cmax'] = v_line.CmaxValidator() + self._validators['cmid'] = v_line.CmidValidator() + self._validators['cmin'] = v_line.CminValidator() + self._validators['color'] = v_line.ColorValidator() + self._validators['colorscale'] = v_line.ColorscaleValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['reversescale'] = v_line.ReversescaleValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Gradient(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # type + # ---- + @property + 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'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # typesrc + # ------- + @property + def typesrc(self): + """ + Sets the source reference on plot.ly for type . + + The 'typesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['typesrc'] + + @typesrc.setter + def typesrc(self, val): + self['typesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color . + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on plot.ly for type . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + type=None, + typesrc=None, + **kwargs + ): + """ + Construct a new Gradient object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolar.marker.Gradient + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color . + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on plot.ly for type . + + Returns + ------- + Gradient + """ + super(Gradient, self).__init__('gradient') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.marker.Gradient +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.marker.Gradient""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar.marker import ( + gradient as v_gradient + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_gradient.ColorValidator() + self._validators['colorsrc'] = v_gradient.ColorsrcValidator() + self._validators['type'] = v_gradient.TypeValidator() + self._validators['typesrc'] = v_gradient.TypesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('typesrc', None) + self['typesrc'] = typesrc if typesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scatterpolar.m + 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 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 + ------- + plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.scatterpolar.marker.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use scatterpolar.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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use scatterpolar.marker.colorbar.title.side + instead. Determines the location of color bar's title with + respect to the color bar. Note that the title's location used + to be set by the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scatterpolar.marker.colorbar.Tickform + atstop instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rpolar.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scatterpolar.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatterpolar.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + scatterpolar.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. + titleside + Deprecated: Please use + scatterpolar.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolar.marker.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scatterpolar.marker.colorbar.Tickform + atstop instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rpolar.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scatterpolar.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatterpolar.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + scatterpolar.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. + titleside + Deprecated: Please use + scatterpolar.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.marker.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.marker.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar.marker import ( + colorbar as v_colorbar + ) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scatterpolar.marker import colorbar diff --git a/plotly/graph_objs/scatterpolar/marker/_colorbar.py b/plotly/graph_objs/scatterpolar/marker/_colorbar.py deleted file mode 100644 index 361f34a9768..00000000000 --- a/plotly/graph_objs/scatterpolar/marker/_colorbar.py +++ /dev/null @@ -1,1871 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.scatterpolar.m - 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 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 - ------- - plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.scatterpolar.marker.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use scatterpolar.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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use scatterpolar.marker.colorbar.title.side - instead. Determines the location of color bar's title with - respect to the color bar. Note that the title's location used - to be set by the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scatterpolar.marker.colorbar.Tickform - atstop instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - rpolar.marker.colorbar.tickformatstopdefaults), sets - the default property values to use for elements of - scatterpolar.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatterpolar.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - scatterpolar.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. - titleside - Deprecated: Please use - scatterpolar.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.marker.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scatterpolar.marker.colorbar.Tickform - atstop instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - rpolar.marker.colorbar.tickformatstopdefaults), sets - the default property values to use for elements of - scatterpolar.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatterpolar.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - scatterpolar.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. - titleside - Deprecated: Please use - scatterpolar.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.marker.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.marker.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar.marker import ( - colorbar as v_colorbar - ) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/marker/_gradient.py b/plotly/graph_objs/scatterpolar/marker/_gradient.py deleted file mode 100644 index b170daa7893..00000000000 --- a/plotly/graph_objs/scatterpolar/marker/_gradient.py +++ /dev/null @@ -1,238 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Gradient(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # type - # ---- - @property - 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'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # typesrc - # ------- - @property - def typesrc(self): - """ - Sets the source reference on plot.ly for type . - - The 'typesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['typesrc'] - - @typesrc.setter - def typesrc(self, val): - self['typesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the final color of the gradient fill: the center - color for radial, the right for horizontal, or the - bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color . - type - Sets the type of gradient used to fill the markers - typesrc - Sets the source reference on plot.ly for type . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - type=None, - typesrc=None, - **kwargs - ): - """ - Construct a new Gradient object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.marker.Gradient - color - Sets the final color of the gradient fill: the center - color for radial, the right for horizontal, or the - bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color . - type - Sets the type of gradient used to fill the markers - typesrc - Sets the source reference on plot.ly for type . - - Returns - ------- - Gradient - """ - super(Gradient, self).__init__('gradient') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.marker.Gradient -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.marker.Gradient""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar.marker import ( - gradient as v_gradient - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_gradient.ColorValidator() - self._validators['colorsrc'] = v_gradient.ColorsrcValidator() - self._validators['type'] = v_gradient.TypeValidator() - self._validators['typesrc'] = v_gradient.TypesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('typesrc', None) - self['typesrc'] = typesrc if typesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/marker/_line.py b/plotly/graph_objs/scatterpolar/marker/_line.py deleted file mode 100644 index 37a4fb7574a..00000000000 --- a/plotly/graph_objs/scatterpolar/marker/_line.py +++ /dev/null @@ -1,573 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is true, the - default palette will be chosen according to whether numbers in - the `color` array are all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.line.color`) or the - bounds set in `marker.line.cmin` and `marker.line.cmax` Has an - 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) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be equidistant - to this point. Has an effect only if in `marker.line.color`is - 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 - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarker.linecolor. It accepts either a specific color or - an array of numbers that are mapped to the colorscale relative - to the max and min values of the array or relative to - `marker.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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scatterpolar.marker.line.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized value - to an rgb, rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and highest (1) values - are required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the colorscale in - color space, use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.line.color`is set to a numerical array. If true, - `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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorscale=None, - colorsrc=None, - reversescale=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.marker.Line - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.marker.Line -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.marker.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar.marker import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() - self._validators['cauto'] = v_line.CautoValidator() - self._validators['cmax'] = v_line.CmaxValidator() - self._validators['cmid'] = v_line.CmidValidator() - self._validators['cmin'] = v_line.CminValidator() - self._validators['color'] = v_line.ColorValidator() - self._validators['colorscale'] = v_line.ColorscaleValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['reversescale'] = v_line.ReversescaleValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/marker/colorbar/__init__.py b/plotly/graph_objs/scatterpolar/marker/colorbar/__init__.py index 89dc9b9cd07..b3bb6afc014 100644 --- a/plotly/graph_objs/scatterpolar/marker/colorbar/__init__.py +++ b/plotly/graph_objs/scatterpolar/marker/colorbar/__init__.py @@ -1,4 +1,725 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scatterpolar.marker.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolar.marker.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.marker.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.marker.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar.marker.colorbar import ( + title as v_title + ) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterpolar.marker.co + lorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar.marker.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar.marker.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scatterpolar.marker.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/scatterpolar/marker/colorbar/_tickfont.py b/plotly/graph_objs/scatterpolar/marker/colorbar/_tickfont.py deleted file mode 100644 index 97751d9743f..00000000000 --- a/plotly/graph_objs/scatterpolar/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar.marker.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py deleted file mode 100644 index 5b504e60f96..00000000000 --- a/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolar.marker.co - lorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar.marker.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/marker/colorbar/_title.py b/plotly/graph_objs/scatterpolar/marker/colorbar/_title.py deleted file mode 100644 index 4ff5508df8b..00000000000 --- a/plotly/graph_objs/scatterpolar/marker/colorbar/_title.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scatterpolar.marker.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.marker.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.marker.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.marker.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar.marker.colorbar import ( - title as v_title - ) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/marker/colorbar/title/__init__.py b/plotly/graph_objs/scatterpolar/marker/colorbar/title/__init__.py index c37b8b5cd28..6b8adcc9f36 100644 --- a/plotly/graph_objs/scatterpolar/marker/colorbar/title/__init__.py +++ b/plotly/graph_objs/scatterpolar/marker/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar.marker.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterpolar.marker.co + lorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.marker.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.marker.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar.marker.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/marker/colorbar/title/_font.py b/plotly/graph_objs/scatterpolar/marker/colorbar/title/_font.py deleted file mode 100644 index f808e4a5437..00000000000 --- a/plotly/graph_objs/scatterpolar/marker/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar.marker.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolar.marker.co - lorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.marker.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.marker.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar.marker.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/selected/__init__.py b/plotly/graph_objs/scatterpolar/selected/__init__.py index adba53218ca..fc1ca03c2e3 100644 --- a/plotly/graph_objs/scatterpolar/selected/__init__.py +++ b/plotly/graph_objs/scatterpolar/selected/__init__.py @@ -1,2 +1,342 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolar.selected.Textfont + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.selected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.selected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar.selected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolar.selected.Marker + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.selected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.selected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar.selected import ( + marker as v_marker + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/selected/_marker.py b/plotly/graph_objs/scatterpolar/selected/_marker.py deleted file mode 100644 index dedcb72acfd..00000000000 --- a/plotly/graph_objs/scatterpolar/selected/_marker.py +++ /dev/null @@ -1,197 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.selected.Marker - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.selected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.selected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar.selected import ( - marker as v_marker - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/selected/_textfont.py b/plotly/graph_objs/scatterpolar/selected/_textfont.py deleted file mode 100644 index 75980570dc7..00000000000 --- a/plotly/graph_objs/scatterpolar/selected/_textfont.py +++ /dev/null @@ -1,141 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of selected points. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.selected.Textfont - color - Sets the text font color of selected points. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.selected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.selected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar.selected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/unselected/__init__.py b/plotly/graph_objs/scatterpolar/unselected/__init__.py index adba53218ca..13b3079d34b 100644 --- a/plotly/graph_objs/scatterpolar/unselected/__init__.py +++ b/plotly/graph_objs/scatterpolar/unselected/__init__.py @@ -1,2 +1,354 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolar.unselected.Textfont + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.unselected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.unselected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar.unselected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolar.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolar.unselected.Marker + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolar.unselected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolar.unselected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolar.unselected import ( + marker as v_marker + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/unselected/_marker.py b/plotly/graph_objs/scatterpolar/unselected/_marker.py deleted file mode 100644 index 4b548309ca9..00000000000 --- a/plotly/graph_objs/scatterpolar/unselected/_marker.py +++ /dev/null @@ -1,206 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.unselected.Marker - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.unselected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.unselected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar.unselected import ( - marker as v_marker - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolar/unselected/_textfont.py b/plotly/graph_objs/scatterpolar/unselected/_textfont.py deleted file mode 100644 index 8769ee1aa5e..00000000000 --- a/plotly/graph_objs/scatterpolar/unselected/_textfont.py +++ /dev/null @@ -1,144 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolar.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of unselected points, applied - only when a selection exists. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolar.unselected.Textfont - color - Sets the text font color of unselected points, applied - only when a selection exists. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolar.unselected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolar.unselected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolar.unselected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/__init__.py b/plotly/graph_objs/scatterpolargl/__init__.py index 0f0959b835d..8be6314e0b7 100644 --- a/plotly/graph_objs/scatterpolargl/__init__.py +++ b/plotly/graph_objs/scatterpolargl/__init__.py @@ -1,11 +1,2671 @@ -from ._unselected import Unselected + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. + + Returns + ------- + plotly.graph_objs.scatterpolargl.unselected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.scatterpolargl.unselected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.scatterpolargl.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scatterpolargl.unselected.Textfont + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolargl.Unselected + marker + plotly.graph_objs.scatterpolargl.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scatterpolargl.unselected.Textfont + instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super(Unselected, self).__init__('unselected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.Unselected +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.Unselected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl import ( + unselected as v_unselected + ) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_unselected.MarkerValidator() + self._validators['textfont'] = v_unselected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolargl.Textfont + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl import (textfont as v_textfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + self._validators['colorsrc'] = v_textfont.ColorsrcValidator() + self._validators['family'] = v_textfont.FamilyValidator() + self._validators['familysrc'] = v_textfont.FamilysrcValidator() + self._validators['size'] = v_textfont.SizeValidator() + self._validators['sizesrc'] = v_textfont.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterpolargl.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.Stream +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + plotly.graph_objs.scatterpolargl.selected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.scatterpolargl.selected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.scatterpolargl.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scatterpolargl.selected.Textfont + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolargl.Selected + marker + plotly.graph_objs.scatterpolargl.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scatterpolargl.selected.Textfont + instance or dict with compatible properties + + Returns + ------- + Selected + """ + super(Selected, self).__init__('selected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.Selected +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.Selected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl import (selected as v_selected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_selected.MarkerValidator() + self._validators['textfont'] = v_selected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color`is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` array are + all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmin` + must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmax` + must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarkercolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scatterpolargl.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of 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 + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scatterpolargl.marker.colorba + r.Tickformatstop instance or dict with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scatterpolargl.marker.colorbar.tickformatstop + defaults), sets the default property values to + use for elements of + scatterpolargl.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatterpolargl.marker.colorba + r.Title instance or dict with compatible + properties + titlefont + Deprecated: Please use + 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. + titleside + Deprecated: Please use + scatterpolargl.marker.colorbar.title.side + instead. Determines the location of color bar's + title with respect to the color bar. Note that + the title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.scatterpolargl.marker.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color`is + set to a numerical array. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At minimum, a mapping for + the lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Greys,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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.scatterpolargl.marker.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # opacity + # ------- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # opacitysrc + # ---------- + @property + def opacitysrc(self): + """ + Sets the source reference on plot.ly for opacity . + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['opacitysrc'] + + @opacitysrc.setter + def opacitysrc(self, val): + self['opacitysrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color`is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # size + # ---- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizemin + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['sizemin'] + + @sizemin.setter + def sizemin(self, val): + self['sizemin'] = val + + # sizemode + # -------- + @property + 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'] + + Returns + ------- + Any + """ + return self['sizemode'] + + @sizemode.setter + def sizemode(self, val): + self['sizemode'] = val + + # sizeref + # ------- + @property + 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 + + Returns + ------- + int|float + """ + return self['sizeref'] + + @sizeref.setter + def sizeref(self, val): + self['sizeref'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # symbol + # ------ + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', + 315, 'hexagon2-open-dot', 16, 'octagon', 116, + 'octagon-open', 216, 'octagon-dot', 316, + 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, + 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, + 'hexagram-open', 218, 'hexagram-dot', 318, + 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', + 120, 'star-triangle-down-open', 220, + 'star-triangle-down-dot', 320, + 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, + 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, + 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, + 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, + 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, + 'line-nw-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['symbol'] + + @symbol.setter + def symbol(self, val): + self['symbol'] = val + + # symbolsrc + # --------- + @property + def symbolsrc(self): + """ + Sets the source reference on plot.ly for symbol . + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['symbolsrc'] + + @symbolsrc.setter + def symbolsrc(self, val): + self['symbolsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scatterpolargl.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + line + plotly.graph_objs.scatterpolargl.marker.Line instance + or dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorbar=None, + colorscale=None, + colorsrc=None, + line=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterpolargl.Marker + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scatterpolargl.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + line + plotly.graph_objs.scatterpolargl.marker.Line instance + or dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() + self._validators['cauto'] = v_marker.CautoValidator() + self._validators['cmax'] = v_marker.CmaxValidator() + self._validators['cmid'] = v_marker.CmidValidator() + self._validators['cmin'] = v_marker.CminValidator() + self._validators['color'] = v_marker.ColorValidator() + self._validators['colorbar'] = v_marker.ColorBarValidator() + self._validators['colorscale'] = v_marker.ColorscaleValidator() + self._validators['colorsrc'] = v_marker.ColorsrcValidator() + self._validators['line'] = v_marker.LineValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() + self._validators['reversescale'] = v_marker.ReversescaleValidator() + self._validators['showscale'] = v_marker.ShowscaleValidator() + self._validators['size'] = v_marker.SizeValidator() + self._validators['sizemin'] = v_marker.SizeminValidator() + self._validators['sizemode'] = v_marker.SizemodeValidator() + self._validators['sizeref'] = v_marker.SizerefValidator() + self._validators['sizesrc'] = v_marker.SizesrcValidator() + self._validators['symbol'] = v_marker.SymbolValidator() + self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('opacitysrc', None) + self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizemin', None) + self['sizemin'] = sizemin if sizemin is not None else _v + _v = arg.pop('sizemode', None) + self['sizemode'] = sizemode if sizemode is not None else _v + _v = arg.pop('sizeref', None) + self['sizeref'] = sizeref if sizeref is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + _v = arg.pop('symbol', None) + self['symbol'] = symbol if symbol is not None else _v + _v = arg.pop('symbolsrc', None) + self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dash + # ---- + @property + 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', + 'longdashdot'] + + Returns + ------- + Any + """ + return self['dash'] + + @dash.setter + def dash(self, val): + self['dash'] = val + + # shape + # ----- + @property + 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'] + + Returns + ------- + Any + """ + return self['shape'] + + @shape.setter + def shape(self, val): + self['shape'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the style of the lines. + shape + Determines the line shape. The values correspond to + step-wise line shapes. + width + Sets the line width (in px). + """ + + def __init__( + self, + arg=None, + color=None, + dash=None, + shape=None, + width=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterpolargl.Line + color + Sets the line color. + dash + Sets the style of the lines. + shape + Determines the line shape. The values correspond to + step-wise line shapes. + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.Line +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['dash'] = v_line.DashValidator() + self._validators['shape'] = v_line.ShapeValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dash', None) + self['dash'] = dash if dash is not None else _v + _v = arg.pop('shape', None) + self['shape'] = shape if shape is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scatterpolargl.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolargl.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl import ( + hoverlabel as v_hoverlabel + ) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scatterpolargl import unselected -from ._textfont import Textfont -from ._stream import Stream -from ._selected import Selected from plotly.graph_objs.scatterpolargl import selected -from ._marker import Marker from plotly.graph_objs.scatterpolargl import marker -from ._line import Line -from ._hoverlabel import Hoverlabel from plotly.graph_objs.scatterpolargl import hoverlabel diff --git a/plotly/graph_objs/scatterpolargl/_hoverlabel.py b/plotly/graph_objs/scatterpolargl/_hoverlabel.py deleted file mode 100644 index 6436ae07595..00000000000 --- a/plotly/graph_objs/scatterpolargl/_hoverlabel.py +++ /dev/null @@ -1,417 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scatterpolargl.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl import ( - hoverlabel as v_hoverlabel - ) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/_line.py b/plotly/graph_objs/scatterpolargl/_line.py deleted file mode 100644 index 9bc54aa758a..00000000000 --- a/plotly/graph_objs/scatterpolargl/_line.py +++ /dev/null @@ -1,233 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dash - # ---- - @property - 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', - 'longdashdot'] - - Returns - ------- - Any - """ - return self['dash'] - - @dash.setter - def dash(self, val): - self['dash'] = val - - # shape - # ----- - @property - 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'] - - Returns - ------- - Any - """ - return self['shape'] - - @shape.setter - def shape(self, val): - self['shape'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the line color. - dash - Sets the style of the lines. - shape - Determines the line shape. The values correspond to - step-wise line shapes. - width - Sets the line width (in px). - """ - - def __init__( - self, - arg=None, - color=None, - dash=None, - shape=None, - width=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolargl.Line - color - Sets the line color. - dash - Sets the style of the lines. - shape - Determines the line shape. The values correspond to - step-wise line shapes. - width - Sets the line width (in px). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.Line -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['dash'] = v_line.DashValidator() - self._validators['shape'] = v_line.ShapeValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dash', None) - self['dash'] = dash if dash is not None else _v - _v = arg.pop('shape', None) - self['shape'] = shape if shape is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/_marker.py b/plotly/graph_objs/scatterpolargl/_marker.py deleted file mode 100644 index 460537d9cbf..00000000000 --- a/plotly/graph_objs/scatterpolargl/_marker.py +++ /dev/null @@ -1,1242 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in `marker.color`is - set to a numerical array. In case `colorscale` is unspecified - or `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` array are - all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.color`) or the - bounds set in `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical array. Defaults - to `false` when `marker.cmin` and `marker.cmax` are set by the - user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmin` - must be set as well. - - The 'cmax' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling `marker.cmin` - and/or `marker.cmax` to be equidistant to this point. Has an - effect only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color`. Has no - effect when `marker.cauto` is `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmax` - must be set as well. - - The 'cmin' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarkercolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scatterpolargl.marker.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of 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 - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scatterpolargl.marker.colorba - r.Tickformatstop instance or dict with - compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scatterpolargl.marker.colorbar.tickformatstop - defaults), sets the default property values to - use for elements of - scatterpolargl.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatterpolargl.marker.colorba - r.Title instance or dict with compatible - properties - titlefont - Deprecated: Please use - 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. - titleside - Deprecated: Please use - scatterpolargl.marker.colorbar.title.side - instead. Determines the location of color bar's - title with respect to the color bar. Note that - the title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.scatterpolargl.marker.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in `marker.color`is - set to a numerical array. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At minimum, a mapping for - the lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` - may be a palette name string of the following list: Greys,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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.scatterpolargl.marker.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # opacity - # ------- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # opacitysrc - # ---------- - @property - def opacitysrc(self): - """ - Sets the source reference on plot.ly for opacity . - - The 'opacitysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['opacitysrc'] - - @opacitysrc.setter - def opacitysrc(self, val): - self['opacitysrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.color`is set to a numerical array. If true, - `marker.cmin` will correspond to the last color in the array - and `marker.cmax` will correspond to the first color. - - The 'reversescale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # size - # ---- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizemin - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['sizemin'] - - @sizemin.setter - def sizemin(self, val): - self['sizemin'] = val - - # sizemode - # -------- - @property - 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'] - - Returns - ------- - Any - """ - return self['sizemode'] - - @sizemode.setter - def sizemode(self, val): - self['sizemode'] = val - - # sizeref - # ------- - @property - 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 - - Returns - ------- - int|float - """ - return self['sizeref'] - - @sizeref.setter - def sizeref(self, val): - self['sizeref'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # symbol - # ------ - @property - def symbol(self): - """ - Sets the marker symbol type. Adding 100 is equivalent to - appending "-open" to a symbol name. Adding 200 is equivalent to - appending "-dot" to a symbol name. Adding 300 is equivalent to - appending "-open-dot" or "dot-open" to a symbol name. - - The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', - 315, 'hexagon2-open-dot', 16, 'octagon', 116, - 'octagon-open', 216, 'octagon-dot', 316, - 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, - 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, - 'hexagram-open', 218, 'hexagram-dot', 318, - 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', - 120, 'star-triangle-down-open', 220, - 'star-triangle-down-dot', 320, - 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, - 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, - 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, - 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, - 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, - 'line-nw-open'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['symbol'] - - @symbol.setter - def symbol(self, val): - self['symbol'] = val - - # symbolsrc - # --------- - @property - def symbolsrc(self): - """ - Sets the source reference on plot.ly for symbol . - - The 'symbolsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['symbolsrc'] - - @symbolsrc.setter - def symbolsrc(self, val): - self['symbolsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scatterpolargl.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - line - plotly.graph_objs.scatterpolargl.marker.Line instance - or dict with compatible properties - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorbar=None, - colorscale=None, - colorsrc=None, - line=None, - opacity=None, - opacitysrc=None, - reversescale=None, - showscale=None, - size=None, - sizemin=None, - sizemode=None, - sizeref=None, - sizesrc=None, - symbol=None, - symbolsrc=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolargl.Marker - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scatterpolargl.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - line - plotly.graph_objs.scatterpolargl.marker.Line instance - or dict with compatible properties - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() - self._validators['cauto'] = v_marker.CautoValidator() - self._validators['cmax'] = v_marker.CmaxValidator() - self._validators['cmid'] = v_marker.CmidValidator() - self._validators['cmin'] = v_marker.CminValidator() - self._validators['color'] = v_marker.ColorValidator() - self._validators['colorbar'] = v_marker.ColorBarValidator() - self._validators['colorscale'] = v_marker.ColorscaleValidator() - self._validators['colorsrc'] = v_marker.ColorsrcValidator() - self._validators['line'] = v_marker.LineValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() - self._validators['reversescale'] = v_marker.ReversescaleValidator() - self._validators['showscale'] = v_marker.ShowscaleValidator() - self._validators['size'] = v_marker.SizeValidator() - self._validators['sizemin'] = v_marker.SizeminValidator() - self._validators['sizemode'] = v_marker.SizemodeValidator() - self._validators['sizeref'] = v_marker.SizerefValidator() - self._validators['sizesrc'] = v_marker.SizesrcValidator() - self._validators['symbol'] = v_marker.SymbolValidator() - self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('opacitysrc', None) - self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizemin', None) - self['sizemin'] = sizemin if sizemin is not None else _v - _v = arg.pop('sizemode', None) - self['sizemode'] = sizemode if sizemode is not None else _v - _v = arg.pop('sizeref', None) - self['sizeref'] = sizeref if sizeref is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - _v = arg.pop('symbol', None) - self['symbol'] = symbol if symbol is not None else _v - _v = arg.pop('symbolsrc', None) - self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/_selected.py b/plotly/graph_objs/scatterpolargl/_selected.py deleted file mode 100644 index 779b00d0056..00000000000 --- a/plotly/graph_objs/scatterpolargl/_selected.py +++ /dev/null @@ -1,147 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Selected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - plotly.graph_objs.scatterpolargl.selected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.scatterpolargl.selected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.scatterpolargl.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scatterpolargl.selected.Textfont - instance or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Selected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.Selected - marker - plotly.graph_objs.scatterpolargl.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scatterpolargl.selected.Textfont - instance or dict with compatible properties - - Returns - ------- - Selected - """ - super(Selected, self).__init__('selected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.Selected -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.Selected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl import (selected as v_selected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_selected.MarkerValidator() - self._validators['textfont'] = v_selected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/_stream.py b/plotly/graph_objs/scatterpolargl/_stream.py deleted file mode 100644 index 5d438f60748..00000000000 --- a/plotly/graph_objs/scatterpolargl/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolargl.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.Stream -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/_textfont.py b/plotly/graph_objs/scatterpolargl/_textfont.py deleted file mode 100644 index 5be4e0b9a6c..00000000000 --- a/plotly/graph_objs/scatterpolargl/_textfont.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Textfont object - - Sets the text font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.Textfont - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl import (textfont as v_textfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - self._validators['colorsrc'] = v_textfont.ColorsrcValidator() - self._validators['family'] = v_textfont.FamilyValidator() - self._validators['familysrc'] = v_textfont.FamilysrcValidator() - self._validators['size'] = v_textfont.SizeValidator() - self._validators['sizesrc'] = v_textfont.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/_unselected.py b/plotly/graph_objs/scatterpolargl/_unselected.py deleted file mode 100644 index c98cace6dc9..00000000000 --- a/plotly/graph_objs/scatterpolargl/_unselected.py +++ /dev/null @@ -1,153 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Unselected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. - - Returns - ------- - plotly.graph_objs.scatterpolargl.unselected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.scatterpolargl.unselected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.scatterpolargl.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scatterpolargl.unselected.Textfont - instance or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Unselected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.Unselected - marker - plotly.graph_objs.scatterpolargl.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scatterpolargl.unselected.Textfont - instance or dict with compatible properties - - Returns - ------- - Unselected - """ - super(Unselected, self).__init__('unselected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.Unselected -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.Unselected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl import ( - unselected as v_unselected - ) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_unselected.MarkerValidator() - self._validators['textfont'] = v_unselected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/hoverlabel/__init__.py b/plotly/graph_objs/scatterpolargl/hoverlabel/__init__.py index c37b8b5cd28..742695377c9 100644 --- a/plotly/graph_objs/scatterpolargl/hoverlabel/__init__.py +++ b/plotly/graph_objs/scatterpolargl/hoverlabel/__init__.py @@ -1 +1,324 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolargl.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl.hoverlabel import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/hoverlabel/_font.py b/plotly/graph_objs/scatterpolargl/hoverlabel/_font.py deleted file mode 100644 index 1728c92f7ba..00000000000 --- a/plotly/graph_objs/scatterpolargl/hoverlabel/_font.py +++ /dev/null @@ -1,322 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl.hoverlabel import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/marker/__init__.py b/plotly/graph_objs/scatterpolargl/marker/__init__.py index 073df902bdf..9e042c3d085 100644 --- a/plotly/graph_objs/scatterpolargl/marker/__init__.py +++ b/plotly/graph_objs/scatterpolargl/marker/__init__.py @@ -1,3 +1,2452 @@ -from ._line import Line -from ._colorbar import ColorBar + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + 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) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color`is + 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 + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarker.linecolor. It accepts either a specific color or + an array of numbers that are mapped to the colorscale relative + to the max and min values of the array or relative to + `marker.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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scatterpolargl.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized value + to an rgb, rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and highest (1) values + are required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color`is set to a numerical array. If true, + `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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolargl.marker.Line + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.marker.Line +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.marker.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl.marker import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() + self._validators['cauto'] = v_line.CautoValidator() + self._validators['cmax'] = v_line.CmaxValidator() + self._validators['cmid'] = v_line.CmidValidator() + self._validators['cmin'] = v_line.CminValidator() + self._validators['color'] = v_line.ColorValidator() + self._validators['colorscale'] = v_line.ColorscaleValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['reversescale'] = v_line.ReversescaleValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scatterpolargl + .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 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 + ------- + plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.scatterpolargl.marker.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use + scatterpolargl.marker.colorbar.title.side instead. Determines + the location of color bar's title with respect to the color + bar. Note that the title's location used to be set by the now + deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfo + rmatstop instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rpolargl.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scatterpolargl.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatterpolargl.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + 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. + titleside + Deprecated: Please use + scatterpolargl.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolargl.marker.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfo + rmatstop instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rpolargl.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scatterpolargl.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatterpolargl.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + 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. + titleside + Deprecated: Please use + scatterpolargl.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.marker.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.marker.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl.marker import ( + colorbar as v_colorbar + ) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scatterpolargl.marker import colorbar diff --git a/plotly/graph_objs/scatterpolargl/marker/_colorbar.py b/plotly/graph_objs/scatterpolargl/marker/_colorbar.py deleted file mode 100644 index e1bb7706a93..00000000000 --- a/plotly/graph_objs/scatterpolargl/marker/_colorbar.py +++ /dev/null @@ -1,1872 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.scatterpolargl - .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 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 - ------- - plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.scatterpolargl.marker.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use - scatterpolargl.marker.colorbar.title.side instead. Determines - the location of color bar's title with respect to the color - bar. Note that the title's location used to be set by the now - deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfo - rmatstop instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - rpolargl.marker.colorbar.tickformatstopdefaults), sets - the default property values to use for elements of - scatterpolargl.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatterpolargl.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - 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. - titleside - Deprecated: Please use - scatterpolargl.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.marker.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfo - rmatstop instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - rpolargl.marker.colorbar.tickformatstopdefaults), sets - the default property values to use for elements of - scatterpolargl.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatterpolargl.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - 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. - titleside - Deprecated: Please use - scatterpolargl.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.marker.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.marker.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl.marker import ( - colorbar as v_colorbar - ) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/marker/_line.py b/plotly/graph_objs/scatterpolargl/marker/_line.py deleted file mode 100644 index d63033f5b22..00000000000 --- a/plotly/graph_objs/scatterpolargl/marker/_line.py +++ /dev/null @@ -1,573 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is true, the - default palette will be chosen according to whether numbers in - the `color` array are all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.line.color`) or the - bounds set in `marker.line.cmin` and `marker.line.cmax` Has an - 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) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be equidistant - to this point. Has an effect only if in `marker.line.color`is - 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 - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarker.linecolor. It accepts either a specific color or - an array of numbers that are mapped to the colorscale relative - to the max and min values of the array or relative to - `marker.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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scatterpolargl.marker.line.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized value - to an rgb, rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and highest (1) values - are required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the colorscale in - color space, use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.line.color`is set to a numerical array. If true, - `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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorscale=None, - colorsrc=None, - reversescale=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.marker.Line - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.marker.Line -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.marker.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl.marker import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() - self._validators['cauto'] = v_line.CautoValidator() - self._validators['cmax'] = v_line.CmaxValidator() - self._validators['cmid'] = v_line.CmidValidator() - self._validators['cmin'] = v_line.CminValidator() - self._validators['color'] = v_line.ColorValidator() - self._validators['colorscale'] = v_line.ColorscaleValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['reversescale'] = v_line.ReversescaleValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/marker/colorbar/__init__.py b/plotly/graph_objs/scatterpolargl/marker/colorbar/__init__.py index ff81c39e142..7d4659c8d09 100644 --- a/plotly/graph_objs/scatterpolargl/marker/colorbar/__init__.py +++ b/plotly/graph_objs/scatterpolargl/marker/colorbar/__init__.py @@ -1,4 +1,725 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolargl.marker.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.marker.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.marker.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl.marker.colorbar import ( + title as v_title + ) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterpolargl.marker. + colorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl.marker.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterpolargl.marker. + colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl.marker.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scatterpolargl.marker.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickfont.py b/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickfont.py deleted file mode 100644 index 46fbbc63772..00000000000 --- a/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolargl.marker. - colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl.marker.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py deleted file mode 100644 index 3dee6c4e4db..00000000000 --- a/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolargl.marker. - colorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl.marker.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/marker/colorbar/_title.py b/plotly/graph_objs/scatterpolargl/marker/colorbar/_title.py deleted file mode 100644 index 4f3a3ee0977..00000000000 --- a/plotly/graph_objs/scatterpolargl/marker/colorbar/_title.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.marker.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.marker.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.marker.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl.marker.colorbar import ( - title as v_title - ) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/marker/colorbar/title/__init__.py b/plotly/graph_objs/scatterpolargl/marker/colorbar/title/__init__.py index c37b8b5cd28..15c143d7bb7 100644 --- a/plotly/graph_objs/scatterpolargl/marker/colorbar/title/__init__.py +++ b/plotly/graph_objs/scatterpolargl/marker/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl.marker.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterpolargl.marker. + colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl.marker.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/marker/colorbar/title/_font.py b/plotly/graph_objs/scatterpolargl/marker/colorbar/title/_font.py deleted file mode 100644 index f0f91d94e63..00000000000 --- a/plotly/graph_objs/scatterpolargl/marker/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl.marker.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterpolargl.marker. - colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl.marker.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/selected/__init__.py b/plotly/graph_objs/scatterpolargl/selected/__init__.py index adba53218ca..28bb2d96e0a 100644 --- a/plotly/graph_objs/scatterpolargl/selected/__init__.py +++ b/plotly/graph_objs/scatterpolargl/selected/__init__.py @@ -1,2 +1,342 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolargl.selected.Textfont + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.selected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.selected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl.selected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolargl.selected.Marker + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.selected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.selected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl.selected import ( + marker as v_marker + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/selected/_marker.py b/plotly/graph_objs/scatterpolargl/selected/_marker.py deleted file mode 100644 index 96f287f6b97..00000000000 --- a/plotly/graph_objs/scatterpolargl/selected/_marker.py +++ /dev/null @@ -1,197 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.selected.Marker - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.selected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.selected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl.selected import ( - marker as v_marker - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/selected/_textfont.py b/plotly/graph_objs/scatterpolargl/selected/_textfont.py deleted file mode 100644 index 065b988a496..00000000000 --- a/plotly/graph_objs/scatterpolargl/selected/_textfont.py +++ /dev/null @@ -1,141 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of selected points. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.selected.Textfont - color - Sets the text font color of selected points. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.selected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.selected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl.selected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/unselected/__init__.py b/plotly/graph_objs/scatterpolargl/unselected/__init__.py index adba53218ca..4d3a2ab3713 100644 --- a/plotly/graph_objs/scatterpolargl/unselected/__init__.py +++ b/plotly/graph_objs/scatterpolargl/unselected/__init__.py @@ -1,2 +1,354 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolargl.unselected.Textfont + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.unselected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.unselected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl.unselected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterpolargl.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterpolargl.unselected.Marker + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterpolargl.unselected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scatterpolargl.unselected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterpolargl.unselected import ( + marker as v_marker + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/unselected/_marker.py b/plotly/graph_objs/scatterpolargl/unselected/_marker.py deleted file mode 100644 index f911a7a13c9..00000000000 --- a/plotly/graph_objs/scatterpolargl/unselected/_marker.py +++ /dev/null @@ -1,206 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.unselected.Marker - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.unselected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.unselected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl.unselected import ( - marker as v_marker - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterpolargl/unselected/_textfont.py b/plotly/graph_objs/scatterpolargl/unselected/_textfont.py deleted file mode 100644 index 1a8efa02902..00000000000 --- a/plotly/graph_objs/scatterpolargl/unselected/_textfont.py +++ /dev/null @@ -1,144 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterpolargl.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of unselected points, applied - only when a selection exists. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterpolargl.unselected.Textfont - color - Sets the text font color of unselected points, applied - only when a selection exists. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterpolargl.unselected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scatterpolargl.unselected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterpolargl.unselected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/__init__.py b/plotly/graph_objs/scatterternary/__init__.py index 661912d2d40..8aa3786a1da 100644 --- a/plotly/graph_objs/scatterternary/__init__.py +++ b/plotly/graph_objs/scatterternary/__init__.py @@ -1,11 +1,2796 @@ -from ._unselected import Unselected + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. + + Returns + ------- + plotly.graph_objs.scatterternary.unselected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.scatterternary.unselected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.scatterternary.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scatterternary.unselected.Textfont + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterternary.Unselected + marker + plotly.graph_objs.scatterternary.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scatterternary.unselected.Textfont + instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super(Unselected, self).__init__('unselected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.Unselected +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.Unselected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary import ( + unselected as v_unselected + ) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_unselected.MarkerValidator() + self._validators['textfont'] = v_unselected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterternary.Textfont + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary import (textfont as v_textfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + self._validators['colorsrc'] = v_textfont.ColorsrcValidator() + self._validators['family'] = v_textfont.FamilyValidator() + self._validators['familysrc'] = v_textfont.FamilysrcValidator() + self._validators['size'] = v_textfont.SizeValidator() + self._validators['sizesrc'] = v_textfont.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterternary.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.Stream +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + plotly.graph_objs.scatterternary.selected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # textfont + # -------- + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of 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. + + Returns + ------- + plotly.graph_objs.scatterternary.selected.Textfont + """ + return self['textfont'] + + @textfont.setter + def textfont(self, val): + self['textfont'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.scatterternary.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scatterternary.selected.Textfont + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterternary.Selected + marker + plotly.graph_objs.scatterternary.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scatterternary.selected.Textfont + instance or dict with compatible properties + + Returns + ------- + Selected + """ + super(Selected, self).__init__('selected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.Selected +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.Selected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary import (selected as v_selected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_selected.MarkerValidator() + self._validators['textfont'] = v_selected.TextfontValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + _v = arg.pop('textfont', None) + self['textfont'] = textfont if textfont is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color`is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` array are + all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmin` + must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmax` + must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarkercolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scatterternary.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of 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 + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scatterternary.marker.colorba + r.Tickformatstop instance or dict with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scatterternary.marker.colorbar.tickformatstop + defaults), sets the default property values to + use for elements of + scatterternary.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatterternary.marker.colorba + r.Title instance or dict with compatible + properties + titlefont + Deprecated: Please use + 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. + titleside + Deprecated: Please use + scatterternary.marker.colorbar.title.side + instead. Determines the location of color bar's + title with respect to the color bar. Note that + the title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.scatterternary.marker.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color`is + set to a numerical array. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At minimum, a mapping for + the lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Greys,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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # gradient + # -------- + @property + def gradient(self): + """ + The 'gradient' property is an instance of Gradient + that may be specified as: + - An instance of 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 + horizontal, or the bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color + . + type + Sets the type of gradient used to fill the + markers + typesrc + Sets the source reference on plot.ly for type + . + + Returns + ------- + plotly.graph_objs.scatterternary.marker.Gradient + """ + return self['gradient'] + + @gradient.setter + def gradient(self, val): + self['gradient'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.scatterternary.marker.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # maxdisplayed + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['maxdisplayed'] + + @maxdisplayed.setter + def maxdisplayed(self, val): + self['maxdisplayed'] = val + + # opacity + # ------- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # opacitysrc + # ---------- + @property + def opacitysrc(self): + """ + Sets the source reference on plot.ly for opacity . + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['opacitysrc'] + + @opacitysrc.setter + def opacitysrc(self, val): + self['opacitysrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color`is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # size + # ---- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizemin + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['sizemin'] + + @sizemin.setter + def sizemin(self, val): + self['sizemin'] = val + + # sizemode + # -------- + @property + 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'] + + Returns + ------- + Any + """ + return self['sizemode'] + + @sizemode.setter + def sizemode(self, val): + self['sizemode'] = val + + # sizeref + # ------- + @property + 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 + + Returns + ------- + int|float + """ + return self['sizeref'] + + @sizeref.setter + def sizeref(self, val): + self['sizeref'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # symbol + # ------ + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', + 315, 'hexagon2-open-dot', 16, 'octagon', 116, + 'octagon-open', 216, 'octagon-dot', 316, + 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, + 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, + 'hexagram-open', 218, 'hexagram-dot', 318, + 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', + 120, 'star-triangle-down-open', 220, + 'star-triangle-down-dot', 320, + 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, + 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, + 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, + 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, + 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, + 'line-nw-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['symbol'] + + @symbol.setter + def symbol(self, val): + self['symbol'] = val + + # symbolsrc + # --------- + @property + def symbolsrc(self): + """ + Sets the source reference on plot.ly for symbol . + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['symbolsrc'] + + @symbolsrc.setter + def symbolsrc(self, val): + self['symbolsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scatterternary.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + gradient + plotly.graph_objs.scatterternary.marker.Gradient + instance or dict with compatible properties + line + plotly.graph_objs.scatterternary.marker.Line instance + or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorbar=None, + colorscale=None, + colorsrc=None, + gradient=None, + line=None, + maxdisplayed=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterternary.Marker + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.scatterternary.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + gradient + plotly.graph_objs.scatterternary.marker.Gradient + instance or dict with compatible properties + line + plotly.graph_objs.scatterternary.marker.Line instance + or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() + self._validators['cauto'] = v_marker.CautoValidator() + self._validators['cmax'] = v_marker.CmaxValidator() + self._validators['cmid'] = v_marker.CmidValidator() + self._validators['cmin'] = v_marker.CminValidator() + self._validators['color'] = v_marker.ColorValidator() + self._validators['colorbar'] = v_marker.ColorBarValidator() + self._validators['colorscale'] = v_marker.ColorscaleValidator() + self._validators['colorsrc'] = v_marker.ColorsrcValidator() + self._validators['gradient'] = v_marker.GradientValidator() + self._validators['line'] = v_marker.LineValidator() + self._validators['maxdisplayed'] = v_marker.MaxdisplayedValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() + self._validators['reversescale'] = v_marker.ReversescaleValidator() + self._validators['showscale'] = v_marker.ShowscaleValidator() + self._validators['size'] = v_marker.SizeValidator() + self._validators['sizemin'] = v_marker.SizeminValidator() + self._validators['sizemode'] = v_marker.SizemodeValidator() + self._validators['sizeref'] = v_marker.SizerefValidator() + self._validators['sizesrc'] = v_marker.SizesrcValidator() + self._validators['symbol'] = v_marker.SymbolValidator() + self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('gradient', None) + self['gradient'] = gradient if gradient is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('maxdisplayed', None) + self['maxdisplayed'] = maxdisplayed if maxdisplayed is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('opacitysrc', None) + self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizemin', None) + self['sizemin'] = sizemin if sizemin is not None else _v + _v = arg.pop('sizemode', None) + self['sizemode'] = sizemode if sizemode is not None else _v + _v = arg.pop('sizeref', None) + self['sizeref'] = sizeref if sizeref is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + _v = arg.pop('symbol', None) + self['symbol'] = symbol if symbol is not None else _v + _v = arg.pop('symbolsrc', None) + self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # dash + # ---- + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self['dash'] + + @dash.setter + def dash(self, val): + self['dash'] = val + + # shape + # ----- + @property + 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'] + + Returns + ------- + Any + """ + return self['shape'] + + @shape.setter + def shape(self, val): + self['shape'] = val + + # smoothing + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['smoothing'] + + @smoothing.setter + def smoothing(self, val): + self['smoothing'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + """ + + def __init__( + self, + arg=None, + color=None, + dash=None, + shape=None, + smoothing=None, + width=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterternary.Line + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.Line +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['dash'] = v_line.DashValidator() + self._validators['shape'] = v_line.ShapeValidator() + self._validators['smoothing'] = v_line.SmoothingValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('dash', None) + self['dash'] = dash if dash is not None else _v + _v = arg.pop('shape', None) + self['shape'] = shape if shape is not None else _v + _v = arg.pop('smoothing', None) + self['smoothing'] = smoothing if smoothing is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.scatterternary.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterternary.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary import ( + hoverlabel as v_hoverlabel + ) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scatterternary import unselected -from ._textfont import Textfont -from ._stream import Stream -from ._selected import Selected from plotly.graph_objs.scatterternary import selected -from ._marker import Marker from plotly.graph_objs.scatterternary import marker -from ._line import Line -from ._hoverlabel import Hoverlabel from plotly.graph_objs.scatterternary import hoverlabel diff --git a/plotly/graph_objs/scatterternary/_hoverlabel.py b/plotly/graph_objs/scatterternary/_hoverlabel.py deleted file mode 100644 index 4eab17de5bf..00000000000 --- a/plotly/graph_objs/scatterternary/_hoverlabel.py +++ /dev/null @@ -1,417 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.scatterternary.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary import ( - hoverlabel as v_hoverlabel - ) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/_line.py b/plotly/graph_objs/scatterternary/_line.py deleted file mode 100644 index 2ff8767f2b4..00000000000 --- a/plotly/graph_objs/scatterternary/_line.py +++ /dev/null @@ -1,280 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # dash - # ---- - @property - def dash(self): - """ - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - - The 'dash' property is an enumeration that may be specified as: - - One of the following dash styles: - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - - A string containing a dash length list in pixels or percentages - (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) - - Returns - ------- - str - """ - return self['dash'] - - @dash.setter - def dash(self, val): - self['dash'] = val - - # shape - # ----- - @property - 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'] - - Returns - ------- - Any - """ - return self['shape'] - - @shape.setter - def shape(self, val): - self['shape'] = val - - # smoothing - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['smoothing'] - - @smoothing.setter - def smoothing(self, val): - self['smoothing'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - shape - Determines the line shape. With "spline" the lines are - drawn using spline interpolation. The other available - values correspond to step-wise line shapes. - smoothing - Has an effect only if `shape` is set to "spline" Sets - the amount of smoothing. 0 corresponds to no smoothing - (equivalent to a "linear" shape). - width - Sets the line width (in px). - """ - - def __init__( - self, - arg=None, - color=None, - dash=None, - shape=None, - smoothing=None, - width=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterternary.Line - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash type string - ("solid", "dot", "dash", "longdash", "dashdot", or - "longdashdot") or a dash length list in px (eg - "5px,10px,2px,2px"). - shape - Determines the line shape. With "spline" the lines are - drawn using spline interpolation. The other available - values correspond to step-wise line shapes. - smoothing - Has an effect only if `shape` is set to "spline" Sets - the amount of smoothing. 0 corresponds to no smoothing - (equivalent to a "linear" shape). - width - Sets the line width (in px). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.Line -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['dash'] = v_line.DashValidator() - self._validators['shape'] = v_line.ShapeValidator() - self._validators['smoothing'] = v_line.SmoothingValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('dash', None) - self['dash'] = dash if dash is not None else _v - _v = arg.pop('shape', None) - self['shape'] = shape if shape is not None else _v - _v = arg.pop('smoothing', None) - self['smoothing'] = smoothing if smoothing is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/_marker.py b/plotly/graph_objs/scatterternary/_marker.py deleted file mode 100644 index e477e55195f..00000000000 --- a/plotly/graph_objs/scatterternary/_marker.py +++ /dev/null @@ -1,1320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in `marker.color`is - set to a numerical array. In case `colorscale` is unspecified - or `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` array are - all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.color`) or the - bounds set in `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical array. Defaults - to `false` when `marker.cmin` and `marker.cmax` are set by the - user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmin` - must be set as well. - - The 'cmax' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling `marker.cmin` - and/or `marker.cmax` to be equidistant to this point. Has an - effect only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color`. Has no - effect when `marker.cauto` is `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmax` - must be set as well. - - The 'cmin' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarkercolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scatterternary.marker.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of 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 - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scatterternary.marker.colorba - r.Tickformatstop instance or dict with - compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scatterternary.marker.colorbar.tickformatstop - defaults), sets the default property values to - use for elements of - scatterternary.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatterternary.marker.colorba - r.Title instance or dict with compatible - properties - titlefont - Deprecated: Please use - 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. - titleside - Deprecated: Please use - scatterternary.marker.colorbar.title.side - instead. Determines the location of color bar's - title with respect to the color bar. Note that - the title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.scatterternary.marker.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in `marker.color`is - set to a numerical array. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At minimum, a mapping for - the lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` - may be a palette name string of the following list: Greys,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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # gradient - # -------- - @property - def gradient(self): - """ - The 'gradient' property is an instance of Gradient - that may be specified as: - - An instance of 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 - horizontal, or the bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color - . - type - Sets the type of gradient used to fill the - markers - typesrc - Sets the source reference on plot.ly for type - . - - Returns - ------- - plotly.graph_objs.scatterternary.marker.Gradient - """ - return self['gradient'] - - @gradient.setter - def gradient(self, val): - self['gradient'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.scatterternary.marker.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # maxdisplayed - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['maxdisplayed'] - - @maxdisplayed.setter - def maxdisplayed(self, val): - self['maxdisplayed'] = val - - # opacity - # ------- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # opacitysrc - # ---------- - @property - def opacitysrc(self): - """ - Sets the source reference on plot.ly for opacity . - - The 'opacitysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['opacitysrc'] - - @opacitysrc.setter - def opacitysrc(self, val): - self['opacitysrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.color`is set to a numerical array. If true, - `marker.cmin` will correspond to the last color in the array - and `marker.cmax` will correspond to the first color. - - The 'reversescale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # size - # ---- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizemin - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['sizemin'] - - @sizemin.setter - def sizemin(self, val): - self['sizemin'] = val - - # sizemode - # -------- - @property - 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'] - - Returns - ------- - Any - """ - return self['sizemode'] - - @sizemode.setter - def sizemode(self, val): - self['sizemode'] = val - - # sizeref - # ------- - @property - 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 - - Returns - ------- - int|float - """ - return self['sizeref'] - - @sizeref.setter - def sizeref(self, val): - self['sizeref'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # symbol - # ------ - @property - def symbol(self): - """ - Sets the marker symbol type. Adding 100 is equivalent to - appending "-open" to a symbol name. Adding 200 is equivalent to - appending "-dot" to a symbol name. Adding 300 is equivalent to - appending "-open-dot" or "dot-open" to a symbol name. - - The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', - 315, 'hexagon2-open-dot', 16, 'octagon', 116, - 'octagon-open', 216, 'octagon-dot', 316, - 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, - 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, - 'hexagram-open', 218, 'hexagram-dot', 318, - 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', - 120, 'star-triangle-down-open', 220, - 'star-triangle-down-dot', 320, - 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, - 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, - 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, - 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, - 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, - 'line-nw-open'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['symbol'] - - @symbol.setter - def symbol(self, val): - self['symbol'] = val - - # symbolsrc - # --------- - @property - def symbolsrc(self): - """ - Sets the source reference on plot.ly for symbol . - - The 'symbolsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['symbolsrc'] - - @symbolsrc.setter - def symbolsrc(self, val): - self['symbolsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scatterternary.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - gradient - plotly.graph_objs.scatterternary.marker.Gradient - instance or dict with compatible properties - line - plotly.graph_objs.scatterternary.marker.Line instance - or dict with compatible properties - maxdisplayed - Sets a maximum number of points to be drawn on the - graph. 0 corresponds to no limit. - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorbar=None, - colorscale=None, - colorsrc=None, - gradient=None, - line=None, - maxdisplayed=None, - opacity=None, - opacitysrc=None, - reversescale=None, - showscale=None, - size=None, - sizemin=None, - sizemode=None, - sizeref=None, - sizesrc=None, - symbol=None, - symbolsrc=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterternary.Marker - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.scatterternary.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - gradient - plotly.graph_objs.scatterternary.marker.Gradient - instance or dict with compatible properties - line - plotly.graph_objs.scatterternary.marker.Line instance - or dict with compatible properties - maxdisplayed - Sets a maximum number of points to be drawn on the - graph. 0 corresponds to no limit. - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() - self._validators['cauto'] = v_marker.CautoValidator() - self._validators['cmax'] = v_marker.CmaxValidator() - self._validators['cmid'] = v_marker.CmidValidator() - self._validators['cmin'] = v_marker.CminValidator() - self._validators['color'] = v_marker.ColorValidator() - self._validators['colorbar'] = v_marker.ColorBarValidator() - self._validators['colorscale'] = v_marker.ColorscaleValidator() - self._validators['colorsrc'] = v_marker.ColorsrcValidator() - self._validators['gradient'] = v_marker.GradientValidator() - self._validators['line'] = v_marker.LineValidator() - self._validators['maxdisplayed'] = v_marker.MaxdisplayedValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() - self._validators['reversescale'] = v_marker.ReversescaleValidator() - self._validators['showscale'] = v_marker.ShowscaleValidator() - self._validators['size'] = v_marker.SizeValidator() - self._validators['sizemin'] = v_marker.SizeminValidator() - self._validators['sizemode'] = v_marker.SizemodeValidator() - self._validators['sizeref'] = v_marker.SizerefValidator() - self._validators['sizesrc'] = v_marker.SizesrcValidator() - self._validators['symbol'] = v_marker.SymbolValidator() - self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('gradient', None) - self['gradient'] = gradient if gradient is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('maxdisplayed', None) - self['maxdisplayed'] = maxdisplayed if maxdisplayed is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('opacitysrc', None) - self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizemin', None) - self['sizemin'] = sizemin if sizemin is not None else _v - _v = arg.pop('sizemode', None) - self['sizemode'] = sizemode if sizemode is not None else _v - _v = arg.pop('sizeref', None) - self['sizeref'] = sizeref if sizeref is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - _v = arg.pop('symbol', None) - self['symbol'] = symbol if symbol is not None else _v - _v = arg.pop('symbolsrc', None) - self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/_selected.py b/plotly/graph_objs/scatterternary/_selected.py deleted file mode 100644 index 3ef0449a128..00000000000 --- a/plotly/graph_objs/scatterternary/_selected.py +++ /dev/null @@ -1,147 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Selected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - plotly.graph_objs.scatterternary.selected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.scatterternary.selected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.scatterternary.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scatterternary.selected.Textfont - instance or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Selected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.Selected - marker - plotly.graph_objs.scatterternary.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scatterternary.selected.Textfont - instance or dict with compatible properties - - Returns - ------- - Selected - """ - super(Selected, self).__init__('selected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.Selected -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.Selected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary import (selected as v_selected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_selected.MarkerValidator() - self._validators['textfont'] = v_selected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/_stream.py b/plotly/graph_objs/scatterternary/_stream.py deleted file mode 100644 index 0aa92baa21c..00000000000 --- a/plotly/graph_objs/scatterternary/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterternary.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.Stream -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/_textfont.py b/plotly/graph_objs/scatterternary/_textfont.py deleted file mode 100644 index 3355ab36bcf..00000000000 --- a/plotly/graph_objs/scatterternary/_textfont.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Textfont object - - Sets the text font. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.Textfont - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary import (textfont as v_textfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - self._validators['colorsrc'] = v_textfont.ColorsrcValidator() - self._validators['family'] = v_textfont.FamilyValidator() - self._validators['familysrc'] = v_textfont.FamilysrcValidator() - self._validators['size'] = v_textfont.SizeValidator() - self._validators['sizesrc'] = v_textfont.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/_unselected.py b/plotly/graph_objs/scatterternary/_unselected.py deleted file mode 100644 index d651cc5d192..00000000000 --- a/plotly/graph_objs/scatterternary/_unselected.py +++ /dev/null @@ -1,153 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Unselected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. - - Returns - ------- - plotly.graph_objs.scatterternary.unselected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # textfont - # -------- - @property - def textfont(self): - """ - The 'textfont' property is an instance of Textfont - that may be specified as: - - An instance of 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. - - Returns - ------- - plotly.graph_objs.scatterternary.unselected.Textfont - """ - return self['textfont'] - - @textfont.setter - def textfont(self, val): - self['textfont'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.scatterternary.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scatterternary.unselected.Textfont - instance or dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, textfont=None, **kwargs): - """ - Construct a new Unselected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.Unselected - marker - plotly.graph_objs.scatterternary.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scatterternary.unselected.Textfont - instance or dict with compatible properties - - Returns - ------- - Unselected - """ - super(Unselected, self).__init__('unselected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.Unselected -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.Unselected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary import ( - unselected as v_unselected - ) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_unselected.MarkerValidator() - self._validators['textfont'] = v_unselected.TextfontValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - _v = arg.pop('textfont', None) - self['textfont'] = textfont if textfont is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/hoverlabel/__init__.py b/plotly/graph_objs/scatterternary/hoverlabel/__init__.py index c37b8b5cd28..9699145a8cf 100644 --- a/plotly/graph_objs/scatterternary/hoverlabel/__init__.py +++ b/plotly/graph_objs/scatterternary/hoverlabel/__init__.py @@ -1 +1,324 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterternary.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary.hoverlabel import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/hoverlabel/_font.py b/plotly/graph_objs/scatterternary/hoverlabel/_font.py deleted file mode 100644 index 929b0218ace..00000000000 --- a/plotly/graph_objs/scatterternary/hoverlabel/_font.py +++ /dev/null @@ -1,322 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary.hoverlabel import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/marker/__init__.py b/plotly/graph_objs/scatterternary/marker/__init__.py index c66a50cf28d..d9357fc17b3 100644 --- a/plotly/graph_objs/scatterternary/marker/__init__.py +++ b/plotly/graph_objs/scatterternary/marker/__init__.py @@ -1,4 +1,2692 @@ -from ._line import Line -from ._gradient import Gradient -from ._colorbar import ColorBar + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + 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) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color`is + 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 + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarker.linecolor. It accepts either a specific color or + an array of numbers that are mapped to the colorscale relative + to the max and min values of the array or relative to + `marker.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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to scatterternary.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized value + to an rgb, rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and highest (1) values + are required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color`is set to a numerical array. If true, + `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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterternary.marker.Line + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.marker.Line +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.marker.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary.marker import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() + self._validators['cauto'] = v_line.CautoValidator() + self._validators['cmax'] = v_line.CmaxValidator() + self._validators['cmid'] = v_line.CmidValidator() + self._validators['cmin'] = v_line.CminValidator() + self._validators['color'] = v_line.ColorValidator() + self._validators['colorscale'] = v_line.ColorscaleValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['reversescale'] = v_line.ReversescaleValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Gradient(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # type + # ---- + @property + 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'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # typesrc + # ------- + @property + def typesrc(self): + """ + Sets the source reference on plot.ly for type . + + The 'typesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['typesrc'] + + @typesrc.setter + def typesrc(self, val): + self['typesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color . + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on plot.ly for type . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + type=None, + typesrc=None, + **kwargs + ): + """ + Construct a new Gradient object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterternary.marker.Gradient + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color . + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on plot.ly for type . + + Returns + ------- + Gradient + """ + super(Gradient, self).__init__('gradient') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.marker.Gradient +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.marker.Gradient""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary.marker import ( + gradient as v_gradient + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_gradient.ColorValidator() + self._validators['colorsrc'] = v_gradient.ColorsrcValidator() + self._validators['type'] = v_gradient.TypeValidator() + self._validators['typesrc'] = v_gradient.TypesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + _v = arg.pop('typesrc', None) + self['typesrc'] = typesrc if typesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scatterternary.marker.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scatterternary + .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 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 + ------- + plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.scatterternary.marker.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use + scatterternary.marker.colorbar.title.side instead. Determines + the location of color bar's title with respect to the color + bar. Note that the title's location used to be set by the now + deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scatterternary.marker.colorbar.Tickfo + rmatstop instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rternary.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scatterternary.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatterternary.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + 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. + titleside + Deprecated: Please use + scatterternary.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterternary.marker.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.scatterternary.marker.colorbar.Tickfo + rmatstop instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rternary.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scatterternary.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatterternary.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + 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. + titleside + Deprecated: Please use + scatterternary.marker.colorbar.title.side instead. + Determines the location of color bar's title with + respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.marker.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.marker.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary.marker import ( + colorbar as v_colorbar + ) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scatterternary.marker import colorbar diff --git a/plotly/graph_objs/scatterternary/marker/_colorbar.py b/plotly/graph_objs/scatterternary/marker/_colorbar.py deleted file mode 100644 index 1ebf138dc5b..00000000000 --- a/plotly/graph_objs/scatterternary/marker/_colorbar.py +++ /dev/null @@ -1,1872 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scatterternary.marker.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.scatterternary - .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 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 - ------- - plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.scatterternary.marker.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use - scatterternary.marker.colorbar.title.side instead. Determines - the location of color bar's title with respect to the color - bar. Note that the title's location used to be set by the now - deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scatterternary.marker.colorbar.Tickfo - rmatstop instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - rternary.marker.colorbar.tickformatstopdefaults), sets - the default property values to use for elements of - scatterternary.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatterternary.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - 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. - titleside - Deprecated: Please use - scatterternary.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.marker.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.scatterternary.marker.colorbar.Tickfo - rmatstop instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.scatte - rternary.marker.colorbar.tickformatstopdefaults), sets - the default property values to use for elements of - scatterternary.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatterternary.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - 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. - titleside - Deprecated: Please use - scatterternary.marker.colorbar.title.side instead. - Determines the location of color bar's title with - respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.marker.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.marker.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary.marker import ( - colorbar as v_colorbar - ) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/marker/_gradient.py b/plotly/graph_objs/scatterternary/marker/_gradient.py deleted file mode 100644 index 142b3c7da84..00000000000 --- a/plotly/graph_objs/scatterternary/marker/_gradient.py +++ /dev/null @@ -1,238 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Gradient(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # type - # ---- - @property - 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'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # typesrc - # ------- - @property - def typesrc(self): - """ - Sets the source reference on plot.ly for type . - - The 'typesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['typesrc'] - - @typesrc.setter - def typesrc(self, val): - self['typesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the final color of the gradient fill: the center - color for radial, the right for horizontal, or the - bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color . - type - Sets the type of gradient used to fill the markers - typesrc - Sets the source reference on plot.ly for type . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - type=None, - typesrc=None, - **kwargs - ): - """ - Construct a new Gradient object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.marker.Gradient - color - Sets the final color of the gradient fill: the center - color for radial, the right for horizontal, or the - bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color . - type - Sets the type of gradient used to fill the markers - typesrc - Sets the source reference on plot.ly for type . - - Returns - ------- - Gradient - """ - super(Gradient, self).__init__('gradient') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.marker.Gradient -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.marker.Gradient""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary.marker import ( - gradient as v_gradient - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_gradient.ColorValidator() - self._validators['colorsrc'] = v_gradient.ColorsrcValidator() - self._validators['type'] = v_gradient.TypeValidator() - self._validators['typesrc'] = v_gradient.TypesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - _v = arg.pop('typesrc', None) - self['typesrc'] = typesrc if typesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/marker/_line.py b/plotly/graph_objs/scatterternary/marker/_line.py deleted file mode 100644 index dc2f8c86170..00000000000 --- a/plotly/graph_objs/scatterternary/marker/_line.py +++ /dev/null @@ -1,573 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is true, the - default palette will be chosen according to whether numbers in - the `color` array are all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.line.color`) or the - bounds set in `marker.line.cmin` and `marker.line.cmax` Has an - 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) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be equidistant - to this point. Has an effect only if in `marker.line.color`is - 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 - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarker.linecolor. It accepts either a specific color or - an array of numbers that are mapped to the colorscale relative - to the max and min values of the array or relative to - `marker.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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to scatterternary.marker.line.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized value - to an rgb, rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and highest (1) values - are required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the colorscale in - color space, use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.line.color`is set to a numerical array. If true, - `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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorscale=None, - colorsrc=None, - reversescale=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.marker.Line - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.marker.Line -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.marker.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary.marker import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() - self._validators['cauto'] = v_line.CautoValidator() - self._validators['cmax'] = v_line.CmaxValidator() - self._validators['cmid'] = v_line.CmidValidator() - self._validators['cmin'] = v_line.CminValidator() - self._validators['color'] = v_line.ColorValidator() - self._validators['colorscale'] = v_line.ColorscaleValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['reversescale'] = v_line.ReversescaleValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/marker/colorbar/__init__.py b/plotly/graph_objs/scatterternary/marker/colorbar/__init__.py index 7043b3988d9..3275f97fcec 100644 --- a/plotly/graph_objs/scatterternary/marker/colorbar/__init__.py +++ b/plotly/graph_objs/scatterternary/marker/colorbar/__init__.py @@ -1,4 +1,725 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.scatterternary.marker.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterternary.marker.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.marker.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.marker.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary.marker.colorbar import ( + title as v_title + ) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterternary.marker. + colorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary.marker.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterternary.marker. + colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.marker.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.marker.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary.marker.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.scatterternary.marker.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/scatterternary/marker/colorbar/_tickfont.py b/plotly/graph_objs/scatterternary/marker/colorbar/_tickfont.py deleted file mode 100644 index 15b653f5a33..00000000000 --- a/plotly/graph_objs/scatterternary/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterternary.marker. - colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.marker.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.marker.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary.marker.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py deleted file mode 100644 index b3e75a8e2b6..00000000000 --- a/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterternary.marker. - colorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary.marker.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/marker/colorbar/_title.py b/plotly/graph_objs/scatterternary/marker/colorbar/_title.py deleted file mode 100644 index 10e8527d192..00000000000 --- a/plotly/graph_objs/scatterternary/marker/colorbar/_title.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.scatterternary.marker.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.marker.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.marker.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.marker.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary.marker.colorbar import ( - title as v_title - ) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/marker/colorbar/title/__init__.py b/plotly/graph_objs/scatterternary/marker/colorbar/title/__init__.py index c37b8b5cd28..472c3b06ee2 100644 --- a/plotly/graph_objs/scatterternary/marker/colorbar/title/__init__.py +++ b/plotly/graph_objs/scatterternary/marker/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary.marker.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.scatterternary.marker. + colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.marker.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.marker.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary.marker.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/marker/colorbar/title/_font.py b/plotly/graph_objs/scatterternary/marker/colorbar/title/_font.py deleted file mode 100644 index b77e4cb7c02..00000000000 --- a/plotly/graph_objs/scatterternary/marker/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary.marker.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.scatterternary.marker. - colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.marker.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.marker.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary.marker.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/selected/__init__.py b/plotly/graph_objs/scatterternary/selected/__init__.py index adba53218ca..87b8ba76d1d 100644 --- a/plotly/graph_objs/scatterternary/selected/__init__.py +++ b/plotly/graph_objs/scatterternary/selected/__init__.py @@ -1,2 +1,342 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterternary.selected.Textfont + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.selected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.selected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary.selected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterternary.selected.Marker + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.selected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.selected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary.selected import ( + marker as v_marker + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/selected/_marker.py b/plotly/graph_objs/scatterternary/selected/_marker.py deleted file mode 100644 index a93358a398a..00000000000 --- a/plotly/graph_objs/scatterternary/selected/_marker.py +++ /dev/null @@ -1,197 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.selected.Marker - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.selected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.selected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary.selected import ( - marker as v_marker - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/selected/_textfont.py b/plotly/graph_objs/scatterternary/selected/_textfont.py deleted file mode 100644 index 2a75b72b10a..00000000000 --- a/plotly/graph_objs/scatterternary/selected/_textfont.py +++ /dev/null @@ -1,141 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of selected points. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.selected.Textfont - color - Sets the text font color of selected points. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.selected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.selected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary.selected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/unselected/__init__.py b/plotly/graph_objs/scatterternary/unselected/__init__.py index adba53218ca..91c445528b4 100644 --- a/plotly/graph_objs/scatterternary/unselected/__init__.py +++ b/plotly/graph_objs/scatterternary/unselected/__init__.py @@ -1,2 +1,354 @@ -from ._textfont import Textfont -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterternary.unselected.Textfont + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super(Textfont, self).__init__('textfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.unselected.Textfont +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.unselected.Textfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary.unselected import ( + textfont as v_textfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_textfont.ColorValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'scatterternary.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.scatterternary.unselected.Marker + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.scatterternary.unselected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.scatterternary.unselected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.scatterternary.unselected import ( + marker as v_marker + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/unselected/_marker.py b/plotly/graph_objs/scatterternary/unselected/_marker.py deleted file mode 100644 index 642082bdfa9..00000000000 --- a/plotly/graph_objs/scatterternary/unselected/_marker.py +++ /dev/null @@ -1,206 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.unselected.Marker - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.unselected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.unselected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary.unselected import ( - marker as v_marker - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/scatterternary/unselected/_textfont.py b/plotly/graph_objs/scatterternary/unselected/_textfont.py deleted file mode 100644 index 96b19b098eb..00000000000 --- a/plotly/graph_objs/scatterternary/unselected/_textfont.py +++ /dev/null @@ -1,144 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Textfont(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'scatterternary.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the text font color of unselected points, applied - only when a selection exists. - """ - - def __init__(self, arg=None, color=None, **kwargs): - """ - Construct a new Textfont object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.scatterternary.unselected.Textfont - color - Sets the text font color of unselected points, applied - only when a selection exists. - - Returns - ------- - Textfont - """ - super(Textfont, self).__init__('textfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.scatterternary.unselected.Textfont -constructor must be a dict or -an instance of plotly.graph_objs.scatterternary.unselected.Textfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.scatterternary.unselected import ( - textfont as v_textfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_textfont.ColorValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/__init__.py b/plotly/graph_objs/splom/__init__.py index d64fc797a96..2dc0febaadb 100644 --- a/plotly/graph_objs/splom/__init__.py +++ b/plotly/graph_objs/splom/__init__.py @@ -1,12 +1,2486 @@ -from ._unselected import Unselected + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. + + Returns + ------- + plotly.graph_objs.splom.unselected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.splom.unselected.Marker instance or + dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.splom.Unselected + marker + plotly.graph_objs.splom.unselected.Marker instance or + dict with compatible properties + + Returns + ------- + Unselected + """ + super(Unselected, self).__init__('unselected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.Unselected +constructor must be a dict or +an instance of plotly.graph_objs.splom.Unselected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom import (unselected as v_unselected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_unselected.MarkerValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.splom.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.Stream +constructor must be a dict or +an instance of plotly.graph_objs.splom.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + plotly.graph_objs.splom.selected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.splom.selected.Marker instance or + dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.splom.Selected + marker + plotly.graph_objs.splom.selected.Marker instance or + dict with compatible properties + + Returns + ------- + Selected + """ + super(Selected, self).__init__('selected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.Selected +constructor must be a dict or +an instance of plotly.graph_objs.splom.Selected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom import (selected as v_selected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_selected.MarkerValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color`is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` array are + all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmin` + must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color`is set to a numerical array. Value should have + the same units as in `marker.color` and if set, `marker.cmax` + must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarkercolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to splom.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorbar + # -------- + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of 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 + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.splom.marker.colorbar.Tickfor + matstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.splom.marker.colorbar.tickformatstopdefaults) + , sets the default property values to use for + elements of + splom.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.splom.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + splom.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. + titleside + Deprecated: Please use + splom.marker.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + plotly.graph_objs.splom.marker.ColorBar + """ + return self['colorbar'] + + @colorbar.setter + def colorbar(self, val): + self['colorbar'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color`is + set to a numerical array. The colorscale must be an array + containing arrays mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At minimum, a mapping for + the lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Greys,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 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.splom.marker.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # opacity + # ------- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # opacitysrc + # ---------- + @property + def opacitysrc(self): + """ + Sets the source reference on plot.ly for opacity . + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['opacitysrc'] + + @opacitysrc.setter + def opacitysrc(self, val): + self['opacitysrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color`is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # showscale + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['showscale'] + + @showscale.setter + def showscale(self, val): + self['showscale'] = val + + # size + # ---- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizemin + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['sizemin'] + + @sizemin.setter + def sizemin(self, val): + self['sizemin'] = val + + # sizemode + # -------- + @property + 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'] + + Returns + ------- + Any + """ + return self['sizemode'] + + @sizemode.setter + def sizemode(self, val): + self['sizemode'] = val + + # sizeref + # ------- + @property + 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 + + Returns + ------- + int|float + """ + return self['sizeref'] + + @sizeref.setter + def sizeref(self, val): + self['sizeref'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # symbol + # ------ + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', + 315, 'hexagon2-open-dot', 16, 'octagon', 116, + 'octagon-open', 216, 'octagon-dot', 316, + 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, + 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, + 'hexagram-open', 218, 'hexagram-dot', 318, + 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', + 120, 'star-triangle-down-open', 220, + 'star-triangle-down-dot', 320, + 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, + 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, + 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, + 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, + 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, + 'line-nw-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['symbol'] + + @symbol.setter + def symbol(self, val): + self['symbol'] = val + + # symbolsrc + # --------- + @property + def symbolsrc(self): + """ + Sets the source reference on plot.ly for symbol . + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['symbolsrc'] + + @symbolsrc.setter + def symbolsrc(self, val): + self['symbolsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.splom.marker.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + line + plotly.graph_objs.splom.marker.Line instance or dict + with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorbar=None, + colorscale=None, + colorsrc=None, + line=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.splom.Marker + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color`is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color`is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color`is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + colorbar + plotly.graph_objs.splom.marker.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu + ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E + arth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + line + plotly.graph_objs.splom.marker.Line instance or dict + with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for opacity . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color`is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color`is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size . + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for symbol . + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.Marker +constructor must be a dict or +an instance of plotly.graph_objs.splom.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() + self._validators['cauto'] = v_marker.CautoValidator() + self._validators['cmax'] = v_marker.CmaxValidator() + self._validators['cmid'] = v_marker.CmidValidator() + self._validators['cmin'] = v_marker.CminValidator() + self._validators['color'] = v_marker.ColorValidator() + self._validators['colorbar'] = v_marker.ColorBarValidator() + self._validators['colorscale'] = v_marker.ColorscaleValidator() + self._validators['colorsrc'] = v_marker.ColorsrcValidator() + self._validators['line'] = v_marker.LineValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() + self._validators['reversescale'] = v_marker.ReversescaleValidator() + self._validators['showscale'] = v_marker.ShowscaleValidator() + self._validators['size'] = v_marker.SizeValidator() + self._validators['sizemin'] = v_marker.SizeminValidator() + self._validators['sizemode'] = v_marker.SizemodeValidator() + self._validators['sizeref'] = v_marker.SizerefValidator() + self._validators['sizesrc'] = v_marker.SizesrcValidator() + self._validators['symbol'] = v_marker.SymbolValidator() + self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorbar', None) + self['colorbar'] = colorbar if colorbar is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('opacitysrc', None) + self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('showscale', None) + self['showscale'] = showscale if showscale is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizemin', None) + self['sizemin'] = sizemin if sizemin is not None else _v + _v = arg.pop('sizemode', None) + self['sizemode'] = sizemode if sizemode is not None else _v + _v = arg.pop('sizeref', None) + self['sizeref'] = sizeref if sizeref is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + _v = arg.pop('symbol', None) + self['symbol'] = symbol if symbol is not None else _v + _v = arg.pop('symbolsrc', None) + self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.splom.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.splom.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.splom.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Dimension(_BaseTraceHierarchyType): + + # axis + # ---- + @property + def axis(self): + """ + The 'axis' property is an instance of Axis + that may be specified as: + - An instance of 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 + to setting the `matches` axis attribute in the + layout with the correct axis id. + type + 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. + + Returns + ------- + plotly.graph_objs.splom.dimension.Axis + """ + return self['axis'] + + @axis.setter + def axis(self, val): + self['axis'] = val + + # label + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['label'] + + @label.setter + def label(self, val): + self['label'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # values + # ------ + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['values'] + + @values.setter + def values(self, val): + self['values'] = val + + # valuessrc + # --------- + @property + def valuessrc(self): + """ + Sets the source reference on plot.ly for values . + + The 'valuessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['valuessrc'] + + @valuessrc.setter + def valuessrc(self, val): + self['valuessrc'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + axis + plotly.graph_objs.splom.dimension.Axis instance or dict + with compatible properties + label + Sets the label corresponding to this splom dimension. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + values + Sets the dimension values to be plotted. + valuessrc + Sets the source reference on plot.ly for values . + visible + Determines whether or not this dimension is shown on + the graph. Note that even visible false dimension + contribute to the default grid generate by this splom + trace. + """ + + def __init__( + self, + arg=None, + axis=None, + label=None, + name=None, + templateitemname=None, + values=None, + valuessrc=None, + visible=None, + **kwargs + ): + """ + Construct a new Dimension object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.splom.Dimension + axis + plotly.graph_objs.splom.dimension.Axis instance or dict + with compatible properties + label + Sets the label corresponding to this splom dimension. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + values + Sets the dimension values to be plotted. + valuessrc + Sets the source reference on plot.ly for values . + visible + Determines whether or not this dimension is shown on + the graph. Note that even visible false dimension + contribute to the default grid generate by this splom + trace. + + Returns + ------- + Dimension + """ + super(Dimension, self).__init__('dimensions') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.Dimension +constructor must be a dict or +an instance of plotly.graph_objs.splom.Dimension""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom import (dimension as v_dimension) + + # Initialize validators + # --------------------- + self._validators['axis'] = v_dimension.AxisValidator() + self._validators['label'] = v_dimension.LabelValidator() + self._validators['name'] = v_dimension.NameValidator() + self._validators['templateitemname' + ] = v_dimension.TemplateitemnameValidator() + self._validators['values'] = v_dimension.ValuesValidator() + self._validators['valuessrc'] = v_dimension.ValuessrcValidator() + self._validators['visible'] = v_dimension.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('axis', None) + self['axis'] = axis if axis is not None else _v + _v = arg.pop('label', None) + self['label'] = label if label is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('values', None) + self['values'] = values if values is not None else _v + _v = arg.pop('valuessrc', None) + self['valuessrc'] = valuessrc if valuessrc is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Diagonal(_BaseTraceHierarchyType): + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + visible + Determines whether or not subplots on the diagonal are + displayed. + """ + + def __init__(self, arg=None, visible=None, **kwargs): + """ + Construct a new Diagonal object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.splom.Diagonal + visible + Determines whether or not subplots on the diagonal are + displayed. + + Returns + ------- + Diagonal + """ + super(Diagonal, self).__init__('diagonal') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.Diagonal +constructor must be a dict or +an instance of plotly.graph_objs.splom.Diagonal""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom import (diagonal as v_diagonal) + + # Initialize validators + # --------------------- + self._validators['visible'] = v_diagonal.VisibleValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.splom import unselected -from ._stream import Stream -from ._selected import Selected from plotly.graph_objs.splom import selected -from ._marker import Marker from plotly.graph_objs.splom import marker -from ._hoverlabel import Hoverlabel from plotly.graph_objs.splom import hoverlabel -from ._dimension import Dimension from plotly.graph_objs.splom import dimension -from ._diagonal import Diagonal diff --git a/plotly/graph_objs/splom/_diagonal.py b/plotly/graph_objs/splom/_diagonal.py deleted file mode 100644 index a1a9ed5be5b..00000000000 --- a/plotly/graph_objs/splom/_diagonal.py +++ /dev/null @@ -1,102 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Diagonal(BaseTraceHierarchyType): - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - visible - Determines whether or not subplots on the diagonal are - displayed. - """ - - def __init__(self, arg=None, visible=None, **kwargs): - """ - Construct a new Diagonal object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.Diagonal - visible - Determines whether or not subplots on the diagonal are - displayed. - - Returns - ------- - Diagonal - """ - super(Diagonal, self).__init__('diagonal') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.Diagonal -constructor must be a dict or -an instance of plotly.graph_objs.splom.Diagonal""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom import (diagonal as v_diagonal) - - # Initialize validators - # --------------------- - self._validators['visible'] = v_diagonal.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/_dimension.py b/plotly/graph_objs/splom/_dimension.py deleted file mode 100644 index 42249b25855..00000000000 --- a/plotly/graph_objs/splom/_dimension.py +++ /dev/null @@ -1,344 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Dimension(BaseTraceHierarchyType): - - # axis - # ---- - @property - def axis(self): - """ - The 'axis' property is an instance of Axis - that may be specified as: - - An instance of 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 - to setting the `matches` axis attribute in the - layout with the correct axis id. - type - 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. - - Returns - ------- - plotly.graph_objs.splom.dimension.Axis - """ - return self['axis'] - - @axis.setter - def axis(self, val): - self['axis'] = val - - # label - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['label'] - - @label.setter - def label(self, val): - self['label'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # values - # ------ - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['values'] - - @values.setter - def values(self, val): - self['values'] = val - - # valuessrc - # --------- - @property - def valuessrc(self): - """ - Sets the source reference on plot.ly for values . - - The 'valuessrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['valuessrc'] - - @valuessrc.setter - def valuessrc(self, val): - self['valuessrc'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - axis - plotly.graph_objs.splom.dimension.Axis instance or dict - with compatible properties - label - Sets the label corresponding to this splom dimension. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - values - Sets the dimension values to be plotted. - valuessrc - Sets the source reference on plot.ly for values . - visible - Determines whether or not this dimension is shown on - the graph. Note that even visible false dimension - contribute to the default grid generate by this splom - trace. - """ - - def __init__( - self, - arg=None, - axis=None, - label=None, - name=None, - templateitemname=None, - values=None, - valuessrc=None, - visible=None, - **kwargs - ): - """ - Construct a new Dimension object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.Dimension - axis - plotly.graph_objs.splom.dimension.Axis instance or dict - with compatible properties - label - Sets the label corresponding to this splom dimension. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - values - Sets the dimension values to be plotted. - valuessrc - Sets the source reference on plot.ly for values . - visible - Determines whether or not this dimension is shown on - the graph. Note that even visible false dimension - contribute to the default grid generate by this splom - trace. - - Returns - ------- - Dimension - """ - super(Dimension, self).__init__('dimensions') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.Dimension -constructor must be a dict or -an instance of plotly.graph_objs.splom.Dimension""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom import (dimension as v_dimension) - - # Initialize validators - # --------------------- - self._validators['axis'] = v_dimension.AxisValidator() - self._validators['label'] = v_dimension.LabelValidator() - self._validators['name'] = v_dimension.NameValidator() - self._validators['templateitemname' - ] = v_dimension.TemplateitemnameValidator() - self._validators['values'] = v_dimension.ValuesValidator() - self._validators['valuessrc'] = v_dimension.ValuessrcValidator() - self._validators['visible'] = v_dimension.VisibleValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('axis', None) - self['axis'] = axis if axis is not None else _v - _v = arg.pop('label', None) - self['label'] = label if label is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('values', None) - self['values'] = values if values is not None else _v - _v = arg.pop('valuessrc', None) - self['valuessrc'] = valuessrc if valuessrc is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/_hoverlabel.py b/plotly/graph_objs/splom/_hoverlabel.py deleted file mode 100644 index 9861f8cc4dc..00000000000 --- a/plotly/graph_objs/splom/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.splom.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.splom.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/_marker.py b/plotly/graph_objs/splom/_marker.py deleted file mode 100644 index 9849b43495f..00000000000 --- a/plotly/graph_objs/splom/_marker.py +++ /dev/null @@ -1,1241 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in `marker.color`is - set to a numerical array. In case `colorscale` is unspecified - or `autocolorscale` is true, the default palette will be - chosen according to whether numbers in the `color` array are - all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.color`) or the - bounds set in `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical array. Defaults - to `false` when `marker.cmin` and `marker.cmax` are set by the - user. - - The 'cauto' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmin` - must be set as well. - - The 'cmax' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling `marker.cmin` - and/or `marker.cmax` to be equidistant to this point. Has an - effect only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color`. Has no - effect when `marker.cauto` is `false`. - - The 'cmid' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - in `marker.color`is set to a numerical array. Value should have - the same units as in `marker.color` and if set, `marker.cmax` - must be set as well. - - The 'cmin' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarkercolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to splom.marker.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorbar - # -------- - @property - def colorbar(self): - """ - The 'colorbar' property is an instance of ColorBar - that may be specified as: - - An instance of 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 - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.splom.marker.colorbar.Tickfor - matstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.splom.marker.colorbar.tickformatstopdefaults) - , sets the default property values to use for - elements of - splom.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.splom.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - splom.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. - titleside - Deprecated: Please use - splom.marker.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - plotly.graph_objs.splom.marker.ColorBar - """ - return self['colorbar'] - - @colorbar.setter - def colorbar(self, val): - self['colorbar'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in `marker.color`is - set to a numerical array. The colorscale must be an array - containing arrays mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At minimum, a mapping for - the lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, `colorscale` - may be a palette name string of the following list: Greys,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 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.splom.marker.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # opacity - # ------- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # opacitysrc - # ---------- - @property - def opacitysrc(self): - """ - Sets the source reference on plot.ly for opacity . - - The 'opacitysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['opacitysrc'] - - @opacitysrc.setter - def opacitysrc(self, val): - self['opacitysrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.color`is set to a numerical array. If true, - `marker.cmin` will correspond to the last color in the array - and `marker.cmax` will correspond to the first color. - - The 'reversescale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # showscale - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['showscale'] - - @showscale.setter - def showscale(self, val): - self['showscale'] = val - - # size - # ---- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizemin - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['sizemin'] - - @sizemin.setter - def sizemin(self, val): - self['sizemin'] = val - - # sizemode - # -------- - @property - 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'] - - Returns - ------- - Any - """ - return self['sizemode'] - - @sizemode.setter - def sizemode(self, val): - self['sizemode'] = val - - # sizeref - # ------- - @property - 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 - - Returns - ------- - int|float - """ - return self['sizeref'] - - @sizeref.setter - def sizeref(self, val): - self['sizeref'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # symbol - # ------ - @property - def symbol(self): - """ - Sets the marker symbol type. Adding 100 is equivalent to - appending "-open" to a symbol name. Adding 200 is equivalent to - appending "-dot" to a symbol name. Adding 300 is equivalent to - appending "-open-dot" or "dot-open" to a symbol name. - - The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', - 315, 'hexagon2-open-dot', 16, 'octagon', 116, - 'octagon-open', 216, 'octagon-dot', 316, - 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, - 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, - 'hexagram-open', 218, 'hexagram-dot', 318, - 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', - 120, 'star-triangle-down-open', 220, - 'star-triangle-down-dot', 320, - 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, - 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, - 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, - 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, - 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, - 'line-nw-open'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['symbol'] - - @symbol.setter - def symbol(self, val): - self['symbol'] = val - - # symbolsrc - # --------- - @property - def symbolsrc(self): - """ - Sets the source reference on plot.ly for symbol . - - The 'symbolsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['symbolsrc'] - - @symbolsrc.setter - def symbolsrc(self, val): - self['symbolsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.splom.marker.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - line - plotly.graph_objs.splom.marker.Line instance or dict - with compatible properties - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorbar=None, - colorscale=None, - colorsrc=None, - line=None, - opacity=None, - opacitysrc=None, - reversescale=None, - showscale=None, - size=None, - sizemin=None, - sizemode=None, - sizeref=None, - sizesrc=None, - symbol=None, - symbolsrc=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.Marker - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.colorscale`. Has an effect only if in - `marker.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in `marker.color`) - or the bounds set in `marker.cmin` and `marker.cmax` - Has an effect only if in `marker.color`is set to a - numerical array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by scaling - `marker.cmin` and/or `marker.cmax` to be equidistant to - this point. Has an effect only if in `marker.color`is - set to a numerical array. Value should have the same - units as in `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has an effect - only if in `marker.color`is set to a numerical array. - Value should have the same units as in `marker.color` - and if set, `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - colorbar - plotly.graph_objs.splom.marker.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.cmin` and `marker.cmax`. Alternatively, - `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu - ,Reds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,E - arth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - line - plotly.graph_objs.splom.marker.Line instance or dict - with compatible properties - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for opacity . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.color`is set to a numerical array. If - true, `marker.cmin` will correspond to the last color - in the array and `marker.cmax` will correspond to the - first color. - showscale - Determines whether or not a colorbar is displayed for - this trace. Has an effect only if in `marker.color`is - set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) of the - rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the data in - `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. Use with - `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size . - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for symbol . - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.Marker -constructor must be a dict or -an instance of plotly.graph_objs.splom.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_marker.AutocolorscaleValidator() - self._validators['cauto'] = v_marker.CautoValidator() - self._validators['cmax'] = v_marker.CmaxValidator() - self._validators['cmid'] = v_marker.CmidValidator() - self._validators['cmin'] = v_marker.CminValidator() - self._validators['color'] = v_marker.ColorValidator() - self._validators['colorbar'] = v_marker.ColorBarValidator() - self._validators['colorscale'] = v_marker.ColorscaleValidator() - self._validators['colorsrc'] = v_marker.ColorsrcValidator() - self._validators['line'] = v_marker.LineValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['opacitysrc'] = v_marker.OpacitysrcValidator() - self._validators['reversescale'] = v_marker.ReversescaleValidator() - self._validators['showscale'] = v_marker.ShowscaleValidator() - self._validators['size'] = v_marker.SizeValidator() - self._validators['sizemin'] = v_marker.SizeminValidator() - self._validators['sizemode'] = v_marker.SizemodeValidator() - self._validators['sizeref'] = v_marker.SizerefValidator() - self._validators['sizesrc'] = v_marker.SizesrcValidator() - self._validators['symbol'] = v_marker.SymbolValidator() - self._validators['symbolsrc'] = v_marker.SymbolsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorbar', None) - self['colorbar'] = colorbar if colorbar is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('opacitysrc', None) - self['opacitysrc'] = opacitysrc if opacitysrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('showscale', None) - self['showscale'] = showscale if showscale is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizemin', None) - self['sizemin'] = sizemin if sizemin is not None else _v - _v = arg.pop('sizemode', None) - self['sizemode'] = sizemode if sizemode is not None else _v - _v = arg.pop('sizeref', None) - self['sizeref'] = sizeref if sizeref is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - _v = arg.pop('symbol', None) - self['symbol'] = symbol if symbol is not None else _v - _v = arg.pop('symbolsrc', None) - self['symbolsrc'] = symbolsrc if symbolsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/_selected.py b/plotly/graph_objs/splom/_selected.py deleted file mode 100644 index 7d685eb824e..00000000000 --- a/plotly/graph_objs/splom/_selected.py +++ /dev/null @@ -1,111 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Selected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - plotly.graph_objs.splom.selected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.splom.selected.Marker instance or - dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, **kwargs): - """ - Construct a new Selected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.Selected - marker - plotly.graph_objs.splom.selected.Marker instance or - dict with compatible properties - - Returns - ------- - Selected - """ - super(Selected, self).__init__('selected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.Selected -constructor must be a dict or -an instance of plotly.graph_objs.splom.Selected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom import (selected as v_selected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_selected.MarkerValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/_stream.py b/plotly/graph_objs/splom/_stream.py deleted file mode 100644 index f0d77df442b..00000000000 --- a/plotly/graph_objs/splom/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.Stream -constructor must be a dict or -an instance of plotly.graph_objs.splom.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/_unselected.py b/plotly/graph_objs/splom/_unselected.py deleted file mode 100644 index 816e63a1295..00000000000 --- a/plotly/graph_objs/splom/_unselected.py +++ /dev/null @@ -1,114 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Unselected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. - - Returns - ------- - plotly.graph_objs.splom.unselected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.splom.unselected.Marker instance or - dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, **kwargs): - """ - Construct a new Unselected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.Unselected - marker - plotly.graph_objs.splom.unselected.Marker instance or - dict with compatible properties - - Returns - ------- - Unselected - """ - super(Unselected, self).__init__('unselected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.Unselected -constructor must be a dict or -an instance of plotly.graph_objs.splom.Unselected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom import (unselected as v_unselected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_unselected.MarkerValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/dimension/__init__.py b/plotly/graph_objs/splom/dimension/__init__.py index d99d2db8730..184d57ecf90 100644 --- a/plotly/graph_objs/splom/dimension/__init__.py +++ b/plotly/graph_objs/splom/dimension/__init__.py @@ -1 +1,143 @@ -from ._axis import Axis + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Axis(_BaseTraceHierarchyType): + + # matches + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['matches'] + + @matches.setter + def matches(self, val): + self['matches'] = val + + # type + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['type'] + + @type.setter + def type(self, val): + self['type'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom.dimension' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + matches + 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. + type + 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. + """ + + def __init__(self, arg=None, matches=None, type=None, **kwargs): + """ + Construct a new Axis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.splom.dimension.Axis + matches + 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. + type + 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. + + Returns + ------- + Axis + """ + super(Axis, self).__init__('axis') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.dimension.Axis +constructor must be a dict or +an instance of plotly.graph_objs.splom.dimension.Axis""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom.dimension import (axis as v_axis) + + # Initialize validators + # --------------------- + self._validators['matches'] = v_axis.MatchesValidator() + self._validators['type'] = v_axis.TypeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('matches', None) + self['matches'] = matches if matches is not None else _v + _v = arg.pop('type', None) + self['type'] = type if type is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/splom/dimension/_axis.py b/plotly/graph_objs/splom/dimension/_axis.py deleted file mode 100644 index 2125bc0b61c..00000000000 --- a/plotly/graph_objs/splom/dimension/_axis.py +++ /dev/null @@ -1,141 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Axis(BaseTraceHierarchyType): - - # matches - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['matches'] - - @matches.setter - def matches(self, val): - self['matches'] = val - - # type - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['type'] - - @type.setter - def type(self, val): - self['type'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom.dimension' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - matches - 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. - type - 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. - """ - - def __init__(self, arg=None, matches=None, type=None, **kwargs): - """ - Construct a new Axis object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.dimension.Axis - matches - 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. - type - 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. - - Returns - ------- - Axis - """ - super(Axis, self).__init__('axis') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.dimension.Axis -constructor must be a dict or -an instance of plotly.graph_objs.splom.dimension.Axis""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom.dimension import (axis as v_axis) - - # Initialize validators - # --------------------- - self._validators['matches'] = v_axis.MatchesValidator() - self._validators['type'] = v_axis.TypeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('matches', None) - self['matches'] = matches if matches is not None else _v - _v = arg.pop('type', None) - self['type'] = type if type is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/hoverlabel/__init__.py b/plotly/graph_objs/splom/hoverlabel/__init__.py index c37b8b5cd28..8a8ca36abfd 100644 --- a/plotly/graph_objs/splom/hoverlabel/__init__.py +++ b/plotly/graph_objs/splom/hoverlabel/__init__.py @@ -1 +1,321 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.splom.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.splom.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/splom/hoverlabel/_font.py b/plotly/graph_objs/splom/hoverlabel/_font.py deleted file mode 100644 index f28448c218f..00000000000 --- a/plotly/graph_objs/splom/hoverlabel/_font.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.splom.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/marker/__init__.py b/plotly/graph_objs/splom/marker/__init__.py index d2d000bfde9..de47d0e45a0 100644 --- a/plotly/graph_objs/splom/marker/__init__.py +++ b/plotly/graph_objs/splom/marker/__init__.py @@ -1,3 +1,2443 @@ -from ._line import Line -from ._colorbar import ColorBar + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # autocolorscale + # -------------- + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['autocolorscale'] + + @autocolorscale.setter + def autocolorscale(self, val): + self['autocolorscale'] = val + + # cauto + # ----- + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + 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) + + Returns + ------- + bool + """ + return self['cauto'] + + @cauto.setter + def cauto(self, val): + self['cauto'] = val + + # cmax + # ---- + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmax'] + + @cmax.setter + def cmax(self, val): + self['cmax'] = val + + # cmid + # ---- + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color`is + 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 + + Returns + ------- + int|float + """ + return self['cmid'] + + @cmid.setter + def cmid(self, val): + self['cmid'] = val + + # cmin + # ---- + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + 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 + + Returns + ------- + int|float + """ + return self['cmin'] + + @cmin.setter + def cmin(self, val): + self['cmin'] = val + + # color + # ----- + @property + def color(self): + """ + Sets themarker.linecolor. It accepts either a specific color or + an array of numbers that are mapped to the colorscale relative + to the max and min values of the array or relative to + `marker.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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A number that will be interpreted as a color + according to splom.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorscale + # ---------- + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The colorscale + must be an array containing arrays mapping a normalized value + to an rgb, rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and highest (1) values + are required. For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl + ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi + ridis,Cividis. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', + 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', + 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] + + Returns + ------- + str + """ + return self['colorscale'] + + @colorscale.setter + def colorscale(self, val): + self['colorscale'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # reversescale + # ------------ + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color`is set to a numerical array. If true, + `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) + + Returns + ------- + bool + """ + return self['reversescale'] + + @reversescale.setter + def reversescale(self, val): + self['reversescale'] = val + + # width + # ----- + @property + 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 + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.splom.marker.Line + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color`is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an + 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. + cmax + Sets the upper bound of the color domain. Has an effect + only if 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. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has an effect + only if 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. + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. The + colorscale must be an array containing arrays mapping a + normalized value to an rgb, rgba, hex, hsl, hsv, or + named color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. For + example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use`marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Greys,YlGnBu,Greens,YlOrR + d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H + ot,Blackbody,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color . + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color`is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.marker.Line +constructor must be a dict or +an instance of plotly.graph_objs.splom.marker.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom.marker import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() + self._validators['cauto'] = v_line.CautoValidator() + self._validators['cmax'] = v_line.CmaxValidator() + self._validators['cmid'] = v_line.CmidValidator() + self._validators['cmin'] = v_line.CminValidator() + self._validators['color'] = v_line.ColorValidator() + self._validators['colorscale'] = v_line.ColorscaleValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['reversescale'] = v_line.ReversescaleValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('autocolorscale', None) + self['autocolorscale' + ] = autocolorscale if autocolorscale is not None else _v + _v = arg.pop('cauto', None) + self['cauto'] = cauto if cauto is not None else _v + _v = arg.pop('cmax', None) + self['cmax'] = cmax if cmax is not None else _v + _v = arg.pop('cmid', None) + self['cmid'] = cmid if cmid is not None else _v + _v = arg.pop('cmin', None) + self['cmin'] = cmin if cmin is not None else _v + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorscale', None) + self['colorscale'] = colorscale if colorscale is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('reversescale', None) + self['reversescale'] = reversescale if reversescale is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.splom.marker.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.splom.marker.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.splom.marker.c + 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 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 + ------- + plotly.graph_objs.splom.marker.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.splom.marker.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + def titlefont(self): + """ + Deprecated: Please use splom.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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use splom.marker.colorbar.title.side + instead. Determines the location of color bar's title with + respect to the color bar. Note that the title's location used + to be set by the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.splom.marker.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.splom. + marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + splom.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.splom.marker.colorbar.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use splom.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. + titleside + Deprecated: Please use splom.marker.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.splom.marker.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.splom.marker.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.splom. + marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + splom.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.splom.marker.colorbar.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use splom.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. + titleside + Deprecated: Please use splom.marker.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.marker.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.splom.marker.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom.marker import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.splom.marker import colorbar diff --git a/plotly/graph_objs/splom/marker/_colorbar.py b/plotly/graph_objs/splom/marker/_colorbar.py deleted file mode 100644 index 501b6506a03..00000000000 --- a/plotly/graph_objs/splom/marker/_colorbar.py +++ /dev/null @@ -1,1864 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.splom.marker.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.splom.marker.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as layout.template.data.splom.marker.c - 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 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 - ------- - plotly.graph_objs.splom.marker.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.splom.marker.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - def titlefont(self): - """ - Deprecated: Please use splom.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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use splom.marker.colorbar.title.side - instead. Determines the location of color bar's title with - respect to the color bar. Note that the title's location used - to be set by the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.splom.marker.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.splom. - marker.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - splom.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.splom.marker.colorbar.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use splom.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. - titleside - Deprecated: Please use splom.marker.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.marker.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.splom.marker.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.splom. - marker.colorbar.tickformatstopdefaults), sets the - default property values to use for elements of - splom.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.splom.marker.colorbar.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use splom.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. - titleside - Deprecated: Please use splom.marker.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.marker.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.splom.marker.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom.marker import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/marker/_line.py b/plotly/graph_objs/splom/marker/_line.py deleted file mode 100644 index 8bd8974f61b..00000000000 --- a/plotly/graph_objs/splom/marker/_line.py +++ /dev/null @@ -1,572 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # autocolorscale - # -------------- - @property - def autocolorscale(self): - """ - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is true, the - default palette will be chosen according to whether numbers in - the `color` array are all positive, all negative or mixed. - - The 'autocolorscale' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['autocolorscale'] - - @autocolorscale.setter - def autocolorscale(self, val): - self['autocolorscale'] = val - - # cauto - # ----- - @property - def cauto(self): - """ - Determines whether or not the color domain is computed with - respect to the input data (here in `marker.line.color`) or the - bounds set in `marker.line.cmin` and `marker.line.cmax` Has an - 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) - - Returns - ------- - bool - """ - return self['cauto'] - - @cauto.setter - def cauto(self, val): - self['cauto'] = val - - # cmax - # ---- - @property - def cmax(self): - """ - Sets the upper bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmax'] - - @cmax.setter - def cmax(self, val): - self['cmax'] = val - - # cmid - # ---- - @property - def cmid(self): - """ - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be equidistant - to this point. Has an effect only if in `marker.line.color`is - 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 - - Returns - ------- - int|float - """ - return self['cmid'] - - @cmid.setter - def cmid(self, val): - self['cmid'] = val - - # cmin - # ---- - @property - def cmin(self): - """ - Sets the lower bound of the color domain. Has an effect only if - 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 - - Returns - ------- - int|float - """ - return self['cmin'] - - @cmin.setter - def cmin(self, val): - self['cmin'] = val - - # color - # ----- - @property - def color(self): - """ - Sets themarker.linecolor. It accepts either a specific color or - an array of numbers that are mapped to the colorscale relative - to the max and min values of the array or relative to - `marker.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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A number that will be interpreted as a color - according to splom.marker.line.colorscale - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorscale - # ---------- - @property - def colorscale(self): - """ - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The colorscale - must be an array containing arrays mapping a normalized value - to an rgb, rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and highest (1) values - are required. For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the colorscale in - color space, use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name string of the - following list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Bl - ues,Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth,Electric,Vi - ridis,Cividis. - - The 'colorscale' property is a colorscale and may be - specified as: - - A list of 2-element lists where the first element is the - normalized color level value (starting at 0 and ending at 1), - and the second item is a valid color string. - (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) - - One of the following named colorscales: - ['Greys', 'YlGnBu', 'Greens', 'YlOrRd', 'Bluered', 'RdBu', - 'Reds', 'Blues', 'Picnic', 'Rainbow', 'Portland', 'Jet', - 'Hot', 'Blackbody', 'Earth', 'Electric', 'Viridis', 'Cividis'] - - Returns - ------- - str - """ - return self['colorscale'] - - @colorscale.setter - def colorscale(self, val): - self['colorscale'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # reversescale - # ------------ - @property - def reversescale(self): - """ - Reverses the color mapping if true. Has an effect only if in - `marker.line.color`is set to a numerical array. If true, - `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) - - Returns - ------- - bool - """ - return self['reversescale'] - - @reversescale.setter - def reversescale(self, val): - self['reversescale'] = val - - # width - # ----- - @property - 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 - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - autocolorscale=None, - cauto=None, - cmax=None, - cmid=None, - cmin=None, - color=None, - colorscale=None, - colorsrc=None, - reversescale=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.marker.Line - autocolorscale - Determines whether the colorscale is a default palette - (`autocolorscale: true`) or the palette determined by - `marker.line.colorscale`. Has an effect only if in - `marker.line.color`is set to a numerical array. In case - `colorscale` is unspecified or `autocolorscale` is - true, the default palette will be chosen according to - whether numbers in the `color` array are all positive, - all negative or mixed. - cauto - Determines whether or not the color domain is computed - with respect to the input data (here in - `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has an - 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. - cmax - Sets the upper bound of the color domain. Has an effect - only if 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. - cmid - Sets the mid-point of the color domain by scaling - `marker.line.cmin` and/or `marker.line.cmax` to be - equidistant to this point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has an effect - only if 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. - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. The - colorscale must be an array containing arrays mapping a - normalized value to an rgb, rgba, hex, hsl, hsv, or - named color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. For - example, `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. - To control the bounds of the colorscale in color space, - use`marker.line.cmin` and `marker.line.cmax`. - Alternatively, `colorscale` may be a palette name - string of the following list: Greys,YlGnBu,Greens,YlOrR - d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H - ot,Blackbody,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color . - reversescale - Reverses the color mapping if true. Has an effect only - if in `marker.line.color`is set to a numerical array. - If true, `marker.line.cmin` will correspond to the last - color in the array and `marker.line.cmax` will - correspond to the first color. - width - Sets the width (in px) of the lines bounding the marker - points. - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.marker.Line -constructor must be a dict or -an instance of plotly.graph_objs.splom.marker.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom.marker import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['autocolorscale'] = v_line.AutocolorscaleValidator() - self._validators['cauto'] = v_line.CautoValidator() - self._validators['cmax'] = v_line.CmaxValidator() - self._validators['cmid'] = v_line.CmidValidator() - self._validators['cmin'] = v_line.CminValidator() - self._validators['color'] = v_line.ColorValidator() - self._validators['colorscale'] = v_line.ColorscaleValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['reversescale'] = v_line.ReversescaleValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('autocolorscale', None) - self['autocolorscale' - ] = autocolorscale if autocolorscale is not None else _v - _v = arg.pop('cauto', None) - self['cauto'] = cauto if cauto is not None else _v - _v = arg.pop('cmax', None) - self['cmax'] = cmax if cmax is not None else _v - _v = arg.pop('cmid', None) - self['cmid'] = cmid if cmid is not None else _v - _v = arg.pop('cmin', None) - self['cmin'] = cmin if cmin is not None else _v - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorscale', None) - self['colorscale'] = colorscale if colorscale is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('reversescale', None) - self['reversescale'] = reversescale if reversescale is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/marker/colorbar/__init__.py b/plotly/graph_objs/splom/marker/colorbar/__init__.py index 52e5b575a5d..8df64406b87 100644 --- a/plotly/graph_objs/splom/marker/colorbar/__init__.py +++ b/plotly/graph_objs/splom/marker/colorbar/__init__.py @@ -1,4 +1,723 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.splom.marker.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.splom.marker.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.marker.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.splom.marker.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom.marker.colorbar import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.splom.marker.colorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.splom.marker.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom.marker.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom.marker.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.splom.marker.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.marker.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.splom.marker.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom.marker.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.splom.marker.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/splom/marker/colorbar/_tickfont.py b/plotly/graph_objs/splom/marker/colorbar/_tickfont.py deleted file mode 100644 index a415d1d3281..00000000000 --- a/plotly/graph_objs/splom/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.splom.marker.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.marker.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.splom.marker.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom.marker.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py b/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py deleted file mode 100644 index 714501b68b4..00000000000 --- a/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.splom.marker.colorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.marker.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.splom.marker.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom.marker.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/marker/colorbar/_title.py b/plotly/graph_objs/splom/marker/colorbar/_title.py deleted file mode 100644 index 2c5d6199661..00000000000 --- a/plotly/graph_objs/splom/marker/colorbar/_title.py +++ /dev/null @@ -1,202 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.splom.marker.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom.marker.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.splom.marker.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.marker.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.splom.marker.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom.marker.colorbar import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/marker/colorbar/title/__init__.py b/plotly/graph_objs/splom/marker/colorbar/title/__init__.py index c37b8b5cd28..3214c09804c 100644 --- a/plotly/graph_objs/splom/marker/colorbar/title/__init__.py +++ b/plotly/graph_objs/splom/marker/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom.marker.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.splom.marker.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.marker.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.splom.marker.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom.marker.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/splom/marker/colorbar/title/_font.py b/plotly/graph_objs/splom/marker/colorbar/title/_font.py deleted file mode 100644 index a1d2c4da584..00000000000 --- a/plotly/graph_objs/splom/marker/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom.marker.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.splom.marker.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.marker.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.splom.marker.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom.marker.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/selected/__init__.py b/plotly/graph_objs/splom/selected/__init__.py index 0bda16c3500..ef08e0796bd 100644 --- a/plotly/graph_objs/splom/selected/__init__.py +++ b/plotly/graph_objs/splom/selected/__init__.py @@ -1 +1,196 @@ -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.splom.selected.Marker + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.selected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.splom.selected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom.selected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/splom/selected/_marker.py b/plotly/graph_objs/splom/selected/_marker.py deleted file mode 100644 index c65b1ff82c5..00000000000 --- a/plotly/graph_objs/splom/selected/_marker.py +++ /dev/null @@ -1,194 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.splom.selected.Marker - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.selected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.splom.selected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom.selected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/splom/unselected/__init__.py b/plotly/graph_objs/splom/unselected/__init__.py index 0bda16c3500..25cd5690bdc 100644 --- a/plotly/graph_objs/splom/unselected/__init__.py +++ b/plotly/graph_objs/splom/unselected/__init__.py @@ -1 +1,206 @@ -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'splom.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.splom.unselected.Marker + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.splom.unselected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.splom.unselected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.splom.unselected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/splom/unselected/_marker.py b/plotly/graph_objs/splom/unselected/_marker.py deleted file mode 100644 index 325bcd0db97..00000000000 --- a/plotly/graph_objs/splom/unselected/_marker.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'splom.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.splom.unselected.Marker - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.splom.unselected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.splom.unselected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.splom.unselected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/streamtube/__init__.py b/plotly/graph_objs/streamtube/__init__.py index acc14ca0293..b1eb6e98554 100644 --- a/plotly/graph_objs/streamtube/__init__.py +++ b/plotly/graph_objs/streamtube/__init__.py @@ -1,8 +1,3149 @@ -from ._stream import Stream -from ._starts import Starts -from ._lightposition import Lightposition -from ._lighting import Lighting -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'streamtube' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.streamtube.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.streamtube.Stream +constructor must be a dict or +an instance of plotly.graph_objs.streamtube.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.streamtube import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Starts(_BaseTraceHierarchyType): + + # x + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xsrc + # ---- + @property + def xsrc(self): + """ + Sets the source reference on plot.ly for x . + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['xsrc'] + + @xsrc.setter + def xsrc(self, val): + self['xsrc'] = val + + # y + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # ysrc + # ---- + @property + def ysrc(self): + """ + Sets the source reference on plot.ly for y . + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ysrc'] + + @ysrc.setter + def ysrc(self, val): + self['ysrc'] = val + + # z + # - + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # zsrc + # ---- + @property + def zsrc(self): + """ + Sets the source reference on plot.ly for z . + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['zsrc'] + + @zsrc.setter + def zsrc(self, val): + self['zsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'streamtube' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + Sets the x components of the starting position of the + streamtubes + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y components of the starting position of the + streamtubes + ysrc + Sets the source reference on plot.ly for y . + z + Sets the z components of the starting position of the + streamtubes + zsrc + Sets the source reference on plot.ly for z . + """ + + def __init__( + self, + arg=None, + x=None, + xsrc=None, + y=None, + ysrc=None, + z=None, + zsrc=None, + **kwargs + ): + """ + Construct a new Starts object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.streamtube.Starts + x + Sets the x components of the starting position of the + streamtubes + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y components of the starting position of the + streamtubes + ysrc + Sets the source reference on plot.ly for y . + z + Sets the z components of the starting position of the + streamtubes + zsrc + Sets the source reference on plot.ly for z . + + Returns + ------- + Starts + """ + super(Starts, self).__init__('starts') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.streamtube.Starts +constructor must be a dict or +an instance of plotly.graph_objs.streamtube.Starts""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.streamtube import (starts as v_starts) + + # Initialize validators + # --------------------- + self._validators['x'] = v_starts.XValidator() + self._validators['xsrc'] = v_starts.XsrcValidator() + self._validators['y'] = v_starts.YValidator() + self._validators['ysrc'] = v_starts.YsrcValidator() + self._validators['z'] = v_starts.ZValidator() + self._validators['zsrc'] = v_starts.ZsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xsrc', None) + self['xsrc'] = xsrc if xsrc is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('ysrc', None) + self['ysrc'] = ysrc if ysrc is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + _v = arg.pop('zsrc', None) + self['zsrc'] = zsrc if zsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lightposition(_BaseTraceHierarchyType): + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # z + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'streamtube' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Lightposition object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.streamtube.Lightposition + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + + Returns + ------- + Lightposition + """ + super(Lightposition, self).__init__('lightposition') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.streamtube.Lightposition +constructor must be a dict or +an instance of plotly.graph_objs.streamtube.Lightposition""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.streamtube import ( + lightposition as v_lightposition + ) + + # Initialize validators + # --------------------- + self._validators['x'] = v_lightposition.XValidator() + self._validators['y'] = v_lightposition.YValidator() + self._validators['z'] = v_lightposition.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lighting(_BaseTraceHierarchyType): + + # ambient + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ambient'] + + @ambient.setter + def ambient(self, val): + self['ambient'] = val + + # diffuse + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['diffuse'] + + @diffuse.setter + def diffuse(self, val): + self['diffuse'] = val + + # facenormalsepsilon + # ------------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['facenormalsepsilon'] + + @facenormalsepsilon.setter + def facenormalsepsilon(self, val): + self['facenormalsepsilon'] = val + + # fresnel + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['fresnel'] + + @fresnel.setter + def fresnel(self, val): + self['fresnel'] = val + + # roughness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['roughness'] + + @roughness.setter + def roughness(self, val): + self['roughness'] = val + + # specular + # -------- + @property + 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] + + Returns + ------- + int|float + """ + return self['specular'] + + @specular.setter + def specular(self, val): + self['specular'] = val + + # vertexnormalsepsilon + # -------------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['vertexnormalsepsilon'] + + @vertexnormalsepsilon.setter + def vertexnormalsepsilon(self, val): + self['vertexnormalsepsilon'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'streamtube' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + """ + + def __init__( + self, + arg=None, + ambient=None, + diffuse=None, + facenormalsepsilon=None, + fresnel=None, + roughness=None, + specular=None, + vertexnormalsepsilon=None, + **kwargs + ): + """ + Construct a new Lighting object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.streamtube.Lighting + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + + Returns + ------- + Lighting + """ + super(Lighting, self).__init__('lighting') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.streamtube.Lighting +constructor must be a dict or +an instance of plotly.graph_objs.streamtube.Lighting""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.streamtube import (lighting as v_lighting) + + # Initialize validators + # --------------------- + self._validators['ambient'] = v_lighting.AmbientValidator() + self._validators['diffuse'] = v_lighting.DiffuseValidator() + self._validators['facenormalsepsilon' + ] = v_lighting.FacenormalsepsilonValidator() + self._validators['fresnel'] = v_lighting.FresnelValidator() + self._validators['roughness'] = v_lighting.RoughnessValidator() + self._validators['specular'] = v_lighting.SpecularValidator() + self._validators['vertexnormalsepsilon' + ] = v_lighting.VertexnormalsepsilonValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('ambient', None) + self['ambient'] = ambient if ambient is not None else _v + _v = arg.pop('diffuse', None) + self['diffuse'] = diffuse if diffuse is not None else _v + _v = arg.pop('facenormalsepsilon', None) + self['facenormalsepsilon' + ] = facenormalsepsilon if facenormalsepsilon is not None else _v + _v = arg.pop('fresnel', None) + self['fresnel'] = fresnel if fresnel is not None else _v + _v = arg.pop('roughness', None) + self['roughness'] = roughness if roughness is not None else _v + _v = arg.pop('specular', None) + self['specular'] = specular if specular is not None else _v + _v = arg.pop('vertexnormalsepsilon', None) + self[ + 'vertexnormalsepsilon' + ] = vertexnormalsepsilon if vertexnormalsepsilon is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.streamtube.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'streamtube' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.streamtube.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.streamtube.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.streamtube.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.streamtube import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.streamtube.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.streamtube.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + 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 plotly.graph_objs.streamtube.colorbar.Tickformatstop + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.streamtube.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.streamtube.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use streamtube.colorbar.title.side instead. + Determines the location of color bar's title with respect to + the color bar. Note that the title's location used to be set by + the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'streamtube' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.streamtube.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.stream + tube.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + streamtube.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.streamtube.colorbar.Title instance or + dict with compatible properties + titlefont + Deprecated: Please use streamtube.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use streamtube.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.streamtube.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.streamtube.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.stream + tube.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + streamtube.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.streamtube.colorbar.Title instance or + dict with compatible properties + titlefont + Deprecated: Please use streamtube.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use streamtube.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.streamtube.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.streamtube.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.streamtube import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.streamtube import hoverlabel -from ._colorbar import ColorBar from plotly.graph_objs.streamtube import colorbar diff --git a/plotly/graph_objs/streamtube/_colorbar.py b/plotly/graph_objs/streamtube/_colorbar.py deleted file mode 100644 index e87e96d4994..00000000000 --- a/plotly/graph_objs/streamtube/_colorbar.py +++ /dev/null @@ -1,1862 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.streamtube.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.streamtube.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - 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 plotly.graph_objs.streamtube.colorbar.Tickformatstop - - A dict of string/value properties that will be passed - to the Tickformatstop constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.streamtube.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.streamtube.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use streamtube.colorbar.title.side instead. - Determines the location of color bar's title with respect to - the color bar. Note that the title's location used to be set by - the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'streamtube' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.streamtube.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.stream - tube.colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - streamtube.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.streamtube.colorbar.Title instance or - dict with compatible properties - titlefont - Deprecated: Please use streamtube.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use streamtube.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.streamtube.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.streamtube.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.stream - tube.colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - streamtube.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.streamtube.colorbar.Title instance or - dict with compatible properties - titlefont - Deprecated: Please use streamtube.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use streamtube.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.streamtube.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.streamtube.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.streamtube import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/streamtube/_hoverlabel.py b/plotly/graph_objs/streamtube/_hoverlabel.py deleted file mode 100644 index cf65dc152b0..00000000000 --- a/plotly/graph_objs/streamtube/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.streamtube.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'streamtube' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.streamtube.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.streamtube.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.streamtube.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.streamtube import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/streamtube/_lighting.py b/plotly/graph_objs/streamtube/_lighting.py deleted file mode 100644 index 73669353a3c..00000000000 --- a/plotly/graph_objs/streamtube/_lighting.py +++ /dev/null @@ -1,303 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Lighting(BaseTraceHierarchyType): - - # ambient - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ambient'] - - @ambient.setter - def ambient(self, val): - self['ambient'] = val - - # diffuse - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['diffuse'] - - @diffuse.setter - def diffuse(self, val): - self['diffuse'] = val - - # facenormalsepsilon - # ------------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['facenormalsepsilon'] - - @facenormalsepsilon.setter - def facenormalsepsilon(self, val): - self['facenormalsepsilon'] = val - - # fresnel - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['fresnel'] - - @fresnel.setter - def fresnel(self, val): - self['fresnel'] = val - - # roughness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['roughness'] - - @roughness.setter - def roughness(self, val): - self['roughness'] = val - - # specular - # -------- - @property - 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] - - Returns - ------- - int|float - """ - return self['specular'] - - @specular.setter - def specular(self, val): - self['specular'] = val - - # vertexnormalsepsilon - # -------------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['vertexnormalsepsilon'] - - @vertexnormalsepsilon.setter - def vertexnormalsepsilon(self, val): - self['vertexnormalsepsilon'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'streamtube' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - ambient - Ambient light increases overall color visibility but - can wash out the image. - diffuse - Represents the extent that incident rays are reflected - in a range of angles. - facenormalsepsilon - Epsilon for face normals calculation avoids math issues - arising from degenerate geometry. - fresnel - Represents the reflectance as a dependency of the - viewing angle; e.g. paper is reflective when viewing it - from the edge of the paper (almost 90 degrees), causing - shine. - roughness - Alters specular reflection; the rougher the surface, - the wider and less contrasty the shine. - specular - Represents the level that incident rays are reflected - in a single direction, causing shine. - vertexnormalsepsilon - Epsilon for vertex normals calculation avoids math - issues arising from degenerate geometry. - """ - - def __init__( - self, - arg=None, - ambient=None, - diffuse=None, - facenormalsepsilon=None, - fresnel=None, - roughness=None, - specular=None, - vertexnormalsepsilon=None, - **kwargs - ): - """ - Construct a new Lighting object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.streamtube.Lighting - ambient - Ambient light increases overall color visibility but - can wash out the image. - diffuse - Represents the extent that incident rays are reflected - in a range of angles. - facenormalsepsilon - Epsilon for face normals calculation avoids math issues - arising from degenerate geometry. - fresnel - Represents the reflectance as a dependency of the - viewing angle; e.g. paper is reflective when viewing it - from the edge of the paper (almost 90 degrees), causing - shine. - roughness - Alters specular reflection; the rougher the surface, - the wider and less contrasty the shine. - specular - Represents the level that incident rays are reflected - in a single direction, causing shine. - vertexnormalsepsilon - Epsilon for vertex normals calculation avoids math - issues arising from degenerate geometry. - - Returns - ------- - Lighting - """ - super(Lighting, self).__init__('lighting') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.streamtube.Lighting -constructor must be a dict or -an instance of plotly.graph_objs.streamtube.Lighting""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.streamtube import (lighting as v_lighting) - - # Initialize validators - # --------------------- - self._validators['ambient'] = v_lighting.AmbientValidator() - self._validators['diffuse'] = v_lighting.DiffuseValidator() - self._validators['facenormalsepsilon' - ] = v_lighting.FacenormalsepsilonValidator() - self._validators['fresnel'] = v_lighting.FresnelValidator() - self._validators['roughness'] = v_lighting.RoughnessValidator() - self._validators['specular'] = v_lighting.SpecularValidator() - self._validators['vertexnormalsepsilon' - ] = v_lighting.VertexnormalsepsilonValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('ambient', None) - self['ambient'] = ambient if ambient is not None else _v - _v = arg.pop('diffuse', None) - self['diffuse'] = diffuse if diffuse is not None else _v - _v = arg.pop('facenormalsepsilon', None) - self['facenormalsepsilon' - ] = facenormalsepsilon if facenormalsepsilon is not None else _v - _v = arg.pop('fresnel', None) - self['fresnel'] = fresnel if fresnel is not None else _v - _v = arg.pop('roughness', None) - self['roughness'] = roughness if roughness is not None else _v - _v = arg.pop('specular', None) - self['specular'] = specular if specular is not None else _v - _v = arg.pop('vertexnormalsepsilon', None) - self[ - 'vertexnormalsepsilon' - ] = vertexnormalsepsilon if vertexnormalsepsilon is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/streamtube/_lightposition.py b/plotly/graph_objs/streamtube/_lightposition.py deleted file mode 100644 index 8bca49d4940..00000000000 --- a/plotly/graph_objs/streamtube/_lightposition.py +++ /dev/null @@ -1,162 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Lightposition(BaseTraceHierarchyType): - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # z - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'streamtube' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - Numeric vector, representing the X coordinate for each - vertex. - y - Numeric vector, representing the Y coordinate for each - vertex. - z - Numeric vector, representing the Z coordinate for each - vertex. - """ - - def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): - """ - Construct a new Lightposition object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.streamtube.Lightposition - x - Numeric vector, representing the X coordinate for each - vertex. - y - Numeric vector, representing the Y coordinate for each - vertex. - z - Numeric vector, representing the Z coordinate for each - vertex. - - Returns - ------- - Lightposition - """ - super(Lightposition, self).__init__('lightposition') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.streamtube.Lightposition -constructor must be a dict or -an instance of plotly.graph_objs.streamtube.Lightposition""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.streamtube import ( - lightposition as v_lightposition - ) - - # Initialize validators - # --------------------- - self._validators['x'] = v_lightposition.XValidator() - self._validators['y'] = v_lightposition.YValidator() - self._validators['z'] = v_lightposition.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/streamtube/_starts.py b/plotly/graph_objs/streamtube/_starts.py deleted file mode 100644 index fc3fca93dbb..00000000000 --- a/plotly/graph_objs/streamtube/_starts.py +++ /dev/null @@ -1,253 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Starts(BaseTraceHierarchyType): - - # x - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xsrc - # ---- - @property - def xsrc(self): - """ - Sets the source reference on plot.ly for x . - - The 'xsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['xsrc'] - - @xsrc.setter - def xsrc(self, val): - self['xsrc'] = val - - # y - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # ysrc - # ---- - @property - def ysrc(self): - """ - Sets the source reference on plot.ly for y . - - The 'ysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ysrc'] - - @ysrc.setter - def ysrc(self, val): - self['ysrc'] = val - - # z - # - - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # zsrc - # ---- - @property - def zsrc(self): - """ - Sets the source reference on plot.ly for z . - - The 'zsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['zsrc'] - - @zsrc.setter - def zsrc(self, val): - self['zsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'streamtube' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - Sets the x components of the starting position of the - streamtubes - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y components of the starting position of the - streamtubes - ysrc - Sets the source reference on plot.ly for y . - z - Sets the z components of the starting position of the - streamtubes - zsrc - Sets the source reference on plot.ly for z . - """ - - def __init__( - self, - arg=None, - x=None, - xsrc=None, - y=None, - ysrc=None, - z=None, - zsrc=None, - **kwargs - ): - """ - Construct a new Starts object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.streamtube.Starts - x - Sets the x components of the starting position of the - streamtubes - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y components of the starting position of the - streamtubes - ysrc - Sets the source reference on plot.ly for y . - z - Sets the z components of the starting position of the - streamtubes - zsrc - Sets the source reference on plot.ly for z . - - Returns - ------- - Starts - """ - super(Starts, self).__init__('starts') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.streamtube.Starts -constructor must be a dict or -an instance of plotly.graph_objs.streamtube.Starts""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.streamtube import (starts as v_starts) - - # Initialize validators - # --------------------- - self._validators['x'] = v_starts.XValidator() - self._validators['xsrc'] = v_starts.XsrcValidator() - self._validators['y'] = v_starts.YValidator() - self._validators['ysrc'] = v_starts.YsrcValidator() - self._validators['z'] = v_starts.ZValidator() - self._validators['zsrc'] = v_starts.ZsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xsrc', None) - self['xsrc'] = xsrc if xsrc is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('ysrc', None) - self['ysrc'] = ysrc if ysrc is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - _v = arg.pop('zsrc', None) - self['zsrc'] = zsrc if zsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/streamtube/_stream.py b/plotly/graph_objs/streamtube/_stream.py deleted file mode 100644 index 23339a918ea..00000000000 --- a/plotly/graph_objs/streamtube/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'streamtube' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.streamtube.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.streamtube.Stream -constructor must be a dict or -an instance of plotly.graph_objs.streamtube.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.streamtube import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/streamtube/colorbar/__init__.py b/plotly/graph_objs/streamtube/colorbar/__init__.py index b9e4d9529f2..27ad3a83942 100644 --- a/plotly/graph_objs/streamtube/colorbar/__init__.py +++ b/plotly/graph_objs/streamtube/colorbar/__init__.py @@ -1,4 +1,723 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.streamtube.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'streamtube.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.streamtube.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.streamtube.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.streamtube.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.streamtube.colorbar import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'streamtube.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.streamtube.colorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.streamtube.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.streamtube.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.streamtube.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'streamtube.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.streamtube.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.streamtube.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.streamtube.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.streamtube.colorbar import ( + tickfont as v_tickfont + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.streamtube.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/streamtube/colorbar/_tickfont.py b/plotly/graph_objs/streamtube/colorbar/_tickfont.py deleted file mode 100644 index 68c9517e929..00000000000 --- a/plotly/graph_objs/streamtube/colorbar/_tickfont.py +++ /dev/null @@ -1,228 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'streamtube.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.streamtube.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.streamtube.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.streamtube.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.streamtube.colorbar import ( - tickfont as v_tickfont - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py b/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py deleted file mode 100644 index 235d0bffbd8..00000000000 --- a/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'streamtube.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.streamtube.colorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.streamtube.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.streamtube.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.streamtube.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/streamtube/colorbar/_title.py b/plotly/graph_objs/streamtube/colorbar/_title.py deleted file mode 100644 index b81fa875fec..00000000000 --- a/plotly/graph_objs/streamtube/colorbar/_title.py +++ /dev/null @@ -1,202 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.streamtube.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'streamtube.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.streamtube.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.streamtube.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.streamtube.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.streamtube.colorbar import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/streamtube/colorbar/title/__init__.py b/plotly/graph_objs/streamtube/colorbar/title/__init__.py index c37b8b5cd28..83377f3e5bb 100644 --- a/plotly/graph_objs/streamtube/colorbar/title/__init__.py +++ b/plotly/graph_objs/streamtube/colorbar/title/__init__.py @@ -1 +1,231 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'streamtube.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.streamtube.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.streamtube.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.streamtube.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.streamtube.colorbar.title import ( + font as v_font + ) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/streamtube/colorbar/title/_font.py b/plotly/graph_objs/streamtube/colorbar/title/_font.py deleted file mode 100644 index 5494bcb59b7..00000000000 --- a/plotly/graph_objs/streamtube/colorbar/title/_font.py +++ /dev/null @@ -1,229 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'streamtube.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.streamtube.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.streamtube.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.streamtube.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.streamtube.colorbar.title import ( - font as v_font - ) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/streamtube/hoverlabel/__init__.py b/plotly/graph_objs/streamtube/hoverlabel/__init__.py index c37b8b5cd28..2c7d37edbd2 100644 --- a/plotly/graph_objs/streamtube/hoverlabel/__init__.py +++ b/plotly/graph_objs/streamtube/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'streamtube.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.streamtube.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.streamtube.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.streamtube.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.streamtube.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/streamtube/hoverlabel/_font.py b/plotly/graph_objs/streamtube/hoverlabel/_font.py deleted file mode 100644 index 4da1f393da4..00000000000 --- a/plotly/graph_objs/streamtube/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'streamtube.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.streamtube.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.streamtube.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.streamtube.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.streamtube.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/__init__.py b/plotly/graph_objs/surface/__init__.py index 55b53efac9a..5ea78b34910 100644 --- a/plotly/graph_objs/surface/__init__.py +++ b/plotly/graph_objs/surface/__init__.py @@ -1,9 +1,3070 @@ -from ._stream import Stream -from ._lightposition import Lightposition -from ._lighting import Lighting -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.surface.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.Stream +constructor must be a dict or +an instance of plotly.graph_objs.surface.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lightposition(_BaseTraceHierarchyType): + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # z + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Lightposition object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.surface.Lightposition + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + + Returns + ------- + Lightposition + """ + super(Lightposition, self).__init__('lightposition') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.Lightposition +constructor must be a dict or +an instance of plotly.graph_objs.surface.Lightposition""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface import ( + lightposition as v_lightposition + ) + + # Initialize validators + # --------------------- + self._validators['x'] = v_lightposition.XValidator() + self._validators['y'] = v_lightposition.YValidator() + self._validators['z'] = v_lightposition.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lighting(_BaseTraceHierarchyType): + + # ambient + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ambient'] + + @ambient.setter + def ambient(self, val): + self['ambient'] = val + + # diffuse + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['diffuse'] + + @diffuse.setter + def diffuse(self, val): + self['diffuse'] = val + + # fresnel + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['fresnel'] + + @fresnel.setter + def fresnel(self, val): + self['fresnel'] = val + + # roughness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['roughness'] + + @roughness.setter + def roughness(self, val): + self['roughness'] = val + + # specular + # -------- + @property + 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] + + Returns + ------- + int|float + """ + return self['specular'] + + @specular.setter + def specular(self, val): + self['specular'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + """ + + def __init__( + self, + arg=None, + ambient=None, + diffuse=None, + fresnel=None, + roughness=None, + specular=None, + **kwargs + ): + """ + Construct a new Lighting object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.surface.Lighting + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + + Returns + ------- + Lighting + """ + super(Lighting, self).__init__('lighting') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.Lighting +constructor must be a dict or +an instance of plotly.graph_objs.surface.Lighting""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface import (lighting as v_lighting) + + # Initialize validators + # --------------------- + self._validators['ambient'] = v_lighting.AmbientValidator() + self._validators['diffuse'] = v_lighting.DiffuseValidator() + self._validators['fresnel'] = v_lighting.FresnelValidator() + self._validators['roughness'] = v_lighting.RoughnessValidator() + self._validators['specular'] = v_lighting.SpecularValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('ambient', None) + self['ambient'] = ambient if ambient is not None else _v + _v = arg.pop('diffuse', None) + self['diffuse'] = diffuse if diffuse is not None else _v + _v = arg.pop('fresnel', None) + self['fresnel'] = fresnel if fresnel is not None else _v + _v = arg.pop('roughness', None) + self['roughness'] = roughness if roughness is not None else _v + _v = arg.pop('specular', None) + self['specular'] = specular if specular is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.surface.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.surface.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.surface.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Contours(_BaseTraceHierarchyType): + + # x + # - + @property + def x(self): + """ + The 'x' property is an instance of X + that may be specified as: + - An instance of 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. + highlight + Determines whether or not contour lines about + the x dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour + lines. + highlightwidth + Sets the width of the highlighted contour + lines. + project + plotly.graph_objs.surface.contours.x.Project + instance or dict with compatible properties + show + Determines whether or not contour lines about + the x dimension are drawn. + usecolormap + An alternate to "color". Determines whether or + not the contour lines are colored using the + trace "colorscale". + width + Sets the width of the contour lines. + + Returns + ------- + plotly.graph_objs.surface.contours.X + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @property + def y(self): + """ + The 'y' property is an instance of Y + that may be specified as: + - An instance of 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. + highlight + Determines whether or not contour lines about + the y dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour + lines. + highlightwidth + Sets the width of the highlighted contour + lines. + project + plotly.graph_objs.surface.contours.y.Project + instance or dict with compatible properties + show + Determines whether or not contour lines about + the y dimension are drawn. + usecolormap + An alternate to "color". Determines whether or + not the contour lines are colored using the + trace "colorscale". + width + Sets the width of the contour lines. + + Returns + ------- + plotly.graph_objs.surface.contours.Y + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # z + # - + @property + def z(self): + """ + The 'z' property is an instance of Z + that may be specified as: + - An instance of 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. + highlight + Determines whether or not contour lines about + the z dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour + lines. + highlightwidth + Sets the width of the highlighted contour + lines. + project + plotly.graph_objs.surface.contours.z.Project + instance or dict with compatible properties + show + Determines whether or not contour lines about + the z dimension are drawn. + usecolormap + An alternate to "color". Determines whether or + not the contour lines are colored using the + trace "colorscale". + width + Sets the width of the contour lines. + + Returns + ------- + plotly.graph_objs.surface.contours.Z + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + plotly.graph_objs.surface.contours.X instance or dict + with compatible properties + y + plotly.graph_objs.surface.contours.Y instance or dict + with compatible properties + z + plotly.graph_objs.surface.contours.Z instance or dict + with compatible properties + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Contours object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.surface.Contours + x + plotly.graph_objs.surface.contours.X instance or dict + with compatible properties + y + plotly.graph_objs.surface.contours.Y instance or dict + with compatible properties + z + plotly.graph_objs.surface.contours.Z instance or dict + with compatible properties + + Returns + ------- + Contours + """ + super(Contours, self).__init__('contours') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.Contours +constructor must be a dict or +an instance of plotly.graph_objs.surface.Contours""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface import (contours as v_contours) + + # Initialize validators + # --------------------- + self._validators['x'] = v_contours.XValidator() + self._validators['y'] = v_contours.YValidator() + self._validators['z'] = v_contours.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # borderwidth + # ----------- + @property + 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] + + Returns + ------- + int|float + """ + return self['borderwidth'] + + @borderwidth.setter + def borderwidth(self, val): + self['borderwidth'] = val + + # dtick + # ----- + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self['dtick'] + + @dtick.setter + def dtick(self, val): + self['dtick'] = val + + # exponentformat + # -------------- + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self['exponentformat'] + + @exponentformat.setter + def exponentformat(self, val): + self['exponentformat'] = val + + # len + # --- + @property + 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] + + Returns + ------- + int|float + """ + return self['len'] + + @len.setter + def len(self, val): + self['len'] = val + + # lenmode + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['lenmode'] + + @lenmode.setter + def lenmode(self, val): + self['lenmode'] = val + + # nticks + # ------ + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + 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] + + Returns + ------- + int + """ + return self['nticks'] + + @nticks.setter + def nticks(self, val): + self['nticks'] = val + + # outlinecolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outlinecolor'] + + @outlinecolor.setter + def outlinecolor(self, val): + self['outlinecolor'] = val + + # outlinewidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlinewidth'] + + @outlinewidth.setter + def outlinewidth(self, val): + self['outlinewidth'] = val + + # separatethousands + # ----------------- + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['separatethousands'] + + @separatethousands.setter + def separatethousands(self, val): + self['separatethousands'] = val + + # showexponent + # ------------ + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showexponent'] + + @showexponent.setter + def showexponent(self, val): + self['showexponent'] = val + + # showticklabels + # -------------- + @property + 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) + + Returns + ------- + bool + """ + return self['showticklabels'] + + @showticklabels.setter + def showticklabels(self, val): + self['showticklabels'] = val + + # showtickprefix + # -------------- + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self['showtickprefix'] + + @showtickprefix.setter + def showtickprefix(self, val): + self['showtickprefix'] = val + + # showticksuffix + # -------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['showticksuffix'] + + @showticksuffix.setter + def showticksuffix(self, val): + self['showticksuffix'] = val + + # thickness + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['thickness'] + + @thickness.setter + def thickness(self, val): + self['thickness'] = val + + # thicknessmode + # ------------- + @property + 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'] + + Returns + ------- + Any + """ + return self['thicknessmode'] + + @thicknessmode.setter + def thicknessmode(self, val): + self['thicknessmode'] = val + + # tick0 + # ----- + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self['tick0'] + + @tick0.setter + def tick0(self, val): + self['tick0'] = val + + # tickangle + # --------- + @property + 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 + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self['tickangle'] + + @tickangle.setter + def tickangle(self, val): + self['tickangle'] = val + + # tickcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['tickcolor'] + + @tickcolor.setter + def tickcolor(self, val): + self['tickcolor'] = val + + # tickfont + # -------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.surface.colorbar.Tickfont + """ + return self['tickfont'] + + @tickfont.setter + def tickfont(self, val): + self['tickfont'] = val + + # tickformat + # ---------- + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: https://github.com/d3/d3-format/blob/master/READM + E.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one item to + d3's date formatter: "%{n}f" for fractional seconds with n + digits. For example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['tickformat'] + + @tickformat.setter + def tickformat(self, val): + self['tickformat'] = val + + # tickformatstops + # --------------- + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - 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 + is possible to omit "min" or "max" value by + passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" + + Returns + ------- + tuple[plotly.graph_objs.surface.colorbar.Tickformatstop] + """ + return self['tickformatstops'] + + @tickformatstops.setter + def tickformatstops(self, val): + self['tickformatstops'] = val + + # tickformatstopdefaults + # ---------------------- + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + 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 plotly.graph_objs.surface.colorbar.Tickformatstop + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Supported dict properties: + + Returns + ------- + plotly.graph_objs.surface.colorbar.Tickformatstop + """ + return self['tickformatstopdefaults'] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self['tickformatstopdefaults'] = val + + # ticklen + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['ticklen'] + + @ticklen.setter + def ticklen(self, val): + self['ticklen'] = val + + # tickmode + # -------- + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self['tickmode'] + + @tickmode.setter + def tickmode(self, val): + self['tickmode'] = val + + # tickprefix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['tickprefix'] + + @tickprefix.setter + def tickprefix(self, val): + self['tickprefix'] = val + + # ticks + # ----- + @property + 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', ''] + + Returns + ------- + Any + """ + return self['ticks'] + + @ticks.setter + def ticks(self, val): + self['ticks'] = val + + # ticksuffix + # ---------- + @property + 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 + + Returns + ------- + str + """ + return self['ticksuffix'] + + @ticksuffix.setter + def ticksuffix(self, val): + self['ticksuffix'] = val + + # ticktext + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['ticktext'] + + @ticktext.setter + def ticktext(self, val): + self['ticktext'] = val + + # ticktextsrc + # ----------- + @property + def ticktextsrc(self): + """ + Sets the source reference on plot.ly for ticktext . + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['ticktextsrc'] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self['ticktextsrc'] = val + + # tickvals + # -------- + @property + 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 + + Returns + ------- + numpy.ndarray + """ + return self['tickvals'] + + @tickvals.setter + def tickvals(self, val): + self['tickvals'] = val + + # tickvalssrc + # ----------- + @property + def tickvalssrc(self): + """ + Sets the source reference on plot.ly for tickvals . + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['tickvalssrc'] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self['tickvalssrc'] = val + + # tickwidth + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['tickwidth'] + + @tickwidth.setter + def tickwidth(self, val): + self['tickwidth'] = val + + # title + # ----- + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of 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 + deprecated `titlefont` attribute. + side + 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. + text + 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. + + Returns + ------- + plotly.graph_objs.surface.colorbar.Title + """ + return self['title'] + + @title.setter + def title(self, val): + self['title'] = val + + # titlefont + # --------- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + + """ + return self['titlefont'] + + @titlefont.setter + def titlefont(self, val): + self['titlefont'] = val + + # titleside + # --------- + @property + def titleside(self): + """ + Deprecated: Please use surface.colorbar.title.side instead. + Determines the location of color bar's title with respect to + the color bar. Note that the title's location used to be set by + the now deprecated `titleside` attribute. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + + """ + return self['titleside'] + + @titleside.setter + def titleside(self, val): + self['titleside'] = val + + # x + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # xanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['xanchor'] + + @xanchor.setter + def xanchor(self, val): + self['xanchor'] = val + + # xpad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['xpad'] + + @xpad.setter + def xpad(self, val): + self['xpad'] = val + + # y + # - + @property + 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] + + Returns + ------- + int|float + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # yanchor + # ------- + @property + 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'] + + Returns + ------- + Any + """ + return self['yanchor'] + + @yanchor.setter + def yanchor(self, val): + self['yanchor'] = val + + # ypad + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['ypad'] + + @ypad.setter + def ypad(self, val): + self['ypad'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.surface.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.surfac + e.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + surface.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.surface.colorbar.Title instance or + dict with compatible properties + titlefont + Deprecated: Please use surface.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use surface.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + """ + + _mapped_properties = { + 'titlefont': ('title', 'font'), + 'titleside': ('title', 'side') + } + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + len=None, + lenmode=None, + nticks=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + titlefont=None, + titleside=None, + x=None, + xanchor=None, + xpad=None, + y=None, + yanchor=None, + ypad=None, + **kwargs + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.surface.ColorBar + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: https://github.com/d3/d3-form + at/blob/master/README.md#locale_format And for dates + see: https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We add one + item to d3's date formatter: "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + plotly.graph_objs.surface.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.surfac + e.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + surface.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for ticktext . + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.surface.colorbar.Title instance or + dict with compatible properties + titlefont + Deprecated: Please use surface.colorbar.title.font + instead. Sets this color bar's title font. Note that + the title's font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use surface.colorbar.title.side + instead. Determines the location of color bar's title + with respect to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. + + Returns + ------- + ColorBar + """ + super(ColorBar, self).__init__('colorbar') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.ColorBar +constructor must be a dict or +an instance of plotly.graph_objs.surface.ColorBar""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface import (colorbar as v_colorbar) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_colorbar.BgcolorValidator() + self._validators['bordercolor'] = v_colorbar.BordercolorValidator() + self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() + self._validators['dtick'] = v_colorbar.DtickValidator() + self._validators['exponentformat' + ] = v_colorbar.ExponentformatValidator() + self._validators['len'] = v_colorbar.LenValidator() + self._validators['lenmode'] = v_colorbar.LenmodeValidator() + self._validators['nticks'] = v_colorbar.NticksValidator() + self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() + self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() + self._validators['separatethousands' + ] = v_colorbar.SeparatethousandsValidator() + self._validators['showexponent'] = v_colorbar.ShowexponentValidator() + self._validators['showticklabels' + ] = v_colorbar.ShowticklabelsValidator() + self._validators['showtickprefix' + ] = v_colorbar.ShowtickprefixValidator() + self._validators['showticksuffix' + ] = v_colorbar.ShowticksuffixValidator() + self._validators['thickness'] = v_colorbar.ThicknessValidator() + self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() + self._validators['tick0'] = v_colorbar.Tick0Validator() + self._validators['tickangle'] = v_colorbar.TickangleValidator() + self._validators['tickcolor'] = v_colorbar.TickcolorValidator() + self._validators['tickfont'] = v_colorbar.TickfontValidator() + self._validators['tickformat'] = v_colorbar.TickformatValidator() + self._validators['tickformatstops' + ] = v_colorbar.TickformatstopsValidator() + self._validators['tickformatstopdefaults' + ] = v_colorbar.TickformatstopValidator() + self._validators['ticklen'] = v_colorbar.TicklenValidator() + self._validators['tickmode'] = v_colorbar.TickmodeValidator() + self._validators['tickprefix'] = v_colorbar.TickprefixValidator() + self._validators['ticks'] = v_colorbar.TicksValidator() + self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() + self._validators['ticktext'] = v_colorbar.TicktextValidator() + self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() + self._validators['tickvals'] = v_colorbar.TickvalsValidator() + self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() + self._validators['tickwidth'] = v_colorbar.TickwidthValidator() + self._validators['title'] = v_colorbar.TitleValidator() + self._validators['x'] = v_colorbar.XValidator() + self._validators['xanchor'] = v_colorbar.XanchorValidator() + self._validators['xpad'] = v_colorbar.XpadValidator() + self._validators['y'] = v_colorbar.YValidator() + self._validators['yanchor'] = v_colorbar.YanchorValidator() + self._validators['ypad'] = v_colorbar.YpadValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('borderwidth', None) + self['borderwidth'] = borderwidth if borderwidth is not None else _v + _v = arg.pop('dtick', None) + self['dtick'] = dtick if dtick is not None else _v + _v = arg.pop('exponentformat', None) + self['exponentformat' + ] = exponentformat if exponentformat is not None else _v + _v = arg.pop('len', None) + self['len'] = len if len is not None else _v + _v = arg.pop('lenmode', None) + self['lenmode'] = lenmode if lenmode is not None else _v + _v = arg.pop('nticks', None) + self['nticks'] = nticks if nticks is not None else _v + _v = arg.pop('outlinecolor', None) + self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v + _v = arg.pop('outlinewidth', None) + self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v + _v = arg.pop('separatethousands', None) + self['separatethousands' + ] = separatethousands if separatethousands is not None else _v + _v = arg.pop('showexponent', None) + self['showexponent'] = showexponent if showexponent is not None else _v + _v = arg.pop('showticklabels', None) + self['showticklabels' + ] = showticklabels if showticklabels is not None else _v + _v = arg.pop('showtickprefix', None) + self['showtickprefix' + ] = showtickprefix if showtickprefix is not None else _v + _v = arg.pop('showticksuffix', None) + self['showticksuffix' + ] = showticksuffix if showticksuffix is not None else _v + _v = arg.pop('thickness', None) + self['thickness'] = thickness if thickness is not None else _v + _v = arg.pop('thicknessmode', None) + self['thicknessmode' + ] = thicknessmode if thicknessmode is not None else _v + _v = arg.pop('tick0', None) + self['tick0'] = tick0 if tick0 is not None else _v + _v = arg.pop('tickangle', None) + self['tickangle'] = tickangle if tickangle is not None else _v + _v = arg.pop('tickcolor', None) + self['tickcolor'] = tickcolor if tickcolor is not None else _v + _v = arg.pop('tickfont', None) + self['tickfont'] = tickfont if tickfont is not None else _v + _v = arg.pop('tickformat', None) + self['tickformat'] = tickformat if tickformat is not None else _v + _v = arg.pop('tickformatstops', None) + self['tickformatstops' + ] = tickformatstops if tickformatstops is not None else _v + _v = arg.pop('tickformatstopdefaults', None) + self[ + 'tickformatstopdefaults' + ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v + _v = arg.pop('ticklen', None) + self['ticklen'] = ticklen if ticklen is not None else _v + _v = arg.pop('tickmode', None) + self['tickmode'] = tickmode if tickmode is not None else _v + _v = arg.pop('tickprefix', None) + self['tickprefix'] = tickprefix if tickprefix is not None else _v + _v = arg.pop('ticks', None) + self['ticks'] = ticks if ticks is not None else _v + _v = arg.pop('ticksuffix', None) + self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v + _v = arg.pop('ticktext', None) + self['ticktext'] = ticktext if ticktext is not None else _v + _v = arg.pop('ticktextsrc', None) + self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v + _v = arg.pop('tickvals', None) + self['tickvals'] = tickvals if tickvals is not None else _v + _v = arg.pop('tickvalssrc', None) + self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v + _v = arg.pop('tickwidth', None) + self['tickwidth'] = tickwidth if tickwidth is not None else _v + _v = arg.pop('title', None) + self['title'] = title if title is not None else _v + _v = arg.pop('titlefont', None) + _v = titlefont if titlefont is not None else _v + if _v is not None: + self['titlefont'] = _v + _v = arg.pop('titleside', None) + _v = titleside if titleside is not None else _v + if _v is not None: + self['titleside'] = _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('xanchor', None) + self['xanchor'] = xanchor if xanchor is not None else _v + _v = arg.pop('xpad', None) + self['xpad'] = xpad if xpad is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('yanchor', None) + self['yanchor'] = yanchor if yanchor is not None else _v + _v = arg.pop('ypad', None) + self['ypad'] = ypad if ypad is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.surface import hoverlabel -from ._contours import Contours from plotly.graph_objs.surface import contours -from ._colorbar import ColorBar from plotly.graph_objs.surface import colorbar diff --git a/plotly/graph_objs/surface/_colorbar.py b/plotly/graph_objs/surface/_colorbar.py deleted file mode 100644 index c05c84c024a..00000000000 --- a/plotly/graph_objs/surface/_colorbar.py +++ /dev/null @@ -1,1863 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class ColorBar(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # borderwidth - # ----------- - @property - 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] - - Returns - ------- - int|float - """ - return self['borderwidth'] - - @borderwidth.setter - def borderwidth(self, val): - self['borderwidth'] = val - - # dtick - # ----- - @property - def dtick(self): - """ - Sets the step in-between ticks on this axis. Use with `tick0`. - Must be a positive number, or special strings available to - "log" and "date" axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick number. For - example, to set a tick mark at 1, 10, 100, 1000, ... set dtick - to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. - To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special values; - "L", where `f` is a positive number, gives ticks linearly - spaced in value (but not position). For example `tick0` = 0.1, - `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To - show powers of 10 plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and - "D2". If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval between - ticks to one day, set `dtick` to 86400000.0. "date" also has - special values "M" gives ticks spaced by a number of months. - `n` must be a positive integer. To set ticks on the 15th of - every third month, set `tick0` to "2000-01-15" and `dtick` to - "M3". To set ticks every 4 years, set `dtick` to "M48" - - The 'dtick' property accepts values of any type - - Returns - ------- - Any - """ - return self['dtick'] - - @dtick.setter - def dtick(self, val): - self['dtick'] = val - - # exponentformat - # -------------- - @property - def exponentformat(self): - """ - Determines a formatting rule for the tick exponents. For - example, consider the number 1,000,000,000. If "none", it - appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If - "B", 1B. - - The 'exponentformat' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['none', 'e', 'E', 'power', 'SI', 'B'] - - Returns - ------- - Any - """ - return self['exponentformat'] - - @exponentformat.setter - def exponentformat(self, val): - self['exponentformat'] = val - - # len - # --- - @property - 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] - - Returns - ------- - int|float - """ - return self['len'] - - @len.setter - def len(self, val): - self['len'] = val - - # lenmode - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['lenmode'] - - @lenmode.setter - def lenmode(self, val): - self['lenmode'] = val - - # nticks - # ------ - @property - def nticks(self): - """ - Specifies the maximum number of ticks for the particular axis. - The actual number of ticks will be chosen automatically to be - less than or equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - - 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] - - Returns - ------- - int - """ - return self['nticks'] - - @nticks.setter - def nticks(self, val): - self['nticks'] = val - - # outlinecolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outlinecolor'] - - @outlinecolor.setter - def outlinecolor(self, val): - self['outlinecolor'] = val - - # outlinewidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlinewidth'] - - @outlinewidth.setter - def outlinewidth(self, val): - self['outlinewidth'] = val - - # separatethousands - # ----------------- - @property - def separatethousands(self): - """ - If "true", even 4-digit integers are separated - - The 'separatethousands' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['separatethousands'] - - @separatethousands.setter - def separatethousands(self, val): - self['separatethousands'] = val - - # showexponent - # ------------ - @property - def showexponent(self): - """ - If "all", all exponents are shown besides their significands. - If "first", only the exponent of the first tick is shown. If - "last", only the exponent of the last tick is shown. If "none", - no exponents appear. - - The 'showexponent' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showexponent'] - - @showexponent.setter - def showexponent(self, val): - self['showexponent'] = val - - # showticklabels - # -------------- - @property - 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) - - Returns - ------- - bool - """ - return self['showticklabels'] - - @showticklabels.setter - def showticklabels(self, val): - self['showticklabels'] = val - - # showtickprefix - # -------------- - @property - def showtickprefix(self): - """ - If "all", all tick labels are displayed with a prefix. If - "first", only the first tick is displayed with a prefix. If - "last", only the last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - - The 'showtickprefix' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['all', 'first', 'last', 'none'] - - Returns - ------- - Any - """ - return self['showtickprefix'] - - @showtickprefix.setter - def showtickprefix(self, val): - self['showtickprefix'] = val - - # showticksuffix - # -------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['showticksuffix'] - - @showticksuffix.setter - def showticksuffix(self, val): - self['showticksuffix'] = val - - # thickness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['thickness'] - - @thickness.setter - def thickness(self, val): - self['thickness'] = val - - # thicknessmode - # ------------- - @property - 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'] - - Returns - ------- - Any - """ - return self['thicknessmode'] - - @thicknessmode.setter - def thicknessmode(self, val): - self['thicknessmode'] = val - - # tick0 - # ----- - @property - def tick0(self): - """ - Sets the placement of the first tick on this axis. Use with - `dtick`. If the axis `type` is "log", then you must take the - log of your starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when `dtick`=*L* (see - `dtick` for more info). If the axis `type` is "date", it should - be a date string, like date data. If the axis `type` is - "category", it should be a number, using the scale where each - category is assigned a serial number from zero in the order it - appears. - - The 'tick0' property accepts values of any type - - Returns - ------- - Any - """ - return self['tick0'] - - @tick0.setter - def tick0(self, val): - self['tick0'] = val - - # tickangle - # --------- - @property - 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 - (e.g. 270 is converted to -90). - - Returns - ------- - int|float - """ - return self['tickangle'] - - @tickangle.setter - def tickangle(self, val): - self['tickangle'] = val - - # tickcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['tickcolor'] - - @tickcolor.setter - def tickcolor(self, val): - self['tickcolor'] = val - - # tickfont - # -------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.surface.colorbar.Tickfont - """ - return self['tickfont'] - - @tickfont.setter - def tickfont(self, val): - self['tickfont'] = val - - # tickformat - # ---------- - @property - def tickformat(self): - """ - Sets the tick label formatting rule using d3 formatting mini- - languages which are very similar to those in Python. For - numbers, see: https://github.com/d3/d3-format/blob/master/READM - E.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one item to - d3's date formatter: "%{n}f" for fractional seconds with n - digits. For example, *2016-10-13 09:15:23.456* with tickformat - "%H~%M~%S.%2f" would display "09~15~23.46" - - The 'tickformat' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['tickformat'] - - @tickformat.setter - def tickformat(self, val): - self['tickformat'] = val - - # tickformatstops - # --------------- - @property - def tickformatstops(self): - """ - The 'tickformatstops' property is a tuple of instances of - Tickformatstop that may be specified as: - - 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 - is possible to omit "min" or "max" value by - passing "null" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" - - Returns - ------- - tuple[plotly.graph_objs.surface.colorbar.Tickformatstop] - """ - return self['tickformatstops'] - - @tickformatstops.setter - def tickformatstops(self, val): - self['tickformatstops'] = val - - # tickformatstopdefaults - # ---------------------- - @property - def tickformatstopdefaults(self): - """ - When used in a template (as - 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 plotly.graph_objs.surface.colorbar.Tickformatstop - - A dict of string/value properties that will be passed - to the Tickformatstop constructor - - Supported dict properties: - - Returns - ------- - plotly.graph_objs.surface.colorbar.Tickformatstop - """ - return self['tickformatstopdefaults'] - - @tickformatstopdefaults.setter - def tickformatstopdefaults(self, val): - self['tickformatstopdefaults'] = val - - # ticklen - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ticklen'] - - @ticklen.setter - def ticklen(self, val): - self['ticklen'] = val - - # tickmode - # -------- - @property - def tickmode(self): - """ - Sets the tick mode for this axis. If "auto", the number of - ticks is set via `nticks`. If "linear", the placement of the - ticks is determined by a starting position `tick0` and a tick - step `dtick` ("linear" is the default value if `tick0` and - `dtick` are provided). If "array", the placement of the ticks - is set via `tickvals` and the tick text is `ticktext`. ("array" - is the default value if `tickvals` is provided). - - The 'tickmode' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['auto', 'linear', 'array'] - - Returns - ------- - Any - """ - return self['tickmode'] - - @tickmode.setter - def tickmode(self, val): - self['tickmode'] = val - - # tickprefix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['tickprefix'] - - @tickprefix.setter - def tickprefix(self, val): - self['tickprefix'] = val - - # ticks - # ----- - @property - 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', ''] - - Returns - ------- - Any - """ - return self['ticks'] - - @ticks.setter - def ticks(self, val): - self['ticks'] = val - - # ticksuffix - # ---------- - @property - 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 - - Returns - ------- - str - """ - return self['ticksuffix'] - - @ticksuffix.setter - def ticksuffix(self, val): - self['ticksuffix'] = val - - # ticktext - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['ticktext'] - - @ticktext.setter - def ticktext(self, val): - self['ticktext'] = val - - # ticktextsrc - # ----------- - @property - def ticktextsrc(self): - """ - Sets the source reference on plot.ly for ticktext . - - The 'ticktextsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['ticktextsrc'] - - @ticktextsrc.setter - def ticktextsrc(self, val): - self['ticktextsrc'] = val - - # tickvals - # -------- - @property - 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 - - Returns - ------- - numpy.ndarray - """ - return self['tickvals'] - - @tickvals.setter - def tickvals(self, val): - self['tickvals'] = val - - # tickvalssrc - # ----------- - @property - def tickvalssrc(self): - """ - Sets the source reference on plot.ly for tickvals . - - The 'tickvalssrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['tickvalssrc'] - - @tickvalssrc.setter - def tickvalssrc(self, val): - self['tickvalssrc'] = val - - # tickwidth - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['tickwidth'] - - @tickwidth.setter - def tickwidth(self, val): - self['tickwidth'] = val - - # title - # ----- - @property - def title(self): - """ - The 'title' property is an instance of Title - that may be specified as: - - An instance of 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 - deprecated `titlefont` attribute. - side - 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. - text - 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. - - Returns - ------- - plotly.graph_objs.surface.colorbar.Title - """ - return self['title'] - - @title.setter - def title(self, val): - self['title'] = val - - # titlefont - # --------- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - - """ - return self['titlefont'] - - @titlefont.setter - def titlefont(self, val): - self['titlefont'] = val - - # titleside - # --------- - @property - def titleside(self): - """ - Deprecated: Please use surface.colorbar.title.side instead. - Determines the location of color bar's title with respect to - the color bar. Note that the title's location used to be set by - the now deprecated `titleside` attribute. - - The 'side' property is an enumeration that may be specified as: - - One of the following enumeration values: - ['right', 'top', 'bottom'] - - Returns - ------- - - """ - return self['titleside'] - - @titleside.setter - def titleside(self, val): - self['titleside'] = val - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # xanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['xanchor'] - - @xanchor.setter - def xanchor(self, val): - self['xanchor'] = val - - # xpad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['xpad'] - - @xpad.setter - def xpad(self, val): - self['xpad'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # yanchor - # ------- - @property - 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'] - - Returns - ------- - Any - """ - return self['yanchor'] - - @yanchor.setter - def yanchor(self, val): - self['yanchor'] = val - - # ypad - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['ypad'] - - @ypad.setter - def ypad(self, val): - self['ypad'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.surface.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.surfac - e.colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - surface.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.surface.colorbar.Title instance or - dict with compatible properties - titlefont - Deprecated: Please use surface.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use surface.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - """ - - _mapped_properties = { - 'titlefont': ('title', 'font'), - 'titleside': ('title', 'side') - } - - def __init__( - self, - arg=None, - bgcolor=None, - bordercolor=None, - borderwidth=None, - dtick=None, - exponentformat=None, - len=None, - lenmode=None, - nticks=None, - outlinecolor=None, - outlinewidth=None, - separatethousands=None, - showexponent=None, - showticklabels=None, - showtickprefix=None, - showticksuffix=None, - thickness=None, - thicknessmode=None, - tick0=None, - tickangle=None, - tickcolor=None, - tickfont=None, - tickformat=None, - tickformatstops=None, - tickformatstopdefaults=None, - ticklen=None, - tickmode=None, - tickprefix=None, - ticks=None, - ticksuffix=None, - ticktext=None, - ticktextsrc=None, - tickvals=None, - tickvalssrc=None, - tickwidth=None, - title=None, - titlefont=None, - titleside=None, - x=None, - xanchor=None, - xpad=None, - y=None, - yanchor=None, - ypad=None, - **kwargs - ): - """ - Construct a new ColorBar object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.ColorBar - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing this - color bar. - dtick - Sets the step in-between ticks on this axis. Use with - `tick0`. Must be a positive number, or special strings - available to "log" and "date" axes. If the axis `type` - is "log", then ticks are set every 10^(n*dtick) where n - is the tick number. For example, to set a tick mark at - 1, 10, 100, 1000, ... set dtick to 1. To set tick marks - at 1, 100, 10000, ... set dtick to 2. To set tick marks - at 1, 5, 25, 125, 625, 3125, ... set dtick to - log_10(5), or 0.69897000433. "log" has several special - values; "L", where `f` is a positive number, gives - ticks linearly spaced in value (but not position). For - example `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus - small digits between, use "D1" (all digits) or "D2" - (only 2 and 5). `tick0` is ignored for "D1" and "D2". - If the axis `type` is "date", then you must convert the - time to milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to 86400000.0. - "date" also has special values "M" gives ticks - spaced by a number of months. `n` must be a positive - integer. To set ticks on the 15th of every third month, - set `tick0` to "2000-01-15" and `dtick` to "M3". To set - ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick exponents. - For example, consider the number 1,000,000,000. If - "none", it appears as 1,000,000,000. If "e", 1e+9. If - "E", 1E+9. If "power", 1x10^9 (with 9 in a super - script). If "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure excludes - the padding of both ends. That is, the color bar length - is this length minus the padding on both ends. - lenmode - Determines whether this color bar's length (i.e. the - measure in the color variation direction) is set in - units of plot "fraction" or in *pixels. Use `len` to - set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks will be - chosen automatically to be less than or equal to - `nticks`. Has an effect only if `tickmode` is set to - "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of the - first tick is shown. If "last", only the exponent of - the last tick is shown. If "none", no exponents appear. - showticklabels - Determines whether or not the tick labels are drawn. - showtickprefix - If "all", all tick labels are displayed with a prefix. - If "first", only the first tick is displayed with a - prefix. If "last", only the last tick is displayed with - a suffix. If "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This measure - excludes the size of the padding, ticks and labels. - thicknessmode - Determines whether this color bar's thickness (i.e. the - measure in the constant color direction) is set in - units of plot "fraction" or in "pixels". Use - `thickness` to set the value. - tick0 - Sets the placement of the first tick on this axis. Use - with `dtick`. If the axis `type` is "log", then you - must take the log of your starting tick (e.g. to set - the starting tick to 100, set the `tick0` to 2) except - when `dtick`=*L* (see `dtick` for more info). If the - axis `type` is "date", it should be a date string, like - date data. If the axis `type` is "category", it should - be a number, using the scale where each category is - assigned a serial number from zero in the order it - appears. - tickangle - Sets the angle of the tick labels with respect to the - horizontal. For example, a `tickangle` of -90 draws the - tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 formatting - mini-languages which are very similar to those in - Python. For numbers, see: https://github.com/d3/d3-form - at/blob/master/README.md#locale_format And for dates - see: https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We add one - item to d3's date formatter: "%{n}f" for fractional - seconds with n digits. For example, *2016-10-13 - 09:15:23.456* with tickformat "%H~%M~%S.%2f" would - display "09~15~23.46" - tickformatstops - plotly.graph_objs.surface.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.data.surfac - e.colorbar.tickformatstopdefaults), sets the default - property values to use for elements of - surface.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", the number - of ticks is set via `nticks`. If "linear", the - placement of the ticks is determined by a starting - position `tick0` and a tick step `dtick` ("linear" is - the default value if `tick0` and `dtick` are provided). - If "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. ("array" is - the default value if `tickvals` is provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If "", this - axis' ticks are not drawn. If "outside" ("inside"), - this axis' are drawn outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position via - `tickvals`. Only has an effect if `tickmode` is set to - "array". Used with `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for ticktext . - tickvals - Sets the values at which ticks on this axis appear. - Only has an effect if `tickmode` is set to "array". - Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.surface.colorbar.Title instance or - dict with compatible properties - titlefont - Deprecated: Please use surface.colorbar.title.font - instead. Sets this color bar's title font. Note that - the title's font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use surface.colorbar.title.side - instead. Determines the location of color bar's title - with respect to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position anchor. This - anchor binds the `x` position to the "left", "center" - or "right" of the color bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor This - anchor binds the `y` position to the "top", "middle" or - "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. - - Returns - ------- - ColorBar - """ - super(ColorBar, self).__init__('colorbar') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.ColorBar -constructor must be a dict or -an instance of plotly.graph_objs.surface.ColorBar""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface import (colorbar as v_colorbar) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_colorbar.BgcolorValidator() - self._validators['bordercolor'] = v_colorbar.BordercolorValidator() - self._validators['borderwidth'] = v_colorbar.BorderwidthValidator() - self._validators['dtick'] = v_colorbar.DtickValidator() - self._validators['exponentformat' - ] = v_colorbar.ExponentformatValidator() - self._validators['len'] = v_colorbar.LenValidator() - self._validators['lenmode'] = v_colorbar.LenmodeValidator() - self._validators['nticks'] = v_colorbar.NticksValidator() - self._validators['outlinecolor'] = v_colorbar.OutlinecolorValidator() - self._validators['outlinewidth'] = v_colorbar.OutlinewidthValidator() - self._validators['separatethousands' - ] = v_colorbar.SeparatethousandsValidator() - self._validators['showexponent'] = v_colorbar.ShowexponentValidator() - self._validators['showticklabels' - ] = v_colorbar.ShowticklabelsValidator() - self._validators['showtickprefix' - ] = v_colorbar.ShowtickprefixValidator() - self._validators['showticksuffix' - ] = v_colorbar.ShowticksuffixValidator() - self._validators['thickness'] = v_colorbar.ThicknessValidator() - self._validators['thicknessmode'] = v_colorbar.ThicknessmodeValidator() - self._validators['tick0'] = v_colorbar.Tick0Validator() - self._validators['tickangle'] = v_colorbar.TickangleValidator() - self._validators['tickcolor'] = v_colorbar.TickcolorValidator() - self._validators['tickfont'] = v_colorbar.TickfontValidator() - self._validators['tickformat'] = v_colorbar.TickformatValidator() - self._validators['tickformatstops' - ] = v_colorbar.TickformatstopsValidator() - self._validators['tickformatstopdefaults' - ] = v_colorbar.TickformatstopValidator() - self._validators['ticklen'] = v_colorbar.TicklenValidator() - self._validators['tickmode'] = v_colorbar.TickmodeValidator() - self._validators['tickprefix'] = v_colorbar.TickprefixValidator() - self._validators['ticks'] = v_colorbar.TicksValidator() - self._validators['ticksuffix'] = v_colorbar.TicksuffixValidator() - self._validators['ticktext'] = v_colorbar.TicktextValidator() - self._validators['ticktextsrc'] = v_colorbar.TicktextsrcValidator() - self._validators['tickvals'] = v_colorbar.TickvalsValidator() - self._validators['tickvalssrc'] = v_colorbar.TickvalssrcValidator() - self._validators['tickwidth'] = v_colorbar.TickwidthValidator() - self._validators['title'] = v_colorbar.TitleValidator() - self._validators['x'] = v_colorbar.XValidator() - self._validators['xanchor'] = v_colorbar.XanchorValidator() - self._validators['xpad'] = v_colorbar.XpadValidator() - self._validators['y'] = v_colorbar.YValidator() - self._validators['yanchor'] = v_colorbar.YanchorValidator() - self._validators['ypad'] = v_colorbar.YpadValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('borderwidth', None) - self['borderwidth'] = borderwidth if borderwidth is not None else _v - _v = arg.pop('dtick', None) - self['dtick'] = dtick if dtick is not None else _v - _v = arg.pop('exponentformat', None) - self['exponentformat' - ] = exponentformat if exponentformat is not None else _v - _v = arg.pop('len', None) - self['len'] = len if len is not None else _v - _v = arg.pop('lenmode', None) - self['lenmode'] = lenmode if lenmode is not None else _v - _v = arg.pop('nticks', None) - self['nticks'] = nticks if nticks is not None else _v - _v = arg.pop('outlinecolor', None) - self['outlinecolor'] = outlinecolor if outlinecolor is not None else _v - _v = arg.pop('outlinewidth', None) - self['outlinewidth'] = outlinewidth if outlinewidth is not None else _v - _v = arg.pop('separatethousands', None) - self['separatethousands' - ] = separatethousands if separatethousands is not None else _v - _v = arg.pop('showexponent', None) - self['showexponent'] = showexponent if showexponent is not None else _v - _v = arg.pop('showticklabels', None) - self['showticklabels' - ] = showticklabels if showticklabels is not None else _v - _v = arg.pop('showtickprefix', None) - self['showtickprefix' - ] = showtickprefix if showtickprefix is not None else _v - _v = arg.pop('showticksuffix', None) - self['showticksuffix' - ] = showticksuffix if showticksuffix is not None else _v - _v = arg.pop('thickness', None) - self['thickness'] = thickness if thickness is not None else _v - _v = arg.pop('thicknessmode', None) - self['thicknessmode' - ] = thicknessmode if thicknessmode is not None else _v - _v = arg.pop('tick0', None) - self['tick0'] = tick0 if tick0 is not None else _v - _v = arg.pop('tickangle', None) - self['tickangle'] = tickangle if tickangle is not None else _v - _v = arg.pop('tickcolor', None) - self['tickcolor'] = tickcolor if tickcolor is not None else _v - _v = arg.pop('tickfont', None) - self['tickfont'] = tickfont if tickfont is not None else _v - _v = arg.pop('tickformat', None) - self['tickformat'] = tickformat if tickformat is not None else _v - _v = arg.pop('tickformatstops', None) - self['tickformatstops' - ] = tickformatstops if tickformatstops is not None else _v - _v = arg.pop('tickformatstopdefaults', None) - self[ - 'tickformatstopdefaults' - ] = tickformatstopdefaults if tickformatstopdefaults is not None else _v - _v = arg.pop('ticklen', None) - self['ticklen'] = ticklen if ticklen is not None else _v - _v = arg.pop('tickmode', None) - self['tickmode'] = tickmode if tickmode is not None else _v - _v = arg.pop('tickprefix', None) - self['tickprefix'] = tickprefix if tickprefix is not None else _v - _v = arg.pop('ticks', None) - self['ticks'] = ticks if ticks is not None else _v - _v = arg.pop('ticksuffix', None) - self['ticksuffix'] = ticksuffix if ticksuffix is not None else _v - _v = arg.pop('ticktext', None) - self['ticktext'] = ticktext if ticktext is not None else _v - _v = arg.pop('ticktextsrc', None) - self['ticktextsrc'] = ticktextsrc if ticktextsrc is not None else _v - _v = arg.pop('tickvals', None) - self['tickvals'] = tickvals if tickvals is not None else _v - _v = arg.pop('tickvalssrc', None) - self['tickvalssrc'] = tickvalssrc if tickvalssrc is not None else _v - _v = arg.pop('tickwidth', None) - self['tickwidth'] = tickwidth if tickwidth is not None else _v - _v = arg.pop('title', None) - self['title'] = title if title is not None else _v - _v = arg.pop('titlefont', None) - _v = titlefont if titlefont is not None else _v - if _v is not None: - self['titlefont'] = _v - _v = arg.pop('titleside', None) - _v = titleside if titleside is not None else _v - if _v is not None: - self['titleside'] = _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('xanchor', None) - self['xanchor'] = xanchor if xanchor is not None else _v - _v = arg.pop('xpad', None) - self['xpad'] = xpad if xpad is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('yanchor', None) - self['yanchor'] = yanchor if yanchor is not None else _v - _v = arg.pop('ypad', None) - self['ypad'] = ypad if ypad is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/_contours.py b/plotly/graph_objs/surface/_contours.py deleted file mode 100644 index a5e3bd04d62..00000000000 --- a/plotly/graph_objs/surface/_contours.py +++ /dev/null @@ -1,240 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Contours(BaseTraceHierarchyType): - - # x - # - - @property - def x(self): - """ - The 'x' property is an instance of X - that may be specified as: - - An instance of 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. - highlight - Determines whether or not contour lines about - the x dimension are highlighted on hover. - highlightcolor - Sets the color of the highlighted contour - lines. - highlightwidth - Sets the width of the highlighted contour - lines. - project - plotly.graph_objs.surface.contours.x.Project - instance or dict with compatible properties - show - Determines whether or not contour lines about - the x dimension are drawn. - usecolormap - An alternate to "color". Determines whether or - not the contour lines are colored using the - trace "colorscale". - width - Sets the width of the contour lines. - - Returns - ------- - plotly.graph_objs.surface.contours.X - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @property - def y(self): - """ - The 'y' property is an instance of Y - that may be specified as: - - An instance of 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. - highlight - Determines whether or not contour lines about - the y dimension are highlighted on hover. - highlightcolor - Sets the color of the highlighted contour - lines. - highlightwidth - Sets the width of the highlighted contour - lines. - project - plotly.graph_objs.surface.contours.y.Project - instance or dict with compatible properties - show - Determines whether or not contour lines about - the y dimension are drawn. - usecolormap - An alternate to "color". Determines whether or - not the contour lines are colored using the - trace "colorscale". - width - Sets the width of the contour lines. - - Returns - ------- - plotly.graph_objs.surface.contours.Y - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # z - # - - @property - def z(self): - """ - The 'z' property is an instance of Z - that may be specified as: - - An instance of 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. - highlight - Determines whether or not contour lines about - the z dimension are highlighted on hover. - highlightcolor - Sets the color of the highlighted contour - lines. - highlightwidth - Sets the width of the highlighted contour - lines. - project - plotly.graph_objs.surface.contours.z.Project - instance or dict with compatible properties - show - Determines whether or not contour lines about - the z dimension are drawn. - usecolormap - An alternate to "color". Determines whether or - not the contour lines are colored using the - trace "colorscale". - width - Sets the width of the contour lines. - - Returns - ------- - plotly.graph_objs.surface.contours.Z - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - plotly.graph_objs.surface.contours.X instance or dict - with compatible properties - y - plotly.graph_objs.surface.contours.Y instance or dict - with compatible properties - z - plotly.graph_objs.surface.contours.Z instance or dict - with compatible properties - """ - - def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): - """ - Construct a new Contours object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.Contours - x - plotly.graph_objs.surface.contours.X instance or dict - with compatible properties - y - plotly.graph_objs.surface.contours.Y instance or dict - with compatible properties - z - plotly.graph_objs.surface.contours.Z instance or dict - with compatible properties - - Returns - ------- - Contours - """ - super(Contours, self).__init__('contours') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.Contours -constructor must be a dict or -an instance of plotly.graph_objs.surface.Contours""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface import (contours as v_contours) - - # Initialize validators - # --------------------- - self._validators['x'] = v_contours.XValidator() - self._validators['y'] = v_contours.YValidator() - self._validators['z'] = v_contours.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/_hoverlabel.py b/plotly/graph_objs/surface/_hoverlabel.py deleted file mode 100644 index 6c6a791d79b..00000000000 --- a/plotly/graph_objs/surface/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.surface.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.surface.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/_lighting.py b/plotly/graph_objs/surface/_lighting.py deleted file mode 100644 index 71f5209de42..00000000000 --- a/plotly/graph_objs/surface/_lighting.py +++ /dev/null @@ -1,236 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Lighting(BaseTraceHierarchyType): - - # ambient - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['ambient'] - - @ambient.setter - def ambient(self, val): - self['ambient'] = val - - # diffuse - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['diffuse'] - - @diffuse.setter - def diffuse(self, val): - self['diffuse'] = val - - # fresnel - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['fresnel'] - - @fresnel.setter - def fresnel(self, val): - self['fresnel'] = val - - # roughness - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['roughness'] - - @roughness.setter - def roughness(self, val): - self['roughness'] = val - - # specular - # -------- - @property - 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] - - Returns - ------- - int|float - """ - return self['specular'] - - @specular.setter - def specular(self, val): - self['specular'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - ambient - Ambient light increases overall color visibility but - can wash out the image. - diffuse - Represents the extent that incident rays are reflected - in a range of angles. - fresnel - Represents the reflectance as a dependency of the - viewing angle; e.g. paper is reflective when viewing it - from the edge of the paper (almost 90 degrees), causing - shine. - roughness - Alters specular reflection; the rougher the surface, - the wider and less contrasty the shine. - specular - Represents the level that incident rays are reflected - in a single direction, causing shine. - """ - - def __init__( - self, - arg=None, - ambient=None, - diffuse=None, - fresnel=None, - roughness=None, - specular=None, - **kwargs - ): - """ - Construct a new Lighting object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.Lighting - ambient - Ambient light increases overall color visibility but - can wash out the image. - diffuse - Represents the extent that incident rays are reflected - in a range of angles. - fresnel - Represents the reflectance as a dependency of the - viewing angle; e.g. paper is reflective when viewing it - from the edge of the paper (almost 90 degrees), causing - shine. - roughness - Alters specular reflection; the rougher the surface, - the wider and less contrasty the shine. - specular - Represents the level that incident rays are reflected - in a single direction, causing shine. - - Returns - ------- - Lighting - """ - super(Lighting, self).__init__('lighting') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.Lighting -constructor must be a dict or -an instance of plotly.graph_objs.surface.Lighting""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface import (lighting as v_lighting) - - # Initialize validators - # --------------------- - self._validators['ambient'] = v_lighting.AmbientValidator() - self._validators['diffuse'] = v_lighting.DiffuseValidator() - self._validators['fresnel'] = v_lighting.FresnelValidator() - self._validators['roughness'] = v_lighting.RoughnessValidator() - self._validators['specular'] = v_lighting.SpecularValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('ambient', None) - self['ambient'] = ambient if ambient is not None else _v - _v = arg.pop('diffuse', None) - self['diffuse'] = diffuse if diffuse is not None else _v - _v = arg.pop('fresnel', None) - self['fresnel'] = fresnel if fresnel is not None else _v - _v = arg.pop('roughness', None) - self['roughness'] = roughness if roughness is not None else _v - _v = arg.pop('specular', None) - self['specular'] = specular if specular is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/_lightposition.py b/plotly/graph_objs/surface/_lightposition.py deleted file mode 100644 index c97ca2ce05f..00000000000 --- a/plotly/graph_objs/surface/_lightposition.py +++ /dev/null @@ -1,161 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Lightposition(BaseTraceHierarchyType): - - # x - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # z - # - - @property - 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] - - Returns - ------- - int|float - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - Numeric vector, representing the X coordinate for each - vertex. - y - Numeric vector, representing the Y coordinate for each - vertex. - z - Numeric vector, representing the Z coordinate for each - vertex. - """ - - def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): - """ - Construct a new Lightposition object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.Lightposition - x - Numeric vector, representing the X coordinate for each - vertex. - y - Numeric vector, representing the Y coordinate for each - vertex. - z - Numeric vector, representing the Z coordinate for each - vertex. - - Returns - ------- - Lightposition - """ - super(Lightposition, self).__init__('lightposition') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.Lightposition -constructor must be a dict or -an instance of plotly.graph_objs.surface.Lightposition""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface import ( - lightposition as v_lightposition - ) - - # Initialize validators - # --------------------- - self._validators['x'] = v_lightposition.XValidator() - self._validators['y'] = v_lightposition.YValidator() - self._validators['z'] = v_lightposition.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/_stream.py b/plotly/graph_objs/surface/_stream.py deleted file mode 100644 index 89795d346e8..00000000000 --- a/plotly/graph_objs/surface/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.Stream -constructor must be a dict or -an instance of plotly.graph_objs.surface.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/colorbar/__init__.py b/plotly/graph_objs/surface/colorbar/__init__.py index c0cbcef4de4..760daf516f8 100644 --- a/plotly/graph_objs/surface/colorbar/__init__.py +++ b/plotly/graph_objs/surface/colorbar/__init__.py @@ -1,4 +1,720 @@ -from ._title import Title + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + + # font + # ---- + @property + 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 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 + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + Returns + ------- + plotly.graph_objs.surface.colorbar.title.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # side + # ---- + @property + 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'] + + Returns + ------- + Any + """ + return self['side'] + + @side.setter + def side(self, val): + self['side'] = val + + # text + # ---- + @property + 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 + + Returns + ------- + str + """ + return self['text'] + + @text.setter + def text(self, val): + self['text'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.surface.colorbar.Title + font + Sets this color bar's title font. Note that the title's + font used to be set by the now deprecated `titlefont` + attribute. + side + 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. + text + 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. + + Returns + ------- + Title + """ + super(Title, self).__init__('title') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.colorbar.Title +constructor must be a dict or +an instance of plotly.graph_objs.surface.colorbar.Title""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface.colorbar import (title as v_title) + + # Initialize validators + # --------------------- + self._validators['font'] = v_title.FontValidator() + self._validators['side'] = v_title.SideValidator() + self._validators['text'] = v_title.TextValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('side', None) + self['side'] = side if side is not None else _v + _v = arg.pop('text', None) + self['text'] = text if text is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + + # dtickrange + # ---------- + @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 + + Returns + ------- + list + """ + return self['dtickrange'] + + @dtickrange.setter + def dtickrange(self, val): + self['dtickrange'] = val + + # enabled + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['enabled'] + + @enabled.setter + def enabled(self, val): + self['enabled'] = val + + # name + # ---- + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['name'] + + @name.setter + def name(self, val): + self['name'] = val + + # templateitemname + # ---------------- + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self['templateitemname'] + + @templateitemname.setter + def templateitemname(self, val): + self['templateitemname'] = val + + # value + # ----- + @property + 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 + + Returns + ------- + str + """ + return self['value'] + + @value.setter + def value(self, val): + self['value'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.surface.colorbar.Tickformatstop + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super(Tickformatstop, self).__init__('tickformatstops') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.colorbar.Tickformatstop +constructor must be a dict or +an instance of plotly.graph_objs.surface.colorbar.Tickformatstop""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface.colorbar import ( + tickformatstop as v_tickformatstop + ) + + # Initialize validators + # --------------------- + self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() + self._validators['enabled'] = v_tickformatstop.EnabledValidator() + self._validators['name'] = v_tickformatstop.NameValidator() + self._validators['templateitemname' + ] = v_tickformatstop.TemplateitemnameValidator() + self._validators['value'] = v_tickformatstop.ValueValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('dtickrange', None) + self['dtickrange'] = dtickrange if dtickrange is not None else _v + _v = arg.pop('enabled', None) + self['enabled'] = enabled if enabled is not None else _v + _v = arg.pop('name', None) + self['name'] = name if name is not None else _v + _v = arg.pop('templateitemname', None) + self['templateitemname' + ] = templateitemname if templateitemname is not None else _v + _v = arg.pop('value', None) + self['value'] = value if value is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface.colorbar' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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 + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.surface.colorbar.Tickfont + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Tickfont + """ + super(Tickfont, self).__init__('tickfont') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.colorbar.Tickfont +constructor must be a dict or +an instance of plotly.graph_objs.surface.colorbar.Tickfont""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface.colorbar import (tickfont as v_tickfont) + + # Initialize validators + # --------------------- + self._validators['color'] = v_tickfont.ColorValidator() + self._validators['family'] = v_tickfont.FamilyValidator() + self._validators['size'] = v_tickfont.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.surface.colorbar import title -from ._tickformatstop import Tickformatstop -from ._tickfont import Tickfont diff --git a/plotly/graph_objs/surface/colorbar/_tickfont.py b/plotly/graph_objs/surface/colorbar/_tickfont.py deleted file mode 100644 index 3ed3c5d4a5d..00000000000 --- a/plotly/graph_objs/surface/colorbar/_tickfont.py +++ /dev/null @@ -1,226 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickfont(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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 - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.surface.colorbar.Tickfont - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Tickfont - """ - super(Tickfont, self).__init__('tickfont') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.colorbar.Tickfont -constructor must be a dict or -an instance of plotly.graph_objs.surface.colorbar.Tickfont""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface.colorbar import (tickfont as v_tickfont) - - # Initialize validators - # --------------------- - self._validators['color'] = v_tickfont.ColorValidator() - self._validators['family'] = v_tickfont.FamilyValidator() - self._validators['size'] = v_tickfont.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/colorbar/_tickformatstop.py b/plotly/graph_objs/surface/colorbar/_tickformatstop.py deleted file mode 100644 index 6814e1577fc..00000000000 --- a/plotly/graph_objs/surface/colorbar/_tickformatstop.py +++ /dev/null @@ -1,284 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Tickformatstop(BaseTraceHierarchyType): - - # dtickrange - # ---------- - @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 - - Returns - ------- - list - """ - return self['dtickrange'] - - @dtickrange.setter - def dtickrange(self, val): - self['dtickrange'] = val - - # enabled - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['enabled'] - - @enabled.setter - def enabled(self, val): - self['enabled'] = val - - # name - # ---- - @property - def name(self): - """ - When used in a template, named items are created in the output - figure in addition to any items the figure already has in this - array. You can modify these items in the output figure by - making your own item with `templateitemname` matching this - `name` alongside your modifications (including `visible: false` - or `enabled: false` to hide it). Has no effect outside of a - template. - - The 'name' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['name'] - - @name.setter - def name(self, val): - self['name'] = val - - # templateitemname - # ---------------- - @property - def templateitemname(self): - """ - Used to refer to a named item in this array in the template. - Named items from the template will be created even without a - matching item in the input figure, but you can modify one by - making an item with `templateitemname` matching its `name`, - alongside your modifications (including `visible: false` or - `enabled: false` to hide it). If there is no template or no - matching item, this item will be hidden unless you explicitly - show it with `visible: true`. - - The 'templateitemname' property is a string and must be specified as: - - A string - - A number that will be converted to a string - - Returns - ------- - str - """ - return self['templateitemname'] - - @templateitemname.setter - def templateitemname(self, val): - self['templateitemname'] = val - - # value - # ----- - @property - 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 - - Returns - ------- - str - """ - return self['value'] - - @value.setter - def value(self, val): - self['value'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - """ - - def __init__( - self, - arg=None, - dtickrange=None, - enabled=None, - name=None, - templateitemname=None, - value=None, - **kwargs - ): - """ - Construct a new Tickformatstop object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.surface.colorbar.Tickformatstop - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are created in the - output figure in addition to any items the figure - already has in this array. You can modify these items - in the output figure by making your own item with - `templateitemname` matching this `name` alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). Has no effect outside of a - template. - templateitemname - Used to refer to a named item in this array in the - template. Named items from the template will be created - even without a matching item in the input figure, but - you can modify one by making an item with - `templateitemname` matching its `name`, alongside your - modifications (including `visible: false` or `enabled: - false` to hide it). If there is no template or no - matching item, this item will be hidden unless you - explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, the same - as "tickformat" - - Returns - ------- - Tickformatstop - """ - super(Tickformatstop, self).__init__('tickformatstops') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.colorbar.Tickformatstop -constructor must be a dict or -an instance of plotly.graph_objs.surface.colorbar.Tickformatstop""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface.colorbar import ( - tickformatstop as v_tickformatstop - ) - - # Initialize validators - # --------------------- - self._validators['dtickrange'] = v_tickformatstop.DtickrangeValidator() - self._validators['enabled'] = v_tickformatstop.EnabledValidator() - self._validators['name'] = v_tickformatstop.NameValidator() - self._validators['templateitemname' - ] = v_tickformatstop.TemplateitemnameValidator() - self._validators['value'] = v_tickformatstop.ValueValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('dtickrange', None) - self['dtickrange'] = dtickrange if dtickrange is not None else _v - _v = arg.pop('enabled', None) - self['enabled'] = enabled if enabled is not None else _v - _v = arg.pop('name', None) - self['name'] = name if name is not None else _v - _v = arg.pop('templateitemname', None) - self['templateitemname' - ] = templateitemname if templateitemname is not None else _v - _v = arg.pop('value', None) - self['value'] = value if value is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/colorbar/_title.py b/plotly/graph_objs/surface/colorbar/_title.py deleted file mode 100644 index cbb608ee382..00000000000 --- a/plotly/graph_objs/surface/colorbar/_title.py +++ /dev/null @@ -1,201 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Title(BaseTraceHierarchyType): - - # font - # ---- - @property - 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 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 - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - Returns - ------- - plotly.graph_objs.surface.colorbar.title.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # side - # ---- - @property - 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'] - - Returns - ------- - Any - """ - return self['side'] - - @side.setter - def side(self, val): - self['side'] = val - - # text - # ---- - @property - 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 - - Returns - ------- - str - """ - return self['text'] - - @text.setter - def text(self, val): - self['text'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface.colorbar' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - """ - - def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): - """ - Construct a new Title object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.colorbar.Title - font - Sets this color bar's title font. Note that the title's - font used to be set by the now deprecated `titlefont` - attribute. - side - 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. - text - 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. - - Returns - ------- - Title - """ - super(Title, self).__init__('title') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.colorbar.Title -constructor must be a dict or -an instance of plotly.graph_objs.surface.colorbar.Title""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface.colorbar import (title as v_title) - - # Initialize validators - # --------------------- - self._validators['font'] = v_title.FontValidator() - self._validators['side'] = v_title.SideValidator() - self._validators['text'] = v_title.TextValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('side', None) - self['side'] = side if side is not None else _v - _v = arg.pop('text', None) - self['text'] = text if text is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/colorbar/title/__init__.py b/plotly/graph_objs/surface/colorbar/title/__init__.py index c37b8b5cd28..114dfbfedb5 100644 --- a/plotly/graph_objs/surface/colorbar/title/__init__.py +++ b/plotly/graph_objs/surface/colorbar/title/__init__.py @@ -1 +1,229 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface.colorbar.title' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + """ + + 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. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.surface.colorbar.title.Font + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.colorbar.title.Font +constructor must be a dict or +an instance of plotly.graph_objs.surface.colorbar.title.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface.colorbar.title import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['size'] = v_font.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/surface/colorbar/title/_font.py b/plotly/graph_objs/surface/colorbar/title/_font.py deleted file mode 100644 index 42d0b15dbf1..00000000000 --- a/plotly/graph_objs/surface/colorbar/title/_font.py +++ /dev/null @@ -1,227 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - The 'family' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface.colorbar.title' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - """ - - 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. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.surface.colorbar.title.Font - color - - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.colorbar.title.Font -constructor must be a dict or -an instance of plotly.graph_objs.surface.colorbar.title.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface.colorbar.title import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['size'] = v_font.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/contours/__init__.py b/plotly/graph_objs/surface/contours/__init__.py index a39c97f2a42..2510b9da680 100644 --- a/plotly/graph_objs/surface/contours/__init__.py +++ b/plotly/graph_objs/surface/contours/__init__.py @@ -1,6 +1,1250 @@ -from ._z import Z + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Z(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # highlight + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['highlight'] + + @highlight.setter + def highlight(self, val): + self['highlight'] = val + + # highlightcolor + # -------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['highlightcolor'] + + @highlightcolor.setter + def highlightcolor(self, val): + self['highlightcolor'] = val + + # highlightwidth + # -------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['highlightwidth'] + + @highlightwidth.setter + def highlightwidth(self, val): + self['highlightwidth'] = val + + # project + # ------- + @property + def project(self): + """ + The 'project' property is an instance of Project + that may be specified as: + - An instance of 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 + 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. + y + Determines whether or not these contour lines + are projected on 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. + z + Determines whether or not these contour lines + are projected on 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. + + Returns + ------- + plotly.graph_objs.surface.contours.z.Project + """ + return self['project'] + + @project.setter + def project(self, val): + self['project'] = val + + # show + # ---- + @property + 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) + + Returns + ------- + bool + """ + return self['show'] + + @show.setter + def show(self, val): + self['show'] = val + + # usecolormap + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['usecolormap'] + + @usecolormap.setter + def usecolormap(self, val): + self['usecolormap'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface.contours' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour lines. + highlight + Determines whether or not contour lines about the z + dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour lines. + highlightwidth + Sets the width of the highlighted contour lines. + project + plotly.graph_objs.surface.contours.z.Project instance + or dict with compatible properties + show + Determines whether or not contour lines about the z + dimension are drawn. + usecolormap + An alternate to "color". Determines whether or not the + contour lines are colored using the trace "colorscale". + width + Sets the width of the contour lines. + """ + + def __init__( + self, + arg=None, + color=None, + highlight=None, + highlightcolor=None, + highlightwidth=None, + project=None, + show=None, + usecolormap=None, + width=None, + **kwargs + ): + """ + Construct a new Z object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.surface.contours.Z + color + Sets the color of the contour lines. + highlight + Determines whether or not contour lines about the z + dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour lines. + highlightwidth + Sets the width of the highlighted contour lines. + project + plotly.graph_objs.surface.contours.z.Project instance + or dict with compatible properties + show + Determines whether or not contour lines about the z + dimension are drawn. + usecolormap + An alternate to "color". Determines whether or not the + contour lines are colored using the trace "colorscale". + width + Sets the width of the contour lines. + + Returns + ------- + Z + """ + super(Z, self).__init__('z') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.contours.Z +constructor must be a dict or +an instance of plotly.graph_objs.surface.contours.Z""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface.contours import (z as v_z) + + # Initialize validators + # --------------------- + self._validators['color'] = v_z.ColorValidator() + self._validators['highlight'] = v_z.HighlightValidator() + self._validators['highlightcolor'] = v_z.HighlightcolorValidator() + self._validators['highlightwidth'] = v_z.HighlightwidthValidator() + self._validators['project'] = v_z.ProjectValidator() + self._validators['show'] = v_z.ShowValidator() + self._validators['usecolormap'] = v_z.UsecolormapValidator() + self._validators['width'] = v_z.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('highlight', None) + self['highlight'] = highlight if highlight is not None else _v + _v = arg.pop('highlightcolor', None) + self['highlightcolor' + ] = highlightcolor if highlightcolor is not None else _v + _v = arg.pop('highlightwidth', None) + self['highlightwidth' + ] = highlightwidth if highlightwidth is not None else _v + _v = arg.pop('project', None) + self['project'] = project if project is not None else _v + _v = arg.pop('show', None) + self['show'] = show if show is not None else _v + _v = arg.pop('usecolormap', None) + self['usecolormap'] = usecolormap if usecolormap is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Y(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # highlight + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['highlight'] + + @highlight.setter + def highlight(self, val): + self['highlight'] = val + + # highlightcolor + # -------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['highlightcolor'] + + @highlightcolor.setter + def highlightcolor(self, val): + self['highlightcolor'] = val + + # highlightwidth + # -------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['highlightwidth'] + + @highlightwidth.setter + def highlightwidth(self, val): + self['highlightwidth'] = val + + # project + # ------- + @property + def project(self): + """ + The 'project' property is an instance of Project + that may be specified as: + - An instance of 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 + 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. + y + Determines whether or not these contour lines + are projected on 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. + z + Determines whether or not these contour lines + are projected on 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. + + Returns + ------- + plotly.graph_objs.surface.contours.y.Project + """ + return self['project'] + + @project.setter + def project(self, val): + self['project'] = val + + # show + # ---- + @property + 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) + + Returns + ------- + bool + """ + return self['show'] + + @show.setter + def show(self, val): + self['show'] = val + + # usecolormap + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['usecolormap'] + + @usecolormap.setter + def usecolormap(self, val): + self['usecolormap'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface.contours' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour lines. + highlight + Determines whether or not contour lines about the y + dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour lines. + highlightwidth + Sets the width of the highlighted contour lines. + project + plotly.graph_objs.surface.contours.y.Project instance + or dict with compatible properties + show + Determines whether or not contour lines about the y + dimension are drawn. + usecolormap + An alternate to "color". Determines whether or not the + contour lines are colored using the trace "colorscale". + width + Sets the width of the contour lines. + """ + + def __init__( + self, + arg=None, + color=None, + highlight=None, + highlightcolor=None, + highlightwidth=None, + project=None, + show=None, + usecolormap=None, + width=None, + **kwargs + ): + """ + Construct a new Y object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.surface.contours.Y + color + Sets the color of the contour lines. + highlight + Determines whether or not contour lines about the y + dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour lines. + highlightwidth + Sets the width of the highlighted contour lines. + project + plotly.graph_objs.surface.contours.y.Project instance + or dict with compatible properties + show + Determines whether or not contour lines about the y + dimension are drawn. + usecolormap + An alternate to "color". Determines whether or not the + contour lines are colored using the trace "colorscale". + width + Sets the width of the contour lines. + + Returns + ------- + Y + """ + super(Y, self).__init__('y') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.contours.Y +constructor must be a dict or +an instance of plotly.graph_objs.surface.contours.Y""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface.contours import (y as v_y) + + # Initialize validators + # --------------------- + self._validators['color'] = v_y.ColorValidator() + self._validators['highlight'] = v_y.HighlightValidator() + self._validators['highlightcolor'] = v_y.HighlightcolorValidator() + self._validators['highlightwidth'] = v_y.HighlightwidthValidator() + self._validators['project'] = v_y.ProjectValidator() + self._validators['show'] = v_y.ShowValidator() + self._validators['usecolormap'] = v_y.UsecolormapValidator() + self._validators['width'] = v_y.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('highlight', None) + self['highlight'] = highlight if highlight is not None else _v + _v = arg.pop('highlightcolor', None) + self['highlightcolor' + ] = highlightcolor if highlightcolor is not None else _v + _v = arg.pop('highlightwidth', None) + self['highlightwidth' + ] = highlightwidth if highlightwidth is not None else _v + _v = arg.pop('project', None) + self['project'] = project if project is not None else _v + _v = arg.pop('show', None) + self['show'] = show if show is not None else _v + _v = arg.pop('usecolormap', None) + self['usecolormap'] = usecolormap if usecolormap is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class X(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # highlight + # --------- + @property + 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) + + Returns + ------- + bool + """ + return self['highlight'] + + @highlight.setter + def highlight(self, val): + self['highlight'] = val + + # highlightcolor + # -------------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['highlightcolor'] + + @highlightcolor.setter + def highlightcolor(self, val): + self['highlightcolor'] = val + + # highlightwidth + # -------------- + @property + 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] + + Returns + ------- + int|float + """ + return self['highlightwidth'] + + @highlightwidth.setter + def highlightwidth(self, val): + self['highlightwidth'] = val + + # project + # ------- + @property + def project(self): + """ + The 'project' property is an instance of Project + that may be specified as: + - An instance of 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 + 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. + y + Determines whether or not these contour lines + are projected on 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. + z + Determines whether or not these contour lines + are projected on 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. + + Returns + ------- + plotly.graph_objs.surface.contours.x.Project + """ + return self['project'] + + @project.setter + def project(self, val): + self['project'] = val + + # show + # ---- + @property + 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) + + Returns + ------- + bool + """ + return self['show'] + + @show.setter + def show(self, val): + self['show'] = val + + # usecolormap + # ----------- + @property + 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) + + Returns + ------- + bool + """ + return self['usecolormap'] + + @usecolormap.setter + def usecolormap(self, val): + self['usecolormap'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface.contours' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour lines. + highlight + Determines whether or not contour lines about the x + dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour lines. + highlightwidth + Sets the width of the highlighted contour lines. + project + plotly.graph_objs.surface.contours.x.Project instance + or dict with compatible properties + show + Determines whether or not contour lines about the x + dimension are drawn. + usecolormap + An alternate to "color". Determines whether or not the + contour lines are colored using the trace "colorscale". + width + Sets the width of the contour lines. + """ + + def __init__( + self, + arg=None, + color=None, + highlight=None, + highlightcolor=None, + highlightwidth=None, + project=None, + show=None, + usecolormap=None, + width=None, + **kwargs + ): + """ + Construct a new X object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.surface.contours.X + color + Sets the color of the contour lines. + highlight + Determines whether or not contour lines about the x + dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour lines. + highlightwidth + Sets the width of the highlighted contour lines. + project + plotly.graph_objs.surface.contours.x.Project instance + or dict with compatible properties + show + Determines whether or not contour lines about the x + dimension are drawn. + usecolormap + An alternate to "color". Determines whether or not the + contour lines are colored using the trace "colorscale". + width + Sets the width of the contour lines. + + Returns + ------- + X + """ + super(X, self).__init__('x') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.contours.X +constructor must be a dict or +an instance of plotly.graph_objs.surface.contours.X""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface.contours import (x as v_x) + + # Initialize validators + # --------------------- + self._validators['color'] = v_x.ColorValidator() + self._validators['highlight'] = v_x.HighlightValidator() + self._validators['highlightcolor'] = v_x.HighlightcolorValidator() + self._validators['highlightwidth'] = v_x.HighlightwidthValidator() + self._validators['project'] = v_x.ProjectValidator() + self._validators['show'] = v_x.ShowValidator() + self._validators['usecolormap'] = v_x.UsecolormapValidator() + self._validators['width'] = v_x.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('highlight', None) + self['highlight'] = highlight if highlight is not None else _v + _v = arg.pop('highlightcolor', None) + self['highlightcolor' + ] = highlightcolor if highlightcolor is not None else _v + _v = arg.pop('highlightwidth', None) + self['highlightwidth' + ] = highlightwidth if highlightwidth is not None else _v + _v = arg.pop('project', None) + self['project'] = project if project is not None else _v + _v = arg.pop('show', None) + self['show'] = show if show is not None else _v + _v = arg.pop('usecolormap', None) + self['usecolormap'] = usecolormap if usecolormap is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.surface.contours import z -from ._y import Y from plotly.graph_objs.surface.contours import y -from ._x import X from plotly.graph_objs.surface.contours import x diff --git a/plotly/graph_objs/surface/contours/_x.py b/plotly/graph_objs/surface/contours/_x.py deleted file mode 100644 index eb65949b234..00000000000 --- a/plotly/graph_objs/surface/contours/_x.py +++ /dev/null @@ -1,413 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class X(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # highlight - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['highlight'] - - @highlight.setter - def highlight(self, val): - self['highlight'] = val - - # highlightcolor - # -------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['highlightcolor'] - - @highlightcolor.setter - def highlightcolor(self, val): - self['highlightcolor'] = val - - # highlightwidth - # -------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['highlightwidth'] - - @highlightwidth.setter - def highlightwidth(self, val): - self['highlightwidth'] = val - - # project - # ------- - @property - def project(self): - """ - The 'project' property is an instance of Project - that may be specified as: - - An instance of 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 - 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. - y - Determines whether or not these contour lines - are projected on 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. - z - Determines whether or not these contour lines - are projected on 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. - - Returns - ------- - plotly.graph_objs.surface.contours.x.Project - """ - return self['project'] - - @project.setter - def project(self, val): - self['project'] = val - - # show - # ---- - @property - 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) - - Returns - ------- - bool - """ - return self['show'] - - @show.setter - def show(self, val): - self['show'] = val - - # usecolormap - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['usecolormap'] - - @usecolormap.setter - def usecolormap(self, val): - self['usecolormap'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface.contours' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the color of the contour lines. - highlight - Determines whether or not contour lines about the x - dimension are highlighted on hover. - highlightcolor - Sets the color of the highlighted contour lines. - highlightwidth - Sets the width of the highlighted contour lines. - project - plotly.graph_objs.surface.contours.x.Project instance - or dict with compatible properties - show - Determines whether or not contour lines about the x - dimension are drawn. - usecolormap - An alternate to "color". Determines whether or not the - contour lines are colored using the trace "colorscale". - width - Sets the width of the contour lines. - """ - - def __init__( - self, - arg=None, - color=None, - highlight=None, - highlightcolor=None, - highlightwidth=None, - project=None, - show=None, - usecolormap=None, - width=None, - **kwargs - ): - """ - Construct a new X object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.contours.X - color - Sets the color of the contour lines. - highlight - Determines whether or not contour lines about the x - dimension are highlighted on hover. - highlightcolor - Sets the color of the highlighted contour lines. - highlightwidth - Sets the width of the highlighted contour lines. - project - plotly.graph_objs.surface.contours.x.Project instance - or dict with compatible properties - show - Determines whether or not contour lines about the x - dimension are drawn. - usecolormap - An alternate to "color". Determines whether or not the - contour lines are colored using the trace "colorscale". - width - Sets the width of the contour lines. - - Returns - ------- - X - """ - super(X, self).__init__('x') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.contours.X -constructor must be a dict or -an instance of plotly.graph_objs.surface.contours.X""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface.contours import (x as v_x) - - # Initialize validators - # --------------------- - self._validators['color'] = v_x.ColorValidator() - self._validators['highlight'] = v_x.HighlightValidator() - self._validators['highlightcolor'] = v_x.HighlightcolorValidator() - self._validators['highlightwidth'] = v_x.HighlightwidthValidator() - self._validators['project'] = v_x.ProjectValidator() - self._validators['show'] = v_x.ShowValidator() - self._validators['usecolormap'] = v_x.UsecolormapValidator() - self._validators['width'] = v_x.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('highlight', None) - self['highlight'] = highlight if highlight is not None else _v - _v = arg.pop('highlightcolor', None) - self['highlightcolor' - ] = highlightcolor if highlightcolor is not None else _v - _v = arg.pop('highlightwidth', None) - self['highlightwidth' - ] = highlightwidth if highlightwidth is not None else _v - _v = arg.pop('project', None) - self['project'] = project if project is not None else _v - _v = arg.pop('show', None) - self['show'] = show if show is not None else _v - _v = arg.pop('usecolormap', None) - self['usecolormap'] = usecolormap if usecolormap is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/contours/_y.py b/plotly/graph_objs/surface/contours/_y.py deleted file mode 100644 index f42a536cfcc..00000000000 --- a/plotly/graph_objs/surface/contours/_y.py +++ /dev/null @@ -1,413 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Y(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # highlight - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['highlight'] - - @highlight.setter - def highlight(self, val): - self['highlight'] = val - - # highlightcolor - # -------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['highlightcolor'] - - @highlightcolor.setter - def highlightcolor(self, val): - self['highlightcolor'] = val - - # highlightwidth - # -------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['highlightwidth'] - - @highlightwidth.setter - def highlightwidth(self, val): - self['highlightwidth'] = val - - # project - # ------- - @property - def project(self): - """ - The 'project' property is an instance of Project - that may be specified as: - - An instance of 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 - 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. - y - Determines whether or not these contour lines - are projected on 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. - z - Determines whether or not these contour lines - are projected on 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. - - Returns - ------- - plotly.graph_objs.surface.contours.y.Project - """ - return self['project'] - - @project.setter - def project(self, val): - self['project'] = val - - # show - # ---- - @property - 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) - - Returns - ------- - bool - """ - return self['show'] - - @show.setter - def show(self, val): - self['show'] = val - - # usecolormap - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['usecolormap'] - - @usecolormap.setter - def usecolormap(self, val): - self['usecolormap'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface.contours' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the color of the contour lines. - highlight - Determines whether or not contour lines about the y - dimension are highlighted on hover. - highlightcolor - Sets the color of the highlighted contour lines. - highlightwidth - Sets the width of the highlighted contour lines. - project - plotly.graph_objs.surface.contours.y.Project instance - or dict with compatible properties - show - Determines whether or not contour lines about the y - dimension are drawn. - usecolormap - An alternate to "color". Determines whether or not the - contour lines are colored using the trace "colorscale". - width - Sets the width of the contour lines. - """ - - def __init__( - self, - arg=None, - color=None, - highlight=None, - highlightcolor=None, - highlightwidth=None, - project=None, - show=None, - usecolormap=None, - width=None, - **kwargs - ): - """ - Construct a new Y object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.contours.Y - color - Sets the color of the contour lines. - highlight - Determines whether or not contour lines about the y - dimension are highlighted on hover. - highlightcolor - Sets the color of the highlighted contour lines. - highlightwidth - Sets the width of the highlighted contour lines. - project - plotly.graph_objs.surface.contours.y.Project instance - or dict with compatible properties - show - Determines whether or not contour lines about the y - dimension are drawn. - usecolormap - An alternate to "color". Determines whether or not the - contour lines are colored using the trace "colorscale". - width - Sets the width of the contour lines. - - Returns - ------- - Y - """ - super(Y, self).__init__('y') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.contours.Y -constructor must be a dict or -an instance of plotly.graph_objs.surface.contours.Y""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface.contours import (y as v_y) - - # Initialize validators - # --------------------- - self._validators['color'] = v_y.ColorValidator() - self._validators['highlight'] = v_y.HighlightValidator() - self._validators['highlightcolor'] = v_y.HighlightcolorValidator() - self._validators['highlightwidth'] = v_y.HighlightwidthValidator() - self._validators['project'] = v_y.ProjectValidator() - self._validators['show'] = v_y.ShowValidator() - self._validators['usecolormap'] = v_y.UsecolormapValidator() - self._validators['width'] = v_y.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('highlight', None) - self['highlight'] = highlight if highlight is not None else _v - _v = arg.pop('highlightcolor', None) - self['highlightcolor' - ] = highlightcolor if highlightcolor is not None else _v - _v = arg.pop('highlightwidth', None) - self['highlightwidth' - ] = highlightwidth if highlightwidth is not None else _v - _v = arg.pop('project', None) - self['project'] = project if project is not None else _v - _v = arg.pop('show', None) - self['show'] = show if show is not None else _v - _v = arg.pop('usecolormap', None) - self['usecolormap'] = usecolormap if usecolormap is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/contours/_z.py b/plotly/graph_objs/surface/contours/_z.py deleted file mode 100644 index c8fd5f7460a..00000000000 --- a/plotly/graph_objs/surface/contours/_z.py +++ /dev/null @@ -1,413 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Z(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # highlight - # --------- - @property - 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) - - Returns - ------- - bool - """ - return self['highlight'] - - @highlight.setter - def highlight(self, val): - self['highlight'] = val - - # highlightcolor - # -------------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['highlightcolor'] - - @highlightcolor.setter - def highlightcolor(self, val): - self['highlightcolor'] = val - - # highlightwidth - # -------------- - @property - 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] - - Returns - ------- - int|float - """ - return self['highlightwidth'] - - @highlightwidth.setter - def highlightwidth(self, val): - self['highlightwidth'] = val - - # project - # ------- - @property - def project(self): - """ - The 'project' property is an instance of Project - that may be specified as: - - An instance of 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 - 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. - y - Determines whether or not these contour lines - are projected on 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. - z - Determines whether or not these contour lines - are projected on 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. - - Returns - ------- - plotly.graph_objs.surface.contours.z.Project - """ - return self['project'] - - @project.setter - def project(self, val): - self['project'] = val - - # show - # ---- - @property - 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) - - Returns - ------- - bool - """ - return self['show'] - - @show.setter - def show(self, val): - self['show'] = val - - # usecolormap - # ----------- - @property - 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) - - Returns - ------- - bool - """ - return self['usecolormap'] - - @usecolormap.setter - def usecolormap(self, val): - self['usecolormap'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface.contours' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the color of the contour lines. - highlight - Determines whether or not contour lines about the z - dimension are highlighted on hover. - highlightcolor - Sets the color of the highlighted contour lines. - highlightwidth - Sets the width of the highlighted contour lines. - project - plotly.graph_objs.surface.contours.z.Project instance - or dict with compatible properties - show - Determines whether or not contour lines about the z - dimension are drawn. - usecolormap - An alternate to "color". Determines whether or not the - contour lines are colored using the trace "colorscale". - width - Sets the width of the contour lines. - """ - - def __init__( - self, - arg=None, - color=None, - highlight=None, - highlightcolor=None, - highlightwidth=None, - project=None, - show=None, - usecolormap=None, - width=None, - **kwargs - ): - """ - Construct a new Z object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.surface.contours.Z - color - Sets the color of the contour lines. - highlight - Determines whether or not contour lines about the z - dimension are highlighted on hover. - highlightcolor - Sets the color of the highlighted contour lines. - highlightwidth - Sets the width of the highlighted contour lines. - project - plotly.graph_objs.surface.contours.z.Project instance - or dict with compatible properties - show - Determines whether or not contour lines about the z - dimension are drawn. - usecolormap - An alternate to "color". Determines whether or not the - contour lines are colored using the trace "colorscale". - width - Sets the width of the contour lines. - - Returns - ------- - Z - """ - super(Z, self).__init__('z') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.contours.Z -constructor must be a dict or -an instance of plotly.graph_objs.surface.contours.Z""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface.contours import (z as v_z) - - # Initialize validators - # --------------------- - self._validators['color'] = v_z.ColorValidator() - self._validators['highlight'] = v_z.HighlightValidator() - self._validators['highlightcolor'] = v_z.HighlightcolorValidator() - self._validators['highlightwidth'] = v_z.HighlightwidthValidator() - self._validators['project'] = v_z.ProjectValidator() - self._validators['show'] = v_z.ShowValidator() - self._validators['usecolormap'] = v_z.UsecolormapValidator() - self._validators['width'] = v_z.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('highlight', None) - self['highlight'] = highlight if highlight is not None else _v - _v = arg.pop('highlightcolor', None) - self['highlightcolor' - ] = highlightcolor if highlightcolor is not None else _v - _v = arg.pop('highlightwidth', None) - self['highlightwidth' - ] = highlightwidth if highlightwidth is not None else _v - _v = arg.pop('project', None) - self['project'] = project if project is not None else _v - _v = arg.pop('show', None) - self['show'] = show if show is not None else _v - _v = arg.pop('usecolormap', None) - self['usecolormap'] = usecolormap if usecolormap is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/contours/x/__init__.py b/plotly/graph_objs/surface/contours/x/__init__.py index 0bd829fdb18..7cb4a72270c 100644 --- a/plotly/graph_objs/surface/contours/x/__init__.py +++ b/plotly/graph_objs/surface/contours/x/__init__.py @@ -1 +1,189 @@ -from ._project import Project + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Project(_BaseTraceHierarchyType): + + # x + # - + @property + def x(self): + """ + Determines whether or not these contour lines are projected on + 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) + + Returns + ------- + bool + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @property + def y(self): + """ + Determines whether or not these contour lines are projected on + 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) + + Returns + ------- + bool + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # z + # - + @property + def z(self): + """ + Determines whether or not these contour lines are projected on + 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) + + Returns + ------- + bool + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface.contours.x' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + Determines whether or not these contour lines are + projected on 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. + y + Determines whether or not these contour lines are + projected on 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. + z + Determines whether or not these contour lines are + projected on 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. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Project object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.surface.contours.x.Project + x + Determines whether or not these contour lines are + projected on 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. + y + Determines whether or not these contour lines are + projected on 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. + z + Determines whether or not these contour lines are + projected on 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. + + Returns + ------- + Project + """ + super(Project, self).__init__('project') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.contours.x.Project +constructor must be a dict or +an instance of plotly.graph_objs.surface.contours.x.Project""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface.contours.x import (project as v_project) + + # Initialize validators + # --------------------- + self._validators['x'] = v_project.XValidator() + self._validators['y'] = v_project.YValidator() + self._validators['z'] = v_project.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/surface/contours/x/_project.py b/plotly/graph_objs/surface/contours/x/_project.py deleted file mode 100644 index dd23a26a801..00000000000 --- a/plotly/graph_objs/surface/contours/x/_project.py +++ /dev/null @@ -1,187 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Project(BaseTraceHierarchyType): - - # x - # - - @property - def x(self): - """ - Determines whether or not these contour lines are projected on - 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) - - Returns - ------- - bool - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @property - def y(self): - """ - Determines whether or not these contour lines are projected on - 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) - - Returns - ------- - bool - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # z - # - - @property - def z(self): - """ - Determines whether or not these contour lines are projected on - 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) - - Returns - ------- - bool - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface.contours.x' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - Determines whether or not these contour lines are - projected on 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. - y - Determines whether or not these contour lines are - projected on 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. - z - Determines whether or not these contour lines are - projected on 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. - """ - - def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): - """ - Construct a new Project object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.surface.contours.x.Project - x - Determines whether or not these contour lines are - projected on 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. - y - Determines whether or not these contour lines are - projected on 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. - z - Determines whether or not these contour lines are - projected on 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. - - Returns - ------- - Project - """ - super(Project, self).__init__('project') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.contours.x.Project -constructor must be a dict or -an instance of plotly.graph_objs.surface.contours.x.Project""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface.contours.x import (project as v_project) - - # Initialize validators - # --------------------- - self._validators['x'] = v_project.XValidator() - self._validators['y'] = v_project.YValidator() - self._validators['z'] = v_project.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/contours/y/__init__.py b/plotly/graph_objs/surface/contours/y/__init__.py index 0bd829fdb18..806ce0ac30f 100644 --- a/plotly/graph_objs/surface/contours/y/__init__.py +++ b/plotly/graph_objs/surface/contours/y/__init__.py @@ -1 +1,189 @@ -from ._project import Project + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Project(_BaseTraceHierarchyType): + + # x + # - + @property + def x(self): + """ + Determines whether or not these contour lines are projected on + 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) + + Returns + ------- + bool + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @property + def y(self): + """ + Determines whether or not these contour lines are projected on + 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) + + Returns + ------- + bool + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # z + # - + @property + def z(self): + """ + Determines whether or not these contour lines are projected on + 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) + + Returns + ------- + bool + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface.contours.y' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + Determines whether or not these contour lines are + projected on 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. + y + Determines whether or not these contour lines are + projected on 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. + z + Determines whether or not these contour lines are + projected on 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. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Project object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.surface.contours.y.Project + x + Determines whether or not these contour lines are + projected on 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. + y + Determines whether or not these contour lines are + projected on 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. + z + Determines whether or not these contour lines are + projected on 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. + + Returns + ------- + Project + """ + super(Project, self).__init__('project') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.contours.y.Project +constructor must be a dict or +an instance of plotly.graph_objs.surface.contours.y.Project""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface.contours.y import (project as v_project) + + # Initialize validators + # --------------------- + self._validators['x'] = v_project.XValidator() + self._validators['y'] = v_project.YValidator() + self._validators['z'] = v_project.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/surface/contours/y/_project.py b/plotly/graph_objs/surface/contours/y/_project.py deleted file mode 100644 index 79e8b02666f..00000000000 --- a/plotly/graph_objs/surface/contours/y/_project.py +++ /dev/null @@ -1,187 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Project(BaseTraceHierarchyType): - - # x - # - - @property - def x(self): - """ - Determines whether or not these contour lines are projected on - 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) - - Returns - ------- - bool - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @property - def y(self): - """ - Determines whether or not these contour lines are projected on - 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) - - Returns - ------- - bool - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # z - # - - @property - def z(self): - """ - Determines whether or not these contour lines are projected on - 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) - - Returns - ------- - bool - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface.contours.y' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - Determines whether or not these contour lines are - projected on 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. - y - Determines whether or not these contour lines are - projected on 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. - z - Determines whether or not these contour lines are - projected on 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. - """ - - def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): - """ - Construct a new Project object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.surface.contours.y.Project - x - Determines whether or not these contour lines are - projected on 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. - y - Determines whether or not these contour lines are - projected on 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. - z - Determines whether or not these contour lines are - projected on 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. - - Returns - ------- - Project - """ - super(Project, self).__init__('project') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.contours.y.Project -constructor must be a dict or -an instance of plotly.graph_objs.surface.contours.y.Project""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface.contours.y import (project as v_project) - - # Initialize validators - # --------------------- - self._validators['x'] = v_project.XValidator() - self._validators['y'] = v_project.YValidator() - self._validators['z'] = v_project.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/contours/z/__init__.py b/plotly/graph_objs/surface/contours/z/__init__.py index 0bd829fdb18..2ae427e3b30 100644 --- a/plotly/graph_objs/surface/contours/z/__init__.py +++ b/plotly/graph_objs/surface/contours/z/__init__.py @@ -1 +1,189 @@ -from ._project import Project + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Project(_BaseTraceHierarchyType): + + # x + # - + @property + def x(self): + """ + Determines whether or not these contour lines are projected on + 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) + + Returns + ------- + bool + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @property + def y(self): + """ + Determines whether or not these contour lines are projected on + 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) + + Returns + ------- + bool + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # z + # - + @property + def z(self): + """ + Determines whether or not these contour lines are projected on + 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) + + Returns + ------- + bool + """ + return self['z'] + + @z.setter + def z(self, val): + self['z'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface.contours.z' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + x + Determines whether or not these contour lines are + projected on 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. + y + Determines whether or not these contour lines are + projected on 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. + z + Determines whether or not these contour lines are + projected on 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. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Project object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.surface.contours.z.Project + x + Determines whether or not these contour lines are + projected on 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. + y + Determines whether or not these contour lines are + projected on 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. + z + Determines whether or not these contour lines are + projected on 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. + + Returns + ------- + Project + """ + super(Project, self).__init__('project') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.contours.z.Project +constructor must be a dict or +an instance of plotly.graph_objs.surface.contours.z.Project""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface.contours.z import (project as v_project) + + # Initialize validators + # --------------------- + self._validators['x'] = v_project.XValidator() + self._validators['y'] = v_project.YValidator() + self._validators['z'] = v_project.ZValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + _v = arg.pop('z', None) + self['z'] = z if z is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/surface/contours/z/_project.py b/plotly/graph_objs/surface/contours/z/_project.py deleted file mode 100644 index e380cd3c24c..00000000000 --- a/plotly/graph_objs/surface/contours/z/_project.py +++ /dev/null @@ -1,187 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Project(BaseTraceHierarchyType): - - # x - # - - @property - def x(self): - """ - Determines whether or not these contour lines are projected on - 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) - - Returns - ------- - bool - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @property - def y(self): - """ - Determines whether or not these contour lines are projected on - 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) - - Returns - ------- - bool - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # z - # - - @property - def z(self): - """ - Determines whether or not these contour lines are projected on - 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) - - Returns - ------- - bool - """ - return self['z'] - - @z.setter - def z(self, val): - self['z'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface.contours.z' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - x - Determines whether or not these contour lines are - projected on 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. - y - Determines whether or not these contour lines are - projected on 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. - z - Determines whether or not these contour lines are - projected on 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. - """ - - def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): - """ - Construct a new Project object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.surface.contours.z.Project - x - Determines whether or not these contour lines are - projected on 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. - y - Determines whether or not these contour lines are - projected on 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. - z - Determines whether or not these contour lines are - projected on 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. - - Returns - ------- - Project - """ - super(Project, self).__init__('project') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.contours.z.Project -constructor must be a dict or -an instance of plotly.graph_objs.surface.contours.z.Project""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface.contours.z import (project as v_project) - - # Initialize validators - # --------------------- - self._validators['x'] = v_project.XValidator() - self._validators['y'] = v_project.YValidator() - self._validators['z'] = v_project.ZValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - _v = arg.pop('z', None) - self['z'] = z if z is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/surface/hoverlabel/__init__.py b/plotly/graph_objs/surface/hoverlabel/__init__.py index c37b8b5cd28..07407020f63 100644 --- a/plotly/graph_objs/surface/hoverlabel/__init__.py +++ b/plotly/graph_objs/surface/hoverlabel/__init__.py @@ -1 +1,322 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'surface.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.surface.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.surface.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.surface.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.surface.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/surface/hoverlabel/_font.py b/plotly/graph_objs/surface/hoverlabel/_font.py deleted file mode 100644 index 2cb3ba52fe0..00000000000 --- a/plotly/graph_objs/surface/hoverlabel/_font.py +++ /dev/null @@ -1,320 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'surface.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.surface.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.surface.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.surface.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.surface.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/table/__init__.py b/plotly/graph_objs/table/__init__.py index 72c2c2da5ad..fb7e07f2b1e 100644 --- a/plotly/graph_objs/table/__init__.py +++ b/plotly/graph_objs/table/__init__.py @@ -1,8 +1,1910 @@ -from ._stream import Stream -from ._hoverlabel import Hoverlabel + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'table' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.table.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.table.Stream +constructor must be a dict or +an instance of plotly.graph_objs.table.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.table import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.table.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'table' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.table.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.table.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.table.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.table import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Header(_BaseTraceHierarchyType): + + # align + # ----- + @property + def align(self): + """ + Sets the horizontal alignment of the `text` within the box. Has + an effect only if `text` spans more 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'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['align'] + + @align.setter + def align(self, val): + self['align'] = val + + # alignsrc + # -------- + @property + def alignsrc(self): + """ + Sets the source reference on plot.ly for align . + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['alignsrc'] + + @alignsrc.setter + def alignsrc(self, val): + self['alignsrc'] = val + + # fill + # ---- + @property + def fill(self): + """ + The 'fill' property is an instance of Fill + that may be specified as: + - An instance of 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 + array of colors. + colorsrc + Sets the source reference on plot.ly for color + . + + Returns + ------- + plotly.graph_objs.table.header.Fill + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # font + # ---- + @property + def font(self): + """ + The 'font' property is an instance of Font + that may be specified as: + - An instance of 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.table.header.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # format + # ------ + @property + def format(self): + """ + Sets the cell value formatting rule using d3 formatting mini- + language which is similar to those of Python. See https://githu + b.com/d3/d3-format/blob/master/README.md#locale_format + + The 'format' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['format'] + + @format.setter + def format(self, val): + self['format'] = val + + # formatsrc + # --------- + @property + def formatsrc(self): + """ + Sets the source reference on plot.ly for format . + + The 'formatsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['formatsrc'] + + @formatsrc.setter + def formatsrc(self, val): + self['formatsrc'] = val + + # height + # ------ + @property + def height(self): + """ + The height of cells. + + The 'height' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['height'] + + @height.setter + def height(self, val): + self['height'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 plot.ly for color + . + width + + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.table.header.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # prefix + # ------ + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['prefix'] + + @prefix.setter + def prefix(self, val): + self['prefix'] = val + + # prefixsrc + # --------- + @property + def prefixsrc(self): + """ + Sets the source reference on plot.ly for prefix . + + The 'prefixsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['prefixsrc'] + + @prefixsrc.setter + def prefixsrc(self, val): + self['prefixsrc'] = val + + # suffix + # ------ + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['suffix'] + + @suffix.setter + def suffix(self, val): + self['suffix'] = val + + # suffixsrc + # --------- + @property + def suffixsrc(self): + """ + Sets the source reference on plot.ly for suffix . + + The 'suffixsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['suffixsrc'] + + @suffixsrc.setter + def suffixsrc(self, val): + self['suffixsrc'] = val + + # values + # ------ + @property + def values(self): + """ + Header cell values. `values[m][n]` represents the value of the + `n`th point in column `m`, therefore the `values[m]` vector + length for all columns must be the same (longer vectors will be + truncated). Each value must be a finite number or a string. + + The 'values' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['values'] + + @values.setter + def values(self, val): + self['values'] = val + + # valuessrc + # --------- + @property + def valuessrc(self): + """ + Sets the source reference on plot.ly for values . + + The 'valuessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['valuessrc'] + + @valuessrc.setter + def valuessrc(self, val): + self['valuessrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'table' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans more two or + more lines (i.e. `text` contains one or more
HTML + tags) or if an explicit width is set to override the + text width. + alignsrc + Sets the source reference on plot.ly for align . + fill + plotly.graph_objs.table.header.Fill instance or dict + with compatible properties + font + plotly.graph_objs.table.header.Font instance or dict + with compatible properties + format + Sets the cell value formatting rule using d3 formatting + mini-language which is similar to those of Python. See + https://github.com/d3/d3-format/blob/master/README.md#l + ocale_format + formatsrc + Sets the source reference on plot.ly for format . + height + The height of cells. + line + plotly.graph_objs.table.header.Line instance or dict + with compatible properties + prefix + Prefix for cell values. + prefixsrc + Sets the source reference on plot.ly for prefix . + suffix + Suffix for cell values. + suffixsrc + Sets the source reference on plot.ly for suffix . + values + Header cell values. `values[m][n]` represents the value + of the `n`th point in column `m`, therefore the + `values[m]` vector length for all columns must be the + same (longer vectors will be truncated). Each value + must be a finite number or a string. + valuessrc + Sets the source reference on plot.ly for values . + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + fill=None, + font=None, + format=None, + formatsrc=None, + height=None, + line=None, + prefix=None, + prefixsrc=None, + suffix=None, + suffixsrc=None, + values=None, + valuessrc=None, + **kwargs + ): + """ + Construct a new Header object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.table.Header + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans more two or + more lines (i.e. `text` contains one or more
HTML + tags) or if an explicit width is set to override the + text width. + alignsrc + Sets the source reference on plot.ly for align . + fill + plotly.graph_objs.table.header.Fill instance or dict + with compatible properties + font + plotly.graph_objs.table.header.Font instance or dict + with compatible properties + format + Sets the cell value formatting rule using d3 formatting + mini-language which is similar to those of Python. See + https://github.com/d3/d3-format/blob/master/README.md#l + ocale_format + formatsrc + Sets the source reference on plot.ly for format . + height + The height of cells. + line + plotly.graph_objs.table.header.Line instance or dict + with compatible properties + prefix + Prefix for cell values. + prefixsrc + Sets the source reference on plot.ly for prefix . + suffix + Suffix for cell values. + suffixsrc + Sets the source reference on plot.ly for suffix . + values + Header cell values. `values[m][n]` represents the value + of the `n`th point in column `m`, therefore the + `values[m]` vector length for all columns must be the + same (longer vectors will be truncated). Each value + must be a finite number or a string. + valuessrc + Sets the source reference on plot.ly for values . + + Returns + ------- + Header + """ + super(Header, self).__init__('header') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.table.Header +constructor must be a dict or +an instance of plotly.graph_objs.table.Header""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.table import (header as v_header) + + # Initialize validators + # --------------------- + self._validators['align'] = v_header.AlignValidator() + self._validators['alignsrc'] = v_header.AlignsrcValidator() + self._validators['fill'] = v_header.FillValidator() + self._validators['font'] = v_header.FontValidator() + self._validators['format'] = v_header.FormatValidator() + self._validators['formatsrc'] = v_header.FormatsrcValidator() + self._validators['height'] = v_header.HeightValidator() + self._validators['line'] = v_header.LineValidator() + self._validators['prefix'] = v_header.PrefixValidator() + self._validators['prefixsrc'] = v_header.PrefixsrcValidator() + self._validators['suffix'] = v_header.SuffixValidator() + self._validators['suffixsrc'] = v_header.SuffixsrcValidator() + self._validators['values'] = v_header.ValuesValidator() + self._validators['valuessrc'] = v_header.ValuessrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('align', None) + self['align'] = align if align is not None else _v + _v = arg.pop('alignsrc', None) + self['alignsrc'] = alignsrc if alignsrc is not None else _v + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('format', None) + self['format'] = format if format is not None else _v + _v = arg.pop('formatsrc', None) + self['formatsrc'] = formatsrc if formatsrc is not None else _v + _v = arg.pop('height', None) + self['height'] = height if height is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('prefix', None) + self['prefix'] = prefix if prefix is not None else _v + _v = arg.pop('prefixsrc', None) + self['prefixsrc'] = prefixsrc if prefixsrc is not None else _v + _v = arg.pop('suffix', None) + self['suffix'] = suffix if suffix is not None else _v + _v = arg.pop('suffixsrc', None) + self['suffixsrc'] = suffixsrc if suffixsrc is not None else _v + _v = arg.pop('values', None) + self['values'] = values if values is not None else _v + _v = arg.pop('valuessrc', None) + self['valuessrc'] = valuessrc if valuessrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Domain(_BaseTraceHierarchyType): + + # column + # ------ + @property + 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] + + Returns + ------- + int + """ + return self['column'] + + @column.setter + def column(self, val): + self['column'] = val + + # row + # --- + @property + 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] + + Returns + ------- + int + """ + return self['row'] + + @row.setter + def row(self, val): + self['row'] = val + + # x + # - + @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] + + Returns + ------- + list + """ + return self['x'] + + @x.setter + def x(self, val): + self['x'] = val + + # y + # - + @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] + + Returns + ------- + list + """ + return self['y'] + + @y.setter + def y(self, val): + self['y'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'table' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this table trace . + row + If there is a layout grid, use the domain for this row + in the grid for this table trace . + x + Sets the horizontal domain of this table trace (in plot + fraction). + y + Sets the vertical domain of this table trace (in plot + fraction). + """ + + def __init__( + self, arg=None, column=None, row=None, x=None, y=None, **kwargs + ): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.table.Domain + column + If there is a layout grid, use the domain for this + column in the grid for this table trace . + row + If there is a layout grid, use the domain for this row + in the grid for this table trace . + x + Sets the horizontal domain of this table trace (in plot + fraction). + y + Sets the vertical domain of this table trace (in plot + fraction). + + Returns + ------- + Domain + """ + super(Domain, self).__init__('domain') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.table.Domain +constructor must be a dict or +an instance of plotly.graph_objs.table.Domain""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.table import (domain as v_domain) + + # Initialize validators + # --------------------- + self._validators['column'] = v_domain.ColumnValidator() + self._validators['row'] = v_domain.RowValidator() + self._validators['x'] = v_domain.XValidator() + self._validators['y'] = v_domain.YValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('column', None) + self['column'] = column if column is not None else _v + _v = arg.pop('row', None) + self['row'] = row if row is not None else _v + _v = arg.pop('x', None) + self['x'] = x if x is not None else _v + _v = arg.pop('y', None) + self['y'] = y if y is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Cells(_BaseTraceHierarchyType): + + # align + # ----- + @property + def align(self): + """ + Sets the horizontal alignment of the `text` within the box. Has + an effect only if `text` spans more 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'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self['align'] + + @align.setter + def align(self, val): + self['align'] = val + + # alignsrc + # -------- + @property + def alignsrc(self): + """ + Sets the source reference on plot.ly for align . + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['alignsrc'] + + @alignsrc.setter + def alignsrc(self, val): + self['alignsrc'] = val + + # fill + # ---- + @property + def fill(self): + """ + The 'fill' property is an instance of Fill + that may be specified as: + - An instance of 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 + array of colors. + colorsrc + Sets the source reference on plot.ly for color + . + + Returns + ------- + plotly.graph_objs.table.cells.Fill + """ + return self['fill'] + + @fill.setter + def fill(self, val): + self['fill'] = val + + # font + # ---- + @property + def font(self): + """ + The 'font' property is an instance of Font + that may be specified as: + - An instance of 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.table.cells.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # format + # ------ + @property + def format(self): + """ + Sets the cell value formatting rule using d3 formatting mini- + language which is similar to those of Python. See https://githu + b.com/d3/d3-format/blob/master/README.md#locale_format + + The 'format' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['format'] + + @format.setter + def format(self, val): + self['format'] = val + + # formatsrc + # --------- + @property + def formatsrc(self): + """ + Sets the source reference on plot.ly for format . + + The 'formatsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['formatsrc'] + + @formatsrc.setter + def formatsrc(self, val): + self['formatsrc'] = val + + # height + # ------ + @property + def height(self): + """ + The height of cells. + + The 'height' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self['height'] + + @height.setter + def height(self, val): + self['height'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 plot.ly for color + . + width + + widthsrc + Sets the source reference on plot.ly for width + . + + Returns + ------- + plotly.graph_objs.table.cells.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # prefix + # ------ + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['prefix'] + + @prefix.setter + def prefix(self, val): + self['prefix'] = val + + # prefixsrc + # --------- + @property + def prefixsrc(self): + """ + Sets the source reference on plot.ly for prefix . + + The 'prefixsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['prefixsrc'] + + @prefixsrc.setter + def prefixsrc(self, val): + self['prefixsrc'] = val + + # suffix + # ------ + @property + 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 + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['suffix'] + + @suffix.setter + def suffix(self, val): + self['suffix'] = val + + # suffixsrc + # --------- + @property + def suffixsrc(self): + """ + Sets the source reference on plot.ly for suffix . + + The 'suffixsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['suffixsrc'] + + @suffixsrc.setter + def suffixsrc(self, val): + self['suffixsrc'] = val + + # values + # ------ + @property + def values(self): + """ + Cell values. `values[m][n]` represents the value of the `n`th + point in column `m`, therefore the `values[m]` vector length + for all columns must be the same (longer vectors will be + truncated). Each value must be a finite number or a string. + + The 'values' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self['values'] + + @values.setter + def values(self, val): + self['values'] = val + + # valuessrc + # --------- + @property + def valuessrc(self): + """ + Sets the source reference on plot.ly for values . + + The 'valuessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['valuessrc'] + + @valuessrc.setter + def valuessrc(self, val): + self['valuessrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'table' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans more two or + more lines (i.e. `text` contains one or more
HTML + tags) or if an explicit width is set to override the + text width. + alignsrc + Sets the source reference on plot.ly for align . + fill + plotly.graph_objs.table.cells.Fill instance or dict + with compatible properties + font + plotly.graph_objs.table.cells.Font instance or dict + with compatible properties + format + Sets the cell value formatting rule using d3 formatting + mini-language which is similar to those of Python. See + https://github.com/d3/d3-format/blob/master/README.md#l + ocale_format + formatsrc + Sets the source reference on plot.ly for format . + height + The height of cells. + line + plotly.graph_objs.table.cells.Line instance or dict + with compatible properties + prefix + Prefix for cell values. + prefixsrc + Sets the source reference on plot.ly for prefix . + suffix + Suffix for cell values. + suffixsrc + Sets the source reference on plot.ly for suffix . + values + Cell values. `values[m][n]` represents the value of the + `n`th point in column `m`, therefore the `values[m]` + vector length for all columns must be the same (longer + vectors will be truncated). Each value must be a finite + number or a string. + valuessrc + Sets the source reference on plot.ly for values . + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + fill=None, + font=None, + format=None, + formatsrc=None, + height=None, + line=None, + prefix=None, + prefixsrc=None, + suffix=None, + suffixsrc=None, + values=None, + valuessrc=None, + **kwargs + ): + """ + Construct a new Cells object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.table.Cells + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans more two or + more lines (i.e. `text` contains one or more
HTML + tags) or if an explicit width is set to override the + text width. + alignsrc + Sets the source reference on plot.ly for align . + fill + plotly.graph_objs.table.cells.Fill instance or dict + with compatible properties + font + plotly.graph_objs.table.cells.Font instance or dict + with compatible properties + format + Sets the cell value formatting rule using d3 formatting + mini-language which is similar to those of Python. See + https://github.com/d3/d3-format/blob/master/README.md#l + ocale_format + formatsrc + Sets the source reference on plot.ly for format . + height + The height of cells. + line + plotly.graph_objs.table.cells.Line instance or dict + with compatible properties + prefix + Prefix for cell values. + prefixsrc + Sets the source reference on plot.ly for prefix . + suffix + Suffix for cell values. + suffixsrc + Sets the source reference on plot.ly for suffix . + values + Cell values. `values[m][n]` represents the value of the + `n`th point in column `m`, therefore the `values[m]` + vector length for all columns must be the same (longer + vectors will be truncated). Each value must be a finite + number or a string. + valuessrc + Sets the source reference on plot.ly for values . + + Returns + ------- + Cells + """ + super(Cells, self).__init__('cells') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.table.Cells +constructor must be a dict or +an instance of plotly.graph_objs.table.Cells""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.table import (cells as v_cells) + + # Initialize validators + # --------------------- + self._validators['align'] = v_cells.AlignValidator() + self._validators['alignsrc'] = v_cells.AlignsrcValidator() + self._validators['fill'] = v_cells.FillValidator() + self._validators['font'] = v_cells.FontValidator() + self._validators['format'] = v_cells.FormatValidator() + self._validators['formatsrc'] = v_cells.FormatsrcValidator() + self._validators['height'] = v_cells.HeightValidator() + self._validators['line'] = v_cells.LineValidator() + self._validators['prefix'] = v_cells.PrefixValidator() + self._validators['prefixsrc'] = v_cells.PrefixsrcValidator() + self._validators['suffix'] = v_cells.SuffixValidator() + self._validators['suffixsrc'] = v_cells.SuffixsrcValidator() + self._validators['values'] = v_cells.ValuesValidator() + self._validators['valuessrc'] = v_cells.ValuessrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('align', None) + self['align'] = align if align is not None else _v + _v = arg.pop('alignsrc', None) + self['alignsrc'] = alignsrc if alignsrc is not None else _v + _v = arg.pop('fill', None) + self['fill'] = fill if fill is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('format', None) + self['format'] = format if format is not None else _v + _v = arg.pop('formatsrc', None) + self['formatsrc'] = formatsrc if formatsrc is not None else _v + _v = arg.pop('height', None) + self['height'] = height if height is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('prefix', None) + self['prefix'] = prefix if prefix is not None else _v + _v = arg.pop('prefixsrc', None) + self['prefixsrc'] = prefixsrc if prefixsrc is not None else _v + _v = arg.pop('suffix', None) + self['suffix'] = suffix if suffix is not None else _v + _v = arg.pop('suffixsrc', None) + self['suffixsrc'] = suffixsrc if suffixsrc is not None else _v + _v = arg.pop('values', None) + self['values'] = values if values is not None else _v + _v = arg.pop('valuessrc', None) + self['valuessrc'] = valuessrc if valuessrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.table import hoverlabel -from ._header import Header from plotly.graph_objs.table import header -from ._domain import Domain -from ._cells import Cells from plotly.graph_objs.table import cells diff --git a/plotly/graph_objs/table/_cells.py b/plotly/graph_objs/table/_cells.py deleted file mode 100644 index fad633d4e71..00000000000 --- a/plotly/graph_objs/table/_cells.py +++ /dev/null @@ -1,568 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Cells(BaseTraceHierarchyType): - - # align - # ----- - @property - def align(self): - """ - Sets the horizontal alignment of the `text` within the box. Has - an effect only if `text` spans more 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'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['align'] - - @align.setter - def align(self, val): - self['align'] = val - - # alignsrc - # -------- - @property - def alignsrc(self): - """ - Sets the source reference on plot.ly for align . - - The 'alignsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['alignsrc'] - - @alignsrc.setter - def alignsrc(self, val): - self['alignsrc'] = val - - # fill - # ---- - @property - def fill(self): - """ - The 'fill' property is an instance of Fill - that may be specified as: - - An instance of 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 - array of colors. - colorsrc - Sets the source reference on plot.ly for color - . - - Returns - ------- - plotly.graph_objs.table.cells.Fill - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # font - # ---- - @property - def font(self): - """ - The 'font' property is an instance of Font - that may be specified as: - - An instance of 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.table.cells.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # format - # ------ - @property - def format(self): - """ - Sets the cell value formatting rule using d3 formatting mini- - language which is similar to those of Python. See https://githu - b.com/d3/d3-format/blob/master/README.md#locale_format - - The 'format' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['format'] - - @format.setter - def format(self, val): - self['format'] = val - - # formatsrc - # --------- - @property - def formatsrc(self): - """ - Sets the source reference on plot.ly for format . - - The 'formatsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['formatsrc'] - - @formatsrc.setter - def formatsrc(self, val): - self['formatsrc'] = val - - # height - # ------ - @property - def height(self): - """ - The height of cells. - - The 'height' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['height'] - - @height.setter - def height(self, val): - self['height'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 plot.ly for color - . - width - - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.table.cells.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # prefix - # ------ - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['prefix'] - - @prefix.setter - def prefix(self, val): - self['prefix'] = val - - # prefixsrc - # --------- - @property - def prefixsrc(self): - """ - Sets the source reference on plot.ly for prefix . - - The 'prefixsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['prefixsrc'] - - @prefixsrc.setter - def prefixsrc(self, val): - self['prefixsrc'] = val - - # suffix - # ------ - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['suffix'] - - @suffix.setter - def suffix(self, val): - self['suffix'] = val - - # suffixsrc - # --------- - @property - def suffixsrc(self): - """ - Sets the source reference on plot.ly for suffix . - - The 'suffixsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['suffixsrc'] - - @suffixsrc.setter - def suffixsrc(self, val): - self['suffixsrc'] = val - - # values - # ------ - @property - def values(self): - """ - Cell values. `values[m][n]` represents the value of the `n`th - point in column `m`, therefore the `values[m]` vector length - for all columns must be the same (longer vectors will be - truncated). Each value must be a finite number or a string. - - The 'values' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['values'] - - @values.setter - def values(self, val): - self['values'] = val - - # valuessrc - # --------- - @property - def valuessrc(self): - """ - Sets the source reference on plot.ly for values . - - The 'valuessrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['valuessrc'] - - @valuessrc.setter - def valuessrc(self, val): - self['valuessrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'table' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - align - Sets the horizontal alignment of the `text` within the - box. Has an effect only if `text` spans more two or - more lines (i.e. `text` contains one or more
HTML - tags) or if an explicit width is set to override the - text width. - alignsrc - Sets the source reference on plot.ly for align . - fill - plotly.graph_objs.table.cells.Fill instance or dict - with compatible properties - font - plotly.graph_objs.table.cells.Font instance or dict - with compatible properties - format - Sets the cell value formatting rule using d3 formatting - mini-language which is similar to those of Python. See - https://github.com/d3/d3-format/blob/master/README.md#l - ocale_format - formatsrc - Sets the source reference on plot.ly for format . - height - The height of cells. - line - plotly.graph_objs.table.cells.Line instance or dict - with compatible properties - prefix - Prefix for cell values. - prefixsrc - Sets the source reference on plot.ly for prefix . - suffix - Suffix for cell values. - suffixsrc - Sets the source reference on plot.ly for suffix . - values - Cell values. `values[m][n]` represents the value of the - `n`th point in column `m`, therefore the `values[m]` - vector length for all columns must be the same (longer - vectors will be truncated). Each value must be a finite - number or a string. - valuessrc - Sets the source reference on plot.ly for values . - """ - - def __init__( - self, - arg=None, - align=None, - alignsrc=None, - fill=None, - font=None, - format=None, - formatsrc=None, - height=None, - line=None, - prefix=None, - prefixsrc=None, - suffix=None, - suffixsrc=None, - values=None, - valuessrc=None, - **kwargs - ): - """ - Construct a new Cells object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.Cells - align - Sets the horizontal alignment of the `text` within the - box. Has an effect only if `text` spans more two or - more lines (i.e. `text` contains one or more
HTML - tags) or if an explicit width is set to override the - text width. - alignsrc - Sets the source reference on plot.ly for align . - fill - plotly.graph_objs.table.cells.Fill instance or dict - with compatible properties - font - plotly.graph_objs.table.cells.Font instance or dict - with compatible properties - format - Sets the cell value formatting rule using d3 formatting - mini-language which is similar to those of Python. See - https://github.com/d3/d3-format/blob/master/README.md#l - ocale_format - formatsrc - Sets the source reference on plot.ly for format . - height - The height of cells. - line - plotly.graph_objs.table.cells.Line instance or dict - with compatible properties - prefix - Prefix for cell values. - prefixsrc - Sets the source reference on plot.ly for prefix . - suffix - Suffix for cell values. - suffixsrc - Sets the source reference on plot.ly for suffix . - values - Cell values. `values[m][n]` represents the value of the - `n`th point in column `m`, therefore the `values[m]` - vector length for all columns must be the same (longer - vectors will be truncated). Each value must be a finite - number or a string. - valuessrc - Sets the source reference on plot.ly for values . - - Returns - ------- - Cells - """ - super(Cells, self).__init__('cells') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.table.Cells -constructor must be a dict or -an instance of plotly.graph_objs.table.Cells""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.table import (cells as v_cells) - - # Initialize validators - # --------------------- - self._validators['align'] = v_cells.AlignValidator() - self._validators['alignsrc'] = v_cells.AlignsrcValidator() - self._validators['fill'] = v_cells.FillValidator() - self._validators['font'] = v_cells.FontValidator() - self._validators['format'] = v_cells.FormatValidator() - self._validators['formatsrc'] = v_cells.FormatsrcValidator() - self._validators['height'] = v_cells.HeightValidator() - self._validators['line'] = v_cells.LineValidator() - self._validators['prefix'] = v_cells.PrefixValidator() - self._validators['prefixsrc'] = v_cells.PrefixsrcValidator() - self._validators['suffix'] = v_cells.SuffixValidator() - self._validators['suffixsrc'] = v_cells.SuffixsrcValidator() - self._validators['values'] = v_cells.ValuesValidator() - self._validators['valuessrc'] = v_cells.ValuessrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('align', None) - self['align'] = align if align is not None else _v - _v = arg.pop('alignsrc', None) - self['alignsrc'] = alignsrc if alignsrc is not None else _v - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('format', None) - self['format'] = format if format is not None else _v - _v = arg.pop('formatsrc', None) - self['formatsrc'] = formatsrc if formatsrc is not None else _v - _v = arg.pop('height', None) - self['height'] = height if height is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('prefix', None) - self['prefix'] = prefix if prefix is not None else _v - _v = arg.pop('prefixsrc', None) - self['prefixsrc'] = prefixsrc if prefixsrc is not None else _v - _v = arg.pop('suffix', None) - self['suffix'] = suffix if suffix is not None else _v - _v = arg.pop('suffixsrc', None) - self['suffixsrc'] = suffixsrc if suffixsrc is not None else _v - _v = arg.pop('values', None) - self['values'] = values if values is not None else _v - _v = arg.pop('valuessrc', None) - self['valuessrc'] = valuessrc if valuessrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/table/_domain.py b/plotly/graph_objs/table/_domain.py deleted file mode 100644 index 877141a4156..00000000000 --- a/plotly/graph_objs/table/_domain.py +++ /dev/null @@ -1,206 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Domain(BaseTraceHierarchyType): - - # column - # ------ - @property - 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] - - Returns - ------- - int - """ - return self['column'] - - @column.setter - def column(self, val): - self['column'] = val - - # row - # --- - @property - 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] - - Returns - ------- - int - """ - return self['row'] - - @row.setter - def row(self, val): - self['row'] = val - - # x - # - - @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] - - Returns - ------- - list - """ - return self['x'] - - @x.setter - def x(self, val): - self['x'] = val - - # y - # - - @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] - - Returns - ------- - list - """ - return self['y'] - - @y.setter - def y(self, val): - self['y'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'table' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - column - If there is a layout grid, use the domain for this - column in the grid for this table trace . - row - If there is a layout grid, use the domain for this row - in the grid for this table trace . - x - Sets the horizontal domain of this table trace (in plot - fraction). - y - Sets the vertical domain of this table trace (in plot - fraction). - """ - - def __init__( - self, arg=None, column=None, row=None, x=None, y=None, **kwargs - ): - """ - Construct a new Domain object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.Domain - column - If there is a layout grid, use the domain for this - column in the grid for this table trace . - row - If there is a layout grid, use the domain for this row - in the grid for this table trace . - x - Sets the horizontal domain of this table trace (in plot - fraction). - y - Sets the vertical domain of this table trace (in plot - fraction). - - Returns - ------- - Domain - """ - super(Domain, self).__init__('domain') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.table.Domain -constructor must be a dict or -an instance of plotly.graph_objs.table.Domain""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.table import (domain as v_domain) - - # Initialize validators - # --------------------- - self._validators['column'] = v_domain.ColumnValidator() - self._validators['row'] = v_domain.RowValidator() - self._validators['x'] = v_domain.XValidator() - self._validators['y'] = v_domain.YValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('column', None) - self['column'] = column if column is not None else _v - _v = arg.pop('row', None) - self['row'] = row if row is not None else _v - _v = arg.pop('x', None) - self['x'] = x if x is not None else _v - _v = arg.pop('y', None) - self['y'] = y if y is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/table/_header.py b/plotly/graph_objs/table/_header.py deleted file mode 100644 index ed28ad5a216..00000000000 --- a/plotly/graph_objs/table/_header.py +++ /dev/null @@ -1,568 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Header(BaseTraceHierarchyType): - - # align - # ----- - @property - def align(self): - """ - Sets the horizontal alignment of the `text` within the box. Has - an effect only if `text` spans more 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'] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - Any|numpy.ndarray - """ - return self['align'] - - @align.setter - def align(self, val): - self['align'] = val - - # alignsrc - # -------- - @property - def alignsrc(self): - """ - Sets the source reference on plot.ly for align . - - The 'alignsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['alignsrc'] - - @alignsrc.setter - def alignsrc(self, val): - self['alignsrc'] = val - - # fill - # ---- - @property - def fill(self): - """ - The 'fill' property is an instance of Fill - that may be specified as: - - An instance of 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 - array of colors. - colorsrc - Sets the source reference on plot.ly for color - . - - Returns - ------- - plotly.graph_objs.table.header.Fill - """ - return self['fill'] - - @fill.setter - def fill(self, val): - self['fill'] = val - - # font - # ---- - @property - def font(self): - """ - The 'font' property is an instance of Font - that may be specified as: - - An instance of 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.table.header.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # format - # ------ - @property - def format(self): - """ - Sets the cell value formatting rule using d3 formatting mini- - language which is similar to those of Python. See https://githu - b.com/d3/d3-format/blob/master/README.md#locale_format - - The 'format' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['format'] - - @format.setter - def format(self, val): - self['format'] = val - - # formatsrc - # --------- - @property - def formatsrc(self): - """ - Sets the source reference on plot.ly for format . - - The 'formatsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['formatsrc'] - - @formatsrc.setter - def formatsrc(self, val): - self['formatsrc'] = val - - # height - # ------ - @property - def height(self): - """ - The height of cells. - - The 'height' property is a number and may be specified as: - - An int or float - - Returns - ------- - int|float - """ - return self['height'] - - @height.setter - def height(self, val): - self['height'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 plot.ly for color - . - width - - widthsrc - Sets the source reference on plot.ly for width - . - - Returns - ------- - plotly.graph_objs.table.header.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # prefix - # ------ - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['prefix'] - - @prefix.setter - def prefix(self, val): - self['prefix'] = val - - # prefixsrc - # --------- - @property - def prefixsrc(self): - """ - Sets the source reference on plot.ly for prefix . - - The 'prefixsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['prefixsrc'] - - @prefixsrc.setter - def prefixsrc(self, val): - self['prefixsrc'] = val - - # suffix - # ------ - @property - 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 - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['suffix'] - - @suffix.setter - def suffix(self, val): - self['suffix'] = val - - # suffixsrc - # --------- - @property - def suffixsrc(self): - """ - Sets the source reference on plot.ly for suffix . - - The 'suffixsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['suffixsrc'] - - @suffixsrc.setter - def suffixsrc(self, val): - self['suffixsrc'] = val - - # values - # ------ - @property - def values(self): - """ - Header cell values. `values[m][n]` represents the value of the - `n`th point in column `m`, therefore the `values[m]` vector - length for all columns must be the same (longer vectors will be - truncated). Each value must be a finite number or a string. - - The 'values' property is an array that may be specified as a tuple, - list, numpy array, or pandas Series - - Returns - ------- - numpy.ndarray - """ - return self['values'] - - @values.setter - def values(self, val): - self['values'] = val - - # valuessrc - # --------- - @property - def valuessrc(self): - """ - Sets the source reference on plot.ly for values . - - The 'valuessrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['valuessrc'] - - @valuessrc.setter - def valuessrc(self, val): - self['valuessrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'table' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - align - Sets the horizontal alignment of the `text` within the - box. Has an effect only if `text` spans more two or - more lines (i.e. `text` contains one or more
HTML - tags) or if an explicit width is set to override the - text width. - alignsrc - Sets the source reference on plot.ly for align . - fill - plotly.graph_objs.table.header.Fill instance or dict - with compatible properties - font - plotly.graph_objs.table.header.Font instance or dict - with compatible properties - format - Sets the cell value formatting rule using d3 formatting - mini-language which is similar to those of Python. See - https://github.com/d3/d3-format/blob/master/README.md#l - ocale_format - formatsrc - Sets the source reference on plot.ly for format . - height - The height of cells. - line - plotly.graph_objs.table.header.Line instance or dict - with compatible properties - prefix - Prefix for cell values. - prefixsrc - Sets the source reference on plot.ly for prefix . - suffix - Suffix for cell values. - suffixsrc - Sets the source reference on plot.ly for suffix . - values - Header cell values. `values[m][n]` represents the value - of the `n`th point in column `m`, therefore the - `values[m]` vector length for all columns must be the - same (longer vectors will be truncated). Each value - must be a finite number or a string. - valuessrc - Sets the source reference on plot.ly for values . - """ - - def __init__( - self, - arg=None, - align=None, - alignsrc=None, - fill=None, - font=None, - format=None, - formatsrc=None, - height=None, - line=None, - prefix=None, - prefixsrc=None, - suffix=None, - suffixsrc=None, - values=None, - valuessrc=None, - **kwargs - ): - """ - Construct a new Header object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.Header - align - Sets the horizontal alignment of the `text` within the - box. Has an effect only if `text` spans more two or - more lines (i.e. `text` contains one or more
HTML - tags) or if an explicit width is set to override the - text width. - alignsrc - Sets the source reference on plot.ly for align . - fill - plotly.graph_objs.table.header.Fill instance or dict - with compatible properties - font - plotly.graph_objs.table.header.Font instance or dict - with compatible properties - format - Sets the cell value formatting rule using d3 formatting - mini-language which is similar to those of Python. See - https://github.com/d3/d3-format/blob/master/README.md#l - ocale_format - formatsrc - Sets the source reference on plot.ly for format . - height - The height of cells. - line - plotly.graph_objs.table.header.Line instance or dict - with compatible properties - prefix - Prefix for cell values. - prefixsrc - Sets the source reference on plot.ly for prefix . - suffix - Suffix for cell values. - suffixsrc - Sets the source reference on plot.ly for suffix . - values - Header cell values. `values[m][n]` represents the value - of the `n`th point in column `m`, therefore the - `values[m]` vector length for all columns must be the - same (longer vectors will be truncated). Each value - must be a finite number or a string. - valuessrc - Sets the source reference on plot.ly for values . - - Returns - ------- - Header - """ - super(Header, self).__init__('header') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.table.Header -constructor must be a dict or -an instance of plotly.graph_objs.table.Header""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.table import (header as v_header) - - # Initialize validators - # --------------------- - self._validators['align'] = v_header.AlignValidator() - self._validators['alignsrc'] = v_header.AlignsrcValidator() - self._validators['fill'] = v_header.FillValidator() - self._validators['font'] = v_header.FontValidator() - self._validators['format'] = v_header.FormatValidator() - self._validators['formatsrc'] = v_header.FormatsrcValidator() - self._validators['height'] = v_header.HeightValidator() - self._validators['line'] = v_header.LineValidator() - self._validators['prefix'] = v_header.PrefixValidator() - self._validators['prefixsrc'] = v_header.PrefixsrcValidator() - self._validators['suffix'] = v_header.SuffixValidator() - self._validators['suffixsrc'] = v_header.SuffixsrcValidator() - self._validators['values'] = v_header.ValuesValidator() - self._validators['valuessrc'] = v_header.ValuessrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('align', None) - self['align'] = align if align is not None else _v - _v = arg.pop('alignsrc', None) - self['alignsrc'] = alignsrc if alignsrc is not None else _v - _v = arg.pop('fill', None) - self['fill'] = fill if fill is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('format', None) - self['format'] = format if format is not None else _v - _v = arg.pop('formatsrc', None) - self['formatsrc'] = formatsrc if formatsrc is not None else _v - _v = arg.pop('height', None) - self['height'] = height if height is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('prefix', None) - self['prefix'] = prefix if prefix is not None else _v - _v = arg.pop('prefixsrc', None) - self['prefixsrc'] = prefixsrc if prefixsrc is not None else _v - _v = arg.pop('suffix', None) - self['suffix'] = suffix if suffix is not None else _v - _v = arg.pop('suffixsrc', None) - self['suffixsrc'] = suffixsrc if suffixsrc is not None else _v - _v = arg.pop('values', None) - self['values'] = values if values is not None else _v - _v = arg.pop('valuessrc', None) - self['valuessrc'] = valuessrc if valuessrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/table/_hoverlabel.py b/plotly/graph_objs/table/_hoverlabel.py deleted file mode 100644 index 72b7d92bded..00000000000 --- a/plotly/graph_objs/table/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.table.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'table' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.table.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.table.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.table import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/table/_stream.py b/plotly/graph_objs/table/_stream.py deleted file mode 100644 index dcf64275e5e..00000000000 --- a/plotly/graph_objs/table/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'table' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.table.Stream -constructor must be a dict or -an instance of plotly.graph_objs.table.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.table import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/table/cells/__init__.py b/plotly/graph_objs/table/cells/__init__.py index 2ec886325aa..6c3c4cdc960 100644 --- a/plotly/graph_objs/table/cells/__init__.py +++ b/plotly/graph_objs/table/cells/__init__.py @@ -1,3 +1,717 @@ -from ._line import Line -from ._font import Font -from ._fill import Fill + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # width + # ----- + @property + def width(self): + """ + The 'width' property is a number and may be specified as: + - An int or float + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'table.cells' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + width + + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.table.cells.Line + color + + colorsrc + Sets the source reference on plot.ly for color . + width + + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.table.cells.Line +constructor must be a dict or +an instance of plotly.graph_objs.table.cells.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.table.cells import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'table.cells' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.table.cells.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.table.cells.Font +constructor must be a dict or +an instance of plotly.graph_objs.table.cells.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.table.cells import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Fill(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'table.cells' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the cell fill color. It accepts either a specific + color or an array of colors or a 2D array of colors. + colorsrc + Sets the source reference on plot.ly for color . + """ + + def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): + """ + Construct a new Fill object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.table.cells.Fill + color + Sets the cell fill color. It accepts either a specific + color or an array of colors or a 2D array of colors. + colorsrc + Sets the source reference on plot.ly for color . + + Returns + ------- + Fill + """ + super(Fill, self).__init__('fill') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.table.cells.Fill +constructor must be a dict or +an instance of plotly.graph_objs.table.cells.Fill""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.table.cells import (fill as v_fill) + + # Initialize validators + # --------------------- + self._validators['color'] = v_fill.ColorValidator() + self._validators['colorsrc'] = v_fill.ColorsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/table/cells/_fill.py b/plotly/graph_objs/table/cells/_fill.py deleted file mode 100644 index b72e4ace772..00000000000 --- a/plotly/graph_objs/table/cells/_fill.py +++ /dev/null @@ -1,169 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Fill(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'table.cells' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the cell fill color. It accepts either a specific - color or an array of colors or a 2D array of colors. - colorsrc - Sets the source reference on plot.ly for color . - """ - - def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): - """ - Construct a new Fill object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.cells.Fill - color - Sets the cell fill color. It accepts either a specific - color or an array of colors or a 2D array of colors. - colorsrc - Sets the source reference on plot.ly for color . - - Returns - ------- - Fill - """ - super(Fill, self).__init__('fill') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.table.cells.Fill -constructor must be a dict or -an instance of plotly.graph_objs.table.cells.Fill""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.table.cells import (fill as v_fill) - - # Initialize validators - # --------------------- - self._validators['color'] = v_fill.ColorValidator() - self._validators['colorsrc'] = v_fill.ColorsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/table/cells/_font.py b/plotly/graph_objs/table/cells/_font.py deleted file mode 100644 index 37d80d3cc0f..00000000000 --- a/plotly/graph_objs/table/cells/_font.py +++ /dev/null @@ -1,317 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'table.cells' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.cells.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.table.cells.Font -constructor must be a dict or -an instance of plotly.graph_objs.table.cells.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.table.cells import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/table/cells/_line.py b/plotly/graph_objs/table/cells/_line.py deleted file mode 100644 index db6ea046d5b..00000000000 --- a/plotly/graph_objs/table/cells/_line.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # width - # ----- - @property - def width(self): - """ - The 'width' property is a number and may be specified as: - - An int or float - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'table.cells' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - width - - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.cells.Line - color - - colorsrc - Sets the source reference on plot.ly for color . - width - - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.table.cells.Line -constructor must be a dict or -an instance of plotly.graph_objs.table.cells.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.table.cells import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/table/header/__init__.py b/plotly/graph_objs/table/header/__init__.py index 2ec886325aa..58c0501ec04 100644 --- a/plotly/graph_objs/table/header/__init__.py +++ b/plotly/graph_objs/table/header/__init__.py @@ -1,3 +1,717 @@ -from ._line import Line -from ._font import Font -from ._fill import Fill + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # width + # ----- + @property + def width(self): + """ + The 'width' property is a number and may be specified as: + - An int or float + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # widthsrc + # -------- + @property + def widthsrc(self): + """ + Sets the source reference on plot.ly for width . + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['widthsrc'] + + @widthsrc.setter + def widthsrc(self, val): + self['widthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'table.header' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + width + + widthsrc + Sets the source reference on plot.ly for width . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + width=None, + widthsrc=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.table.header.Line + color + + colorsrc + Sets the source reference on plot.ly for color . + width + + widthsrc + Sets the source reference on plot.ly for width . + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.table.header.Line +constructor must be a dict or +an instance of plotly.graph_objs.table.header.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.table.header import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['colorsrc'] = v_line.ColorsrcValidator() + self._validators['width'] = v_line.WidthValidator() + self._validators['widthsrc'] = v_line.WidthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + _v = arg.pop('widthsrc', None) + self['widthsrc'] = widthsrc if widthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'table.header' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.table.header.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.table.header.Font +constructor must be a dict or +an instance of plotly.graph_objs.table.header.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.table.header import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Fill(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'table.header' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the cell fill color. It accepts either a specific + color or an array of colors or a 2D array of colors. + colorsrc + Sets the source reference on plot.ly for color . + """ + + def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): + """ + Construct a new Fill object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.table.header.Fill + color + Sets the cell fill color. It accepts either a specific + color or an array of colors or a 2D array of colors. + colorsrc + Sets the source reference on plot.ly for color . + + Returns + ------- + Fill + """ + super(Fill, self).__init__('fill') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.table.header.Fill +constructor must be a dict or +an instance of plotly.graph_objs.table.header.Fill""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.table.header import (fill as v_fill) + + # Initialize validators + # --------------------- + self._validators['color'] = v_fill.ColorValidator() + self._validators['colorsrc'] = v_fill.ColorsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/table/header/_fill.py b/plotly/graph_objs/table/header/_fill.py deleted file mode 100644 index 6e7747182a2..00000000000 --- a/plotly/graph_objs/table/header/_fill.py +++ /dev/null @@ -1,169 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Fill(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'table.header' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the cell fill color. It accepts either a specific - color or an array of colors or a 2D array of colors. - colorsrc - Sets the source reference on plot.ly for color . - """ - - def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): - """ - Construct a new Fill object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.header.Fill - color - Sets the cell fill color. It accepts either a specific - color or an array of colors or a 2D array of colors. - colorsrc - Sets the source reference on plot.ly for color . - - Returns - ------- - Fill - """ - super(Fill, self).__init__('fill') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.table.header.Fill -constructor must be a dict or -an instance of plotly.graph_objs.table.header.Fill""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.table.header import (fill as v_fill) - - # Initialize validators - # --------------------- - self._validators['color'] = v_fill.ColorValidator() - self._validators['colorsrc'] = v_fill.ColorsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/table/header/_font.py b/plotly/graph_objs/table/header/_font.py deleted file mode 100644 index 0d47a581e50..00000000000 --- a/plotly/graph_objs/table/header/_font.py +++ /dev/null @@ -1,317 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'table.header' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.header.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.table.header.Font -constructor must be a dict or -an instance of plotly.graph_objs.table.header.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.table.header import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/table/header/_line.py b/plotly/graph_objs/table/header/_line.py deleted file mode 100644 index 6b5818afb5a..00000000000 --- a/plotly/graph_objs/table/header/_line.py +++ /dev/null @@ -1,225 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # width - # ----- - @property - def width(self): - """ - The 'width' property is a number and may be specified as: - - An int or float - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # widthsrc - # -------- - @property - def widthsrc(self): - """ - Sets the source reference on plot.ly for width . - - The 'widthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['widthsrc'] - - @widthsrc.setter - def widthsrc(self, val): - self['widthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'table.header' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - width - - widthsrc - Sets the source reference on plot.ly for width . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - width=None, - widthsrc=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.header.Line - color - - colorsrc - Sets the source reference on plot.ly for color . - width - - widthsrc - Sets the source reference on plot.ly for width . - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.table.header.Line -constructor must be a dict or -an instance of plotly.graph_objs.table.header.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.table.header import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['colorsrc'] = v_line.ColorsrcValidator() - self._validators['width'] = v_line.WidthValidator() - self._validators['widthsrc'] = v_line.WidthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - _v = arg.pop('widthsrc', None) - self['widthsrc'] = widthsrc if widthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/table/hoverlabel/__init__.py b/plotly/graph_objs/table/hoverlabel/__init__.py index c37b8b5cd28..718d8da8091 100644 --- a/plotly/graph_objs/table/hoverlabel/__init__.py +++ b/plotly/graph_objs/table/hoverlabel/__init__.py @@ -1 +1,321 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'table.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.table.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.table.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.table.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.table.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/table/hoverlabel/_font.py b/plotly/graph_objs/table/hoverlabel/_font.py deleted file mode 100644 index 71ca9c9e0ef..00000000000 --- a/plotly/graph_objs/table/hoverlabel/_font.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'table.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.table.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.table.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.table.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.table.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/violin/__init__.py b/plotly/graph_objs/violin/__init__.py index 0cc26bb368a..d922ac71dbd 100644 --- a/plotly/graph_objs/violin/__init__.py +++ b/plotly/graph_objs/violin/__init__.py @@ -1,13 +1,1844 @@ -from ._unselected import Unselected + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. + + Returns + ------- + plotly.graph_objs.violin.unselected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'violin' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.violin.unselected.Marker instance or + dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.violin.Unselected + marker + plotly.graph_objs.violin.unselected.Marker instance or + dict with compatible properties + + Returns + ------- + Unselected + """ + super(Unselected, self).__init__('unselected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.violin.Unselected +constructor must be a dict or +an instance of plotly.graph_objs.violin.Unselected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.violin import (unselected as v_unselected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_unselected.MarkerValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + + # maxpoints + # --------- + @property + 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] + + Returns + ------- + int|float + """ + return self['maxpoints'] + + @maxpoints.setter + def maxpoints(self, val): + self['maxpoints'] = val + + # token + # ----- + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://plot.ly/settings for more details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self['token'] + + @token.setter + def token(self, val): + self['token'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'violin' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.violin.Stream + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://plot.ly/settings for more + details. + + Returns + ------- + Stream + """ + super(Stream, self).__init__('stream') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.violin.Stream +constructor must be a dict or +an instance of plotly.graph_objs.violin.Stream""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.violin import (stream as v_stream) + + # Initialize validators + # --------------------- + self._validators['maxpoints'] = v_stream.MaxpointsValidator() + self._validators['token'] = v_stream.TokenValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('maxpoints', None) + self['maxpoints'] = maxpoints if maxpoints is not None else _v + _v = arg.pop('token', None) + self['token'] = token if token is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + + # marker + # ------ + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of 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 + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + plotly.graph_objs.violin.selected.Marker + """ + return self['marker'] + + @marker.setter + def marker(self, val): + self['marker'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'violin' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + marker + plotly.graph_objs.violin.selected.Marker instance or + dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.violin.Selected + marker + plotly.graph_objs.violin.selected.Marker instance or + dict with compatible properties + + Returns + ------- + Selected + """ + super(Selected, self).__init__('selected') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.violin.Selected +constructor must be a dict or +an instance of plotly.graph_objs.violin.Selected""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.violin import (selected as v_selected) + + # Initialize validators + # --------------------- + self._validators['marker'] = v_selected.MarkerValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('marker', None) + self['marker'] = marker if marker is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Meanline(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # visible + # ------- + @property + def visible(self): + """ + Determines if a line corresponding to the sample's mean is + shown inside the violins. If `box.visible` is turned on, the + mean line is drawn inside the inner box. Otherwise, the mean + line is drawn from one side of the violin to other. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'violin' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the mean line color. + visible + Determines if a line corresponding to the sample's mean + is shown inside the violins. If `box.visible` is turned + on, the mean line is drawn inside the inner box. + Otherwise, the mean line is drawn from one side of the + violin to other. + width + Sets the mean line width. + """ + + def __init__( + self, arg=None, color=None, visible=None, width=None, **kwargs + ): + """ + Construct a new Meanline object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.violin.Meanline + color + Sets the mean line color. + visible + Determines if a line corresponding to the sample's mean + is shown inside the violins. If `box.visible` is turned + on, the mean line is drawn inside the inner box. + Otherwise, the mean line is drawn from one side of the + violin to other. + width + Sets the mean line width. + + Returns + ------- + Meanline + """ + super(Meanline, self).__init__('meanline') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.violin.Meanline +constructor must be a dict or +an instance of plotly.graph_objs.violin.Meanline""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.violin import (meanline as v_meanline) + + # Initialize validators + # --------------------- + self._validators['color'] = v_meanline.ColorValidator() + self._validators['visible'] = v_meanline.VisibleValidator() + self._validators['width'] = v_meanline.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + Sets themarkercolor. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + 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. + outliercolor + Sets the border line color of the outlier + sample points. Defaults to marker.color + outlierwidth + Sets the border line width (in px) of the + outlier sample points. + width + Sets the width (in px) of the lines bounding + the marker points. + + Returns + ------- + plotly.graph_objs.violin.marker.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # outliercolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outliercolor'] + + @outliercolor.setter + def outliercolor(self, val): + self['outliercolor'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # symbol + # ------ + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', + 315, 'hexagon2-open-dot', 16, 'octagon', 116, + 'octagon-open', 216, 'octagon-dot', 316, + 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, + 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, + 'hexagram-open', 218, 'hexagram-dot', 318, + 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', + 120, 'star-triangle-down-open', 220, + 'star-triangle-down-dot', 320, + 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, + 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, + 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, + 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, + 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, + 'line-nw-open'] + + Returns + ------- + Any + """ + return self['symbol'] + + @symbol.setter + def symbol(self, val): + self['symbol'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'violin' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + line + plotly.graph_objs.violin.marker.Line instance or dict + with compatible properties + opacity + Sets the marker opacity. + outliercolor + Sets the color of the outlier sample points. + size + Sets the marker size (in px). + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + """ + + def __init__( + self, + arg=None, + color=None, + line=None, + opacity=None, + outliercolor=None, + size=None, + symbol=None, + **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.violin.Marker + color + Sets themarkercolor. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + line + plotly.graph_objs.violin.marker.Line instance or dict + with compatible properties + opacity + Sets the marker opacity. + outliercolor + Sets the color of the outlier sample points. + size + Sets the marker size (in px). + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.violin.Marker +constructor must be a dict or +an instance of plotly.graph_objs.violin.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.violin import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['line'] = v_marker.LineValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['outliercolor'] = v_marker.OutliercolorValidator() + self._validators['size'] = v_marker.SizeValidator() + self._validators['symbol'] = v_marker.SymbolValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('outliercolor', None) + self['outliercolor'] = outliercolor if outliercolor is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('symbol', None) + self['symbol'] = symbol if symbol is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'violin' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of line bounding the violin(s). + width + Sets the width (in px) of line bounding the violin(s). + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.violin.Line + color + Sets the color of line bounding the violin(s). + width + Sets the width (in px) of line bounding the violin(s). + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.violin.Line +constructor must be a dict or +an instance of plotly.graph_objs.violin.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.violin import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + + # bgcolor + # ------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bgcolor'] + + @bgcolor.setter + def bgcolor(self, val): + self['bgcolor'] = val + + # bgcolorsrc + # ---------- + @property + def bgcolorsrc(self): + """ + Sets the source reference on plot.ly for bgcolor . + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bgcolorsrc'] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self['bgcolorsrc'] = val + + # bordercolor + # ----------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['bordercolor'] + + @bordercolor.setter + def bordercolor(self, val): + self['bordercolor'] = val + + # bordercolorsrc + # -------------- + @property + def bordercolorsrc(self): + """ + Sets the source reference on plot.ly for bordercolor . + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['bordercolorsrc'] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self['bordercolorsrc'] = val + + # font + # ---- + @property + 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 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 plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . + + Returns + ------- + plotly.graph_objs.violin.hoverlabel.Font + """ + return self['font'] + + @font.setter + def font(self, val): + self['font'] = val + + # namelength + # ---------- + @property + def namelength(self): + """ + Sets the length (in number of characters) of the trace name in + the hover labels for this trace. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is less than that + many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + 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] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self['namelength'] + + @namelength.setter + def namelength(self, val): + self['namelength'] = val + + # namelengthsrc + # ------------- + @property + def namelengthsrc(self): + """ + Sets the source reference on plot.ly for namelength . + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['namelengthsrc'] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self['namelengthsrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'violin' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.violin.Hoverlabel + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on plot.ly for bgcolor . + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on plot.ly for bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of the trace + name in the hover labels for this trace. -1 shows the + whole name regardless of length. 0-3 shows the first + 0-3 characters, and an integer >3 will show the whole + name if it is less than that many characters, but if it + is longer, will truncate to `namelength - 3` characters + and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for namelength . + + Returns + ------- + Hoverlabel + """ + super(Hoverlabel, self).__init__('hoverlabel') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.violin.Hoverlabel +constructor must be a dict or +an instance of plotly.graph_objs.violin.Hoverlabel""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.violin import (hoverlabel as v_hoverlabel) + + # Initialize validators + # --------------------- + self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() + self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() + self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() + self._validators['bordercolorsrc' + ] = v_hoverlabel.BordercolorsrcValidator() + self._validators['font'] = v_hoverlabel.FontValidator() + self._validators['namelength'] = v_hoverlabel.NamelengthValidator() + self._validators['namelengthsrc' + ] = v_hoverlabel.NamelengthsrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('bgcolor', None) + self['bgcolor'] = bgcolor if bgcolor is not None else _v + _v = arg.pop('bgcolorsrc', None) + self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v + _v = arg.pop('bordercolor', None) + self['bordercolor'] = bordercolor if bordercolor is not None else _v + _v = arg.pop('bordercolorsrc', None) + self['bordercolorsrc' + ] = bordercolorsrc if bordercolorsrc is not None else _v + _v = arg.pop('font', None) + self['font'] = font if font is not None else _v + _v = arg.pop('namelength', None) + self['namelength'] = namelength if namelength is not None else _v + _v = arg.pop('namelengthsrc', None) + self['namelengthsrc' + ] = namelengthsrc if namelengthsrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Box(_BaseTraceHierarchyType): + + # fillcolor + # --------- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['fillcolor'] + + @fillcolor.setter + def fillcolor(self, val): + self['fillcolor'] = val + + # line + # ---- + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of 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 + Sets the inner box plot bounding line width. + + Returns + ------- + plotly.graph_objs.violin.box.Line + """ + return self['line'] + + @line.setter + def line(self, val): + self['line'] = val + + # visible + # ------- + @property + 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) + + Returns + ------- + bool + """ + return self['visible'] + + @visible.setter + def visible(self, val): + self['visible'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'violin' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + fillcolor + Sets the inner box plot fill color. + line + plotly.graph_objs.violin.box.Line instance or dict with + compatible properties + visible + Determines if an miniature box plot is drawn inside the + violins. + width + Sets the width of the inner box plots relative to the + violins' width. For example, with 1, the inner box + plots are as wide as the violins. + """ + + def __init__( + self, + arg=None, + fillcolor=None, + line=None, + visible=None, + width=None, + **kwargs + ): + """ + Construct a new Box object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.violin.Box + fillcolor + Sets the inner box plot fill color. + line + plotly.graph_objs.violin.box.Line instance or dict with + compatible properties + visible + Determines if an miniature box plot is drawn inside the + violins. + width + Sets the width of the inner box plots relative to the + violins' width. For example, with 1, the inner box + plots are as wide as the violins. + + Returns + ------- + Box + """ + super(Box, self).__init__('box') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.violin.Box +constructor must be a dict or +an instance of plotly.graph_objs.violin.Box""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.violin import (box as v_box) + + # Initialize validators + # --------------------- + self._validators['fillcolor'] = v_box.FillcolorValidator() + self._validators['line'] = v_box.LineValidator() + self._validators['visible'] = v_box.VisibleValidator() + self._validators['width'] = v_box.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('fillcolor', None) + self['fillcolor'] = fillcolor if fillcolor is not None else _v + _v = arg.pop('line', None) + self['line'] = line if line is not None else _v + _v = arg.pop('visible', None) + self['visible'] = visible if visible is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False + + from plotly.graph_objs.violin import unselected -from ._stream import Stream -from ._selected import Selected from plotly.graph_objs.violin import selected -from ._meanline import Meanline -from ._marker import Marker from plotly.graph_objs.violin import marker -from ._line import Line -from ._hoverlabel import Hoverlabel from plotly.graph_objs.violin import hoverlabel -from ._box import Box from plotly.graph_objs.violin import box diff --git a/plotly/graph_objs/violin/_box.py b/plotly/graph_objs/violin/_box.py deleted file mode 100644 index 2cb36b92355..00000000000 --- a/plotly/graph_objs/violin/_box.py +++ /dev/null @@ -1,246 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Box(BaseTraceHierarchyType): - - # fillcolor - # --------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['fillcolor'] - - @fillcolor.setter - def fillcolor(self, val): - self['fillcolor'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - Sets the inner box plot bounding line width. - - Returns - ------- - plotly.graph_objs.violin.box.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # visible - # ------- - @property - 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) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'violin' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - fillcolor - Sets the inner box plot fill color. - line - plotly.graph_objs.violin.box.Line instance or dict with - compatible properties - visible - Determines if an miniature box plot is drawn inside the - violins. - width - Sets the width of the inner box plots relative to the - violins' width. For example, with 1, the inner box - plots are as wide as the violins. - """ - - def __init__( - self, - arg=None, - fillcolor=None, - line=None, - visible=None, - width=None, - **kwargs - ): - """ - Construct a new Box object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.Box - fillcolor - Sets the inner box plot fill color. - line - plotly.graph_objs.violin.box.Line instance or dict with - compatible properties - visible - Determines if an miniature box plot is drawn inside the - violins. - width - Sets the width of the inner box plots relative to the - violins' width. For example, with 1, the inner box - plots are as wide as the violins. - - Returns - ------- - Box - """ - super(Box, self).__init__('box') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.violin.Box -constructor must be a dict or -an instance of plotly.graph_objs.violin.Box""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.violin import (box as v_box) - - # Initialize validators - # --------------------- - self._validators['fillcolor'] = v_box.FillcolorValidator() - self._validators['line'] = v_box.LineValidator() - self._validators['visible'] = v_box.VisibleValidator() - self._validators['width'] = v_box.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('fillcolor', None) - self['fillcolor'] = fillcolor if fillcolor is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/violin/_hoverlabel.py b/plotly/graph_objs/violin/_hoverlabel.py deleted file mode 100644 index 19ee83b1d76..00000000000 --- a/plotly/graph_objs/violin/_hoverlabel.py +++ /dev/null @@ -1,414 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Hoverlabel(BaseTraceHierarchyType): - - # bgcolor - # ------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bgcolor'] - - @bgcolor.setter - def bgcolor(self, val): - self['bgcolor'] = val - - # bgcolorsrc - # ---------- - @property - def bgcolorsrc(self): - """ - Sets the source reference on plot.ly for bgcolor . - - The 'bgcolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bgcolorsrc'] - - @bgcolorsrc.setter - def bgcolorsrc(self, val): - self['bgcolorsrc'] = val - - # bordercolor - # ----------- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['bordercolor'] - - @bordercolor.setter - def bordercolor(self, val): - self['bordercolor'] = val - - # bordercolorsrc - # -------------- - @property - def bordercolorsrc(self): - """ - Sets the source reference on plot.ly for bordercolor . - - The 'bordercolorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['bordercolorsrc'] - - @bordercolorsrc.setter - def bordercolorsrc(self, val): - self['bordercolorsrc'] = val - - # font - # ---- - @property - 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 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 plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . - - Returns - ------- - plotly.graph_objs.violin.hoverlabel.Font - """ - return self['font'] - - @font.setter - def font(self, val): - self['font'] = val - - # namelength - # ---------- - @property - def namelength(self): - """ - Sets the length (in number of characters) of the trace name in - the hover labels for this trace. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is less than that - many characters, but if it is longer, will truncate to - `namelength - 3` characters and add an ellipsis. - - 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] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|numpy.ndarray - """ - return self['namelength'] - - @namelength.setter - def namelength(self, val): - self['namelength'] = val - - # namelengthsrc - # ------------- - @property - def namelengthsrc(self): - """ - Sets the source reference on plot.ly for namelength . - - The 'namelengthsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['namelengthsrc'] - - @namelengthsrc.setter - def namelengthsrc(self, val): - self['namelengthsrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'violin' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - """ - - def __init__( - self, - arg=None, - bgcolor=None, - bgcolorsrc=None, - bordercolor=None, - bordercolorsrc=None, - font=None, - namelength=None, - namelengthsrc=None, - **kwargs - ): - """ - Construct a new Hoverlabel object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.Hoverlabel - bgcolor - Sets the background color of the hover labels for this - trace - bgcolorsrc - Sets the source reference on plot.ly for bgcolor . - bordercolor - Sets the border color of the hover labels for this - trace. - bordercolorsrc - Sets the source reference on plot.ly for bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of the trace - name in the hover labels for this trace. -1 shows the - whole name regardless of length. 0-3 shows the first - 0-3 characters, and an integer >3 will show the whole - name if it is less than that many characters, but if it - is longer, will truncate to `namelength - 3` characters - and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for namelength . - - Returns - ------- - Hoverlabel - """ - super(Hoverlabel, self).__init__('hoverlabel') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.violin.Hoverlabel -constructor must be a dict or -an instance of plotly.graph_objs.violin.Hoverlabel""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.violin import (hoverlabel as v_hoverlabel) - - # Initialize validators - # --------------------- - self._validators['bgcolor'] = v_hoverlabel.BgcolorValidator() - self._validators['bgcolorsrc'] = v_hoverlabel.BgcolorsrcValidator() - self._validators['bordercolor'] = v_hoverlabel.BordercolorValidator() - self._validators['bordercolorsrc' - ] = v_hoverlabel.BordercolorsrcValidator() - self._validators['font'] = v_hoverlabel.FontValidator() - self._validators['namelength'] = v_hoverlabel.NamelengthValidator() - self._validators['namelengthsrc' - ] = v_hoverlabel.NamelengthsrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('bgcolor', None) - self['bgcolor'] = bgcolor if bgcolor is not None else _v - _v = arg.pop('bgcolorsrc', None) - self['bgcolorsrc'] = bgcolorsrc if bgcolorsrc is not None else _v - _v = arg.pop('bordercolor', None) - self['bordercolor'] = bordercolor if bordercolor is not None else _v - _v = arg.pop('bordercolorsrc', None) - self['bordercolorsrc' - ] = bordercolorsrc if bordercolorsrc is not None else _v - _v = arg.pop('font', None) - self['font'] = font if font is not None else _v - _v = arg.pop('namelength', None) - self['namelength'] = namelength if namelength is not None else _v - _v = arg.pop('namelengthsrc', None) - self['namelengthsrc' - ] = namelengthsrc if namelengthsrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/violin/_line.py b/plotly/graph_objs/violin/_line.py deleted file mode 100644 index b4acf2daec8..00000000000 --- a/plotly/graph_objs/violin/_line.py +++ /dev/null @@ -1,165 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'violin' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the color of line bounding the violin(s). - width - Sets the width (in px) of line bounding the violin(s). - """ - - def __init__(self, arg=None, color=None, width=None, **kwargs): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.Line - color - Sets the color of line bounding the violin(s). - width - Sets the width (in px) of line bounding the violin(s). - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.violin.Line -constructor must be a dict or -an instance of plotly.graph_objs.violin.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.violin import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/violin/_marker.py b/plotly/graph_objs/violin/_marker.py deleted file mode 100644 index b1867d1bd41..00000000000 --- a/plotly/graph_objs/violin/_marker.py +++ /dev/null @@ -1,427 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - Sets themarkercolor. It accepts either a specific color or an - array of numbers that are mapped to the colorscale relative to - the max and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # line - # ---- - @property - def line(self): - """ - The 'line' property is an instance of Line - that may be specified as: - - An instance of 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 - 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. - outliercolor - Sets the border line color of the outlier - sample points. Defaults to marker.color - outlierwidth - Sets the border line width (in px) of the - outlier sample points. - width - Sets the width (in px) of the lines bounding - the marker points. - - Returns - ------- - plotly.graph_objs.violin.marker.Line - """ - return self['line'] - - @line.setter - def line(self, val): - self['line'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # outliercolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outliercolor'] - - @outliercolor.setter - def outliercolor(self, val): - self['outliercolor'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # symbol - # ------ - @property - def symbol(self): - """ - Sets the marker symbol type. Adding 100 is equivalent to - appending "-open" to a symbol name. Adding 200 is equivalent to - appending "-dot" to a symbol name. Adding 300 is equivalent to - appending "-open-dot" or "dot-open" to a symbol name. - - The 'symbol' property is an enumeration that may be specified as: - - One of the following enumeration values: - [0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', - 315, 'hexagon2-open-dot', 16, 'octagon', 116, - 'octagon-open', 216, 'octagon-dot', 316, - 'octagon-open-dot', 17, 'star', 117, 'star-open', 217, - 'star-dot', 317, 'star-open-dot', 18, 'hexagram', 118, - 'hexagram-open', 218, 'hexagram-dot', 318, - 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', - 120, 'star-triangle-down-open', 220, - 'star-triangle-down-dot', 320, - 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, - 'y-down-open', 39, 'y-left', 139, 'y-left-open', 40, - 'y-right', 140, 'y-right-open', 41, 'line-ew', 141, - 'line-ew-open', 42, 'line-ns', 142, 'line-ns-open', 43, - 'line-ne', 143, 'line-ne-open', 44, 'line-nw', 144, - 'line-nw-open'] - - Returns - ------- - Any - """ - return self['symbol'] - - @symbol.setter - def symbol(self, val): - self['symbol'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'violin' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - line - plotly.graph_objs.violin.marker.Line instance or dict - with compatible properties - opacity - Sets the marker opacity. - outliercolor - Sets the color of the outlier sample points. - size - Sets the marker size (in px). - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - """ - - def __init__( - self, - arg=None, - color=None, - line=None, - opacity=None, - outliercolor=None, - size=None, - symbol=None, - **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.Marker - color - Sets themarkercolor. It accepts either a specific color - or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.cmin` and `marker.cmax` if - set. - line - plotly.graph_objs.violin.marker.Line instance or dict - with compatible properties - opacity - Sets the marker opacity. - outliercolor - Sets the color of the outlier sample points. - size - Sets the marker size (in px). - symbol - Sets the marker symbol type. Adding 100 is equivalent - to appending "-open" to a symbol name. Adding 200 is - equivalent to appending "-dot" to a symbol name. Adding - 300 is equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.violin.Marker -constructor must be a dict or -an instance of plotly.graph_objs.violin.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.violin import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['line'] = v_marker.LineValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['outliercolor'] = v_marker.OutliercolorValidator() - self._validators['size'] = v_marker.SizeValidator() - self._validators['symbol'] = v_marker.SymbolValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('line', None) - self['line'] = line if line is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('outliercolor', None) - self['outliercolor'] = outliercolor if outliercolor is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('symbol', None) - self['symbol'] = symbol if symbol is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/violin/_meanline.py b/plotly/graph_objs/violin/_meanline.py deleted file mode 100644 index 10a0c21b8ac..00000000000 --- a/plotly/graph_objs/violin/_meanline.py +++ /dev/null @@ -1,205 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Meanline(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # visible - # ------- - @property - def visible(self): - """ - Determines if a line corresponding to the sample's mean is - shown inside the violins. If `box.visible` is turned on, the - mean line is drawn inside the inner box. Otherwise, the mean - line is drawn from one side of the violin to other. - - The 'visible' property must be specified as a bool - (either True, or False) - - Returns - ------- - bool - """ - return self['visible'] - - @visible.setter - def visible(self, val): - self['visible'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'violin' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the mean line color. - visible - Determines if a line corresponding to the sample's mean - is shown inside the violins. If `box.visible` is turned - on, the mean line is drawn inside the inner box. - Otherwise, the mean line is drawn from one side of the - violin to other. - width - Sets the mean line width. - """ - - def __init__( - self, arg=None, color=None, visible=None, width=None, **kwargs - ): - """ - Construct a new Meanline object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.Meanline - color - Sets the mean line color. - visible - Determines if a line corresponding to the sample's mean - is shown inside the violins. If `box.visible` is turned - on, the mean line is drawn inside the inner box. - Otherwise, the mean line is drawn from one side of the - violin to other. - width - Sets the mean line width. - - Returns - ------- - Meanline - """ - super(Meanline, self).__init__('meanline') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.violin.Meanline -constructor must be a dict or -an instance of plotly.graph_objs.violin.Meanline""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.violin import (meanline as v_meanline) - - # Initialize validators - # --------------------- - self._validators['color'] = v_meanline.ColorValidator() - self._validators['visible'] = v_meanline.VisibleValidator() - self._validators['width'] = v_meanline.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('visible', None) - self['visible'] = visible if visible is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/violin/_selected.py b/plotly/graph_objs/violin/_selected.py deleted file mode 100644 index 097e01f48b0..00000000000 --- a/plotly/graph_objs/violin/_selected.py +++ /dev/null @@ -1,111 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Selected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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 - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - plotly.graph_objs.violin.selected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'violin' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.violin.selected.Marker instance or - dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, **kwargs): - """ - Construct a new Selected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.Selected - marker - plotly.graph_objs.violin.selected.Marker instance or - dict with compatible properties - - Returns - ------- - Selected - """ - super(Selected, self).__init__('selected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.violin.Selected -constructor must be a dict or -an instance of plotly.graph_objs.violin.Selected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.violin import (selected as v_selected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_selected.MarkerValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/violin/_stream.py b/plotly/graph_objs/violin/_stream.py deleted file mode 100644 index d97901c5dbe..00000000000 --- a/plotly/graph_objs/violin/_stream.py +++ /dev/null @@ -1,139 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Stream(BaseTraceHierarchyType): - - # maxpoints - # --------- - @property - 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] - - Returns - ------- - int|float - """ - return self['maxpoints'] - - @maxpoints.setter - def maxpoints(self, val): - self['maxpoints'] = val - - # token - # ----- - @property - def token(self): - """ - The stream id number links a data trace on a plot with a - stream. See https://plot.ly/settings for more details. - - The 'token' property is a string and must be specified as: - - A non-empty string - - Returns - ------- - str - """ - return self['token'] - - @token.setter - def token(self, val): - self['token'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'violin' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - """ - - def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): - """ - Construct a new Stream object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.Stream - maxpoints - Sets the maximum number of points to keep on the plots - from an incoming stream. If `maxpoints` is set to 50, - only the newest 50 points will be displayed on the - plot. - token - The stream id number links a data trace on a plot with - a stream. See https://plot.ly/settings for more - details. - - Returns - ------- - Stream - """ - super(Stream, self).__init__('stream') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.violin.Stream -constructor must be a dict or -an instance of plotly.graph_objs.violin.Stream""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.violin import (stream as v_stream) - - # Initialize validators - # --------------------- - self._validators['maxpoints'] = v_stream.MaxpointsValidator() - self._validators['token'] = v_stream.TokenValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('maxpoints', None) - self['maxpoints'] = maxpoints if maxpoints is not None else _v - _v = arg.pop('token', None) - self['token'] = token if token is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/violin/_unselected.py b/plotly/graph_objs/violin/_unselected.py deleted file mode 100644 index 09b76bc0d16..00000000000 --- a/plotly/graph_objs/violin/_unselected.py +++ /dev/null @@ -1,114 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Unselected(BaseTraceHierarchyType): - - # marker - # ------ - @property - def marker(self): - """ - The 'marker' property is an instance of Marker - that may be specified as: - - An instance of 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. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. - - Returns - ------- - plotly.graph_objs.violin.unselected.Marker - """ - return self['marker'] - - @marker.setter - def marker(self, val): - self['marker'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'violin' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - marker - plotly.graph_objs.violin.unselected.Marker instance or - dict with compatible properties - """ - - def __init__(self, arg=None, marker=None, **kwargs): - """ - Construct a new Unselected object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.Unselected - marker - plotly.graph_objs.violin.unselected.Marker instance or - dict with compatible properties - - Returns - ------- - Unselected - """ - super(Unselected, self).__init__('unselected') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.violin.Unselected -constructor must be a dict or -an instance of plotly.graph_objs.violin.Unselected""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.violin import (unselected as v_unselected) - - # Initialize validators - # --------------------- - self._validators['marker'] = v_unselected.MarkerValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('marker', None) - self['marker'] = marker if marker is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/violin/box/__init__.py b/plotly/graph_objs/violin/box/__init__.py index 471a5835d71..67aba9bd530 100644 --- a/plotly/graph_objs/violin/box/__init__.py +++ b/plotly/graph_objs/violin/box/__init__.py @@ -1 +1,167 @@ -from ._line import Line + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'violin.box' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the inner box plot bounding line color. + width + Sets the inner box plot bounding line width. + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.violin.box.Line + color + Sets the inner box plot bounding line color. + width + Sets the inner box plot bounding line width. + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.violin.box.Line +constructor must be a dict or +an instance of plotly.graph_objs.violin.box.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.violin.box import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/violin/box/_line.py b/plotly/graph_objs/violin/box/_line.py deleted file mode 100644 index 379e1783bf8..00000000000 --- a/plotly/graph_objs/violin/box/_line.py +++ /dev/null @@ -1,165 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'violin.box' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the inner box plot bounding line color. - width - Sets the inner box plot bounding line width. - """ - - def __init__(self, arg=None, color=None, width=None, **kwargs): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.box.Line - color - Sets the inner box plot bounding line color. - width - Sets the inner box plot bounding line width. - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.violin.box.Line -constructor must be a dict or -an instance of plotly.graph_objs.violin.box.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.violin.box import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/violin/hoverlabel/__init__.py b/plotly/graph_objs/violin/hoverlabel/__init__.py index c37b8b5cd28..2064cfcfb46 100644 --- a/plotly/graph_objs/violin/hoverlabel/__init__.py +++ b/plotly/graph_objs/violin/hoverlabel/__init__.py @@ -1 +1,321 @@ -from ._font import Font + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # colorsrc + # -------- + @property + def colorsrc(self): + """ + Sets the source reference on plot.ly for color . + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['colorsrc'] + + @colorsrc.setter + def colorsrc(self, val): + self['colorsrc'] = val + + # family + # ------ + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser will only be able to apply a font if + it is available on the system which it operates. Provide + multiple font families, separated by commas, to indicate the + preference in which to apply fonts if they aren't available on + the system. The plotly service (at https://plot.ly or on- + premise) generates images on a server, where only a select + number of fonts are installed and supported. These include + "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", + "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open + Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New + Roman". + + 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 + + Returns + ------- + str|numpy.ndarray + """ + return self['family'] + + @family.setter + def family(self, val): + self['family'] = val + + # familysrc + # --------- + @property + def familysrc(self): + """ + Sets the source reference on plot.ly for family . + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['familysrc'] + + @familysrc.setter + def familysrc(self, val): + self['familysrc'] = val + + # size + # ---- + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # sizesrc + # ------- + @property + def sizesrc(self): + """ + Sets the source reference on plot.ly for size . + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self['sizesrc'] + + @sizesrc.setter + def sizesrc(self, val): + self['sizesrc'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'violin.hoverlabel' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + **kwargs + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.violin.hoverlabel.Font + color + + colorsrc + Sets the source reference on plot.ly for color . + family + HTML font family - the typeface that will be applied by + the web browser. The web browser will only be able to + apply a font if it is available on the system which it + operates. Provide multiple font families, separated by + commas, to indicate the preference in which to apply + fonts if they aren't available on the system. The + plotly service (at https://plot.ly or on-premise) + generates images on a server, where only a select + number of fonts are installed and supported. These + include "Arial", "Balto", "Courier New", "Droid Sans",, + "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for family . + size + + sizesrc + Sets the source reference on plot.ly for size . + + Returns + ------- + Font + """ + super(Font, self).__init__('font') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.violin.hoverlabel.Font +constructor must be a dict or +an instance of plotly.graph_objs.violin.hoverlabel.Font""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.violin.hoverlabel import (font as v_font) + + # Initialize validators + # --------------------- + self._validators['color'] = v_font.ColorValidator() + self._validators['colorsrc'] = v_font.ColorsrcValidator() + self._validators['family'] = v_font.FamilyValidator() + self._validators['familysrc'] = v_font.FamilysrcValidator() + self._validators['size'] = v_font.SizeValidator() + self._validators['sizesrc'] = v_font.SizesrcValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('colorsrc', None) + self['colorsrc'] = colorsrc if colorsrc is not None else _v + _v = arg.pop('family', None) + self['family'] = family if family is not None else _v + _v = arg.pop('familysrc', None) + self['familysrc'] = familysrc if familysrc is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + _v = arg.pop('sizesrc', None) + self['sizesrc'] = sizesrc if sizesrc is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/violin/hoverlabel/_font.py b/plotly/graph_objs/violin/hoverlabel/_font.py deleted file mode 100644 index 594e90298c3..00000000000 --- a/plotly/graph_objs/violin/hoverlabel/_font.py +++ /dev/null @@ -1,319 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Font(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - The 'color' property is a color and may be specified as: - - A hex string (e.g. '#ff0000') - - An rgb/rgba string (e.g. 'rgb(255,0,0)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - A list or array of any of the above - - Returns - ------- - str|numpy.ndarray - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # colorsrc - # -------- - @property - def colorsrc(self): - """ - Sets the source reference on plot.ly for color . - - The 'colorsrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['colorsrc'] - - @colorsrc.setter - def colorsrc(self, val): - self['colorsrc'] = val - - # family - # ------ - @property - def family(self): - """ - HTML font family - the typeface that will be applied by the web - browser. The web browser will only be able to apply a font if - it is available on the system which it operates. Provide - multiple font families, separated by commas, to indicate the - preference in which to apply fonts if they aren't available on - the system. The plotly service (at https://plot.ly or on- - premise) generates images on a server, where only a select - number of fonts are installed and supported. These include - "Arial", "Balto", "Courier New", "Droid Sans",, "Droid Serif", - "Droid Sans Mono", "Gravitas One", "Old Standard TT", "Open - Sans", "Overpass", "PT Sans Narrow", "Raleway", "Times New - Roman". - - 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 - - Returns - ------- - str|numpy.ndarray - """ - return self['family'] - - @family.setter - def family(self, val): - self['family'] = val - - # familysrc - # --------- - @property - def familysrc(self): - """ - Sets the source reference on plot.ly for family . - - The 'familysrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['familysrc'] - - @familysrc.setter - def familysrc(self, val): - self['familysrc'] = val - - # size - # ---- - @property - def size(self): - """ - The 'size' property is a number and may be specified as: - - An int or float in the interval [1, inf] - - A tuple, list, or one-dimensional numpy array of the above - - Returns - ------- - int|float|numpy.ndarray - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # sizesrc - # ------- - @property - def sizesrc(self): - """ - Sets the source reference on plot.ly for size . - - The 'sizesrc' property must be specified as a string or - as a plotly.grid_objs.Column object - - Returns - ------- - str - """ - return self['sizesrc'] - - @sizesrc.setter - def sizesrc(self, val): - self['sizesrc'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'violin.hoverlabel' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - """ - - def __init__( - self, - arg=None, - color=None, - colorsrc=None, - family=None, - familysrc=None, - size=None, - sizesrc=None, - **kwargs - ): - """ - Construct a new Font object - - Sets the font used in hover labels. - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.hoverlabel.Font - color - - colorsrc - Sets the source reference on plot.ly for color . - family - HTML font family - the typeface that will be applied by - the web browser. The web browser will only be able to - apply a font if it is available on the system which it - operates. Provide multiple font families, separated by - commas, to indicate the preference in which to apply - fonts if they aren't available on the system. The - plotly service (at https://plot.ly or on-premise) - generates images on a server, where only a select - number of fonts are installed and supported. These - include "Arial", "Balto", "Courier New", "Droid Sans",, - "Droid Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for family . - size - - sizesrc - Sets the source reference on plot.ly for size . - - Returns - ------- - Font - """ - super(Font, self).__init__('font') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.violin.hoverlabel.Font -constructor must be a dict or -an instance of plotly.graph_objs.violin.hoverlabel.Font""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.violin.hoverlabel import (font as v_font) - - # Initialize validators - # --------------------- - self._validators['color'] = v_font.ColorValidator() - self._validators['colorsrc'] = v_font.ColorsrcValidator() - self._validators['family'] = v_font.FamilyValidator() - self._validators['familysrc'] = v_font.FamilysrcValidator() - self._validators['size'] = v_font.SizeValidator() - self._validators['sizesrc'] = v_font.SizesrcValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('colorsrc', None) - self['colorsrc'] = colorsrc if colorsrc is not None else _v - _v = arg.pop('family', None) - self['family'] = family if family is not None else _v - _v = arg.pop('familysrc', None) - self['familysrc'] = familysrc if familysrc is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - _v = arg.pop('sizesrc', None) - self['sizesrc'] = sizesrc if sizesrc is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/violin/marker/__init__.py b/plotly/graph_objs/violin/marker/__init__.py index 471a5835d71..828bcc78488 100644 --- a/plotly/graph_objs/violin/marker/__init__.py +++ b/plotly/graph_objs/violin/marker/__init__.py @@ -1 +1,287 @@ -from ._line import Line + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + + # color + # ----- + @property + def color(self): + """ + Sets themarker.linecolor. It accepts either a specific color or + an array of numbers that are mapped to the colorscale relative + to the max and min values of the array or relative to + `marker.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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # outliercolor + # ------------ + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['outliercolor'] + + @outliercolor.setter + def outliercolor(self, val): + self['outliercolor'] = val + + # outlierwidth + # ------------ + @property + 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] + + Returns + ------- + int|float + """ + return self['outlierwidth'] + + @outlierwidth.setter + def outlierwidth(self, val): + self['outlierwidth'] = val + + # width + # ----- + @property + 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] + + Returns + ------- + int|float + """ + return self['width'] + + @width.setter + def width(self, val): + self['width'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'violin.marker' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + outliercolor + Sets the border line color of the outlier sample + points. Defaults to marker.color + outlierwidth + Sets the border line width (in px) of the outlier + sample points. + width + Sets the width (in px) of the lines bounding the marker + points. + """ + + def __init__( + self, + arg=None, + color=None, + outliercolor=None, + outlierwidth=None, + width=None, + **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.violin.marker.Line + color + Sets themarker.linecolor. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + outliercolor + Sets the border line color of the outlier sample + points. Defaults to marker.color + outlierwidth + Sets the border line width (in px) of the outlier + sample points. + width + Sets the width (in px) of the lines bounding the marker + points. + + Returns + ------- + Line + """ + super(Line, self).__init__('line') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.violin.marker.Line +constructor must be a dict or +an instance of plotly.graph_objs.violin.marker.Line""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.violin.marker import (line as v_line) + + # Initialize validators + # --------------------- + self._validators['color'] = v_line.ColorValidator() + self._validators['outliercolor'] = v_line.OutliercolorValidator() + self._validators['outlierwidth'] = v_line.OutlierwidthValidator() + self._validators['width'] = v_line.WidthValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('outliercolor', None) + self['outliercolor'] = outliercolor if outliercolor is not None else _v + _v = arg.pop('outlierwidth', None) + self['outlierwidth'] = outlierwidth if outlierwidth is not None else _v + _v = arg.pop('width', None) + self['width'] = width if width is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/violin/marker/_line.py b/plotly/graph_objs/violin/marker/_line.py deleted file mode 100644 index 68ada6282bf..00000000000 --- a/plotly/graph_objs/violin/marker/_line.py +++ /dev/null @@ -1,285 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Line(BaseTraceHierarchyType): - - # color - # ----- - @property - def color(self): - """ - Sets themarker.linecolor. It accepts either a specific color or - an array of numbers that are mapped to the colorscale relative - to the max and min values of the array or relative to - `marker.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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # outliercolor - # ------------ - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['outliercolor'] - - @outliercolor.setter - def outliercolor(self, val): - self['outliercolor'] = val - - # outlierwidth - # ------------ - @property - 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] - - Returns - ------- - int|float - """ - return self['outlierwidth'] - - @outlierwidth.setter - def outlierwidth(self, val): - self['outlierwidth'] = val - - # width - # ----- - @property - 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] - - Returns - ------- - int|float - """ - return self['width'] - - @width.setter - def width(self, val): - self['width'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'violin.marker' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - outliercolor - Sets the border line color of the outlier sample - points. Defaults to marker.color - outlierwidth - Sets the border line width (in px) of the outlier - sample points. - width - Sets the width (in px) of the lines bounding the marker - points. - """ - - def __init__( - self, - arg=None, - color=None, - outliercolor=None, - outlierwidth=None, - width=None, - **kwargs - ): - """ - Construct a new Line object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.marker.Line - color - Sets themarker.linecolor. It accepts either a specific - color or an array of numbers that are mapped to the - colorscale relative to the max and min values of the - array or relative to `marker.line.cmin` and - `marker.line.cmax` if set. - outliercolor - Sets the border line color of the outlier sample - points. Defaults to marker.color - outlierwidth - Sets the border line width (in px) of the outlier - sample points. - width - Sets the width (in px) of the lines bounding the marker - points. - - Returns - ------- - Line - """ - super(Line, self).__init__('line') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.violin.marker.Line -constructor must be a dict or -an instance of plotly.graph_objs.violin.marker.Line""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.violin.marker import (line as v_line) - - # Initialize validators - # --------------------- - self._validators['color'] = v_line.ColorValidator() - self._validators['outliercolor'] = v_line.OutliercolorValidator() - self._validators['outlierwidth'] = v_line.OutlierwidthValidator() - self._validators['width'] = v_line.WidthValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('outliercolor', None) - self['outliercolor'] = outliercolor if outliercolor is not None else _v - _v = arg.pop('outlierwidth', None) - self['outlierwidth'] = outlierwidth if outlierwidth is not None else _v - _v = arg.pop('width', None) - self['width'] = width if width is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/violin/selected/__init__.py b/plotly/graph_objs/violin/selected/__init__.py index 0bda16c3500..c482552872b 100644 --- a/plotly/graph_objs/violin/selected/__init__.py +++ b/plotly/graph_objs/violin/selected/__init__.py @@ -1 +1,196 @@ -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'violin.selected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of plotly.graph_objs.violin.selected.Marker + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.violin.selected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.violin.selected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.violin.selected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/violin/selected/_marker.py b/plotly/graph_objs/violin/selected/_marker.py deleted file mode 100644 index 3251b69c141..00000000000 --- a/plotly/graph_objs/violin/selected/_marker.py +++ /dev/null @@ -1,194 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'violin.selected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of plotly.graph_objs.violin.selected.Marker - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.violin.selected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.violin.selected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.violin.selected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/graph_objs/violin/unselected/__init__.py b/plotly/graph_objs/violin/unselected/__init__.py index 0bda16c3500..1d523437397 100644 --- a/plotly/graph_objs/violin/unselected/__init__.py +++ b/plotly/graph_objs/violin/unselected/__init__.py @@ -1 +1,206 @@ -from ._marker import Marker + + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + + # color + # ----- + @property + 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)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: + aliceblue, antiquewhite, aqua, aquamarine, azure, + beige, bisque, black, blanchedalmond, blue, + blueviolet, brown, burlywood, cadetblue, + chartreuse, chocolate, coral, cornflowerblue, + cornsilk, crimson, cyan, darkblue, darkcyan, + darkgoldenrod, darkgray, darkgrey, darkgreen, + darkkhaki, darkmagenta, darkolivegreen, darkorange, + darkorchid, darkred, darksalmon, darkseagreen, + darkslateblue, darkslategray, darkslategrey, + darkturquoise, darkviolet, deeppink, deepskyblue, + dimgray, dimgrey, dodgerblue, firebrick, + floralwhite, forestgreen, fuchsia, gainsboro, + ghostwhite, gold, goldenrod, gray, grey, green, + greenyellow, honeydew, hotpink, indianred, indigo, + ivory, khaki, lavender, lavenderblush, lawngreen, + lemonchiffon, lightblue, lightcoral, lightcyan, + lightgoldenrodyellow, lightgray, lightgrey, + lightgreen, lightpink, lightsalmon, lightseagreen, + lightskyblue, lightslategray, lightslategrey, + lightsteelblue, lightyellow, lime, limegreen, + linen, magenta, maroon, mediumaquamarine, + mediumblue, mediumorchid, mediumpurple, + mediumseagreen, mediumslateblue, mediumspringgreen, + mediumturquoise, mediumvioletred, midnightblue, + mintcream, mistyrose, moccasin, navajowhite, navy, + oldlace, olive, olivedrab, orange, orangered, + orchid, palegoldenrod, palegreen, paleturquoise, + palevioletred, papayawhip, peachpuff, peru, pink, + plum, powderblue, purple, red, rosybrown, + royalblue, saddlebrown, salmon, sandybrown, + seagreen, seashell, sienna, silver, skyblue, + slateblue, slategray, slategrey, snow, springgreen, + steelblue, tan, teal, thistle, tomato, turquoise, + violet, wheat, white, whitesmoke, yellow, + yellowgreen + + Returns + ------- + str + """ + return self['color'] + + @color.setter + def color(self, val): + self['color'] = val + + # opacity + # ------- + @property + 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] + + Returns + ------- + int|float + """ + return self['opacity'] + + @opacity.setter + def opacity(self, val): + self['opacity'] = val + + # size + # ---- + @property + 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] + + Returns + ------- + int|float + """ + return self['size'] + + @size.setter + def size(self, val): + self['size'] = val + + # property parent name + # -------------------- + @property + def _parent_path_str(self): + return 'violin.unselected' + + # Self properties description + # --------------------------- + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__( + self, arg=None, color=None, opacity=None, size=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + plotly.graph_objs.violin.unselected.Marker + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super(Marker, self).__init__('marker') + + # Validate arg + # ------------ + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError( + """\ +The first argument to the plotly.graph_objs.violin.unselected.Marker +constructor must be a dict or +an instance of plotly.graph_objs.violin.unselected.Marker""" + ) + + # Handle skip_invalid + # ------------------- + self._skip_invalid = kwargs.pop('skip_invalid', False) + + # Import validators + # ----------------- + from plotly.validators.violin.unselected import (marker as v_marker) + + # Initialize validators + # --------------------- + self._validators['color'] = v_marker.ColorValidator() + self._validators['opacity'] = v_marker.OpacityValidator() + self._validators['size'] = v_marker.SizeValidator() + + # Populate data dict with properties + # ---------------------------------- + _v = arg.pop('color', None) + self['color'] = color if color is not None else _v + _v = arg.pop('opacity', None) + self['opacity'] = opacity if opacity is not None else _v + _v = arg.pop('size', None) + self['size'] = size if size is not None else _v + + # Process unknown kwargs + # ---------------------- + self._process_kwargs(**dict(arg, **kwargs)) + + # Reset skip_invalid + # ------------------ + self._skip_invalid = False diff --git a/plotly/graph_objs/violin/unselected/_marker.py b/plotly/graph_objs/violin/unselected/_marker.py deleted file mode 100644 index 222cd00bb8d..00000000000 --- a/plotly/graph_objs/violin/unselected/_marker.py +++ /dev/null @@ -1,204 +0,0 @@ -from plotly.basedatatypes import BaseTraceHierarchyType -import copy - - -class Marker(BaseTraceHierarchyType): - - # color - # ----- - @property - 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)') - - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') - - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') - - A named CSS color: - aliceblue, antiquewhite, aqua, aquamarine, azure, - beige, bisque, black, blanchedalmond, blue, - blueviolet, brown, burlywood, cadetblue, - chartreuse, chocolate, coral, cornflowerblue, - cornsilk, crimson, cyan, darkblue, darkcyan, - darkgoldenrod, darkgray, darkgrey, darkgreen, - darkkhaki, darkmagenta, darkolivegreen, darkorange, - darkorchid, darkred, darksalmon, darkseagreen, - darkslateblue, darkslategray, darkslategrey, - darkturquoise, darkviolet, deeppink, deepskyblue, - dimgray, dimgrey, dodgerblue, firebrick, - floralwhite, forestgreen, fuchsia, gainsboro, - ghostwhite, gold, goldenrod, gray, grey, green, - greenyellow, honeydew, hotpink, indianred, indigo, - ivory, khaki, lavender, lavenderblush, lawngreen, - lemonchiffon, lightblue, lightcoral, lightcyan, - lightgoldenrodyellow, lightgray, lightgrey, - lightgreen, lightpink, lightsalmon, lightseagreen, - lightskyblue, lightslategray, lightslategrey, - lightsteelblue, lightyellow, lime, limegreen, - linen, magenta, maroon, mediumaquamarine, - mediumblue, mediumorchid, mediumpurple, - mediumseagreen, mediumslateblue, mediumspringgreen, - mediumturquoise, mediumvioletred, midnightblue, - mintcream, mistyrose, moccasin, navajowhite, navy, - oldlace, olive, olivedrab, orange, orangered, - orchid, palegoldenrod, palegreen, paleturquoise, - palevioletred, papayawhip, peachpuff, peru, pink, - plum, powderblue, purple, red, rosybrown, - royalblue, saddlebrown, salmon, sandybrown, - seagreen, seashell, sienna, silver, skyblue, - slateblue, slategray, slategrey, snow, springgreen, - steelblue, tan, teal, thistle, tomato, turquoise, - violet, wheat, white, whitesmoke, yellow, - yellowgreen - - Returns - ------- - str - """ - return self['color'] - - @color.setter - def color(self, val): - self['color'] = val - - # opacity - # ------- - @property - 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] - - Returns - ------- - int|float - """ - return self['opacity'] - - @opacity.setter - def opacity(self, val): - self['opacity'] = val - - # size - # ---- - @property - 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] - - Returns - ------- - int|float - """ - return self['size'] - - @size.setter - def size(self, val): - self['size'] = val - - # property parent name - # -------------------- - @property - def _parent_path_str(self): - return 'violin.unselected' - - # Self properties description - # --------------------------- - @property - def _prop_descriptions(self): - return """\ - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - """ - - def __init__( - self, arg=None, color=None, opacity=None, size=None, **kwargs - ): - """ - Construct a new Marker object - - Parameters - ---------- - arg - dict of properties compatible with this constructor or - an instance of - plotly.graph_objs.violin.unselected.Marker - color - Sets the marker color of unselected points, applied - only when a selection exists. - opacity - Sets the marker opacity of unselected points, applied - only when a selection exists. - size - Sets the marker size of unselected points, applied only - when a selection exists. - - Returns - ------- - Marker - """ - super(Marker, self).__init__('marker') - - # Validate arg - # ------------ - if arg is None: - arg = {} - elif isinstance(arg, self.__class__): - arg = arg.to_plotly_json() - elif isinstance(arg, dict): - arg = copy.copy(arg) - else: - raise ValueError( - """\ -The first argument to the plotly.graph_objs.violin.unselected.Marker -constructor must be a dict or -an instance of plotly.graph_objs.violin.unselected.Marker""" - ) - - # Handle skip_invalid - # ------------------- - self._skip_invalid = kwargs.pop('skip_invalid', False) - - # Import validators - # ----------------- - from plotly.validators.violin.unselected import (marker as v_marker) - - # Initialize validators - # --------------------- - self._validators['color'] = v_marker.ColorValidator() - self._validators['opacity'] = v_marker.OpacityValidator() - self._validators['size'] = v_marker.SizeValidator() - - # Populate data dict with properties - # ---------------------------------- - _v = arg.pop('color', None) - self['color'] = color if color is not None else _v - _v = arg.pop('opacity', None) - self['opacity'] = opacity if opacity is not None else _v - _v = arg.pop('size', None) - self['size'] = size if size is not None else _v - - # Process unknown kwargs - # ---------------------- - self._process_kwargs(**dict(arg, **kwargs)) - - # Reset skip_invalid - # ------------------ - self._skip_invalid = False diff --git a/plotly/grid_objs.py b/plotly/grid_objs.py new file mode 100644 index 00000000000..939d8ff469f --- /dev/null +++ b/plotly/grid_objs.py @@ -0,0 +1,9 @@ +from __future__ import absolute_import + +from _plotly_future_ import _future_flags + + +if 'remove_deprecations' not in _future_flags: + from _plotly_future_ import _chart_studio_warning + _chart_studio_warning('grid_objs') + from chart_studio.grid_objs import * diff --git a/plotly/grid_objs/__init__.py b/plotly/grid_objs/__init__.py deleted file mode 100644 index bddd0a36482..00000000000 --- a/plotly/grid_objs/__init__.py +++ /dev/null @@ -1,8 +0,0 @@ -"""" -grid_objs -========= - -""" -from __future__ import absolute_import - -from plotly.grid_objs.grid_objs import Grid, Column diff --git a/plotly/grid_objs/grid_objs.py b/plotly/grid_objs/grid_objs.py deleted file mode 100644 index dabf49582b6..00000000000 --- a/plotly/grid_objs/grid_objs.py +++ /dev/null @@ -1,297 +0,0 @@ -""" -grid_objs -========= - -""" -from __future__ import absolute_import - -try: - from collections.abc import MutableSequence -except ImportError: - from collections import MutableSequence - -from requests.compat import json as _json - -from plotly import exceptions, optional_imports, utils - -pd = optional_imports.get_module('pandas') - -__all__ = None - - -class Column(object): - """ - Columns make up Plotly Grids and can be the source of - data for Plotly Graphs. - They have a name and an array of data. - They can be uploaded to Plotly with the `plotly.plotly.grid_ops` - class. - - Usage example 1: Upload a set of columns as a grid to Plotly - ``` - from plotly.grid_objs import Grid, Column - import plotly.plotly as py - column_1 = Column([1, 2, 3], 'time') - column_2 = Column([4, 2, 5], 'voltage') - grid = Grid([column_1, column_2]) - py.grid_ops.upload(grid, 'time vs voltage') - ``` - - Usage example 2: Make a graph based with data that is sourced - from a newly uploaded Plotly columns - ``` - import plotly.plotly as py - from plotly.grid_objs import Grid, Column - from plotly.graph_objs import Scatter - # Upload a grid - column_1 = Column([1, 2, 3], 'time') - column_2 = Column([4, 2, 5], 'voltage') - grid = Grid([column_1, column_2]) - py.grid_ops.upload(grid, 'time vs voltage') - - # Build a Plotly graph object sourced from the - # grid's columns - trace = Scatter(xsrc=grid[0], ysrc=grid[1]) - py.plot([trace], filename='graph from grid') - ``` - """ - def __init__(self, data, name): - """ - Initialize a Plotly column with `data` and `name`. - `data` is an array of strings, numbers, or dates. - `name` is the name of the column as it will apppear - in the Plotly grid. Names must be unique to a grid. - """ - - # TODO: data type checking - self.data = data - # TODO: name type checking - self.name = name - - self.id = '' - - def __str__(self): - max_chars = 10 - jdata = _json.dumps(self.data, cls=utils.PlotlyJSONEncoder) - if len(jdata) > max_chars: - data_string = jdata[:max_chars] + "...]" - else: - data_string = jdata - string = '' - return string.format(name=self.name, data=data_string, id=self.id) - - def __repr__(self): - return 'Column("{0}", {1})'.format(self.data, self.name) - - def to_plotly_json(self): - return {'name': self.name, 'data': self.data} - - -class Grid(MutableSequence): - """ - Grid is Plotly's Python representation of Plotly Grids. - Plotly Grids are tabular data made up of columns. They can be - uploaded, appended to, and can source the data for Plotly - graphs. - - A plotly.grid_objs.Grid object is essentially a list. - - Usage example 1: Upload a set of columns as a grid to Plotly - ``` - from plotly.grid_objs import Grid, Column - import plotly.plotly as py - column_1 = Column([1, 2, 3], 'time') - column_2 = Column([4, 2, 5], 'voltage') - grid = Grid([column_1, column_2]) - py.grid_ops.upload(grid, 'time vs voltage') - ``` - - Usage example 2: Make a graph based with data that is sourced - from a newly uploaded Plotly columns - ``` - import plotly.plotly as py - from plotly.grid_objs import Grid, Column - from plotly.graph_objs import Scatter - # Upload a grid - column_1 = Column([1, 2, 3], 'time') - column_2 = Column([4, 2, 5], 'voltage') - grid = Grid([column_1, column_2]) - py.grid_ops.upload(grid, 'time vs voltage') - - # Build a Plotly graph object sourced from the - # grid's columns - trace = Scatter(xsrc=grid[0], ysrc=grid[1]) - py.plot([trace], filename='graph from grid') - ``` - """ - def __init__(self, columns_or_json, fid=None): - """ - Initialize a grid with an iterable of `plotly.grid_objs.Column` - objects or a json/dict describing a grid. See second usage example - below for the necessary structure of the dict. - - :param (str|bool) fid: should not be accessible to users. Default - is 'None' but if a grid is retrieved via `py.get_grid()` then the - retrieved grid response will contain the fid which will be - necessary to set `self.id` and `self._columns.id` below. - - Example from iterable of columns: - ``` - column_1 = Column([1, 2, 3], 'time') - column_2 = Column([4, 2, 5], 'voltage') - grid = Grid([column_1, column_2]) - ``` - Example from json grid - ``` - grid_json = { - 'cols': { - 'time': {'data': [1, 2, 3], 'order': 0, 'uid': '4cd7fc'}, - 'voltage': {'data': [4, 2, 5], 'order': 1, 'uid': u'2744be'} - } - } - grid = Grid(grid_json) - ``` - """ - # TODO: verify that columns are actually columns - if pd and isinstance(columns_or_json, pd.DataFrame): - duplicate_name = utils.get_first_duplicate(columns_or_json.columns) - if duplicate_name: - err = exceptions.NON_UNIQUE_COLUMN_MESSAGE.format(duplicate_name) - raise exceptions.InputError(err) - - # create columns from dataframe - all_columns = [] - for name in columns_or_json.columns: - all_columns.append(Column(columns_or_json[name].tolist(), name)) - self._columns = all_columns - self.id = '' - - elif isinstance(columns_or_json, dict): - # check that fid is entered - if fid is None: - raise exceptions.PlotlyError( - "If you are manually converting a raw json/dict grid " - "into a Grid instance, you must ensure that 'fid' is " - "set to your file ID. This looks like 'username:187'." - ) - - self.id = fid - - # check if 'cols' is a root key - if 'cols' not in columns_or_json: - raise exceptions.PlotlyError( - "'cols' must be a root key in your json grid." - ) - - # check if 'data', 'order' and 'uid' are not in columns - grid_col_keys = ['data', 'order', 'uid'] - - for column_name in columns_or_json['cols']: - for key in grid_col_keys: - if key not in columns_or_json['cols'][column_name]: - raise exceptions.PlotlyError( - "Each column name of your dictionary must have " - "'data', 'order' and 'uid' as keys." - ) - # collect and sort all orders in case orders do not start - # at zero or there are jump discontinuities between them - all_orders = [] - for column_name in columns_or_json['cols'].keys(): - all_orders.append(columns_or_json['cols'][column_name]['order']) - all_orders.sort() - - # put columns in order in a list - ordered_columns = [] - for order in all_orders: - for column_name in columns_or_json['cols'].keys(): - if columns_or_json['cols'][column_name]['order'] == order: - break - - ordered_columns.append(Column( - columns_or_json['cols'][column_name]['data'], - column_name) - ) - self._columns = ordered_columns - - # fill in column_ids - for column in self: - column.id = self.id + ':' + columns_or_json['cols'][column.name]['uid'] - - else: - column_names = [column.name for column in columns_or_json] - duplicate_name = utils.get_first_duplicate(column_names) - if duplicate_name: - err = exceptions.NON_UNIQUE_COLUMN_MESSAGE.format(duplicate_name) - raise exceptions.InputError(err) - - self._columns = list(columns_or_json) - self.id = '' - - def __repr__(self): - return self._columns.__repr__() - - def __getitem__(self, index): - return self._columns[index] - - def __setitem__(self, index, column): - self._validate_insertion(column) - return self._columns.__setitem__(index, column) - - def __delitem__(self, index): - del self._columns[index] - - def __len__(self): - return len(self._columns) - - def insert(self, index, column): - self._validate_insertion(column) - self._columns.insert(index, column) - - def _validate_insertion(self, column): - """ - Raise an error if we're gonna add a duplicate column name - """ - existing_column_names = [col.name for col in self._columns] - if column.name in existing_column_names: - err = exceptions.NON_UNIQUE_COLUMN_MESSAGE.format(column.name) - raise exceptions.InputError(err) - - def _to_plotly_grid_json(self): - grid_json = {'cols': {}} - for column_index, column in enumerate(self): - grid_json['cols'][column.name] = { - 'data': column.data, - 'order': column_index - } - return grid_json - - def get_column(self, column_name): - """ Return the first column with name `column_name`. - If no column with `column_name` exists in this grid, return None. - """ - for column in self._columns: - if column.name == column_name: - return column - - def get_column_reference(self, column_name): - """ - Returns the column reference of given column in the grid by its name. - - Raises an error if the column name is not in the grid. Otherwise, - returns the fid:uid pair, which may be the empty string. - """ - column_id = None - for column in self._columns: - if column.name == column_name: - column_id = column.id - break - - if column_id is None: - col_names = [] - for column in self._columns: - col_names.append(column.name) - raise exceptions.PlotlyError( - "Whoops, that column name doesn't match any of the column " - "names in your grid. You must pick from {cols}".format(cols=col_names) - ) - return column_id diff --git a/plotly/io/_json.py b/plotly/io/_json.py index 8561fdc8bed..9ba129e16ba 100644 --- a/plotly/io/_json.py +++ b/plotly/io/_json.py @@ -3,7 +3,7 @@ from six import string_types import json -from plotly.utils import PlotlyJSONEncoder + from plotly.io._utils import (validate_coerce_fig_to_dict, validate_coerce_output_type) @@ -36,6 +36,8 @@ def to_json(fig, str Representation of figure as a JSON string """ + from _plotly_utils.utils import PlotlyJSONEncoder + # Validate figure # --------------- fig_dict = validate_coerce_fig_to_dict(fig, validate) diff --git a/plotly/io/_orca.py b/plotly/io/_orca.py index d51e5ed6b6d..e8642d8c128 100644 --- a/plotly/io/_orca.py +++ b/plotly/io/_orca.py @@ -11,10 +11,10 @@ from copy import copy from contextlib import contextmanager -import requests import retrying from six import string_types +import _plotly_utils.utils import plotly from plotly.files import PLOTLY_DIR, ensure_writable_plotly_dir from plotly.io._utils import validate_coerce_fig_to_dict @@ -707,7 +707,7 @@ def __repr__(self): constants --------- - plotlyjs: {plotlyjs} + plotlyjs: {plotlyjs} config_file: {config_file} """.format(port=self.port, @@ -822,7 +822,7 @@ def __repr__(self): port: {port} pid: {pid} command: {command} - + """.format(executable=self.executable, version=self.version, port=self.port, @@ -910,7 +910,7 @@ def validate_executable(): Alternatively, see other installation methods in the orca project README at https://github.com/plotly/orca. -After installation is complete, no further configuration should be needed. +After installation is complete, no further configuration should be needed. If you have installed orca, then for some reason plotly.py was unable to locate it. In this case, set the `plotly.io.orca.config.executable` @@ -922,7 +922,7 @@ def validate_executable(): If it is successful then you may want to save this configuration so that it will be applied automatically in future sessions. You can do this as follows: - >>> plotly.io.orca.config.save() + >>> plotly.io.orca.config.save() If you're still having trouble, feel free to ask for help on the forums at https://community.plot.ly/c/api/python @@ -1038,7 +1038,7 @@ def validate_executable(): The error encountered is that no version was reported by the orca executable. Here is the command that plotly.py ran to request the version: - $ {executable} --version + $ {executable} --version """.format(executable=executable)) else: version_result = version_result.decode() @@ -1153,7 +1153,7 @@ def ensure_server(): Install using pip: $ pip install psutil - + Install using conda: $ conda install psutil """) @@ -1224,12 +1224,13 @@ def request_image_with_retrying(**kwargs): Helper method to perform an image request to a running orca server process with retrying logic. """ + from requests import post server_url = 'http://{hostname}:{port}'.format( hostname='localhost', port=orca_state['port']) request_params = {k: v for k, v, in kwargs.items() if v is not None} - json_str = json.dumps(request_params, cls=plotly.utils.PlotlyJSONEncoder) - response = requests.post(server_url + '/', data=json_str) + json_str = json.dumps(request_params, cls=_plotly_utils.utils.PlotlyJSONEncoder) + response = post(server_url + '/', data=json_str) return response @@ -1351,7 +1352,7 @@ def to_image(fig, {info} plotly.py will attempt to start the local server process again the next time -an image export operation is performed. +an image export operation is performed. """.format(info=status_str)) # Check response @@ -1393,7 +1394,7 @@ def to_image(fig, >>> plotly.io.orca.config.mapbox_access_token = 'pk.abc...' -If you would like this token to be applied automatically in +If you would like this token to be applied automatically in future sessions, then save your orca configuration as follows: >>> plotly.io.orca.config.save() @@ -1402,9 +1403,9 @@ def to_image(fig, err_message += """ Exporting to EPS format requires the poppler library. You can install poppler on MacOS or Linux with: - + $ conda install poppler - + Or, you can install it on MacOS using homebrew with: $ brew install poppler @@ -1498,7 +1499,7 @@ def write_image(fig, For example: >>> import plotly.io as pio - >>> pio.write_image(fig, file_path, format='png') + >>> pio.write_image(fig, file_path, format='png') """.format(file=file)) # Request image diff --git a/plotly/io/_templates.py b/plotly/io/_templates.py index e6c25ce49e1..fd185e78f2c 100644 --- a/plotly/io/_templates.py +++ b/plotly/io/_templates.py @@ -1,12 +1,5 @@ from __future__ import absolute_import -from plotly.basedatatypes import BaseFigure -from plotly.graph_objs import Figure -from plotly.validators.layout import TemplateValidator -from plotly.graph_objs.layout import Template -from _plotly_utils.basevalidators import ( - CompoundValidator, CompoundArrayValidator, is_array) - import textwrap import pkgutil @@ -45,7 +38,7 @@ def __init__(self): for template_name in default_templates: self._templates[template_name] = Lazy - self._validator = TemplateValidator() + self._validator = None self._default = None # ### Magic methods ### @@ -62,6 +55,8 @@ def __iter__(self): def __getitem__(self, item): template = self._templates[item] if template is Lazy: + from plotly.graph_objs.layout import Template + # Load template from package data path = os.path.join('package_data', 'templates', item + '.json') template_str = pkgutil.get_data('plotly', path).decode('utf-8') @@ -72,7 +67,7 @@ def __getitem__(self, item): return template def __setitem__(self, key, value): - self._templates[key] = self._validator.validate_coerce(value) + self._templates[key] = self._validate(value) def __delitem__(self, key): # Remove template @@ -82,6 +77,13 @@ def __delitem__(self, key): if self._default == key: self._default = None + def _validate(self, value): + if not self._validator: + from plotly.validators.layout import TemplateValidator + self._validator = TemplateValidator() + + return self._validator.validate_coerce(value) + def keys(self): return self._templates.keys() @@ -133,7 +135,7 @@ def default(self, value): # Could be a Template object, the key of a registered template, # Or a string containing the names of multiple templates joined on # '+' characters - self._validator.validate_coerce(value) + self._validate(value) self._default = value def __repr__(self): @@ -190,6 +192,7 @@ def merge_templates(self, *args): if args: return reduce(self._merge_2_templates, args) else: + from plotly.graph_objs.layout import Template return Template() def _merge_2_templates(self, template1, template2): @@ -207,8 +210,8 @@ def _merge_2_templates(self, template1, template2): merged template """ # Validate/copy input templates - result = self._validator.validate_coerce(template1) - other = self._validator.validate_coerce(template2) + result = self._validate(template1) + other = self._validate(template2) # Cycle traces for trace_type in result.data: @@ -238,7 +241,6 @@ def _merge_2_templates(self, template1, template2): templates = TemplatesConfig() del TemplatesConfig - # Template utilities # ------------------ def walk_push_to_template(fig_obj, template_obj, skip): @@ -252,6 +254,9 @@ def walk_push_to_template(fig_obj, template_obj, skip): skip: set of str Set of names of properties to skip """ + from _plotly_utils.basevalidators import ( + CompoundValidator, CompoundArrayValidator, is_array) + for prop in list(fig_obj._props): if prop == 'template' or prop in skip: # Avoid infinite recursion @@ -395,6 +400,8 @@ def to_templated(fig, skip=('title', 'text')): """ # process fig + from plotly.basedatatypes import BaseFigure + from plotly.graph_objs import Figure if not isinstance(fig, BaseFigure): fig = Figure(fig) diff --git a/plotly/io/_utils.py b/plotly/io/_utils.py index bdf35b04094..1f4e117d5cd 100644 --- a/plotly/io/_utils.py +++ b/plotly/io/_utils.py @@ -31,4 +31,4 @@ def validate_coerce_output_type(output_type): raise ValueError(""" Invalid output type: {output_type} Must be one of: 'Figure', 'FigureWidget'""") - return cls \ No newline at end of file + return cls diff --git a/plotly/offline/offline.py b/plotly/offline/offline.py index 94a7fd07a27..2e30dd91b3f 100644 --- a/plotly/offline/offline.py +++ b/plotly/offline/offline.py @@ -6,23 +6,15 @@ from __future__ import absolute_import import os -import uuid import warnings import pkgutil -import time -import webbrowser - -import six -from requests.compat import json as _json - import plotly -from plotly import optional_imports, tools, utils -from plotly.exceptions import PlotlyError +import plotly.tools + +from plotly.optional_imports import get_module +from plotly import tools from ._plotlyjs_version import __plotlyjs_version__ -ipython = optional_imports.get_module('IPython') -ipython_display = optional_imports.get_module('IPython.display') -matplotlib = optional_imports.get_module('matplotlib') __IMAGE_FORMATS = ['jpeg', 'png', 'webp', 'svg'] @@ -165,13 +157,10 @@ def _get_jconfig(config): clean_config = config else: - config = plotly.plotly.get_config() - clean_config = dict((k, config[k]) for k in configkeys if k in config) + clean_config = {} + + plotly_platform_url = plotly.tools.get_config_plotly_server_url() - # TODO: The get_config 'source of truth' should - # really be somewhere other than plotly.plotly - plotly_platform_url = plotly.plotly.get_config().get('plotly_domain', - 'https://plot.ly') clean_config['plotlyServerURL'] = plotly_platform_url if (plotly_platform_url != 'https://plot.ly' and @@ -278,7 +267,7 @@ def init_notebook_mode(connected=False): where `connected=True`. """ import plotly.io as pio - + ipython = get_module('IPython') if not ipython: raise ImportError('`iplot` can only run inside an IPython Notebook.') @@ -361,6 +350,7 @@ def iplot(figure_or_data, show_link=False, link_text='Export to plot.ly', """ import plotly.io as pio + ipython = get_module('IPython') if not ipython: raise ImportError('`iplot` can only run inside an IPython Notebook.') @@ -653,7 +643,7 @@ def plot_mpl(mpl_fig, resize=False, strip_style=False, plot_mpl(fig, image='png') ``` """ - plotly_plot = tools.mpl_to_plotly(mpl_fig, resize, strip_style, verbose) + plotly_plot = plotly.tools.mpl_to_plotly(mpl_fig, resize, strip_style, verbose) return plot(plotly_plot, show_link, link_text, validate, output_type, include_plotlyjs, filename, auto_open, image=image, image_filename=image_filename, @@ -718,7 +708,7 @@ def iplot_mpl(mpl_fig, resize=False, strip_style=False, iplot_mpl(fig, image='jpeg') ``` """ - plotly_plot = tools.mpl_to_plotly(mpl_fig, resize, strip_style, verbose) + plotly_plot = plotly.tools.mpl_to_plotly(mpl_fig, resize, strip_style, verbose) return iplot(plotly_plot, show_link, link_text, validate, image=image, filename=image_filename, image_height=image_height, image_width=image_width) @@ -753,6 +743,8 @@ def enable_mpl_offline(resize=False, strip_style=False, ``` """ init_notebook_mode() + ipython = get_module('IPython') + matplotlib = get_module('matplotlib') ip = ipython.core.getipython.get_ipython() formatter = ip.display_formatter.formatters['text/html'] diff --git a/plotly/optional_imports.py b/plotly/optional_imports.py index 7f49d1fe26f..54a8302f1aa 100644 --- a/plotly/optional_imports.py +++ b/plotly/optional_imports.py @@ -1,31 +1 @@ -""" -Stand-alone module to provide information about whether optional deps exist. - -""" -from __future__ import absolute_import - -from importlib import import_module -import logging - -logger = logging.getLogger(__name__) -_not_importable = set() - - -def get_module(name): - """ - Return module or None. Absolute import is required. - - :param (str) name: Dot-separated module path. E.g., 'scipy.stats'. - :raise: (ImportError) Only when exc_msg is defined. - :return: (module|None) If import succeeds, the module will be returned. - - """ - if name not in _not_importable: - try: - return import_module(name) - except ImportError: - _not_importable.add(name) - except Exception as e: - _not_importable.add(name) - msg = "Error importing optional module {}".format(name) - logger.exception(msg) +from _plotly_utils.optional_imports import get_module diff --git a/plotly/plotly/__init__.py b/plotly/plotly/__init__.py index 15295ab9236..ebc18caf8f2 100644 --- a/plotly/plotly/__init__.py +++ b/plotly/plotly/__init__.py @@ -1,30 +1,8 @@ -""" -plotly -====== +from __future__ import absolute_import -This module defines functionality that requires interaction between your -local machine and Plotly. Almost all functionality used here will require a -verifiable account (username/api-key pair) and a network connection. +from _plotly_future_ import _future_flags -""" -from . plotly import ( - sign_in, - update_plot_options, - get_credentials, - iplot, - plot, - iplot_mpl, - plot_mpl, - get_figure, - Stream, - image, - grid_ops, - meta_ops, - file_ops, - get_config, - get_grid, - dashboard_ops, - presentation_ops, - create_animations, - icreate_animations -) +if 'remove_deprecations' not in _future_flags: + from _plotly_future_ import _chart_studio_warning + _chart_studio_warning('plotly') + from chart_studio.plotly import * \ No newline at end of file diff --git a/plotly/plotly/chunked_requests.py b/plotly/plotly/chunked_requests.py new file mode 100644 index 00000000000..a2ec4e4179b --- /dev/null +++ b/plotly/plotly/chunked_requests.py @@ -0,0 +1,5 @@ +from __future__ import absolute_import + +from _plotly_future_ import _chart_studio_warning +_chart_studio_warning('plotly.chunked_requests') +from chart_studio.plotly.chunked_requests import * diff --git a/plotly/presentation_objs.py b/plotly/presentation_objs.py new file mode 100644 index 00000000000..d176ccc1de0 --- /dev/null +++ b/plotly/presentation_objs.py @@ -0,0 +1,5 @@ +from __future__ import absolute_import + +from _plotly_future_ import _chart_studio_warning +_chart_studio_warning('presentation_objs') +from chart_studio.presentation_objs import * diff --git a/plotly/presentation_objs/presentation_objs.py b/plotly/presentation_objs/presentation_objs.py deleted file mode 100644 index 5f91c2e5192..00000000000 --- a/plotly/presentation_objs/presentation_objs.py +++ /dev/null @@ -1,1176 +0,0 @@ -""" -dashboard_objs -========== - -A module for creating and manipulating spectacle-presentation dashboards. -""" - -import copy -import random -import re -import string -import warnings - -from plotly import exceptions -from plotly.config import get_config - -HEIGHT = 700.0 -WIDTH = 1000.0 - -CODEPANE_THEMES = ['tomorrow', 'tomorrowNight'] - -VALID_LANGUAGES = ['cpp', 'cs', 'css', 'fsharp', 'go', 'haskell', 'java', - 'javascript', 'jsx', 'julia', 'xml', 'matlab', 'php', - 'python', 'r', 'ruby', 'scala', 'sql', 'yaml'] - -VALID_TRANSITIONS = ['slide', 'zoom', 'fade', 'spin'] - -PRES_THEMES = ['moods', 'martik'] - -VALID_GROUPTYPES = [ - 'leftgroup_v', 'rightgroup_v', 'middle', 'checkerboard_topleft', - 'checkerboard_topright' -] - -fontWeight_dict = { - 'Thin': {'fontWeight': 100}, - 'Thin Italic': {'fontWeight': 100, 'fontStyle': 'italic'}, - 'Light': {'fontWeight': 300}, - 'Light Italic': {'fontWeight': 300, 'fontStyle': 'italic'}, - 'Regular': {'fontWeight': 400}, - 'Regular Italic': {'fontWeight': 400, 'fontStyle': 'italic'}, - 'Medium': {'fontWeight': 500}, - 'Medium Italic': {'fontWeight': 500, 'fontStyle': 'italic'}, - 'Bold': {'fontWeight': 700}, - 'Bold Italic': {'fontWeight': 700, 'fontStyle': 'italic'}, - 'Black': {'fontWeight': 900}, - 'Black Italic': {'fontWeight': 900, 'fontStyle': 'italic'}, -} - - -def list_of_options(iterable, conj='and', period=True): - """ - Returns an English listing of objects seperated by commas ',' - - For example, ['foo', 'bar', 'baz'] becomes 'foo, bar and baz' - if the conjunction 'and' is selected. - """ - if len(iterable) < 2: - raise exceptions.PlotlyError( - 'Your list or tuple must contain at least 2 items.' - ) - template = (len(iterable) - 2)*'{}, ' + '{} ' + conj + ' {}' + period*'.' - return template.format(*iterable) - - -# Error Messages -STYLE_ERROR = "Your presentation style must be {}".format( - list_of_options(PRES_THEMES, conj='or', period=True) -) - -CODE_ENV_ERROR = ( - "If you are putting a block of code into your markdown " - "presentation, make sure your denote the start and end " - "of the code environment with the '```' characters. For " - "example, your markdown string would include something " - "like:\n\n```python\nx = 2\ny = 1\nprint x\n```\n\n" - "Notice how the language that you want the code to be " - "displayed in is immediately to the right of first " - "entering '```', i.e. '```python'." -) - -LANG_ERROR = ( - "The language of your code block should be " - "clearly indicated after the first ``` that " - "begins the code block. The valid languages to " - "choose from are" + list_of_options( - VALID_LANGUAGES - ) -) - - -def _generate_id(size): - letters_and_numbers = string.ascii_letters - for num in range(10): - letters_and_numbers += str(num) - letters_and_numbers += str(num) - id_str = '' - for _ in range(size): - id_str += random.choice(list(letters_and_numbers)) - - return id_str - - -paragraph_styles = { - 'Body': { - 'color': '#3d3d3d', - 'fontFamily': 'Open Sans', - 'fontSize': 11, - 'fontStyle': 'normal', - 'fontWeight': 400, - 'lineHeight': 'normal', - 'minWidth': 20, - 'opacity': 1, - 'textAlign': 'center', - 'textDecoration': 'none', - 'wordBreak': 'break-word' - }, - 'Body Small': { - 'color': '#3d3d3d', - 'fontFamily': 'Open Sans', - 'fontSize': 10, - 'fontStyle': 'normal', - 'fontWeight': 400, - 'lineHeight': 'normal', - 'minWidth': 20, - 'opacity': 1, - 'textAlign': 'center', - 'textDecoration': 'none' - }, - 'Caption': { - 'color': '#3d3d3d', - 'fontFamily': 'Open Sans', - 'fontSize': 11, - 'fontStyle': 'italic', - 'fontWeight': 400, - 'lineHeight': 'normal', - 'minWidth': 20, - 'opacity': 1, - 'textAlign': 'center', - 'textDecoration': 'none' - }, - 'Heading 1': { - 'color': '#3d3d3d', - 'fontFamily': 'Open Sans', - 'fontSize': 26, - 'fontStyle': 'normal', - 'fontWeight': 400, - 'lineHeight': 'normal', - 'minWidth': 20, - 'opacity': 1, - 'textAlign': 'center', - 'textDecoration': 'none', - }, - 'Heading 2': { - 'color': '#3d3d3d', - 'fontFamily': 'Open Sans', - 'fontSize': 20, - 'fontStyle': 'normal', - 'fontWeight': 400, - 'lineHeight': 'normal', - 'minWidth': 20, - 'opacity': 1, - 'textAlign': 'center', - 'textDecoration': 'none' - }, - 'Heading 3': { - 'color': '#3d3d3d', - 'fontFamily': 'Open Sans', - 'fontSize': 11, - 'fontStyle': 'normal', - 'fontWeight': 700, - 'lineHeight': 'normal', - 'minWidth': 20, - 'opacity': 1, - 'textAlign': 'center', - 'textDecoration': 'none' - } -} - - -def _empty_slide(transition, id): - empty_slide = {'children': [], - 'id': id, - 'props': {'style': {}, 'transition': transition}} - return empty_slide - - -def _box(boxtype, text_or_url, left, top, height, width, id, props_attr, - style_attr, paragraphStyle): - children_list = [] - fontFamily = "Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace" - if boxtype == 'Text': - children_list = text_or_url.split('\n') - - props = { - 'isQuote': False, - 'listType': None, - 'paragraphStyle': paragraphStyle, - 'size': 4, - 'style': copy.deepcopy(paragraph_styles[paragraphStyle]) - } - - props['style'].update( - {'height': height, - 'left': left, - 'top': top, - 'width': width, - 'position': 'absolute'} - ) - - elif boxtype == 'Image': - # height, width are set to default 512 - # as set by the Presentation Editor - props = { - 'height': 512, - 'imageName': None, - 'src': text_or_url, - 'style': {'height': height, - 'left': left, - 'opacity': 1, - 'position': 'absolute', - 'top': top, - 'width': width}, - 'width': 512 - } - elif boxtype == 'Plotly': - if '?share_key' in text_or_url: - src = text_or_url - else: - src = text_or_url + '.embed?link=false' - props = { - 'frameBorder': 0, - 'scrolling': 'no', - 'src': src, - 'style': {'height': height, - 'left': left, - 'position': 'absolute', - 'top': top, - 'width': width} - } - elif boxtype == 'CodePane': - props = { - 'language': 'python', - 'source': text_or_url, - 'style': {'fontFamily': fontFamily, - 'fontSize': 13, - 'height': height, - 'left': left, - 'margin': 0, - 'position': 'absolute', - 'textAlign': 'left', - 'top': top, - 'width': width}, - 'theme': 'tomorrowNight' - } - - # update props and style attributes - for item in props_attr.items(): - props[item[0]] = item[1] - for item in style_attr.items(): - props['style'][item[0]] = item[1] - - child = { - 'children': children_list, - 'id': id, - 'props': props, - 'type': boxtype - } - - if boxtype == 'Text': - child['defaultHeight'] = 36 - child['defaultWidth'] = 52 - child['resizeVertical'] = False - if boxtype == 'CodePane': - child['defaultText'] = 'Code' - - return child - - -def _percentage_to_pixel(value, side): - if side == 'left': - return WIDTH * (0.01 * value) - elif side == 'top': - return HEIGHT * (0.01 * value) - elif side == 'height': - return HEIGHT * (0.01 * value) - elif side == 'width': - return WIDTH * (0.01 * value) - - -def _return_box_position(left, top, height, width): - values_dict = { - 'left': left, - 'top': top, - 'height': height, - 'width': width, - } - for key in iter(values_dict): - if isinstance(values_dict[key], str): - var = float(values_dict[key][: -2]) - else: - var = _percentage_to_pixel(values_dict[key], key) - values_dict[key] = var - - return (values_dict['left'], values_dict['top'], - values_dict['height'], values_dict['width']) - - -def _remove_extra_whitespace_from_line(line): - line = line.lstrip() - line = line.rstrip() - return line - - -def _list_of_slides(markdown_string): - if not markdown_string.endswith('\n---\n'): - markdown_string += '\n---\n' - - text_blocks = re.split('\n-{2,}\n', markdown_string) - - list_of_slides = [] - for text in text_blocks: - if not all(char in ['\n', '-', ' '] for char in text): - list_of_slides.append(text) - - if '\n-\n' in markdown_string: - msg = ("You have at least one '-' by itself on its own line in your " - "markdown string. If you are trying to denote a new slide, " - "make sure that the line has 3 '-'s like this: \n\n---\n\n" - "A new slide will NOT be created here.") - warnings.warn(msg) - - return list_of_slides - - -def _top_spec_for_text_at_bottom(text_block, width_per, per_from_bottom=0, - min_top=30): - # This function ensures that if there is a large block of - # text in your slide it will not overflow off the bottom - # of the slide. - # The input for this function are a block of text and the - # params that define where it will be placed in the slide. - # The function makes some calculations and will output a - # 'top' value (i.e. the left, top, height, width css params) - # so that the text block will come down to some specified - # distance from the bottom of the page. - - # TODO: customize this function for different fonts/sizes - max_lines = 37 - one_char_percent_width = 0.764 - chars_in_full_line = width_per / one_char_percent_width - - num_of_lines = 0 - char_group = 0 - for char in text_block: - if char == '\n': - num_of_lines += 1 - char_group = 0 - else: - if char_group >= chars_in_full_line: - char_group = 0 - num_of_lines += 1 - else: - char_group += 1 - - num_of_lines += 1 - top_frac = (max_lines - num_of_lines) / float(max_lines) - top = top_frac * 100 - per_from_bottom - - # to be safe - return max(top, min_top) - - -def _box_specs_gen(num_of_boxes, grouptype='leftgroup_v', width_range=50, - height_range=50, margin=2, betw_boxes=4, middle_center=50): - # the (left, top, width, height) specs - # are added to specs_for_boxes - specs_for_boxes = [] - if num_of_boxes == 1 and grouptype in ['leftgroup_v', 'rightgroup_v']: - if grouptype == 'rightgroup_v': - left_shift = (100 - width_range) - else: - left_shift = 0 - - box_spec = ( - left_shift + (margin / WIDTH) * 100, - (margin / HEIGHT) * 100, - 100 - (2 * margin / HEIGHT * 100), - width_range - (2 * margin / WIDTH) * 100 - ) - specs_for_boxes.append(box_spec) - - elif num_of_boxes > 1 and grouptype in ['leftgroup_v', 'rightgroup_v']: - if grouptype == 'rightgroup_v': - left_shift = (100 - width_range) - else: - left_shift = 0 - - if num_of_boxes % 2 == 0: - box_width_px = 0.5 * ( - (float(width_range)/100) * WIDTH - 2 * margin - betw_boxes - ) - box_width = (box_width_px / WIDTH) * 100 - - height = (200.0 / (num_of_boxes * HEIGHT)) * ( - HEIGHT - (num_of_boxes / 2 - 1) * betw_boxes - 2 * margin - ) - - left1 = left_shift + (margin / WIDTH) * 100 - left2 = left_shift + ( - ((margin + betw_boxes) / WIDTH) * 100 + box_width - ) - for left in [left1, left2]: - for j in range(int(num_of_boxes / 2)): - top = (margin * 100 / HEIGHT) + j * ( - height + (betw_boxes * 100 / HEIGHT) - ) - specs = ( - left, - top, - height, - box_width - ) - specs_for_boxes.append(specs) - - if num_of_boxes % 2 == 1: - width = width_range - (200 * margin) / WIDTH - height = (100.0 / (num_of_boxes * HEIGHT)) * ( - HEIGHT - (num_of_boxes - 1) * betw_boxes - 2 * margin - ) - left = left_shift + (margin / WIDTH) * 100 - for j in range(num_of_boxes): - top = (margin / HEIGHT) * 100 + j * ( - height + (betw_boxes / HEIGHT) * 100 - ) - specs = ( - left, - top, - height, - width - ) - specs_for_boxes.append(specs) - - elif grouptype == 'middle': - top = float(middle_center - (height_range / 2)) - height = height_range - width = (1 / float(num_of_boxes)) * ( - width_range - (num_of_boxes - 1) * (100*betw_boxes/WIDTH) - ) - for j in range(num_of_boxes): - left = ((100 - float(width_range)) / 2) + j * ( - width + (betw_boxes / WIDTH) * 100 - ) - specs = (left, top, height, width) - specs_for_boxes.append(specs) - - elif 'checkerboard' in grouptype and num_of_boxes == 2: - if grouptype == 'checkerboard_topleft': - for j in range(2): - left = j * 50 - top = j * 50 - height = 50 - width = 50 - specs = ( - left, - top, - height, - width - ) - specs_for_boxes.append(specs) - else: - for j in range(2): - left = 50 * (1 - j) - top = j * 50 - height = 50 - width = 50 - specs = ( - left, - top, - height, - width - ) - specs_for_boxes.append(specs) - return specs_for_boxes - - -def _return_layout_specs(num_of_boxes, url_lines, title_lines, text_block, - code_blocks, slide_num, style): - # returns specs of the form (left, top, height, width) - code_theme = 'tomorrowNight' - if style == 'martik': - specs_for_boxes = [] - margin = 18 # in pxs - - # set Headings styles - paragraph_styles['Heading 1'].update( - {'color': '#0D0A1E', - 'fontFamily': 'Raleway', - 'fontSize': 55, - 'fontWeight': fontWeight_dict['Bold']['fontWeight']} - ) - - paragraph_styles['Heading 2'] = copy.deepcopy( - paragraph_styles['Heading 1'] - ) - paragraph_styles['Heading 2'].update({'fontSize': 36}) - paragraph_styles['Heading 3'] = copy.deepcopy( - paragraph_styles['Heading 1'] - ) - paragraph_styles['Heading 3'].update({'fontSize': 30}) - - # set Body style - paragraph_styles['Body'].update( - {'color': '#96969C', - 'fontFamily': 'Roboto', - 'fontSize': 16, - 'fontWeight': fontWeight_dict['Regular']['fontWeight']} - ) - - bkgd_color = '#F4FAFB' - title_font_color = '#0D0A1E' - text_font_color = '#96969C' - if num_of_boxes == 0 and slide_num == 0: - text_textAlign = 'center' - else: - text_textAlign = 'left' - if num_of_boxes == 0: - specs_for_title = (0, 50, 20, 100) - specs_for_text = (15, 60, 50, 70) - - bkgd_color = '#0D0A1E' - title_font_color = '#F4FAFB' - text_font_color = '#F4FAFB' - elif num_of_boxes == 1: - if code_blocks != [] or (url_lines != [] and - get_config()['plotly_domain'] in - url_lines[0]): - if code_blocks != []: - w_range = 40 - else: - w_range = 60 - text_top = _top_spec_for_text_at_bottom( - text_block, 80, - per_from_bottom=(margin / HEIGHT) * 100 - ) - specs_for_title = (0, 3, 20, 100) - specs_for_text = (10, text_top, 30, 80) - specs_for_boxes = _box_specs_gen( - num_of_boxes, grouptype='middle', width_range=w_range, - height_range=60, margin=margin, betw_boxes=4 - ) - bkgd_color = '#0D0A1E' - title_font_color = '#F4FAFB' - text_font_color = '#F4FAFB' - code_theme = 'tomorrow' - elif title_lines == [] and text_block == '': - specs_for_title = (0, 50, 20, 100) - specs_for_text = (15, 60, 50, 70) - specs_for_boxes = _box_specs_gen( - num_of_boxes, grouptype='middle', width_range=50, - height_range=80, margin=0, betw_boxes=0 - ) - else: - title_text_width = 40 - (margin / WIDTH) * 100 - - text_top = _top_spec_for_text_at_bottom( - text_block, title_text_width, - per_from_bottom=(margin / HEIGHT) * 100 - ) - specs_for_title = (60, 3, 20, 40) - specs_for_text = (60, text_top, 1, title_text_width) - specs_for_boxes = _box_specs_gen( - num_of_boxes, grouptype='leftgroup_v', width_range=60, - margin=margin, betw_boxes=4 - ) - bkgd_color = '#0D0A1E' - title_font_color = '#F4FAFB' - text_font_color = '#F4FAFB' - elif num_of_boxes == 2 and url_lines != []: - text_top = _top_spec_for_text_at_bottom( - text_block, 46, per_from_bottom=(margin / HEIGHT) * 100, - min_top=50 - ) - specs_for_title = (0, 3, 20, 50) - specs_for_text = (52, text_top, 40, 46) - specs_for_boxes = _box_specs_gen( - num_of_boxes, grouptype='checkerboard_topright' - ) - elif num_of_boxes >= 2 and url_lines == []: - text_top = _top_spec_for_text_at_bottom( - text_block, 92, per_from_bottom=(margin / HEIGHT) * 100, - min_top=15 - ) - if num_of_boxes == 2: - betw_boxes = 90 - else: - betw_boxes = 10 - specs_for_title = (0, 3, 20, 100) - specs_for_text = (4, text_top, 1, 92) - specs_for_boxes = _box_specs_gen( - num_of_boxes, grouptype='middle', width_range=92, - height_range=60, margin=margin, betw_boxes=betw_boxes - ) - code_theme = 'tomorrow' - else: - text_top = _top_spec_for_text_at_bottom( - text_block, 40 - (margin / WIDTH) * 100, - per_from_bottom=(margin / HEIGHT) * 100 - ) - specs_for_title = (0, 3, 20, 40 - (margin / WIDTH) * 100) - specs_for_text = ( - (margin / WIDTH) * 100, text_top, 50, - 40 - (margin / WIDTH) * 100 - ) - specs_for_boxes = _box_specs_gen( - num_of_boxes, grouptype='rightgroup_v', width_range=60, - margin=margin, betw_boxes=4 - ) - - elif style == 'moods': - specs_for_boxes = [] - margin = 18 - code_theme = 'tomorrowNight' - - # set Headings styles - paragraph_styles['Heading 1'].update( - {'color': '#000016', - 'fontFamily': 'Roboto', - 'fontSize': 55, - 'fontWeight': fontWeight_dict['Black']['fontWeight']} - ) - - paragraph_styles['Heading 2'] = copy.deepcopy( - paragraph_styles['Heading 1'] - ) - paragraph_styles['Heading 2'].update({'fontSize': 36}) - paragraph_styles['Heading 3'] = copy.deepcopy( - paragraph_styles['Heading 1'] - ) - paragraph_styles['Heading 3'].update({'fontSize': 30}) - - # set Body style - paragraph_styles['Body'].update( - {'color': '#000016', - 'fontFamily': 'Roboto', - 'fontSize': 16, - 'fontWeight': fontWeight_dict['Thin']['fontWeight']} - ) - - bkgd_color = '#FFFFFF' - title_font_color = None - text_font_color = None - if num_of_boxes == 0 and slide_num == 0: - text_textAlign = 'center' - else: - text_textAlign = 'left' - if num_of_boxes == 0: - if slide_num == 0 or text_block == '': - bkgd_color = '#F7F7F7' - specs_for_title = (0, 50, 20, 100) - specs_for_text = (15, 60, 50, 70) - else: - bkgd_color = '#F7F7F7' - text_top = _top_spec_for_text_at_bottom( - text_block, width_per=90, - per_from_bottom=(margin / HEIGHT) * 100, - min_top=20 - ) - specs_for_title = (0, 2, 20, 100) - specs_for_text = (5, text_top, 50, 90) - - elif num_of_boxes == 1: - if code_blocks != []: - # code - if text_block == '': - margin = 5 - specs_for_title = (0, 3, 20, 100) - specs_for_text = (0, 0, 0, 0) - top = 12 - specs_for_boxes = [ - (margin, top, 100 - top - margin, 100 - 2 * margin) - ] - - elif slide_num % 2 == 0: - # middle center - width_per = 90 - height_range = 60 - text_top = _top_spec_for_text_at_bottom( - text_block, width_per=width_per, - per_from_bottom=(margin / HEIGHT) * 100, - min_top=100 - height_range / 2. - ) - specs_for_boxes = _box_specs_gen( - num_of_boxes, grouptype='middle', - width_range=50, height_range=60, margin=margin, - ) - specs_for_title = (0, 3, 20, 100) - specs_for_text = ( - 5, text_top, 2, width_per - ) - else: - # right - width_per = 50 - text_top = _top_spec_for_text_at_bottom( - text_block, width_per=width_per, - per_from_bottom=(margin / HEIGHT) * 100, - min_top=30 - ) - specs_for_boxes = _box_specs_gen( - num_of_boxes, grouptype='rightgroup_v', - width_range=50, margin=40, - ) - specs_for_title = (0, 3, 20, 50) - specs_for_text = ( - 2, text_top, 2, width_per - 2 - ) - elif (url_lines != [] and - get_config()['plotly_domain'] in url_lines[0]): - # url - if slide_num % 2 == 0: - # top half - width_per = 95 - text_top = _top_spec_for_text_at_bottom( - text_block, width_per=width_per, - per_from_bottom=(margin / HEIGHT) * 100, - min_top=60 - ) - specs_for_boxes = _box_specs_gen( - num_of_boxes, grouptype='middle', - width_range=100, height_range=60, - middle_center=30 - ) - specs_for_title = (0, 60, 20, 100) - specs_for_text = ( - 2.5, text_top, 2, width_per - ) - else: - # middle across - width_per = 95 - text_top = _top_spec_for_text_at_bottom( - text_block, width_per=width_per, - per_from_bottom=(margin / HEIGHT) * 100, - min_top=60 - ) - specs_for_boxes = _box_specs_gen( - num_of_boxes, grouptype='middle', - width_range=100, height_range=60 - ) - specs_for_title = (0, 3, 20, 100) - specs_for_text = ( - 2.5, text_top, 2, width_per - ) - else: - # image - if slide_num % 2 == 0: - # right - width_per = 50 - text_top = _top_spec_for_text_at_bottom( - text_block, width_per=width_per, - per_from_bottom=(margin / HEIGHT) * 100, - min_top=30 - ) - specs_for_boxes = _box_specs_gen( - num_of_boxes, grouptype='rightgroup_v', - width_range=50, margin=0, - ) - specs_for_title = (0, 3, 20, 50) - specs_for_text = ( - 2, text_top, 2, width_per - 2 - ) - else: - # left - width_per = 50 - text_top = _top_spec_for_text_at_bottom( - text_block, width_per=width_per, - per_from_bottom=(margin / HEIGHT) * 100, - min_top=30 - ) - specs_for_boxes = _box_specs_gen( - num_of_boxes, grouptype='leftgroup_v', - width_range=50, margin=0, - ) - specs_for_title = (50, 3, 20, 50) - specs_for_text = ( - 52, text_top, 2, width_per - 2 - ) - elif num_of_boxes == 2: - # right stack - width_per = 50 - text_top = _top_spec_for_text_at_bottom( - text_block, width_per=width_per, - per_from_bottom=(margin / HEIGHT) * 100, - min_top=30 - ) - specs_for_boxes = [(50, 0, 50, 50), (50, 50, 50, 50)] - specs_for_title = (0, 3, 20, 50) - specs_for_text = ( - 2, text_top, 2, width_per - 2 - ) - elif num_of_boxes == 3: - # middle top - width_per = 95 - text_top = _top_spec_for_text_at_bottom( - text_block, width_per=width_per, - per_from_bottom=(margin / HEIGHT) * 100, - min_top=40 - ) - specs_for_boxes = _box_specs_gen( - num_of_boxes, grouptype='middle', - width_range=100, height_range=40, middle_center=30 - ) - specs_for_title = (0, 0, 20, 100) - specs_for_text = ( - 2.5, text_top, 2, width_per - ) - else: - # right stack - width_per = 40 - text_top = _top_spec_for_text_at_bottom( - text_block, width_per=width_per, - per_from_bottom=(margin / HEIGHT) * 100, - min_top=30 - ) - specs_for_boxes = _box_specs_gen( - num_of_boxes, grouptype='rightgroup_v', - width_range=60, margin=0, - ) - specs_for_title = (0, 3, 20, 40) - specs_for_text = ( - 2, text_top, 2, width_per - 2 - ) - - # set text style attributes - title_style_attr = {} - text_style_attr = {'textAlign': text_textAlign} - - if text_font_color: - text_style_attr['color'] = text_font_color - if title_font_color: - title_style_attr['color'] = title_font_color - - return (specs_for_boxes, specs_for_title, specs_for_text, bkgd_color, - title_style_attr, text_style_attr, code_theme) - - -def _url_parens_contained(url_name, line): - return line.startswith(url_name + '(') and line.endswith(')') - - -class Presentation(dict): - """ - The Presentation class for creating spectacle-presentations. - - The Presentations API is a means for creating JSON blobs which are then - converted Spectacle Presentations. To use the API you only need to define - a block string and define your slides using markdown. Then you can upload - your presentation to the Plotly Server. - - Rules for your presentation string: - - use '---' to denote a slide break. - - headers work as per usual, where if '#' is used before a line of text - then it is interpretted as a header. Only the first header in a slide is - displayed on the slide. There are only 3 heading sizes: #, ## and ###. - 4 or more hashes will be interpretted as ###. - - you can set the type of slide transition you want by writing a line that - starts with 'transition: ' before your first header line in the slide, - and write the types of transition you want after. Your transition to - choose from are 'slide', 'zoom', 'fade' and 'spin'. - - to insert a Plotly chart into your slide, write a line that has the form - Plotly(url) with your url pointing to your chart. Note that it is - STRONGLY advised that your chart has fig['layout']['autosize'] = True. - - to insert an image from the web, write a line with the form Image(url) - - to insert a block of text, begin with a line that denotes the code - envoronment '```lang' where lang is a valid programming language. To find - the valid languages run:\n - 'plotly.presentation_objs.presentation_objs.VALID_LANGUAGES'\n - To end the code block environment, - write a single '```' line. All Plotly(url) and Image(url) lines will NOT - be interpretted as a Plotly or Image url if they are in the code block. - - :param (str) markdown_string: the block string that denotes the slides, - slide properties, and images to be placed in the presentation. If - 'markdown_string' is set to 'None', the JSON for a presentation with - one empty slide will be created. - :param (str) style: the theme that the presentation will take on. The - themes that are available now are 'martik' and 'moods'. - Default = 'moods'. - :param (bool) imgStretch: if set to False, all images in the presentation - will not have heights and widths that will not exceed the parent - container they belong to. In other words, images will keep their - original aspect ratios. - Default = True. - - For examples see the documentation:\n - https://plot.ly/python/presentations-api/ - """ - def __init__(self, markdown_string=None, style='moods', imgStretch=True): - self['presentation'] = { - 'slides': [], - 'slidePreviews': [None for _ in range(496)], - 'version': '0.1.3', - 'paragraphStyles': paragraph_styles - } - - if markdown_string: - if style not in PRES_THEMES: - raise exceptions.PlotlyError( - "Your presentation style must be {}".format( - list_of_options(PRES_THEMES, conj='or', period=True) - ) - ) - self._markdown_to_presentation(markdown_string, style, imgStretch) - else: - self._add_empty_slide() - - def _markdown_to_presentation(self, markdown_string, style, imgStretch): - list_of_slides = _list_of_slides(markdown_string) - - for slide_num, slide in enumerate(list_of_slides): - lines_in_slide = slide.split('\n') - title_lines = [] - - # validate blocks of code - if slide.count('```') % 2 != 0: - raise exceptions.PlotlyError(CODE_ENV_ERROR) - - # find code blocks - code_indices = [] - code_blocks = [] - wdw_size = len('```') - for j in range(len(slide)): - if slide[j:j+wdw_size] == '```': - code_indices.append(j) - - for k in range(int(len(code_indices) / 2)): - code_blocks.append( - slide[code_indices[2 * k]:code_indices[(2 * k) + 1]] - ) - - lang_and_code_tuples = [] - for code_block in code_blocks: - # validate code blocks - code_by_lines = code_block.split('\n') - language = _remove_extra_whitespace_from_line( - code_by_lines[0][3:] - ).lower() - if language == '' or language not in VALID_LANGUAGES: - raise exceptions.PlotlyError( - "The language of your code block should be " - "clearly indicated after the first ``` that " - "begins the code block. The valid languages to " - "choose from are" + list_of_options( - VALID_LANGUAGES - ) - ) - lang_and_code_tuples.append( - (language, '\n'.join(code_by_lines[1:])) - ) - - # collect text, code and urls - title_lines = [] - url_lines = [] - text_lines = [] - inCode = False - - for line in lines_in_slide: - # inCode handling - if line[:3] == '```' and len(line) > 3: - inCode = True - if line == '```': - inCode = False - - if not inCode and line != '```': - if len(line) > 0 and line[0] == '#': - title_lines.append(line) - elif (_url_parens_contained('Plotly', line) or - _url_parens_contained('Image', line)): - if (line.startswith('Plotly(') and - get_config()['plotly_domain'] not in line): - raise exceptions.PlotlyError( - "You are attempting to insert a Plotly Chart " - "in your slide but your url does not have " - "your plotly domain '{}' in it.".format( - get_config()['plotly_domain'] - ) - ) - url_lines.append(line) - else: - # find and set transition properties - trans = 'transition:' - if line.startswith(trans) and title_lines == []: - slide_trans = line[len(trans):] - slide_trans = _remove_extra_whitespace_from_line( - slide_trans - ) - slide_transition_list = [] - for key in VALID_TRANSITIONS: - if key in slide_trans: - slide_transition_list.append(key) - - if slide_transition_list == []: - slide_transition_list.append('slide') - self._set_transition( - slide_transition_list, slide_num - ) - - else: - text_lines.append(line) - - # make text block - for i in range(2): - try: - while text_lines[-i] == '': - text_lines.pop(-i) - except IndexError: - pass - - text_block = '\n'.join(text_lines) - num_of_boxes = len(url_lines) + len(lang_and_code_tuples) - - (specs_for_boxes, specs_for_title, specs_for_text, bkgd_color, - title_style_attr, text_style_attr, - code_theme) = _return_layout_specs( - num_of_boxes, url_lines, title_lines, text_block, code_blocks, - slide_num, style - ) - - # background color - self._color_background(bkgd_color, slide_num) - - # insert title, text, code, and images - if len(title_lines) > 0: - # clean titles - title = title_lines[0] - num_hashes = 0 - while title[0] == '#': - title = title[1:] - num_hashes += 1 - title = _remove_extra_whitespace_from_line(title) - - self._insert( - box='Text', text_or_url=title, - left=specs_for_title[0], top=specs_for_title[1], - height=specs_for_title[2], width=specs_for_title[3], - slide=slide_num, style_attr=title_style_attr, - paragraphStyle='Heading 1'.format( - min(num_hashes, 3) - ) - ) - - # text - if len(text_lines) > 0: - self._insert( - box='Text', text_or_url=text_block, - left=specs_for_text[0], top=specs_for_text[1], - height=specs_for_text[2], width=specs_for_text[3], - slide=slide_num, style_attr=text_style_attr, - paragraphStyle='Body' - ) - - url_and_code_blocks = list(url_lines + lang_and_code_tuples) - for k, specs in enumerate(specs_for_boxes): - url_or_code = url_and_code_blocks[k] - if isinstance(url_or_code, tuple): - # code - language = url_or_code[0] - code = url_or_code[1] - box_name = 'CodePane' - - # code style - props_attr = {} - props_attr['language'] = language - props_attr['theme'] = code_theme - - self._insert(box=box_name, text_or_url=code, - left=specs[0], top=specs[1], - height=specs[2], width=specs[3], - slide=slide_num, props_attr=props_attr) - else: - # url - if get_config()['plotly_domain'] in url_or_code: - box_name = 'Plotly' - else: - box_name = 'Image' - url = url_or_code[len(box_name) + 1: -1] - - self._insert(box=box_name, text_or_url=url, - left=specs[0], top=specs[1], - height=specs[2], width=specs[3], - slide=slide_num) - - if not imgStretch: - for s, slide in enumerate(self['presentation']['slides']): - for c, child in enumerate(slide['children']): - if child['type'] in ['Image', 'Plotly']: - deep_child = child['props']['style'] - width = deep_child['width'] - height = deep_child['height'] - - if width >= height: - deep_child['max-width'] = deep_child.pop('width') - else: - deep_child['max-height'] = deep_child.pop('height') - - def _add_empty_slide(self): - self['presentation']['slides'].append( - _empty_slide(['slide'], _generate_id(9)) - ) - - def _add_missing_slides(self, slide): - # add slides if desired slide number isn't in the presentation - try: - self['presentation']['slides'][slide]['children'] - except IndexError: - num_of_slides = len(self['presentation']['slides']) - for _ in range(slide - num_of_slides + 1): - self._add_empty_slide() - - def _insert(self, box, text_or_url, left, top, height, width, slide=0, - props_attr={}, style_attr={}, paragraphStyle=None): - self._add_missing_slides(slide) - - left, top, height, width = _return_box_position(left, top, height, - width) - new_id = _generate_id(9) - child = _box(box, text_or_url, left, top, height, width, new_id, - props_attr, style_attr, paragraphStyle) - - self['presentation']['slides'][slide]['children'].append(child) - - def _color_background(self, color, slide): - self._add_missing_slides(slide) - - loc = self['presentation']['slides'][slide] - loc['props']['style']['backgroundColor'] = color - - def _background_image(self, url, slide, bkrd_image_dict): - self._add_missing_slides(slide) - - loc = self['presentation']['slides'][slide]['props'] - - # default settings - size = 'stretch' - repeat = 'no-repeat' - - if 'background-size:' in bkrd_image_dict: - size = bkrd_image_dict['background-size:'] - if 'background-repeat:' in bkrd_image_dict: - repeat = bkrd_image_dict['background-repeat:'] - - if size == 'stretch': - backgroundSize = '100% 100%' - elif size == 'original': - backgroundSize = 'auto' - elif size == 'contain': - backgroundSize = 'contain' - elif size == 'cover': - backgroundSize = 'cover' - - style = { - 'backgroundImage': 'url({})'.format(url), - 'backgroundPosition': 'center center', - 'backgroundRepeat': repeat, - 'backgroundSize': backgroundSize - } - - for item in style.items(): - loc['style'].setdefault(item[0], item[1]) - - loc['backgroundImageSrc'] = url - loc['backgroundImageName'] = None - - def _set_transition(self, transition, slide): - self._add_missing_slides(slide) - loc = self['presentation']['slides'][slide]['props'] - loc['transition'] = transition diff --git a/plotly/session.py b/plotly/session.py index 2e72d45bff3..410e26ff7d5 100644 --- a/plotly/session.py +++ b/plotly/session.py @@ -1,158 +1,9 @@ -""" -The session module handles the user's current credentials, config and plot opts - -This allows users to dynamically change which plotly domain they're using, -which user they're signed in as, and plotting defaults. - -""" from __future__ import absolute_import -import copy - -import six - -from plotly import exceptions - -_session = { - 'credentials': {}, - 'config': {}, - 'plot_options': {} -} - -CREDENTIALS_KEYS = { - 'username': six.string_types, - 'api_key': six.string_types, - 'proxy_username': six.string_types, - 'proxy_password': six.string_types, - 'stream_ids': list -} - -CONFIG_KEYS = { - 'plotly_domain': six.string_types, - 'plotly_streaming_domain': six.string_types, - 'plotly_api_domain': six.string_types, - 'plotly_ssl_verification': bool, - 'plotly_proxy_authorization': bool, - 'world_readable': bool, - 'auto_open': bool, - 'sharing': six.string_types -} - -PLOT_OPTIONS = { - 'filename': six.string_types, - 'fileopt': six.string_types, - 'validate': bool, - 'world_readable': bool, - 'auto_open': bool, - 'sharing': six.string_types -} - -SHARING_OPTIONS = ['public', 'private', 'secret'] - - -def sign_in(username, api_key, **kwargs): - """ - Set set session credentials and config (not saved to file). - - If unspecified, credentials and config are searched for in `.plotly` dir. - - :param (str) username: The username you'd use to sign in to Plotly - :param (str) api_key: The api key associated with above username - :param (list|optional) stream_ids: Stream tokens for above credentials - :param (str|optional) proxy_username: The un associated with with your Proxy - :param (str|optional) proxy_password: The pw associated with your Proxy un - - :param (str|optional) plotly_domain: - :param (str|optional) plotly_streaming_domain: - :param (str|optional) plotly_api_domain: - :param (bool|optional) plotly_ssl_verification: - :param (bool|optional) plotly_proxy_authorization: - :param (bool|optional) world_readable: - - """ - # TODO: verify these _credentials with plotly - - # kwargs will contain all our info - kwargs.update(username=username, api_key=api_key) - - # raise error if key isn't valid anywhere - for key in kwargs: - if key not in CREDENTIALS_KEYS and key not in CONFIG_KEYS: - raise exceptions.PlotlyError( - "{} is not a valid config or credentials key".format(key) - ) - - # add credentials, raise error if type is wrong. - for key in CREDENTIALS_KEYS: - if key in kwargs: - if not isinstance(kwargs[key], CREDENTIALS_KEYS[key]): - raise exceptions.PlotlyError( - "{} must be of type '{}'" - .format(key, CREDENTIALS_KEYS[key]) - ) - _session['credentials'][key] = kwargs[key] - - # add config, raise error if type is wrong. - for key in CONFIG_KEYS: - if key in kwargs: - if not isinstance(kwargs[key], CONFIG_KEYS[key]): - raise exceptions.PlotlyError("{} must be of type '{}'" - .format(key, CONFIG_KEYS[key])) - _session['config'][key] = kwargs.get(key) - - # add plot options, raise error if type is wrong. - for key in PLOT_OPTIONS: - if key in kwargs: - if not isinstance(kwargs[key], CONFIG_KEYS[key]): - raise exceptions.PlotlyError("{} must be of type '{}'" - .format(key, CONFIG_KEYS[key])) - _session['plot_options'][key] = kwargs.get(key) - - -def update_session_plot_options(**kwargs): - """ - Update the _session plot_options - - :param (str|optional) filename: What the file will be named in Plotly - :param (str|optional) fileopt: 'overwrite', 'append', 'new', or 'extend' - :param (bool|optional) world_readable: Make public or private. - :param (dict|optional) sharing: 'public', 'private', 'secret' - :param (bool|optional) auto_open: For `plot`, open in new browser tab? - :param (bool|optional) validate: Error locally if data doesn't pass? - - """ - # raise exception if key is invalid or value is the wrong type - for key in kwargs: - if key not in PLOT_OPTIONS: - raise exceptions.PlotlyError( - "{} is not a valid config or plot option key".format(key) - ) - if not isinstance(kwargs[key], PLOT_OPTIONS[key]): - raise exceptions.PlotlyError("{} must be of type '{}'" - .format(key, PLOT_OPTIONS[key])) - - # raise exception if sharing is invalid - if (key == 'sharing' and not (kwargs[key] in SHARING_OPTIONS)): - raise exceptions.PlotlyError("'{0}' must be of either '{1}', '{2}'" - " or '{3}'" - .format(key, *SHARING_OPTIONS)) - - # update local _session dict with new plot options - _session['plot_options'].update(kwargs) - - -def get_session_plot_options(): - """ Returns a copy of the user supplied plot options. - Use `update_plot_options()` to change. - """ - return copy.deepcopy(_session['plot_options']) - - -def get_session_config(): - """Returns either module config or file config.""" - return copy.deepcopy(_session['config']) +from _plotly_future_ import _future_flags -def get_session_credentials(): - """Returns the credentials that will be sent to plotly.""" - return copy.deepcopy(_session['credentials']) +if 'remove_deprecations' not in _future_flags: + from _plotly_future_ import _chart_studio_warning + _chart_studio_warning('session') + from chart_studio.session import * diff --git a/plotly/stuff.js b/plotly/stuff.js deleted file mode 100644 index 447f6fc8d94..00000000000 --- a/plotly/stuff.js +++ /dev/null @@ -1 +0,0 @@ -{"type": "FeatureCollection", "features": [{"geometry": {"type": "MultiPolygon", "coordinates": [[[[-124.194502, 40.961703], [-124.182694, 41.001312999999996], [-124.204984, 41.013638], [-124.227079, 41.046622], [-124.231202, 41.065501], [-124.249588, 41.099025], [-124.24916400000001, 41.120157], [-124.252474, 41.134074999999996], [-124.247236, 41.152817], [-124.237625, 41.165959], [-124.21941799999999, 41.177687], [-124.195532, 41.184582], [-124.176367, 41.237148], [-124.173316, 41.260995], [-124.160704, 41.289293], [-124.163398, 41.293169], [-124.192328, 41.29199], [-124.220032, 41.302994], [-124.23821, 41.321446], [-124.24242, 41.3433], [-124.238191, 41.358705], [-124.231087, 41.368856], [-124.206515, 41.384718], [-124.176556, 41.390352], [-124.154195, 41.387628], [-124.139973, 41.381820999999995], [-124.133231, 41.432311], [-124.136906, 41.446822999999995], [-124.136561, 41.464452], [-123.770551, 41.464193], [-123.770239, 41.380776], [-123.50117, 41.382567], [-123.474085, 41.366192999999996], [-123.48250999999999, 41.353649999999995], [-123.478641, 41.329648], [-123.472471, 41.321546999999995], [-123.46343999999999, 41.31773], [-123.459592, 41.310238999999996], [-123.460335, 41.303304], [-123.455475, 41.292819], [-123.463241, 41.286338], [-123.461889, 41.282589], [-123.443821, 41.273233], [-123.44214, 41.251396], [-123.455307, 41.236537], [-123.434376, 41.222874999999995], [-123.435313, 41.213301], [-123.42770999999999, 41.203340999999995], [-123.417095, 41.197002], [-123.40829099999999, 41.179944], [-123.410365, 41.170705999999996], [-123.416949, 41.16553], [-123.432608, 41.162327999999995], [-123.42876799999999, 41.152062], [-123.431491, 41.147726999999996], [-123.429251, 41.118], [-123.434289, 41.111655], [-123.439806, 41.092541], [-123.449479, 41.089106], [-123.464222, 41.094408], [-123.458282, 41.083785999999996], [-123.464006, 41.076347999999996], [-123.457942, 41.068214999999995], [-123.452525, 41.068531], [-123.445599, 41.061681], [-123.435219, 41.060615999999996], [-123.430723, 41.063266999999996], [-123.423272, 41.058157], [-123.423754, 41.043185], [-123.419282, 41.034528], [-123.407218, 41.030619], [-123.410312, 41.020674], [-123.40603999999999, 41.012896999999995], [-123.420059, 41.009674], [-123.425755, 41.003510999999996], [-123.427258, 40.988256], [-123.434855, 40.982552], [-123.436555, 40.973653], [-123.453258, 40.964152999999996], [-123.45295899999999, 40.960059], [-123.444859, 40.956157999999995], [-123.445661, 40.947054], [-123.449488, 40.943132999999996], [-123.467656, 40.938159], [-123.477958, 40.928056], [-123.481457, 40.914957], [-123.511758, 40.920356999999996], [-123.529659, 40.934855999999996], [-123.533859, 40.930755999999995], [-123.540959, 40.932255999999995], [-123.54115999999999, 40.939656], [-123.560163, 40.950257], [-123.569961, 40.946555], [-123.56766, 40.936555999999996], [-123.581556, 40.933157], [-123.587861, 40.927755], [-123.599261, 40.931155], [-123.611362, 40.929255], [-123.622387, 40.931703], [-123.623891, 40.928674], [-123.613423, 40.921551], [-123.615827, 40.914068], [-123.604725, 40.900369999999995], [-123.608542, 40.894937999999996], [-123.597211, 40.884104], [-123.601709, 40.879953], [-123.61025000000001, 40.878972], [-123.59799699999999, 40.877615], [-123.591109, 40.867281999999996], [-123.5806, 40.867999], [-123.58754, 40.858483], [-123.575841, 40.857994], [-123.573162, 40.843515], [-123.563059, 40.840416999999995], [-123.566243, 40.834978], [-123.559628, 40.830318999999996], [-123.568731, 40.819739999999996], [-123.562522, 40.809698], [-123.556215, 40.808817], [-123.554071, 40.796309], [-123.557779, 40.793741999999995], [-123.56584699999999, 40.796231], [-123.566253, 40.78881], [-123.560033, 40.790268999999995], [-123.55828, 40.781071], [-123.549865, 40.775808], [-123.554507, 40.766656], [-123.55019300000001, 40.762803999999996], [-123.554165, 40.759502], [-123.550907, 40.756085], [-123.551806, 40.748127], [-123.548096, 40.746373], [-123.543015, 40.733578], [-123.54445799999999, 40.001923], [-124.134889, 40.002469999999995], [-124.145333, 40.024170999999996], [-124.144099, 40.052400999999996], [-124.153762, 40.063544], [-124.23120399999999, 40.093382], [-124.272099, 40.133649999999996], [-124.287833, 40.137682999999996], [-124.33368899999999, 40.167175], [-124.403151, 40.218005], [-124.421287, 40.237102], [-124.42914999999999, 40.266915], [-124.427899, 40.288804], [-124.41827599999999, 40.314288999999995], [-124.427945, 40.338823], [-124.428055, 40.361785], [-124.44470799999999, 40.376411999999995], [-124.478625, 40.422101999999995], [-124.48200299999999, 40.440318], [-124.479158, 40.452636], [-124.455952, 40.484047], [-124.447677, 40.529709], [-124.427191, 40.562084999999996], [-124.403367, 40.61317], [-124.3429, 40.708832], [-124.29933299999999, 40.768481], [-124.292662, 40.788094], [-124.280181, 40.799932], [-124.23262199999999, 40.869285999999995], [-124.214964, 40.906403999999995], [-124.194502, 40.961703]]]]} \ No newline at end of file diff --git a/plotly/tests/test_core/test_graph_objs/test_instantiate_hierarchy.py b/plotly/tests/test_core/test_graph_objs/test_instantiate_hierarchy.py index 7ac1b82fa3b..cfe77b5510b 100644 --- a/plotly/tests/test_core/test_graph_objs/test_instantiate_hierarchy.py +++ b/plotly/tests/test_core/test_graph_objs/test_instantiate_hierarchy.py @@ -17,7 +17,14 @@ def test_construct_datatypes(self): for datatypes_module in datatype_modules: module = importlib.import_module(datatypes_module) for name, obj in inspect.getmembers(module, inspect.isclass): - v = obj() + if name.startswith('_'): + continue + try: + v = obj() + except Exception: + print('Failed to construct {obj} in module {module}' + .format(obj=obj, module=datatypes_module)) + if obj.__module__ == 'plotly.graph_objs._deprecations': self.assertTrue( isinstance(v, list) or isinstance(v, dict) diff --git a/plotly/tests/test_core/test_graph_objs/test_template.py b/plotly/tests/test_core/test_graph_objs/test_template.py index 21f2c43567c..a5068e15b43 100644 --- a/plotly/tests/test_core/test_graph_objs/test_template.py +++ b/plotly/tests/test_core/test_graph_objs/test_template.py @@ -469,3 +469,11 @@ def test_merge_by_flaglist_string(self): # Make sure input templates weren't modified self.assertEqual(self.template1, self.template1_orig) self.assertEqual(self.template2, self.template2_orig) + + def test_set_default_template(self): + orig_default = pio.templates.default + pio.templates.default = 'plotly' + fig = go.Figure() + self.assertEqual(fig.layout.template.to_plotly_json(), + pio.templates['plotly'].to_plotly_json()) + pio.templates.default = orig_default diff --git a/plotly/tests/test_core/test_optional_imports/test_optional_imports.py b/plotly/tests/test_core/test_optional_imports/test_optional_imports.py index de70ee2d122..8fec76dc6f4 100644 --- a/plotly/tests/test_core/test_optional_imports/test_optional_imports.py +++ b/plotly/tests/test_core/test_optional_imports/test_optional_imports.py @@ -28,14 +28,14 @@ def test_get_module_import_exception(self): 'test_optional_imports.exploding_module') if sys.version_info.major == 3 and sys.version_info.minor >= 4: - with self.assertLogs('plotly.optional_imports', level='ERROR') as cm: + with self.assertLogs('_plotly_utils.optional_imports', level='ERROR') as cm: module = get_module(module_str) # No exception should be raised and None should be returned self.assertIsNone(module) # Check logging level and log message - expected_start = ('ERROR:plotly.optional_imports:' + expected_start = ('ERROR:_plotly_utils.optional_imports:' 'Error importing optional module ' + module_str) self.assertEqual( diff --git a/plotly/tests/test_optional/test_offline/temp-plot.html b/plotly/tests/test_optional/test_offline/temp-plot.html new file mode 100644 index 00000000000..03a4fda1e3e --- /dev/null +++ b/plotly/tests/test_optional/test_offline/temp-plot.html @@ -0,0 +1,28 @@ + + + +
+ + + +
+ +
+ + \ No newline at end of file diff --git a/plotly/tests/test_plot_ly/test_dashboard/test_dashboard.py b/plotly/tests/test_plot_ly/test_dashboard/test_dashboard.py index 494f4618f8d..a9f1c10fe53 100644 --- a/plotly/tests/test_plot_ly/test_dashboard/test_dashboard.py +++ b/plotly/tests/test_plot_ly/test_dashboard/test_dashboard.py @@ -9,7 +9,7 @@ from unittest import TestCase from plotly.exceptions import PlotlyError -import plotly.dashboard_objs.dashboard_objs as dashboard +import plotly.dashboard_objs as dashboard class TestDashboard(TestCase): diff --git a/plotly/tests/test_plot_ly/test_grid/test_grid.py b/plotly/tests/test_plot_ly/test_grid/test_grid.py index f756266a329..9260e51c936 100644 --- a/plotly/tests/test_plot_ly/test_grid/test_grid.py +++ b/plotly/tests/test_plot_ly/test_grid/test_grid.py @@ -17,7 +17,7 @@ from plotly.exceptions import InputError, PlotlyRequestError, PlotlyError from plotly.graph_objs import Scatter from plotly.grid_objs import Column, Grid -from plotly.plotly.plotly import parse_grid_id_args +from plotly.plotly import parse_grid_id_args from plotly.tests.utils import PlotlyTestCase diff --git a/plotly/tests/test_plot_ly/test_plotly/test_credentials.py b/plotly/tests/test_plot_ly/test_plotly/test_credentials.py index 36b08822ba1..f826b7768ba 100644 --- a/plotly/tests/test_plot_ly/test_plotly/test_credentials.py +++ b/plotly/tests/test_plot_ly/test_plotly/test_credentials.py @@ -1,7 +1,7 @@ from __future__ import absolute_import -import plotly.plotly.plotly as py -import plotly.session as session +import plotly.plotly as py +import chart_studio.session as session import plotly.tools as tls from plotly import exceptions from plotly.tests.utils import PlotlyTestCase @@ -19,7 +19,7 @@ class TestSignIn(PlotlyTestCase): def setUp(self): super(TestSignIn, self).setUp() - patcher = patch('plotly.api.v2.users.current') + patcher = patch('chart_studio.api.v2.users.current') self.users_current_mock = patcher.start() self.addCleanup(patcher.stop) diff --git a/plotly/tests/test_plot_ly/test_plotly/test_plot.py b/plotly/tests/test_plot_ly/test_plotly/test_plot.py index 8227df07ab7..1d378ea7c64 100644 --- a/plotly/tests/test_plot_ly/test_plotly/test_plot.py +++ b/plotly/tests/test_plot_ly/test_plotly/test_plot.py @@ -16,7 +16,7 @@ from nose.plugins.attrib import attr import plotly.tools as tls -from plotly import session +from chart_studio import session from plotly.tests.utils import PlotlyTestCase from plotly.plotly import plotly as py from plotly.exceptions import PlotlyError, PlotlyEmptyDataError @@ -284,7 +284,7 @@ def setUp(self): super(TestPlotOptionLogic, self).setUp() # Make sure we don't hit sign-in validation failures. - patcher = patch('plotly.api.v2.users.current') + patcher = patch('chart_studio.api.v2.users.current') self.users_current_mock = patcher.start() self.addCleanup(patcher.stop) diff --git a/plotly/tests/test_plot_ly/test_session/test_session.py b/plotly/tests/test_plot_ly/test_session/test_session.py index 0f5fa0e3d0c..addea310a8e 100644 --- a/plotly/tests/test_plot_ly/test_session/test_session.py +++ b/plotly/tests/test_plot_ly/test_session/test_session.py @@ -2,7 +2,7 @@ from plotly.tests.utils import PlotlyTestCase -from plotly import session +from chart_studio import session from plotly.session import update_session_plot_options, SHARING_OPTIONS from plotly.exceptions import PlotlyError @@ -26,7 +26,7 @@ def test_update_session_plot_options_valid_sharing_argument(self): # _session['plot_options'] should contain sharing key after # update_session_plot_options is called by correct arguments # 'public, 'private' or 'secret' - from plotly.session import _session + from chart_studio.session import _session for key in SHARING_OPTIONS: kwargs = {'sharing': key} update_session_plot_options(**kwargs) diff --git a/plotly/tools.py b/plotly/tools.py index 3f6fd488069..112c99c264e 100644 --- a/plotly/tools.py +++ b/plotly/tools.py @@ -9,15 +9,15 @@ """ from __future__ import absolute_import +import json import warnings import six -import copy import re +import os -from plotly import exceptions, optional_imports, session, utils -from plotly.files import (CONFIG_FILE, CREDENTIALS_FILE, FILE_CONTENT, - ensure_writable_plotly_dir) +from plotly import exceptions, optional_imports +from plotly.files import PLOTLY_DIR DEFAULT_PLOTLY_COLORS = ['rgb(31, 119, 180)', 'rgb(255, 127, 14)', 'rgb(44, 160, 44)', 'rgb(214, 39, 40)', @@ -62,361 +62,7 @@ def warning_on_one_line(message, category, filename, lineno, sage_salvus = optional_imports.get_module('sage_salvus') -def get_config_defaults(): - """ - Convenience function to check current settings against defaults. - - Example: - - if plotly_domain != get_config_defaults()['plotly_domain']: - # do something - - """ - return dict(FILE_CONTENT[CONFIG_FILE]) # performs a shallow copy - - -def ensure_local_plotly_files(): - """Ensure that filesystem is setup/filled out in a valid way. - If the config or credential files aren't filled out, then write them - to the disk. - """ - if ensure_writable_plotly_dir(): - for fn in [CREDENTIALS_FILE, CONFIG_FILE]: - utils.ensure_file_exists(fn) - contents = utils.load_json_dict(fn) - contents_orig = contents.copy() - for key, val in list(FILE_CONTENT[fn].items()): - # TODO: removed type checking below, may want to revisit - if key not in contents: - contents[key] = val - contents_keys = list(contents.keys()) - for key in contents_keys: - if key not in FILE_CONTENT[fn]: - del contents[key] - # save only if contents has changed. - # This is to avoid .credentials or .config file to be overwritten randomly, - # which we constantly keep experiencing - # (sync issues? the file might be locked for writing by other process in file._permissions) - if contents_orig.keys() != contents.keys(): - utils.save_json_dict(fn, contents) - - else: - warnings.warn("Looks like you don't have 'read-write' permission to " - "your 'home' ('~') directory or to our '~/.plotly' " - "directory. That means plotly's python api can't setup " - "local configuration files. No problem though! You'll " - "just have to sign-in using 'plotly.plotly.sign_in()'. " - "For help with that: 'help(plotly.plotly.sign_in)'." - "\nQuestions? Visit https://support.plot.ly") - - -### credentials tools ### - -def set_credentials_file(username=None, - api_key=None, - stream_ids=None, - proxy_username=None, - proxy_password=None): - """Set the keyword-value pairs in `~/.plotly_credentials`. - - :param (str) username: The username you'd use to sign in to Plotly - :param (str) api_key: The api key associated with above username - :param (list) stream_ids: Stream tokens for above credentials - :param (str) proxy_username: The un associated with with your Proxy - :param (str) proxy_password: The pw associated with your Proxy un - - """ - if not ensure_writable_plotly_dir(): - raise exceptions.PlotlyError("You don't have proper file permissions " - "to run this function.") - ensure_local_plotly_files() # make sure what's there is OK - credentials = get_credentials_file() - if isinstance(username, six.string_types): - credentials['username'] = username - if isinstance(api_key, six.string_types): - credentials['api_key'] = api_key - if isinstance(proxy_username, six.string_types): - credentials['proxy_username'] = proxy_username - if isinstance(proxy_password, six.string_types): - credentials['proxy_password'] = proxy_password - if isinstance(stream_ids, (list, tuple)): - credentials['stream_ids'] = stream_ids - utils.save_json_dict(CREDENTIALS_FILE, credentials) - ensure_local_plotly_files() # make sure what we just put there is OK - - -def get_credentials_file(*args): - """Return specified args from `~/.plotly_credentials`. as dict. - - Returns all if no arguments are specified. - - Example: - get_credentials_file('username') - - """ - # Read credentials from file if possible - credentials = utils.load_json_dict(CREDENTIALS_FILE, *args) - if not credentials: - # Credentials could not be read, use defaults - credentials = copy.copy(FILE_CONTENT[CREDENTIALS_FILE]) - - return credentials - - -def reset_credentials_file(): - ensure_local_plotly_files() # make sure what's there is OK - utils.save_json_dict(CREDENTIALS_FILE, {}) - ensure_local_plotly_files() # put the defaults back - - -### config tools ### - -def set_config_file(plotly_domain=None, - plotly_streaming_domain=None, - plotly_api_domain=None, - plotly_ssl_verification=None, - plotly_proxy_authorization=None, - world_readable=None, - sharing=None, - auto_open=None): - """Set the keyword-value pairs in `~/.plotly/.config`. - - :param (str) plotly_domain: ex - https://plot.ly - :param (str) plotly_streaming_domain: ex - stream.plot.ly - :param (str) plotly_api_domain: ex - https://api.plot.ly - :param (bool) plotly_ssl_verification: True = verify, False = don't verify - :param (bool) plotly_proxy_authorization: True = use plotly proxy auth creds - :param (bool) world_readable: True = public, False = private - - """ - if not ensure_writable_plotly_dir(): - raise exceptions.PlotlyError("You don't have proper file permissions " - "to run this function.") - ensure_local_plotly_files() # make sure what's there is OK - utils.validate_world_readable_and_sharing_settings({ - 'sharing': sharing, 'world_readable': world_readable}) - - settings = get_config_file() - if isinstance(plotly_domain, six.string_types): - settings['plotly_domain'] = plotly_domain - elif plotly_domain is not None: - raise TypeError('plotly_domain should be a string') - if isinstance(plotly_streaming_domain, six.string_types): - settings['plotly_streaming_domain'] = plotly_streaming_domain - elif plotly_streaming_domain is not None: - raise TypeError('plotly_streaming_domain should be a string') - if isinstance(plotly_api_domain, six.string_types): - settings['plotly_api_domain'] = plotly_api_domain - elif plotly_api_domain is not None: - raise TypeError('plotly_api_domain should be a string') - if isinstance(plotly_ssl_verification, (six.string_types, bool)): - settings['plotly_ssl_verification'] = plotly_ssl_verification - elif plotly_ssl_verification is not None: - raise TypeError('plotly_ssl_verification should be a boolean') - if isinstance(plotly_proxy_authorization, (six.string_types, bool)): - settings['plotly_proxy_authorization'] = plotly_proxy_authorization - elif plotly_proxy_authorization is not None: - raise TypeError('plotly_proxy_authorization should be a boolean') - if isinstance(auto_open, bool): - settings['auto_open'] = auto_open - elif auto_open is not None: - raise TypeError('auto_open should be a boolean') - - # validate plotly_domain and plotly_api_domain - utils.validate_plotly_domains( - {'plotly_domain': plotly_domain, 'plotly_api_domain': plotly_api_domain} - ) - - if isinstance(world_readable, bool): - settings['world_readable'] = world_readable - settings.pop('sharing') - elif world_readable is not None: - raise TypeError('Input should be a boolean') - if isinstance(sharing, six.string_types): - settings['sharing'] = sharing - elif sharing is not None: - raise TypeError('sharing should be a string') - utils.set_sharing_and_world_readable(settings) - - utils.save_json_dict(CONFIG_FILE, settings) - ensure_local_plotly_files() # make sure what we just put there is OK - - -def get_config_file(*args): - """Return specified args from `~/.plotly/.config`. as tuple. - - Returns all if no arguments are specified. - - Example: - get_config_file('plotly_domain') - - """ - # Read config from file if possible - config = utils.load_json_dict(CONFIG_FILE, *args) - if not config: - # Config could not be read, use defaults - config = copy.copy(FILE_CONTENT[CONFIG_FILE]) - - return config - - -def reset_config_file(): - ensure_local_plotly_files() # make sure what's there is OK - f = open(CONFIG_FILE, 'w') - f.close() - ensure_local_plotly_files() # put the defaults back - - -### embed tools ### - -def get_embed(file_owner_or_url, file_id=None, width="100%", height=525): - """Returns HTML code to embed figure on a webpage as an ").format( - plotly_rest_url=plotly_rest_url, - file_owner=file_owner, file_id=file_id, - iframe_height=height, iframe_width=width) - else: - s = ("").format( - plotly_rest_url=plotly_rest_url, - file_owner=file_owner, file_id=file_id, share_key=share_key, - iframe_height=height, iframe_width=width) - - return s - - -def embed(file_owner_or_url, file_id=None, width="100%", height=525): - """Embeds existing Plotly figure in IPython Notebook - - Plotly uniquely identifies figures with a 'file_owner'/'file_id' pair. - Since each file is given a corresponding unique url, you may also simply - pass a valid plotly url as the first argument. - - Note, if you're using a file_owner string as the first argument, you MUST - specify a `file_id` keyword argument. Else, if you're using a url string - as the first argument, you MUST NOT specify a `file_id` keyword argument, - or file_id must be set to Python's None value. - - Positional arguments: - file_owner_or_url (string) -- a valid plotly username OR a valid plotly url - - Keyword arguments: - file_id (default=None) -- an int or string that can be converted to int - if you're using a url, don't fill this in! - width (default="100%") -- an int or string corresp. to width of the figure - height (default="525") -- same as width but corresp. to the height of the - figure - - """ - try: - s = get_embed(file_owner_or_url, file_id=file_id, width=width, - height=height) - - # see if we are in the SageMath Cloud - if sage_salvus: - return sage_salvus.html(s, hide=False) - except: - pass - if ipython_core_display: - if file_id: - plotly_domain = ( - session.get_session_config().get('plotly_domain') or - get_config_file()['plotly_domain'] - ) - url = "{plotly_domain}/~{un}/{fid}".format( - plotly_domain=plotly_domain, - un=file_owner_or_url, - fid=file_id) - else: - url = file_owner_or_url - return PlotlyDisplay(url, width, height) - else: - if (get_config_defaults()['plotly_domain'] - != session.get_session_config()['plotly_domain']): - feedback_contact = 'Visit support.plot.ly' - else: - - # different domain likely means enterprise - feedback_contact = 'Contact your On-Premise account executive' - - warnings.warn( - "Looks like you're not using IPython or Sage to embed this " - "plot. If you just want the *embed code*,\ntry using " - "`get_embed()` instead." - '\nQuestions? {}'.format(feedback_contact)) - - ### mpl-related tools ### -@utils.template_doc(**get_config_file()) def mpl_to_plotly(fig, resize=False, strip_style=False, verbose=False): """Convert a matplotlib figure to plotly dictionary and send. @@ -450,19 +96,6 @@ def mpl_to_plotly(fig, resize=False, strip_style=False, verbose=False): renderer.layout -- a plotly layout dictionary renderer.data -- a list of plotly data dictionaries - - Positional arguments: - fig -- a matplotlib figure object - username -- a valid plotly username ** - api_key -- a valid api_key for the above username ** - notebook -- an option for use with an IPython notebook - - ** Don't have a username/api_key? Try looking here: - {plotly_domain}/plot - - ** Forgot your api_key? Try signing in and looking here: - {plotly_domain}/python/getting-started - """ matplotlylib = optional_imports.get_module('plotly.matplotlylib') if matplotlylib: @@ -1465,26 +1098,6 @@ def _replace_newline(obj): return obj # we return the actual reference... but DON'T mutate. -if ipython_core_display: - class PlotlyDisplay(ipython_core_display.HTML): - """An IPython display object for use with plotly urls - - PlotlyDisplay objects should be instantiated with a url for a plot. - IPython will *choose* the proper display representation from any - Python object, and using provided methods if they exist. By defining - the following, if an HTML display is unusable, the PlotlyDisplay - object can provide alternate representations. - - """ - def __init__(self, url, width, height): - self.resource = url - self.embed_code = get_embed(url, width=width, height=height) - super(PlotlyDisplay, self).__init__(data=self.embed_code) - - def _repr_html_(self): - return self.embed_code - - def return_figure_from_figure_or_data(figure_or_data, validate_figure): from plotly.graph_objs import Figure from plotly.basedatatypes import BaseFigure @@ -1532,7 +1145,7 @@ def return_figure_from_figure_or_data(figure_or_data, validate_figure): DIAG_CHOICES = ['scatter', 'histogram', 'box'] VALID_COLORMAP_TYPES = ['cat', 'seq'] - +# Deprecations class FigureFactory(object): @staticmethod @@ -1628,3 +1241,86 @@ def create_violin(*args, **kwargs): FigureFactory._deprecated('create_violin') from plotly.figure_factory import create_violin return create_violin(*args, **kwargs) + + +def get_config_plotly_server_url(): + """ + Function to get the .config file's 'plotly_domain' without importing + the chart_studio package. This property is needed to compute the default + value of the plotly.js config plotlyServerURL, so it is independent of + the chart_studio integration and still needs to live in + + Returns + ------- + str + """ + config_file = os.path.join(PLOTLY_DIR, ".config") + default_server_url = 'https://plot.ly' + if not os.path.exists(config_file): + return default_server_url + with open(config_file, 'rt') as f: + try: + config_dict = json.load(f) + if not isinstance(config_dict, dict): + data = {} + except: + # TODO: issue a warning and bubble it up + data = {} + + return config_dict.get('plotly_domain', default_server_url) + + +# get_config_defaults +from _plotly_future_ import _future_flags + +if 'remove_deprecations' not in _future_flags: + from _plotly_future_ import _chart_studio_deprecation + + from chart_studio.tools import (get_config_defaults) + get_config_defaults = _chart_studio_deprecation( + get_config_defaults) + + # ensure_local_plotly_files + from chart_studio.tools import ensure_local_plotly_files + ensure_local_plotly_files = _chart_studio_deprecation( + ensure_local_plotly_files) + + # set_credentials_file + from chart_studio.tools import set_credentials_file + set_credentials_file = _chart_studio_deprecation( + set_credentials_file) + + # get_credentials_file + from chart_studio.tools import get_credentials_file + get_credentials_file = _chart_studio_deprecation( + get_credentials_file) + + # reset_credentials_file + from chart_studio.tools import reset_credentials_file + reset_credentials_file = _chart_studio_deprecation( + reset_credentials_file) + + # set_config_file + from chart_studio.tools import set_config_file + set_config_file = _chart_studio_deprecation( + set_config_file) + + # get_config_file + from chart_studio.tools import get_config_file + get_config_file = _chart_studio_deprecation( + get_config_file) + + # reset_config_file + from chart_studio.tools import reset_config_file + reset_config_file = _chart_studio_deprecation( + reset_config_file) + + # get_embed + from chart_studio.tools import get_embed + get_embed = _chart_studio_deprecation( + get_embed) + + # embed + from chart_studio.tools import embed + embed = _chart_studio_deprecation( + embed) diff --git a/plotly/utils.py b/plotly/utils.py index acf1a6fe99c..6dbaf9e568e 100644 --- a/plotly/utils.py +++ b/plotly/utils.py @@ -1,390 +1,136 @@ -""" -utils -===== +from __future__ import absolute_import, division -Low-level functionality NOT intended for users to EVER use. - -""" -from __future__ import absolute_import - -import decimal -import os.path -import re -import sys import textwrap -import threading -import datetime -import warnings from collections import deque from pprint import PrettyPrinter -import pytz from decorator import decorator -from requests.compat import json as _json - -from plotly.optional_imports import get_module - -from . exceptions import PlotlyError - -# Optional imports, may be None for users that only use our core functionality. -numpy = get_module('numpy') -pandas = get_module('pandas') -sage_all = get_module('sage.all') - - -### incase people are using threading, we lock file reads -lock = threading.Lock() - -PY36_OR_LATER = ( - sys.version_info.major == 3 and sys.version_info.minor >= 6 -) - - -http_msg = ( - "The plotly_domain and plotly_api_domain of your config file must start " - "with 'https', not 'http'. If you are not using On-Premise then run the " - "following code to ensure your plotly_domain and plotly_api_domain start " - "with 'https':\n\n\n" - "import plotly\n" - "plotly.tools.set_config_file(\n" - " plotly_domain='https://plot.ly',\n" - " plotly_api_domain='https://api.plot.ly'\n" - ")\n\n\n" - "If you are using On-Premise then you will need to use your company's " - "domain and api_domain urls:\n\n\n" - "import plotly\n" - "plotly.tools.set_config_file(\n" - " plotly_domain='https://plotly.your-company.com',\n" - " plotly_api_domain='https://plotly.your-company.com'\n" - ")\n\n\n" - "Make sure to replace `your-company.com` with the URL of your Plotly " - "On-Premise server.\nSee " - "https://plot.ly/python/getting-started/#special-instructions-for-plotly-onpremise-users " - "for more help with getting started with On-Premise." -) - - -### general file setup tools ### - -def load_json_dict(filename, *args): - """Checks if file exists. Returns {} if something fails.""" - data = {} - if os.path.exists(filename): - lock.acquire() - with open(filename, "r") as f: - try: - data = _json.load(f) - if not isinstance(data, dict): - data = {} - except: - data = {} # TODO: issue a warning and bubble it up - lock.release() - if args: - return {key: data[key] for key in args if key in data} - return data - - -def save_json_dict(filename, json_dict): - """Save json to file. Error if path DNE, not a dict, or invalid json.""" - if isinstance(json_dict, dict): - # this will raise a TypeError if something goes wrong - json_string = _json.dumps(json_dict, indent=4) - lock.acquire() - with open(filename, "w") as f: - f.write(json_string) - lock.release() - else: - raise TypeError("json_dict was not a dictionary. not saving.") - - -def ensure_file_exists(filename): - """Given a valid filename, make sure it exists (will create if DNE).""" - if not os.path.exists(filename): - head, tail = os.path.split(filename) - ensure_dir_exists(head) - with open(filename, 'w') as f: - pass # just create the file +from _plotly_utils.utils import * -def ensure_dir_exists(directory): - """Given a valid directory path, make sure it exists.""" - if dir: - if not os.path.isdir(directory): - os.makedirs(directory) - +# Pretty printing +def _list_repr_elided(v, threshold=200, edgeitems=3, indent=0, width=80): + """ + Return a string representation for of a list where list is elided if + it has more than n elements -def iso_to_plotly_time_string(iso_string): - """Remove timezone info and replace 'T' delimeter with ' ' (ws).""" - # make sure we don't send timezone info to plotly - if (iso_string.split('-')[:3] is '00:00') or\ - (iso_string.split('+')[0] is '00:00'): - raise Exception("Plotly won't accept timestrings with timezone info.\n" - "All timestrings are assumed to be in UTC.") + Parameters + ---------- + v : list + Input list + threshold : + Maximum number of elements to display - iso_string = iso_string.replace('-00:00', '').replace('+00:00', '') + Returns + ------- + str + """ + if isinstance(v, list): + open_char, close_char = '[', ']' + elif isinstance(v, tuple): + open_char, close_char = '(', ')' + else: + raise ValueError('Invalid value of type: %s' % type(v)) - if iso_string.endswith('T00:00:00'): - return iso_string.replace('T00:00:00', '') + if len(v) <= threshold: + disp_v = v else: - return iso_string.replace('T', ' ') + disp_v = (list(v[:edgeitems]) + + ['...'] + + list(v[-edgeitems:])) + v_str = open_char + ', '.join([str(e) for e in disp_v]) + close_char -### Custom JSON encoders ### -class NotEncodable(Exception): - pass + v_wrapped = '\n'.join(textwrap.wrap(v_str, width=width, + initial_indent=' ' * (indent + 1), + subsequent_indent =' ' * (indent + 1))).strip() + return v_wrapped -class PlotlyJSONEncoder(_json.JSONEncoder): +class ElidedWrapper(object): """ - Meant to be passed as the `cls` kwarg to json.dumps(obj, cls=..) - - See PlotlyJSONEncoder.default for more implementation information. - - Additionally, this encoder overrides nan functionality so that 'Inf', - 'NaN' and '-Inf' encode to 'null'. Which is stricter JSON than the Python - version. - + Helper class that wraps values of certain types and produces a custom + __repr__() that may be elided and is suitable for use during pretty + printing """ - def coerce_to_strict(self, const): - """ - This is used to ultimately *encode* into strict JSON, see `encode` - - """ - # before python 2.7, 'true', 'false', 'null', were include here. - if const in ('Infinity', '-Infinity', 'NaN'): - return None - else: - return const - - def encode(self, o): - """ - Load and then dump the result using parse_constant kwarg - - Note that setting invalid separators will cause a failure at this step. - - """ - - # this will raise errors in a normal-expected way - encoded_o = super(PlotlyJSONEncoder, self).encode(o) - - # now: - # 1. `loads` to switch Infinity, -Infinity, NaN to None - # 2. `dumps` again so you get 'null' instead of extended JSON - try: - new_o = _json.loads(encoded_o, - parse_constant=self.coerce_to_strict) - except ValueError: - - # invalid separators will fail here. raise a helpful exception - raise ValueError( - "Encoding into strict JSON failed. Did you set the separators " - "valid JSON separators?" - ) - else: - return _json.dumps(new_o, sort_keys=self.sort_keys, - indent=self.indent, - separators=(self.item_separator, - self.key_separator)) - - def default(self, obj): - """ - Accept an object (of unknown type) and try to encode with priority: - 1. builtin: user-defined objects - 2. sage: sage math cloud - 3. pandas: dataframes/series - 4. numpy: ndarrays - 5. datetime: time/datetime objects - - Each method throws a NotEncoded exception if it fails. - - The default method will only get hit if the object is not a type that - is naturally encoded by json: - - Normal objects: - dict object - list, tuple array - str, unicode string - int, long, float number - True true - False false - None null - - Extended objects: - float('nan') 'NaN' - float('infinity') 'Infinity' - float('-infinity') '-Infinity' - - Therefore, we only anticipate either unknown iterables or values here. - - """ - # TODO: The ordering if these methods is *very* important. Is this OK? - encoding_methods = ( - self.encode_as_plotly, - self.encode_as_sage, - self.encode_as_numpy, - self.encode_as_pandas, - self.encode_as_datetime, - self.encode_as_date, - self.encode_as_list, # because some values have `tolist` do last. - self.encode_as_decimal - ) - for encoding_method in encoding_methods: - try: - return encoding_method(obj) - except NotEncodable: - pass - return _json.JSONEncoder.default(self, obj) - - @staticmethod - def encode_as_plotly(obj): - """Attempt to use a builtin `to_plotly_json` method.""" - try: - return obj.to_plotly_json() - except AttributeError: - raise NotEncodable - - @staticmethod - def encode_as_list(obj): - """Attempt to use `tolist` method to convert to normal Python list.""" - if hasattr(obj, 'tolist'): - return obj.tolist() - else: - raise NotEncodable - - @staticmethod - def encode_as_sage(obj): - """Attempt to convert sage.all.RR to floats and sage.all.ZZ to ints""" - if not sage_all: - raise NotEncodable - - if obj in sage_all.RR: - return float(obj) - elif obj in sage_all.ZZ: - return int(obj) - else: - raise NotEncodable + def __init__(self, v, threshold, indent): + self.v = v + self.indent = indent + self.threshold = threshold @staticmethod - def encode_as_pandas(obj): - """Attempt to convert pandas.NaT""" - if not pandas: - raise NotEncodable - - if obj is pandas.NaT: - return None + def is_wrappable(v): + numpy = get_module('numpy') + if (isinstance(v, (list, tuple)) and + len(v) > 0 and + not isinstance(v[0], dict)): + return True + elif numpy and isinstance(v, numpy.ndarray): + return True + elif isinstance(v, str): + return True else: - raise NotEncodable - - @staticmethod - def encode_as_numpy(obj): - """Attempt to convert numpy.ma.core.masked""" - if not numpy: - raise NotEncodable + return False - if obj is numpy.ma.core.masked: - return float('nan') - else: - raise NotEncodable + def __repr__(self): + numpy = get_module('numpy') + if isinstance(self.v, (list, tuple)): + # Handle lists/tuples + res = _list_repr_elided(self.v, + threshold=self.threshold, + indent=self.indent) + return res + elif numpy and isinstance(self.v, numpy.ndarray): + # Handle numpy arrays - @staticmethod - def encode_as_datetime(obj): - """Attempt to convert to utc-iso time string using datetime methods.""" - # Since PY36, isoformat() converts UTC - # datetime.datetime objs to UTC T04:00:00 - if not (PY36_OR_LATER and (isinstance(obj, datetime.datetime) and - obj.tzinfo is None)): - try: - obj = obj.astimezone(pytz.utc) - except ValueError: - # we'll get a value error if trying to convert with naive datetime - pass - except TypeError: - # pandas throws a typeerror here instead of a value error, it's OK - pass - except AttributeError: - # we'll get an attribute error if astimezone DNE - raise NotEncodable - - # now we need to get a nicely formatted time string - try: - time_string = obj.isoformat() - except AttributeError: - raise NotEncodable - else: - return iso_to_plotly_time_string(time_string) + # Get original print opts + orig_opts = numpy.get_printoptions() - @staticmethod - def encode_as_date(obj): - """Attempt to convert to utc-iso time string using date methods.""" - try: - time_string = obj.isoformat() - except AttributeError: - raise NotEncodable - else: - return iso_to_plotly_time_string(time_string) + # Set threshold to self.max_list_elements + numpy.set_printoptions( + **dict(orig_opts, + threshold=self.threshold, + edgeitems=3, + linewidth=80)) - @staticmethod - def encode_as_decimal(obj): - """Attempt to encode decimal by converting it to float""" - if isinstance(obj, decimal.Decimal): - return float(obj) - else: - raise NotEncodable + res = self.v.__repr__() + # Add indent to all but the first line + res_lines = res.split('\n') + res = ('\n' + ' '*self.indent).join(res_lines) -### unicode stuff ### -def decode_unicode(coll): - if isinstance(coll, list): - for no, entry in enumerate(coll): - if isinstance(entry, (dict, list)): - coll[no] = decode_unicode(entry) + # Restore print opts + numpy.set_printoptions(**orig_opts) + return res + elif isinstance(self.v, str): + # Handle strings + if len(self.v) > 80: + return ('(' + repr(self.v[:30]) + + ' ... ' + repr(self.v[-30:]) + ')') else: - if isinstance(entry, str): - try: - coll[no] = str(entry) - except UnicodeEncodeError: - pass - elif isinstance(coll, dict): - keys, vals = list(coll.keys()), list(coll.values()) - for key, val in zip(keys, vals): - if isinstance(val, (dict, list)): - coll[key] = decode_unicode(val) - elif isinstance(val, str): - try: - coll[key] = str(val) - except UnicodeEncodeError: - pass - coll[str(key)] = coll.pop(key) - return coll + return self.v.__repr__() + else: + return self.v.__repr__() -### docstring templating ### -def template_doc(**names): - def _decorator(func): - if sys.version[:3] != '3.2': - if func.__doc__ is not None: - func.__doc__ = func.__doc__.format(**names) - return func - return _decorator +class ElidedPrettyPrinter(PrettyPrinter): + """ + PrettyPrinter subclass that elides long lists/arrays/strings + """ + def __init__(self, *args, **kwargs): + self.threshold = kwargs.pop('threshold', 200) + PrettyPrinter.__init__(self, *args, **kwargs) + def _format(self, val, stream, indent, allowance, context, level): + if ElidedWrapper.is_wrappable(val): + elided_val = ElidedWrapper( + val, self.threshold, indent) -def get_first_duplicate(items): - seen = set() - for item in items: - if item not in seen: - seen.add(item) + return self._format( + elided_val, stream, indent, allowance, context, level) else: - return item - return None - - -### source key -def is_source_key(key): - src_regex = re.compile(r'.+src$') - if src_regex.match(key) is not None: - return True - else: - return False + return PrettyPrinter._format( + self, val, stream, indent, allowance, context, level) def node_generator(node, path=()): @@ -441,65 +187,29 @@ def get_by_path(obj, path): return obj -### validation -def validate_world_readable_and_sharing_settings(option_set): - if ('world_readable' in option_set and - option_set['world_readable'] is True and - 'sharing' in option_set and - option_set['sharing'] is not None and - option_set['sharing'] != 'public'): - raise PlotlyError( - "Looks like you are setting your plot privacy to both " - "public and private.\n If you set world_readable as True, " - "sharing can only be set to 'public'") - elif ('world_readable' in option_set and - option_set['world_readable'] is False and - 'sharing' in option_set and - option_set['sharing'] == 'public'): - raise PlotlyError( - "Looks like you are setting your plot privacy to both " - "public and private.\n If you set world_readable as " - "False, sharing can only be set to 'private' or 'secret'") - elif ('sharing' in option_set and - option_set['sharing'] not in ['public', 'private', 'secret', None]): - raise PlotlyError( - "The 'sharing' argument only accepts one of the following " - "strings:\n'public' -- for public plots\n" - "'private' -- for private plots\n" - "'secret' -- for private plots that can be shared with a " - "secret url" - ) - - -def validate_plotly_domains(option_set): - domains_not_none = [] - for d in ['plotly_domain', 'plotly_api_domain']: - if d in option_set and option_set[d]: - domains_not_none.append(option_set[d]) - - if not all(d.lower().startswith('https') for d in domains_not_none): - warnings.warn(http_msg, category=UserWarning) - - -def set_sharing_and_world_readable(option_set): - if 'world_readable' in option_set and 'sharing' not in option_set: - option_set['sharing'] = ( - 'public' if option_set['world_readable'] else 'private') - - elif 'sharing' in option_set and 'world_readable' not in option_set: - if option_set['sharing'] == 'public': - option_set['world_readable'] = True - else: - option_set['world_readable'] = False - - -def _default_memoize_key_function(*args, **kwargs): - """Factored out in case we want to allow callers to specify this func.""" - if kwargs: - # frozenset is used to ensure hashability - return args, frozenset(kwargs.items()) - else: - return args +def decode_unicode(coll): + if isinstance(coll, list): + for no, entry in enumerate(coll): + if isinstance(entry, (dict, list)): + coll[no] = decode_unicode(entry) + else: + if isinstance(entry, str): + try: + coll[no] = str(entry) + except UnicodeEncodeError: + pass + elif isinstance(coll, dict): + keys, vals = list(coll.keys()), list(coll.values()) + for key, val in zip(keys, vals): + if isinstance(val, (dict, list)): + coll[key] = decode_unicode(val) + elif isinstance(val, str): + try: + coll[key] = str(val) + except UnicodeEncodeError: + pass + coll[str(key)] = coll.pop(key) + return coll def memoize(maxsize=128): @@ -537,123 +247,16 @@ def _memoize(*all_args, **kwargs): return decorator(_memoize) -def _list_repr_elided(v, threshold=200, edgeitems=3, indent=0, width=80): - """ - Return a string representation for of a list where list is elided if - it has more than n elements - - Parameters - ---------- - v : list - Input list - threshold : - Maximum number of elements to display - - Returns - ------- - str - """ - if isinstance(v, list): - open_char, close_char = '[', ']' - elif isinstance(v, tuple): - open_char, close_char = '(', ')' - else: - raise ValueError('Invalid value of type: %s' % type(v)) - - if len(v) <= threshold: - disp_v = v +def _default_memoize_key_function(*args, **kwargs): + """Factored out in case we want to allow callers to specify this func.""" + if kwargs: + # frozenset is used to ensure hashability + return args, frozenset(kwargs.items()) else: - disp_v = (list(v[:edgeitems]) - + ['...'] + - list(v[-edgeitems:])) - - v_str = open_char + ', '.join([str(e) for e in disp_v]) + close_char - - v_wrapped = '\n'.join(textwrap.wrap(v_str, width=width, - initial_indent=' ' * (indent + 1), - subsequent_indent =' ' * (indent + 1))).strip() - return v_wrapped - - -class ElidedWrapper(object): - """ - Helper class that wraps values of certain types and produces a custom - __repr__() that may be elided and is suitable for use during pretty - printing - """ - def __init__(self, v, threshold, indent): - self.v = v - self.indent = indent - self.threshold = threshold - - @staticmethod - def is_wrappable(v): - if (isinstance(v, (list, tuple)) and - len(v) > 0 and - not isinstance(v[0], dict)): - return True - elif numpy and isinstance(v, numpy.ndarray): - return True - elif isinstance(v, str): - return True - else: - return False - - def __repr__(self): - if isinstance(self.v, (list, tuple)): - # Handle lists/tuples - res = _list_repr_elided(self.v, - threshold=self.threshold, - indent=self.indent) - return res - elif numpy and isinstance(self.v, numpy.ndarray): - # Handle numpy arrays - - # Get original print opts - orig_opts = numpy.get_printoptions() - - # Set threshold to self.max_list_elements - numpy.set_printoptions( - **dict(orig_opts, - threshold=self.threshold, - edgeitems=3, - linewidth=80)) - - res = self.v.__repr__() - - # Add indent to all but the first line - res_lines = res.split('\n') - res = ('\n' + ' '*self.indent).join(res_lines) - - # Restore print opts - numpy.set_printoptions(**orig_opts) - return res - elif isinstance(self.v, str): - # Handle strings - if len(self.v) > 80: - return ('(' + repr(self.v[:30]) + - ' ... ' + repr(self.v[-30:]) + ')') - else: - return self.v.__repr__() - else: - return self.v.__repr__() - + return args -class ElidedPrettyPrinter(PrettyPrinter): - """ - PrettyPrinter subclass that elides long lists/arrays/strings - """ - def __init__(self, *args, **kwargs): - self.threshold = kwargs.pop('threshold', 200) - PrettyPrinter.__init__(self, *args, **kwargs) - def _format(self, val, stream, indent, allowance, context, level): - if ElidedWrapper.is_wrappable(val): - elided_val = ElidedWrapper( - val, self.threshold, indent) - - return self._format( - elided_val, stream, indent, allowance, context, level) - else: - return PrettyPrinter._format( - self, val, stream, indent, allowance, context, level) +# Deprecations +from _plotly_future_ import _future_flags +if 'remove_deprecations' not in _future_flags: + from chart_studio.utils import * diff --git a/plotly/validators/__init__.py b/plotly/validators/__init__.py index 8cd53041a7f..ba7b8caf823 100644 --- a/plotly/validators/__init__.py +++ b/plotly/validators/__init__.py @@ -1,40 +1,8718 @@ -from ._violin import ViolinValidator -from ._table import TableValidator -from ._surface import SurfaceValidator -from ._streamtube import StreamtubeValidator -from ._splom import SplomValidator -from ._scatterternary import ScatterternaryValidator -from ._scatterpolargl import ScatterpolarglValidator -from ._scatterpolar import ScatterpolarValidator -from ._scattermapbox import ScattermapboxValidator -from ._scattergl import ScatterglValidator -from ._scattergeo import ScattergeoValidator -from ._scattercarpet import ScattercarpetValidator -from ._scatter3d import Scatter3dValidator -from ._scatter import ScatterValidator -from ._sankey import SankeyValidator -from ._pointcloud import PointcloudValidator -from ._pie import PieValidator -from ._parcoords import ParcoordsValidator -from ._parcats import ParcatsValidator -from ._ohlc import OhlcValidator -from ._mesh3d import Mesh3dValidator -from ._isosurface import IsosurfaceValidator -from ._histogram2dcontour import Histogram2dContourValidator -from ._histogram2d import Histogram2dValidator -from ._histogram import HistogramValidator -from ._heatmapgl import HeatmapglValidator -from ._heatmap import HeatmapValidator -from ._contourcarpet import ContourcarpetValidator -from ._contour import ContourValidator -from ._cone import ConeValidator -from ._choropleth import ChoroplethValidator -from ._carpet import CarpetValidator -from ._candlestick import CandlestickValidator -from ._box import BoxValidator -from ._barpolar import BarpolarValidator -from ._bar import BarValidator -from ._area import AreaValidator -from ._layout import LayoutValidator -from ._frames import FramesValidator -from ._data import DataValidator + + +import _plotly_utils.basevalidators + + +class LayoutValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='layout', parent_name='', **kwargs): + super(LayoutValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Layout'), + data_docs=kwargs.pop( + 'data_docs', """ + angularaxis + plotly.graph_objs.layout.AngularAxis instance + or dict with compatible properties + annotations + plotly.graph_objs.layout.Annotation instance or + dict with compatible properties + annotationdefaults + When used in a template (as + layout.template.layout.annotationdefaults), + sets the default property values to use for + elements of layout.annotations + autosize + Determines whether or not a layout width or + height that has been left undefined by the user + is initialized on each relayout. Note that, + regardless of this attribute, an undefined + layout width or height is always initialized on + the first call to plot. + bargap + Sets the gap (in plot fraction) between bars of + adjacent location coordinates. + bargroupgap + Sets the gap (in plot fraction) between bars of + the same location coordinate. + barmode + Determines how bars at the same location + coordinate are displayed on the graph. With + "stack", the bars are stacked on top of one + another With "relative", the bars are stacked + on top of one another, with negative values + below the axis, positive values above With + "group", the bars are plotted next to one + another centered around the shared location. + With "overlay", the bars are plotted over one + another, you might need to an "opacity" to see + multiple bars. + barnorm + Sets the normalization for bar traces on the + graph. With "fraction", the value of each bar + is divided by the sum of all values at that + location coordinate. "percent" is the same but + multiplied by 100 to show percentages. + boxgap + Sets the gap (in plot fraction) between boxes + of adjacent location coordinates. Has no effect + on traces that have "width" set. + boxgroupgap + Sets the gap (in plot fraction) between boxes + of the same location coordinate. Has no effect + on traces that have "width" set. + boxmode + Determines how boxes at the same location + coordinate are displayed on the graph. If + "group", the boxes are plotted next to one + another centered around the shared location. If + "overlay", the boxes are plotted over one + another, you might need to set "opacity" to see + them multiple boxes. Has no effect on traces + that have "width" set. + calendar + Sets the default calendar system to use for + interpreting and displaying dates throughout + the plot. + clickmode + Determines the mode of single click + interactions. "event" is the default value and + emits the `plotly_click` event. In addition + this mode emits the `plotly_selected` event in + drag modes "lasso" and "select", but with no + event data attached (kept for compatibility + reasons). The "select" flag enables selecting + single data points via click. This mode also + supports persistent selections, meaning that + pressing Shift while clicking, adds to / + subtracts from an existing selection. "select" + with `hovermode`: "x" can be confusing, + consider explicitly setting `hovermode`: + "closest" when using this feature. Selection + events are sent accordingly as long as "event" + flag is set as well. When the "event" flag is + missing, `plotly_click` and `plotly_selected` + events are not fired. + colorscale + plotly.graph_objs.layout.Colorscale instance or + dict with compatible properties + colorway + Sets the default trace colors. + datarevision + If provided, a changed value tells + `Plotly.react` that one or more data arrays has + changed. This way you can modify arrays in- + place rather than making a complete new copy + for an incremental change. If NOT provided, + `Plotly.react` assumes that data arrays are + being treated as immutable, thus any data array + with a different identity from its predecessor + contains new data. + direction + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the direction + corresponding to positive angles in legacy + polar charts. + dragmode + Determines the mode of drag interactions. + "select" and "lasso" apply only to scatter + traces with markers or text. "orbit" and + "turntable" apply only to 3D scenes. + editrevision + Controls persistence of user-driven changes in + `editable: true` configuration, other than + trace names and axis titles. Defaults to + `layout.uirevision`. + extendpiecolors + If `true`, the pie slice colors (whether given + by `piecolorway` or inherited from `colorway`) + will be extended to three times its original + length by first repeating every color 20% + lighter then each color 20% darker. This is + intended to reduce the likelihood of reusing + the same color when you have many slices, but + you can set `false` to disable. Colors provided + in the trace, using `marker.colors`, are never + extended. + font + Sets the global font. Note that fonts used in + traces and other layout components inherit from + the global font. + geo + plotly.graph_objs.layout.Geo instance or dict + with compatible properties + grid + plotly.graph_objs.layout.Grid instance or dict + with compatible properties + height + Sets the plot's height (in px). + hiddenlabels + + hiddenlabelssrc + Sets the source reference on plot.ly for + hiddenlabels . + hidesources + Determines whether or not a text link citing + the data source is placed at the bottom-right + cored of the figure. Has only an effect only on + graphs that have been generated via forked + graphs from the plotly service (at + https://plot.ly or on-premise). + hoverdistance + Sets the default distance (in pixels) to look + for data to add hover labels (-1 means no + cutoff, 0 means no looking for data). This is + only a real distance for hovering on point-like + objects, like scatter points. For area-like + objects (bars, scatter fills, etc) hovering is + on inside the area and off outside, but these + objects will not supersede hover on point-like + objects in case of conflict. + hoverlabel + plotly.graph_objs.layout.Hoverlabel instance or + dict with compatible properties + hovermode + Determines the mode of hover interactions. If + `clickmode` includes the "select" flag, + `hovermode` defaults to "closest". If + `clickmode` lacks the "select" flag, it + defaults to "x" or "y" (depending on the + trace's `orientation` value) for plots based on + cartesian coordinates. For anything else the + default value is "closest". + images + plotly.graph_objs.layout.Image instance or dict + with compatible properties + imagedefaults + When used in a template (as + layout.template.layout.imagedefaults), sets the + default property values to use for elements of + layout.images + legend + plotly.graph_objs.layout.Legend instance or + dict with compatible properties + mapbox + plotly.graph_objs.layout.Mapbox instance or + dict with compatible properties + margin + plotly.graph_objs.layout.Margin instance or + dict with compatible properties + meta + Assigns extra meta information that can be used + in various `text` attributes. Attributes such + as the graph, axis and colorbar `title.text`, + annotation `text` `trace.name` in legend items, + `rangeselector`, `updatemenues` and `sliders` + `label` text all support `meta`. One can access + `meta` fields using template strings: + `%{meta[i]}` where `i` is the index of the + `meta` item in question. + metasrc + Sets the source reference on plot.ly for meta + . + modebar + plotly.graph_objs.layout.Modebar instance or + dict with compatible properties + orientation + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Rotates the entire + polar by the given angle in legacy polar + charts. + paper_bgcolor + Sets the color of paper where the graph is + drawn. + piecolorway + Sets the default pie slice colors. Defaults to + the main `colorway` used for trace colors. If + you specify a new list here it can still be + extended with lighter and darker colors, see + `extendpiecolors`. + plot_bgcolor + Sets the color of plotting area in-between x + and y axes. + polar + plotly.graph_objs.layout.Polar instance or dict + with compatible properties + radialaxis + plotly.graph_objs.layout.RadialAxis instance or + dict with compatible properties + scene + plotly.graph_objs.layout.Scene instance or dict + with compatible properties + selectdirection + When "dragmode" is set to "select", this limits + the selection of the drag to horizontal, + vertical or diagonal. "h" only allows + horizontal selection, "v" only vertical, "d" + only diagonal and "any" sets no limit. + selectionrevision + Controls persistence of user-driven changes in + selected points from all traces. + separators + Sets the decimal and thousand separators. For + example, *. * puts a '.' before decimals and a + space between thousands. In English locales, + dflt is ".," but other locales may alter this + default. + shapes + plotly.graph_objs.layout.Shape instance or dict + with compatible properties + shapedefaults + When used in a template (as + layout.template.layout.shapedefaults), sets the + default property values to use for elements of + layout.shapes + showlegend + Determines whether or not a legend is drawn. + Default is `true` if there is a trace to show + and any of these: a) Two or more traces would + by default be shown in the legend. b) One pie + trace is shown in the legend. c) One trace is + explicitly given with `showlegend: true`. + sliders + plotly.graph_objs.layout.Slider instance or + dict with compatible properties + sliderdefaults + When used in a template (as + layout.template.layout.sliderdefaults), sets + the default property values to use for elements + of layout.sliders + spikedistance + Sets the default distance (in pixels) to look + for data to draw spikelines to (-1 means no + cutoff, 0 means no looking for data). As with + hoverdistance, distance does not apply to area- + like objects. In addition, some objects can be + hovered on but will not generate spikelines, + such as scatter fills. + template + Default attributes to be applied to the plot. + This should be a dict with format: `{'layout': + layoutTemplate, 'data': {trace_type: + [traceTemplate, ...], ...}}` where + `layoutTemplate` is a dict matching the + structure of `figure.layout` and + `traceTemplate` is a dict matching the + structure of the trace with type `trace_type` + (e.g. 'scatter'). Alternatively, this may be + specified as an instance of + plotly.graph_objs.layout.Template. Trace + templates are applied cyclically to traces of + each type. Container arrays (eg `annotations`) + have special handling: An object ending in + `defaults` (eg `annotationdefaults`) is applied + to each array item. But if an item has a + `templateitemname` key we look in the template + array for an item with matching `name` and + apply that instead. If no matching `name` is + found we mark the item invisible. Any named + template item not referenced is appended to the + end of the array, so this can be used to add a + watermark annotation or a logo image, for + example. To omit one of these items on the + plot, make an item with matching + `templateitemname` and `visible: false`. + ternary + plotly.graph_objs.layout.Ternary instance or + dict with compatible properties + title + plotly.graph_objs.layout.Title instance or dict + with compatible properties + titlefont + Deprecated: Please use layout.title.font + instead. Sets the title font. Note that the + title's font used to be customized by the now + deprecated `titlefont` attribute. + transition + Sets transition options used during + Plotly.react updates. + uirevision + Used to allow user interactions with the plot + to persist after `Plotly.react` calls that are + unaware of these interactions. If `uirevision` + is omitted, or if it is given and it changed + from the previous `Plotly.react` call, the + exact new figure is used. If `uirevision` is + truthy and did NOT change, any attribute that + has been affected by user interactions and did + not receive a different value in the new figure + will keep the interaction value. + `layout.uirevision` attribute serves as the + default for `uirevision` attributes in various + sub-containers. For finer control you can set + these sub-attributes directly. For example, if + your app separately controls the data on the x + and y axes you might set + `xaxis.uirevision=*time*` and + `yaxis.uirevision=*cost*`. Then if only the y + data is changed, you can update + `yaxis.uirevision=*quantity*` and the y axis + range will reset but the x axis range will + retain any user-driven zoom. + updatemenus + plotly.graph_objs.layout.Updatemenu instance or + dict with compatible properties + updatemenudefaults + When used in a template (as + layout.template.layout.updatemenudefaults), + sets the default property values to use for + elements of layout.updatemenus + violingap + Sets the gap (in plot fraction) between violins + of adjacent location coordinates. Has no effect + on traces that have "width" set. + violingroupgap + Sets the gap (in plot fraction) between violins + of the same location coordinate. Has no effect + on traces that have "width" set. + violinmode + Determines how violins at the same location + coordinate are displayed on the graph. If + "group", the violins are plotted next to one + another centered around the shared location. If + "overlay", the violins are plotted over one + another, you might need to set "opacity" to see + them multiple violins. Has no effect on traces + that have "width" set. + width + Sets the plot's width (in px). + xaxis + plotly.graph_objs.layout.XAxis instance or dict + with compatible properties + yaxis + plotly.graph_objs.layout.YAxis instance or dict + with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ViolinValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='violin', parent_name='', **kwargs): + super(ViolinValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Violin'), + data_docs=kwargs.pop( + 'data_docs', """ + alignmentgroup + Set several traces linked to the same position + axis or matching axes to the same + alignmentgroup. This controls whether bars + compute their positional range dependently or + independently. + bandwidth + Sets the bandwidth used to compute the kernel + density estimate. By default, the bandwidth is + determined by Silverman's rule of thumb. + box + plotly.graph_objs.violin.Box instance or dict + with compatible properties + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + fillcolor + Sets the fill color. Defaults to a half- + transparent variant of the line color, marker + color, or marker line color, whichever is + available. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.violin.Hoverlabel instance or + dict with compatible properties + hoveron + Do the hover effects highlight individual + violins or sample points or the kernel density + estimate or any combination of them? + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + jitter + Sets the amount of jitter in the sample points + drawn. If 0, the sample points align along the + distribution axis. If 1, the sample points are + drawn in a random jitter of width equal to the + width of the violins. + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.violin.Line instance or dict + with compatible properties + marker + plotly.graph_objs.violin.Marker instance or + dict with compatible properties + meanline + plotly.graph_objs.violin.Meanline instance or + dict with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. For box traces, + the name will also be used for the position + coordinate, if `x` and `x0` (`y` and `y0` if + horizontal) are missing and the position axis + is categorical + offsetgroup + Set several traces linked to the same position + axis or matching axes to the same offsetgroup + where bars of the same position coordinate will + line up. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the violin(s). If "v" + ("h"), the distribution is visualized along the + vertical (horizontal). + pointpos + Sets the position of the sample points in + relation to the violins. If 0, the sample + points are places over the center of the + violins. Positive (negative) values correspond + to positions to the right (left) for vertical + violins and above (below) for horizontal + violins. + points + If "outliers", only the sample points lying + outside the whiskers are shown If + "suspectedoutliers", the outlier points are + shown and points either less than 4*Q1-3*Q3 or + greater than 4*Q3-3*Q1 are highlighted (see + `outliercolor`) If "all", all sample points are + shown If False, only the violins are shown with + no sample points + scalegroup + If there are multiple violins that should be + sized according to to some metric (see + `scalemode`), link them by providing a non- + empty group id here shared by every trace in + the same group. + scalemode + Sets the metric by which the width of each + violin is determined."width" means each violin + has the same (max) width*count* means the + violins are scaled by the number of sample + points makingup each violin. + selected + plotly.graph_objs.violin.Selected instance or + dict with compatible properties + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + side + Determines on which side of the position value + the density function making up one half of a + violin is plotted. Useful when comparing two + violin traces under "overlay" mode, where one + trace has `side` set to "positive" and the + other to "negative". + span + Sets the span in data space for which the + density function will be computed. Has an + effect only when `spanmode` is set to "manual". + spanmode + Sets the method by which the span in data space + where the density function will be computed. + "soft" means the span goes from the sample's + minimum value minus two bandwidths to the + sample's maximum value plus two bandwidths. + "hard" means the span goes from the sample's + minimum to its maximum value. For custom span + settings, use mode "manual" and fill in the + `span` attribute. + stream + plotly.graph_objs.violin.Stream instance or + dict with compatible properties + text + Sets the text elements associated with each + sample value. If a single string, the same + string appears over all the data points. If an + array of string, the items are mapped in order + to the this trace's (x,y) coordinates. To be + seen, trace `hoverinfo` must contain a "text" + flag. + textsrc + Sets the source reference on plot.ly for text + . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + unselected + plotly.graph_objs.violin.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + width + Sets the width of the violin in data + coordinates. If 0 (default value) the width is + automatically selected based on the positions + of other violin traces in the same subplot. + x + Sets the x sample data or coordinates. See + overview for more info. + x0 + Sets the x coordinate of the box. See overview + for more info. + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y sample data or coordinates. See + overview for more info. + y0 + Sets the y coordinate of the box. See overview + for more info. + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. + ysrc + Sets the source reference on plot.ly for y . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TableValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='table', parent_name='', **kwargs): + super(TableValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Table'), + data_docs=kwargs.pop( + 'data_docs', """ + cells + plotly.graph_objs.table.Cells instance or dict + with compatible properties + columnorder + Specifies the rendered order of the data + columns; for example, a value `2` at position + `0` means that column index `0` in the data + will be rendered as the third column, as + columns have an index base of zero. + columnordersrc + Sets the source reference on plot.ly for + columnorder . + columnwidth + The width of columns expressed as a ratio. + Columns fill the available width in proportion + of their specified column widths. + columnwidthsrc + Sets the source reference on plot.ly for + columnwidth . + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + domain + plotly.graph_objs.table.Domain instance or dict + with compatible properties + header + plotly.graph_objs.table.Header instance or dict + with compatible properties + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.table.Hoverlabel instance or + dict with compatible properties + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.table.Stream instance or dict + with compatible properties + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SurfaceValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='surface', parent_name='', **kwargs): + super(SurfaceValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Surface'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `colorscale`. In case + `colorscale` is unspecified or `autocolorscale` + is true, the default palette will be chosen + according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here z + or surfacecolor) or the bounds set in `cmin` + and `cmax` Defaults to `false` when `cmin` and + `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value + should have the same units as z or surfacecolor + and if set, `cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `cmin` and/or `cmax` to be equidistant + to this point. Value should have the same units + as z or surfacecolor. Has no effect when + `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value + should have the same units as z or surfacecolor + and if set, `cmax` must be set as well. + colorbar + plotly.graph_objs.surface.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. The colorscale must be an + array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named + color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. + For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and + `cmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Grey + s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, + Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth + ,Electric,Viridis,Cividis. + contours + plotly.graph_objs.surface.Contours instance or + dict with compatible properties + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + hidesurface + Determines whether or not a surface is drawn. + For example, set `hidesurface` to False + `contours.x.show` to True and `contours.y.show` + to True to draw a wire frame plot. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.surface.Hoverlabel instance + or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + lighting + plotly.graph_objs.surface.Lighting instance or + dict with compatible properties + lightposition + plotly.graph_objs.surface.Lightposition + instance or dict with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the surface. Please note + that in the case of using high `opacity` values + for example a value greater than or equal to + 0.5 on two surfaces (and 0.25 with four + surfaces), an overlay of multiple transparent + surfaces may not perfectly be sorted in depth + by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, + `cmin` will correspond to the last color in the + array and `cmax` will correspond to the first + color. + scene + Sets a reference between this trace's 3D + coordinate system and a 3D scene. If "scene" + (the default value), the (x,y,z) coordinates + refer to `layout.scene`. If "scene2", the + (x,y,z) coordinates refer to `layout.scene2`, + and so on. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + showscale + Determines whether or not a colorbar is + displayed for this trace. + stream + plotly.graph_objs.surface.Stream instance or + dict with compatible properties + surfacecolor + Sets the surface color values, used for setting + a color scale independent of `z`. + surfacecolorsrc + Sets the source reference on plot.ly for + surfacecolor . + text + Sets the text elements associated with each z + value. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements + will be seen in the hover labels. + textsrc + Sets the source reference on plot.ly for text + . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + x + Sets the x coordinates. + xcalendar + Sets the calendar system to use with `x` date + data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates. + ycalendar + Sets the calendar system to use with `y` date + data. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the z coordinates. + zcalendar + Sets the calendar system to use with `z` date + data. + zsrc + Sets the source reference on plot.ly for z . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamtubeValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='streamtube', parent_name='', **kwargs): + super(StreamtubeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Streamtube'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `colorscale`. In case + `colorscale` is unspecified or `autocolorscale` + is true, the default palette will be chosen + according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + u/v/w norm) or the bounds set in `cmin` and + `cmax` Defaults to `false` when `cmin` and + `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value + should have the same units as u/v/w norm and if + set, `cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `cmin` and/or `cmax` to be equidistant + to this point. Value should have the same units + as u/v/w norm. Has no effect when `cauto` is + `false`. + cmin + Sets the lower bound of the color domain. Value + should have the same units as u/v/w norm and if + set, `cmax` must be set as well. + colorbar + plotly.graph_objs.streamtube.ColorBar instance + or dict with compatible properties + colorscale + Sets the colorscale. The colorscale must be an + array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named + color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. + For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and + `cmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Grey + s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, + Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth + ,Electric,Viridis,Cividis. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.streamtube.Hoverlabel + instance or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + variables `tubex`, `tubey`, `tubez`, `tubeu`, + `tubev`, `tubew`, `norm` and `divergence`. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Same as `text`. + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + lighting + plotly.graph_objs.streamtube.Lighting instance + or dict with compatible properties + lightposition + plotly.graph_objs.streamtube.Lightposition + instance or dict with compatible properties + maxdisplayed + The maximum number of displayed segments in a + streamtube. + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the surface. Please note + that in the case of using high `opacity` values + for example a value greater than or equal to + 0.5 on two surfaces (and 0.25 with four + surfaces), an overlay of multiple transparent + surfaces may not perfectly be sorted in depth + by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, + `cmin` will correspond to the last color in the + array and `cmax` will correspond to the first + color. + scene + Sets a reference between this trace's 3D + coordinate system and a 3D scene. If "scene" + (the default value), the (x,y,z) coordinates + refer to `layout.scene`. If "scene2", the + (x,y,z) coordinates refer to `layout.scene2`, + and so on. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + showscale + Determines whether or not a colorbar is + displayed for this trace. + sizeref + The scaling factor for the streamtubes. The + default is 1, which avoids two max divergence + tubes from touching at adjacent starting + positions. + starts + plotly.graph_objs.streamtube.Starts instance or + dict with compatible properties + stream + plotly.graph_objs.streamtube.Stream instance or + dict with compatible properties + text + Sets a text element associated with this trace. + If trace `hoverinfo` contains a "text" flag, + this text element will be seen in all hover + labels. Note that streamtube traces do not + support array `text` values. + u + Sets the x components of the vector field. + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + usrc + Sets the source reference on plot.ly for u . + v + Sets the y components of the vector field. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + vsrc + Sets the source reference on plot.ly for v . + w + Sets the z components of the vector field. + wsrc + Sets the source reference on plot.ly for w . + x + Sets the x coordinates of the vector field. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates of the vector field. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the z coordinates of the vector field. + zsrc + Sets the source reference on plot.ly for z . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SplomValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='splom', parent_name='', **kwargs): + super(SplomValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Splom'), + data_docs=kwargs.pop( + 'data_docs', """ + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + diagonal + plotly.graph_objs.splom.Diagonal instance or + dict with compatible properties + dimensions + plotly.graph_objs.splom.Dimension instance or + dict with compatible properties + dimensiondefaults + When used in a template (as + layout.template.data.splom.dimensiondefaults), + sets the default property values to use for + elements of splom.dimensions + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.splom.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + marker + plotly.graph_objs.splom.Marker instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.splom.Selected instance or + dict with compatible properties + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + showlowerhalf + Determines whether or not subplots on the lower + half from the diagonal are displayed. + showupperhalf + Determines whether or not subplots on the upper + half from the diagonal are displayed. + stream + plotly.graph_objs.splom.Stream instance or dict + with compatible properties + text + Sets text elements associated with each (x,y) + pair to appear on hover. If a single string, + the same string appears over all the data + points. If an array of string, the items are + mapped in order to the this trace's (x,y) + coordinates. + textsrc + Sets the source reference on plot.ly for text + . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + unselected + plotly.graph_objs.splom.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + xaxes + Sets the list of x axes corresponding to + dimensions of this splom trace. By default, a + splom will match the first N xaxes where N is + the number of input dimensions. Note that, in + case where `diagonal.visible` is false and + `showupperhalf` or `showlowerhalf` is false, + this splom trace will generate one less x-axis + and one less y-axis. + yaxes + Sets the list of y axes corresponding to + dimensions of this splom trace. By default, a + splom will match the first N yaxes where N is + the number of input dimensions. Note that, in + case where `diagonal.visible` is false and + `showupperhalf` or `showlowerhalf` is false, + this splom trace will generate one less x-axis + and one less y-axis. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScatterternaryValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='scatterternary', parent_name='', **kwargs): + super(ScatterternaryValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scatterternary'), + data_docs=kwargs.pop( + 'data_docs', """ + a + Sets the quantity of component `a` in each data + point. If `a`, `b`, and `c` are all provided, + they need not be normalized, only the relative + values matter. If only two arrays are provided + they must be normalized to match + `ternary.sum`. + asrc + Sets the source reference on plot.ly for a . + b + Sets the quantity of component `a` in each data + point. If `a`, `b`, and `c` are all provided, + they need not be normalized, only the relative + values matter. If only two arrays are provided + they must be normalized to match + `ternary.sum`. + bsrc + Sets the source reference on plot.ly for b . + c + Sets the quantity of component `a` in each data + point. If `a`, `b`, and `c` are all provided, + they need not be normalized, only the relative + values matter. If only two arrays are provided + they must be normalized to match + `ternary.sum`. + cliponaxis + Determines whether or not markers and text + nodes are clipped about the subplot axes. To + show markers and text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` + and `yaxis.layer` to *below traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or + missing values) in the provided data arrays are + connected. + csrc + Sets the source reference on plot.ly for c . + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + fill + Sets the area to fill with a solid color. Use + with `fillcolor` if not "none". scatterternary + has a subset of the options available to + scatter. "toself" connects the endpoints of the + trace (or each segment of the trace if it has + gaps) into a closed shape. "tonext" fills the + space between two traces if one completely + encloses the other (eg consecutive contour + lines), and behaves like "toself" if there is + no trace before it. "tonext" should not be used + if one trace does not enclose the other. + fillcolor + Sets the fill color. Defaults to a half- + transparent variant of the line color, marker + color, or marker line color, whichever is + available. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.scatterternary.Hoverlabel + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual + points (markers or line points) or do they + highlight filled regions? If the fill is + "toself" or "tonext" and there are no markers + or text, then the default is "fills", otherwise + it is "points". + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Sets hover text elements associated with each + (a,b,c) point. If a single string, the same + string appears over all the data points. If an + array of strings, the items are mapped in order + to the the data points in (a,b,c). To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.scatterternary.Line instance + or dict with compatible properties + marker + plotly.graph_objs.scatterternary.Marker + instance or dict with compatible properties + mode + Determines the drawing mode for this scatter + trace. If the provided `mode` includes "text" + then the `text` elements appear at the + coordinates. Otherwise, the `text` elements + appear on hover. If there are less than 20 + points and the trace is not stacked then the + default is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.scatterternary.Selected + instance or dict with compatible properties + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.scatterternary.Stream + instance or dict with compatible properties + subplot + Sets a reference between this trace's data + coordinates and a ternary subplot. If "ternary" + (the default value), the data refer to + `layout.ternary`. If "ternary2", the data refer + to `layout.ternary2`, and so on. + sum + The number each triplet should sum to, if only + two of `a`, `b`, and `c` are provided. This + overrides `ternary.sum` to normalize this + specific trace, but does not affect the values + displayed on the axes. 0 (or missing) means to + use ternary.sum + text + Sets text elements associated with each (a,b,c) + point. If a single string, the same string + appears over all the data points. If an array + of strings, the items are mapped in order to + the the data points in (a,b,c). If trace + `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with + respects to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for + textposition . + textsrc + Sets the source reference on plot.ly for text + . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + unselected + plotly.graph_objs.scatterternary.Unselected + instance or dict with compatible properties + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScatterpolarglValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='scatterpolargl', parent_name='', **kwargs): + super(ScatterpolarglValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scatterpolargl'), + data_docs=kwargs.pop( + 'data_docs', """ + connectgaps + Determines whether or not gaps (i.e. {nan} or + missing values) in the provided data arrays are + connected. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period + divided by the length of the `r` coordinates. + fill + Sets the area to fill with a solid color. + Defaults to "none" unless this trace is + stacked, then it gets "tonexty" ("tonextx") if + `orientation` is "v" ("h") Use with `fillcolor` + if not "none". "tozerox" and "tozeroy" fill to + x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this + trace and the endpoints of the trace before it, + connecting those endpoints with straight lines + (to make a stacked area graph); if there is no + trace before it, they behave like "tozerox" and + "tozeroy". "toself" connects the endpoints of + the trace (or each segment of the trace if it + has gaps) into a closed shape. "tonext" fills + the space between two traces if one completely + encloses the other (eg consecutive contour + lines), and behaves like "toself" if there is + no trace before it. "tonext" should not be used + if one trace does not enclose the other. Traces + in a `stackgroup` will only fill to (or be + filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked + and some not, if fill-linked traces are not + already consecutive, the later ones will be + pushed down in the drawing order. + fillcolor + Sets the fill color. Defaults to a half- + transparent variant of the line color, marker + color, or marker line color, whichever is + available. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.scatterpolargl.Hoverlabel + instance or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Sets hover text elements associated with each + (x,y) pair. If a single string, the same string + appears over all the data points. If an array + of string, the items are mapped in order to the + this trace's (x,y) coordinates. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.scatterpolargl.Line instance + or dict with compatible properties + marker + plotly.graph_objs.scatterpolargl.Marker + instance or dict with compatible properties + mode + Determines the drawing mode for this scatter + trace. If the provided `mode` includes "text" + then the `text` elements appear at the + coordinates. Otherwise, the `text` elements + appear on hover. If there are less than 20 + points and the trace is not stacked then the + default is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the + starting coordinate and `dr` the step. + rsrc + Sets the source reference on plot.ly for r . + selected + plotly.graph_objs.scatterpolargl.Selected + instance or dict with compatible properties + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.scatterpolargl.Stream + instance or dict with compatible properties + subplot + Sets a reference between this trace's data + coordinates and a polar subplot. If "polar" + (the default value), the data refer to + `layout.polar`. If "polar2", the data refer to + `layout.polar2`, and so on. + text + Sets text elements associated with each (x,y) + pair. If a single string, the same string + appears over all the data points. If an array + of string, the items are mapped in order to the + this trace's (x,y) coordinates. If trace + `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with + respects to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for + textposition . + textsrc + Sets the source reference on plot.ly for text + . + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of + theta coordinates. Use with `dtheta` where + `theta0` is the starting coordinate and + `dtheta` the step. + thetasrc + Sets the source reference on plot.ly for theta + . + thetaunit + Sets the unit of input "theta" values. Has an + effect only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + unselected + plotly.graph_objs.scatterpolargl.Unselected + instance or dict with compatible properties + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScatterpolarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='scatterpolar', parent_name='', **kwargs): + super(ScatterpolarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scatterpolar'), + data_docs=kwargs.pop( + 'data_docs', """ + cliponaxis + Determines whether or not markers and text + nodes are clipped about the subplot axes. To + show markers and text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` + and `yaxis.layer` to *below traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or + missing values) in the provided data arrays are + connected. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period + divided by the length of the `r` coordinates. + fill + Sets the area to fill with a solid color. Use + with `fillcolor` if not "none". scatterpolar + has a subset of the options available to + scatter. "toself" connects the endpoints of the + trace (or each segment of the trace if it has + gaps) into a closed shape. "tonext" fills the + space between two traces if one completely + encloses the other (eg consecutive contour + lines), and behaves like "toself" if there is + no trace before it. "tonext" should not be used + if one trace does not enclose the other. + fillcolor + Sets the fill color. Defaults to a half- + transparent variant of the line color, marker + color, or marker line color, whichever is + available. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.scatterpolar.Hoverlabel + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual + points (markers or line points) or do they + highlight filled regions? If the fill is + "toself" or "tonext" and there are no markers + or text, then the default is "fills", otherwise + it is "points". + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Sets hover text elements associated with each + (x,y) pair. If a single string, the same string + appears over all the data points. If an array + of string, the items are mapped in order to the + this trace's (x,y) coordinates. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.scatterpolar.Line instance or + dict with compatible properties + marker + plotly.graph_objs.scatterpolar.Marker instance + or dict with compatible properties + mode + Determines the drawing mode for this scatter + trace. If the provided `mode` includes "text" + then the `text` elements appear at the + coordinates. Otherwise, the `text` elements + appear on hover. If there are less than 20 + points and the trace is not stacked then the + default is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the + starting coordinate and `dr` the step. + rsrc + Sets the source reference on plot.ly for r . + selected + plotly.graph_objs.scatterpolar.Selected + instance or dict with compatible properties + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.scatterpolar.Stream instance + or dict with compatible properties + subplot + Sets a reference between this trace's data + coordinates and a polar subplot. If "polar" + (the default value), the data refer to + `layout.polar`. If "polar2", the data refer to + `layout.polar2`, and so on. + text + Sets text elements associated with each (x,y) + pair. If a single string, the same string + appears over all the data points. If an array + of string, the items are mapped in order to the + this trace's (x,y) coordinates. If trace + `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with + respects to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for + textposition . + textsrc + Sets the source reference on plot.ly for text + . + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of + theta coordinates. Use with `dtheta` where + `theta0` is the starting coordinate and + `dtheta` the step. + thetasrc + Sets the source reference on plot.ly for theta + . + thetaunit + Sets the unit of input "theta" values. Has an + effect only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + unselected + plotly.graph_objs.scatterpolar.Unselected + instance or dict with compatible properties + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScattermapboxValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='scattermapbox', parent_name='', **kwargs): + super(ScattermapboxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scattermapbox'), + data_docs=kwargs.pop( + 'data_docs', """ + connectgaps + Determines whether or not gaps (i.e. {nan} or + missing values) in the provided data arrays are + connected. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + fill + Sets the area to fill with a solid color. Use + with `fillcolor` if not "none". "toself" + connects the endpoints of the trace (or each + segment of the trace if it has gaps) into a + closed shape. + fillcolor + Sets the fill color. Defaults to a half- + transparent variant of the line color, marker + color, or marker line color, whichever is + available. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.scattermapbox.Hoverlabel + instance or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Sets hover text elements associated with each + (lon,lat) pair If a single string, the same + string appears over all the data points. If an + array of string, the items are mapped in order + to the this trace's (lon,lat) coordinates. To + be seen, trace `hoverinfo` must contain a + "text" flag. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + lat + Sets the latitude coordinates (in degrees + North). + latsrc + Sets the source reference on plot.ly for lat . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.scattermapbox.Line instance + or dict with compatible properties + lon + Sets the longitude coordinates (in degrees + East). + lonsrc + Sets the source reference on plot.ly for lon . + marker + plotly.graph_objs.scattermapbox.Marker instance + or dict with compatible properties + mode + Determines the drawing mode for this scatter + trace. If the provided `mode` includes "text" + then the `text` elements appear at the + coordinates. Otherwise, the `text` elements + appear on hover. + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.scattermapbox.Selected + instance or dict with compatible properties + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.scattermapbox.Stream instance + or dict with compatible properties + subplot + Sets a reference between this trace's data + coordinates and a mapbox subplot. If "mapbox" + (the default value), the data refer to + `layout.mapbox`. If "mapbox2", the data refer + to `layout.mapbox2`, and so on. + text + Sets text elements associated with each + (lon,lat) pair If a single string, the same + string appears over all the data points. If an + array of string, the items are mapped in order + to the this trace's (lon,lat) coordinates. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the icon text font + (color=mapbox.layer.paint.text-color, + size=mapbox.layer.layout.text-size). Has an + effect only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with + respects to the (x,y) coordinates. + textsrc + Sets the source reference on plot.ly for text + . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + unselected + plotly.graph_objs.scattermapbox.Unselected + instance or dict with compatible properties + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScatterglValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='scattergl', parent_name='', **kwargs): + super(ScatterglValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scattergl'), + data_docs=kwargs.pop( + 'data_docs', """ + connectgaps + Determines whether or not gaps (i.e. {nan} or + missing values) in the provided data arrays are + connected. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + dx + Sets the x coordinate step. See `x0` for more + info. + dy + Sets the y coordinate step. See `y0` for more + info. + error_x + plotly.graph_objs.scattergl.ErrorX instance or + dict with compatible properties + error_y + plotly.graph_objs.scattergl.ErrorY instance or + dict with compatible properties + fill + Sets the area to fill with a solid color. + Defaults to "none" unless this trace is + stacked, then it gets "tonexty" ("tonextx") if + `orientation` is "v" ("h") Use with `fillcolor` + if not "none". "tozerox" and "tozeroy" fill to + x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this + trace and the endpoints of the trace before it, + connecting those endpoints with straight lines + (to make a stacked area graph); if there is no + trace before it, they behave like "tozerox" and + "tozeroy". "toself" connects the endpoints of + the trace (or each segment of the trace if it + has gaps) into a closed shape. "tonext" fills + the space between two traces if one completely + encloses the other (eg consecutive contour + lines), and behaves like "toself" if there is + no trace before it. "tonext" should not be used + if one trace does not enclose the other. Traces + in a `stackgroup` will only fill to (or be + filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked + and some not, if fill-linked traces are not + already consecutive, the later ones will be + pushed down in the drawing order. + fillcolor + Sets the fill color. Defaults to a half- + transparent variant of the line color, marker + color, or marker line color, whichever is + available. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.scattergl.Hoverlabel instance + or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Sets hover text elements associated with each + (x,y) pair. If a single string, the same string + appears over all the data points. If an array + of string, the items are mapped in order to the + this trace's (x,y) coordinates. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.scattergl.Line instance or + dict with compatible properties + marker + plotly.graph_objs.scattergl.Marker instance or + dict with compatible properties + mode + Determines the drawing mode for this scatter + trace. + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.scattergl.Selected instance + or dict with compatible properties + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.scattergl.Stream instance or + dict with compatible properties + text + Sets text elements associated with each (x,y) + pair. If a single string, the same string + appears over all the data points. If an array + of string, the items are mapped in order to the + this trace's (x,y) coordinates. If trace + `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with + respects to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for + textposition . + textsrc + Sets the source reference on plot.ly for text + . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + unselected + plotly.graph_objs.scattergl.Unselected instance + or dict with compatible properties + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the + starting coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date + data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the + starting coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date + data. + ysrc + Sets the source reference on plot.ly for y . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScattergeoValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='scattergeo', parent_name='', **kwargs): + super(ScattergeoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scattergeo'), + data_docs=kwargs.pop( + 'data_docs', """ + connectgaps + Determines whether or not gaps (i.e. {nan} or + missing values) in the provided data arrays are + connected. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + fill + Sets the area to fill with a solid color. Use + with `fillcolor` if not "none". "toself" + connects the endpoints of the trace (or each + segment of the trace if it has gaps) into a + closed shape. + fillcolor + Sets the fill color. Defaults to a half- + transparent variant of the line color, marker + color, or marker line color, whichever is + available. + geo + Sets a reference between this trace's + geospatial coordinates and a geographic map. If + "geo" (the default value), the geospatial + coordinates refer to `layout.geo`. If "geo2", + the geospatial coordinates refer to + `layout.geo2`, and so on. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.scattergeo.Hoverlabel + instance or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Sets hover text elements associated with each + (lon,lat) pair or item in `locations`. If a + single string, the same string appears over all + the data points. If an array of string, the + items are mapped in order to the this trace's + (lon,lat) or `locations` coordinates. To be + seen, trace `hoverinfo` must contain a "text" + flag. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + lat + Sets the latitude coordinates (in degrees + North). + latsrc + Sets the source reference on plot.ly for lat . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.scattergeo.Line instance or + dict with compatible properties + locationmode + Determines the set of locations used to match + entries in `locations` to regions on the map. + locations + Sets the coordinates via location IDs or names. + Coordinates correspond to the centroid of each + location given. See `locationmode` for more + info. + locationssrc + Sets the source reference on plot.ly for + locations . + lon + Sets the longitude coordinates (in degrees + East). + lonsrc + Sets the source reference on plot.ly for lon . + marker + plotly.graph_objs.scattergeo.Marker instance or + dict with compatible properties + mode + Determines the drawing mode for this scatter + trace. If the provided `mode` includes "text" + then the `text` elements appear at the + coordinates. Otherwise, the `text` elements + appear on hover. If there are less than 20 + points and the trace is not stacked then the + default is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.scattergeo.Selected instance + or dict with compatible properties + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.scattergeo.Stream instance or + dict with compatible properties + text + Sets text elements associated with each + (lon,lat) pair or item in `locations`. If a + single string, the same string appears over all + the data points. If an array of string, the + items are mapped in order to the this trace's + (lon,lat) or `locations` coordinates. If trace + `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with + respects to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for + textposition . + textsrc + Sets the source reference on plot.ly for text + . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + unselected + plotly.graph_objs.scattergeo.Unselected + instance or dict with compatible properties + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScattercarpetValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='scattercarpet', parent_name='', **kwargs): + super(ScattercarpetValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scattercarpet'), + data_docs=kwargs.pop( + 'data_docs', """ + a + Sets the a-axis coordinates. + asrc + Sets the source reference on plot.ly for a . + b + Sets the b-axis coordinates. + bsrc + Sets the source reference on plot.ly for b . + carpet + An identifier for this carpet, so that + `scattercarpet` and `scattercontour` traces can + specify a carpet plot on which they lie + connectgaps + Determines whether or not gaps (i.e. {nan} or + missing values) in the provided data arrays are + connected. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + fill + Sets the area to fill with a solid color. Use + with `fillcolor` if not "none". scatterternary + has a subset of the options available to + scatter. "toself" connects the endpoints of the + trace (or each segment of the trace if it has + gaps) into a closed shape. "tonext" fills the + space between two traces if one completely + encloses the other (eg consecutive contour + lines), and behaves like "toself" if there is + no trace before it. "tonext" should not be used + if one trace does not enclose the other. + fillcolor + Sets the fill color. Defaults to a half- + transparent variant of the line color, marker + color, or marker line color, whichever is + available. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.scattercarpet.Hoverlabel + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual + points (markers or line points) or do they + highlight filled regions? If the fill is + "toself" or "tonext" and there are no markers + or text, then the default is "fills", otherwise + it is "points". + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Sets hover text elements associated with each + (a,b) point. If a single string, the same + string appears over all the data points. If an + array of strings, the items are mapped in order + to the the data points in (a,b). To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.scattercarpet.Line instance + or dict with compatible properties + marker + plotly.graph_objs.scattercarpet.Marker instance + or dict with compatible properties + mode + Determines the drawing mode for this scatter + trace. If the provided `mode` includes "text" + then the `text` elements appear at the + coordinates. Otherwise, the `text` elements + appear on hover. If there are less than 20 + points and the trace is not stacked then the + default is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + selected + plotly.graph_objs.scattercarpet.Selected + instance or dict with compatible properties + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.scattercarpet.Stream instance + or dict with compatible properties + text + Sets text elements associated with each (a,b) + point. If a single string, the same string + appears over all the data points. If an array + of strings, the items are mapped in order to + the the data points in (a,b). If trace + `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with + respects to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for + textposition . + textsrc + Sets the source reference on plot.ly for text + . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + unselected + plotly.graph_objs.scattercarpet.Unselected + instance or dict with compatible properties + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Scatter3dValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='scatter3d', parent_name='', **kwargs): + super(Scatter3dValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scatter3d'), + data_docs=kwargs.pop( + 'data_docs', """ + connectgaps + Determines whether or not gaps (i.e. {nan} or + missing values) in the provided data arrays are + connected. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + error_x + plotly.graph_objs.scatter3d.ErrorX instance or + dict with compatible properties + error_y + plotly.graph_objs.scatter3d.ErrorY instance or + dict with compatible properties + error_z + plotly.graph_objs.scatter3d.ErrorZ instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.scatter3d.Hoverlabel instance + or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Sets text elements associated with each (x,y,z) + triplet. If a single string, the same string + appears over all the data points. If an array + of string, the items are mapped in order to the + this trace's (x,y,z) coordinates. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.scatter3d.Line instance or + dict with compatible properties + marker + plotly.graph_objs.scatter3d.Marker instance or + dict with compatible properties + mode + Determines the drawing mode for this scatter + trace. If the provided `mode` includes "text" + then the `text` elements appear at the + coordinates. Otherwise, the `text` elements + appear on hover. If there are less than 20 + points and the trace is not stacked then the + default is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + projection + plotly.graph_objs.scatter3d.Projection instance + or dict with compatible properties + scene + Sets a reference between this trace's 3D + coordinate system and a 3D scene. If "scene" + (the default value), the (x,y,z) coordinates + refer to `layout.scene`. If "scene2", the + (x,y,z) coordinates refer to `layout.scene2`, + and so on. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.scatter3d.Stream instance or + dict with compatible properties + surfaceaxis + If "-1", the scatter points are not fill with a + surface If 0, 1, 2, the scatter points are + filled with a Delaunay surface about the x, y, + z respectively. + surfacecolor + Sets the surface fill color. + text + Sets text elements associated with each (x,y,z) + triplet. If a single string, the same string + appears over all the data points. If an array + of string, the items are mapped in order to the + this trace's (x,y,z) coordinates. If trace + `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + plotly.graph_objs.scatter3d.Textfont instance + or dict with compatible properties + textposition + Sets the positions of the `text` elements with + respects to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for + textposition . + textsrc + Sets the source reference on plot.ly for text + . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + x + Sets the x coordinates. + xcalendar + Sets the calendar system to use with `x` date + data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates. + ycalendar + Sets the calendar system to use with `y` date + data. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the z coordinates. + zcalendar + Sets the calendar system to use with `z` date + data. + zsrc + Sets the source reference on plot.ly for z . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScatterValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='scatter', parent_name='', **kwargs): + super(ScatterValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scatter'), + data_docs=kwargs.pop( + 'data_docs', """ + cliponaxis + Determines whether or not markers and text + nodes are clipped about the subplot axes. To + show markers and text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` + and `yaxis.layer` to *below traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or + missing values) in the provided data arrays are + connected. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + dx + Sets the x coordinate step. See `x0` for more + info. + dy + Sets the y coordinate step. See `y0` for more + info. + error_x + plotly.graph_objs.scatter.ErrorX instance or + dict with compatible properties + error_y + plotly.graph_objs.scatter.ErrorY instance or + dict with compatible properties + fill + Sets the area to fill with a solid color. + Defaults to "none" unless this trace is + stacked, then it gets "tonexty" ("tonextx") if + `orientation` is "v" ("h") Use with `fillcolor` + if not "none". "tozerox" and "tozeroy" fill to + x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this + trace and the endpoints of the trace before it, + connecting those endpoints with straight lines + (to make a stacked area graph); if there is no + trace before it, they behave like "tozerox" and + "tozeroy". "toself" connects the endpoints of + the trace (or each segment of the trace if it + has gaps) into a closed shape. "tonext" fills + the space between two traces if one completely + encloses the other (eg consecutive contour + lines), and behaves like "toself" if there is + no trace before it. "tonext" should not be used + if one trace does not enclose the other. Traces + in a `stackgroup` will only fill to (or be + filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked + and some not, if fill-linked traces are not + already consecutive, the later ones will be + pushed down in the drawing order. + fillcolor + Sets the fill color. Defaults to a half- + transparent variant of the line color, marker + color, or marker line color, whichever is + available. + groupnorm + Only relevant when `stackgroup` is used, and + only the first `groupnorm` found in the + `stackgroup` will be used - including if + `visible` is "legendonly" but not if it is + `false`. Sets the normalization for the sum of + this `stackgroup`. With "fraction", the value + of each trace at each location is divided by + the sum of all trace values at that location. + "percent" is the same but multiplied by 100 to + show percentages. If there are multiple + subplots, or multiple `stackgroup`s on one + subplot, each will be normalized within its own + set. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.scatter.Hoverlabel instance + or dict with compatible properties + hoveron + Do the hover effects highlight individual + points (markers or line points) or do they + highlight filled regions? If the fill is + "toself" or "tonext" and there are no markers + or text, then the default is "fills", otherwise + it is "points". + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Sets hover text elements associated with each + (x,y) pair. If a single string, the same string + appears over all the data points. If an array + of string, the items are mapped in order to the + this trace's (x,y) coordinates. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.scatter.Line instance or dict + with compatible properties + marker + plotly.graph_objs.scatter.Marker instance or + dict with compatible properties + mode + Determines the drawing mode for this scatter + trace. If the provided `mode` includes "text" + then the `text` elements appear at the + coordinates. Otherwise, the `text` elements + appear on hover. If there are less than 20 + points and the trace is not stacked then the + default is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + orientation + Only relevant when `stackgroup` is used, and + only the first `orientation` found in the + `stackgroup` will be used - including if + `visible` is "legendonly" but not if it is + `false`. Sets the stacking direction. With "v" + ("h"), the y (x) values of subsequent traces + are added. Also affects the default value of + `fill`. + r + r coordinates in scatter traces are + deprecated!Please switch to the "scatterpolar" + trace type.Sets the radial coordinatesfor + legacy polar chart only. + rsrc + Sets the source reference on plot.ly for r . + selected + plotly.graph_objs.scatter.Selected instance or + dict with compatible properties + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stackgaps + Only relevant when `stackgroup` is used, and + only the first `stackgaps` found in the + `stackgroup` will be used - including if + `visible` is "legendonly" but not if it is + `false`. Determines how we handle locations at + which other traces in this group have data but + this one does not. With *infer zero* we insert + a zero at these locations. With "interpolate" + we linearly interpolate between existing + values, and extrapolate a constant beyond the + existing values. + stackgroup + Set several scatter traces (on the same + subplot) to the same stackgroup in order to add + their y values (or their x values if + `orientation` is "h"). If blank or omitted this + trace will not be stacked. Stacking also turns + `fill` on by default, using "tonexty" + ("tonextx") if `orientation` is "h" ("v") and + sets the default `mode` to "lines" irrespective + of point count. You can only stack on a numeric + (linear or log) axis. Traces in a `stackgroup` + will only fill to (or be filled to) other + traces in the same group. With multiple + `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already + consecutive, the later ones will be pushed down + in the drawing order. + stream + plotly.graph_objs.scatter.Stream instance or + dict with compatible properties + t + t coordinates in scatter traces are + deprecated!Please switch to the "scatterpolar" + trace type.Sets the angular coordinatesfor + legacy polar chart only. + text + Sets text elements associated with each (x,y) + pair. If a single string, the same string + appears over all the data points. If an array + of string, the items are mapped in order to the + this trace's (x,y) coordinates. If trace + `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with + respects to the (x,y) coordinates. + textpositionsrc + Sets the source reference on plot.ly for + textposition . + textsrc + Sets the source reference on plot.ly for text + . + tsrc + Sets the source reference on plot.ly for t . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + unselected + plotly.graph_objs.scatter.Unselected instance + or dict with compatible properties + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the + starting coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date + data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the + starting coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date + data. + ysrc + Sets the source reference on plot.ly for y . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SankeyValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='sankey', parent_name='', **kwargs): + super(SankeyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Sankey'), + data_docs=kwargs.pop( + 'data_docs', """ + arrangement + If value is `snap` (the default), the node + arrangement is assisted by automatic snapping + of elements to preserve space between nodes + specified via `nodepad`. If value is + `perpendicular`, the nodes can only move along + a line perpendicular to the flow. If value is + `freeform`, the nodes can freely move on the + plane. If value is `fixed`, the nodes are + stationary. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + domain + plotly.graph_objs.sankey.Domain instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. Note that this attribute is superseded + by `node.hoverinfo` and `node.hoverinfo` for + nodes and links respectively. + hoverlabel + plotly.graph_objs.sankey.Hoverlabel instance or + dict with compatible properties + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + link + The links of the Sankey plot. + name + Sets the trace name. The trace name appear as + the legend item and on hover. + node + The nodes of the Sankey plot. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the Sankey diagram. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.sankey.Stream instance or + dict with compatible properties + textfont + Sets the font for node labels + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + valueformat + Sets the value formatting rule using d3 + formatting mini-language which is similar to + those of Python. See https://github.com/d3/d3-f + ormat/blob/master/README.md#locale_format + valuesuffix + Adds a unit to follow the value in the hover + tooltip. Add a space if a separation is + necessary from the value. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PointcloudValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='pointcloud', parent_name='', **kwargs): + super(PointcloudValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Pointcloud'), + data_docs=kwargs.pop( + 'data_docs', """ + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.pointcloud.Hoverlabel + instance or dict with compatible properties + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + indices + A sequential value, 0..n, supply it to avoid + creating this array inside plotting. If + specified, it must be a typed `Int32Array` + array. Its length must be equal to or greater + than the number of points. For the best + performance and memory use, create one large + `indices` typed array that is guaranteed to be + at least as long as the largest number of + points during use, and reuse it on each + `Plotly.restyle()` call. + indicessrc + Sets the source reference on plot.ly for + indices . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + marker + plotly.graph_objs.pointcloud.Marker instance or + dict with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.pointcloud.Stream instance or + dict with compatible properties + text + Sets text elements associated with each (x,y) + pair. If a single string, the same string + appears over all the data points. If an array + of string, the items are mapped in order to the + this trace's (x,y) coordinates. If trace + `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be + seen in the hover labels. + textsrc + Sets the source reference on plot.ly for text + . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + x + Sets the x coordinates. + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + xbounds + Specify `xbounds` in the shape of `[xMin, xMax] + to avoid looping through the `xy` typed array. + Use it in conjunction with `xy` and `ybounds` + for the performance benefits. + xboundssrc + Sets the source reference on plot.ly for + xbounds . + xsrc + Sets the source reference on plot.ly for x . + xy + Faster alternative to specifying `x` and `y` + separately. If supplied, it must be a typed + `Float32Array` array that represents points + such that `xy[i * 2] = x[i]` and `xy[i * 2 + 1] + = y[i]` + xysrc + Sets the source reference on plot.ly for xy . + y + Sets the y coordinates. + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. + ybounds + Specify `ybounds` in the shape of `[yMin, yMax] + to avoid looping through the `xy` typed array. + Use it in conjunction with `xy` and `xbounds` + for the performance benefits. + yboundssrc + Sets the source reference on plot.ly for + ybounds . + ysrc + Sets the source reference on plot.ly for y . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PieValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='pie', parent_name='', **kwargs): + super(PieValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Pie'), + data_docs=kwargs.pop( + 'data_docs', """ + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + direction + Specifies the direction at which succeeding + sectors follow one another. + dlabel + Sets the label step. See `label0` for more + info. + domain + plotly.graph_objs.pie.Domain instance or dict + with compatible properties + hole + Sets the fraction of the radius to cut out of + the pie. Use this to make a donut chart. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.pie.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + variables `label`, `color`, `value`, `percent` + and `text`. Anything contained in tag `` + is displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Sets hover text elements associated with each + sector. If a single string, the same string + appears for all data points. If an array of + string, the items are mapped in order of this + trace's sectors. To be seen, trace `hoverinfo` + must contain a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + insidetextfont + Sets the font used for `textinfo` lying inside + the pie. + label0 + Alternate to `labels`. Builds a numeric set of + labels. Use with `dlabel` where `label0` is the + starting label and `dlabel` the step. + labels + Sets the sector labels. If `labels` entries are + duplicated, we sum associated `values` or + simply count occurrences if `values` is not + provided. For other array attributes (including + color) we use the first non-empty entry among + all occurrences of the label. + labelssrc + Sets the source reference on plot.ly for + labels . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + marker + plotly.graph_objs.pie.Marker instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside + the pie. + pull + Sets the fraction of larger radius to pull the + sectors out from the center. This can be a + constant to pull all slices apart from each + other equally or an array to highlight one or + more slices. + pullsrc + Sets the source reference on plot.ly for pull + . + rotation + Instead of the first slice starting at 12 + o'clock, rotate to some other angle. + scalegroup + If there are multiple pies that should be sized + according to their totals, link them by + providing a non-empty group id here shared by + every trace in the same group. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + sort + Determines whether or not the sectors are + reordered from largest to smallest. + stream + plotly.graph_objs.pie.Stream instance or dict + with compatible properties + text + Sets text elements associated with each sector. + If trace `textinfo` contains a "text" flag, + these elements will be seen on the chart. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on + the graph. + textposition + Specifies the location of the `textinfo`. + textpositionsrc + Sets the source reference on plot.ly for + textposition . + textsrc + Sets the source reference on plot.ly for text + . + title + plotly.graph_objs.pie.Title instance or dict + with compatible properties + titlefont + Deprecated: Please use pie.title.font instead. + Sets the font used for `title`. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleposition + Deprecated: Please use pie.title.position + instead. Specifies the location of the `title`. + Note that the title's position used to be set + by the now deprecated `titleposition` + attribute. + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + values + Sets the values of the sectors of this pie + chart. If omitted, we count occurrences of each + label. + valuessrc + Sets the source reference on plot.ly for + values . + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ParcoordsValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='parcoords', parent_name='', **kwargs): + super(ParcoordsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Parcoords'), + data_docs=kwargs.pop( + 'data_docs', """ + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + dimensions + The dimensions (variables) of the parallel + coordinates chart. 2..60 dimensions are + supported. + dimensiondefaults + When used in a template (as layout.template.dat + a.parcoords.dimensiondefaults), sets the + default property values to use for elements of + parcoords.dimensions + domain + plotly.graph_objs.parcoords.Domain instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + labelfont + Sets the font for the `dimension` labels. + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.parcoords.Line instance or + dict with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + rangefont + Sets the font for the `dimension` range values. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.parcoords.Stream instance or + dict with compatible properties + tickfont + Sets the font for the `dimension` tick values. + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ParcatsValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='parcats', parent_name='', **kwargs): + super(ParcatsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Parcats'), + data_docs=kwargs.pop( + 'data_docs', """ + arrangement + Sets the drag interaction mode for categories + and dimensions. If `perpendicular`, the + categories can only move along a line + perpendicular to the paths. If `freeform`, the + categories can freely move on the plane. If + `fixed`, the categories and dimensions are + stationary. + bundlecolors + Sort paths so that like colors are bundled + together within each category. + counts + The number of observations represented by each + state. Defaults to 1 so that each state + represents one observation + countssrc + Sets the source reference on plot.ly for + counts . + dimensions + The dimensions (variables) of the parallel + categories diagram. + dimensiondefaults + When used in a template (as layout.template.dat + a.parcats.dimensiondefaults), sets the default + property values to use for elements of + parcats.dimensions + domain + plotly.graph_objs.parcats.Domain instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoveron + Sets the hover interaction mode for the parcats + diagram. If `category`, hover interaction take + place per category. If `color`, hover + interactions take place per color per category. + If `dimension`, hover interactions take place + across all categories per dimension. + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + variables `count`, `probability`, `category`, + `categorycount`, `colorcount` and + `bandcolorcount`. Anything contained in tag + `` is displayed in the secondary box, + for example "{fullData.name}". + labelfont + Sets the font for the `dimension` labels. + line + plotly.graph_objs.parcats.Line instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + sortpaths + Sets the path sorting algorithm. If `forward`, + sort paths based on dimension categories from + left to right. If `backward`, sort paths based + on dimensions categories from right to left. + stream + plotly.graph_objs.parcats.Stream instance or + dict with compatible properties + tickfont + Sets the font for the `category` labels. + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OhlcValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='ohlc', parent_name='', **kwargs): + super(OhlcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Ohlc'), + data_docs=kwargs.pop( + 'data_docs', """ + close + Sets the close values. + closesrc + Sets the source reference on plot.ly for close + . + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + decreasing + plotly.graph_objs.ohlc.Decreasing instance or + dict with compatible properties + high + Sets the high values. + highsrc + Sets the source reference on plot.ly for high + . + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.ohlc.Hoverlabel instance or + dict with compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + increasing + plotly.graph_objs.ohlc.Increasing instance or + dict with compatible properties + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.ohlc.Line instance or dict + with compatible properties + low + Sets the low values. + lowsrc + Sets the source reference on plot.ly for low . + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + open + Sets the open values. + opensrc + Sets the source reference on plot.ly for open + . + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.ohlc.Stream instance or dict + with compatible properties + text + Sets hover text elements associated with each + sample point. If a single string, the same + string appears over all the data points. If an + array of string, the items are mapped in order + to this trace's sample points. + textsrc + Sets the source reference on plot.ly for text + . + tickwidth + Sets the width of the open/close tick marks + relative to the "x" minimal interval. + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + x + Sets the x coordinates. If absent, linear + coordinate will be generated. + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date + data. + xsrc + Sets the source reference on plot.ly for x . + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Mesh3dValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='mesh3d', parent_name='', **kwargs): + super(Mesh3dValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Mesh3d'), + data_docs=kwargs.pop( + 'data_docs', """ + alphahull + Determines how the mesh surface triangles are + derived from the set of vertices (points) + represented by the `x`, `y` and `z` arrays, if + the `i`, `j`, `k` arrays are not supplied. For + general use of `mesh3d` it is preferred that + `i`, `j`, `k` are supplied. If "-1", Delaunay + triangulation is used, which is mainly suitable + if the mesh is a single, more or less layer + surface that is perpendicular to + `delaunayaxis`. In case the `delaunayaxis` + intersects the mesh surface at more than one + point it will result triangles that are very + long in the dimension of `delaunayaxis`. If + ">0", the alpha-shape algorithm is used. In + this case, the positive `alphahull` value + signals the use of the alpha-shape algorithm, + _and_ its value acts as the parameter for the + mesh fitting. If 0, the convex-hull algorithm + is used. It is suitable for convex bodies or if + the intention is to enclose the `x`, `y` and + `z` point set into a convex hull. + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `colorscale`. In case + `colorscale` is unspecified or `autocolorscale` + is true, the default palette will be chosen + according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + `intensity`) or the bounds set in `cmin` and + `cmax` Defaults to `false` when `cmin` and + `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value + should have the same units as `intensity` and + if set, `cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `cmin` and/or `cmax` to be equidistant + to this point. Value should have the same units + as `intensity`. Has no effect when `cauto` is + `false`. + cmin + Sets the lower bound of the color domain. Value + should have the same units as `intensity` and + if set, `cmax` must be set as well. + color + Sets the color of the whole mesh + colorbar + plotly.graph_objs.mesh3d.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. The colorscale must be an + array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named + color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. + For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and + `cmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Grey + s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, + Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth + ,Electric,Viridis,Cividis. + contour + plotly.graph_objs.mesh3d.Contour instance or + dict with compatible properties + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + delaunayaxis + Sets the Delaunay axis, which is the axis that + is perpendicular to the surface of the Delaunay + triangulation. It has an effect if `i`, `j`, + `k` are not provided and `alphahull` is set to + indicate Delaunay triangulation. + facecolor + Sets the color of each face Overrides "color" + and "vertexcolor". + facecolorsrc + Sets the source reference on plot.ly for + facecolor . + flatshading + Determines whether or not normal smoothing is + applied to the meshes, creating meshes with an + angular, low-poly look via flat reflections. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.mesh3d.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + i + A vector of vertex indices, i.e. integer values + between 0 and the length of the vertex vectors, + representing the "first" vertex of a triangle. + For example, `{i[m], j[m], k[m]}` together + represent face m (triangle m) in the mesh, + where `i[m] = n` points to the triplet `{x[n], + y[n], z[n]}` in the vertex arrays. Therefore, + each element in `i` represents a point in + space, which is the first vertex of a triangle. + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + intensity + Sets the vertex intensity values, used for + plotting fields on meshes + intensitysrc + Sets the source reference on plot.ly for + intensity . + isrc + Sets the source reference on plot.ly for i . + j + A vector of vertex indices, i.e. integer values + between 0 and the length of the vertex vectors, + representing the "second" vertex of a triangle. + For example, `{i[m], j[m], k[m]}` together + represent face m (triangle m) in the mesh, + where `j[m] = n` points to the triplet `{x[n], + y[n], z[n]}` in the vertex arrays. Therefore, + each element in `j` represents a point in + space, which is the second vertex of a + triangle. + jsrc + Sets the source reference on plot.ly for j . + k + A vector of vertex indices, i.e. integer values + between 0 and the length of the vertex vectors, + representing the "third" vertex of a triangle. + For example, `{i[m], j[m], k[m]}` together + represent face m (triangle m) in the mesh, + where `k[m] = n` points to the triplet `{x[n], + y[n], z[n]}` in the vertex arrays. Therefore, + each element in `k` represents a point in + space, which is the third vertex of a triangle. + ksrc + Sets the source reference on plot.ly for k . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + lighting + plotly.graph_objs.mesh3d.Lighting instance or + dict with compatible properties + lightposition + plotly.graph_objs.mesh3d.Lightposition instance + or dict with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the surface. Please note + that in the case of using high `opacity` values + for example a value greater than or equal to + 0.5 on two surfaces (and 0.25 with four + surfaces), an overlay of multiple transparent + surfaces may not perfectly be sorted in depth + by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, + `cmin` will correspond to the last color in the + array and `cmax` will correspond to the first + color. + scene + Sets a reference between this trace's 3D + coordinate system and a 3D scene. If "scene" + (the default value), the (x,y,z) coordinates + refer to `layout.scene`. If "scene2", the + (x,y,z) coordinates refer to `layout.scene2`, + and so on. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + showscale + Determines whether or not a colorbar is + displayed for this trace. + stream + plotly.graph_objs.mesh3d.Stream instance or + dict with compatible properties + text + Sets the text elements associated with the + vertices. If trace `hoverinfo` contains a + "text" flag and "hovertext" is not set, these + elements will be seen in the hover labels. + textsrc + Sets the source reference on plot.ly for text + . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + vertexcolor + Sets the color of each vertex Overrides + "color". + vertexcolorsrc + Sets the source reference on plot.ly for + vertexcolor . + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + x + Sets the X coordinates of the vertices. The nth + element of vectors `x`, `y` and `z` jointly + represent the X, Y and Z coordinates of the nth + vertex. + xcalendar + Sets the calendar system to use with `x` date + data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the Y coordinates of the vertices. The nth + element of vectors `x`, `y` and `z` jointly + represent the X, Y and Z coordinates of the nth + vertex. + ycalendar + Sets the calendar system to use with `y` date + data. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the Z coordinates of the vertices. The nth + element of vectors `x`, `y` and `z` jointly + represent the X, Y and Z coordinates of the nth + vertex. + zcalendar + Sets the calendar system to use with `z` date + data. + zsrc + Sets the source reference on plot.ly for z . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IsosurfaceValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='isosurface', parent_name='', **kwargs): + super(IsosurfaceValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Isosurface'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `colorscale`. In case + `colorscale` is unspecified or `autocolorscale` + is true, the default palette will be chosen + according to whether numbers in the `color` + array are all positive, all negative or mixed. + caps + plotly.graph_objs.isosurface.Caps instance or + dict with compatible properties + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + `value`) or the bounds set in `cmin` and `cmax` + Defaults to `false` when `cmin` and `cmax` are + set by the user. + cmax + Sets the upper bound of the color domain. Value + should have the same units as `value` and if + set, `cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `cmin` and/or `cmax` to be equidistant + to this point. Value should have the same units + as `value`. Has no effect when `cauto` is + `false`. + cmin + Sets the lower bound of the color domain. Value + should have the same units as `value` and if + set, `cmax` must be set as well. + colorbar + plotly.graph_objs.isosurface.ColorBar instance + or dict with compatible properties + colorscale + Sets the colorscale. The colorscale must be an + array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named + color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. + For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and + `cmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Grey + s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, + Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth + ,Electric,Viridis,Cividis. + contour + plotly.graph_objs.isosurface.Contour instance + or dict with compatible properties + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + flatshading + Determines whether or not normal smoothing is + applied to the meshes, creating meshes with an + angular, low-poly look via flat reflections. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.isosurface.Hoverlabel + instance or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + isomax + Sets the maximum boundary for iso-surface plot. + isomin + Sets the minimum boundary for iso-surface plot. + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + lighting + plotly.graph_objs.isosurface.Lighting instance + or dict with compatible properties + lightposition + plotly.graph_objs.isosurface.Lightposition + instance or dict with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the surface. Please note + that in the case of using high `opacity` values + for example a value greater than or equal to + 0.5 on two surfaces (and 0.25 with four + surfaces), an overlay of multiple transparent + surfaces may not perfectly be sorted in depth + by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, + `cmin` will correspond to the last color in the + array and `cmax` will correspond to the first + color. + scene + Sets a reference between this trace's 3D + coordinate system and a 3D scene. If "scene" + (the default value), the (x,y,z) coordinates + refer to `layout.scene`. If "scene2", the + (x,y,z) coordinates refer to `layout.scene2`, + and so on. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + showscale + Determines whether or not a colorbar is + displayed for this trace. + slices + plotly.graph_objs.isosurface.Slices instance or + dict with compatible properties + spaceframe + plotly.graph_objs.isosurface.Spaceframe + instance or dict with compatible properties + stream + plotly.graph_objs.isosurface.Stream instance or + dict with compatible properties + surface + plotly.graph_objs.isosurface.Surface instance + or dict with compatible properties + text + Sets the text elements associated with the + vertices. If trace `hoverinfo` contains a + "text" flag and "hovertext" is not set, these + elements will be seen in the hover labels. + textsrc + Sets the source reference on plot.ly for text + . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + value + Sets the 4th dimension (value) of the vertices. + valuesrc + Sets the source reference on plot.ly for value + . + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + x + Sets the X coordinates of the vertices on X + axis. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the Y coordinates of the vertices on Y + axis. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the Z coordinates of the vertices on Z + axis. + zsrc + Sets the source reference on plot.ly for z . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Histogram2dContourValidator( + _plotly_utils.basevalidators.CompoundValidator +): + + def __init__( + self, plotly_name='histogram2dcontour', parent_name='', **kwargs + ): + super(Histogram2dContourValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Histogram2dContour'), + data_docs=kwargs.pop( + 'data_docs', """ + autobinx + Obsolete: since v1.42 each bin attribute is + auto-determined separately and `autobinx` is + not needed. However, we accept `autobinx: true` + or `false` and will update `xbins` accordingly + before deleting `autobinx` from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is + auto-determined separately and `autobiny` is + not needed. However, we accept `autobiny: true` + or `false` and will update `ybins` accordingly + before deleting `autobiny` from the trace. + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `colorscale`. In case + `colorscale` is unspecified or `autocolorscale` + is true, the default palette will be chosen + according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level + attributes are picked by an algorithm. If True, + the number of contour levels can be set in + `ncontours`. If False, set the contour level + attributes in `contours`. + colorbar + plotly.graph_objs.histogram2dcontour.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. The colorscale must be an + array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named + color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. + For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and + `zmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Grey + s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, + Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth + ,Electric,Viridis,Cividis. + contours + plotly.graph_objs.histogram2dcontour.Contours + instance or dict with compatible properties + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + histfunc + Specifies the binning function used for this + histogram trace. If "count", the histogram + values are computed by counting the number of + values lying inside each bin. If "sum", "avg", + "min", "max", the histogram values are computed + using the sum, the average, the minimum or the + maximum of the values lying inside each bin + respectively. + histnorm + Specifies the type of normalization used for + this histogram trace. If "", the span of each + bar corresponds to the number of occurrences + (i.e. the number of data points lying inside + the bins). If "percent" / "probability", the + span of each bar corresponds to the percentage + / fraction of occurrences with respect to the + total number of sample points (here, the sum of + all bin HEIGHTS equals 100% / 1). If "density", + the span of each bar corresponds to the number + of occurrences in a bin divided by the size of + the bin interval (here, the sum of all bin + AREAS equals the total number of sample + points). If *probability density*, the area of + each bar corresponds to the probability that an + event will fall into the corresponding bin + (here, the sum of all bin AREAS equals 1). + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.histogram2dcontour.Hoverlabel + instance or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + variable `z` Anything contained in tag + `` is displayed in the secondary box, + for example "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.histogram2dcontour.Line + instance or dict with compatible properties + marker + plotly.graph_objs.histogram2dcontour.Marker + instance or dict with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + nbinsx + Specifies the maximum number of desired bins. + This value will be used in an algorithm that + will decide the optimal bin size such that the + histogram best visualizes the distribution of + the data. Ignored if `xbins.size` is provided. + nbinsy + Specifies the maximum number of desired bins. + This value will be used in an algorithm that + will decide the optimal bin size such that the + histogram best visualizes the distribution of + the data. Ignored if `ybins.size` is provided. + ncontours + Sets the maximum number of contour levels. The + actual number of contours will be chosen + automatically to be less than or equal to the + value of `ncontours`. Has an effect only if + `autocontour` is True or if `contours.size` is + missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, + `zmin` will correspond to the last color in the + array and `zmax` will correspond to the first + color. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + showscale + Determines whether or not a colorbar is + displayed for this trace. + stream + plotly.graph_objs.histogram2dcontour.Stream + instance or dict with compatible properties + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + x + Sets the sample data to be binned on the x + axis. + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + xbins + plotly.graph_objs.histogram2dcontour.XBins + instance or dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date + data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the sample data to be binned on the y + axis. + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. + ybins + plotly.graph_objs.histogram2dcontour.YBins + instance or dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date + data. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the aggregation data. + zauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `z`) or the bounds set in `zmin` and `zmax` + Defaults to `false` when `zmin` and `zmax` are + set by the user. + zhoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. See: https://github + .com/d3/d3-format/blob/master/README.md#locale_ + format + zmax + Sets the upper bound of the color domain. Value + should have the same units as in `z` and if + set, `zmin` must be set as well. + zmid + Sets the mid-point of the color domain by + scaling `zmin` and/or `zmax` to be equidistant + to this point. Value should have the same units + as in `z`. Has no effect when `zauto` is + `false`. + zmin + Sets the lower bound of the color domain. Value + should have the same units as in `z` and if + set, `zmax` must be set as well. + zsrc + Sets the source reference on plot.ly for z . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Histogram2dValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='histogram2d', parent_name='', **kwargs): + super(Histogram2dValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Histogram2d'), + data_docs=kwargs.pop( + 'data_docs', """ + autobinx + Obsolete: since v1.42 each bin attribute is + auto-determined separately and `autobinx` is + not needed. However, we accept `autobinx: true` + or `false` and will update `xbins` accordingly + before deleting `autobinx` from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is + auto-determined separately and `autobiny` is + not needed. However, we accept `autobiny: true` + or `false` and will update `ybins` accordingly + before deleting `autobiny` from the trace. + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `colorscale`. In case + `colorscale` is unspecified or `autocolorscale` + is true, the default palette will be chosen + according to whether numbers in the `color` + array are all positive, all negative or mixed. + colorbar + plotly.graph_objs.histogram2d.ColorBar instance + or dict with compatible properties + colorscale + Sets the colorscale. The colorscale must be an + array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named + color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. + For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and + `zmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Grey + s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, + Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth + ,Electric,Viridis,Cividis. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + histfunc + Specifies the binning function used for this + histogram trace. If "count", the histogram + values are computed by counting the number of + values lying inside each bin. If "sum", "avg", + "min", "max", the histogram values are computed + using the sum, the average, the minimum or the + maximum of the values lying inside each bin + respectively. + histnorm + Specifies the type of normalization used for + this histogram trace. If "", the span of each + bar corresponds to the number of occurrences + (i.e. the number of data points lying inside + the bins). If "percent" / "probability", the + span of each bar corresponds to the percentage + / fraction of occurrences with respect to the + total number of sample points (here, the sum of + all bin HEIGHTS equals 100% / 1). If "density", + the span of each bar corresponds to the number + of occurrences in a bin divided by the size of + the bin interval (here, the sum of all bin + AREAS equals the total number of sample + points). If *probability density*, the area of + each bar corresponds to the probability that an + event will fall into the corresponding bin + (here, the sum of all bin AREAS equals 1). + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.histogram2d.Hoverlabel + instance or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + variable `z` Anything contained in tag + `` is displayed in the secondary box, + for example "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + marker + plotly.graph_objs.histogram2d.Marker instance + or dict with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + nbinsx + Specifies the maximum number of desired bins. + This value will be used in an algorithm that + will decide the optimal bin size such that the + histogram best visualizes the distribution of + the data. Ignored if `xbins.size` is provided. + nbinsy + Specifies the maximum number of desired bins. + This value will be used in an algorithm that + will decide the optimal bin size such that the + histogram best visualizes the distribution of + the data. Ignored if `ybins.size` is provided. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, + `zmin` will correspond to the last color in the + array and `zmax` will correspond to the first + color. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + showscale + Determines whether or not a colorbar is + displayed for this trace. + stream + plotly.graph_objs.histogram2d.Stream instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + x + Sets the sample data to be binned on the x + axis. + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + xbins + plotly.graph_objs.histogram2d.XBins instance or + dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date + data. + xgap + Sets the horizontal gap (in pixels) between + bricks. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the sample data to be binned on the y + axis. + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. + ybins + plotly.graph_objs.histogram2d.YBins instance or + dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date + data. + ygap + Sets the vertical gap (in pixels) between + bricks. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the aggregation data. + zauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `z`) or the bounds set in `zmin` and `zmax` + Defaults to `false` when `zmin` and `zmax` are + set by the user. + zhoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. See: https://github + .com/d3/d3-format/blob/master/README.md#locale_ + format + zmax + Sets the upper bound of the color domain. Value + should have the same units as in `z` and if + set, `zmin` must be set as well. + zmid + Sets the mid-point of the color domain by + scaling `zmin` and/or `zmax` to be equidistant + to this point. Value should have the same units + as in `z`. Has no effect when `zauto` is + `false`. + zmin + Sets the lower bound of the color domain. Value + should have the same units as in `z` and if + set, `zmax` must be set as well. + zsmooth + Picks a smoothing algorithm use to smooth `z` + data. + zsrc + Sets the source reference on plot.ly for z . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HistogramValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='histogram', parent_name='', **kwargs): + super(HistogramValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Histogram'), + data_docs=kwargs.pop( + 'data_docs', """ + alignmentgroup + Set several traces linked to the same position + axis or matching axes to the same + alignmentgroup. This controls whether bars + compute their positional range dependently or + independently. + autobinx + Obsolete: since v1.42 each bin attribute is + auto-determined separately and `autobinx` is + not needed. However, we accept `autobinx: true` + or `false` and will update `xbins` accordingly + before deleting `autobinx` from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is + auto-determined separately and `autobiny` is + not needed. However, we accept `autobiny: true` + or `false` and will update `ybins` accordingly + before deleting `autobiny` from the trace. + cumulative + plotly.graph_objs.histogram.Cumulative instance + or dict with compatible properties + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + error_x + plotly.graph_objs.histogram.ErrorX instance or + dict with compatible properties + error_y + plotly.graph_objs.histogram.ErrorY instance or + dict with compatible properties + histfunc + Specifies the binning function used for this + histogram trace. If "count", the histogram + values are computed by counting the number of + values lying inside each bin. If "sum", "avg", + "min", "max", the histogram values are computed + using the sum, the average, the minimum or the + maximum of the values lying inside each bin + respectively. + histnorm + Specifies the type of normalization used for + this histogram trace. If "", the span of each + bar corresponds to the number of occurrences + (i.e. the number of data points lying inside + the bins). If "percent" / "probability", the + span of each bar corresponds to the percentage + / fraction of occurrences with respect to the + total number of sample points (here, the sum of + all bin HEIGHTS equals 100% / 1). If "density", + the span of each bar corresponds to the number + of occurrences in a bin divided by the size of + the bin interval (here, the sum of all bin + AREAS equals the total number of sample + points). If *probability density*, the area of + each bar corresponds to the probability that an + event will fall into the corresponding bin + (here, the sum of all bin AREAS equals 1). + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.histogram.Hoverlabel instance + or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + variable `binNumber` Anything contained in tag + `` is displayed in the secondary box, + for example "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + marker + plotly.graph_objs.histogram.Marker instance or + dict with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + nbinsx + Specifies the maximum number of desired bins. + This value will be used in an algorithm that + will decide the optimal bin size such that the + histogram best visualizes the distribution of + the data. Ignored if `xbins.size` is provided. + nbinsy + Specifies the maximum number of desired bins. + This value will be used in an algorithm that + will decide the optimal bin size such that the + histogram best visualizes the distribution of + the data. Ignored if `ybins.size` is provided. + offsetgroup + Set several traces linked to the same position + axis or matching axes to the same offsetgroup + where bars of the same position coordinate will + line up. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" + ("h"), the value of the each bar spans along + the vertical (horizontal). + selected + plotly.graph_objs.histogram.Selected instance + or dict with compatible properties + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.histogram.Stream instance or + dict with compatible properties + text + Sets hover text elements associated with each + bar. If a single string, the same string + appears over all bars. If an array of string, + the items are mapped in order to the this + trace's coordinates. + textsrc + Sets the source reference on plot.ly for text + . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + unselected + plotly.graph_objs.histogram.Unselected instance + or dict with compatible properties + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + x + Sets the sample data to be binned on the x + axis. + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + xbins + plotly.graph_objs.histogram.XBins instance or + dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date + data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the sample data to be binned on the y + axis. + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. + ybins + plotly.graph_objs.histogram.YBins instance or + dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date + data. + ysrc + Sets the source reference on plot.ly for y . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HeatmapglValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='heatmapgl', parent_name='', **kwargs): + super(HeatmapglValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Heatmapgl'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `colorscale`. In case + `colorscale` is unspecified or `autocolorscale` + is true, the default palette will be chosen + according to whether numbers in the `color` + array are all positive, all negative or mixed. + colorbar + plotly.graph_objs.heatmapgl.ColorBar instance + or dict with compatible properties + colorscale + Sets the colorscale. The colorscale must be an + array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named + color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. + For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and + `zmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Grey + s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, + Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth + ,Electric,Viridis,Cividis. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + dx + Sets the x coordinate step. See `x0` for more + info. + dy + Sets the y coordinate step. See `y0` for more + info. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.heatmapgl.Hoverlabel instance + or dict with compatible properties + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, + `zmin` will correspond to the last color in the + array and `zmax` will correspond to the first + color. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + showscale + Determines whether or not a colorbar is + displayed for this trace. + stream + plotly.graph_objs.heatmapgl.Stream instance or + dict with compatible properties + text + Sets the text elements associated with each z + value. + textsrc + Sets the source reference on plot.ly for text + . + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the + starting coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + xsrc + Sets the source reference on plot.ly for x . + xtype + If "array", the heatmap's x coordinates are + given by "x" (the default behavior when `x` is + provided). If "scaled", the heatmap's x + coordinates are given by "x0" and "dx" (the + default behavior when `x` is not provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the + starting coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. + ysrc + Sets the source reference on plot.ly for y . + ytype + If "array", the heatmap's y coordinates are + given by "y" (the default behavior when `y` is + provided) If "scaled", the heatmap's y + coordinates are given by "y0" and "dy" (the + default behavior when `y` is not provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `z`) or the bounds set in `zmin` and `zmax` + Defaults to `false` when `zmin` and `zmax` are + set by the user. + zmax + Sets the upper bound of the color domain. Value + should have the same units as in `z` and if + set, `zmin` must be set as well. + zmid + Sets the mid-point of the color domain by + scaling `zmin` and/or `zmax` to be equidistant + to this point. Value should have the same units + as in `z`. Has no effect when `zauto` is + `false`. + zmin + Sets the lower bound of the color domain. Value + should have the same units as in `z` and if + set, `zmax` must be set as well. + zsrc + Sets the source reference on plot.ly for z . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HeatmapValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='heatmap', parent_name='', **kwargs): + super(HeatmapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Heatmap'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `colorscale`. In case + `colorscale` is unspecified or `autocolorscale` + is true, the default palette will be chosen + according to whether numbers in the `color` + array are all positive, all negative or mixed. + colorbar + plotly.graph_objs.heatmap.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. The colorscale must be an + array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named + color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. + For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and + `zmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Grey + s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, + Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth + ,Electric,Viridis,Cividis. + connectgaps + Determines whether or not gaps (i.e. {nan} or + missing values) in the `z` data are filled in. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + dx + Sets the x coordinate step. See `x0` for more + info. + dy + Sets the y coordinate step. See `y0` for more + info. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.heatmap.Hoverlabel instance + or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, + `zmin` will correspond to the last color in the + array and `zmax` will correspond to the first + color. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + showscale + Determines whether or not a colorbar is + displayed for this trace. + stream + plotly.graph_objs.heatmap.Stream instance or + dict with compatible properties + text + Sets the text elements associated with each z + value. + textsrc + Sets the source reference on plot.ly for text + . + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the + starting coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date + data. + xgap + Sets the horizontal gap (in pixels) between + bricks. + xsrc + Sets the source reference on plot.ly for x . + xtype + If "array", the heatmap's x coordinates are + given by "x" (the default behavior when `x` is + provided). If "scaled", the heatmap's x + coordinates are given by "x0" and "dx" (the + default behavior when `x` is not provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the + starting coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date + data. + ygap + Sets the vertical gap (in pixels) between + bricks. + ysrc + Sets the source reference on plot.ly for y . + ytype + If "array", the heatmap's y coordinates are + given by "y" (the default behavior when `y` is + provided) If "scaled", the heatmap's y + coordinates are given by "y0" and "dy" (the + default behavior when `y` is not provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `z`) or the bounds set in `zmin` and `zmax` + Defaults to `false` when `zmin` and `zmax` are + set by the user. + zhoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. See: https://github + .com/d3/d3-format/blob/master/README.md#locale_ + format + zmax + Sets the upper bound of the color domain. Value + should have the same units as in `z` and if + set, `zmin` must be set as well. + zmid + Sets the mid-point of the color domain by + scaling `zmin` and/or `zmax` to be equidistant + to this point. Value should have the same units + as in `z`. Has no effect when `zauto` is + `false`. + zmin + Sets the lower bound of the color domain. Value + should have the same units as in `z` and if + set, `zmax` must be set as well. + zsmooth + Picks a smoothing algorithm use to smooth `z` + data. + zsrc + Sets the source reference on plot.ly for z . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ContourcarpetValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='contourcarpet', parent_name='', **kwargs): + super(ContourcarpetValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Contourcarpet'), + data_docs=kwargs.pop( + 'data_docs', """ + a + Sets the x coordinates. + a0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the + starting coordinate and `dx` the step. + asrc + Sets the source reference on plot.ly for a . + atype + If "array", the heatmap's x coordinates are + given by "x" (the default behavior when `x` is + provided). If "scaled", the heatmap's x + coordinates are given by "x0" and "dx" (the + default behavior when `x` is not provided). + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `colorscale`. In case + `colorscale` is unspecified or `autocolorscale` + is true, the default palette will be chosen + according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level + attributes are picked by an algorithm. If True, + the number of contour levels can be set in + `ncontours`. If False, set the contour level + attributes in `contours`. + b + Sets the y coordinates. + b0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the + starting coordinate and `dy` the step. + bsrc + Sets the source reference on plot.ly for b . + btype + If "array", the heatmap's y coordinates are + given by "y" (the default behavior when `y` is + provided) If "scaled", the heatmap's y + coordinates are given by "y0" and "dy" (the + default behavior when `y` is not provided) + carpet + The `carpet` of the carpet axes on which this + contour trace lies + colorbar + plotly.graph_objs.contourcarpet.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. The colorscale must be an + array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named + color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. + For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and + `zmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Grey + s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, + Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth + ,Electric,Viridis,Cividis. + contours + plotly.graph_objs.contourcarpet.Contours + instance or dict with compatible properties + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + da + Sets the x coordinate step. See `x0` for more + info. + db + Sets the y coordinate step. See `y0` for more + info. + fillcolor + Sets the fill color if `contours.type` is + "constraint". Defaults to a half-transparent + variant of the line color, marker color, or + marker line color, whichever is available. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.contourcarpet.Hoverlabel + instance or dict with compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.contourcarpet.Line instance + or dict with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + ncontours + Sets the maximum number of contour levels. The + actual number of contours will be chosen + automatically to be less than or equal to the + value of `ncontours`. Has an effect only if + `autocontour` is True or if `contours.size` is + missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, + `zmin` will correspond to the last color in the + array and `zmax` will correspond to the first + color. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + showscale + Determines whether or not a colorbar is + displayed for this trace. + stream + plotly.graph_objs.contourcarpet.Stream instance + or dict with compatible properties + text + Sets the text elements associated with each z + value. + textsrc + Sets the source reference on plot.ly for text + . + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. + z + Sets the z data. + zauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `z`) or the bounds set in `zmin` and `zmax` + Defaults to `false` when `zmin` and `zmax` are + set by the user. + zmax + Sets the upper bound of the color domain. Value + should have the same units as in `z` and if + set, `zmin` must be set as well. + zmid + Sets the mid-point of the color domain by + scaling `zmin` and/or `zmax` to be equidistant + to this point. Value should have the same units + as in `z`. Has no effect when `zauto` is + `false`. + zmin + Sets the lower bound of the color domain. Value + should have the same units as in `z` and if + set, `zmax` must be set as well. + zsrc + Sets the source reference on plot.ly for z . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ContourValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='contour', parent_name='', **kwargs): + super(ContourValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Contour'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `colorscale`. In case + `colorscale` is unspecified or `autocolorscale` + is true, the default palette will be chosen + according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level + attributes are picked by an algorithm. If True, + the number of contour levels can be set in + `ncontours`. If False, set the contour level + attributes in `contours`. + colorbar + plotly.graph_objs.contour.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. The colorscale must be an + array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named + color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. + For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and + `zmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Grey + s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, + Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth + ,Electric,Viridis,Cividis. + connectgaps + Determines whether or not gaps (i.e. {nan} or + missing values) in the `z` data are filled in. + contours + plotly.graph_objs.contour.Contours instance or + dict with compatible properties + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + dx + Sets the x coordinate step. See `x0` for more + info. + dy + Sets the y coordinate step. See `y0` for more + info. + fillcolor + Sets the fill color if `contours.type` is + "constraint". Defaults to a half-transparent + variant of the line color, marker color, or + marker line color, whichever is available. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.contour.Hoverlabel instance + or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.contour.Line instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + ncontours + Sets the maximum number of contour levels. The + actual number of contours will be chosen + automatically to be less than or equal to the + value of `ncontours`. Has an effect only if + `autocontour` is True or if `contours.size` is + missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, + `zmin` will correspond to the last color in the + array and `zmax` will correspond to the first + color. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + showscale + Determines whether or not a colorbar is + displayed for this trace. + stream + plotly.graph_objs.contour.Stream instance or + dict with compatible properties + text + Sets the text elements associated with each z + value. + textsrc + Sets the source reference on plot.ly for text + . + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the + starting coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date + data. + xsrc + Sets the source reference on plot.ly for x . + xtype + If "array", the heatmap's x coordinates are + given by "x" (the default behavior when `x` is + provided). If "scaled", the heatmap's x + coordinates are given by "x0" and "dx" (the + default behavior when `x` is not provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the + starting coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date + data. + ysrc + Sets the source reference on plot.ly for y . + ytype + If "array", the heatmap's y coordinates are + given by "y" (the default behavior when `y` is + provided) If "scaled", the heatmap's y + coordinates are given by "y0" and "dy" (the + default behavior when `y` is not provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `z`) or the bounds set in `zmin` and `zmax` + Defaults to `false` when `zmin` and `zmax` are + set by the user. + zhoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. See: https://github + .com/d3/d3-format/blob/master/README.md#locale_ + format + zmax + Sets the upper bound of the color domain. Value + should have the same units as in `z` and if + set, `zmin` must be set as well. + zmid + Sets the mid-point of the color domain by + scaling `zmin` and/or `zmax` to be equidistant + to this point. Value should have the same units + as in `z`. Has no effect when `zauto` is + `false`. + zmin + Sets the lower bound of the color domain. Value + should have the same units as in `z` and if + set, `zmax` must be set as well. + zsrc + Sets the source reference on plot.ly for z . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConeValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='cone', parent_name='', **kwargs): + super(ConeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Cone'), + data_docs=kwargs.pop( + 'data_docs', """ + anchor + Sets the cones' anchor with respect to their + x/y/z positions. Note that "cm" denote the + cone's center of mass which corresponds to 1/4 + from the tail to tip. + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `colorscale`. In case + `colorscale` is unspecified or `autocolorscale` + is true, the default palette will be chosen + according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + u/v/w norm) or the bounds set in `cmin` and + `cmax` Defaults to `false` when `cmin` and + `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value + should have the same units as u/v/w norm and if + set, `cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `cmin` and/or `cmax` to be equidistant + to this point. Value should have the same units + as u/v/w norm. Has no effect when `cauto` is + `false`. + cmin + Sets the lower bound of the color domain. Value + should have the same units as u/v/w norm and if + set, `cmax` must be set as well. + colorbar + plotly.graph_objs.cone.ColorBar instance or + dict with compatible properties + colorscale + Sets the colorscale. The colorscale must be an + array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named + color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. + For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and + `cmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Grey + s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, + Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth + ,Electric,Viridis,Cividis. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.cone.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + variable `norm` Anything contained in tag + `` is displayed in the secondary box, + for example "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + lighting + plotly.graph_objs.cone.Lighting instance or + dict with compatible properties + lightposition + plotly.graph_objs.cone.Lightposition instance + or dict with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the surface. Please note + that in the case of using high `opacity` values + for example a value greater than or equal to + 0.5 on two surfaces (and 0.25 with four + surfaces), an overlay of multiple transparent + surfaces may not perfectly be sorted in depth + by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, + `cmin` will correspond to the last color in the + array and `cmax` will correspond to the first + color. + scene + Sets a reference between this trace's 3D + coordinate system and a 3D scene. If "scene" + (the default value), the (x,y,z) coordinates + refer to `layout.scene`. If "scene2", the + (x,y,z) coordinates refer to `layout.scene2`, + and so on. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + showscale + Determines whether or not a colorbar is + displayed for this trace. + sizemode + Determines whether `sizeref` is set as a + "scaled" (i.e unitless) scalar (normalized by + the max u/v/w norm in the vector field) or as + "absolute" value (in the same units as the + vector field). + sizeref + Adjusts the cone size scaling. The size of the + cones is determined by their u/v/w norm + multiplied a factor and `sizeref`. This factor + (computed internally) corresponds to the + minimum "time" to travel across two successive + x/y/z positions at the average velocity of + those two successive positions. All cones in a + given trace use the same factor. With + `sizemode` set to "scaled", `sizeref` is + unitless, its default value is 0.5 With + `sizemode` set to "absolute", `sizeref` has the + same units as the u/v/w vector field, its the + default value is half the sample's maximum + vector norm. + stream + plotly.graph_objs.cone.Stream instance or dict + with compatible properties + text + Sets the text elements associated with the + cones. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements + will be seen in the hover labels. + textsrc + Sets the source reference on plot.ly for text + . + u + Sets the x components of the vector field. + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + usrc + Sets the source reference on plot.ly for u . + v + Sets the y components of the vector field. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + vsrc + Sets the source reference on plot.ly for v . + w + Sets the z components of the vector field. + wsrc + Sets the source reference on plot.ly for w . + x + Sets the x coordinates of the vector field and + of the displayed cones. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates of the vector field and + of the displayed cones. + ysrc + Sets the source reference on plot.ly for y . + z + Sets the z coordinates of the vector field and + of the displayed cones. + zsrc + Sets the source reference on plot.ly for z . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ChoroplethValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='choropleth', parent_name='', **kwargs): + super(ChoroplethValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Choropleth'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `colorscale`. In case + `colorscale` is unspecified or `autocolorscale` + is true, the default palette will be chosen + according to whether numbers in the `color` + array are all positive, all negative or mixed. + colorbar + plotly.graph_objs.choropleth.ColorBar instance + or dict with compatible properties + colorscale + Sets the colorscale. The colorscale must be an + array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named + color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. + For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`zmin` and + `zmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Grey + s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, + Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth + ,Electric,Viridis,Cividis. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + geo + Sets a reference between this trace's + geospatial coordinates and a geographic map. If + "geo" (the default value), the geospatial + coordinates refer to `layout.geo`. If "geo2", + the geospatial coordinates refer to + `layout.geo2`, and so on. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.choropleth.Hoverlabel + instance or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + locationmode + Determines the set of locations used to match + entries in `locations` to regions on the map. + locations + Sets the coordinates via location IDs or names. + See `locationmode` for more info. + locationssrc + Sets the source reference on plot.ly for + locations . + marker + plotly.graph_objs.choropleth.Marker instance or + dict with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, + `zmin` will correspond to the last color in the + array and `zmax` will correspond to the first + color. + selected + plotly.graph_objs.choropleth.Selected instance + or dict with compatible properties + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + showscale + Determines whether or not a colorbar is + displayed for this trace. + stream + plotly.graph_objs.choropleth.Stream instance or + dict with compatible properties + text + Sets the text elements associated with each + location. + textsrc + Sets the source reference on plot.ly for text + . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + unselected + plotly.graph_objs.choropleth.Unselected + instance or dict with compatible properties + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + z + Sets the color values. + zauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `z`) or the bounds set in `zmin` and `zmax` + Defaults to `false` when `zmin` and `zmax` are + set by the user. + zmax + Sets the upper bound of the color domain. Value + should have the same units as in `z` and if + set, `zmin` must be set as well. + zmid + Sets the mid-point of the color domain by + scaling `zmin` and/or `zmax` to be equidistant + to this point. Value should have the same units + as in `z`. Has no effect when `zauto` is + `false`. + zmin + Sets the lower bound of the color domain. Value + should have the same units as in `z` and if + set, `zmax` must be set as well. + zsrc + Sets the source reference on plot.ly for z . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CarpetValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='carpet', parent_name='', **kwargs): + super(CarpetValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Carpet'), + data_docs=kwargs.pop( + 'data_docs', """ + a + An array containing values of the first + parameter value + a0 + Alternate to `a`. Builds a linear space of a + coordinates. Use with `da` where `a0` is the + starting coordinate and `da` the step. + aaxis + plotly.graph_objs.carpet.Aaxis instance or dict + with compatible properties + asrc + Sets the source reference on plot.ly for a . + b + A two dimensional array of y coordinates at + each carpet point. + b0 + Alternate to `b`. Builds a linear space of a + coordinates. Use with `db` where `b0` is the + starting coordinate and `db` the step. + baxis + plotly.graph_objs.carpet.Baxis instance or dict + with compatible properties + bsrc + Sets the source reference on plot.ly for b . + carpet + An identifier for this carpet, so that + `scattercarpet` and `scattercontour` traces can + specify a carpet plot on which they lie + cheaterslope + The shift applied to each successive row of + data in creating a cheater plot. Only used if + `x` is been ommitted. + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + da + Sets the a coordinate step. See `a0` for more + info. + db + Sets the b coordinate step. See `b0` for more + info. + font + The default font used for axis & tick labels on + this carpet + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.carpet.Hoverlabel instance or + dict with compatible properties + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.carpet.Stream instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + x + A two dimensional array of x coordinates at + each carpet point. If ommitted, the plot is a + cheater plot and the xaxis is hidden by + default. + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + xsrc + Sets the source reference on plot.ly for x . + y + A two dimensional array of y coordinates at + each carpet point. + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. + ysrc + Sets the source reference on plot.ly for y . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CandlestickValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='candlestick', parent_name='', **kwargs): + super(CandlestickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Candlestick'), + data_docs=kwargs.pop( + 'data_docs', """ + close + Sets the close values. + closesrc + Sets the source reference on plot.ly for close + . + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + decreasing + plotly.graph_objs.candlestick.Decreasing + instance or dict with compatible properties + high + Sets the high values. + highsrc + Sets the source reference on plot.ly for high + . + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.candlestick.Hoverlabel + instance or dict with compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + increasing + plotly.graph_objs.candlestick.Increasing + instance or dict with compatible properties + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.candlestick.Line instance or + dict with compatible properties + low + Sets the low values. + lowsrc + Sets the source reference on plot.ly for low . + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + open + Sets the open values. + opensrc + Sets the source reference on plot.ly for open + . + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.candlestick.Stream instance + or dict with compatible properties + text + Sets hover text elements associated with each + sample point. If a single string, the same + string appears over all the data points. If an + array of string, the items are mapped in order + to this trace's sample points. + textsrc + Sets the source reference on plot.ly for text + . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + whiskerwidth + Sets the width of the whiskers relative to the + box' width. For example, with 1, the whiskers + are as wide as the box(es). + x + Sets the x coordinates. If absent, linear + coordinate will be generated. + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date + data. + xsrc + Sets the source reference on plot.ly for x . + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BoxValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='box', parent_name='', **kwargs): + super(BoxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Box'), + data_docs=kwargs.pop( + 'data_docs', """ + alignmentgroup + Set several traces linked to the same position + axis or matching axes to the same + alignmentgroup. This controls whether bars + compute their positional range dependently or + independently. + boxmean + If True, the mean of the box(es)' underlying + distribution is drawn as a dashed line inside + the box(es). If "sd" the standard deviation is + also drawn. + boxpoints + If "outliers", only the sample points lying + outside the whiskers are shown If + "suspectedoutliers", the outlier points are + shown and points either less than 4*Q1-3*Q3 or + greater than 4*Q3-3*Q1 are highlighted (see + `outliercolor`) If "all", all sample points are + shown If False, only the box(es) are shown with + no sample points + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + fillcolor + Sets the fill color. Defaults to a half- + transparent variant of the line color, marker + color, or marker line color, whichever is + available. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.box.Hoverlabel instance or + dict with compatible properties + hoveron + Do the hover effects highlight individual boxes + or sample points or both? + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + jitter + Sets the amount of jitter in the sample points + drawn. If 0, the sample points align along the + distribution axis. If 1, the sample points are + drawn in a random jitter of width equal to the + width of the box(es). + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + line + plotly.graph_objs.box.Line instance or dict + with compatible properties + marker + plotly.graph_objs.box.Marker instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. For box traces, + the name will also be used for the position + coordinate, if `x` and `x0` (`y` and `y0` if + horizontal) are missing and the position axis + is categorical + notched + Determines whether or not notches should be + drawn. + notchwidth + Sets the width of the notches relative to the + box' width. For example, with 0, the notches + are as wide as the box(es). + offsetgroup + Set several traces linked to the same position + axis or matching axes to the same offsetgroup + where bars of the same position coordinate will + line up. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the box(es). If "v" + ("h"), the distribution is visualized along the + vertical (horizontal). + pointpos + Sets the position of the sample points in + relation to the box(es). If 0, the sample + points are places over the center of the + box(es). Positive (negative) values correspond + to positions to the right (left) for vertical + boxes and above (below) for horizontal boxes + selected + plotly.graph_objs.box.Selected instance or dict + with compatible properties + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.box.Stream instance or dict + with compatible properties + text + Sets the text elements associated with each + sample value. If a single string, the same + string appears over all the data points. If an + array of string, the items are mapped in order + to the this trace's (x,y) coordinates. To be + seen, trace `hoverinfo` must contain a "text" + flag. + textsrc + Sets the source reference on plot.ly for text + . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + unselected + plotly.graph_objs.box.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + whiskerwidth + Sets the width of the whiskers relative to the + box' width. For example, with 1, the whiskers + are as wide as the box(es). + width + Sets the width of the box in data coordinate If + 0 (default value) the width is automatically + selected based on the positions of other box + traces in the same subplot. + x + Sets the x sample data or coordinates. See + overview for more info. + x0 + Sets the x coordinate of the box. See overview + for more info. + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date + data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y sample data or coordinates. See + overview for more info. + y0 + Sets the y coordinate of the box. See overview + for more info. + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date + data. + ysrc + Sets the source reference on plot.ly for y . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BarpolarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='barpolar', parent_name='', **kwargs): + super(BarpolarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Barpolar'), + data_docs=kwargs.pop( + 'data_docs', """ + base + Sets where the bar base is drawn (in radial + axis units). In "stack" barmode, traces that + set "base" will be excluded and drawn in + "overlay" mode instead. + basesrc + Sets the source reference on plot.ly for base + . + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period + divided by the length of the `r` coordinates. + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.barpolar.Hoverlabel instance + or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + marker + plotly.graph_objs.barpolar.Marker instance or + dict with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + offset + Shifts the angular position where the bar is + drawn (in "thetatunit" units). + offsetsrc + Sets the source reference on plot.ly for + offset . + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the + starting coordinate and `dr` the step. + rsrc + Sets the source reference on plot.ly for r . + selected + plotly.graph_objs.barpolar.Selected instance or + dict with compatible properties + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.barpolar.Stream instance or + dict with compatible properties + subplot + Sets a reference between this trace's data + coordinates and a polar subplot. If "polar" + (the default value), the data refer to + `layout.polar`. If "polar2", the data refer to + `layout.polar2`, and so on. + text + Sets hover text elements associated with each + bar. If a single string, the same string + appears over all bars. If an array of string, + the items are mapped in order to the this + trace's coordinates. + textsrc + Sets the source reference on plot.ly for text + . + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of + theta coordinates. Use with `dtheta` where + `theta0` is the starting coordinate and + `dtheta` the step. + thetasrc + Sets the source reference on plot.ly for theta + . + thetaunit + Sets the unit of input "theta" values. Has an + effect only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + unselected + plotly.graph_objs.barpolar.Unselected instance + or dict with compatible properties + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + width + Sets the bar angular width (in "thetaunit" + units). + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='bar', parent_name='', **kwargs): + super(BarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Bar'), + data_docs=kwargs.pop( + 'data_docs', """ + alignmentgroup + Set several traces linked to the same position + axis or matching axes to the same + alignmentgroup. This controls whether bars + compute their positional range dependently or + independently. + base + Sets where the bar base is drawn (in position + axis units). In "stack" or "relative" barmode, + traces that set "base" will be excluded and + drawn in "overlay" mode instead. + basesrc + Sets the source reference on plot.ly for base + . + cliponaxis + Determines whether the text nodes are clipped + about the subplot axes. To show the text nodes + above axis lines and tick labels, make sure to + set `xaxis.layer` and `yaxis.layer` to *below + traces*. + constraintext + Constrain the size of text inside or outside a + bar to be no larger than the bar itself. + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + dx + Sets the x coordinate step. See `x0` for more + info. + dy + Sets the y coordinate step. See `y0` for more + info. + error_x + plotly.graph_objs.bar.ErrorX instance or dict + with compatible properties + error_y + plotly.graph_objs.bar.ErrorY instance or dict + with compatible properties + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.bar.Hoverlabel instance or + dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + hovertext + Sets hover text elements associated with each + (x,y) pair. If a single string, the same string + appears over all the data points. If an array + of string, the items are mapped in order to the + this trace's (x,y) coordinates. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on plot.ly for + hovertext . + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + insidetextfont + Sets the font used for `text` lying inside the + bar. + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + marker + plotly.graph_objs.bar.Marker instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + offset + Shifts the position where the bar is drawn (in + position axis units). In "group" barmode, + traces that set "offset" will be excluded and + drawn in "overlay" mode instead. + offsetgroup + Set several traces linked to the same position + axis or matching axes to the same offsetgroup + where bars of the same position coordinate will + line up. + offsetsrc + Sets the source reference on plot.ly for + offset . + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" + ("h"), the value of the each bar spans along + the vertical (horizontal). + outsidetextfont + Sets the font used for `text` lying outside the + bar. + r + r coordinates in scatter traces are + deprecated!Please switch to the "scatterpolar" + trace type.Sets the radial coordinatesfor + legacy polar chart only. + rsrc + Sets the source reference on plot.ly for r . + selected + plotly.graph_objs.bar.Selected instance or dict + with compatible properties + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.bar.Stream instance or dict + with compatible properties + t + t coordinates in scatter traces are + deprecated!Please switch to the "scatterpolar" + trace type.Sets the angular coordinatesfor + legacy polar chart only. + text + Sets text elements associated with each (x,y) + pair. If a single string, the same string + appears over all the data points. If an array + of string, the items are mapped in order to the + this trace's (x,y) coordinates. If trace + `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the font used for `text`. + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end + (rotated and scaled if needed). "outside" + positions `text` outside, next to the bar end + (scaled if needed), unless there is another bar + stacked on this one, then the text gets pushed + inside. "auto" tries to position `text` inside + the bar, but if the bar is too small and no bar + is stacked on this one the text is moved + outside. + textpositionsrc + Sets the source reference on plot.ly for + textposition . + textsrc + Sets the source reference on plot.ly for text + . + tsrc + Sets the source reference on plot.ly for t . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + unselected + plotly.graph_objs.bar.Unselected instance or + dict with compatible properties + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). + width + Sets the bar width (in position axis units). + widthsrc + Sets the source reference on plot.ly for width + . + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the + starting coordinate and `dx` the step. + xaxis + Sets a reference between this trace's x + coordinates and a 2D cartesian x axis. If "x" + (the default value), the x coordinates refer to + `layout.xaxis`. If "x2", the x coordinates + refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date + data. + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the + starting coordinate and `dy` the step. + yaxis + Sets a reference between this trace's y + coordinates and a 2D cartesian y axis. If "y" + (the default value), the y coordinates refer to + `layout.yaxis`. If "y2", the y coordinates + refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date + data. + ysrc + Sets the source reference on plot.ly for y . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AreaValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='area', parent_name='', **kwargs): + super(AreaValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Area'), + data_docs=kwargs.pop( + 'data_docs', """ + customdata + Assigns extra data each datum. This may be + useful when listening to hover, click and + selection events. Note that, "scatter" traces + also appends customdata items in the markers + DOM elements + customdatasrc + Sets the source reference on plot.ly for + customdata . + hoverinfo + Determines which trace information appear on + hover. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverinfosrc + Sets the source reference on plot.ly for + hoverinfo . + hoverlabel + plotly.graph_objs.area.Hoverlabel instance or + dict with compatible properties + ids + Assigns id labels to each datum. These ids for + object constancy of data points during + animation. Should be an array of strings, not + numbers or any other type. + idssrc + Sets the source reference on plot.ly for ids . + legendgroup + Sets the legend group for this trace. Traces + part of the same legend group hide/show at the + same time when toggling legend items. + marker + plotly.graph_objs.area.Marker instance or dict + with compatible properties + name + Sets the trace name. The trace name appear as + the legend item and on hover. + opacity + Sets the opacity of the trace. + r + Area traces are deprecated! Please switch to + the "barpolar" trace type. Sets the radial + coordinates for legacy polar chart only. + rsrc + Sets the source reference on plot.ly for r . + selectedpoints + Array containing integer indices of selected + points. Has an effect only for traces that + support selections. Note that an empty array + means an empty selection where the `unselected` + are turned on for all points, whereas, any + other non-array values means no selection all + where the `selected` and `unselected` styles + have no effect. + showlegend + Determines whether or not an item corresponding + to this trace is shown in the legend. + stream + plotly.graph_objs.area.Stream instance or dict + with compatible properties + t + Area traces are deprecated! Please switch to + the "barpolar" trace type. Sets the angular + coordinates for legacy polar chart only. + tsrc + Sets the source reference on plot.ly for t . + uid + Assign an id to this trace, Use this to provide + object constancy between traces during + animations and transitions. + uirevision + Controls persistence of some user-driven + changes to the trace: `constraintrange` in + `parcoords` traces, as well as some `editable: + true` modifications such as `name` and + `colorbar.title`. Defaults to + `layout.uirevision`. Note that other user- + driven trace attribute changes are controlled + by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and + `colorbar.(x|y)` (accessible with `config: + {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on + trace index if no `uid` is provided. So if your + app can add/remove traces before the end of the + `data` array, such that the same trace has a + different index, you can still preserve user- + driven changes if you give each trace a `uid` + that stays with it as it moves. + visible + Determines whether or not this trace is + visible. If "legendonly", the trace is not + drawn, but can appear as a legend item + (provided that the legend itself is visible). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FramesValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__(self, plotly_name='frames', parent_name='', **kwargs): + super(FramesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Frame'), + data_docs=kwargs.pop( + 'data_docs', """ + baseframe + The name of the frame into which this frame's + properties are merged before applying. This is + used to unify properties and avoid needing to + specify the same values for the same properties + in multiple frames. + data + A list of traces this frame modifies. The + format is identical to the normal trace + definition. + group + An identifier that specifies the group to which + the frame belongs, used by animate to select a + subset of frames. + layout + Layout properties which this frame modifies. + The format is identical to the normal layout + definition. + name + A label by which to identify the frame + traces + A list of trace indices that identify the + respective traces in the data attribute +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DataValidator(_plotly_utils.basevalidators.BaseDataValidator): + + def __init__(self, plotly_name='data', parent_name='', **kwargs): + + super(DataValidator, self).__init__( + class_strs_map={ + 'area': 'Area', + 'bar': 'Bar', + 'barpolar': 'Barpolar', + 'box': 'Box', + 'candlestick': 'Candlestick', + 'carpet': 'Carpet', + 'choropleth': 'Choropleth', + 'cone': 'Cone', + 'contour': 'Contour', + 'contourcarpet': 'Contourcarpet', + 'heatmap': 'Heatmap', + 'heatmapgl': 'Heatmapgl', + 'histogram': 'Histogram', + 'histogram2d': 'Histogram2d', + 'histogram2dcontour': 'Histogram2dContour', + 'isosurface': 'Isosurface', + 'mesh3d': 'Mesh3d', + 'ohlc': 'Ohlc', + 'parcats': 'Parcats', + 'parcoords': 'Parcoords', + 'pie': 'Pie', + 'pointcloud': 'Pointcloud', + 'sankey': 'Sankey', + 'scatter': 'Scatter', + 'scatter3d': 'Scatter3d', + 'scattercarpet': 'Scattercarpet', + 'scattergeo': 'Scattergeo', + 'scattergl': 'Scattergl', + 'scattermapbox': 'Scattermapbox', + 'scatterpolar': 'Scatterpolar', + 'scatterpolargl': 'Scatterpolargl', + 'scatterternary': 'Scatterternary', + 'splom': 'Splom', + 'streamtube': 'Streamtube', + 'surface': 'Surface', + 'table': 'Table', + 'violin': 'Violin', + }, + plotly_name=plotly_name, + parent_name=parent_name, + **kwargs + ) diff --git a/plotly/validators/_area.py b/plotly/validators/_area.py deleted file mode 100644 index 088addbcfe6..00000000000 --- a/plotly/validators/_area.py +++ /dev/null @@ -1,114 +0,0 @@ -import _plotly_utils.basevalidators - - -class AreaValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='area', parent_name='', **kwargs): - super(AreaValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Area'), - data_docs=kwargs.pop( - 'data_docs', """ - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.area.Hoverlabel instance or - dict with compatible properties - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - marker - plotly.graph_objs.area.Marker instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - r - Area traces are deprecated! Please switch to - the "barpolar" trace type. Sets the radial - coordinates for legacy polar chart only. - rsrc - Sets the source reference on plot.ly for r . - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.area.Stream instance or dict - with compatible properties - t - Area traces are deprecated! Please switch to - the "barpolar" trace type. Sets the angular - coordinates for legacy polar chart only. - tsrc - Sets the source reference on plot.ly for t . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). -""" - ), - **kwargs - ) diff --git a/plotly/validators/_bar.py b/plotly/validators/_bar.py deleted file mode 100644 index f501c595bbb..00000000000 --- a/plotly/validators/_bar.py +++ /dev/null @@ -1,279 +0,0 @@ -import _plotly_utils.basevalidators - - -class BarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='bar', parent_name='', **kwargs): - super(BarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Bar'), - data_docs=kwargs.pop( - 'data_docs', """ - alignmentgroup - Set several traces linked to the same position - axis or matching axes to the same - alignmentgroup. This controls whether bars - compute their positional range dependently or - independently. - base - Sets where the bar base is drawn (in position - axis units). In "stack" or "relative" barmode, - traces that set "base" will be excluded and - drawn in "overlay" mode instead. - basesrc - Sets the source reference on plot.ly for base - . - cliponaxis - Determines whether the text nodes are clipped - about the subplot axes. To show the text nodes - above axis lines and tick labels, make sure to - set `xaxis.layer` and `yaxis.layer` to *below - traces*. - constraintext - Constrain the size of text inside or outside a - bar to be no larger than the bar itself. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - dx - Sets the x coordinate step. See `x0` for more - info. - dy - Sets the y coordinate step. See `y0` for more - info. - error_x - plotly.graph_objs.bar.ErrorX instance or dict - with compatible properties - error_y - plotly.graph_objs.bar.ErrorY instance or dict - with compatible properties - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.bar.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Sets hover text elements associated with each - (x,y) pair. If a single string, the same string - appears over all the data points. If an array - of string, the items are mapped in order to the - this trace's (x,y) coordinates. To be seen, - trace `hoverinfo` must contain a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - insidetextfont - Sets the font used for `text` lying inside the - bar. - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - marker - plotly.graph_objs.bar.Marker instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - offset - Shifts the position where the bar is drawn (in - position axis units). In "group" barmode, - traces that set "offset" will be excluded and - drawn in "overlay" mode instead. - offsetgroup - Set several traces linked to the same position - axis or matching axes to the same offsetgroup - where bars of the same position coordinate will - line up. - offsetsrc - Sets the source reference on plot.ly for - offset . - opacity - Sets the opacity of the trace. - orientation - Sets the orientation of the bars. With "v" - ("h"), the value of the each bar spans along - the vertical (horizontal). - outsidetextfont - Sets the font used for `text` lying outside the - bar. - r - r coordinates in scatter traces are - deprecated!Please switch to the "scatterpolar" - trace type.Sets the radial coordinatesfor - legacy polar chart only. - rsrc - Sets the source reference on plot.ly for r . - selected - plotly.graph_objs.bar.Selected instance or dict - with compatible properties - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.bar.Stream instance or dict - with compatible properties - t - t coordinates in scatter traces are - deprecated!Please switch to the "scatterpolar" - trace type.Sets the angular coordinatesfor - legacy polar chart only. - text - Sets text elements associated with each (x,y) - pair. If a single string, the same string - appears over all the data points. If an array - of string, the items are mapped in order to the - this trace's (x,y) coordinates. If trace - `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be - seen in the hover labels. - textfont - Sets the font used for `text`. - textposition - Specifies the location of the `text`. "inside" - positions `text` inside, next to the bar end - (rotated and scaled if needed). "outside" - positions `text` outside, next to the bar end - (scaled if needed), unless there is another bar - stacked on this one, then the text gets pushed - inside. "auto" tries to position `text` inside - the bar, but if the bar is too small and no bar - is stacked on this one the text is moved - outside. - textpositionsrc - Sets the source reference on plot.ly for - textposition . - textsrc - Sets the source reference on plot.ly for text - . - tsrc - Sets the source reference on plot.ly for t . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - unselected - plotly.graph_objs.bar.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - width - Sets the bar width (in position axis units). - widthsrc - Sets the source reference on plot.ly for width - . - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the - starting coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date - data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the - starting coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date - data. - ysrc - Sets the source reference on plot.ly for y . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_barpolar.py b/plotly/validators/_barpolar.py deleted file mode 100644 index c01e9372a72..00000000000 --- a/plotly/validators/_barpolar.py +++ /dev/null @@ -1,197 +0,0 @@ -import _plotly_utils.basevalidators - - -class BarpolarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='barpolar', parent_name='', **kwargs): - super(BarpolarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Barpolar'), - data_docs=kwargs.pop( - 'data_docs', """ - base - Sets where the bar base is drawn (in radial - axis units). In "stack" barmode, traces that - set "base" will be excluded and drawn in - "overlay" mode instead. - basesrc - Sets the source reference on plot.ly for base - . - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - dr - Sets the r coordinate step. - dtheta - Sets the theta coordinate step. By default, the - `dtheta` step equals the subplot's period - divided by the length of the `r` coordinates. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.barpolar.Hoverlabel instance - or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - marker - plotly.graph_objs.barpolar.Marker instance or - dict with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - offset - Shifts the angular position where the bar is - drawn (in "thetatunit" units). - offsetsrc - Sets the source reference on plot.ly for - offset . - opacity - Sets the opacity of the trace. - r - Sets the radial coordinates - r0 - Alternate to `r`. Builds a linear space of r - coordinates. Use with `dr` where `r0` is the - starting coordinate and `dr` the step. - rsrc - Sets the source reference on plot.ly for r . - selected - plotly.graph_objs.barpolar.Selected instance or - dict with compatible properties - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.barpolar.Stream instance or - dict with compatible properties - subplot - Sets a reference between this trace's data - coordinates and a polar subplot. If "polar" - (the default value), the data refer to - `layout.polar`. If "polar2", the data refer to - `layout.polar2`, and so on. - text - Sets hover text elements associated with each - bar. If a single string, the same string - appears over all bars. If an array of string, - the items are mapped in order to the this - trace's coordinates. - textsrc - Sets the source reference on plot.ly for text - . - theta - Sets the angular coordinates - theta0 - Alternate to `theta`. Builds a linear space of - theta coordinates. Use with `dtheta` where - `theta0` is the starting coordinate and - `dtheta` the step. - thetasrc - Sets the source reference on plot.ly for theta - . - thetaunit - Sets the unit of input "theta" values. Has an - effect only when on "linear" angular axes. - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - unselected - plotly.graph_objs.barpolar.Unselected instance - or dict with compatible properties - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - width - Sets the bar angular width (in "thetaunit" - units). - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_box.py b/plotly/validators/_box.py deleted file mode 100644 index 8c019c817c4..00000000000 --- a/plotly/validators/_box.py +++ /dev/null @@ -1,231 +0,0 @@ -import _plotly_utils.basevalidators - - -class BoxValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='box', parent_name='', **kwargs): - super(BoxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Box'), - data_docs=kwargs.pop( - 'data_docs', """ - alignmentgroup - Set several traces linked to the same position - axis or matching axes to the same - alignmentgroup. This controls whether bars - compute their positional range dependently or - independently. - boxmean - If True, the mean of the box(es)' underlying - distribution is drawn as a dashed line inside - the box(es). If "sd" the standard deviation is - also drawn. - boxpoints - If "outliers", only the sample points lying - outside the whiskers are shown If - "suspectedoutliers", the outlier points are - shown and points either less than 4*Q1-3*Q3 or - greater than 4*Q3-3*Q1 are highlighted (see - `outliercolor`) If "all", all sample points are - shown If False, only the box(es) are shown with - no sample points - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - fillcolor - Sets the fill color. Defaults to a half- - transparent variant of the line color, marker - color, or marker line color, whichever is - available. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.box.Hoverlabel instance or - dict with compatible properties - hoveron - Do the hover effects highlight individual boxes - or sample points or both? - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - jitter - Sets the amount of jitter in the sample points - drawn. If 0, the sample points align along the - distribution axis. If 1, the sample points are - drawn in a random jitter of width equal to the - width of the box(es). - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.box.Line instance or dict - with compatible properties - marker - plotly.graph_objs.box.Marker instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. For box traces, - the name will also be used for the position - coordinate, if `x` and `x0` (`y` and `y0` if - horizontal) are missing and the position axis - is categorical - notched - Determines whether or not notches should be - drawn. - notchwidth - Sets the width of the notches relative to the - box' width. For example, with 0, the notches - are as wide as the box(es). - offsetgroup - Set several traces linked to the same position - axis or matching axes to the same offsetgroup - where bars of the same position coordinate will - line up. - opacity - Sets the opacity of the trace. - orientation - Sets the orientation of the box(es). If "v" - ("h"), the distribution is visualized along the - vertical (horizontal). - pointpos - Sets the position of the sample points in - relation to the box(es). If 0, the sample - points are places over the center of the - box(es). Positive (negative) values correspond - to positions to the right (left) for vertical - boxes and above (below) for horizontal boxes - selected - plotly.graph_objs.box.Selected instance or dict - with compatible properties - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.box.Stream instance or dict - with compatible properties - text - Sets the text elements associated with each - sample value. If a single string, the same - string appears over all the data points. If an - array of string, the items are mapped in order - to the this trace's (x,y) coordinates. To be - seen, trace `hoverinfo` must contain a "text" - flag. - textsrc - Sets the source reference on plot.ly for text - . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - unselected - plotly.graph_objs.box.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - whiskerwidth - Sets the width of the whiskers relative to the - box' width. For example, with 1, the whiskers - are as wide as the box(es). - width - Sets the width of the box in data coordinate If - 0 (default value) the width is automatically - selected based on the positions of other box - traces in the same subplot. - x - Sets the x sample data or coordinates. See - overview for more info. - x0 - Sets the x coordinate of the box. See overview - for more info. - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date - data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y sample data or coordinates. See - overview for more info. - y0 - Sets the y coordinate of the box. See overview - for more info. - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date - data. - ysrc - Sets the source reference on plot.ly for y . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_candlestick.py b/plotly/validators/_candlestick.py deleted file mode 100644 index c7f15457535..00000000000 --- a/plotly/validators/_candlestick.py +++ /dev/null @@ -1,165 +0,0 @@ -import _plotly_utils.basevalidators - - -class CandlestickValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='candlestick', parent_name='', **kwargs): - super(CandlestickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Candlestick'), - data_docs=kwargs.pop( - 'data_docs', """ - close - Sets the close values. - closesrc - Sets the source reference on plot.ly for close - . - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - decreasing - plotly.graph_objs.candlestick.Decreasing - instance or dict with compatible properties - high - Sets the high values. - highsrc - Sets the source reference on plot.ly for high - . - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.candlestick.Hoverlabel - instance or dict with compatible properties - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - increasing - plotly.graph_objs.candlestick.Increasing - instance or dict with compatible properties - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.candlestick.Line instance or - dict with compatible properties - low - Sets the low values. - lowsrc - Sets the source reference on plot.ly for low . - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - open - Sets the open values. - opensrc - Sets the source reference on plot.ly for open - . - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.candlestick.Stream instance - or dict with compatible properties - text - Sets hover text elements associated with each - sample point. If a single string, the same - string appears over all the data points. If an - array of string, the items are mapped in order - to this trace's sample points. - textsrc - Sets the source reference on plot.ly for text - . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - whiskerwidth - Sets the width of the whiskers relative to the - box' width. For example, with 1, the whiskers - are as wide as the box(es). - x - Sets the x coordinates. If absent, linear - coordinate will be generated. - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date - data. - xsrc - Sets the source reference on plot.ly for x . - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. -""" - ), - **kwargs - ) diff --git a/plotly/validators/_carpet.py b/plotly/validators/_carpet.py deleted file mode 100644 index 08c4345849d..00000000000 --- a/plotly/validators/_carpet.py +++ /dev/null @@ -1,170 +0,0 @@ -import _plotly_utils.basevalidators - - -class CarpetValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='carpet', parent_name='', **kwargs): - super(CarpetValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Carpet'), - data_docs=kwargs.pop( - 'data_docs', """ - a - An array containing values of the first - parameter value - a0 - Alternate to `a`. Builds a linear space of a - coordinates. Use with `da` where `a0` is the - starting coordinate and `da` the step. - aaxis - plotly.graph_objs.carpet.Aaxis instance or dict - with compatible properties - asrc - Sets the source reference on plot.ly for a . - b - A two dimensional array of y coordinates at - each carpet point. - b0 - Alternate to `b`. Builds a linear space of a - coordinates. Use with `db` where `b0` is the - starting coordinate and `db` the step. - baxis - plotly.graph_objs.carpet.Baxis instance or dict - with compatible properties - bsrc - Sets the source reference on plot.ly for b . - carpet - An identifier for this carpet, so that - `scattercarpet` and `scattercontour` traces can - specify a carpet plot on which they lie - cheaterslope - The shift applied to each successive row of - data in creating a cheater plot. Only used if - `x` is been ommitted. - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - da - Sets the a coordinate step. See `a0` for more - info. - db - Sets the b coordinate step. See `b0` for more - info. - font - The default font used for axis & tick labels on - this carpet - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.carpet.Hoverlabel instance or - dict with compatible properties - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.carpet.Stream instance or - dict with compatible properties - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - x - A two dimensional array of x coordinates at - each carpet point. If ommitted, the plot is a - cheater plot and the xaxis is hidden by - default. - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - xsrc - Sets the source reference on plot.ly for x . - y - A two dimensional array of y coordinates at - each carpet point. - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. - ysrc - Sets the source reference on plot.ly for y . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_choropleth.py b/plotly/validators/_choropleth.py deleted file mode 100644 index f194851ed3d..00000000000 --- a/plotly/validators/_choropleth.py +++ /dev/null @@ -1,214 +0,0 @@ -import _plotly_utils.basevalidators - - -class ChoroplethValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='choropleth', parent_name='', **kwargs): - super(ChoroplethValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Choropleth'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `colorscale`. In case - `colorscale` is unspecified or `autocolorscale` - is true, the default palette will be chosen - according to whether numbers in the `color` - array are all positive, all negative or mixed. - colorbar - plotly.graph_objs.choropleth.ColorBar instance - or dict with compatible properties - colorscale - Sets the colorscale. The colorscale must be an - array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named - color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. - For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and - `zmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Grey - s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, - Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth - ,Electric,Viridis,Cividis. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - geo - Sets a reference between this trace's - geospatial coordinates and a geographic map. If - "geo" (the default value), the geospatial - coordinates refer to `layout.geo`. If "geo2", - the geospatial coordinates refer to - `layout.geo2`, and so on. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.choropleth.Hoverlabel - instance or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - locationmode - Determines the set of locations used to match - entries in `locations` to regions on the map. - locations - Sets the coordinates via location IDs or names. - See `locationmode` for more info. - locationssrc - Sets the source reference on plot.ly for - locations . - marker - plotly.graph_objs.choropleth.Marker instance or - dict with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, - `zmin` will correspond to the last color in the - array and `zmax` will correspond to the first - color. - selected - plotly.graph_objs.choropleth.Selected instance - or dict with compatible properties - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - showscale - Determines whether or not a colorbar is - displayed for this trace. - stream - plotly.graph_objs.choropleth.Stream instance or - dict with compatible properties - text - Sets the text elements associated with each - location. - textsrc - Sets the source reference on plot.ly for text - . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - unselected - plotly.graph_objs.choropleth.Unselected - instance or dict with compatible properties - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - z - Sets the color values. - zauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `z`) or the bounds set in `zmin` and `zmax` - Defaults to `false` when `zmin` and `zmax` are - set by the user. - zmax - Sets the upper bound of the color domain. Value - should have the same units as in `z` and if - set, `zmin` must be set as well. - zmid - Sets the mid-point of the color domain by - scaling `zmin` and/or `zmax` to be equidistant - to this point. Value should have the same units - as in `z`. Has no effect when `zauto` is - `false`. - zmin - Sets the lower bound of the color domain. Value - should have the same units as in `z` and if - set, `zmax` must be set as well. - zsrc - Sets the source reference on plot.ly for z . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_cone.py b/plotly/validators/_cone.py deleted file mode 100644 index 6a687c9f1b8..00000000000 --- a/plotly/validators/_cone.py +++ /dev/null @@ -1,260 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConeValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='cone', parent_name='', **kwargs): - super(ConeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Cone'), - data_docs=kwargs.pop( - 'data_docs', """ - anchor - Sets the cones' anchor with respect to their - x/y/z positions. Note that "cm" denote the - cone's center of mass which corresponds to 1/4 - from the tail to tip. - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `colorscale`. In case - `colorscale` is unspecified or `autocolorscale` - is true, the default palette will be chosen - according to whether numbers in the `color` - array are all positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - u/v/w norm) or the bounds set in `cmin` and - `cmax` Defaults to `false` when `cmin` and - `cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Value - should have the same units as u/v/w norm and if - set, `cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `cmin` and/or `cmax` to be equidistant - to this point. Value should have the same units - as u/v/w norm. Has no effect when `cauto` is - `false`. - cmin - Sets the lower bound of the color domain. Value - should have the same units as u/v/w norm and if - set, `cmax` must be set as well. - colorbar - plotly.graph_objs.cone.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. The colorscale must be an - array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named - color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. - For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and - `cmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Grey - s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, - Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth - ,Electric,Viridis,Cividis. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.cone.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - variable `norm` Anything contained in tag - `` is displayed in the secondary box, - for example "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - lighting - plotly.graph_objs.cone.Lighting instance or - dict with compatible properties - lightposition - plotly.graph_objs.cone.Lightposition instance - or dict with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the surface. Please note - that in the case of using high `opacity` values - for example a value greater than or equal to - 0.5 on two surfaces (and 0.25 with four - surfaces), an overlay of multiple transparent - surfaces may not perfectly be sorted in depth - by the webgl API. This behavior may be improved - in the near future and is subject to change. - reversescale - Reverses the color mapping if true. If true, - `cmin` will correspond to the last color in the - array and `cmax` will correspond to the first - color. - scene - Sets a reference between this trace's 3D - coordinate system and a 3D scene. If "scene" - (the default value), the (x,y,z) coordinates - refer to `layout.scene`. If "scene2", the - (x,y,z) coordinates refer to `layout.scene2`, - and so on. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - showscale - Determines whether or not a colorbar is - displayed for this trace. - sizemode - Determines whether `sizeref` is set as a - "scaled" (i.e unitless) scalar (normalized by - the max u/v/w norm in the vector field) or as - "absolute" value (in the same units as the - vector field). - sizeref - Adjusts the cone size scaling. The size of the - cones is determined by their u/v/w norm - multiplied a factor and `sizeref`. This factor - (computed internally) corresponds to the - minimum "time" to travel across two successive - x/y/z positions at the average velocity of - those two successive positions. All cones in a - given trace use the same factor. With - `sizemode` set to "scaled", `sizeref` is - unitless, its default value is 0.5 With - `sizemode` set to "absolute", `sizeref` has the - same units as the u/v/w vector field, its the - default value is half the sample's maximum - vector norm. - stream - plotly.graph_objs.cone.Stream instance or dict - with compatible properties - text - Sets the text elements associated with the - cones. If trace `hoverinfo` contains a "text" - flag and "hovertext" is not set, these elements - will be seen in the hover labels. - textsrc - Sets the source reference on plot.ly for text - . - u - Sets the x components of the vector field. - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - usrc - Sets the source reference on plot.ly for u . - v - Sets the y components of the vector field. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - vsrc - Sets the source reference on plot.ly for v . - w - Sets the z components of the vector field. - wsrc - Sets the source reference on plot.ly for w . - x - Sets the x coordinates of the vector field and - of the displayed cones. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates of the vector field and - of the displayed cones. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the z coordinates of the vector field and - of the displayed cones. - zsrc - Sets the source reference on plot.ly for z . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_contour.py b/plotly/validators/_contour.py deleted file mode 100644 index b799c5e2182..00000000000 --- a/plotly/validators/_contour.py +++ /dev/null @@ -1,276 +0,0 @@ -import _plotly_utils.basevalidators - - -class ContourValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='contour', parent_name='', **kwargs): - super(ContourValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Contour'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `colorscale`. In case - `colorscale` is unspecified or `autocolorscale` - is true, the default palette will be chosen - according to whether numbers in the `color` - array are all positive, all negative or mixed. - autocontour - Determines whether or not the contour level - attributes are picked by an algorithm. If True, - the number of contour levels can be set in - `ncontours`. If False, set the contour level - attributes in `contours`. - colorbar - plotly.graph_objs.contour.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. The colorscale must be an - array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named - color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. - For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and - `zmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Grey - s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, - Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth - ,Electric,Viridis,Cividis. - connectgaps - Determines whether or not gaps (i.e. {nan} or - missing values) in the `z` data are filled in. - contours - plotly.graph_objs.contour.Contours instance or - dict with compatible properties - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - dx - Sets the x coordinate step. See `x0` for more - info. - dy - Sets the y coordinate step. See `y0` for more - info. - fillcolor - Sets the fill color if `contours.type` is - "constraint". Defaults to a half-transparent - variant of the line color, marker color, or - marker line color, whichever is available. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.contour.Hoverlabel instance - or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.contour.Line instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - ncontours - Sets the maximum number of contour levels. The - actual number of contours will be chosen - automatically to be less than or equal to the - value of `ncontours`. Has an effect only if - `autocontour` is True or if `contours.size` is - missing. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, - `zmin` will correspond to the last color in the - array and `zmax` will correspond to the first - color. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - showscale - Determines whether or not a colorbar is - displayed for this trace. - stream - plotly.graph_objs.contour.Stream instance or - dict with compatible properties - text - Sets the text elements associated with each z - value. - textsrc - Sets the source reference on plot.ly for text - . - transpose - Transposes the z data. - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the - starting coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date - data. - xsrc - Sets the source reference on plot.ly for x . - xtype - If "array", the heatmap's x coordinates are - given by "x" (the default behavior when `x` is - provided). If "scaled", the heatmap's x - coordinates are given by "x0" and "dx" (the - default behavior when `x` is not provided). - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the - starting coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date - data. - ysrc - Sets the source reference on plot.ly for y . - ytype - If "array", the heatmap's y coordinates are - given by "y" (the default behavior when `y` is - provided) If "scaled", the heatmap's y - coordinates are given by "y0" and "dy" (the - default behavior when `y` is not provided) - z - Sets the z data. - zauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `z`) or the bounds set in `zmin` and `zmax` - Defaults to `false` when `zmin` and `zmax` are - set by the user. - zhoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. See: https://github - .com/d3/d3-format/blob/master/README.md#locale_ - format - zmax - Sets the upper bound of the color domain. Value - should have the same units as in `z` and if - set, `zmin` must be set as well. - zmid - Sets the mid-point of the color domain by - scaling `zmin` and/or `zmax` to be equidistant - to this point. Value should have the same units - as in `z`. Has no effect when `zauto` is - `false`. - zmin - Sets the lower bound of the color domain. Value - should have the same units as in `z` and if - set, `zmax` must be set as well. - zsrc - Sets the source reference on plot.ly for z . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_contourcarpet.py b/plotly/validators/_contourcarpet.py deleted file mode 100644 index 3db27a2454c..00000000000 --- a/plotly/validators/_contourcarpet.py +++ /dev/null @@ -1,242 +0,0 @@ -import _plotly_utils.basevalidators - - -class ContourcarpetValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='contourcarpet', parent_name='', **kwargs): - super(ContourcarpetValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Contourcarpet'), - data_docs=kwargs.pop( - 'data_docs', """ - a - Sets the x coordinates. - a0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the - starting coordinate and `dx` the step. - asrc - Sets the source reference on plot.ly for a . - atype - If "array", the heatmap's x coordinates are - given by "x" (the default behavior when `x` is - provided). If "scaled", the heatmap's x - coordinates are given by "x0" and "dx" (the - default behavior when `x` is not provided). - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `colorscale`. In case - `colorscale` is unspecified or `autocolorscale` - is true, the default palette will be chosen - according to whether numbers in the `color` - array are all positive, all negative or mixed. - autocontour - Determines whether or not the contour level - attributes are picked by an algorithm. If True, - the number of contour levels can be set in - `ncontours`. If False, set the contour level - attributes in `contours`. - b - Sets the y coordinates. - b0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the - starting coordinate and `dy` the step. - bsrc - Sets the source reference on plot.ly for b . - btype - If "array", the heatmap's y coordinates are - given by "y" (the default behavior when `y` is - provided) If "scaled", the heatmap's y - coordinates are given by "y0" and "dy" (the - default behavior when `y` is not provided) - carpet - The `carpet` of the carpet axes on which this - contour trace lies - colorbar - plotly.graph_objs.contourcarpet.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. The colorscale must be an - array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named - color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. - For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and - `zmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Grey - s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, - Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth - ,Electric,Viridis,Cividis. - contours - plotly.graph_objs.contourcarpet.Contours - instance or dict with compatible properties - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - da - Sets the x coordinate step. See `x0` for more - info. - db - Sets the y coordinate step. See `y0` for more - info. - fillcolor - Sets the fill color if `contours.type` is - "constraint". Defaults to a half-transparent - variant of the line color, marker color, or - marker line color, whichever is available. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.contourcarpet.Hoverlabel - instance or dict with compatible properties - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.contourcarpet.Line instance - or dict with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - ncontours - Sets the maximum number of contour levels. The - actual number of contours will be chosen - automatically to be less than or equal to the - value of `ncontours`. Has an effect only if - `autocontour` is True or if `contours.size` is - missing. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, - `zmin` will correspond to the last color in the - array and `zmax` will correspond to the first - color. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - showscale - Determines whether or not a colorbar is - displayed for this trace. - stream - plotly.graph_objs.contourcarpet.Stream instance - or dict with compatible properties - text - Sets the text elements associated with each z - value. - textsrc - Sets the source reference on plot.ly for text - . - transpose - Transposes the z data. - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. - z - Sets the z data. - zauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `z`) or the bounds set in `zmin` and `zmax` - Defaults to `false` when `zmin` and `zmax` are - set by the user. - zmax - Sets the upper bound of the color domain. Value - should have the same units as in `z` and if - set, `zmin` must be set as well. - zmid - Sets the mid-point of the color domain by - scaling `zmin` and/or `zmax` to be equidistant - to this point. Value should have the same units - as in `z`. Has no effect when `zauto` is - `false`. - zmin - Sets the lower bound of the color domain. Value - should have the same units as in `z` and if - set, `zmax` must be set as well. - zsrc - Sets the source reference on plot.ly for z . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_data.py b/plotly/validators/_data.py deleted file mode 100644 index 8965580d131..00000000000 --- a/plotly/validators/_data.py +++ /dev/null @@ -1,51 +0,0 @@ -import _plotly_utils.basevalidators - - -class DataValidator(_plotly_utils.basevalidators.BaseDataValidator): - - def __init__(self, plotly_name='data', parent_name='', **kwargs): - - super(DataValidator, self).__init__( - class_strs_map={ - 'area': 'Area', - 'bar': 'Bar', - 'barpolar': 'Barpolar', - 'box': 'Box', - 'candlestick': 'Candlestick', - 'carpet': 'Carpet', - 'choropleth': 'Choropleth', - 'cone': 'Cone', - 'contour': 'Contour', - 'contourcarpet': 'Contourcarpet', - 'heatmap': 'Heatmap', - 'heatmapgl': 'Heatmapgl', - 'histogram': 'Histogram', - 'histogram2d': 'Histogram2d', - 'histogram2dcontour': 'Histogram2dContour', - 'isosurface': 'Isosurface', - 'mesh3d': 'Mesh3d', - 'ohlc': 'Ohlc', - 'parcats': 'Parcats', - 'parcoords': 'Parcoords', - 'pie': 'Pie', - 'pointcloud': 'Pointcloud', - 'sankey': 'Sankey', - 'scatter': 'Scatter', - 'scatter3d': 'Scatter3d', - 'scattercarpet': 'Scattercarpet', - 'scattergeo': 'Scattergeo', - 'scattergl': 'Scattergl', - 'scattermapbox': 'Scattermapbox', - 'scatterpolar': 'Scatterpolar', - 'scatterpolargl': 'Scatterpolargl', - 'scatterternary': 'Scatterternary', - 'splom': 'Splom', - 'streamtube': 'Streamtube', - 'surface': 'Surface', - 'table': 'Table', - 'violin': 'Violin', - }, - plotly_name=plotly_name, - parent_name=parent_name, - **kwargs - ) diff --git a/plotly/validators/_frames.py b/plotly/validators/_frames.py deleted file mode 100644 index d20358b13e3..00000000000 --- a/plotly/validators/_frames.py +++ /dev/null @@ -1,39 +0,0 @@ -import _plotly_utils.basevalidators - - -class FramesValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__(self, plotly_name='frames', parent_name='', **kwargs): - super(FramesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Frame'), - data_docs=kwargs.pop( - 'data_docs', """ - baseframe - The name of the frame into which this frame's - properties are merged before applying. This is - used to unify properties and avoid needing to - specify the same values for the same properties - in multiple frames. - data - A list of traces this frame modifies. The - format is identical to the normal trace - definition. - group - An identifier that specifies the group to which - the frame belongs, used by animate to select a - subset of frames. - layout - Layout properties which this frame modifies. - The format is identical to the normal layout - definition. - name - A label by which to identify the frame - traces - A list of trace indices that identify the - respective traces in the data attribute -""" - ), - **kwargs - ) diff --git a/plotly/validators/_heatmap.py b/plotly/validators/_heatmap.py deleted file mode 100644 index 76812faf734..00000000000 --- a/plotly/validators/_heatmap.py +++ /dev/null @@ -1,261 +0,0 @@ -import _plotly_utils.basevalidators - - -class HeatmapValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='heatmap', parent_name='', **kwargs): - super(HeatmapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Heatmap'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `colorscale`. In case - `colorscale` is unspecified or `autocolorscale` - is true, the default palette will be chosen - according to whether numbers in the `color` - array are all positive, all negative or mixed. - colorbar - plotly.graph_objs.heatmap.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. The colorscale must be an - array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named - color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. - For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and - `zmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Grey - s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, - Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth - ,Electric,Viridis,Cividis. - connectgaps - Determines whether or not gaps (i.e. {nan} or - missing values) in the `z` data are filled in. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - dx - Sets the x coordinate step. See `x0` for more - info. - dy - Sets the y coordinate step. See `y0` for more - info. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.heatmap.Hoverlabel instance - or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, - `zmin` will correspond to the last color in the - array and `zmax` will correspond to the first - color. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - showscale - Determines whether or not a colorbar is - displayed for this trace. - stream - plotly.graph_objs.heatmap.Stream instance or - dict with compatible properties - text - Sets the text elements associated with each z - value. - textsrc - Sets the source reference on plot.ly for text - . - transpose - Transposes the z data. - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the - starting coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date - data. - xgap - Sets the horizontal gap (in pixels) between - bricks. - xsrc - Sets the source reference on plot.ly for x . - xtype - If "array", the heatmap's x coordinates are - given by "x" (the default behavior when `x` is - provided). If "scaled", the heatmap's x - coordinates are given by "x0" and "dx" (the - default behavior when `x` is not provided). - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the - starting coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date - data. - ygap - Sets the vertical gap (in pixels) between - bricks. - ysrc - Sets the source reference on plot.ly for y . - ytype - If "array", the heatmap's y coordinates are - given by "y" (the default behavior when `y` is - provided) If "scaled", the heatmap's y - coordinates are given by "y0" and "dy" (the - default behavior when `y` is not provided) - z - Sets the z data. - zauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `z`) or the bounds set in `zmin` and `zmax` - Defaults to `false` when `zmin` and `zmax` are - set by the user. - zhoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. See: https://github - .com/d3/d3-format/blob/master/README.md#locale_ - format - zmax - Sets the upper bound of the color domain. Value - should have the same units as in `z` and if - set, `zmin` must be set as well. - zmid - Sets the mid-point of the color domain by - scaling `zmin` and/or `zmax` to be equidistant - to this point. Value should have the same units - as in `z`. Has no effect when `zauto` is - `false`. - zmin - Sets the lower bound of the color domain. Value - should have the same units as in `z` and if - set, `zmax` must be set as well. - zsmooth - Picks a smoothing algorithm use to smooth `z` - data. - zsrc - Sets the source reference on plot.ly for z . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_heatmapgl.py b/plotly/validators/_heatmapgl.py deleted file mode 100644 index 1b88f06b914..00000000000 --- a/plotly/validators/_heatmapgl.py +++ /dev/null @@ -1,210 +0,0 @@ -import _plotly_utils.basevalidators - - -class HeatmapglValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='heatmapgl', parent_name='', **kwargs): - super(HeatmapglValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Heatmapgl'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `colorscale`. In case - `colorscale` is unspecified or `autocolorscale` - is true, the default palette will be chosen - according to whether numbers in the `color` - array are all positive, all negative or mixed. - colorbar - plotly.graph_objs.heatmapgl.ColorBar instance - or dict with compatible properties - colorscale - Sets the colorscale. The colorscale must be an - array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named - color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. - For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and - `zmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Grey - s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, - Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth - ,Electric,Viridis,Cividis. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - dx - Sets the x coordinate step. See `x0` for more - info. - dy - Sets the y coordinate step. See `y0` for more - info. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.heatmapgl.Hoverlabel instance - or dict with compatible properties - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, - `zmin` will correspond to the last color in the - array and `zmax` will correspond to the first - color. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - showscale - Determines whether or not a colorbar is - displayed for this trace. - stream - plotly.graph_objs.heatmapgl.Stream instance or - dict with compatible properties - text - Sets the text elements associated with each z - value. - textsrc - Sets the source reference on plot.ly for text - . - transpose - Transposes the z data. - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the - starting coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - xsrc - Sets the source reference on plot.ly for x . - xtype - If "array", the heatmap's x coordinates are - given by "x" (the default behavior when `x` is - provided). If "scaled", the heatmap's x - coordinates are given by "x0" and "dx" (the - default behavior when `x` is not provided). - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the - starting coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. - ysrc - Sets the source reference on plot.ly for y . - ytype - If "array", the heatmap's y coordinates are - given by "y" (the default behavior when `y` is - provided) If "scaled", the heatmap's y - coordinates are given by "y0" and "dy" (the - default behavior when `y` is not provided) - z - Sets the z data. - zauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `z`) or the bounds set in `zmin` and `zmax` - Defaults to `false` when `zmin` and `zmax` are - set by the user. - zmax - Sets the upper bound of the color domain. Value - should have the same units as in `z` and if - set, `zmin` must be set as well. - zmid - Sets the mid-point of the color domain by - scaling `zmin` and/or `zmax` to be equidistant - to this point. Value should have the same units - as in `z`. Has no effect when `zauto` is - `false`. - zmin - Sets the lower bound of the color domain. Value - should have the same units as in `z` and if - set, `zmax` must be set as well. - zsrc - Sets the source reference on plot.ly for z . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_histogram.py b/plotly/validators/_histogram.py deleted file mode 100644 index 4c3c40dd753..00000000000 --- a/plotly/validators/_histogram.py +++ /dev/null @@ -1,253 +0,0 @@ -import _plotly_utils.basevalidators - - -class HistogramValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='histogram', parent_name='', **kwargs): - super(HistogramValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Histogram'), - data_docs=kwargs.pop( - 'data_docs', """ - alignmentgroup - Set several traces linked to the same position - axis or matching axes to the same - alignmentgroup. This controls whether bars - compute their positional range dependently or - independently. - autobinx - Obsolete: since v1.42 each bin attribute is - auto-determined separately and `autobinx` is - not needed. However, we accept `autobinx: true` - or `false` and will update `xbins` accordingly - before deleting `autobinx` from the trace. - autobiny - Obsolete: since v1.42 each bin attribute is - auto-determined separately and `autobiny` is - not needed. However, we accept `autobiny: true` - or `false` and will update `ybins` accordingly - before deleting `autobiny` from the trace. - cumulative - plotly.graph_objs.histogram.Cumulative instance - or dict with compatible properties - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - error_x - plotly.graph_objs.histogram.ErrorX instance or - dict with compatible properties - error_y - plotly.graph_objs.histogram.ErrorY instance or - dict with compatible properties - histfunc - Specifies the binning function used for this - histogram trace. If "count", the histogram - values are computed by counting the number of - values lying inside each bin. If "sum", "avg", - "min", "max", the histogram values are computed - using the sum, the average, the minimum or the - maximum of the values lying inside each bin - respectively. - histnorm - Specifies the type of normalization used for - this histogram trace. If "", the span of each - bar corresponds to the number of occurrences - (i.e. the number of data points lying inside - the bins). If "percent" / "probability", the - span of each bar corresponds to the percentage - / fraction of occurrences with respect to the - total number of sample points (here, the sum of - all bin HEIGHTS equals 100% / 1). If "density", - the span of each bar corresponds to the number - of occurrences in a bin divided by the size of - the bin interval (here, the sum of all bin - AREAS equals the total number of sample - points). If *probability density*, the area of - each bar corresponds to the probability that an - event will fall into the corresponding bin - (here, the sum of all bin AREAS equals 1). - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.histogram.Hoverlabel instance - or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - variable `binNumber` Anything contained in tag - `` is displayed in the secondary box, - for example "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - marker - plotly.graph_objs.histogram.Marker instance or - dict with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - nbinsx - Specifies the maximum number of desired bins. - This value will be used in an algorithm that - will decide the optimal bin size such that the - histogram best visualizes the distribution of - the data. Ignored if `xbins.size` is provided. - nbinsy - Specifies the maximum number of desired bins. - This value will be used in an algorithm that - will decide the optimal bin size such that the - histogram best visualizes the distribution of - the data. Ignored if `ybins.size` is provided. - offsetgroup - Set several traces linked to the same position - axis or matching axes to the same offsetgroup - where bars of the same position coordinate will - line up. - opacity - Sets the opacity of the trace. - orientation - Sets the orientation of the bars. With "v" - ("h"), the value of the each bar spans along - the vertical (horizontal). - selected - plotly.graph_objs.histogram.Selected instance - or dict with compatible properties - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.histogram.Stream instance or - dict with compatible properties - text - Sets hover text elements associated with each - bar. If a single string, the same string - appears over all bars. If an array of string, - the items are mapped in order to the this - trace's coordinates. - textsrc - Sets the source reference on plot.ly for text - . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - unselected - plotly.graph_objs.histogram.Unselected instance - or dict with compatible properties - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - x - Sets the sample data to be binned on the x - axis. - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - xbins - plotly.graph_objs.histogram.XBins instance or - dict with compatible properties - xcalendar - Sets the calendar system to use with `x` date - data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the sample data to be binned on the y - axis. - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. - ybins - plotly.graph_objs.histogram.YBins instance or - dict with compatible properties - ycalendar - Sets the calendar system to use with `y` date - data. - ysrc - Sets the source reference on plot.ly for y . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_histogram2d.py b/plotly/validators/_histogram2d.py deleted file mode 100644 index f049ce673cb..00000000000 --- a/plotly/validators/_histogram2d.py +++ /dev/null @@ -1,281 +0,0 @@ -import _plotly_utils.basevalidators - - -class Histogram2dValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='histogram2d', parent_name='', **kwargs): - super(Histogram2dValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Histogram2d'), - data_docs=kwargs.pop( - 'data_docs', """ - autobinx - Obsolete: since v1.42 each bin attribute is - auto-determined separately and `autobinx` is - not needed. However, we accept `autobinx: true` - or `false` and will update `xbins` accordingly - before deleting `autobinx` from the trace. - autobiny - Obsolete: since v1.42 each bin attribute is - auto-determined separately and `autobiny` is - not needed. However, we accept `autobiny: true` - or `false` and will update `ybins` accordingly - before deleting `autobiny` from the trace. - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `colorscale`. In case - `colorscale` is unspecified or `autocolorscale` - is true, the default palette will be chosen - according to whether numbers in the `color` - array are all positive, all negative or mixed. - colorbar - plotly.graph_objs.histogram2d.ColorBar instance - or dict with compatible properties - colorscale - Sets the colorscale. The colorscale must be an - array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named - color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. - For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and - `zmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Grey - s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, - Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth - ,Electric,Viridis,Cividis. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - histfunc - Specifies the binning function used for this - histogram trace. If "count", the histogram - values are computed by counting the number of - values lying inside each bin. If "sum", "avg", - "min", "max", the histogram values are computed - using the sum, the average, the minimum or the - maximum of the values lying inside each bin - respectively. - histnorm - Specifies the type of normalization used for - this histogram trace. If "", the span of each - bar corresponds to the number of occurrences - (i.e. the number of data points lying inside - the bins). If "percent" / "probability", the - span of each bar corresponds to the percentage - / fraction of occurrences with respect to the - total number of sample points (here, the sum of - all bin HEIGHTS equals 100% / 1). If "density", - the span of each bar corresponds to the number - of occurrences in a bin divided by the size of - the bin interval (here, the sum of all bin - AREAS equals the total number of sample - points). If *probability density*, the area of - each bar corresponds to the probability that an - event will fall into the corresponding bin - (here, the sum of all bin AREAS equals 1). - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.histogram2d.Hoverlabel - instance or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - variable `z` Anything contained in tag - `` is displayed in the secondary box, - for example "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - marker - plotly.graph_objs.histogram2d.Marker instance - or dict with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - nbinsx - Specifies the maximum number of desired bins. - This value will be used in an algorithm that - will decide the optimal bin size such that the - histogram best visualizes the distribution of - the data. Ignored if `xbins.size` is provided. - nbinsy - Specifies the maximum number of desired bins. - This value will be used in an algorithm that - will decide the optimal bin size such that the - histogram best visualizes the distribution of - the data. Ignored if `ybins.size` is provided. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, - `zmin` will correspond to the last color in the - array and `zmax` will correspond to the first - color. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - showscale - Determines whether or not a colorbar is - displayed for this trace. - stream - plotly.graph_objs.histogram2d.Stream instance - or dict with compatible properties - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - x - Sets the sample data to be binned on the x - axis. - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - xbins - plotly.graph_objs.histogram2d.XBins instance or - dict with compatible properties - xcalendar - Sets the calendar system to use with `x` date - data. - xgap - Sets the horizontal gap (in pixels) between - bricks. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the sample data to be binned on the y - axis. - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. - ybins - plotly.graph_objs.histogram2d.YBins instance or - dict with compatible properties - ycalendar - Sets the calendar system to use with `y` date - data. - ygap - Sets the vertical gap (in pixels) between - bricks. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the aggregation data. - zauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `z`) or the bounds set in `zmin` and `zmax` - Defaults to `false` when `zmin` and `zmax` are - set by the user. - zhoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. See: https://github - .com/d3/d3-format/blob/master/README.md#locale_ - format - zmax - Sets the upper bound of the color domain. Value - should have the same units as in `z` and if - set, `zmin` must be set as well. - zmid - Sets the mid-point of the color domain by - scaling `zmin` and/or `zmax` to be equidistant - to this point. Value should have the same units - as in `z`. Has no effect when `zauto` is - `false`. - zmin - Sets the lower bound of the color domain. Value - should have the same units as in `z` and if - set, `zmax` must be set as well. - zsmooth - Picks a smoothing algorithm use to smooth `z` - data. - zsrc - Sets the source reference on plot.ly for z . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_histogram2dcontour.py b/plotly/validators/_histogram2dcontour.py deleted file mode 100644 index 2fe54eb0e39..00000000000 --- a/plotly/validators/_histogram2dcontour.py +++ /dev/null @@ -1,295 +0,0 @@ -import _plotly_utils.basevalidators - - -class Histogram2dContourValidator( - _plotly_utils.basevalidators.CompoundValidator -): - - def __init__( - self, plotly_name='histogram2dcontour', parent_name='', **kwargs - ): - super(Histogram2dContourValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Histogram2dContour'), - data_docs=kwargs.pop( - 'data_docs', """ - autobinx - Obsolete: since v1.42 each bin attribute is - auto-determined separately and `autobinx` is - not needed. However, we accept `autobinx: true` - or `false` and will update `xbins` accordingly - before deleting `autobinx` from the trace. - autobiny - Obsolete: since v1.42 each bin attribute is - auto-determined separately and `autobiny` is - not needed. However, we accept `autobiny: true` - or `false` and will update `ybins` accordingly - before deleting `autobiny` from the trace. - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `colorscale`. In case - `colorscale` is unspecified or `autocolorscale` - is true, the default palette will be chosen - according to whether numbers in the `color` - array are all positive, all negative or mixed. - autocontour - Determines whether or not the contour level - attributes are picked by an algorithm. If True, - the number of contour levels can be set in - `ncontours`. If False, set the contour level - attributes in `contours`. - colorbar - plotly.graph_objs.histogram2dcontour.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. The colorscale must be an - array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named - color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. - For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`zmin` and - `zmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Grey - s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, - Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth - ,Electric,Viridis,Cividis. - contours - plotly.graph_objs.histogram2dcontour.Contours - instance or dict with compatible properties - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - histfunc - Specifies the binning function used for this - histogram trace. If "count", the histogram - values are computed by counting the number of - values lying inside each bin. If "sum", "avg", - "min", "max", the histogram values are computed - using the sum, the average, the minimum or the - maximum of the values lying inside each bin - respectively. - histnorm - Specifies the type of normalization used for - this histogram trace. If "", the span of each - bar corresponds to the number of occurrences - (i.e. the number of data points lying inside - the bins). If "percent" / "probability", the - span of each bar corresponds to the percentage - / fraction of occurrences with respect to the - total number of sample points (here, the sum of - all bin HEIGHTS equals 100% / 1). If "density", - the span of each bar corresponds to the number - of occurrences in a bin divided by the size of - the bin interval (here, the sum of all bin - AREAS equals the total number of sample - points). If *probability density*, the area of - each bar corresponds to the probability that an - event will fall into the corresponding bin - (here, the sum of all bin AREAS equals 1). - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.histogram2dcontour.Hoverlabel - instance or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - variable `z` Anything contained in tag - `` is displayed in the secondary box, - for example "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.histogram2dcontour.Line - instance or dict with compatible properties - marker - plotly.graph_objs.histogram2dcontour.Marker - instance or dict with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - nbinsx - Specifies the maximum number of desired bins. - This value will be used in an algorithm that - will decide the optimal bin size such that the - histogram best visualizes the distribution of - the data. Ignored if `xbins.size` is provided. - nbinsy - Specifies the maximum number of desired bins. - This value will be used in an algorithm that - will decide the optimal bin size such that the - histogram best visualizes the distribution of - the data. Ignored if `ybins.size` is provided. - ncontours - Sets the maximum number of contour levels. The - actual number of contours will be chosen - automatically to be less than or equal to the - value of `ncontours`. Has an effect only if - `autocontour` is True or if `contours.size` is - missing. - opacity - Sets the opacity of the trace. - reversescale - Reverses the color mapping if true. If true, - `zmin` will correspond to the last color in the - array and `zmax` will correspond to the first - color. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - showscale - Determines whether or not a colorbar is - displayed for this trace. - stream - plotly.graph_objs.histogram2dcontour.Stream - instance or dict with compatible properties - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - x - Sets the sample data to be binned on the x - axis. - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - xbins - plotly.graph_objs.histogram2dcontour.XBins - instance or dict with compatible properties - xcalendar - Sets the calendar system to use with `x` date - data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the sample data to be binned on the y - axis. - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. - ybins - plotly.graph_objs.histogram2dcontour.YBins - instance or dict with compatible properties - ycalendar - Sets the calendar system to use with `y` date - data. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the aggregation data. - zauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `z`) or the bounds set in `zmin` and `zmax` - Defaults to `false` when `zmin` and `zmax` are - set by the user. - zhoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. See: https://github - .com/d3/d3-format/blob/master/README.md#locale_ - format - zmax - Sets the upper bound of the color domain. Value - should have the same units as in `z` and if - set, `zmin` must be set as well. - zmid - Sets the mid-point of the color domain by - scaling `zmin` and/or `zmax` to be equidistant - to this point. Value should have the same units - as in `z`. Has no effect when `zauto` is - `false`. - zmin - Sets the lower bound of the color domain. Value - should have the same units as in `z` and if - set, `zmax` must be set as well. - zsrc - Sets the source reference on plot.ly for z . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_isosurface.py b/plotly/validators/_isosurface.py deleted file mode 100644 index 188e965bea9..00000000000 --- a/plotly/validators/_isosurface.py +++ /dev/null @@ -1,250 +0,0 @@ -import _plotly_utils.basevalidators - - -class IsosurfaceValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='isosurface', parent_name='', **kwargs): - super(IsosurfaceValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Isosurface'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `colorscale`. In case - `colorscale` is unspecified or `autocolorscale` - is true, the default palette will be chosen - according to whether numbers in the `color` - array are all positive, all negative or mixed. - caps - plotly.graph_objs.isosurface.Caps instance or - dict with compatible properties - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - `value`) or the bounds set in `cmin` and `cmax` - Defaults to `false` when `cmin` and `cmax` are - set by the user. - cmax - Sets the upper bound of the color domain. Value - should have the same units as `value` and if - set, `cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `cmin` and/or `cmax` to be equidistant - to this point. Value should have the same units - as `value`. Has no effect when `cauto` is - `false`. - cmin - Sets the lower bound of the color domain. Value - should have the same units as `value` and if - set, `cmax` must be set as well. - colorbar - plotly.graph_objs.isosurface.ColorBar instance - or dict with compatible properties - colorscale - Sets the colorscale. The colorscale must be an - array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named - color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. - For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and - `cmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Grey - s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, - Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth - ,Electric,Viridis,Cividis. - contour - plotly.graph_objs.isosurface.Contour instance - or dict with compatible properties - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - flatshading - Determines whether or not normal smoothing is - applied to the meshes, creating meshes with an - angular, low-poly look via flat reflections. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.isosurface.Hoverlabel - instance or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - isomax - Sets the maximum boundary for iso-surface plot. - isomin - Sets the minimum boundary for iso-surface plot. - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - lighting - plotly.graph_objs.isosurface.Lighting instance - or dict with compatible properties - lightposition - plotly.graph_objs.isosurface.Lightposition - instance or dict with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the surface. Please note - that in the case of using high `opacity` values - for example a value greater than or equal to - 0.5 on two surfaces (and 0.25 with four - surfaces), an overlay of multiple transparent - surfaces may not perfectly be sorted in depth - by the webgl API. This behavior may be improved - in the near future and is subject to change. - reversescale - Reverses the color mapping if true. If true, - `cmin` will correspond to the last color in the - array and `cmax` will correspond to the first - color. - scene - Sets a reference between this trace's 3D - coordinate system and a 3D scene. If "scene" - (the default value), the (x,y,z) coordinates - refer to `layout.scene`. If "scene2", the - (x,y,z) coordinates refer to `layout.scene2`, - and so on. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - showscale - Determines whether or not a colorbar is - displayed for this trace. - slices - plotly.graph_objs.isosurface.Slices instance or - dict with compatible properties - spaceframe - plotly.graph_objs.isosurface.Spaceframe - instance or dict with compatible properties - stream - plotly.graph_objs.isosurface.Stream instance or - dict with compatible properties - surface - plotly.graph_objs.isosurface.Surface instance - or dict with compatible properties - text - Sets the text elements associated with the - vertices. If trace `hoverinfo` contains a - "text" flag and "hovertext" is not set, these - elements will be seen in the hover labels. - textsrc - Sets the source reference on plot.ly for text - . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - value - Sets the 4th dimension (value) of the vertices. - valuesrc - Sets the source reference on plot.ly for value - . - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - x - Sets the X coordinates of the vertices on X - axis. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the Y coordinates of the vertices on Y - axis. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the Z coordinates of the vertices on Z - axis. - zsrc - Sets the source reference on plot.ly for z . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_layout.py b/plotly/validators/_layout.py deleted file mode 100644 index 0d36e0a3be8..00000000000 --- a/plotly/validators/_layout.py +++ /dev/null @@ -1,387 +0,0 @@ -import _plotly_utils.basevalidators - - -class LayoutValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='layout', parent_name='', **kwargs): - super(LayoutValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Layout'), - data_docs=kwargs.pop( - 'data_docs', """ - angularaxis - plotly.graph_objs.layout.AngularAxis instance - or dict with compatible properties - annotations - plotly.graph_objs.layout.Annotation instance or - dict with compatible properties - annotationdefaults - When used in a template (as - layout.template.layout.annotationdefaults), - sets the default property values to use for - elements of layout.annotations - autosize - Determines whether or not a layout width or - height that has been left undefined by the user - is initialized on each relayout. Note that, - regardless of this attribute, an undefined - layout width or height is always initialized on - the first call to plot. - bargap - Sets the gap (in plot fraction) between bars of - adjacent location coordinates. - bargroupgap - Sets the gap (in plot fraction) between bars of - the same location coordinate. - barmode - Determines how bars at the same location - coordinate are displayed on the graph. With - "stack", the bars are stacked on top of one - another With "relative", the bars are stacked - on top of one another, with negative values - below the axis, positive values above With - "group", the bars are plotted next to one - another centered around the shared location. - With "overlay", the bars are plotted over one - another, you might need to an "opacity" to see - multiple bars. - barnorm - Sets the normalization for bar traces on the - graph. With "fraction", the value of each bar - is divided by the sum of all values at that - location coordinate. "percent" is the same but - multiplied by 100 to show percentages. - boxgap - Sets the gap (in plot fraction) between boxes - of adjacent location coordinates. Has no effect - on traces that have "width" set. - boxgroupgap - Sets the gap (in plot fraction) between boxes - of the same location coordinate. Has no effect - on traces that have "width" set. - boxmode - Determines how boxes at the same location - coordinate are displayed on the graph. If - "group", the boxes are plotted next to one - another centered around the shared location. If - "overlay", the boxes are plotted over one - another, you might need to set "opacity" to see - them multiple boxes. Has no effect on traces - that have "width" set. - calendar - Sets the default calendar system to use for - interpreting and displaying dates throughout - the plot. - clickmode - Determines the mode of single click - interactions. "event" is the default value and - emits the `plotly_click` event. In addition - this mode emits the `plotly_selected` event in - drag modes "lasso" and "select", but with no - event data attached (kept for compatibility - reasons). The "select" flag enables selecting - single data points via click. This mode also - supports persistent selections, meaning that - pressing Shift while clicking, adds to / - subtracts from an existing selection. "select" - with `hovermode`: "x" can be confusing, - consider explicitly setting `hovermode`: - "closest" when using this feature. Selection - events are sent accordingly as long as "event" - flag is set as well. When the "event" flag is - missing, `plotly_click` and `plotly_selected` - events are not fired. - colorscale - plotly.graph_objs.layout.Colorscale instance or - dict with compatible properties - colorway - Sets the default trace colors. - datarevision - If provided, a changed value tells - `Plotly.react` that one or more data arrays has - changed. This way you can modify arrays in- - place rather than making a complete new copy - for an incremental change. If NOT provided, - `Plotly.react` assumes that data arrays are - being treated as immutable, thus any data array - with a different identity from its predecessor - contains new data. - direction - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the direction - corresponding to positive angles in legacy - polar charts. - dragmode - Determines the mode of drag interactions. - "select" and "lasso" apply only to scatter - traces with markers or text. "orbit" and - "turntable" apply only to 3D scenes. - editrevision - Controls persistence of user-driven changes in - `editable: true` configuration, other than - trace names and axis titles. Defaults to - `layout.uirevision`. - extendpiecolors - If `true`, the pie slice colors (whether given - by `piecolorway` or inherited from `colorway`) - will be extended to three times its original - length by first repeating every color 20% - lighter then each color 20% darker. This is - intended to reduce the likelihood of reusing - the same color when you have many slices, but - you can set `false` to disable. Colors provided - in the trace, using `marker.colors`, are never - extended. - font - Sets the global font. Note that fonts used in - traces and other layout components inherit from - the global font. - geo - plotly.graph_objs.layout.Geo instance or dict - with compatible properties - grid - plotly.graph_objs.layout.Grid instance or dict - with compatible properties - height - Sets the plot's height (in px). - hiddenlabels - - hiddenlabelssrc - Sets the source reference on plot.ly for - hiddenlabels . - hidesources - Determines whether or not a text link citing - the data source is placed at the bottom-right - cored of the figure. Has only an effect only on - graphs that have been generated via forked - graphs from the plotly service (at - https://plot.ly or on-premise). - hoverdistance - Sets the default distance (in pixels) to look - for data to add hover labels (-1 means no - cutoff, 0 means no looking for data). This is - only a real distance for hovering on point-like - objects, like scatter points. For area-like - objects (bars, scatter fills, etc) hovering is - on inside the area and off outside, but these - objects will not supersede hover on point-like - objects in case of conflict. - hoverlabel - plotly.graph_objs.layout.Hoverlabel instance or - dict with compatible properties - hovermode - Determines the mode of hover interactions. If - `clickmode` includes the "select" flag, - `hovermode` defaults to "closest". If - `clickmode` lacks the "select" flag, it - defaults to "x" or "y" (depending on the - trace's `orientation` value) for plots based on - cartesian coordinates. For anything else the - default value is "closest". - images - plotly.graph_objs.layout.Image instance or dict - with compatible properties - imagedefaults - When used in a template (as - layout.template.layout.imagedefaults), sets the - default property values to use for elements of - layout.images - legend - plotly.graph_objs.layout.Legend instance or - dict with compatible properties - mapbox - plotly.graph_objs.layout.Mapbox instance or - dict with compatible properties - margin - plotly.graph_objs.layout.Margin instance or - dict with compatible properties - meta - Assigns extra meta information that can be used - in various `text` attributes. Attributes such - as the graph, axis and colorbar `title.text`, - annotation `text` `trace.name` in legend items, - `rangeselector`, `updatemenues` and `sliders` - `label` text all support `meta`. One can access - `meta` fields using template strings: - `%{meta[i]}` where `i` is the index of the - `meta` item in question. - metasrc - Sets the source reference on plot.ly for meta - . - modebar - plotly.graph_objs.layout.Modebar instance or - dict with compatible properties - orientation - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Rotates the entire - polar by the given angle in legacy polar - charts. - paper_bgcolor - Sets the color of paper where the graph is - drawn. - piecolorway - Sets the default pie slice colors. Defaults to - the main `colorway` used for trace colors. If - you specify a new list here it can still be - extended with lighter and darker colors, see - `extendpiecolors`. - plot_bgcolor - Sets the color of plotting area in-between x - and y axes. - polar - plotly.graph_objs.layout.Polar instance or dict - with compatible properties - radialaxis - plotly.graph_objs.layout.RadialAxis instance or - dict with compatible properties - scene - plotly.graph_objs.layout.Scene instance or dict - with compatible properties - selectdirection - When "dragmode" is set to "select", this limits - the selection of the drag to horizontal, - vertical or diagonal. "h" only allows - horizontal selection, "v" only vertical, "d" - only diagonal and "any" sets no limit. - selectionrevision - Controls persistence of user-driven changes in - selected points from all traces. - separators - Sets the decimal and thousand separators. For - example, *. * puts a '.' before decimals and a - space between thousands. In English locales, - dflt is ".," but other locales may alter this - default. - shapes - plotly.graph_objs.layout.Shape instance or dict - with compatible properties - shapedefaults - When used in a template (as - layout.template.layout.shapedefaults), sets the - default property values to use for elements of - layout.shapes - showlegend - Determines whether or not a legend is drawn. - Default is `true` if there is a trace to show - and any of these: a) Two or more traces would - by default be shown in the legend. b) One pie - trace is shown in the legend. c) One trace is - explicitly given with `showlegend: true`. - sliders - plotly.graph_objs.layout.Slider instance or - dict with compatible properties - sliderdefaults - When used in a template (as - layout.template.layout.sliderdefaults), sets - the default property values to use for elements - of layout.sliders - spikedistance - Sets the default distance (in pixels) to look - for data to draw spikelines to (-1 means no - cutoff, 0 means no looking for data). As with - hoverdistance, distance does not apply to area- - like objects. In addition, some objects can be - hovered on but will not generate spikelines, - such as scatter fills. - template - Default attributes to be applied to the plot. - This should be a dict with format: `{'layout': - layoutTemplate, 'data': {trace_type: - [traceTemplate, ...], ...}}` where - `layoutTemplate` is a dict matching the - structure of `figure.layout` and - `traceTemplate` is a dict matching the - structure of the trace with type `trace_type` - (e.g. 'scatter'). Alternatively, this may be - specified as an instance of - plotly.graph_objs.layout.Template. Trace - templates are applied cyclically to traces of - each type. Container arrays (eg `annotations`) - have special handling: An object ending in - `defaults` (eg `annotationdefaults`) is applied - to each array item. But if an item has a - `templateitemname` key we look in the template - array for an item with matching `name` and - apply that instead. If no matching `name` is - found we mark the item invisible. Any named - template item not referenced is appended to the - end of the array, so this can be used to add a - watermark annotation or a logo image, for - example. To omit one of these items on the - plot, make an item with matching - `templateitemname` and `visible: false`. - ternary - plotly.graph_objs.layout.Ternary instance or - dict with compatible properties - title - plotly.graph_objs.layout.Title instance or dict - with compatible properties - titlefont - Deprecated: Please use layout.title.font - instead. Sets the title font. Note that the - title's font used to be customized by the now - deprecated `titlefont` attribute. - transition - Sets transition options used during - Plotly.react updates. - uirevision - Used to allow user interactions with the plot - to persist after `Plotly.react` calls that are - unaware of these interactions. If `uirevision` - is omitted, or if it is given and it changed - from the previous `Plotly.react` call, the - exact new figure is used. If `uirevision` is - truthy and did NOT change, any attribute that - has been affected by user interactions and did - not receive a different value in the new figure - will keep the interaction value. - `layout.uirevision` attribute serves as the - default for `uirevision` attributes in various - sub-containers. For finer control you can set - these sub-attributes directly. For example, if - your app separately controls the data on the x - and y axes you might set - `xaxis.uirevision=*time*` and - `yaxis.uirevision=*cost*`. Then if only the y - data is changed, you can update - `yaxis.uirevision=*quantity*` and the y axis - range will reset but the x axis range will - retain any user-driven zoom. - updatemenus - plotly.graph_objs.layout.Updatemenu instance or - dict with compatible properties - updatemenudefaults - When used in a template (as - layout.template.layout.updatemenudefaults), - sets the default property values to use for - elements of layout.updatemenus - violingap - Sets the gap (in plot fraction) between violins - of adjacent location coordinates. Has no effect - on traces that have "width" set. - violingroupgap - Sets the gap (in plot fraction) between violins - of the same location coordinate. Has no effect - on traces that have "width" set. - violinmode - Determines how violins at the same location - coordinate are displayed on the graph. If - "group", the violins are plotted next to one - another centered around the shared location. If - "overlay", the violins are plotted over one - another, you might need to set "opacity" to see - them multiple violins. Has no effect on traces - that have "width" set. - width - Sets the plot's width (in px). - xaxis - plotly.graph_objs.layout.XAxis instance or dict - with compatible properties - yaxis - plotly.graph_objs.layout.YAxis instance or dict - with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/_mesh3d.py b/plotly/validators/_mesh3d.py deleted file mode 100644 index ae7b184d59e..00000000000 --- a/plotly/validators/_mesh3d.py +++ /dev/null @@ -1,329 +0,0 @@ -import _plotly_utils.basevalidators - - -class Mesh3dValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='mesh3d', parent_name='', **kwargs): - super(Mesh3dValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Mesh3d'), - data_docs=kwargs.pop( - 'data_docs', """ - alphahull - Determines how the mesh surface triangles are - derived from the set of vertices (points) - represented by the `x`, `y` and `z` arrays, if - the `i`, `j`, `k` arrays are not supplied. For - general use of `mesh3d` it is preferred that - `i`, `j`, `k` are supplied. If "-1", Delaunay - triangulation is used, which is mainly suitable - if the mesh is a single, more or less layer - surface that is perpendicular to - `delaunayaxis`. In case the `delaunayaxis` - intersects the mesh surface at more than one - point it will result triangles that are very - long in the dimension of `delaunayaxis`. If - ">0", the alpha-shape algorithm is used. In - this case, the positive `alphahull` value - signals the use of the alpha-shape algorithm, - _and_ its value acts as the parameter for the - mesh fitting. If 0, the convex-hull algorithm - is used. It is suitable for convex bodies or if - the intention is to enclose the `x`, `y` and - `z` point set into a convex hull. - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `colorscale`. In case - `colorscale` is unspecified or `autocolorscale` - is true, the default palette will be chosen - according to whether numbers in the `color` - array are all positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - `intensity`) or the bounds set in `cmin` and - `cmax` Defaults to `false` when `cmin` and - `cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Value - should have the same units as `intensity` and - if set, `cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `cmin` and/or `cmax` to be equidistant - to this point. Value should have the same units - as `intensity`. Has no effect when `cauto` is - `false`. - cmin - Sets the lower bound of the color domain. Value - should have the same units as `intensity` and - if set, `cmax` must be set as well. - color - Sets the color of the whole mesh - colorbar - plotly.graph_objs.mesh3d.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. The colorscale must be an - array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named - color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. - For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and - `cmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Grey - s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, - Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth - ,Electric,Viridis,Cividis. - contour - plotly.graph_objs.mesh3d.Contour instance or - dict with compatible properties - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - delaunayaxis - Sets the Delaunay axis, which is the axis that - is perpendicular to the surface of the Delaunay - triangulation. It has an effect if `i`, `j`, - `k` are not provided and `alphahull` is set to - indicate Delaunay triangulation. - facecolor - Sets the color of each face Overrides "color" - and "vertexcolor". - facecolorsrc - Sets the source reference on plot.ly for - facecolor . - flatshading - Determines whether or not normal smoothing is - applied to the meshes, creating meshes with an - angular, low-poly look via flat reflections. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.mesh3d.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - i - A vector of vertex indices, i.e. integer values - between 0 and the length of the vertex vectors, - representing the "first" vertex of a triangle. - For example, `{i[m], j[m], k[m]}` together - represent face m (triangle m) in the mesh, - where `i[m] = n` points to the triplet `{x[n], - y[n], z[n]}` in the vertex arrays. Therefore, - each element in `i` represents a point in - space, which is the first vertex of a triangle. - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - intensity - Sets the vertex intensity values, used for - plotting fields on meshes - intensitysrc - Sets the source reference on plot.ly for - intensity . - isrc - Sets the source reference on plot.ly for i . - j - A vector of vertex indices, i.e. integer values - between 0 and the length of the vertex vectors, - representing the "second" vertex of a triangle. - For example, `{i[m], j[m], k[m]}` together - represent face m (triangle m) in the mesh, - where `j[m] = n` points to the triplet `{x[n], - y[n], z[n]}` in the vertex arrays. Therefore, - each element in `j` represents a point in - space, which is the second vertex of a - triangle. - jsrc - Sets the source reference on plot.ly for j . - k - A vector of vertex indices, i.e. integer values - between 0 and the length of the vertex vectors, - representing the "third" vertex of a triangle. - For example, `{i[m], j[m], k[m]}` together - represent face m (triangle m) in the mesh, - where `k[m] = n` points to the triplet `{x[n], - y[n], z[n]}` in the vertex arrays. Therefore, - each element in `k` represents a point in - space, which is the third vertex of a triangle. - ksrc - Sets the source reference on plot.ly for k . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - lighting - plotly.graph_objs.mesh3d.Lighting instance or - dict with compatible properties - lightposition - plotly.graph_objs.mesh3d.Lightposition instance - or dict with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the surface. Please note - that in the case of using high `opacity` values - for example a value greater than or equal to - 0.5 on two surfaces (and 0.25 with four - surfaces), an overlay of multiple transparent - surfaces may not perfectly be sorted in depth - by the webgl API. This behavior may be improved - in the near future and is subject to change. - reversescale - Reverses the color mapping if true. If true, - `cmin` will correspond to the last color in the - array and `cmax` will correspond to the first - color. - scene - Sets a reference between this trace's 3D - coordinate system and a 3D scene. If "scene" - (the default value), the (x,y,z) coordinates - refer to `layout.scene`. If "scene2", the - (x,y,z) coordinates refer to `layout.scene2`, - and so on. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - showscale - Determines whether or not a colorbar is - displayed for this trace. - stream - plotly.graph_objs.mesh3d.Stream instance or - dict with compatible properties - text - Sets the text elements associated with the - vertices. If trace `hoverinfo` contains a - "text" flag and "hovertext" is not set, these - elements will be seen in the hover labels. - textsrc - Sets the source reference on plot.ly for text - . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - vertexcolor - Sets the color of each vertex Overrides - "color". - vertexcolorsrc - Sets the source reference on plot.ly for - vertexcolor . - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - x - Sets the X coordinates of the vertices. The nth - element of vectors `x`, `y` and `z` jointly - represent the X, Y and Z coordinates of the nth - vertex. - xcalendar - Sets the calendar system to use with `x` date - data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the Y coordinates of the vertices. The nth - element of vectors `x`, `y` and `z` jointly - represent the X, Y and Z coordinates of the nth - vertex. - ycalendar - Sets the calendar system to use with `y` date - data. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the Z coordinates of the vertices. The nth - element of vectors `x`, `y` and `z` jointly - represent the X, Y and Z coordinates of the nth - vertex. - zcalendar - Sets the calendar system to use with `z` date - data. - zsrc - Sets the source reference on plot.ly for z . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_ohlc.py b/plotly/validators/_ohlc.py deleted file mode 100644 index 2500956a6a7..00000000000 --- a/plotly/validators/_ohlc.py +++ /dev/null @@ -1,164 +0,0 @@ -import _plotly_utils.basevalidators - - -class OhlcValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='ohlc', parent_name='', **kwargs): - super(OhlcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Ohlc'), - data_docs=kwargs.pop( - 'data_docs', """ - close - Sets the close values. - closesrc - Sets the source reference on plot.ly for close - . - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - decreasing - plotly.graph_objs.ohlc.Decreasing instance or - dict with compatible properties - high - Sets the high values. - highsrc - Sets the source reference on plot.ly for high - . - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.ohlc.Hoverlabel instance or - dict with compatible properties - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - increasing - plotly.graph_objs.ohlc.Increasing instance or - dict with compatible properties - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.ohlc.Line instance or dict - with compatible properties - low - Sets the low values. - lowsrc - Sets the source reference on plot.ly for low . - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - open - Sets the open values. - opensrc - Sets the source reference on plot.ly for open - . - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.ohlc.Stream instance or dict - with compatible properties - text - Sets hover text elements associated with each - sample point. If a single string, the same - string appears over all the data points. If an - array of string, the items are mapped in order - to this trace's sample points. - textsrc - Sets the source reference on plot.ly for text - . - tickwidth - Sets the width of the open/close tick marks - relative to the "x" minimal interval. - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - x - Sets the x coordinates. If absent, linear - coordinate will be generated. - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date - data. - xsrc - Sets the source reference on plot.ly for x . - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. -""" - ), - **kwargs - ) diff --git a/plotly/validators/_parcats.py b/plotly/validators/_parcats.py deleted file mode 100644 index f00e2fc5949..00000000000 --- a/plotly/validators/_parcats.py +++ /dev/null @@ -1,128 +0,0 @@ -import _plotly_utils.basevalidators - - -class ParcatsValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='parcats', parent_name='', **kwargs): - super(ParcatsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Parcats'), - data_docs=kwargs.pop( - 'data_docs', """ - arrangement - Sets the drag interaction mode for categories - and dimensions. If `perpendicular`, the - categories can only move along a line - perpendicular to the paths. If `freeform`, the - categories can freely move on the plane. If - `fixed`, the categories and dimensions are - stationary. - bundlecolors - Sort paths so that like colors are bundled - together within each category. - counts - The number of observations represented by each - state. Defaults to 1 so that each state - represents one observation - countssrc - Sets the source reference on plot.ly for - counts . - dimensions - The dimensions (variables) of the parallel - categories diagram. - dimensiondefaults - When used in a template (as layout.template.dat - a.parcats.dimensiondefaults), sets the default - property values to use for elements of - parcats.dimensions - domain - plotly.graph_objs.parcats.Domain instance or - dict with compatible properties - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoveron - Sets the hover interaction mode for the parcats - diagram. If `category`, hover interaction take - place per category. If `color`, hover - interactions take place per color per category. - If `dimension`, hover interactions take place - across all categories per dimension. - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - variables `count`, `probability`, `category`, - `categorycount`, `colorcount` and - `bandcolorcount`. Anything contained in tag - `` is displayed in the secondary box, - for example "{fullData.name}". - labelfont - Sets the font for the `dimension` labels. - line - plotly.graph_objs.parcats.Line instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - sortpaths - Sets the path sorting algorithm. If `forward`, - sort paths based on dimension categories from - left to right. If `backward`, sort paths based - on dimensions categories from right to left. - stream - plotly.graph_objs.parcats.Stream instance or - dict with compatible properties - tickfont - Sets the font for the `category` labels. - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). -""" - ), - **kwargs - ) diff --git a/plotly/validators/_parcoords.py b/plotly/validators/_parcoords.py deleted file mode 100644 index f526100e9ef..00000000000 --- a/plotly/validators/_parcoords.py +++ /dev/null @@ -1,117 +0,0 @@ -import _plotly_utils.basevalidators - - -class ParcoordsValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='parcoords', parent_name='', **kwargs): - super(ParcoordsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Parcoords'), - data_docs=kwargs.pop( - 'data_docs', """ - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - dimensions - The dimensions (variables) of the parallel - coordinates chart. 2..60 dimensions are - supported. - dimensiondefaults - When used in a template (as layout.template.dat - a.parcoords.dimensiondefaults), sets the - default property values to use for elements of - parcoords.dimensions - domain - plotly.graph_objs.parcoords.Domain instance or - dict with compatible properties - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - labelfont - Sets the font for the `dimension` labels. - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.parcoords.Line instance or - dict with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - rangefont - Sets the font for the `dimension` range values. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.parcoords.Stream instance or - dict with compatible properties - tickfont - Sets the font for the `dimension` tick values. - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). -""" - ), - **kwargs - ) diff --git a/plotly/validators/_pie.py b/plotly/validators/_pie.py deleted file mode 100644 index 9655af4407b..00000000000 --- a/plotly/validators/_pie.py +++ /dev/null @@ -1,228 +0,0 @@ -import _plotly_utils.basevalidators - - -class PieValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='pie', parent_name='', **kwargs): - super(PieValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Pie'), - data_docs=kwargs.pop( - 'data_docs', """ - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - direction - Specifies the direction at which succeeding - sectors follow one another. - dlabel - Sets the label step. See `label0` for more - info. - domain - plotly.graph_objs.pie.Domain instance or dict - with compatible properties - hole - Sets the fraction of the radius to cut out of - the pie. Use this to make a donut chart. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.pie.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - variables `label`, `color`, `value`, `percent` - and `text`. Anything contained in tag `` - is displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Sets hover text elements associated with each - sector. If a single string, the same string - appears for all data points. If an array of - string, the items are mapped in order of this - trace's sectors. To be seen, trace `hoverinfo` - must contain a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - insidetextfont - Sets the font used for `textinfo` lying inside - the pie. - label0 - Alternate to `labels`. Builds a numeric set of - labels. Use with `dlabel` where `label0` is the - starting label and `dlabel` the step. - labels - Sets the sector labels. If `labels` entries are - duplicated, we sum associated `values` or - simply count occurrences if `values` is not - provided. For other array attributes (including - color) we use the first non-empty entry among - all occurrences of the label. - labelssrc - Sets the source reference on plot.ly for - labels . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - marker - plotly.graph_objs.pie.Marker instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - outsidetextfont - Sets the font used for `textinfo` lying outside - the pie. - pull - Sets the fraction of larger radius to pull the - sectors out from the center. This can be a - constant to pull all slices apart from each - other equally or an array to highlight one or - more slices. - pullsrc - Sets the source reference on plot.ly for pull - . - rotation - Instead of the first slice starting at 12 - o'clock, rotate to some other angle. - scalegroup - If there are multiple pies that should be sized - according to their totals, link them by - providing a non-empty group id here shared by - every trace in the same group. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - sort - Determines whether or not the sectors are - reordered from largest to smallest. - stream - plotly.graph_objs.pie.Stream instance or dict - with compatible properties - text - Sets text elements associated with each sector. - If trace `textinfo` contains a "text" flag, - these elements will be seen on the chart. If - trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be - seen in the hover labels. - textfont - Sets the font used for `textinfo`. - textinfo - Determines which trace information appear on - the graph. - textposition - Specifies the location of the `textinfo`. - textpositionsrc - Sets the source reference on plot.ly for - textposition . - textsrc - Sets the source reference on plot.ly for text - . - title - plotly.graph_objs.pie.Title instance or dict - with compatible properties - titlefont - Deprecated: Please use pie.title.font instead. - Sets the font used for `title`. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleposition - Deprecated: Please use pie.title.position - instead. Specifies the location of the `title`. - Note that the title's position used to be set - by the now deprecated `titleposition` - attribute. - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - values - Sets the values of the sectors of this pie - chart. If omitted, we count occurrences of each - label. - valuessrc - Sets the source reference on plot.ly for - values . - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). -""" - ), - **kwargs - ) diff --git a/plotly/validators/_pointcloud.py b/plotly/validators/_pointcloud.py deleted file mode 100644 index 4c2e8905ecd..00000000000 --- a/plotly/validators/_pointcloud.py +++ /dev/null @@ -1,172 +0,0 @@ -import _plotly_utils.basevalidators - - -class PointcloudValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='pointcloud', parent_name='', **kwargs): - super(PointcloudValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Pointcloud'), - data_docs=kwargs.pop( - 'data_docs', """ - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.pointcloud.Hoverlabel - instance or dict with compatible properties - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - indices - A sequential value, 0..n, supply it to avoid - creating this array inside plotting. If - specified, it must be a typed `Int32Array` - array. Its length must be equal to or greater - than the number of points. For the best - performance and memory use, create one large - `indices` typed array that is guaranteed to be - at least as long as the largest number of - points during use, and reuse it on each - `Plotly.restyle()` call. - indicessrc - Sets the source reference on plot.ly for - indices . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - marker - plotly.graph_objs.pointcloud.Marker instance or - dict with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.pointcloud.Stream instance or - dict with compatible properties - text - Sets text elements associated with each (x,y) - pair. If a single string, the same string - appears over all the data points. If an array - of string, the items are mapped in order to the - this trace's (x,y) coordinates. If trace - `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be - seen in the hover labels. - textsrc - Sets the source reference on plot.ly for text - . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - x - Sets the x coordinates. - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - xbounds - Specify `xbounds` in the shape of `[xMin, xMax] - to avoid looping through the `xy` typed array. - Use it in conjunction with `xy` and `ybounds` - for the performance benefits. - xboundssrc - Sets the source reference on plot.ly for - xbounds . - xsrc - Sets the source reference on plot.ly for x . - xy - Faster alternative to specifying `x` and `y` - separately. If supplied, it must be a typed - `Float32Array` array that represents points - such that `xy[i * 2] = x[i]` and `xy[i * 2 + 1] - = y[i]` - xysrc - Sets the source reference on plot.ly for xy . - y - Sets the y coordinates. - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. - ybounds - Specify `ybounds` in the shape of `[yMin, yMax] - to avoid looping through the `xy` typed array. - Use it in conjunction with `xy` and `xbounds` - for the performance benefits. - yboundssrc - Sets the source reference on plot.ly for - ybounds . - ysrc - Sets the source reference on plot.ly for y . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_sankey.py b/plotly/validators/_sankey.py deleted file mode 100644 index be5e34fe678..00000000000 --- a/plotly/validators/_sankey.py +++ /dev/null @@ -1,128 +0,0 @@ -import _plotly_utils.basevalidators - - -class SankeyValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='sankey', parent_name='', **kwargs): - super(SankeyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Sankey'), - data_docs=kwargs.pop( - 'data_docs', """ - arrangement - If value is `snap` (the default), the node - arrangement is assisted by automatic snapping - of elements to preserve space between nodes - specified via `nodepad`. If value is - `perpendicular`, the nodes can only move along - a line perpendicular to the flow. If value is - `freeform`, the nodes can freely move on the - plane. If value is `fixed`, the nodes are - stationary. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - domain - plotly.graph_objs.sankey.Domain instance or - dict with compatible properties - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. Note that this attribute is superseded - by `node.hoverinfo` and `node.hoverinfo` for - nodes and links respectively. - hoverlabel - plotly.graph_objs.sankey.Hoverlabel instance or - dict with compatible properties - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - link - The links of the Sankey plot. - name - Sets the trace name. The trace name appear as - the legend item and on hover. - node - The nodes of the Sankey plot. - opacity - Sets the opacity of the trace. - orientation - Sets the orientation of the Sankey diagram. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.sankey.Stream instance or - dict with compatible properties - textfont - Sets the font for node labels - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - valueformat - Sets the value formatting rule using d3 - formatting mini-language which is similar to - those of Python. See https://github.com/d3/d3-f - ormat/blob/master/README.md#locale_format - valuesuffix - Adds a unit to follow the value in the hover - tooltip. Add a space if a separation is - necessary from the value. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). -""" - ), - **kwargs - ) diff --git a/plotly/validators/_scatter.py b/plotly/validators/_scatter.py deleted file mode 100644 index 009d54a41a8..00000000000 --- a/plotly/validators/_scatter.py +++ /dev/null @@ -1,331 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScatterValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='scatter', parent_name='', **kwargs): - super(ScatterValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scatter'), - data_docs=kwargs.pop( - 'data_docs', """ - cliponaxis - Determines whether or not markers and text - nodes are clipped about the subplot axes. To - show markers and text nodes above axis lines - and tick labels, make sure to set `xaxis.layer` - and `yaxis.layer` to *below traces*. - connectgaps - Determines whether or not gaps (i.e. {nan} or - missing values) in the provided data arrays are - connected. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - dx - Sets the x coordinate step. See `x0` for more - info. - dy - Sets the y coordinate step. See `y0` for more - info. - error_x - plotly.graph_objs.scatter.ErrorX instance or - dict with compatible properties - error_y - plotly.graph_objs.scatter.ErrorY instance or - dict with compatible properties - fill - Sets the area to fill with a solid color. - Defaults to "none" unless this trace is - stacked, then it gets "tonexty" ("tonextx") if - `orientation` is "v" ("h") Use with `fillcolor` - if not "none". "tozerox" and "tozeroy" fill to - x=0 and y=0 respectively. "tonextx" and - "tonexty" fill between the endpoints of this - trace and the endpoints of the trace before it, - connecting those endpoints with straight lines - (to make a stacked area graph); if there is no - trace before it, they behave like "tozerox" and - "tozeroy". "toself" connects the endpoints of - the trace (or each segment of the trace if it - has gaps) into a closed shape. "tonext" fills - the space between two traces if one completely - encloses the other (eg consecutive contour - lines), and behaves like "toself" if there is - no trace before it. "tonext" should not be used - if one trace does not enclose the other. Traces - in a `stackgroup` will only fill to (or be - filled to) other traces in the same group. With - multiple `stackgroup`s or some traces stacked - and some not, if fill-linked traces are not - already consecutive, the later ones will be - pushed down in the drawing order. - fillcolor - Sets the fill color. Defaults to a half- - transparent variant of the line color, marker - color, or marker line color, whichever is - available. - groupnorm - Only relevant when `stackgroup` is used, and - only the first `groupnorm` found in the - `stackgroup` will be used - including if - `visible` is "legendonly" but not if it is - `false`. Sets the normalization for the sum of - this `stackgroup`. With "fraction", the value - of each trace at each location is divided by - the sum of all trace values at that location. - "percent" is the same but multiplied by 100 to - show percentages. If there are multiple - subplots, or multiple `stackgroup`s on one - subplot, each will be normalized within its own - set. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.scatter.Hoverlabel instance - or dict with compatible properties - hoveron - Do the hover effects highlight individual - points (markers or line points) or do they - highlight filled regions? If the fill is - "toself" or "tonext" and there are no markers - or text, then the default is "fills", otherwise - it is "points". - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Sets hover text elements associated with each - (x,y) pair. If a single string, the same string - appears over all the data points. If an array - of string, the items are mapped in order to the - this trace's (x,y) coordinates. To be seen, - trace `hoverinfo` must contain a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.scatter.Line instance or dict - with compatible properties - marker - plotly.graph_objs.scatter.Marker instance or - dict with compatible properties - mode - Determines the drawing mode for this scatter - trace. If the provided `mode` includes "text" - then the `text` elements appear at the - coordinates. Otherwise, the `text` elements - appear on hover. If there are less than 20 - points and the trace is not stacked then the - default is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - orientation - Only relevant when `stackgroup` is used, and - only the first `orientation` found in the - `stackgroup` will be used - including if - `visible` is "legendonly" but not if it is - `false`. Sets the stacking direction. With "v" - ("h"), the y (x) values of subsequent traces - are added. Also affects the default value of - `fill`. - r - r coordinates in scatter traces are - deprecated!Please switch to the "scatterpolar" - trace type.Sets the radial coordinatesfor - legacy polar chart only. - rsrc - Sets the source reference on plot.ly for r . - selected - plotly.graph_objs.scatter.Selected instance or - dict with compatible properties - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stackgaps - Only relevant when `stackgroup` is used, and - only the first `stackgaps` found in the - `stackgroup` will be used - including if - `visible` is "legendonly" but not if it is - `false`. Determines how we handle locations at - which other traces in this group have data but - this one does not. With *infer zero* we insert - a zero at these locations. With "interpolate" - we linearly interpolate between existing - values, and extrapolate a constant beyond the - existing values. - stackgroup - Set several scatter traces (on the same - subplot) to the same stackgroup in order to add - their y values (or their x values if - `orientation` is "h"). If blank or omitted this - trace will not be stacked. Stacking also turns - `fill` on by default, using "tonexty" - ("tonextx") if `orientation` is "h" ("v") and - sets the default `mode` to "lines" irrespective - of point count. You can only stack on a numeric - (linear or log) axis. Traces in a `stackgroup` - will only fill to (or be filled to) other - traces in the same group. With multiple - `stackgroup`s or some traces stacked and some - not, if fill-linked traces are not already - consecutive, the later ones will be pushed down - in the drawing order. - stream - plotly.graph_objs.scatter.Stream instance or - dict with compatible properties - t - t coordinates in scatter traces are - deprecated!Please switch to the "scatterpolar" - trace type.Sets the angular coordinatesfor - legacy polar chart only. - text - Sets text elements associated with each (x,y) - pair. If a single string, the same string - appears over all the data points. If an array - of string, the items are mapped in order to the - this trace's (x,y) coordinates. If trace - `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be - seen in the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with - respects to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for - textposition . - textsrc - Sets the source reference on plot.ly for text - . - tsrc - Sets the source reference on plot.ly for t . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - unselected - plotly.graph_objs.scatter.Unselected instance - or dict with compatible properties - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the - starting coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date - data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the - starting coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date - data. - ysrc - Sets the source reference on plot.ly for y . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_scatter3d.py b/plotly/validators/_scatter3d.py deleted file mode 100644 index 3572e227b31..00000000000 --- a/plotly/validators/_scatter3d.py +++ /dev/null @@ -1,217 +0,0 @@ -import _plotly_utils.basevalidators - - -class Scatter3dValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='scatter3d', parent_name='', **kwargs): - super(Scatter3dValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scatter3d'), - data_docs=kwargs.pop( - 'data_docs', """ - connectgaps - Determines whether or not gaps (i.e. {nan} or - missing values) in the provided data arrays are - connected. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - error_x - plotly.graph_objs.scatter3d.ErrorX instance or - dict with compatible properties - error_y - plotly.graph_objs.scatter3d.ErrorY instance or - dict with compatible properties - error_z - plotly.graph_objs.scatter3d.ErrorZ instance or - dict with compatible properties - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.scatter3d.Hoverlabel instance - or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Sets text elements associated with each (x,y,z) - triplet. If a single string, the same string - appears over all the data points. If an array - of string, the items are mapped in order to the - this trace's (x,y,z) coordinates. To be seen, - trace `hoverinfo` must contain a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.scatter3d.Line instance or - dict with compatible properties - marker - plotly.graph_objs.scatter3d.Marker instance or - dict with compatible properties - mode - Determines the drawing mode for this scatter - trace. If the provided `mode` includes "text" - then the `text` elements appear at the - coordinates. Otherwise, the `text` elements - appear on hover. If there are less than 20 - points and the trace is not stacked then the - default is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - projection - plotly.graph_objs.scatter3d.Projection instance - or dict with compatible properties - scene - Sets a reference between this trace's 3D - coordinate system and a 3D scene. If "scene" - (the default value), the (x,y,z) coordinates - refer to `layout.scene`. If "scene2", the - (x,y,z) coordinates refer to `layout.scene2`, - and so on. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.scatter3d.Stream instance or - dict with compatible properties - surfaceaxis - If "-1", the scatter points are not fill with a - surface If 0, 1, 2, the scatter points are - filled with a Delaunay surface about the x, y, - z respectively. - surfacecolor - Sets the surface fill color. - text - Sets text elements associated with each (x,y,z) - triplet. If a single string, the same string - appears over all the data points. If an array - of string, the items are mapped in order to the - this trace's (x,y,z) coordinates. If trace - `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be - seen in the hover labels. - textfont - plotly.graph_objs.scatter3d.Textfont instance - or dict with compatible properties - textposition - Sets the positions of the `text` elements with - respects to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for - textposition . - textsrc - Sets the source reference on plot.ly for text - . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - x - Sets the x coordinates. - xcalendar - Sets the calendar system to use with `x` date - data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates. - ycalendar - Sets the calendar system to use with `y` date - data. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the z coordinates. - zcalendar - Sets the calendar system to use with `z` date - data. - zsrc - Sets the source reference on plot.ly for z . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_scattercarpet.py b/plotly/validators/_scattercarpet.py deleted file mode 100644 index faf63be17fe..00000000000 --- a/plotly/validators/_scattercarpet.py +++ /dev/null @@ -1,223 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScattercarpetValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='scattercarpet', parent_name='', **kwargs): - super(ScattercarpetValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scattercarpet'), - data_docs=kwargs.pop( - 'data_docs', """ - a - Sets the a-axis coordinates. - asrc - Sets the source reference on plot.ly for a . - b - Sets the b-axis coordinates. - bsrc - Sets the source reference on plot.ly for b . - carpet - An identifier for this carpet, so that - `scattercarpet` and `scattercontour` traces can - specify a carpet plot on which they lie - connectgaps - Determines whether or not gaps (i.e. {nan} or - missing values) in the provided data arrays are - connected. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - fill - Sets the area to fill with a solid color. Use - with `fillcolor` if not "none". scatterternary - has a subset of the options available to - scatter. "toself" connects the endpoints of the - trace (or each segment of the trace if it has - gaps) into a closed shape. "tonext" fills the - space between two traces if one completely - encloses the other (eg consecutive contour - lines), and behaves like "toself" if there is - no trace before it. "tonext" should not be used - if one trace does not enclose the other. - fillcolor - Sets the fill color. Defaults to a half- - transparent variant of the line color, marker - color, or marker line color, whichever is - available. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.scattercarpet.Hoverlabel - instance or dict with compatible properties - hoveron - Do the hover effects highlight individual - points (markers or line points) or do they - highlight filled regions? If the fill is - "toself" or "tonext" and there are no markers - or text, then the default is "fills", otherwise - it is "points". - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Sets hover text elements associated with each - (a,b) point. If a single string, the same - string appears over all the data points. If an - array of strings, the items are mapped in order - to the the data points in (a,b). To be seen, - trace `hoverinfo` must contain a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.scattercarpet.Line instance - or dict with compatible properties - marker - plotly.graph_objs.scattercarpet.Marker instance - or dict with compatible properties - mode - Determines the drawing mode for this scatter - trace. If the provided `mode` includes "text" - then the `text` elements appear at the - coordinates. Otherwise, the `text` elements - appear on hover. If there are less than 20 - points and the trace is not stacked then the - default is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.scattercarpet.Selected - instance or dict with compatible properties - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.scattercarpet.Stream instance - or dict with compatible properties - text - Sets text elements associated with each (a,b) - point. If a single string, the same string - appears over all the data points. If an array - of strings, the items are mapped in order to - the the data points in (a,b). If trace - `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be - seen in the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with - respects to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for - textposition . - textsrc - Sets the source reference on plot.ly for text - . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - unselected - plotly.graph_objs.scattercarpet.Unselected - instance or dict with compatible properties - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. -""" - ), - **kwargs - ) diff --git a/plotly/validators/_scattergeo.py b/plotly/validators/_scattergeo.py deleted file mode 100644 index a62a796bae7..00000000000 --- a/plotly/validators/_scattergeo.py +++ /dev/null @@ -1,217 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScattergeoValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='scattergeo', parent_name='', **kwargs): - super(ScattergeoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scattergeo'), - data_docs=kwargs.pop( - 'data_docs', """ - connectgaps - Determines whether or not gaps (i.e. {nan} or - missing values) in the provided data arrays are - connected. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - fill - Sets the area to fill with a solid color. Use - with `fillcolor` if not "none". "toself" - connects the endpoints of the trace (or each - segment of the trace if it has gaps) into a - closed shape. - fillcolor - Sets the fill color. Defaults to a half- - transparent variant of the line color, marker - color, or marker line color, whichever is - available. - geo - Sets a reference between this trace's - geospatial coordinates and a geographic map. If - "geo" (the default value), the geospatial - coordinates refer to `layout.geo`. If "geo2", - the geospatial coordinates refer to - `layout.geo2`, and so on. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.scattergeo.Hoverlabel - instance or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Sets hover text elements associated with each - (lon,lat) pair or item in `locations`. If a - single string, the same string appears over all - the data points. If an array of string, the - items are mapped in order to the this trace's - (lon,lat) or `locations` coordinates. To be - seen, trace `hoverinfo` must contain a "text" - flag. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - lat - Sets the latitude coordinates (in degrees - North). - latsrc - Sets the source reference on plot.ly for lat . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.scattergeo.Line instance or - dict with compatible properties - locationmode - Determines the set of locations used to match - entries in `locations` to regions on the map. - locations - Sets the coordinates via location IDs or names. - Coordinates correspond to the centroid of each - location given. See `locationmode` for more - info. - locationssrc - Sets the source reference on plot.ly for - locations . - lon - Sets the longitude coordinates (in degrees - East). - lonsrc - Sets the source reference on plot.ly for lon . - marker - plotly.graph_objs.scattergeo.Marker instance or - dict with compatible properties - mode - Determines the drawing mode for this scatter - trace. If the provided `mode` includes "text" - then the `text` elements appear at the - coordinates. Otherwise, the `text` elements - appear on hover. If there are less than 20 - points and the trace is not stacked then the - default is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.scattergeo.Selected instance - or dict with compatible properties - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.scattergeo.Stream instance or - dict with compatible properties - text - Sets text elements associated with each - (lon,lat) pair or item in `locations`. If a - single string, the same string appears over all - the data points. If an array of string, the - items are mapped in order to the this trace's - (lon,lat) or `locations` coordinates. If trace - `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be - seen in the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with - respects to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for - textposition . - textsrc - Sets the source reference on plot.ly for text - . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - unselected - plotly.graph_objs.scattergeo.Unselected - instance or dict with compatible properties - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). -""" - ), - **kwargs - ) diff --git a/plotly/validators/_scattergl.py b/plotly/validators/_scattergl.py deleted file mode 100644 index 1a9eab91c8f..00000000000 --- a/plotly/validators/_scattergl.py +++ /dev/null @@ -1,247 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScatterglValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='scattergl', parent_name='', **kwargs): - super(ScatterglValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scattergl'), - data_docs=kwargs.pop( - 'data_docs', """ - connectgaps - Determines whether or not gaps (i.e. {nan} or - missing values) in the provided data arrays are - connected. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - dx - Sets the x coordinate step. See `x0` for more - info. - dy - Sets the y coordinate step. See `y0` for more - info. - error_x - plotly.graph_objs.scattergl.ErrorX instance or - dict with compatible properties - error_y - plotly.graph_objs.scattergl.ErrorY instance or - dict with compatible properties - fill - Sets the area to fill with a solid color. - Defaults to "none" unless this trace is - stacked, then it gets "tonexty" ("tonextx") if - `orientation` is "v" ("h") Use with `fillcolor` - if not "none". "tozerox" and "tozeroy" fill to - x=0 and y=0 respectively. "tonextx" and - "tonexty" fill between the endpoints of this - trace and the endpoints of the trace before it, - connecting those endpoints with straight lines - (to make a stacked area graph); if there is no - trace before it, they behave like "tozerox" and - "tozeroy". "toself" connects the endpoints of - the trace (or each segment of the trace if it - has gaps) into a closed shape. "tonext" fills - the space between two traces if one completely - encloses the other (eg consecutive contour - lines), and behaves like "toself" if there is - no trace before it. "tonext" should not be used - if one trace does not enclose the other. Traces - in a `stackgroup` will only fill to (or be - filled to) other traces in the same group. With - multiple `stackgroup`s or some traces stacked - and some not, if fill-linked traces are not - already consecutive, the later ones will be - pushed down in the drawing order. - fillcolor - Sets the fill color. Defaults to a half- - transparent variant of the line color, marker - color, or marker line color, whichever is - available. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.scattergl.Hoverlabel instance - or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Sets hover text elements associated with each - (x,y) pair. If a single string, the same string - appears over all the data points. If an array - of string, the items are mapped in order to the - this trace's (x,y) coordinates. To be seen, - trace `hoverinfo` must contain a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.scattergl.Line instance or - dict with compatible properties - marker - plotly.graph_objs.scattergl.Marker instance or - dict with compatible properties - mode - Determines the drawing mode for this scatter - trace. - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.scattergl.Selected instance - or dict with compatible properties - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.scattergl.Stream instance or - dict with compatible properties - text - Sets text elements associated with each (x,y) - pair. If a single string, the same string - appears over all the data points. If an array - of string, the items are mapped in order to the - this trace's (x,y) coordinates. If trace - `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be - seen in the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with - respects to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for - textposition . - textsrc - Sets the source reference on plot.ly for text - . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - unselected - plotly.graph_objs.scattergl.Unselected instance - or dict with compatible properties - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - x - Sets the x coordinates. - x0 - Alternate to `x`. Builds a linear space of x - coordinates. Use with `dx` where `x0` is the - starting coordinate and `dx` the step. - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - xcalendar - Sets the calendar system to use with `x` date - data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates. - y0 - Alternate to `y`. Builds a linear space of y - coordinates. Use with `dy` where `y0` is the - starting coordinate and `dy` the step. - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. - ycalendar - Sets the calendar system to use with `y` date - data. - ysrc - Sets the source reference on plot.ly for y . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_scattermapbox.py b/plotly/validators/_scattermapbox.py deleted file mode 100644 index abd147a4f75..00000000000 --- a/plotly/validators/_scattermapbox.py +++ /dev/null @@ -1,201 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScattermapboxValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='scattermapbox', parent_name='', **kwargs): - super(ScattermapboxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scattermapbox'), - data_docs=kwargs.pop( - 'data_docs', """ - connectgaps - Determines whether or not gaps (i.e. {nan} or - missing values) in the provided data arrays are - connected. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - fill - Sets the area to fill with a solid color. Use - with `fillcolor` if not "none". "toself" - connects the endpoints of the trace (or each - segment of the trace if it has gaps) into a - closed shape. - fillcolor - Sets the fill color. Defaults to a half- - transparent variant of the line color, marker - color, or marker line color, whichever is - available. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.scattermapbox.Hoverlabel - instance or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Sets hover text elements associated with each - (lon,lat) pair If a single string, the same - string appears over all the data points. If an - array of string, the items are mapped in order - to the this trace's (lon,lat) coordinates. To - be seen, trace `hoverinfo` must contain a - "text" flag. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - lat - Sets the latitude coordinates (in degrees - North). - latsrc - Sets the source reference on plot.ly for lat . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.scattermapbox.Line instance - or dict with compatible properties - lon - Sets the longitude coordinates (in degrees - East). - lonsrc - Sets the source reference on plot.ly for lon . - marker - plotly.graph_objs.scattermapbox.Marker instance - or dict with compatible properties - mode - Determines the drawing mode for this scatter - trace. If the provided `mode` includes "text" - then the `text` elements appear at the - coordinates. Otherwise, the `text` elements - appear on hover. - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.scattermapbox.Selected - instance or dict with compatible properties - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.scattermapbox.Stream instance - or dict with compatible properties - subplot - Sets a reference between this trace's data - coordinates and a mapbox subplot. If "mapbox" - (the default value), the data refer to - `layout.mapbox`. If "mapbox2", the data refer - to `layout.mapbox2`, and so on. - text - Sets text elements associated with each - (lon,lat) pair If a single string, the same - string appears over all the data points. If an - array of string, the items are mapped in order - to the this trace's (lon,lat) coordinates. If - trace `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be - seen in the hover labels. - textfont - Sets the icon text font - (color=mapbox.layer.paint.text-color, - size=mapbox.layer.layout.text-size). Has an - effect only when `type` is set to "symbol". - textposition - Sets the positions of the `text` elements with - respects to the (x,y) coordinates. - textsrc - Sets the source reference on plot.ly for text - . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - unselected - plotly.graph_objs.scattermapbox.Unselected - instance or dict with compatible properties - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). -""" - ), - **kwargs - ) diff --git a/plotly/validators/_scatterpolar.py b/plotly/validators/_scatterpolar.py deleted file mode 100644 index d0660bd60bf..00000000000 --- a/plotly/validators/_scatterpolar.py +++ /dev/null @@ -1,238 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScatterpolarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='scatterpolar', parent_name='', **kwargs): - super(ScatterpolarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scatterpolar'), - data_docs=kwargs.pop( - 'data_docs', """ - cliponaxis - Determines whether or not markers and text - nodes are clipped about the subplot axes. To - show markers and text nodes above axis lines - and tick labels, make sure to set `xaxis.layer` - and `yaxis.layer` to *below traces*. - connectgaps - Determines whether or not gaps (i.e. {nan} or - missing values) in the provided data arrays are - connected. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - dr - Sets the r coordinate step. - dtheta - Sets the theta coordinate step. By default, the - `dtheta` step equals the subplot's period - divided by the length of the `r` coordinates. - fill - Sets the area to fill with a solid color. Use - with `fillcolor` if not "none". scatterpolar - has a subset of the options available to - scatter. "toself" connects the endpoints of the - trace (or each segment of the trace if it has - gaps) into a closed shape. "tonext" fills the - space between two traces if one completely - encloses the other (eg consecutive contour - lines), and behaves like "toself" if there is - no trace before it. "tonext" should not be used - if one trace does not enclose the other. - fillcolor - Sets the fill color. Defaults to a half- - transparent variant of the line color, marker - color, or marker line color, whichever is - available. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.scatterpolar.Hoverlabel - instance or dict with compatible properties - hoveron - Do the hover effects highlight individual - points (markers or line points) or do they - highlight filled regions? If the fill is - "toself" or "tonext" and there are no markers - or text, then the default is "fills", otherwise - it is "points". - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Sets hover text elements associated with each - (x,y) pair. If a single string, the same string - appears over all the data points. If an array - of string, the items are mapped in order to the - this trace's (x,y) coordinates. To be seen, - trace `hoverinfo` must contain a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.scatterpolar.Line instance or - dict with compatible properties - marker - plotly.graph_objs.scatterpolar.Marker instance - or dict with compatible properties - mode - Determines the drawing mode for this scatter - trace. If the provided `mode` includes "text" - then the `text` elements appear at the - coordinates. Otherwise, the `text` elements - appear on hover. If there are less than 20 - points and the trace is not stacked then the - default is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - r - Sets the radial coordinates - r0 - Alternate to `r`. Builds a linear space of r - coordinates. Use with `dr` where `r0` is the - starting coordinate and `dr` the step. - rsrc - Sets the source reference on plot.ly for r . - selected - plotly.graph_objs.scatterpolar.Selected - instance or dict with compatible properties - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.scatterpolar.Stream instance - or dict with compatible properties - subplot - Sets a reference between this trace's data - coordinates and a polar subplot. If "polar" - (the default value), the data refer to - `layout.polar`. If "polar2", the data refer to - `layout.polar2`, and so on. - text - Sets text elements associated with each (x,y) - pair. If a single string, the same string - appears over all the data points. If an array - of string, the items are mapped in order to the - this trace's (x,y) coordinates. If trace - `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be - seen in the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with - respects to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for - textposition . - textsrc - Sets the source reference on plot.ly for text - . - theta - Sets the angular coordinates - theta0 - Alternate to `theta`. Builds a linear space of - theta coordinates. Use with `dtheta` where - `theta0` is the starting coordinate and - `dtheta` the step. - thetasrc - Sets the source reference on plot.ly for theta - . - thetaunit - Sets the unit of input "theta" values. Has an - effect only when on "linear" angular axes. - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - unselected - plotly.graph_objs.scatterpolar.Unselected - instance or dict with compatible properties - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). -""" - ), - **kwargs - ) diff --git a/plotly/validators/_scatterpolargl.py b/plotly/validators/_scatterpolargl.py deleted file mode 100644 index 3c6a26e2acd..00000000000 --- a/plotly/validators/_scatterpolargl.py +++ /dev/null @@ -1,239 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScatterpolarglValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='scatterpolargl', parent_name='', **kwargs): - super(ScatterpolarglValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scatterpolargl'), - data_docs=kwargs.pop( - 'data_docs', """ - connectgaps - Determines whether or not gaps (i.e. {nan} or - missing values) in the provided data arrays are - connected. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - dr - Sets the r coordinate step. - dtheta - Sets the theta coordinate step. By default, the - `dtheta` step equals the subplot's period - divided by the length of the `r` coordinates. - fill - Sets the area to fill with a solid color. - Defaults to "none" unless this trace is - stacked, then it gets "tonexty" ("tonextx") if - `orientation` is "v" ("h") Use with `fillcolor` - if not "none". "tozerox" and "tozeroy" fill to - x=0 and y=0 respectively. "tonextx" and - "tonexty" fill between the endpoints of this - trace and the endpoints of the trace before it, - connecting those endpoints with straight lines - (to make a stacked area graph); if there is no - trace before it, they behave like "tozerox" and - "tozeroy". "toself" connects the endpoints of - the trace (or each segment of the trace if it - has gaps) into a closed shape. "tonext" fills - the space between two traces if one completely - encloses the other (eg consecutive contour - lines), and behaves like "toself" if there is - no trace before it. "tonext" should not be used - if one trace does not enclose the other. Traces - in a `stackgroup` will only fill to (or be - filled to) other traces in the same group. With - multiple `stackgroup`s or some traces stacked - and some not, if fill-linked traces are not - already consecutive, the later ones will be - pushed down in the drawing order. - fillcolor - Sets the fill color. Defaults to a half- - transparent variant of the line color, marker - color, or marker line color, whichever is - available. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.scatterpolargl.Hoverlabel - instance or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Sets hover text elements associated with each - (x,y) pair. If a single string, the same string - appears over all the data points. If an array - of string, the items are mapped in order to the - this trace's (x,y) coordinates. To be seen, - trace `hoverinfo` must contain a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.scatterpolargl.Line instance - or dict with compatible properties - marker - plotly.graph_objs.scatterpolargl.Marker - instance or dict with compatible properties - mode - Determines the drawing mode for this scatter - trace. If the provided `mode` includes "text" - then the `text` elements appear at the - coordinates. Otherwise, the `text` elements - appear on hover. If there are less than 20 - points and the trace is not stacked then the - default is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - r - Sets the radial coordinates - r0 - Alternate to `r`. Builds a linear space of r - coordinates. Use with `dr` where `r0` is the - starting coordinate and `dr` the step. - rsrc - Sets the source reference on plot.ly for r . - selected - plotly.graph_objs.scatterpolargl.Selected - instance or dict with compatible properties - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.scatterpolargl.Stream - instance or dict with compatible properties - subplot - Sets a reference between this trace's data - coordinates and a polar subplot. If "polar" - (the default value), the data refer to - `layout.polar`. If "polar2", the data refer to - `layout.polar2`, and so on. - text - Sets text elements associated with each (x,y) - pair. If a single string, the same string - appears over all the data points. If an array - of string, the items are mapped in order to the - this trace's (x,y) coordinates. If trace - `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be - seen in the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with - respects to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for - textposition . - textsrc - Sets the source reference on plot.ly for text - . - theta - Sets the angular coordinates - theta0 - Alternate to `theta`. Builds a linear space of - theta coordinates. Use with `dtheta` where - `theta0` is the starting coordinate and - `dtheta` the step. - thetasrc - Sets the source reference on plot.ly for theta - . - thetaunit - Sets the unit of input "theta" values. Has an - effect only when on "linear" angular axes. - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - unselected - plotly.graph_objs.scatterpolargl.Unselected - instance or dict with compatible properties - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). -""" - ), - **kwargs - ) diff --git a/plotly/validators/_scatterternary.py b/plotly/validators/_scatterternary.py deleted file mode 100644 index 9882f4cac17..00000000000 --- a/plotly/validators/_scatterternary.py +++ /dev/null @@ -1,245 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScatterternaryValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='scatterternary', parent_name='', **kwargs): - super(ScatterternaryValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scatterternary'), - data_docs=kwargs.pop( - 'data_docs', """ - a - Sets the quantity of component `a` in each data - point. If `a`, `b`, and `c` are all provided, - they need not be normalized, only the relative - values matter. If only two arrays are provided - they must be normalized to match - `ternary.sum`. - asrc - Sets the source reference on plot.ly for a . - b - Sets the quantity of component `a` in each data - point. If `a`, `b`, and `c` are all provided, - they need not be normalized, only the relative - values matter. If only two arrays are provided - they must be normalized to match - `ternary.sum`. - bsrc - Sets the source reference on plot.ly for b . - c - Sets the quantity of component `a` in each data - point. If `a`, `b`, and `c` are all provided, - they need not be normalized, only the relative - values matter. If only two arrays are provided - they must be normalized to match - `ternary.sum`. - cliponaxis - Determines whether or not markers and text - nodes are clipped about the subplot axes. To - show markers and text nodes above axis lines - and tick labels, make sure to set `xaxis.layer` - and `yaxis.layer` to *below traces*. - connectgaps - Determines whether or not gaps (i.e. {nan} or - missing values) in the provided data arrays are - connected. - csrc - Sets the source reference on plot.ly for c . - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - fill - Sets the area to fill with a solid color. Use - with `fillcolor` if not "none". scatterternary - has a subset of the options available to - scatter. "toself" connects the endpoints of the - trace (or each segment of the trace if it has - gaps) into a closed shape. "tonext" fills the - space between two traces if one completely - encloses the other (eg consecutive contour - lines), and behaves like "toself" if there is - no trace before it. "tonext" should not be used - if one trace does not enclose the other. - fillcolor - Sets the fill color. Defaults to a half- - transparent variant of the line color, marker - color, or marker line color, whichever is - available. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.scatterternary.Hoverlabel - instance or dict with compatible properties - hoveron - Do the hover effects highlight individual - points (markers or line points) or do they - highlight filled regions? If the fill is - "toself" or "tonext" and there are no markers - or text, then the default is "fills", otherwise - it is "points". - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Sets hover text elements associated with each - (a,b,c) point. If a single string, the same - string appears over all the data points. If an - array of strings, the items are mapped in order - to the the data points in (a,b,c). To be seen, - trace `hoverinfo` must contain a "text" flag. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.scatterternary.Line instance - or dict with compatible properties - marker - plotly.graph_objs.scatterternary.Marker - instance or dict with compatible properties - mode - Determines the drawing mode for this scatter - trace. If the provided `mode` includes "text" - then the `text` elements appear at the - coordinates. Otherwise, the `text` elements - appear on hover. If there are less than 20 - points and the trace is not stacked then the - default is "lines+markers". Otherwise, "lines". - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.scatterternary.Selected - instance or dict with compatible properties - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.scatterternary.Stream - instance or dict with compatible properties - subplot - Sets a reference between this trace's data - coordinates and a ternary subplot. If "ternary" - (the default value), the data refer to - `layout.ternary`. If "ternary2", the data refer - to `layout.ternary2`, and so on. - sum - The number each triplet should sum to, if only - two of `a`, `b`, and `c` are provided. This - overrides `ternary.sum` to normalize this - specific trace, but does not affect the values - displayed on the axes. 0 (or missing) means to - use ternary.sum - text - Sets text elements associated with each (a,b,c) - point. If a single string, the same string - appears over all the data points. If an array - of strings, the items are mapped in order to - the the data points in (a,b,c). If trace - `hoverinfo` contains a "text" flag and - "hovertext" is not set, these elements will be - seen in the hover labels. - textfont - Sets the text font. - textposition - Sets the positions of the `text` elements with - respects to the (x,y) coordinates. - textpositionsrc - Sets the source reference on plot.ly for - textposition . - textsrc - Sets the source reference on plot.ly for text - . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - unselected - plotly.graph_objs.scatterternary.Unselected - instance or dict with compatible properties - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). -""" - ), - **kwargs - ) diff --git a/plotly/validators/_splom.py b/plotly/validators/_splom.py deleted file mode 100644 index 73fa78a6c69..00000000000 --- a/plotly/validators/_splom.py +++ /dev/null @@ -1,180 +0,0 @@ -import _plotly_utils.basevalidators - - -class SplomValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='splom', parent_name='', **kwargs): - super(SplomValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Splom'), - data_docs=kwargs.pop( - 'data_docs', """ - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - diagonal - plotly.graph_objs.splom.Diagonal instance or - dict with compatible properties - dimensions - plotly.graph_objs.splom.Dimension instance or - dict with compatible properties - dimensiondefaults - When used in a template (as - layout.template.data.splom.dimensiondefaults), - sets the default property values to use for - elements of splom.dimensions - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.splom.Hoverlabel instance or - dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - marker - plotly.graph_objs.splom.Marker instance or dict - with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - selected - plotly.graph_objs.splom.Selected instance or - dict with compatible properties - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - showlowerhalf - Determines whether or not subplots on the lower - half from the diagonal are displayed. - showupperhalf - Determines whether or not subplots on the upper - half from the diagonal are displayed. - stream - plotly.graph_objs.splom.Stream instance or dict - with compatible properties - text - Sets text elements associated with each (x,y) - pair to appear on hover. If a single string, - the same string appears over all the data - points. If an array of string, the items are - mapped in order to the this trace's (x,y) - coordinates. - textsrc - Sets the source reference on plot.ly for text - . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - unselected - plotly.graph_objs.splom.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - xaxes - Sets the list of x axes corresponding to - dimensions of this splom trace. By default, a - splom will match the first N xaxes where N is - the number of input dimensions. Note that, in - case where `diagonal.visible` is false and - `showupperhalf` or `showlowerhalf` is false, - this splom trace will generate one less x-axis - and one less y-axis. - yaxes - Sets the list of y axes corresponding to - dimensions of this splom trace. By default, a - splom will match the first N yaxes where N is - the number of input dimensions. Note that, in - case where `diagonal.visible` is false and - `showupperhalf` or `showlowerhalf` is false, - this splom trace will generate one less x-axis - and one less y-axis. -""" - ), - **kwargs - ) diff --git a/plotly/validators/_streamtube.py b/plotly/validators/_streamtube.py deleted file mode 100644 index edff1281823..00000000000 --- a/plotly/validators/_streamtube.py +++ /dev/null @@ -1,239 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamtubeValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='streamtube', parent_name='', **kwargs): - super(StreamtubeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Streamtube'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `colorscale`. In case - `colorscale` is unspecified or `autocolorscale` - is true, the default palette will be chosen - according to whether numbers in the `color` - array are all positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - u/v/w norm) or the bounds set in `cmin` and - `cmax` Defaults to `false` when `cmin` and - `cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Value - should have the same units as u/v/w norm and if - set, `cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `cmin` and/or `cmax` to be equidistant - to this point. Value should have the same units - as u/v/w norm. Has no effect when `cauto` is - `false`. - cmin - Sets the lower bound of the color domain. Value - should have the same units as u/v/w norm and if - set, `cmax` must be set as well. - colorbar - plotly.graph_objs.streamtube.ColorBar instance - or dict with compatible properties - colorscale - Sets the colorscale. The colorscale must be an - array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named - color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. - For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and - `cmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Grey - s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, - Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth - ,Electric,Viridis,Cividis. - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.streamtube.Hoverlabel - instance or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - variables `tubex`, `tubey`, `tubez`, `tubeu`, - `tubev`, `tubew`, `norm` and `divergence`. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Same as `text`. - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - lighting - plotly.graph_objs.streamtube.Lighting instance - or dict with compatible properties - lightposition - plotly.graph_objs.streamtube.Lightposition - instance or dict with compatible properties - maxdisplayed - The maximum number of displayed segments in a - streamtube. - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the surface. Please note - that in the case of using high `opacity` values - for example a value greater than or equal to - 0.5 on two surfaces (and 0.25 with four - surfaces), an overlay of multiple transparent - surfaces may not perfectly be sorted in depth - by the webgl API. This behavior may be improved - in the near future and is subject to change. - reversescale - Reverses the color mapping if true. If true, - `cmin` will correspond to the last color in the - array and `cmax` will correspond to the first - color. - scene - Sets a reference between this trace's 3D - coordinate system and a 3D scene. If "scene" - (the default value), the (x,y,z) coordinates - refer to `layout.scene`. If "scene2", the - (x,y,z) coordinates refer to `layout.scene2`, - and so on. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - showscale - Determines whether or not a colorbar is - displayed for this trace. - sizeref - The scaling factor for the streamtubes. The - default is 1, which avoids two max divergence - tubes from touching at adjacent starting - positions. - starts - plotly.graph_objs.streamtube.Starts instance or - dict with compatible properties - stream - plotly.graph_objs.streamtube.Stream instance or - dict with compatible properties - text - Sets a text element associated with this trace. - If trace `hoverinfo` contains a "text" flag, - this text element will be seen in all hover - labels. Note that streamtube traces do not - support array `text` values. - u - Sets the x components of the vector field. - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - usrc - Sets the source reference on plot.ly for u . - v - Sets the y components of the vector field. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - vsrc - Sets the source reference on plot.ly for v . - w - Sets the z components of the vector field. - wsrc - Sets the source reference on plot.ly for w . - x - Sets the x coordinates of the vector field. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates of the vector field. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the z coordinates of the vector field. - zsrc - Sets the source reference on plot.ly for z . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_surface.py b/plotly/validators/_surface.py deleted file mode 100644 index 95aa70a2de5..00000000000 --- a/plotly/validators/_surface.py +++ /dev/null @@ -1,242 +0,0 @@ -import _plotly_utils.basevalidators - - -class SurfaceValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='surface', parent_name='', **kwargs): - super(SurfaceValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Surface'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `colorscale`. In case - `colorscale` is unspecified or `autocolorscale` - is true, the default palette will be chosen - according to whether numbers in the `color` - array are all positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here z - or surfacecolor) or the bounds set in `cmin` - and `cmax` Defaults to `false` when `cmin` and - `cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Value - should have the same units as z or surfacecolor - and if set, `cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `cmin` and/or `cmax` to be equidistant - to this point. Value should have the same units - as z or surfacecolor. Has no effect when - `cauto` is `false`. - cmin - Sets the lower bound of the color domain. Value - should have the same units as z or surfacecolor - and if set, `cmax` must be set as well. - colorbar - plotly.graph_objs.surface.ColorBar instance or - dict with compatible properties - colorscale - Sets the colorscale. The colorscale must be an - array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named - color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. - For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and - `cmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Grey - s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, - Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth - ,Electric,Viridis,Cividis. - contours - plotly.graph_objs.surface.Contours instance or - dict with compatible properties - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - hidesurface - Determines whether or not a surface is drawn. - For example, set `hidesurface` to False - `contours.x.show` to True and `contours.y.show` - to True to draw a wire frame plot. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.surface.Hoverlabel instance - or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - Anything contained in tag `` is - displayed in the secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - lighting - plotly.graph_objs.surface.Lighting instance or - dict with compatible properties - lightposition - plotly.graph_objs.surface.Lightposition - instance or dict with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the surface. Please note - that in the case of using high `opacity` values - for example a value greater than or equal to - 0.5 on two surfaces (and 0.25 with four - surfaces), an overlay of multiple transparent - surfaces may not perfectly be sorted in depth - by the webgl API. This behavior may be improved - in the near future and is subject to change. - reversescale - Reverses the color mapping if true. If true, - `cmin` will correspond to the last color in the - array and `cmax` will correspond to the first - color. - scene - Sets a reference between this trace's 3D - coordinate system and a 3D scene. If "scene" - (the default value), the (x,y,z) coordinates - refer to `layout.scene`. If "scene2", the - (x,y,z) coordinates refer to `layout.scene2`, - and so on. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - showscale - Determines whether or not a colorbar is - displayed for this trace. - stream - plotly.graph_objs.surface.Stream instance or - dict with compatible properties - surfacecolor - Sets the surface color values, used for setting - a color scale independent of `z`. - surfacecolorsrc - Sets the source reference on plot.ly for - surfacecolor . - text - Sets the text elements associated with each z - value. If trace `hoverinfo` contains a "text" - flag and "hovertext" is not set, these elements - will be seen in the hover labels. - textsrc - Sets the source reference on plot.ly for text - . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - x - Sets the x coordinates. - xcalendar - Sets the calendar system to use with `x` date - data. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y coordinates. - ycalendar - Sets the calendar system to use with `y` date - data. - ysrc - Sets the source reference on plot.ly for y . - z - Sets the z coordinates. - zcalendar - Sets the calendar system to use with `z` date - data. - zsrc - Sets the source reference on plot.ly for z . -""" - ), - **kwargs - ) diff --git a/plotly/validators/_table.py b/plotly/validators/_table.py deleted file mode 100644 index b02de293bd1..00000000000 --- a/plotly/validators/_table.py +++ /dev/null @@ -1,124 +0,0 @@ -import _plotly_utils.basevalidators - - -class TableValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='table', parent_name='', **kwargs): - super(TableValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Table'), - data_docs=kwargs.pop( - 'data_docs', """ - cells - plotly.graph_objs.table.Cells instance or dict - with compatible properties - columnorder - Specifies the rendered order of the data - columns; for example, a value `2` at position - `0` means that column index `0` in the data - will be rendered as the third column, as - columns have an index base of zero. - columnordersrc - Sets the source reference on plot.ly for - columnorder . - columnwidth - The width of columns expressed as a ratio. - Columns fill the available width in proportion - of their specified column widths. - columnwidthsrc - Sets the source reference on plot.ly for - columnwidth . - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - domain - plotly.graph_objs.table.Domain instance or dict - with compatible properties - header - plotly.graph_objs.table.Header instance or dict - with compatible properties - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.table.Hoverlabel instance or - dict with compatible properties - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - name - Sets the trace name. The trace name appear as - the legend item and on hover. - opacity - Sets the opacity of the trace. - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - stream - plotly.graph_objs.table.Stream instance or dict - with compatible properties - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). -""" - ), - **kwargs - ) diff --git a/plotly/validators/_violin.py b/plotly/validators/_violin.py deleted file mode 100644 index 276667a1b45..00000000000 --- a/plotly/validators/_violin.py +++ /dev/null @@ -1,254 +0,0 @@ -import _plotly_utils.basevalidators - - -class ViolinValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='violin', parent_name='', **kwargs): - super(ViolinValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Violin'), - data_docs=kwargs.pop( - 'data_docs', """ - alignmentgroup - Set several traces linked to the same position - axis or matching axes to the same - alignmentgroup. This controls whether bars - compute their positional range dependently or - independently. - bandwidth - Sets the bandwidth used to compute the kernel - density estimate. By default, the bandwidth is - determined by Silverman's rule of thumb. - box - plotly.graph_objs.violin.Box instance or dict - with compatible properties - customdata - Assigns extra data each datum. This may be - useful when listening to hover, click and - selection events. Note that, "scatter" traces - also appends customdata items in the markers - DOM elements - customdatasrc - Sets the source reference on plot.ly for - customdata . - fillcolor - Sets the fill color. Defaults to a half- - transparent variant of the line color, marker - color, or marker line color, whichever is - available. - hoverinfo - Determines which trace information appear on - hover. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverinfosrc - Sets the source reference on plot.ly for - hoverinfo . - hoverlabel - plotly.graph_objs.violin.Hoverlabel instance or - dict with compatible properties - hoveron - Do the hover effects highlight individual - violins or sample points or the kernel density - estimate or any combination of them? - hovertext - Same as `text`. - hovertextsrc - Sets the source reference on plot.ly for - hovertext . - ids - Assigns id labels to each datum. These ids for - object constancy of data points during - animation. Should be an array of strings, not - numbers or any other type. - idssrc - Sets the source reference on plot.ly for ids . - jitter - Sets the amount of jitter in the sample points - drawn. If 0, the sample points align along the - distribution axis. If 1, the sample points are - drawn in a random jitter of width equal to the - width of the violins. - legendgroup - Sets the legend group for this trace. Traces - part of the same legend group hide/show at the - same time when toggling legend items. - line - plotly.graph_objs.violin.Line instance or dict - with compatible properties - marker - plotly.graph_objs.violin.Marker instance or - dict with compatible properties - meanline - plotly.graph_objs.violin.Meanline instance or - dict with compatible properties - name - Sets the trace name. The trace name appear as - the legend item and on hover. For box traces, - the name will also be used for the position - coordinate, if `x` and `x0` (`y` and `y0` if - horizontal) are missing and the position axis - is categorical - offsetgroup - Set several traces linked to the same position - axis or matching axes to the same offsetgroup - where bars of the same position coordinate will - line up. - opacity - Sets the opacity of the trace. - orientation - Sets the orientation of the violin(s). If "v" - ("h"), the distribution is visualized along the - vertical (horizontal). - pointpos - Sets the position of the sample points in - relation to the violins. If 0, the sample - points are places over the center of the - violins. Positive (negative) values correspond - to positions to the right (left) for vertical - violins and above (below) for horizontal - violins. - points - If "outliers", only the sample points lying - outside the whiskers are shown If - "suspectedoutliers", the outlier points are - shown and points either less than 4*Q1-3*Q3 or - greater than 4*Q3-3*Q1 are highlighted (see - `outliercolor`) If "all", all sample points are - shown If False, only the violins are shown with - no sample points - scalegroup - If there are multiple violins that should be - sized according to to some metric (see - `scalemode`), link them by providing a non- - empty group id here shared by every trace in - the same group. - scalemode - Sets the metric by which the width of each - violin is determined."width" means each violin - has the same (max) width*count* means the - violins are scaled by the number of sample - points makingup each violin. - selected - plotly.graph_objs.violin.Selected instance or - dict with compatible properties - selectedpoints - Array containing integer indices of selected - points. Has an effect only for traces that - support selections. Note that an empty array - means an empty selection where the `unselected` - are turned on for all points, whereas, any - other non-array values means no selection all - where the `selected` and `unselected` styles - have no effect. - showlegend - Determines whether or not an item corresponding - to this trace is shown in the legend. - side - Determines on which side of the position value - the density function making up one half of a - violin is plotted. Useful when comparing two - violin traces under "overlay" mode, where one - trace has `side` set to "positive" and the - other to "negative". - span - Sets the span in data space for which the - density function will be computed. Has an - effect only when `spanmode` is set to "manual". - spanmode - Sets the method by which the span in data space - where the density function will be computed. - "soft" means the span goes from the sample's - minimum value minus two bandwidths to the - sample's maximum value plus two bandwidths. - "hard" means the span goes from the sample's - minimum to its maximum value. For custom span - settings, use mode "manual" and fill in the - `span` attribute. - stream - plotly.graph_objs.violin.Stream instance or - dict with compatible properties - text - Sets the text elements associated with each - sample value. If a single string, the same - string appears over all the data points. If an - array of string, the items are mapped in order - to the this trace's (x,y) coordinates. To be - seen, trace `hoverinfo` must contain a "text" - flag. - textsrc - Sets the source reference on plot.ly for text - . - uid - Assign an id to this trace, Use this to provide - object constancy between traces during - animations and transitions. - uirevision - Controls persistence of some user-driven - changes to the trace: `constraintrange` in - `parcoords` traces, as well as some `editable: - true` modifications such as `name` and - `colorbar.title`. Defaults to - `layout.uirevision`. Note that other user- - driven trace attribute changes are controlled - by `layout` attributes: `trace.visible` is - controlled by `layout.legend.uirevision`, - `selectedpoints` is controlled by - `layout.selectionrevision`, and - `colorbar.(x|y)` (accessible with `config: - {editable: true}`) is controlled by - `layout.editrevision`. Trace changes are - tracked by `uid`, which only falls back on - trace index if no `uid` is provided. So if your - app can add/remove traces before the end of the - `data` array, such that the same trace has a - different index, you can still preserve user- - driven changes if you give each trace a `uid` - that stays with it as it moves. - unselected - plotly.graph_objs.violin.Unselected instance or - dict with compatible properties - visible - Determines whether or not this trace is - visible. If "legendonly", the trace is not - drawn, but can appear as a legend item - (provided that the legend itself is visible). - width - Sets the width of the violin in data - coordinates. If 0 (default value) the width is - automatically selected based on the positions - of other violin traces in the same subplot. - x - Sets the x sample data or coordinates. See - overview for more info. - x0 - Sets the x coordinate of the box. See overview - for more info. - xaxis - Sets a reference between this trace's x - coordinates and a 2D cartesian x axis. If "x" - (the default value), the x coordinates refer to - `layout.xaxis`. If "x2", the x coordinates - refer to `layout.xaxis2`, and so on. - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y sample data or coordinates. See - overview for more info. - y0 - Sets the y coordinate of the box. See overview - for more info. - yaxis - Sets a reference between this trace's y - coordinates and a 2D cartesian y axis. If "y" - (the default value), the y coordinates refer to - `layout.yaxis`. If "y2", the y coordinates - refer to `layout.yaxis2`, and so on. - ysrc - Sets the source reference on plot.ly for y . -""" - ), - **kwargs - ) diff --git a/plotly/validators/area/__init__.py b/plotly/validators/area/__init__.py index 40f46aee0d7..54a192010aa 100644 --- a/plotly/validators/area/__init__.py +++ b/plotly/validators/area/__init__.py @@ -1,21 +1,411 @@ -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._tsrc import TsrcValidator -from ._t import TValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._rsrc import RsrcValidator -from ._r import RValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._marker import MarkerValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='area', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='uirevision', parent_name='area', **kwargs): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='area', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='tsrc', parent_name='area', **kwargs): + super(TsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='t', parent_name='area', **kwargs): + super(TValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='area', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='showlegend', parent_name='area', **kwargs): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='area', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='rsrc', parent_name='area', **kwargs): + super(RsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='r', parent_name='area', **kwargs): + super(RValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='opacity', parent_name='area', **kwargs): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='area', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='marker', parent_name='area', **kwargs): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Area traces are deprecated! Please switch to + the "barpolar" trace type. Sets themarkercolor. + It accepts either a specific color or an array + of numbers that are mapped to the colorscale + relative to the max and min values of the array + or relative to `marker.cmin` and `marker.cmax` + if set. + colorsrc + Sets the source reference on plot.ly for color + . + opacity + Area traces are deprecated! Please switch to + the "barpolar" trace type. Sets the marker + opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + size + Area traces are deprecated! Please switch to + the "barpolar" trace type. Sets the marker size + (in px). + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Area traces are deprecated! Please switch to + the "barpolar" trace type. Sets the marker + symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 + is equivalent to appending "-dot" to a symbol + name. Adding 300 is equivalent to appending + "-open-dot" or "dot-open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='area', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='area', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='area', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='hoverlabel', parent_name='area', **kwargs): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='area', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__(self, plotly_name='hoverinfo', parent_name='area', **kwargs): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='area', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='customdata', parent_name='area', **kwargs): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/area/_customdata.py b/plotly/validators/area/_customdata.py deleted file mode 100644 index 8ef7d23d1a5..00000000000 --- a/plotly/validators/area/_customdata.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='customdata', parent_name='area', **kwargs): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/area/_customdatasrc.py b/plotly/validators/area/_customdatasrc.py deleted file mode 100644 index 06aedd9d77b..00000000000 --- a/plotly/validators/area/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='area', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/_hoverinfo.py b/plotly/validators/area/_hoverinfo.py deleted file mode 100644 index 611949972dd..00000000000 --- a/plotly/validators/area/_hoverinfo.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__(self, plotly_name='hoverinfo', parent_name='area', **kwargs): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/_hoverinfosrc.py b/plotly/validators/area/_hoverinfosrc.py deleted file mode 100644 index e5542043c08..00000000000 --- a/plotly/validators/area/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='area', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/_hoverlabel.py b/plotly/validators/area/_hoverlabel.py deleted file mode 100644 index 172f051d453..00000000000 --- a/plotly/validators/area/_hoverlabel.py +++ /dev/null @@ -1,42 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='hoverlabel', parent_name='area', **kwargs): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/area/_ids.py b/plotly/validators/area/_ids.py deleted file mode 100644 index 3cbe83aba81..00000000000 --- a/plotly/validators/area/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='area', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/area/_idssrc.py b/plotly/validators/area/_idssrc.py deleted file mode 100644 index 8472cc86bd8..00000000000 --- a/plotly/validators/area/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='area', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/_legendgroup.py b/plotly/validators/area/_legendgroup.py deleted file mode 100644 index 37999092c5c..00000000000 --- a/plotly/validators/area/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='area', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/_marker.py b/plotly/validators/area/_marker.py deleted file mode 100644 index c7859709354..00000000000 --- a/plotly/validators/area/_marker.py +++ /dev/null @@ -1,52 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='marker', parent_name='area', **kwargs): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Area traces are deprecated! Please switch to - the "barpolar" trace type. Sets themarkercolor. - It accepts either a specific color or an array - of numbers that are mapped to the colorscale - relative to the max and min values of the array - or relative to `marker.cmin` and `marker.cmax` - if set. - colorsrc - Sets the source reference on plot.ly for color - . - opacity - Area traces are deprecated! Please switch to - the "barpolar" trace type. Sets the marker - opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - size - Area traces are deprecated! Please switch to - the "barpolar" trace type. Sets the marker size - (in px). - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Area traces are deprecated! Please switch to - the "barpolar" trace type. Sets the marker - symbol type. Adding 100 is equivalent to - appending "-open" to a symbol name. Adding 200 - is equivalent to appending "-dot" to a symbol - name. Adding 300 is equivalent to appending - "-open-dot" or "dot-open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . -""" - ), - **kwargs - ) diff --git a/plotly/validators/area/_name.py b/plotly/validators/area/_name.py deleted file mode 100644 index e67634857bb..00000000000 --- a/plotly/validators/area/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='area', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/_opacity.py b/plotly/validators/area/_opacity.py deleted file mode 100644 index c3ada0d73c2..00000000000 --- a/plotly/validators/area/_opacity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='opacity', parent_name='area', **kwargs): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/area/_r.py b/plotly/validators/area/_r.py deleted file mode 100644 index d40aa040b25..00000000000 --- a/plotly/validators/area/_r.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class RValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='r', parent_name='area', **kwargs): - super(RValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/area/_rsrc.py b/plotly/validators/area/_rsrc.py deleted file mode 100644 index 82e94d1dedc..00000000000 --- a/plotly/validators/area/_rsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class RsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='rsrc', parent_name='area', **kwargs): - super(RsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/_selectedpoints.py b/plotly/validators/area/_selectedpoints.py deleted file mode 100644 index b39b7d2ca7c..00000000000 --- a/plotly/validators/area/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='area', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/_showlegend.py b/plotly/validators/area/_showlegend.py deleted file mode 100644 index 63fcea51344..00000000000 --- a/plotly/validators/area/_showlegend.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='showlegend', parent_name='area', **kwargs): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/_stream.py b/plotly/validators/area/_stream.py deleted file mode 100644 index a2116015228..00000000000 --- a/plotly/validators/area/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='area', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/area/_t.py b/plotly/validators/area/_t.py deleted file mode 100644 index 11e5181936a..00000000000 --- a/plotly/validators/area/_t.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='t', parent_name='area', **kwargs): - super(TValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/area/_tsrc.py b/plotly/validators/area/_tsrc.py deleted file mode 100644 index 4a8f768f7a2..00000000000 --- a/plotly/validators/area/_tsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='tsrc', parent_name='area', **kwargs): - super(TsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/_uid.py b/plotly/validators/area/_uid.py deleted file mode 100644 index e82f0716ed9..00000000000 --- a/plotly/validators/area/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='area', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/_uirevision.py b/plotly/validators/area/_uirevision.py deleted file mode 100644 index d03724b44ef..00000000000 --- a/plotly/validators/area/_uirevision.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='uirevision', parent_name='area', **kwargs): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/_visible.py b/plotly/validators/area/_visible.py deleted file mode 100644 index fe3cfb451d6..00000000000 --- a/plotly/validators/area/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='area', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/area/hoverlabel/__init__.py b/plotly/validators/area/hoverlabel/__init__.py index 856f769ba33..872356f1ed1 100644 --- a/plotly/validators/area/hoverlabel/__init__.py +++ b/plotly/validators/area/hoverlabel/__init__.py @@ -1,7 +1,170 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='area.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='area.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='area.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='area.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='area.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='area.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='area.hoverlabel', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/area/hoverlabel/_bgcolor.py b/plotly/validators/area/hoverlabel/_bgcolor.py deleted file mode 100644 index 18e2f5bdc15..00000000000 --- a/plotly/validators/area/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='area.hoverlabel', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/area/hoverlabel/_bgcolorsrc.py b/plotly/validators/area/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index fd084d708eb..00000000000 --- a/plotly/validators/area/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='area.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/hoverlabel/_bordercolor.py b/plotly/validators/area/hoverlabel/_bordercolor.py deleted file mode 100644 index f7a27f14a64..00000000000 --- a/plotly/validators/area/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='area.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/area/hoverlabel/_bordercolorsrc.py b/plotly/validators/area/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index ce124809940..00000000000 --- a/plotly/validators/area/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='area.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/hoverlabel/_font.py b/plotly/validators/area/hoverlabel/_font.py deleted file mode 100644 index bb1411279a8..00000000000 --- a/plotly/validators/area/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='area.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/area/hoverlabel/_namelength.py b/plotly/validators/area/hoverlabel/_namelength.py deleted file mode 100644 index 521410e3895..00000000000 --- a/plotly/validators/area/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='area.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/area/hoverlabel/_namelengthsrc.py b/plotly/validators/area/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 7e5c5e058f2..00000000000 --- a/plotly/validators/area/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='area.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/hoverlabel/font/__init__.py b/plotly/validators/area/hoverlabel/font/__init__.py index 1d2c591d1e5..10c2d6cfcb5 100644 --- a/plotly/validators/area/hoverlabel/font/__init__.py +++ b/plotly/validators/area/hoverlabel/font/__init__.py @@ -1,6 +1,123 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='area.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='area.hoverlabel.font', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='area.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='area.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='area.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='area.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/area/hoverlabel/font/_color.py b/plotly/validators/area/hoverlabel/font/_color.py deleted file mode 100644 index 5f81bc58689..00000000000 --- a/plotly/validators/area/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='area.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/area/hoverlabel/font/_colorsrc.py b/plotly/validators/area/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 82a0ce25063..00000000000 --- a/plotly/validators/area/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='area.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/hoverlabel/font/_family.py b/plotly/validators/area/hoverlabel/font/_family.py deleted file mode 100644 index 017a8120f5f..00000000000 --- a/plotly/validators/area/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='area.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/area/hoverlabel/font/_familysrc.py b/plotly/validators/area/hoverlabel/font/_familysrc.py deleted file mode 100644 index addbd9a1e4a..00000000000 --- a/plotly/validators/area/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='area.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/hoverlabel/font/_size.py b/plotly/validators/area/hoverlabel/font/_size.py deleted file mode 100644 index 61ae161a43b..00000000000 --- a/plotly/validators/area/hoverlabel/font/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='area.hoverlabel.font', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/area/hoverlabel/font/_sizesrc.py b/plotly/validators/area/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 0920b96eeca..00000000000 --- a/plotly/validators/area/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='area.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/marker/__init__.py b/plotly/validators/area/marker/__init__.py index 274a546c58a..3fdc6476277 100644 --- a/plotly/validators/area/marker/__init__.py +++ b/plotly/validators/area/marker/__init__.py @@ -1,8 +1,208 @@ -from ._symbolsrc import SymbolsrcValidator -from ._symbol import SymbolValidator -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._opacitysrc import OpacitysrcValidator -from ._opacity import OpacityValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='symbolsrc', parent_name='area.marker', **kwargs + ): + super(SymbolsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='symbol', parent_name='area.marker', **kwargs + ): + super(SymbolValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, + 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', + 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', + 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', + 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', + 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, + 'star-triangle-down-open', 220, 'star-triangle-down-dot', + 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', + 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, + 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, + 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, + 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='sizesrc', parent_name='area.marker', **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='area.marker', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='opacitysrc', parent_name='area.marker', **kwargs + ): + super(OpacitysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='area.marker', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='area.marker', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='area.marker', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/area/marker/_color.py b/plotly/validators/area/marker/_color.py deleted file mode 100644 index 53ecd04a8a8..00000000000 --- a/plotly/validators/area/marker/_color.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='area.marker', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/area/marker/_colorsrc.py b/plotly/validators/area/marker/_colorsrc.py deleted file mode 100644 index 836ade6910c..00000000000 --- a/plotly/validators/area/marker/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='area.marker', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/marker/_opacity.py b/plotly/validators/area/marker/_opacity.py deleted file mode 100644 index d127e53bcaf..00000000000 --- a/plotly/validators/area/marker/_opacity.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='area.marker', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/area/marker/_opacitysrc.py b/plotly/validators/area/marker/_opacitysrc.py deleted file mode 100644 index 8aa9bca9186..00000000000 --- a/plotly/validators/area/marker/_opacitysrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='opacitysrc', parent_name='area.marker', **kwargs - ): - super(OpacitysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/marker/_size.py b/plotly/validators/area/marker/_size.py deleted file mode 100644 index f0328ccf9df..00000000000 --- a/plotly/validators/area/marker/_size.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='area.marker', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/area/marker/_sizesrc.py b/plotly/validators/area/marker/_sizesrc.py deleted file mode 100644 index 08dfcdb86a7..00000000000 --- a/plotly/validators/area/marker/_sizesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='sizesrc', parent_name='area.marker', **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/marker/_symbol.py b/plotly/validators/area/marker/_symbol.py deleted file mode 100644 index 43b9cb0e84e..00000000000 --- a/plotly/validators/area/marker/_symbol.py +++ /dev/null @@ -1,78 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='symbol', parent_name='area.marker', **kwargs - ): - super(SymbolValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, - 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', - 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', - 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', - 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', - 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, - 'star-triangle-down-open', 220, 'star-triangle-down-dot', - 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', - 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, - 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, - 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, - 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' - ] - ), - **kwargs - ) diff --git a/plotly/validators/area/marker/_symbolsrc.py b/plotly/validators/area/marker/_symbolsrc.py deleted file mode 100644 index 6666fef4f71..00000000000 --- a/plotly/validators/area/marker/_symbolsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='symbolsrc', parent_name='area.marker', **kwargs - ): - super(SymbolsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/stream/__init__.py b/plotly/validators/area/stream/__init__.py index 2f4f2047594..3daa433dd4c 100644 --- a/plotly/validators/area/stream/__init__.py +++ b/plotly/validators/area/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='area.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='area.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/area/stream/_maxpoints.py b/plotly/validators/area/stream/_maxpoints.py deleted file mode 100644 index 557a2ed2fc1..00000000000 --- a/plotly/validators/area/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='area.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/area/stream/_token.py b/plotly/validators/area/stream/_token.py deleted file mode 100644 index 612e12462d8..00000000000 --- a/plotly/validators/area/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='area.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/bar/__init__.py b/plotly/validators/bar/__init__.py index 4827fb39b59..4b3ee6a170d 100644 --- a/plotly/validators/bar/__init__.py +++ b/plotly/validators/bar/__init__.py @@ -1,59 +1,1313 @@ -from ._ysrc import YsrcValidator -from ._ycalendar import YcalendarValidator -from ._yaxis import YAxisValidator -from ._y0 import Y0Validator -from ._y import YValidator -from ._xsrc import XsrcValidator -from ._xcalendar import XcalendarValidator -from ._xaxis import XAxisValidator -from ._x0 import X0Validator -from ._x import XValidator -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._unselected import UnselectedValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._tsrc import TsrcValidator -from ._textsrc import TextsrcValidator -from ._textpositionsrc import TextpositionsrcValidator -from ._textposition import TextpositionValidator -from ._textfont import TextfontValidator -from ._text import TextValidator -from ._t import TValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._selected import SelectedValidator -from ._rsrc import RsrcValidator -from ._r import RValidator -from ._outsidetextfont import OutsidetextfontValidator -from ._orientation import OrientationValidator -from ._opacity import OpacityValidator -from ._offsetsrc import OffsetsrcValidator -from ._offsetgroup import OffsetgroupValidator -from ._offset import OffsetValidator -from ._name import NameValidator -from ._marker import MarkerValidator -from ._legendgroup import LegendgroupValidator -from ._insidetextfont import InsidetextfontValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._error_y import ErrorYValidator -from ._error_x import ErrorXValidator -from ._dy import DyValidator -from ._dx import DxValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._constraintext import ConstraintextValidator -from ._cliponaxis import CliponaxisValidator -from ._basesrc import BasesrcValidator -from ._base import BaseValidator -from ._alignmentgroup import AlignmentgroupValidator + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='bar', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='ycalendar', parent_name='bar', **kwargs): + super(YcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='yaxis', parent_name='bar', **kwargs): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Y0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='y0', parent_name='bar', **kwargs): + super(Y0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='bar', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='bar', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='xcalendar', parent_name='bar', **kwargs): + super(XcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='xaxis', parent_name='bar', **kwargs): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class X0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='x0', parent_name='bar', **kwargs): + super(X0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='bar', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='widthsrc', parent_name='bar', **kwargs): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='width', parent_name='bar', **kwargs): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='bar', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='unselected', parent_name='bar', **kwargs): + super(UnselectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Unselected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.bar.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.bar.unselected.Textfont + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='uirevision', parent_name='bar', **kwargs): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='bar', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='tsrc', parent_name='bar', **kwargs): + super(TsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='textsrc', parent_name='bar', **kwargs): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textpositionsrc', parent_name='bar', **kwargs + ): + super(TextpositionsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='textposition', parent_name='bar', **kwargs + ): + super(TextpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['inside', 'outside', 'auto', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='textfont', parent_name='bar', **kwargs): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='bar', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='t', parent_name='bar', **kwargs): + super(TValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='bar', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='showlegend', parent_name='bar', **kwargs): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='bar', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='selected', parent_name='bar', **kwargs): + super(SelectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Selected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.bar.selected.Marker instance + or dict with compatible properties + textfont + plotly.graph_objs.bar.selected.Textfont + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='rsrc', parent_name='bar', **kwargs): + super(RsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='r', parent_name='bar', **kwargs): + super(RValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutsidetextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='outsidetextfont', parent_name='bar', **kwargs + ): + super(OutsidetextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Outsidetextfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OrientationValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='orientation', parent_name='bar', **kwargs): + super(OrientationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['v', 'h']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='opacity', parent_name='bar', **kwargs): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OffsetsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='offsetsrc', parent_name='bar', **kwargs): + super(OffsetsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OffsetgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='offsetgroup', parent_name='bar', **kwargs): + super(OffsetgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OffsetValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='offset', parent_name='bar', **kwargs): + super(OffsetValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='bar', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='marker', parent_name='bar', **kwargs): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.bar.marker.ColorBar instance + or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + line + plotly.graph_objs.bar.marker.Line instance or + dict with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='legendgroup', parent_name='bar', **kwargs): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class InsidetextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='insidetextfont', parent_name='bar', **kwargs + ): + super(InsidetextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Insidetextfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='bar', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='bar', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='bar', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='hovertext', parent_name='bar', **kwargs): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertemplatesrc', parent_name='bar', **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='bar', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='hoverlabel', parent_name='bar', **kwargs): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='bar', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__(self, plotly_name='hoverinfo', parent_name='bar', **kwargs): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ErrorYValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='error_y', parent_name='bar', **kwargs): + super(ErrorYValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ErrorY'), + data_docs=kwargs.pop( + 'data_docs', """ + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ErrorXValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='error_x', parent_name='bar', **kwargs): + super(ErrorXValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ErrorX'), + data_docs=kwargs.pop( + 'data_docs', """ + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DyValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='dy', parent_name='bar', **kwargs): + super(DyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='dx', parent_name='bar', **kwargs): + super(DxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='bar', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='customdata', parent_name='bar', **kwargs): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConstraintextValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='constraintext', parent_name='bar', **kwargs + ): + super(ConstraintextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['inside', 'outside', 'both', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CliponaxisValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='cliponaxis', parent_name='bar', **kwargs): + super(CliponaxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BasesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='basesrc', parent_name='bar', **kwargs): + super(BasesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BaseValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='base', parent_name='bar', **kwargs): + super(BaseValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AlignmentgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='alignmentgroup', parent_name='bar', **kwargs + ): + super(AlignmentgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/bar/_alignmentgroup.py b/plotly/validators/bar/_alignmentgroup.py deleted file mode 100644 index ef2c75a33e8..00000000000 --- a/plotly/validators/bar/_alignmentgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AlignmentgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='alignmentgroup', parent_name='bar', **kwargs - ): - super(AlignmentgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_base.py b/plotly/validators/bar/_base.py deleted file mode 100644 index 03427de3cd7..00000000000 --- a/plotly/validators/bar/_base.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class BaseValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='base', parent_name='bar', **kwargs): - super(BaseValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_basesrc.py b/plotly/validators/bar/_basesrc.py deleted file mode 100644 index 0bac3750906..00000000000 --- a/plotly/validators/bar/_basesrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class BasesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='basesrc', parent_name='bar', **kwargs): - super(BasesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_cliponaxis.py b/plotly/validators/bar/_cliponaxis.py deleted file mode 100644 index d852393015b..00000000000 --- a/plotly/validators/bar/_cliponaxis.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class CliponaxisValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='cliponaxis', parent_name='bar', **kwargs): - super(CliponaxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_constraintext.py b/plotly/validators/bar/_constraintext.py deleted file mode 100644 index 27b85796c54..00000000000 --- a/plotly/validators/bar/_constraintext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConstraintextValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='constraintext', parent_name='bar', **kwargs - ): - super(ConstraintextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['inside', 'outside', 'both', 'none']), - **kwargs - ) diff --git a/plotly/validators/bar/_customdata.py b/plotly/validators/bar/_customdata.py deleted file mode 100644 index 24a2b118b4f..00000000000 --- a/plotly/validators/bar/_customdata.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='customdata', parent_name='bar', **kwargs): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/bar/_customdatasrc.py b/plotly/validators/bar/_customdatasrc.py deleted file mode 100644 index 4730408a72c..00000000000 --- a/plotly/validators/bar/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='bar', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_dx.py b/plotly/validators/bar/_dx.py deleted file mode 100644 index 1a57828c3ce..00000000000 --- a/plotly/validators/bar/_dx.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class DxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='dx', parent_name='bar', **kwargs): - super(DxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_dy.py b/plotly/validators/bar/_dy.py deleted file mode 100644 index 009a9038f36..00000000000 --- a/plotly/validators/bar/_dy.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class DyValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='dy', parent_name='bar', **kwargs): - super(DyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_error_x.py b/plotly/validators/bar/_error_x.py deleted file mode 100644 index f0d29825538..00000000000 --- a/plotly/validators/bar/_error_x.py +++ /dev/null @@ -1,73 +0,0 @@ -import _plotly_utils.basevalidators - - -class ErrorXValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='error_x', parent_name='bar', **kwargs): - super(ErrorXValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ErrorX'), - data_docs=kwargs.pop( - 'data_docs', """ - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - copy_ystyle - - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/_error_y.py b/plotly/validators/bar/_error_y.py deleted file mode 100644 index f718673d1ce..00000000000 --- a/plotly/validators/bar/_error_y.py +++ /dev/null @@ -1,71 +0,0 @@ -import _plotly_utils.basevalidators - - -class ErrorYValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='error_y', parent_name='bar', **kwargs): - super(ErrorYValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ErrorY'), - data_docs=kwargs.pop( - 'data_docs', """ - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/_hoverinfo.py b/plotly/validators/bar/_hoverinfo.py deleted file mode 100644 index f4cb579653f..00000000000 --- a/plotly/validators/bar/_hoverinfo.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__(self, plotly_name='hoverinfo', parent_name='bar', **kwargs): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_hoverinfosrc.py b/plotly/validators/bar/_hoverinfosrc.py deleted file mode 100644 index a51d1cf95b8..00000000000 --- a/plotly/validators/bar/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='bar', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_hoverlabel.py b/plotly/validators/bar/_hoverlabel.py deleted file mode 100644 index b8c70dc74d3..00000000000 --- a/plotly/validators/bar/_hoverlabel.py +++ /dev/null @@ -1,42 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='hoverlabel', parent_name='bar', **kwargs): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/_hovertemplate.py b/plotly/validators/bar/_hovertemplate.py deleted file mode 100644 index 2a01b682ed8..00000000000 --- a/plotly/validators/bar/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='bar', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_hovertemplatesrc.py b/plotly/validators/bar/_hovertemplatesrc.py deleted file mode 100644 index 7f5ea086420..00000000000 --- a/plotly/validators/bar/_hovertemplatesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertemplatesrc', parent_name='bar', **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_hovertext.py b/plotly/validators/bar/_hovertext.py deleted file mode 100644 index 79efca7203b..00000000000 --- a/plotly/validators/bar/_hovertext.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='hovertext', parent_name='bar', **kwargs): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_hovertextsrc.py b/plotly/validators/bar/_hovertextsrc.py deleted file mode 100644 index 1169a9126d7..00000000000 --- a/plotly/validators/bar/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='bar', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_ids.py b/plotly/validators/bar/_ids.py deleted file mode 100644 index 27eaff242a0..00000000000 --- a/plotly/validators/bar/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='bar', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/bar/_idssrc.py b/plotly/validators/bar/_idssrc.py deleted file mode 100644 index ac3e2fc7231..00000000000 --- a/plotly/validators/bar/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='bar', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_insidetextfont.py b/plotly/validators/bar/_insidetextfont.py deleted file mode 100644 index b4e05adf299..00000000000 --- a/plotly/validators/bar/_insidetextfont.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class InsidetextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='insidetextfont', parent_name='bar', **kwargs - ): - super(InsidetextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Insidetextfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/_legendgroup.py b/plotly/validators/bar/_legendgroup.py deleted file mode 100644 index 39bf8869925..00000000000 --- a/plotly/validators/bar/_legendgroup.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='legendgroup', parent_name='bar', **kwargs): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_marker.py b/plotly/validators/bar/_marker.py deleted file mode 100644 index f0ce2b99588..00000000000 --- a/plotly/validators/bar/_marker.py +++ /dev/null @@ -1,101 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='marker', parent_name='bar', **kwargs): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.bar.marker.ColorBar instance - or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - line - plotly.graph_objs.bar.marker.Line instance or - dict with compatible properties - opacity - Sets the opacity of the bars. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/_name.py b/plotly/validators/bar/_name.py deleted file mode 100644 index ad72b14e586..00000000000 --- a/plotly/validators/bar/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='bar', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_offset.py b/plotly/validators/bar/_offset.py deleted file mode 100644 index c8e24da0aa2..00000000000 --- a/plotly/validators/bar/_offset.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class OffsetValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='offset', parent_name='bar', **kwargs): - super(OffsetValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_offsetgroup.py b/plotly/validators/bar/_offsetgroup.py deleted file mode 100644 index ebfe477a1c5..00000000000 --- a/plotly/validators/bar/_offsetgroup.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class OffsetgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='offsetgroup', parent_name='bar', **kwargs): - super(OffsetgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_offsetsrc.py b/plotly/validators/bar/_offsetsrc.py deleted file mode 100644 index f2128cdc34d..00000000000 --- a/plotly/validators/bar/_offsetsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class OffsetsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='offsetsrc', parent_name='bar', **kwargs): - super(OffsetsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_opacity.py b/plotly/validators/bar/_opacity.py deleted file mode 100644 index a372138c41b..00000000000 --- a/plotly/validators/bar/_opacity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='opacity', parent_name='bar', **kwargs): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/_orientation.py b/plotly/validators/bar/_orientation.py deleted file mode 100644 index 224f6b12e17..00000000000 --- a/plotly/validators/bar/_orientation.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class OrientationValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='orientation', parent_name='bar', **kwargs): - super(OrientationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['v', 'h']), - **kwargs - ) diff --git a/plotly/validators/bar/_outsidetextfont.py b/plotly/validators/bar/_outsidetextfont.py deleted file mode 100644 index 4a3674dcd7b..00000000000 --- a/plotly/validators/bar/_outsidetextfont.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutsidetextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='outsidetextfont', parent_name='bar', **kwargs - ): - super(OutsidetextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Outsidetextfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/_r.py b/plotly/validators/bar/_r.py deleted file mode 100644 index 3b83e7be1c7..00000000000 --- a/plotly/validators/bar/_r.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class RValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='r', parent_name='bar', **kwargs): - super(RValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/bar/_rsrc.py b/plotly/validators/bar/_rsrc.py deleted file mode 100644 index 7d5ed2a6df8..00000000000 --- a/plotly/validators/bar/_rsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class RsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='rsrc', parent_name='bar', **kwargs): - super(RsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_selected.py b/plotly/validators/bar/_selected.py deleted file mode 100644 index 806e2a31128..00000000000 --- a/plotly/validators/bar/_selected.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='selected', parent_name='bar', **kwargs): - super(SelectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Selected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.bar.selected.Marker instance - or dict with compatible properties - textfont - plotly.graph_objs.bar.selected.Textfont - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/_selectedpoints.py b/plotly/validators/bar/_selectedpoints.py deleted file mode 100644 index f10ec0fa3b0..00000000000 --- a/plotly/validators/bar/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='bar', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_showlegend.py b/plotly/validators/bar/_showlegend.py deleted file mode 100644 index 636187fd882..00000000000 --- a/plotly/validators/bar/_showlegend.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='showlegend', parent_name='bar', **kwargs): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_stream.py b/plotly/validators/bar/_stream.py deleted file mode 100644 index 52085dc1f09..00000000000 --- a/plotly/validators/bar/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='bar', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/_t.py b/plotly/validators/bar/_t.py deleted file mode 100644 index 4bb9fb004f6..00000000000 --- a/plotly/validators/bar/_t.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='t', parent_name='bar', **kwargs): - super(TValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/bar/_text.py b/plotly/validators/bar/_text.py deleted file mode 100644 index c9ce9ae07b4..00000000000 --- a/plotly/validators/bar/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='bar', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_textfont.py b/plotly/validators/bar/_textfont.py deleted file mode 100644 index 98990221d49..00000000000 --- a/plotly/validators/bar/_textfont.py +++ /dev/null @@ -1,45 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='textfont', parent_name='bar', **kwargs): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/_textposition.py b/plotly/validators/bar/_textposition.py deleted file mode 100644 index a0229f1a8d1..00000000000 --- a/plotly/validators/bar/_textposition.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='textposition', parent_name='bar', **kwargs - ): - super(TextpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['inside', 'outside', 'auto', 'none']), - **kwargs - ) diff --git a/plotly/validators/bar/_textpositionsrc.py b/plotly/validators/bar/_textpositionsrc.py deleted file mode 100644 index 1540380864b..00000000000 --- a/plotly/validators/bar/_textpositionsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textpositionsrc', parent_name='bar', **kwargs - ): - super(TextpositionsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_textsrc.py b/plotly/validators/bar/_textsrc.py deleted file mode 100644 index 1f918f4cff3..00000000000 --- a/plotly/validators/bar/_textsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='textsrc', parent_name='bar', **kwargs): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_tsrc.py b/plotly/validators/bar/_tsrc.py deleted file mode 100644 index 6ea7bfad839..00000000000 --- a/plotly/validators/bar/_tsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='tsrc', parent_name='bar', **kwargs): - super(TsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_uid.py b/plotly/validators/bar/_uid.py deleted file mode 100644 index 82ded05d2a9..00000000000 --- a/plotly/validators/bar/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='bar', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_uirevision.py b/plotly/validators/bar/_uirevision.py deleted file mode 100644 index 473c1e258c9..00000000000 --- a/plotly/validators/bar/_uirevision.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='uirevision', parent_name='bar', **kwargs): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_unselected.py b/plotly/validators/bar/_unselected.py deleted file mode 100644 index 3fbc96dec58..00000000000 --- a/plotly/validators/bar/_unselected.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='unselected', parent_name='bar', **kwargs): - super(UnselectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Unselected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.bar.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.bar.unselected.Textfont - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/_visible.py b/plotly/validators/bar/_visible.py deleted file mode 100644 index b0816afb9fb..00000000000 --- a/plotly/validators/bar/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='bar', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/bar/_width.py b/plotly/validators/bar/_width.py deleted file mode 100644 index 12b4b3bca17..00000000000 --- a/plotly/validators/bar/_width.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='width', parent_name='bar', **kwargs): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_widthsrc.py b/plotly/validators/bar/_widthsrc.py deleted file mode 100644 index e8d05346619..00000000000 --- a/plotly/validators/bar/_widthsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='widthsrc', parent_name='bar', **kwargs): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_x.py b/plotly/validators/bar/_x.py deleted file mode 100644 index 111bbcc7628..00000000000 --- a/plotly/validators/bar/_x.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='bar', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/bar/_x0.py b/plotly/validators/bar/_x0.py deleted file mode 100644 index 7bc64a67623..00000000000 --- a/plotly/validators/bar/_x0.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class X0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='x0', parent_name='bar', **kwargs): - super(X0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_xaxis.py b/plotly/validators/bar/_xaxis.py deleted file mode 100644 index 2bba159f8ff..00000000000 --- a/plotly/validators/bar/_xaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='xaxis', parent_name='bar', **kwargs): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_xcalendar.py b/plotly/validators/bar/_xcalendar.py deleted file mode 100644 index e006b42113d..00000000000 --- a/plotly/validators/bar/_xcalendar.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='xcalendar', parent_name='bar', **kwargs): - super(XcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/bar/_xsrc.py b/plotly/validators/bar/_xsrc.py deleted file mode 100644 index 9ad552d197b..00000000000 --- a/plotly/validators/bar/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='bar', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_y.py b/plotly/validators/bar/_y.py deleted file mode 100644 index a867ef75298..00000000000 --- a/plotly/validators/bar/_y.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='bar', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/bar/_y0.py b/plotly/validators/bar/_y0.py deleted file mode 100644 index 1ec8baf5224..00000000000 --- a/plotly/validators/bar/_y0.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class Y0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='y0', parent_name='bar', **kwargs): - super(Y0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_yaxis.py b/plotly/validators/bar/_yaxis.py deleted file mode 100644 index e6cdf225df3..00000000000 --- a/plotly/validators/bar/_yaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='yaxis', parent_name='bar', **kwargs): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/_ycalendar.py b/plotly/validators/bar/_ycalendar.py deleted file mode 100644 index 2422b6cd750..00000000000 --- a/plotly/validators/bar/_ycalendar.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='ycalendar', parent_name='bar', **kwargs): - super(YcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/bar/_ysrc.py b/plotly/validators/bar/_ysrc.py deleted file mode 100644 index 6bb431cdd64..00000000000 --- a/plotly/validators/bar/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='bar', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_x/__init__.py b/plotly/validators/bar/error_x/__init__.py index c4605e01877..0f62ef9b6c3 100644 --- a/plotly/validators/bar/error_x/__init__.py +++ b/plotly/validators/bar/error_x/__init__.py @@ -1,15 +1,264 @@ -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._valueminus import ValueminusValidator -from ._value import ValueValidator -from ._type import TypeValidator -from ._tracerefminus import TracerefminusValidator -from ._traceref import TracerefValidator -from ._thickness import ThicknessValidator -from ._symmetric import SymmetricValidator -from ._copy_ystyle import CopyYstyleValidator -from ._color import ColorValidator -from ._arraysrc import ArraysrcValidator -from ._arrayminussrc import ArrayminussrcValidator -from ._arrayminus import ArrayminusValidator -from ._array import ArrayValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='bar.error_x', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='bar.error_x', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='valueminus', parent_name='bar.error_x', **kwargs + ): + super(ValueminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='value', parent_name='bar.error_x', **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='bar.error_x', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['percent', 'constant', 'sqrt', 'data'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='tracerefminus', parent_name='bar.error_x', **kwargs + ): + super(TracerefminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='traceref', parent_name='bar.error_x', **kwargs + ): + super(TracerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='thickness', parent_name='bar.error_x', **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='symmetric', parent_name='bar.error_x', **kwargs + ): + super(SymmetricValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CopyYstyleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='copy_ystyle', parent_name='bar.error_x', **kwargs + ): + super(CopyYstyleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='bar.error_x', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='arraysrc', parent_name='bar.error_x', **kwargs + ): + super(ArraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='arrayminussrc', parent_name='bar.error_x', **kwargs + ): + super(ArrayminussrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='arrayminus', parent_name='bar.error_x', **kwargs + ): + super(ArrayminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='array', parent_name='bar.error_x', **kwargs + ): + super(ArrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/bar/error_x/_array.py b/plotly/validators/bar/error_x/_array.py deleted file mode 100644 index 8f9cd8cd914..00000000000 --- a/plotly/validators/bar/error_x/_array.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='array', parent_name='bar.error_x', **kwargs - ): - super(ArrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/bar/error_x/_arrayminus.py b/plotly/validators/bar/error_x/_arrayminus.py deleted file mode 100644 index 22bbc3c25b9..00000000000 --- a/plotly/validators/bar/error_x/_arrayminus.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='arrayminus', parent_name='bar.error_x', **kwargs - ): - super(ArrayminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/bar/error_x/_arrayminussrc.py b/plotly/validators/bar/error_x/_arrayminussrc.py deleted file mode 100644 index 1282d87f651..00000000000 --- a/plotly/validators/bar/error_x/_arrayminussrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='arrayminussrc', parent_name='bar.error_x', **kwargs - ): - super(ArrayminussrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_x/_arraysrc.py b/plotly/validators/bar/error_x/_arraysrc.py deleted file mode 100644 index e6bcd9ec511..00000000000 --- a/plotly/validators/bar/error_x/_arraysrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='arraysrc', parent_name='bar.error_x', **kwargs - ): - super(ArraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_x/_color.py b/plotly/validators/bar/error_x/_color.py deleted file mode 100644 index 675a72bd78c..00000000000 --- a/plotly/validators/bar/error_x/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='bar.error_x', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/error_x/_copy_ystyle.py b/plotly/validators/bar/error_x/_copy_ystyle.py deleted file mode 100644 index 7d778dccaf7..00000000000 --- a/plotly/validators/bar/error_x/_copy_ystyle.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CopyYstyleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='copy_ystyle', parent_name='bar.error_x', **kwargs - ): - super(CopyYstyleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/error_x/_symmetric.py b/plotly/validators/bar/error_x/_symmetric.py deleted file mode 100644 index 2b4efda3576..00000000000 --- a/plotly/validators/bar/error_x/_symmetric.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='symmetric', parent_name='bar.error_x', **kwargs - ): - super(SymmetricValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_x/_thickness.py b/plotly/validators/bar/error_x/_thickness.py deleted file mode 100644 index 11faa86f4a6..00000000000 --- a/plotly/validators/bar/error_x/_thickness.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='thickness', parent_name='bar.error_x', **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/error_x/_traceref.py b/plotly/validators/bar/error_x/_traceref.py deleted file mode 100644 index b7ef0da1919..00000000000 --- a/plotly/validators/bar/error_x/_traceref.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='traceref', parent_name='bar.error_x', **kwargs - ): - super(TracerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_x/_tracerefminus.py b/plotly/validators/bar/error_x/_tracerefminus.py deleted file mode 100644 index 386caddafe6..00000000000 --- a/plotly/validators/bar/error_x/_tracerefminus.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='tracerefminus', parent_name='bar.error_x', **kwargs - ): - super(TracerefminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_x/_type.py b/plotly/validators/bar/error_x/_type.py deleted file mode 100644 index 07aa02875ee..00000000000 --- a/plotly/validators/bar/error_x/_type.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='bar.error_x', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['percent', 'constant', 'sqrt', 'data'] - ), - **kwargs - ) diff --git a/plotly/validators/bar/error_x/_value.py b/plotly/validators/bar/error_x/_value.py deleted file mode 100644 index 7850d040075..00000000000 --- a/plotly/validators/bar/error_x/_value.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='value', parent_name='bar.error_x', **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_x/_valueminus.py b/plotly/validators/bar/error_x/_valueminus.py deleted file mode 100644 index 2df80f5ba9a..00000000000 --- a/plotly/validators/bar/error_x/_valueminus.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='valueminus', parent_name='bar.error_x', **kwargs - ): - super(ValueminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_x/_visible.py b/plotly/validators/bar/error_x/_visible.py deleted file mode 100644 index 44725d80a8e..00000000000 --- a/plotly/validators/bar/error_x/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='bar.error_x', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_x/_width.py b/plotly/validators/bar/error_x/_width.py deleted file mode 100644 index a559a0166a6..00000000000 --- a/plotly/validators/bar/error_x/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='bar.error_x', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/error_y/__init__.py b/plotly/validators/bar/error_y/__init__.py index 2fc70c4058d..c17bef60194 100644 --- a/plotly/validators/bar/error_y/__init__.py +++ b/plotly/validators/bar/error_y/__init__.py @@ -1,14 +1,247 @@ -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._valueminus import ValueminusValidator -from ._value import ValueValidator -from ._type import TypeValidator -from ._tracerefminus import TracerefminusValidator -from ._traceref import TracerefValidator -from ._thickness import ThicknessValidator -from ._symmetric import SymmetricValidator -from ._color import ColorValidator -from ._arraysrc import ArraysrcValidator -from ._arrayminussrc import ArrayminussrcValidator -from ._arrayminus import ArrayminusValidator -from ._array import ArrayValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='bar.error_y', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='bar.error_y', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='valueminus', parent_name='bar.error_y', **kwargs + ): + super(ValueminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='value', parent_name='bar.error_y', **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='bar.error_y', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['percent', 'constant', 'sqrt', 'data'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='tracerefminus', parent_name='bar.error_y', **kwargs + ): + super(TracerefminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='traceref', parent_name='bar.error_y', **kwargs + ): + super(TracerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='thickness', parent_name='bar.error_y', **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='symmetric', parent_name='bar.error_y', **kwargs + ): + super(SymmetricValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='bar.error_y', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='arraysrc', parent_name='bar.error_y', **kwargs + ): + super(ArraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='arrayminussrc', parent_name='bar.error_y', **kwargs + ): + super(ArrayminussrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='arrayminus', parent_name='bar.error_y', **kwargs + ): + super(ArrayminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='array', parent_name='bar.error_y', **kwargs + ): + super(ArrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/bar/error_y/_array.py b/plotly/validators/bar/error_y/_array.py deleted file mode 100644 index a3d714a7cc3..00000000000 --- a/plotly/validators/bar/error_y/_array.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='array', parent_name='bar.error_y', **kwargs - ): - super(ArrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/bar/error_y/_arrayminus.py b/plotly/validators/bar/error_y/_arrayminus.py deleted file mode 100644 index ad450f4f852..00000000000 --- a/plotly/validators/bar/error_y/_arrayminus.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='arrayminus', parent_name='bar.error_y', **kwargs - ): - super(ArrayminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/bar/error_y/_arrayminussrc.py b/plotly/validators/bar/error_y/_arrayminussrc.py deleted file mode 100644 index af708f91e7c..00000000000 --- a/plotly/validators/bar/error_y/_arrayminussrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='arrayminussrc', parent_name='bar.error_y', **kwargs - ): - super(ArrayminussrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_y/_arraysrc.py b/plotly/validators/bar/error_y/_arraysrc.py deleted file mode 100644 index 5c3f0cde97d..00000000000 --- a/plotly/validators/bar/error_y/_arraysrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='arraysrc', parent_name='bar.error_y', **kwargs - ): - super(ArraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_y/_color.py b/plotly/validators/bar/error_y/_color.py deleted file mode 100644 index ece35d6b286..00000000000 --- a/plotly/validators/bar/error_y/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='bar.error_y', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/error_y/_symmetric.py b/plotly/validators/bar/error_y/_symmetric.py deleted file mode 100644 index 167149995b0..00000000000 --- a/plotly/validators/bar/error_y/_symmetric.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='symmetric', parent_name='bar.error_y', **kwargs - ): - super(SymmetricValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_y/_thickness.py b/plotly/validators/bar/error_y/_thickness.py deleted file mode 100644 index c0f2ccd074a..00000000000 --- a/plotly/validators/bar/error_y/_thickness.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='thickness', parent_name='bar.error_y', **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/error_y/_traceref.py b/plotly/validators/bar/error_y/_traceref.py deleted file mode 100644 index a14e849e618..00000000000 --- a/plotly/validators/bar/error_y/_traceref.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='traceref', parent_name='bar.error_y', **kwargs - ): - super(TracerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_y/_tracerefminus.py b/plotly/validators/bar/error_y/_tracerefminus.py deleted file mode 100644 index 713a3ff5655..00000000000 --- a/plotly/validators/bar/error_y/_tracerefminus.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='tracerefminus', parent_name='bar.error_y', **kwargs - ): - super(TracerefminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_y/_type.py b/plotly/validators/bar/error_y/_type.py deleted file mode 100644 index cd463b694e8..00000000000 --- a/plotly/validators/bar/error_y/_type.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='bar.error_y', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['percent', 'constant', 'sqrt', 'data'] - ), - **kwargs - ) diff --git a/plotly/validators/bar/error_y/_value.py b/plotly/validators/bar/error_y/_value.py deleted file mode 100644 index e580f2afc19..00000000000 --- a/plotly/validators/bar/error_y/_value.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='value', parent_name='bar.error_y', **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_y/_valueminus.py b/plotly/validators/bar/error_y/_valueminus.py deleted file mode 100644 index 6e046181755..00000000000 --- a/plotly/validators/bar/error_y/_valueminus.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='valueminus', parent_name='bar.error_y', **kwargs - ): - super(ValueminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_y/_visible.py b/plotly/validators/bar/error_y/_visible.py deleted file mode 100644 index c068f3855e0..00000000000 --- a/plotly/validators/bar/error_y/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='bar.error_y', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/error_y/_width.py b/plotly/validators/bar/error_y/_width.py deleted file mode 100644 index 8054d40430c..00000000000 --- a/plotly/validators/bar/error_y/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='bar.error_y', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/hoverlabel/__init__.py b/plotly/validators/bar/hoverlabel/__init__.py index 856f769ba33..01e1c2c4019 100644 --- a/plotly/validators/bar/hoverlabel/__init__.py +++ b/plotly/validators/bar/hoverlabel/__init__.py @@ -1,7 +1,164 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='bar.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='namelength', parent_name='bar.hoverlabel', **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='bar.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='bar.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='bar.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='bgcolorsrc', parent_name='bar.hoverlabel', **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='bar.hoverlabel', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/bar/hoverlabel/_bgcolor.py b/plotly/validators/bar/hoverlabel/_bgcolor.py deleted file mode 100644 index d8a4760e13b..00000000000 --- a/plotly/validators/bar/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='bar.hoverlabel', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/hoverlabel/_bgcolorsrc.py b/plotly/validators/bar/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 6fec65bd023..00000000000 --- a/plotly/validators/bar/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='bgcolorsrc', parent_name='bar.hoverlabel', **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/hoverlabel/_bordercolor.py b/plotly/validators/bar/hoverlabel/_bordercolor.py deleted file mode 100644 index d6f802c808a..00000000000 --- a/plotly/validators/bar/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='bar.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/hoverlabel/_bordercolorsrc.py b/plotly/validators/bar/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index c3ee19cae74..00000000000 --- a/plotly/validators/bar/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='bar.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/hoverlabel/_font.py b/plotly/validators/bar/hoverlabel/_font.py deleted file mode 100644 index eb5c462bc2f..00000000000 --- a/plotly/validators/bar/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='bar.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/hoverlabel/_namelength.py b/plotly/validators/bar/hoverlabel/_namelength.py deleted file mode 100644 index 2f3b92340e7..00000000000 --- a/plotly/validators/bar/hoverlabel/_namelength.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='namelength', parent_name='bar.hoverlabel', **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/hoverlabel/_namelengthsrc.py b/plotly/validators/bar/hoverlabel/_namelengthsrc.py deleted file mode 100644 index f705f652c38..00000000000 --- a/plotly/validators/bar/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='bar.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/hoverlabel/font/__init__.py b/plotly/validators/bar/hoverlabel/font/__init__.py index 1d2c591d1e5..24348c13ef2 100644 --- a/plotly/validators/bar/hoverlabel/font/__init__.py +++ b/plotly/validators/bar/hoverlabel/font/__init__.py @@ -1,6 +1,120 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='bar.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='bar.hoverlabel.font', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='bar.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='bar.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='bar.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='bar.hoverlabel.font', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/bar/hoverlabel/font/_color.py b/plotly/validators/bar/hoverlabel/font/_color.py deleted file mode 100644 index 5b03c2417a8..00000000000 --- a/plotly/validators/bar/hoverlabel/font/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='bar.hoverlabel.font', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/hoverlabel/font/_colorsrc.py b/plotly/validators/bar/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 2c54ac5088b..00000000000 --- a/plotly/validators/bar/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='bar.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/hoverlabel/font/_family.py b/plotly/validators/bar/hoverlabel/font/_family.py deleted file mode 100644 index f655eccc0c1..00000000000 --- a/plotly/validators/bar/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='bar.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/bar/hoverlabel/font/_familysrc.py b/plotly/validators/bar/hoverlabel/font/_familysrc.py deleted file mode 100644 index 7dbd56f9d8e..00000000000 --- a/plotly/validators/bar/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='bar.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/hoverlabel/font/_size.py b/plotly/validators/bar/hoverlabel/font/_size.py deleted file mode 100644 index 52df88543c1..00000000000 --- a/plotly/validators/bar/hoverlabel/font/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='bar.hoverlabel.font', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/hoverlabel/font/_sizesrc.py b/plotly/validators/bar/hoverlabel/font/_sizesrc.py deleted file mode 100644 index b935c523574..00000000000 --- a/plotly/validators/bar/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='bar.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/insidetextfont/__init__.py b/plotly/validators/bar/insidetextfont/__init__.py index 1d2c591d1e5..82386f463ab 100644 --- a/plotly/validators/bar/insidetextfont/__init__.py +++ b/plotly/validators/bar/insidetextfont/__init__.py @@ -1,6 +1,117 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='bar.insidetextfont', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='bar.insidetextfont', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='bar.insidetextfont', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='bar.insidetextfont', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='bar.insidetextfont', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='bar.insidetextfont', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/bar/insidetextfont/_color.py b/plotly/validators/bar/insidetextfont/_color.py deleted file mode 100644 index b0d622bcdf9..00000000000 --- a/plotly/validators/bar/insidetextfont/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='bar.insidetextfont', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/insidetextfont/_colorsrc.py b/plotly/validators/bar/insidetextfont/_colorsrc.py deleted file mode 100644 index c199b2e1065..00000000000 --- a/plotly/validators/bar/insidetextfont/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='bar.insidetextfont', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/insidetextfont/_family.py b/plotly/validators/bar/insidetextfont/_family.py deleted file mode 100644 index a914a61a0f8..00000000000 --- a/plotly/validators/bar/insidetextfont/_family.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='bar.insidetextfont', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/bar/insidetextfont/_familysrc.py b/plotly/validators/bar/insidetextfont/_familysrc.py deleted file mode 100644 index afc6c69c42e..00000000000 --- a/plotly/validators/bar/insidetextfont/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='bar.insidetextfont', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/insidetextfont/_size.py b/plotly/validators/bar/insidetextfont/_size.py deleted file mode 100644 index a8d3add2785..00000000000 --- a/plotly/validators/bar/insidetextfont/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='bar.insidetextfont', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/insidetextfont/_sizesrc.py b/plotly/validators/bar/insidetextfont/_sizesrc.py deleted file mode 100644 index 9c78f2a7355..00000000000 --- a/plotly/validators/bar/insidetextfont/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='bar.insidetextfont', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/__init__.py b/plotly/validators/bar/marker/__init__.py index ea24221c2fd..bbcd2cfc68e 100644 --- a/plotly/validators/bar/marker/__init__.py +++ b/plotly/validators/bar/marker/__init__.py @@ -1,14 +1,539 @@ -from ._showscale import ShowscaleValidator -from ._reversescale import ReversescaleValidator -from ._opacitysrc import OpacitysrcValidator -from ._opacity import OpacityValidator -from ._line import LineValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='bar.marker', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='reversescale', parent_name='bar.marker', **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='opacitysrc', parent_name='bar.marker', **kwargs + ): + super(OpacitysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='bar.marker', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='line', parent_name='bar.marker', **kwargs): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='bar.marker', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='bar.marker', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='bar.marker', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.bar.marker.colorbar.Tickforma + tstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.bar.marker.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of bar.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.bar.marker.colorbar.Title + instance or dict with compatible properties + titlefont + 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. + titleside + Deprecated: Please use + bar.marker.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='bar.marker', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'bar.marker.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmin', parent_name='bar.marker', **kwargs): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmid', parent_name='bar.marker', **kwargs): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmax', parent_name='bar.marker', **kwargs): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='bar.marker', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autocolorscale', parent_name='bar.marker', **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/bar/marker/_autocolorscale.py b/plotly/validators/bar/marker/_autocolorscale.py deleted file mode 100644 index 5ccb030dabf..00000000000 --- a/plotly/validators/bar/marker/_autocolorscale.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autocolorscale', parent_name='bar.marker', **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/_cauto.py b/plotly/validators/bar/marker/_cauto.py deleted file mode 100644 index ad6c9ccdcd7..00000000000 --- a/plotly/validators/bar/marker/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='bar.marker', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/_cmax.py b/plotly/validators/bar/marker/_cmax.py deleted file mode 100644 index 100b2be3be9..00000000000 --- a/plotly/validators/bar/marker/_cmax.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmax', parent_name='bar.marker', **kwargs): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/_cmid.py b/plotly/validators/bar/marker/_cmid.py deleted file mode 100644 index be1f7478750..00000000000 --- a/plotly/validators/bar/marker/_cmid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmid', parent_name='bar.marker', **kwargs): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/_cmin.py b/plotly/validators/bar/marker/_cmin.py deleted file mode 100644 index b43b6a2ffae..00000000000 --- a/plotly/validators/bar/marker/_cmin.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmin', parent_name='bar.marker', **kwargs): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/_color.py b/plotly/validators/bar/marker/_color.py deleted file mode 100644 index 2c14f6a81ea..00000000000 --- a/plotly/validators/bar/marker/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='bar.marker', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'bar.marker.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/bar/marker/_colorbar.py b/plotly/validators/bar/marker/_colorbar.py deleted file mode 100644 index 29c04fc42d8..00000000000 --- a/plotly/validators/bar/marker/_colorbar.py +++ /dev/null @@ -1,227 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='bar.marker', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.bar.marker.colorbar.Tickforma - tstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.bar.marker.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of bar.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.bar.marker.colorbar.Title - instance or dict with compatible properties - titlefont - 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. - titleside - Deprecated: Please use - bar.marker.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/marker/_colorscale.py b/plotly/validators/bar/marker/_colorscale.py deleted file mode 100644 index 7262814b5ec..00000000000 --- a/plotly/validators/bar/marker/_colorscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='bar.marker', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/_colorsrc.py b/plotly/validators/bar/marker/_colorsrc.py deleted file mode 100644 index 30351957a5a..00000000000 --- a/plotly/validators/bar/marker/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='bar.marker', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/_line.py b/plotly/validators/bar/marker/_line.py deleted file mode 100644 index abb465b69cf..00000000000 --- a/plotly/validators/bar/marker/_line.py +++ /dev/null @@ -1,95 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='line', parent_name='bar.marker', **kwargs): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/marker/_opacity.py b/plotly/validators/bar/marker/_opacity.py deleted file mode 100644 index 5af14d18e0b..00000000000 --- a/plotly/validators/bar/marker/_opacity.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='bar.marker', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/_opacitysrc.py b/plotly/validators/bar/marker/_opacitysrc.py deleted file mode 100644 index f988910db61..00000000000 --- a/plotly/validators/bar/marker/_opacitysrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='opacitysrc', parent_name='bar.marker', **kwargs - ): - super(OpacitysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/_reversescale.py b/plotly/validators/bar/marker/_reversescale.py deleted file mode 100644 index 0643f129967..00000000000 --- a/plotly/validators/bar/marker/_reversescale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='reversescale', parent_name='bar.marker', **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/_showscale.py b/plotly/validators/bar/marker/_showscale.py deleted file mode 100644 index 8441e1d5c9a..00000000000 --- a/plotly/validators/bar/marker/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='bar.marker', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/__init__.py b/plotly/validators/bar/marker/colorbar/__init__.py index 3dab31f7e02..d19e05a1f6a 100644 --- a/plotly/validators/bar/marker/colorbar/__init__.py +++ b/plotly/validators/bar/marker/colorbar/__init__.py @@ -1,41 +1,909 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ypad', parent_name='bar.marker.colorbar', **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='bar.marker.colorbar', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='xpad', parent_name='bar.marker.colorbar', **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='bar.marker.colorbar', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='bar.marker.colorbar', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ticks', parent_name='bar.marker.colorbar', **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='tick0', parent_name='bar.marker.colorbar', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='len', parent_name='bar.marker.colorbar', **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='dtick', parent_name='bar.marker.colorbar', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='bar.marker.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/bar/marker/colorbar/_bgcolor.py b/plotly/validators/bar/marker/colorbar/_bgcolor.py deleted file mode 100644 index fd961a95c1f..00000000000 --- a/plotly/validators/bar/marker/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_bordercolor.py b/plotly/validators/bar/marker/colorbar/_bordercolor.py deleted file mode 100644 index 0171ed7ee4c..00000000000 --- a/plotly/validators/bar/marker/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_borderwidth.py b/plotly/validators/bar/marker/colorbar/_borderwidth.py deleted file mode 100644 index d6d08eca96c..00000000000 --- a/plotly/validators/bar/marker/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_dtick.py b/plotly/validators/bar/marker/colorbar/_dtick.py deleted file mode 100644 index 24964dadfc7..00000000000 --- a/plotly/validators/bar/marker/colorbar/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='dtick', parent_name='bar.marker.colorbar', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_exponentformat.py b/plotly/validators/bar/marker/colorbar/_exponentformat.py deleted file mode 100644 index a7687189cb8..00000000000 --- a/plotly/validators/bar/marker/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_len.py b/plotly/validators/bar/marker/colorbar/_len.py deleted file mode 100644 index bdf536b3eb2..00000000000 --- a/plotly/validators/bar/marker/colorbar/_len.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='len', parent_name='bar.marker.colorbar', **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_lenmode.py b/plotly/validators/bar/marker/colorbar/_lenmode.py deleted file mode 100644 index e3bad15e639..00000000000 --- a/plotly/validators/bar/marker/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_nticks.py b/plotly/validators/bar/marker/colorbar/_nticks.py deleted file mode 100644 index b6d16ebf8aa..00000000000 --- a/plotly/validators/bar/marker/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_outlinecolor.py b/plotly/validators/bar/marker/colorbar/_outlinecolor.py deleted file mode 100644 index 6497ae21ac1..00000000000 --- a/plotly/validators/bar/marker/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_outlinewidth.py b/plotly/validators/bar/marker/colorbar/_outlinewidth.py deleted file mode 100644 index 281def9461c..00000000000 --- a/plotly/validators/bar/marker/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_separatethousands.py b/plotly/validators/bar/marker/colorbar/_separatethousands.py deleted file mode 100644 index 5660b7c5d4a..00000000000 --- a/plotly/validators/bar/marker/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_showexponent.py b/plotly/validators/bar/marker/colorbar/_showexponent.py deleted file mode 100644 index 0f17a610ae5..00000000000 --- a/plotly/validators/bar/marker/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_showticklabels.py b/plotly/validators/bar/marker/colorbar/_showticklabels.py deleted file mode 100644 index e8ebccff16e..00000000000 --- a/plotly/validators/bar/marker/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_showtickprefix.py b/plotly/validators/bar/marker/colorbar/_showtickprefix.py deleted file mode 100644 index 35783e5bcf8..00000000000 --- a/plotly/validators/bar/marker/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_showticksuffix.py b/plotly/validators/bar/marker/colorbar/_showticksuffix.py deleted file mode 100644 index 3c746efabbc..00000000000 --- a/plotly/validators/bar/marker/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_thickness.py b/plotly/validators/bar/marker/colorbar/_thickness.py deleted file mode 100644 index 385d1ec56eb..00000000000 --- a/plotly/validators/bar/marker/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_thicknessmode.py b/plotly/validators/bar/marker/colorbar/_thicknessmode.py deleted file mode 100644 index 7b369fcc875..00000000000 --- a/plotly/validators/bar/marker/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_tick0.py b/plotly/validators/bar/marker/colorbar/_tick0.py deleted file mode 100644 index e1622451dc3..00000000000 --- a/plotly/validators/bar/marker/colorbar/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='tick0', parent_name='bar.marker.colorbar', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_tickangle.py b/plotly/validators/bar/marker/colorbar/_tickangle.py deleted file mode 100644 index 90235c004b8..00000000000 --- a/plotly/validators/bar/marker/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_tickcolor.py b/plotly/validators/bar/marker/colorbar/_tickcolor.py deleted file mode 100644 index b41bd11ee33..00000000000 --- a/plotly/validators/bar/marker/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_tickfont.py b/plotly/validators/bar/marker/colorbar/_tickfont.py deleted file mode 100644 index 0708618d9ff..00000000000 --- a/plotly/validators/bar/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_tickformat.py b/plotly/validators/bar/marker/colorbar/_tickformat.py deleted file mode 100644 index b7c6ae5a05c..00000000000 --- a/plotly/validators/bar/marker/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_tickformatstopdefaults.py b/plotly/validators/bar/marker/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index dd2cd157a69..00000000000 --- a/plotly/validators/bar/marker/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_tickformatstops.py b/plotly/validators/bar/marker/colorbar/_tickformatstops.py deleted file mode 100644 index f014742f8a5..00000000000 --- a/plotly/validators/bar/marker/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_ticklen.py b/plotly/validators/bar/marker/colorbar/_ticklen.py deleted file mode 100644 index 7ad48ea206c..00000000000 --- a/plotly/validators/bar/marker/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_tickmode.py b/plotly/validators/bar/marker/colorbar/_tickmode.py deleted file mode 100644 index b12f0437566..00000000000 --- a/plotly/validators/bar/marker/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_tickprefix.py b/plotly/validators/bar/marker/colorbar/_tickprefix.py deleted file mode 100644 index f67243d97ea..00000000000 --- a/plotly/validators/bar/marker/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_ticks.py b/plotly/validators/bar/marker/colorbar/_ticks.py deleted file mode 100644 index 9f99d9b5171..00000000000 --- a/plotly/validators/bar/marker/colorbar/_ticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ticks', parent_name='bar.marker.colorbar', **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_ticksuffix.py b/plotly/validators/bar/marker/colorbar/_ticksuffix.py deleted file mode 100644 index 83c075caf27..00000000000 --- a/plotly/validators/bar/marker/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_ticktext.py b/plotly/validators/bar/marker/colorbar/_ticktext.py deleted file mode 100644 index ad5d06943d2..00000000000 --- a/plotly/validators/bar/marker/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_ticktextsrc.py b/plotly/validators/bar/marker/colorbar/_ticktextsrc.py deleted file mode 100644 index 6d4eb3376e5..00000000000 --- a/plotly/validators/bar/marker/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_tickvals.py b/plotly/validators/bar/marker/colorbar/_tickvals.py deleted file mode 100644 index bac0e3c1ea3..00000000000 --- a/plotly/validators/bar/marker/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_tickvalssrc.py b/plotly/validators/bar/marker/colorbar/_tickvalssrc.py deleted file mode 100644 index 5bb75ef0bf1..00000000000 --- a/plotly/validators/bar/marker/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_tickwidth.py b/plotly/validators/bar/marker/colorbar/_tickwidth.py deleted file mode 100644 index 83c5731d47b..00000000000 --- a/plotly/validators/bar/marker/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_title.py b/plotly/validators/bar/marker/colorbar/_title.py deleted file mode 100644 index 1b37c7411f3..00000000000 --- a/plotly/validators/bar/marker/colorbar/_title.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='bar.marker.colorbar', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_x.py b/plotly/validators/bar/marker/colorbar/_x.py deleted file mode 100644 index b5032969912..00000000000 --- a/plotly/validators/bar/marker/colorbar/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='bar.marker.colorbar', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_xanchor.py b/plotly/validators/bar/marker/colorbar/_xanchor.py deleted file mode 100644 index 934012fcacd..00000000000 --- a/plotly/validators/bar/marker/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_xpad.py b/plotly/validators/bar/marker/colorbar/_xpad.py deleted file mode 100644 index 57f85901979..00000000000 --- a/plotly/validators/bar/marker/colorbar/_xpad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='xpad', parent_name='bar.marker.colorbar', **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_y.py b/plotly/validators/bar/marker/colorbar/_y.py deleted file mode 100644 index e8826f0e2a5..00000000000 --- a/plotly/validators/bar/marker/colorbar/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='bar.marker.colorbar', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_yanchor.py b/plotly/validators/bar/marker/colorbar/_yanchor.py deleted file mode 100644 index d24a606a7e5..00000000000 --- a/plotly/validators/bar/marker/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='bar.marker.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/_ypad.py b/plotly/validators/bar/marker/colorbar/_ypad.py deleted file mode 100644 index 6a5268e6ca5..00000000000 --- a/plotly/validators/bar/marker/colorbar/_ypad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ypad', parent_name='bar.marker.colorbar', **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/tickfont/__init__.py b/plotly/validators/bar/marker/colorbar/tickfont/__init__.py index 199d72e71c6..358ff263f75 100644 --- a/plotly/validators/bar/marker/colorbar/tickfont/__init__.py +++ b/plotly/validators/bar/marker/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='bar.marker.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='bar.marker.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='bar.marker.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/bar/marker/colorbar/tickfont/_color.py b/plotly/validators/bar/marker/colorbar/tickfont/_color.py deleted file mode 100644 index 9a2079be65f..00000000000 --- a/plotly/validators/bar/marker/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='bar.marker.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/tickfont/_family.py b/plotly/validators/bar/marker/colorbar/tickfont/_family.py deleted file mode 100644 index bfd28089ce7..00000000000 --- a/plotly/validators/bar/marker/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='bar.marker.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/tickfont/_size.py b/plotly/validators/bar/marker/colorbar/tickfont/_size.py deleted file mode 100644 index 6fa44429974..00000000000 --- a/plotly/validators/bar/marker/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='bar.marker.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/tickformatstop/__init__.py b/plotly/validators/bar/marker/colorbar/tickformatstop/__init__.py index 3f6c06cac47..fd6f7a7cc52 100644 --- a/plotly/validators/bar/marker/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/bar/marker/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='bar.marker.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='bar.marker.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='bar.marker.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='bar.marker.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='bar.marker.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/bar/marker/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/bar/marker/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index a09f7c303e2..00000000000 --- a/plotly/validators/bar/marker/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='bar.marker.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/tickformatstop/_enabled.py b/plotly/validators/bar/marker/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index 410fde2d0ee..00000000000 --- a/plotly/validators/bar/marker/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='bar.marker.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/tickformatstop/_name.py b/plotly/validators/bar/marker/colorbar/tickformatstop/_name.py deleted file mode 100644 index b707a70bc70..00000000000 --- a/plotly/validators/bar/marker/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='bar.marker.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/bar/marker/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 37e0a312d03..00000000000 --- a/plotly/validators/bar/marker/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='bar.marker.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/tickformatstop/_value.py b/plotly/validators/bar/marker/colorbar/tickformatstop/_value.py deleted file mode 100644 index e2b5ecb4798..00000000000 --- a/plotly/validators/bar/marker/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='bar.marker.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/title/__init__.py b/plotly/validators/bar/marker/colorbar/title/__init__.py index 33c9c145bb8..d591fab8644 100644 --- a/plotly/validators/bar/marker/colorbar/title/__init__.py +++ b/plotly/validators/bar/marker/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='bar.marker.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='bar.marker.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='bar.marker.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/bar/marker/colorbar/title/_font.py b/plotly/validators/bar/marker/colorbar/title/_font.py deleted file mode 100644 index 61116cf833e..00000000000 --- a/plotly/validators/bar/marker/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='bar.marker.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/title/_side.py b/plotly/validators/bar/marker/colorbar/title/_side.py deleted file mode 100644 index dfca3a182bc..00000000000 --- a/plotly/validators/bar/marker/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='bar.marker.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/title/_text.py b/plotly/validators/bar/marker/colorbar/title/_text.py deleted file mode 100644 index 5ad6e75b0bf..00000000000 --- a/plotly/validators/bar/marker/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='bar.marker.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/title/font/__init__.py b/plotly/validators/bar/marker/colorbar/title/font/__init__.py index 199d72e71c6..0a029b56209 100644 --- a/plotly/validators/bar/marker/colorbar/title/font/__init__.py +++ b/plotly/validators/bar/marker/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='bar.marker.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='bar.marker.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='bar.marker.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/bar/marker/colorbar/title/font/_color.py b/plotly/validators/bar/marker/colorbar/title/font/_color.py deleted file mode 100644 index 68104ec4aa3..00000000000 --- a/plotly/validators/bar/marker/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='bar.marker.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/title/font/_family.py b/plotly/validators/bar/marker/colorbar/title/font/_family.py deleted file mode 100644 index e15a8f5ddd0..00000000000 --- a/plotly/validators/bar/marker/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='bar.marker.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/bar/marker/colorbar/title/font/_size.py b/plotly/validators/bar/marker/colorbar/title/font/_size.py deleted file mode 100644 index 6de6a22c657..00000000000 --- a/plotly/validators/bar/marker/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='bar.marker.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/line/__init__.py b/plotly/validators/bar/marker/line/__init__.py index c031ca61ce2..89c09ef790c 100644 --- a/plotly/validators/bar/marker/line/__init__.py +++ b/plotly/validators/bar/marker/line/__init__.py @@ -1,11 +1,211 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._reversescale import ReversescaleValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='widthsrc', parent_name='bar.marker.line', **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='bar.marker.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='bar.marker.line', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='bar.marker.line', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='bar.marker.line', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='bar.marker.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'bar.marker.line.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='bar.marker.line', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='bar.marker.line', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='bar.marker.line', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='bar.marker.line', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='bar.marker.line', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/bar/marker/line/_autocolorscale.py b/plotly/validators/bar/marker/line/_autocolorscale.py deleted file mode 100644 index 353901c7040..00000000000 --- a/plotly/validators/bar/marker/line/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='bar.marker.line', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/line/_cauto.py b/plotly/validators/bar/marker/line/_cauto.py deleted file mode 100644 index 2f97de095c8..00000000000 --- a/plotly/validators/bar/marker/line/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='bar.marker.line', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/line/_cmax.py b/plotly/validators/bar/marker/line/_cmax.py deleted file mode 100644 index 052421a536d..00000000000 --- a/plotly/validators/bar/marker/line/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='bar.marker.line', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/line/_cmid.py b/plotly/validators/bar/marker/line/_cmid.py deleted file mode 100644 index 383583db2d0..00000000000 --- a/plotly/validators/bar/marker/line/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='bar.marker.line', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/line/_cmin.py b/plotly/validators/bar/marker/line/_cmin.py deleted file mode 100644 index bb246512ffc..00000000000 --- a/plotly/validators/bar/marker/line/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='bar.marker.line', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/line/_color.py b/plotly/validators/bar/marker/line/_color.py deleted file mode 100644 index f06d1226f8a..00000000000 --- a/plotly/validators/bar/marker/line/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='bar.marker.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'bar.marker.line.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/bar/marker/line/_colorscale.py b/plotly/validators/bar/marker/line/_colorscale.py deleted file mode 100644 index 53905706cc5..00000000000 --- a/plotly/validators/bar/marker/line/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='bar.marker.line', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/line/_colorsrc.py b/plotly/validators/bar/marker/line/_colorsrc.py deleted file mode 100644 index 72b61ce59dd..00000000000 --- a/plotly/validators/bar/marker/line/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='bar.marker.line', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/line/_reversescale.py b/plotly/validators/bar/marker/line/_reversescale.py deleted file mode 100644 index 7170ebdb303..00000000000 --- a/plotly/validators/bar/marker/line/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='bar.marker.line', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/line/_width.py b/plotly/validators/bar/marker/line/_width.py deleted file mode 100644 index cdb4b86d7db..00000000000 --- a/plotly/validators/bar/marker/line/_width.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='bar.marker.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/marker/line/_widthsrc.py b/plotly/validators/bar/marker/line/_widthsrc.py deleted file mode 100644 index 47cc1864b92..00000000000 --- a/plotly/validators/bar/marker/line/_widthsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='widthsrc', parent_name='bar.marker.line', **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/outsidetextfont/__init__.py b/plotly/validators/bar/outsidetextfont/__init__.py index 1d2c591d1e5..8709f8b4191 100644 --- a/plotly/validators/bar/outsidetextfont/__init__.py +++ b/plotly/validators/bar/outsidetextfont/__init__.py @@ -1,6 +1,120 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='bar.outsidetextfont', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='bar.outsidetextfont', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='bar.outsidetextfont', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='bar.outsidetextfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='bar.outsidetextfont', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='bar.outsidetextfont', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/bar/outsidetextfont/_color.py b/plotly/validators/bar/outsidetextfont/_color.py deleted file mode 100644 index abeccf8f31b..00000000000 --- a/plotly/validators/bar/outsidetextfont/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='bar.outsidetextfont', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/outsidetextfont/_colorsrc.py b/plotly/validators/bar/outsidetextfont/_colorsrc.py deleted file mode 100644 index f18e92b2bf6..00000000000 --- a/plotly/validators/bar/outsidetextfont/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='bar.outsidetextfont', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/outsidetextfont/_family.py b/plotly/validators/bar/outsidetextfont/_family.py deleted file mode 100644 index 4a4d311c1f9..00000000000 --- a/plotly/validators/bar/outsidetextfont/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='bar.outsidetextfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/bar/outsidetextfont/_familysrc.py b/plotly/validators/bar/outsidetextfont/_familysrc.py deleted file mode 100644 index a4aa1245f41..00000000000 --- a/plotly/validators/bar/outsidetextfont/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='bar.outsidetextfont', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/outsidetextfont/_size.py b/plotly/validators/bar/outsidetextfont/_size.py deleted file mode 100644 index d42c37dd12f..00000000000 --- a/plotly/validators/bar/outsidetextfont/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='bar.outsidetextfont', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/outsidetextfont/_sizesrc.py b/plotly/validators/bar/outsidetextfont/_sizesrc.py deleted file mode 100644 index ee7c6dc528b..00000000000 --- a/plotly/validators/bar/outsidetextfont/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='bar.outsidetextfont', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/selected/__init__.py b/plotly/validators/bar/selected/__init__.py index f1a1ef3742f..5aa174996ad 100644 --- a/plotly/validators/bar/selected/__init__.py +++ b/plotly/validators/bar/selected/__init__.py @@ -1,2 +1,46 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='textfont', parent_name='bar.selected', **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of selected points. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='bar.selected', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. +""" + ), + **kwargs + ) diff --git a/plotly/validators/bar/selected/_marker.py b/plotly/validators/bar/selected/_marker.py deleted file mode 100644 index 28955c7e6f1..00000000000 --- a/plotly/validators/bar/selected/_marker.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='bar.selected', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/selected/_textfont.py b/plotly/validators/bar/selected/_textfont.py deleted file mode 100644 index 744cc46f6f9..00000000000 --- a/plotly/validators/bar/selected/_textfont.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='textfont', parent_name='bar.selected', **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/selected/marker/__init__.py b/plotly/validators/bar/selected/marker/__init__.py index 990c554a22a..80b29aef8ee 100644 --- a/plotly/validators/bar/selected/marker/__init__.py +++ b/plotly/validators/bar/selected/marker/__init__.py @@ -1,2 +1,39 @@ -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='bar.selected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='bar.selected.marker', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/bar/selected/marker/_color.py b/plotly/validators/bar/selected/marker/_color.py deleted file mode 100644 index e5799b11ec9..00000000000 --- a/plotly/validators/bar/selected/marker/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='bar.selected.marker', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/selected/marker/_opacity.py b/plotly/validators/bar/selected/marker/_opacity.py deleted file mode 100644 index 59394bfb8d0..00000000000 --- a/plotly/validators/bar/selected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='bar.selected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/selected/textfont/__init__.py b/plotly/validators/bar/selected/textfont/__init__.py index 74135b3f315..b65a348752a 100644 --- a/plotly/validators/bar/selected/textfont/__init__.py +++ b/plotly/validators/bar/selected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='bar.selected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/bar/selected/textfont/_color.py b/plotly/validators/bar/selected/textfont/_color.py deleted file mode 100644 index 782b1ce2a43..00000000000 --- a/plotly/validators/bar/selected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='bar.selected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/stream/__init__.py b/plotly/validators/bar/stream/__init__.py index 2f4f2047594..539e0d220d3 100644 --- a/plotly/validators/bar/stream/__init__.py +++ b/plotly/validators/bar/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='bar.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='bar.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/bar/stream/_maxpoints.py b/plotly/validators/bar/stream/_maxpoints.py deleted file mode 100644 index 12690939775..00000000000 --- a/plotly/validators/bar/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='bar.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/stream/_token.py b/plotly/validators/bar/stream/_token.py deleted file mode 100644 index 7effdbeba5e..00000000000 --- a/plotly/validators/bar/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='bar.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/bar/textfont/__init__.py b/plotly/validators/bar/textfont/__init__.py index 1d2c591d1e5..876b2be0062 100644 --- a/plotly/validators/bar/textfont/__init__.py +++ b/plotly/validators/bar/textfont/__init__.py @@ -1,6 +1,108 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='sizesrc', parent_name='bar.textfont', **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='bar.textfont', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='familysrc', parent_name='bar.textfont', **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='bar.textfont', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='bar.textfont', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='bar.textfont', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/bar/textfont/_color.py b/plotly/validators/bar/textfont/_color.py deleted file mode 100644 index 26547dd3483..00000000000 --- a/plotly/validators/bar/textfont/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='bar.textfont', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/textfont/_colorsrc.py b/plotly/validators/bar/textfont/_colorsrc.py deleted file mode 100644 index c6523d237cb..00000000000 --- a/plotly/validators/bar/textfont/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='bar.textfont', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/textfont/_family.py b/plotly/validators/bar/textfont/_family.py deleted file mode 100644 index 550598b0e3b..00000000000 --- a/plotly/validators/bar/textfont/_family.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='bar.textfont', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/bar/textfont/_familysrc.py b/plotly/validators/bar/textfont/_familysrc.py deleted file mode 100644 index becf5437aad..00000000000 --- a/plotly/validators/bar/textfont/_familysrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='familysrc', parent_name='bar.textfont', **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/textfont/_size.py b/plotly/validators/bar/textfont/_size.py deleted file mode 100644 index 593e5f5652e..00000000000 --- a/plotly/validators/bar/textfont/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='bar.textfont', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/textfont/_sizesrc.py b/plotly/validators/bar/textfont/_sizesrc.py deleted file mode 100644 index 72f7aca0aae..00000000000 --- a/plotly/validators/bar/textfont/_sizesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='sizesrc', parent_name='bar.textfont', **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/bar/unselected/__init__.py b/plotly/validators/bar/unselected/__init__.py index f1a1ef3742f..7f0cddaa14c 100644 --- a/plotly/validators/bar/unselected/__init__.py +++ b/plotly/validators/bar/unselected/__init__.py @@ -1,2 +1,49 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='textfont', parent_name='bar.unselected', **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='bar.unselected', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of unselected points, + applied only when a selection exists. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) diff --git a/plotly/validators/bar/unselected/_marker.py b/plotly/validators/bar/unselected/_marker.py deleted file mode 100644 index d0ad2bd4a53..00000000000 --- a/plotly/validators/bar/unselected/_marker.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='bar.unselected', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of unselected points, - applied only when a selection exists. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/unselected/_textfont.py b/plotly/validators/bar/unselected/_textfont.py deleted file mode 100644 index f18f29493a8..00000000000 --- a/plotly/validators/bar/unselected/_textfont.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='textfont', parent_name='bar.unselected', **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/bar/unselected/marker/__init__.py b/plotly/validators/bar/unselected/marker/__init__.py index 990c554a22a..aada914340f 100644 --- a/plotly/validators/bar/unselected/marker/__init__.py +++ b/plotly/validators/bar/unselected/marker/__init__.py @@ -1,2 +1,42 @@ -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='bar.unselected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='bar.unselected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/bar/unselected/marker/_color.py b/plotly/validators/bar/unselected/marker/_color.py deleted file mode 100644 index 40e42dc029f..00000000000 --- a/plotly/validators/bar/unselected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='bar.unselected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/unselected/marker/_opacity.py b/plotly/validators/bar/unselected/marker/_opacity.py deleted file mode 100644 index ed658a5799a..00000000000 --- a/plotly/validators/bar/unselected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='bar.unselected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/bar/unselected/textfont/__init__.py b/plotly/validators/bar/unselected/textfont/__init__.py index 74135b3f315..bb347de569d 100644 --- a/plotly/validators/bar/unselected/textfont/__init__.py +++ b/plotly/validators/bar/unselected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='bar.unselected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/bar/unselected/textfont/_color.py b/plotly/validators/bar/unselected/textfont/_color.py deleted file mode 100644 index 09dd861a99f..00000000000 --- a/plotly/validators/bar/unselected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='bar.unselected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/__init__.py b/plotly/validators/barpolar/__init__.py index 1aebce5cb89..4e6d9904b74 100644 --- a/plotly/validators/barpolar/__init__.py +++ b/plotly/validators/barpolar/__init__.py @@ -1,41 +1,827 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._unselected import UnselectedValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._thetaunit import ThetaunitValidator -from ._thetasrc import ThetasrcValidator -from ._theta0 import Theta0Validator -from ._theta import ThetaValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._subplot import SubplotValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._selected import SelectedValidator -from ._rsrc import RsrcValidator -from ._r0 import R0Validator -from ._r import RValidator -from ._opacity import OpacityValidator -from ._offsetsrc import OffsetsrcValidator -from ._offset import OffsetValidator -from ._name import NameValidator -from ._marker import MarkerValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._dtheta import DthetaValidator -from ._dr import DrValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._basesrc import BasesrcValidator -from ._base import BaseValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='widthsrc', parent_name='barpolar', **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='width', parent_name='barpolar', **kwargs): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='barpolar', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='unselected', parent_name='barpolar', **kwargs + ): + super(UnselectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Unselected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.barpolar.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.barpolar.unselected.Textfont + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='barpolar', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='barpolar', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThetaunitValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='thetaunit', parent_name='barpolar', **kwargs + ): + super(ThetaunitValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['radians', 'degrees', 'gradians']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThetasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='thetasrc', parent_name='barpolar', **kwargs + ): + super(ThetasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Theta0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='theta0', parent_name='barpolar', **kwargs): + super(Theta0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThetaValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='theta', parent_name='barpolar', **kwargs): + super(ThetaValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textsrc', parent_name='barpolar', **kwargs + ): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='barpolar', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SubplotValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='subplot', parent_name='barpolar', **kwargs + ): + super(SubplotValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'polar'), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='barpolar', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='barpolar', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='barpolar', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='selected', parent_name='barpolar', **kwargs + ): + super(SelectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Selected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.barpolar.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.barpolar.selected.Textfont + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='rsrc', parent_name='barpolar', **kwargs): + super(RsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class R0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='r0', parent_name='barpolar', **kwargs): + super(R0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='r', parent_name='barpolar', **kwargs): + super(RValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='barpolar', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OffsetsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='offsetsrc', parent_name='barpolar', **kwargs + ): + super(OffsetsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OffsetValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='offset', parent_name='barpolar', **kwargs): + super(OffsetValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='barpolar', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='marker', parent_name='barpolar', **kwargs): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.barpolar.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + line + plotly.graph_objs.barpolar.marker.Line instance + or dict with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='barpolar', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='barpolar', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='barpolar', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='barpolar', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='barpolar', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertemplatesrc', parent_name='barpolar', **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='barpolar', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='barpolar', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='barpolar', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='barpolar', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['r', 'theta', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DthetaValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='dtheta', parent_name='barpolar', **kwargs): + super(DthetaValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DrValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='dr', parent_name='barpolar', **kwargs): + super(DrValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='barpolar', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='barpolar', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BasesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='basesrc', parent_name='barpolar', **kwargs + ): + super(BasesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BaseValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='base', parent_name='barpolar', **kwargs): + super(BaseValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/barpolar/_base.py b/plotly/validators/barpolar/_base.py deleted file mode 100644 index e730e3ef3f5..00000000000 --- a/plotly/validators/barpolar/_base.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class BaseValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='base', parent_name='barpolar', **kwargs): - super(BaseValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_basesrc.py b/plotly/validators/barpolar/_basesrc.py deleted file mode 100644 index e0f6a9804d8..00000000000 --- a/plotly/validators/barpolar/_basesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BasesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='basesrc', parent_name='barpolar', **kwargs - ): - super(BasesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_customdata.py b/plotly/validators/barpolar/_customdata.py deleted file mode 100644 index f861c059173..00000000000 --- a/plotly/validators/barpolar/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='barpolar', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_customdatasrc.py b/plotly/validators/barpolar/_customdatasrc.py deleted file mode 100644 index 30848ee3a29..00000000000 --- a/plotly/validators/barpolar/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='barpolar', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_dr.py b/plotly/validators/barpolar/_dr.py deleted file mode 100644 index 88f28aafeb5..00000000000 --- a/plotly/validators/barpolar/_dr.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class DrValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='dr', parent_name='barpolar', **kwargs): - super(DrValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_dtheta.py b/plotly/validators/barpolar/_dtheta.py deleted file mode 100644 index d1197732eb7..00000000000 --- a/plotly/validators/barpolar/_dtheta.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class DthetaValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='dtheta', parent_name='barpolar', **kwargs): - super(DthetaValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_hoverinfo.py b/plotly/validators/barpolar/_hoverinfo.py deleted file mode 100644 index ad9bb509e99..00000000000 --- a/plotly/validators/barpolar/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='barpolar', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['r', 'theta', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_hoverinfosrc.py b/plotly/validators/barpolar/_hoverinfosrc.py deleted file mode 100644 index c232f108861..00000000000 --- a/plotly/validators/barpolar/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='barpolar', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_hoverlabel.py b/plotly/validators/barpolar/_hoverlabel.py deleted file mode 100644 index 9fce279a096..00000000000 --- a/plotly/validators/barpolar/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='barpolar', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/_hovertemplate.py b/plotly/validators/barpolar/_hovertemplate.py deleted file mode 100644 index d7284495685..00000000000 --- a/plotly/validators/barpolar/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='barpolar', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_hovertemplatesrc.py b/plotly/validators/barpolar/_hovertemplatesrc.py deleted file mode 100644 index f27b6d9a076..00000000000 --- a/plotly/validators/barpolar/_hovertemplatesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertemplatesrc', parent_name='barpolar', **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_hovertext.py b/plotly/validators/barpolar/_hovertext.py deleted file mode 100644 index 76a611654d1..00000000000 --- a/plotly/validators/barpolar/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='barpolar', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_hovertextsrc.py b/plotly/validators/barpolar/_hovertextsrc.py deleted file mode 100644 index b4cfaaf2351..00000000000 --- a/plotly/validators/barpolar/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='barpolar', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_ids.py b/plotly/validators/barpolar/_ids.py deleted file mode 100644 index 920d011d1b4..00000000000 --- a/plotly/validators/barpolar/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='barpolar', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_idssrc.py b/plotly/validators/barpolar/_idssrc.py deleted file mode 100644 index 60a063dc089..00000000000 --- a/plotly/validators/barpolar/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='barpolar', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_legendgroup.py b/plotly/validators/barpolar/_legendgroup.py deleted file mode 100644 index 2c854c5ba53..00000000000 --- a/plotly/validators/barpolar/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='barpolar', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_marker.py b/plotly/validators/barpolar/_marker.py deleted file mode 100644 index 40c85108922..00000000000 --- a/plotly/validators/barpolar/_marker.py +++ /dev/null @@ -1,101 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='marker', parent_name='barpolar', **kwargs): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.barpolar.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - line - plotly.graph_objs.barpolar.marker.Line instance - or dict with compatible properties - opacity - Sets the opacity of the bars. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. -""" - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/_name.py b/plotly/validators/barpolar/_name.py deleted file mode 100644 index b5609d21820..00000000000 --- a/plotly/validators/barpolar/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='barpolar', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_offset.py b/plotly/validators/barpolar/_offset.py deleted file mode 100644 index ea1687da53c..00000000000 --- a/plotly/validators/barpolar/_offset.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class OffsetValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='offset', parent_name='barpolar', **kwargs): - super(OffsetValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_offsetsrc.py b/plotly/validators/barpolar/_offsetsrc.py deleted file mode 100644 index 03b8ea74c08..00000000000 --- a/plotly/validators/barpolar/_offsetsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OffsetsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='offsetsrc', parent_name='barpolar', **kwargs - ): - super(OffsetsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_opacity.py b/plotly/validators/barpolar/_opacity.py deleted file mode 100644 index d7c538d6001..00000000000 --- a/plotly/validators/barpolar/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='barpolar', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_r.py b/plotly/validators/barpolar/_r.py deleted file mode 100644 index cffc81ca960..00000000000 --- a/plotly/validators/barpolar/_r.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class RValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='r', parent_name='barpolar', **kwargs): - super(RValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_r0.py b/plotly/validators/barpolar/_r0.py deleted file mode 100644 index 1db725d77e5..00000000000 --- a/plotly/validators/barpolar/_r0.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class R0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='r0', parent_name='barpolar', **kwargs): - super(R0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_rsrc.py b/plotly/validators/barpolar/_rsrc.py deleted file mode 100644 index 42220aa912e..00000000000 --- a/plotly/validators/barpolar/_rsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class RsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='rsrc', parent_name='barpolar', **kwargs): - super(RsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_selected.py b/plotly/validators/barpolar/_selected.py deleted file mode 100644 index c93b60321f8..00000000000 --- a/plotly/validators/barpolar/_selected.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='selected', parent_name='barpolar', **kwargs - ): - super(SelectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Selected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.barpolar.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.barpolar.selected.Textfont - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/_selectedpoints.py b/plotly/validators/barpolar/_selectedpoints.py deleted file mode 100644 index 42c6675b37a..00000000000 --- a/plotly/validators/barpolar/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='barpolar', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_showlegend.py b/plotly/validators/barpolar/_showlegend.py deleted file mode 100644 index 0a3dcc737e3..00000000000 --- a/plotly/validators/barpolar/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='barpolar', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_stream.py b/plotly/validators/barpolar/_stream.py deleted file mode 100644 index f431a13be7e..00000000000 --- a/plotly/validators/barpolar/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='barpolar', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/_subplot.py b/plotly/validators/barpolar/_subplot.py deleted file mode 100644 index e5b39a81290..00000000000 --- a/plotly/validators/barpolar/_subplot.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SubplotValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='subplot', parent_name='barpolar', **kwargs - ): - super(SubplotValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'polar'), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_text.py b/plotly/validators/barpolar/_text.py deleted file mode 100644 index dba74f8394b..00000000000 --- a/plotly/validators/barpolar/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='barpolar', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_textsrc.py b/plotly/validators/barpolar/_textsrc.py deleted file mode 100644 index 8c5f2d1764a..00000000000 --- a/plotly/validators/barpolar/_textsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textsrc', parent_name='barpolar', **kwargs - ): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_theta.py b/plotly/validators/barpolar/_theta.py deleted file mode 100644 index 98b2e430467..00000000000 --- a/plotly/validators/barpolar/_theta.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThetaValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='theta', parent_name='barpolar', **kwargs): - super(ThetaValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_theta0.py b/plotly/validators/barpolar/_theta0.py deleted file mode 100644 index 51f5077a842..00000000000 --- a/plotly/validators/barpolar/_theta0.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class Theta0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='theta0', parent_name='barpolar', **kwargs): - super(Theta0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_thetasrc.py b/plotly/validators/barpolar/_thetasrc.py deleted file mode 100644 index 628e4ce4950..00000000000 --- a/plotly/validators/barpolar/_thetasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThetasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='thetasrc', parent_name='barpolar', **kwargs - ): - super(ThetasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_thetaunit.py b/plotly/validators/barpolar/_thetaunit.py deleted file mode 100644 index 8d542fd1127..00000000000 --- a/plotly/validators/barpolar/_thetaunit.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThetaunitValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='thetaunit', parent_name='barpolar', **kwargs - ): - super(ThetaunitValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['radians', 'degrees', 'gradians']), - **kwargs - ) diff --git a/plotly/validators/barpolar/_uid.py b/plotly/validators/barpolar/_uid.py deleted file mode 100644 index ca6bcffd575..00000000000 --- a/plotly/validators/barpolar/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='barpolar', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_uirevision.py b/plotly/validators/barpolar/_uirevision.py deleted file mode 100644 index 74e9b4c393a..00000000000 --- a/plotly/validators/barpolar/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='barpolar', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_unselected.py b/plotly/validators/barpolar/_unselected.py deleted file mode 100644 index 215861a3a7a..00000000000 --- a/plotly/validators/barpolar/_unselected.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='unselected', parent_name='barpolar', **kwargs - ): - super(UnselectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Unselected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.barpolar.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.barpolar.unselected.Textfont - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/_visible.py b/plotly/validators/barpolar/_visible.py deleted file mode 100644 index ee38f1c60f5..00000000000 --- a/plotly/validators/barpolar/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='barpolar', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/barpolar/_width.py b/plotly/validators/barpolar/_width.py deleted file mode 100644 index 4904d6b5db1..00000000000 --- a/plotly/validators/barpolar/_width.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='width', parent_name='barpolar', **kwargs): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/_widthsrc.py b/plotly/validators/barpolar/_widthsrc.py deleted file mode 100644 index b7556db4646..00000000000 --- a/plotly/validators/barpolar/_widthsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='widthsrc', parent_name='barpolar', **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/hoverlabel/__init__.py b/plotly/validators/barpolar/hoverlabel/__init__.py index 856f769ba33..a592b2f966b 100644 --- a/plotly/validators/barpolar/hoverlabel/__init__.py +++ b/plotly/validators/barpolar/hoverlabel/__init__.py @@ -1,7 +1,173 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='barpolar.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='barpolar.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='barpolar.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='barpolar.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='barpolar.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='barpolar.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='barpolar.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/barpolar/hoverlabel/_bgcolor.py b/plotly/validators/barpolar/hoverlabel/_bgcolor.py deleted file mode 100644 index 0ad21658b39..00000000000 --- a/plotly/validators/barpolar/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='barpolar.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/hoverlabel/_bgcolorsrc.py b/plotly/validators/barpolar/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index ecfb0af4459..00000000000 --- a/plotly/validators/barpolar/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='barpolar.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/hoverlabel/_bordercolor.py b/plotly/validators/barpolar/hoverlabel/_bordercolor.py deleted file mode 100644 index 0fda5cb7dff..00000000000 --- a/plotly/validators/barpolar/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='barpolar.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/hoverlabel/_bordercolorsrc.py b/plotly/validators/barpolar/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 02b42cd0641..00000000000 --- a/plotly/validators/barpolar/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='barpolar.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/hoverlabel/_font.py b/plotly/validators/barpolar/hoverlabel/_font.py deleted file mode 100644 index 66dfb6a3683..00000000000 --- a/plotly/validators/barpolar/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='barpolar.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/hoverlabel/_namelength.py b/plotly/validators/barpolar/hoverlabel/_namelength.py deleted file mode 100644 index a421b50c9e2..00000000000 --- a/plotly/validators/barpolar/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='barpolar.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/hoverlabel/_namelengthsrc.py b/plotly/validators/barpolar/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 6b8ac04ec75..00000000000 --- a/plotly/validators/barpolar/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='barpolar.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/hoverlabel/font/__init__.py b/plotly/validators/barpolar/hoverlabel/font/__init__.py index 1d2c591d1e5..899a0b6ef12 100644 --- a/plotly/validators/barpolar/hoverlabel/font/__init__.py +++ b/plotly/validators/barpolar/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='barpolar.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='barpolar.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='barpolar.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='barpolar.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='barpolar.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='barpolar.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/barpolar/hoverlabel/font/_color.py b/plotly/validators/barpolar/hoverlabel/font/_color.py deleted file mode 100644 index 6f98651008e..00000000000 --- a/plotly/validators/barpolar/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='barpolar.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/hoverlabel/font/_colorsrc.py b/plotly/validators/barpolar/hoverlabel/font/_colorsrc.py deleted file mode 100644 index bfcad0f69e4..00000000000 --- a/plotly/validators/barpolar/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='barpolar.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/hoverlabel/font/_family.py b/plotly/validators/barpolar/hoverlabel/font/_family.py deleted file mode 100644 index ff08f46f9d2..00000000000 --- a/plotly/validators/barpolar/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='barpolar.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/barpolar/hoverlabel/font/_familysrc.py b/plotly/validators/barpolar/hoverlabel/font/_familysrc.py deleted file mode 100644 index 41dcc338152..00000000000 --- a/plotly/validators/barpolar/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='barpolar.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/hoverlabel/font/_size.py b/plotly/validators/barpolar/hoverlabel/font/_size.py deleted file mode 100644 index af17bf2ac57..00000000000 --- a/plotly/validators/barpolar/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='barpolar.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/hoverlabel/font/_sizesrc.py b/plotly/validators/barpolar/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 4e956c087db..00000000000 --- a/plotly/validators/barpolar/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='barpolar.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/__init__.py b/plotly/validators/barpolar/marker/__init__.py index ea24221c2fd..fafb4c5038b 100644 --- a/plotly/validators/barpolar/marker/__init__.py +++ b/plotly/validators/barpolar/marker/__init__.py @@ -1,14 +1,560 @@ -from ._showscale import ShowscaleValidator -from ._reversescale import ReversescaleValidator -from ._opacitysrc import OpacitysrcValidator -from ._opacity import OpacityValidator -from ._line import LineValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='barpolar.marker', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='barpolar.marker', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='opacitysrc', + parent_name='barpolar.marker', + **kwargs + ): + super(OpacitysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='barpolar.marker', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='barpolar.marker', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='barpolar.marker', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='barpolar.marker', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='barpolar.marker', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.barpolar.marker.colorbar.Tick + formatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.barpolar.marker.colorbar.tickformatstopdefaul + ts), sets the default property values to use + for elements of + barpolar.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.barpolar.marker.colorbar.Titl + e instance or dict with compatible properties + titlefont + Deprecated: Please use + barpolar.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. + titleside + Deprecated: Please use + barpolar.marker.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='barpolar.marker', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'barpolar.marker.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='barpolar.marker', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='barpolar.marker', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='barpolar.marker', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='barpolar.marker', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='barpolar.marker', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/barpolar/marker/_autocolorscale.py b/plotly/validators/barpolar/marker/_autocolorscale.py deleted file mode 100644 index 1822cfdb25e..00000000000 --- a/plotly/validators/barpolar/marker/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='barpolar.marker', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/_cauto.py b/plotly/validators/barpolar/marker/_cauto.py deleted file mode 100644 index afe83e6e0b4..00000000000 --- a/plotly/validators/barpolar/marker/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='barpolar.marker', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/_cmax.py b/plotly/validators/barpolar/marker/_cmax.py deleted file mode 100644 index 72e10e7f5cb..00000000000 --- a/plotly/validators/barpolar/marker/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='barpolar.marker', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/_cmid.py b/plotly/validators/barpolar/marker/_cmid.py deleted file mode 100644 index 21afba68bc1..00000000000 --- a/plotly/validators/barpolar/marker/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='barpolar.marker', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/_cmin.py b/plotly/validators/barpolar/marker/_cmin.py deleted file mode 100644 index f43e2eb372f..00000000000 --- a/plotly/validators/barpolar/marker/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='barpolar.marker', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/_color.py b/plotly/validators/barpolar/marker/_color.py deleted file mode 100644 index 8f8e7ace0fe..00000000000 --- a/plotly/validators/barpolar/marker/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='barpolar.marker', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'barpolar.marker.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/_colorbar.py b/plotly/validators/barpolar/marker/_colorbar.py deleted file mode 100644 index 4e293cbe7f2..00000000000 --- a/plotly/validators/barpolar/marker/_colorbar.py +++ /dev/null @@ -1,228 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='barpolar.marker', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.barpolar.marker.colorbar.Tick - formatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.barpolar.marker.colorbar.tickformatstopdefaul - ts), sets the default property values to use - for elements of - barpolar.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.barpolar.marker.colorbar.Titl - e instance or dict with compatible properties - titlefont - Deprecated: Please use - barpolar.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. - titleside - Deprecated: Please use - barpolar.marker.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/_colorscale.py b/plotly/validators/barpolar/marker/_colorscale.py deleted file mode 100644 index 4df5d24b4e1..00000000000 --- a/plotly/validators/barpolar/marker/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='barpolar.marker', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/_colorsrc.py b/plotly/validators/barpolar/marker/_colorsrc.py deleted file mode 100644 index 81cba0a4673..00000000000 --- a/plotly/validators/barpolar/marker/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='barpolar.marker', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/_line.py b/plotly/validators/barpolar/marker/_line.py deleted file mode 100644 index f9dee59ec63..00000000000 --- a/plotly/validators/barpolar/marker/_line.py +++ /dev/null @@ -1,97 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='barpolar.marker', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/_opacity.py b/plotly/validators/barpolar/marker/_opacity.py deleted file mode 100644 index 46519b90307..00000000000 --- a/plotly/validators/barpolar/marker/_opacity.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='barpolar.marker', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/_opacitysrc.py b/plotly/validators/barpolar/marker/_opacitysrc.py deleted file mode 100644 index 64883ed5cd8..00000000000 --- a/plotly/validators/barpolar/marker/_opacitysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='opacitysrc', - parent_name='barpolar.marker', - **kwargs - ): - super(OpacitysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/_reversescale.py b/plotly/validators/barpolar/marker/_reversescale.py deleted file mode 100644 index 0a07ef10fd2..00000000000 --- a/plotly/validators/barpolar/marker/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='barpolar.marker', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/_showscale.py b/plotly/validators/barpolar/marker/_showscale.py deleted file mode 100644 index d0c526db38b..00000000000 --- a/plotly/validators/barpolar/marker/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='barpolar.marker', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/__init__.py b/plotly/validators/barpolar/marker/colorbar/__init__.py index 3dab31f7e02..dfe74896f0f 100644 --- a/plotly/validators/barpolar/marker/colorbar/__init__.py +++ b/plotly/validators/barpolar/marker/colorbar/__init__.py @@ -1,41 +1,936 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ypad', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='y', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xpad', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='x', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='len', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='barpolar.marker.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/barpolar/marker/colorbar/_bgcolor.py b/plotly/validators/barpolar/marker/colorbar/_bgcolor.py deleted file mode 100644 index ad22446681d..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_bordercolor.py b/plotly/validators/barpolar/marker/colorbar/_bordercolor.py deleted file mode 100644 index a553e855df8..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_borderwidth.py b/plotly/validators/barpolar/marker/colorbar/_borderwidth.py deleted file mode 100644 index f9b3ac1ea5c..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_dtick.py b/plotly/validators/barpolar/marker/colorbar/_dtick.py deleted file mode 100644 index 98b5d9b57df..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_exponentformat.py b/plotly/validators/barpolar/marker/colorbar/_exponentformat.py deleted file mode 100644 index 3e9b7ddca54..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_len.py b/plotly/validators/barpolar/marker/colorbar/_len.py deleted file mode 100644 index 7ae51e8b2d5..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_len.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='len', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_lenmode.py b/plotly/validators/barpolar/marker/colorbar/_lenmode.py deleted file mode 100644 index ab18a33b625..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_nticks.py b/plotly/validators/barpolar/marker/colorbar/_nticks.py deleted file mode 100644 index e87fbf163bb..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_outlinecolor.py b/plotly/validators/barpolar/marker/colorbar/_outlinecolor.py deleted file mode 100644 index 6a4eb56a47c..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_outlinewidth.py b/plotly/validators/barpolar/marker/colorbar/_outlinewidth.py deleted file mode 100644 index efa3283838b..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_separatethousands.py b/plotly/validators/barpolar/marker/colorbar/_separatethousands.py deleted file mode 100644 index be03117b9e4..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_showexponent.py b/plotly/validators/barpolar/marker/colorbar/_showexponent.py deleted file mode 100644 index 7713897c90b..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_showticklabels.py b/plotly/validators/barpolar/marker/colorbar/_showticklabels.py deleted file mode 100644 index 687036075da..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_showtickprefix.py b/plotly/validators/barpolar/marker/colorbar/_showtickprefix.py deleted file mode 100644 index ed3f62c3b38..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_showticksuffix.py b/plotly/validators/barpolar/marker/colorbar/_showticksuffix.py deleted file mode 100644 index 14e2fcf9fb4..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_thickness.py b/plotly/validators/barpolar/marker/colorbar/_thickness.py deleted file mode 100644 index 240beb04b30..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_thicknessmode.py b/plotly/validators/barpolar/marker/colorbar/_thicknessmode.py deleted file mode 100644 index c2bbce34063..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_tick0.py b/plotly/validators/barpolar/marker/colorbar/_tick0.py deleted file mode 100644 index 9d788478e8b..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_tickangle.py b/plotly/validators/barpolar/marker/colorbar/_tickangle.py deleted file mode 100644 index 10304231394..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_tickcolor.py b/plotly/validators/barpolar/marker/colorbar/_tickcolor.py deleted file mode 100644 index 9158b928d31..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_tickfont.py b/plotly/validators/barpolar/marker/colorbar/_tickfont.py deleted file mode 100644 index d13a360ab6d..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_tickformat.py b/plotly/validators/barpolar/marker/colorbar/_tickformat.py deleted file mode 100644 index b9f909937dc..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_tickformatstopdefaults.py b/plotly/validators/barpolar/marker/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 8105fedf1c6..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_tickformatstops.py b/plotly/validators/barpolar/marker/colorbar/_tickformatstops.py deleted file mode 100644 index 24dea55da96..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_ticklen.py b/plotly/validators/barpolar/marker/colorbar/_ticklen.py deleted file mode 100644 index a1a192520a3..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_tickmode.py b/plotly/validators/barpolar/marker/colorbar/_tickmode.py deleted file mode 100644 index be5bc460b34..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_tickprefix.py b/plotly/validators/barpolar/marker/colorbar/_tickprefix.py deleted file mode 100644 index c49e896d11c..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_ticks.py b/plotly/validators/barpolar/marker/colorbar/_ticks.py deleted file mode 100644 index 086b6f071b2..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_ticksuffix.py b/plotly/validators/barpolar/marker/colorbar/_ticksuffix.py deleted file mode 100644 index a6af28d7ed7..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_ticktext.py b/plotly/validators/barpolar/marker/colorbar/_ticktext.py deleted file mode 100644 index 7a12c93ef5a..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_ticktextsrc.py b/plotly/validators/barpolar/marker/colorbar/_ticktextsrc.py deleted file mode 100644 index 495c7c2357c..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_tickvals.py b/plotly/validators/barpolar/marker/colorbar/_tickvals.py deleted file mode 100644 index a2404ee61a7..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_tickvalssrc.py b/plotly/validators/barpolar/marker/colorbar/_tickvalssrc.py deleted file mode 100644 index ab31dd13937..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_tickwidth.py b/plotly/validators/barpolar/marker/colorbar/_tickwidth.py deleted file mode 100644 index 49dfbad15d7..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_title.py b/plotly/validators/barpolar/marker/colorbar/_title.py deleted file mode 100644 index fee2b570999..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_x.py b/plotly/validators/barpolar/marker/colorbar/_x.py deleted file mode 100644 index 9672151d650..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_x.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='x', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_xanchor.py b/plotly/validators/barpolar/marker/colorbar/_xanchor.py deleted file mode 100644 index 4151e5254a5..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_xpad.py b/plotly/validators/barpolar/marker/colorbar/_xpad.py deleted file mode 100644 index 0ad77331d3b..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_xpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xpad', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_y.py b/plotly/validators/barpolar/marker/colorbar/_y.py deleted file mode 100644 index c0076b3f5d2..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_y.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='y', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_yanchor.py b/plotly/validators/barpolar/marker/colorbar/_yanchor.py deleted file mode 100644 index 564f1743011..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/_ypad.py b/plotly/validators/barpolar/marker/colorbar/_ypad.py deleted file mode 100644 index a8683f44e6a..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/_ypad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ypad', - parent_name='barpolar.marker.colorbar', - **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/tickfont/__init__.py b/plotly/validators/barpolar/marker/colorbar/tickfont/__init__.py index 199d72e71c6..fc8a1edf6a2 100644 --- a/plotly/validators/barpolar/marker/colorbar/tickfont/__init__.py +++ b/plotly/validators/barpolar/marker/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='barpolar.marker.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='barpolar.marker.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='barpolar.marker.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/barpolar/marker/colorbar/tickfont/_color.py b/plotly/validators/barpolar/marker/colorbar/tickfont/_color.py deleted file mode 100644 index e22a9cb4bc6..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='barpolar.marker.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/tickfont/_family.py b/plotly/validators/barpolar/marker/colorbar/tickfont/_family.py deleted file mode 100644 index 1c1965bcebb..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='barpolar.marker.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/tickfont/_size.py b/plotly/validators/barpolar/marker/colorbar/tickfont/_size.py deleted file mode 100644 index 011c30477a6..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='barpolar.marker.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/tickformatstop/__init__.py b/plotly/validators/barpolar/marker/colorbar/tickformatstop/__init__.py index 3f6c06cac47..88b489e9cab 100644 --- a/plotly/validators/barpolar/marker/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/barpolar/marker/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='barpolar.marker.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='barpolar.marker.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='barpolar.marker.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='barpolar.marker.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='barpolar.marker.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/barpolar/marker/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/barpolar/marker/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 042e51a68a1..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='barpolar.marker.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/tickformatstop/_enabled.py b/plotly/validators/barpolar/marker/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index c232e642bd7..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='barpolar.marker.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/tickformatstop/_name.py b/plotly/validators/barpolar/marker/colorbar/tickformatstop/_name.py deleted file mode 100644 index bb6deaccc7f..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='barpolar.marker.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/barpolar/marker/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index c4cec7c1c99..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='barpolar.marker.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/tickformatstop/_value.py b/plotly/validators/barpolar/marker/colorbar/tickformatstop/_value.py deleted file mode 100644 index b9a38ace89a..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='barpolar.marker.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/title/__init__.py b/plotly/validators/barpolar/marker/colorbar/title/__init__.py index 33c9c145bb8..48d579b65a4 100644 --- a/plotly/validators/barpolar/marker/colorbar/title/__init__.py +++ b/plotly/validators/barpolar/marker/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='barpolar.marker.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='barpolar.marker.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='barpolar.marker.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/barpolar/marker/colorbar/title/_font.py b/plotly/validators/barpolar/marker/colorbar/title/_font.py deleted file mode 100644 index fa3c14d2ffe..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='barpolar.marker.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/title/_side.py b/plotly/validators/barpolar/marker/colorbar/title/_side.py deleted file mode 100644 index 23c0c45939e..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='barpolar.marker.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/title/_text.py b/plotly/validators/barpolar/marker/colorbar/title/_text.py deleted file mode 100644 index 94cb18ac582..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='barpolar.marker.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/title/font/__init__.py b/plotly/validators/barpolar/marker/colorbar/title/font/__init__.py index 199d72e71c6..31018ad478d 100644 --- a/plotly/validators/barpolar/marker/colorbar/title/font/__init__.py +++ b/plotly/validators/barpolar/marker/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='barpolar.marker.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='barpolar.marker.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='barpolar.marker.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/barpolar/marker/colorbar/title/font/_color.py b/plotly/validators/barpolar/marker/colorbar/title/font/_color.py deleted file mode 100644 index e2318e742bc..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='barpolar.marker.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/title/font/_family.py b/plotly/validators/barpolar/marker/colorbar/title/font/_family.py deleted file mode 100644 index a89cfde5d6f..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='barpolar.marker.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/colorbar/title/font/_size.py b/plotly/validators/barpolar/marker/colorbar/title/font/_size.py deleted file mode 100644 index 1b26faa658b..00000000000 --- a/plotly/validators/barpolar/marker/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='barpolar.marker.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/line/__init__.py b/plotly/validators/barpolar/marker/line/__init__.py index c031ca61ce2..84fb417e06c 100644 --- a/plotly/validators/barpolar/marker/line/__init__.py +++ b/plotly/validators/barpolar/marker/line/__init__.py @@ -1,11 +1,226 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._reversescale import ReversescaleValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='widthsrc', + parent_name='barpolar.marker.line', + **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='barpolar.marker.line', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='barpolar.marker.line', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='barpolar.marker.line', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='barpolar.marker.line', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='barpolar.marker.line', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'barpolar.marker.line.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='barpolar.marker.line', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='barpolar.marker.line', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='barpolar.marker.line', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='cauto', + parent_name='barpolar.marker.line', + **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='barpolar.marker.line', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/barpolar/marker/line/_autocolorscale.py b/plotly/validators/barpolar/marker/line/_autocolorscale.py deleted file mode 100644 index 299afc7ed03..00000000000 --- a/plotly/validators/barpolar/marker/line/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='barpolar.marker.line', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/line/_cauto.py b/plotly/validators/barpolar/marker/line/_cauto.py deleted file mode 100644 index 430298e8485..00000000000 --- a/plotly/validators/barpolar/marker/line/_cauto.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='cauto', - parent_name='barpolar.marker.line', - **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/line/_cmax.py b/plotly/validators/barpolar/marker/line/_cmax.py deleted file mode 100644 index e870cea13f3..00000000000 --- a/plotly/validators/barpolar/marker/line/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='barpolar.marker.line', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/line/_cmid.py b/plotly/validators/barpolar/marker/line/_cmid.py deleted file mode 100644 index b43d7b2c5a3..00000000000 --- a/plotly/validators/barpolar/marker/line/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='barpolar.marker.line', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/line/_cmin.py b/plotly/validators/barpolar/marker/line/_cmin.py deleted file mode 100644 index 9513fa1c347..00000000000 --- a/plotly/validators/barpolar/marker/line/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='barpolar.marker.line', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/line/_color.py b/plotly/validators/barpolar/marker/line/_color.py deleted file mode 100644 index 3c0172684a7..00000000000 --- a/plotly/validators/barpolar/marker/line/_color.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='barpolar.marker.line', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'barpolar.marker.line.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/line/_colorscale.py b/plotly/validators/barpolar/marker/line/_colorscale.py deleted file mode 100644 index d0e4a2165d3..00000000000 --- a/plotly/validators/barpolar/marker/line/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='barpolar.marker.line', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/line/_colorsrc.py b/plotly/validators/barpolar/marker/line/_colorsrc.py deleted file mode 100644 index 43531b120f8..00000000000 --- a/plotly/validators/barpolar/marker/line/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='barpolar.marker.line', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/line/_reversescale.py b/plotly/validators/barpolar/marker/line/_reversescale.py deleted file mode 100644 index 955e31f63ce..00000000000 --- a/plotly/validators/barpolar/marker/line/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='barpolar.marker.line', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/line/_width.py b/plotly/validators/barpolar/marker/line/_width.py deleted file mode 100644 index 0dbbe6c4272..00000000000 --- a/plotly/validators/barpolar/marker/line/_width.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='barpolar.marker.line', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/marker/line/_widthsrc.py b/plotly/validators/barpolar/marker/line/_widthsrc.py deleted file mode 100644 index 3fc6d614eb7..00000000000 --- a/plotly/validators/barpolar/marker/line/_widthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='widthsrc', - parent_name='barpolar.marker.line', - **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/selected/__init__.py b/plotly/validators/barpolar/selected/__init__.py index f1a1ef3742f..63f3b4e21b7 100644 --- a/plotly/validators/barpolar/selected/__init__.py +++ b/plotly/validators/barpolar/selected/__init__.py @@ -1,2 +1,49 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='barpolar.selected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of selected points. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='barpolar.selected', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. +""" + ), + **kwargs + ) diff --git a/plotly/validators/barpolar/selected/_marker.py b/plotly/validators/barpolar/selected/_marker.py deleted file mode 100644 index a789193d0ef..00000000000 --- a/plotly/validators/barpolar/selected/_marker.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='barpolar.selected', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/selected/_textfont.py b/plotly/validators/barpolar/selected/_textfont.py deleted file mode 100644 index d413cd9934d..00000000000 --- a/plotly/validators/barpolar/selected/_textfont.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='barpolar.selected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/selected/marker/__init__.py b/plotly/validators/barpolar/selected/marker/__init__.py index 990c554a22a..ae94973f1bf 100644 --- a/plotly/validators/barpolar/selected/marker/__init__.py +++ b/plotly/validators/barpolar/selected/marker/__init__.py @@ -1,2 +1,42 @@ -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='barpolar.selected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='barpolar.selected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/barpolar/selected/marker/_color.py b/plotly/validators/barpolar/selected/marker/_color.py deleted file mode 100644 index 53e9317993f..00000000000 --- a/plotly/validators/barpolar/selected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='barpolar.selected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/selected/marker/_opacity.py b/plotly/validators/barpolar/selected/marker/_opacity.py deleted file mode 100644 index 164a059876c..00000000000 --- a/plotly/validators/barpolar/selected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='barpolar.selected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/selected/textfont/__init__.py b/plotly/validators/barpolar/selected/textfont/__init__.py index 74135b3f315..4aec9f7c185 100644 --- a/plotly/validators/barpolar/selected/textfont/__init__.py +++ b/plotly/validators/barpolar/selected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='barpolar.selected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/barpolar/selected/textfont/_color.py b/plotly/validators/barpolar/selected/textfont/_color.py deleted file mode 100644 index 4d947afea13..00000000000 --- a/plotly/validators/barpolar/selected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='barpolar.selected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/stream/__init__.py b/plotly/validators/barpolar/stream/__init__.py index 2f4f2047594..4a49d4b4876 100644 --- a/plotly/validators/barpolar/stream/__init__.py +++ b/plotly/validators/barpolar/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='barpolar.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='barpolar.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/barpolar/stream/_maxpoints.py b/plotly/validators/barpolar/stream/_maxpoints.py deleted file mode 100644 index b68dd60bd41..00000000000 --- a/plotly/validators/barpolar/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='barpolar.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/barpolar/stream/_token.py b/plotly/validators/barpolar/stream/_token.py deleted file mode 100644 index 7efad616757..00000000000 --- a/plotly/validators/barpolar/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='barpolar.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/barpolar/unselected/__init__.py b/plotly/validators/barpolar/unselected/__init__.py index f1a1ef3742f..a7a03b35ac2 100644 --- a/plotly/validators/barpolar/unselected/__init__.py +++ b/plotly/validators/barpolar/unselected/__init__.py @@ -1,2 +1,55 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='barpolar.unselected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='barpolar.unselected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of unselected points, + applied only when a selection exists. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) diff --git a/plotly/validators/barpolar/unselected/_marker.py b/plotly/validators/barpolar/unselected/_marker.py deleted file mode 100644 index df16cb94356..00000000000 --- a/plotly/validators/barpolar/unselected/_marker.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='barpolar.unselected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of unselected points, - applied only when a selection exists. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/unselected/_textfont.py b/plotly/validators/barpolar/unselected/_textfont.py deleted file mode 100644 index ce494d0d57a..00000000000 --- a/plotly/validators/barpolar/unselected/_textfont.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='barpolar.unselected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/barpolar/unselected/marker/__init__.py b/plotly/validators/barpolar/unselected/marker/__init__.py index 990c554a22a..7525e4b2743 100644 --- a/plotly/validators/barpolar/unselected/marker/__init__.py +++ b/plotly/validators/barpolar/unselected/marker/__init__.py @@ -1,2 +1,42 @@ -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='barpolar.unselected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='barpolar.unselected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/barpolar/unselected/marker/_color.py b/plotly/validators/barpolar/unselected/marker/_color.py deleted file mode 100644 index 8a87001d766..00000000000 --- a/plotly/validators/barpolar/unselected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='barpolar.unselected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/unselected/marker/_opacity.py b/plotly/validators/barpolar/unselected/marker/_opacity.py deleted file mode 100644 index 264d9f3c8a9..00000000000 --- a/plotly/validators/barpolar/unselected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='barpolar.unselected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/barpolar/unselected/textfont/__init__.py b/plotly/validators/barpolar/unselected/textfont/__init__.py index 74135b3f315..aa0ebbb92bc 100644 --- a/plotly/validators/barpolar/unselected/textfont/__init__.py +++ b/plotly/validators/barpolar/unselected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='barpolar.unselected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/barpolar/unselected/textfont/_color.py b/plotly/validators/barpolar/unselected/textfont/_color.py deleted file mode 100644 index f285ef15768..00000000000 --- a/plotly/validators/barpolar/unselected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='barpolar.unselected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/__init__.py b/plotly/validators/box/__init__.py index 40f8f630ac0..a56fbe5ff94 100644 --- a/plotly/validators/box/__init__.py +++ b/plotly/validators/box/__init__.py @@ -1,47 +1,847 @@ -from ._ysrc import YsrcValidator -from ._ycalendar import YcalendarValidator -from ._yaxis import YAxisValidator -from ._y0 import Y0Validator -from ._y import YValidator -from ._xsrc import XsrcValidator -from ._xcalendar import XcalendarValidator -from ._xaxis import XAxisValidator -from ._x0 import X0Validator -from ._x import XValidator -from ._width import WidthValidator -from ._whiskerwidth import WhiskerwidthValidator -from ._visible import VisibleValidator -from ._unselected import UnselectedValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._selected import SelectedValidator -from ._pointpos import PointposValidator -from ._orientation import OrientationValidator -from ._opacity import OpacityValidator -from ._offsetgroup import OffsetgroupValidator -from ._notchwidth import NotchwidthValidator -from ._notched import NotchedValidator -from ._name import NameValidator -from ._marker import MarkerValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._jitter import JitterValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hoveron import HoveronValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._fillcolor import FillcolorValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._boxpoints import BoxpointsValidator -from ._boxmean import BoxmeanValidator -from ._alignmentgroup import AlignmentgroupValidator + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='box', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='ycalendar', parent_name='box', **kwargs): + super(YcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='yaxis', parent_name='box', **kwargs): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Y0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='y0', parent_name='box', **kwargs): + super(Y0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='box', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='box', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='xcalendar', parent_name='box', **kwargs): + super(XcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='xaxis', parent_name='box', **kwargs): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class X0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='x0', parent_name='box', **kwargs): + super(X0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='box', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='width', parent_name='box', **kwargs): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WhiskerwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='whiskerwidth', parent_name='box', **kwargs + ): + super(WhiskerwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='box', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='unselected', parent_name='box', **kwargs): + super(UnselectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Unselected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.box.unselected.Marker + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='uirevision', parent_name='box', **kwargs): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='box', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='textsrc', parent_name='box', **kwargs): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='box', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='box', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='showlegend', parent_name='box', **kwargs): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='box', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='selected', parent_name='box', **kwargs): + super(SelectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Selected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.box.selected.Marker instance + or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PointposValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='pointpos', parent_name='box', **kwargs): + super(PointposValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 2), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OrientationValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='orientation', parent_name='box', **kwargs): + super(OrientationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['v', 'h']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='opacity', parent_name='box', **kwargs): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OffsetgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='offsetgroup', parent_name='box', **kwargs): + super(OffsetgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NotchwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='notchwidth', parent_name='box', **kwargs): + super(NotchwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 0.5), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NotchedValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='notched', parent_name='box', **kwargs): + super(NotchedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='box', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='marker', parent_name='box', **kwargs): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + line + plotly.graph_objs.box.marker.Line instance or + dict with compatible properties + opacity + Sets the marker opacity. + outliercolor + Sets the color of the outlier sample points. + size + Sets the marker size (in px). + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='line', parent_name='box', **kwargs): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the color of line bounding the box(es). + width + Sets the width (in px) of line bounding the + box(es). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='legendgroup', parent_name='box', **kwargs): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class JitterValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='jitter', parent_name='box', **kwargs): + super(JitterValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='box', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='box', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='box', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='hovertext', parent_name='box', **kwargs): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoveronValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__(self, plotly_name='hoveron', parent_name='box', **kwargs): + super(HoveronValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + flags=kwargs.pop('flags', ['boxes', 'points']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='hoverlabel', parent_name='box', **kwargs): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='box', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__(self, plotly_name='hoverinfo', parent_name='box', **kwargs): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__(self, plotly_name='fillcolor', parent_name='box', **kwargs): + super(FillcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='box', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='customdata', parent_name='box', **kwargs): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BoxpointsValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='boxpoints', parent_name='box', **kwargs): + super(BoxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['all', 'outliers', 'suspectedoutliers', False] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BoxmeanValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='boxmean', parent_name='box', **kwargs): + super(BoxmeanValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', [True, 'sd', False]), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AlignmentgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='alignmentgroup', parent_name='box', **kwargs + ): + super(AlignmentgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/box/_alignmentgroup.py b/plotly/validators/box/_alignmentgroup.py deleted file mode 100644 index 98e91cb6ea0..00000000000 --- a/plotly/validators/box/_alignmentgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AlignmentgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='alignmentgroup', parent_name='box', **kwargs - ): - super(AlignmentgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_boxmean.py b/plotly/validators/box/_boxmean.py deleted file mode 100644 index 3ab8faa3de0..00000000000 --- a/plotly/validators/box/_boxmean.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class BoxmeanValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='boxmean', parent_name='box', **kwargs): - super(BoxmeanValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', [True, 'sd', False]), - **kwargs - ) diff --git a/plotly/validators/box/_boxpoints.py b/plotly/validators/box/_boxpoints.py deleted file mode 100644 index ce83a1865e1..00000000000 --- a/plotly/validators/box/_boxpoints.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BoxpointsValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='boxpoints', parent_name='box', **kwargs): - super(BoxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['all', 'outliers', 'suspectedoutliers', False] - ), - **kwargs - ) diff --git a/plotly/validators/box/_customdata.py b/plotly/validators/box/_customdata.py deleted file mode 100644 index 061c077efb5..00000000000 --- a/plotly/validators/box/_customdata.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='customdata', parent_name='box', **kwargs): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/box/_customdatasrc.py b/plotly/validators/box/_customdatasrc.py deleted file mode 100644 index ab7bff5d778..00000000000 --- a/plotly/validators/box/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='box', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_fillcolor.py b/plotly/validators/box/_fillcolor.py deleted file mode 100644 index 4c6b48810e1..00000000000 --- a/plotly/validators/box/_fillcolor.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__(self, plotly_name='fillcolor', parent_name='box', **kwargs): - super(FillcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/_hoverinfo.py b/plotly/validators/box/_hoverinfo.py deleted file mode 100644 index f1d710b1936..00000000000 --- a/plotly/validators/box/_hoverinfo.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__(self, plotly_name='hoverinfo', parent_name='box', **kwargs): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_hoverinfosrc.py b/plotly/validators/box/_hoverinfosrc.py deleted file mode 100644 index 82f455e6939..00000000000 --- a/plotly/validators/box/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='box', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_hoverlabel.py b/plotly/validators/box/_hoverlabel.py deleted file mode 100644 index 3d0878a0865..00000000000 --- a/plotly/validators/box/_hoverlabel.py +++ /dev/null @@ -1,42 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='hoverlabel', parent_name='box', **kwargs): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/box/_hoveron.py b/plotly/validators/box/_hoveron.py deleted file mode 100644 index 00dd59e1b95..00000000000 --- a/plotly/validators/box/_hoveron.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoveronValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__(self, plotly_name='hoveron', parent_name='box', **kwargs): - super(HoveronValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - flags=kwargs.pop('flags', ['boxes', 'points']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_hovertext.py b/plotly/validators/box/_hovertext.py deleted file mode 100644 index 98a093b7bb5..00000000000 --- a/plotly/validators/box/_hovertext.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='hovertext', parent_name='box', **kwargs): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_hovertextsrc.py b/plotly/validators/box/_hovertextsrc.py deleted file mode 100644 index 2957d1f7282..00000000000 --- a/plotly/validators/box/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='box', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_ids.py b/plotly/validators/box/_ids.py deleted file mode 100644 index b8204efd5fc..00000000000 --- a/plotly/validators/box/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='box', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/box/_idssrc.py b/plotly/validators/box/_idssrc.py deleted file mode 100644 index 37130a05a2b..00000000000 --- a/plotly/validators/box/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='box', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_jitter.py b/plotly/validators/box/_jitter.py deleted file mode 100644 index 04a72cfb0fd..00000000000 --- a/plotly/validators/box/_jitter.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class JitterValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='jitter', parent_name='box', **kwargs): - super(JitterValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/_legendgroup.py b/plotly/validators/box/_legendgroup.py deleted file mode 100644 index 546b6f22e1e..00000000000 --- a/plotly/validators/box/_legendgroup.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='legendgroup', parent_name='box', **kwargs): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_line.py b/plotly/validators/box/_line.py deleted file mode 100644 index fac93edce6e..00000000000 --- a/plotly/validators/box/_line.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='line', parent_name='box', **kwargs): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the color of line bounding the box(es). - width - Sets the width (in px) of line bounding the - box(es). -""" - ), - **kwargs - ) diff --git a/plotly/validators/box/_marker.py b/plotly/validators/box/_marker.py deleted file mode 100644 index aa5fb367748..00000000000 --- a/plotly/validators/box/_marker.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='marker', parent_name='box', **kwargs): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - line - plotly.graph_objs.box.marker.Line instance or - dict with compatible properties - opacity - Sets the marker opacity. - outliercolor - Sets the color of the outlier sample points. - size - Sets the marker size (in px). - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. -""" - ), - **kwargs - ) diff --git a/plotly/validators/box/_name.py b/plotly/validators/box/_name.py deleted file mode 100644 index 148fe156585..00000000000 --- a/plotly/validators/box/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='box', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_notched.py b/plotly/validators/box/_notched.py deleted file mode 100644 index 07a7ba10b92..00000000000 --- a/plotly/validators/box/_notched.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NotchedValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='notched', parent_name='box', **kwargs): - super(NotchedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/_notchwidth.py b/plotly/validators/box/_notchwidth.py deleted file mode 100644 index f0d0239aba5..00000000000 --- a/plotly/validators/box/_notchwidth.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NotchwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='notchwidth', parent_name='box', **kwargs): - super(NotchwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 0.5), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/_offsetgroup.py b/plotly/validators/box/_offsetgroup.py deleted file mode 100644 index af5fcc0c761..00000000000 --- a/plotly/validators/box/_offsetgroup.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class OffsetgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='offsetgroup', parent_name='box', **kwargs): - super(OffsetgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_opacity.py b/plotly/validators/box/_opacity.py deleted file mode 100644 index f1c9f6d05a7..00000000000 --- a/plotly/validators/box/_opacity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='opacity', parent_name='box', **kwargs): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/_orientation.py b/plotly/validators/box/_orientation.py deleted file mode 100644 index c38ada9dd64..00000000000 --- a/plotly/validators/box/_orientation.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class OrientationValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='orientation', parent_name='box', **kwargs): - super(OrientationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['v', 'h']), - **kwargs - ) diff --git a/plotly/validators/box/_pointpos.py b/plotly/validators/box/_pointpos.py deleted file mode 100644 index 0b8a8fb5834..00000000000 --- a/plotly/validators/box/_pointpos.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class PointposValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='pointpos', parent_name='box', **kwargs): - super(PointposValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 2), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/_selected.py b/plotly/validators/box/_selected.py deleted file mode 100644 index 85257bd41c0..00000000000 --- a/plotly/validators/box/_selected.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='selected', parent_name='box', **kwargs): - super(SelectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Selected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.box.selected.Marker instance - or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/box/_selectedpoints.py b/plotly/validators/box/_selectedpoints.py deleted file mode 100644 index 397945168e0..00000000000 --- a/plotly/validators/box/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='box', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_showlegend.py b/plotly/validators/box/_showlegend.py deleted file mode 100644 index 174600170e9..00000000000 --- a/plotly/validators/box/_showlegend.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='showlegend', parent_name='box', **kwargs): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_stream.py b/plotly/validators/box/_stream.py deleted file mode 100644 index d904e87e21b..00000000000 --- a/plotly/validators/box/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='box', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/box/_text.py b/plotly/validators/box/_text.py deleted file mode 100644 index ab049bbe162..00000000000 --- a/plotly/validators/box/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='box', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_textsrc.py b/plotly/validators/box/_textsrc.py deleted file mode 100644 index fbb11c39499..00000000000 --- a/plotly/validators/box/_textsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='textsrc', parent_name='box', **kwargs): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_uid.py b/plotly/validators/box/_uid.py deleted file mode 100644 index 4643c9c0032..00000000000 --- a/plotly/validators/box/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='box', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_uirevision.py b/plotly/validators/box/_uirevision.py deleted file mode 100644 index b5c0187e980..00000000000 --- a/plotly/validators/box/_uirevision.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='uirevision', parent_name='box', **kwargs): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_unselected.py b/plotly/validators/box/_unselected.py deleted file mode 100644 index 072e83616cb..00000000000 --- a/plotly/validators/box/_unselected.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='unselected', parent_name='box', **kwargs): - super(UnselectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Unselected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.box.unselected.Marker - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/box/_visible.py b/plotly/validators/box/_visible.py deleted file mode 100644 index ade0321c6d2..00000000000 --- a/plotly/validators/box/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='box', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/box/_whiskerwidth.py b/plotly/validators/box/_whiskerwidth.py deleted file mode 100644 index d29fc4fbfca..00000000000 --- a/plotly/validators/box/_whiskerwidth.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WhiskerwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='whiskerwidth', parent_name='box', **kwargs - ): - super(WhiskerwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/_width.py b/plotly/validators/box/_width.py deleted file mode 100644 index 4a56dd09312..00000000000 --- a/plotly/validators/box/_width.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='width', parent_name='box', **kwargs): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_x.py b/plotly/validators/box/_x.py deleted file mode 100644 index 75a60862b35..00000000000 --- a/plotly/validators/box/_x.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='box', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/box/_x0.py b/plotly/validators/box/_x0.py deleted file mode 100644 index 21677d92261..00000000000 --- a/plotly/validators/box/_x0.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class X0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='x0', parent_name='box', **kwargs): - super(X0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_xaxis.py b/plotly/validators/box/_xaxis.py deleted file mode 100644 index f62535d48ff..00000000000 --- a/plotly/validators/box/_xaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='xaxis', parent_name='box', **kwargs): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_xcalendar.py b/plotly/validators/box/_xcalendar.py deleted file mode 100644 index 738ae9969ca..00000000000 --- a/plotly/validators/box/_xcalendar.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='xcalendar', parent_name='box', **kwargs): - super(XcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/box/_xsrc.py b/plotly/validators/box/_xsrc.py deleted file mode 100644 index 2abf9b9af98..00000000000 --- a/plotly/validators/box/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='box', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_y.py b/plotly/validators/box/_y.py deleted file mode 100644 index ebda5904e07..00000000000 --- a/plotly/validators/box/_y.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='box', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/box/_y0.py b/plotly/validators/box/_y0.py deleted file mode 100644 index dcc972ab65f..00000000000 --- a/plotly/validators/box/_y0.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class Y0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='y0', parent_name='box', **kwargs): - super(Y0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_yaxis.py b/plotly/validators/box/_yaxis.py deleted file mode 100644 index 6aced78fff3..00000000000 --- a/plotly/validators/box/_yaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='yaxis', parent_name='box', **kwargs): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/_ycalendar.py b/plotly/validators/box/_ycalendar.py deleted file mode 100644 index f2b297eeee2..00000000000 --- a/plotly/validators/box/_ycalendar.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='ycalendar', parent_name='box', **kwargs): - super(YcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/box/_ysrc.py b/plotly/validators/box/_ysrc.py deleted file mode 100644 index a036062171b..00000000000 --- a/plotly/validators/box/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='box', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/hoverlabel/__init__.py b/plotly/validators/box/hoverlabel/__init__.py index 856f769ba33..4e7f4c86185 100644 --- a/plotly/validators/box/hoverlabel/__init__.py +++ b/plotly/validators/box/hoverlabel/__init__.py @@ -1,7 +1,164 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='box.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='namelength', parent_name='box.hoverlabel', **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='box.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='box.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='box.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='bgcolorsrc', parent_name='box.hoverlabel', **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='box.hoverlabel', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/box/hoverlabel/_bgcolor.py b/plotly/validators/box/hoverlabel/_bgcolor.py deleted file mode 100644 index 7bab1c6679f..00000000000 --- a/plotly/validators/box/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='box.hoverlabel', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/hoverlabel/_bgcolorsrc.py b/plotly/validators/box/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index e4b9312d380..00000000000 --- a/plotly/validators/box/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='bgcolorsrc', parent_name='box.hoverlabel', **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/hoverlabel/_bordercolor.py b/plotly/validators/box/hoverlabel/_bordercolor.py deleted file mode 100644 index edbf57e0003..00000000000 --- a/plotly/validators/box/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='box.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/hoverlabel/_bordercolorsrc.py b/plotly/validators/box/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index aedbc2374bb..00000000000 --- a/plotly/validators/box/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='box.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/hoverlabel/_font.py b/plotly/validators/box/hoverlabel/_font.py deleted file mode 100644 index d0d86444afa..00000000000 --- a/plotly/validators/box/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='box.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/box/hoverlabel/_namelength.py b/plotly/validators/box/hoverlabel/_namelength.py deleted file mode 100644 index abe7713624e..00000000000 --- a/plotly/validators/box/hoverlabel/_namelength.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='namelength', parent_name='box.hoverlabel', **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/hoverlabel/_namelengthsrc.py b/plotly/validators/box/hoverlabel/_namelengthsrc.py deleted file mode 100644 index b3dfe48cd86..00000000000 --- a/plotly/validators/box/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='box.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/hoverlabel/font/__init__.py b/plotly/validators/box/hoverlabel/font/__init__.py index 1d2c591d1e5..3c26f207a75 100644 --- a/plotly/validators/box/hoverlabel/font/__init__.py +++ b/plotly/validators/box/hoverlabel/font/__init__.py @@ -1,6 +1,120 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='box.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='box.hoverlabel.font', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='box.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='box.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='box.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='box.hoverlabel.font', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/box/hoverlabel/font/_color.py b/plotly/validators/box/hoverlabel/font/_color.py deleted file mode 100644 index 10897542ae2..00000000000 --- a/plotly/validators/box/hoverlabel/font/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='box.hoverlabel.font', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/hoverlabel/font/_colorsrc.py b/plotly/validators/box/hoverlabel/font/_colorsrc.py deleted file mode 100644 index f4a444bc429..00000000000 --- a/plotly/validators/box/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='box.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/hoverlabel/font/_family.py b/plotly/validators/box/hoverlabel/font/_family.py deleted file mode 100644 index 9a313ff76da..00000000000 --- a/plotly/validators/box/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='box.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/box/hoverlabel/font/_familysrc.py b/plotly/validators/box/hoverlabel/font/_familysrc.py deleted file mode 100644 index 034e716de6a..00000000000 --- a/plotly/validators/box/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='box.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/hoverlabel/font/_size.py b/plotly/validators/box/hoverlabel/font/_size.py deleted file mode 100644 index 69210c2f933..00000000000 --- a/plotly/validators/box/hoverlabel/font/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='box.hoverlabel.font', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/hoverlabel/font/_sizesrc.py b/plotly/validators/box/hoverlabel/font/_sizesrc.py deleted file mode 100644 index f439940af20..00000000000 --- a/plotly/validators/box/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='box.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/line/__init__.py b/plotly/validators/box/line/__init__.py index 7806a9a1cdc..98e0fe7b7e3 100644 --- a/plotly/validators/box/line/__init__.py +++ b/plotly/validators/box/line/__init__.py @@ -1,2 +1,31 @@ -from ._width import WidthValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='width', parent_name='box.line', **kwargs): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__(self, plotly_name='color', parent_name='box.line', **kwargs): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/box/line/_color.py b/plotly/validators/box/line/_color.py deleted file mode 100644 index 6a2ae38d630..00000000000 --- a/plotly/validators/box/line/_color.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__(self, plotly_name='color', parent_name='box.line', **kwargs): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/line/_width.py b/plotly/validators/box/line/_width.py deleted file mode 100644 index d2408f9582c..00000000000 --- a/plotly/validators/box/line/_width.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='width', parent_name='box.line', **kwargs): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/marker/__init__.py b/plotly/validators/box/marker/__init__.py index 0bc6d87d6bc..77741b88d3a 100644 --- a/plotly/validators/box/marker/__init__.py +++ b/plotly/validators/box/marker/__init__.py @@ -1,6 +1,189 @@ -from ._symbol import SymbolValidator -from ._size import SizeValidator -from ._outliercolor import OutliercolorValidator -from ._opacity import OpacityValidator -from ._line import LineValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='symbol', parent_name='box.marker', **kwargs + ): + super(SymbolValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, + 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', + 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', + 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', + 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', + 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, + 'star-triangle-down-open', 220, 'star-triangle-down-dot', + 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', + 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, + 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, + 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, + 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='size', parent_name='box.marker', **kwargs): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutliercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='outliercolor', parent_name='box.marker', **kwargs + ): + super(OutliercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='box.marker', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='line', parent_name='box.marker', **kwargs): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + outliercolor + Sets the border line color of the outlier + sample points. Defaults to marker.color + outlierwidth + Sets the border line width (in px) of the + outlier sample points. + width + Sets the width (in px) of the lines bounding + the marker points. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='box.marker', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/box/marker/_color.py b/plotly/validators/box/marker/_color.py deleted file mode 100644 index 34f05bf50b5..00000000000 --- a/plotly/validators/box/marker/_color.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='box.marker', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/marker/_line.py b/plotly/validators/box/marker/_line.py deleted file mode 100644 index 7b38d0d1d06..00000000000 --- a/plotly/validators/box/marker/_line.py +++ /dev/null @@ -1,32 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='line', parent_name='box.marker', **kwargs): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - outliercolor - Sets the border line color of the outlier - sample points. Defaults to marker.color - outlierwidth - Sets the border line width (in px) of the - outlier sample points. - width - Sets the width (in px) of the lines bounding - the marker points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/box/marker/_opacity.py b/plotly/validators/box/marker/_opacity.py deleted file mode 100644 index d79fb6683d0..00000000000 --- a/plotly/validators/box/marker/_opacity.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='box.marker', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/marker/_outliercolor.py b/plotly/validators/box/marker/_outliercolor.py deleted file mode 100644 index f7c0de3f3ed..00000000000 --- a/plotly/validators/box/marker/_outliercolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutliercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='outliercolor', parent_name='box.marker', **kwargs - ): - super(OutliercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/marker/_size.py b/plotly/validators/box/marker/_size.py deleted file mode 100644 index b9aef2aca1b..00000000000 --- a/plotly/validators/box/marker/_size.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='size', parent_name='box.marker', **kwargs): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/marker/_symbol.py b/plotly/validators/box/marker/_symbol.py deleted file mode 100644 index 460621b089c..00000000000 --- a/plotly/validators/box/marker/_symbol.py +++ /dev/null @@ -1,78 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='symbol', parent_name='box.marker', **kwargs - ): - super(SymbolValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, - 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', - 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', - 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', - 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', - 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, - 'star-triangle-down-open', 220, 'star-triangle-down-dot', - 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', - 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, - 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, - 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, - 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' - ] - ), - **kwargs - ) diff --git a/plotly/validators/box/marker/line/__init__.py b/plotly/validators/box/marker/line/__init__.py index 250468b9f87..df0e8ddd110 100644 --- a/plotly/validators/box/marker/line/__init__.py +++ b/plotly/validators/box/marker/line/__init__.py @@ -1,4 +1,80 @@ -from ._width import WidthValidator -from ._outlierwidth import OutlierwidthValidator -from ._outliercolor import OutliercolorValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='box.marker.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlierwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlierwidth', + parent_name='box.marker.line', + **kwargs + ): + super(OutlierwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutliercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outliercolor', + parent_name='box.marker.line', + **kwargs + ): + super(OutliercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='box.marker.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/box/marker/line/_color.py b/plotly/validators/box/marker/line/_color.py deleted file mode 100644 index fc1c6012120..00000000000 --- a/plotly/validators/box/marker/line/_color.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='box.marker.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/marker/line/_outliercolor.py b/plotly/validators/box/marker/line/_outliercolor.py deleted file mode 100644 index 764e4d62d45..00000000000 --- a/plotly/validators/box/marker/line/_outliercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutliercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outliercolor', - parent_name='box.marker.line', - **kwargs - ): - super(OutliercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/marker/line/_outlierwidth.py b/plotly/validators/box/marker/line/_outlierwidth.py deleted file mode 100644 index 5c891cfd147..00000000000 --- a/plotly/validators/box/marker/line/_outlierwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlierwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlierwidth', - parent_name='box.marker.line', - **kwargs - ): - super(OutlierwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/marker/line/_width.py b/plotly/validators/box/marker/line/_width.py deleted file mode 100644 index b4caf16d086..00000000000 --- a/plotly/validators/box/marker/line/_width.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='box.marker.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/selected/__init__.py b/plotly/validators/box/selected/__init__.py index 3604b0284fc..76fe511a83b 100644 --- a/plotly/validators/box/selected/__init__.py +++ b/plotly/validators/box/selected/__init__.py @@ -1 +1,26 @@ -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='box.selected', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. +""" + ), + **kwargs + ) diff --git a/plotly/validators/box/selected/_marker.py b/plotly/validators/box/selected/_marker.py deleted file mode 100644 index e5df0b61710..00000000000 --- a/plotly/validators/box/selected/_marker.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='box.selected', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/box/selected/marker/__init__.py b/plotly/validators/box/selected/marker/__init__.py index ed9a9070947..533e44b48f6 100644 --- a/plotly/validators/box/selected/marker/__init__.py +++ b/plotly/validators/box/selected/marker/__init__.py @@ -1,3 +1,57 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='box.selected.marker', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='box.selected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='box.selected.marker', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/box/selected/marker/_color.py b/plotly/validators/box/selected/marker/_color.py deleted file mode 100644 index fd4bb6ecc2c..00000000000 --- a/plotly/validators/box/selected/marker/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='box.selected.marker', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/selected/marker/_opacity.py b/plotly/validators/box/selected/marker/_opacity.py deleted file mode 100644 index cd86f43ab8a..00000000000 --- a/plotly/validators/box/selected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='box.selected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/selected/marker/_size.py b/plotly/validators/box/selected/marker/_size.py deleted file mode 100644 index 3318ec65a4e..00000000000 --- a/plotly/validators/box/selected/marker/_size.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='box.selected.marker', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/stream/__init__.py b/plotly/validators/box/stream/__init__.py index 2f4f2047594..fc1d17c02f5 100644 --- a/plotly/validators/box/stream/__init__.py +++ b/plotly/validators/box/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='box.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='box.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/box/stream/_maxpoints.py b/plotly/validators/box/stream/_maxpoints.py deleted file mode 100644 index 7766d330c9a..00000000000 --- a/plotly/validators/box/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='box.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/box/stream/_token.py b/plotly/validators/box/stream/_token.py deleted file mode 100644 index 15df10590e9..00000000000 --- a/plotly/validators/box/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='box.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/box/unselected/__init__.py b/plotly/validators/box/unselected/__init__.py index 3604b0284fc..dc23d0346d3 100644 --- a/plotly/validators/box/unselected/__init__.py +++ b/plotly/validators/box/unselected/__init__.py @@ -1 +1,29 @@ -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='box.unselected', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of unselected points, + applied only when a selection exists. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) diff --git a/plotly/validators/box/unselected/_marker.py b/plotly/validators/box/unselected/_marker.py deleted file mode 100644 index 9eed6f7f361..00000000000 --- a/plotly/validators/box/unselected/_marker.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='box.unselected', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of unselected points, - applied only when a selection exists. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/box/unselected/marker/__init__.py b/plotly/validators/box/unselected/marker/__init__.py index ed9a9070947..95e8ff5260c 100644 --- a/plotly/validators/box/unselected/marker/__init__.py +++ b/plotly/validators/box/unselected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='box.unselected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='box.unselected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='box.unselected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/box/unselected/marker/_color.py b/plotly/validators/box/unselected/marker/_color.py deleted file mode 100644 index 053d542ba57..00000000000 --- a/plotly/validators/box/unselected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='box.unselected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/unselected/marker/_opacity.py b/plotly/validators/box/unselected/marker/_opacity.py deleted file mode 100644 index 9f944df16d2..00000000000 --- a/plotly/validators/box/unselected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='box.unselected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/box/unselected/marker/_size.py b/plotly/validators/box/unselected/marker/_size.py deleted file mode 100644 index 11dc4fb6868..00000000000 --- a/plotly/validators/box/unselected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='box.unselected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/candlestick/__init__.py b/plotly/validators/candlestick/__init__.py index 2be68a0c136..33ec2413b37 100644 --- a/plotly/validators/candlestick/__init__.py +++ b/plotly/validators/candlestick/__init__.py @@ -1,37 +1,721 @@ -from ._yaxis import YAxisValidator -from ._xsrc import XsrcValidator -from ._xcalendar import XcalendarValidator -from ._xaxis import XAxisValidator -from ._x import XValidator -from ._whiskerwidth import WhiskerwidthValidator -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._opensrc import OpensrcValidator -from ._open import OpenValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._lowsrc import LowsrcValidator -from ._low import LowValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._increasing import IncreasingValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._highsrc import HighsrcValidator -from ._high import HighValidator -from ._decreasing import DecreasingValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._closesrc import ClosesrcValidator -from ._close import CloseValidator + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='yaxis', parent_name='candlestick', **kwargs + ): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='xsrc', parent_name='candlestick', **kwargs + ): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xcalendar', parent_name='candlestick', **kwargs + ): + super(XcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='xaxis', parent_name='candlestick', **kwargs + ): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='candlestick', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WhiskerwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='whiskerwidth', parent_name='candlestick', **kwargs + ): + super(WhiskerwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='candlestick', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='candlestick', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='candlestick', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textsrc', parent_name='candlestick', **kwargs + ): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='text', parent_name='candlestick', **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='candlestick', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='candlestick', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='selectedpoints', + parent_name='candlestick', + **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpensrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='opensrc', parent_name='candlestick', **kwargs + ): + super(OpensrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpenValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='open', parent_name='candlestick', **kwargs + ): + super(OpenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='candlestick', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='candlestick', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LowsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='lowsrc', parent_name='candlestick', **kwargs + ): + super(LowsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LowValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='low', parent_name='candlestick', **kwargs): + super(LowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='candlestick', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + width + Sets the width (in px) of line bounding the + box(es). Note that this style setting can also + be set per direction via + `increasing.line.width` and + `decreasing.line.width`. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='candlestick', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IncreasingValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='increasing', parent_name='candlestick', **kwargs + ): + super(IncreasingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Increasing'), + data_docs=kwargs.pop( + 'data_docs', """ + fillcolor + Sets the fill color. Defaults to a half- + transparent variant of the line color, marker + color, or marker line color, whichever is + available. + line + plotly.graph_objs.candlestick.increasing.Line + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='candlestick', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='candlestick', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='candlestick', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='candlestick', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='candlestick', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + split + Show hover information (open, close, high, low) + in separate labels. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='candlestick', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='candlestick', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HighsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='highsrc', parent_name='candlestick', **kwargs + ): + super(HighsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HighValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='high', parent_name='candlestick', **kwargs + ): + super(HighValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DecreasingValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='decreasing', parent_name='candlestick', **kwargs + ): + super(DecreasingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Decreasing'), + data_docs=kwargs.pop( + 'data_docs', """ + fillcolor + Sets the fill color. Defaults to a half- + transparent variant of the line color, marker + color, or marker line color, whichever is + available. + line + plotly.graph_objs.candlestick.decreasing.Line + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='candlestick', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='candlestick', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ClosesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='closesrc', parent_name='candlestick', **kwargs + ): + super(ClosesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CloseValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='close', parent_name='candlestick', **kwargs + ): + super(CloseValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/candlestick/_close.py b/plotly/validators/candlestick/_close.py deleted file mode 100644 index 6211bf708cb..00000000000 --- a/plotly/validators/candlestick/_close.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CloseValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='close', parent_name='candlestick', **kwargs - ): - super(CloseValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_closesrc.py b/plotly/validators/candlestick/_closesrc.py deleted file mode 100644 index 54bead089f5..00000000000 --- a/plotly/validators/candlestick/_closesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ClosesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='closesrc', parent_name='candlestick', **kwargs - ): - super(ClosesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_customdata.py b/plotly/validators/candlestick/_customdata.py deleted file mode 100644 index d37b652a0ff..00000000000 --- a/plotly/validators/candlestick/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='candlestick', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_customdatasrc.py b/plotly/validators/candlestick/_customdatasrc.py deleted file mode 100644 index 658c63d0510..00000000000 --- a/plotly/validators/candlestick/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='candlestick', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_decreasing.py b/plotly/validators/candlestick/_decreasing.py deleted file mode 100644 index 39ce9d34df5..00000000000 --- a/plotly/validators/candlestick/_decreasing.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class DecreasingValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='decreasing', parent_name='candlestick', **kwargs - ): - super(DecreasingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Decreasing'), - data_docs=kwargs.pop( - 'data_docs', """ - fillcolor - Sets the fill color. Defaults to a half- - transparent variant of the line color, marker - color, or marker line color, whichever is - available. - line - plotly.graph_objs.candlestick.decreasing.Line - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/candlestick/_high.py b/plotly/validators/candlestick/_high.py deleted file mode 100644 index 2c5c15e1724..00000000000 --- a/plotly/validators/candlestick/_high.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HighValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='high', parent_name='candlestick', **kwargs - ): - super(HighValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_highsrc.py b/plotly/validators/candlestick/_highsrc.py deleted file mode 100644 index 8e3af99b633..00000000000 --- a/plotly/validators/candlestick/_highsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HighsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='highsrc', parent_name='candlestick', **kwargs - ): - super(HighsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_hoverinfo.py b/plotly/validators/candlestick/_hoverinfo.py deleted file mode 100644 index 337722c68c7..00000000000 --- a/plotly/validators/candlestick/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='candlestick', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_hoverinfosrc.py b/plotly/validators/candlestick/_hoverinfosrc.py deleted file mode 100644 index c2f89455025..00000000000 --- a/plotly/validators/candlestick/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='candlestick', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_hoverlabel.py b/plotly/validators/candlestick/_hoverlabel.py deleted file mode 100644 index afffbb9edf0..00000000000 --- a/plotly/validators/candlestick/_hoverlabel.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='candlestick', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - split - Show hover information (open, close, high, low) - in separate labels. -""" - ), - **kwargs - ) diff --git a/plotly/validators/candlestick/_hovertext.py b/plotly/validators/candlestick/_hovertext.py deleted file mode 100644 index 9d5f6b7707a..00000000000 --- a/plotly/validators/candlestick/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='candlestick', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_hovertextsrc.py b/plotly/validators/candlestick/_hovertextsrc.py deleted file mode 100644 index b15cba790f0..00000000000 --- a/plotly/validators/candlestick/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='candlestick', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_ids.py b/plotly/validators/candlestick/_ids.py deleted file mode 100644 index dd081c2d3c2..00000000000 --- a/plotly/validators/candlestick/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='candlestick', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_idssrc.py b/plotly/validators/candlestick/_idssrc.py deleted file mode 100644 index e53272ff870..00000000000 --- a/plotly/validators/candlestick/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='candlestick', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_increasing.py b/plotly/validators/candlestick/_increasing.py deleted file mode 100644 index 6ba06a35e7c..00000000000 --- a/plotly/validators/candlestick/_increasing.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class IncreasingValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='increasing', parent_name='candlestick', **kwargs - ): - super(IncreasingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Increasing'), - data_docs=kwargs.pop( - 'data_docs', """ - fillcolor - Sets the fill color. Defaults to a half- - transparent variant of the line color, marker - color, or marker line color, whichever is - available. - line - plotly.graph_objs.candlestick.increasing.Line - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/candlestick/_legendgroup.py b/plotly/validators/candlestick/_legendgroup.py deleted file mode 100644 index de1eb7a86f1..00000000000 --- a/plotly/validators/candlestick/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='candlestick', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_line.py b/plotly/validators/candlestick/_line.py deleted file mode 100644 index 399ddd7648f..00000000000 --- a/plotly/validators/candlestick/_line.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='candlestick', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - width - Sets the width (in px) of line bounding the - box(es). Note that this style setting can also - be set per direction via - `increasing.line.width` and - `decreasing.line.width`. -""" - ), - **kwargs - ) diff --git a/plotly/validators/candlestick/_low.py b/plotly/validators/candlestick/_low.py deleted file mode 100644 index f4e00edd78f..00000000000 --- a/plotly/validators/candlestick/_low.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class LowValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='low', parent_name='candlestick', **kwargs): - super(LowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_lowsrc.py b/plotly/validators/candlestick/_lowsrc.py deleted file mode 100644 index a8e1f7fa08f..00000000000 --- a/plotly/validators/candlestick/_lowsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LowsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='lowsrc', parent_name='candlestick', **kwargs - ): - super(LowsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_name.py b/plotly/validators/candlestick/_name.py deleted file mode 100644 index 6d717707264..00000000000 --- a/plotly/validators/candlestick/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='candlestick', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_opacity.py b/plotly/validators/candlestick/_opacity.py deleted file mode 100644 index 127f22372b0..00000000000 --- a/plotly/validators/candlestick/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='candlestick', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_open.py b/plotly/validators/candlestick/_open.py deleted file mode 100644 index 477c9f537ea..00000000000 --- a/plotly/validators/candlestick/_open.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpenValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='open', parent_name='candlestick', **kwargs - ): - super(OpenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_opensrc.py b/plotly/validators/candlestick/_opensrc.py deleted file mode 100644 index b41e86ba0bf..00000000000 --- a/plotly/validators/candlestick/_opensrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpensrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='opensrc', parent_name='candlestick', **kwargs - ): - super(OpensrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_selectedpoints.py b/plotly/validators/candlestick/_selectedpoints.py deleted file mode 100644 index 5a0dbbd27d8..00000000000 --- a/plotly/validators/candlestick/_selectedpoints.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='selectedpoints', - parent_name='candlestick', - **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_showlegend.py b/plotly/validators/candlestick/_showlegend.py deleted file mode 100644 index 264a8e27a43..00000000000 --- a/plotly/validators/candlestick/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='candlestick', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_stream.py b/plotly/validators/candlestick/_stream.py deleted file mode 100644 index ddbefcc9330..00000000000 --- a/plotly/validators/candlestick/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='candlestick', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/candlestick/_text.py b/plotly/validators/candlestick/_text.py deleted file mode 100644 index 5a14d2eb426..00000000000 --- a/plotly/validators/candlestick/_text.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='text', parent_name='candlestick', **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_textsrc.py b/plotly/validators/candlestick/_textsrc.py deleted file mode 100644 index 59224b2d5b9..00000000000 --- a/plotly/validators/candlestick/_textsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textsrc', parent_name='candlestick', **kwargs - ): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_uid.py b/plotly/validators/candlestick/_uid.py deleted file mode 100644 index 89daa1f65d0..00000000000 --- a/plotly/validators/candlestick/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='candlestick', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_uirevision.py b/plotly/validators/candlestick/_uirevision.py deleted file mode 100644 index 3da12809380..00000000000 --- a/plotly/validators/candlestick/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='candlestick', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_visible.py b/plotly/validators/candlestick/_visible.py deleted file mode 100644 index 3c188f738d4..00000000000 --- a/plotly/validators/candlestick/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='candlestick', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/candlestick/_whiskerwidth.py b/plotly/validators/candlestick/_whiskerwidth.py deleted file mode 100644 index 9642939857e..00000000000 --- a/plotly/validators/candlestick/_whiskerwidth.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WhiskerwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='whiskerwidth', parent_name='candlestick', **kwargs - ): - super(WhiskerwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_x.py b/plotly/validators/candlestick/_x.py deleted file mode 100644 index 27356434a80..00000000000 --- a/plotly/validators/candlestick/_x.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='candlestick', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_xaxis.py b/plotly/validators/candlestick/_xaxis.py deleted file mode 100644 index caa0212e795..00000000000 --- a/plotly/validators/candlestick/_xaxis.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='xaxis', parent_name='candlestick', **kwargs - ): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_xcalendar.py b/plotly/validators/candlestick/_xcalendar.py deleted file mode 100644 index 173cd446f86..00000000000 --- a/plotly/validators/candlestick/_xcalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xcalendar', parent_name='candlestick', **kwargs - ): - super(XcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/candlestick/_xsrc.py b/plotly/validators/candlestick/_xsrc.py deleted file mode 100644 index 9d1d48cd28b..00000000000 --- a/plotly/validators/candlestick/_xsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='xsrc', parent_name='candlestick', **kwargs - ): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/_yaxis.py b/plotly/validators/candlestick/_yaxis.py deleted file mode 100644 index 06c49297090..00000000000 --- a/plotly/validators/candlestick/_yaxis.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='yaxis', parent_name='candlestick', **kwargs - ): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/decreasing/__init__.py b/plotly/validators/candlestick/decreasing/__init__.py index 20ad0eb02bf..27692d2c326 100644 --- a/plotly/validators/candlestick/decreasing/__init__.py +++ b/plotly/validators/candlestick/decreasing/__init__.py @@ -1,2 +1,49 @@ -from ._line import LineValidator -from ._fillcolor import FillcolorValidator + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='line', + parent_name='candlestick.decreasing', + **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the color of line bounding the box(es). + width + Sets the width (in px) of line bounding the + box(es). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='fillcolor', + parent_name='candlestick.decreasing', + **kwargs + ): + super(FillcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/candlestick/decreasing/_fillcolor.py b/plotly/validators/candlestick/decreasing/_fillcolor.py deleted file mode 100644 index 8fd8d4f1a94..00000000000 --- a/plotly/validators/candlestick/decreasing/_fillcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='fillcolor', - parent_name='candlestick.decreasing', - **kwargs - ): - super(FillcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/candlestick/decreasing/_line.py b/plotly/validators/candlestick/decreasing/_line.py deleted file mode 100644 index c45386726c6..00000000000 --- a/plotly/validators/candlestick/decreasing/_line.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='line', - parent_name='candlestick.decreasing', - **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the color of line bounding the box(es). - width - Sets the width (in px) of line bounding the - box(es). -""" - ), - **kwargs - ) diff --git a/plotly/validators/candlestick/decreasing/line/__init__.py b/plotly/validators/candlestick/decreasing/line/__init__.py index 7806a9a1cdc..a558cc82946 100644 --- a/plotly/validators/candlestick/decreasing/line/__init__.py +++ b/plotly/validators/candlestick/decreasing/line/__init__.py @@ -1,2 +1,41 @@ -from ._width import WidthValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='candlestick.decreasing.line', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='candlestick.decreasing.line', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/candlestick/decreasing/line/_color.py b/plotly/validators/candlestick/decreasing/line/_color.py deleted file mode 100644 index 0a049286e86..00000000000 --- a/plotly/validators/candlestick/decreasing/line/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='candlestick.decreasing.line', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/candlestick/decreasing/line/_width.py b/plotly/validators/candlestick/decreasing/line/_width.py deleted file mode 100644 index 19e67b8e9d2..00000000000 --- a/plotly/validators/candlestick/decreasing/line/_width.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='candlestick.decreasing.line', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/candlestick/hoverlabel/__init__.py b/plotly/validators/candlestick/hoverlabel/__init__.py index 437d45e8685..2dce4ec90ad 100644 --- a/plotly/validators/candlestick/hoverlabel/__init__.py +++ b/plotly/validators/candlestick/hoverlabel/__init__.py @@ -1,8 +1,196 @@ -from ._split import SplitValidator -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class SplitValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='split', + parent_name='candlestick.hoverlabel', + **kwargs + ): + super(SplitValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='candlestick.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='candlestick.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='candlestick.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='candlestick.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='candlestick.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='candlestick.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='candlestick.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/candlestick/hoverlabel/_bgcolor.py b/plotly/validators/candlestick/hoverlabel/_bgcolor.py deleted file mode 100644 index 2cf23bad62e..00000000000 --- a/plotly/validators/candlestick/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='candlestick.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/candlestick/hoverlabel/_bgcolorsrc.py b/plotly/validators/candlestick/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 2a4cba047e4..00000000000 --- a/plotly/validators/candlestick/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='candlestick.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/hoverlabel/_bordercolor.py b/plotly/validators/candlestick/hoverlabel/_bordercolor.py deleted file mode 100644 index 0101bfa050f..00000000000 --- a/plotly/validators/candlestick/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='candlestick.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/candlestick/hoverlabel/_bordercolorsrc.py b/plotly/validators/candlestick/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 1b5cfdf2df8..00000000000 --- a/plotly/validators/candlestick/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='candlestick.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/hoverlabel/_font.py b/plotly/validators/candlestick/hoverlabel/_font.py deleted file mode 100644 index 73053e09e94..00000000000 --- a/plotly/validators/candlestick/hoverlabel/_font.py +++ /dev/null @@ -1,50 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='candlestick.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/candlestick/hoverlabel/_namelength.py b/plotly/validators/candlestick/hoverlabel/_namelength.py deleted file mode 100644 index e0db69fb88d..00000000000 --- a/plotly/validators/candlestick/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='candlestick.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/candlestick/hoverlabel/_namelengthsrc.py b/plotly/validators/candlestick/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 52a59f9d0f7..00000000000 --- a/plotly/validators/candlestick/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='candlestick.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/hoverlabel/_split.py b/plotly/validators/candlestick/hoverlabel/_split.py deleted file mode 100644 index 478c04ed0c3..00000000000 --- a/plotly/validators/candlestick/hoverlabel/_split.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SplitValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='split', - parent_name='candlestick.hoverlabel', - **kwargs - ): - super(SplitValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/hoverlabel/font/__init__.py b/plotly/validators/candlestick/hoverlabel/font/__init__.py index 1d2c591d1e5..8407c1fcb0a 100644 --- a/plotly/validators/candlestick/hoverlabel/font/__init__.py +++ b/plotly/validators/candlestick/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='candlestick.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='candlestick.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='candlestick.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='candlestick.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='candlestick.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='candlestick.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/candlestick/hoverlabel/font/_color.py b/plotly/validators/candlestick/hoverlabel/font/_color.py deleted file mode 100644 index 73181e3ab24..00000000000 --- a/plotly/validators/candlestick/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='candlestick.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/candlestick/hoverlabel/font/_colorsrc.py b/plotly/validators/candlestick/hoverlabel/font/_colorsrc.py deleted file mode 100644 index e2dc7be15b9..00000000000 --- a/plotly/validators/candlestick/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='candlestick.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/hoverlabel/font/_family.py b/plotly/validators/candlestick/hoverlabel/font/_family.py deleted file mode 100644 index 842dd5df491..00000000000 --- a/plotly/validators/candlestick/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='candlestick.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/candlestick/hoverlabel/font/_familysrc.py b/plotly/validators/candlestick/hoverlabel/font/_familysrc.py deleted file mode 100644 index 945b810eb9e..00000000000 --- a/plotly/validators/candlestick/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='candlestick.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/hoverlabel/font/_size.py b/plotly/validators/candlestick/hoverlabel/font/_size.py deleted file mode 100644 index 100f3c386fd..00000000000 --- a/plotly/validators/candlestick/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='candlestick.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/candlestick/hoverlabel/font/_sizesrc.py b/plotly/validators/candlestick/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 60c7aafbc58..00000000000 --- a/plotly/validators/candlestick/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='candlestick.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/increasing/__init__.py b/plotly/validators/candlestick/increasing/__init__.py index 20ad0eb02bf..6e911194b8e 100644 --- a/plotly/validators/candlestick/increasing/__init__.py +++ b/plotly/validators/candlestick/increasing/__init__.py @@ -1,2 +1,49 @@ -from ._line import LineValidator -from ._fillcolor import FillcolorValidator + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='line', + parent_name='candlestick.increasing', + **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the color of line bounding the box(es). + width + Sets the width (in px) of line bounding the + box(es). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='fillcolor', + parent_name='candlestick.increasing', + **kwargs + ): + super(FillcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/candlestick/increasing/_fillcolor.py b/plotly/validators/candlestick/increasing/_fillcolor.py deleted file mode 100644 index 7e851782e8a..00000000000 --- a/plotly/validators/candlestick/increasing/_fillcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='fillcolor', - parent_name='candlestick.increasing', - **kwargs - ): - super(FillcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/candlestick/increasing/_line.py b/plotly/validators/candlestick/increasing/_line.py deleted file mode 100644 index 6fed8e1cc7a..00000000000 --- a/plotly/validators/candlestick/increasing/_line.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='line', - parent_name='candlestick.increasing', - **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the color of line bounding the box(es). - width - Sets the width (in px) of line bounding the - box(es). -""" - ), - **kwargs - ) diff --git a/plotly/validators/candlestick/increasing/line/__init__.py b/plotly/validators/candlestick/increasing/line/__init__.py index 7806a9a1cdc..970943708b5 100644 --- a/plotly/validators/candlestick/increasing/line/__init__.py +++ b/plotly/validators/candlestick/increasing/line/__init__.py @@ -1,2 +1,41 @@ -from ._width import WidthValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='candlestick.increasing.line', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='candlestick.increasing.line', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/candlestick/increasing/line/_color.py b/plotly/validators/candlestick/increasing/line/_color.py deleted file mode 100644 index 240c6552810..00000000000 --- a/plotly/validators/candlestick/increasing/line/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='candlestick.increasing.line', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/candlestick/increasing/line/_width.py b/plotly/validators/candlestick/increasing/line/_width.py deleted file mode 100644 index 38a3ce1a961..00000000000 --- a/plotly/validators/candlestick/increasing/line/_width.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='candlestick.increasing.line', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/candlestick/line/__init__.py b/plotly/validators/candlestick/line/__init__.py index 6b3cef5b7d6..58d8a4932c8 100644 --- a/plotly/validators/candlestick/line/__init__.py +++ b/plotly/validators/candlestick/line/__init__.py @@ -1 +1,18 @@ -from ._width import WidthValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='candlestick.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/candlestick/line/_width.py b/plotly/validators/candlestick/line/_width.py deleted file mode 100644 index 1ab319de75b..00000000000 --- a/plotly/validators/candlestick/line/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='candlestick.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/candlestick/stream/__init__.py b/plotly/validators/candlestick/stream/__init__.py index 2f4f2047594..d781647d119 100644 --- a/plotly/validators/candlestick/stream/__init__.py +++ b/plotly/validators/candlestick/stream/__init__.py @@ -1,2 +1,41 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='candlestick.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='candlestick.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/candlestick/stream/_maxpoints.py b/plotly/validators/candlestick/stream/_maxpoints.py deleted file mode 100644 index 08da37a9486..00000000000 --- a/plotly/validators/candlestick/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='candlestick.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/candlestick/stream/_token.py b/plotly/validators/candlestick/stream/_token.py deleted file mode 100644 index 9d5c7a04692..00000000000 --- a/plotly/validators/candlestick/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='candlestick.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/carpet/__init__.py b/plotly/validators/carpet/__init__.py index be5e4b08f6a..12beaa8dcf9 100644 --- a/plotly/validators/carpet/__init__.py +++ b/plotly/validators/carpet/__init__.py @@ -1,36 +1,1064 @@ -from ._ysrc import YsrcValidator -from ._yaxis import YAxisValidator -from ._y import YValidator -from ._xsrc import XsrcValidator -from ._xaxis import XAxisValidator -from ._x import XValidator -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._font import FontValidator -from ._db import DbValidator -from ._da import DaValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._color import ColorValidator -from ._cheaterslope import CheaterslopeValidator -from ._carpet import CarpetValidator -from ._bsrc import BsrcValidator -from ._baxis import BaxisValidator -from ._b0 import B0Validator -from ._b import BValidator -from ._asrc import AsrcValidator -from ._aaxis import AaxisValidator -from ._a0 import A0Validator -from ._a import AValidator + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='carpet', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='yaxis', parent_name='carpet', **kwargs): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='carpet', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='carpet', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='xaxis', parent_name='carpet', **kwargs): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='carpet', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='carpet', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='carpet', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='carpet', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='carpet', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='carpet', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='carpet', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='opacity', parent_name='carpet', **kwargs): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='carpet', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='carpet', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='carpet', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='carpet', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='carpet', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='carpet', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='carpet', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='font', parent_name='carpet', **kwargs): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DbValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='db', parent_name='carpet', **kwargs): + super(DbValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DaValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='da', parent_name='carpet', **kwargs): + super(DaValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='carpet', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='carpet', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__(self, plotly_name='color', parent_name='carpet', **kwargs): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CheaterslopeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cheaterslope', parent_name='carpet', **kwargs + ): + super(CheaterslopeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CarpetValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='carpet', parent_name='carpet', **kwargs): + super(CarpetValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='bsrc', parent_name='carpet', **kwargs): + super(BsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BaxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='baxis', parent_name='carpet', **kwargs): + super(BaxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Baxis'), + data_docs=kwargs.pop( + 'data_docs', """ + arraydtick + The stride between grid lines along the axis + arraytick0 + The starting index of grid lines along the axis + autorange + Determines whether or not the range of this + axis is computed in relation to the input data. + See `rangemode` for more info. If `range` is + provided, then `autorange` is set to False. + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + cheatertype + + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + The stride between grid lines along the axis + endline + Determines whether or not a line is drawn at + along the final value of this axis. If True, + the end line is drawn on top of the grid lines. + endlinecolor + Sets the line color of the end line. + endlinewidth + Sets the width (in px) of the end line. + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom- + able. If true, then zoom is disabled. + gridcolor + Sets the axis line color. + gridwidth + Sets the width (in px) of the axis line. + labelpadding + Extra padding between label and the axis + labelprefix + Sets a axis label prefix. + labelsuffix + Sets a axis label suffix. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + minorgridcolor + Sets the color of the grid lines. + minorgridcount + Sets the number of minor grid ticks per major + grid tick + minorgridwidth + Sets the width (in px) of the grid lines. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + range + Sets the range of this axis. If the axis `type` + is "log", then you must take the log of your + desired range (e.g. to set the range from 1 to + 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, + like date data, though Date objects and unix + milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it + should be numbers, using the scale where each + category is assigned a serial number from zero + in the order it appears. + rangemode + If "normal", the range is computed in relation + to the extrema of the input data. If *tozero*`, + the range extends to 0, regardless of the input + data If "nonnegative", the range is non- + negative, regardless of the input data. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showticklabels + Determines whether axis labels are drawn on the + low side, the high side, both, or neither side + of the axis. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + smoothing + + startline + Determines whether or not a line is drawn at + along the starting value of this axis. If True, + the start line is drawn on top of the grid + lines. + startlinecolor + Sets the line color of the start line. + startlinewidth + Sets the width (in px) of the start line. + tick0 + The starting index of grid lines along the axis + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.carpet.baxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.carpet.baxis.tickformatstopdefaults), sets + the default property values to use for elements + of carpet.baxis.tickformatstops + tickmode + + tickprefix + Sets a tick label prefix. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + title + plotly.graph_objs.carpet.baxis.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use carpet.baxis.title.font + instead. Sets this axis' title font. Note that + the title's font used to be set by the now + deprecated `titlefont` attribute. + titleoffset + Deprecated: Please use + carpet.baxis.title.offset instead. An + additional amount by which to offset the title + from the tick labels, given in pixels. Note + that this used to be set by the now deprecated + `titleoffset` attribute. + type + Sets the axis type. By default, plotly attempts + to determined the axis type by looking into the + data of the traces that referenced the axis in + question. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class B0Validator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='b0', parent_name='carpet', **kwargs): + super(B0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='b', parent_name='carpet', **kwargs): + super(BValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='asrc', parent_name='carpet', **kwargs): + super(AsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AaxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='aaxis', parent_name='carpet', **kwargs): + super(AaxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Aaxis'), + data_docs=kwargs.pop( + 'data_docs', """ + arraydtick + The stride between grid lines along the axis + arraytick0 + The starting index of grid lines along the axis + autorange + Determines whether or not the range of this + axis is computed in relation to the input data. + See `rangemode` for more info. If `range` is + provided, then `autorange` is set to False. + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + cheatertype + + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + The stride between grid lines along the axis + endline + Determines whether or not a line is drawn at + along the final value of this axis. If True, + the end line is drawn on top of the grid lines. + endlinecolor + Sets the line color of the end line. + endlinewidth + Sets the width (in px) of the end line. + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom- + able. If true, then zoom is disabled. + gridcolor + Sets the axis line color. + gridwidth + Sets the width (in px) of the axis line. + labelpadding + Extra padding between label and the axis + labelprefix + Sets a axis label prefix. + labelsuffix + Sets a axis label suffix. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + minorgridcolor + Sets the color of the grid lines. + minorgridcount + Sets the number of minor grid ticks per major + grid tick + minorgridwidth + Sets the width (in px) of the grid lines. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + range + Sets the range of this axis. If the axis `type` + is "log", then you must take the log of your + desired range (e.g. to set the range from 1 to + 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, + like date data, though Date objects and unix + milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it + should be numbers, using the scale where each + category is assigned a serial number from zero + in the order it appears. + rangemode + If "normal", the range is computed in relation + to the extrema of the input data. If *tozero*`, + the range extends to 0, regardless of the input + data If "nonnegative", the range is non- + negative, regardless of the input data. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showticklabels + Determines whether axis labels are drawn on the + low side, the high side, both, or neither side + of the axis. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + smoothing + + startline + Determines whether or not a line is drawn at + along the starting value of this axis. If True, + the start line is drawn on top of the grid + lines. + startlinecolor + Sets the line color of the start line. + startlinewidth + Sets the width (in px) of the start line. + tick0 + The starting index of grid lines along the axis + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.carpet.aaxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.carpet.aaxis.tickformatstopdefaults), sets + the default property values to use for elements + of carpet.aaxis.tickformatstops + tickmode + + tickprefix + Sets a tick label prefix. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + title + plotly.graph_objs.carpet.aaxis.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use carpet.aaxis.title.font + instead. Sets this axis' title font. Note that + the title's font used to be set by the now + deprecated `titlefont` attribute. + titleoffset + Deprecated: Please use + carpet.aaxis.title.offset instead. An + additional amount by which to offset the title + from the tick labels, given in pixels. Note + that this used to be set by the now deprecated + `titleoffset` attribute. + type + Sets the axis type. By default, plotly attempts + to determined the axis type by looking into the + data of the traces that referenced the axis in + question. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class A0Validator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='a0', parent_name='carpet', **kwargs): + super(A0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='a', parent_name='carpet', **kwargs): + super(AValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/carpet/_a.py b/plotly/validators/carpet/_a.py deleted file mode 100644 index 03d4ca2ceaa..00000000000 --- a/plotly/validators/carpet/_a.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class AValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='a', parent_name='carpet', **kwargs): - super(AValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/carpet/_a0.py b/plotly/validators/carpet/_a0.py deleted file mode 100644 index 60e77d90190..00000000000 --- a/plotly/validators/carpet/_a0.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class A0Validator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='a0', parent_name='carpet', **kwargs): - super(A0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_aaxis.py b/plotly/validators/carpet/_aaxis.py deleted file mode 100644 index cc0ab7f1b72..00000000000 --- a/plotly/validators/carpet/_aaxis.py +++ /dev/null @@ -1,228 +0,0 @@ -import _plotly_utils.basevalidators - - -class AaxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='aaxis', parent_name='carpet', **kwargs): - super(AaxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Aaxis'), - data_docs=kwargs.pop( - 'data_docs', """ - arraydtick - The stride between grid lines along the axis - arraytick0 - The starting index of grid lines along the axis - autorange - Determines whether or not the range of this - axis is computed in relation to the input data. - See `rangemode` for more info. If `range` is - provided, then `autorange` is set to False. - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - cheatertype - - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - The stride between grid lines along the axis - endline - Determines whether or not a line is drawn at - along the final value of this axis. If True, - the end line is drawn on top of the grid lines. - endlinecolor - Sets the line color of the end line. - endlinewidth - Sets the width (in px) of the end line. - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - fixedrange - Determines whether or not this axis is zoom- - able. If true, then zoom is disabled. - gridcolor - Sets the axis line color. - gridwidth - Sets the width (in px) of the axis line. - labelpadding - Extra padding between label and the axis - labelprefix - Sets a axis label prefix. - labelsuffix - Sets a axis label suffix. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - minorgridcolor - Sets the color of the grid lines. - minorgridcount - Sets the number of minor grid ticks per major - grid tick - minorgridwidth - Sets the width (in px) of the grid lines. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - range - Sets the range of this axis. If the axis `type` - is "log", then you must take the log of your - desired range (e.g. to set the range from 1 to - 100, set the range from 0 to 2). If the axis - `type` is "date", it should be date strings, - like date data, though Date objects and unix - milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it - should be numbers, using the scale where each - category is assigned a serial number from zero - in the order it appears. - rangemode - If "normal", the range is computed in relation - to the extrema of the input data. If *tozero*`, - the range extends to 0, regardless of the input - data If "nonnegative", the range is non- - negative, regardless of the input data. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showticklabels - Determines whether axis labels are drawn on the - low side, the high side, both, or neither side - of the axis. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - smoothing - - startline - Determines whether or not a line is drawn at - along the starting value of this axis. If True, - the start line is drawn on top of the grid - lines. - startlinecolor - Sets the line color of the start line. - startlinewidth - Sets the width (in px) of the start line. - tick0 - The starting index of grid lines along the axis - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.carpet.aaxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.carpet.aaxis.tickformatstopdefaults), sets - the default property values to use for elements - of carpet.aaxis.tickformatstops - tickmode - - tickprefix - Sets a tick label prefix. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - title - plotly.graph_objs.carpet.aaxis.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use carpet.aaxis.title.font - instead. Sets this axis' title font. Note that - the title's font used to be set by the now - deprecated `titlefont` attribute. - titleoffset - Deprecated: Please use - carpet.aaxis.title.offset instead. An - additional amount by which to offset the title - from the tick labels, given in pixels. Note - that this used to be set by the now deprecated - `titleoffset` attribute. - type - Sets the axis type. By default, plotly attempts - to determined the axis type by looking into the - data of the traces that referenced the axis in - question. -""" - ), - **kwargs - ) diff --git a/plotly/validators/carpet/_asrc.py b/plotly/validators/carpet/_asrc.py deleted file mode 100644 index 87a9831ff53..00000000000 --- a/plotly/validators/carpet/_asrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class AsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='asrc', parent_name='carpet', **kwargs): - super(AsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_b.py b/plotly/validators/carpet/_b.py deleted file mode 100644 index 2bf26322614..00000000000 --- a/plotly/validators/carpet/_b.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class BValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='b', parent_name='carpet', **kwargs): - super(BValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/carpet/_b0.py b/plotly/validators/carpet/_b0.py deleted file mode 100644 index 558ed848834..00000000000 --- a/plotly/validators/carpet/_b0.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class B0Validator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='b0', parent_name='carpet', **kwargs): - super(B0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_baxis.py b/plotly/validators/carpet/_baxis.py deleted file mode 100644 index 6b4be5851cc..00000000000 --- a/plotly/validators/carpet/_baxis.py +++ /dev/null @@ -1,228 +0,0 @@ -import _plotly_utils.basevalidators - - -class BaxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='baxis', parent_name='carpet', **kwargs): - super(BaxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Baxis'), - data_docs=kwargs.pop( - 'data_docs', """ - arraydtick - The stride between grid lines along the axis - arraytick0 - The starting index of grid lines along the axis - autorange - Determines whether or not the range of this - axis is computed in relation to the input data. - See `rangemode` for more info. If `range` is - provided, then `autorange` is set to False. - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - cheatertype - - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - The stride between grid lines along the axis - endline - Determines whether or not a line is drawn at - along the final value of this axis. If True, - the end line is drawn on top of the grid lines. - endlinecolor - Sets the line color of the end line. - endlinewidth - Sets the width (in px) of the end line. - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - fixedrange - Determines whether or not this axis is zoom- - able. If true, then zoom is disabled. - gridcolor - Sets the axis line color. - gridwidth - Sets the width (in px) of the axis line. - labelpadding - Extra padding between label and the axis - labelprefix - Sets a axis label prefix. - labelsuffix - Sets a axis label suffix. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - minorgridcolor - Sets the color of the grid lines. - minorgridcount - Sets the number of minor grid ticks per major - grid tick - minorgridwidth - Sets the width (in px) of the grid lines. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - range - Sets the range of this axis. If the axis `type` - is "log", then you must take the log of your - desired range (e.g. to set the range from 1 to - 100, set the range from 0 to 2). If the axis - `type` is "date", it should be date strings, - like date data, though Date objects and unix - milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it - should be numbers, using the scale where each - category is assigned a serial number from zero - in the order it appears. - rangemode - If "normal", the range is computed in relation - to the extrema of the input data. If *tozero*`, - the range extends to 0, regardless of the input - data If "nonnegative", the range is non- - negative, regardless of the input data. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showticklabels - Determines whether axis labels are drawn on the - low side, the high side, both, or neither side - of the axis. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - smoothing - - startline - Determines whether or not a line is drawn at - along the starting value of this axis. If True, - the start line is drawn on top of the grid - lines. - startlinecolor - Sets the line color of the start line. - startlinewidth - Sets the width (in px) of the start line. - tick0 - The starting index of grid lines along the axis - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.carpet.baxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.carpet.baxis.tickformatstopdefaults), sets - the default property values to use for elements - of carpet.baxis.tickformatstops - tickmode - - tickprefix - Sets a tick label prefix. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - title - plotly.graph_objs.carpet.baxis.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use carpet.baxis.title.font - instead. Sets this axis' title font. Note that - the title's font used to be set by the now - deprecated `titlefont` attribute. - titleoffset - Deprecated: Please use - carpet.baxis.title.offset instead. An - additional amount by which to offset the title - from the tick labels, given in pixels. Note - that this used to be set by the now deprecated - `titleoffset` attribute. - type - Sets the axis type. By default, plotly attempts - to determined the axis type by looking into the - data of the traces that referenced the axis in - question. -""" - ), - **kwargs - ) diff --git a/plotly/validators/carpet/_bsrc.py b/plotly/validators/carpet/_bsrc.py deleted file mode 100644 index 12b5129600c..00000000000 --- a/plotly/validators/carpet/_bsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class BsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='bsrc', parent_name='carpet', **kwargs): - super(BsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_carpet.py b/plotly/validators/carpet/_carpet.py deleted file mode 100644 index 09a89cef202..00000000000 --- a/plotly/validators/carpet/_carpet.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class CarpetValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='carpet', parent_name='carpet', **kwargs): - super(CarpetValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_cheaterslope.py b/plotly/validators/carpet/_cheaterslope.py deleted file mode 100644 index f585570c148..00000000000 --- a/plotly/validators/carpet/_cheaterslope.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CheaterslopeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cheaterslope', parent_name='carpet', **kwargs - ): - super(CheaterslopeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_color.py b/plotly/validators/carpet/_color.py deleted file mode 100644 index f6518e26911..00000000000 --- a/plotly/validators/carpet/_color.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__(self, plotly_name='color', parent_name='carpet', **kwargs): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/_customdata.py b/plotly/validators/carpet/_customdata.py deleted file mode 100644 index a3458ecf3f8..00000000000 --- a/plotly/validators/carpet/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='carpet', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/carpet/_customdatasrc.py b/plotly/validators/carpet/_customdatasrc.py deleted file mode 100644 index 503b12f314f..00000000000 --- a/plotly/validators/carpet/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='carpet', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_da.py b/plotly/validators/carpet/_da.py deleted file mode 100644 index 69e43ae64d2..00000000000 --- a/plotly/validators/carpet/_da.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class DaValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='da', parent_name='carpet', **kwargs): - super(DaValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_db.py b/plotly/validators/carpet/_db.py deleted file mode 100644 index 808baef8769..00000000000 --- a/plotly/validators/carpet/_db.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class DbValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='db', parent_name='carpet', **kwargs): - super(DbValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_font.py b/plotly/validators/carpet/_font.py deleted file mode 100644 index 13152b2e696..00000000000 --- a/plotly/validators/carpet/_font.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='font', parent_name='carpet', **kwargs): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/carpet/_hoverinfo.py b/plotly/validators/carpet/_hoverinfo.py deleted file mode 100644 index 9036769a53f..00000000000 --- a/plotly/validators/carpet/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='carpet', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_hoverinfosrc.py b/plotly/validators/carpet/_hoverinfosrc.py deleted file mode 100644 index bf232776932..00000000000 --- a/plotly/validators/carpet/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='carpet', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_hoverlabel.py b/plotly/validators/carpet/_hoverlabel.py deleted file mode 100644 index a7d0f56de46..00000000000 --- a/plotly/validators/carpet/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='carpet', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/carpet/_ids.py b/plotly/validators/carpet/_ids.py deleted file mode 100644 index 461c67f6e24..00000000000 --- a/plotly/validators/carpet/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='carpet', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/carpet/_idssrc.py b/plotly/validators/carpet/_idssrc.py deleted file mode 100644 index ec768b1341e..00000000000 --- a/plotly/validators/carpet/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='carpet', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_legendgroup.py b/plotly/validators/carpet/_legendgroup.py deleted file mode 100644 index c90e22bc64e..00000000000 --- a/plotly/validators/carpet/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='carpet', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_name.py b/plotly/validators/carpet/_name.py deleted file mode 100644 index 0a770a53bd8..00000000000 --- a/plotly/validators/carpet/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='carpet', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_opacity.py b/plotly/validators/carpet/_opacity.py deleted file mode 100644 index f6a518a25bd..00000000000 --- a/plotly/validators/carpet/_opacity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='opacity', parent_name='carpet', **kwargs): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/_selectedpoints.py b/plotly/validators/carpet/_selectedpoints.py deleted file mode 100644 index ebf9347fdf8..00000000000 --- a/plotly/validators/carpet/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='carpet', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_showlegend.py b/plotly/validators/carpet/_showlegend.py deleted file mode 100644 index 5021dac1625..00000000000 --- a/plotly/validators/carpet/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='carpet', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_stream.py b/plotly/validators/carpet/_stream.py deleted file mode 100644 index 4aefefb003a..00000000000 --- a/plotly/validators/carpet/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='carpet', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/carpet/_uid.py b/plotly/validators/carpet/_uid.py deleted file mode 100644 index 043ab2ac7e6..00000000000 --- a/plotly/validators/carpet/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='carpet', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_uirevision.py b/plotly/validators/carpet/_uirevision.py deleted file mode 100644 index 582a0f78349..00000000000 --- a/plotly/validators/carpet/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='carpet', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_visible.py b/plotly/validators/carpet/_visible.py deleted file mode 100644 index 80bcb1892db..00000000000 --- a/plotly/validators/carpet/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='carpet', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/carpet/_x.py b/plotly/validators/carpet/_x.py deleted file mode 100644 index 1773e03e762..00000000000 --- a/plotly/validators/carpet/_x.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='carpet', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/carpet/_xaxis.py b/plotly/validators/carpet/_xaxis.py deleted file mode 100644 index 86261bc834e..00000000000 --- a/plotly/validators/carpet/_xaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='xaxis', parent_name='carpet', **kwargs): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_xsrc.py b/plotly/validators/carpet/_xsrc.py deleted file mode 100644 index 0e67cafea88..00000000000 --- a/plotly/validators/carpet/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='carpet', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_y.py b/plotly/validators/carpet/_y.py deleted file mode 100644 index a15d3a8e3ee..00000000000 --- a/plotly/validators/carpet/_y.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='carpet', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/carpet/_yaxis.py b/plotly/validators/carpet/_yaxis.py deleted file mode 100644 index 8b299d53177..00000000000 --- a/plotly/validators/carpet/_yaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='yaxis', parent_name='carpet', **kwargs): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/_ysrc.py b/plotly/validators/carpet/_ysrc.py deleted file mode 100644 index 0197488ee9a..00000000000 --- a/plotly/validators/carpet/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='carpet', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/__init__.py b/plotly/validators/carpet/aaxis/__init__.py index 2e0cb044446..36a606635dd 100644 --- a/plotly/validators/carpet/aaxis/__init__.py +++ b/plotly/validators/carpet/aaxis/__init__.py @@ -1,53 +1,1076 @@ -from ._type import TypeValidator -from ._title import TitleValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._startlinewidth import StartlinewidthValidator -from ._startlinecolor import StartlinecolorValidator -from ._startline import StartlineValidator -from ._smoothing import SmoothingValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showline import ShowlineValidator -from ._showgrid import ShowgridValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._rangemode import RangemodeValidator -from ._range import RangeValidator -from ._nticks import NticksValidator -from ._minorgridwidth import MinorgridwidthValidator -from ._minorgridcount import MinorgridcountValidator -from ._minorgridcolor import MinorgridcolorValidator -from ._linewidth import LinewidthValidator -from ._linecolor import LinecolorValidator -from ._labelsuffix import LabelsuffixValidator -from ._labelprefix import LabelprefixValidator -from ._labelpadding import LabelpaddingValidator -from ._gridwidth import GridwidthValidator -from ._gridcolor import GridcolorValidator -from ._fixedrange import FixedrangeValidator -from ._exponentformat import ExponentformatValidator -from ._endlinewidth import EndlinewidthValidator -from ._endlinecolor import EndlinecolorValidator -from ._endline import EndlineValidator -from ._dtick import DtickValidator -from ._color import ColorValidator -from ._cheatertype import CheatertypeValidator -from ._categoryorder import CategoryorderValidator -from ._categoryarraysrc import CategoryarraysrcValidator -from ._categoryarray import CategoryarrayValidator -from ._autorange import AutorangeValidator -from ._arraytick0 import Arraytick0Validator -from ._arraydtick import ArraydtickValidator + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='carpet.aaxis', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['-', 'linear', 'date', 'category']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='carpet.aaxis', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this axis' title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + offset + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='tickvalssrc', parent_name='carpet.aaxis', **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='tickvals', parent_name='carpet.aaxis', **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='ticktextsrc', parent_name='carpet.aaxis', **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ticktext', parent_name='carpet.aaxis', **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='ticksuffix', parent_name='carpet.aaxis', **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='tickprefix', parent_name='carpet.aaxis', **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='tickmode', parent_name='carpet.aaxis', **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='carpet.aaxis', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='carpet.aaxis', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='tickformat', parent_name='carpet.aaxis', **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='tickfont', parent_name='carpet.aaxis', **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, plotly_name='tickangle', parent_name='carpet.aaxis', **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='tick0', parent_name='carpet.aaxis', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StartlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='startlinewidth', + parent_name='carpet.aaxis', + **kwargs + ): + super(StartlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StartlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='startlinecolor', + parent_name='carpet.aaxis', + **kwargs + ): + super(StartlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StartlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='startline', parent_name='carpet.aaxis', **kwargs + ): + super(StartlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='smoothing', parent_name='carpet.aaxis', **kwargs + ): + super(SmoothingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1.3), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='carpet.aaxis', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='carpet.aaxis', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='carpet.aaxis', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['start', 'end', 'both', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showline', parent_name='carpet.aaxis', **kwargs + ): + super(ShowlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showgrid', parent_name='carpet.aaxis', **kwargs + ): + super(ShowgridValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='showexponent', parent_name='carpet.aaxis', **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='carpet.aaxis', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='rangemode', parent_name='carpet.aaxis', **kwargs + ): + super(RangemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['normal', 'tozero', 'nonnegative']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='range', parent_name='carpet.aaxis', **kwargs + ): + super(RangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'calc' + }, { + 'valType': 'any', + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nticks', parent_name='carpet.aaxis', **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MinorgridwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='minorgridwidth', + parent_name='carpet.aaxis', + **kwargs + ): + super(MinorgridwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MinorgridcountValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='minorgridcount', + parent_name='carpet.aaxis', + **kwargs + ): + super(MinorgridcountValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MinorgridcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='minorgridcolor', + parent_name='carpet.aaxis', + **kwargs + ): + super(MinorgridcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='linewidth', parent_name='carpet.aaxis', **kwargs + ): + super(LinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='linecolor', parent_name='carpet.aaxis', **kwargs + ): + super(LinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelsuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='labelsuffix', parent_name='carpet.aaxis', **kwargs + ): + super(LabelsuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='labelprefix', parent_name='carpet.aaxis', **kwargs + ): + super(LabelprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelpaddingValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='labelpadding', parent_name='carpet.aaxis', **kwargs + ): + super(LabelpaddingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='gridwidth', parent_name='carpet.aaxis', **kwargs + ): + super(GridwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='gridcolor', parent_name='carpet.aaxis', **kwargs + ): + super(GridcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FixedrangeValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='fixedrange', parent_name='carpet.aaxis', **kwargs + ): + super(FixedrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='carpet.aaxis', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='endlinewidth', parent_name='carpet.aaxis', **kwargs + ): + super(EndlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='endlinecolor', parent_name='carpet.aaxis', **kwargs + ): + super(EndlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='endline', parent_name='carpet.aaxis', **kwargs + ): + super(EndlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='dtick', parent_name='carpet.aaxis', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='carpet.aaxis', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CheatertypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='cheatertype', parent_name='carpet.aaxis', **kwargs + ): + super(CheatertypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['index', 'value']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='categoryorder', + parent_name='carpet.aaxis', + **kwargs + ): + super(CategoryorderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'trace', 'category ascending', 'category descending', + 'array' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='categoryarraysrc', + parent_name='carpet.aaxis', + **kwargs + ): + super(CategoryarraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='categoryarray', + parent_name='carpet.aaxis', + **kwargs + ): + super(CategoryarrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutorangeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='autorange', parent_name='carpet.aaxis', **kwargs + ): + super(AutorangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', [True, False, 'reversed']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Arraytick0Validator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='arraytick0', parent_name='carpet.aaxis', **kwargs + ): + super(Arraytick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArraydtickValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='arraydtick', parent_name='carpet.aaxis', **kwargs + ): + super(ArraydtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/carpet/aaxis/_arraydtick.py b/plotly/validators/carpet/aaxis/_arraydtick.py deleted file mode 100644 index 02aede0cd7f..00000000000 --- a/plotly/validators/carpet/aaxis/_arraydtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArraydtickValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='arraydtick', parent_name='carpet.aaxis', **kwargs - ): - super(ArraydtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_arraytick0.py b/plotly/validators/carpet/aaxis/_arraytick0.py deleted file mode 100644 index 1fdc5b09120..00000000000 --- a/plotly/validators/carpet/aaxis/_arraytick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Arraytick0Validator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='arraytick0', parent_name='carpet.aaxis', **kwargs - ): - super(Arraytick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_autorange.py b/plotly/validators/carpet/aaxis/_autorange.py deleted file mode 100644 index 290bbb0dee5..00000000000 --- a/plotly/validators/carpet/aaxis/_autorange.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutorangeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='autorange', parent_name='carpet.aaxis', **kwargs - ): - super(AutorangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', [True, False, 'reversed']), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_categoryarray.py b/plotly/validators/carpet/aaxis/_categoryarray.py deleted file mode 100644 index e0ffe746034..00000000000 --- a/plotly/validators/carpet/aaxis/_categoryarray.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='categoryarray', - parent_name='carpet.aaxis', - **kwargs - ): - super(CategoryarrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_categoryarraysrc.py b/plotly/validators/carpet/aaxis/_categoryarraysrc.py deleted file mode 100644 index d02d5b26780..00000000000 --- a/plotly/validators/carpet/aaxis/_categoryarraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='categoryarraysrc', - parent_name='carpet.aaxis', - **kwargs - ): - super(CategoryarraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_categoryorder.py b/plotly/validators/carpet/aaxis/_categoryorder.py deleted file mode 100644 index ec4cd0ede41..00000000000 --- a/plotly/validators/carpet/aaxis/_categoryorder.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='categoryorder', - parent_name='carpet.aaxis', - **kwargs - ): - super(CategoryorderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'trace', 'category ascending', 'category descending', - 'array' - ] - ), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_cheatertype.py b/plotly/validators/carpet/aaxis/_cheatertype.py deleted file mode 100644 index b74dfad9812..00000000000 --- a/plotly/validators/carpet/aaxis/_cheatertype.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CheatertypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='cheatertype', parent_name='carpet.aaxis', **kwargs - ): - super(CheatertypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['index', 'value']), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_color.py b/plotly/validators/carpet/aaxis/_color.py deleted file mode 100644 index 414e2995f8f..00000000000 --- a/plotly/validators/carpet/aaxis/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='carpet.aaxis', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_dtick.py b/plotly/validators/carpet/aaxis/_dtick.py deleted file mode 100644 index 93c0f65eb9b..00000000000 --- a/plotly/validators/carpet/aaxis/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='dtick', parent_name='carpet.aaxis', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_endline.py b/plotly/validators/carpet/aaxis/_endline.py deleted file mode 100644 index be506f966d4..00000000000 --- a/plotly/validators/carpet/aaxis/_endline.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='endline', parent_name='carpet.aaxis', **kwargs - ): - super(EndlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_endlinecolor.py b/plotly/validators/carpet/aaxis/_endlinecolor.py deleted file mode 100644 index d6b45422f50..00000000000 --- a/plotly/validators/carpet/aaxis/_endlinecolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='endlinecolor', parent_name='carpet.aaxis', **kwargs - ): - super(EndlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_endlinewidth.py b/plotly/validators/carpet/aaxis/_endlinewidth.py deleted file mode 100644 index 571236f6170..00000000000 --- a/plotly/validators/carpet/aaxis/_endlinewidth.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='endlinewidth', parent_name='carpet.aaxis', **kwargs - ): - super(EndlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_exponentformat.py b/plotly/validators/carpet/aaxis/_exponentformat.py deleted file mode 100644 index 6254fa3ab05..00000000000 --- a/plotly/validators/carpet/aaxis/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='carpet.aaxis', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_fixedrange.py b/plotly/validators/carpet/aaxis/_fixedrange.py deleted file mode 100644 index 1fdaff8fa6e..00000000000 --- a/plotly/validators/carpet/aaxis/_fixedrange.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FixedrangeValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='fixedrange', parent_name='carpet.aaxis', **kwargs - ): - super(FixedrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_gridcolor.py b/plotly/validators/carpet/aaxis/_gridcolor.py deleted file mode 100644 index 41a2cde2d94..00000000000 --- a/plotly/validators/carpet/aaxis/_gridcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='gridcolor', parent_name='carpet.aaxis', **kwargs - ): - super(GridcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_gridwidth.py b/plotly/validators/carpet/aaxis/_gridwidth.py deleted file mode 100644 index 05ba20cdb76..00000000000 --- a/plotly/validators/carpet/aaxis/_gridwidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='gridwidth', parent_name='carpet.aaxis', **kwargs - ): - super(GridwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_labelpadding.py b/plotly/validators/carpet/aaxis/_labelpadding.py deleted file mode 100644 index 6e2853be334..00000000000 --- a/plotly/validators/carpet/aaxis/_labelpadding.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelpaddingValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='labelpadding', parent_name='carpet.aaxis', **kwargs - ): - super(LabelpaddingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_labelprefix.py b/plotly/validators/carpet/aaxis/_labelprefix.py deleted file mode 100644 index 43df9af2c07..00000000000 --- a/plotly/validators/carpet/aaxis/_labelprefix.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='labelprefix', parent_name='carpet.aaxis', **kwargs - ): - super(LabelprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_labelsuffix.py b/plotly/validators/carpet/aaxis/_labelsuffix.py deleted file mode 100644 index d9b38329895..00000000000 --- a/plotly/validators/carpet/aaxis/_labelsuffix.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelsuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='labelsuffix', parent_name='carpet.aaxis', **kwargs - ): - super(LabelsuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_linecolor.py b/plotly/validators/carpet/aaxis/_linecolor.py deleted file mode 100644 index 533866a87c3..00000000000 --- a/plotly/validators/carpet/aaxis/_linecolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='linecolor', parent_name='carpet.aaxis', **kwargs - ): - super(LinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_linewidth.py b/plotly/validators/carpet/aaxis/_linewidth.py deleted file mode 100644 index 8d4dda4783b..00000000000 --- a/plotly/validators/carpet/aaxis/_linewidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='linewidth', parent_name='carpet.aaxis', **kwargs - ): - super(LinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_minorgridcolor.py b/plotly/validators/carpet/aaxis/_minorgridcolor.py deleted file mode 100644 index 23e8f15103f..00000000000 --- a/plotly/validators/carpet/aaxis/_minorgridcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class MinorgridcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='minorgridcolor', - parent_name='carpet.aaxis', - **kwargs - ): - super(MinorgridcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_minorgridcount.py b/plotly/validators/carpet/aaxis/_minorgridcount.py deleted file mode 100644 index ed4b5d7a22b..00000000000 --- a/plotly/validators/carpet/aaxis/_minorgridcount.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class MinorgridcountValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='minorgridcount', - parent_name='carpet.aaxis', - **kwargs - ): - super(MinorgridcountValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_minorgridwidth.py b/plotly/validators/carpet/aaxis/_minorgridwidth.py deleted file mode 100644 index 2ee9c008ed1..00000000000 --- a/plotly/validators/carpet/aaxis/_minorgridwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class MinorgridwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='minorgridwidth', - parent_name='carpet.aaxis', - **kwargs - ): - super(MinorgridwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_nticks.py b/plotly/validators/carpet/aaxis/_nticks.py deleted file mode 100644 index 05536b2c869..00000000000 --- a/plotly/validators/carpet/aaxis/_nticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nticks', parent_name='carpet.aaxis', **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_range.py b/plotly/validators/carpet/aaxis/_range.py deleted file mode 100644 index 242d40acba9..00000000000 --- a/plotly/validators/carpet/aaxis/_range.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='range', parent_name='carpet.aaxis', **kwargs - ): - super(RangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'calc' - }, { - 'valType': 'any', - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_rangemode.py b/plotly/validators/carpet/aaxis/_rangemode.py deleted file mode 100644 index 94af67c1b58..00000000000 --- a/plotly/validators/carpet/aaxis/_rangemode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='rangemode', parent_name='carpet.aaxis', **kwargs - ): - super(RangemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['normal', 'tozero', 'nonnegative']), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_separatethousands.py b/plotly/validators/carpet/aaxis/_separatethousands.py deleted file mode 100644 index 005be9c6149..00000000000 --- a/plotly/validators/carpet/aaxis/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='carpet.aaxis', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_showexponent.py b/plotly/validators/carpet/aaxis/_showexponent.py deleted file mode 100644 index cca675a72b7..00000000000 --- a/plotly/validators/carpet/aaxis/_showexponent.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='showexponent', parent_name='carpet.aaxis', **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_showgrid.py b/plotly/validators/carpet/aaxis/_showgrid.py deleted file mode 100644 index eb091fe9f40..00000000000 --- a/plotly/validators/carpet/aaxis/_showgrid.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showgrid', parent_name='carpet.aaxis', **kwargs - ): - super(ShowgridValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_showline.py b/plotly/validators/carpet/aaxis/_showline.py deleted file mode 100644 index 44d9e681948..00000000000 --- a/plotly/validators/carpet/aaxis/_showline.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showline', parent_name='carpet.aaxis', **kwargs - ): - super(ShowlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_showticklabels.py b/plotly/validators/carpet/aaxis/_showticklabels.py deleted file mode 100644 index f2690b8ba7d..00000000000 --- a/plotly/validators/carpet/aaxis/_showticklabels.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='carpet.aaxis', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['start', 'end', 'both', 'none']), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_showtickprefix.py b/plotly/validators/carpet/aaxis/_showtickprefix.py deleted file mode 100644 index 7411cedb77d..00000000000 --- a/plotly/validators/carpet/aaxis/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='carpet.aaxis', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_showticksuffix.py b/plotly/validators/carpet/aaxis/_showticksuffix.py deleted file mode 100644 index 0ee74c2db60..00000000000 --- a/plotly/validators/carpet/aaxis/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='carpet.aaxis', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_smoothing.py b/plotly/validators/carpet/aaxis/_smoothing.py deleted file mode 100644 index 9b251cbdc29..00000000000 --- a/plotly/validators/carpet/aaxis/_smoothing.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='smoothing', parent_name='carpet.aaxis', **kwargs - ): - super(SmoothingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1.3), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_startline.py b/plotly/validators/carpet/aaxis/_startline.py deleted file mode 100644 index ad3e88b9ed7..00000000000 --- a/plotly/validators/carpet/aaxis/_startline.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='startline', parent_name='carpet.aaxis', **kwargs - ): - super(StartlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_startlinecolor.py b/plotly/validators/carpet/aaxis/_startlinecolor.py deleted file mode 100644 index 27f44fec7b8..00000000000 --- a/plotly/validators/carpet/aaxis/_startlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='startlinecolor', - parent_name='carpet.aaxis', - **kwargs - ): - super(StartlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_startlinewidth.py b/plotly/validators/carpet/aaxis/_startlinewidth.py deleted file mode 100644 index 3c8e870c3f1..00000000000 --- a/plotly/validators/carpet/aaxis/_startlinewidth.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='startlinewidth', - parent_name='carpet.aaxis', - **kwargs - ): - super(StartlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_tick0.py b/plotly/validators/carpet/aaxis/_tick0.py deleted file mode 100644 index 7a5d312055b..00000000000 --- a/plotly/validators/carpet/aaxis/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='tick0', parent_name='carpet.aaxis', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_tickangle.py b/plotly/validators/carpet/aaxis/_tickangle.py deleted file mode 100644 index 22730a479f3..00000000000 --- a/plotly/validators/carpet/aaxis/_tickangle.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, plotly_name='tickangle', parent_name='carpet.aaxis', **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_tickfont.py b/plotly/validators/carpet/aaxis/_tickfont.py deleted file mode 100644 index b78b9a5f750..00000000000 --- a/plotly/validators/carpet/aaxis/_tickfont.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='tickfont', parent_name='carpet.aaxis', **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_tickformat.py b/plotly/validators/carpet/aaxis/_tickformat.py deleted file mode 100644 index 6f36347bb71..00000000000 --- a/plotly/validators/carpet/aaxis/_tickformat.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='tickformat', parent_name='carpet.aaxis', **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_tickformatstopdefaults.py b/plotly/validators/carpet/aaxis/_tickformatstopdefaults.py deleted file mode 100644 index 517d3fc4f6e..00000000000 --- a/plotly/validators/carpet/aaxis/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='carpet.aaxis', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_tickformatstops.py b/plotly/validators/carpet/aaxis/_tickformatstops.py deleted file mode 100644 index 128d913a7e4..00000000000 --- a/plotly/validators/carpet/aaxis/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='carpet.aaxis', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_tickmode.py b/plotly/validators/carpet/aaxis/_tickmode.py deleted file mode 100644 index 819c3fc97a6..00000000000 --- a/plotly/validators/carpet/aaxis/_tickmode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='tickmode', parent_name='carpet.aaxis', **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_tickprefix.py b/plotly/validators/carpet/aaxis/_tickprefix.py deleted file mode 100644 index 44d39a0ffdf..00000000000 --- a/plotly/validators/carpet/aaxis/_tickprefix.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='tickprefix', parent_name='carpet.aaxis', **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_ticksuffix.py b/plotly/validators/carpet/aaxis/_ticksuffix.py deleted file mode 100644 index 05a3a075fbf..00000000000 --- a/plotly/validators/carpet/aaxis/_ticksuffix.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='ticksuffix', parent_name='carpet.aaxis', **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_ticktext.py b/plotly/validators/carpet/aaxis/_ticktext.py deleted file mode 100644 index 4a7c59573b4..00000000000 --- a/plotly/validators/carpet/aaxis/_ticktext.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ticktext', parent_name='carpet.aaxis', **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_ticktextsrc.py b/plotly/validators/carpet/aaxis/_ticktextsrc.py deleted file mode 100644 index 33f44c4f24c..00000000000 --- a/plotly/validators/carpet/aaxis/_ticktextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='ticktextsrc', parent_name='carpet.aaxis', **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_tickvals.py b/plotly/validators/carpet/aaxis/_tickvals.py deleted file mode 100644 index d3d605db468..00000000000 --- a/plotly/validators/carpet/aaxis/_tickvals.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='tickvals', parent_name='carpet.aaxis', **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_tickvalssrc.py b/plotly/validators/carpet/aaxis/_tickvalssrc.py deleted file mode 100644 index 1ce4ba339ef..00000000000 --- a/plotly/validators/carpet/aaxis/_tickvalssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='tickvalssrc', parent_name='carpet.aaxis', **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_title.py b/plotly/validators/carpet/aaxis/_title.py deleted file mode 100644 index d7b259c728c..00000000000 --- a/plotly/validators/carpet/aaxis/_title.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='carpet.aaxis', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this axis' title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - offset - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/_type.py b/plotly/validators/carpet/aaxis/_type.py deleted file mode 100644 index 9220f13b0ea..00000000000 --- a/plotly/validators/carpet/aaxis/_type.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='carpet.aaxis', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['-', 'linear', 'date', 'category']), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/tickfont/__init__.py b/plotly/validators/carpet/aaxis/tickfont/__init__.py index 199d72e71c6..eeaeafcc413 100644 --- a/plotly/validators/carpet/aaxis/tickfont/__init__.py +++ b/plotly/validators/carpet/aaxis/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='carpet.aaxis.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='carpet.aaxis.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='carpet.aaxis.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/carpet/aaxis/tickfont/_color.py b/plotly/validators/carpet/aaxis/tickfont/_color.py deleted file mode 100644 index c9d97a0ace1..00000000000 --- a/plotly/validators/carpet/aaxis/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='carpet.aaxis.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/tickfont/_family.py b/plotly/validators/carpet/aaxis/tickfont/_family.py deleted file mode 100644 index d34ff2859af..00000000000 --- a/plotly/validators/carpet/aaxis/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='carpet.aaxis.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/tickfont/_size.py b/plotly/validators/carpet/aaxis/tickfont/_size.py deleted file mode 100644 index 38e50462f12..00000000000 --- a/plotly/validators/carpet/aaxis/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='carpet.aaxis.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/tickformatstop/__init__.py b/plotly/validators/carpet/aaxis/tickformatstop/__init__.py index 3f6c06cac47..de96118d5cb 100644 --- a/plotly/validators/carpet/aaxis/tickformatstop/__init__.py +++ b/plotly/validators/carpet/aaxis/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='carpet.aaxis.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='carpet.aaxis.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='carpet.aaxis.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='carpet.aaxis.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='carpet.aaxis.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'calc' + }, { + 'valType': 'any', + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/carpet/aaxis/tickformatstop/_dtickrange.py b/plotly/validators/carpet/aaxis/tickformatstop/_dtickrange.py deleted file mode 100644 index b5885d15778..00000000000 --- a/plotly/validators/carpet/aaxis/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='carpet.aaxis.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'calc' - }, { - 'valType': 'any', - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/tickformatstop/_enabled.py b/plotly/validators/carpet/aaxis/tickformatstop/_enabled.py deleted file mode 100644 index 9ded6f43313..00000000000 --- a/plotly/validators/carpet/aaxis/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='carpet.aaxis.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/tickformatstop/_name.py b/plotly/validators/carpet/aaxis/tickformatstop/_name.py deleted file mode 100644 index c2ace208241..00000000000 --- a/plotly/validators/carpet/aaxis/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='carpet.aaxis.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/tickformatstop/_templateitemname.py b/plotly/validators/carpet/aaxis/tickformatstop/_templateitemname.py deleted file mode 100644 index 092ee9ae232..00000000000 --- a/plotly/validators/carpet/aaxis/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='carpet.aaxis.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/tickformatstop/_value.py b/plotly/validators/carpet/aaxis/tickformatstop/_value.py deleted file mode 100644 index d78e652c9b2..00000000000 --- a/plotly/validators/carpet/aaxis/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='carpet.aaxis.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/title/__init__.py b/plotly/validators/carpet/aaxis/title/__init__.py index 9e8ac2e442b..2b219332296 100644 --- a/plotly/validators/carpet/aaxis/title/__init__.py +++ b/plotly/validators/carpet/aaxis/title/__init__.py @@ -1,3 +1,74 @@ -from ._text import TextValidator -from ._offset import OffsetValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='text', parent_name='carpet.aaxis.title', **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OffsetValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='offset', parent_name='carpet.aaxis.title', **kwargs + ): + super(OffsetValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='carpet.aaxis.title', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/carpet/aaxis/title/_font.py b/plotly/validators/carpet/aaxis/title/_font.py deleted file mode 100644 index ffc5b8b34a0..00000000000 --- a/plotly/validators/carpet/aaxis/title/_font.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='carpet.aaxis.title', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/title/_offset.py b/plotly/validators/carpet/aaxis/title/_offset.py deleted file mode 100644 index ff210b5f9c9..00000000000 --- a/plotly/validators/carpet/aaxis/title/_offset.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OffsetValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='offset', parent_name='carpet.aaxis.title', **kwargs - ): - super(OffsetValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/title/_text.py b/plotly/validators/carpet/aaxis/title/_text.py deleted file mode 100644 index b33ecb20542..00000000000 --- a/plotly/validators/carpet/aaxis/title/_text.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='text', parent_name='carpet.aaxis.title', **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/title/font/__init__.py b/plotly/validators/carpet/aaxis/title/font/__init__.py index 199d72e71c6..26f6a6431ed 100644 --- a/plotly/validators/carpet/aaxis/title/font/__init__.py +++ b/plotly/validators/carpet/aaxis/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='carpet.aaxis.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='carpet.aaxis.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='carpet.aaxis.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/carpet/aaxis/title/font/_color.py b/plotly/validators/carpet/aaxis/title/font/_color.py deleted file mode 100644 index bf683a8b7eb..00000000000 --- a/plotly/validators/carpet/aaxis/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='carpet.aaxis.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/title/font/_family.py b/plotly/validators/carpet/aaxis/title/font/_family.py deleted file mode 100644 index f15fcedd9d1..00000000000 --- a/plotly/validators/carpet/aaxis/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='carpet.aaxis.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/carpet/aaxis/title/font/_size.py b/plotly/validators/carpet/aaxis/title/font/_size.py deleted file mode 100644 index 46d704a69f1..00000000000 --- a/plotly/validators/carpet/aaxis/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='carpet.aaxis.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/__init__.py b/plotly/validators/carpet/baxis/__init__.py index 2e0cb044446..0da1a393f2e 100644 --- a/plotly/validators/carpet/baxis/__init__.py +++ b/plotly/validators/carpet/baxis/__init__.py @@ -1,53 +1,1076 @@ -from ._type import TypeValidator -from ._title import TitleValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._startlinewidth import StartlinewidthValidator -from ._startlinecolor import StartlinecolorValidator -from ._startline import StartlineValidator -from ._smoothing import SmoothingValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showline import ShowlineValidator -from ._showgrid import ShowgridValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._rangemode import RangemodeValidator -from ._range import RangeValidator -from ._nticks import NticksValidator -from ._minorgridwidth import MinorgridwidthValidator -from ._minorgridcount import MinorgridcountValidator -from ._minorgridcolor import MinorgridcolorValidator -from ._linewidth import LinewidthValidator -from ._linecolor import LinecolorValidator -from ._labelsuffix import LabelsuffixValidator -from ._labelprefix import LabelprefixValidator -from ._labelpadding import LabelpaddingValidator -from ._gridwidth import GridwidthValidator -from ._gridcolor import GridcolorValidator -from ._fixedrange import FixedrangeValidator -from ._exponentformat import ExponentformatValidator -from ._endlinewidth import EndlinewidthValidator -from ._endlinecolor import EndlinecolorValidator -from ._endline import EndlineValidator -from ._dtick import DtickValidator -from ._color import ColorValidator -from ._cheatertype import CheatertypeValidator -from ._categoryorder import CategoryorderValidator -from ._categoryarraysrc import CategoryarraysrcValidator -from ._categoryarray import CategoryarrayValidator -from ._autorange import AutorangeValidator -from ._arraytick0 import Arraytick0Validator -from ._arraydtick import ArraydtickValidator + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='carpet.baxis', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['-', 'linear', 'date', 'category']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='carpet.baxis', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this axis' title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + offset + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='tickvalssrc', parent_name='carpet.baxis', **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='tickvals', parent_name='carpet.baxis', **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='ticktextsrc', parent_name='carpet.baxis', **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ticktext', parent_name='carpet.baxis', **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='ticksuffix', parent_name='carpet.baxis', **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='tickprefix', parent_name='carpet.baxis', **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='tickmode', parent_name='carpet.baxis', **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='carpet.baxis', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='carpet.baxis', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='tickformat', parent_name='carpet.baxis', **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='tickfont', parent_name='carpet.baxis', **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, plotly_name='tickangle', parent_name='carpet.baxis', **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='tick0', parent_name='carpet.baxis', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StartlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='startlinewidth', + parent_name='carpet.baxis', + **kwargs + ): + super(StartlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StartlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='startlinecolor', + parent_name='carpet.baxis', + **kwargs + ): + super(StartlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StartlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='startline', parent_name='carpet.baxis', **kwargs + ): + super(StartlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='smoothing', parent_name='carpet.baxis', **kwargs + ): + super(SmoothingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1.3), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='carpet.baxis', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='carpet.baxis', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='carpet.baxis', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['start', 'end', 'both', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showline', parent_name='carpet.baxis', **kwargs + ): + super(ShowlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showgrid', parent_name='carpet.baxis', **kwargs + ): + super(ShowgridValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='showexponent', parent_name='carpet.baxis', **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='carpet.baxis', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='rangemode', parent_name='carpet.baxis', **kwargs + ): + super(RangemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['normal', 'tozero', 'nonnegative']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='range', parent_name='carpet.baxis', **kwargs + ): + super(RangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'calc' + }, { + 'valType': 'any', + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nticks', parent_name='carpet.baxis', **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MinorgridwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='minorgridwidth', + parent_name='carpet.baxis', + **kwargs + ): + super(MinorgridwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MinorgridcountValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='minorgridcount', + parent_name='carpet.baxis', + **kwargs + ): + super(MinorgridcountValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MinorgridcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='minorgridcolor', + parent_name='carpet.baxis', + **kwargs + ): + super(MinorgridcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='linewidth', parent_name='carpet.baxis', **kwargs + ): + super(LinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='linecolor', parent_name='carpet.baxis', **kwargs + ): + super(LinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelsuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='labelsuffix', parent_name='carpet.baxis', **kwargs + ): + super(LabelsuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='labelprefix', parent_name='carpet.baxis', **kwargs + ): + super(LabelprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelpaddingValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='labelpadding', parent_name='carpet.baxis', **kwargs + ): + super(LabelpaddingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='gridwidth', parent_name='carpet.baxis', **kwargs + ): + super(GridwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='gridcolor', parent_name='carpet.baxis', **kwargs + ): + super(GridcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FixedrangeValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='fixedrange', parent_name='carpet.baxis', **kwargs + ): + super(FixedrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='carpet.baxis', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='endlinewidth', parent_name='carpet.baxis', **kwargs + ): + super(EndlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='endlinecolor', parent_name='carpet.baxis', **kwargs + ): + super(EndlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='endline', parent_name='carpet.baxis', **kwargs + ): + super(EndlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='dtick', parent_name='carpet.baxis', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='carpet.baxis', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CheatertypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='cheatertype', parent_name='carpet.baxis', **kwargs + ): + super(CheatertypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['index', 'value']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='categoryorder', + parent_name='carpet.baxis', + **kwargs + ): + super(CategoryorderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'trace', 'category ascending', 'category descending', + 'array' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='categoryarraysrc', + parent_name='carpet.baxis', + **kwargs + ): + super(CategoryarraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='categoryarray', + parent_name='carpet.baxis', + **kwargs + ): + super(CategoryarrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutorangeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='autorange', parent_name='carpet.baxis', **kwargs + ): + super(AutorangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', [True, False, 'reversed']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Arraytick0Validator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='arraytick0', parent_name='carpet.baxis', **kwargs + ): + super(Arraytick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArraydtickValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='arraydtick', parent_name='carpet.baxis', **kwargs + ): + super(ArraydtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/carpet/baxis/_arraydtick.py b/plotly/validators/carpet/baxis/_arraydtick.py deleted file mode 100644 index e20e2f26ca0..00000000000 --- a/plotly/validators/carpet/baxis/_arraydtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArraydtickValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='arraydtick', parent_name='carpet.baxis', **kwargs - ): - super(ArraydtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_arraytick0.py b/plotly/validators/carpet/baxis/_arraytick0.py deleted file mode 100644 index 44ab89867b4..00000000000 --- a/plotly/validators/carpet/baxis/_arraytick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Arraytick0Validator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='arraytick0', parent_name='carpet.baxis', **kwargs - ): - super(Arraytick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_autorange.py b/plotly/validators/carpet/baxis/_autorange.py deleted file mode 100644 index c375b2ada1d..00000000000 --- a/plotly/validators/carpet/baxis/_autorange.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutorangeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='autorange', parent_name='carpet.baxis', **kwargs - ): - super(AutorangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', [True, False, 'reversed']), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_categoryarray.py b/plotly/validators/carpet/baxis/_categoryarray.py deleted file mode 100644 index 5ddc7a03e48..00000000000 --- a/plotly/validators/carpet/baxis/_categoryarray.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='categoryarray', - parent_name='carpet.baxis', - **kwargs - ): - super(CategoryarrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_categoryarraysrc.py b/plotly/validators/carpet/baxis/_categoryarraysrc.py deleted file mode 100644 index 2215bebb7f8..00000000000 --- a/plotly/validators/carpet/baxis/_categoryarraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='categoryarraysrc', - parent_name='carpet.baxis', - **kwargs - ): - super(CategoryarraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_categoryorder.py b/plotly/validators/carpet/baxis/_categoryorder.py deleted file mode 100644 index 6c2c2fe5fa2..00000000000 --- a/plotly/validators/carpet/baxis/_categoryorder.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='categoryorder', - parent_name='carpet.baxis', - **kwargs - ): - super(CategoryorderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'trace', 'category ascending', 'category descending', - 'array' - ] - ), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_cheatertype.py b/plotly/validators/carpet/baxis/_cheatertype.py deleted file mode 100644 index a3c4839adc7..00000000000 --- a/plotly/validators/carpet/baxis/_cheatertype.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CheatertypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='cheatertype', parent_name='carpet.baxis', **kwargs - ): - super(CheatertypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['index', 'value']), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_color.py b/plotly/validators/carpet/baxis/_color.py deleted file mode 100644 index a2f5ba28fa3..00000000000 --- a/plotly/validators/carpet/baxis/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='carpet.baxis', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_dtick.py b/plotly/validators/carpet/baxis/_dtick.py deleted file mode 100644 index fb20bfe77d9..00000000000 --- a/plotly/validators/carpet/baxis/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='dtick', parent_name='carpet.baxis', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_endline.py b/plotly/validators/carpet/baxis/_endline.py deleted file mode 100644 index 3fff318f7bd..00000000000 --- a/plotly/validators/carpet/baxis/_endline.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='endline', parent_name='carpet.baxis', **kwargs - ): - super(EndlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_endlinecolor.py b/plotly/validators/carpet/baxis/_endlinecolor.py deleted file mode 100644 index 6060743986d..00000000000 --- a/plotly/validators/carpet/baxis/_endlinecolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='endlinecolor', parent_name='carpet.baxis', **kwargs - ): - super(EndlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_endlinewidth.py b/plotly/validators/carpet/baxis/_endlinewidth.py deleted file mode 100644 index 30b598e47eb..00000000000 --- a/plotly/validators/carpet/baxis/_endlinewidth.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='endlinewidth', parent_name='carpet.baxis', **kwargs - ): - super(EndlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_exponentformat.py b/plotly/validators/carpet/baxis/_exponentformat.py deleted file mode 100644 index dc37f342f3c..00000000000 --- a/plotly/validators/carpet/baxis/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='carpet.baxis', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_fixedrange.py b/plotly/validators/carpet/baxis/_fixedrange.py deleted file mode 100644 index 8b114b052c3..00000000000 --- a/plotly/validators/carpet/baxis/_fixedrange.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FixedrangeValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='fixedrange', parent_name='carpet.baxis', **kwargs - ): - super(FixedrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_gridcolor.py b/plotly/validators/carpet/baxis/_gridcolor.py deleted file mode 100644 index f33422258a5..00000000000 --- a/plotly/validators/carpet/baxis/_gridcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='gridcolor', parent_name='carpet.baxis', **kwargs - ): - super(GridcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_gridwidth.py b/plotly/validators/carpet/baxis/_gridwidth.py deleted file mode 100644 index 2eaed5db9f5..00000000000 --- a/plotly/validators/carpet/baxis/_gridwidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='gridwidth', parent_name='carpet.baxis', **kwargs - ): - super(GridwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_labelpadding.py b/plotly/validators/carpet/baxis/_labelpadding.py deleted file mode 100644 index 73e4c68ac9f..00000000000 --- a/plotly/validators/carpet/baxis/_labelpadding.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelpaddingValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='labelpadding', parent_name='carpet.baxis', **kwargs - ): - super(LabelpaddingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_labelprefix.py b/plotly/validators/carpet/baxis/_labelprefix.py deleted file mode 100644 index 94b74a0f8ce..00000000000 --- a/plotly/validators/carpet/baxis/_labelprefix.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='labelprefix', parent_name='carpet.baxis', **kwargs - ): - super(LabelprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_labelsuffix.py b/plotly/validators/carpet/baxis/_labelsuffix.py deleted file mode 100644 index b7f3f30faf9..00000000000 --- a/plotly/validators/carpet/baxis/_labelsuffix.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelsuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='labelsuffix', parent_name='carpet.baxis', **kwargs - ): - super(LabelsuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_linecolor.py b/plotly/validators/carpet/baxis/_linecolor.py deleted file mode 100644 index 8f6f0472090..00000000000 --- a/plotly/validators/carpet/baxis/_linecolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='linecolor', parent_name='carpet.baxis', **kwargs - ): - super(LinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_linewidth.py b/plotly/validators/carpet/baxis/_linewidth.py deleted file mode 100644 index 600e7fb6cf8..00000000000 --- a/plotly/validators/carpet/baxis/_linewidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='linewidth', parent_name='carpet.baxis', **kwargs - ): - super(LinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_minorgridcolor.py b/plotly/validators/carpet/baxis/_minorgridcolor.py deleted file mode 100644 index 4555646559c..00000000000 --- a/plotly/validators/carpet/baxis/_minorgridcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class MinorgridcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='minorgridcolor', - parent_name='carpet.baxis', - **kwargs - ): - super(MinorgridcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_minorgridcount.py b/plotly/validators/carpet/baxis/_minorgridcount.py deleted file mode 100644 index 02ab2e154a6..00000000000 --- a/plotly/validators/carpet/baxis/_minorgridcount.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class MinorgridcountValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='minorgridcount', - parent_name='carpet.baxis', - **kwargs - ): - super(MinorgridcountValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_minorgridwidth.py b/plotly/validators/carpet/baxis/_minorgridwidth.py deleted file mode 100644 index b470f2628a3..00000000000 --- a/plotly/validators/carpet/baxis/_minorgridwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class MinorgridwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='minorgridwidth', - parent_name='carpet.baxis', - **kwargs - ): - super(MinorgridwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_nticks.py b/plotly/validators/carpet/baxis/_nticks.py deleted file mode 100644 index 4589173c36c..00000000000 --- a/plotly/validators/carpet/baxis/_nticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nticks', parent_name='carpet.baxis', **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_range.py b/plotly/validators/carpet/baxis/_range.py deleted file mode 100644 index 4a7c914d507..00000000000 --- a/plotly/validators/carpet/baxis/_range.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='range', parent_name='carpet.baxis', **kwargs - ): - super(RangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'calc' - }, { - 'valType': 'any', - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_rangemode.py b/plotly/validators/carpet/baxis/_rangemode.py deleted file mode 100644 index 341f3567c0d..00000000000 --- a/plotly/validators/carpet/baxis/_rangemode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='rangemode', parent_name='carpet.baxis', **kwargs - ): - super(RangemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['normal', 'tozero', 'nonnegative']), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_separatethousands.py b/plotly/validators/carpet/baxis/_separatethousands.py deleted file mode 100644 index c7d121aadcc..00000000000 --- a/plotly/validators/carpet/baxis/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='carpet.baxis', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_showexponent.py b/plotly/validators/carpet/baxis/_showexponent.py deleted file mode 100644 index b9ff2042ee0..00000000000 --- a/plotly/validators/carpet/baxis/_showexponent.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='showexponent', parent_name='carpet.baxis', **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_showgrid.py b/plotly/validators/carpet/baxis/_showgrid.py deleted file mode 100644 index a22dc5182f2..00000000000 --- a/plotly/validators/carpet/baxis/_showgrid.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showgrid', parent_name='carpet.baxis', **kwargs - ): - super(ShowgridValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_showline.py b/plotly/validators/carpet/baxis/_showline.py deleted file mode 100644 index d90fc1ea147..00000000000 --- a/plotly/validators/carpet/baxis/_showline.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showline', parent_name='carpet.baxis', **kwargs - ): - super(ShowlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_showticklabels.py b/plotly/validators/carpet/baxis/_showticklabels.py deleted file mode 100644 index 06b5b8d7db3..00000000000 --- a/plotly/validators/carpet/baxis/_showticklabels.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='carpet.baxis', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['start', 'end', 'both', 'none']), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_showtickprefix.py b/plotly/validators/carpet/baxis/_showtickprefix.py deleted file mode 100644 index 12b56492ef6..00000000000 --- a/plotly/validators/carpet/baxis/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='carpet.baxis', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_showticksuffix.py b/plotly/validators/carpet/baxis/_showticksuffix.py deleted file mode 100644 index 17aca731900..00000000000 --- a/plotly/validators/carpet/baxis/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='carpet.baxis', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_smoothing.py b/plotly/validators/carpet/baxis/_smoothing.py deleted file mode 100644 index e18878415aa..00000000000 --- a/plotly/validators/carpet/baxis/_smoothing.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='smoothing', parent_name='carpet.baxis', **kwargs - ): - super(SmoothingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1.3), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_startline.py b/plotly/validators/carpet/baxis/_startline.py deleted file mode 100644 index 2b5b553c135..00000000000 --- a/plotly/validators/carpet/baxis/_startline.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='startline', parent_name='carpet.baxis', **kwargs - ): - super(StartlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_startlinecolor.py b/plotly/validators/carpet/baxis/_startlinecolor.py deleted file mode 100644 index 63675b5ab84..00000000000 --- a/plotly/validators/carpet/baxis/_startlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='startlinecolor', - parent_name='carpet.baxis', - **kwargs - ): - super(StartlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_startlinewidth.py b/plotly/validators/carpet/baxis/_startlinewidth.py deleted file mode 100644 index b24a6a63e57..00000000000 --- a/plotly/validators/carpet/baxis/_startlinewidth.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='startlinewidth', - parent_name='carpet.baxis', - **kwargs - ): - super(StartlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_tick0.py b/plotly/validators/carpet/baxis/_tick0.py deleted file mode 100644 index 94ed4a8ab8a..00000000000 --- a/plotly/validators/carpet/baxis/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='tick0', parent_name='carpet.baxis', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_tickangle.py b/plotly/validators/carpet/baxis/_tickangle.py deleted file mode 100644 index fba5e788946..00000000000 --- a/plotly/validators/carpet/baxis/_tickangle.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, plotly_name='tickangle', parent_name='carpet.baxis', **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_tickfont.py b/plotly/validators/carpet/baxis/_tickfont.py deleted file mode 100644 index 98f8ffc227d..00000000000 --- a/plotly/validators/carpet/baxis/_tickfont.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='tickfont', parent_name='carpet.baxis', **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_tickformat.py b/plotly/validators/carpet/baxis/_tickformat.py deleted file mode 100644 index eece9484805..00000000000 --- a/plotly/validators/carpet/baxis/_tickformat.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='tickformat', parent_name='carpet.baxis', **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_tickformatstopdefaults.py b/plotly/validators/carpet/baxis/_tickformatstopdefaults.py deleted file mode 100644 index 755c66c46b2..00000000000 --- a/plotly/validators/carpet/baxis/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='carpet.baxis', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_tickformatstops.py b/plotly/validators/carpet/baxis/_tickformatstops.py deleted file mode 100644 index c831fe775d3..00000000000 --- a/plotly/validators/carpet/baxis/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='carpet.baxis', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_tickmode.py b/plotly/validators/carpet/baxis/_tickmode.py deleted file mode 100644 index a1dcd733a19..00000000000 --- a/plotly/validators/carpet/baxis/_tickmode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='tickmode', parent_name='carpet.baxis', **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_tickprefix.py b/plotly/validators/carpet/baxis/_tickprefix.py deleted file mode 100644 index a2991b4d8b5..00000000000 --- a/plotly/validators/carpet/baxis/_tickprefix.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='tickprefix', parent_name='carpet.baxis', **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_ticksuffix.py b/plotly/validators/carpet/baxis/_ticksuffix.py deleted file mode 100644 index dbfc66b49bc..00000000000 --- a/plotly/validators/carpet/baxis/_ticksuffix.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='ticksuffix', parent_name='carpet.baxis', **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_ticktext.py b/plotly/validators/carpet/baxis/_ticktext.py deleted file mode 100644 index 9fbdcee495d..00000000000 --- a/plotly/validators/carpet/baxis/_ticktext.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ticktext', parent_name='carpet.baxis', **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_ticktextsrc.py b/plotly/validators/carpet/baxis/_ticktextsrc.py deleted file mode 100644 index bc402e5c864..00000000000 --- a/plotly/validators/carpet/baxis/_ticktextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='ticktextsrc', parent_name='carpet.baxis', **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_tickvals.py b/plotly/validators/carpet/baxis/_tickvals.py deleted file mode 100644 index da67273e64f..00000000000 --- a/plotly/validators/carpet/baxis/_tickvals.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='tickvals', parent_name='carpet.baxis', **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_tickvalssrc.py b/plotly/validators/carpet/baxis/_tickvalssrc.py deleted file mode 100644 index e9ffdfb5d9d..00000000000 --- a/plotly/validators/carpet/baxis/_tickvalssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='tickvalssrc', parent_name='carpet.baxis', **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_title.py b/plotly/validators/carpet/baxis/_title.py deleted file mode 100644 index 406373900e9..00000000000 --- a/plotly/validators/carpet/baxis/_title.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='carpet.baxis', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this axis' title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - offset - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/_type.py b/plotly/validators/carpet/baxis/_type.py deleted file mode 100644 index b5d1d99b019..00000000000 --- a/plotly/validators/carpet/baxis/_type.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='carpet.baxis', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['-', 'linear', 'date', 'category']), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/tickfont/__init__.py b/plotly/validators/carpet/baxis/tickfont/__init__.py index 199d72e71c6..6a2336d6d08 100644 --- a/plotly/validators/carpet/baxis/tickfont/__init__.py +++ b/plotly/validators/carpet/baxis/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='carpet.baxis.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='carpet.baxis.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='carpet.baxis.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/carpet/baxis/tickfont/_color.py b/plotly/validators/carpet/baxis/tickfont/_color.py deleted file mode 100644 index b9e025c173d..00000000000 --- a/plotly/validators/carpet/baxis/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='carpet.baxis.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/tickfont/_family.py b/plotly/validators/carpet/baxis/tickfont/_family.py deleted file mode 100644 index b310438a5d5..00000000000 --- a/plotly/validators/carpet/baxis/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='carpet.baxis.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/tickfont/_size.py b/plotly/validators/carpet/baxis/tickfont/_size.py deleted file mode 100644 index d472d8dd499..00000000000 --- a/plotly/validators/carpet/baxis/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='carpet.baxis.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/tickformatstop/__init__.py b/plotly/validators/carpet/baxis/tickformatstop/__init__.py index 3f6c06cac47..77d99088526 100644 --- a/plotly/validators/carpet/baxis/tickformatstop/__init__.py +++ b/plotly/validators/carpet/baxis/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='carpet.baxis.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='carpet.baxis.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='carpet.baxis.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='carpet.baxis.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='carpet.baxis.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'calc' + }, { + 'valType': 'any', + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/carpet/baxis/tickformatstop/_dtickrange.py b/plotly/validators/carpet/baxis/tickformatstop/_dtickrange.py deleted file mode 100644 index 5c1e87d1e41..00000000000 --- a/plotly/validators/carpet/baxis/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='carpet.baxis.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'calc' - }, { - 'valType': 'any', - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/tickformatstop/_enabled.py b/plotly/validators/carpet/baxis/tickformatstop/_enabled.py deleted file mode 100644 index f461663b3fe..00000000000 --- a/plotly/validators/carpet/baxis/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='carpet.baxis.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/tickformatstop/_name.py b/plotly/validators/carpet/baxis/tickformatstop/_name.py deleted file mode 100644 index 8ff0b7a47aa..00000000000 --- a/plotly/validators/carpet/baxis/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='carpet.baxis.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/tickformatstop/_templateitemname.py b/plotly/validators/carpet/baxis/tickformatstop/_templateitemname.py deleted file mode 100644 index 6d90c4c258b..00000000000 --- a/plotly/validators/carpet/baxis/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='carpet.baxis.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/tickformatstop/_value.py b/plotly/validators/carpet/baxis/tickformatstop/_value.py deleted file mode 100644 index fe304d4596f..00000000000 --- a/plotly/validators/carpet/baxis/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='carpet.baxis.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/title/__init__.py b/plotly/validators/carpet/baxis/title/__init__.py index 9e8ac2e442b..61af5ecda0e 100644 --- a/plotly/validators/carpet/baxis/title/__init__.py +++ b/plotly/validators/carpet/baxis/title/__init__.py @@ -1,3 +1,74 @@ -from ._text import TextValidator -from ._offset import OffsetValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='text', parent_name='carpet.baxis.title', **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OffsetValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='offset', parent_name='carpet.baxis.title', **kwargs + ): + super(OffsetValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='carpet.baxis.title', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/carpet/baxis/title/_font.py b/plotly/validators/carpet/baxis/title/_font.py deleted file mode 100644 index 0f81c77178b..00000000000 --- a/plotly/validators/carpet/baxis/title/_font.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='carpet.baxis.title', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/title/_offset.py b/plotly/validators/carpet/baxis/title/_offset.py deleted file mode 100644 index 226cbf13d1d..00000000000 --- a/plotly/validators/carpet/baxis/title/_offset.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OffsetValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='offset', parent_name='carpet.baxis.title', **kwargs - ): - super(OffsetValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/title/_text.py b/plotly/validators/carpet/baxis/title/_text.py deleted file mode 100644 index 3c33af4c08a..00000000000 --- a/plotly/validators/carpet/baxis/title/_text.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='text', parent_name='carpet.baxis.title', **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/title/font/__init__.py b/plotly/validators/carpet/baxis/title/font/__init__.py index 199d72e71c6..2f142d4a045 100644 --- a/plotly/validators/carpet/baxis/title/font/__init__.py +++ b/plotly/validators/carpet/baxis/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='carpet.baxis.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='carpet.baxis.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='carpet.baxis.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/carpet/baxis/title/font/_color.py b/plotly/validators/carpet/baxis/title/font/_color.py deleted file mode 100644 index 1e786ca4aa7..00000000000 --- a/plotly/validators/carpet/baxis/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='carpet.baxis.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/title/font/_family.py b/plotly/validators/carpet/baxis/title/font/_family.py deleted file mode 100644 index 4980f4c044b..00000000000 --- a/plotly/validators/carpet/baxis/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='carpet.baxis.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/carpet/baxis/title/font/_size.py b/plotly/validators/carpet/baxis/title/font/_size.py deleted file mode 100644 index 545e5d70a45..00000000000 --- a/plotly/validators/carpet/baxis/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='carpet.baxis.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/font/__init__.py b/plotly/validators/carpet/font/__init__.py index 199d72e71c6..c318ae21904 100644 --- a/plotly/validators/carpet/font/__init__.py +++ b/plotly/validators/carpet/font/__init__.py @@ -1,3 +1,54 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='carpet.font', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='carpet.font', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='carpet.font', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/carpet/font/_color.py b/plotly/validators/carpet/font/_color.py deleted file mode 100644 index e90cc443b4d..00000000000 --- a/plotly/validators/carpet/font/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='carpet.font', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/font/_family.py b/plotly/validators/carpet/font/_family.py deleted file mode 100644 index 673c9b120f9..00000000000 --- a/plotly/validators/carpet/font/_family.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='carpet.font', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/carpet/font/_size.py b/plotly/validators/carpet/font/_size.py deleted file mode 100644 index e2dd19e8926..00000000000 --- a/plotly/validators/carpet/font/_size.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='carpet.font', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/hoverlabel/__init__.py b/plotly/validators/carpet/hoverlabel/__init__.py index 856f769ba33..541fde1c01e 100644 --- a/plotly/validators/carpet/hoverlabel/__init__.py +++ b/plotly/validators/carpet/hoverlabel/__init__.py @@ -1,7 +1,170 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='carpet.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='carpet.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='carpet.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='carpet.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='carpet.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='carpet.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='carpet.hoverlabel', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/carpet/hoverlabel/_bgcolor.py b/plotly/validators/carpet/hoverlabel/_bgcolor.py deleted file mode 100644 index 6969b4a267a..00000000000 --- a/plotly/validators/carpet/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='carpet.hoverlabel', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/hoverlabel/_bgcolorsrc.py b/plotly/validators/carpet/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index c5e8cfed2e0..00000000000 --- a/plotly/validators/carpet/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='carpet.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/hoverlabel/_bordercolor.py b/plotly/validators/carpet/hoverlabel/_bordercolor.py deleted file mode 100644 index 919ca49e884..00000000000 --- a/plotly/validators/carpet/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='carpet.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/hoverlabel/_bordercolorsrc.py b/plotly/validators/carpet/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 42d04face07..00000000000 --- a/plotly/validators/carpet/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='carpet.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/hoverlabel/_font.py b/plotly/validators/carpet/hoverlabel/_font.py deleted file mode 100644 index efb800e4bb7..00000000000 --- a/plotly/validators/carpet/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='carpet.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/carpet/hoverlabel/_namelength.py b/plotly/validators/carpet/hoverlabel/_namelength.py deleted file mode 100644 index 51e52d76edb..00000000000 --- a/plotly/validators/carpet/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='carpet.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/hoverlabel/_namelengthsrc.py b/plotly/validators/carpet/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 731d6b7344f..00000000000 --- a/plotly/validators/carpet/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='carpet.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/hoverlabel/font/__init__.py b/plotly/validators/carpet/hoverlabel/font/__init__.py index 1d2c591d1e5..dc2b5df9b73 100644 --- a/plotly/validators/carpet/hoverlabel/font/__init__.py +++ b/plotly/validators/carpet/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='carpet.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='carpet.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='carpet.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='carpet.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='carpet.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='carpet.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/carpet/hoverlabel/font/_color.py b/plotly/validators/carpet/hoverlabel/font/_color.py deleted file mode 100644 index 502c436084f..00000000000 --- a/plotly/validators/carpet/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='carpet.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/hoverlabel/font/_colorsrc.py b/plotly/validators/carpet/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 03fe3652ed6..00000000000 --- a/plotly/validators/carpet/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='carpet.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/hoverlabel/font/_family.py b/plotly/validators/carpet/hoverlabel/font/_family.py deleted file mode 100644 index 4cbf40a8690..00000000000 --- a/plotly/validators/carpet/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='carpet.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/carpet/hoverlabel/font/_familysrc.py b/plotly/validators/carpet/hoverlabel/font/_familysrc.py deleted file mode 100644 index b3b71b32ccf..00000000000 --- a/plotly/validators/carpet/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='carpet.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/hoverlabel/font/_size.py b/plotly/validators/carpet/hoverlabel/font/_size.py deleted file mode 100644 index 169c7590df5..00000000000 --- a/plotly/validators/carpet/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='carpet.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/carpet/hoverlabel/font/_sizesrc.py b/plotly/validators/carpet/hoverlabel/font/_sizesrc.py deleted file mode 100644 index c4cdaa1c85e..00000000000 --- a/plotly/validators/carpet/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='carpet.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/stream/__init__.py b/plotly/validators/carpet/stream/__init__.py index 2f4f2047594..96c1c5ed89e 100644 --- a/plotly/validators/carpet/stream/__init__.py +++ b/plotly/validators/carpet/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='carpet.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='carpet.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/carpet/stream/_maxpoints.py b/plotly/validators/carpet/stream/_maxpoints.py deleted file mode 100644 index 5e244bbde5a..00000000000 --- a/plotly/validators/carpet/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='carpet.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/carpet/stream/_token.py b/plotly/validators/carpet/stream/_token.py deleted file mode 100644 index b725acbf196..00000000000 --- a/plotly/validators/carpet/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='carpet.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/choropleth/__init__.py b/plotly/validators/choropleth/__init__.py index 0a066e3a7f7..bdd8d28c39f 100644 --- a/plotly/validators/choropleth/__init__.py +++ b/plotly/validators/choropleth/__init__.py @@ -1,40 +1,962 @@ -from ._zsrc import ZsrcValidator -from ._zmin import ZminValidator -from ._zmid import ZmidValidator -from ._zmax import ZmaxValidator -from ._zauto import ZautoValidator -from ._z import ZValidator -from ._visible import VisibleValidator -from ._unselected import UnselectedValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._showscale import ShowscaleValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._selected import SelectedValidator -from ._reversescale import ReversescaleValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._marker import MarkerValidator -from ._locationssrc import LocationssrcValidator -from ._locations import LocationsValidator -from ._locationmode import LocationmodeValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._geo import GeoValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='zsrc', parent_name='choropleth', **kwargs): + super(ZsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='zmin', parent_name='choropleth', **kwargs): + super(ZminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'zauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='zmid', parent_name='choropleth', **kwargs): + super(ZmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='zmax', parent_name='choropleth', **kwargs): + super(ZmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'zauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='zauto', parent_name='choropleth', **kwargs + ): + super(ZautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='z', parent_name='choropleth', **kwargs): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='choropleth', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='unselected', parent_name='choropleth', **kwargs + ): + super(UnselectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Unselected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.choropleth.unselected.Marker + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='choropleth', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='choropleth', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textsrc', parent_name='choropleth', **kwargs + ): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='choropleth', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='choropleth', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='choropleth', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='choropleth', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='choropleth', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='selected', parent_name='choropleth', **kwargs + ): + super(SelectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Selected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.choropleth.selected.Marker + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='reversescale', parent_name='choropleth', **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='choropleth', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='choropleth', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='choropleth', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + line + plotly.graph_objs.choropleth.marker.Line + instance or dict with compatible properties + opacity + Sets the opacity of the locations. + opacitysrc + Sets the source reference on plot.ly for + opacity . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LocationssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='locationssrc', parent_name='choropleth', **kwargs + ): + super(LocationssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LocationsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='locations', parent_name='choropleth', **kwargs + ): + super(LocationsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LocationmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='locationmode', parent_name='choropleth', **kwargs + ): + super(LocationmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['ISO-3', 'USA-states', 'country names'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='choropleth', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='choropleth', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='choropleth', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='choropleth', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='choropleth', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertemplatesrc', + parent_name='choropleth', + **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='choropleth', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='choropleth', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='choropleth', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='choropleth', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['location', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GeoValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='geo', parent_name='choropleth', **kwargs): + super(GeoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'geo'), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='choropleth', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='choropleth', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='choropleth', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='choropleth', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.choropleth.colorbar.Tickforma + tstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.choropleth.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of choropleth.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.choropleth.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + choropleth.colorbar.title.font instead. Sets + this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + choropleth.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autocolorscale', parent_name='choropleth', **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/choropleth/_autocolorscale.py b/plotly/validators/choropleth/_autocolorscale.py deleted file mode 100644 index a25b4774f42..00000000000 --- a/plotly/validators/choropleth/_autocolorscale.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autocolorscale', parent_name='choropleth', **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_colorbar.py b/plotly/validators/choropleth/_colorbar.py deleted file mode 100644 index ef7403e25ff..00000000000 --- a/plotly/validators/choropleth/_colorbar.py +++ /dev/null @@ -1,227 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='choropleth', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.choropleth.colorbar.Tickforma - tstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.choropleth.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of choropleth.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.choropleth.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - choropleth.colorbar.title.font instead. Sets - this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - choropleth.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/choropleth/_colorscale.py b/plotly/validators/choropleth/_colorscale.py deleted file mode 100644 index 612609c0705..00000000000 --- a/plotly/validators/choropleth/_colorscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='choropleth', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_customdata.py b/plotly/validators/choropleth/_customdata.py deleted file mode 100644 index 3c94edb304d..00000000000 --- a/plotly/validators/choropleth/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='choropleth', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_customdatasrc.py b/plotly/validators/choropleth/_customdatasrc.py deleted file mode 100644 index 2cb0c13d2b0..00000000000 --- a/plotly/validators/choropleth/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='choropleth', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_geo.py b/plotly/validators/choropleth/_geo.py deleted file mode 100644 index 51ec69d2671..00000000000 --- a/plotly/validators/choropleth/_geo.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class GeoValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='geo', parent_name='choropleth', **kwargs): - super(GeoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'geo'), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_hoverinfo.py b/plotly/validators/choropleth/_hoverinfo.py deleted file mode 100644 index b3d94413b5c..00000000000 --- a/plotly/validators/choropleth/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='choropleth', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['location', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_hoverinfosrc.py b/plotly/validators/choropleth/_hoverinfosrc.py deleted file mode 100644 index 71db9cef811..00000000000 --- a/plotly/validators/choropleth/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='choropleth', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_hoverlabel.py b/plotly/validators/choropleth/_hoverlabel.py deleted file mode 100644 index f9de2dbaea8..00000000000 --- a/plotly/validators/choropleth/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='choropleth', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/choropleth/_hovertemplate.py b/plotly/validators/choropleth/_hovertemplate.py deleted file mode 100644 index 329c31a34f1..00000000000 --- a/plotly/validators/choropleth/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='choropleth', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_hovertemplatesrc.py b/plotly/validators/choropleth/_hovertemplatesrc.py deleted file mode 100644 index 4f4856e6d7a..00000000000 --- a/plotly/validators/choropleth/_hovertemplatesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertemplatesrc', - parent_name='choropleth', - **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_hovertext.py b/plotly/validators/choropleth/_hovertext.py deleted file mode 100644 index 38fde7b42e3..00000000000 --- a/plotly/validators/choropleth/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='choropleth', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_hovertextsrc.py b/plotly/validators/choropleth/_hovertextsrc.py deleted file mode 100644 index f1e4955b029..00000000000 --- a/plotly/validators/choropleth/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='choropleth', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_ids.py b/plotly/validators/choropleth/_ids.py deleted file mode 100644 index 9c14e4046d6..00000000000 --- a/plotly/validators/choropleth/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='choropleth', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_idssrc.py b/plotly/validators/choropleth/_idssrc.py deleted file mode 100644 index 34ff8ea6cb4..00000000000 --- a/plotly/validators/choropleth/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='choropleth', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_legendgroup.py b/plotly/validators/choropleth/_legendgroup.py deleted file mode 100644 index 16438ebd236..00000000000 --- a/plotly/validators/choropleth/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='choropleth', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_locationmode.py b/plotly/validators/choropleth/_locationmode.py deleted file mode 100644 index 36fe2fa5176..00000000000 --- a/plotly/validators/choropleth/_locationmode.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LocationmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='locationmode', parent_name='choropleth', **kwargs - ): - super(LocationmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['ISO-3', 'USA-states', 'country names'] - ), - **kwargs - ) diff --git a/plotly/validators/choropleth/_locations.py b/plotly/validators/choropleth/_locations.py deleted file mode 100644 index a7f2d1c463c..00000000000 --- a/plotly/validators/choropleth/_locations.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LocationsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='locations', parent_name='choropleth', **kwargs - ): - super(LocationsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_locationssrc.py b/plotly/validators/choropleth/_locationssrc.py deleted file mode 100644 index 5a6d6a3c560..00000000000 --- a/plotly/validators/choropleth/_locationssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LocationssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='locationssrc', parent_name='choropleth', **kwargs - ): - super(LocationssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_marker.py b/plotly/validators/choropleth/_marker.py deleted file mode 100644 index 997f511ffea..00000000000 --- a/plotly/validators/choropleth/_marker.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='choropleth', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - line - plotly.graph_objs.choropleth.marker.Line - instance or dict with compatible properties - opacity - Sets the opacity of the locations. - opacitysrc - Sets the source reference on plot.ly for - opacity . -""" - ), - **kwargs - ) diff --git a/plotly/validators/choropleth/_name.py b/plotly/validators/choropleth/_name.py deleted file mode 100644 index bf07764472b..00000000000 --- a/plotly/validators/choropleth/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='choropleth', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_opacity.py b/plotly/validators/choropleth/_opacity.py deleted file mode 100644 index 6efea140e99..00000000000 --- a/plotly/validators/choropleth/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='choropleth', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_reversescale.py b/plotly/validators/choropleth/_reversescale.py deleted file mode 100644 index 28faba07370..00000000000 --- a/plotly/validators/choropleth/_reversescale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='reversescale', parent_name='choropleth', **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_selected.py b/plotly/validators/choropleth/_selected.py deleted file mode 100644 index fdb8c88120b..00000000000 --- a/plotly/validators/choropleth/_selected.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='selected', parent_name='choropleth', **kwargs - ): - super(SelectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Selected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.choropleth.selected.Marker - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/choropleth/_selectedpoints.py b/plotly/validators/choropleth/_selectedpoints.py deleted file mode 100644 index 5b128a658e8..00000000000 --- a/plotly/validators/choropleth/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='choropleth', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_showlegend.py b/plotly/validators/choropleth/_showlegend.py deleted file mode 100644 index 6a0a4263609..00000000000 --- a/plotly/validators/choropleth/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='choropleth', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_showscale.py b/plotly/validators/choropleth/_showscale.py deleted file mode 100644 index 540544eff99..00000000000 --- a/plotly/validators/choropleth/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='choropleth', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_stream.py b/plotly/validators/choropleth/_stream.py deleted file mode 100644 index 5cc3fba029b..00000000000 --- a/plotly/validators/choropleth/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='choropleth', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/choropleth/_text.py b/plotly/validators/choropleth/_text.py deleted file mode 100644 index 2c07fdf6f9d..00000000000 --- a/plotly/validators/choropleth/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='choropleth', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_textsrc.py b/plotly/validators/choropleth/_textsrc.py deleted file mode 100644 index 6ff4c29ee54..00000000000 --- a/plotly/validators/choropleth/_textsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textsrc', parent_name='choropleth', **kwargs - ): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_uid.py b/plotly/validators/choropleth/_uid.py deleted file mode 100644 index 78dea1c29b5..00000000000 --- a/plotly/validators/choropleth/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='choropleth', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_uirevision.py b/plotly/validators/choropleth/_uirevision.py deleted file mode 100644 index 4b109cedc69..00000000000 --- a/plotly/validators/choropleth/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='choropleth', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_unselected.py b/plotly/validators/choropleth/_unselected.py deleted file mode 100644 index 7197d1124ff..00000000000 --- a/plotly/validators/choropleth/_unselected.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='unselected', parent_name='choropleth', **kwargs - ): - super(UnselectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Unselected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.choropleth.unselected.Marker - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/choropleth/_visible.py b/plotly/validators/choropleth/_visible.py deleted file mode 100644 index 6b4b89f7033..00000000000 --- a/plotly/validators/choropleth/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='choropleth', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/choropleth/_z.py b/plotly/validators/choropleth/_z.py deleted file mode 100644 index 9f7e44e52b8..00000000000 --- a/plotly/validators/choropleth/_z.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='z', parent_name='choropleth', **kwargs): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_zauto.py b/plotly/validators/choropleth/_zauto.py deleted file mode 100644 index 0dd4271a864..00000000000 --- a/plotly/validators/choropleth/_zauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='zauto', parent_name='choropleth', **kwargs - ): - super(ZautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_zmax.py b/plotly/validators/choropleth/_zmax.py deleted file mode 100644 index f3aca74cc08..00000000000 --- a/plotly/validators/choropleth/_zmax.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='zmax', parent_name='choropleth', **kwargs): - super(ZmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'zauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_zmid.py b/plotly/validators/choropleth/_zmid.py deleted file mode 100644 index 31e555aa264..00000000000 --- a/plotly/validators/choropleth/_zmid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='zmid', parent_name='choropleth', **kwargs): - super(ZmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_zmin.py b/plotly/validators/choropleth/_zmin.py deleted file mode 100644 index 69585443f1e..00000000000 --- a/plotly/validators/choropleth/_zmin.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='zmin', parent_name='choropleth', **kwargs): - super(ZminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'zauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/_zsrc.py b/plotly/validators/choropleth/_zsrc.py deleted file mode 100644 index dd30482fe4e..00000000000 --- a/plotly/validators/choropleth/_zsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='zsrc', parent_name='choropleth', **kwargs): - super(ZsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/__init__.py b/plotly/validators/choropleth/colorbar/__init__.py index 3dab31f7e02..b0540c98c02 100644 --- a/plotly/validators/choropleth/colorbar/__init__.py +++ b/plotly/validators/choropleth/colorbar/__init__.py @@ -1,41 +1,909 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ypad', parent_name='choropleth.colorbar', **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='choropleth.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='choropleth.colorbar', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='xpad', parent_name='choropleth.colorbar', **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='choropleth.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='choropleth.colorbar', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='choropleth.colorbar', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='choropleth.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='choropleth.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='choropleth.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='choropleth.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='choropleth.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='choropleth.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ticks', parent_name='choropleth.colorbar', **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='choropleth.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='choropleth.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='choropleth.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='choropleth.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='choropleth.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='choropleth.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='choropleth.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='choropleth.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='choropleth.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='tick0', parent_name='choropleth.colorbar', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='choropleth.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='choropleth.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='choropleth.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='choropleth.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='choropleth.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='choropleth.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='choropleth.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='choropleth.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='choropleth.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='choropleth.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='choropleth.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='len', parent_name='choropleth.colorbar', **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='choropleth.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='dtick', parent_name='choropleth.colorbar', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='choropleth.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='choropleth.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='choropleth.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/choropleth/colorbar/_bgcolor.py b/plotly/validators/choropleth/colorbar/_bgcolor.py deleted file mode 100644 index 1e35221e35b..00000000000 --- a/plotly/validators/choropleth/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='choropleth.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_bordercolor.py b/plotly/validators/choropleth/colorbar/_bordercolor.py deleted file mode 100644 index 60473dc51e6..00000000000 --- a/plotly/validators/choropleth/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='choropleth.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_borderwidth.py b/plotly/validators/choropleth/colorbar/_borderwidth.py deleted file mode 100644 index 52c772860c5..00000000000 --- a/plotly/validators/choropleth/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='choropleth.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_dtick.py b/plotly/validators/choropleth/colorbar/_dtick.py deleted file mode 100644 index c110a02f4a4..00000000000 --- a/plotly/validators/choropleth/colorbar/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='dtick', parent_name='choropleth.colorbar', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_exponentformat.py b/plotly/validators/choropleth/colorbar/_exponentformat.py deleted file mode 100644 index a295e94f137..00000000000 --- a/plotly/validators/choropleth/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='choropleth.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_len.py b/plotly/validators/choropleth/colorbar/_len.py deleted file mode 100644 index 81272a1a911..00000000000 --- a/plotly/validators/choropleth/colorbar/_len.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='len', parent_name='choropleth.colorbar', **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_lenmode.py b/plotly/validators/choropleth/colorbar/_lenmode.py deleted file mode 100644 index e581ef8142a..00000000000 --- a/plotly/validators/choropleth/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='choropleth.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_nticks.py b/plotly/validators/choropleth/colorbar/_nticks.py deleted file mode 100644 index 07bbba44a1d..00000000000 --- a/plotly/validators/choropleth/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='choropleth.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_outlinecolor.py b/plotly/validators/choropleth/colorbar/_outlinecolor.py deleted file mode 100644 index 4476205d6c2..00000000000 --- a/plotly/validators/choropleth/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='choropleth.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_outlinewidth.py b/plotly/validators/choropleth/colorbar/_outlinewidth.py deleted file mode 100644 index 29e67be783b..00000000000 --- a/plotly/validators/choropleth/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='choropleth.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_separatethousands.py b/plotly/validators/choropleth/colorbar/_separatethousands.py deleted file mode 100644 index d2e506969af..00000000000 --- a/plotly/validators/choropleth/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='choropleth.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_showexponent.py b/plotly/validators/choropleth/colorbar/_showexponent.py deleted file mode 100644 index 1ec91c2f3b2..00000000000 --- a/plotly/validators/choropleth/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='choropleth.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_showticklabels.py b/plotly/validators/choropleth/colorbar/_showticklabels.py deleted file mode 100644 index 1a3423de816..00000000000 --- a/plotly/validators/choropleth/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='choropleth.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_showtickprefix.py b/plotly/validators/choropleth/colorbar/_showtickprefix.py deleted file mode 100644 index 759d27719c9..00000000000 --- a/plotly/validators/choropleth/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='choropleth.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_showticksuffix.py b/plotly/validators/choropleth/colorbar/_showticksuffix.py deleted file mode 100644 index 27e8f1610b1..00000000000 --- a/plotly/validators/choropleth/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='choropleth.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_thickness.py b/plotly/validators/choropleth/colorbar/_thickness.py deleted file mode 100644 index 97814d3c39a..00000000000 --- a/plotly/validators/choropleth/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='choropleth.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_thicknessmode.py b/plotly/validators/choropleth/colorbar/_thicknessmode.py deleted file mode 100644 index 51e624cb553..00000000000 --- a/plotly/validators/choropleth/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='choropleth.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_tick0.py b/plotly/validators/choropleth/colorbar/_tick0.py deleted file mode 100644 index 147eb81689e..00000000000 --- a/plotly/validators/choropleth/colorbar/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='tick0', parent_name='choropleth.colorbar', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_tickangle.py b/plotly/validators/choropleth/colorbar/_tickangle.py deleted file mode 100644 index 68f985414bb..00000000000 --- a/plotly/validators/choropleth/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='choropleth.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_tickcolor.py b/plotly/validators/choropleth/colorbar/_tickcolor.py deleted file mode 100644 index 4cab595e307..00000000000 --- a/plotly/validators/choropleth/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='choropleth.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_tickfont.py b/plotly/validators/choropleth/colorbar/_tickfont.py deleted file mode 100644 index ce2a5340238..00000000000 --- a/plotly/validators/choropleth/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='choropleth.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_tickformat.py b/plotly/validators/choropleth/colorbar/_tickformat.py deleted file mode 100644 index 5eb019bccd5..00000000000 --- a/plotly/validators/choropleth/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='choropleth.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_tickformatstopdefaults.py b/plotly/validators/choropleth/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 7e76ceefb67..00000000000 --- a/plotly/validators/choropleth/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='choropleth.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_tickformatstops.py b/plotly/validators/choropleth/colorbar/_tickformatstops.py deleted file mode 100644 index 18d102f958d..00000000000 --- a/plotly/validators/choropleth/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='choropleth.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_ticklen.py b/plotly/validators/choropleth/colorbar/_ticklen.py deleted file mode 100644 index e916f6f7693..00000000000 --- a/plotly/validators/choropleth/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='choropleth.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_tickmode.py b/plotly/validators/choropleth/colorbar/_tickmode.py deleted file mode 100644 index 1c8a111f563..00000000000 --- a/plotly/validators/choropleth/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='choropleth.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_tickprefix.py b/plotly/validators/choropleth/colorbar/_tickprefix.py deleted file mode 100644 index 7222b15b137..00000000000 --- a/plotly/validators/choropleth/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='choropleth.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_ticks.py b/plotly/validators/choropleth/colorbar/_ticks.py deleted file mode 100644 index 386b0e7883a..00000000000 --- a/plotly/validators/choropleth/colorbar/_ticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ticks', parent_name='choropleth.colorbar', **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_ticksuffix.py b/plotly/validators/choropleth/colorbar/_ticksuffix.py deleted file mode 100644 index 916c423790d..00000000000 --- a/plotly/validators/choropleth/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='choropleth.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_ticktext.py b/plotly/validators/choropleth/colorbar/_ticktext.py deleted file mode 100644 index 908ab7b6e1d..00000000000 --- a/plotly/validators/choropleth/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='choropleth.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_ticktextsrc.py b/plotly/validators/choropleth/colorbar/_ticktextsrc.py deleted file mode 100644 index 59d785f2824..00000000000 --- a/plotly/validators/choropleth/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='choropleth.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_tickvals.py b/plotly/validators/choropleth/colorbar/_tickvals.py deleted file mode 100644 index bd175029bab..00000000000 --- a/plotly/validators/choropleth/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='choropleth.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_tickvalssrc.py b/plotly/validators/choropleth/colorbar/_tickvalssrc.py deleted file mode 100644 index 4dee7fe858b..00000000000 --- a/plotly/validators/choropleth/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='choropleth.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_tickwidth.py b/plotly/validators/choropleth/colorbar/_tickwidth.py deleted file mode 100644 index f3052deb2aa..00000000000 --- a/plotly/validators/choropleth/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='choropleth.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_title.py b/plotly/validators/choropleth/colorbar/_title.py deleted file mode 100644 index 940fc683712..00000000000 --- a/plotly/validators/choropleth/colorbar/_title.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='choropleth.colorbar', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_x.py b/plotly/validators/choropleth/colorbar/_x.py deleted file mode 100644 index ae19ab5c658..00000000000 --- a/plotly/validators/choropleth/colorbar/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='choropleth.colorbar', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_xanchor.py b/plotly/validators/choropleth/colorbar/_xanchor.py deleted file mode 100644 index 21886875da3..00000000000 --- a/plotly/validators/choropleth/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='choropleth.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_xpad.py b/plotly/validators/choropleth/colorbar/_xpad.py deleted file mode 100644 index 11314c7f653..00000000000 --- a/plotly/validators/choropleth/colorbar/_xpad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='xpad', parent_name='choropleth.colorbar', **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_y.py b/plotly/validators/choropleth/colorbar/_y.py deleted file mode 100644 index 81f424b1c8e..00000000000 --- a/plotly/validators/choropleth/colorbar/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='choropleth.colorbar', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_yanchor.py b/plotly/validators/choropleth/colorbar/_yanchor.py deleted file mode 100644 index ed88f81475c..00000000000 --- a/plotly/validators/choropleth/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='choropleth.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/_ypad.py b/plotly/validators/choropleth/colorbar/_ypad.py deleted file mode 100644 index 7bb642fdedd..00000000000 --- a/plotly/validators/choropleth/colorbar/_ypad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ypad', parent_name='choropleth.colorbar', **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/tickfont/__init__.py b/plotly/validators/choropleth/colorbar/tickfont/__init__.py index 199d72e71c6..dd33dd8b28c 100644 --- a/plotly/validators/choropleth/colorbar/tickfont/__init__.py +++ b/plotly/validators/choropleth/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='choropleth.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='choropleth.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='choropleth.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/choropleth/colorbar/tickfont/_color.py b/plotly/validators/choropleth/colorbar/tickfont/_color.py deleted file mode 100644 index 743ce4d72c0..00000000000 --- a/plotly/validators/choropleth/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='choropleth.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/tickfont/_family.py b/plotly/validators/choropleth/colorbar/tickfont/_family.py deleted file mode 100644 index 229472ff3c7..00000000000 --- a/plotly/validators/choropleth/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='choropleth.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/tickfont/_size.py b/plotly/validators/choropleth/colorbar/tickfont/_size.py deleted file mode 100644 index eb762550c20..00000000000 --- a/plotly/validators/choropleth/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='choropleth.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/tickformatstop/__init__.py b/plotly/validators/choropleth/colorbar/tickformatstop/__init__.py index 3f6c06cac47..7f48d10eb66 100644 --- a/plotly/validators/choropleth/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/choropleth/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='choropleth.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='choropleth.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='choropleth.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='choropleth.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='choropleth.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/choropleth/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/choropleth/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 4100dbb91c2..00000000000 --- a/plotly/validators/choropleth/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='choropleth.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/tickformatstop/_enabled.py b/plotly/validators/choropleth/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index 5935496fcc6..00000000000 --- a/plotly/validators/choropleth/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='choropleth.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/tickformatstop/_name.py b/plotly/validators/choropleth/colorbar/tickformatstop/_name.py deleted file mode 100644 index 4d2334750cc..00000000000 --- a/plotly/validators/choropleth/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='choropleth.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/choropleth/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 1fa3b5fded5..00000000000 --- a/plotly/validators/choropleth/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='choropleth.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/tickformatstop/_value.py b/plotly/validators/choropleth/colorbar/tickformatstop/_value.py deleted file mode 100644 index 9f3c9c99b47..00000000000 --- a/plotly/validators/choropleth/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='choropleth.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/title/__init__.py b/plotly/validators/choropleth/colorbar/title/__init__.py index 33c9c145bb8..3a4efea831d 100644 --- a/plotly/validators/choropleth/colorbar/title/__init__.py +++ b/plotly/validators/choropleth/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='choropleth.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='choropleth.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='choropleth.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/choropleth/colorbar/title/_font.py b/plotly/validators/choropleth/colorbar/title/_font.py deleted file mode 100644 index cf4b078d5ed..00000000000 --- a/plotly/validators/choropleth/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='choropleth.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/title/_side.py b/plotly/validators/choropleth/colorbar/title/_side.py deleted file mode 100644 index 61b61f9d370..00000000000 --- a/plotly/validators/choropleth/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='choropleth.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/title/_text.py b/plotly/validators/choropleth/colorbar/title/_text.py deleted file mode 100644 index 8e6bf672a6a..00000000000 --- a/plotly/validators/choropleth/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='choropleth.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/title/font/__init__.py b/plotly/validators/choropleth/colorbar/title/font/__init__.py index 199d72e71c6..c5fae4b2dae 100644 --- a/plotly/validators/choropleth/colorbar/title/font/__init__.py +++ b/plotly/validators/choropleth/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='choropleth.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='choropleth.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='choropleth.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/choropleth/colorbar/title/font/_color.py b/plotly/validators/choropleth/colorbar/title/font/_color.py deleted file mode 100644 index ef0a2c2ca6c..00000000000 --- a/plotly/validators/choropleth/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='choropleth.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/title/font/_family.py b/plotly/validators/choropleth/colorbar/title/font/_family.py deleted file mode 100644 index ba20bf43a0e..00000000000 --- a/plotly/validators/choropleth/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='choropleth.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/choropleth/colorbar/title/font/_size.py b/plotly/validators/choropleth/colorbar/title/font/_size.py deleted file mode 100644 index cd3788081d6..00000000000 --- a/plotly/validators/choropleth/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='choropleth.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/hoverlabel/__init__.py b/plotly/validators/choropleth/hoverlabel/__init__.py index 856f769ba33..f09853250d1 100644 --- a/plotly/validators/choropleth/hoverlabel/__init__.py +++ b/plotly/validators/choropleth/hoverlabel/__init__.py @@ -1,7 +1,176 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='choropleth.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='choropleth.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='choropleth.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='choropleth.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='choropleth.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='choropleth.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='choropleth.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/choropleth/hoverlabel/_bgcolor.py b/plotly/validators/choropleth/hoverlabel/_bgcolor.py deleted file mode 100644 index ba0d7210b27..00000000000 --- a/plotly/validators/choropleth/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='choropleth.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/hoverlabel/_bgcolorsrc.py b/plotly/validators/choropleth/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index c807538759c..00000000000 --- a/plotly/validators/choropleth/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='choropleth.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/hoverlabel/_bordercolor.py b/plotly/validators/choropleth/hoverlabel/_bordercolor.py deleted file mode 100644 index 72fd301e887..00000000000 --- a/plotly/validators/choropleth/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='choropleth.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/hoverlabel/_bordercolorsrc.py b/plotly/validators/choropleth/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 85640ce7bc8..00000000000 --- a/plotly/validators/choropleth/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='choropleth.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/hoverlabel/_font.py b/plotly/validators/choropleth/hoverlabel/_font.py deleted file mode 100644 index 9909ab936f4..00000000000 --- a/plotly/validators/choropleth/hoverlabel/_font.py +++ /dev/null @@ -1,50 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='choropleth.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/choropleth/hoverlabel/_namelength.py b/plotly/validators/choropleth/hoverlabel/_namelength.py deleted file mode 100644 index 1ba7c65d49b..00000000000 --- a/plotly/validators/choropleth/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='choropleth.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/hoverlabel/_namelengthsrc.py b/plotly/validators/choropleth/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 3f3e3c81668..00000000000 --- a/plotly/validators/choropleth/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='choropleth.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/hoverlabel/font/__init__.py b/plotly/validators/choropleth/hoverlabel/font/__init__.py index 1d2c591d1e5..81338595cbc 100644 --- a/plotly/validators/choropleth/hoverlabel/font/__init__.py +++ b/plotly/validators/choropleth/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='choropleth.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='choropleth.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='choropleth.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='choropleth.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='choropleth.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='choropleth.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/choropleth/hoverlabel/font/_color.py b/plotly/validators/choropleth/hoverlabel/font/_color.py deleted file mode 100644 index 0036da813c5..00000000000 --- a/plotly/validators/choropleth/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='choropleth.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/hoverlabel/font/_colorsrc.py b/plotly/validators/choropleth/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 2c4cf2ed70a..00000000000 --- a/plotly/validators/choropleth/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='choropleth.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/hoverlabel/font/_family.py b/plotly/validators/choropleth/hoverlabel/font/_family.py deleted file mode 100644 index 8fa5be8a7e9..00000000000 --- a/plotly/validators/choropleth/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='choropleth.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/choropleth/hoverlabel/font/_familysrc.py b/plotly/validators/choropleth/hoverlabel/font/_familysrc.py deleted file mode 100644 index b10d01930c9..00000000000 --- a/plotly/validators/choropleth/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='choropleth.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/hoverlabel/font/_size.py b/plotly/validators/choropleth/hoverlabel/font/_size.py deleted file mode 100644 index d4c72ca69aa..00000000000 --- a/plotly/validators/choropleth/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='choropleth.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/hoverlabel/font/_sizesrc.py b/plotly/validators/choropleth/hoverlabel/font/_sizesrc.py deleted file mode 100644 index cb613d36bd7..00000000000 --- a/plotly/validators/choropleth/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='choropleth.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/marker/__init__.py b/plotly/validators/choropleth/marker/__init__.py index 0cd59cc0625..eee8751fff4 100644 --- a/plotly/validators/choropleth/marker/__init__.py +++ b/plotly/validators/choropleth/marker/__init__.py @@ -1,3 +1,76 @@ -from ._opacitysrc import OpacitysrcValidator -from ._opacity import OpacityValidator -from ._line import LineValidator + + +import _plotly_utils.basevalidators + + +class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='opacitysrc', + parent_name='choropleth.marker', + **kwargs + ): + super(OpacitysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='choropleth.marker', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='choropleth.marker', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorsrc + Sets the source reference on plot.ly for color + . + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) diff --git a/plotly/validators/choropleth/marker/_line.py b/plotly/validators/choropleth/marker/_line.py deleted file mode 100644 index 803de1f8550..00000000000 --- a/plotly/validators/choropleth/marker/_line.py +++ /dev/null @@ -1,34 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='choropleth.marker', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorsrc - Sets the source reference on plot.ly for color - . - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/choropleth/marker/_opacity.py b/plotly/validators/choropleth/marker/_opacity.py deleted file mode 100644 index 7be0af49cbb..00000000000 --- a/plotly/validators/choropleth/marker/_opacity.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='choropleth.marker', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/marker/_opacitysrc.py b/plotly/validators/choropleth/marker/_opacitysrc.py deleted file mode 100644 index 74b259d5518..00000000000 --- a/plotly/validators/choropleth/marker/_opacitysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='opacitysrc', - parent_name='choropleth.marker', - **kwargs - ): - super(OpacitysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/marker/line/__init__.py b/plotly/validators/choropleth/marker/line/__init__.py index 1c7b37b04f2..92ea71f00c7 100644 --- a/plotly/validators/choropleth/marker/line/__init__.py +++ b/plotly/validators/choropleth/marker/line/__init__.py @@ -1,4 +1,84 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='widthsrc', + parent_name='choropleth.marker.line', + **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='choropleth.marker.line', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='choropleth.marker.line', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='choropleth.marker.line', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/choropleth/marker/line/_color.py b/plotly/validators/choropleth/marker/line/_color.py deleted file mode 100644 index d2c7ad3c01d..00000000000 --- a/plotly/validators/choropleth/marker/line/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='choropleth.marker.line', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/marker/line/_colorsrc.py b/plotly/validators/choropleth/marker/line/_colorsrc.py deleted file mode 100644 index 870f0dce654..00000000000 --- a/plotly/validators/choropleth/marker/line/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='choropleth.marker.line', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/marker/line/_width.py b/plotly/validators/choropleth/marker/line/_width.py deleted file mode 100644 index a78522ef3e9..00000000000 --- a/plotly/validators/choropleth/marker/line/_width.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='choropleth.marker.line', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/marker/line/_widthsrc.py b/plotly/validators/choropleth/marker/line/_widthsrc.py deleted file mode 100644 index 56a9a5fcc15..00000000000 --- a/plotly/validators/choropleth/marker/line/_widthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='widthsrc', - parent_name='choropleth.marker.line', - **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/selected/__init__.py b/plotly/validators/choropleth/selected/__init__.py index 3604b0284fc..a9e36d12c4c 100644 --- a/plotly/validators/choropleth/selected/__init__.py +++ b/plotly/validators/choropleth/selected/__init__.py @@ -1 +1,25 @@ -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='choropleth.selected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + opacity + Sets the marker opacity of selected points. +""" + ), + **kwargs + ) diff --git a/plotly/validators/choropleth/selected/_marker.py b/plotly/validators/choropleth/selected/_marker.py deleted file mode 100644 index 43c39baa147..00000000000 --- a/plotly/validators/choropleth/selected/_marker.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='choropleth.selected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - opacity - Sets the marker opacity of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/choropleth/selected/marker/__init__.py b/plotly/validators/choropleth/selected/marker/__init__.py index c5fa1abc973..07bbd0f210d 100644 --- a/plotly/validators/choropleth/selected/marker/__init__.py +++ b/plotly/validators/choropleth/selected/marker/__init__.py @@ -1 +1,22 @@ -from ._opacity import OpacityValidator + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='choropleth.selected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/choropleth/selected/marker/_opacity.py b/plotly/validators/choropleth/selected/marker/_opacity.py deleted file mode 100644 index 084b033ab76..00000000000 --- a/plotly/validators/choropleth/selected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='choropleth.selected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/choropleth/stream/__init__.py b/plotly/validators/choropleth/stream/__init__.py index 2f4f2047594..e622babbe0a 100644 --- a/plotly/validators/choropleth/stream/__init__.py +++ b/plotly/validators/choropleth/stream/__init__.py @@ -1,2 +1,41 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='choropleth.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='choropleth.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/choropleth/stream/_maxpoints.py b/plotly/validators/choropleth/stream/_maxpoints.py deleted file mode 100644 index 91295026ee1..00000000000 --- a/plotly/validators/choropleth/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='choropleth.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/choropleth/stream/_token.py b/plotly/validators/choropleth/stream/_token.py deleted file mode 100644 index b9db08335c4..00000000000 --- a/plotly/validators/choropleth/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='choropleth.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/choropleth/unselected/__init__.py b/plotly/validators/choropleth/unselected/__init__.py index 3604b0284fc..6b386c7525f 100644 --- a/plotly/validators/choropleth/unselected/__init__.py +++ b/plotly/validators/choropleth/unselected/__init__.py @@ -1 +1,26 @@ -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='choropleth.unselected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) diff --git a/plotly/validators/choropleth/unselected/_marker.py b/plotly/validators/choropleth/unselected/_marker.py deleted file mode 100644 index fa151f47187..00000000000 --- a/plotly/validators/choropleth/unselected/_marker.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='choropleth.unselected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/choropleth/unselected/marker/__init__.py b/plotly/validators/choropleth/unselected/marker/__init__.py index c5fa1abc973..f450405517d 100644 --- a/plotly/validators/choropleth/unselected/marker/__init__.py +++ b/plotly/validators/choropleth/unselected/marker/__init__.py @@ -1 +1,22 @@ -from ._opacity import OpacityValidator + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='choropleth.unselected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/choropleth/unselected/marker/_opacity.py b/plotly/validators/choropleth/unselected/marker/_opacity.py deleted file mode 100644 index cf322b5fcc1..00000000000 --- a/plotly/validators/choropleth/unselected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='choropleth.unselected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/__init__.py b/plotly/validators/cone/__init__.py index 5764b3b9ac7..71ceb9f77d4 100644 --- a/plotly/validators/cone/__init__.py +++ b/plotly/validators/cone/__init__.py @@ -1,49 +1,1070 @@ -from ._zsrc import ZsrcValidator -from ._z import ZValidator -from ._ysrc import YsrcValidator -from ._y import YValidator -from ._xsrc import XsrcValidator -from ._x import XValidator -from ._wsrc import WsrcValidator -from ._w import WValidator -from ._vsrc import VsrcValidator -from ._visible import VisibleValidator -from ._v import VValidator -from ._usrc import UsrcValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._u import UValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._sizeref import SizerefValidator -from ._sizemode import SizemodeValidator -from ._showscale import ShowscaleValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._scene import SceneValidator -from ._reversescale import ReversescaleValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._lightposition import LightpositionValidator -from ._lighting import LightingValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator -from ._anchor import AnchorValidator + + +import _plotly_utils.basevalidators + + +class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='zsrc', parent_name='cone', **kwargs): + super(ZsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='z', parent_name='cone', **kwargs): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='cone', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='cone', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='cone', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='cone', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='wsrc', parent_name='cone', **kwargs): + super(WsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='w', parent_name='cone', **kwargs): + super(WValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='vsrc', parent_name='cone', **kwargs): + super(VsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='cone', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='v', parent_name='cone', **kwargs): + super(VValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='usrc', parent_name='cone', **kwargs): + super(UsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='uirevision', parent_name='cone', **kwargs): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='cone', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='u', parent_name='cone', **kwargs): + super(UValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='textsrc', parent_name='cone', **kwargs): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='cone', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='cone', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='sizeref', parent_name='cone', **kwargs): + super(SizerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='sizemode', parent_name='cone', **kwargs): + super(SizemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['scaled', 'absolute']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='showscale', parent_name='cone', **kwargs): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='showlegend', parent_name='cone', **kwargs): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='cone', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SceneValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='scene', parent_name='cone', **kwargs): + super(SceneValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'scene'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='reversescale', parent_name='cone', **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='opacity', parent_name='cone', **kwargs): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='cone', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LightpositionValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='lightposition', parent_name='cone', **kwargs + ): + super(LightpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Lightposition'), + data_docs=kwargs.pop( + 'data_docs', """ + x + Numeric vector, representing the X coordinate + for each vertex. + y + Numeric vector, representing the Y coordinate + for each vertex. + z + Numeric vector, representing the Z coordinate + for each vertex. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LightingValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='lighting', parent_name='cone', **kwargs): + super(LightingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Lighting'), + data_docs=kwargs.pop( + 'data_docs', """ + ambient + Ambient light increases overall color + visibility but can wash out the image. + diffuse + Represents the extent that incident rays are + reflected in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids + math issues arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of + the viewing angle; e.g. paper is reflective + when viewing it from the edge of the paper + (almost 90 degrees), causing shine. + roughness + Alters specular reflection; the rougher the + surface, the wider and less contrasty the + shine. + specular + Represents the level that incident rays are + reflected in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids + math issues arising from degenerate geometry. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='cone', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='cone', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='cone', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='cone', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='hovertext', parent_name='cone', **kwargs): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertemplatesrc', parent_name='cone', **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='cone', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='hoverlabel', parent_name='cone', **kwargs): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='cone', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__(self, plotly_name='hoverinfo', parent_name='cone', **kwargs): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop( + 'flags', + ['x', 'y', 'z', 'u', 'v', 'w', 'norm', 'text', 'name'] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='cone', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='customdata', parent_name='cone', **kwargs): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__(self, plotly_name='colorscale', parent_name='cone', **kwargs): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='colorbar', parent_name='cone', **kwargs): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.cone.colorbar.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.cone.colorbar.tickformatstopdefaults), sets + the default property values to use for elements + of cone.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.cone.colorbar.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use cone.colorbar.title.font + instead. Sets this color bar's title font. Note + that the title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use cone.colorbar.title.side + instead. Determines the location of color bar's + title with respect to the color bar. Note that + the title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmin', parent_name='cone', **kwargs): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmid', parent_name='cone', **kwargs): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmax', parent_name='cone', **kwargs): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='cauto', parent_name='cone', **kwargs): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autocolorscale', parent_name='cone', **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AnchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='anchor', parent_name='cone', **kwargs): + super(AnchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['tip', 'tail', 'cm', 'center']), + **kwargs + ) diff --git a/plotly/validators/cone/_anchor.py b/plotly/validators/cone/_anchor.py deleted file mode 100644 index 8e4cf0f40f6..00000000000 --- a/plotly/validators/cone/_anchor.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class AnchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='anchor', parent_name='cone', **kwargs): - super(AnchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['tip', 'tail', 'cm', 'center']), - **kwargs - ) diff --git a/plotly/validators/cone/_autocolorscale.py b/plotly/validators/cone/_autocolorscale.py deleted file mode 100644 index 57efc9d02bb..00000000000 --- a/plotly/validators/cone/_autocolorscale.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autocolorscale', parent_name='cone', **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/_cauto.py b/plotly/validators/cone/_cauto.py deleted file mode 100644 index 2c1cc1b9c91..00000000000 --- a/plotly/validators/cone/_cauto.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='cauto', parent_name='cone', **kwargs): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_cmax.py b/plotly/validators/cone/_cmax.py deleted file mode 100644 index 88dbc74ee78..00000000000 --- a/plotly/validators/cone/_cmax.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmax', parent_name='cone', **kwargs): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_cmid.py b/plotly/validators/cone/_cmid.py deleted file mode 100644 index 91a1dc65366..00000000000 --- a/plotly/validators/cone/_cmid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmid', parent_name='cone', **kwargs): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_cmin.py b/plotly/validators/cone/_cmin.py deleted file mode 100644 index 9ade97157a8..00000000000 --- a/plotly/validators/cone/_cmin.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmin', parent_name='cone', **kwargs): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_colorbar.py b/plotly/validators/cone/_colorbar.py deleted file mode 100644 index 9e939e86cfe..00000000000 --- a/plotly/validators/cone/_colorbar.py +++ /dev/null @@ -1,222 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='colorbar', parent_name='cone', **kwargs): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.cone.colorbar.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.cone.colorbar.tickformatstopdefaults), sets - the default property values to use for elements - of cone.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.cone.colorbar.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use cone.colorbar.title.font - instead. Sets this color bar's title font. Note - that the title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use cone.colorbar.title.side - instead. Determines the location of color bar's - title with respect to the color bar. Note that - the title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/cone/_colorscale.py b/plotly/validators/cone/_colorscale.py deleted file mode 100644 index e0ea521b925..00000000000 --- a/plotly/validators/cone/_colorscale.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__(self, plotly_name='colorscale', parent_name='cone', **kwargs): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/_customdata.py b/plotly/validators/cone/_customdata.py deleted file mode 100644 index 9ddfe5b1792..00000000000 --- a/plotly/validators/cone/_customdata.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='customdata', parent_name='cone', **kwargs): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/cone/_customdatasrc.py b/plotly/validators/cone/_customdatasrc.py deleted file mode 100644 index e738de7846a..00000000000 --- a/plotly/validators/cone/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='cone', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_hoverinfo.py b/plotly/validators/cone/_hoverinfo.py deleted file mode 100644 index f473accc373..00000000000 --- a/plotly/validators/cone/_hoverinfo.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__(self, plotly_name='hoverinfo', parent_name='cone', **kwargs): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop( - 'flags', - ['x', 'y', 'z', 'u', 'v', 'w', 'norm', 'text', 'name'] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_hoverinfosrc.py b/plotly/validators/cone/_hoverinfosrc.py deleted file mode 100644 index db3b7e832a9..00000000000 --- a/plotly/validators/cone/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='cone', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_hoverlabel.py b/plotly/validators/cone/_hoverlabel.py deleted file mode 100644 index 8f9350cc44f..00000000000 --- a/plotly/validators/cone/_hoverlabel.py +++ /dev/null @@ -1,42 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='hoverlabel', parent_name='cone', **kwargs): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/cone/_hovertemplate.py b/plotly/validators/cone/_hovertemplate.py deleted file mode 100644 index c3e0dafaeae..00000000000 --- a/plotly/validators/cone/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='cone', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_hovertemplatesrc.py b/plotly/validators/cone/_hovertemplatesrc.py deleted file mode 100644 index a7369789554..00000000000 --- a/plotly/validators/cone/_hovertemplatesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertemplatesrc', parent_name='cone', **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_hovertext.py b/plotly/validators/cone/_hovertext.py deleted file mode 100644 index 6741e6306ce..00000000000 --- a/plotly/validators/cone/_hovertext.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='hovertext', parent_name='cone', **kwargs): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_hovertextsrc.py b/plotly/validators/cone/_hovertextsrc.py deleted file mode 100644 index bfe7489d0e1..00000000000 --- a/plotly/validators/cone/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='cone', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_ids.py b/plotly/validators/cone/_ids.py deleted file mode 100644 index 5e2739b7def..00000000000 --- a/plotly/validators/cone/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='cone', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/cone/_idssrc.py b/plotly/validators/cone/_idssrc.py deleted file mode 100644 index 8d1f93d810b..00000000000 --- a/plotly/validators/cone/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='cone', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_legendgroup.py b/plotly/validators/cone/_legendgroup.py deleted file mode 100644 index 31fcfc6ab7c..00000000000 --- a/plotly/validators/cone/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='cone', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_lighting.py b/plotly/validators/cone/_lighting.py deleted file mode 100644 index c6e9d4b609e..00000000000 --- a/plotly/validators/cone/_lighting.py +++ /dev/null @@ -1,40 +0,0 @@ -import _plotly_utils.basevalidators - - -class LightingValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='lighting', parent_name='cone', **kwargs): - super(LightingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Lighting'), - data_docs=kwargs.pop( - 'data_docs', """ - ambient - Ambient light increases overall color - visibility but can wash out the image. - diffuse - Represents the extent that incident rays are - reflected in a range of angles. - facenormalsepsilon - Epsilon for face normals calculation avoids - math issues arising from degenerate geometry. - fresnel - Represents the reflectance as a dependency of - the viewing angle; e.g. paper is reflective - when viewing it from the edge of the paper - (almost 90 degrees), causing shine. - roughness - Alters specular reflection; the rougher the - surface, the wider and less contrasty the - shine. - specular - Represents the level that incident rays are - reflected in a single direction, causing shine. - vertexnormalsepsilon - Epsilon for vertex normals calculation avoids - math issues arising from degenerate geometry. -""" - ), - **kwargs - ) diff --git a/plotly/validators/cone/_lightposition.py b/plotly/validators/cone/_lightposition.py deleted file mode 100644 index 8c867b6dfab..00000000000 --- a/plotly/validators/cone/_lightposition.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class LightpositionValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='lightposition', parent_name='cone', **kwargs - ): - super(LightpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Lightposition'), - data_docs=kwargs.pop( - 'data_docs', """ - x - Numeric vector, representing the X coordinate - for each vertex. - y - Numeric vector, representing the Y coordinate - for each vertex. - z - Numeric vector, representing the Z coordinate - for each vertex. -""" - ), - **kwargs - ) diff --git a/plotly/validators/cone/_name.py b/plotly/validators/cone/_name.py deleted file mode 100644 index 6a0d714a7be..00000000000 --- a/plotly/validators/cone/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='cone', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_opacity.py b/plotly/validators/cone/_opacity.py deleted file mode 100644 index 06bb8a9cd79..00000000000 --- a/plotly/validators/cone/_opacity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='opacity', parent_name='cone', **kwargs): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/_reversescale.py b/plotly/validators/cone/_reversescale.py deleted file mode 100644 index bc391e40796..00000000000 --- a/plotly/validators/cone/_reversescale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='reversescale', parent_name='cone', **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/_scene.py b/plotly/validators/cone/_scene.py deleted file mode 100644 index 4a7e9b56591..00000000000 --- a/plotly/validators/cone/_scene.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class SceneValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='scene', parent_name='cone', **kwargs): - super(SceneValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'scene'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_selectedpoints.py b/plotly/validators/cone/_selectedpoints.py deleted file mode 100644 index 0e14e0d4f8b..00000000000 --- a/plotly/validators/cone/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='cone', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_showlegend.py b/plotly/validators/cone/_showlegend.py deleted file mode 100644 index 3a337b40332..00000000000 --- a/plotly/validators/cone/_showlegend.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='showlegend', parent_name='cone', **kwargs): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_showscale.py b/plotly/validators/cone/_showscale.py deleted file mode 100644 index 11b0fa66a4f..00000000000 --- a/plotly/validators/cone/_showscale.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='showscale', parent_name='cone', **kwargs): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_sizemode.py b/plotly/validators/cone/_sizemode.py deleted file mode 100644 index 2c3b6a304a6..00000000000 --- a/plotly/validators/cone/_sizemode.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='sizemode', parent_name='cone', **kwargs): - super(SizemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['scaled', 'absolute']), - **kwargs - ) diff --git a/plotly/validators/cone/_sizeref.py b/plotly/validators/cone/_sizeref.py deleted file mode 100644 index 9161b8ab350..00000000000 --- a/plotly/validators/cone/_sizeref.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='sizeref', parent_name='cone', **kwargs): - super(SizerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_stream.py b/plotly/validators/cone/_stream.py deleted file mode 100644 index 93c48be4bfb..00000000000 --- a/plotly/validators/cone/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='cone', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/cone/_text.py b/plotly/validators/cone/_text.py deleted file mode 100644 index 38c59690bc2..00000000000 --- a/plotly/validators/cone/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='cone', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_textsrc.py b/plotly/validators/cone/_textsrc.py deleted file mode 100644 index 0f651ed95f8..00000000000 --- a/plotly/validators/cone/_textsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='textsrc', parent_name='cone', **kwargs): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_u.py b/plotly/validators/cone/_u.py deleted file mode 100644 index 1ffc4ef38e8..00000000000 --- a/plotly/validators/cone/_u.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class UValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='u', parent_name='cone', **kwargs): - super(UValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/cone/_uid.py b/plotly/validators/cone/_uid.py deleted file mode 100644 index 4ae4cd17301..00000000000 --- a/plotly/validators/cone/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='cone', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_uirevision.py b/plotly/validators/cone/_uirevision.py deleted file mode 100644 index e2702fd2865..00000000000 --- a/plotly/validators/cone/_uirevision.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='uirevision', parent_name='cone', **kwargs): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_usrc.py b/plotly/validators/cone/_usrc.py deleted file mode 100644 index 7adb8df439c..00000000000 --- a/plotly/validators/cone/_usrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class UsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='usrc', parent_name='cone', **kwargs): - super(UsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_v.py b/plotly/validators/cone/_v.py deleted file mode 100644 index c05e01def46..00000000000 --- a/plotly/validators/cone/_v.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class VValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='v', parent_name='cone', **kwargs): - super(VValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/cone/_visible.py b/plotly/validators/cone/_visible.py deleted file mode 100644 index c6f4a0c9600..00000000000 --- a/plotly/validators/cone/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='cone', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/cone/_vsrc.py b/plotly/validators/cone/_vsrc.py deleted file mode 100644 index 125282bd449..00000000000 --- a/plotly/validators/cone/_vsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class VsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='vsrc', parent_name='cone', **kwargs): - super(VsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_w.py b/plotly/validators/cone/_w.py deleted file mode 100644 index 1079e58f301..00000000000 --- a/plotly/validators/cone/_w.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class WValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='w', parent_name='cone', **kwargs): - super(WValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/cone/_wsrc.py b/plotly/validators/cone/_wsrc.py deleted file mode 100644 index 7244ef292b0..00000000000 --- a/plotly/validators/cone/_wsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class WsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='wsrc', parent_name='cone', **kwargs): - super(WsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_x.py b/plotly/validators/cone/_x.py deleted file mode 100644 index f344d8328ee..00000000000 --- a/plotly/validators/cone/_x.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='cone', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/cone/_xsrc.py b/plotly/validators/cone/_xsrc.py deleted file mode 100644 index 7cec0d709e2..00000000000 --- a/plotly/validators/cone/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='cone', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_y.py b/plotly/validators/cone/_y.py deleted file mode 100644 index a2f228466fb..00000000000 --- a/plotly/validators/cone/_y.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='cone', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/cone/_ysrc.py b/plotly/validators/cone/_ysrc.py deleted file mode 100644 index 7a573fe17f3..00000000000 --- a/plotly/validators/cone/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='cone', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/_z.py b/plotly/validators/cone/_z.py deleted file mode 100644 index c47c0e78a1f..00000000000 --- a/plotly/validators/cone/_z.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='z', parent_name='cone', **kwargs): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/cone/_zsrc.py b/plotly/validators/cone/_zsrc.py deleted file mode 100644 index 7bdad3df808..00000000000 --- a/plotly/validators/cone/_zsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='zsrc', parent_name='cone', **kwargs): - super(ZsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/__init__.py b/plotly/validators/cone/colorbar/__init__.py index 3dab31f7e02..9548cff3e72 100644 --- a/plotly/validators/cone/colorbar/__init__.py +++ b/plotly/validators/cone/colorbar/__init__.py @@ -1,41 +1,842 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ypad', parent_name='cone.colorbar', **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='yanchor', parent_name='cone.colorbar', **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='y', parent_name='cone.colorbar', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='xpad', parent_name='cone.colorbar', **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xanchor', parent_name='cone.colorbar', **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='x', parent_name='cone.colorbar', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='cone.colorbar', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='tickwidth', parent_name='cone.colorbar', **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='tickvalssrc', parent_name='cone.colorbar', **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='tickvals', parent_name='cone.colorbar', **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='ticktextsrc', parent_name='cone.colorbar', **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ticktext', parent_name='cone.colorbar', **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='ticksuffix', parent_name='cone.colorbar', **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ticks', parent_name='cone.colorbar', **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='tickprefix', parent_name='cone.colorbar', **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='tickmode', parent_name='cone.colorbar', **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ticklen', parent_name='cone.colorbar', **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='cone.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='cone.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='tickformat', parent_name='cone.colorbar', **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='tickfont', parent_name='cone.colorbar', **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='tickcolor', parent_name='cone.colorbar', **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, plotly_name='tickangle', parent_name='cone.colorbar', **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='tick0', parent_name='cone.colorbar', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='cone.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='thickness', parent_name='cone.colorbar', **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='cone.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='cone.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='cone.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='cone.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='cone.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='cone.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='cone.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nticks', parent_name='cone.colorbar', **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='lenmode', parent_name='cone.colorbar', **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='len', parent_name='cone.colorbar', **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='cone.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='dtick', parent_name='cone.colorbar', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='borderwidth', parent_name='cone.colorbar', **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bordercolor', parent_name='cone.colorbar', **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='cone.colorbar', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/cone/colorbar/_bgcolor.py b/plotly/validators/cone/colorbar/_bgcolor.py deleted file mode 100644 index c1caa47db74..00000000000 --- a/plotly/validators/cone/colorbar/_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='cone.colorbar', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_bordercolor.py b/plotly/validators/cone/colorbar/_bordercolor.py deleted file mode 100644 index 42acc4161c0..00000000000 --- a/plotly/validators/cone/colorbar/_bordercolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bordercolor', parent_name='cone.colorbar', **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_borderwidth.py b/plotly/validators/cone/colorbar/_borderwidth.py deleted file mode 100644 index 14537ea0942..00000000000 --- a/plotly/validators/cone/colorbar/_borderwidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='borderwidth', parent_name='cone.colorbar', **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_dtick.py b/plotly/validators/cone/colorbar/_dtick.py deleted file mode 100644 index c8f4b6fee16..00000000000 --- a/plotly/validators/cone/colorbar/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='dtick', parent_name='cone.colorbar', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_exponentformat.py b/plotly/validators/cone/colorbar/_exponentformat.py deleted file mode 100644 index d6dcd0d0dc4..00000000000 --- a/plotly/validators/cone/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='cone.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_len.py b/plotly/validators/cone/colorbar/_len.py deleted file mode 100644 index 5aee25c7012..00000000000 --- a/plotly/validators/cone/colorbar/_len.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='len', parent_name='cone.colorbar', **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_lenmode.py b/plotly/validators/cone/colorbar/_lenmode.py deleted file mode 100644 index 5d9f11f88ea..00000000000 --- a/plotly/validators/cone/colorbar/_lenmode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='lenmode', parent_name='cone.colorbar', **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_nticks.py b/plotly/validators/cone/colorbar/_nticks.py deleted file mode 100644 index 8e38485baf8..00000000000 --- a/plotly/validators/cone/colorbar/_nticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nticks', parent_name='cone.colorbar', **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_outlinecolor.py b/plotly/validators/cone/colorbar/_outlinecolor.py deleted file mode 100644 index 10995a73e3b..00000000000 --- a/plotly/validators/cone/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='cone.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_outlinewidth.py b/plotly/validators/cone/colorbar/_outlinewidth.py deleted file mode 100644 index d76cc46880e..00000000000 --- a/plotly/validators/cone/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='cone.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_separatethousands.py b/plotly/validators/cone/colorbar/_separatethousands.py deleted file mode 100644 index ef0166b485d..00000000000 --- a/plotly/validators/cone/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='cone.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_showexponent.py b/plotly/validators/cone/colorbar/_showexponent.py deleted file mode 100644 index 4ec47748ec9..00000000000 --- a/plotly/validators/cone/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='cone.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_showticklabels.py b/plotly/validators/cone/colorbar/_showticklabels.py deleted file mode 100644 index 53d5db30b76..00000000000 --- a/plotly/validators/cone/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='cone.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_showtickprefix.py b/plotly/validators/cone/colorbar/_showtickprefix.py deleted file mode 100644 index ab070219aaf..00000000000 --- a/plotly/validators/cone/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='cone.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_showticksuffix.py b/plotly/validators/cone/colorbar/_showticksuffix.py deleted file mode 100644 index 56fe021ae93..00000000000 --- a/plotly/validators/cone/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='cone.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_thickness.py b/plotly/validators/cone/colorbar/_thickness.py deleted file mode 100644 index 1eb43bab849..00000000000 --- a/plotly/validators/cone/colorbar/_thickness.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='thickness', parent_name='cone.colorbar', **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_thicknessmode.py b/plotly/validators/cone/colorbar/_thicknessmode.py deleted file mode 100644 index 379cf9f4d53..00000000000 --- a/plotly/validators/cone/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='cone.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_tick0.py b/plotly/validators/cone/colorbar/_tick0.py deleted file mode 100644 index 20088fc2744..00000000000 --- a/plotly/validators/cone/colorbar/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='tick0', parent_name='cone.colorbar', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_tickangle.py b/plotly/validators/cone/colorbar/_tickangle.py deleted file mode 100644 index b545d61ff96..00000000000 --- a/plotly/validators/cone/colorbar/_tickangle.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, plotly_name='tickangle', parent_name='cone.colorbar', **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_tickcolor.py b/plotly/validators/cone/colorbar/_tickcolor.py deleted file mode 100644 index bfb99736684..00000000000 --- a/plotly/validators/cone/colorbar/_tickcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='tickcolor', parent_name='cone.colorbar', **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_tickfont.py b/plotly/validators/cone/colorbar/_tickfont.py deleted file mode 100644 index 5feae6a2279..00000000000 --- a/plotly/validators/cone/colorbar/_tickfont.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='tickfont', parent_name='cone.colorbar', **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_tickformat.py b/plotly/validators/cone/colorbar/_tickformat.py deleted file mode 100644 index 0faf27de3c1..00000000000 --- a/plotly/validators/cone/colorbar/_tickformat.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='tickformat', parent_name='cone.colorbar', **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_tickformatstopdefaults.py b/plotly/validators/cone/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index c6899b55e3a..00000000000 --- a/plotly/validators/cone/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='cone.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_tickformatstops.py b/plotly/validators/cone/colorbar/_tickformatstops.py deleted file mode 100644 index fd27bb9a461..00000000000 --- a/plotly/validators/cone/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='cone.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_ticklen.py b/plotly/validators/cone/colorbar/_ticklen.py deleted file mode 100644 index 494df60234f..00000000000 --- a/plotly/validators/cone/colorbar/_ticklen.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ticklen', parent_name='cone.colorbar', **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_tickmode.py b/plotly/validators/cone/colorbar/_tickmode.py deleted file mode 100644 index 438aca5bf34..00000000000 --- a/plotly/validators/cone/colorbar/_tickmode.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='tickmode', parent_name='cone.colorbar', **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_tickprefix.py b/plotly/validators/cone/colorbar/_tickprefix.py deleted file mode 100644 index 63f3cd7ba56..00000000000 --- a/plotly/validators/cone/colorbar/_tickprefix.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='tickprefix', parent_name='cone.colorbar', **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_ticks.py b/plotly/validators/cone/colorbar/_ticks.py deleted file mode 100644 index 69be3c54873..00000000000 --- a/plotly/validators/cone/colorbar/_ticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ticks', parent_name='cone.colorbar', **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_ticksuffix.py b/plotly/validators/cone/colorbar/_ticksuffix.py deleted file mode 100644 index 1cfeb8bb28c..00000000000 --- a/plotly/validators/cone/colorbar/_ticksuffix.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='ticksuffix', parent_name='cone.colorbar', **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_ticktext.py b/plotly/validators/cone/colorbar/_ticktext.py deleted file mode 100644 index 50e24a8318c..00000000000 --- a/plotly/validators/cone/colorbar/_ticktext.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ticktext', parent_name='cone.colorbar', **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_ticktextsrc.py b/plotly/validators/cone/colorbar/_ticktextsrc.py deleted file mode 100644 index 9c3ea4c8871..00000000000 --- a/plotly/validators/cone/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='ticktextsrc', parent_name='cone.colorbar', **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_tickvals.py b/plotly/validators/cone/colorbar/_tickvals.py deleted file mode 100644 index 9ffcc90c07a..00000000000 --- a/plotly/validators/cone/colorbar/_tickvals.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='tickvals', parent_name='cone.colorbar', **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_tickvalssrc.py b/plotly/validators/cone/colorbar/_tickvalssrc.py deleted file mode 100644 index 80b27d8c1fb..00000000000 --- a/plotly/validators/cone/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='tickvalssrc', parent_name='cone.colorbar', **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_tickwidth.py b/plotly/validators/cone/colorbar/_tickwidth.py deleted file mode 100644 index 109ad5fd0df..00000000000 --- a/plotly/validators/cone/colorbar/_tickwidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='tickwidth', parent_name='cone.colorbar', **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_title.py b/plotly/validators/cone/colorbar/_title.py deleted file mode 100644 index 05ec65a49bc..00000000000 --- a/plotly/validators/cone/colorbar/_title.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='cone.colorbar', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_x.py b/plotly/validators/cone/colorbar/_x.py deleted file mode 100644 index 9299cae4074..00000000000 --- a/plotly/validators/cone/colorbar/_x.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='x', parent_name='cone.colorbar', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_xanchor.py b/plotly/validators/cone/colorbar/_xanchor.py deleted file mode 100644 index c65d5c967ef..00000000000 --- a/plotly/validators/cone/colorbar/_xanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xanchor', parent_name='cone.colorbar', **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_xpad.py b/plotly/validators/cone/colorbar/_xpad.py deleted file mode 100644 index ecd112498ab..00000000000 --- a/plotly/validators/cone/colorbar/_xpad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='xpad', parent_name='cone.colorbar', **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_y.py b/plotly/validators/cone/colorbar/_y.py deleted file mode 100644 index 8e1e86b6294..00000000000 --- a/plotly/validators/cone/colorbar/_y.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='y', parent_name='cone.colorbar', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_yanchor.py b/plotly/validators/cone/colorbar/_yanchor.py deleted file mode 100644 index ed002fb0ac9..00000000000 --- a/plotly/validators/cone/colorbar/_yanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='yanchor', parent_name='cone.colorbar', **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/_ypad.py b/plotly/validators/cone/colorbar/_ypad.py deleted file mode 100644 index 82948169624..00000000000 --- a/plotly/validators/cone/colorbar/_ypad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ypad', parent_name='cone.colorbar', **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/tickfont/__init__.py b/plotly/validators/cone/colorbar/tickfont/__init__.py index 199d72e71c6..8bab122f275 100644 --- a/plotly/validators/cone/colorbar/tickfont/__init__.py +++ b/plotly/validators/cone/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='cone.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='cone.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='cone.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/cone/colorbar/tickfont/_color.py b/plotly/validators/cone/colorbar/tickfont/_color.py deleted file mode 100644 index 0a4273b22c5..00000000000 --- a/plotly/validators/cone/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='cone.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/tickfont/_family.py b/plotly/validators/cone/colorbar/tickfont/_family.py deleted file mode 100644 index f160db2f5b3..00000000000 --- a/plotly/validators/cone/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='cone.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/tickfont/_size.py b/plotly/validators/cone/colorbar/tickfont/_size.py deleted file mode 100644 index fdbc6447882..00000000000 --- a/plotly/validators/cone/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='cone.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/tickformatstop/__init__.py b/plotly/validators/cone/colorbar/tickformatstop/__init__.py index 3f6c06cac47..c529bcfcbfa 100644 --- a/plotly/validators/cone/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/cone/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='cone.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='cone.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='cone.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='cone.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='cone.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/cone/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/cone/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index c0cd280404f..00000000000 --- a/plotly/validators/cone/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='cone.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/tickformatstop/_enabled.py b/plotly/validators/cone/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index 1a80fc86af8..00000000000 --- a/plotly/validators/cone/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='cone.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/tickformatstop/_name.py b/plotly/validators/cone/colorbar/tickformatstop/_name.py deleted file mode 100644 index 0352bae3c29..00000000000 --- a/plotly/validators/cone/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='cone.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/cone/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index a6e19eaac16..00000000000 --- a/plotly/validators/cone/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='cone.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/tickformatstop/_value.py b/plotly/validators/cone/colorbar/tickformatstop/_value.py deleted file mode 100644 index 5922957c83f..00000000000 --- a/plotly/validators/cone/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='cone.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/title/__init__.py b/plotly/validators/cone/colorbar/title/__init__.py index 33c9c145bb8..7677a39fc73 100644 --- a/plotly/validators/cone/colorbar/title/__init__.py +++ b/plotly/validators/cone/colorbar/title/__init__.py @@ -1,3 +1,75 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='text', parent_name='cone.colorbar.title', **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='side', parent_name='cone.colorbar.title', **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='cone.colorbar.title', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/cone/colorbar/title/_font.py b/plotly/validators/cone/colorbar/title/_font.py deleted file mode 100644 index b825a9e54b0..00000000000 --- a/plotly/validators/cone/colorbar/title/_font.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='cone.colorbar.title', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/title/_side.py b/plotly/validators/cone/colorbar/title/_side.py deleted file mode 100644 index ca36b8ab2b1..00000000000 --- a/plotly/validators/cone/colorbar/title/_side.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='side', parent_name='cone.colorbar.title', **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/title/_text.py b/plotly/validators/cone/colorbar/title/_text.py deleted file mode 100644 index d4fe0e71d00..00000000000 --- a/plotly/validators/cone/colorbar/title/_text.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='text', parent_name='cone.colorbar.title', **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/title/font/__init__.py b/plotly/validators/cone/colorbar/title/font/__init__.py index 199d72e71c6..9275d5666f5 100644 --- a/plotly/validators/cone/colorbar/title/font/__init__.py +++ b/plotly/validators/cone/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='cone.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='cone.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='cone.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/cone/colorbar/title/font/_color.py b/plotly/validators/cone/colorbar/title/font/_color.py deleted file mode 100644 index a3062f1705e..00000000000 --- a/plotly/validators/cone/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='cone.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/title/font/_family.py b/plotly/validators/cone/colorbar/title/font/_family.py deleted file mode 100644 index d7171210027..00000000000 --- a/plotly/validators/cone/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='cone.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/cone/colorbar/title/font/_size.py b/plotly/validators/cone/colorbar/title/font/_size.py deleted file mode 100644 index d21d3e85e3d..00000000000 --- a/plotly/validators/cone/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='cone.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/hoverlabel/__init__.py b/plotly/validators/cone/hoverlabel/__init__.py index 856f769ba33..bcfb2f6a8d9 100644 --- a/plotly/validators/cone/hoverlabel/__init__.py +++ b/plotly/validators/cone/hoverlabel/__init__.py @@ -1,7 +1,170 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='cone.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='cone.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='cone.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='cone.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='cone.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='cone.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='cone.hoverlabel', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/cone/hoverlabel/_bgcolor.py b/plotly/validators/cone/hoverlabel/_bgcolor.py deleted file mode 100644 index 4923565a4b4..00000000000 --- a/plotly/validators/cone/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='cone.hoverlabel', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/hoverlabel/_bgcolorsrc.py b/plotly/validators/cone/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 87d1d75ace2..00000000000 --- a/plotly/validators/cone/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='cone.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/hoverlabel/_bordercolor.py b/plotly/validators/cone/hoverlabel/_bordercolor.py deleted file mode 100644 index 52c7185bf65..00000000000 --- a/plotly/validators/cone/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='cone.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/hoverlabel/_bordercolorsrc.py b/plotly/validators/cone/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index bffa4968690..00000000000 --- a/plotly/validators/cone/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='cone.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/hoverlabel/_font.py b/plotly/validators/cone/hoverlabel/_font.py deleted file mode 100644 index d741d700058..00000000000 --- a/plotly/validators/cone/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='cone.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/cone/hoverlabel/_namelength.py b/plotly/validators/cone/hoverlabel/_namelength.py deleted file mode 100644 index d6bfa820e7b..00000000000 --- a/plotly/validators/cone/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='cone.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/hoverlabel/_namelengthsrc.py b/plotly/validators/cone/hoverlabel/_namelengthsrc.py deleted file mode 100644 index bc90fcb611f..00000000000 --- a/plotly/validators/cone/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='cone.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/hoverlabel/font/__init__.py b/plotly/validators/cone/hoverlabel/font/__init__.py index 1d2c591d1e5..02828fd115e 100644 --- a/plotly/validators/cone/hoverlabel/font/__init__.py +++ b/plotly/validators/cone/hoverlabel/font/__init__.py @@ -1,6 +1,123 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='cone.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='cone.hoverlabel.font', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='cone.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='cone.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='cone.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='cone.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/cone/hoverlabel/font/_color.py b/plotly/validators/cone/hoverlabel/font/_color.py deleted file mode 100644 index 35f9ac577b3..00000000000 --- a/plotly/validators/cone/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='cone.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/hoverlabel/font/_colorsrc.py b/plotly/validators/cone/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 3283a21ed95..00000000000 --- a/plotly/validators/cone/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='cone.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/hoverlabel/font/_family.py b/plotly/validators/cone/hoverlabel/font/_family.py deleted file mode 100644 index 294ea594744..00000000000 --- a/plotly/validators/cone/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='cone.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/cone/hoverlabel/font/_familysrc.py b/plotly/validators/cone/hoverlabel/font/_familysrc.py deleted file mode 100644 index ed362fd99d7..00000000000 --- a/plotly/validators/cone/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='cone.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/hoverlabel/font/_size.py b/plotly/validators/cone/hoverlabel/font/_size.py deleted file mode 100644 index 1aabffa5ee6..00000000000 --- a/plotly/validators/cone/hoverlabel/font/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='cone.hoverlabel.font', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/hoverlabel/font/_sizesrc.py b/plotly/validators/cone/hoverlabel/font/_sizesrc.py deleted file mode 100644 index edfb08dab02..00000000000 --- a/plotly/validators/cone/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='cone.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/lighting/__init__.py b/plotly/validators/cone/lighting/__init__.py index 6abe696b0d7..a92df197739 100644 --- a/plotly/validators/cone/lighting/__init__.py +++ b/plotly/validators/cone/lighting/__init__.py @@ -1,7 +1,143 @@ -from ._vertexnormalsepsilon import VertexnormalsepsilonValidator -from ._specular import SpecularValidator -from ._roughness import RoughnessValidator -from ._fresnel import FresnelValidator -from ._facenormalsepsilon import FacenormalsepsilonValidator -from ._diffuse import DiffuseValidator -from ._ambient import AmbientValidator + + +import _plotly_utils.basevalidators + + +class VertexnormalsepsilonValidator( + _plotly_utils.basevalidators.NumberValidator +): + + def __init__( + self, + plotly_name='vertexnormalsepsilon', + parent_name='cone.lighting', + **kwargs + ): + super(VertexnormalsepsilonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpecularValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='specular', parent_name='cone.lighting', **kwargs + ): + super(SpecularValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 2), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RoughnessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='roughness', parent_name='cone.lighting', **kwargs + ): + super(RoughnessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FresnelValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='fresnel', parent_name='cone.lighting', **kwargs + ): + super(FresnelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 5), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FacenormalsepsilonValidator( + _plotly_utils.basevalidators.NumberValidator +): + + def __init__( + self, + plotly_name='facenormalsepsilon', + parent_name='cone.lighting', + **kwargs + ): + super(FacenormalsepsilonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DiffuseValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='diffuse', parent_name='cone.lighting', **kwargs + ): + super(DiffuseValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AmbientValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ambient', parent_name='cone.lighting', **kwargs + ): + super(AmbientValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/cone/lighting/_ambient.py b/plotly/validators/cone/lighting/_ambient.py deleted file mode 100644 index 0008e331216..00000000000 --- a/plotly/validators/cone/lighting/_ambient.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class AmbientValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ambient', parent_name='cone.lighting', **kwargs - ): - super(AmbientValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/lighting/_diffuse.py b/plotly/validators/cone/lighting/_diffuse.py deleted file mode 100644 index dd4a1e791b5..00000000000 --- a/plotly/validators/cone/lighting/_diffuse.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class DiffuseValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='diffuse', parent_name='cone.lighting', **kwargs - ): - super(DiffuseValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/lighting/_facenormalsepsilon.py b/plotly/validators/cone/lighting/_facenormalsepsilon.py deleted file mode 100644 index 84d6154791d..00000000000 --- a/plotly/validators/cone/lighting/_facenormalsepsilon.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class FacenormalsepsilonValidator( - _plotly_utils.basevalidators.NumberValidator -): - - def __init__( - self, - plotly_name='facenormalsepsilon', - parent_name='cone.lighting', - **kwargs - ): - super(FacenormalsepsilonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/lighting/_fresnel.py b/plotly/validators/cone/lighting/_fresnel.py deleted file mode 100644 index d9bdb28330e..00000000000 --- a/plotly/validators/cone/lighting/_fresnel.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FresnelValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='fresnel', parent_name='cone.lighting', **kwargs - ): - super(FresnelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 5), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/lighting/_roughness.py b/plotly/validators/cone/lighting/_roughness.py deleted file mode 100644 index 8d83d6bb232..00000000000 --- a/plotly/validators/cone/lighting/_roughness.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class RoughnessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='roughness', parent_name='cone.lighting', **kwargs - ): - super(RoughnessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/lighting/_specular.py b/plotly/validators/cone/lighting/_specular.py deleted file mode 100644 index 539089f33d3..00000000000 --- a/plotly/validators/cone/lighting/_specular.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpecularValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='specular', parent_name='cone.lighting', **kwargs - ): - super(SpecularValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 2), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/lighting/_vertexnormalsepsilon.py b/plotly/validators/cone/lighting/_vertexnormalsepsilon.py deleted file mode 100644 index ce64cdd5b8e..00000000000 --- a/plotly/validators/cone/lighting/_vertexnormalsepsilon.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class VertexnormalsepsilonValidator( - _plotly_utils.basevalidators.NumberValidator -): - - def __init__( - self, - plotly_name='vertexnormalsepsilon', - parent_name='cone.lighting', - **kwargs - ): - super(VertexnormalsepsilonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/lightposition/__init__.py b/plotly/validators/cone/lightposition/__init__.py index 438e2dc9c6d..8d831612d7b 100644 --- a/plotly/validators/cone/lightposition/__init__.py +++ b/plotly/validators/cone/lightposition/__init__.py @@ -1,3 +1,57 @@ -from ._z import ZValidator -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='z', parent_name='cone.lightposition', **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 100000), + min=kwargs.pop('min', -100000), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='cone.lightposition', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 100000), + min=kwargs.pop('min', -100000), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='cone.lightposition', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 100000), + min=kwargs.pop('min', -100000), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/cone/lightposition/_x.py b/plotly/validators/cone/lightposition/_x.py deleted file mode 100644 index 718d4677f65..00000000000 --- a/plotly/validators/cone/lightposition/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='cone.lightposition', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 100000), - min=kwargs.pop('min', -100000), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/lightposition/_y.py b/plotly/validators/cone/lightposition/_y.py deleted file mode 100644 index 244a74ce262..00000000000 --- a/plotly/validators/cone/lightposition/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='cone.lightposition', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 100000), - min=kwargs.pop('min', -100000), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/lightposition/_z.py b/plotly/validators/cone/lightposition/_z.py deleted file mode 100644 index 653cb7f7466..00000000000 --- a/plotly/validators/cone/lightposition/_z.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='z', parent_name='cone.lightposition', **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 100000), - min=kwargs.pop('min', -100000), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/cone/stream/__init__.py b/plotly/validators/cone/stream/__init__.py index 2f4f2047594..1956eb02bd2 100644 --- a/plotly/validators/cone/stream/__init__.py +++ b/plotly/validators/cone/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='cone.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='cone.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/cone/stream/_maxpoints.py b/plotly/validators/cone/stream/_maxpoints.py deleted file mode 100644 index c02fca2dfe4..00000000000 --- a/plotly/validators/cone/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='cone.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/cone/stream/_token.py b/plotly/validators/cone/stream/_token.py deleted file mode 100644 index d9d5733c7b3..00000000000 --- a/plotly/validators/cone/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='cone.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/contour/__init__.py b/plotly/validators/contour/__init__.py index ac607462521..de82276a516 100644 --- a/plotly/validators/contour/__init__.py +++ b/plotly/validators/contour/__init__.py @@ -1,55 +1,1267 @@ -from ._zsrc import ZsrcValidator -from ._zmin import ZminValidator -from ._zmid import ZmidValidator -from ._zmax import ZmaxValidator -from ._zhoverformat import ZhoverformatValidator -from ._zauto import ZautoValidator -from ._z import ZValidator -from ._ytype import YtypeValidator -from ._ysrc import YsrcValidator -from ._ycalendar import YcalendarValidator -from ._yaxis import YAxisValidator -from ._y0 import Y0Validator -from ._y import YValidator -from ._xtype import XtypeValidator -from ._xsrc import XsrcValidator -from ._xcalendar import XcalendarValidator -from ._xaxis import XAxisValidator -from ._x0 import X0Validator -from ._x import XValidator -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._transpose import TransposeValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._showscale import ShowscaleValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._reversescale import ReversescaleValidator -from ._opacity import OpacityValidator -from ._ncontours import NcontoursValidator -from ._name import NameValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._fillcolor import FillcolorValidator -from ._dy import DyValidator -from ._dx import DxValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._contours import ContoursValidator -from ._connectgaps import ConnectgapsValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._autocontour import AutocontourValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='zsrc', parent_name='contour', **kwargs): + super(ZsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='zmin', parent_name='contour', **kwargs): + super(ZminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'zauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='zmid', parent_name='contour', **kwargs): + super(ZmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='zmax', parent_name='contour', **kwargs): + super(ZmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'zauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZhoverformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='zhoverformat', parent_name='contour', **kwargs + ): + super(ZhoverformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='zauto', parent_name='contour', **kwargs): + super(ZautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='z', parent_name='contour', **kwargs): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YtypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='ytype', parent_name='contour', **kwargs): + super(YtypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['array', 'scaled']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='contour', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ycalendar', parent_name='contour', **kwargs + ): + super(YcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='yaxis', parent_name='contour', **kwargs): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Y0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='y0', parent_name='contour', **kwargs): + super(Y0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + implied_edits=kwargs.pop('implied_edits', {'ytype': 'scaled'}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='contour', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + implied_edits=kwargs.pop('implied_edits', {'ytype': 'array'}), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XtypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='xtype', parent_name='contour', **kwargs): + super(XtypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['array', 'scaled']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='contour', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xcalendar', parent_name='contour', **kwargs + ): + super(XcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='xaxis', parent_name='contour', **kwargs): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class X0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='x0', parent_name='contour', **kwargs): + super(X0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + implied_edits=kwargs.pop('implied_edits', {'xtype': 'scaled'}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='contour', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + implied_edits=kwargs.pop('implied_edits', {'xtype': 'array'}), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='contour', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='contour', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='contour', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TransposeValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='transpose', parent_name='contour', **kwargs + ): + super(TransposeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='textsrc', parent_name='contour', **kwargs): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='text', parent_name='contour', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='contour', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='contour', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='contour', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='contour', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='reversescale', parent_name='contour', **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='opacity', parent_name='contour', **kwargs): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NcontoursValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='ncontours', parent_name='contour', **kwargs + ): + super(NcontoursValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='contour', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='line', parent_name='contour', **kwargs): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the color of the contour level. Has no + effect if `contours.coloring` is set to + "lines". + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour + lines, where 0 corresponds to no smoothing. + width + Sets the line width (in px). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='contour', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='contour', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='contour', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='contour', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='contour', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertemplatesrc', parent_name='contour', **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='contour', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='contour', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='contour', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='contour', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='fillcolor', parent_name='contour', **kwargs + ): + super(FillcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'contour.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DyValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='dy', parent_name='contour', **kwargs): + super(DyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'ytype': 'scaled'}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='dx', parent_name='contour', **kwargs): + super(DxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'xtype': 'scaled'}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='contour', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='contour', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ContoursValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='contours', parent_name='contour', **kwargs + ): + super(ContoursValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Contours'), + data_docs=kwargs.pop( + 'data_docs', """ + coloring + Determines the coloring method showing the + contour values. If "fill", coloring is done + evenly between each contour level If "heatmap", + a heatmap gradient coloring is applied between + each contour level. If "lines", coloring is + done on the contour lines. If "none", no + coloring is applied on this trace. + end + Sets the end contour level value. Must be more + than `contours.start` + labelfont + Sets the font used for labeling the contour + levels. The default color comes from the lines, + if shown. The default family and size come from + `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-language which is very similar + to Python, see: https://github.com/d3/d3-format + /blob/master/README.md#locale_format. + operation + Sets the constraint operation. "=" keeps + regions equal to `value` "<" and "<=" keep + regions less than `value` ">" and ">=" keep + regions greater than `value` "[]", "()", "[)", + and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions + outside `value[0]` to value[1]` Open vs. closed + intervals make no difference to constraint + display, but all versions are allowed for + consistency with filter transforms. + showlabels + Determines whether to label the contour lines + with their values. + showlines + Determines whether or not the contour lines are + drawn. Has an effect only if + `contours.coloring` is set to "fill". + size + Sets the step between each contour level. Must + be positive. + start + Sets the starting contour level value. Must be + less than `contours.end` + type + If `levels`, the data is represented as a + contour plot with multiple levels displayed. If + `constraint`, the data is represented as + constraints with the invalid region shaded as + specified by the `operation` and `value` + parameters. + value + Sets the value or values of the constraint + boundary. When `operation` is set to one of the + comparison values (=,<,>=,>,<=) "value" is + expected to be a number. When `operation` is + set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected + to be an array of two numbers where the first + is the lower bound and the second is the upper + bound. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='connectgaps', parent_name='contour', **kwargs + ): + super(ConnectgapsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='contour', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='contour', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.contour.colorbar.Tickformatst + op instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.contour.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of contour.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.contour.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + contour.colorbar.title.font instead. Sets this + color bar's title font. Note that the title's + font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use + contour.colorbar.title.side instead. Determines + the location of color bar's title with respect + to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocontourValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autocontour', parent_name='contour', **kwargs + ): + super(AutocontourValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autocolorscale', parent_name='contour', **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/contour/_autocolorscale.py b/plotly/validators/contour/_autocolorscale.py deleted file mode 100644 index 43490eff041..00000000000 --- a/plotly/validators/contour/_autocolorscale.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autocolorscale', parent_name='contour', **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/_autocontour.py b/plotly/validators/contour/_autocontour.py deleted file mode 100644 index ee9d68a141a..00000000000 --- a/plotly/validators/contour/_autocontour.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocontourValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autocontour', parent_name='contour', **kwargs - ): - super(AutocontourValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/_colorbar.py b/plotly/validators/contour/_colorbar.py deleted file mode 100644 index fe3b37870d8..00000000000 --- a/plotly/validators/contour/_colorbar.py +++ /dev/null @@ -1,226 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='contour', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.contour.colorbar.Tickformatst - op instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.contour.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of contour.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.contour.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - contour.colorbar.title.font instead. Sets this - color bar's title font. Note that the title's - font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use - contour.colorbar.title.side instead. Determines - the location of color bar's title with respect - to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/contour/_colorscale.py b/plotly/validators/contour/_colorscale.py deleted file mode 100644 index c6e0cea698c..00000000000 --- a/plotly/validators/contour/_colorscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='contour', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/_connectgaps.py b/plotly/validators/contour/_connectgaps.py deleted file mode 100644 index 9fd4453ba2a..00000000000 --- a/plotly/validators/contour/_connectgaps.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='connectgaps', parent_name='contour', **kwargs - ): - super(ConnectgapsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_contours.py b/plotly/validators/contour/_contours.py deleted file mode 100644 index 4706fb5a5b0..00000000000 --- a/plotly/validators/contour/_contours.py +++ /dev/null @@ -1,80 +0,0 @@ -import _plotly_utils.basevalidators - - -class ContoursValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='contours', parent_name='contour', **kwargs - ): - super(ContoursValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Contours'), - data_docs=kwargs.pop( - 'data_docs', """ - coloring - Determines the coloring method showing the - contour values. If "fill", coloring is done - evenly between each contour level If "heatmap", - a heatmap gradient coloring is applied between - each contour level. If "lines", coloring is - done on the contour lines. If "none", no - coloring is applied on this trace. - end - Sets the end contour level value. Must be more - than `contours.start` - labelfont - Sets the font used for labeling the contour - levels. The default color comes from the lines, - if shown. The default family and size come from - `layout.font`. - labelformat - Sets the contour label formatting rule using d3 - formatting mini-language which is very similar - to Python, see: https://github.com/d3/d3-format - /blob/master/README.md#locale_format. - operation - Sets the constraint operation. "=" keeps - regions equal to `value` "<" and "<=" keep - regions less than `value` ">" and ">=" keep - regions greater than `value` "[]", "()", "[)", - and "(]" keep regions inside `value[0]` to - `value[1]` "][", ")(", "](", ")[" keep regions - outside `value[0]` to value[1]` Open vs. closed - intervals make no difference to constraint - display, but all versions are allowed for - consistency with filter transforms. - showlabels - Determines whether to label the contour lines - with their values. - showlines - Determines whether or not the contour lines are - drawn. Has an effect only if - `contours.coloring` is set to "fill". - size - Sets the step between each contour level. Must - be positive. - start - Sets the starting contour level value. Must be - less than `contours.end` - type - If `levels`, the data is represented as a - contour plot with multiple levels displayed. If - `constraint`, the data is represented as - constraints with the invalid region shaded as - specified by the `operation` and `value` - parameters. - value - Sets the value or values of the constraint - boundary. When `operation` is set to one of the - comparison values (=,<,>=,>,<=) "value" is - expected to be a number. When `operation` is - set to one of the interval values - ([],(),[),(],][,)(,](,)[) "value" is expected - to be an array of two numbers where the first - is the lower bound and the second is the upper - bound. -""" - ), - **kwargs - ) diff --git a/plotly/validators/contour/_customdata.py b/plotly/validators/contour/_customdata.py deleted file mode 100644 index 80e5a56cb65..00000000000 --- a/plotly/validators/contour/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='contour', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contour/_customdatasrc.py b/plotly/validators/contour/_customdatasrc.py deleted file mode 100644 index 6325328698f..00000000000 --- a/plotly/validators/contour/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='contour', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_dx.py b/plotly/validators/contour/_dx.py deleted file mode 100644 index e099a692874..00000000000 --- a/plotly/validators/contour/_dx.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class DxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='dx', parent_name='contour', **kwargs): - super(DxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'xtype': 'scaled'}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_dy.py b/plotly/validators/contour/_dy.py deleted file mode 100644 index 0edb699fda4..00000000000 --- a/plotly/validators/contour/_dy.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class DyValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='dy', parent_name='contour', **kwargs): - super(DyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'ytype': 'scaled'}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_fillcolor.py b/plotly/validators/contour/_fillcolor.py deleted file mode 100644 index 6a5f3245fee..00000000000 --- a/plotly/validators/contour/_fillcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='fillcolor', parent_name='contour', **kwargs - ): - super(FillcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'contour.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/contour/_hoverinfo.py b/plotly/validators/contour/_hoverinfo.py deleted file mode 100644 index 4119d4bd4af..00000000000 --- a/plotly/validators/contour/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='contour', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_hoverinfosrc.py b/plotly/validators/contour/_hoverinfosrc.py deleted file mode 100644 index 9c49c4e3f1f..00000000000 --- a/plotly/validators/contour/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='contour', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_hoverlabel.py b/plotly/validators/contour/_hoverlabel.py deleted file mode 100644 index 452dc4be307..00000000000 --- a/plotly/validators/contour/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='contour', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/contour/_hovertemplate.py b/plotly/validators/contour/_hovertemplate.py deleted file mode 100644 index 4d7144747ef..00000000000 --- a/plotly/validators/contour/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='contour', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_hovertemplatesrc.py b/plotly/validators/contour/_hovertemplatesrc.py deleted file mode 100644 index 62637719a68..00000000000 --- a/plotly/validators/contour/_hovertemplatesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertemplatesrc', parent_name='contour', **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_hovertext.py b/plotly/validators/contour/_hovertext.py deleted file mode 100644 index 88298008bd2..00000000000 --- a/plotly/validators/contour/_hovertext.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='contour', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contour/_hovertextsrc.py b/plotly/validators/contour/_hovertextsrc.py deleted file mode 100644 index e33e3b35712..00000000000 --- a/plotly/validators/contour/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='contour', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_ids.py b/plotly/validators/contour/_ids.py deleted file mode 100644 index 746bcbf68ac..00000000000 --- a/plotly/validators/contour/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='contour', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contour/_idssrc.py b/plotly/validators/contour/_idssrc.py deleted file mode 100644 index ca05ad793fc..00000000000 --- a/plotly/validators/contour/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='contour', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_legendgroup.py b/plotly/validators/contour/_legendgroup.py deleted file mode 100644 index 51c60c5759c..00000000000 --- a/plotly/validators/contour/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='contour', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_line.py b/plotly/validators/contour/_line.py deleted file mode 100644 index 631d0f94878..00000000000 --- a/plotly/validators/contour/_line.py +++ /dev/null @@ -1,30 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='line', parent_name='contour', **kwargs): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the color of the contour level. Has no - effect if `contours.coloring` is set to - "lines". - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - smoothing - Sets the amount of smoothing for the contour - lines, where 0 corresponds to no smoothing. - width - Sets the line width (in px). -""" - ), - **kwargs - ) diff --git a/plotly/validators/contour/_name.py b/plotly/validators/contour/_name.py deleted file mode 100644 index afab98b39d1..00000000000 --- a/plotly/validators/contour/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='contour', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_ncontours.py b/plotly/validators/contour/_ncontours.py deleted file mode 100644 index b566c2b1d3c..00000000000 --- a/plotly/validators/contour/_ncontours.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NcontoursValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='ncontours', parent_name='contour', **kwargs - ): - super(NcontoursValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/_opacity.py b/plotly/validators/contour/_opacity.py deleted file mode 100644 index d55fa17557a..00000000000 --- a/plotly/validators/contour/_opacity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='opacity', parent_name='contour', **kwargs): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/_reversescale.py b/plotly/validators/contour/_reversescale.py deleted file mode 100644 index b87444df6d5..00000000000 --- a/plotly/validators/contour/_reversescale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='reversescale', parent_name='contour', **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/_selectedpoints.py b/plotly/validators/contour/_selectedpoints.py deleted file mode 100644 index bfe52ac1046..00000000000 --- a/plotly/validators/contour/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='contour', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_showlegend.py b/plotly/validators/contour/_showlegend.py deleted file mode 100644 index 26d759935f2..00000000000 --- a/plotly/validators/contour/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='contour', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_showscale.py b/plotly/validators/contour/_showscale.py deleted file mode 100644 index 4b205c58a15..00000000000 --- a/plotly/validators/contour/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='contour', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_stream.py b/plotly/validators/contour/_stream.py deleted file mode 100644 index b935f76e4e2..00000000000 --- a/plotly/validators/contour/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='contour', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/contour/_text.py b/plotly/validators/contour/_text.py deleted file mode 100644 index 9614a96e092..00000000000 --- a/plotly/validators/contour/_text.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='text', parent_name='contour', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contour/_textsrc.py b/plotly/validators/contour/_textsrc.py deleted file mode 100644 index 079777a410a..00000000000 --- a/plotly/validators/contour/_textsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='textsrc', parent_name='contour', **kwargs): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_transpose.py b/plotly/validators/contour/_transpose.py deleted file mode 100644 index 6594e3dc5d2..00000000000 --- a/plotly/validators/contour/_transpose.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TransposeValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='transpose', parent_name='contour', **kwargs - ): - super(TransposeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_uid.py b/plotly/validators/contour/_uid.py deleted file mode 100644 index e639302fade..00000000000 --- a/plotly/validators/contour/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='contour', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_uirevision.py b/plotly/validators/contour/_uirevision.py deleted file mode 100644 index 67ca04e3aa3..00000000000 --- a/plotly/validators/contour/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='contour', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_visible.py b/plotly/validators/contour/_visible.py deleted file mode 100644 index e389036f2a2..00000000000 --- a/plotly/validators/contour/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='contour', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/contour/_x.py b/plotly/validators/contour/_x.py deleted file mode 100644 index de7b3c842fc..00000000000 --- a/plotly/validators/contour/_x.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='contour', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - implied_edits=kwargs.pop('implied_edits', {'xtype': 'array'}), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contour/_x0.py b/plotly/validators/contour/_x0.py deleted file mode 100644 index 523550db24c..00000000000 --- a/plotly/validators/contour/_x0.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class X0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='x0', parent_name='contour', **kwargs): - super(X0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - implied_edits=kwargs.pop('implied_edits', {'xtype': 'scaled'}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_xaxis.py b/plotly/validators/contour/_xaxis.py deleted file mode 100644 index d6e7e1070f3..00000000000 --- a/plotly/validators/contour/_xaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='xaxis', parent_name='contour', **kwargs): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_xcalendar.py b/plotly/validators/contour/_xcalendar.py deleted file mode 100644 index 283cf6e4770..00000000000 --- a/plotly/validators/contour/_xcalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xcalendar', parent_name='contour', **kwargs - ): - super(XcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/contour/_xsrc.py b/plotly/validators/contour/_xsrc.py deleted file mode 100644 index 280753d07e2..00000000000 --- a/plotly/validators/contour/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='contour', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_xtype.py b/plotly/validators/contour/_xtype.py deleted file mode 100644 index bd1be7fc95d..00000000000 --- a/plotly/validators/contour/_xtype.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XtypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='xtype', parent_name='contour', **kwargs): - super(XtypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['array', 'scaled']), - **kwargs - ) diff --git a/plotly/validators/contour/_y.py b/plotly/validators/contour/_y.py deleted file mode 100644 index 9861829ce4b..00000000000 --- a/plotly/validators/contour/_y.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='contour', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - implied_edits=kwargs.pop('implied_edits', {'ytype': 'array'}), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contour/_y0.py b/plotly/validators/contour/_y0.py deleted file mode 100644 index cb02889349d..00000000000 --- a/plotly/validators/contour/_y0.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class Y0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='y0', parent_name='contour', **kwargs): - super(Y0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - implied_edits=kwargs.pop('implied_edits', {'ytype': 'scaled'}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_yaxis.py b/plotly/validators/contour/_yaxis.py deleted file mode 100644 index 3ac39599695..00000000000 --- a/plotly/validators/contour/_yaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='yaxis', parent_name='contour', **kwargs): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_ycalendar.py b/plotly/validators/contour/_ycalendar.py deleted file mode 100644 index 75540024a7a..00000000000 --- a/plotly/validators/contour/_ycalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ycalendar', parent_name='contour', **kwargs - ): - super(YcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/contour/_ysrc.py b/plotly/validators/contour/_ysrc.py deleted file mode 100644 index 436cc1cfef1..00000000000 --- a/plotly/validators/contour/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='contour', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_ytype.py b/plotly/validators/contour/_ytype.py deleted file mode 100644 index f02e2cc8d9b..00000000000 --- a/plotly/validators/contour/_ytype.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YtypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='ytype', parent_name='contour', **kwargs): - super(YtypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['array', 'scaled']), - **kwargs - ) diff --git a/plotly/validators/contour/_z.py b/plotly/validators/contour/_z.py deleted file mode 100644 index a448ed2871d..00000000000 --- a/plotly/validators/contour/_z.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='z', parent_name='contour', **kwargs): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contour/_zauto.py b/plotly/validators/contour/_zauto.py deleted file mode 100644 index 80c6b07d7a8..00000000000 --- a/plotly/validators/contour/_zauto.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='zauto', parent_name='contour', **kwargs): - super(ZautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_zhoverformat.py b/plotly/validators/contour/_zhoverformat.py deleted file mode 100644 index 36c2ace25c5..00000000000 --- a/plotly/validators/contour/_zhoverformat.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZhoverformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='zhoverformat', parent_name='contour', **kwargs - ): - super(ZhoverformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/_zmax.py b/plotly/validators/contour/_zmax.py deleted file mode 100644 index 31b81033908..00000000000 --- a/plotly/validators/contour/_zmax.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='zmax', parent_name='contour', **kwargs): - super(ZmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'zauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_zmid.py b/plotly/validators/contour/_zmid.py deleted file mode 100644 index 4b4c1d34129..00000000000 --- a/plotly/validators/contour/_zmid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='zmid', parent_name='contour', **kwargs): - super(ZmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_zmin.py b/plotly/validators/contour/_zmin.py deleted file mode 100644 index 7fa2f2dd722..00000000000 --- a/plotly/validators/contour/_zmin.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='zmin', parent_name='contour', **kwargs): - super(ZminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'zauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/_zsrc.py b/plotly/validators/contour/_zsrc.py deleted file mode 100644 index 7880d532823..00000000000 --- a/plotly/validators/contour/_zsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='zsrc', parent_name='contour', **kwargs): - super(ZsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/__init__.py b/plotly/validators/contour/colorbar/__init__.py index 3dab31f7e02..25fcd329536 100644 --- a/plotly/validators/contour/colorbar/__init__.py +++ b/plotly/validators/contour/colorbar/__init__.py @@ -1,41 +1,879 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ypad', parent_name='contour.colorbar', **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='yanchor', parent_name='contour.colorbar', **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='contour.colorbar', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='xpad', parent_name='contour.colorbar', **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xanchor', parent_name='contour.colorbar', **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='contour.colorbar', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='contour.colorbar', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='contour.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='contour.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='tickvals', parent_name='contour.colorbar', **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='contour.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ticktext', parent_name='contour.colorbar', **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='contour.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ticks', parent_name='contour.colorbar', **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='contour.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='tickmode', parent_name='contour.colorbar', **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ticklen', parent_name='contour.colorbar', **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='contour.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='contour.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='contour.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='tickfont', parent_name='contour.colorbar', **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='contour.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='contour.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='tick0', parent_name='contour.colorbar', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='contour.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='contour.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='contour.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='contour.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='contour.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='contour.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='contour.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='contour.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='contour.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nticks', parent_name='contour.colorbar', **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='lenmode', parent_name='contour.colorbar', **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='len', parent_name='contour.colorbar', **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='contour.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='dtick', parent_name='contour.colorbar', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='contour.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='contour.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='contour.colorbar', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/contour/colorbar/_bgcolor.py b/plotly/validators/contour/colorbar/_bgcolor.py deleted file mode 100644 index ce46c0c86ba..00000000000 --- a/plotly/validators/contour/colorbar/_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='contour.colorbar', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_bordercolor.py b/plotly/validators/contour/colorbar/_bordercolor.py deleted file mode 100644 index 32e34b4e57c..00000000000 --- a/plotly/validators/contour/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='contour.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_borderwidth.py b/plotly/validators/contour/colorbar/_borderwidth.py deleted file mode 100644 index 164d5918d4d..00000000000 --- a/plotly/validators/contour/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='contour.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_dtick.py b/plotly/validators/contour/colorbar/_dtick.py deleted file mode 100644 index 5c89d68a57b..00000000000 --- a/plotly/validators/contour/colorbar/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='dtick', parent_name='contour.colorbar', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_exponentformat.py b/plotly/validators/contour/colorbar/_exponentformat.py deleted file mode 100644 index 8b59502356d..00000000000 --- a/plotly/validators/contour/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='contour.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_len.py b/plotly/validators/contour/colorbar/_len.py deleted file mode 100644 index f918cc7ed7a..00000000000 --- a/plotly/validators/contour/colorbar/_len.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='len', parent_name='contour.colorbar', **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_lenmode.py b/plotly/validators/contour/colorbar/_lenmode.py deleted file mode 100644 index 83d4aaa8b54..00000000000 --- a/plotly/validators/contour/colorbar/_lenmode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='lenmode', parent_name='contour.colorbar', **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_nticks.py b/plotly/validators/contour/colorbar/_nticks.py deleted file mode 100644 index b4aa05a5b5d..00000000000 --- a/plotly/validators/contour/colorbar/_nticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nticks', parent_name='contour.colorbar', **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_outlinecolor.py b/plotly/validators/contour/colorbar/_outlinecolor.py deleted file mode 100644 index fa6d4fd8084..00000000000 --- a/plotly/validators/contour/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='contour.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_outlinewidth.py b/plotly/validators/contour/colorbar/_outlinewidth.py deleted file mode 100644 index 8c4a918272d..00000000000 --- a/plotly/validators/contour/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='contour.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_separatethousands.py b/plotly/validators/contour/colorbar/_separatethousands.py deleted file mode 100644 index 7bd346925df..00000000000 --- a/plotly/validators/contour/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='contour.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_showexponent.py b/plotly/validators/contour/colorbar/_showexponent.py deleted file mode 100644 index 4e7dab7e97c..00000000000 --- a/plotly/validators/contour/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='contour.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_showticklabels.py b/plotly/validators/contour/colorbar/_showticklabels.py deleted file mode 100644 index aa1c86b94ed..00000000000 --- a/plotly/validators/contour/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='contour.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_showtickprefix.py b/plotly/validators/contour/colorbar/_showtickprefix.py deleted file mode 100644 index 9ee1c3acef2..00000000000 --- a/plotly/validators/contour/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='contour.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_showticksuffix.py b/plotly/validators/contour/colorbar/_showticksuffix.py deleted file mode 100644 index c87393e6529..00000000000 --- a/plotly/validators/contour/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='contour.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_thickness.py b/plotly/validators/contour/colorbar/_thickness.py deleted file mode 100644 index 3455eb02c34..00000000000 --- a/plotly/validators/contour/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='contour.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_thicknessmode.py b/plotly/validators/contour/colorbar/_thicknessmode.py deleted file mode 100644 index fec8d07d319..00000000000 --- a/plotly/validators/contour/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='contour.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_tick0.py b/plotly/validators/contour/colorbar/_tick0.py deleted file mode 100644 index 8a20ea61005..00000000000 --- a/plotly/validators/contour/colorbar/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='tick0', parent_name='contour.colorbar', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_tickangle.py b/plotly/validators/contour/colorbar/_tickangle.py deleted file mode 100644 index e9556344e7b..00000000000 --- a/plotly/validators/contour/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='contour.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_tickcolor.py b/plotly/validators/contour/colorbar/_tickcolor.py deleted file mode 100644 index ebb45a92f09..00000000000 --- a/plotly/validators/contour/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='contour.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_tickfont.py b/plotly/validators/contour/colorbar/_tickfont.py deleted file mode 100644 index fbe19867e43..00000000000 --- a/plotly/validators/contour/colorbar/_tickfont.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='tickfont', parent_name='contour.colorbar', **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_tickformat.py b/plotly/validators/contour/colorbar/_tickformat.py deleted file mode 100644 index ac4eeb241d3..00000000000 --- a/plotly/validators/contour/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='contour.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_tickformatstopdefaults.py b/plotly/validators/contour/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 5b4480fa5de..00000000000 --- a/plotly/validators/contour/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='contour.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_tickformatstops.py b/plotly/validators/contour/colorbar/_tickformatstops.py deleted file mode 100644 index 68161d2fa75..00000000000 --- a/plotly/validators/contour/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='contour.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_ticklen.py b/plotly/validators/contour/colorbar/_ticklen.py deleted file mode 100644 index d222f42b8a5..00000000000 --- a/plotly/validators/contour/colorbar/_ticklen.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ticklen', parent_name='contour.colorbar', **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_tickmode.py b/plotly/validators/contour/colorbar/_tickmode.py deleted file mode 100644 index df21178c010..00000000000 --- a/plotly/validators/contour/colorbar/_tickmode.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='tickmode', parent_name='contour.colorbar', **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_tickprefix.py b/plotly/validators/contour/colorbar/_tickprefix.py deleted file mode 100644 index b6721347b54..00000000000 --- a/plotly/validators/contour/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='contour.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_ticks.py b/plotly/validators/contour/colorbar/_ticks.py deleted file mode 100644 index 7cbe40f4032..00000000000 --- a/plotly/validators/contour/colorbar/_ticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ticks', parent_name='contour.colorbar', **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_ticksuffix.py b/plotly/validators/contour/colorbar/_ticksuffix.py deleted file mode 100644 index 656383cf043..00000000000 --- a/plotly/validators/contour/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='contour.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_ticktext.py b/plotly/validators/contour/colorbar/_ticktext.py deleted file mode 100644 index 689e129bec4..00000000000 --- a/plotly/validators/contour/colorbar/_ticktext.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ticktext', parent_name='contour.colorbar', **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_ticktextsrc.py b/plotly/validators/contour/colorbar/_ticktextsrc.py deleted file mode 100644 index c32ecffb9ab..00000000000 --- a/plotly/validators/contour/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='contour.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_tickvals.py b/plotly/validators/contour/colorbar/_tickvals.py deleted file mode 100644 index 7c8df1bc3fa..00000000000 --- a/plotly/validators/contour/colorbar/_tickvals.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='tickvals', parent_name='contour.colorbar', **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_tickvalssrc.py b/plotly/validators/contour/colorbar/_tickvalssrc.py deleted file mode 100644 index 04b6f4b0192..00000000000 --- a/plotly/validators/contour/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='contour.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_tickwidth.py b/plotly/validators/contour/colorbar/_tickwidth.py deleted file mode 100644 index a04a268b18f..00000000000 --- a/plotly/validators/contour/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='contour.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_title.py b/plotly/validators/contour/colorbar/_title.py deleted file mode 100644 index 4f7db47f275..00000000000 --- a/plotly/validators/contour/colorbar/_title.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='contour.colorbar', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_x.py b/plotly/validators/contour/colorbar/_x.py deleted file mode 100644 index dccb6eeb2b4..00000000000 --- a/plotly/validators/contour/colorbar/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='contour.colorbar', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_xanchor.py b/plotly/validators/contour/colorbar/_xanchor.py deleted file mode 100644 index dd8b2d5c439..00000000000 --- a/plotly/validators/contour/colorbar/_xanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xanchor', parent_name='contour.colorbar', **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_xpad.py b/plotly/validators/contour/colorbar/_xpad.py deleted file mode 100644 index 5a9c3381793..00000000000 --- a/plotly/validators/contour/colorbar/_xpad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='xpad', parent_name='contour.colorbar', **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_y.py b/plotly/validators/contour/colorbar/_y.py deleted file mode 100644 index a3ce1dfb7d3..00000000000 --- a/plotly/validators/contour/colorbar/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='contour.colorbar', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_yanchor.py b/plotly/validators/contour/colorbar/_yanchor.py deleted file mode 100644 index 505df2af1b7..00000000000 --- a/plotly/validators/contour/colorbar/_yanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='yanchor', parent_name='contour.colorbar', **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/_ypad.py b/plotly/validators/contour/colorbar/_ypad.py deleted file mode 100644 index e4d3c7f6c3c..00000000000 --- a/plotly/validators/contour/colorbar/_ypad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ypad', parent_name='contour.colorbar', **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/tickfont/__init__.py b/plotly/validators/contour/colorbar/tickfont/__init__.py index 199d72e71c6..16728294f79 100644 --- a/plotly/validators/contour/colorbar/tickfont/__init__.py +++ b/plotly/validators/contour/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='contour.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='contour.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='contour.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/contour/colorbar/tickfont/_color.py b/plotly/validators/contour/colorbar/tickfont/_color.py deleted file mode 100644 index e340eda6d43..00000000000 --- a/plotly/validators/contour/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='contour.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/tickfont/_family.py b/plotly/validators/contour/colorbar/tickfont/_family.py deleted file mode 100644 index bed09fd5136..00000000000 --- a/plotly/validators/contour/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='contour.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/tickfont/_size.py b/plotly/validators/contour/colorbar/tickfont/_size.py deleted file mode 100644 index 4a4f7f38bb8..00000000000 --- a/plotly/validators/contour/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='contour.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/tickformatstop/__init__.py b/plotly/validators/contour/colorbar/tickformatstop/__init__.py index 3f6c06cac47..08ec1510b12 100644 --- a/plotly/validators/contour/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/contour/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='contour.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='contour.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='contour.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='contour.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='contour.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/contour/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/contour/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index aaec4af51e3..00000000000 --- a/plotly/validators/contour/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='contour.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/tickformatstop/_enabled.py b/plotly/validators/contour/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index 266022bf4a6..00000000000 --- a/plotly/validators/contour/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='contour.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/tickformatstop/_name.py b/plotly/validators/contour/colorbar/tickformatstop/_name.py deleted file mode 100644 index fd130b85492..00000000000 --- a/plotly/validators/contour/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='contour.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/contour/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index be0bc830004..00000000000 --- a/plotly/validators/contour/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='contour.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/tickformatstop/_value.py b/plotly/validators/contour/colorbar/tickformatstop/_value.py deleted file mode 100644 index f65f86d2af5..00000000000 --- a/plotly/validators/contour/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='contour.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/title/__init__.py b/plotly/validators/contour/colorbar/title/__init__.py index 33c9c145bb8..d668147161f 100644 --- a/plotly/validators/contour/colorbar/title/__init__.py +++ b/plotly/validators/contour/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='contour.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='contour.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='contour.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/contour/colorbar/title/_font.py b/plotly/validators/contour/colorbar/title/_font.py deleted file mode 100644 index 5372846720b..00000000000 --- a/plotly/validators/contour/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='contour.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/title/_side.py b/plotly/validators/contour/colorbar/title/_side.py deleted file mode 100644 index 28da4de8a18..00000000000 --- a/plotly/validators/contour/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='contour.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/title/_text.py b/plotly/validators/contour/colorbar/title/_text.py deleted file mode 100644 index 2bfcfe2ade6..00000000000 --- a/plotly/validators/contour/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='contour.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/title/font/__init__.py b/plotly/validators/contour/colorbar/title/font/__init__.py index 199d72e71c6..2f0e05e686b 100644 --- a/plotly/validators/contour/colorbar/title/font/__init__.py +++ b/plotly/validators/contour/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='contour.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='contour.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='contour.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/contour/colorbar/title/font/_color.py b/plotly/validators/contour/colorbar/title/font/_color.py deleted file mode 100644 index a188d778a51..00000000000 --- a/plotly/validators/contour/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='contour.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/title/font/_family.py b/plotly/validators/contour/colorbar/title/font/_family.py deleted file mode 100644 index 43540a24c5d..00000000000 --- a/plotly/validators/contour/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='contour.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/contour/colorbar/title/font/_size.py b/plotly/validators/contour/colorbar/title/font/_size.py deleted file mode 100644 index f3834e47864..00000000000 --- a/plotly/validators/contour/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='contour.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/contours/__init__.py b/plotly/validators/contour/contours/__init__.py index 2ff9693386a..42b30f37a49 100644 --- a/plotly/validators/contour/contours/__init__.py +++ b/plotly/validators/contour/contours/__init__.py @@ -1,11 +1,237 @@ -from ._value import ValueValidator -from ._type import TypeValidator -from ._start import StartValidator -from ._size import SizeValidator -from ._showlines import ShowlinesValidator -from ._showlabels import ShowlabelsValidator -from ._operation import OperationValidator -from ._labelformat import LabelformatValidator -from ._labelfont import LabelfontValidator -from ._end import EndValidator -from ._coloring import ColoringValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='value', parent_name='contour.contours', **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='contour.contours', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['levels', 'constraint']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StartValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='start', parent_name='contour.contours', **kwargs + ): + super(StartValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='contour.contours', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlinesValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showlines', + parent_name='contour.contours', + **kwargs + ): + super(ShowlinesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showlabels', + parent_name='contour.contours', + **kwargs + ): + super(ShowlabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OperationValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='operation', + parent_name='contour.contours', + **kwargs + ): + super(OperationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + '=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', + ')(', '](', ')[' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='labelformat', + parent_name='contour.contours', + **kwargs + ): + super(LabelformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='labelfont', + parent_name='contour.contours', + **kwargs + ): + super(LabelfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Labelfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='end', parent_name='contour.contours', **kwargs + ): + super(EndValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColoringValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='coloring', parent_name='contour.contours', **kwargs + ): + super(ColoringValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fill', 'heatmap', 'lines', 'none']), + **kwargs + ) diff --git a/plotly/validators/contour/contours/_coloring.py b/plotly/validators/contour/contours/_coloring.py deleted file mode 100644 index c2b366fff48..00000000000 --- a/plotly/validators/contour/contours/_coloring.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColoringValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='coloring', parent_name='contour.contours', **kwargs - ): - super(ColoringValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fill', 'heatmap', 'lines', 'none']), - **kwargs - ) diff --git a/plotly/validators/contour/contours/_end.py b/plotly/validators/contour/contours/_end.py deleted file mode 100644 index b14558a43ec..00000000000 --- a/plotly/validators/contour/contours/_end.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='end', parent_name='contour.contours', **kwargs - ): - super(EndValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/contours/_labelfont.py b/plotly/validators/contour/contours/_labelfont.py deleted file mode 100644 index 0ff3e5fd2e2..00000000000 --- a/plotly/validators/contour/contours/_labelfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='labelfont', - parent_name='contour.contours', - **kwargs - ): - super(LabelfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Labelfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/contour/contours/_labelformat.py b/plotly/validators/contour/contours/_labelformat.py deleted file mode 100644 index a95ec2337a2..00000000000 --- a/plotly/validators/contour/contours/_labelformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='labelformat', - parent_name='contour.contours', - **kwargs - ): - super(LabelformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/contours/_operation.py b/plotly/validators/contour/contours/_operation.py deleted file mode 100644 index 831c9df0e20..00000000000 --- a/plotly/validators/contour/contours/_operation.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class OperationValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='operation', - parent_name='contour.contours', - **kwargs - ): - super(OperationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - '=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', - ')(', '](', ')[' - ] - ), - **kwargs - ) diff --git a/plotly/validators/contour/contours/_showlabels.py b/plotly/validators/contour/contours/_showlabels.py deleted file mode 100644 index 7216285ed2d..00000000000 --- a/plotly/validators/contour/contours/_showlabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showlabels', - parent_name='contour.contours', - **kwargs - ): - super(ShowlabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/contours/_showlines.py b/plotly/validators/contour/contours/_showlines.py deleted file mode 100644 index b3e2adbdc17..00000000000 --- a/plotly/validators/contour/contours/_showlines.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlinesValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showlines', - parent_name='contour.contours', - **kwargs - ): - super(ShowlinesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/contours/_size.py b/plotly/validators/contour/contours/_size.py deleted file mode 100644 index 5f65d31f786..00000000000 --- a/plotly/validators/contour/contours/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='contour.contours', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/contours/_start.py b/plotly/validators/contour/contours/_start.py deleted file mode 100644 index 19f8603b59c..00000000000 --- a/plotly/validators/contour/contours/_start.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='start', parent_name='contour.contours', **kwargs - ): - super(StartValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/contours/_type.py b/plotly/validators/contour/contours/_type.py deleted file mode 100644 index 1859ddcdb20..00000000000 --- a/plotly/validators/contour/contours/_type.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='contour.contours', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['levels', 'constraint']), - **kwargs - ) diff --git a/plotly/validators/contour/contours/_value.py b/plotly/validators/contour/contours/_value.py deleted file mode 100644 index d28fdc9ae6b..00000000000 --- a/plotly/validators/contour/contours/_value.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='value', parent_name='contour.contours', **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/contours/labelfont/__init__.py b/plotly/validators/contour/contours/labelfont/__init__.py index 199d72e71c6..2e6b523f6f6 100644 --- a/plotly/validators/contour/contours/labelfont/__init__.py +++ b/plotly/validators/contour/contours/labelfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='contour.contours.labelfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='contour.contours.labelfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='contour.contours.labelfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/contour/contours/labelfont/_color.py b/plotly/validators/contour/contours/labelfont/_color.py deleted file mode 100644 index 02a4e2e5af3..00000000000 --- a/plotly/validators/contour/contours/labelfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='contour.contours.labelfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/contours/labelfont/_family.py b/plotly/validators/contour/contours/labelfont/_family.py deleted file mode 100644 index 066c80a11af..00000000000 --- a/plotly/validators/contour/contours/labelfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='contour.contours.labelfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/contour/contours/labelfont/_size.py b/plotly/validators/contour/contours/labelfont/_size.py deleted file mode 100644 index 18d4f0d85ba..00000000000 --- a/plotly/validators/contour/contours/labelfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='contour.contours.labelfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/hoverlabel/__init__.py b/plotly/validators/contour/hoverlabel/__init__.py index 856f769ba33..287c5dfa76a 100644 --- a/plotly/validators/contour/hoverlabel/__init__.py +++ b/plotly/validators/contour/hoverlabel/__init__.py @@ -1,7 +1,173 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='contour.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='contour.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='contour.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='contour.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='contour.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='contour.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='contour.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/contour/hoverlabel/_bgcolor.py b/plotly/validators/contour/hoverlabel/_bgcolor.py deleted file mode 100644 index c2d7f438727..00000000000 --- a/plotly/validators/contour/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='contour.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/hoverlabel/_bgcolorsrc.py b/plotly/validators/contour/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 7048e8f245f..00000000000 --- a/plotly/validators/contour/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='contour.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/hoverlabel/_bordercolor.py b/plotly/validators/contour/hoverlabel/_bordercolor.py deleted file mode 100644 index 68a847611b8..00000000000 --- a/plotly/validators/contour/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='contour.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/hoverlabel/_bordercolorsrc.py b/plotly/validators/contour/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 1bc43c9b1fb..00000000000 --- a/plotly/validators/contour/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='contour.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/hoverlabel/_font.py b/plotly/validators/contour/hoverlabel/_font.py deleted file mode 100644 index 88ee4aa2e02..00000000000 --- a/plotly/validators/contour/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='contour.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/contour/hoverlabel/_namelength.py b/plotly/validators/contour/hoverlabel/_namelength.py deleted file mode 100644 index 71f44e306a1..00000000000 --- a/plotly/validators/contour/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='contour.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/hoverlabel/_namelengthsrc.py b/plotly/validators/contour/hoverlabel/_namelengthsrc.py deleted file mode 100644 index d8362ba935b..00000000000 --- a/plotly/validators/contour/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='contour.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/hoverlabel/font/__init__.py b/plotly/validators/contour/hoverlabel/font/__init__.py index 1d2c591d1e5..704257e34b2 100644 --- a/plotly/validators/contour/hoverlabel/font/__init__.py +++ b/plotly/validators/contour/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='contour.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='contour.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='contour.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='contour.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='contour.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='contour.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/contour/hoverlabel/font/_color.py b/plotly/validators/contour/hoverlabel/font/_color.py deleted file mode 100644 index d8aff8a3790..00000000000 --- a/plotly/validators/contour/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='contour.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/hoverlabel/font/_colorsrc.py b/plotly/validators/contour/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 04e62dfbbcc..00000000000 --- a/plotly/validators/contour/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='contour.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/hoverlabel/font/_family.py b/plotly/validators/contour/hoverlabel/font/_family.py deleted file mode 100644 index e0e1d5db770..00000000000 --- a/plotly/validators/contour/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='contour.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/contour/hoverlabel/font/_familysrc.py b/plotly/validators/contour/hoverlabel/font/_familysrc.py deleted file mode 100644 index 3dbd7e4585a..00000000000 --- a/plotly/validators/contour/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='contour.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/hoverlabel/font/_size.py b/plotly/validators/contour/hoverlabel/font/_size.py deleted file mode 100644 index f9c473d604d..00000000000 --- a/plotly/validators/contour/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='contour.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/hoverlabel/font/_sizesrc.py b/plotly/validators/contour/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 3ba236fcb35..00000000000 --- a/plotly/validators/contour/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='contour.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/line/__init__.py b/plotly/validators/contour/line/__init__.py index 185c3b5d84e..05614dcb109 100644 --- a/plotly/validators/contour/line/__init__.py +++ b/plotly/validators/contour/line/__init__.py @@ -1,4 +1,77 @@ -from ._width import WidthValidator -from ._smoothing import SmoothingValidator -from ._dash import DashValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='contour.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style+colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='smoothing', parent_name='contour.line', **kwargs + ): + super(SmoothingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 1.3), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashValidator(_plotly_utils.basevalidators.DashValidator): + + def __init__( + self, plotly_name='dash', parent_name='contour.line', **kwargs + ): + super(DashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='contour.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style+colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/contour/line/_color.py b/plotly/validators/contour/line/_color.py deleted file mode 100644 index 34f9b39660e..00000000000 --- a/plotly/validators/contour/line/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='contour.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style+colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/line/_dash.py b/plotly/validators/contour/line/_dash.py deleted file mode 100644 index 6274be31291..00000000000 --- a/plotly/validators/contour/line/_dash.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashValidator(_plotly_utils.basevalidators.DashValidator): - - def __init__( - self, plotly_name='dash', parent_name='contour.line', **kwargs - ): - super(DashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/contour/line/_smoothing.py b/plotly/validators/contour/line/_smoothing.py deleted file mode 100644 index 439b0578db9..00000000000 --- a/plotly/validators/contour/line/_smoothing.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='smoothing', parent_name='contour.line', **kwargs - ): - super(SmoothingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 1.3), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/line/_width.py b/plotly/validators/contour/line/_width.py deleted file mode 100644 index 0216864e464..00000000000 --- a/plotly/validators/contour/line/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='contour.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style+colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contour/stream/__init__.py b/plotly/validators/contour/stream/__init__.py index 2f4f2047594..ff13c96c840 100644 --- a/plotly/validators/contour/stream/__init__.py +++ b/plotly/validators/contour/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='contour.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='contour.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/contour/stream/_maxpoints.py b/plotly/validators/contour/stream/_maxpoints.py deleted file mode 100644 index 263304fbbf4..00000000000 --- a/plotly/validators/contour/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='contour.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contour/stream/_token.py b/plotly/validators/contour/stream/_token.py deleted file mode 100644 index ccdba149d6a..00000000000 --- a/plotly/validators/contour/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='contour.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/__init__.py b/plotly/validators/contourcarpet/__init__.py index 27931991f10..42aea17ac45 100644 --- a/plotly/validators/contourcarpet/__init__.py +++ b/plotly/validators/contourcarpet/__init__.py @@ -1,50 +1,1232 @@ -from ._zsrc import ZsrcValidator -from ._zmin import ZminValidator -from ._zmid import ZmidValidator -from ._zmax import ZmaxValidator -from ._zauto import ZautoValidator -from ._z import ZValidator -from ._yaxis import YAxisValidator -from ._xaxis import XAxisValidator -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._transpose import TransposeValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._showscale import ShowscaleValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._reversescale import ReversescaleValidator -from ._opacity import OpacityValidator -from ._ncontours import NcontoursValidator -from ._name import NameValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._fillcolor import FillcolorValidator -from ._db import DbValidator -from ._da import DaValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._contours import ContoursValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._carpet import CarpetValidator -from ._btype import BtypeValidator -from ._bsrc import BsrcValidator -from ._b0 import B0Validator -from ._b import BValidator -from ._autocontour import AutocontourValidator -from ._autocolorscale import AutocolorscaleValidator -from ._atype import AtypeValidator -from ._asrc import AsrcValidator -from ._a0 import A0Validator -from ._a import AValidator + + +import _plotly_utils.basevalidators + + +class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='zsrc', parent_name='contourcarpet', **kwargs + ): + super(ZsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='zmin', parent_name='contourcarpet', **kwargs + ): + super(ZminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'zauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='zmid', parent_name='contourcarpet', **kwargs + ): + super(ZmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='zmax', parent_name='contourcarpet', **kwargs + ): + super(ZmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'zauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='zauto', parent_name='contourcarpet', **kwargs + ): + super(ZautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='z', parent_name='contourcarpet', **kwargs): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='yaxis', parent_name='contourcarpet', **kwargs + ): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='xaxis', parent_name='contourcarpet', **kwargs + ): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='contourcarpet', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='contourcarpet', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='uid', parent_name='contourcarpet', **kwargs + ): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TransposeValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='transpose', parent_name='contourcarpet', **kwargs + ): + super(TransposeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textsrc', parent_name='contourcarpet', **kwargs + ): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='text', parent_name='contourcarpet', **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='contourcarpet', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='contourcarpet', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='contourcarpet', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='selectedpoints', + parent_name='contourcarpet', + **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='contourcarpet', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='contourcarpet', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NcontoursValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='ncontours', parent_name='contourcarpet', **kwargs + ): + super(NcontoursValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='contourcarpet', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='contourcarpet', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the color of the contour level. Has no if + `contours.coloring` is set to "lines". + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour + lines, where 0 corresponds to no smoothing. + width + Sets the line width (in px). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='contourcarpet', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='contourcarpet', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ids', parent_name='contourcarpet', **kwargs + ): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertextsrc', + parent_name='contourcarpet', + **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='contourcarpet', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='contourcarpet', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hoverinfosrc', + parent_name='contourcarpet', + **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='contourcarpet', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='fillcolor', parent_name='contourcarpet', **kwargs + ): + super(FillcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'contourcarpet.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DbValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='db', parent_name='contourcarpet', **kwargs + ): + super(DbValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'ytype': 'scaled'}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DaValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='da', parent_name='contourcarpet', **kwargs + ): + super(DaValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'xtype': 'scaled'}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='customdatasrc', + parent_name='contourcarpet', + **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='contourcarpet', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ContoursValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='contours', parent_name='contourcarpet', **kwargs + ): + super(ContoursValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Contours'), + data_docs=kwargs.pop( + 'data_docs', """ + coloring + Determines the coloring method showing the + contour values. If "fill", coloring is done + evenly between each contour level If "lines", + coloring is done on the contour lines. If + "none", no coloring is applied on this trace. + end + Sets the end contour level value. Must be more + than `contours.start` + labelfont + Sets the font used for labeling the contour + levels. The default color comes from the lines, + if shown. The default family and size come from + `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-language which is very similar + to Python, see: https://github.com/d3/d3-format + /blob/master/README.md#locale_format. + operation + Sets the constraint operation. "=" keeps + regions equal to `value` "<" and "<=" keep + regions less than `value` ">" and ">=" keep + regions greater than `value` "[]", "()", "[)", + and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions + outside `value[0]` to value[1]` Open vs. closed + intervals make no difference to constraint + display, but all versions are allowed for + consistency with filter transforms. + showlabels + Determines whether to label the contour lines + with their values. + showlines + Determines whether or not the contour lines are + drawn. Has an effect only if + `contours.coloring` is set to "fill". + size + Sets the step between each contour level. Must + be positive. + start + Sets the starting contour level value. Must be + less than `contours.end` + type + If `levels`, the data is represented as a + contour plot with multiple levels displayed. If + `constraint`, the data is represented as + constraints with the invalid region shaded as + specified by the `operation` and `value` + parameters. + value + Sets the value or values of the constraint + boundary. When `operation` is set to one of the + comparison values (=,<,>=,>,<=) "value" is + expected to be a number. When `operation` is + set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected + to be an array of two numbers where the first + is the lower bound and the second is the upper + bound. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='contourcarpet', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='contourcarpet', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.contourcarpet.colorbar.Tickfo + rmatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.contourcarpet.colorbar.tickformatstopdefaults + ), sets the default property values to use for + elements of + contourcarpet.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.contourcarpet.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + contourcarpet.colorbar.title.font instead. Sets + this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + contourcarpet.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CarpetValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='carpet', parent_name='contourcarpet', **kwargs + ): + super(CarpetValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BtypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='btype', parent_name='contourcarpet', **kwargs + ): + super(BtypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['array', 'scaled']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='bsrc', parent_name='contourcarpet', **kwargs + ): + super(BsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class B0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='b0', parent_name='contourcarpet', **kwargs + ): + super(B0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + implied_edits=kwargs.pop('implied_edits', {'ytype': 'scaled'}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='b', parent_name='contourcarpet', **kwargs): + super(BValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + implied_edits=kwargs.pop('implied_edits', {'ytype': 'array'}), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocontourValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autocontour', parent_name='contourcarpet', **kwargs + ): + super(AutocontourValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='contourcarpet', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AtypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='atype', parent_name='contourcarpet', **kwargs + ): + super(AtypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['array', 'scaled']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='asrc', parent_name='contourcarpet', **kwargs + ): + super(AsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class A0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='a0', parent_name='contourcarpet', **kwargs + ): + super(A0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + implied_edits=kwargs.pop('implied_edits', {'xtype': 'scaled'}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='a', parent_name='contourcarpet', **kwargs): + super(AValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + implied_edits=kwargs.pop('implied_edits', {'xtype': 'array'}), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/contourcarpet/_a.py b/plotly/validators/contourcarpet/_a.py deleted file mode 100644 index f52f1e3505d..00000000000 --- a/plotly/validators/contourcarpet/_a.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='a', parent_name='contourcarpet', **kwargs): - super(AValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - implied_edits=kwargs.pop('implied_edits', {'xtype': 'array'}), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_a0.py b/plotly/validators/contourcarpet/_a0.py deleted file mode 100644 index d25fd6765ef..00000000000 --- a/plotly/validators/contourcarpet/_a0.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class A0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='a0', parent_name='contourcarpet', **kwargs - ): - super(A0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - implied_edits=kwargs.pop('implied_edits', {'xtype': 'scaled'}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_asrc.py b/plotly/validators/contourcarpet/_asrc.py deleted file mode 100644 index 62fa854415f..00000000000 --- a/plotly/validators/contourcarpet/_asrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='asrc', parent_name='contourcarpet', **kwargs - ): - super(AsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_atype.py b/plotly/validators/contourcarpet/_atype.py deleted file mode 100644 index ea1e20b5041..00000000000 --- a/plotly/validators/contourcarpet/_atype.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AtypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='atype', parent_name='contourcarpet', **kwargs - ): - super(AtypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['array', 'scaled']), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_autocolorscale.py b/plotly/validators/contourcarpet/_autocolorscale.py deleted file mode 100644 index 2244196503f..00000000000 --- a/plotly/validators/contourcarpet/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='contourcarpet', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_autocontour.py b/plotly/validators/contourcarpet/_autocontour.py deleted file mode 100644 index 2d8d54515a3..00000000000 --- a/plotly/validators/contourcarpet/_autocontour.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocontourValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autocontour', parent_name='contourcarpet', **kwargs - ): - super(AutocontourValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_b.py b/plotly/validators/contourcarpet/_b.py deleted file mode 100644 index 4dc0f4681a9..00000000000 --- a/plotly/validators/contourcarpet/_b.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='b', parent_name='contourcarpet', **kwargs): - super(BValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - implied_edits=kwargs.pop('implied_edits', {'ytype': 'array'}), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_b0.py b/plotly/validators/contourcarpet/_b0.py deleted file mode 100644 index df9bf7c7937..00000000000 --- a/plotly/validators/contourcarpet/_b0.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class B0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='b0', parent_name='contourcarpet', **kwargs - ): - super(B0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - implied_edits=kwargs.pop('implied_edits', {'ytype': 'scaled'}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_bsrc.py b/plotly/validators/contourcarpet/_bsrc.py deleted file mode 100644 index f1627177859..00000000000 --- a/plotly/validators/contourcarpet/_bsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='bsrc', parent_name='contourcarpet', **kwargs - ): - super(BsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_btype.py b/plotly/validators/contourcarpet/_btype.py deleted file mode 100644 index 86296a0a7aa..00000000000 --- a/plotly/validators/contourcarpet/_btype.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BtypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='btype', parent_name='contourcarpet', **kwargs - ): - super(BtypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['array', 'scaled']), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_carpet.py b/plotly/validators/contourcarpet/_carpet.py deleted file mode 100644 index 2dc57ba6041..00000000000 --- a/plotly/validators/contourcarpet/_carpet.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CarpetValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='carpet', parent_name='contourcarpet', **kwargs - ): - super(CarpetValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_colorbar.py b/plotly/validators/contourcarpet/_colorbar.py deleted file mode 100644 index c503f0975db..00000000000 --- a/plotly/validators/contourcarpet/_colorbar.py +++ /dev/null @@ -1,228 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='contourcarpet', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.contourcarpet.colorbar.Tickfo - rmatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.contourcarpet.colorbar.tickformatstopdefaults - ), sets the default property values to use for - elements of - contourcarpet.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.contourcarpet.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - contourcarpet.colorbar.title.font instead. Sets - this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - contourcarpet.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_colorscale.py b/plotly/validators/contourcarpet/_colorscale.py deleted file mode 100644 index 5e8768b70a2..00000000000 --- a/plotly/validators/contourcarpet/_colorscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='contourcarpet', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_contours.py b/plotly/validators/contourcarpet/_contours.py deleted file mode 100644 index 425f8fa2f8a..00000000000 --- a/plotly/validators/contourcarpet/_contours.py +++ /dev/null @@ -1,78 +0,0 @@ -import _plotly_utils.basevalidators - - -class ContoursValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='contours', parent_name='contourcarpet', **kwargs - ): - super(ContoursValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Contours'), - data_docs=kwargs.pop( - 'data_docs', """ - coloring - Determines the coloring method showing the - contour values. If "fill", coloring is done - evenly between each contour level If "lines", - coloring is done on the contour lines. If - "none", no coloring is applied on this trace. - end - Sets the end contour level value. Must be more - than `contours.start` - labelfont - Sets the font used for labeling the contour - levels. The default color comes from the lines, - if shown. The default family and size come from - `layout.font`. - labelformat - Sets the contour label formatting rule using d3 - formatting mini-language which is very similar - to Python, see: https://github.com/d3/d3-format - /blob/master/README.md#locale_format. - operation - Sets the constraint operation. "=" keeps - regions equal to `value` "<" and "<=" keep - regions less than `value` ">" and ">=" keep - regions greater than `value` "[]", "()", "[)", - and "(]" keep regions inside `value[0]` to - `value[1]` "][", ")(", "](", ")[" keep regions - outside `value[0]` to value[1]` Open vs. closed - intervals make no difference to constraint - display, but all versions are allowed for - consistency with filter transforms. - showlabels - Determines whether to label the contour lines - with their values. - showlines - Determines whether or not the contour lines are - drawn. Has an effect only if - `contours.coloring` is set to "fill". - size - Sets the step between each contour level. Must - be positive. - start - Sets the starting contour level value. Must be - less than `contours.end` - type - If `levels`, the data is represented as a - contour plot with multiple levels displayed. If - `constraint`, the data is represented as - constraints with the invalid region shaded as - specified by the `operation` and `value` - parameters. - value - Sets the value or values of the constraint - boundary. When `operation` is set to one of the - comparison values (=,<,>=,>,<=) "value" is - expected to be a number. When `operation` is - set to one of the interval values - ([],(),[),(],][,)(,](,)[) "value" is expected - to be an array of two numbers where the first - is the lower bound and the second is the upper - bound. -""" - ), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_customdata.py b/plotly/validators/contourcarpet/_customdata.py deleted file mode 100644 index 914965d9468..00000000000 --- a/plotly/validators/contourcarpet/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='contourcarpet', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_customdatasrc.py b/plotly/validators/contourcarpet/_customdatasrc.py deleted file mode 100644 index e67d38817eb..00000000000 --- a/plotly/validators/contourcarpet/_customdatasrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='customdatasrc', - parent_name='contourcarpet', - **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_da.py b/plotly/validators/contourcarpet/_da.py deleted file mode 100644 index 2bf2edd3dc6..00000000000 --- a/plotly/validators/contourcarpet/_da.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class DaValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='da', parent_name='contourcarpet', **kwargs - ): - super(DaValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'xtype': 'scaled'}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_db.py b/plotly/validators/contourcarpet/_db.py deleted file mode 100644 index 8804bf67f1e..00000000000 --- a/plotly/validators/contourcarpet/_db.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class DbValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='db', parent_name='contourcarpet', **kwargs - ): - super(DbValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'ytype': 'scaled'}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_fillcolor.py b/plotly/validators/contourcarpet/_fillcolor.py deleted file mode 100644 index 9ddd782c0a6..00000000000 --- a/plotly/validators/contourcarpet/_fillcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='fillcolor', parent_name='contourcarpet', **kwargs - ): - super(FillcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'contourcarpet.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_hoverinfo.py b/plotly/validators/contourcarpet/_hoverinfo.py deleted file mode 100644 index 475329302ad..00000000000 --- a/plotly/validators/contourcarpet/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='contourcarpet', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_hoverinfosrc.py b/plotly/validators/contourcarpet/_hoverinfosrc.py deleted file mode 100644 index 559b897f040..00000000000 --- a/plotly/validators/contourcarpet/_hoverinfosrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hoverinfosrc', - parent_name='contourcarpet', - **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_hoverlabel.py b/plotly/validators/contourcarpet/_hoverlabel.py deleted file mode 100644 index e11f9de4397..00000000000 --- a/plotly/validators/contourcarpet/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='contourcarpet', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_hovertext.py b/plotly/validators/contourcarpet/_hovertext.py deleted file mode 100644 index f4081f7632b..00000000000 --- a/plotly/validators/contourcarpet/_hovertext.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='contourcarpet', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_hovertextsrc.py b/plotly/validators/contourcarpet/_hovertextsrc.py deleted file mode 100644 index de15c797d1c..00000000000 --- a/plotly/validators/contourcarpet/_hovertextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertextsrc', - parent_name='contourcarpet', - **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_ids.py b/plotly/validators/contourcarpet/_ids.py deleted file mode 100644 index 23c9179ae78..00000000000 --- a/plotly/validators/contourcarpet/_ids.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ids', parent_name='contourcarpet', **kwargs - ): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_idssrc.py b/plotly/validators/contourcarpet/_idssrc.py deleted file mode 100644 index 7e3caf49da8..00000000000 --- a/plotly/validators/contourcarpet/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='contourcarpet', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_legendgroup.py b/plotly/validators/contourcarpet/_legendgroup.py deleted file mode 100644 index 37cbcd7b611..00000000000 --- a/plotly/validators/contourcarpet/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='contourcarpet', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_line.py b/plotly/validators/contourcarpet/_line.py deleted file mode 100644 index 0f86a129553..00000000000 --- a/plotly/validators/contourcarpet/_line.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='contourcarpet', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the color of the contour level. Has no if - `contours.coloring` is set to "lines". - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - smoothing - Sets the amount of smoothing for the contour - lines, where 0 corresponds to no smoothing. - width - Sets the line width (in px). -""" - ), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_name.py b/plotly/validators/contourcarpet/_name.py deleted file mode 100644 index e2a51312fbf..00000000000 --- a/plotly/validators/contourcarpet/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='contourcarpet', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_ncontours.py b/plotly/validators/contourcarpet/_ncontours.py deleted file mode 100644 index dc2658d6e36..00000000000 --- a/plotly/validators/contourcarpet/_ncontours.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NcontoursValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='ncontours', parent_name='contourcarpet', **kwargs - ): - super(NcontoursValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_opacity.py b/plotly/validators/contourcarpet/_opacity.py deleted file mode 100644 index b4c9398208e..00000000000 --- a/plotly/validators/contourcarpet/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='contourcarpet', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_reversescale.py b/plotly/validators/contourcarpet/_reversescale.py deleted file mode 100644 index ea7393eeff4..00000000000 --- a/plotly/validators/contourcarpet/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='contourcarpet', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_selectedpoints.py b/plotly/validators/contourcarpet/_selectedpoints.py deleted file mode 100644 index 17783ed6747..00000000000 --- a/plotly/validators/contourcarpet/_selectedpoints.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='selectedpoints', - parent_name='contourcarpet', - **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_showlegend.py b/plotly/validators/contourcarpet/_showlegend.py deleted file mode 100644 index 4ccf984fd9b..00000000000 --- a/plotly/validators/contourcarpet/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='contourcarpet', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_showscale.py b/plotly/validators/contourcarpet/_showscale.py deleted file mode 100644 index 9ac9de6b5e1..00000000000 --- a/plotly/validators/contourcarpet/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='contourcarpet', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_stream.py b/plotly/validators/contourcarpet/_stream.py deleted file mode 100644 index 7996ec5ba03..00000000000 --- a/plotly/validators/contourcarpet/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='contourcarpet', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_text.py b/plotly/validators/contourcarpet/_text.py deleted file mode 100644 index e5039b48930..00000000000 --- a/plotly/validators/contourcarpet/_text.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='text', parent_name='contourcarpet', **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_textsrc.py b/plotly/validators/contourcarpet/_textsrc.py deleted file mode 100644 index 5c0b355d5ec..00000000000 --- a/plotly/validators/contourcarpet/_textsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textsrc', parent_name='contourcarpet', **kwargs - ): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_transpose.py b/plotly/validators/contourcarpet/_transpose.py deleted file mode 100644 index 6bb58bd7c6c..00000000000 --- a/plotly/validators/contourcarpet/_transpose.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TransposeValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='transpose', parent_name='contourcarpet', **kwargs - ): - super(TransposeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_uid.py b/plotly/validators/contourcarpet/_uid.py deleted file mode 100644 index 3c40d135f4d..00000000000 --- a/plotly/validators/contourcarpet/_uid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='uid', parent_name='contourcarpet', **kwargs - ): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_uirevision.py b/plotly/validators/contourcarpet/_uirevision.py deleted file mode 100644 index 73cc79a8bea..00000000000 --- a/plotly/validators/contourcarpet/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='contourcarpet', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_visible.py b/plotly/validators/contourcarpet/_visible.py deleted file mode 100644 index 6a270e9ff97..00000000000 --- a/plotly/validators/contourcarpet/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='contourcarpet', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_xaxis.py b/plotly/validators/contourcarpet/_xaxis.py deleted file mode 100644 index f2c796cf2c3..00000000000 --- a/plotly/validators/contourcarpet/_xaxis.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='xaxis', parent_name='contourcarpet', **kwargs - ): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_yaxis.py b/plotly/validators/contourcarpet/_yaxis.py deleted file mode 100644 index 29c25aede49..00000000000 --- a/plotly/validators/contourcarpet/_yaxis.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='yaxis', parent_name='contourcarpet', **kwargs - ): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_z.py b/plotly/validators/contourcarpet/_z.py deleted file mode 100644 index f45ccce8816..00000000000 --- a/plotly/validators/contourcarpet/_z.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='z', parent_name='contourcarpet', **kwargs): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_zauto.py b/plotly/validators/contourcarpet/_zauto.py deleted file mode 100644 index 7d759139c85..00000000000 --- a/plotly/validators/contourcarpet/_zauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='zauto', parent_name='contourcarpet', **kwargs - ): - super(ZautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_zmax.py b/plotly/validators/contourcarpet/_zmax.py deleted file mode 100644 index a53c42d2440..00000000000 --- a/plotly/validators/contourcarpet/_zmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='zmax', parent_name='contourcarpet', **kwargs - ): - super(ZmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'zauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_zmid.py b/plotly/validators/contourcarpet/_zmid.py deleted file mode 100644 index b3116954c83..00000000000 --- a/plotly/validators/contourcarpet/_zmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='zmid', parent_name='contourcarpet', **kwargs - ): - super(ZmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_zmin.py b/plotly/validators/contourcarpet/_zmin.py deleted file mode 100644 index 20796622ac7..00000000000 --- a/plotly/validators/contourcarpet/_zmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='zmin', parent_name='contourcarpet', **kwargs - ): - super(ZminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'zauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/_zsrc.py b/plotly/validators/contourcarpet/_zsrc.py deleted file mode 100644 index 4555508d968..00000000000 --- a/plotly/validators/contourcarpet/_zsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='zsrc', parent_name='contourcarpet', **kwargs - ): - super(ZsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/__init__.py b/plotly/validators/contourcarpet/colorbar/__init__.py index 3dab31f7e02..e368a5dd323 100644 --- a/plotly/validators/contourcarpet/colorbar/__init__.py +++ b/plotly/validators/contourcarpet/colorbar/__init__.py @@ -1,41 +1,930 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ypad', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='contourcarpet.colorbar', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xpad', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='contourcarpet.colorbar', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='len', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='contourcarpet.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/contourcarpet/colorbar/_bgcolor.py b/plotly/validators/contourcarpet/colorbar/_bgcolor.py deleted file mode 100644 index 71087b56807..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_bordercolor.py b/plotly/validators/contourcarpet/colorbar/_bordercolor.py deleted file mode 100644 index a19d965e3d8..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_borderwidth.py b/plotly/validators/contourcarpet/colorbar/_borderwidth.py deleted file mode 100644 index 1d12a66c573..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_dtick.py b/plotly/validators/contourcarpet/colorbar/_dtick.py deleted file mode 100644 index 5da4f05f0cd..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_exponentformat.py b/plotly/validators/contourcarpet/colorbar/_exponentformat.py deleted file mode 100644 index 951d9824003..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_len.py b/plotly/validators/contourcarpet/colorbar/_len.py deleted file mode 100644 index 49b88df08b8..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_len.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='len', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_lenmode.py b/plotly/validators/contourcarpet/colorbar/_lenmode.py deleted file mode 100644 index 82758fea984..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_nticks.py b/plotly/validators/contourcarpet/colorbar/_nticks.py deleted file mode 100644 index e17248724eb..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_outlinecolor.py b/plotly/validators/contourcarpet/colorbar/_outlinecolor.py deleted file mode 100644 index 8a78b91d4fb..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_outlinewidth.py b/plotly/validators/contourcarpet/colorbar/_outlinewidth.py deleted file mode 100644 index 038b17ee643..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_separatethousands.py b/plotly/validators/contourcarpet/colorbar/_separatethousands.py deleted file mode 100644 index 77b76cd1801..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_showexponent.py b/plotly/validators/contourcarpet/colorbar/_showexponent.py deleted file mode 100644 index 2e985244be8..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_showticklabels.py b/plotly/validators/contourcarpet/colorbar/_showticklabels.py deleted file mode 100644 index ef3457e0991..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_showtickprefix.py b/plotly/validators/contourcarpet/colorbar/_showtickprefix.py deleted file mode 100644 index 19398da60a3..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_showticksuffix.py b/plotly/validators/contourcarpet/colorbar/_showticksuffix.py deleted file mode 100644 index 1d6aaec41f4..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_thickness.py b/plotly/validators/contourcarpet/colorbar/_thickness.py deleted file mode 100644 index f146a5366ba..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_thicknessmode.py b/plotly/validators/contourcarpet/colorbar/_thicknessmode.py deleted file mode 100644 index 83151051ba0..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_tick0.py b/plotly/validators/contourcarpet/colorbar/_tick0.py deleted file mode 100644 index 4aa175ae438..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_tickangle.py b/plotly/validators/contourcarpet/colorbar/_tickangle.py deleted file mode 100644 index 66ae7b28151..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_tickcolor.py b/plotly/validators/contourcarpet/colorbar/_tickcolor.py deleted file mode 100644 index 323fa00f3a7..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_tickfont.py b/plotly/validators/contourcarpet/colorbar/_tickfont.py deleted file mode 100644 index a0ad34f0503..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_tickformat.py b/plotly/validators/contourcarpet/colorbar/_tickformat.py deleted file mode 100644 index f126fe0c4ff..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_tickformatstopdefaults.py b/plotly/validators/contourcarpet/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 9a73310453e..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_tickformatstops.py b/plotly/validators/contourcarpet/colorbar/_tickformatstops.py deleted file mode 100644 index 9e9c41b68e9..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_ticklen.py b/plotly/validators/contourcarpet/colorbar/_ticklen.py deleted file mode 100644 index 7eef51a0f20..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_tickmode.py b/plotly/validators/contourcarpet/colorbar/_tickmode.py deleted file mode 100644 index 0f59867e69e..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_tickprefix.py b/plotly/validators/contourcarpet/colorbar/_tickprefix.py deleted file mode 100644 index 220ccd6c230..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_ticks.py b/plotly/validators/contourcarpet/colorbar/_ticks.py deleted file mode 100644 index 49e5156aa03..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_ticksuffix.py b/plotly/validators/contourcarpet/colorbar/_ticksuffix.py deleted file mode 100644 index 194db942a90..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_ticktext.py b/plotly/validators/contourcarpet/colorbar/_ticktext.py deleted file mode 100644 index 2d0e77b2628..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_ticktextsrc.py b/plotly/validators/contourcarpet/colorbar/_ticktextsrc.py deleted file mode 100644 index f60cfd1550f..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_tickvals.py b/plotly/validators/contourcarpet/colorbar/_tickvals.py deleted file mode 100644 index 258c7ddfb51..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_tickvalssrc.py b/plotly/validators/contourcarpet/colorbar/_tickvalssrc.py deleted file mode 100644 index 3daac6ec9d1..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_tickwidth.py b/plotly/validators/contourcarpet/colorbar/_tickwidth.py deleted file mode 100644 index 79efddd44ef..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_title.py b/plotly/validators/contourcarpet/colorbar/_title.py deleted file mode 100644 index 1cc82b34830..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_x.py b/plotly/validators/contourcarpet/colorbar/_x.py deleted file mode 100644 index dcfe6ca1e32..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='contourcarpet.colorbar', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_xanchor.py b/plotly/validators/contourcarpet/colorbar/_xanchor.py deleted file mode 100644 index 8adfd0d7e8b..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_xpad.py b/plotly/validators/contourcarpet/colorbar/_xpad.py deleted file mode 100644 index 7fb660bceca..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_xpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xpad', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_y.py b/plotly/validators/contourcarpet/colorbar/_y.py deleted file mode 100644 index fa76a168f44..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='contourcarpet.colorbar', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_yanchor.py b/plotly/validators/contourcarpet/colorbar/_yanchor.py deleted file mode 100644 index 8ed546bb395..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/_ypad.py b/plotly/validators/contourcarpet/colorbar/_ypad.py deleted file mode 100644 index 16d8176fe51..00000000000 --- a/plotly/validators/contourcarpet/colorbar/_ypad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ypad', - parent_name='contourcarpet.colorbar', - **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/tickfont/__init__.py b/plotly/validators/contourcarpet/colorbar/tickfont/__init__.py index 199d72e71c6..3018852aae7 100644 --- a/plotly/validators/contourcarpet/colorbar/tickfont/__init__.py +++ b/plotly/validators/contourcarpet/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='contourcarpet.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='contourcarpet.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='contourcarpet.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/contourcarpet/colorbar/tickfont/_color.py b/plotly/validators/contourcarpet/colorbar/tickfont/_color.py deleted file mode 100644 index 6fd696f74d1..00000000000 --- a/plotly/validators/contourcarpet/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='contourcarpet.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/tickfont/_family.py b/plotly/validators/contourcarpet/colorbar/tickfont/_family.py deleted file mode 100644 index 8f4c529ff8b..00000000000 --- a/plotly/validators/contourcarpet/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='contourcarpet.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/tickfont/_size.py b/plotly/validators/contourcarpet/colorbar/tickfont/_size.py deleted file mode 100644 index ce3fb4a5ca2..00000000000 --- a/plotly/validators/contourcarpet/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='contourcarpet.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/tickformatstop/__init__.py b/plotly/validators/contourcarpet/colorbar/tickformatstop/__init__.py index 3f6c06cac47..6d8211387b8 100644 --- a/plotly/validators/contourcarpet/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/contourcarpet/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='contourcarpet.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='contourcarpet.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='contourcarpet.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='contourcarpet.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='contourcarpet.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/contourcarpet/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/contourcarpet/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 030c0c1130a..00000000000 --- a/plotly/validators/contourcarpet/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='contourcarpet.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/tickformatstop/_enabled.py b/plotly/validators/contourcarpet/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index 70e389d28b2..00000000000 --- a/plotly/validators/contourcarpet/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='contourcarpet.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/tickformatstop/_name.py b/plotly/validators/contourcarpet/colorbar/tickformatstop/_name.py deleted file mode 100644 index afbe8dbf318..00000000000 --- a/plotly/validators/contourcarpet/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='contourcarpet.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/contourcarpet/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 2d0263a6cb0..00000000000 --- a/plotly/validators/contourcarpet/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='contourcarpet.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/tickformatstop/_value.py b/plotly/validators/contourcarpet/colorbar/tickformatstop/_value.py deleted file mode 100644 index 47980792bb2..00000000000 --- a/plotly/validators/contourcarpet/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='contourcarpet.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/title/__init__.py b/plotly/validators/contourcarpet/colorbar/title/__init__.py index 33c9c145bb8..54367d38000 100644 --- a/plotly/validators/contourcarpet/colorbar/title/__init__.py +++ b/plotly/validators/contourcarpet/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='contourcarpet.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='contourcarpet.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='contourcarpet.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/contourcarpet/colorbar/title/_font.py b/plotly/validators/contourcarpet/colorbar/title/_font.py deleted file mode 100644 index 6ffb1ccb0c5..00000000000 --- a/plotly/validators/contourcarpet/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='contourcarpet.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/title/_side.py b/plotly/validators/contourcarpet/colorbar/title/_side.py deleted file mode 100644 index 6d01e664a41..00000000000 --- a/plotly/validators/contourcarpet/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='contourcarpet.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/title/_text.py b/plotly/validators/contourcarpet/colorbar/title/_text.py deleted file mode 100644 index 3167964ef8a..00000000000 --- a/plotly/validators/contourcarpet/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='contourcarpet.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/title/font/__init__.py b/plotly/validators/contourcarpet/colorbar/title/font/__init__.py index 199d72e71c6..bf0fa23cb54 100644 --- a/plotly/validators/contourcarpet/colorbar/title/font/__init__.py +++ b/plotly/validators/contourcarpet/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='contourcarpet.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='contourcarpet.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='contourcarpet.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/contourcarpet/colorbar/title/font/_color.py b/plotly/validators/contourcarpet/colorbar/title/font/_color.py deleted file mode 100644 index 5729e92624d..00000000000 --- a/plotly/validators/contourcarpet/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='contourcarpet.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/title/font/_family.py b/plotly/validators/contourcarpet/colorbar/title/font/_family.py deleted file mode 100644 index 2baa1ec549c..00000000000 --- a/plotly/validators/contourcarpet/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='contourcarpet.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/colorbar/title/font/_size.py b/plotly/validators/contourcarpet/colorbar/title/font/_size.py deleted file mode 100644 index d8a3f94874f..00000000000 --- a/plotly/validators/contourcarpet/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='contourcarpet.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/contours/__init__.py b/plotly/validators/contourcarpet/contours/__init__.py index 2ff9693386a..a284f5190e2 100644 --- a/plotly/validators/contourcarpet/contours/__init__.py +++ b/plotly/validators/contourcarpet/contours/__init__.py @@ -1,11 +1,255 @@ -from ._value import ValueValidator -from ._type import TypeValidator -from ._start import StartValidator -from ._size import SizeValidator -from ._showlines import ShowlinesValidator -from ._showlabels import ShowlabelsValidator -from ._operation import OperationValidator -from ._labelformat import LabelformatValidator -from ._labelfont import LabelfontValidator -from ._end import EndValidator -from ._coloring import ColoringValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='value', + parent_name='contourcarpet.contours', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='type', + parent_name='contourcarpet.contours', + **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['levels', 'constraint']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StartValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='start', + parent_name='contourcarpet.contours', + **kwargs + ): + super(StartValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='contourcarpet.contours', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlinesValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showlines', + parent_name='contourcarpet.contours', + **kwargs + ): + super(ShowlinesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showlabels', + parent_name='contourcarpet.contours', + **kwargs + ): + super(ShowlabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OperationValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='operation', + parent_name='contourcarpet.contours', + **kwargs + ): + super(OperationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + '=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', + ')(', '](', ')[' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='labelformat', + parent_name='contourcarpet.contours', + **kwargs + ): + super(LabelformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='labelfont', + parent_name='contourcarpet.contours', + **kwargs + ): + super(LabelfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Labelfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='end', + parent_name='contourcarpet.contours', + **kwargs + ): + super(EndValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColoringValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='coloring', + parent_name='contourcarpet.contours', + **kwargs + ): + super(ColoringValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fill', 'lines', 'none']), + **kwargs + ) diff --git a/plotly/validators/contourcarpet/contours/_coloring.py b/plotly/validators/contourcarpet/contours/_coloring.py deleted file mode 100644 index ec9decaf258..00000000000 --- a/plotly/validators/contourcarpet/contours/_coloring.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColoringValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='coloring', - parent_name='contourcarpet.contours', - **kwargs - ): - super(ColoringValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fill', 'lines', 'none']), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/contours/_end.py b/plotly/validators/contourcarpet/contours/_end.py deleted file mode 100644 index 78fb5655216..00000000000 --- a/plotly/validators/contourcarpet/contours/_end.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='end', - parent_name='contourcarpet.contours', - **kwargs - ): - super(EndValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/contours/_labelfont.py b/plotly/validators/contourcarpet/contours/_labelfont.py deleted file mode 100644 index effb421782a..00000000000 --- a/plotly/validators/contourcarpet/contours/_labelfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='labelfont', - parent_name='contourcarpet.contours', - **kwargs - ): - super(LabelfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Labelfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/contours/_labelformat.py b/plotly/validators/contourcarpet/contours/_labelformat.py deleted file mode 100644 index b41ef9b3145..00000000000 --- a/plotly/validators/contourcarpet/contours/_labelformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='labelformat', - parent_name='contourcarpet.contours', - **kwargs - ): - super(LabelformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/contours/_operation.py b/plotly/validators/contourcarpet/contours/_operation.py deleted file mode 100644 index 4505eeeeef5..00000000000 --- a/plotly/validators/contourcarpet/contours/_operation.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class OperationValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='operation', - parent_name='contourcarpet.contours', - **kwargs - ): - super(OperationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - '=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', - ')(', '](', ')[' - ] - ), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/contours/_showlabels.py b/plotly/validators/contourcarpet/contours/_showlabels.py deleted file mode 100644 index c7ec795e485..00000000000 --- a/plotly/validators/contourcarpet/contours/_showlabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showlabels', - parent_name='contourcarpet.contours', - **kwargs - ): - super(ShowlabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/contours/_showlines.py b/plotly/validators/contourcarpet/contours/_showlines.py deleted file mode 100644 index a4d6ee4f9dd..00000000000 --- a/plotly/validators/contourcarpet/contours/_showlines.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlinesValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showlines', - parent_name='contourcarpet.contours', - **kwargs - ): - super(ShowlinesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/contours/_size.py b/plotly/validators/contourcarpet/contours/_size.py deleted file mode 100644 index cbeacd8ea3c..00000000000 --- a/plotly/validators/contourcarpet/contours/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='contourcarpet.contours', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/contours/_start.py b/plotly/validators/contourcarpet/contours/_start.py deleted file mode 100644 index 3c3386cf324..00000000000 --- a/plotly/validators/contourcarpet/contours/_start.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='start', - parent_name='contourcarpet.contours', - **kwargs - ): - super(StartValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/contours/_type.py b/plotly/validators/contourcarpet/contours/_type.py deleted file mode 100644 index e9e5cc158ba..00000000000 --- a/plotly/validators/contourcarpet/contours/_type.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='type', - parent_name='contourcarpet.contours', - **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['levels', 'constraint']), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/contours/_value.py b/plotly/validators/contourcarpet/contours/_value.py deleted file mode 100644 index ba3c3aba98a..00000000000 --- a/plotly/validators/contourcarpet/contours/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='value', - parent_name='contourcarpet.contours', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/contours/labelfont/__init__.py b/plotly/validators/contourcarpet/contours/labelfont/__init__.py index 199d72e71c6..0b7944364d1 100644 --- a/plotly/validators/contourcarpet/contours/labelfont/__init__.py +++ b/plotly/validators/contourcarpet/contours/labelfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='contourcarpet.contours.labelfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='contourcarpet.contours.labelfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='contourcarpet.contours.labelfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/contourcarpet/contours/labelfont/_color.py b/plotly/validators/contourcarpet/contours/labelfont/_color.py deleted file mode 100644 index 998ffe3c45c..00000000000 --- a/plotly/validators/contourcarpet/contours/labelfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='contourcarpet.contours.labelfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/contours/labelfont/_family.py b/plotly/validators/contourcarpet/contours/labelfont/_family.py deleted file mode 100644 index 2757818fe92..00000000000 --- a/plotly/validators/contourcarpet/contours/labelfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='contourcarpet.contours.labelfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/contours/labelfont/_size.py b/plotly/validators/contourcarpet/contours/labelfont/_size.py deleted file mode 100644 index 59296e08e7d..00000000000 --- a/plotly/validators/contourcarpet/contours/labelfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='contourcarpet.contours.labelfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/hoverlabel/__init__.py b/plotly/validators/contourcarpet/hoverlabel/__init__.py index 856f769ba33..a77960c761d 100644 --- a/plotly/validators/contourcarpet/hoverlabel/__init__.py +++ b/plotly/validators/contourcarpet/hoverlabel/__init__.py @@ -1,7 +1,176 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='contourcarpet.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='contourcarpet.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='contourcarpet.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='contourcarpet.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='contourcarpet.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='contourcarpet.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='contourcarpet.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/contourcarpet/hoverlabel/_bgcolor.py b/plotly/validators/contourcarpet/hoverlabel/_bgcolor.py deleted file mode 100644 index ca0c554daa2..00000000000 --- a/plotly/validators/contourcarpet/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='contourcarpet.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/hoverlabel/_bgcolorsrc.py b/plotly/validators/contourcarpet/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 3f54c990d4a..00000000000 --- a/plotly/validators/contourcarpet/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='contourcarpet.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/hoverlabel/_bordercolor.py b/plotly/validators/contourcarpet/hoverlabel/_bordercolor.py deleted file mode 100644 index 9fede52cda3..00000000000 --- a/plotly/validators/contourcarpet/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='contourcarpet.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/hoverlabel/_bordercolorsrc.py b/plotly/validators/contourcarpet/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 1c4ef7e90fa..00000000000 --- a/plotly/validators/contourcarpet/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='contourcarpet.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/hoverlabel/_font.py b/plotly/validators/contourcarpet/hoverlabel/_font.py deleted file mode 100644 index 6dadf31d8ae..00000000000 --- a/plotly/validators/contourcarpet/hoverlabel/_font.py +++ /dev/null @@ -1,50 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='contourcarpet.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/hoverlabel/_namelength.py b/plotly/validators/contourcarpet/hoverlabel/_namelength.py deleted file mode 100644 index d917dd704b5..00000000000 --- a/plotly/validators/contourcarpet/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='contourcarpet.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/hoverlabel/_namelengthsrc.py b/plotly/validators/contourcarpet/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 157fde7ea3d..00000000000 --- a/plotly/validators/contourcarpet/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='contourcarpet.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/hoverlabel/font/__init__.py b/plotly/validators/contourcarpet/hoverlabel/font/__init__.py index 1d2c591d1e5..b5e918878ae 100644 --- a/plotly/validators/contourcarpet/hoverlabel/font/__init__.py +++ b/plotly/validators/contourcarpet/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='contourcarpet.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='contourcarpet.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='contourcarpet.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='contourcarpet.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='contourcarpet.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='contourcarpet.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/contourcarpet/hoverlabel/font/_color.py b/plotly/validators/contourcarpet/hoverlabel/font/_color.py deleted file mode 100644 index c206700c4b5..00000000000 --- a/plotly/validators/contourcarpet/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='contourcarpet.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/hoverlabel/font/_colorsrc.py b/plotly/validators/contourcarpet/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 55dfb6bd9bf..00000000000 --- a/plotly/validators/contourcarpet/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='contourcarpet.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/hoverlabel/font/_family.py b/plotly/validators/contourcarpet/hoverlabel/font/_family.py deleted file mode 100644 index 3741854594e..00000000000 --- a/plotly/validators/contourcarpet/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='contourcarpet.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/hoverlabel/font/_familysrc.py b/plotly/validators/contourcarpet/hoverlabel/font/_familysrc.py deleted file mode 100644 index 2ff6136352f..00000000000 --- a/plotly/validators/contourcarpet/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='contourcarpet.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/hoverlabel/font/_size.py b/plotly/validators/contourcarpet/hoverlabel/font/_size.py deleted file mode 100644 index 3f57284277b..00000000000 --- a/plotly/validators/contourcarpet/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='contourcarpet.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/hoverlabel/font/_sizesrc.py b/plotly/validators/contourcarpet/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 9af6db27ed2..00000000000 --- a/plotly/validators/contourcarpet/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='contourcarpet.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/line/__init__.py b/plotly/validators/contourcarpet/line/__init__.py index 185c3b5d84e..826bb469703 100644 --- a/plotly/validators/contourcarpet/line/__init__.py +++ b/plotly/validators/contourcarpet/line/__init__.py @@ -1,4 +1,80 @@ -from ._width import WidthValidator -from ._smoothing import SmoothingValidator -from ._dash import DashValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='contourcarpet.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='smoothing', + parent_name='contourcarpet.line', + **kwargs + ): + super(SmoothingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 1.3), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashValidator(_plotly_utils.basevalidators.DashValidator): + + def __init__( + self, plotly_name='dash', parent_name='contourcarpet.line', **kwargs + ): + super(DashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='contourcarpet.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/contourcarpet/line/_color.py b/plotly/validators/contourcarpet/line/_color.py deleted file mode 100644 index f759ec0515e..00000000000 --- a/plotly/validators/contourcarpet/line/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='contourcarpet.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/line/_dash.py b/plotly/validators/contourcarpet/line/_dash.py deleted file mode 100644 index 8ac0d21adf1..00000000000 --- a/plotly/validators/contourcarpet/line/_dash.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashValidator(_plotly_utils.basevalidators.DashValidator): - - def __init__( - self, plotly_name='dash', parent_name='contourcarpet.line', **kwargs - ): - super(DashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/line/_smoothing.py b/plotly/validators/contourcarpet/line/_smoothing.py deleted file mode 100644 index 7d2f3ef0589..00000000000 --- a/plotly/validators/contourcarpet/line/_smoothing.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='smoothing', - parent_name='contourcarpet.line', - **kwargs - ): - super(SmoothingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 1.3), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/line/_width.py b/plotly/validators/contourcarpet/line/_width.py deleted file mode 100644 index a0208fdaa71..00000000000 --- a/plotly/validators/contourcarpet/line/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='contourcarpet.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/stream/__init__.py b/plotly/validators/contourcarpet/stream/__init__.py index 2f4f2047594..861782fa703 100644 --- a/plotly/validators/contourcarpet/stream/__init__.py +++ b/plotly/validators/contourcarpet/stream/__init__.py @@ -1,2 +1,44 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='token', + parent_name='contourcarpet.stream', + **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='contourcarpet.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/contourcarpet/stream/_maxpoints.py b/plotly/validators/contourcarpet/stream/_maxpoints.py deleted file mode 100644 index 1bb05ab7071..00000000000 --- a/plotly/validators/contourcarpet/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='contourcarpet.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/contourcarpet/stream/_token.py b/plotly/validators/contourcarpet/stream/_token.py deleted file mode 100644 index 1c0a9265dae..00000000000 --- a/plotly/validators/contourcarpet/stream/_token.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='token', - parent_name='contourcarpet.stream', - **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/frame/__init__.py b/plotly/validators/frame/__init__.py index 3568b631917..c1ffc658e53 100644 --- a/plotly/validators/frame/__init__.py +++ b/plotly/validators/frame/__init__.py @@ -1,6 +1,84 @@ -from ._traces import TracesValidator -from ._name import NameValidator -from ._layout import LayoutValidator -from ._group import GroupValidator -from ._data import DataValidator -from ._baseframe import BaseframeValidator + + +import _plotly_utils.basevalidators + + +class TracesValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='traces', parent_name='frame', **kwargs): + super(TracesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='frame', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import plotly.validators + + +class LayoutValidator(plotly.validators.LayoutValidator): + + def __init__(self, plotly_name='layout', parent_name='frame', **kwargs): + super(LayoutValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + role=kwargs.pop('role', 'object'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='group', parent_name='frame', **kwargs): + super(GroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import plotly.validators + + +class DataValidator(plotly.validators.DataValidator): + + def __init__(self, plotly_name='data', parent_name='frame', **kwargs): + super(DataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + role=kwargs.pop('role', 'object'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BaseframeValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='baseframe', parent_name='frame', **kwargs): + super(BaseframeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/frame/_baseframe.py b/plotly/validators/frame/_baseframe.py deleted file mode 100644 index 6cb29e4dfbc..00000000000 --- a/plotly/validators/frame/_baseframe.py +++ /dev/null @@ -1,12 +0,0 @@ -import _plotly_utils.basevalidators - - -class BaseframeValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='baseframe', parent_name='frame', **kwargs): - super(BaseframeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/frame/_data.py b/plotly/validators/frame/_data.py deleted file mode 100644 index bb78ad7aa24..00000000000 --- a/plotly/validators/frame/_data.py +++ /dev/null @@ -1,12 +0,0 @@ -import plotly.validators - - -class DataValidator(plotly.validators.DataValidator): - - def __init__(self, plotly_name='data', parent_name='frame', **kwargs): - super(DataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - role=kwargs.pop('role', 'object'), - **kwargs - ) diff --git a/plotly/validators/frame/_group.py b/plotly/validators/frame/_group.py deleted file mode 100644 index 45194dc427e..00000000000 --- a/plotly/validators/frame/_group.py +++ /dev/null @@ -1,12 +0,0 @@ -import _plotly_utils.basevalidators - - -class GroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='group', parent_name='frame', **kwargs): - super(GroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/frame/_layout.py b/plotly/validators/frame/_layout.py deleted file mode 100644 index f95c7c02f2f..00000000000 --- a/plotly/validators/frame/_layout.py +++ /dev/null @@ -1,12 +0,0 @@ -import plotly.validators - - -class LayoutValidator(plotly.validators.LayoutValidator): - - def __init__(self, plotly_name='layout', parent_name='frame', **kwargs): - super(LayoutValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - role=kwargs.pop('role', 'object'), - **kwargs - ) diff --git a/plotly/validators/frame/_name.py b/plotly/validators/frame/_name.py deleted file mode 100644 index 47224bd1e19..00000000000 --- a/plotly/validators/frame/_name.py +++ /dev/null @@ -1,12 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='frame', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/frame/_traces.py b/plotly/validators/frame/_traces.py deleted file mode 100644 index 01c38311edb..00000000000 --- a/plotly/validators/frame/_traces.py +++ /dev/null @@ -1,12 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracesValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='traces', parent_name='frame', **kwargs): - super(TracesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/__init__.py b/plotly/validators/heatmap/__init__.py index df8a8ad903e..51e9db5e453 100644 --- a/plotly/validators/heatmap/__init__.py +++ b/plotly/validators/heatmap/__init__.py @@ -1,53 +1,1145 @@ -from ._zsrc import ZsrcValidator -from ._zsmooth import ZsmoothValidator -from ._zmin import ZminValidator -from ._zmid import ZmidValidator -from ._zmax import ZmaxValidator -from ._zhoverformat import ZhoverformatValidator -from ._zauto import ZautoValidator -from ._z import ZValidator -from ._ytype import YtypeValidator -from ._ysrc import YsrcValidator -from ._ygap import YgapValidator -from ._ycalendar import YcalendarValidator -from ._yaxis import YAxisValidator -from ._y0 import Y0Validator -from ._y import YValidator -from ._xtype import XtypeValidator -from ._xsrc import XsrcValidator -from ._xgap import XgapValidator -from ._xcalendar import XcalendarValidator -from ._xaxis import XAxisValidator -from ._x0 import X0Validator -from ._x import XValidator -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._transpose import TransposeValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._showscale import ShowscaleValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._reversescale import ReversescaleValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._dy import DyValidator -from ._dx import DxValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._connectgaps import ConnectgapsValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='zsrc', parent_name='heatmap', **kwargs): + super(ZsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZsmoothValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='zsmooth', parent_name='heatmap', **kwargs): + super(ZsmoothValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fast', 'best', False]), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='zmin', parent_name='heatmap', **kwargs): + super(ZminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'zauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='zmid', parent_name='heatmap', **kwargs): + super(ZmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='zmax', parent_name='heatmap', **kwargs): + super(ZmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'zauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZhoverformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='zhoverformat', parent_name='heatmap', **kwargs + ): + super(ZhoverformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='zauto', parent_name='heatmap', **kwargs): + super(ZautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='z', parent_name='heatmap', **kwargs): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YtypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='ytype', parent_name='heatmap', **kwargs): + super(YtypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['array', 'scaled']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='heatmap', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YgapValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='ygap', parent_name='heatmap', **kwargs): + super(YgapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ycalendar', parent_name='heatmap', **kwargs + ): + super(YcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='yaxis', parent_name='heatmap', **kwargs): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Y0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='y0', parent_name='heatmap', **kwargs): + super(Y0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + implied_edits=kwargs.pop('implied_edits', {'ytype': 'scaled'}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='heatmap', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + implied_edits=kwargs.pop('implied_edits', {'ytype': 'array'}), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XtypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='xtype', parent_name='heatmap', **kwargs): + super(XtypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['array', 'scaled']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='heatmap', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XgapValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='xgap', parent_name='heatmap', **kwargs): + super(XgapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xcalendar', parent_name='heatmap', **kwargs + ): + super(XcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='xaxis', parent_name='heatmap', **kwargs): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class X0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='x0', parent_name='heatmap', **kwargs): + super(X0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + implied_edits=kwargs.pop('implied_edits', {'xtype': 'scaled'}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='heatmap', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + implied_edits=kwargs.pop('implied_edits', {'xtype': 'array'}), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='heatmap', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='heatmap', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='heatmap', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TransposeValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='transpose', parent_name='heatmap', **kwargs + ): + super(TransposeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='textsrc', parent_name='heatmap', **kwargs): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='text', parent_name='heatmap', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='heatmap', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='heatmap', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='heatmap', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='heatmap', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='reversescale', parent_name='heatmap', **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='opacity', parent_name='heatmap', **kwargs): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='heatmap', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='heatmap', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='heatmap', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='heatmap', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='heatmap', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='heatmap', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertemplatesrc', parent_name='heatmap', **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='heatmap', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='heatmap', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='heatmap', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='heatmap', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DyValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='dy', parent_name='heatmap', **kwargs): + super(DyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'ytype': 'scaled'}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='dx', parent_name='heatmap', **kwargs): + super(DxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'xtype': 'scaled'}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='heatmap', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='heatmap', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='connectgaps', parent_name='heatmap', **kwargs + ): + super(ConnectgapsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='heatmap', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='heatmap', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.heatmap.colorbar.Tickformatst + op instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.heatmap.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of heatmap.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.heatmap.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + heatmap.colorbar.title.font instead. Sets this + color bar's title font. Note that the title's + font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use + heatmap.colorbar.title.side instead. Determines + the location of color bar's title with respect + to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autocolorscale', parent_name='heatmap', **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/heatmap/_autocolorscale.py b/plotly/validators/heatmap/_autocolorscale.py deleted file mode 100644 index 4cf503e25da..00000000000 --- a/plotly/validators/heatmap/_autocolorscale.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autocolorscale', parent_name='heatmap', **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_colorbar.py b/plotly/validators/heatmap/_colorbar.py deleted file mode 100644 index 477e037edd9..00000000000 --- a/plotly/validators/heatmap/_colorbar.py +++ /dev/null @@ -1,226 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='heatmap', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.heatmap.colorbar.Tickformatst - op instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.heatmap.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of heatmap.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.heatmap.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - heatmap.colorbar.title.font instead. Sets this - color bar's title font. Note that the title's - font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use - heatmap.colorbar.title.side instead. Determines - the location of color bar's title with respect - to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/heatmap/_colorscale.py b/plotly/validators/heatmap/_colorscale.py deleted file mode 100644 index 45d3e8483f9..00000000000 --- a/plotly/validators/heatmap/_colorscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='heatmap', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_connectgaps.py b/plotly/validators/heatmap/_connectgaps.py deleted file mode 100644 index ec5b8e250db..00000000000 --- a/plotly/validators/heatmap/_connectgaps.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='connectgaps', parent_name='heatmap', **kwargs - ): - super(ConnectgapsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_customdata.py b/plotly/validators/heatmap/_customdata.py deleted file mode 100644 index 01322d40628..00000000000 --- a/plotly/validators/heatmap/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='heatmap', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_customdatasrc.py b/plotly/validators/heatmap/_customdatasrc.py deleted file mode 100644 index 155d5f91277..00000000000 --- a/plotly/validators/heatmap/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='heatmap', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_dx.py b/plotly/validators/heatmap/_dx.py deleted file mode 100644 index 19f5bd26f17..00000000000 --- a/plotly/validators/heatmap/_dx.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class DxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='dx', parent_name='heatmap', **kwargs): - super(DxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'xtype': 'scaled'}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_dy.py b/plotly/validators/heatmap/_dy.py deleted file mode 100644 index 9dce8218275..00000000000 --- a/plotly/validators/heatmap/_dy.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class DyValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='dy', parent_name='heatmap', **kwargs): - super(DyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'ytype': 'scaled'}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_hoverinfo.py b/plotly/validators/heatmap/_hoverinfo.py deleted file mode 100644 index 3876bdfba57..00000000000 --- a/plotly/validators/heatmap/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='heatmap', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_hoverinfosrc.py b/plotly/validators/heatmap/_hoverinfosrc.py deleted file mode 100644 index e628dd2853f..00000000000 --- a/plotly/validators/heatmap/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='heatmap', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_hoverlabel.py b/plotly/validators/heatmap/_hoverlabel.py deleted file mode 100644 index 52d1766b54f..00000000000 --- a/plotly/validators/heatmap/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='heatmap', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/heatmap/_hovertemplate.py b/plotly/validators/heatmap/_hovertemplate.py deleted file mode 100644 index 61b68076477..00000000000 --- a/plotly/validators/heatmap/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='heatmap', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_hovertemplatesrc.py b/plotly/validators/heatmap/_hovertemplatesrc.py deleted file mode 100644 index 15eaa9ddae0..00000000000 --- a/plotly/validators/heatmap/_hovertemplatesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertemplatesrc', parent_name='heatmap', **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_hovertext.py b/plotly/validators/heatmap/_hovertext.py deleted file mode 100644 index 3c294c912c9..00000000000 --- a/plotly/validators/heatmap/_hovertext.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='heatmap', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_hovertextsrc.py b/plotly/validators/heatmap/_hovertextsrc.py deleted file mode 100644 index 8a268c0d823..00000000000 --- a/plotly/validators/heatmap/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='heatmap', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_ids.py b/plotly/validators/heatmap/_ids.py deleted file mode 100644 index 6a37f5edade..00000000000 --- a/plotly/validators/heatmap/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='heatmap', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_idssrc.py b/plotly/validators/heatmap/_idssrc.py deleted file mode 100644 index 2faebe8a396..00000000000 --- a/plotly/validators/heatmap/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='heatmap', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_legendgroup.py b/plotly/validators/heatmap/_legendgroup.py deleted file mode 100644 index 526c39be3e3..00000000000 --- a/plotly/validators/heatmap/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='heatmap', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_name.py b/plotly/validators/heatmap/_name.py deleted file mode 100644 index 1ede0322ba3..00000000000 --- a/plotly/validators/heatmap/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='heatmap', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_opacity.py b/plotly/validators/heatmap/_opacity.py deleted file mode 100644 index 7f77563476f..00000000000 --- a/plotly/validators/heatmap/_opacity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='opacity', parent_name='heatmap', **kwargs): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_reversescale.py b/plotly/validators/heatmap/_reversescale.py deleted file mode 100644 index 598ca414d92..00000000000 --- a/plotly/validators/heatmap/_reversescale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='reversescale', parent_name='heatmap', **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_selectedpoints.py b/plotly/validators/heatmap/_selectedpoints.py deleted file mode 100644 index acb05247448..00000000000 --- a/plotly/validators/heatmap/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='heatmap', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_showlegend.py b/plotly/validators/heatmap/_showlegend.py deleted file mode 100644 index 9e147886eb4..00000000000 --- a/plotly/validators/heatmap/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='heatmap', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_showscale.py b/plotly/validators/heatmap/_showscale.py deleted file mode 100644 index 596eda69e9d..00000000000 --- a/plotly/validators/heatmap/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='heatmap', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_stream.py b/plotly/validators/heatmap/_stream.py deleted file mode 100644 index eed539236a8..00000000000 --- a/plotly/validators/heatmap/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='heatmap', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/heatmap/_text.py b/plotly/validators/heatmap/_text.py deleted file mode 100644 index 01ea1cf1c82..00000000000 --- a/plotly/validators/heatmap/_text.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='text', parent_name='heatmap', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_textsrc.py b/plotly/validators/heatmap/_textsrc.py deleted file mode 100644 index dc8ac7a5c6f..00000000000 --- a/plotly/validators/heatmap/_textsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='textsrc', parent_name='heatmap', **kwargs): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_transpose.py b/plotly/validators/heatmap/_transpose.py deleted file mode 100644 index 77ea3eb3fda..00000000000 --- a/plotly/validators/heatmap/_transpose.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TransposeValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='transpose', parent_name='heatmap', **kwargs - ): - super(TransposeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_uid.py b/plotly/validators/heatmap/_uid.py deleted file mode 100644 index a6374212096..00000000000 --- a/plotly/validators/heatmap/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='heatmap', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_uirevision.py b/plotly/validators/heatmap/_uirevision.py deleted file mode 100644 index 22ad1daeebf..00000000000 --- a/plotly/validators/heatmap/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='heatmap', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_visible.py b/plotly/validators/heatmap/_visible.py deleted file mode 100644 index 9c6c7f213c7..00000000000 --- a/plotly/validators/heatmap/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='heatmap', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/heatmap/_x.py b/plotly/validators/heatmap/_x.py deleted file mode 100644 index b29fd49235c..00000000000 --- a/plotly/validators/heatmap/_x.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='heatmap', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - implied_edits=kwargs.pop('implied_edits', {'xtype': 'array'}), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_x0.py b/plotly/validators/heatmap/_x0.py deleted file mode 100644 index 5d2048b0615..00000000000 --- a/plotly/validators/heatmap/_x0.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class X0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='x0', parent_name='heatmap', **kwargs): - super(X0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - implied_edits=kwargs.pop('implied_edits', {'xtype': 'scaled'}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_xaxis.py b/plotly/validators/heatmap/_xaxis.py deleted file mode 100644 index 9e81dd9d9d2..00000000000 --- a/plotly/validators/heatmap/_xaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='xaxis', parent_name='heatmap', **kwargs): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_xcalendar.py b/plotly/validators/heatmap/_xcalendar.py deleted file mode 100644 index 4961b26bc6b..00000000000 --- a/plotly/validators/heatmap/_xcalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xcalendar', parent_name='heatmap', **kwargs - ): - super(XcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/heatmap/_xgap.py b/plotly/validators/heatmap/_xgap.py deleted file mode 100644 index 4c308f8418f..00000000000 --- a/plotly/validators/heatmap/_xgap.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XgapValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='xgap', parent_name='heatmap', **kwargs): - super(XgapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_xsrc.py b/plotly/validators/heatmap/_xsrc.py deleted file mode 100644 index 87abc207fc5..00000000000 --- a/plotly/validators/heatmap/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='heatmap', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_xtype.py b/plotly/validators/heatmap/_xtype.py deleted file mode 100644 index 63d6b605f9e..00000000000 --- a/plotly/validators/heatmap/_xtype.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XtypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='xtype', parent_name='heatmap', **kwargs): - super(XtypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['array', 'scaled']), - **kwargs - ) diff --git a/plotly/validators/heatmap/_y.py b/plotly/validators/heatmap/_y.py deleted file mode 100644 index b533fd1cdcd..00000000000 --- a/plotly/validators/heatmap/_y.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='heatmap', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - implied_edits=kwargs.pop('implied_edits', {'ytype': 'array'}), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_y0.py b/plotly/validators/heatmap/_y0.py deleted file mode 100644 index 153e866f476..00000000000 --- a/plotly/validators/heatmap/_y0.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class Y0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='y0', parent_name='heatmap', **kwargs): - super(Y0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - implied_edits=kwargs.pop('implied_edits', {'ytype': 'scaled'}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_yaxis.py b/plotly/validators/heatmap/_yaxis.py deleted file mode 100644 index b418692e626..00000000000 --- a/plotly/validators/heatmap/_yaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='yaxis', parent_name='heatmap', **kwargs): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_ycalendar.py b/plotly/validators/heatmap/_ycalendar.py deleted file mode 100644 index 0eea440957a..00000000000 --- a/plotly/validators/heatmap/_ycalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ycalendar', parent_name='heatmap', **kwargs - ): - super(YcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/heatmap/_ygap.py b/plotly/validators/heatmap/_ygap.py deleted file mode 100644 index bcc0953d418..00000000000 --- a/plotly/validators/heatmap/_ygap.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YgapValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='ygap', parent_name='heatmap', **kwargs): - super(YgapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_ysrc.py b/plotly/validators/heatmap/_ysrc.py deleted file mode 100644 index 27653e5a169..00000000000 --- a/plotly/validators/heatmap/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='heatmap', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_ytype.py b/plotly/validators/heatmap/_ytype.py deleted file mode 100644 index dd02fe5df89..00000000000 --- a/plotly/validators/heatmap/_ytype.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YtypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='ytype', parent_name='heatmap', **kwargs): - super(YtypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['array', 'scaled']), - **kwargs - ) diff --git a/plotly/validators/heatmap/_z.py b/plotly/validators/heatmap/_z.py deleted file mode 100644 index 361b8f8852b..00000000000 --- a/plotly/validators/heatmap/_z.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='z', parent_name='heatmap', **kwargs): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_zauto.py b/plotly/validators/heatmap/_zauto.py deleted file mode 100644 index 8d50f114392..00000000000 --- a/plotly/validators/heatmap/_zauto.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='zauto', parent_name='heatmap', **kwargs): - super(ZautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_zhoverformat.py b/plotly/validators/heatmap/_zhoverformat.py deleted file mode 100644 index dfe9a64f972..00000000000 --- a/plotly/validators/heatmap/_zhoverformat.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZhoverformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='zhoverformat', parent_name='heatmap', **kwargs - ): - super(ZhoverformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_zmax.py b/plotly/validators/heatmap/_zmax.py deleted file mode 100644 index e0f4e0bcd28..00000000000 --- a/plotly/validators/heatmap/_zmax.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='zmax', parent_name='heatmap', **kwargs): - super(ZmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'zauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_zmid.py b/plotly/validators/heatmap/_zmid.py deleted file mode 100644 index 858d04c83bb..00000000000 --- a/plotly/validators/heatmap/_zmid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='zmid', parent_name='heatmap', **kwargs): - super(ZmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_zmin.py b/plotly/validators/heatmap/_zmin.py deleted file mode 100644 index c02814fc95a..00000000000 --- a/plotly/validators/heatmap/_zmin.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='zmin', parent_name='heatmap', **kwargs): - super(ZminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'zauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/_zsmooth.py b/plotly/validators/heatmap/_zsmooth.py deleted file mode 100644 index 651c5425083..00000000000 --- a/plotly/validators/heatmap/_zsmooth.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZsmoothValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='zsmooth', parent_name='heatmap', **kwargs): - super(ZsmoothValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fast', 'best', False]), - **kwargs - ) diff --git a/plotly/validators/heatmap/_zsrc.py b/plotly/validators/heatmap/_zsrc.py deleted file mode 100644 index edd4ac4720e..00000000000 --- a/plotly/validators/heatmap/_zsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='zsrc', parent_name='heatmap', **kwargs): - super(ZsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/__init__.py b/plotly/validators/heatmap/colorbar/__init__.py index 3dab31f7e02..55cef4ab9c6 100644 --- a/plotly/validators/heatmap/colorbar/__init__.py +++ b/plotly/validators/heatmap/colorbar/__init__.py @@ -1,41 +1,879 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ypad', parent_name='heatmap.colorbar', **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='yanchor', parent_name='heatmap.colorbar', **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='heatmap.colorbar', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='xpad', parent_name='heatmap.colorbar', **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xanchor', parent_name='heatmap.colorbar', **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='heatmap.colorbar', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='heatmap.colorbar', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='heatmap.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='heatmap.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='tickvals', parent_name='heatmap.colorbar', **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='heatmap.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ticktext', parent_name='heatmap.colorbar', **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='heatmap.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ticks', parent_name='heatmap.colorbar', **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='heatmap.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='tickmode', parent_name='heatmap.colorbar', **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ticklen', parent_name='heatmap.colorbar', **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='heatmap.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='heatmap.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='heatmap.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='tickfont', parent_name='heatmap.colorbar', **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='heatmap.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='heatmap.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='tick0', parent_name='heatmap.colorbar', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='heatmap.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='heatmap.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='heatmap.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='heatmap.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='heatmap.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='heatmap.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='heatmap.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='heatmap.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='heatmap.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nticks', parent_name='heatmap.colorbar', **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='lenmode', parent_name='heatmap.colorbar', **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='len', parent_name='heatmap.colorbar', **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='heatmap.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='dtick', parent_name='heatmap.colorbar', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='heatmap.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='heatmap.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='heatmap.colorbar', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/heatmap/colorbar/_bgcolor.py b/plotly/validators/heatmap/colorbar/_bgcolor.py deleted file mode 100644 index b7797b798d3..00000000000 --- a/plotly/validators/heatmap/colorbar/_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='heatmap.colorbar', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_bordercolor.py b/plotly/validators/heatmap/colorbar/_bordercolor.py deleted file mode 100644 index 140e6487a21..00000000000 --- a/plotly/validators/heatmap/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='heatmap.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_borderwidth.py b/plotly/validators/heatmap/colorbar/_borderwidth.py deleted file mode 100644 index 86472bd33c6..00000000000 --- a/plotly/validators/heatmap/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='heatmap.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_dtick.py b/plotly/validators/heatmap/colorbar/_dtick.py deleted file mode 100644 index 230f55df6aa..00000000000 --- a/plotly/validators/heatmap/colorbar/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='dtick', parent_name='heatmap.colorbar', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_exponentformat.py b/plotly/validators/heatmap/colorbar/_exponentformat.py deleted file mode 100644 index 0f881fdf856..00000000000 --- a/plotly/validators/heatmap/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='heatmap.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_len.py b/plotly/validators/heatmap/colorbar/_len.py deleted file mode 100644 index 8e906a8764b..00000000000 --- a/plotly/validators/heatmap/colorbar/_len.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='len', parent_name='heatmap.colorbar', **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_lenmode.py b/plotly/validators/heatmap/colorbar/_lenmode.py deleted file mode 100644 index c9480b66180..00000000000 --- a/plotly/validators/heatmap/colorbar/_lenmode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='lenmode', parent_name='heatmap.colorbar', **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_nticks.py b/plotly/validators/heatmap/colorbar/_nticks.py deleted file mode 100644 index dbf6e4a9e04..00000000000 --- a/plotly/validators/heatmap/colorbar/_nticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nticks', parent_name='heatmap.colorbar', **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_outlinecolor.py b/plotly/validators/heatmap/colorbar/_outlinecolor.py deleted file mode 100644 index fbc7b58e13f..00000000000 --- a/plotly/validators/heatmap/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='heatmap.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_outlinewidth.py b/plotly/validators/heatmap/colorbar/_outlinewidth.py deleted file mode 100644 index 7d6e9e514f4..00000000000 --- a/plotly/validators/heatmap/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='heatmap.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_separatethousands.py b/plotly/validators/heatmap/colorbar/_separatethousands.py deleted file mode 100644 index e5bf8594118..00000000000 --- a/plotly/validators/heatmap/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='heatmap.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_showexponent.py b/plotly/validators/heatmap/colorbar/_showexponent.py deleted file mode 100644 index 39b936a62e8..00000000000 --- a/plotly/validators/heatmap/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='heatmap.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_showticklabels.py b/plotly/validators/heatmap/colorbar/_showticklabels.py deleted file mode 100644 index 91ad7c090f9..00000000000 --- a/plotly/validators/heatmap/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='heatmap.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_showtickprefix.py b/plotly/validators/heatmap/colorbar/_showtickprefix.py deleted file mode 100644 index 38af89a09b3..00000000000 --- a/plotly/validators/heatmap/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='heatmap.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_showticksuffix.py b/plotly/validators/heatmap/colorbar/_showticksuffix.py deleted file mode 100644 index f7cfe17da61..00000000000 --- a/plotly/validators/heatmap/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='heatmap.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_thickness.py b/plotly/validators/heatmap/colorbar/_thickness.py deleted file mode 100644 index 788a7145bed..00000000000 --- a/plotly/validators/heatmap/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='heatmap.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_thicknessmode.py b/plotly/validators/heatmap/colorbar/_thicknessmode.py deleted file mode 100644 index 2f172bb6c73..00000000000 --- a/plotly/validators/heatmap/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='heatmap.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_tick0.py b/plotly/validators/heatmap/colorbar/_tick0.py deleted file mode 100644 index ac0777db56e..00000000000 --- a/plotly/validators/heatmap/colorbar/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='tick0', parent_name='heatmap.colorbar', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_tickangle.py b/plotly/validators/heatmap/colorbar/_tickangle.py deleted file mode 100644 index 10535fcfda4..00000000000 --- a/plotly/validators/heatmap/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='heatmap.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_tickcolor.py b/plotly/validators/heatmap/colorbar/_tickcolor.py deleted file mode 100644 index a1111547a44..00000000000 --- a/plotly/validators/heatmap/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='heatmap.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_tickfont.py b/plotly/validators/heatmap/colorbar/_tickfont.py deleted file mode 100644 index ca4f1ed8804..00000000000 --- a/plotly/validators/heatmap/colorbar/_tickfont.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='tickfont', parent_name='heatmap.colorbar', **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_tickformat.py b/plotly/validators/heatmap/colorbar/_tickformat.py deleted file mode 100644 index ccf1a3d90fe..00000000000 --- a/plotly/validators/heatmap/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='heatmap.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_tickformatstopdefaults.py b/plotly/validators/heatmap/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 559a3739b03..00000000000 --- a/plotly/validators/heatmap/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='heatmap.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_tickformatstops.py b/plotly/validators/heatmap/colorbar/_tickformatstops.py deleted file mode 100644 index ad802116300..00000000000 --- a/plotly/validators/heatmap/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='heatmap.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_ticklen.py b/plotly/validators/heatmap/colorbar/_ticklen.py deleted file mode 100644 index c44289286e1..00000000000 --- a/plotly/validators/heatmap/colorbar/_ticklen.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ticklen', parent_name='heatmap.colorbar', **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_tickmode.py b/plotly/validators/heatmap/colorbar/_tickmode.py deleted file mode 100644 index b38a47cdccd..00000000000 --- a/plotly/validators/heatmap/colorbar/_tickmode.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='tickmode', parent_name='heatmap.colorbar', **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_tickprefix.py b/plotly/validators/heatmap/colorbar/_tickprefix.py deleted file mode 100644 index bb3aff0d5ed..00000000000 --- a/plotly/validators/heatmap/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='heatmap.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_ticks.py b/plotly/validators/heatmap/colorbar/_ticks.py deleted file mode 100644 index 29166ce9e8a..00000000000 --- a/plotly/validators/heatmap/colorbar/_ticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ticks', parent_name='heatmap.colorbar', **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_ticksuffix.py b/plotly/validators/heatmap/colorbar/_ticksuffix.py deleted file mode 100644 index 09e63ad266c..00000000000 --- a/plotly/validators/heatmap/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='heatmap.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_ticktext.py b/plotly/validators/heatmap/colorbar/_ticktext.py deleted file mode 100644 index aa26a3c9520..00000000000 --- a/plotly/validators/heatmap/colorbar/_ticktext.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ticktext', parent_name='heatmap.colorbar', **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_ticktextsrc.py b/plotly/validators/heatmap/colorbar/_ticktextsrc.py deleted file mode 100644 index 3f6b7244aea..00000000000 --- a/plotly/validators/heatmap/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='heatmap.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_tickvals.py b/plotly/validators/heatmap/colorbar/_tickvals.py deleted file mode 100644 index e0e8b632717..00000000000 --- a/plotly/validators/heatmap/colorbar/_tickvals.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='tickvals', parent_name='heatmap.colorbar', **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_tickvalssrc.py b/plotly/validators/heatmap/colorbar/_tickvalssrc.py deleted file mode 100644 index d0605463af7..00000000000 --- a/plotly/validators/heatmap/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='heatmap.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_tickwidth.py b/plotly/validators/heatmap/colorbar/_tickwidth.py deleted file mode 100644 index d87341e2eff..00000000000 --- a/plotly/validators/heatmap/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='heatmap.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_title.py b/plotly/validators/heatmap/colorbar/_title.py deleted file mode 100644 index c17b5634aee..00000000000 --- a/plotly/validators/heatmap/colorbar/_title.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='heatmap.colorbar', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_x.py b/plotly/validators/heatmap/colorbar/_x.py deleted file mode 100644 index db819362de8..00000000000 --- a/plotly/validators/heatmap/colorbar/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='heatmap.colorbar', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_xanchor.py b/plotly/validators/heatmap/colorbar/_xanchor.py deleted file mode 100644 index 52ea765f209..00000000000 --- a/plotly/validators/heatmap/colorbar/_xanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xanchor', parent_name='heatmap.colorbar', **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_xpad.py b/plotly/validators/heatmap/colorbar/_xpad.py deleted file mode 100644 index 89b09b74e41..00000000000 --- a/plotly/validators/heatmap/colorbar/_xpad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='xpad', parent_name='heatmap.colorbar', **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_y.py b/plotly/validators/heatmap/colorbar/_y.py deleted file mode 100644 index 3e31dc57aba..00000000000 --- a/plotly/validators/heatmap/colorbar/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='heatmap.colorbar', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_yanchor.py b/plotly/validators/heatmap/colorbar/_yanchor.py deleted file mode 100644 index c617b563ec8..00000000000 --- a/plotly/validators/heatmap/colorbar/_yanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='yanchor', parent_name='heatmap.colorbar', **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/_ypad.py b/plotly/validators/heatmap/colorbar/_ypad.py deleted file mode 100644 index 6ec5c1e0b2b..00000000000 --- a/plotly/validators/heatmap/colorbar/_ypad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ypad', parent_name='heatmap.colorbar', **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/tickfont/__init__.py b/plotly/validators/heatmap/colorbar/tickfont/__init__.py index 199d72e71c6..b1627131f38 100644 --- a/plotly/validators/heatmap/colorbar/tickfont/__init__.py +++ b/plotly/validators/heatmap/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='heatmap.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='heatmap.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='heatmap.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/heatmap/colorbar/tickfont/_color.py b/plotly/validators/heatmap/colorbar/tickfont/_color.py deleted file mode 100644 index ad5606f817b..00000000000 --- a/plotly/validators/heatmap/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='heatmap.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/tickfont/_family.py b/plotly/validators/heatmap/colorbar/tickfont/_family.py deleted file mode 100644 index e7d3b949360..00000000000 --- a/plotly/validators/heatmap/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='heatmap.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/tickfont/_size.py b/plotly/validators/heatmap/colorbar/tickfont/_size.py deleted file mode 100644 index e5ef918aa5a..00000000000 --- a/plotly/validators/heatmap/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='heatmap.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/tickformatstop/__init__.py b/plotly/validators/heatmap/colorbar/tickformatstop/__init__.py index 3f6c06cac47..dc8c9872455 100644 --- a/plotly/validators/heatmap/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/heatmap/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='heatmap.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='heatmap.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='heatmap.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='heatmap.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='heatmap.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/heatmap/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/heatmap/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index dc8258e1526..00000000000 --- a/plotly/validators/heatmap/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='heatmap.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/tickformatstop/_enabled.py b/plotly/validators/heatmap/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index 1fbe95feca7..00000000000 --- a/plotly/validators/heatmap/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='heatmap.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/tickformatstop/_name.py b/plotly/validators/heatmap/colorbar/tickformatstop/_name.py deleted file mode 100644 index 3992da2e5a3..00000000000 --- a/plotly/validators/heatmap/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='heatmap.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/heatmap/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index ab870a08206..00000000000 --- a/plotly/validators/heatmap/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='heatmap.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/tickformatstop/_value.py b/plotly/validators/heatmap/colorbar/tickformatstop/_value.py deleted file mode 100644 index e63caa08913..00000000000 --- a/plotly/validators/heatmap/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='heatmap.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/title/__init__.py b/plotly/validators/heatmap/colorbar/title/__init__.py index 33c9c145bb8..d19ac9a9335 100644 --- a/plotly/validators/heatmap/colorbar/title/__init__.py +++ b/plotly/validators/heatmap/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='heatmap.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='heatmap.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='heatmap.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/heatmap/colorbar/title/_font.py b/plotly/validators/heatmap/colorbar/title/_font.py deleted file mode 100644 index 464cab86c7d..00000000000 --- a/plotly/validators/heatmap/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='heatmap.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/title/_side.py b/plotly/validators/heatmap/colorbar/title/_side.py deleted file mode 100644 index 26c9f84f713..00000000000 --- a/plotly/validators/heatmap/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='heatmap.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/title/_text.py b/plotly/validators/heatmap/colorbar/title/_text.py deleted file mode 100644 index 6bdb4b8678e..00000000000 --- a/plotly/validators/heatmap/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='heatmap.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/title/font/__init__.py b/plotly/validators/heatmap/colorbar/title/font/__init__.py index 199d72e71c6..2ff1eea8c65 100644 --- a/plotly/validators/heatmap/colorbar/title/font/__init__.py +++ b/plotly/validators/heatmap/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='heatmap.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='heatmap.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='heatmap.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/heatmap/colorbar/title/font/_color.py b/plotly/validators/heatmap/colorbar/title/font/_color.py deleted file mode 100644 index f4ef02f56c9..00000000000 --- a/plotly/validators/heatmap/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='heatmap.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/title/font/_family.py b/plotly/validators/heatmap/colorbar/title/font/_family.py deleted file mode 100644 index 45bbaf88a62..00000000000 --- a/plotly/validators/heatmap/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='heatmap.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/heatmap/colorbar/title/font/_size.py b/plotly/validators/heatmap/colorbar/title/font/_size.py deleted file mode 100644 index d861108ba69..00000000000 --- a/plotly/validators/heatmap/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='heatmap.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/hoverlabel/__init__.py b/plotly/validators/heatmap/hoverlabel/__init__.py index 856f769ba33..b79b633df8a 100644 --- a/plotly/validators/heatmap/hoverlabel/__init__.py +++ b/plotly/validators/heatmap/hoverlabel/__init__.py @@ -1,7 +1,173 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='heatmap.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='heatmap.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='heatmap.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='heatmap.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='heatmap.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='heatmap.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='heatmap.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/heatmap/hoverlabel/_bgcolor.py b/plotly/validators/heatmap/hoverlabel/_bgcolor.py deleted file mode 100644 index e10d2cdfcc3..00000000000 --- a/plotly/validators/heatmap/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='heatmap.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/hoverlabel/_bgcolorsrc.py b/plotly/validators/heatmap/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 5f44c6e9279..00000000000 --- a/plotly/validators/heatmap/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='heatmap.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/hoverlabel/_bordercolor.py b/plotly/validators/heatmap/hoverlabel/_bordercolor.py deleted file mode 100644 index f200d60d43e..00000000000 --- a/plotly/validators/heatmap/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='heatmap.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/hoverlabel/_bordercolorsrc.py b/plotly/validators/heatmap/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 02cf30845b2..00000000000 --- a/plotly/validators/heatmap/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='heatmap.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/hoverlabel/_font.py b/plotly/validators/heatmap/hoverlabel/_font.py deleted file mode 100644 index 07c1414f571..00000000000 --- a/plotly/validators/heatmap/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='heatmap.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/heatmap/hoverlabel/_namelength.py b/plotly/validators/heatmap/hoverlabel/_namelength.py deleted file mode 100644 index 2daba3115ba..00000000000 --- a/plotly/validators/heatmap/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='heatmap.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/hoverlabel/_namelengthsrc.py b/plotly/validators/heatmap/hoverlabel/_namelengthsrc.py deleted file mode 100644 index fc6bbcadb63..00000000000 --- a/plotly/validators/heatmap/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='heatmap.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/hoverlabel/font/__init__.py b/plotly/validators/heatmap/hoverlabel/font/__init__.py index 1d2c591d1e5..7fefac0027a 100644 --- a/plotly/validators/heatmap/hoverlabel/font/__init__.py +++ b/plotly/validators/heatmap/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='heatmap.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='heatmap.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='heatmap.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='heatmap.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='heatmap.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='heatmap.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/heatmap/hoverlabel/font/_color.py b/plotly/validators/heatmap/hoverlabel/font/_color.py deleted file mode 100644 index 208cb013fe0..00000000000 --- a/plotly/validators/heatmap/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='heatmap.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/hoverlabel/font/_colorsrc.py b/plotly/validators/heatmap/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 46b33dae4b2..00000000000 --- a/plotly/validators/heatmap/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='heatmap.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/hoverlabel/font/_family.py b/plotly/validators/heatmap/hoverlabel/font/_family.py deleted file mode 100644 index bd5904530a1..00000000000 --- a/plotly/validators/heatmap/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='heatmap.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/heatmap/hoverlabel/font/_familysrc.py b/plotly/validators/heatmap/hoverlabel/font/_familysrc.py deleted file mode 100644 index 72073bba6a8..00000000000 --- a/plotly/validators/heatmap/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='heatmap.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/hoverlabel/font/_size.py b/plotly/validators/heatmap/hoverlabel/font/_size.py deleted file mode 100644 index 42e3dd66095..00000000000 --- a/plotly/validators/heatmap/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='heatmap.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmap/hoverlabel/font/_sizesrc.py b/plotly/validators/heatmap/hoverlabel/font/_sizesrc.py deleted file mode 100644 index ea86e86024b..00000000000 --- a/plotly/validators/heatmap/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='heatmap.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/stream/__init__.py b/plotly/validators/heatmap/stream/__init__.py index 2f4f2047594..a3584b5808a 100644 --- a/plotly/validators/heatmap/stream/__init__.py +++ b/plotly/validators/heatmap/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='heatmap.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='heatmap.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/heatmap/stream/_maxpoints.py b/plotly/validators/heatmap/stream/_maxpoints.py deleted file mode 100644 index 70b272b44f4..00000000000 --- a/plotly/validators/heatmap/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='heatmap.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmap/stream/_token.py b/plotly/validators/heatmap/stream/_token.py deleted file mode 100644 index e2d0be31b93..00000000000 --- a/plotly/validators/heatmap/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='heatmap.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/__init__.py b/plotly/validators/heatmapgl/__init__.py index 6a09e605088..820f191622b 100644 --- a/plotly/validators/heatmapgl/__init__.py +++ b/plotly/validators/heatmapgl/__init__.py @@ -1,42 +1,955 @@ -from ._zsrc import ZsrcValidator -from ._zmin import ZminValidator -from ._zmid import ZmidValidator -from ._zmax import ZmaxValidator -from ._zauto import ZautoValidator -from ._z import ZValidator -from ._ytype import YtypeValidator -from ._ysrc import YsrcValidator -from ._yaxis import YAxisValidator -from ._y0 import Y0Validator -from ._y import YValidator -from ._xtype import XtypeValidator -from ._xsrc import XsrcValidator -from ._xaxis import XAxisValidator -from ._x0 import X0Validator -from ._x import XValidator -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._transpose import TransposeValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._showscale import ShowscaleValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._reversescale import ReversescaleValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._dy import DyValidator -from ._dx import DxValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='zsrc', parent_name='heatmapgl', **kwargs): + super(ZsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='zmin', parent_name='heatmapgl', **kwargs): + super(ZminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'zauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='zmid', parent_name='heatmapgl', **kwargs): + super(ZmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='zmax', parent_name='heatmapgl', **kwargs): + super(ZmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'zauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='zauto', parent_name='heatmapgl', **kwargs): + super(ZautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='z', parent_name='heatmapgl', **kwargs): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YtypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='ytype', parent_name='heatmapgl', **kwargs): + super(YtypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['array', 'scaled']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='heatmapgl', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='yaxis', parent_name='heatmapgl', **kwargs): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Y0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='y0', parent_name='heatmapgl', **kwargs): + super(Y0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'ytype': 'scaled'}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='heatmapgl', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'ytype': 'array'}), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XtypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='xtype', parent_name='heatmapgl', **kwargs): + super(XtypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['array', 'scaled']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='heatmapgl', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='xaxis', parent_name='heatmapgl', **kwargs): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class X0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='x0', parent_name='heatmapgl', **kwargs): + super(X0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'xtype': 'scaled'}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='heatmapgl', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'xtype': 'array'}), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='heatmapgl', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='heatmapgl', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='heatmapgl', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TransposeValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='transpose', parent_name='heatmapgl', **kwargs + ): + super(TransposeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textsrc', parent_name='heatmapgl', **kwargs + ): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='text', parent_name='heatmapgl', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='heatmapgl', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='heatmapgl', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='heatmapgl', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='heatmapgl', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='reversescale', parent_name='heatmapgl', **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='heatmapgl', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='heatmapgl', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='heatmapgl', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='heatmapgl', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='heatmapgl', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='heatmapgl', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='heatmapgl', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='heatmapgl', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DyValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='dy', parent_name='heatmapgl', **kwargs): + super(DyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'ytype': 'scaled'}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='dx', parent_name='heatmapgl', **kwargs): + super(DxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'xtype': 'scaled'}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='heatmapgl', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='heatmapgl', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='heatmapgl', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='heatmapgl', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.heatmapgl.colorbar.Tickformat + stop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.heatmapgl.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of heatmapgl.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.heatmapgl.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + heatmapgl.colorbar.title.font instead. Sets + this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + heatmapgl.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autocolorscale', parent_name='heatmapgl', **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/heatmapgl/_autocolorscale.py b/plotly/validators/heatmapgl/_autocolorscale.py deleted file mode 100644 index 0cf4cd379c9..00000000000 --- a/plotly/validators/heatmapgl/_autocolorscale.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autocolorscale', parent_name='heatmapgl', **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_colorbar.py b/plotly/validators/heatmapgl/_colorbar.py deleted file mode 100644 index 64382602740..00000000000 --- a/plotly/validators/heatmapgl/_colorbar.py +++ /dev/null @@ -1,227 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='heatmapgl', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.heatmapgl.colorbar.Tickformat - stop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.heatmapgl.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of heatmapgl.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.heatmapgl.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - heatmapgl.colorbar.title.font instead. Sets - this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - heatmapgl.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_colorscale.py b/plotly/validators/heatmapgl/_colorscale.py deleted file mode 100644 index 8bc09e7347f..00000000000 --- a/plotly/validators/heatmapgl/_colorscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='heatmapgl', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_customdata.py b/plotly/validators/heatmapgl/_customdata.py deleted file mode 100644 index 8af3787b8b9..00000000000 --- a/plotly/validators/heatmapgl/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='heatmapgl', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_customdatasrc.py b/plotly/validators/heatmapgl/_customdatasrc.py deleted file mode 100644 index 4152ba80d12..00000000000 --- a/plotly/validators/heatmapgl/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='heatmapgl', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_dx.py b/plotly/validators/heatmapgl/_dx.py deleted file mode 100644 index 8166ca5f751..00000000000 --- a/plotly/validators/heatmapgl/_dx.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class DxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='dx', parent_name='heatmapgl', **kwargs): - super(DxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'xtype': 'scaled'}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_dy.py b/plotly/validators/heatmapgl/_dy.py deleted file mode 100644 index 7b2b5da1944..00000000000 --- a/plotly/validators/heatmapgl/_dy.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class DyValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='dy', parent_name='heatmapgl', **kwargs): - super(DyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'ytype': 'scaled'}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_hoverinfo.py b/plotly/validators/heatmapgl/_hoverinfo.py deleted file mode 100644 index 1ec4e5652c6..00000000000 --- a/plotly/validators/heatmapgl/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='heatmapgl', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_hoverinfosrc.py b/plotly/validators/heatmapgl/_hoverinfosrc.py deleted file mode 100644 index fe70916b2d0..00000000000 --- a/plotly/validators/heatmapgl/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='heatmapgl', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_hoverlabel.py b/plotly/validators/heatmapgl/_hoverlabel.py deleted file mode 100644 index 34d4af469e9..00000000000 --- a/plotly/validators/heatmapgl/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='heatmapgl', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_ids.py b/plotly/validators/heatmapgl/_ids.py deleted file mode 100644 index b3608711f71..00000000000 --- a/plotly/validators/heatmapgl/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='heatmapgl', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_idssrc.py b/plotly/validators/heatmapgl/_idssrc.py deleted file mode 100644 index 25dfbb147af..00000000000 --- a/plotly/validators/heatmapgl/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='heatmapgl', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_legendgroup.py b/plotly/validators/heatmapgl/_legendgroup.py deleted file mode 100644 index 245d382447e..00000000000 --- a/plotly/validators/heatmapgl/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='heatmapgl', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_name.py b/plotly/validators/heatmapgl/_name.py deleted file mode 100644 index 4c3cb6af4c0..00000000000 --- a/plotly/validators/heatmapgl/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='heatmapgl', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_opacity.py b/plotly/validators/heatmapgl/_opacity.py deleted file mode 100644 index ec57cd8426a..00000000000 --- a/plotly/validators/heatmapgl/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='heatmapgl', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_reversescale.py b/plotly/validators/heatmapgl/_reversescale.py deleted file mode 100644 index 448a5900840..00000000000 --- a/plotly/validators/heatmapgl/_reversescale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='reversescale', parent_name='heatmapgl', **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_selectedpoints.py b/plotly/validators/heatmapgl/_selectedpoints.py deleted file mode 100644 index 5be6870cda7..00000000000 --- a/plotly/validators/heatmapgl/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='heatmapgl', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_showlegend.py b/plotly/validators/heatmapgl/_showlegend.py deleted file mode 100644 index 86b8eb21798..00000000000 --- a/plotly/validators/heatmapgl/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='heatmapgl', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_showscale.py b/plotly/validators/heatmapgl/_showscale.py deleted file mode 100644 index e08bde20445..00000000000 --- a/plotly/validators/heatmapgl/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='heatmapgl', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_stream.py b/plotly/validators/heatmapgl/_stream.py deleted file mode 100644 index 84e675ff73c..00000000000 --- a/plotly/validators/heatmapgl/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='heatmapgl', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_text.py b/plotly/validators/heatmapgl/_text.py deleted file mode 100644 index fcae95d4a46..00000000000 --- a/plotly/validators/heatmapgl/_text.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='text', parent_name='heatmapgl', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_textsrc.py b/plotly/validators/heatmapgl/_textsrc.py deleted file mode 100644 index 40868a648c3..00000000000 --- a/plotly/validators/heatmapgl/_textsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textsrc', parent_name='heatmapgl', **kwargs - ): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_transpose.py b/plotly/validators/heatmapgl/_transpose.py deleted file mode 100644 index ae5ca953fc4..00000000000 --- a/plotly/validators/heatmapgl/_transpose.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TransposeValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='transpose', parent_name='heatmapgl', **kwargs - ): - super(TransposeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_uid.py b/plotly/validators/heatmapgl/_uid.py deleted file mode 100644 index a3947103ea0..00000000000 --- a/plotly/validators/heatmapgl/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='heatmapgl', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_uirevision.py b/plotly/validators/heatmapgl/_uirevision.py deleted file mode 100644 index c66eced5d3c..00000000000 --- a/plotly/validators/heatmapgl/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='heatmapgl', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_visible.py b/plotly/validators/heatmapgl/_visible.py deleted file mode 100644 index 8fb63b2878d..00000000000 --- a/plotly/validators/heatmapgl/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='heatmapgl', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_x.py b/plotly/validators/heatmapgl/_x.py deleted file mode 100644 index 8af581bbe8b..00000000000 --- a/plotly/validators/heatmapgl/_x.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='heatmapgl', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'xtype': 'array'}), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_x0.py b/plotly/validators/heatmapgl/_x0.py deleted file mode 100644 index 8d4a82e5eef..00000000000 --- a/plotly/validators/heatmapgl/_x0.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class X0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='x0', parent_name='heatmapgl', **kwargs): - super(X0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'xtype': 'scaled'}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_xaxis.py b/plotly/validators/heatmapgl/_xaxis.py deleted file mode 100644 index 244699c4363..00000000000 --- a/plotly/validators/heatmapgl/_xaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='xaxis', parent_name='heatmapgl', **kwargs): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_xsrc.py b/plotly/validators/heatmapgl/_xsrc.py deleted file mode 100644 index dff524e827d..00000000000 --- a/plotly/validators/heatmapgl/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='heatmapgl', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_xtype.py b/plotly/validators/heatmapgl/_xtype.py deleted file mode 100644 index 1b7f6c928fd..00000000000 --- a/plotly/validators/heatmapgl/_xtype.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XtypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='xtype', parent_name='heatmapgl', **kwargs): - super(XtypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['array', 'scaled']), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_y.py b/plotly/validators/heatmapgl/_y.py deleted file mode 100644 index 8aef2faeb01..00000000000 --- a/plotly/validators/heatmapgl/_y.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='heatmapgl', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'ytype': 'array'}), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_y0.py b/plotly/validators/heatmapgl/_y0.py deleted file mode 100644 index 1e4df07e8cd..00000000000 --- a/plotly/validators/heatmapgl/_y0.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class Y0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='y0', parent_name='heatmapgl', **kwargs): - super(Y0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'ytype': 'scaled'}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_yaxis.py b/plotly/validators/heatmapgl/_yaxis.py deleted file mode 100644 index 9755e392f38..00000000000 --- a/plotly/validators/heatmapgl/_yaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='yaxis', parent_name='heatmapgl', **kwargs): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_ysrc.py b/plotly/validators/heatmapgl/_ysrc.py deleted file mode 100644 index 9cb7ab3f804..00000000000 --- a/plotly/validators/heatmapgl/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='heatmapgl', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_ytype.py b/plotly/validators/heatmapgl/_ytype.py deleted file mode 100644 index c5606c3c78f..00000000000 --- a/plotly/validators/heatmapgl/_ytype.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YtypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='ytype', parent_name='heatmapgl', **kwargs): - super(YtypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['array', 'scaled']), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_z.py b/plotly/validators/heatmapgl/_z.py deleted file mode 100644 index 05aecbabf3d..00000000000 --- a/plotly/validators/heatmapgl/_z.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='z', parent_name='heatmapgl', **kwargs): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_zauto.py b/plotly/validators/heatmapgl/_zauto.py deleted file mode 100644 index 035e30d72f3..00000000000 --- a/plotly/validators/heatmapgl/_zauto.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='zauto', parent_name='heatmapgl', **kwargs): - super(ZautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_zmax.py b/plotly/validators/heatmapgl/_zmax.py deleted file mode 100644 index 52c2039ad7b..00000000000 --- a/plotly/validators/heatmapgl/_zmax.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='zmax', parent_name='heatmapgl', **kwargs): - super(ZmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'zauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_zmid.py b/plotly/validators/heatmapgl/_zmid.py deleted file mode 100644 index 526a80608b7..00000000000 --- a/plotly/validators/heatmapgl/_zmid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='zmid', parent_name='heatmapgl', **kwargs): - super(ZmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_zmin.py b/plotly/validators/heatmapgl/_zmin.py deleted file mode 100644 index ae9574a4272..00000000000 --- a/plotly/validators/heatmapgl/_zmin.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='zmin', parent_name='heatmapgl', **kwargs): - super(ZminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'zauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/_zsrc.py b/plotly/validators/heatmapgl/_zsrc.py deleted file mode 100644 index be835f4d920..00000000000 --- a/plotly/validators/heatmapgl/_zsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='zsrc', parent_name='heatmapgl', **kwargs): - super(ZsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/__init__.py b/plotly/validators/heatmapgl/colorbar/__init__.py index 3dab31f7e02..d2f52a243a0 100644 --- a/plotly/validators/heatmapgl/colorbar/__init__.py +++ b/plotly/validators/heatmapgl/colorbar/__init__.py @@ -1,41 +1,906 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ypad', parent_name='heatmapgl.colorbar', **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='heatmapgl.colorbar', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='xpad', parent_name='heatmapgl.colorbar', **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='heatmapgl.colorbar', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='heatmapgl.colorbar', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ticks', parent_name='heatmapgl.colorbar', **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='tick0', parent_name='heatmapgl.colorbar', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nticks', parent_name='heatmapgl.colorbar', **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='len', parent_name='heatmapgl.colorbar', **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='dtick', parent_name='heatmapgl.colorbar', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='heatmapgl.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/heatmapgl/colorbar/_bgcolor.py b/plotly/validators/heatmapgl/colorbar/_bgcolor.py deleted file mode 100644 index 3a3ef5033b8..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_bordercolor.py b/plotly/validators/heatmapgl/colorbar/_bordercolor.py deleted file mode 100644 index 1ce127a57ac..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_borderwidth.py b/plotly/validators/heatmapgl/colorbar/_borderwidth.py deleted file mode 100644 index d5bfb42ebfc..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_dtick.py b/plotly/validators/heatmapgl/colorbar/_dtick.py deleted file mode 100644 index a516ff78652..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='dtick', parent_name='heatmapgl.colorbar', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_exponentformat.py b/plotly/validators/heatmapgl/colorbar/_exponentformat.py deleted file mode 100644 index 8c937f60080..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_len.py b/plotly/validators/heatmapgl/colorbar/_len.py deleted file mode 100644 index 6b089e7e36b..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_len.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='len', parent_name='heatmapgl.colorbar', **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_lenmode.py b/plotly/validators/heatmapgl/colorbar/_lenmode.py deleted file mode 100644 index 364684b287b..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_nticks.py b/plotly/validators/heatmapgl/colorbar/_nticks.py deleted file mode 100644 index fd994673f1c..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_nticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nticks', parent_name='heatmapgl.colorbar', **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_outlinecolor.py b/plotly/validators/heatmapgl/colorbar/_outlinecolor.py deleted file mode 100644 index fee7b64ccc1..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_outlinewidth.py b/plotly/validators/heatmapgl/colorbar/_outlinewidth.py deleted file mode 100644 index a3ea6641b1d..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_separatethousands.py b/plotly/validators/heatmapgl/colorbar/_separatethousands.py deleted file mode 100644 index abb39d5e165..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_showexponent.py b/plotly/validators/heatmapgl/colorbar/_showexponent.py deleted file mode 100644 index a40f3a25650..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_showticklabels.py b/plotly/validators/heatmapgl/colorbar/_showticklabels.py deleted file mode 100644 index 281a7340e92..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_showtickprefix.py b/plotly/validators/heatmapgl/colorbar/_showtickprefix.py deleted file mode 100644 index 84f283eb60c..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_showticksuffix.py b/plotly/validators/heatmapgl/colorbar/_showticksuffix.py deleted file mode 100644 index 11dfa933ca3..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_thickness.py b/plotly/validators/heatmapgl/colorbar/_thickness.py deleted file mode 100644 index 54b88106dd2..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_thicknessmode.py b/plotly/validators/heatmapgl/colorbar/_thicknessmode.py deleted file mode 100644 index 51812c1e38c..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_tick0.py b/plotly/validators/heatmapgl/colorbar/_tick0.py deleted file mode 100644 index b01623ccd89..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='tick0', parent_name='heatmapgl.colorbar', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_tickangle.py b/plotly/validators/heatmapgl/colorbar/_tickangle.py deleted file mode 100644 index 8df85dc3455..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_tickcolor.py b/plotly/validators/heatmapgl/colorbar/_tickcolor.py deleted file mode 100644 index cb182488d44..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_tickfont.py b/plotly/validators/heatmapgl/colorbar/_tickfont.py deleted file mode 100644 index 6b9086b6b4c..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_tickformat.py b/plotly/validators/heatmapgl/colorbar/_tickformat.py deleted file mode 100644 index 4c0fe855bf8..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_tickformatstopdefaults.py b/plotly/validators/heatmapgl/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 026bfd1ed12..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_tickformatstops.py b/plotly/validators/heatmapgl/colorbar/_tickformatstops.py deleted file mode 100644 index 99fe709e833..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_ticklen.py b/plotly/validators/heatmapgl/colorbar/_ticklen.py deleted file mode 100644 index ca7050ca930..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_tickmode.py b/plotly/validators/heatmapgl/colorbar/_tickmode.py deleted file mode 100644 index b7e47df781e..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_tickprefix.py b/plotly/validators/heatmapgl/colorbar/_tickprefix.py deleted file mode 100644 index ea581c907d5..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_ticks.py b/plotly/validators/heatmapgl/colorbar/_ticks.py deleted file mode 100644 index 72a396e2f06..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_ticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ticks', parent_name='heatmapgl.colorbar', **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_ticksuffix.py b/plotly/validators/heatmapgl/colorbar/_ticksuffix.py deleted file mode 100644 index a86d255500e..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_ticktext.py b/plotly/validators/heatmapgl/colorbar/_ticktext.py deleted file mode 100644 index 8422d22ac28..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_ticktextsrc.py b/plotly/validators/heatmapgl/colorbar/_ticktextsrc.py deleted file mode 100644 index c8f1558071d..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_tickvals.py b/plotly/validators/heatmapgl/colorbar/_tickvals.py deleted file mode 100644 index b8fd6359de3..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_tickvalssrc.py b/plotly/validators/heatmapgl/colorbar/_tickvalssrc.py deleted file mode 100644 index 38b0070481a..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_tickwidth.py b/plotly/validators/heatmapgl/colorbar/_tickwidth.py deleted file mode 100644 index 39fb9c2886b..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_title.py b/plotly/validators/heatmapgl/colorbar/_title.py deleted file mode 100644 index b103c09d533..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_title.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='heatmapgl.colorbar', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_x.py b/plotly/validators/heatmapgl/colorbar/_x.py deleted file mode 100644 index 22e043300a5..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='heatmapgl.colorbar', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_xanchor.py b/plotly/validators/heatmapgl/colorbar/_xanchor.py deleted file mode 100644 index 93412a1d4cd..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_xpad.py b/plotly/validators/heatmapgl/colorbar/_xpad.py deleted file mode 100644 index b29dac35810..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_xpad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='xpad', parent_name='heatmapgl.colorbar', **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_y.py b/plotly/validators/heatmapgl/colorbar/_y.py deleted file mode 100644 index 66e6197ac0b..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='heatmapgl.colorbar', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_yanchor.py b/plotly/validators/heatmapgl/colorbar/_yanchor.py deleted file mode 100644 index afef9f9e4b5..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='heatmapgl.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/_ypad.py b/plotly/validators/heatmapgl/colorbar/_ypad.py deleted file mode 100644 index dd2821cad6b..00000000000 --- a/plotly/validators/heatmapgl/colorbar/_ypad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ypad', parent_name='heatmapgl.colorbar', **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/tickfont/__init__.py b/plotly/validators/heatmapgl/colorbar/tickfont/__init__.py index 199d72e71c6..fbffc11f68b 100644 --- a/plotly/validators/heatmapgl/colorbar/tickfont/__init__.py +++ b/plotly/validators/heatmapgl/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='heatmapgl.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='heatmapgl.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='heatmapgl.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/heatmapgl/colorbar/tickfont/_color.py b/plotly/validators/heatmapgl/colorbar/tickfont/_color.py deleted file mode 100644 index f1c3cec4b91..00000000000 --- a/plotly/validators/heatmapgl/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='heatmapgl.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/tickfont/_family.py b/plotly/validators/heatmapgl/colorbar/tickfont/_family.py deleted file mode 100644 index b78bc12d610..00000000000 --- a/plotly/validators/heatmapgl/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='heatmapgl.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/tickfont/_size.py b/plotly/validators/heatmapgl/colorbar/tickfont/_size.py deleted file mode 100644 index cc403f0762b..00000000000 --- a/plotly/validators/heatmapgl/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='heatmapgl.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/tickformatstop/__init__.py b/plotly/validators/heatmapgl/colorbar/tickformatstop/__init__.py index 3f6c06cac47..13ee1df3107 100644 --- a/plotly/validators/heatmapgl/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/heatmapgl/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='heatmapgl.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='heatmapgl.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='heatmapgl.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='heatmapgl.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='heatmapgl.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'calc' + }, { + 'valType': 'any', + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/heatmapgl/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/heatmapgl/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index b96801285f3..00000000000 --- a/plotly/validators/heatmapgl/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='heatmapgl.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'calc' - }, { - 'valType': 'any', - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/tickformatstop/_enabled.py b/plotly/validators/heatmapgl/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index ba13a0737ed..00000000000 --- a/plotly/validators/heatmapgl/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='heatmapgl.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/tickformatstop/_name.py b/plotly/validators/heatmapgl/colorbar/tickformatstop/_name.py deleted file mode 100644 index 42173a0ae98..00000000000 --- a/plotly/validators/heatmapgl/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='heatmapgl.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/heatmapgl/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 165b57dd7f7..00000000000 --- a/plotly/validators/heatmapgl/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='heatmapgl.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/tickformatstop/_value.py b/plotly/validators/heatmapgl/colorbar/tickformatstop/_value.py deleted file mode 100644 index 7ffda4b9e2d..00000000000 --- a/plotly/validators/heatmapgl/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='heatmapgl.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/title/__init__.py b/plotly/validators/heatmapgl/colorbar/title/__init__.py index 33c9c145bb8..4dd5b43a4ad 100644 --- a/plotly/validators/heatmapgl/colorbar/title/__init__.py +++ b/plotly/validators/heatmapgl/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='heatmapgl.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='heatmapgl.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='heatmapgl.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/heatmapgl/colorbar/title/_font.py b/plotly/validators/heatmapgl/colorbar/title/_font.py deleted file mode 100644 index ff56574d303..00000000000 --- a/plotly/validators/heatmapgl/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='heatmapgl.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/title/_side.py b/plotly/validators/heatmapgl/colorbar/title/_side.py deleted file mode 100644 index a0083fdf9a9..00000000000 --- a/plotly/validators/heatmapgl/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='heatmapgl.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/title/_text.py b/plotly/validators/heatmapgl/colorbar/title/_text.py deleted file mode 100644 index 37ec205613f..00000000000 --- a/plotly/validators/heatmapgl/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='heatmapgl.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/title/font/__init__.py b/plotly/validators/heatmapgl/colorbar/title/font/__init__.py index 199d72e71c6..a144b99cd7a 100644 --- a/plotly/validators/heatmapgl/colorbar/title/font/__init__.py +++ b/plotly/validators/heatmapgl/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='heatmapgl.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='heatmapgl.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='heatmapgl.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/heatmapgl/colorbar/title/font/_color.py b/plotly/validators/heatmapgl/colorbar/title/font/_color.py deleted file mode 100644 index 0c30e30da4d..00000000000 --- a/plotly/validators/heatmapgl/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='heatmapgl.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/title/font/_family.py b/plotly/validators/heatmapgl/colorbar/title/font/_family.py deleted file mode 100644 index 2c9259dac9f..00000000000 --- a/plotly/validators/heatmapgl/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='heatmapgl.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/colorbar/title/font/_size.py b/plotly/validators/heatmapgl/colorbar/title/font/_size.py deleted file mode 100644 index 34b943b9e19..00000000000 --- a/plotly/validators/heatmapgl/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='heatmapgl.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/hoverlabel/__init__.py b/plotly/validators/heatmapgl/hoverlabel/__init__.py index 856f769ba33..c8d2e229650 100644 --- a/plotly/validators/heatmapgl/hoverlabel/__init__.py +++ b/plotly/validators/heatmapgl/hoverlabel/__init__.py @@ -1,7 +1,173 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='heatmapgl.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='heatmapgl.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='heatmapgl.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='heatmapgl.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='heatmapgl.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='heatmapgl.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='heatmapgl.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/heatmapgl/hoverlabel/_bgcolor.py b/plotly/validators/heatmapgl/hoverlabel/_bgcolor.py deleted file mode 100644 index 9b28eeac8e8..00000000000 --- a/plotly/validators/heatmapgl/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='heatmapgl.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/hoverlabel/_bgcolorsrc.py b/plotly/validators/heatmapgl/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index da32cd42dd9..00000000000 --- a/plotly/validators/heatmapgl/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='heatmapgl.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/hoverlabel/_bordercolor.py b/plotly/validators/heatmapgl/hoverlabel/_bordercolor.py deleted file mode 100644 index fbe2971e3f7..00000000000 --- a/plotly/validators/heatmapgl/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='heatmapgl.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/hoverlabel/_bordercolorsrc.py b/plotly/validators/heatmapgl/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 5dfaccc7f32..00000000000 --- a/plotly/validators/heatmapgl/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='heatmapgl.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/hoverlabel/_font.py b/plotly/validators/heatmapgl/hoverlabel/_font.py deleted file mode 100644 index f7e7f598ebf..00000000000 --- a/plotly/validators/heatmapgl/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='heatmapgl.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/hoverlabel/_namelength.py b/plotly/validators/heatmapgl/hoverlabel/_namelength.py deleted file mode 100644 index a45798e4096..00000000000 --- a/plotly/validators/heatmapgl/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='heatmapgl.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/hoverlabel/_namelengthsrc.py b/plotly/validators/heatmapgl/hoverlabel/_namelengthsrc.py deleted file mode 100644 index bd6966c7608..00000000000 --- a/plotly/validators/heatmapgl/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='heatmapgl.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/hoverlabel/font/__init__.py b/plotly/validators/heatmapgl/hoverlabel/font/__init__.py index 1d2c591d1e5..0fde55d98b2 100644 --- a/plotly/validators/heatmapgl/hoverlabel/font/__init__.py +++ b/plotly/validators/heatmapgl/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='heatmapgl.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='heatmapgl.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='heatmapgl.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='heatmapgl.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='heatmapgl.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='heatmapgl.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/heatmapgl/hoverlabel/font/_color.py b/plotly/validators/heatmapgl/hoverlabel/font/_color.py deleted file mode 100644 index 06b81847531..00000000000 --- a/plotly/validators/heatmapgl/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='heatmapgl.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/hoverlabel/font/_colorsrc.py b/plotly/validators/heatmapgl/hoverlabel/font/_colorsrc.py deleted file mode 100644 index f55bda367f9..00000000000 --- a/plotly/validators/heatmapgl/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='heatmapgl.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/hoverlabel/font/_family.py b/plotly/validators/heatmapgl/hoverlabel/font/_family.py deleted file mode 100644 index 0527bfd5753..00000000000 --- a/plotly/validators/heatmapgl/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='heatmapgl.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/hoverlabel/font/_familysrc.py b/plotly/validators/heatmapgl/hoverlabel/font/_familysrc.py deleted file mode 100644 index f98e6d65152..00000000000 --- a/plotly/validators/heatmapgl/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='heatmapgl.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/hoverlabel/font/_size.py b/plotly/validators/heatmapgl/hoverlabel/font/_size.py deleted file mode 100644 index c964dd3f6d9..00000000000 --- a/plotly/validators/heatmapgl/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='heatmapgl.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/hoverlabel/font/_sizesrc.py b/plotly/validators/heatmapgl/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 2b44d53b241..00000000000 --- a/plotly/validators/heatmapgl/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='heatmapgl.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/stream/__init__.py b/plotly/validators/heatmapgl/stream/__init__.py index 2f4f2047594..88e0aa8abd4 100644 --- a/plotly/validators/heatmapgl/stream/__init__.py +++ b/plotly/validators/heatmapgl/stream/__init__.py @@ -1,2 +1,41 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='heatmapgl.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='heatmapgl.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/heatmapgl/stream/_maxpoints.py b/plotly/validators/heatmapgl/stream/_maxpoints.py deleted file mode 100644 index 0eb4c0a9227..00000000000 --- a/plotly/validators/heatmapgl/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='heatmapgl.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/heatmapgl/stream/_token.py b/plotly/validators/heatmapgl/stream/_token.py deleted file mode 100644 index 485697bfb8b..00000000000 --- a/plotly/validators/heatmapgl/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='heatmapgl.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/histogram/__init__.py b/plotly/validators/histogram/__init__.py index 9a6f33fa3b4..4de4f4e78c8 100644 --- a/plotly/validators/histogram/__init__.py +++ b/plotly/validators/histogram/__init__.py @@ -1,47 +1,1205 @@ -from ._ysrc import YsrcValidator -from ._ycalendar import YcalendarValidator -from ._ybins import YBinsValidator -from ._yaxis import YAxisValidator -from ._y import YValidator -from ._xsrc import XsrcValidator -from ._xcalendar import XcalendarValidator -from ._xbins import XBinsValidator -from ._xaxis import XAxisValidator -from ._x import XValidator -from ._visible import VisibleValidator -from ._unselected import UnselectedValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._selected import SelectedValidator -from ._orientation import OrientationValidator -from ._opacity import OpacityValidator -from ._offsetgroup import OffsetgroupValidator -from ._nbinsy import NbinsyValidator -from ._nbinsx import NbinsxValidator -from ._name import NameValidator -from ._marker import MarkerValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._histnorm import HistnormValidator -from ._histfunc import HistfuncValidator -from ._error_y import ErrorYValidator -from ._error_x import ErrorXValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._cumulative import CumulativeValidator -from ._autobiny import AutobinyValidator -from ._autobinx import AutobinxValidator -from ._alignmentgroup import AlignmentgroupValidator + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='histogram', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ycalendar', parent_name='histogram', **kwargs + ): + super(YcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YBinsValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='ybins', parent_name='histogram', **kwargs): + super(YBinsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'YBins'), + data_docs=kwargs.pop( + 'data_docs', """ + end + Sets the end value for the y axis bins. The + last bin may not end exactly at this value, we + increment the bin edge by `size` from `start` + until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use + a date string, and for category data `end` is + based on the category serial numbers. + size + Sets the size of each y axis bin. Default + behavior: If `nbinsy` is 0 or omitted, we + choose a nice round bin size such that the + number of bins is about the same as the typical + number of samples in each bin. If `nbinsy` is + provided, we choose a nice round bin size + giving no more than that many bins. For date + data, use milliseconds or "M" for months, as + in `axis.dtick`. For category data, the number + of categories to bin together (always defaults + to 1). If multiple non-overlaying histograms + share a subplot, the first explicit `size` is + used and all others discarded. If no `size` is + provided,the sample data from all traces is + combined to determine `size` as described + above. + start + Sets the starting value for the y axis bins. + Defaults to the minimum data value, shifted + down if necessary to make nice round values and + to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin + edges 0.5 down, so a `size` of 5 would have a + default `start` of -0.5, so it is clear that + 0-4 are in the first bin, 5-9 in the second, + but continuous data gets a start of 0 and bins + [0,5), [5,10) etc. Dates behave similarly, and + `start` should be a date string. For category + data, `start` is based on the category serial + numbers, and defaults to -0.5. If multiple non- + overlaying histograms share a subplot, the + first explicit `start` is used exactly and all + others are shifted down (if necessary) to + differ from that one by an integer number of + bins. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='yaxis', parent_name='histogram', **kwargs): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='histogram', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='histogram', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xcalendar', parent_name='histogram', **kwargs + ): + super(XcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XBinsValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='xbins', parent_name='histogram', **kwargs): + super(XBinsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'XBins'), + data_docs=kwargs.pop( + 'data_docs', """ + end + Sets the end value for the x axis bins. The + last bin may not end exactly at this value, we + increment the bin edge by `size` from `start` + until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use + a date string, and for category data `end` is + based on the category serial numbers. + size + Sets the size of each x axis bin. Default + behavior: If `nbinsx` is 0 or omitted, we + choose a nice round bin size such that the + number of bins is about the same as the typical + number of samples in each bin. If `nbinsx` is + provided, we choose a nice round bin size + giving no more than that many bins. For date + data, use milliseconds or "M" for months, as + in `axis.dtick`. For category data, the number + of categories to bin together (always defaults + to 1). If multiple non-overlaying histograms + share a subplot, the first explicit `size` is + used and all others discarded. If no `size` is + provided,the sample data from all traces is + combined to determine `size` as described + above. + start + Sets the starting value for the x axis bins. + Defaults to the minimum data value, shifted + down if necessary to make nice round values and + to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin + edges 0.5 down, so a `size` of 5 would have a + default `start` of -0.5, so it is clear that + 0-4 are in the first bin, 5-9 in the second, + but continuous data gets a start of 0 and bins + [0,5), [5,10) etc. Dates behave similarly, and + `start` should be a date string. For category + data, `start` is based on the category serial + numbers, and defaults to -0.5. If multiple non- + overlaying histograms share a subplot, the + first explicit `start` is used exactly and all + others are shifted down (if necessary) to + differ from that one by an integer number of + bins. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='xaxis', parent_name='histogram', **kwargs): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='histogram', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='histogram', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='unselected', parent_name='histogram', **kwargs + ): + super(UnselectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Unselected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.histogram.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.histogram.unselected.Textfont + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='histogram', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='histogram', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textsrc', parent_name='histogram', **kwargs + ): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='histogram', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='histogram', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='histogram', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='histogram', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='selected', parent_name='histogram', **kwargs + ): + super(SelectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Selected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.histogram.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.histogram.selected.Textfont + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OrientationValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='orientation', parent_name='histogram', **kwargs + ): + super(OrientationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['v', 'h']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='histogram', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OffsetgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='offsetgroup', parent_name='histogram', **kwargs + ): + super(OffsetgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NbinsyValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nbinsy', parent_name='histogram', **kwargs + ): + super(NbinsyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NbinsxValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nbinsx', parent_name='histogram', **kwargs + ): + super(NbinsxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='histogram', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='histogram', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.histogram.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + line + plotly.graph_objs.histogram.marker.Line + instance or dict with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='histogram', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='histogram', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='histogram', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='histogram', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='histogram', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertemplatesrc', + parent_name='histogram', + **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='histogram', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='histogram', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='histogram', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='histogram', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HistnormValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='histnorm', parent_name='histogram', **kwargs + ): + super(HistnormValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + '', 'percent', 'probability', 'density', + 'probability density' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HistfuncValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='histfunc', parent_name='histogram', **kwargs + ): + super(HistfuncValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['count', 'sum', 'avg', 'min', 'max']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ErrorYValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='error_y', parent_name='histogram', **kwargs + ): + super(ErrorYValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ErrorY'), + data_docs=kwargs.pop( + 'data_docs', """ + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ErrorXValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='error_x', parent_name='histogram', **kwargs + ): + super(ErrorXValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ErrorX'), + data_docs=kwargs.pop( + 'data_docs', """ + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='histogram', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='histogram', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CumulativeValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='cumulative', parent_name='histogram', **kwargs + ): + super(CumulativeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Cumulative'), + data_docs=kwargs.pop( + 'data_docs', """ + currentbin + Only applies if cumulative is enabled. Sets + whether the current bin is included, excluded, + or has half of its value included in the + current cumulative value. "include" is the + default for compatibility with various other + tools, however it introduces a half-bin bias to + the results. "exclude" makes the opposite half- + bin bias, and "half" removes it. + direction + Only applies if cumulative is enabled. If + "increasing" (default) we sum all prior bins, + so the result increases from left to right. If + "decreasing" we sum later bins so the result + decreases from left to right. + enabled + If true, display the cumulative distribution by + summing the binned values. Use the `direction` + and `centralbin` attributes to tune the + accumulation method. Note: in this mode, the + "density" `histnorm` settings behave the same + as their equivalents without "density": "" and + "density" both rise to the number of data + points, and "probability" and *probability + density* both rise to the number of sample + points. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutobinyValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autobiny', parent_name='histogram', **kwargs + ): + super(AutobinyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutobinxValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autobinx', parent_name='histogram', **kwargs + ): + super(AutobinxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AlignmentgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='alignmentgroup', parent_name='histogram', **kwargs + ): + super(AlignmentgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/histogram/_alignmentgroup.py b/plotly/validators/histogram/_alignmentgroup.py deleted file mode 100644 index b560e53a5ac..00000000000 --- a/plotly/validators/histogram/_alignmentgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AlignmentgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='alignmentgroup', parent_name='histogram', **kwargs - ): - super(AlignmentgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_autobinx.py b/plotly/validators/histogram/_autobinx.py deleted file mode 100644 index 688595354de..00000000000 --- a/plotly/validators/histogram/_autobinx.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutobinxValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autobinx', parent_name='histogram', **kwargs - ): - super(AutobinxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/_autobiny.py b/plotly/validators/histogram/_autobiny.py deleted file mode 100644 index fce716f710d..00000000000 --- a/plotly/validators/histogram/_autobiny.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutobinyValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autobiny', parent_name='histogram', **kwargs - ): - super(AutobinyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/_cumulative.py b/plotly/validators/histogram/_cumulative.py deleted file mode 100644 index dd8bbaddfd4..00000000000 --- a/plotly/validators/histogram/_cumulative.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class CumulativeValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='cumulative', parent_name='histogram', **kwargs - ): - super(CumulativeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Cumulative'), - data_docs=kwargs.pop( - 'data_docs', """ - currentbin - Only applies if cumulative is enabled. Sets - whether the current bin is included, excluded, - or has half of its value included in the - current cumulative value. "include" is the - default for compatibility with various other - tools, however it introduces a half-bin bias to - the results. "exclude" makes the opposite half- - bin bias, and "half" removes it. - direction - Only applies if cumulative is enabled. If - "increasing" (default) we sum all prior bins, - so the result increases from left to right. If - "decreasing" we sum later bins so the result - decreases from left to right. - enabled - If true, display the cumulative distribution by - summing the binned values. Use the `direction` - and `centralbin` attributes to tune the - accumulation method. Note: in this mode, the - "density" `histnorm` settings behave the same - as their equivalents without "density": "" and - "density" both rise to the number of data - points, and "probability" and *probability - density* both rise to the number of sample - points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/_customdata.py b/plotly/validators/histogram/_customdata.py deleted file mode 100644 index 329041bd62a..00000000000 --- a/plotly/validators/histogram/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='histogram', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram/_customdatasrc.py b/plotly/validators/histogram/_customdatasrc.py deleted file mode 100644 index ba793b20f78..00000000000 --- a/plotly/validators/histogram/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='histogram', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_error_x.py b/plotly/validators/histogram/_error_x.py deleted file mode 100644 index 8def5a1d9b3..00000000000 --- a/plotly/validators/histogram/_error_x.py +++ /dev/null @@ -1,75 +0,0 @@ -import _plotly_utils.basevalidators - - -class ErrorXValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='error_x', parent_name='histogram', **kwargs - ): - super(ErrorXValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ErrorX'), - data_docs=kwargs.pop( - 'data_docs', """ - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - copy_ystyle - - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/_error_y.py b/plotly/validators/histogram/_error_y.py deleted file mode 100644 index 8e6a1bbdc56..00000000000 --- a/plotly/validators/histogram/_error_y.py +++ /dev/null @@ -1,73 +0,0 @@ -import _plotly_utils.basevalidators - - -class ErrorYValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='error_y', parent_name='histogram', **kwargs - ): - super(ErrorYValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ErrorY'), - data_docs=kwargs.pop( - 'data_docs', """ - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/_histfunc.py b/plotly/validators/histogram/_histfunc.py deleted file mode 100644 index 5fc3111d2f8..00000000000 --- a/plotly/validators/histogram/_histfunc.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HistfuncValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='histfunc', parent_name='histogram', **kwargs - ): - super(HistfuncValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['count', 'sum', 'avg', 'min', 'max']), - **kwargs - ) diff --git a/plotly/validators/histogram/_histnorm.py b/plotly/validators/histogram/_histnorm.py deleted file mode 100644 index 7139c27b70e..00000000000 --- a/plotly/validators/histogram/_histnorm.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class HistnormValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='histnorm', parent_name='histogram', **kwargs - ): - super(HistnormValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - '', 'percent', 'probability', 'density', - 'probability density' - ] - ), - **kwargs - ) diff --git a/plotly/validators/histogram/_hoverinfo.py b/plotly/validators/histogram/_hoverinfo.py deleted file mode 100644 index 03fe1363724..00000000000 --- a/plotly/validators/histogram/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='histogram', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_hoverinfosrc.py b/plotly/validators/histogram/_hoverinfosrc.py deleted file mode 100644 index 86385c13b67..00000000000 --- a/plotly/validators/histogram/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='histogram', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_hoverlabel.py b/plotly/validators/histogram/_hoverlabel.py deleted file mode 100644 index 100ae22b3d9..00000000000 --- a/plotly/validators/histogram/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='histogram', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/_hovertemplate.py b/plotly/validators/histogram/_hovertemplate.py deleted file mode 100644 index 1e4a222a03e..00000000000 --- a/plotly/validators/histogram/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='histogram', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_hovertemplatesrc.py b/plotly/validators/histogram/_hovertemplatesrc.py deleted file mode 100644 index d6209d18bd3..00000000000 --- a/plotly/validators/histogram/_hovertemplatesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertemplatesrc', - parent_name='histogram', - **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_hovertext.py b/plotly/validators/histogram/_hovertext.py deleted file mode 100644 index 44cba731c40..00000000000 --- a/plotly/validators/histogram/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='histogram', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_hovertextsrc.py b/plotly/validators/histogram/_hovertextsrc.py deleted file mode 100644 index c012b2fff14..00000000000 --- a/plotly/validators/histogram/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='histogram', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_ids.py b/plotly/validators/histogram/_ids.py deleted file mode 100644 index b073dbd1b87..00000000000 --- a/plotly/validators/histogram/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='histogram', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram/_idssrc.py b/plotly/validators/histogram/_idssrc.py deleted file mode 100644 index 18bc0c13ea3..00000000000 --- a/plotly/validators/histogram/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='histogram', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_legendgroup.py b/plotly/validators/histogram/_legendgroup.py deleted file mode 100644 index 87d3496145c..00000000000 --- a/plotly/validators/histogram/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='histogram', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_marker.py b/plotly/validators/histogram/_marker.py deleted file mode 100644 index 6655d0e014c..00000000000 --- a/plotly/validators/histogram/_marker.py +++ /dev/null @@ -1,103 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='histogram', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.histogram.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - line - plotly.graph_objs.histogram.marker.Line - instance or dict with compatible properties - opacity - Sets the opacity of the bars. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/_name.py b/plotly/validators/histogram/_name.py deleted file mode 100644 index a1f92cf695c..00000000000 --- a/plotly/validators/histogram/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='histogram', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_nbinsx.py b/plotly/validators/histogram/_nbinsx.py deleted file mode 100644 index 0da4921452b..00000000000 --- a/plotly/validators/histogram/_nbinsx.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NbinsxValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nbinsx', parent_name='histogram', **kwargs - ): - super(NbinsxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/_nbinsy.py b/plotly/validators/histogram/_nbinsy.py deleted file mode 100644 index b696453181f..00000000000 --- a/plotly/validators/histogram/_nbinsy.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NbinsyValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nbinsy', parent_name='histogram', **kwargs - ): - super(NbinsyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/_offsetgroup.py b/plotly/validators/histogram/_offsetgroup.py deleted file mode 100644 index ce77c620bd7..00000000000 --- a/plotly/validators/histogram/_offsetgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OffsetgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='offsetgroup', parent_name='histogram', **kwargs - ): - super(OffsetgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_opacity.py b/plotly/validators/histogram/_opacity.py deleted file mode 100644 index 68a1adb0fef..00000000000 --- a/plotly/validators/histogram/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='histogram', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/_orientation.py b/plotly/validators/histogram/_orientation.py deleted file mode 100644 index 539e36a09b3..00000000000 --- a/plotly/validators/histogram/_orientation.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class OrientationValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='orientation', parent_name='histogram', **kwargs - ): - super(OrientationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['v', 'h']), - **kwargs - ) diff --git a/plotly/validators/histogram/_selected.py b/plotly/validators/histogram/_selected.py deleted file mode 100644 index cf11369bab0..00000000000 --- a/plotly/validators/histogram/_selected.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='selected', parent_name='histogram', **kwargs - ): - super(SelectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Selected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.histogram.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.histogram.selected.Textfont - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/_selectedpoints.py b/plotly/validators/histogram/_selectedpoints.py deleted file mode 100644 index c33052b67ec..00000000000 --- a/plotly/validators/histogram/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='histogram', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_showlegend.py b/plotly/validators/histogram/_showlegend.py deleted file mode 100644 index 695bc0ab6b5..00000000000 --- a/plotly/validators/histogram/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='histogram', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_stream.py b/plotly/validators/histogram/_stream.py deleted file mode 100644 index 21a7ef60847..00000000000 --- a/plotly/validators/histogram/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='histogram', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/_text.py b/plotly/validators/histogram/_text.py deleted file mode 100644 index 128cff33339..00000000000 --- a/plotly/validators/histogram/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='histogram', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_textsrc.py b/plotly/validators/histogram/_textsrc.py deleted file mode 100644 index acc62b7084e..00000000000 --- a/plotly/validators/histogram/_textsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textsrc', parent_name='histogram', **kwargs - ): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_uid.py b/plotly/validators/histogram/_uid.py deleted file mode 100644 index 29610ed73ff..00000000000 --- a/plotly/validators/histogram/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='histogram', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_uirevision.py b/plotly/validators/histogram/_uirevision.py deleted file mode 100644 index b3635c6f77f..00000000000 --- a/plotly/validators/histogram/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='histogram', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_unselected.py b/plotly/validators/histogram/_unselected.py deleted file mode 100644 index bde2c48fe9c..00000000000 --- a/plotly/validators/histogram/_unselected.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='unselected', parent_name='histogram', **kwargs - ): - super(UnselectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Unselected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.histogram.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.histogram.unselected.Textfont - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/_visible.py b/plotly/validators/histogram/_visible.py deleted file mode 100644 index 403feca22e9..00000000000 --- a/plotly/validators/histogram/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='histogram', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/histogram/_x.py b/plotly/validators/histogram/_x.py deleted file mode 100644 index 3ccd0958124..00000000000 --- a/plotly/validators/histogram/_x.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='histogram', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram/_xaxis.py b/plotly/validators/histogram/_xaxis.py deleted file mode 100644 index d4e1cf93549..00000000000 --- a/plotly/validators/histogram/_xaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='xaxis', parent_name='histogram', **kwargs): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_xbins.py b/plotly/validators/histogram/_xbins.py deleted file mode 100644 index 63750f423e1..00000000000 --- a/plotly/validators/histogram/_xbins.py +++ /dev/null @@ -1,60 +0,0 @@ -import _plotly_utils.basevalidators - - -class XBinsValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='xbins', parent_name='histogram', **kwargs): - super(XBinsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'XBins'), - data_docs=kwargs.pop( - 'data_docs', """ - end - Sets the end value for the x axis bins. The - last bin may not end exactly at this value, we - increment the bin edge by `size` from `start` - until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use - a date string, and for category data `end` is - based on the category serial numbers. - size - Sets the size of each x axis bin. Default - behavior: If `nbinsx` is 0 or omitted, we - choose a nice round bin size such that the - number of bins is about the same as the typical - number of samples in each bin. If `nbinsx` is - provided, we choose a nice round bin size - giving no more than that many bins. For date - data, use milliseconds or "M" for months, as - in `axis.dtick`. For category data, the number - of categories to bin together (always defaults - to 1). If multiple non-overlaying histograms - share a subplot, the first explicit `size` is - used and all others discarded. If no `size` is - provided,the sample data from all traces is - combined to determine `size` as described - above. - start - Sets the starting value for the x axis bins. - Defaults to the minimum data value, shifted - down if necessary to make nice round values and - to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin - edges 0.5 down, so a `size` of 5 would have a - default `start` of -0.5, so it is clear that - 0-4 are in the first bin, 5-9 in the second, - but continuous data gets a start of 0 and bins - [0,5), [5,10) etc. Dates behave similarly, and - `start` should be a date string. For category - data, `start` is based on the category serial - numbers, and defaults to -0.5. If multiple non- - overlaying histograms share a subplot, the - first explicit `start` is used exactly and all - others are shifted down (if necessary) to - differ from that one by an integer number of - bins. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/_xcalendar.py b/plotly/validators/histogram/_xcalendar.py deleted file mode 100644 index cf878240779..00000000000 --- a/plotly/validators/histogram/_xcalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xcalendar', parent_name='histogram', **kwargs - ): - super(XcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/histogram/_xsrc.py b/plotly/validators/histogram/_xsrc.py deleted file mode 100644 index adbc8a10096..00000000000 --- a/plotly/validators/histogram/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='histogram', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_y.py b/plotly/validators/histogram/_y.py deleted file mode 100644 index 7bba846d53d..00000000000 --- a/plotly/validators/histogram/_y.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='histogram', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram/_yaxis.py b/plotly/validators/histogram/_yaxis.py deleted file mode 100644 index 92ce6668548..00000000000 --- a/plotly/validators/histogram/_yaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='yaxis', parent_name='histogram', **kwargs): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/_ybins.py b/plotly/validators/histogram/_ybins.py deleted file mode 100644 index a5d1b330344..00000000000 --- a/plotly/validators/histogram/_ybins.py +++ /dev/null @@ -1,60 +0,0 @@ -import _plotly_utils.basevalidators - - -class YBinsValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='ybins', parent_name='histogram', **kwargs): - super(YBinsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'YBins'), - data_docs=kwargs.pop( - 'data_docs', """ - end - Sets the end value for the y axis bins. The - last bin may not end exactly at this value, we - increment the bin edge by `size` from `start` - until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use - a date string, and for category data `end` is - based on the category serial numbers. - size - Sets the size of each y axis bin. Default - behavior: If `nbinsy` is 0 or omitted, we - choose a nice round bin size such that the - number of bins is about the same as the typical - number of samples in each bin. If `nbinsy` is - provided, we choose a nice round bin size - giving no more than that many bins. For date - data, use milliseconds or "M" for months, as - in `axis.dtick`. For category data, the number - of categories to bin together (always defaults - to 1). If multiple non-overlaying histograms - share a subplot, the first explicit `size` is - used and all others discarded. If no `size` is - provided,the sample data from all traces is - combined to determine `size` as described - above. - start - Sets the starting value for the y axis bins. - Defaults to the minimum data value, shifted - down if necessary to make nice round values and - to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin - edges 0.5 down, so a `size` of 5 would have a - default `start` of -0.5, so it is clear that - 0-4 are in the first bin, 5-9 in the second, - but continuous data gets a start of 0 and bins - [0,5), [5,10) etc. Dates behave similarly, and - `start` should be a date string. For category - data, `start` is based on the category serial - numbers, and defaults to -0.5. If multiple non- - overlaying histograms share a subplot, the - first explicit `start` is used exactly and all - others are shifted down (if necessary) to - differ from that one by an integer number of - bins. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/_ycalendar.py b/plotly/validators/histogram/_ycalendar.py deleted file mode 100644 index f1b67334cdc..00000000000 --- a/plotly/validators/histogram/_ycalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ycalendar', parent_name='histogram', **kwargs - ): - super(YcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/histogram/_ysrc.py b/plotly/validators/histogram/_ysrc.py deleted file mode 100644 index 3c3599ca7eb..00000000000 --- a/plotly/validators/histogram/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='histogram', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/cumulative/__init__.py b/plotly/validators/histogram/cumulative/__init__.py index d3426ed067f..6f6ea1966da 100644 --- a/plotly/validators/histogram/cumulative/__init__.py +++ b/plotly/validators/histogram/cumulative/__init__.py @@ -1,3 +1,62 @@ -from ._enabled import EnabledValidator -from ._direction import DirectionValidator -from ._currentbin import CurrentbinValidator + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='histogram.cumulative', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DirectionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='direction', + parent_name='histogram.cumulative', + **kwargs + ): + super(DirectionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['increasing', 'decreasing']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CurrentbinValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='currentbin', + parent_name='histogram.cumulative', + **kwargs + ): + super(CurrentbinValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['include', 'exclude', 'half']), + **kwargs + ) diff --git a/plotly/validators/histogram/cumulative/_currentbin.py b/plotly/validators/histogram/cumulative/_currentbin.py deleted file mode 100644 index d409486fa39..00000000000 --- a/plotly/validators/histogram/cumulative/_currentbin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CurrentbinValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='currentbin', - parent_name='histogram.cumulative', - **kwargs - ): - super(CurrentbinValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['include', 'exclude', 'half']), - **kwargs - ) diff --git a/plotly/validators/histogram/cumulative/_direction.py b/plotly/validators/histogram/cumulative/_direction.py deleted file mode 100644 index fd8668ef25d..00000000000 --- a/plotly/validators/histogram/cumulative/_direction.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DirectionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='direction', - parent_name='histogram.cumulative', - **kwargs - ): - super(DirectionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['increasing', 'decreasing']), - **kwargs - ) diff --git a/plotly/validators/histogram/cumulative/_enabled.py b/plotly/validators/histogram/cumulative/_enabled.py deleted file mode 100644 index 141a8a58ed9..00000000000 --- a/plotly/validators/histogram/cumulative/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='histogram.cumulative', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_x/__init__.py b/plotly/validators/histogram/error_x/__init__.py index c4605e01877..5d140c70f14 100644 --- a/plotly/validators/histogram/error_x/__init__.py +++ b/plotly/validators/histogram/error_x/__init__.py @@ -1,15 +1,291 @@ -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._valueminus import ValueminusValidator -from ._value import ValueValidator -from ._type import TypeValidator -from ._tracerefminus import TracerefminusValidator -from ._traceref import TracerefValidator -from ._thickness import ThicknessValidator -from ._symmetric import SymmetricValidator -from ._copy_ystyle import CopyYstyleValidator -from ._color import ColorValidator -from ._arraysrc import ArraysrcValidator -from ._arrayminussrc import ArrayminussrcValidator -from ._arrayminus import ArrayminusValidator -from ._array import ArrayValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='histogram.error_x', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='histogram.error_x', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='valueminus', + parent_name='histogram.error_x', + **kwargs + ): + super(ValueminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='value', parent_name='histogram.error_x', **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='histogram.error_x', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['percent', 'constant', 'sqrt', 'data'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='tracerefminus', + parent_name='histogram.error_x', + **kwargs + ): + super(TracerefminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='traceref', + parent_name='histogram.error_x', + **kwargs + ): + super(TracerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='histogram.error_x', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='symmetric', + parent_name='histogram.error_x', + **kwargs + ): + super(SymmetricValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CopyYstyleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='copy_ystyle', + parent_name='histogram.error_x', + **kwargs + ): + super(CopyYstyleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='histogram.error_x', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='arraysrc', + parent_name='histogram.error_x', + **kwargs + ): + super(ArraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='arrayminussrc', + parent_name='histogram.error_x', + **kwargs + ): + super(ArrayminussrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='arrayminus', + parent_name='histogram.error_x', + **kwargs + ): + super(ArrayminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='array', parent_name='histogram.error_x', **kwargs + ): + super(ArrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/histogram/error_x/_array.py b/plotly/validators/histogram/error_x/_array.py deleted file mode 100644 index d8c1dd7fbb4..00000000000 --- a/plotly/validators/histogram/error_x/_array.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='array', parent_name='histogram.error_x', **kwargs - ): - super(ArrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_x/_arrayminus.py b/plotly/validators/histogram/error_x/_arrayminus.py deleted file mode 100644 index 9148abf0b52..00000000000 --- a/plotly/validators/histogram/error_x/_arrayminus.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='arrayminus', - parent_name='histogram.error_x', - **kwargs - ): - super(ArrayminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_x/_arrayminussrc.py b/plotly/validators/histogram/error_x/_arrayminussrc.py deleted file mode 100644 index 0108008539d..00000000000 --- a/plotly/validators/histogram/error_x/_arrayminussrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='arrayminussrc', - parent_name='histogram.error_x', - **kwargs - ): - super(ArrayminussrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_x/_arraysrc.py b/plotly/validators/histogram/error_x/_arraysrc.py deleted file mode 100644 index 9106c4899ac..00000000000 --- a/plotly/validators/histogram/error_x/_arraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='arraysrc', - parent_name='histogram.error_x', - **kwargs - ): - super(ArraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_x/_color.py b/plotly/validators/histogram/error_x/_color.py deleted file mode 100644 index 00e6954069f..00000000000 --- a/plotly/validators/histogram/error_x/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='histogram.error_x', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_x/_copy_ystyle.py b/plotly/validators/histogram/error_x/_copy_ystyle.py deleted file mode 100644 index 66670dce5d0..00000000000 --- a/plotly/validators/histogram/error_x/_copy_ystyle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CopyYstyleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='copy_ystyle', - parent_name='histogram.error_x', - **kwargs - ): - super(CopyYstyleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_x/_symmetric.py b/plotly/validators/histogram/error_x/_symmetric.py deleted file mode 100644 index 08f73533024..00000000000 --- a/plotly/validators/histogram/error_x/_symmetric.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='symmetric', - parent_name='histogram.error_x', - **kwargs - ): - super(SymmetricValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_x/_thickness.py b/plotly/validators/histogram/error_x/_thickness.py deleted file mode 100644 index e5e2a7e3b39..00000000000 --- a/plotly/validators/histogram/error_x/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='histogram.error_x', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_x/_traceref.py b/plotly/validators/histogram/error_x/_traceref.py deleted file mode 100644 index 3a8ffdb68ab..00000000000 --- a/plotly/validators/histogram/error_x/_traceref.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='traceref', - parent_name='histogram.error_x', - **kwargs - ): - super(TracerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_x/_tracerefminus.py b/plotly/validators/histogram/error_x/_tracerefminus.py deleted file mode 100644 index 0e7d9dcc64e..00000000000 --- a/plotly/validators/histogram/error_x/_tracerefminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='tracerefminus', - parent_name='histogram.error_x', - **kwargs - ): - super(TracerefminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_x/_type.py b/plotly/validators/histogram/error_x/_type.py deleted file mode 100644 index 860cc8bcf3f..00000000000 --- a/plotly/validators/histogram/error_x/_type.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='histogram.error_x', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['percent', 'constant', 'sqrt', 'data'] - ), - **kwargs - ) diff --git a/plotly/validators/histogram/error_x/_value.py b/plotly/validators/histogram/error_x/_value.py deleted file mode 100644 index e6453b9d12c..00000000000 --- a/plotly/validators/histogram/error_x/_value.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='value', parent_name='histogram.error_x', **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_x/_valueminus.py b/plotly/validators/histogram/error_x/_valueminus.py deleted file mode 100644 index 1ab5b1b9511..00000000000 --- a/plotly/validators/histogram/error_x/_valueminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='valueminus', - parent_name='histogram.error_x', - **kwargs - ): - super(ValueminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_x/_visible.py b/plotly/validators/histogram/error_x/_visible.py deleted file mode 100644 index 82d4e596b45..00000000000 --- a/plotly/validators/histogram/error_x/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='histogram.error_x', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_x/_width.py b/plotly/validators/histogram/error_x/_width.py deleted file mode 100644 index 22d4cbe1861..00000000000 --- a/plotly/validators/histogram/error_x/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='histogram.error_x', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_y/__init__.py b/plotly/validators/histogram/error_y/__init__.py index 2fc70c4058d..52d1d6cdb79 100644 --- a/plotly/validators/histogram/error_y/__init__.py +++ b/plotly/validators/histogram/error_y/__init__.py @@ -1,14 +1,271 @@ -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._valueminus import ValueminusValidator -from ._value import ValueValidator -from ._type import TypeValidator -from ._tracerefminus import TracerefminusValidator -from ._traceref import TracerefValidator -from ._thickness import ThicknessValidator -from ._symmetric import SymmetricValidator -from ._color import ColorValidator -from ._arraysrc import ArraysrcValidator -from ._arrayminussrc import ArrayminussrcValidator -from ._arrayminus import ArrayminusValidator -from ._array import ArrayValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='histogram.error_y', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='histogram.error_y', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='valueminus', + parent_name='histogram.error_y', + **kwargs + ): + super(ValueminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='value', parent_name='histogram.error_y', **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='histogram.error_y', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['percent', 'constant', 'sqrt', 'data'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='tracerefminus', + parent_name='histogram.error_y', + **kwargs + ): + super(TracerefminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='traceref', + parent_name='histogram.error_y', + **kwargs + ): + super(TracerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='histogram.error_y', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='symmetric', + parent_name='histogram.error_y', + **kwargs + ): + super(SymmetricValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='histogram.error_y', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='arraysrc', + parent_name='histogram.error_y', + **kwargs + ): + super(ArraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='arrayminussrc', + parent_name='histogram.error_y', + **kwargs + ): + super(ArrayminussrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='arrayminus', + parent_name='histogram.error_y', + **kwargs + ): + super(ArrayminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='array', parent_name='histogram.error_y', **kwargs + ): + super(ArrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/histogram/error_y/_array.py b/plotly/validators/histogram/error_y/_array.py deleted file mode 100644 index 74b486b4fb4..00000000000 --- a/plotly/validators/histogram/error_y/_array.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='array', parent_name='histogram.error_y', **kwargs - ): - super(ArrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_y/_arrayminus.py b/plotly/validators/histogram/error_y/_arrayminus.py deleted file mode 100644 index 00e3369283a..00000000000 --- a/plotly/validators/histogram/error_y/_arrayminus.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='arrayminus', - parent_name='histogram.error_y', - **kwargs - ): - super(ArrayminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_y/_arrayminussrc.py b/plotly/validators/histogram/error_y/_arrayminussrc.py deleted file mode 100644 index d9938d138e9..00000000000 --- a/plotly/validators/histogram/error_y/_arrayminussrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='arrayminussrc', - parent_name='histogram.error_y', - **kwargs - ): - super(ArrayminussrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_y/_arraysrc.py b/plotly/validators/histogram/error_y/_arraysrc.py deleted file mode 100644 index 1fea83eea4c..00000000000 --- a/plotly/validators/histogram/error_y/_arraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='arraysrc', - parent_name='histogram.error_y', - **kwargs - ): - super(ArraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_y/_color.py b/plotly/validators/histogram/error_y/_color.py deleted file mode 100644 index 07f12895262..00000000000 --- a/plotly/validators/histogram/error_y/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='histogram.error_y', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_y/_symmetric.py b/plotly/validators/histogram/error_y/_symmetric.py deleted file mode 100644 index 114f32e2e82..00000000000 --- a/plotly/validators/histogram/error_y/_symmetric.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='symmetric', - parent_name='histogram.error_y', - **kwargs - ): - super(SymmetricValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_y/_thickness.py b/plotly/validators/histogram/error_y/_thickness.py deleted file mode 100644 index 191b7eccb32..00000000000 --- a/plotly/validators/histogram/error_y/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='histogram.error_y', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_y/_traceref.py b/plotly/validators/histogram/error_y/_traceref.py deleted file mode 100644 index bab76470d5b..00000000000 --- a/plotly/validators/histogram/error_y/_traceref.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='traceref', - parent_name='histogram.error_y', - **kwargs - ): - super(TracerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_y/_tracerefminus.py b/plotly/validators/histogram/error_y/_tracerefminus.py deleted file mode 100644 index bdc48a07016..00000000000 --- a/plotly/validators/histogram/error_y/_tracerefminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='tracerefminus', - parent_name='histogram.error_y', - **kwargs - ): - super(TracerefminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_y/_type.py b/plotly/validators/histogram/error_y/_type.py deleted file mode 100644 index ba123a2c87b..00000000000 --- a/plotly/validators/histogram/error_y/_type.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='histogram.error_y', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['percent', 'constant', 'sqrt', 'data'] - ), - **kwargs - ) diff --git a/plotly/validators/histogram/error_y/_value.py b/plotly/validators/histogram/error_y/_value.py deleted file mode 100644 index 215a967f690..00000000000 --- a/plotly/validators/histogram/error_y/_value.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='value', parent_name='histogram.error_y', **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_y/_valueminus.py b/plotly/validators/histogram/error_y/_valueminus.py deleted file mode 100644 index 9c2fe178f16..00000000000 --- a/plotly/validators/histogram/error_y/_valueminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='valueminus', - parent_name='histogram.error_y', - **kwargs - ): - super(ValueminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_y/_visible.py b/plotly/validators/histogram/error_y/_visible.py deleted file mode 100644 index aaa78cb6a3d..00000000000 --- a/plotly/validators/histogram/error_y/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='histogram.error_y', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/error_y/_width.py b/plotly/validators/histogram/error_y/_width.py deleted file mode 100644 index 59b06bd14d3..00000000000 --- a/plotly/validators/histogram/error_y/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='histogram.error_y', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/hoverlabel/__init__.py b/plotly/validators/histogram/hoverlabel/__init__.py index 856f769ba33..90f27c88299 100644 --- a/plotly/validators/histogram/hoverlabel/__init__.py +++ b/plotly/validators/histogram/hoverlabel/__init__.py @@ -1,7 +1,173 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='histogram.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='histogram.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='histogram.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='histogram.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='histogram.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='histogram.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='histogram.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram/hoverlabel/_bgcolor.py b/plotly/validators/histogram/hoverlabel/_bgcolor.py deleted file mode 100644 index d974a36e89e..00000000000 --- a/plotly/validators/histogram/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='histogram.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/hoverlabel/_bgcolorsrc.py b/plotly/validators/histogram/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 33f0cc677bb..00000000000 --- a/plotly/validators/histogram/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='histogram.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/hoverlabel/_bordercolor.py b/plotly/validators/histogram/hoverlabel/_bordercolor.py deleted file mode 100644 index b7e2f116303..00000000000 --- a/plotly/validators/histogram/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='histogram.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/hoverlabel/_bordercolorsrc.py b/plotly/validators/histogram/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 5f6b2e0e935..00000000000 --- a/plotly/validators/histogram/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='histogram.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/hoverlabel/_font.py b/plotly/validators/histogram/hoverlabel/_font.py deleted file mode 100644 index ec33820fad7..00000000000 --- a/plotly/validators/histogram/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='histogram.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/hoverlabel/_namelength.py b/plotly/validators/histogram/hoverlabel/_namelength.py deleted file mode 100644 index 131eedb1c60..00000000000 --- a/plotly/validators/histogram/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='histogram.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/hoverlabel/_namelengthsrc.py b/plotly/validators/histogram/hoverlabel/_namelengthsrc.py deleted file mode 100644 index ceb550683d4..00000000000 --- a/plotly/validators/histogram/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='histogram.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/hoverlabel/font/__init__.py b/plotly/validators/histogram/hoverlabel/font/__init__.py index 1d2c591d1e5..2c646bb8a45 100644 --- a/plotly/validators/histogram/hoverlabel/font/__init__.py +++ b/plotly/validators/histogram/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='histogram.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='histogram.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='histogram.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='histogram.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='histogram.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram/hoverlabel/font/_color.py b/plotly/validators/histogram/hoverlabel/font/_color.py deleted file mode 100644 index ced0a38ec86..00000000000 --- a/plotly/validators/histogram/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/hoverlabel/font/_colorsrc.py b/plotly/validators/histogram/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 29d4cc614bb..00000000000 --- a/plotly/validators/histogram/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='histogram.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/hoverlabel/font/_family.py b/plotly/validators/histogram/hoverlabel/font/_family.py deleted file mode 100644 index 27be15089c8..00000000000 --- a/plotly/validators/histogram/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='histogram.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/histogram/hoverlabel/font/_familysrc.py b/plotly/validators/histogram/hoverlabel/font/_familysrc.py deleted file mode 100644 index 8e8647fc001..00000000000 --- a/plotly/validators/histogram/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='histogram.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/hoverlabel/font/_size.py b/plotly/validators/histogram/hoverlabel/font/_size.py deleted file mode 100644 index 5f0140985cd..00000000000 --- a/plotly/validators/histogram/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='histogram.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/hoverlabel/font/_sizesrc.py b/plotly/validators/histogram/hoverlabel/font/_sizesrc.py deleted file mode 100644 index d4347780ef2..00000000000 --- a/plotly/validators/histogram/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='histogram.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/__init__.py b/plotly/validators/histogram/marker/__init__.py index ea24221c2fd..588483d33ed 100644 --- a/plotly/validators/histogram/marker/__init__.py +++ b/plotly/validators/histogram/marker/__init__.py @@ -1,14 +1,563 @@ -from ._showscale import ShowscaleValidator -from ._reversescale import ReversescaleValidator -from ._opacitysrc import OpacitysrcValidator -from ._opacity import OpacityValidator -from ._line import LineValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showscale', + parent_name='histogram.marker', + **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='histogram.marker', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='opacitysrc', + parent_name='histogram.marker', + **kwargs + ): + super(OpacitysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='histogram.marker', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='histogram.marker', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='histogram.marker', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='histogram.marker', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='histogram.marker', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.histogram.marker.colorbar.Tic + kformatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.histogram.marker.colorbar.tickformatstopdefau + lts), sets the default property values to use + for elements of + histogram.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.histogram.marker.colorbar.Tit + le instance or dict with compatible properties + titlefont + Deprecated: Please use + histogram.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. + titleside + Deprecated: Please use + histogram.marker.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='histogram.marker', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'histogram.marker.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='histogram.marker', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='histogram.marker', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='histogram.marker', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='histogram.marker', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='histogram.marker', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram/marker/_autocolorscale.py b/plotly/validators/histogram/marker/_autocolorscale.py deleted file mode 100644 index ac9b9b193ed..00000000000 --- a/plotly/validators/histogram/marker/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='histogram.marker', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/_cauto.py b/plotly/validators/histogram/marker/_cauto.py deleted file mode 100644 index 42d3817210b..00000000000 --- a/plotly/validators/histogram/marker/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='histogram.marker', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/_cmax.py b/plotly/validators/histogram/marker/_cmax.py deleted file mode 100644 index a8f42a4b20d..00000000000 --- a/plotly/validators/histogram/marker/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='histogram.marker', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/_cmid.py b/plotly/validators/histogram/marker/_cmid.py deleted file mode 100644 index ea839ebd5e2..00000000000 --- a/plotly/validators/histogram/marker/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='histogram.marker', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/_cmin.py b/plotly/validators/histogram/marker/_cmin.py deleted file mode 100644 index 90a84c1a00f..00000000000 --- a/plotly/validators/histogram/marker/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='histogram.marker', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/_color.py b/plotly/validators/histogram/marker/_color.py deleted file mode 100644 index d656aad1f46..00000000000 --- a/plotly/validators/histogram/marker/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='histogram.marker', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'histogram.marker.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/_colorbar.py b/plotly/validators/histogram/marker/_colorbar.py deleted file mode 100644 index a94f2da609e..00000000000 --- a/plotly/validators/histogram/marker/_colorbar.py +++ /dev/null @@ -1,228 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='histogram.marker', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.histogram.marker.colorbar.Tic - kformatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.histogram.marker.colorbar.tickformatstopdefau - lts), sets the default property values to use - for elements of - histogram.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.histogram.marker.colorbar.Tit - le instance or dict with compatible properties - titlefont - Deprecated: Please use - histogram.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. - titleside - Deprecated: Please use - histogram.marker.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/_colorscale.py b/plotly/validators/histogram/marker/_colorscale.py deleted file mode 100644 index 5aab62b4a2d..00000000000 --- a/plotly/validators/histogram/marker/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='histogram.marker', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/_colorsrc.py b/plotly/validators/histogram/marker/_colorsrc.py deleted file mode 100644 index bee26ca0187..00000000000 --- a/plotly/validators/histogram/marker/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='histogram.marker', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/_line.py b/plotly/validators/histogram/marker/_line.py deleted file mode 100644 index 2ad7e73cadb..00000000000 --- a/plotly/validators/histogram/marker/_line.py +++ /dev/null @@ -1,97 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='histogram.marker', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/_opacity.py b/plotly/validators/histogram/marker/_opacity.py deleted file mode 100644 index dbd2dc66b76..00000000000 --- a/plotly/validators/histogram/marker/_opacity.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='histogram.marker', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/_opacitysrc.py b/plotly/validators/histogram/marker/_opacitysrc.py deleted file mode 100644 index 4a75b212a88..00000000000 --- a/plotly/validators/histogram/marker/_opacitysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='opacitysrc', - parent_name='histogram.marker', - **kwargs - ): - super(OpacitysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/_reversescale.py b/plotly/validators/histogram/marker/_reversescale.py deleted file mode 100644 index 431d15cfe82..00000000000 --- a/plotly/validators/histogram/marker/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='histogram.marker', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/_showscale.py b/plotly/validators/histogram/marker/_showscale.py deleted file mode 100644 index 548be0d4baa..00000000000 --- a/plotly/validators/histogram/marker/_showscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showscale', - parent_name='histogram.marker', - **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/__init__.py b/plotly/validators/histogram/marker/colorbar/__init__.py index 3dab31f7e02..9647df5b143 100644 --- a/plotly/validators/histogram/marker/colorbar/__init__.py +++ b/plotly/validators/histogram/marker/colorbar/__init__.py @@ -1,41 +1,936 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ypad', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='y', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xpad', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='x', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='len', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='histogram.marker.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram/marker/colorbar/_bgcolor.py b/plotly/validators/histogram/marker/colorbar/_bgcolor.py deleted file mode 100644 index 3c94a4da38b..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_bordercolor.py b/plotly/validators/histogram/marker/colorbar/_bordercolor.py deleted file mode 100644 index b5ec5a2982e..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_borderwidth.py b/plotly/validators/histogram/marker/colorbar/_borderwidth.py deleted file mode 100644 index 3e96ebaa887..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_dtick.py b/plotly/validators/histogram/marker/colorbar/_dtick.py deleted file mode 100644 index bccba95a88f..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_exponentformat.py b/plotly/validators/histogram/marker/colorbar/_exponentformat.py deleted file mode 100644 index 48dda4f00da..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_len.py b/plotly/validators/histogram/marker/colorbar/_len.py deleted file mode 100644 index 3f9aca349ff..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_len.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='len', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_lenmode.py b/plotly/validators/histogram/marker/colorbar/_lenmode.py deleted file mode 100644 index 21c89d73990..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_nticks.py b/plotly/validators/histogram/marker/colorbar/_nticks.py deleted file mode 100644 index 01a22d18844..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_outlinecolor.py b/plotly/validators/histogram/marker/colorbar/_outlinecolor.py deleted file mode 100644 index 73948a56b4d..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_outlinewidth.py b/plotly/validators/histogram/marker/colorbar/_outlinewidth.py deleted file mode 100644 index a31fe80868b..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_separatethousands.py b/plotly/validators/histogram/marker/colorbar/_separatethousands.py deleted file mode 100644 index 303599e57c5..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_showexponent.py b/plotly/validators/histogram/marker/colorbar/_showexponent.py deleted file mode 100644 index 49cdabcab00..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_showticklabels.py b/plotly/validators/histogram/marker/colorbar/_showticklabels.py deleted file mode 100644 index f840ec82416..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_showtickprefix.py b/plotly/validators/histogram/marker/colorbar/_showtickprefix.py deleted file mode 100644 index cb6ad1502e9..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_showticksuffix.py b/plotly/validators/histogram/marker/colorbar/_showticksuffix.py deleted file mode 100644 index 758f3a0d681..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_thickness.py b/plotly/validators/histogram/marker/colorbar/_thickness.py deleted file mode 100644 index e0da2c83e48..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_thicknessmode.py b/plotly/validators/histogram/marker/colorbar/_thicknessmode.py deleted file mode 100644 index 4c32328ab5f..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_tick0.py b/plotly/validators/histogram/marker/colorbar/_tick0.py deleted file mode 100644 index 0d0ff2f43bb..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_tickangle.py b/plotly/validators/histogram/marker/colorbar/_tickangle.py deleted file mode 100644 index 991c7045253..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_tickcolor.py b/plotly/validators/histogram/marker/colorbar/_tickcolor.py deleted file mode 100644 index 77acfc8b3d6..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_tickfont.py b/plotly/validators/histogram/marker/colorbar/_tickfont.py deleted file mode 100644 index 392d24e92e7..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_tickformat.py b/plotly/validators/histogram/marker/colorbar/_tickformat.py deleted file mode 100644 index c6f0f8aacd6..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_tickformatstopdefaults.py b/plotly/validators/histogram/marker/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index acd068fc127..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_tickformatstops.py b/plotly/validators/histogram/marker/colorbar/_tickformatstops.py deleted file mode 100644 index 33b33a87809..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_ticklen.py b/plotly/validators/histogram/marker/colorbar/_ticklen.py deleted file mode 100644 index 0f44b342953..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_tickmode.py b/plotly/validators/histogram/marker/colorbar/_tickmode.py deleted file mode 100644 index 5aa7d7afb52..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_tickprefix.py b/plotly/validators/histogram/marker/colorbar/_tickprefix.py deleted file mode 100644 index 950d851969d..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_ticks.py b/plotly/validators/histogram/marker/colorbar/_ticks.py deleted file mode 100644 index 036a29be04a..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_ticksuffix.py b/plotly/validators/histogram/marker/colorbar/_ticksuffix.py deleted file mode 100644 index d4367424968..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_ticktext.py b/plotly/validators/histogram/marker/colorbar/_ticktext.py deleted file mode 100644 index 2795c660a1d..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_ticktextsrc.py b/plotly/validators/histogram/marker/colorbar/_ticktextsrc.py deleted file mode 100644 index 8383116c6b5..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_tickvals.py b/plotly/validators/histogram/marker/colorbar/_tickvals.py deleted file mode 100644 index e948b638450..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_tickvalssrc.py b/plotly/validators/histogram/marker/colorbar/_tickvalssrc.py deleted file mode 100644 index 3c22f31fec2..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_tickwidth.py b/plotly/validators/histogram/marker/colorbar/_tickwidth.py deleted file mode 100644 index 004e6df1033..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_title.py b/plotly/validators/histogram/marker/colorbar/_title.py deleted file mode 100644 index 5f6003f68ad..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_x.py b/plotly/validators/histogram/marker/colorbar/_x.py deleted file mode 100644 index 47651e5a0e8..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_x.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='x', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_xanchor.py b/plotly/validators/histogram/marker/colorbar/_xanchor.py deleted file mode 100644 index d0d2d0e710b..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_xpad.py b/plotly/validators/histogram/marker/colorbar/_xpad.py deleted file mode 100644 index fb426bc3430..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_xpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xpad', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_y.py b/plotly/validators/histogram/marker/colorbar/_y.py deleted file mode 100644 index 508d7f32d8b..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_y.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='y', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_yanchor.py b/plotly/validators/histogram/marker/colorbar/_yanchor.py deleted file mode 100644 index 7bbe559056f..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/_ypad.py b/plotly/validators/histogram/marker/colorbar/_ypad.py deleted file mode 100644 index c8adb68e8a3..00000000000 --- a/plotly/validators/histogram/marker/colorbar/_ypad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ypad', - parent_name='histogram.marker.colorbar', - **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/tickfont/__init__.py b/plotly/validators/histogram/marker/colorbar/tickfont/__init__.py index 199d72e71c6..9cc440e9216 100644 --- a/plotly/validators/histogram/marker/colorbar/tickfont/__init__.py +++ b/plotly/validators/histogram/marker/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='histogram.marker.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='histogram.marker.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram.marker.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram/marker/colorbar/tickfont/_color.py b/plotly/validators/histogram/marker/colorbar/tickfont/_color.py deleted file mode 100644 index 859943b090c..00000000000 --- a/plotly/validators/histogram/marker/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram.marker.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/tickfont/_family.py b/plotly/validators/histogram/marker/colorbar/tickfont/_family.py deleted file mode 100644 index dbb9c75a394..00000000000 --- a/plotly/validators/histogram/marker/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='histogram.marker.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/tickfont/_size.py b/plotly/validators/histogram/marker/colorbar/tickfont/_size.py deleted file mode 100644 index 3b17a242217..00000000000 --- a/plotly/validators/histogram/marker/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='histogram.marker.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/tickformatstop/__init__.py b/plotly/validators/histogram/marker/colorbar/tickformatstop/__init__.py index 3f6c06cac47..7d4c17feeb4 100644 --- a/plotly/validators/histogram/marker/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/histogram/marker/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='histogram.marker.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='histogram.marker.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='histogram.marker.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='histogram.marker.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='histogram.marker.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/histogram/marker/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/histogram/marker/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 83034f32a94..00000000000 --- a/plotly/validators/histogram/marker/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='histogram.marker.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/tickformatstop/_enabled.py b/plotly/validators/histogram/marker/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index 6651458e14e..00000000000 --- a/plotly/validators/histogram/marker/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='histogram.marker.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/tickformatstop/_name.py b/plotly/validators/histogram/marker/colorbar/tickformatstop/_name.py deleted file mode 100644 index f174dd75696..00000000000 --- a/plotly/validators/histogram/marker/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='histogram.marker.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/histogram/marker/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 6fcceb21056..00000000000 --- a/plotly/validators/histogram/marker/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='histogram.marker.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/tickformatstop/_value.py b/plotly/validators/histogram/marker/colorbar/tickformatstop/_value.py deleted file mode 100644 index 903bde48860..00000000000 --- a/plotly/validators/histogram/marker/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='histogram.marker.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/title/__init__.py b/plotly/validators/histogram/marker/colorbar/title/__init__.py index 33c9c145bb8..5f52821c1f0 100644 --- a/plotly/validators/histogram/marker/colorbar/title/__init__.py +++ b/plotly/validators/histogram/marker/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='histogram.marker.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='histogram.marker.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='histogram.marker.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/histogram/marker/colorbar/title/_font.py b/plotly/validators/histogram/marker/colorbar/title/_font.py deleted file mode 100644 index ba86cd5b73e..00000000000 --- a/plotly/validators/histogram/marker/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='histogram.marker.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/title/_side.py b/plotly/validators/histogram/marker/colorbar/title/_side.py deleted file mode 100644 index 05dec0bf785..00000000000 --- a/plotly/validators/histogram/marker/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='histogram.marker.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/title/_text.py b/plotly/validators/histogram/marker/colorbar/title/_text.py deleted file mode 100644 index 1c1f6f75bb7..00000000000 --- a/plotly/validators/histogram/marker/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='histogram.marker.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/title/font/__init__.py b/plotly/validators/histogram/marker/colorbar/title/font/__init__.py index 199d72e71c6..3c2e579d6f8 100644 --- a/plotly/validators/histogram/marker/colorbar/title/font/__init__.py +++ b/plotly/validators/histogram/marker/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='histogram.marker.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='histogram.marker.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram.marker.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram/marker/colorbar/title/font/_color.py b/plotly/validators/histogram/marker/colorbar/title/font/_color.py deleted file mode 100644 index a968d619fab..00000000000 --- a/plotly/validators/histogram/marker/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram.marker.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/title/font/_family.py b/plotly/validators/histogram/marker/colorbar/title/font/_family.py deleted file mode 100644 index ca7f2583e16..00000000000 --- a/plotly/validators/histogram/marker/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='histogram.marker.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/colorbar/title/font/_size.py b/plotly/validators/histogram/marker/colorbar/title/font/_size.py deleted file mode 100644 index b732818c7ee..00000000000 --- a/plotly/validators/histogram/marker/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='histogram.marker.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/line/__init__.py b/plotly/validators/histogram/marker/line/__init__.py index c031ca61ce2..f97ec77ab9f 100644 --- a/plotly/validators/histogram/marker/line/__init__.py +++ b/plotly/validators/histogram/marker/line/__init__.py @@ -1,11 +1,235 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._reversescale import ReversescaleValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='widthsrc', + parent_name='histogram.marker.line', + **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='histogram.marker.line', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='histogram.marker.line', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='histogram.marker.line', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='histogram.marker.line', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram.marker.line', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'histogram.marker.line.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmin', + parent_name='histogram.marker.line', + **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmid', + parent_name='histogram.marker.line', + **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmax', + parent_name='histogram.marker.line', + **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='cauto', + parent_name='histogram.marker.line', + **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='histogram.marker.line', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram/marker/line/_autocolorscale.py b/plotly/validators/histogram/marker/line/_autocolorscale.py deleted file mode 100644 index b422bf3fd06..00000000000 --- a/plotly/validators/histogram/marker/line/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='histogram.marker.line', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/line/_cauto.py b/plotly/validators/histogram/marker/line/_cauto.py deleted file mode 100644 index 88eb8fee02c..00000000000 --- a/plotly/validators/histogram/marker/line/_cauto.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='cauto', - parent_name='histogram.marker.line', - **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/line/_cmax.py b/plotly/validators/histogram/marker/line/_cmax.py deleted file mode 100644 index d449bcb98a0..00000000000 --- a/plotly/validators/histogram/marker/line/_cmax.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmax', - parent_name='histogram.marker.line', - **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/line/_cmid.py b/plotly/validators/histogram/marker/line/_cmid.py deleted file mode 100644 index 4899eec707b..00000000000 --- a/plotly/validators/histogram/marker/line/_cmid.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmid', - parent_name='histogram.marker.line', - **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/line/_cmin.py b/plotly/validators/histogram/marker/line/_cmin.py deleted file mode 100644 index d3700a772d4..00000000000 --- a/plotly/validators/histogram/marker/line/_cmin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmin', - parent_name='histogram.marker.line', - **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/line/_color.py b/plotly/validators/histogram/marker/line/_color.py deleted file mode 100644 index de7eb4a7d51..00000000000 --- a/plotly/validators/histogram/marker/line/_color.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram.marker.line', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'histogram.marker.line.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/line/_colorscale.py b/plotly/validators/histogram/marker/line/_colorscale.py deleted file mode 100644 index 793d45cfc33..00000000000 --- a/plotly/validators/histogram/marker/line/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='histogram.marker.line', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/line/_colorsrc.py b/plotly/validators/histogram/marker/line/_colorsrc.py deleted file mode 100644 index d3ab7e83a26..00000000000 --- a/plotly/validators/histogram/marker/line/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='histogram.marker.line', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/line/_reversescale.py b/plotly/validators/histogram/marker/line/_reversescale.py deleted file mode 100644 index 794846e46e6..00000000000 --- a/plotly/validators/histogram/marker/line/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='histogram.marker.line', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/line/_width.py b/plotly/validators/histogram/marker/line/_width.py deleted file mode 100644 index 11e17a0171c..00000000000 --- a/plotly/validators/histogram/marker/line/_width.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='histogram.marker.line', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/marker/line/_widthsrc.py b/plotly/validators/histogram/marker/line/_widthsrc.py deleted file mode 100644 index 9e2b34117cd..00000000000 --- a/plotly/validators/histogram/marker/line/_widthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='widthsrc', - parent_name='histogram.marker.line', - **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/selected/__init__.py b/plotly/validators/histogram/selected/__init__.py index f1a1ef3742f..825251500fa 100644 --- a/plotly/validators/histogram/selected/__init__.py +++ b/plotly/validators/histogram/selected/__init__.py @@ -1,2 +1,49 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='histogram.selected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of selected points. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='histogram.selected', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. +""" + ), + **kwargs + ) diff --git a/plotly/validators/histogram/selected/_marker.py b/plotly/validators/histogram/selected/_marker.py deleted file mode 100644 index f4ad8a4c5e8..00000000000 --- a/plotly/validators/histogram/selected/_marker.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='histogram.selected', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/selected/_textfont.py b/plotly/validators/histogram/selected/_textfont.py deleted file mode 100644 index 0b8d0165e67..00000000000 --- a/plotly/validators/histogram/selected/_textfont.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='histogram.selected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/selected/marker/__init__.py b/plotly/validators/histogram/selected/marker/__init__.py index 990c554a22a..c9a2c33880a 100644 --- a/plotly/validators/histogram/selected/marker/__init__.py +++ b/plotly/validators/histogram/selected/marker/__init__.py @@ -1,2 +1,42 @@ -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='histogram.selected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram.selected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram/selected/marker/_color.py b/plotly/validators/histogram/selected/marker/_color.py deleted file mode 100644 index d0a19d79a5d..00000000000 --- a/plotly/validators/histogram/selected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram.selected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/selected/marker/_opacity.py b/plotly/validators/histogram/selected/marker/_opacity.py deleted file mode 100644 index dc97e56f82c..00000000000 --- a/plotly/validators/histogram/selected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='histogram.selected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/selected/textfont/__init__.py b/plotly/validators/histogram/selected/textfont/__init__.py index 74135b3f315..2663b6dc17f 100644 --- a/plotly/validators/histogram/selected/textfont/__init__.py +++ b/plotly/validators/histogram/selected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram.selected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram/selected/textfont/_color.py b/plotly/validators/histogram/selected/textfont/_color.py deleted file mode 100644 index 981d93c3cdb..00000000000 --- a/plotly/validators/histogram/selected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram.selected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/stream/__init__.py b/plotly/validators/histogram/stream/__init__.py index 2f4f2047594..610e447fbf8 100644 --- a/plotly/validators/histogram/stream/__init__.py +++ b/plotly/validators/histogram/stream/__init__.py @@ -1,2 +1,41 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='histogram.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='histogram.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/histogram/stream/_maxpoints.py b/plotly/validators/histogram/stream/_maxpoints.py deleted file mode 100644 index 24269180e02..00000000000 --- a/plotly/validators/histogram/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='histogram.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram/stream/_token.py b/plotly/validators/histogram/stream/_token.py deleted file mode 100644 index f6a6a90c4ee..00000000000 --- a/plotly/validators/histogram/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='histogram.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/histogram/unselected/__init__.py b/plotly/validators/histogram/unselected/__init__.py index f1a1ef3742f..8bc0354b059 100644 --- a/plotly/validators/histogram/unselected/__init__.py +++ b/plotly/validators/histogram/unselected/__init__.py @@ -1,2 +1,55 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='histogram.unselected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='histogram.unselected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of unselected points, + applied only when a selection exists. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) diff --git a/plotly/validators/histogram/unselected/_marker.py b/plotly/validators/histogram/unselected/_marker.py deleted file mode 100644 index 7e70a992aa1..00000000000 --- a/plotly/validators/histogram/unselected/_marker.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='histogram.unselected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of unselected points, - applied only when a selection exists. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/unselected/_textfont.py b/plotly/validators/histogram/unselected/_textfont.py deleted file mode 100644 index c3e75ccc844..00000000000 --- a/plotly/validators/histogram/unselected/_textfont.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='histogram.unselected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram/unselected/marker/__init__.py b/plotly/validators/histogram/unselected/marker/__init__.py index 990c554a22a..715372cde2d 100644 --- a/plotly/validators/histogram/unselected/marker/__init__.py +++ b/plotly/validators/histogram/unselected/marker/__init__.py @@ -1,2 +1,42 @@ -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='histogram.unselected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram.unselected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram/unselected/marker/_color.py b/plotly/validators/histogram/unselected/marker/_color.py deleted file mode 100644 index e6eac5a827a..00000000000 --- a/plotly/validators/histogram/unselected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram.unselected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/unselected/marker/_opacity.py b/plotly/validators/histogram/unselected/marker/_opacity.py deleted file mode 100644 index ca3efb665c6..00000000000 --- a/plotly/validators/histogram/unselected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='histogram.unselected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/unselected/textfont/__init__.py b/plotly/validators/histogram/unselected/textfont/__init__.py index 74135b3f315..033511501e6 100644 --- a/plotly/validators/histogram/unselected/textfont/__init__.py +++ b/plotly/validators/histogram/unselected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram.unselected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram/unselected/textfont/_color.py b/plotly/validators/histogram/unselected/textfont/_color.py deleted file mode 100644 index 62ff69db3db..00000000000 --- a/plotly/validators/histogram/unselected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram.unselected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/xbins/__init__.py b/plotly/validators/histogram/xbins/__init__.py index 06f4b8ab6a6..d70679f90ea 100644 --- a/plotly/validators/histogram/xbins/__init__.py +++ b/plotly/validators/histogram/xbins/__init__.py @@ -1,3 +1,51 @@ -from ._start import StartValidator -from ._size import SizeValidator -from ._end import EndValidator + + +import _plotly_utils.basevalidators + + +class StartValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='start', parent_name='histogram.xbins', **kwargs + ): + super(StartValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='size', parent_name='histogram.xbins', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='end', parent_name='histogram.xbins', **kwargs + ): + super(EndValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram/xbins/_end.py b/plotly/validators/histogram/xbins/_end.py deleted file mode 100644 index ee35eead1df..00000000000 --- a/plotly/validators/histogram/xbins/_end.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='end', parent_name='histogram.xbins', **kwargs - ): - super(EndValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/xbins/_size.py b/plotly/validators/histogram/xbins/_size.py deleted file mode 100644 index aaf0cbd83c3..00000000000 --- a/plotly/validators/histogram/xbins/_size.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='size', parent_name='histogram.xbins', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/xbins/_start.py b/plotly/validators/histogram/xbins/_start.py deleted file mode 100644 index e3673b8c127..00000000000 --- a/plotly/validators/histogram/xbins/_start.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='start', parent_name='histogram.xbins', **kwargs - ): - super(StartValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/ybins/__init__.py b/plotly/validators/histogram/ybins/__init__.py index 06f4b8ab6a6..d4247e5772b 100644 --- a/plotly/validators/histogram/ybins/__init__.py +++ b/plotly/validators/histogram/ybins/__init__.py @@ -1,3 +1,51 @@ -from ._start import StartValidator -from ._size import SizeValidator -from ._end import EndValidator + + +import _plotly_utils.basevalidators + + +class StartValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='start', parent_name='histogram.ybins', **kwargs + ): + super(StartValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='size', parent_name='histogram.ybins', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='end', parent_name='histogram.ybins', **kwargs + ): + super(EndValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram/ybins/_end.py b/plotly/validators/histogram/ybins/_end.py deleted file mode 100644 index a68d041b17f..00000000000 --- a/plotly/validators/histogram/ybins/_end.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='end', parent_name='histogram.ybins', **kwargs - ): - super(EndValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/ybins/_size.py b/plotly/validators/histogram/ybins/_size.py deleted file mode 100644 index 9d8eb7f504e..00000000000 --- a/plotly/validators/histogram/ybins/_size.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='size', parent_name='histogram.ybins', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram/ybins/_start.py b/plotly/validators/histogram/ybins/_start.py deleted file mode 100644 index 0abd0ec8603..00000000000 --- a/plotly/validators/histogram/ybins/_start.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='start', parent_name='histogram.ybins', **kwargs - ): - super(StartValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/__init__.py b/plotly/validators/histogram2d/__init__.py index d2d840cadfc..918e35f4468 100644 --- a/plotly/validators/histogram2d/__init__.py +++ b/plotly/validators/histogram2d/__init__.py @@ -1,50 +1,1232 @@ -from ._zsrc import ZsrcValidator -from ._zsmooth import ZsmoothValidator -from ._zmin import ZminValidator -from ._zmid import ZmidValidator -from ._zmax import ZmaxValidator -from ._zhoverformat import ZhoverformatValidator -from ._zauto import ZautoValidator -from ._z import ZValidator -from ._ysrc import YsrcValidator -from ._ygap import YgapValidator -from ._ycalendar import YcalendarValidator -from ._ybins import YBinsValidator -from ._yaxis import YAxisValidator -from ._y import YValidator -from ._xsrc import XsrcValidator -from ._xgap import XgapValidator -from ._xcalendar import XcalendarValidator -from ._xbins import XBinsValidator -from ._xaxis import XAxisValidator -from ._x import XValidator -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._stream import StreamValidator -from ._showscale import ShowscaleValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._reversescale import ReversescaleValidator -from ._opacity import OpacityValidator -from ._nbinsy import NbinsyValidator -from ._nbinsx import NbinsxValidator -from ._name import NameValidator -from ._marker import MarkerValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._histnorm import HistnormValidator -from ._histfunc import HistfuncValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._autocolorscale import AutocolorscaleValidator -from ._autobiny import AutobinyValidator -from ._autobinx import AutobinxValidator + + +import _plotly_utils.basevalidators + + +class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='zsrc', parent_name='histogram2d', **kwargs + ): + super(ZsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZsmoothValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='zsmooth', parent_name='histogram2d', **kwargs + ): + super(ZsmoothValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fast', 'best', False]), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='zmin', parent_name='histogram2d', **kwargs + ): + super(ZminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'zauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='zmid', parent_name='histogram2d', **kwargs + ): + super(ZmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='zmax', parent_name='histogram2d', **kwargs + ): + super(ZmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'zauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZhoverformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='zhoverformat', parent_name='histogram2d', **kwargs + ): + super(ZhoverformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='zauto', parent_name='histogram2d', **kwargs + ): + super(ZautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='z', parent_name='histogram2d', **kwargs): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='ysrc', parent_name='histogram2d', **kwargs + ): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YgapValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ygap', parent_name='histogram2d', **kwargs + ): + super(YgapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ycalendar', parent_name='histogram2d', **kwargs + ): + super(YcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YBinsValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='ybins', parent_name='histogram2d', **kwargs + ): + super(YBinsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'YBins'), + data_docs=kwargs.pop( + 'data_docs', """ + end + Sets the end value for the y axis bins. The + last bin may not end exactly at this value, we + increment the bin edge by `size` from `start` + until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use + a date string, and for category data `end` is + based on the category serial numbers. + size + Sets the size of each y axis bin. Default + behavior: If `nbinsy` is 0 or omitted, we + choose a nice round bin size such that the + number of bins is about the same as the typical + number of samples in each bin. If `nbinsy` is + provided, we choose a nice round bin size + giving no more than that many bins. For date + data, use milliseconds or "M" for months, as + in `axis.dtick`. For category data, the number + of categories to bin together (always defaults + to 1). + start + Sets the starting value for the y axis bins. + Defaults to the minimum data value, shifted + down if necessary to make nice round values and + to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin + edges 0.5 down, so a `size` of 5 would have a + default `start` of -0.5, so it is clear that + 0-4 are in the first bin, 5-9 in the second, + but continuous data gets a start of 0 and bins + [0,5), [5,10) etc. Dates behave similarly, and + `start` should be a date string. For category + data, `start` is based on the category serial + numbers, and defaults to -0.5. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='yaxis', parent_name='histogram2d', **kwargs + ): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='histogram2d', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='xsrc', parent_name='histogram2d', **kwargs + ): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XgapValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='xgap', parent_name='histogram2d', **kwargs + ): + super(XgapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xcalendar', parent_name='histogram2d', **kwargs + ): + super(XcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XBinsValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='xbins', parent_name='histogram2d', **kwargs + ): + super(XBinsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'XBins'), + data_docs=kwargs.pop( + 'data_docs', """ + end + Sets the end value for the x axis bins. The + last bin may not end exactly at this value, we + increment the bin edge by `size` from `start` + until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use + a date string, and for category data `end` is + based on the category serial numbers. + size + Sets the size of each x axis bin. Default + behavior: If `nbinsx` is 0 or omitted, we + choose a nice round bin size such that the + number of bins is about the same as the typical + number of samples in each bin. If `nbinsx` is + provided, we choose a nice round bin size + giving no more than that many bins. For date + data, use milliseconds or "M" for months, as + in `axis.dtick`. For category data, the number + of categories to bin together (always defaults + to 1). + start + Sets the starting value for the x axis bins. + Defaults to the minimum data value, shifted + down if necessary to make nice round values and + to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin + edges 0.5 down, so a `size` of 5 would have a + default `start` of -0.5, so it is clear that + 0-4 are in the first bin, 5-9 in the second, + but continuous data gets a start of 0 and bins + [0,5), [5,10) etc. Dates behave similarly, and + `start` should be a date string. For category + data, `start` is based on the category serial + numbers, and defaults to -0.5. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='xaxis', parent_name='histogram2d', **kwargs + ): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='histogram2d', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='histogram2d', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='histogram2d', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='histogram2d', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='histogram2d', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='histogram2d', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='histogram2d', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='selectedpoints', + parent_name='histogram2d', + **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='reversescale', parent_name='histogram2d', **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='histogram2d', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NbinsyValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nbinsy', parent_name='histogram2d', **kwargs + ): + super(NbinsyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NbinsxValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nbinsx', parent_name='histogram2d', **kwargs + ): + super(NbinsxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='histogram2d', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='histogram2d', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the aggregation data. + colorsrc + Sets the source reference on plot.ly for color + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='histogram2d', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='histogram2d', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='histogram2d', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertemplatesrc', + parent_name='histogram2d', + **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='histogram2d', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='histogram2d', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='histogram2d', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='histogram2d', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HistnormValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='histnorm', parent_name='histogram2d', **kwargs + ): + super(HistnormValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + '', 'percent', 'probability', 'density', + 'probability density' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HistfuncValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='histfunc', parent_name='histogram2d', **kwargs + ): + super(HistfuncValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['count', 'sum', 'avg', 'min', 'max']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='histogram2d', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='histogram2d', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='histogram2d', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='histogram2d', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.histogram2d.colorbar.Tickform + atstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.histogram2d.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of + histogram2d.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.histogram2d.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + histogram2d.colorbar.title.font instead. Sets + this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + histogram2d.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='histogram2d', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutobinyValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autobiny', parent_name='histogram2d', **kwargs + ): + super(AutobinyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutobinxValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autobinx', parent_name='histogram2d', **kwargs + ): + super(AutobinxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2d/_autobinx.py b/plotly/validators/histogram2d/_autobinx.py deleted file mode 100644 index dfaf619e872..00000000000 --- a/plotly/validators/histogram2d/_autobinx.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutobinxValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autobinx', parent_name='histogram2d', **kwargs - ): - super(AutobinxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_autobiny.py b/plotly/validators/histogram2d/_autobiny.py deleted file mode 100644 index eef9821dc8c..00000000000 --- a/plotly/validators/histogram2d/_autobiny.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutobinyValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autobiny', parent_name='histogram2d', **kwargs - ): - super(AutobinyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_autocolorscale.py b/plotly/validators/histogram2d/_autocolorscale.py deleted file mode 100644 index 500ccf4c432..00000000000 --- a/plotly/validators/histogram2d/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='histogram2d', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_colorbar.py b/plotly/validators/histogram2d/_colorbar.py deleted file mode 100644 index 861987140a3..00000000000 --- a/plotly/validators/histogram2d/_colorbar.py +++ /dev/null @@ -1,228 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='histogram2d', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.histogram2d.colorbar.Tickform - atstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.histogram2d.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of - histogram2d.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.histogram2d.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - histogram2d.colorbar.title.font instead. Sets - this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - histogram2d.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_colorscale.py b/plotly/validators/histogram2d/_colorscale.py deleted file mode 100644 index 13b5b6bab56..00000000000 --- a/plotly/validators/histogram2d/_colorscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='histogram2d', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_customdata.py b/plotly/validators/histogram2d/_customdata.py deleted file mode 100644 index 1603f88b340..00000000000 --- a/plotly/validators/histogram2d/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='histogram2d', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_customdatasrc.py b/plotly/validators/histogram2d/_customdatasrc.py deleted file mode 100644 index e32541612bb..00000000000 --- a/plotly/validators/histogram2d/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='histogram2d', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_histfunc.py b/plotly/validators/histogram2d/_histfunc.py deleted file mode 100644 index cf160572d1a..00000000000 --- a/plotly/validators/histogram2d/_histfunc.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HistfuncValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='histfunc', parent_name='histogram2d', **kwargs - ): - super(HistfuncValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['count', 'sum', 'avg', 'min', 'max']), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_histnorm.py b/plotly/validators/histogram2d/_histnorm.py deleted file mode 100644 index 9a33ad51fa4..00000000000 --- a/plotly/validators/histogram2d/_histnorm.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class HistnormValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='histnorm', parent_name='histogram2d', **kwargs - ): - super(HistnormValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - '', 'percent', 'probability', 'density', - 'probability density' - ] - ), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_hoverinfo.py b/plotly/validators/histogram2d/_hoverinfo.py deleted file mode 100644 index 6fc3760997f..00000000000 --- a/plotly/validators/histogram2d/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='histogram2d', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_hoverinfosrc.py b/plotly/validators/histogram2d/_hoverinfosrc.py deleted file mode 100644 index 5fe537fe510..00000000000 --- a/plotly/validators/histogram2d/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='histogram2d', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_hoverlabel.py b/plotly/validators/histogram2d/_hoverlabel.py deleted file mode 100644 index f6c0258a498..00000000000 --- a/plotly/validators/histogram2d/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='histogram2d', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_hovertemplate.py b/plotly/validators/histogram2d/_hovertemplate.py deleted file mode 100644 index 66f51f012f6..00000000000 --- a/plotly/validators/histogram2d/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='histogram2d', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_hovertemplatesrc.py b/plotly/validators/histogram2d/_hovertemplatesrc.py deleted file mode 100644 index 1781fed0499..00000000000 --- a/plotly/validators/histogram2d/_hovertemplatesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertemplatesrc', - parent_name='histogram2d', - **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_ids.py b/plotly/validators/histogram2d/_ids.py deleted file mode 100644 index 82e70eff497..00000000000 --- a/plotly/validators/histogram2d/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='histogram2d', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_idssrc.py b/plotly/validators/histogram2d/_idssrc.py deleted file mode 100644 index b36b928f3a9..00000000000 --- a/plotly/validators/histogram2d/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='histogram2d', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_legendgroup.py b/plotly/validators/histogram2d/_legendgroup.py deleted file mode 100644 index 00bd407aad2..00000000000 --- a/plotly/validators/histogram2d/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='histogram2d', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_marker.py b/plotly/validators/histogram2d/_marker.py deleted file mode 100644 index 9a82ab3c67d..00000000000 --- a/plotly/validators/histogram2d/_marker.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='histogram2d', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the aggregation data. - colorsrc - Sets the source reference on plot.ly for color - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_name.py b/plotly/validators/histogram2d/_name.py deleted file mode 100644 index a22dc0f2297..00000000000 --- a/plotly/validators/histogram2d/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='histogram2d', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_nbinsx.py b/plotly/validators/histogram2d/_nbinsx.py deleted file mode 100644 index afaa923df63..00000000000 --- a/plotly/validators/histogram2d/_nbinsx.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NbinsxValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nbinsx', parent_name='histogram2d', **kwargs - ): - super(NbinsxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_nbinsy.py b/plotly/validators/histogram2d/_nbinsy.py deleted file mode 100644 index 30ecd63314a..00000000000 --- a/plotly/validators/histogram2d/_nbinsy.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NbinsyValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nbinsy', parent_name='histogram2d', **kwargs - ): - super(NbinsyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_opacity.py b/plotly/validators/histogram2d/_opacity.py deleted file mode 100644 index e4cc5de0d1f..00000000000 --- a/plotly/validators/histogram2d/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='histogram2d', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_reversescale.py b/plotly/validators/histogram2d/_reversescale.py deleted file mode 100644 index 3325d7fc7f3..00000000000 --- a/plotly/validators/histogram2d/_reversescale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='reversescale', parent_name='histogram2d', **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_selectedpoints.py b/plotly/validators/histogram2d/_selectedpoints.py deleted file mode 100644 index dfd2409bf92..00000000000 --- a/plotly/validators/histogram2d/_selectedpoints.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='selectedpoints', - parent_name='histogram2d', - **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_showlegend.py b/plotly/validators/histogram2d/_showlegend.py deleted file mode 100644 index 8287a88e543..00000000000 --- a/plotly/validators/histogram2d/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='histogram2d', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_showscale.py b/plotly/validators/histogram2d/_showscale.py deleted file mode 100644 index 22e834e8a44..00000000000 --- a/plotly/validators/histogram2d/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='histogram2d', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_stream.py b/plotly/validators/histogram2d/_stream.py deleted file mode 100644 index f56e2133afe..00000000000 --- a/plotly/validators/histogram2d/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='histogram2d', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_uid.py b/plotly/validators/histogram2d/_uid.py deleted file mode 100644 index bd8a53b7204..00000000000 --- a/plotly/validators/histogram2d/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='histogram2d', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_uirevision.py b/plotly/validators/histogram2d/_uirevision.py deleted file mode 100644 index 6b924105f1d..00000000000 --- a/plotly/validators/histogram2d/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='histogram2d', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_visible.py b/plotly/validators/histogram2d/_visible.py deleted file mode 100644 index 663994f5382..00000000000 --- a/plotly/validators/histogram2d/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='histogram2d', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_x.py b/plotly/validators/histogram2d/_x.py deleted file mode 100644 index adb4ef3ad24..00000000000 --- a/plotly/validators/histogram2d/_x.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='histogram2d', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_xaxis.py b/plotly/validators/histogram2d/_xaxis.py deleted file mode 100644 index ab5d6a05c84..00000000000 --- a/plotly/validators/histogram2d/_xaxis.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='xaxis', parent_name='histogram2d', **kwargs - ): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_xbins.py b/plotly/validators/histogram2d/_xbins.py deleted file mode 100644 index f2da8963b5a..00000000000 --- a/plotly/validators/histogram2d/_xbins.py +++ /dev/null @@ -1,52 +0,0 @@ -import _plotly_utils.basevalidators - - -class XBinsValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='xbins', parent_name='histogram2d', **kwargs - ): - super(XBinsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'XBins'), - data_docs=kwargs.pop( - 'data_docs', """ - end - Sets the end value for the x axis bins. The - last bin may not end exactly at this value, we - increment the bin edge by `size` from `start` - until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use - a date string, and for category data `end` is - based on the category serial numbers. - size - Sets the size of each x axis bin. Default - behavior: If `nbinsx` is 0 or omitted, we - choose a nice round bin size such that the - number of bins is about the same as the typical - number of samples in each bin. If `nbinsx` is - provided, we choose a nice round bin size - giving no more than that many bins. For date - data, use milliseconds or "M" for months, as - in `axis.dtick`. For category data, the number - of categories to bin together (always defaults - to 1). - start - Sets the starting value for the x axis bins. - Defaults to the minimum data value, shifted - down if necessary to make nice round values and - to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin - edges 0.5 down, so a `size` of 5 would have a - default `start` of -0.5, so it is clear that - 0-4 are in the first bin, 5-9 in the second, - but continuous data gets a start of 0 and bins - [0,5), [5,10) etc. Dates behave similarly, and - `start` should be a date string. For category - data, `start` is based on the category serial - numbers, and defaults to -0.5. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_xcalendar.py b/plotly/validators/histogram2d/_xcalendar.py deleted file mode 100644 index a3c0aadbdd5..00000000000 --- a/plotly/validators/histogram2d/_xcalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xcalendar', parent_name='histogram2d', **kwargs - ): - super(XcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_xgap.py b/plotly/validators/histogram2d/_xgap.py deleted file mode 100644 index a2fa45d49b2..00000000000 --- a/plotly/validators/histogram2d/_xgap.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XgapValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='xgap', parent_name='histogram2d', **kwargs - ): - super(XgapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_xsrc.py b/plotly/validators/histogram2d/_xsrc.py deleted file mode 100644 index 6c98858d209..00000000000 --- a/plotly/validators/histogram2d/_xsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='xsrc', parent_name='histogram2d', **kwargs - ): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_y.py b/plotly/validators/histogram2d/_y.py deleted file mode 100644 index e4f37e8c64c..00000000000 --- a/plotly/validators/histogram2d/_y.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='histogram2d', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_yaxis.py b/plotly/validators/histogram2d/_yaxis.py deleted file mode 100644 index d612b9b3b2c..00000000000 --- a/plotly/validators/histogram2d/_yaxis.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='yaxis', parent_name='histogram2d', **kwargs - ): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_ybins.py b/plotly/validators/histogram2d/_ybins.py deleted file mode 100644 index 5fb8371f016..00000000000 --- a/plotly/validators/histogram2d/_ybins.py +++ /dev/null @@ -1,52 +0,0 @@ -import _plotly_utils.basevalidators - - -class YBinsValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='ybins', parent_name='histogram2d', **kwargs - ): - super(YBinsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'YBins'), - data_docs=kwargs.pop( - 'data_docs', """ - end - Sets the end value for the y axis bins. The - last bin may not end exactly at this value, we - increment the bin edge by `size` from `start` - until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use - a date string, and for category data `end` is - based on the category serial numbers. - size - Sets the size of each y axis bin. Default - behavior: If `nbinsy` is 0 or omitted, we - choose a nice round bin size such that the - number of bins is about the same as the typical - number of samples in each bin. If `nbinsy` is - provided, we choose a nice round bin size - giving no more than that many bins. For date - data, use milliseconds or "M" for months, as - in `axis.dtick`. For category data, the number - of categories to bin together (always defaults - to 1). - start - Sets the starting value for the y axis bins. - Defaults to the minimum data value, shifted - down if necessary to make nice round values and - to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin - edges 0.5 down, so a `size` of 5 would have a - default `start` of -0.5, so it is clear that - 0-4 are in the first bin, 5-9 in the second, - but continuous data gets a start of 0 and bins - [0,5), [5,10) etc. Dates behave similarly, and - `start` should be a date string. For category - data, `start` is based on the category serial - numbers, and defaults to -0.5. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_ycalendar.py b/plotly/validators/histogram2d/_ycalendar.py deleted file mode 100644 index a0ef830fbf9..00000000000 --- a/plotly/validators/histogram2d/_ycalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ycalendar', parent_name='histogram2d', **kwargs - ): - super(YcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_ygap.py b/plotly/validators/histogram2d/_ygap.py deleted file mode 100644 index 7702a69f47a..00000000000 --- a/plotly/validators/histogram2d/_ygap.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YgapValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ygap', parent_name='histogram2d', **kwargs - ): - super(YgapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_ysrc.py b/plotly/validators/histogram2d/_ysrc.py deleted file mode 100644 index 428b97f1150..00000000000 --- a/plotly/validators/histogram2d/_ysrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='ysrc', parent_name='histogram2d', **kwargs - ): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_z.py b/plotly/validators/histogram2d/_z.py deleted file mode 100644 index e235a5df855..00000000000 --- a/plotly/validators/histogram2d/_z.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='z', parent_name='histogram2d', **kwargs): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_zauto.py b/plotly/validators/histogram2d/_zauto.py deleted file mode 100644 index 9cedcc8183b..00000000000 --- a/plotly/validators/histogram2d/_zauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='zauto', parent_name='histogram2d', **kwargs - ): - super(ZautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_zhoverformat.py b/plotly/validators/histogram2d/_zhoverformat.py deleted file mode 100644 index 60ecacb0807..00000000000 --- a/plotly/validators/histogram2d/_zhoverformat.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZhoverformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='zhoverformat', parent_name='histogram2d', **kwargs - ): - super(ZhoverformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_zmax.py b/plotly/validators/histogram2d/_zmax.py deleted file mode 100644 index 35c0280f150..00000000000 --- a/plotly/validators/histogram2d/_zmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='zmax', parent_name='histogram2d', **kwargs - ): - super(ZmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'zauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_zmid.py b/plotly/validators/histogram2d/_zmid.py deleted file mode 100644 index a6b35875e5f..00000000000 --- a/plotly/validators/histogram2d/_zmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='zmid', parent_name='histogram2d', **kwargs - ): - super(ZmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_zmin.py b/plotly/validators/histogram2d/_zmin.py deleted file mode 100644 index 2bafb3e2b45..00000000000 --- a/plotly/validators/histogram2d/_zmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='zmin', parent_name='histogram2d', **kwargs - ): - super(ZminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'zauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_zsmooth.py b/plotly/validators/histogram2d/_zsmooth.py deleted file mode 100644 index 188743c1cb6..00000000000 --- a/plotly/validators/histogram2d/_zsmooth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZsmoothValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='zsmooth', parent_name='histogram2d', **kwargs - ): - super(ZsmoothValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fast', 'best', False]), - **kwargs - ) diff --git a/plotly/validators/histogram2d/_zsrc.py b/plotly/validators/histogram2d/_zsrc.py deleted file mode 100644 index bddb341d223..00000000000 --- a/plotly/validators/histogram2d/_zsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='zsrc', parent_name='histogram2d', **kwargs - ): - super(ZsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/__init__.py b/plotly/validators/histogram2d/colorbar/__init__.py index 3dab31f7e02..be64ddd2711 100644 --- a/plotly/validators/histogram2d/colorbar/__init__.py +++ b/plotly/validators/histogram2d/colorbar/__init__.py @@ -1,41 +1,921 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ypad', parent_name='histogram2d.colorbar', **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='histogram2d.colorbar', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='xpad', parent_name='histogram2d.colorbar', **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='histogram2d.colorbar', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='len', parent_name='histogram2d.colorbar', **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='histogram2d.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2d/colorbar/_bgcolor.py b/plotly/validators/histogram2d/colorbar/_bgcolor.py deleted file mode 100644 index c18989b5597..00000000000 --- a/plotly/validators/histogram2d/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_bordercolor.py b/plotly/validators/histogram2d/colorbar/_bordercolor.py deleted file mode 100644 index 78c0167a961..00000000000 --- a/plotly/validators/histogram2d/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_borderwidth.py b/plotly/validators/histogram2d/colorbar/_borderwidth.py deleted file mode 100644 index c3fa5c52708..00000000000 --- a/plotly/validators/histogram2d/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_dtick.py b/plotly/validators/histogram2d/colorbar/_dtick.py deleted file mode 100644 index c901bbfc857..00000000000 --- a/plotly/validators/histogram2d/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_exponentformat.py b/plotly/validators/histogram2d/colorbar/_exponentformat.py deleted file mode 100644 index 2d742a45820..00000000000 --- a/plotly/validators/histogram2d/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_len.py b/plotly/validators/histogram2d/colorbar/_len.py deleted file mode 100644 index 917b1436545..00000000000 --- a/plotly/validators/histogram2d/colorbar/_len.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='len', parent_name='histogram2d.colorbar', **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_lenmode.py b/plotly/validators/histogram2d/colorbar/_lenmode.py deleted file mode 100644 index 9e78c38122e..00000000000 --- a/plotly/validators/histogram2d/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_nticks.py b/plotly/validators/histogram2d/colorbar/_nticks.py deleted file mode 100644 index f38c9bf371a..00000000000 --- a/plotly/validators/histogram2d/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_outlinecolor.py b/plotly/validators/histogram2d/colorbar/_outlinecolor.py deleted file mode 100644 index 426a48c3dac..00000000000 --- a/plotly/validators/histogram2d/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_outlinewidth.py b/plotly/validators/histogram2d/colorbar/_outlinewidth.py deleted file mode 100644 index b22f522032a..00000000000 --- a/plotly/validators/histogram2d/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_separatethousands.py b/plotly/validators/histogram2d/colorbar/_separatethousands.py deleted file mode 100644 index 575534aafad..00000000000 --- a/plotly/validators/histogram2d/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_showexponent.py b/plotly/validators/histogram2d/colorbar/_showexponent.py deleted file mode 100644 index eb58f9e8138..00000000000 --- a/plotly/validators/histogram2d/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_showticklabels.py b/plotly/validators/histogram2d/colorbar/_showticklabels.py deleted file mode 100644 index 0dd52b55d77..00000000000 --- a/plotly/validators/histogram2d/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_showtickprefix.py b/plotly/validators/histogram2d/colorbar/_showtickprefix.py deleted file mode 100644 index e192f33c975..00000000000 --- a/plotly/validators/histogram2d/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_showticksuffix.py b/plotly/validators/histogram2d/colorbar/_showticksuffix.py deleted file mode 100644 index 6d459ecabc7..00000000000 --- a/plotly/validators/histogram2d/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_thickness.py b/plotly/validators/histogram2d/colorbar/_thickness.py deleted file mode 100644 index 649f914a0fa..00000000000 --- a/plotly/validators/histogram2d/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_thicknessmode.py b/plotly/validators/histogram2d/colorbar/_thicknessmode.py deleted file mode 100644 index 436d625dc3c..00000000000 --- a/plotly/validators/histogram2d/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_tick0.py b/plotly/validators/histogram2d/colorbar/_tick0.py deleted file mode 100644 index e02fa2991de..00000000000 --- a/plotly/validators/histogram2d/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_tickangle.py b/plotly/validators/histogram2d/colorbar/_tickangle.py deleted file mode 100644 index 35a6caff4ea..00000000000 --- a/plotly/validators/histogram2d/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_tickcolor.py b/plotly/validators/histogram2d/colorbar/_tickcolor.py deleted file mode 100644 index 0f7c3132c97..00000000000 --- a/plotly/validators/histogram2d/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_tickfont.py b/plotly/validators/histogram2d/colorbar/_tickfont.py deleted file mode 100644 index 6d47602fc0b..00000000000 --- a/plotly/validators/histogram2d/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_tickformat.py b/plotly/validators/histogram2d/colorbar/_tickformat.py deleted file mode 100644 index 781d48ae0a2..00000000000 --- a/plotly/validators/histogram2d/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_tickformatstopdefaults.py b/plotly/validators/histogram2d/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 7ef78eb924d..00000000000 --- a/plotly/validators/histogram2d/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_tickformatstops.py b/plotly/validators/histogram2d/colorbar/_tickformatstops.py deleted file mode 100644 index 9ed1149b3a2..00000000000 --- a/plotly/validators/histogram2d/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_ticklen.py b/plotly/validators/histogram2d/colorbar/_ticklen.py deleted file mode 100644 index 9b5d541ee80..00000000000 --- a/plotly/validators/histogram2d/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_tickmode.py b/plotly/validators/histogram2d/colorbar/_tickmode.py deleted file mode 100644 index 0ee982f6b08..00000000000 --- a/plotly/validators/histogram2d/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_tickprefix.py b/plotly/validators/histogram2d/colorbar/_tickprefix.py deleted file mode 100644 index 9b3b8c98767..00000000000 --- a/plotly/validators/histogram2d/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_ticks.py b/plotly/validators/histogram2d/colorbar/_ticks.py deleted file mode 100644 index 9541f3b53fe..00000000000 --- a/plotly/validators/histogram2d/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_ticksuffix.py b/plotly/validators/histogram2d/colorbar/_ticksuffix.py deleted file mode 100644 index ff042630eea..00000000000 --- a/plotly/validators/histogram2d/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_ticktext.py b/plotly/validators/histogram2d/colorbar/_ticktext.py deleted file mode 100644 index 97837099f61..00000000000 --- a/plotly/validators/histogram2d/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_ticktextsrc.py b/plotly/validators/histogram2d/colorbar/_ticktextsrc.py deleted file mode 100644 index b9b46b01bea..00000000000 --- a/plotly/validators/histogram2d/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_tickvals.py b/plotly/validators/histogram2d/colorbar/_tickvals.py deleted file mode 100644 index cec42259509..00000000000 --- a/plotly/validators/histogram2d/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_tickvalssrc.py b/plotly/validators/histogram2d/colorbar/_tickvalssrc.py deleted file mode 100644 index f1b465e1cb5..00000000000 --- a/plotly/validators/histogram2d/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_tickwidth.py b/plotly/validators/histogram2d/colorbar/_tickwidth.py deleted file mode 100644 index d82f88d3e71..00000000000 --- a/plotly/validators/histogram2d/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_title.py b/plotly/validators/histogram2d/colorbar/_title.py deleted file mode 100644 index 10707c72357..00000000000 --- a/plotly/validators/histogram2d/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_x.py b/plotly/validators/histogram2d/colorbar/_x.py deleted file mode 100644 index d350b5bfb30..00000000000 --- a/plotly/validators/histogram2d/colorbar/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='histogram2d.colorbar', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_xanchor.py b/plotly/validators/histogram2d/colorbar/_xanchor.py deleted file mode 100644 index af61884aa01..00000000000 --- a/plotly/validators/histogram2d/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_xpad.py b/plotly/validators/histogram2d/colorbar/_xpad.py deleted file mode 100644 index f8b97b39c04..00000000000 --- a/plotly/validators/histogram2d/colorbar/_xpad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='xpad', parent_name='histogram2d.colorbar', **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_y.py b/plotly/validators/histogram2d/colorbar/_y.py deleted file mode 100644 index 8b151d7196e..00000000000 --- a/plotly/validators/histogram2d/colorbar/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='histogram2d.colorbar', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_yanchor.py b/plotly/validators/histogram2d/colorbar/_yanchor.py deleted file mode 100644 index 2036783011b..00000000000 --- a/plotly/validators/histogram2d/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='histogram2d.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/_ypad.py b/plotly/validators/histogram2d/colorbar/_ypad.py deleted file mode 100644 index ad732fb4fcc..00000000000 --- a/plotly/validators/histogram2d/colorbar/_ypad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ypad', parent_name='histogram2d.colorbar', **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/tickfont/__init__.py b/plotly/validators/histogram2d/colorbar/tickfont/__init__.py index 199d72e71c6..1f3739a5a43 100644 --- a/plotly/validators/histogram2d/colorbar/tickfont/__init__.py +++ b/plotly/validators/histogram2d/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='histogram2d.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='histogram2d.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram2d.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2d/colorbar/tickfont/_color.py b/plotly/validators/histogram2d/colorbar/tickfont/_color.py deleted file mode 100644 index 94ecb7c984b..00000000000 --- a/plotly/validators/histogram2d/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram2d.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/tickfont/_family.py b/plotly/validators/histogram2d/colorbar/tickfont/_family.py deleted file mode 100644 index be7ec2cfe00..00000000000 --- a/plotly/validators/histogram2d/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='histogram2d.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/tickfont/_size.py b/plotly/validators/histogram2d/colorbar/tickfont/_size.py deleted file mode 100644 index 206a0deb630..00000000000 --- a/plotly/validators/histogram2d/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='histogram2d.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/tickformatstop/__init__.py b/plotly/validators/histogram2d/colorbar/tickformatstop/__init__.py index 3f6c06cac47..d6bdef447fc 100644 --- a/plotly/validators/histogram2d/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/histogram2d/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='histogram2d.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='histogram2d.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='histogram2d.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='histogram2d.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='histogram2d.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/histogram2d/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/histogram2d/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index a398be52075..00000000000 --- a/plotly/validators/histogram2d/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='histogram2d.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/tickformatstop/_enabled.py b/plotly/validators/histogram2d/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index 57dfa43a631..00000000000 --- a/plotly/validators/histogram2d/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='histogram2d.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/tickformatstop/_name.py b/plotly/validators/histogram2d/colorbar/tickformatstop/_name.py deleted file mode 100644 index 36f0b77fdf5..00000000000 --- a/plotly/validators/histogram2d/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='histogram2d.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/histogram2d/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index ee9a8ff078c..00000000000 --- a/plotly/validators/histogram2d/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='histogram2d.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/tickformatstop/_value.py b/plotly/validators/histogram2d/colorbar/tickformatstop/_value.py deleted file mode 100644 index e3ab9a9d6e9..00000000000 --- a/plotly/validators/histogram2d/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='histogram2d.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/title/__init__.py b/plotly/validators/histogram2d/colorbar/title/__init__.py index 33c9c145bb8..e3bcabeab45 100644 --- a/plotly/validators/histogram2d/colorbar/title/__init__.py +++ b/plotly/validators/histogram2d/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='histogram2d.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='histogram2d.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='histogram2d.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/histogram2d/colorbar/title/_font.py b/plotly/validators/histogram2d/colorbar/title/_font.py deleted file mode 100644 index 870701b492d..00000000000 --- a/plotly/validators/histogram2d/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='histogram2d.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/title/_side.py b/plotly/validators/histogram2d/colorbar/title/_side.py deleted file mode 100644 index 249fa3b5d92..00000000000 --- a/plotly/validators/histogram2d/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='histogram2d.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/title/_text.py b/plotly/validators/histogram2d/colorbar/title/_text.py deleted file mode 100644 index a81193984f6..00000000000 --- a/plotly/validators/histogram2d/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='histogram2d.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/title/font/__init__.py b/plotly/validators/histogram2d/colorbar/title/font/__init__.py index 199d72e71c6..0106a41adbf 100644 --- a/plotly/validators/histogram2d/colorbar/title/font/__init__.py +++ b/plotly/validators/histogram2d/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='histogram2d.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='histogram2d.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram2d.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2d/colorbar/title/font/_color.py b/plotly/validators/histogram2d/colorbar/title/font/_color.py deleted file mode 100644 index fcbe6ec20cb..00000000000 --- a/plotly/validators/histogram2d/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram2d.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/title/font/_family.py b/plotly/validators/histogram2d/colorbar/title/font/_family.py deleted file mode 100644 index 088cad0f97e..00000000000 --- a/plotly/validators/histogram2d/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='histogram2d.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/histogram2d/colorbar/title/font/_size.py b/plotly/validators/histogram2d/colorbar/title/font/_size.py deleted file mode 100644 index 57086622791..00000000000 --- a/plotly/validators/histogram2d/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='histogram2d.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/hoverlabel/__init__.py b/plotly/validators/histogram2d/hoverlabel/__init__.py index 856f769ba33..8dc9efe89d2 100644 --- a/plotly/validators/histogram2d/hoverlabel/__init__.py +++ b/plotly/validators/histogram2d/hoverlabel/__init__.py @@ -1,7 +1,176 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='histogram2d.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='histogram2d.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='histogram2d.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='histogram2d.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='histogram2d.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='histogram2d.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='histogram2d.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2d/hoverlabel/_bgcolor.py b/plotly/validators/histogram2d/hoverlabel/_bgcolor.py deleted file mode 100644 index 7625619d204..00000000000 --- a/plotly/validators/histogram2d/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='histogram2d.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/hoverlabel/_bgcolorsrc.py b/plotly/validators/histogram2d/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index f8227e7e20b..00000000000 --- a/plotly/validators/histogram2d/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='histogram2d.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/hoverlabel/_bordercolor.py b/plotly/validators/histogram2d/hoverlabel/_bordercolor.py deleted file mode 100644 index 659325cb09c..00000000000 --- a/plotly/validators/histogram2d/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='histogram2d.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/hoverlabel/_bordercolorsrc.py b/plotly/validators/histogram2d/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 26db5681413..00000000000 --- a/plotly/validators/histogram2d/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='histogram2d.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/hoverlabel/_font.py b/plotly/validators/histogram2d/hoverlabel/_font.py deleted file mode 100644 index c7ba111b051..00000000000 --- a/plotly/validators/histogram2d/hoverlabel/_font.py +++ /dev/null @@ -1,50 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='histogram2d.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2d/hoverlabel/_namelength.py b/plotly/validators/histogram2d/hoverlabel/_namelength.py deleted file mode 100644 index 44faf639e7e..00000000000 --- a/plotly/validators/histogram2d/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='histogram2d.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/hoverlabel/_namelengthsrc.py b/plotly/validators/histogram2d/hoverlabel/_namelengthsrc.py deleted file mode 100644 index c5da6643b11..00000000000 --- a/plotly/validators/histogram2d/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='histogram2d.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/hoverlabel/font/__init__.py b/plotly/validators/histogram2d/hoverlabel/font/__init__.py index 1d2c591d1e5..83a11542c4c 100644 --- a/plotly/validators/histogram2d/hoverlabel/font/__init__.py +++ b/plotly/validators/histogram2d/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='histogram2d.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='histogram2d.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='histogram2d.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='histogram2d.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='histogram2d.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram2d.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2d/hoverlabel/font/_color.py b/plotly/validators/histogram2d/hoverlabel/font/_color.py deleted file mode 100644 index 5b399ccf74f..00000000000 --- a/plotly/validators/histogram2d/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram2d.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/hoverlabel/font/_colorsrc.py b/plotly/validators/histogram2d/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 04fb3981364..00000000000 --- a/plotly/validators/histogram2d/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='histogram2d.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/hoverlabel/font/_family.py b/plotly/validators/histogram2d/hoverlabel/font/_family.py deleted file mode 100644 index 6c8531da425..00000000000 --- a/plotly/validators/histogram2d/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='histogram2d.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/histogram2d/hoverlabel/font/_familysrc.py b/plotly/validators/histogram2d/hoverlabel/font/_familysrc.py deleted file mode 100644 index a072e27f4d2..00000000000 --- a/plotly/validators/histogram2d/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='histogram2d.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/hoverlabel/font/_size.py b/plotly/validators/histogram2d/hoverlabel/font/_size.py deleted file mode 100644 index f23119bb797..00000000000 --- a/plotly/validators/histogram2d/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='histogram2d.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/hoverlabel/font/_sizesrc.py b/plotly/validators/histogram2d/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 766ea417afb..00000000000 --- a/plotly/validators/histogram2d/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='histogram2d.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/marker/__init__.py b/plotly/validators/histogram2d/marker/__init__.py index e60d2b4c8db..729b407ef6f 100644 --- a/plotly/validators/histogram2d/marker/__init__.py +++ b/plotly/validators/histogram2d/marker/__init__.py @@ -1,2 +1,37 @@ -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='histogram2d.marker', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='color', parent_name='histogram2d.marker', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/histogram2d/marker/_color.py b/plotly/validators/histogram2d/marker/_color.py deleted file mode 100644 index 47528ee1c4e..00000000000 --- a/plotly/validators/histogram2d/marker/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='color', parent_name='histogram2d.marker', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/marker/_colorsrc.py b/plotly/validators/histogram2d/marker/_colorsrc.py deleted file mode 100644 index d55414ddf2d..00000000000 --- a/plotly/validators/histogram2d/marker/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='histogram2d.marker', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/stream/__init__.py b/plotly/validators/histogram2d/stream/__init__.py index 2f4f2047594..2262eab1987 100644 --- a/plotly/validators/histogram2d/stream/__init__.py +++ b/plotly/validators/histogram2d/stream/__init__.py @@ -1,2 +1,41 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='histogram2d.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='histogram2d.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/histogram2d/stream/_maxpoints.py b/plotly/validators/histogram2d/stream/_maxpoints.py deleted file mode 100644 index 489f478e685..00000000000 --- a/plotly/validators/histogram2d/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='histogram2d.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/stream/_token.py b/plotly/validators/histogram2d/stream/_token.py deleted file mode 100644 index 74d1546a1c3..00000000000 --- a/plotly/validators/histogram2d/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='histogram2d.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/histogram2d/xbins/__init__.py b/plotly/validators/histogram2d/xbins/__init__.py index 06f4b8ab6a6..58ab0d6a3d6 100644 --- a/plotly/validators/histogram2d/xbins/__init__.py +++ b/plotly/validators/histogram2d/xbins/__init__.py @@ -1,3 +1,51 @@ -from ._start import StartValidator -from ._size import SizeValidator -from ._end import EndValidator + + +import _plotly_utils.basevalidators + + +class StartValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='start', parent_name='histogram2d.xbins', **kwargs + ): + super(StartValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='size', parent_name='histogram2d.xbins', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='end', parent_name='histogram2d.xbins', **kwargs + ): + super(EndValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2d/xbins/_end.py b/plotly/validators/histogram2d/xbins/_end.py deleted file mode 100644 index 5d56074f498..00000000000 --- a/plotly/validators/histogram2d/xbins/_end.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='end', parent_name='histogram2d.xbins', **kwargs - ): - super(EndValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/xbins/_size.py b/plotly/validators/histogram2d/xbins/_size.py deleted file mode 100644 index ab041d2f492..00000000000 --- a/plotly/validators/histogram2d/xbins/_size.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='size', parent_name='histogram2d.xbins', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/xbins/_start.py b/plotly/validators/histogram2d/xbins/_start.py deleted file mode 100644 index cec0eed5c0a..00000000000 --- a/plotly/validators/histogram2d/xbins/_start.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='start', parent_name='histogram2d.xbins', **kwargs - ): - super(StartValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/ybins/__init__.py b/plotly/validators/histogram2d/ybins/__init__.py index 06f4b8ab6a6..64d8052e1cc 100644 --- a/plotly/validators/histogram2d/ybins/__init__.py +++ b/plotly/validators/histogram2d/ybins/__init__.py @@ -1,3 +1,51 @@ -from ._start import StartValidator -from ._size import SizeValidator -from ._end import EndValidator + + +import _plotly_utils.basevalidators + + +class StartValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='start', parent_name='histogram2d.ybins', **kwargs + ): + super(StartValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='size', parent_name='histogram2d.ybins', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='end', parent_name='histogram2d.ybins', **kwargs + ): + super(EndValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2d/ybins/_end.py b/plotly/validators/histogram2d/ybins/_end.py deleted file mode 100644 index 04cc48f702b..00000000000 --- a/plotly/validators/histogram2d/ybins/_end.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='end', parent_name='histogram2d.ybins', **kwargs - ): - super(EndValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/ybins/_size.py b/plotly/validators/histogram2d/ybins/_size.py deleted file mode 100644 index 7d8078c8b52..00000000000 --- a/plotly/validators/histogram2d/ybins/_size.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='size', parent_name='histogram2d.ybins', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2d/ybins/_start.py b/plotly/validators/histogram2d/ybins/_start.py deleted file mode 100644 index e4203586773..00000000000 --- a/plotly/validators/histogram2d/ybins/_start.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='start', parent_name='histogram2d.ybins', **kwargs - ): - super(StartValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/__init__.py b/plotly/validators/histogram2dcontour/__init__.py index de1cc8a63a2..263a2fdcff3 100644 --- a/plotly/validators/histogram2dcontour/__init__.py +++ b/plotly/validators/histogram2dcontour/__init__.py @@ -1,51 +1,1416 @@ -from ._zsrc import ZsrcValidator -from ._zmin import ZminValidator -from ._zmid import ZmidValidator -from ._zmax import ZmaxValidator -from ._zhoverformat import ZhoverformatValidator -from ._zauto import ZautoValidator -from ._z import ZValidator -from ._ysrc import YsrcValidator -from ._ycalendar import YcalendarValidator -from ._ybins import YBinsValidator -from ._yaxis import YAxisValidator -from ._y import YValidator -from ._xsrc import XsrcValidator -from ._xcalendar import XcalendarValidator -from ._xbins import XBinsValidator -from ._xaxis import XAxisValidator -from ._x import XValidator -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._stream import StreamValidator -from ._showscale import ShowscaleValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._reversescale import ReversescaleValidator -from ._opacity import OpacityValidator -from ._ncontours import NcontoursValidator -from ._nbinsy import NbinsyValidator -from ._nbinsx import NbinsxValidator -from ._name import NameValidator -from ._marker import MarkerValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._histnorm import HistnormValidator -from ._histfunc import HistfuncValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._contours import ContoursValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._autocontour import AutocontourValidator -from ._autocolorscale import AutocolorscaleValidator -from ._autobiny import AutobinyValidator -from ._autobinx import AutobinxValidator + + +import _plotly_utils.basevalidators + + +class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='zsrc', parent_name='histogram2dcontour', **kwargs + ): + super(ZsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='zmin', parent_name='histogram2dcontour', **kwargs + ): + super(ZminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'zauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='zmid', parent_name='histogram2dcontour', **kwargs + ): + super(ZmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='zmax', parent_name='histogram2dcontour', **kwargs + ): + super(ZmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'zauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZhoverformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='zhoverformat', + parent_name='histogram2dcontour', + **kwargs + ): + super(ZhoverformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='zauto', parent_name='histogram2dcontour', **kwargs + ): + super(ZautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='z', parent_name='histogram2dcontour', **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='ysrc', parent_name='histogram2dcontour', **kwargs + ): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ycalendar', + parent_name='histogram2dcontour', + **kwargs + ): + super(YcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YBinsValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='ybins', parent_name='histogram2dcontour', **kwargs + ): + super(YBinsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'YBins'), + data_docs=kwargs.pop( + 'data_docs', """ + end + Sets the end value for the y axis bins. The + last bin may not end exactly at this value, we + increment the bin edge by `size` from `start` + until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use + a date string, and for category data `end` is + based on the category serial numbers. + size + Sets the size of each y axis bin. Default + behavior: If `nbinsy` is 0 or omitted, we + choose a nice round bin size such that the + number of bins is about the same as the typical + number of samples in each bin. If `nbinsy` is + provided, we choose a nice round bin size + giving no more than that many bins. For date + data, use milliseconds or "M" for months, as + in `axis.dtick`. For category data, the number + of categories to bin together (always defaults + to 1). + start + Sets the starting value for the y axis bins. + Defaults to the minimum data value, shifted + down if necessary to make nice round values and + to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin + edges 0.5 down, so a `size` of 5 would have a + default `start` of -0.5, so it is clear that + 0-4 are in the first bin, 5-9 in the second, + but continuous data gets a start of 0 and bins + [0,5), [5,10) etc. Dates behave similarly, and + `start` should be a date string. For category + data, `start` is based on the category serial + numbers, and defaults to -0.5. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='yaxis', parent_name='histogram2dcontour', **kwargs + ): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='y', parent_name='histogram2dcontour', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='xsrc', parent_name='histogram2dcontour', **kwargs + ): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xcalendar', + parent_name='histogram2dcontour', + **kwargs + ): + super(XcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XBinsValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='xbins', parent_name='histogram2dcontour', **kwargs + ): + super(XBinsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'XBins'), + data_docs=kwargs.pop( + 'data_docs', """ + end + Sets the end value for the x axis bins. The + last bin may not end exactly at this value, we + increment the bin edge by `size` from `start` + until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use + a date string, and for category data `end` is + based on the category serial numbers. + size + Sets the size of each x axis bin. Default + behavior: If `nbinsx` is 0 or omitted, we + choose a nice round bin size such that the + number of bins is about the same as the typical + number of samples in each bin. If `nbinsx` is + provided, we choose a nice round bin size + giving no more than that many bins. For date + data, use milliseconds or "M" for months, as + in `axis.dtick`. For category data, the number + of categories to bin together (always defaults + to 1). + start + Sets the starting value for the x axis bins. + Defaults to the minimum data value, shifted + down if necessary to make nice round values and + to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin + edges 0.5 down, so a `size` of 5 would have a + default `start` of -0.5, so it is clear that + 0-4 are in the first bin, 5-9 in the second, + but continuous data gets a start of 0 and bins + [0,5), [5,10) etc. Dates behave similarly, and + `start` should be a date string. For category + data, `start` is based on the category serial + numbers, and defaults to -0.5. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='xaxis', parent_name='histogram2dcontour', **kwargs + ): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='x', parent_name='histogram2dcontour', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='visible', + parent_name='histogram2dcontour', + **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='uirevision', + parent_name='histogram2dcontour', + **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='uid', parent_name='histogram2dcontour', **kwargs + ): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='histogram2dcontour', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showscale', + parent_name='histogram2dcontour', + **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showlegend', + parent_name='histogram2dcontour', + **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='selectedpoints', + parent_name='histogram2dcontour', + **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='histogram2dcontour', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='histogram2dcontour', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NcontoursValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='ncontours', + parent_name='histogram2dcontour', + **kwargs + ): + super(NcontoursValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NbinsyValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nbinsy', parent_name='histogram2dcontour', **kwargs + ): + super(NbinsyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NbinsxValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nbinsx', parent_name='histogram2dcontour', **kwargs + ): + super(NbinsxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='histogram2dcontour', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='histogram2dcontour', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the aggregation data. + colorsrc + Sets the source reference on plot.ly for color + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='histogram2dcontour', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the color of the contour level. Has no + effect if `contours.coloring` is set to + "lines". + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour + lines, where 0 corresponds to no smoothing. + width + Sets the line width (in px). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='legendgroup', + parent_name='histogram2dcontour', + **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='histogram2dcontour', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ids', parent_name='histogram2dcontour', **kwargs + ): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertemplatesrc', + parent_name='histogram2dcontour', + **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hovertemplate', + parent_name='histogram2dcontour', + **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='hoverlabel', + parent_name='histogram2dcontour', + **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hoverinfosrc', + parent_name='histogram2dcontour', + **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, + plotly_name='hoverinfo', + parent_name='histogram2dcontour', + **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HistnormValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='histnorm', + parent_name='histogram2dcontour', + **kwargs + ): + super(HistnormValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + '', 'percent', 'probability', 'density', + 'probability density' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HistfuncValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='histfunc', + parent_name='histogram2dcontour', + **kwargs + ): + super(HistfuncValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['count', 'sum', 'avg', 'min', 'max']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='customdatasrc', + parent_name='histogram2dcontour', + **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='customdata', + parent_name='histogram2dcontour', + **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ContoursValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='contours', + parent_name='histogram2dcontour', + **kwargs + ): + super(ContoursValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Contours'), + data_docs=kwargs.pop( + 'data_docs', """ + coloring + Determines the coloring method showing the + contour values. If "fill", coloring is done + evenly between each contour level If "heatmap", + a heatmap gradient coloring is applied between + each contour level. If "lines", coloring is + done on the contour lines. If "none", no + coloring is applied on this trace. + end + Sets the end contour level value. Must be more + than `contours.start` + labelfont + Sets the font used for labeling the contour + levels. The default color comes from the lines, + if shown. The default family and size come from + `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-language which is very similar + to Python, see: https://github.com/d3/d3-format + /blob/master/README.md#locale_format. + operation + Sets the constraint operation. "=" keeps + regions equal to `value` "<" and "<=" keep + regions less than `value` ">" and ">=" keep + regions greater than `value` "[]", "()", "[)", + and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions + outside `value[0]` to value[1]` Open vs. closed + intervals make no difference to constraint + display, but all versions are allowed for + consistency with filter transforms. + showlabels + Determines whether to label the contour lines + with their values. + showlines + Determines whether or not the contour lines are + drawn. Has an effect only if + `contours.coloring` is set to "fill". + size + Sets the step between each contour level. Must + be positive. + start + Sets the starting contour level value. Must be + less than `contours.end` + type + If `levels`, the data is represented as a + contour plot with multiple levels displayed. If + `constraint`, the data is represented as + constraints with the invalid region shaded as + specified by the `operation` and `value` + parameters. + value + Sets the value or values of the constraint + boundary. When `operation` is set to one of the + comparison values (=,<,>=,>,<=) "value" is + expected to be a number. When `operation` is + set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected + to be an array of two numbers where the first + is the lower bound and the second is the upper + bound. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='histogram2dcontour', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='colorbar', + parent_name='histogram2dcontour', + **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.histogram2dcontour.colorbar.T + ickformatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.histogram2dcontour.colorbar.tickformatstopdef + aults), sets the default property values to use + for elements of + histogram2dcontour.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.histogram2dcontour.colorbar.T + itle instance or dict with compatible + properties + titlefont + Deprecated: Please use + histogram2dcontour.colorbar.title.font instead. + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + histogram2dcontour.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocontourValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocontour', + parent_name='histogram2dcontour', + **kwargs + ): + super(AutocontourValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='histogram2dcontour', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutobinyValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autobiny', + parent_name='histogram2dcontour', + **kwargs + ): + super(AutobinyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutobinxValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autobinx', + parent_name='histogram2dcontour', + **kwargs + ): + super(AutobinxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2dcontour/_autobinx.py b/plotly/validators/histogram2dcontour/_autobinx.py deleted file mode 100644 index 0bb2c2b7cd8..00000000000 --- a/plotly/validators/histogram2dcontour/_autobinx.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutobinxValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autobinx', - parent_name='histogram2dcontour', - **kwargs - ): - super(AutobinxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_autobiny.py b/plotly/validators/histogram2dcontour/_autobiny.py deleted file mode 100644 index eba60bda89b..00000000000 --- a/plotly/validators/histogram2dcontour/_autobiny.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutobinyValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autobiny', - parent_name='histogram2dcontour', - **kwargs - ): - super(AutobinyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_autocolorscale.py b/plotly/validators/histogram2dcontour/_autocolorscale.py deleted file mode 100644 index f546adf3bdb..00000000000 --- a/plotly/validators/histogram2dcontour/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='histogram2dcontour', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_autocontour.py b/plotly/validators/histogram2dcontour/_autocontour.py deleted file mode 100644 index b5738c5c2e2..00000000000 --- a/plotly/validators/histogram2dcontour/_autocontour.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocontourValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocontour', - parent_name='histogram2dcontour', - **kwargs - ): - super(AutocontourValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_colorbar.py b/plotly/validators/histogram2dcontour/_colorbar.py deleted file mode 100644 index 78c7c2c1262..00000000000 --- a/plotly/validators/histogram2dcontour/_colorbar.py +++ /dev/null @@ -1,232 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='colorbar', - parent_name='histogram2dcontour', - **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.histogram2dcontour.colorbar.T - ickformatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.histogram2dcontour.colorbar.tickformatstopdef - aults), sets the default property values to use - for elements of - histogram2dcontour.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.histogram2dcontour.colorbar.T - itle instance or dict with compatible - properties - titlefont - Deprecated: Please use - histogram2dcontour.colorbar.title.font instead. - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - histogram2dcontour.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_colorscale.py b/plotly/validators/histogram2dcontour/_colorscale.py deleted file mode 100644 index cfef7352e76..00000000000 --- a/plotly/validators/histogram2dcontour/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='histogram2dcontour', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_contours.py b/plotly/validators/histogram2dcontour/_contours.py deleted file mode 100644 index 15e7e5a019e..00000000000 --- a/plotly/validators/histogram2dcontour/_contours.py +++ /dev/null @@ -1,83 +0,0 @@ -import _plotly_utils.basevalidators - - -class ContoursValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='contours', - parent_name='histogram2dcontour', - **kwargs - ): - super(ContoursValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Contours'), - data_docs=kwargs.pop( - 'data_docs', """ - coloring - Determines the coloring method showing the - contour values. If "fill", coloring is done - evenly between each contour level If "heatmap", - a heatmap gradient coloring is applied between - each contour level. If "lines", coloring is - done on the contour lines. If "none", no - coloring is applied on this trace. - end - Sets the end contour level value. Must be more - than `contours.start` - labelfont - Sets the font used for labeling the contour - levels. The default color comes from the lines, - if shown. The default family and size come from - `layout.font`. - labelformat - Sets the contour label formatting rule using d3 - formatting mini-language which is very similar - to Python, see: https://github.com/d3/d3-format - /blob/master/README.md#locale_format. - operation - Sets the constraint operation. "=" keeps - regions equal to `value` "<" and "<=" keep - regions less than `value` ">" and ">=" keep - regions greater than `value` "[]", "()", "[)", - and "(]" keep regions inside `value[0]` to - `value[1]` "][", ")(", "](", ")[" keep regions - outside `value[0]` to value[1]` Open vs. closed - intervals make no difference to constraint - display, but all versions are allowed for - consistency with filter transforms. - showlabels - Determines whether to label the contour lines - with their values. - showlines - Determines whether or not the contour lines are - drawn. Has an effect only if - `contours.coloring` is set to "fill". - size - Sets the step between each contour level. Must - be positive. - start - Sets the starting contour level value. Must be - less than `contours.end` - type - If `levels`, the data is represented as a - contour plot with multiple levels displayed. If - `constraint`, the data is represented as - constraints with the invalid region shaded as - specified by the `operation` and `value` - parameters. - value - Sets the value or values of the constraint - boundary. When `operation` is set to one of the - comparison values (=,<,>=,>,<=) "value" is - expected to be a number. When `operation` is - set to one of the interval values - ([],(),[),(],][,)(,](,)[) "value" is expected - to be an array of two numbers where the first - is the lower bound and the second is the upper - bound. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_customdata.py b/plotly/validators/histogram2dcontour/_customdata.py deleted file mode 100644 index 570ef240f49..00000000000 --- a/plotly/validators/histogram2dcontour/_customdata.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='customdata', - parent_name='histogram2dcontour', - **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_customdatasrc.py b/plotly/validators/histogram2dcontour/_customdatasrc.py deleted file mode 100644 index 585fa3f30c5..00000000000 --- a/plotly/validators/histogram2dcontour/_customdatasrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='customdatasrc', - parent_name='histogram2dcontour', - **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_histfunc.py b/plotly/validators/histogram2dcontour/_histfunc.py deleted file mode 100644 index 13953e0e599..00000000000 --- a/plotly/validators/histogram2dcontour/_histfunc.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class HistfuncValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='histfunc', - parent_name='histogram2dcontour', - **kwargs - ): - super(HistfuncValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['count', 'sum', 'avg', 'min', 'max']), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_histnorm.py b/plotly/validators/histogram2dcontour/_histnorm.py deleted file mode 100644 index 5cb1995ecee..00000000000 --- a/plotly/validators/histogram2dcontour/_histnorm.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class HistnormValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='histnorm', - parent_name='histogram2dcontour', - **kwargs - ): - super(HistnormValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - '', 'percent', 'probability', 'density', - 'probability density' - ] - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_hoverinfo.py b/plotly/validators/histogram2dcontour/_hoverinfo.py deleted file mode 100644 index 6d28dfa83b9..00000000000 --- a/plotly/validators/histogram2dcontour/_hoverinfo.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, - plotly_name='hoverinfo', - parent_name='histogram2dcontour', - **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_hoverinfosrc.py b/plotly/validators/histogram2dcontour/_hoverinfosrc.py deleted file mode 100644 index aae6ed653fd..00000000000 --- a/plotly/validators/histogram2dcontour/_hoverinfosrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hoverinfosrc', - parent_name='histogram2dcontour', - **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_hoverlabel.py b/plotly/validators/histogram2dcontour/_hoverlabel.py deleted file mode 100644 index 5bc6ee7dc16..00000000000 --- a/plotly/validators/histogram2dcontour/_hoverlabel.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='hoverlabel', - parent_name='histogram2dcontour', - **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_hovertemplate.py b/plotly/validators/histogram2dcontour/_hovertemplate.py deleted file mode 100644 index bea6090e83d..00000000000 --- a/plotly/validators/histogram2dcontour/_hovertemplate.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hovertemplate', - parent_name='histogram2dcontour', - **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_hovertemplatesrc.py b/plotly/validators/histogram2dcontour/_hovertemplatesrc.py deleted file mode 100644 index 6d71db037cb..00000000000 --- a/plotly/validators/histogram2dcontour/_hovertemplatesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertemplatesrc', - parent_name='histogram2dcontour', - **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_ids.py b/plotly/validators/histogram2dcontour/_ids.py deleted file mode 100644 index a65c1bb7c15..00000000000 --- a/plotly/validators/histogram2dcontour/_ids.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ids', parent_name='histogram2dcontour', **kwargs - ): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_idssrc.py b/plotly/validators/histogram2dcontour/_idssrc.py deleted file mode 100644 index c631165c363..00000000000 --- a/plotly/validators/histogram2dcontour/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='histogram2dcontour', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_legendgroup.py b/plotly/validators/histogram2dcontour/_legendgroup.py deleted file mode 100644 index 58ed78012a8..00000000000 --- a/plotly/validators/histogram2dcontour/_legendgroup.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='legendgroup', - parent_name='histogram2dcontour', - **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_line.py b/plotly/validators/histogram2dcontour/_line.py deleted file mode 100644 index 0e12b733597..00000000000 --- a/plotly/validators/histogram2dcontour/_line.py +++ /dev/null @@ -1,32 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='histogram2dcontour', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the color of the contour level. Has no - effect if `contours.coloring` is set to - "lines". - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - smoothing - Sets the amount of smoothing for the contour - lines, where 0 corresponds to no smoothing. - width - Sets the line width (in px). -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_marker.py b/plotly/validators/histogram2dcontour/_marker.py deleted file mode 100644 index 16ba69d3683..00000000000 --- a/plotly/validators/histogram2dcontour/_marker.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='histogram2dcontour', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the aggregation data. - colorsrc - Sets the source reference on plot.ly for color - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_name.py b/plotly/validators/histogram2dcontour/_name.py deleted file mode 100644 index 7c06480c6da..00000000000 --- a/plotly/validators/histogram2dcontour/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='histogram2dcontour', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_nbinsx.py b/plotly/validators/histogram2dcontour/_nbinsx.py deleted file mode 100644 index fc1f4630919..00000000000 --- a/plotly/validators/histogram2dcontour/_nbinsx.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NbinsxValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nbinsx', parent_name='histogram2dcontour', **kwargs - ): - super(NbinsxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_nbinsy.py b/plotly/validators/histogram2dcontour/_nbinsy.py deleted file mode 100644 index 435eadc210a..00000000000 --- a/plotly/validators/histogram2dcontour/_nbinsy.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NbinsyValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nbinsy', parent_name='histogram2dcontour', **kwargs - ): - super(NbinsyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_ncontours.py b/plotly/validators/histogram2dcontour/_ncontours.py deleted file mode 100644 index 73ac019be94..00000000000 --- a/plotly/validators/histogram2dcontour/_ncontours.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NcontoursValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='ncontours', - parent_name='histogram2dcontour', - **kwargs - ): - super(NcontoursValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_opacity.py b/plotly/validators/histogram2dcontour/_opacity.py deleted file mode 100644 index 5d491845416..00000000000 --- a/plotly/validators/histogram2dcontour/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='histogram2dcontour', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_reversescale.py b/plotly/validators/histogram2dcontour/_reversescale.py deleted file mode 100644 index 732081ac5d9..00000000000 --- a/plotly/validators/histogram2dcontour/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='histogram2dcontour', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_selectedpoints.py b/plotly/validators/histogram2dcontour/_selectedpoints.py deleted file mode 100644 index 6bd104e7875..00000000000 --- a/plotly/validators/histogram2dcontour/_selectedpoints.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='selectedpoints', - parent_name='histogram2dcontour', - **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_showlegend.py b/plotly/validators/histogram2dcontour/_showlegend.py deleted file mode 100644 index be1bfb6e82b..00000000000 --- a/plotly/validators/histogram2dcontour/_showlegend.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showlegend', - parent_name='histogram2dcontour', - **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_showscale.py b/plotly/validators/histogram2dcontour/_showscale.py deleted file mode 100644 index 8c9a77cd16a..00000000000 --- a/plotly/validators/histogram2dcontour/_showscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showscale', - parent_name='histogram2dcontour', - **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_stream.py b/plotly/validators/histogram2dcontour/_stream.py deleted file mode 100644 index 851162a183c..00000000000 --- a/plotly/validators/histogram2dcontour/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='histogram2dcontour', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_uid.py b/plotly/validators/histogram2dcontour/_uid.py deleted file mode 100644 index 7da5e22f886..00000000000 --- a/plotly/validators/histogram2dcontour/_uid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='uid', parent_name='histogram2dcontour', **kwargs - ): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_uirevision.py b/plotly/validators/histogram2dcontour/_uirevision.py deleted file mode 100644 index fd495a6303b..00000000000 --- a/plotly/validators/histogram2dcontour/_uirevision.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='uirevision', - parent_name='histogram2dcontour', - **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_visible.py b/plotly/validators/histogram2dcontour/_visible.py deleted file mode 100644 index e4b14b582f6..00000000000 --- a/plotly/validators/histogram2dcontour/_visible.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='visible', - parent_name='histogram2dcontour', - **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_x.py b/plotly/validators/histogram2dcontour/_x.py deleted file mode 100644 index ef34a936012..00000000000 --- a/plotly/validators/histogram2dcontour/_x.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='x', parent_name='histogram2dcontour', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_xaxis.py b/plotly/validators/histogram2dcontour/_xaxis.py deleted file mode 100644 index 703e1c21ec2..00000000000 --- a/plotly/validators/histogram2dcontour/_xaxis.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='xaxis', parent_name='histogram2dcontour', **kwargs - ): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_xbins.py b/plotly/validators/histogram2dcontour/_xbins.py deleted file mode 100644 index e1e7d75d7a2..00000000000 --- a/plotly/validators/histogram2dcontour/_xbins.py +++ /dev/null @@ -1,52 +0,0 @@ -import _plotly_utils.basevalidators - - -class XBinsValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='xbins', parent_name='histogram2dcontour', **kwargs - ): - super(XBinsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'XBins'), - data_docs=kwargs.pop( - 'data_docs', """ - end - Sets the end value for the x axis bins. The - last bin may not end exactly at this value, we - increment the bin edge by `size` from `start` - until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use - a date string, and for category data `end` is - based on the category serial numbers. - size - Sets the size of each x axis bin. Default - behavior: If `nbinsx` is 0 or omitted, we - choose a nice round bin size such that the - number of bins is about the same as the typical - number of samples in each bin. If `nbinsx` is - provided, we choose a nice round bin size - giving no more than that many bins. For date - data, use milliseconds or "M" for months, as - in `axis.dtick`. For category data, the number - of categories to bin together (always defaults - to 1). - start - Sets the starting value for the x axis bins. - Defaults to the minimum data value, shifted - down if necessary to make nice round values and - to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin - edges 0.5 down, so a `size` of 5 would have a - default `start` of -0.5, so it is clear that - 0-4 are in the first bin, 5-9 in the second, - but continuous data gets a start of 0 and bins - [0,5), [5,10) etc. Dates behave similarly, and - `start` should be a date string. For category - data, `start` is based on the category serial - numbers, and defaults to -0.5. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_xcalendar.py b/plotly/validators/histogram2dcontour/_xcalendar.py deleted file mode 100644 index 7c8650c6e9d..00000000000 --- a/plotly/validators/histogram2dcontour/_xcalendar.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xcalendar', - parent_name='histogram2dcontour', - **kwargs - ): - super(XcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_xsrc.py b/plotly/validators/histogram2dcontour/_xsrc.py deleted file mode 100644 index f84376b965e..00000000000 --- a/plotly/validators/histogram2dcontour/_xsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='xsrc', parent_name='histogram2dcontour', **kwargs - ): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_y.py b/plotly/validators/histogram2dcontour/_y.py deleted file mode 100644 index b5420445c77..00000000000 --- a/plotly/validators/histogram2dcontour/_y.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='y', parent_name='histogram2dcontour', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_yaxis.py b/plotly/validators/histogram2dcontour/_yaxis.py deleted file mode 100644 index 5f7117ab42c..00000000000 --- a/plotly/validators/histogram2dcontour/_yaxis.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='yaxis', parent_name='histogram2dcontour', **kwargs - ): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_ybins.py b/plotly/validators/histogram2dcontour/_ybins.py deleted file mode 100644 index 4b7e55a0a18..00000000000 --- a/plotly/validators/histogram2dcontour/_ybins.py +++ /dev/null @@ -1,52 +0,0 @@ -import _plotly_utils.basevalidators - - -class YBinsValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='ybins', parent_name='histogram2dcontour', **kwargs - ): - super(YBinsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'YBins'), - data_docs=kwargs.pop( - 'data_docs', """ - end - Sets the end value for the y axis bins. The - last bin may not end exactly at this value, we - increment the bin edge by `size` from `start` - until we reach or exceed `end`. Defaults to the - maximum data value. Like `start`, for dates use - a date string, and for category data `end` is - based on the category serial numbers. - size - Sets the size of each y axis bin. Default - behavior: If `nbinsy` is 0 or omitted, we - choose a nice round bin size such that the - number of bins is about the same as the typical - number of samples in each bin. If `nbinsy` is - provided, we choose a nice round bin size - giving no more than that many bins. For date - data, use milliseconds or "M" for months, as - in `axis.dtick`. For category data, the number - of categories to bin together (always defaults - to 1). - start - Sets the starting value for the y axis bins. - Defaults to the minimum data value, shifted - down if necessary to make nice round values and - to remove ambiguous bin edges. For example, if - most of the data is integers we shift the bin - edges 0.5 down, so a `size` of 5 would have a - default `start` of -0.5, so it is clear that - 0-4 are in the first bin, 5-9 in the second, - but continuous data gets a start of 0 and bins - [0,5), [5,10) etc. Dates behave similarly, and - `start` should be a date string. For category - data, `start` is based on the category serial - numbers, and defaults to -0.5. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_ycalendar.py b/plotly/validators/histogram2dcontour/_ycalendar.py deleted file mode 100644 index e043089cf91..00000000000 --- a/plotly/validators/histogram2dcontour/_ycalendar.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ycalendar', - parent_name='histogram2dcontour', - **kwargs - ): - super(YcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_ysrc.py b/plotly/validators/histogram2dcontour/_ysrc.py deleted file mode 100644 index 8e0ef7f8e14..00000000000 --- a/plotly/validators/histogram2dcontour/_ysrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='ysrc', parent_name='histogram2dcontour', **kwargs - ): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_z.py b/plotly/validators/histogram2dcontour/_z.py deleted file mode 100644 index 6d1762b04ac..00000000000 --- a/plotly/validators/histogram2dcontour/_z.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='z', parent_name='histogram2dcontour', **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_zauto.py b/plotly/validators/histogram2dcontour/_zauto.py deleted file mode 100644 index c7f1dd86428..00000000000 --- a/plotly/validators/histogram2dcontour/_zauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='zauto', parent_name='histogram2dcontour', **kwargs - ): - super(ZautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_zhoverformat.py b/plotly/validators/histogram2dcontour/_zhoverformat.py deleted file mode 100644 index f1b5c33111e..00000000000 --- a/plotly/validators/histogram2dcontour/_zhoverformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZhoverformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='zhoverformat', - parent_name='histogram2dcontour', - **kwargs - ): - super(ZhoverformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_zmax.py b/plotly/validators/histogram2dcontour/_zmax.py deleted file mode 100644 index bf4f4eef6ea..00000000000 --- a/plotly/validators/histogram2dcontour/_zmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='zmax', parent_name='histogram2dcontour', **kwargs - ): - super(ZmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'zauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_zmid.py b/plotly/validators/histogram2dcontour/_zmid.py deleted file mode 100644 index 9c8170e304d..00000000000 --- a/plotly/validators/histogram2dcontour/_zmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='zmid', parent_name='histogram2dcontour', **kwargs - ): - super(ZmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_zmin.py b/plotly/validators/histogram2dcontour/_zmin.py deleted file mode 100644 index f8c893d2043..00000000000 --- a/plotly/validators/histogram2dcontour/_zmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='zmin', parent_name='histogram2dcontour', **kwargs - ): - super(ZminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'zauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/_zsrc.py b/plotly/validators/histogram2dcontour/_zsrc.py deleted file mode 100644 index 1c3014f133c..00000000000 --- a/plotly/validators/histogram2dcontour/_zsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='zsrc', parent_name='histogram2dcontour', **kwargs - ): - super(ZsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/__init__.py b/plotly/validators/histogram2dcontour/colorbar/__init__.py index 3dab31f7e02..59b3a3465b3 100644 --- a/plotly/validators/histogram2dcontour/colorbar/__init__.py +++ b/plotly/validators/histogram2dcontour/colorbar/__init__.py @@ -1,41 +1,936 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ypad', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='y', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xpad', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='x', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='len', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='histogram2dcontour.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_bgcolor.py b/plotly/validators/histogram2dcontour/colorbar/_bgcolor.py deleted file mode 100644 index d00737a42d6..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_bordercolor.py b/plotly/validators/histogram2dcontour/colorbar/_bordercolor.py deleted file mode 100644 index 608f2d8e845..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_borderwidth.py b/plotly/validators/histogram2dcontour/colorbar/_borderwidth.py deleted file mode 100644 index d93791a71ee..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_dtick.py b/plotly/validators/histogram2dcontour/colorbar/_dtick.py deleted file mode 100644 index b59c6980d33..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_exponentformat.py b/plotly/validators/histogram2dcontour/colorbar/_exponentformat.py deleted file mode 100644 index cc2197e4bc8..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_len.py b/plotly/validators/histogram2dcontour/colorbar/_len.py deleted file mode 100644 index 331e6c6930a..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_len.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='len', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_lenmode.py b/plotly/validators/histogram2dcontour/colorbar/_lenmode.py deleted file mode 100644 index 87ffd379772..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_nticks.py b/plotly/validators/histogram2dcontour/colorbar/_nticks.py deleted file mode 100644 index 56756607311..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_outlinecolor.py b/plotly/validators/histogram2dcontour/colorbar/_outlinecolor.py deleted file mode 100644 index 80175bc14a6..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_outlinewidth.py b/plotly/validators/histogram2dcontour/colorbar/_outlinewidth.py deleted file mode 100644 index 627e64a2a6b..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_separatethousands.py b/plotly/validators/histogram2dcontour/colorbar/_separatethousands.py deleted file mode 100644 index f8351c92820..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_showexponent.py b/plotly/validators/histogram2dcontour/colorbar/_showexponent.py deleted file mode 100644 index b0db152068e..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_showticklabels.py b/plotly/validators/histogram2dcontour/colorbar/_showticklabels.py deleted file mode 100644 index 9eb2d0cbc19..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_showtickprefix.py b/plotly/validators/histogram2dcontour/colorbar/_showtickprefix.py deleted file mode 100644 index 2166d464ba0..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_showticksuffix.py b/plotly/validators/histogram2dcontour/colorbar/_showticksuffix.py deleted file mode 100644 index ada442da169..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_thickness.py b/plotly/validators/histogram2dcontour/colorbar/_thickness.py deleted file mode 100644 index f060a943ed5..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_thicknessmode.py b/plotly/validators/histogram2dcontour/colorbar/_thicknessmode.py deleted file mode 100644 index cd04a3c7fb3..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_tick0.py b/plotly/validators/histogram2dcontour/colorbar/_tick0.py deleted file mode 100644 index e4ee9976fcd..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_tickangle.py b/plotly/validators/histogram2dcontour/colorbar/_tickangle.py deleted file mode 100644 index 2451a3a21a8..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_tickcolor.py b/plotly/validators/histogram2dcontour/colorbar/_tickcolor.py deleted file mode 100644 index 24d8cea1095..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_tickfont.py b/plotly/validators/histogram2dcontour/colorbar/_tickfont.py deleted file mode 100644 index d476042204e..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_tickformat.py b/plotly/validators/histogram2dcontour/colorbar/_tickformat.py deleted file mode 100644 index 6f2b1c5b937..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_tickformatstopdefaults.py b/plotly/validators/histogram2dcontour/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index e81f516dacc..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_tickformatstops.py b/plotly/validators/histogram2dcontour/colorbar/_tickformatstops.py deleted file mode 100644 index 4740384338f..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_ticklen.py b/plotly/validators/histogram2dcontour/colorbar/_ticklen.py deleted file mode 100644 index 88a78e03159..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_tickmode.py b/plotly/validators/histogram2dcontour/colorbar/_tickmode.py deleted file mode 100644 index 41cfb80ee50..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_tickprefix.py b/plotly/validators/histogram2dcontour/colorbar/_tickprefix.py deleted file mode 100644 index 5f79104246f..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_ticks.py b/plotly/validators/histogram2dcontour/colorbar/_ticks.py deleted file mode 100644 index 638c18befdf..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_ticksuffix.py b/plotly/validators/histogram2dcontour/colorbar/_ticksuffix.py deleted file mode 100644 index 0c2e1cc5233..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_ticktext.py b/plotly/validators/histogram2dcontour/colorbar/_ticktext.py deleted file mode 100644 index c573b97832f..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_ticktextsrc.py b/plotly/validators/histogram2dcontour/colorbar/_ticktextsrc.py deleted file mode 100644 index 5d7ddccef5f..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_tickvals.py b/plotly/validators/histogram2dcontour/colorbar/_tickvals.py deleted file mode 100644 index 06ba7d01f29..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_tickvalssrc.py b/plotly/validators/histogram2dcontour/colorbar/_tickvalssrc.py deleted file mode 100644 index a9d3905b5ce..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_tickwidth.py b/plotly/validators/histogram2dcontour/colorbar/_tickwidth.py deleted file mode 100644 index c3acaa452bf..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_title.py b/plotly/validators/histogram2dcontour/colorbar/_title.py deleted file mode 100644 index 77eac8d13a1..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_x.py b/plotly/validators/histogram2dcontour/colorbar/_x.py deleted file mode 100644 index 3a5eb7c1ce8..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_x.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='x', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_xanchor.py b/plotly/validators/histogram2dcontour/colorbar/_xanchor.py deleted file mode 100644 index 6f1a6eea40b..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_xpad.py b/plotly/validators/histogram2dcontour/colorbar/_xpad.py deleted file mode 100644 index 78d89f6fa75..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_xpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xpad', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_y.py b/plotly/validators/histogram2dcontour/colorbar/_y.py deleted file mode 100644 index aad53fc9bbe..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_y.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='y', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_yanchor.py b/plotly/validators/histogram2dcontour/colorbar/_yanchor.py deleted file mode 100644 index d743b88f642..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/_ypad.py b/plotly/validators/histogram2dcontour/colorbar/_ypad.py deleted file mode 100644 index 98a1645e663..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/_ypad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ypad', - parent_name='histogram2dcontour.colorbar', - **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/tickfont/__init__.py b/plotly/validators/histogram2dcontour/colorbar/tickfont/__init__.py index 199d72e71c6..d5ff6060eef 100644 --- a/plotly/validators/histogram2dcontour/colorbar/tickfont/__init__.py +++ b/plotly/validators/histogram2dcontour/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='histogram2dcontour.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='histogram2dcontour.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram2dcontour.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2dcontour/colorbar/tickfont/_color.py b/plotly/validators/histogram2dcontour/colorbar/tickfont/_color.py deleted file mode 100644 index e8e2447cb74..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram2dcontour.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/tickfont/_family.py b/plotly/validators/histogram2dcontour/colorbar/tickfont/_family.py deleted file mode 100644 index d5c24b499af..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='histogram2dcontour.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/tickfont/_size.py b/plotly/validators/histogram2dcontour/colorbar/tickfont/_size.py deleted file mode 100644 index 7f2edc3fc09..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='histogram2dcontour.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/tickformatstop/__init__.py b/plotly/validators/histogram2dcontour/colorbar/tickformatstop/__init__.py index 3f6c06cac47..a13b2be2e34 100644 --- a/plotly/validators/histogram2dcontour/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/histogram2dcontour/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='histogram2dcontour.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='histogram2dcontour.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='histogram2dcontour.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='histogram2dcontour.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='histogram2dcontour.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/histogram2dcontour/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/histogram2dcontour/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 5e1091b0de8..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='histogram2dcontour.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/tickformatstop/_enabled.py b/plotly/validators/histogram2dcontour/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index b94436a84d5..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='histogram2dcontour.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/tickformatstop/_name.py b/plotly/validators/histogram2dcontour/colorbar/tickformatstop/_name.py deleted file mode 100644 index 0e42679e542..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='histogram2dcontour.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/histogram2dcontour/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 209234150b2..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='histogram2dcontour.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/tickformatstop/_value.py b/plotly/validators/histogram2dcontour/colorbar/tickformatstop/_value.py deleted file mode 100644 index 6013c475051..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='histogram2dcontour.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/title/__init__.py b/plotly/validators/histogram2dcontour/colorbar/title/__init__.py index 33c9c145bb8..2b83f14f779 100644 --- a/plotly/validators/histogram2dcontour/colorbar/title/__init__.py +++ b/plotly/validators/histogram2dcontour/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='histogram2dcontour.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='histogram2dcontour.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='histogram2dcontour.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/histogram2dcontour/colorbar/title/_font.py b/plotly/validators/histogram2dcontour/colorbar/title/_font.py deleted file mode 100644 index ffe60aab898..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='histogram2dcontour.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/title/_side.py b/plotly/validators/histogram2dcontour/colorbar/title/_side.py deleted file mode 100644 index 32e358631e2..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='histogram2dcontour.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/title/_text.py b/plotly/validators/histogram2dcontour/colorbar/title/_text.py deleted file mode 100644 index 4e09a9bdc05..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='histogram2dcontour.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/title/font/__init__.py b/plotly/validators/histogram2dcontour/colorbar/title/font/__init__.py index 199d72e71c6..f553c3e72e9 100644 --- a/plotly/validators/histogram2dcontour/colorbar/title/font/__init__.py +++ b/plotly/validators/histogram2dcontour/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='histogram2dcontour.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='histogram2dcontour.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram2dcontour.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2dcontour/colorbar/title/font/_color.py b/plotly/validators/histogram2dcontour/colorbar/title/font/_color.py deleted file mode 100644 index 999f0bc93c5..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram2dcontour.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/title/font/_family.py b/plotly/validators/histogram2dcontour/colorbar/title/font/_family.py deleted file mode 100644 index 06c42a67ea9..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='histogram2dcontour.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/colorbar/title/font/_size.py b/plotly/validators/histogram2dcontour/colorbar/title/font/_size.py deleted file mode 100644 index 009e9a547bf..00000000000 --- a/plotly/validators/histogram2dcontour/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='histogram2dcontour.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/contours/__init__.py b/plotly/validators/histogram2dcontour/contours/__init__.py index 2ff9693386a..68d070bff47 100644 --- a/plotly/validators/histogram2dcontour/contours/__init__.py +++ b/plotly/validators/histogram2dcontour/contours/__init__.py @@ -1,11 +1,255 @@ -from ._value import ValueValidator -from ._type import TypeValidator -from ._start import StartValidator -from ._size import SizeValidator -from ._showlines import ShowlinesValidator -from ._showlabels import ShowlabelsValidator -from ._operation import OperationValidator -from ._labelformat import LabelformatValidator -from ._labelfont import LabelfontValidator -from ._end import EndValidator -from ._coloring import ColoringValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='value', + parent_name='histogram2dcontour.contours', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='type', + parent_name='histogram2dcontour.contours', + **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['levels', 'constraint']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StartValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='start', + parent_name='histogram2dcontour.contours', + **kwargs + ): + super(StartValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='histogram2dcontour.contours', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlinesValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showlines', + parent_name='histogram2dcontour.contours', + **kwargs + ): + super(ShowlinesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showlabels', + parent_name='histogram2dcontour.contours', + **kwargs + ): + super(ShowlabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OperationValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='operation', + parent_name='histogram2dcontour.contours', + **kwargs + ): + super(OperationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + '=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', + ')(', '](', ')[' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='labelformat', + parent_name='histogram2dcontour.contours', + **kwargs + ): + super(LabelformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='labelfont', + parent_name='histogram2dcontour.contours', + **kwargs + ): + super(LabelfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Labelfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='end', + parent_name='histogram2dcontour.contours', + **kwargs + ): + super(EndValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColoringValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='coloring', + parent_name='histogram2dcontour.contours', + **kwargs + ): + super(ColoringValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fill', 'heatmap', 'lines', 'none']), + **kwargs + ) diff --git a/plotly/validators/histogram2dcontour/contours/_coloring.py b/plotly/validators/histogram2dcontour/contours/_coloring.py deleted file mode 100644 index c541e3fdfb0..00000000000 --- a/plotly/validators/histogram2dcontour/contours/_coloring.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColoringValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='coloring', - parent_name='histogram2dcontour.contours', - **kwargs - ): - super(ColoringValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fill', 'heatmap', 'lines', 'none']), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/contours/_end.py b/plotly/validators/histogram2dcontour/contours/_end.py deleted file mode 100644 index 4f3ac4025f9..00000000000 --- a/plotly/validators/histogram2dcontour/contours/_end.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='end', - parent_name='histogram2dcontour.contours', - **kwargs - ): - super(EndValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/contours/_labelfont.py b/plotly/validators/histogram2dcontour/contours/_labelfont.py deleted file mode 100644 index d459dc3c780..00000000000 --- a/plotly/validators/histogram2dcontour/contours/_labelfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='labelfont', - parent_name='histogram2dcontour.contours', - **kwargs - ): - super(LabelfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Labelfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/contours/_labelformat.py b/plotly/validators/histogram2dcontour/contours/_labelformat.py deleted file mode 100644 index bed4a3dc556..00000000000 --- a/plotly/validators/histogram2dcontour/contours/_labelformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='labelformat', - parent_name='histogram2dcontour.contours', - **kwargs - ): - super(LabelformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/contours/_operation.py b/plotly/validators/histogram2dcontour/contours/_operation.py deleted file mode 100644 index 46c0c032526..00000000000 --- a/plotly/validators/histogram2dcontour/contours/_operation.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class OperationValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='operation', - parent_name='histogram2dcontour.contours', - **kwargs - ): - super(OperationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - '=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', - ')(', '](', ')[' - ] - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/contours/_showlabels.py b/plotly/validators/histogram2dcontour/contours/_showlabels.py deleted file mode 100644 index f66d13caa32..00000000000 --- a/plotly/validators/histogram2dcontour/contours/_showlabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showlabels', - parent_name='histogram2dcontour.contours', - **kwargs - ): - super(ShowlabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/contours/_showlines.py b/plotly/validators/histogram2dcontour/contours/_showlines.py deleted file mode 100644 index 254754b47c2..00000000000 --- a/plotly/validators/histogram2dcontour/contours/_showlines.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlinesValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showlines', - parent_name='histogram2dcontour.contours', - **kwargs - ): - super(ShowlinesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/contours/_size.py b/plotly/validators/histogram2dcontour/contours/_size.py deleted file mode 100644 index 8bb9d70bc28..00000000000 --- a/plotly/validators/histogram2dcontour/contours/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='histogram2dcontour.contours', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/contours/_start.py b/plotly/validators/histogram2dcontour/contours/_start.py deleted file mode 100644 index 890585c35d7..00000000000 --- a/plotly/validators/histogram2dcontour/contours/_start.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='start', - parent_name='histogram2dcontour.contours', - **kwargs - ): - super(StartValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'^autocontour': False}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/contours/_type.py b/plotly/validators/histogram2dcontour/contours/_type.py deleted file mode 100644 index c43aee2497d..00000000000 --- a/plotly/validators/histogram2dcontour/contours/_type.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='type', - parent_name='histogram2dcontour.contours', - **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['levels', 'constraint']), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/contours/_value.py b/plotly/validators/histogram2dcontour/contours/_value.py deleted file mode 100644 index 928f26a5b38..00000000000 --- a/plotly/validators/histogram2dcontour/contours/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='value', - parent_name='histogram2dcontour.contours', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/contours/labelfont/__init__.py b/plotly/validators/histogram2dcontour/contours/labelfont/__init__.py index 199d72e71c6..69e2db7ab0e 100644 --- a/plotly/validators/histogram2dcontour/contours/labelfont/__init__.py +++ b/plotly/validators/histogram2dcontour/contours/labelfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='histogram2dcontour.contours.labelfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='histogram2dcontour.contours.labelfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram2dcontour.contours.labelfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2dcontour/contours/labelfont/_color.py b/plotly/validators/histogram2dcontour/contours/labelfont/_color.py deleted file mode 100644 index 84f4409a77a..00000000000 --- a/plotly/validators/histogram2dcontour/contours/labelfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram2dcontour.contours.labelfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/contours/labelfont/_family.py b/plotly/validators/histogram2dcontour/contours/labelfont/_family.py deleted file mode 100644 index 3c6a4d2546c..00000000000 --- a/plotly/validators/histogram2dcontour/contours/labelfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='histogram2dcontour.contours.labelfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/contours/labelfont/_size.py b/plotly/validators/histogram2dcontour/contours/labelfont/_size.py deleted file mode 100644 index 30b186294a5..00000000000 --- a/plotly/validators/histogram2dcontour/contours/labelfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='histogram2dcontour.contours.labelfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/hoverlabel/__init__.py b/plotly/validators/histogram2dcontour/hoverlabel/__init__.py index 856f769ba33..73a0eb28611 100644 --- a/plotly/validators/histogram2dcontour/hoverlabel/__init__.py +++ b/plotly/validators/histogram2dcontour/hoverlabel/__init__.py @@ -1,7 +1,176 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='histogram2dcontour.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='histogram2dcontour.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='histogram2dcontour.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='histogram2dcontour.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='histogram2dcontour.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='histogram2dcontour.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='histogram2dcontour.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2dcontour/hoverlabel/_bgcolor.py b/plotly/validators/histogram2dcontour/hoverlabel/_bgcolor.py deleted file mode 100644 index e16b03351ce..00000000000 --- a/plotly/validators/histogram2dcontour/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='histogram2dcontour.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/hoverlabel/_bgcolorsrc.py b/plotly/validators/histogram2dcontour/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index d9dfb399fe6..00000000000 --- a/plotly/validators/histogram2dcontour/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='histogram2dcontour.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/hoverlabel/_bordercolor.py b/plotly/validators/histogram2dcontour/hoverlabel/_bordercolor.py deleted file mode 100644 index 3ab7ee018d7..00000000000 --- a/plotly/validators/histogram2dcontour/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='histogram2dcontour.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/hoverlabel/_bordercolorsrc.py b/plotly/validators/histogram2dcontour/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 425caa3eb1f..00000000000 --- a/plotly/validators/histogram2dcontour/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='histogram2dcontour.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/hoverlabel/_font.py b/plotly/validators/histogram2dcontour/hoverlabel/_font.py deleted file mode 100644 index 793a11800b9..00000000000 --- a/plotly/validators/histogram2dcontour/hoverlabel/_font.py +++ /dev/null @@ -1,50 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='histogram2dcontour.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/hoverlabel/_namelength.py b/plotly/validators/histogram2dcontour/hoverlabel/_namelength.py deleted file mode 100644 index 7c0ad812f16..00000000000 --- a/plotly/validators/histogram2dcontour/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='histogram2dcontour.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/hoverlabel/_namelengthsrc.py b/plotly/validators/histogram2dcontour/hoverlabel/_namelengthsrc.py deleted file mode 100644 index ef7cb21ba9a..00000000000 --- a/plotly/validators/histogram2dcontour/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='histogram2dcontour.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/hoverlabel/font/__init__.py b/plotly/validators/histogram2dcontour/hoverlabel/font/__init__.py index 1d2c591d1e5..845dabf64de 100644 --- a/plotly/validators/histogram2dcontour/hoverlabel/font/__init__.py +++ b/plotly/validators/histogram2dcontour/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='histogram2dcontour.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='histogram2dcontour.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='histogram2dcontour.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='histogram2dcontour.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='histogram2dcontour.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram2dcontour.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2dcontour/hoverlabel/font/_color.py b/plotly/validators/histogram2dcontour/hoverlabel/font/_color.py deleted file mode 100644 index 44bb39749e3..00000000000 --- a/plotly/validators/histogram2dcontour/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram2dcontour.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/hoverlabel/font/_colorsrc.py b/plotly/validators/histogram2dcontour/hoverlabel/font/_colorsrc.py deleted file mode 100644 index e6401353a19..00000000000 --- a/plotly/validators/histogram2dcontour/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='histogram2dcontour.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/hoverlabel/font/_family.py b/plotly/validators/histogram2dcontour/hoverlabel/font/_family.py deleted file mode 100644 index 31970d9898c..00000000000 --- a/plotly/validators/histogram2dcontour/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='histogram2dcontour.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/hoverlabel/font/_familysrc.py b/plotly/validators/histogram2dcontour/hoverlabel/font/_familysrc.py deleted file mode 100644 index 94c6af93599..00000000000 --- a/plotly/validators/histogram2dcontour/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='histogram2dcontour.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/hoverlabel/font/_size.py b/plotly/validators/histogram2dcontour/hoverlabel/font/_size.py deleted file mode 100644 index 4e938f1ab59..00000000000 --- a/plotly/validators/histogram2dcontour/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='histogram2dcontour.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/hoverlabel/font/_sizesrc.py b/plotly/validators/histogram2dcontour/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 020f963163d..00000000000 --- a/plotly/validators/histogram2dcontour/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='histogram2dcontour.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/line/__init__.py b/plotly/validators/histogram2dcontour/line/__init__.py index 185c3b5d84e..801eee5eff1 100644 --- a/plotly/validators/histogram2dcontour/line/__init__.py +++ b/plotly/validators/histogram2dcontour/line/__init__.py @@ -1,4 +1,89 @@ -from ._width import WidthValidator -from ._smoothing import SmoothingValidator -from ._dash import DashValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='histogram2dcontour.line', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style+colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='smoothing', + parent_name='histogram2dcontour.line', + **kwargs + ): + super(SmoothingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 1.3), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashValidator(_plotly_utils.basevalidators.DashValidator): + + def __init__( + self, + plotly_name='dash', + parent_name='histogram2dcontour.line', + **kwargs + ): + super(DashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram2dcontour.line', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style+colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2dcontour/line/_color.py b/plotly/validators/histogram2dcontour/line/_color.py deleted file mode 100644 index 5c2ae2a54dd..00000000000 --- a/plotly/validators/histogram2dcontour/line/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram2dcontour.line', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style+colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/line/_dash.py b/plotly/validators/histogram2dcontour/line/_dash.py deleted file mode 100644 index 7e8496290bd..00000000000 --- a/plotly/validators/histogram2dcontour/line/_dash.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashValidator(_plotly_utils.basevalidators.DashValidator): - - def __init__( - self, - plotly_name='dash', - parent_name='histogram2dcontour.line', - **kwargs - ): - super(DashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/line/_smoothing.py b/plotly/validators/histogram2dcontour/line/_smoothing.py deleted file mode 100644 index 6909bc86e98..00000000000 --- a/plotly/validators/histogram2dcontour/line/_smoothing.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='smoothing', - parent_name='histogram2dcontour.line', - **kwargs - ): - super(SmoothingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 1.3), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/line/_width.py b/plotly/validators/histogram2dcontour/line/_width.py deleted file mode 100644 index 47237b27b07..00000000000 --- a/plotly/validators/histogram2dcontour/line/_width.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='histogram2dcontour.line', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style+colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/marker/__init__.py b/plotly/validators/histogram2dcontour/marker/__init__.py index e60d2b4c8db..bd6854010ba 100644 --- a/plotly/validators/histogram2dcontour/marker/__init__.py +++ b/plotly/validators/histogram2dcontour/marker/__init__.py @@ -1,2 +1,40 @@ -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='histogram2dcontour.marker', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='color', + parent_name='histogram2dcontour.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/histogram2dcontour/marker/_color.py b/plotly/validators/histogram2dcontour/marker/_color.py deleted file mode 100644 index e2ff46cd3bd..00000000000 --- a/plotly/validators/histogram2dcontour/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='color', - parent_name='histogram2dcontour.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/marker/_colorsrc.py b/plotly/validators/histogram2dcontour/marker/_colorsrc.py deleted file mode 100644 index 720346cad3b..00000000000 --- a/plotly/validators/histogram2dcontour/marker/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='histogram2dcontour.marker', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/stream/__init__.py b/plotly/validators/histogram2dcontour/stream/__init__.py index 2f4f2047594..5bafe1b306b 100644 --- a/plotly/validators/histogram2dcontour/stream/__init__.py +++ b/plotly/validators/histogram2dcontour/stream/__init__.py @@ -1,2 +1,44 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='token', + parent_name='histogram2dcontour.stream', + **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='histogram2dcontour.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/histogram2dcontour/stream/_maxpoints.py b/plotly/validators/histogram2dcontour/stream/_maxpoints.py deleted file mode 100644 index 2f054f80b1d..00000000000 --- a/plotly/validators/histogram2dcontour/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='histogram2dcontour.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/stream/_token.py b/plotly/validators/histogram2dcontour/stream/_token.py deleted file mode 100644 index 9ff38d2cb8a..00000000000 --- a/plotly/validators/histogram2dcontour/stream/_token.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='token', - parent_name='histogram2dcontour.stream', - **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/xbins/__init__.py b/plotly/validators/histogram2dcontour/xbins/__init__.py index 06f4b8ab6a6..2513bb7749f 100644 --- a/plotly/validators/histogram2dcontour/xbins/__init__.py +++ b/plotly/validators/histogram2dcontour/xbins/__init__.py @@ -1,3 +1,60 @@ -from ._start import StartValidator -from ._size import SizeValidator -from ._end import EndValidator + + +import _plotly_utils.basevalidators + + +class StartValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='start', + parent_name='histogram2dcontour.xbins', + **kwargs + ): + super(StartValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='size', + parent_name='histogram2dcontour.xbins', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='end', + parent_name='histogram2dcontour.xbins', + **kwargs + ): + super(EndValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2dcontour/xbins/_end.py b/plotly/validators/histogram2dcontour/xbins/_end.py deleted file mode 100644 index 594c50d1f5a..00000000000 --- a/plotly/validators/histogram2dcontour/xbins/_end.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='end', - parent_name='histogram2dcontour.xbins', - **kwargs - ): - super(EndValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/xbins/_size.py b/plotly/validators/histogram2dcontour/xbins/_size.py deleted file mode 100644 index 0810a64ce9a..00000000000 --- a/plotly/validators/histogram2dcontour/xbins/_size.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='size', - parent_name='histogram2dcontour.xbins', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/xbins/_start.py b/plotly/validators/histogram2dcontour/xbins/_start.py deleted file mode 100644 index a1274ca4d3a..00000000000 --- a/plotly/validators/histogram2dcontour/xbins/_start.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='start', - parent_name='histogram2dcontour.xbins', - **kwargs - ): - super(StartValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/ybins/__init__.py b/plotly/validators/histogram2dcontour/ybins/__init__.py index 06f4b8ab6a6..e27765314fd 100644 --- a/plotly/validators/histogram2dcontour/ybins/__init__.py +++ b/plotly/validators/histogram2dcontour/ybins/__init__.py @@ -1,3 +1,60 @@ -from ._start import StartValidator -from ._size import SizeValidator -from ._end import EndValidator + + +import _plotly_utils.basevalidators + + +class StartValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='start', + parent_name='histogram2dcontour.ybins', + **kwargs + ): + super(StartValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='size', + parent_name='histogram2dcontour.ybins', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='end', + parent_name='histogram2dcontour.ybins', + **kwargs + ): + super(EndValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/histogram2dcontour/ybins/_end.py b/plotly/validators/histogram2dcontour/ybins/_end.py deleted file mode 100644 index 10454aaf6ad..00000000000 --- a/plotly/validators/histogram2dcontour/ybins/_end.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='end', - parent_name='histogram2dcontour.ybins', - **kwargs - ): - super(EndValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/ybins/_size.py b/plotly/validators/histogram2dcontour/ybins/_size.py deleted file mode 100644 index 94c0832b0b1..00000000000 --- a/plotly/validators/histogram2dcontour/ybins/_size.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='size', - parent_name='histogram2dcontour.ybins', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/histogram2dcontour/ybins/_start.py b/plotly/validators/histogram2dcontour/ybins/_start.py deleted file mode 100644 index 0f125f5cff7..00000000000 --- a/plotly/validators/histogram2dcontour/ybins/_start.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='start', - parent_name='histogram2dcontour.ybins', - **kwargs - ): - super(StartValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/__init__.py b/plotly/validators/isosurface/__init__.py index 0ee40bbb815..ed2b45ccb2b 100644 --- a/plotly/validators/isosurface/__init__.py +++ b/plotly/validators/isosurface/__init__.py @@ -1,50 +1,1216 @@ -from ._zsrc import ZsrcValidator -from ._z import ZValidator -from ._ysrc import YsrcValidator -from ._y import YValidator -from ._xsrc import XsrcValidator -from ._x import XValidator -from ._visible import VisibleValidator -from ._valuesrc import ValuesrcValidator -from ._value import ValueValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._surface import SurfaceValidator -from ._stream import StreamValidator -from ._spaceframe import SpaceframeValidator -from ._slices import SlicesValidator -from ._showscale import ShowscaleValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._scene import SceneValidator -from ._reversescale import ReversescaleValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._lightposition import LightpositionValidator -from ._lighting import LightingValidator -from ._legendgroup import LegendgroupValidator -from ._isomin import IsominValidator -from ._isomax import IsomaxValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._flatshading import FlatshadingValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._contour import ContourValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._caps import CapsValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='zsrc', parent_name='isosurface', **kwargs): + super(ZsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='z', parent_name='isosurface', **kwargs): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='isosurface', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='isosurface', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='isosurface', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='isosurface', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='isosurface', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValuesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='valuesrc', parent_name='isosurface', **kwargs + ): + super(ValuesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='value', parent_name='isosurface', **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='isosurface', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='isosurface', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textsrc', parent_name='isosurface', **kwargs + ): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='isosurface', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SurfaceValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='surface', parent_name='isosurface', **kwargs + ): + super(SurfaceValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Surface'), + data_docs=kwargs.pop( + 'data_docs', """ + count + Sets the number of iso-surfaces between minimum + and maximum iso-values. By default this value + is 2 meaning that only minimum and maximum + surfaces would be drawn. + fill + Sets the fill ratio of the iso-surface. The + default fill value of the surface is 1 meaning + that they are entirely shaded. On the other + hand Applying a `fill` ratio less than one + would allow the creation of openings parallel + to the edges. + pattern + Sets the surface pattern of the iso-surface 3-D + sections. The default pattern of the surface is + `all` meaning that the rest of surface elements + would be shaded. The check options (either 1 or + 2) could be used to draw half of the squares on + the surface. Using various combinations of + capital `A`, `B`, `C`, `D` and `E` may also be + used to reduce the number of triangles on the + iso-surfaces and creating other patterns of + interest. + show + Hides/displays surfaces between minimum and + maximum iso-values. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='isosurface', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpaceframeValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='spaceframe', parent_name='isosurface', **kwargs + ): + super(SpaceframeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Spaceframe'), + data_docs=kwargs.pop( + 'data_docs', """ + fill + Sets the fill ratio of the `spaceframe` + elements. The default fill value is 0.15 + meaning that only 15% of the area of every + faces of tetras would be shaded. Applying a + greater `fill` ratio would allow the creation + of stronger elements or could be sued to have + entirely closed areas (in case of using 1). + show + Displays/hides tetrahedron shapes between + minimum and maximum iso-values. Often useful + when either caps or surfaces are disabled or + filled with values less than 1. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SlicesValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='slices', parent_name='isosurface', **kwargs + ): + super(SlicesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Slices'), + data_docs=kwargs.pop( + 'data_docs', """ + x + plotly.graph_objs.isosurface.slices.X instance + or dict with compatible properties + y + plotly.graph_objs.isosurface.slices.Y instance + or dict with compatible properties + z + plotly.graph_objs.isosurface.slices.Z instance + or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='isosurface', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='isosurface', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='isosurface', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SceneValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='scene', parent_name='isosurface', **kwargs + ): + super(SceneValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'scene'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='reversescale', parent_name='isosurface', **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='isosurface', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='isosurface', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LightpositionValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='lightposition', parent_name='isosurface', **kwargs + ): + super(LightpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Lightposition'), + data_docs=kwargs.pop( + 'data_docs', """ + x + Numeric vector, representing the X coordinate + for each vertex. + y + Numeric vector, representing the Y coordinate + for each vertex. + z + Numeric vector, representing the Z coordinate + for each vertex. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LightingValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='lighting', parent_name='isosurface', **kwargs + ): + super(LightingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Lighting'), + data_docs=kwargs.pop( + 'data_docs', """ + ambient + Ambient light increases overall color + visibility but can wash out the image. + diffuse + Represents the extent that incident rays are + reflected in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids + math issues arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of + the viewing angle; e.g. paper is reflective + when viewing it from the edge of the paper + (almost 90 degrees), causing shine. + roughness + Alters specular reflection; the rougher the + surface, the wider and less contrasty the + shine. + specular + Represents the level that incident rays are + reflected in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids + math issues arising from degenerate geometry. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='isosurface', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IsominValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='isomin', parent_name='isosurface', **kwargs + ): + super(IsominValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IsomaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='isomax', parent_name='isosurface', **kwargs + ): + super(IsomaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='isosurface', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='isosurface', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='isosurface', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='isosurface', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertemplatesrc', + parent_name='isosurface', + **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='isosurface', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='isosurface', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='isosurface', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='isosurface', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FlatshadingValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='flatshading', parent_name='isosurface', **kwargs + ): + super(FlatshadingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='isosurface', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='isosurface', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ContourValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='contour', parent_name='isosurface', **kwargs + ): + super(ContourValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Contour'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the color of the contour lines. + show + Sets whether or not dynamic contours are shown + on hover + width + Sets the width of the contour lines. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='isosurface', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='isosurface', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.isosurface.colorbar.Tickforma + tstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.isosurface.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of isosurface.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.isosurface.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + isosurface.colorbar.title.font instead. Sets + this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + isosurface.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmin', parent_name='isosurface', **kwargs): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmid', parent_name='isosurface', **kwargs): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmax', parent_name='isosurface', **kwargs): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='isosurface', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CapsValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='caps', parent_name='isosurface', **kwargs): + super(CapsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Caps'), + data_docs=kwargs.pop( + 'data_docs', """ + x + plotly.graph_objs.isosurface.caps.X instance or + dict with compatible properties + y + plotly.graph_objs.isosurface.caps.Y instance or + dict with compatible properties + z + plotly.graph_objs.isosurface.caps.Z instance or + dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autocolorscale', parent_name='isosurface', **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/isosurface/_autocolorscale.py b/plotly/validators/isosurface/_autocolorscale.py deleted file mode 100644 index 4d42c22fa35..00000000000 --- a/plotly/validators/isosurface/_autocolorscale.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autocolorscale', parent_name='isosurface', **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_caps.py b/plotly/validators/isosurface/_caps.py deleted file mode 100644 index fdb958caebc..00000000000 --- a/plotly/validators/isosurface/_caps.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class CapsValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='caps', parent_name='isosurface', **kwargs): - super(CapsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Caps'), - data_docs=kwargs.pop( - 'data_docs', """ - x - plotly.graph_objs.isosurface.caps.X instance or - dict with compatible properties - y - plotly.graph_objs.isosurface.caps.Y instance or - dict with compatible properties - z - plotly.graph_objs.isosurface.caps.Z instance or - dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/_cauto.py b/plotly/validators/isosurface/_cauto.py deleted file mode 100644 index bf8e3ae3b7b..00000000000 --- a/plotly/validators/isosurface/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='isosurface', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_cmax.py b/plotly/validators/isosurface/_cmax.py deleted file mode 100644 index ccafe50a180..00000000000 --- a/plotly/validators/isosurface/_cmax.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmax', parent_name='isosurface', **kwargs): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_cmid.py b/plotly/validators/isosurface/_cmid.py deleted file mode 100644 index 4ff70b27421..00000000000 --- a/plotly/validators/isosurface/_cmid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmid', parent_name='isosurface', **kwargs): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_cmin.py b/plotly/validators/isosurface/_cmin.py deleted file mode 100644 index e3c97835c63..00000000000 --- a/plotly/validators/isosurface/_cmin.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmin', parent_name='isosurface', **kwargs): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_colorbar.py b/plotly/validators/isosurface/_colorbar.py deleted file mode 100644 index 63fbd74aa6e..00000000000 --- a/plotly/validators/isosurface/_colorbar.py +++ /dev/null @@ -1,227 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='isosurface', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.isosurface.colorbar.Tickforma - tstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.isosurface.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of isosurface.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.isosurface.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - isosurface.colorbar.title.font instead. Sets - this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - isosurface.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/_colorscale.py b/plotly/validators/isosurface/_colorscale.py deleted file mode 100644 index c9447f485ee..00000000000 --- a/plotly/validators/isosurface/_colorscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='isosurface', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_contour.py b/plotly/validators/isosurface/_contour.py deleted file mode 100644 index baca590e51f..00000000000 --- a/plotly/validators/isosurface/_contour.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class ContourValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='contour', parent_name='isosurface', **kwargs - ): - super(ContourValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Contour'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the color of the contour lines. - show - Sets whether or not dynamic contours are shown - on hover - width - Sets the width of the contour lines. -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/_customdata.py b/plotly/validators/isosurface/_customdata.py deleted file mode 100644 index c802c79085a..00000000000 --- a/plotly/validators/isosurface/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='isosurface', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_customdatasrc.py b/plotly/validators/isosurface/_customdatasrc.py deleted file mode 100644 index 9592d1e9fd3..00000000000 --- a/plotly/validators/isosurface/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='isosurface', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_flatshading.py b/plotly/validators/isosurface/_flatshading.py deleted file mode 100644 index 1f53709507b..00000000000 --- a/plotly/validators/isosurface/_flatshading.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FlatshadingValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='flatshading', parent_name='isosurface', **kwargs - ): - super(FlatshadingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_hoverinfo.py b/plotly/validators/isosurface/_hoverinfo.py deleted file mode 100644 index d4c8f45724f..00000000000 --- a/plotly/validators/isosurface/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='isosurface', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_hoverinfosrc.py b/plotly/validators/isosurface/_hoverinfosrc.py deleted file mode 100644 index ee17649da5e..00000000000 --- a/plotly/validators/isosurface/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='isosurface', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_hoverlabel.py b/plotly/validators/isosurface/_hoverlabel.py deleted file mode 100644 index 12e67337aa7..00000000000 --- a/plotly/validators/isosurface/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='isosurface', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/_hovertemplate.py b/plotly/validators/isosurface/_hovertemplate.py deleted file mode 100644 index 6ee9678f25d..00000000000 --- a/plotly/validators/isosurface/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='isosurface', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_hovertemplatesrc.py b/plotly/validators/isosurface/_hovertemplatesrc.py deleted file mode 100644 index 8fc998841c7..00000000000 --- a/plotly/validators/isosurface/_hovertemplatesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertemplatesrc', - parent_name='isosurface', - **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_hovertext.py b/plotly/validators/isosurface/_hovertext.py deleted file mode 100644 index 6d67c517e06..00000000000 --- a/plotly/validators/isosurface/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='isosurface', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_hovertextsrc.py b/plotly/validators/isosurface/_hovertextsrc.py deleted file mode 100644 index c6e3d824837..00000000000 --- a/plotly/validators/isosurface/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='isosurface', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_ids.py b/plotly/validators/isosurface/_ids.py deleted file mode 100644 index 002c2265116..00000000000 --- a/plotly/validators/isosurface/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='isosurface', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_idssrc.py b/plotly/validators/isosurface/_idssrc.py deleted file mode 100644 index 671d1616f6b..00000000000 --- a/plotly/validators/isosurface/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='isosurface', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_isomax.py b/plotly/validators/isosurface/_isomax.py deleted file mode 100644 index 3b64a31ec50..00000000000 --- a/plotly/validators/isosurface/_isomax.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IsomaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='isomax', parent_name='isosurface', **kwargs - ): - super(IsomaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_isomin.py b/plotly/validators/isosurface/_isomin.py deleted file mode 100644 index 6cf8eaff21c..00000000000 --- a/plotly/validators/isosurface/_isomin.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IsominValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='isomin', parent_name='isosurface', **kwargs - ): - super(IsominValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_legendgroup.py b/plotly/validators/isosurface/_legendgroup.py deleted file mode 100644 index 4bc3b867930..00000000000 --- a/plotly/validators/isosurface/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='isosurface', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_lighting.py b/plotly/validators/isosurface/_lighting.py deleted file mode 100644 index 7018c25903d..00000000000 --- a/plotly/validators/isosurface/_lighting.py +++ /dev/null @@ -1,42 +0,0 @@ -import _plotly_utils.basevalidators - - -class LightingValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='lighting', parent_name='isosurface', **kwargs - ): - super(LightingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Lighting'), - data_docs=kwargs.pop( - 'data_docs', """ - ambient - Ambient light increases overall color - visibility but can wash out the image. - diffuse - Represents the extent that incident rays are - reflected in a range of angles. - facenormalsepsilon - Epsilon for face normals calculation avoids - math issues arising from degenerate geometry. - fresnel - Represents the reflectance as a dependency of - the viewing angle; e.g. paper is reflective - when viewing it from the edge of the paper - (almost 90 degrees), causing shine. - roughness - Alters specular reflection; the rougher the - surface, the wider and less contrasty the - shine. - specular - Represents the level that incident rays are - reflected in a single direction, causing shine. - vertexnormalsepsilon - Epsilon for vertex normals calculation avoids - math issues arising from degenerate geometry. -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/_lightposition.py b/plotly/validators/isosurface/_lightposition.py deleted file mode 100644 index 912ce582527..00000000000 --- a/plotly/validators/isosurface/_lightposition.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class LightpositionValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='lightposition', parent_name='isosurface', **kwargs - ): - super(LightpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Lightposition'), - data_docs=kwargs.pop( - 'data_docs', """ - x - Numeric vector, representing the X coordinate - for each vertex. - y - Numeric vector, representing the Y coordinate - for each vertex. - z - Numeric vector, representing the Z coordinate - for each vertex. -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/_name.py b/plotly/validators/isosurface/_name.py deleted file mode 100644 index 9d89ab6d962..00000000000 --- a/plotly/validators/isosurface/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='isosurface', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_opacity.py b/plotly/validators/isosurface/_opacity.py deleted file mode 100644 index bd30a8a1095..00000000000 --- a/plotly/validators/isosurface/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='isosurface', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_reversescale.py b/plotly/validators/isosurface/_reversescale.py deleted file mode 100644 index 6ce8e67000a..00000000000 --- a/plotly/validators/isosurface/_reversescale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='reversescale', parent_name='isosurface', **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_scene.py b/plotly/validators/isosurface/_scene.py deleted file mode 100644 index bdab5b3ea97..00000000000 --- a/plotly/validators/isosurface/_scene.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SceneValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='scene', parent_name='isosurface', **kwargs - ): - super(SceneValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'scene'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_selectedpoints.py b/plotly/validators/isosurface/_selectedpoints.py deleted file mode 100644 index 31fc0163971..00000000000 --- a/plotly/validators/isosurface/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='isosurface', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_showlegend.py b/plotly/validators/isosurface/_showlegend.py deleted file mode 100644 index c45ab4940ac..00000000000 --- a/plotly/validators/isosurface/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='isosurface', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_showscale.py b/plotly/validators/isosurface/_showscale.py deleted file mode 100644 index f41a4e6f71e..00000000000 --- a/plotly/validators/isosurface/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='isosurface', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_slices.py b/plotly/validators/isosurface/_slices.py deleted file mode 100644 index a2dc47c690f..00000000000 --- a/plotly/validators/isosurface/_slices.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class SlicesValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='slices', parent_name='isosurface', **kwargs - ): - super(SlicesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Slices'), - data_docs=kwargs.pop( - 'data_docs', """ - x - plotly.graph_objs.isosurface.slices.X instance - or dict with compatible properties - y - plotly.graph_objs.isosurface.slices.Y instance - or dict with compatible properties - z - plotly.graph_objs.isosurface.slices.Z instance - or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/_spaceframe.py b/plotly/validators/isosurface/_spaceframe.py deleted file mode 100644 index b80cf3a0fb4..00000000000 --- a/plotly/validators/isosurface/_spaceframe.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpaceframeValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='spaceframe', parent_name='isosurface', **kwargs - ): - super(SpaceframeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Spaceframe'), - data_docs=kwargs.pop( - 'data_docs', """ - fill - Sets the fill ratio of the `spaceframe` - elements. The default fill value is 0.15 - meaning that only 15% of the area of every - faces of tetras would be shaded. Applying a - greater `fill` ratio would allow the creation - of stronger elements or could be sued to have - entirely closed areas (in case of using 1). - show - Displays/hides tetrahedron shapes between - minimum and maximum iso-values. Often useful - when either caps or surfaces are disabled or - filled with values less than 1. -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/_stream.py b/plotly/validators/isosurface/_stream.py deleted file mode 100644 index 3e80a3698a2..00000000000 --- a/plotly/validators/isosurface/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='isosurface', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/_surface.py b/plotly/validators/isosurface/_surface.py deleted file mode 100644 index e5ea00f8631..00000000000 --- a/plotly/validators/isosurface/_surface.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class SurfaceValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='surface', parent_name='isosurface', **kwargs - ): - super(SurfaceValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Surface'), - data_docs=kwargs.pop( - 'data_docs', """ - count - Sets the number of iso-surfaces between minimum - and maximum iso-values. By default this value - is 2 meaning that only minimum and maximum - surfaces would be drawn. - fill - Sets the fill ratio of the iso-surface. The - default fill value of the surface is 1 meaning - that they are entirely shaded. On the other - hand Applying a `fill` ratio less than one - would allow the creation of openings parallel - to the edges. - pattern - Sets the surface pattern of the iso-surface 3-D - sections. The default pattern of the surface is - `all` meaning that the rest of surface elements - would be shaded. The check options (either 1 or - 2) could be used to draw half of the squares on - the surface. Using various combinations of - capital `A`, `B`, `C`, `D` and `E` may also be - used to reduce the number of triangles on the - iso-surfaces and creating other patterns of - interest. - show - Hides/displays surfaces between minimum and - maximum iso-values. -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/_text.py b/plotly/validators/isosurface/_text.py deleted file mode 100644 index 86d5b89d99e..00000000000 --- a/plotly/validators/isosurface/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='isosurface', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_textsrc.py b/plotly/validators/isosurface/_textsrc.py deleted file mode 100644 index 68055b61782..00000000000 --- a/plotly/validators/isosurface/_textsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textsrc', parent_name='isosurface', **kwargs - ): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_uid.py b/plotly/validators/isosurface/_uid.py deleted file mode 100644 index 75369d48d7d..00000000000 --- a/plotly/validators/isosurface/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='isosurface', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_uirevision.py b/plotly/validators/isosurface/_uirevision.py deleted file mode 100644 index 383db3ab16f..00000000000 --- a/plotly/validators/isosurface/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='isosurface', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_value.py b/plotly/validators/isosurface/_value.py deleted file mode 100644 index 85a5b5d9a8a..00000000000 --- a/plotly/validators/isosurface/_value.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='value', parent_name='isosurface', **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_valuesrc.py b/plotly/validators/isosurface/_valuesrc.py deleted file mode 100644 index d9f15b07c75..00000000000 --- a/plotly/validators/isosurface/_valuesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValuesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='valuesrc', parent_name='isosurface', **kwargs - ): - super(ValuesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_visible.py b/plotly/validators/isosurface/_visible.py deleted file mode 100644 index 6c4bcf70a4e..00000000000 --- a/plotly/validators/isosurface/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='isosurface', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/isosurface/_x.py b/plotly/validators/isosurface/_x.py deleted file mode 100644 index 7fc9055afb2..00000000000 --- a/plotly/validators/isosurface/_x.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='isosurface', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_xsrc.py b/plotly/validators/isosurface/_xsrc.py deleted file mode 100644 index 7b4a15a1b19..00000000000 --- a/plotly/validators/isosurface/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='isosurface', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_y.py b/plotly/validators/isosurface/_y.py deleted file mode 100644 index 138f8013f68..00000000000 --- a/plotly/validators/isosurface/_y.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='isosurface', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_ysrc.py b/plotly/validators/isosurface/_ysrc.py deleted file mode 100644 index f346039b338..00000000000 --- a/plotly/validators/isosurface/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='isosurface', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_z.py b/plotly/validators/isosurface/_z.py deleted file mode 100644 index d64bfaa5e80..00000000000 --- a/plotly/validators/isosurface/_z.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='z', parent_name='isosurface', **kwargs): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/isosurface/_zsrc.py b/plotly/validators/isosurface/_zsrc.py deleted file mode 100644 index 2e25aaa81fc..00000000000 --- a/plotly/validators/isosurface/_zsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='zsrc', parent_name='isosurface', **kwargs): - super(ZsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/caps/__init__.py b/plotly/validators/isosurface/caps/__init__.py index 438e2dc9c6d..4f5ba519901 100644 --- a/plotly/validators/isosurface/caps/__init__.py +++ b/plotly/validators/isosurface/caps/__init__.py @@ -1,3 +1,99 @@ -from ._z import ZValidator -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='z', parent_name='isosurface.caps', **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Z'), + data_docs=kwargs.pop( + 'data_docs', """ + fill + Sets the fill ratio of the `caps`. The default + fill value of 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. + show + Sets the fill ratio of the `slices`. The + default fill value of 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='y', parent_name='isosurface.caps', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Y'), + data_docs=kwargs.pop( + 'data_docs', """ + fill + Sets the fill ratio of the `caps`. The default + fill value of 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. + show + Sets the fill ratio of the `slices`. The + default fill value of 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='x', parent_name='isosurface.caps', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'X'), + data_docs=kwargs.pop( + 'data_docs', """ + fill + Sets the fill ratio of the `caps`. The default + fill value of 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. + show + Sets the fill ratio of the `slices`. The + default fill value of 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. +""" + ), + **kwargs + ) diff --git a/plotly/validators/isosurface/caps/_x.py b/plotly/validators/isosurface/caps/_x.py deleted file mode 100644 index 1ff298d6e20..00000000000 --- a/plotly/validators/isosurface/caps/_x.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='x', parent_name='isosurface.caps', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'X'), - data_docs=kwargs.pop( - 'data_docs', """ - fill - Sets the fill ratio of the `caps`. The default - fill value of 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. - show - Sets the fill ratio of the `slices`. The - default fill value of 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/caps/_y.py b/plotly/validators/isosurface/caps/_y.py deleted file mode 100644 index 1c738e26827..00000000000 --- a/plotly/validators/isosurface/caps/_y.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='y', parent_name='isosurface.caps', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Y'), - data_docs=kwargs.pop( - 'data_docs', """ - fill - Sets the fill ratio of the `caps`. The default - fill value of 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. - show - Sets the fill ratio of the `slices`. The - default fill value of 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/caps/_z.py b/plotly/validators/isosurface/caps/_z.py deleted file mode 100644 index 73247955470..00000000000 --- a/plotly/validators/isosurface/caps/_z.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='z', parent_name='isosurface.caps', **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Z'), - data_docs=kwargs.pop( - 'data_docs', """ - fill - Sets the fill ratio of the `caps`. The default - fill value of 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. - show - Sets the fill ratio of the `slices`. The - default fill value of 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/caps/x/__init__.py b/plotly/validators/isosurface/caps/x/__init__.py index e0f8766d38e..c06213df54f 100644 --- a/plotly/validators/isosurface/caps/x/__init__.py +++ b/plotly/validators/isosurface/caps/x/__init__.py @@ -1,2 +1,36 @@ -from ._show import ShowValidator -from ._fill import FillValidator + + +import _plotly_utils.basevalidators + + +class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='show', parent_name='isosurface.caps.x', **kwargs + ): + super(ShowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='fill', parent_name='isosurface.caps.x', **kwargs + ): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/isosurface/caps/x/_fill.py b/plotly/validators/isosurface/caps/x/_fill.py deleted file mode 100644 index 7976034a1ca..00000000000 --- a/plotly/validators/isosurface/caps/x/_fill.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='fill', parent_name='isosurface.caps.x', **kwargs - ): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/caps/x/_show.py b/plotly/validators/isosurface/caps/x/_show.py deleted file mode 100644 index 658f70995c8..00000000000 --- a/plotly/validators/isosurface/caps/x/_show.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='show', parent_name='isosurface.caps.x', **kwargs - ): - super(ShowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/caps/y/__init__.py b/plotly/validators/isosurface/caps/y/__init__.py index e0f8766d38e..75b5bc93097 100644 --- a/plotly/validators/isosurface/caps/y/__init__.py +++ b/plotly/validators/isosurface/caps/y/__init__.py @@ -1,2 +1,36 @@ -from ._show import ShowValidator -from ._fill import FillValidator + + +import _plotly_utils.basevalidators + + +class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='show', parent_name='isosurface.caps.y', **kwargs + ): + super(ShowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='fill', parent_name='isosurface.caps.y', **kwargs + ): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/isosurface/caps/y/_fill.py b/plotly/validators/isosurface/caps/y/_fill.py deleted file mode 100644 index f110368325b..00000000000 --- a/plotly/validators/isosurface/caps/y/_fill.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='fill', parent_name='isosurface.caps.y', **kwargs - ): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/caps/y/_show.py b/plotly/validators/isosurface/caps/y/_show.py deleted file mode 100644 index 4432bfd776c..00000000000 --- a/plotly/validators/isosurface/caps/y/_show.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='show', parent_name='isosurface.caps.y', **kwargs - ): - super(ShowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/caps/z/__init__.py b/plotly/validators/isosurface/caps/z/__init__.py index e0f8766d38e..9d537585045 100644 --- a/plotly/validators/isosurface/caps/z/__init__.py +++ b/plotly/validators/isosurface/caps/z/__init__.py @@ -1,2 +1,36 @@ -from ._show import ShowValidator -from ._fill import FillValidator + + +import _plotly_utils.basevalidators + + +class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='show', parent_name='isosurface.caps.z', **kwargs + ): + super(ShowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='fill', parent_name='isosurface.caps.z', **kwargs + ): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/isosurface/caps/z/_fill.py b/plotly/validators/isosurface/caps/z/_fill.py deleted file mode 100644 index 142c0d8b812..00000000000 --- a/plotly/validators/isosurface/caps/z/_fill.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='fill', parent_name='isosurface.caps.z', **kwargs - ): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/caps/z/_show.py b/plotly/validators/isosurface/caps/z/_show.py deleted file mode 100644 index a10c578a258..00000000000 --- a/plotly/validators/isosurface/caps/z/_show.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='show', parent_name='isosurface.caps.z', **kwargs - ): - super(ShowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/__init__.py b/plotly/validators/isosurface/colorbar/__init__.py index 3dab31f7e02..faeaa10cc20 100644 --- a/plotly/validators/isosurface/colorbar/__init__.py +++ b/plotly/validators/isosurface/colorbar/__init__.py @@ -1,41 +1,909 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ypad', parent_name='isosurface.colorbar', **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='isosurface.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='isosurface.colorbar', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='xpad', parent_name='isosurface.colorbar', **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='isosurface.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='isosurface.colorbar', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='isosurface.colorbar', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='isosurface.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='isosurface.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='isosurface.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='isosurface.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='isosurface.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='isosurface.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ticks', parent_name='isosurface.colorbar', **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='isosurface.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='isosurface.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='isosurface.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='isosurface.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='isosurface.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='isosurface.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='isosurface.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='isosurface.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='isosurface.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='tick0', parent_name='isosurface.colorbar', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='isosurface.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='isosurface.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='isosurface.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='isosurface.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='isosurface.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='isosurface.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='isosurface.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='isosurface.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='isosurface.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='isosurface.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='isosurface.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='len', parent_name='isosurface.colorbar', **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='isosurface.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='dtick', parent_name='isosurface.colorbar', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='isosurface.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='isosurface.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='isosurface.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/isosurface/colorbar/_bgcolor.py b/plotly/validators/isosurface/colorbar/_bgcolor.py deleted file mode 100644 index f67be74ef59..00000000000 --- a/plotly/validators/isosurface/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='isosurface.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_bordercolor.py b/plotly/validators/isosurface/colorbar/_bordercolor.py deleted file mode 100644 index dd5ba4f191f..00000000000 --- a/plotly/validators/isosurface/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='isosurface.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_borderwidth.py b/plotly/validators/isosurface/colorbar/_borderwidth.py deleted file mode 100644 index 5e12e1011e3..00000000000 --- a/plotly/validators/isosurface/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='isosurface.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_dtick.py b/plotly/validators/isosurface/colorbar/_dtick.py deleted file mode 100644 index 206443a33fe..00000000000 --- a/plotly/validators/isosurface/colorbar/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='dtick', parent_name='isosurface.colorbar', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_exponentformat.py b/plotly/validators/isosurface/colorbar/_exponentformat.py deleted file mode 100644 index 632d94af228..00000000000 --- a/plotly/validators/isosurface/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='isosurface.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_len.py b/plotly/validators/isosurface/colorbar/_len.py deleted file mode 100644 index e4966793a2f..00000000000 --- a/plotly/validators/isosurface/colorbar/_len.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='len', parent_name='isosurface.colorbar', **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_lenmode.py b/plotly/validators/isosurface/colorbar/_lenmode.py deleted file mode 100644 index 840501a77b0..00000000000 --- a/plotly/validators/isosurface/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='isosurface.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_nticks.py b/plotly/validators/isosurface/colorbar/_nticks.py deleted file mode 100644 index a01ea993aee..00000000000 --- a/plotly/validators/isosurface/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='isosurface.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_outlinecolor.py b/plotly/validators/isosurface/colorbar/_outlinecolor.py deleted file mode 100644 index 5c8e7d04f12..00000000000 --- a/plotly/validators/isosurface/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='isosurface.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_outlinewidth.py b/plotly/validators/isosurface/colorbar/_outlinewidth.py deleted file mode 100644 index 97f780b3b6d..00000000000 --- a/plotly/validators/isosurface/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='isosurface.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_separatethousands.py b/plotly/validators/isosurface/colorbar/_separatethousands.py deleted file mode 100644 index d8cd0735529..00000000000 --- a/plotly/validators/isosurface/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='isosurface.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_showexponent.py b/plotly/validators/isosurface/colorbar/_showexponent.py deleted file mode 100644 index 4bed32eed53..00000000000 --- a/plotly/validators/isosurface/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='isosurface.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_showticklabels.py b/plotly/validators/isosurface/colorbar/_showticklabels.py deleted file mode 100644 index 08126b2ecde..00000000000 --- a/plotly/validators/isosurface/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='isosurface.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_showtickprefix.py b/plotly/validators/isosurface/colorbar/_showtickprefix.py deleted file mode 100644 index 762c6f06679..00000000000 --- a/plotly/validators/isosurface/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='isosurface.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_showticksuffix.py b/plotly/validators/isosurface/colorbar/_showticksuffix.py deleted file mode 100644 index 5dd82ff4c4f..00000000000 --- a/plotly/validators/isosurface/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='isosurface.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_thickness.py b/plotly/validators/isosurface/colorbar/_thickness.py deleted file mode 100644 index 7fab50dd598..00000000000 --- a/plotly/validators/isosurface/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='isosurface.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_thicknessmode.py b/plotly/validators/isosurface/colorbar/_thicknessmode.py deleted file mode 100644 index a3c7473f4fa..00000000000 --- a/plotly/validators/isosurface/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='isosurface.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_tick0.py b/plotly/validators/isosurface/colorbar/_tick0.py deleted file mode 100644 index 5f0e172f4f0..00000000000 --- a/plotly/validators/isosurface/colorbar/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='tick0', parent_name='isosurface.colorbar', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_tickangle.py b/plotly/validators/isosurface/colorbar/_tickangle.py deleted file mode 100644 index 5e3f1e924ea..00000000000 --- a/plotly/validators/isosurface/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='isosurface.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_tickcolor.py b/plotly/validators/isosurface/colorbar/_tickcolor.py deleted file mode 100644 index 8c128690d0e..00000000000 --- a/plotly/validators/isosurface/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='isosurface.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_tickfont.py b/plotly/validators/isosurface/colorbar/_tickfont.py deleted file mode 100644 index e27bc3382fc..00000000000 --- a/plotly/validators/isosurface/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='isosurface.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_tickformat.py b/plotly/validators/isosurface/colorbar/_tickformat.py deleted file mode 100644 index dbe77b34ddc..00000000000 --- a/plotly/validators/isosurface/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='isosurface.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_tickformatstopdefaults.py b/plotly/validators/isosurface/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 0580d323cba..00000000000 --- a/plotly/validators/isosurface/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='isosurface.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_tickformatstops.py b/plotly/validators/isosurface/colorbar/_tickformatstops.py deleted file mode 100644 index d73037b796a..00000000000 --- a/plotly/validators/isosurface/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='isosurface.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_ticklen.py b/plotly/validators/isosurface/colorbar/_ticklen.py deleted file mode 100644 index 055c4bf1b4e..00000000000 --- a/plotly/validators/isosurface/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='isosurface.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_tickmode.py b/plotly/validators/isosurface/colorbar/_tickmode.py deleted file mode 100644 index 8c2bfd508f2..00000000000 --- a/plotly/validators/isosurface/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='isosurface.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_tickprefix.py b/plotly/validators/isosurface/colorbar/_tickprefix.py deleted file mode 100644 index 41bd5837546..00000000000 --- a/plotly/validators/isosurface/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='isosurface.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_ticks.py b/plotly/validators/isosurface/colorbar/_ticks.py deleted file mode 100644 index b5339cac8c8..00000000000 --- a/plotly/validators/isosurface/colorbar/_ticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ticks', parent_name='isosurface.colorbar', **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_ticksuffix.py b/plotly/validators/isosurface/colorbar/_ticksuffix.py deleted file mode 100644 index 9f6025c825b..00000000000 --- a/plotly/validators/isosurface/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='isosurface.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_ticktext.py b/plotly/validators/isosurface/colorbar/_ticktext.py deleted file mode 100644 index 2c2e92e8f28..00000000000 --- a/plotly/validators/isosurface/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='isosurface.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_ticktextsrc.py b/plotly/validators/isosurface/colorbar/_ticktextsrc.py deleted file mode 100644 index 2e14155435d..00000000000 --- a/plotly/validators/isosurface/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='isosurface.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_tickvals.py b/plotly/validators/isosurface/colorbar/_tickvals.py deleted file mode 100644 index 116a24bfd89..00000000000 --- a/plotly/validators/isosurface/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='isosurface.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_tickvalssrc.py b/plotly/validators/isosurface/colorbar/_tickvalssrc.py deleted file mode 100644 index 3a47ee016f1..00000000000 --- a/plotly/validators/isosurface/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='isosurface.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_tickwidth.py b/plotly/validators/isosurface/colorbar/_tickwidth.py deleted file mode 100644 index 2ecca07c112..00000000000 --- a/plotly/validators/isosurface/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='isosurface.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_title.py b/plotly/validators/isosurface/colorbar/_title.py deleted file mode 100644 index f8cc2c9f414..00000000000 --- a/plotly/validators/isosurface/colorbar/_title.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='isosurface.colorbar', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_x.py b/plotly/validators/isosurface/colorbar/_x.py deleted file mode 100644 index 2f52f6759da..00000000000 --- a/plotly/validators/isosurface/colorbar/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='isosurface.colorbar', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_xanchor.py b/plotly/validators/isosurface/colorbar/_xanchor.py deleted file mode 100644 index e4692db9911..00000000000 --- a/plotly/validators/isosurface/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='isosurface.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_xpad.py b/plotly/validators/isosurface/colorbar/_xpad.py deleted file mode 100644 index 284b0f39a35..00000000000 --- a/plotly/validators/isosurface/colorbar/_xpad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='xpad', parent_name='isosurface.colorbar', **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_y.py b/plotly/validators/isosurface/colorbar/_y.py deleted file mode 100644 index c7e106701f6..00000000000 --- a/plotly/validators/isosurface/colorbar/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='isosurface.colorbar', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_yanchor.py b/plotly/validators/isosurface/colorbar/_yanchor.py deleted file mode 100644 index c11fb3c09f3..00000000000 --- a/plotly/validators/isosurface/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='isosurface.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/_ypad.py b/plotly/validators/isosurface/colorbar/_ypad.py deleted file mode 100644 index e5ec12c6cfc..00000000000 --- a/plotly/validators/isosurface/colorbar/_ypad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ypad', parent_name='isosurface.colorbar', **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/tickfont/__init__.py b/plotly/validators/isosurface/colorbar/tickfont/__init__.py index 199d72e71c6..45fd67126d1 100644 --- a/plotly/validators/isosurface/colorbar/tickfont/__init__.py +++ b/plotly/validators/isosurface/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='isosurface.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='isosurface.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='isosurface.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/isosurface/colorbar/tickfont/_color.py b/plotly/validators/isosurface/colorbar/tickfont/_color.py deleted file mode 100644 index 213196b74f0..00000000000 --- a/plotly/validators/isosurface/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='isosurface.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/tickfont/_family.py b/plotly/validators/isosurface/colorbar/tickfont/_family.py deleted file mode 100644 index c1302041913..00000000000 --- a/plotly/validators/isosurface/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='isosurface.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/tickfont/_size.py b/plotly/validators/isosurface/colorbar/tickfont/_size.py deleted file mode 100644 index 5f13c8f5161..00000000000 --- a/plotly/validators/isosurface/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='isosurface.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/tickformatstop/__init__.py b/plotly/validators/isosurface/colorbar/tickformatstop/__init__.py index 3f6c06cac47..f68ba700dbb 100644 --- a/plotly/validators/isosurface/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/isosurface/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='isosurface.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='isosurface.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='isosurface.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='isosurface.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='isosurface.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'calc' + }, { + 'valType': 'any', + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/isosurface/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/isosurface/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 00d370868a7..00000000000 --- a/plotly/validators/isosurface/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='isosurface.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'calc' - }, { - 'valType': 'any', - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/tickformatstop/_enabled.py b/plotly/validators/isosurface/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index b9f023c4626..00000000000 --- a/plotly/validators/isosurface/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='isosurface.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/tickformatstop/_name.py b/plotly/validators/isosurface/colorbar/tickformatstop/_name.py deleted file mode 100644 index d2ee8a323f8..00000000000 --- a/plotly/validators/isosurface/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='isosurface.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/isosurface/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 7b2ffe2cfdc..00000000000 --- a/plotly/validators/isosurface/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='isosurface.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/tickformatstop/_value.py b/plotly/validators/isosurface/colorbar/tickformatstop/_value.py deleted file mode 100644 index 3cd791123aa..00000000000 --- a/plotly/validators/isosurface/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='isosurface.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/title/__init__.py b/plotly/validators/isosurface/colorbar/title/__init__.py index 33c9c145bb8..c51e0dd3ab7 100644 --- a/plotly/validators/isosurface/colorbar/title/__init__.py +++ b/plotly/validators/isosurface/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='isosurface.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='isosurface.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='isosurface.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/isosurface/colorbar/title/_font.py b/plotly/validators/isosurface/colorbar/title/_font.py deleted file mode 100644 index 5b1ff79f337..00000000000 --- a/plotly/validators/isosurface/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='isosurface.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/title/_side.py b/plotly/validators/isosurface/colorbar/title/_side.py deleted file mode 100644 index ebd403ecc90..00000000000 --- a/plotly/validators/isosurface/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='isosurface.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/title/_text.py b/plotly/validators/isosurface/colorbar/title/_text.py deleted file mode 100644 index 65288a576d9..00000000000 --- a/plotly/validators/isosurface/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='isosurface.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/title/font/__init__.py b/plotly/validators/isosurface/colorbar/title/font/__init__.py index 199d72e71c6..0353a0e6204 100644 --- a/plotly/validators/isosurface/colorbar/title/font/__init__.py +++ b/plotly/validators/isosurface/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='isosurface.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='isosurface.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='isosurface.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/isosurface/colorbar/title/font/_color.py b/plotly/validators/isosurface/colorbar/title/font/_color.py deleted file mode 100644 index 3d45a80274d..00000000000 --- a/plotly/validators/isosurface/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='isosurface.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/title/font/_family.py b/plotly/validators/isosurface/colorbar/title/font/_family.py deleted file mode 100644 index b2b850dc19f..00000000000 --- a/plotly/validators/isosurface/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='isosurface.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/isosurface/colorbar/title/font/_size.py b/plotly/validators/isosurface/colorbar/title/font/_size.py deleted file mode 100644 index d3eff3eb9de..00000000000 --- a/plotly/validators/isosurface/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='isosurface.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/contour/__init__.py b/plotly/validators/isosurface/contour/__init__.py index 54b6fd53570..7203fcfeda6 100644 --- a/plotly/validators/isosurface/contour/__init__.py +++ b/plotly/validators/isosurface/contour/__init__.py @@ -1,3 +1,53 @@ -from ._width import WidthValidator -from ._show import ShowValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='isosurface.contour', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 16), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='show', parent_name='isosurface.contour', **kwargs + ): + super(ShowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='isosurface.contour', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/isosurface/contour/_color.py b/plotly/validators/isosurface/contour/_color.py deleted file mode 100644 index 5c6bf331ddb..00000000000 --- a/plotly/validators/isosurface/contour/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='isosurface.contour', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/contour/_show.py b/plotly/validators/isosurface/contour/_show.py deleted file mode 100644 index 28ffd477d11..00000000000 --- a/plotly/validators/isosurface/contour/_show.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='show', parent_name='isosurface.contour', **kwargs - ): - super(ShowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/contour/_width.py b/plotly/validators/isosurface/contour/_width.py deleted file mode 100644 index eb0e96e3d6f..00000000000 --- a/plotly/validators/isosurface/contour/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='isosurface.contour', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 16), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/hoverlabel/__init__.py b/plotly/validators/isosurface/hoverlabel/__init__.py index 856f769ba33..f0be91c0d73 100644 --- a/plotly/validators/isosurface/hoverlabel/__init__.py +++ b/plotly/validators/isosurface/hoverlabel/__init__.py @@ -1,7 +1,176 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='isosurface.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='isosurface.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='isosurface.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='isosurface.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='isosurface.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='isosurface.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='isosurface.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/isosurface/hoverlabel/_bgcolor.py b/plotly/validators/isosurface/hoverlabel/_bgcolor.py deleted file mode 100644 index 4101d1e684d..00000000000 --- a/plotly/validators/isosurface/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='isosurface.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/hoverlabel/_bgcolorsrc.py b/plotly/validators/isosurface/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 262798ec018..00000000000 --- a/plotly/validators/isosurface/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='isosurface.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/hoverlabel/_bordercolor.py b/plotly/validators/isosurface/hoverlabel/_bordercolor.py deleted file mode 100644 index 2e92bea6ae1..00000000000 --- a/plotly/validators/isosurface/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='isosurface.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/hoverlabel/_bordercolorsrc.py b/plotly/validators/isosurface/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index a1e36c3dd21..00000000000 --- a/plotly/validators/isosurface/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='isosurface.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/hoverlabel/_font.py b/plotly/validators/isosurface/hoverlabel/_font.py deleted file mode 100644 index 0a2ea3f8c78..00000000000 --- a/plotly/validators/isosurface/hoverlabel/_font.py +++ /dev/null @@ -1,50 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='isosurface.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/hoverlabel/_namelength.py b/plotly/validators/isosurface/hoverlabel/_namelength.py deleted file mode 100644 index 8f6a47116cb..00000000000 --- a/plotly/validators/isosurface/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='isosurface.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/hoverlabel/_namelengthsrc.py b/plotly/validators/isosurface/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 547c954dc5a..00000000000 --- a/plotly/validators/isosurface/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='isosurface.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/hoverlabel/font/__init__.py b/plotly/validators/isosurface/hoverlabel/font/__init__.py index 1d2c591d1e5..1d14f870180 100644 --- a/plotly/validators/isosurface/hoverlabel/font/__init__.py +++ b/plotly/validators/isosurface/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='isosurface.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='isosurface.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='isosurface.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='isosurface.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='isosurface.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='isosurface.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/isosurface/hoverlabel/font/_color.py b/plotly/validators/isosurface/hoverlabel/font/_color.py deleted file mode 100644 index d765492098e..00000000000 --- a/plotly/validators/isosurface/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='isosurface.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/hoverlabel/font/_colorsrc.py b/plotly/validators/isosurface/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 4c8ef9ea07a..00000000000 --- a/plotly/validators/isosurface/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='isosurface.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/hoverlabel/font/_family.py b/plotly/validators/isosurface/hoverlabel/font/_family.py deleted file mode 100644 index 2edb2b6d1ba..00000000000 --- a/plotly/validators/isosurface/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='isosurface.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/isosurface/hoverlabel/font/_familysrc.py b/plotly/validators/isosurface/hoverlabel/font/_familysrc.py deleted file mode 100644 index 1442290134e..00000000000 --- a/plotly/validators/isosurface/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='isosurface.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/hoverlabel/font/_size.py b/plotly/validators/isosurface/hoverlabel/font/_size.py deleted file mode 100644 index 3f3369eea7e..00000000000 --- a/plotly/validators/isosurface/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='isosurface.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/hoverlabel/font/_sizesrc.py b/plotly/validators/isosurface/hoverlabel/font/_sizesrc.py deleted file mode 100644 index a389c42d830..00000000000 --- a/plotly/validators/isosurface/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='isosurface.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/lighting/__init__.py b/plotly/validators/isosurface/lighting/__init__.py index 6abe696b0d7..6940704dec9 100644 --- a/plotly/validators/isosurface/lighting/__init__.py +++ b/plotly/validators/isosurface/lighting/__init__.py @@ -1,7 +1,158 @@ -from ._vertexnormalsepsilon import VertexnormalsepsilonValidator -from ._specular import SpecularValidator -from ._roughness import RoughnessValidator -from ._fresnel import FresnelValidator -from ._facenormalsepsilon import FacenormalsepsilonValidator -from ._diffuse import DiffuseValidator -from ._ambient import AmbientValidator + + +import _plotly_utils.basevalidators + + +class VertexnormalsepsilonValidator( + _plotly_utils.basevalidators.NumberValidator +): + + def __init__( + self, + plotly_name='vertexnormalsepsilon', + parent_name='isosurface.lighting', + **kwargs + ): + super(VertexnormalsepsilonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpecularValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='specular', + parent_name='isosurface.lighting', + **kwargs + ): + super(SpecularValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 2), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RoughnessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='roughness', + parent_name='isosurface.lighting', + **kwargs + ): + super(RoughnessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FresnelValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='fresnel', + parent_name='isosurface.lighting', + **kwargs + ): + super(FresnelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 5), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FacenormalsepsilonValidator( + _plotly_utils.basevalidators.NumberValidator +): + + def __init__( + self, + plotly_name='facenormalsepsilon', + parent_name='isosurface.lighting', + **kwargs + ): + super(FacenormalsepsilonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DiffuseValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='diffuse', + parent_name='isosurface.lighting', + **kwargs + ): + super(DiffuseValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AmbientValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ambient', + parent_name='isosurface.lighting', + **kwargs + ): + super(AmbientValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/isosurface/lighting/_ambient.py b/plotly/validators/isosurface/lighting/_ambient.py deleted file mode 100644 index aed32bebdaa..00000000000 --- a/plotly/validators/isosurface/lighting/_ambient.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class AmbientValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ambient', - parent_name='isosurface.lighting', - **kwargs - ): - super(AmbientValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/lighting/_diffuse.py b/plotly/validators/isosurface/lighting/_diffuse.py deleted file mode 100644 index ae3e1430c54..00000000000 --- a/plotly/validators/isosurface/lighting/_diffuse.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class DiffuseValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='diffuse', - parent_name='isosurface.lighting', - **kwargs - ): - super(DiffuseValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/lighting/_facenormalsepsilon.py b/plotly/validators/isosurface/lighting/_facenormalsepsilon.py deleted file mode 100644 index fbb7874e2a8..00000000000 --- a/plotly/validators/isosurface/lighting/_facenormalsepsilon.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class FacenormalsepsilonValidator( - _plotly_utils.basevalidators.NumberValidator -): - - def __init__( - self, - plotly_name='facenormalsepsilon', - parent_name='isosurface.lighting', - **kwargs - ): - super(FacenormalsepsilonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/lighting/_fresnel.py b/plotly/validators/isosurface/lighting/_fresnel.py deleted file mode 100644 index b9c974196fc..00000000000 --- a/plotly/validators/isosurface/lighting/_fresnel.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FresnelValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='fresnel', - parent_name='isosurface.lighting', - **kwargs - ): - super(FresnelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 5), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/lighting/_roughness.py b/plotly/validators/isosurface/lighting/_roughness.py deleted file mode 100644 index a9f3eb652c3..00000000000 --- a/plotly/validators/isosurface/lighting/_roughness.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class RoughnessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='roughness', - parent_name='isosurface.lighting', - **kwargs - ): - super(RoughnessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/lighting/_specular.py b/plotly/validators/isosurface/lighting/_specular.py deleted file mode 100644 index 47c09ab414d..00000000000 --- a/plotly/validators/isosurface/lighting/_specular.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpecularValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='specular', - parent_name='isosurface.lighting', - **kwargs - ): - super(SpecularValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 2), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/lighting/_vertexnormalsepsilon.py b/plotly/validators/isosurface/lighting/_vertexnormalsepsilon.py deleted file mode 100644 index 9ebeb04a85f..00000000000 --- a/plotly/validators/isosurface/lighting/_vertexnormalsepsilon.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class VertexnormalsepsilonValidator( - _plotly_utils.basevalidators.NumberValidator -): - - def __init__( - self, - plotly_name='vertexnormalsepsilon', - parent_name='isosurface.lighting', - **kwargs - ): - super(VertexnormalsepsilonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/lightposition/__init__.py b/plotly/validators/isosurface/lightposition/__init__.py index 438e2dc9c6d..63557d37d9b 100644 --- a/plotly/validators/isosurface/lightposition/__init__.py +++ b/plotly/validators/isosurface/lightposition/__init__.py @@ -1,3 +1,66 @@ -from ._z import ZValidator -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='z', + parent_name='isosurface.lightposition', + **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 100000), + min=kwargs.pop('min', -100000), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='y', + parent_name='isosurface.lightposition', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 100000), + min=kwargs.pop('min', -100000), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='x', + parent_name='isosurface.lightposition', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 100000), + min=kwargs.pop('min', -100000), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/isosurface/lightposition/_x.py b/plotly/validators/isosurface/lightposition/_x.py deleted file mode 100644 index b3eb8ed6f55..00000000000 --- a/plotly/validators/isosurface/lightposition/_x.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='x', - parent_name='isosurface.lightposition', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 100000), - min=kwargs.pop('min', -100000), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/lightposition/_y.py b/plotly/validators/isosurface/lightposition/_y.py deleted file mode 100644 index 7042245afd8..00000000000 --- a/plotly/validators/isosurface/lightposition/_y.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='y', - parent_name='isosurface.lightposition', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 100000), - min=kwargs.pop('min', -100000), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/lightposition/_z.py b/plotly/validators/isosurface/lightposition/_z.py deleted file mode 100644 index 7fcfe8b99b6..00000000000 --- a/plotly/validators/isosurface/lightposition/_z.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='z', - parent_name='isosurface.lightposition', - **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 100000), - min=kwargs.pop('min', -100000), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/slices/__init__.py b/plotly/validators/isosurface/slices/__init__.py index 438e2dc9c6d..44afe7fe5ea 100644 --- a/plotly/validators/isosurface/slices/__init__.py +++ b/plotly/validators/isosurface/slices/__init__.py @@ -1,3 +1,114 @@ -from ._z import ZValidator -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='z', parent_name='isosurface.slices', **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Z'), + data_docs=kwargs.pop( + 'data_docs', """ + fill + Sets the fill ratio of the `slices`. The + default fill value of 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. + locations + Specifies the location(s) of slices on the + axis. When not locations specified slices would + be created for all points of the axis z except + start and end. + locationssrc + Sets the source reference on plot.ly for + locations . + show + Determines whether or not slice planes about + the z dimension are drawn. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='y', parent_name='isosurface.slices', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Y'), + data_docs=kwargs.pop( + 'data_docs', """ + fill + Sets the fill ratio of the `slices`. The + default fill value of 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. + locations + Specifies the location(s) of slices on the + axis. When not locations specified slices would + be created for all points of the axis y except + start and end. + locationssrc + Sets the source reference on plot.ly for + locations . + show + Determines whether or not slice planes about + the y dimension are drawn. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='x', parent_name='isosurface.slices', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'X'), + data_docs=kwargs.pop( + 'data_docs', """ + fill + Sets the fill ratio of the `slices`. The + default fill value of 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. + locations + Specifies the location(s) of slices on the + axis. When not locations specified slices would + be created for all points of the axis x except + start and end. + locationssrc + Sets the source reference on plot.ly for + locations . + show + Determines whether or not slice planes about + the x dimension are drawn. +""" + ), + **kwargs + ) diff --git a/plotly/validators/isosurface/slices/_x.py b/plotly/validators/isosurface/slices/_x.py deleted file mode 100644 index c8348a9cfd9..00000000000 --- a/plotly/validators/isosurface/slices/_x.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='x', parent_name='isosurface.slices', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'X'), - data_docs=kwargs.pop( - 'data_docs', """ - fill - Sets the fill ratio of the `slices`. The - default fill value of 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. - locations - Specifies the location(s) of slices on the - axis. When not locations specified slices would - be created for all points of the axis x except - start and end. - locationssrc - Sets the source reference on plot.ly for - locations . - show - Determines whether or not slice planes about - the x dimension are drawn. -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/slices/_y.py b/plotly/validators/isosurface/slices/_y.py deleted file mode 100644 index e2f7ddf6802..00000000000 --- a/plotly/validators/isosurface/slices/_y.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='y', parent_name='isosurface.slices', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Y'), - data_docs=kwargs.pop( - 'data_docs', """ - fill - Sets the fill ratio of the `slices`. The - default fill value of 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. - locations - Specifies the location(s) of slices on the - axis. When not locations specified slices would - be created for all points of the axis y except - start and end. - locationssrc - Sets the source reference on plot.ly for - locations . - show - Determines whether or not slice planes about - the y dimension are drawn. -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/slices/_z.py b/plotly/validators/isosurface/slices/_z.py deleted file mode 100644 index b1701ae5e70..00000000000 --- a/plotly/validators/isosurface/slices/_z.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='z', parent_name='isosurface.slices', **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Z'), - data_docs=kwargs.pop( - 'data_docs', """ - fill - Sets the fill ratio of the `slices`. The - default fill value of 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. - locations - Specifies the location(s) of slices on the - axis. When not locations specified slices would - be created for all points of the axis z except - start and end. - locationssrc - Sets the source reference on plot.ly for - locations . - show - Determines whether or not slice planes about - the z dimension are drawn. -""" - ), - **kwargs - ) diff --git a/plotly/validators/isosurface/slices/x/__init__.py b/plotly/validators/isosurface/slices/x/__init__.py index 19a9c5d82a3..a075f48dae5 100644 --- a/plotly/validators/isosurface/slices/x/__init__.py +++ b/plotly/validators/isosurface/slices/x/__init__.py @@ -1,4 +1,76 @@ -from ._show import ShowValidator -from ._locationssrc import LocationssrcValidator -from ._locations import LocationsValidator -from ._fill import FillValidator + + +import _plotly_utils.basevalidators + + +class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='show', parent_name='isosurface.slices.x', **kwargs + ): + super(ShowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LocationssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='locationssrc', + parent_name='isosurface.slices.x', + **kwargs + ): + super(LocationssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LocationsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='locations', + parent_name='isosurface.slices.x', + **kwargs + ): + super(LocationsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='fill', parent_name='isosurface.slices.x', **kwargs + ): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/isosurface/slices/x/_fill.py b/plotly/validators/isosurface/slices/x/_fill.py deleted file mode 100644 index 148bc98ffa0..00000000000 --- a/plotly/validators/isosurface/slices/x/_fill.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='fill', parent_name='isosurface.slices.x', **kwargs - ): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/slices/x/_locations.py b/plotly/validators/isosurface/slices/x/_locations.py deleted file mode 100644 index 53a8c8224dc..00000000000 --- a/plotly/validators/isosurface/slices/x/_locations.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LocationsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='locations', - parent_name='isosurface.slices.x', - **kwargs - ): - super(LocationsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/isosurface/slices/x/_locationssrc.py b/plotly/validators/isosurface/slices/x/_locationssrc.py deleted file mode 100644 index 1e094f884e9..00000000000 --- a/plotly/validators/isosurface/slices/x/_locationssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LocationssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='locationssrc', - parent_name='isosurface.slices.x', - **kwargs - ): - super(LocationssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/slices/x/_show.py b/plotly/validators/isosurface/slices/x/_show.py deleted file mode 100644 index d96be484ce3..00000000000 --- a/plotly/validators/isosurface/slices/x/_show.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='show', parent_name='isosurface.slices.x', **kwargs - ): - super(ShowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/slices/y/__init__.py b/plotly/validators/isosurface/slices/y/__init__.py index 19a9c5d82a3..f6cc41f1620 100644 --- a/plotly/validators/isosurface/slices/y/__init__.py +++ b/plotly/validators/isosurface/slices/y/__init__.py @@ -1,4 +1,76 @@ -from ._show import ShowValidator -from ._locationssrc import LocationssrcValidator -from ._locations import LocationsValidator -from ._fill import FillValidator + + +import _plotly_utils.basevalidators + + +class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='show', parent_name='isosurface.slices.y', **kwargs + ): + super(ShowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LocationssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='locationssrc', + parent_name='isosurface.slices.y', + **kwargs + ): + super(LocationssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LocationsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='locations', + parent_name='isosurface.slices.y', + **kwargs + ): + super(LocationsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='fill', parent_name='isosurface.slices.y', **kwargs + ): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/isosurface/slices/y/_fill.py b/plotly/validators/isosurface/slices/y/_fill.py deleted file mode 100644 index 64eb4223a4e..00000000000 --- a/plotly/validators/isosurface/slices/y/_fill.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='fill', parent_name='isosurface.slices.y', **kwargs - ): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/slices/y/_locations.py b/plotly/validators/isosurface/slices/y/_locations.py deleted file mode 100644 index b9e684cb45f..00000000000 --- a/plotly/validators/isosurface/slices/y/_locations.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LocationsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='locations', - parent_name='isosurface.slices.y', - **kwargs - ): - super(LocationsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/isosurface/slices/y/_locationssrc.py b/plotly/validators/isosurface/slices/y/_locationssrc.py deleted file mode 100644 index a490186e8d2..00000000000 --- a/plotly/validators/isosurface/slices/y/_locationssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LocationssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='locationssrc', - parent_name='isosurface.slices.y', - **kwargs - ): - super(LocationssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/slices/y/_show.py b/plotly/validators/isosurface/slices/y/_show.py deleted file mode 100644 index b6505e91c7b..00000000000 --- a/plotly/validators/isosurface/slices/y/_show.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='show', parent_name='isosurface.slices.y', **kwargs - ): - super(ShowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/slices/z/__init__.py b/plotly/validators/isosurface/slices/z/__init__.py index 19a9c5d82a3..e76823b8fa9 100644 --- a/plotly/validators/isosurface/slices/z/__init__.py +++ b/plotly/validators/isosurface/slices/z/__init__.py @@ -1,4 +1,76 @@ -from ._show import ShowValidator -from ._locationssrc import LocationssrcValidator -from ._locations import LocationsValidator -from ._fill import FillValidator + + +import _plotly_utils.basevalidators + + +class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='show', parent_name='isosurface.slices.z', **kwargs + ): + super(ShowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LocationssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='locationssrc', + parent_name='isosurface.slices.z', + **kwargs + ): + super(LocationssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LocationsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='locations', + parent_name='isosurface.slices.z', + **kwargs + ): + super(LocationsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='fill', parent_name='isosurface.slices.z', **kwargs + ): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/isosurface/slices/z/_fill.py b/plotly/validators/isosurface/slices/z/_fill.py deleted file mode 100644 index 71b24b78302..00000000000 --- a/plotly/validators/isosurface/slices/z/_fill.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='fill', parent_name='isosurface.slices.z', **kwargs - ): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/slices/z/_locations.py b/plotly/validators/isosurface/slices/z/_locations.py deleted file mode 100644 index 8295e5b165c..00000000000 --- a/plotly/validators/isosurface/slices/z/_locations.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LocationsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='locations', - parent_name='isosurface.slices.z', - **kwargs - ): - super(LocationsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/isosurface/slices/z/_locationssrc.py b/plotly/validators/isosurface/slices/z/_locationssrc.py deleted file mode 100644 index 80a269ad1b3..00000000000 --- a/plotly/validators/isosurface/slices/z/_locationssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LocationssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='locationssrc', - parent_name='isosurface.slices.z', - **kwargs - ): - super(LocationssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/slices/z/_show.py b/plotly/validators/isosurface/slices/z/_show.py deleted file mode 100644 index 69cb672b9b0..00000000000 --- a/plotly/validators/isosurface/slices/z/_show.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='show', parent_name='isosurface.slices.z', **kwargs - ): - super(ShowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/spaceframe/__init__.py b/plotly/validators/isosurface/spaceframe/__init__.py index e0f8766d38e..40b58e7ec5b 100644 --- a/plotly/validators/isosurface/spaceframe/__init__.py +++ b/plotly/validators/isosurface/spaceframe/__init__.py @@ -1,2 +1,42 @@ -from ._show import ShowValidator -from ._fill import FillValidator + + +import _plotly_utils.basevalidators + + +class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='show', + parent_name='isosurface.spaceframe', + **kwargs + ): + super(ShowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='fill', + parent_name='isosurface.spaceframe', + **kwargs + ): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/isosurface/spaceframe/_fill.py b/plotly/validators/isosurface/spaceframe/_fill.py deleted file mode 100644 index befdd172c0c..00000000000 --- a/plotly/validators/isosurface/spaceframe/_fill.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='fill', - parent_name='isosurface.spaceframe', - **kwargs - ): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/spaceframe/_show.py b/plotly/validators/isosurface/spaceframe/_show.py deleted file mode 100644 index f7da54eb054..00000000000 --- a/plotly/validators/isosurface/spaceframe/_show.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='show', - parent_name='isosurface.spaceframe', - **kwargs - ): - super(ShowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/stream/__init__.py b/plotly/validators/isosurface/stream/__init__.py index 2f4f2047594..6bd33b2072b 100644 --- a/plotly/validators/isosurface/stream/__init__.py +++ b/plotly/validators/isosurface/stream/__init__.py @@ -1,2 +1,41 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='isosurface.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='isosurface.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/isosurface/stream/_maxpoints.py b/plotly/validators/isosurface/stream/_maxpoints.py deleted file mode 100644 index d8f8983c003..00000000000 --- a/plotly/validators/isosurface/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='isosurface.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/stream/_token.py b/plotly/validators/isosurface/stream/_token.py deleted file mode 100644 index d3c661a08d9..00000000000 --- a/plotly/validators/isosurface/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='isosurface.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/isosurface/surface/__init__.py b/plotly/validators/isosurface/surface/__init__.py index e16b616d1b3..1fd0b90289e 100644 --- a/plotly/validators/isosurface/surface/__init__.py +++ b/plotly/validators/isosurface/surface/__init__.py @@ -1,4 +1,76 @@ -from ._show import ShowValidator -from ._pattern import PatternValidator -from ._fill import FillValidator -from ._count import CountValidator + + +import _plotly_utils.basevalidators + + +class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='show', parent_name='isosurface.surface', **kwargs + ): + super(ShowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PatternValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, + plotly_name='pattern', + parent_name='isosurface.surface', + **kwargs + ): + super(PatternValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['all', 'odd', 'even']), + flags=kwargs.pop('flags', ['A', 'B', 'C', 'D', 'E']), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='fill', parent_name='isosurface.surface', **kwargs + ): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CountValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='count', parent_name='isosurface.surface', **kwargs + ): + super(CountValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/isosurface/surface/_count.py b/plotly/validators/isosurface/surface/_count.py deleted file mode 100644 index 9f96db74e60..00000000000 --- a/plotly/validators/isosurface/surface/_count.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CountValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='count', parent_name='isosurface.surface', **kwargs - ): - super(CountValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/isosurface/surface/_fill.py b/plotly/validators/isosurface/surface/_fill.py deleted file mode 100644 index 9ab3e2e9888..00000000000 --- a/plotly/validators/isosurface/surface/_fill.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='fill', parent_name='isosurface.surface', **kwargs - ): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/surface/_pattern.py b/plotly/validators/isosurface/surface/_pattern.py deleted file mode 100644 index e02a39ec285..00000000000 --- a/plotly/validators/isosurface/surface/_pattern.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class PatternValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, - plotly_name='pattern', - parent_name='isosurface.surface', - **kwargs - ): - super(PatternValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['all', 'odd', 'even']), - flags=kwargs.pop('flags', ['A', 'B', 'C', 'D', 'E']), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/isosurface/surface/_show.py b/plotly/validators/isosurface/surface/_show.py deleted file mode 100644 index 4aeb364baaf..00000000000 --- a/plotly/validators/isosurface/surface/_show.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='show', parent_name='isosurface.surface', **kwargs - ): - super(ShowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/__init__.py b/plotly/validators/layout/__init__.py index 0b045709d4d..871f729089d 100644 --- a/plotly/validators/layout/__init__.py +++ b/plotly/validators/layout/__init__.py @@ -1,67 +1,3259 @@ -from ._yaxis import YAxisValidator -from ._xaxis import XAxisValidator -from ._width import WidthValidator -from ._violinmode import ViolinmodeValidator -from ._violingroupgap import ViolingroupgapValidator -from ._violingap import ViolingapValidator -from ._updatemenudefaults import UpdatemenuValidator -from ._updatemenus import UpdatemenusValidator -from ._uirevision import UirevisionValidator -from ._transition import TransitionValidator -from ._title import TitleValidator -from ._ternary import TernaryValidator -from ._template import TemplateValidator -from ._spikedistance import SpikedistanceValidator -from ._sliderdefaults import SliderValidator -from ._sliders import SlidersValidator -from ._showlegend import ShowlegendValidator -from ._shapedefaults import ShapeValidator -from ._shapes import ShapesValidator -from ._separators import SeparatorsValidator -from ._selectionrevision import SelectionrevisionValidator -from ._selectdirection import SelectdirectionValidator -from ._scene import SceneValidator -from ._radialaxis import RadialAxisValidator -from ._polar import PolarValidator -from ._plot_bgcolor import PlotBgcolorValidator -from ._piecolorway import PiecolorwayValidator -from ._paper_bgcolor import PaperBgcolorValidator -from ._orientation import OrientationValidator -from ._modebar import ModebarValidator -from ._metasrc import MetasrcValidator -from ._meta import MetaValidator -from ._margin import MarginValidator -from ._mapbox import MapboxValidator -from ._legend import LegendValidator -from ._imagedefaults import ImageValidator -from ._images import ImagesValidator -from ._hovermode import HovermodeValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverdistance import HoverdistanceValidator -from ._hidesources import HidesourcesValidator -from ._hiddenlabelssrc import HiddenlabelssrcValidator -from ._hiddenlabels import HiddenlabelsValidator -from ._height import HeightValidator -from ._grid import GridValidator -from ._geo import GeoValidator -from ._font import FontValidator -from ._extendpiecolors import ExtendpiecolorsValidator -from ._editrevision import EditrevisionValidator -from ._dragmode import DragmodeValidator -from ._direction import DirectionValidator -from ._datarevision import DatarevisionValidator -from ._colorway import ColorwayValidator -from ._colorscale import ColorscaleValidator -from ._clickmode import ClickmodeValidator -from ._calendar import CalendarValidator -from ._boxmode import BoxmodeValidator -from ._boxgroupgap import BoxgroupgapValidator -from ._boxgap import BoxgapValidator -from ._barnorm import BarnormValidator -from ._barmode import BarmodeValidator -from ._bargroupgap import BargroupgapValidator -from ._bargap import BargapValidator -from ._autosize import AutosizeValidator -from ._annotationdefaults import AnnotationValidator -from ._annotations import AnnotationsValidator -from ._angularaxis import AngularAxisValidator + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='yaxis', parent_name='layout', **kwargs): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'YAxis'), + data_docs=kwargs.pop( + 'data_docs', """ + anchor + If set to an opposite-letter axis id (e.g. + `x2`, `y`), this axis is bound to the + corresponding opposite-letter axis. If set to + "free", this axis' position is determined by + `position`. + automargin + Determines whether long tick labels + automatically grow the figure margins. + autorange + Determines whether or not the range of this + axis is computed in relation to the input data. + See `rangemode` for more info. If `range` is + provided, then `autorange` is set to False. + calendar + Sets the calendar system to use for `range` and + `tick0` if this is a date axis. This does not + set the calendar for interpreting data on this + axis, that's specified in the trace or via the + global `layout.calendar` + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + constrain + If this axis needs to be compressed (either due + to its own `scaleanchor` and `scaleratio` or + those of the other axis), determines how that + happens: by increasing the "range" (default), + or by decreasing the "domain". + constraintoward + If this axis needs to be compressed (either due + to its own `scaleanchor` and `scaleratio` or + those of the other axis), determines which + direction we push the originally specified plot + area. Options are "left", "center" (default), + and "right" for x axes, and "top", "middle" + (default), and "bottom" for y axes. + dividercolor + Sets the color of the dividers Only has an + effect on "multicategory" axes. + dividerwidth + Sets the width (in px) of the dividers Only has + an effect on "multicategory" axes. + domain + Sets the domain of this axis (in plot + fraction). + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom- + able. If true, then zoom is disabled. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + layer + Sets the layer on which this axis is displayed. + If *above traces*, this axis is displayed above + all the subplot's traces If *below traces*, + this axis is displayed below all the subplot's + traces, but above the grid lines. Useful when + used together with scatter-like traces with + `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + matches + If set to another axis id (e.g. `x2`, `y`), the + range of this axis will match the range of the + corresponding axis in data-coordinates space. + Moreover, matching axes share auto-range + values, category lists and histogram auto-bins. + Note that setting axes simultaneously in both a + `scaleanchor` and a `matches` constraint is + currently forbidden. Moreover, note that + matching axes must have the same `type`. + mirror + Determines if the axis lines or/and ticks are + mirrored to the opposite side of the plotting + area. If True, the axis lines are mirrored. If + "ticks", the axis lines and ticks are mirrored. + If False, mirroring is disable. If "all", axis + lines are mirrored on all shared-axes subplots. + If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + overlaying + If set a same-letter axis id, this axis is + overlaid on top of the corresponding same- + letter axis, with traces and axes visible for + both axes. If False, this axis does not overlay + any same-letter axes. In this case, for axes + with overlapping domains only the highest- + numbered axis will be visible. + position + Sets the position of this axis in the plotting + space (in normalized coordinates). Only has an + effect if `anchor` is set to "free". + range + Sets the range of this axis. If the axis `type` + is "log", then you must take the log of your + desired range (e.g. to set the range from 1 to + 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, + like date data, though Date objects and unix + milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it + should be numbers, using the scale where each + category is assigned a serial number from zero + in the order it appears. + rangemode + If "normal", the range is computed in relation + to the extrema of the input data. If *tozero*`, + the range extends to 0, regardless of the input + data If "nonnegative", the range is non- + negative, regardless of the input data. Applies + only to linear axes. + scaleanchor + If set to another axis id (e.g. `x2`, `y`), the + range of this axis changes together with the + range of the corresponding axis such that the + scale of pixels per unit is in a constant + ratio. Both axes are still zoomable, but when + you zoom one, the other will zoom the same + amount, keeping a fixed midpoint. `constrain` + and `constraintoward` determine how we enforce + the constraint. You can chain these, ie `yaxis: + {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` + but you can only link axes of the same `type`. + The linked axis can have the opposite letter + (to constrain the aspect ratio) or the same + letter (to match scales across subplots). Loops + (`yaxis: {scaleanchor: *x*}, xaxis: + {scaleanchor: *y*}` or longer) are redundant + and the last constraint encountered will be + ignored to avoid possible inconsistent + constraints via `scaleratio`. Note that setting + axes simultaneously in both a `scaleanchor` and + a `matches` constraint is currently forbidden. + scaleratio + If this axis is linked to another by + `scaleanchor`, this determines the pixel to + unit scale ratio. For example, if this value is + 10, then every unit on this axis spans 10 times + the number of pixels as a unit on the linked + axis. Use this for example to create an + elevation profile where the vertical scale is + exaggerated a fixed amount with respect to the + horizontal. + separatethousands + If "true", even 4-digit integers are separated + showdividers + Determines whether or not a dividers are drawn + between the category levels of this axis. Only + has an effect on "multicategory" axes. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showspikes + Determines whether or not spikes (aka + droplines) are drawn for this axis. Note: This + only takes affect when hovermode = closest + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines whether a x (y) axis is positioned + at the "bottom" ("left") or "top" ("right") of + the plotting area. + spikecolor + Sets the spike color. If undefined, will use + the series color + spikedash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + spikemode + Determines the drawing mode for the spike line + If "toaxis", the line is drawn from the data + point to the axis the series is plotted on. If + "across", the line is drawn across the entire + plot area, and supercedes "toaxis". If + "marker", then a marker dot is drawn on the + axis the series is plotted on + spikesnap + Determines whether spikelines are stuck to the + cursor or to the closest datapoints. + spikethickness + Sets the width (in px) of the zero line. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.yaxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.yaxis.tickformatstopdefaults), sets the + default property values to use for elements of + layout.yaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + tickson + Determines where ticks and grid lines are drawn + with respect to their corresponding tick + labels. Only has an effect for axes of `type` + "category" or "multicategory". When set to + "boundaries", ticks and grid lines are drawn + half a category to the left/bottom of labels. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.yaxis.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use layout.yaxis.title.font + instead. Sets this axis' title font. Note that + the title's font used to be customized by the + now deprecated `titlefont` attribute. + type + Sets the axis type. By default, plotly attempts + to determined the axis type by looking into the + data of the traces that referenced the axis in + question. + uirevision + Controls persistence of user-driven changes in + axis `range`, `autorange`, and `title` if in + `editable: true` configuration. Defaults to + `layout.uirevision`. + visible + A single toggle to hide the axis while + preserving interaction like dragging. Default + is true when a cheater plot is present on the + axis, otherwise false + zeroline + Determines whether or not a line is drawn at + along the 0 value of this axis. If True, the + zero line is drawn on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='xaxis', parent_name='layout', **kwargs): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'XAxis'), + data_docs=kwargs.pop( + 'data_docs', """ + anchor + If set to an opposite-letter axis id (e.g. + `x2`, `y`), this axis is bound to the + corresponding opposite-letter axis. If set to + "free", this axis' position is determined by + `position`. + automargin + Determines whether long tick labels + automatically grow the figure margins. + autorange + Determines whether or not the range of this + axis is computed in relation to the input data. + See `rangemode` for more info. If `range` is + provided, then `autorange` is set to False. + calendar + Sets the calendar system to use for `range` and + `tick0` if this is a date axis. This does not + set the calendar for interpreting data on this + axis, that's specified in the trace or via the + global `layout.calendar` + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + constrain + If this axis needs to be compressed (either due + to its own `scaleanchor` and `scaleratio` or + those of the other axis), determines how that + happens: by increasing the "range" (default), + or by decreasing the "domain". + constraintoward + If this axis needs to be compressed (either due + to its own `scaleanchor` and `scaleratio` or + those of the other axis), determines which + direction we push the originally specified plot + area. Options are "left", "center" (default), + and "right" for x axes, and "top", "middle" + (default), and "bottom" for y axes. + dividercolor + Sets the color of the dividers Only has an + effect on "multicategory" axes. + dividerwidth + Sets the width (in px) of the dividers Only has + an effect on "multicategory" axes. + domain + Sets the domain of this axis (in plot + fraction). + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom- + able. If true, then zoom is disabled. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + layer + Sets the layer on which this axis is displayed. + If *above traces*, this axis is displayed above + all the subplot's traces If *below traces*, + this axis is displayed below all the subplot's + traces, but above the grid lines. Useful when + used together with scatter-like traces with + `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + matches + If set to another axis id (e.g. `x2`, `y`), the + range of this axis will match the range of the + corresponding axis in data-coordinates space. + Moreover, matching axes share auto-range + values, category lists and histogram auto-bins. + Note that setting axes simultaneously in both a + `scaleanchor` and a `matches` constraint is + currently forbidden. Moreover, note that + matching axes must have the same `type`. + mirror + Determines if the axis lines or/and ticks are + mirrored to the opposite side of the plotting + area. If True, the axis lines are mirrored. If + "ticks", the axis lines and ticks are mirrored. + If False, mirroring is disable. If "all", axis + lines are mirrored on all shared-axes subplots. + If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + overlaying + If set a same-letter axis id, this axis is + overlaid on top of the corresponding same- + letter axis, with traces and axes visible for + both axes. If False, this axis does not overlay + any same-letter axes. In this case, for axes + with overlapping domains only the highest- + numbered axis will be visible. + position + Sets the position of this axis in the plotting + space (in normalized coordinates). Only has an + effect if `anchor` is set to "free". + range + Sets the range of this axis. If the axis `type` + is "log", then you must take the log of your + desired range (e.g. to set the range from 1 to + 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, + like date data, though Date objects and unix + milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it + should be numbers, using the scale where each + category is assigned a serial number from zero + in the order it appears. + rangemode + If "normal", the range is computed in relation + to the extrema of the input data. If *tozero*`, + the range extends to 0, regardless of the input + data If "nonnegative", the range is non- + negative, regardless of the input data. Applies + only to linear axes. + rangeselector + plotly.graph_objs.layout.xaxis.Rangeselector + instance or dict with compatible properties + rangeslider + plotly.graph_objs.layout.xaxis.Rangeslider + instance or dict with compatible properties + scaleanchor + If set to another axis id (e.g. `x2`, `y`), the + range of this axis changes together with the + range of the corresponding axis such that the + scale of pixels per unit is in a constant + ratio. Both axes are still zoomable, but when + you zoom one, the other will zoom the same + amount, keeping a fixed midpoint. `constrain` + and `constraintoward` determine how we enforce + the constraint. You can chain these, ie `yaxis: + {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` + but you can only link axes of the same `type`. + The linked axis can have the opposite letter + (to constrain the aspect ratio) or the same + letter (to match scales across subplots). Loops + (`yaxis: {scaleanchor: *x*}, xaxis: + {scaleanchor: *y*}` or longer) are redundant + and the last constraint encountered will be + ignored to avoid possible inconsistent + constraints via `scaleratio`. Note that setting + axes simultaneously in both a `scaleanchor` and + a `matches` constraint is currently forbidden. + scaleratio + If this axis is linked to another by + `scaleanchor`, this determines the pixel to + unit scale ratio. For example, if this value is + 10, then every unit on this axis spans 10 times + the number of pixels as a unit on the linked + axis. Use this for example to create an + elevation profile where the vertical scale is + exaggerated a fixed amount with respect to the + horizontal. + separatethousands + If "true", even 4-digit integers are separated + showdividers + Determines whether or not a dividers are drawn + between the category levels of this axis. Only + has an effect on "multicategory" axes. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showspikes + Determines whether or not spikes (aka + droplines) are drawn for this axis. Note: This + only takes affect when hovermode = closest + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines whether a x (y) axis is positioned + at the "bottom" ("left") or "top" ("right") of + the plotting area. + spikecolor + Sets the spike color. If undefined, will use + the series color + spikedash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + spikemode + Determines the drawing mode for the spike line + If "toaxis", the line is drawn from the data + point to the axis the series is plotted on. If + "across", the line is drawn across the entire + plot area, and supercedes "toaxis". If + "marker", then a marker dot is drawn on the + axis the series is plotted on + spikesnap + Determines whether spikelines are stuck to the + cursor or to the closest datapoints. + spikethickness + Sets the width (in px) of the zero line. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.xaxis.Tickformatstop + instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.xaxis.tickformatstopdefaults), sets the + default property values to use for elements of + layout.xaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + tickson + Determines where ticks and grid lines are drawn + with respect to their corresponding tick + labels. Only has an effect for axes of `type` + "category" or "multicategory". When set to + "boundaries", ticks and grid lines are drawn + half a category to the left/bottom of labels. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.xaxis.Title instance + or dict with compatible properties + titlefont + Deprecated: Please use layout.xaxis.title.font + instead. Sets this axis' title font. Note that + the title's font used to be customized by the + now deprecated `titlefont` attribute. + type + Sets the axis type. By default, plotly attempts + to determined the axis type by looking into the + data of the traces that referenced the axis in + question. + uirevision + Controls persistence of user-driven changes in + axis `range`, `autorange`, and `title` if in + `editable: true` configuration. Defaults to + `layout.uirevision`. + visible + A single toggle to hide the axis while + preserving interaction like dragging. Default + is true when a cheater plot is present on the + axis, otherwise false + zeroline + Determines whether or not a line is drawn at + along the 0 value of this axis. If True, the + zero line is drawn on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='width', parent_name='layout', **kwargs): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 10), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ViolinmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='violinmode', parent_name='layout', **kwargs + ): + super(ViolinmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['group', 'overlay']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ViolingroupgapValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='violingroupgap', parent_name='layout', **kwargs + ): + super(ViolingroupgapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ViolingapValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='violingap', parent_name='layout', **kwargs + ): + super(ViolingapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UpdatemenuValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='updatemenudefaults', parent_name='layout', **kwargs + ): + super(UpdatemenuValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Updatemenu'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UpdatemenusValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, plotly_name='updatemenus', parent_name='layout', **kwargs + ): + super(UpdatemenusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Updatemenu'), + data_docs=kwargs.pop( + 'data_docs', """ + active + Determines which button (by index starting from + 0) is considered active. + bgcolor + Sets the background color of the update menu + buttons. + bordercolor + Sets the color of the border enclosing the + update menu. + borderwidth + Sets the width (in px) of the border enclosing + the update menu. + buttons + plotly.graph_objs.layout.updatemenu.Button + instance or dict with compatible properties + buttondefaults + When used in a template (as layout.template.lay + out.updatemenu.buttondefaults), sets the + default property values to use for elements of + layout.updatemenu.buttons + direction + Determines the direction in which the buttons + are laid out, whether in a dropdown menu or a + row/column of buttons. For `left` and `up`, the + buttons will still appear in left-to-right or + top-to-bottom order respectively. + font + Sets the font of the update menu button text. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + pad + Sets the padding around the buttons or dropdown + menu. + showactive + Highlights active dropdown item or active + button if true. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + type + Determines whether the buttons are accessible + via a dropdown menu or whether the buttons are + stacked horizontally or vertically + visible + Determines whether or not the update menu is + visible. + x + Sets the x position (in normalized coordinates) + of the update menu. + xanchor + Sets the update menu's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the range + selector. + y + Sets the y position (in normalized coordinates) + of the update menu. + yanchor + Sets the update menu's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the range + selector. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='layout', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TransitionValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='transition', parent_name='layout', **kwargs + ): + super(TransitionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Transition'), + data_docs=kwargs.pop( + 'data_docs', """ + duration + The duration of the transition, in + milliseconds. If equal to zero, updates are + synchronous. + easing + The easing function used for the transition + ordering + Determines whether the figure's layout or + traces smoothly transitions during updates that + make both traces and layout change. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__(self, plotly_name='title', parent_name='layout', **kwargs): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets the title font. Note that the title's font + used to be customized by the now deprecated + `titlefont` attribute. + pad + Sets the padding of the title. Each padding + value only applies when the corresponding + `xanchor`/`yanchor` value is set accordingly. + E.g. for left padding to take effect, `xanchor` + must be set to "left". The same rule applies if + `xanchor`/`yanchor` is determined + automatically. Padding is muted if the + respective anchor value is "middle*/*center". + text + Sets the plot's title. Note that before the + existence of `title.text`, the title's contents + used to be defined as the `title` attribute + itself. This behavior has been deprecated. + x + Sets the x position with respect to `xref` in + normalized coordinates from 0 (left) to 1 + (right). + xanchor + Sets the title's horizontal alignment with + respect to its x position. "left" means that + the title starts at x, "right" means that the + title ends at x and "center" means that the + title's center is at x. "auto" divides `xref` + by three and calculates the `xanchor` value + automatically based on the value of `x`. + xref + Sets the container `x` refers to. "container" + spans the entire `width` of the plot. "paper" + refers to the width of the plotting area only. + y + Sets the y position with respect to `yref` in + normalized coordinates from 0 (bottom) to 1 + (top). "auto" places the baseline of the title + onto the vertical center of the top margin. + yanchor + Sets the title's vertical alignment with + respect to its y position. "top" means that the + title's cap line is at y, "bottom" means that + the title's baseline is at y and "middle" means + that the title's midline is at y. "auto" + divides `yref` by three and calculates the + `yanchor` value automatically based on the + value of `y`. + yref + Sets the container `y` refers to. "container" + spans the entire `height` of the plot. "paper" + refers to the height of the plotting area only. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TernaryValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='ternary', parent_name='layout', **kwargs): + super(TernaryValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Ternary'), + data_docs=kwargs.pop( + 'data_docs', """ + aaxis + plotly.graph_objs.layout.ternary.Aaxis instance + or dict with compatible properties + baxis + plotly.graph_objs.layout.ternary.Baxis instance + or dict with compatible properties + bgcolor + Set the background color of the subplot + caxis + plotly.graph_objs.layout.ternary.Caxis instance + or dict with compatible properties + domain + plotly.graph_objs.layout.ternary.Domain + instance or dict with compatible properties + sum + The number each triplet should sum to, and the + maximum range of each axis + uirevision + Controls persistence of user-driven changes in + axis `min` and `title`, if not overridden in + the individual axes. Defaults to + `layout.uirevision`. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateValidator(_plotly_utils.basevalidators.BaseTemplateValidator): + + def __init__(self, plotly_name='template', parent_name='layout', **kwargs): + super(TemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Template'), + data_docs=kwargs.pop( + 'data_docs', """ + data + plotly.graph_objs.layout.template.Data instance + or dict with compatible properties + layout + plotly.graph_objs.layout.template.Layout + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikedistanceValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='spikedistance', parent_name='layout', **kwargs + ): + super(SpikedistanceValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SliderValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='sliderdefaults', parent_name='layout', **kwargs + ): + super(SliderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Slider'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SlidersValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__(self, plotly_name='sliders', parent_name='layout', **kwargs): + super(SlidersValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Slider'), + data_docs=kwargs.pop( + 'data_docs', """ + active + Determines which button (by index starting from + 0) is considered active. + activebgcolor + Sets the background color of the slider grip + while dragging. + bgcolor + Sets the background color of the slider. + bordercolor + Sets the color of the border enclosing the + slider. + borderwidth + Sets the width (in px) of the border enclosing + the slider. + currentvalue + plotly.graph_objs.layout.slider.Currentvalue + instance or dict with compatible properties + font + Sets the font of the slider step labels. + len + Sets the length of the slider This measure + excludes the padding of both ends. That is, the + slider's length is this length minus the + padding on both ends. + lenmode + Determines whether this slider length is set in + units of plot "fraction" or in *pixels. Use + `len` to set the value. + minorticklen + Sets the length in pixels of minor step tick + marks + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + pad + Set the padding of the slider component along + each side. + steps + plotly.graph_objs.layout.slider.Step instance + or dict with compatible properties + stepdefaults + When used in a template (as + layout.template.layout.slider.stepdefaults), + sets the default property values to use for + elements of layout.slider.steps + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + tickcolor + Sets the color of the border enclosing the + slider. + ticklen + Sets the length in pixels of step tick marks + tickwidth + Sets the tick width (in px). + transition + plotly.graph_objs.layout.slider.Transition + instance or dict with compatible properties + visible + Determines whether or not the slider is + visible. + x + Sets the x position (in normalized coordinates) + of the slider. + xanchor + Sets the slider's horizontal position anchor. + This anchor binds the `x` position to the + "left", "center" or "right" of the range + selector. + y + Sets the y position (in normalized coordinates) + of the slider. + yanchor + Sets the slider's vertical position anchor This + anchor binds the `y` position to the "top", + "middle" or "bottom" of the range selector. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='layout', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'legend'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShapeValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='shapedefaults', parent_name='layout', **kwargs + ): + super(ShapeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Shape'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShapesValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__(self, plotly_name='shapes', parent_name='layout', **kwargs): + super(ShapesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Shape'), + data_docs=kwargs.pop( + 'data_docs', """ + fillcolor + Sets the color filling the shape's interior. + layer + Specifies whether shapes are drawn below or + above traces. + line + plotly.graph_objs.layout.shape.Line instance or + dict with compatible properties + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + opacity + Sets the opacity of the shape. + path + For `type` "path" - a valid SVG path with the + pixel values replaced by data values in + `xsizemode`/`ysizemode` being "scaled" and + taken unmodified as pixels relative to + `xanchor` and `yanchor` in case of "pixel" size + mode. There are a few restrictions / quirks + only absolute instructions, not relative. So + the allowed segments are: M, L, H, V, Q, C, T, + S, and Z arcs (A) are not allowed because + radius rx and ry are relative. In the future we + could consider supporting relative commands, + but we would have to decide on how to handle + date and log axes. Note that even as is, Q and + C Bezier paths that are smooth on linear axes + may not be smooth on log, and vice versa. no + chained "polybezier" commands - specify the + segment type for each one. On category axes, + values are numbers scaled to the serial numbers + of categories because using the categories + themselves there would be no way to describe + fractional positions On data axes: because + space and T are both normal components of path + strings, we can't use either to separate date + from time parts. Therefore we'll use underscore + for this purpose: 2015-02-21_13:45:56.789 + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + type + Specifies the shape type to be drawn. If + "line", a line is drawn from (`x0`,`y0`) to + (`x1`,`y1`) with respect to the axes' sizing + mode. If "circle", a circle is drawn from + ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius + (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 + -`y0`)|) with respect to the axes' sizing mode. + If "rect", a rectangle is drawn linking + (`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`), + (`x0`,`y1`), (`x0`,`y0`) with respect to the + axes' sizing mode. If "path", draw a custom SVG + path using `path`. with respect to the axes' + sizing mode. + visible + Determines whether or not this shape is + visible. + x0 + Sets the shape's starting x position. See + `type` and `xsizemode` for more info. + x1 + Sets the shape's end x position. See `type` and + `xsizemode` for more info. + xanchor + Only relevant in conjunction with `xsizemode` + set to "pixel". Specifies the anchor point on + the x axis to which `x0`, `x1` and x + coordinates within `path` are relative to. E.g. + useful to attach a pixel sized shape to a + certain data value. No effect when `xsizemode` + not set to "pixel". + xref + Sets the shape's x coordinate axis. If set to + an x axis id (e.g. "x" or "x2"), the `x` + position refers to an x coordinate. If set to + "paper", the `x` position refers to the + distance from the left side of the plotting + area in normalized coordinates where 0 (1) + corresponds to the left (right) side. If the + axis `type` is "log", then you must take the + log of your desired range. If the axis `type` + is "date", then you must convert the date to + unix time in milliseconds. + xsizemode + Sets the shapes's sizing mode along the x axis. + If set to "scaled", `x0`, `x1` and x + coordinates within `path` refer to data values + on the x axis or a fraction of the plot area's + width (`xref` set to "paper"). If set to + "pixel", `xanchor` specifies the x position in + terms of data or plot fraction but `x0`, `x1` + and x coordinates within `path` are pixels + relative to `xanchor`. This way, the shape can + have a fixed width while maintaining a position + relative to data or plot fraction. + y0 + Sets the shape's starting y position. See + `type` and `ysizemode` for more info. + y1 + Sets the shape's end y position. See `type` and + `ysizemode` for more info. + yanchor + Only relevant in conjunction with `ysizemode` + set to "pixel". Specifies the anchor point on + the y axis to which `y0`, `y1` and y + coordinates within `path` are relative to. E.g. + useful to attach a pixel sized shape to a + certain data value. No effect when `ysizemode` + not set to "pixel". + yref + Sets the annotation's y coordinate axis. If set + to an y axis id (e.g. "y" or "y2"), the `y` + position refers to an y coordinate If set to + "paper", the `y` position refers to the + distance from the bottom of the plotting area + in normalized coordinates where 0 (1) + corresponds to the bottom (top). + ysizemode + Sets the shapes's sizing mode along the y axis. + If set to "scaled", `y0`, `y1` and y + coordinates within `path` refer to data values + on the y axis or a fraction of the plot area's + height (`yref` set to "paper"). If set to + "pixel", `yanchor` specifies the y position in + terms of data or plot fraction but `y0`, `y1` + and y coordinates within `path` are pixels + relative to `yanchor`. This way, the shape can + have a fixed height while maintaining a + position relative to data or plot fraction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatorsValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='separators', parent_name='layout', **kwargs + ): + super(SeparatorsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectionrevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectionrevision', parent_name='layout', **kwargs + ): + super(SelectionrevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectdirectionValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, plotly_name='selectdirection', parent_name='layout', **kwargs + ): + super(SelectdirectionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['h', 'v', 'd', 'any']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SceneValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='scene', parent_name='layout', **kwargs): + super(SceneValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scene'), + data_docs=kwargs.pop( + 'data_docs', """ + annotations + plotly.graph_objs.layout.scene.Annotation + instance or dict with compatible properties + annotationdefaults + When used in a template (as layout.template.lay + out.scene.annotationdefaults), sets the default + property values to use for elements of + layout.scene.annotations + aspectmode + If "cube", this scene's axes are drawn as a + cube, regardless of the axes' ranges. If + "data", this scene's axes are drawn in + proportion with the axes' ranges. If "manual", + this scene's axes are drawn in proportion with + the input of "aspectratio" (the default + behavior if "aspectratio" is provided). If + "auto", this scene's axes are drawn using the + results of "data" except when one axis is more + than four times the size of the two others, + where in that case the results of "cube" are + used. + aspectratio + Sets this scene's axis aspectratio. + bgcolor + + camera + plotly.graph_objs.layout.scene.Camera instance + or dict with compatible properties + domain + plotly.graph_objs.layout.scene.Domain instance + or dict with compatible properties + dragmode + Determines the mode of drag interactions for + this scene. + hovermode + Determines the mode of hover interactions for + this scene. + uirevision + Controls persistence of user-driven changes in + camera attributes. Defaults to + `layout.uirevision`. + xaxis + plotly.graph_objs.layout.scene.XAxis instance + or dict with compatible properties + yaxis + plotly.graph_objs.layout.scene.YAxis instance + or dict with compatible properties + zaxis + plotly.graph_objs.layout.scene.ZAxis instance + or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RadialAxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='radialaxis', parent_name='layout', **kwargs + ): + super(RadialAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'RadialAxis'), + data_docs=kwargs.pop( + 'data_docs', """ + domain + Polar chart subplots are not supported yet. + This key has currently no effect. + endpadding + Legacy polar charts are deprecated! Please + switch to "polar" subplots. + orientation + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the + orientation (an angle with respect to the + origin) of the radial axis. + range + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Defines the start + and end point of this radial axis. + showline + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Determines whether + or not the line bounding this radial axis will + be shown on the figure. + showticklabels + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Determines whether + or not the radial axis ticks will feature tick + labels. + tickcolor + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the color of + the tick lines on this radial axis. + ticklen + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the length of + the tick lines on this radial axis. + tickorientation + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the + orientation (from the paper perspective) of the + radial axis tick labels. + ticksuffix + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the length of + the tick lines on this radial axis. + visible + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Determines whether + or not this axis will be visible. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PolarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='polar', parent_name='layout', **kwargs): + super(PolarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Polar'), + data_docs=kwargs.pop( + 'data_docs', """ + angularaxis + plotly.graph_objs.layout.polar.AngularAxis + instance or dict with compatible properties + bargap + Sets the gap between bars of adjacent location + coordinates. Values are unitless, they + represent fractions of the minimum difference + in bar positions in the data. + barmode + Determines how bars at the same location + coordinate are displayed on the graph. With + "stack", the bars are stacked on top of one + another With "overlay", the bars are plotted + over one another, you might need to an + "opacity" to see multiple bars. + bgcolor + Set the background color of the subplot + domain + plotly.graph_objs.layout.polar.Domain instance + or dict with compatible properties + gridshape + Determines if the radial axis grid lines and + angular axis line are drawn as "circular" + sectors or as "linear" (polygon) sectors. Has + an effect only when the angular axis has `type` + "category". Note that `radialaxis.angle` is + snapped to the angle of the closest vertex when + `gridshape` is "circular" (so that radial axis + scale is the same as the data scale). + hole + Sets the fraction of the radius to cut out of + the polar subplot. + radialaxis + plotly.graph_objs.layout.polar.RadialAxis + instance or dict with compatible properties + sector + Sets angular span of this polar subplot with + two angles (in degrees). Sector are assumed to + be spanned in the counterclockwise direction + with 0 corresponding to rightmost limit of the + polar subplot. + uirevision + Controls persistence of user-driven changes in + axis attributes, if not overridden in the + individual axes. Defaults to + `layout.uirevision`. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PlotBgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='plot_bgcolor', parent_name='layout', **kwargs + ): + super(PlotBgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PiecolorwayValidator(_plotly_utils.basevalidators.ColorlistValidator): + + def __init__( + self, plotly_name='piecolorway', parent_name='layout', **kwargs + ): + super(PiecolorwayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PaperBgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='paper_bgcolor', parent_name='layout', **kwargs + ): + super(PaperBgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OrientationValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, plotly_name='orientation', parent_name='layout', **kwargs + ): + super(OrientationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ModebarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='modebar', parent_name='layout', **kwargs): + super(ModebarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Modebar'), + data_docs=kwargs.pop( + 'data_docs', """ + activecolor + Sets the color of the active or hovered on + icons in the modebar. + bgcolor + Sets the background color of the modebar. + color + Sets the color of the icons in the modebar. + orientation + Sets the orientation of the modebar. + uirevision + Controls persistence of user-driven changes + related to the modebar, including `hovermode`, + `dragmode`, and `showspikes` at both the root + level and inside subplots. Defaults to + `layout.uirevision`. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MetasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='metasrc', parent_name='layout', **kwargs): + super(MetasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MetaValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='meta', parent_name='layout', **kwargs): + super(MetaValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarginValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='margin', parent_name='layout', **kwargs): + super(MarginValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Margin'), + data_docs=kwargs.pop( + 'data_docs', """ + autoexpand + + b + Sets the bottom margin (in px). + l + Sets the left margin (in px). + pad + Sets the amount of padding (in px) between the + plotting area and the axis lines + r + Sets the right margin (in px). + t + Sets the top margin (in px). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MapboxValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='mapbox', parent_name='layout', **kwargs): + super(MapboxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Mapbox'), + data_docs=kwargs.pop( + 'data_docs', """ + accesstoken + Sets the mapbox access token to be used for + this mapbox map. Alternatively, the mapbox + access token can be set in the configuration + options under `mapboxAccessToken`. + bearing + Sets the bearing angle of the map in degrees + counter-clockwise from North (mapbox.bearing). + center + plotly.graph_objs.layout.mapbox.Center instance + or dict with compatible properties + domain + plotly.graph_objs.layout.mapbox.Domain instance + or dict with compatible properties + layers + plotly.graph_objs.layout.mapbox.Layer instance + or dict with compatible properties + layerdefaults + When used in a template (as + layout.template.layout.mapbox.layerdefaults), + sets the default property values to use for + elements of layout.mapbox.layers + pitch + Sets the pitch angle of the map (in degrees, + where 0 means perpendicular to the surface of + the map) (mapbox.pitch). + style + Sets the Mapbox map style. Either input one of + the default Mapbox style names or the URL to a + custom style or a valid Mapbox style JSON. + uirevision + Controls persistence of user-driven changes in + the view: `center`, `zoom`, `bearing`, `pitch`. + Defaults to `layout.uirevision`. + zoom + Sets the zoom level of the map (mapbox.zoom). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='legend', parent_name='layout', **kwargs): + super(LegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Legend'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the legend background color. + bordercolor + Sets the color of the border enclosing the + legend. + borderwidth + Sets the width (in px) of the border enclosing + the legend. + font + Sets the font used to text the legend items. + orientation + Sets the orientation of the legend. + tracegroupgap + Sets the amount of vertical space (in px) + between legend groups. + traceorder + Determines the order at which the legend items + are displayed. If "normal", the items are + displayed top-to-bottom in the same order as + the input data. If "reversed", the items are + displayed in the opposite order as "normal". If + "grouped", the items are displayed in groups + (when a trace `legendgroup` is provided). if + "grouped+reversed", the items are displayed in + the opposite order as "grouped". + uirevision + Controls persistence of legend-driven changes + in trace and pie label visibility. Defaults to + `layout.uirevision`. + valign + Sets the vertical alignment of the symbols with + respect to their associated text. + x + Sets the x position (in normalized coordinates) + of the legend. + xanchor + Sets the legend's horizontal position anchor. + This anchor binds the `x` position to the + "left", "center" or "right" of the legend. + y + Sets the y position (in normalized coordinates) + of the legend. + yanchor + Sets the legend's vertical position anchor This + anchor binds the `y` position to the "top", + "middle" or "bottom" of the legend. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ImageValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='imagedefaults', parent_name='layout', **kwargs + ): + super(ImageValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Image'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ImagesValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__(self, plotly_name='images', parent_name='layout', **kwargs): + super(ImagesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Image'), + data_docs=kwargs.pop( + 'data_docs', """ + layer + Specifies whether images are drawn below or + above traces. When `xref` and `yref` are both + set to `paper`, image is drawn below the entire + plot area. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + opacity + Sets the opacity of the image. + sizex + Sets the image container size horizontally. The + image will be sized based on the `position` + value. When `xref` is set to `paper`, units are + sized relative to the plot width. + sizey + Sets the image container size vertically. The + image will be sized based on the `position` + value. When `yref` is set to `paper`, units are + sized relative to the plot height. + sizing + Specifies which dimension of the image to + constrain. + source + Specifies the URL of the image to be used. The + URL must be accessible from the domain where + the plot code is run, and can be either + relative or absolute. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + visible + Determines whether or not this image is + visible. + x + Sets the image's x position. When `xref` is set + to `paper`, units are sized relative to the + plot height. See `xref` for more info + xanchor + Sets the anchor for the x position + xref + Sets the images's x coordinate axis. If set to + a x axis id (e.g. "x" or "x2"), the `x` + position refers to an x data coordinate If set + to "paper", the `x` position refers to the + distance from the left of plot in normalized + coordinates where 0 (1) corresponds to the left + (right). + y + Sets the image's y position. When `yref` is set + to `paper`, units are sized relative to the + plot height. See `yref` for more info + yanchor + Sets the anchor for the y position. + yref + Sets the images's y coordinate axis. If set to + a y axis id (e.g. "y" or "y2"), the `y` + position refers to a y data coordinate. If set + to "paper", the `y` position refers to the + distance from the bottom of the plot in + normalized coordinates where 0 (1) corresponds + to the bottom (top). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovermodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='hovermode', parent_name='layout', **kwargs + ): + super(HovermodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'modebar'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['x', 'y', 'closest', False]), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='layout', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of all hover labels + on graph + bordercolor + Sets the border color of all hover labels on + graph. + font + Sets the default hover label font used by all + traces on the graph. + namelength + Sets the default length (in number of + characters) of the trace name in the hover + labels for all traces. -1 shows the whole name + regardless of length. 0-3 shows the first 0-3 + characters, and an integer >3 will show the + whole name if it is less than that many + characters, but if it is longer, will truncate + to `namelength - 3` characters and add an + ellipsis. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverdistanceValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='hoverdistance', parent_name='layout', **kwargs + ): + super(HoverdistanceValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HidesourcesValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='hidesources', parent_name='layout', **kwargs + ): + super(HidesourcesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HiddenlabelssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hiddenlabelssrc', parent_name='layout', **kwargs + ): + super(HiddenlabelssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HiddenlabelsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='hiddenlabels', parent_name='layout', **kwargs + ): + super(HiddenlabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HeightValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='height', parent_name='layout', **kwargs): + super(HeightValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 10), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='grid', parent_name='layout', **kwargs): + super(GridValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Grid'), + data_docs=kwargs.pop( + 'data_docs', """ + columns + The number of columns in the grid. If you + provide a 2D `subplots` array, the length of + its longest row is used as the default. If you + give an `xaxes` array, its length is used as + the default. But it's also possible to have a + different length, if you want to leave a row at + the end for non-cartesian subplots. + domain + plotly.graph_objs.layout.grid.Domain instance + or dict with compatible properties + pattern + If no `subplots`, `xaxes`, or `yaxes` are given + but we do have `rows` and `columns`, we can + generate defaults using consecutive axis IDs, + in two ways: "coupled" gives one x axis per + column and one y axis per row. "independent" + uses a new xy pair for each cell, left-to-right + across each row then iterating rows according + to `roworder`. + roworder + Is the first row the top or the bottom? Note + that columns are always enumerated from left to + right. + rows + The number of rows in the grid. If you provide + a 2D `subplots` array or a `yaxes` array, its + length is used as the default. But it's also + possible to have a different length, if you + want to leave a row at the end for non- + cartesian subplots. + subplots + Used for freeform grids, where some axes may be + shared across subplots but others are not. Each + entry should be a cartesian subplot id, like + "xy" or "x3y2", or "" to leave that cell empty. + You may reuse x axes within the same column, + and y axes within the same row. Non-cartesian + subplots and traces that support `domain` can + place themselves in this grid separately using + the `gridcell` attribute. + xaxes + Used with `yaxes` when the x and y axes are + shared across columns and rows. Each entry + should be an x axis id like "x", "x2", etc., or + "" to not put an x axis in that column. Entries + other than "" must be unique. Ignored if + `subplots` is present. If missing but `yaxes` + is present, will generate consecutive IDs. + xgap + Horizontal space between grid cells, expressed + as a fraction of the total width available to + one cell. Defaults to 0.1 for coupled-axes + grids and 0.2 for independent grids. + xside + Sets where the x axis labels and titles go. + "bottom" means the very bottom of the grid. + "bottom plot" is the lowest plot that each x + axis is used in. "top" and "top plot" are + similar. + yaxes + Used with `yaxes` when the x and y axes are + shared across columns and rows. Each entry + should be an y axis id like "y", "y2", etc., or + "" to not put a y axis in that row. Entries + other than "" must be unique. Ignored if + `subplots` is present. If missing but `xaxes` + is present, will generate consecutive IDs. + ygap + Vertical space between grid cells, expressed as + a fraction of the total height available to one + cell. Defaults to 0.1 for coupled-axes grids + and 0.3 for independent grids. + yside + Sets where the y axis labels and titles go. + "left" means the very left edge of the grid. + *left plot* is the leftmost plot that each y + axis is used in. "right" and *right plot* are + similar. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GeoValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='geo', parent_name='layout', **kwargs): + super(GeoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Geo'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Set the background color of the map + center + plotly.graph_objs.layout.geo.Center instance or + dict with compatible properties + coastlinecolor + Sets the coastline color. + coastlinewidth + Sets the coastline stroke width (in px). + countrycolor + Sets line color of the country boundaries. + countrywidth + Sets line width (in px) of the country + boundaries. + domain + plotly.graph_objs.layout.geo.Domain instance or + dict with compatible properties + framecolor + Sets the color the frame. + framewidth + Sets the stroke width (in px) of the frame. + lakecolor + Sets the color of the lakes. + landcolor + Sets the land mass color. + lataxis + plotly.graph_objs.layout.geo.Lataxis instance + or dict with compatible properties + lonaxis + plotly.graph_objs.layout.geo.Lonaxis instance + or dict with compatible properties + oceancolor + Sets the ocean color + projection + plotly.graph_objs.layout.geo.Projection + instance or dict with compatible properties + resolution + Sets the resolution of the base layers. The + values have units of km/mm e.g. 110 corresponds + to a scale ratio of 1:110,000,000. + rivercolor + Sets color of the rivers. + riverwidth + Sets the stroke width (in px) of the rivers. + scope + Set the scope of the map. + showcoastlines + Sets whether or not the coastlines are drawn. + showcountries + Sets whether or not country boundaries are + drawn. + showframe + Sets whether or not a frame is drawn around the + map. + showlakes + Sets whether or not lakes are drawn. + showland + Sets whether or not land masses are filled in + color. + showocean + Sets whether or not oceans are filled in color. + showrivers + Sets whether or not rivers are drawn. + showsubunits + Sets whether or not boundaries of subunits + within countries (e.g. states, provinces) are + drawn. + subunitcolor + Sets the color of the subunits boundaries. + subunitwidth + Sets the stroke width (in px) of the subunits + boundaries. + uirevision + Controls persistence of user-driven changes in + the view (projection and center). Defaults to + `layout.uirevision`. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='font', parent_name='layout', **kwargs): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExtendpiecolorsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='extendpiecolors', parent_name='layout', **kwargs + ): + super(ExtendpiecolorsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EditrevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='editrevision', parent_name='layout', **kwargs + ): + super(EditrevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DragmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='dragmode', parent_name='layout', **kwargs): + super(DragmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'modebar'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'zoom', 'pan', 'select', 'lasso', 'orbit', 'turntable', + False + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DirectionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='direction', parent_name='layout', **kwargs + ): + super(DirectionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['clockwise', 'counterclockwise']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DatarevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='datarevision', parent_name='layout', **kwargs + ): + super(DatarevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorwayValidator(_plotly_utils.basevalidators.ColorlistValidator): + + def __init__(self, plotly_name='colorway', parent_name='layout', **kwargs): + super(ColorwayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='layout', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Colorscale'), + data_docs=kwargs.pop( + 'data_docs', """ + diverging + Sets the default diverging colorscale. Note + that `autocolorscale` must be true for this + attribute to work. + sequential + Sets the default sequential colorscale for + positive values. Note that `autocolorscale` + must be true for this attribute to work. + sequentialminus + Sets the default sequential colorscale for + negative values. Note that `autocolorscale` + must be true for this attribute to work. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ClickmodeValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='clickmode', parent_name='layout', **kwargs + ): + super(ClickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + extras=kwargs.pop('extras', ['none']), + flags=kwargs.pop('flags', ['event', 'select']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='calendar', parent_name='layout', **kwargs): + super(CalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BoxmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='boxmode', parent_name='layout', **kwargs): + super(BoxmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['group', 'overlay']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BoxgroupgapValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='boxgroupgap', parent_name='layout', **kwargs + ): + super(BoxgroupgapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BoxgapValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='boxgap', parent_name='layout', **kwargs): + super(BoxgapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BarnormValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='barnorm', parent_name='layout', **kwargs): + super(BarnormValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['', 'fraction', 'percent']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BarmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='barmode', parent_name='layout', **kwargs): + super(BarmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['stack', 'group', 'overlay', 'relative'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BargroupgapValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='bargroupgap', parent_name='layout', **kwargs + ): + super(BargroupgapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BargapValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='bargap', parent_name='layout', **kwargs): + super(BargapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutosizeValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='autosize', parent_name='layout', **kwargs): + super(AutosizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AnnotationValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='annotationdefaults', parent_name='layout', **kwargs + ): + super(AnnotationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Annotation'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AnnotationsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, plotly_name='annotations', parent_name='layout', **kwargs + ): + super(AnnotationsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Annotation'), + data_docs=kwargs.pop( + 'data_docs', """ + align + Sets the horizontal alignment of the `text` + within the box. Has an effect only if `text` + spans more two or more lines (i.e. `text` + contains one or more
HTML tags) or if an + explicit width is set to override the text + width. + arrowcolor + Sets the color of the annotation arrow. + arrowhead + Sets the end annotation arrow head style. + arrowside + Sets the annotation arrow head position. + arrowsize + Sets the size of the end annotation arrow head, + relative to `arrowwidth`. A value of 1 + (default) gives a head about 3x as wide as the + line. + arrowwidth + Sets the width (in px) of annotation arrow + line. + ax + Sets the x component of the arrow tail about + the arrow head. If `axref` is `pixel`, a + positive (negative) component corresponds to + an arrow pointing from right to left (left to + right). If `axref` is an axis, this is an + absolute value on that axis, like `x`, NOT a + relative value. + axref + Indicates in what terms the tail of the + annotation (ax,ay) is specified. If `pixel`, + `ax` is a relative offset in pixels from `x`. + If set to an x axis id (e.g. "x" or "x2"), `ax` + is specified in the same terms as that axis. + This is useful for trendline annotations which + should continue to indicate the correct trend + when zoomed. + ay + Sets the y component of the arrow tail about + the arrow head. If `ayref` is `pixel`, a + positive (negative) component corresponds to + an arrow pointing from bottom to top (top to + bottom). If `ayref` is an axis, this is an + absolute value on that axis, like `y`, NOT a + relative value. + ayref + Indicates in what terms the tail of the + annotation (ax,ay) is specified. If `pixel`, + `ay` is a relative offset in pixels from `y`. + If set to a y axis id (e.g. "y" or "y2"), `ay` + is specified in the same terms as that axis. + This is useful for trendline annotations which + should continue to indicate the correct trend + when zoomed. + bgcolor + Sets the background color of the annotation. + bordercolor + Sets the color of the border enclosing the + annotation `text`. + borderpad + Sets the padding (in px) between the `text` and + the enclosing border. + borderwidth + Sets the width (in px) of the border enclosing + the annotation `text`. + captureevents + Determines whether the annotation text box + captures mouse move and click events, or allows + those events to pass through to data points in + the plot that may be behind the annotation. By + default `captureevents` is False unless + `hovertext` is provided. If you use the event + `plotly_clickannotation` without `hovertext` + you must explicitly enable `captureevents`. + clicktoshow + Makes this annotation respond to clicks on the + plot. If you click a data point that exactly + matches the `x` and `y` values of this + annotation, and it is hidden (visible: false), + it will appear. In "onoff" mode, you must click + the same point again to make it disappear, so + if you click multiple points, you can show + multiple annotations. In "onout" mode, a click + anywhere else in the plot (on another data + point or not) will hide this annotation. If you + need to show/hide this annotation in response + to different `x` or `y` values, you can set + `xclick` and/or `yclick`. This is useful for + example to label the side of a bar. To label + markers though, `standoff` is preferred over + `xclick` and `yclick`. + font + Sets the annotation text font. + height + Sets an explicit height for the text box. null + (default) lets the text set the box height. + Taller text will be clipped. + hoverlabel + plotly.graph_objs.layout.annotation.Hoverlabel + instance or dict with compatible properties + hovertext + Sets text to appear when hovering over this + annotation. If omitted or blank, no hover label + will appear. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + opacity + Sets the opacity of the annotation (text + + arrow). + showarrow + Determines whether or not the annotation is + drawn with an arrow. If True, `text` is placed + near the arrow's tail. If False, `text` lines + up with the `x` and `y` provided. + standoff + Sets a distance, in pixels, to move the end + arrowhead away from the position it is pointing + at, for example to point at the edge of a + marker independent of zoom. Note that this + shortens the arrow from the `ax` / `ay` vector, + in contrast to `xshift` / `yshift` which moves + everything by this amount. + startarrowhead + Sets the start annotation arrow head style. + startarrowsize + Sets the size of the start annotation arrow + head, relative to `arrowwidth`. A value of 1 + (default) gives a head about 3x as wide as the + line. + startstandoff + Sets a distance, in pixels, to move the start + arrowhead away from the position it is pointing + at, for example to point at the edge of a + marker independent of zoom. Note that this + shortens the arrow from the `ax` / `ay` vector, + in contrast to `xshift` / `yshift` which moves + everything by this amount. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + text + Sets the text associated with this annotation. + Plotly uses a subset of HTML tags to do things + like newline (
), bold (), italics + (), hyperlinks (). + Tags , , are also + supported. + textangle + Sets the angle at which the `text` is drawn + with respect to the horizontal. + valign + Sets the vertical alignment of the `text` + within the box. Has an effect only if an + explicit height is set to override the text + height. + visible + Determines whether or not this annotation is + visible. + width + Sets an explicit width for the text box. null + (default) lets the text set the box width. + Wider text will be clipped. There is no + automatic wrapping; use
to start a new + line. + x + Sets the annotation's x position. If the axis + `type` is "log", then you must take the log of + your desired range. If the axis `type` is + "date", it should be date strings, like date + data, though Date objects and unix milliseconds + will be accepted and converted to strings. If + the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order + it appears. + xanchor + Sets the text box's horizontal position anchor + This anchor binds the `x` position to the + "left", "center" or "right" of the annotation. + For example, if `x` is set to 1, `xref` to + "paper" and `xanchor` to "right" then the + right-most portion of the annotation lines up + with the right-most edge of the plotting area. + If "auto", the anchor is equivalent to "center" + for data-referenced annotations or if there is + an arrow, whereas for paper-referenced with no + arrow, the anchor picked corresponds to the + closest side. + xclick + Toggle this annotation when clicking a data + point whose `x` value is `xclick` rather than + the annotation's `x` value. + xref + Sets the annotation's x coordinate axis. If set + to an x axis id (e.g. "x" or "x2"), the `x` + position refers to an x coordinate If set to + "paper", the `x` position refers to the + distance from the left side of the plotting + area in normalized coordinates where 0 (1) + corresponds to the left (right) side. + xshift + Shifts the position of the whole annotation and + arrow to the right (positive) or left + (negative) by this many pixels. + y + Sets the annotation's y position. If the axis + `type` is "log", then you must take the log of + your desired range. If the axis `type` is + "date", it should be date strings, like date + data, though Date objects and unix milliseconds + will be accepted and converted to strings. If + the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order + it appears. + yanchor + Sets the text box's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the annotation. + For example, if `y` is set to 1, `yref` to + "paper" and `yanchor` to "top" then the top- + most portion of the annotation lines up with + the top-most edge of the plotting area. If + "auto", the anchor is equivalent to "middle" + for data-referenced annotations or if there is + an arrow, whereas for paper-referenced with no + arrow, the anchor picked corresponds to the + closest side. + yclick + Toggle this annotation when clicking a data + point whose `y` value is `yclick` rather than + the annotation's `y` value. + yref + Sets the annotation's y coordinate axis. If set + to an y axis id (e.g. "y" or "y2"), the `y` + position refers to an y coordinate If set to + "paper", the `y` position refers to the + distance from the bottom of the plotting area + in normalized coordinates where 0 (1) + corresponds to the bottom (top). + yshift + Shifts the position of the whole annotation and + arrow up (positive) or down (negative) by this + many pixels. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AngularAxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='angularaxis', parent_name='layout', **kwargs + ): + super(AngularAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'AngularAxis'), + data_docs=kwargs.pop( + 'data_docs', """ + domain + Polar chart subplots are not supported yet. + This key has currently no effect. + endpadding + Legacy polar charts are deprecated! Please + switch to "polar" subplots. + range + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Defines the start + and end point of this angular axis. + showline + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Determines whether + or not the line bounding this angular axis will + be shown on the figure. + showticklabels + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Determines whether + or not the angular axis ticks will feature tick + labels. + tickcolor + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the color of + the tick lines on this angular axis. + ticklen + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the length of + the tick lines on this angular axis. + tickorientation + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the + orientation (from the paper perspective) of the + angular axis tick labels. + ticksuffix + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Sets the length of + the tick lines on this angular axis. + visible + Legacy polar charts are deprecated! Please + switch to "polar" subplots. Determines whether + or not this axis will be visible. +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/_angularaxis.py b/plotly/validators/layout/_angularaxis.py deleted file mode 100644 index fb7165340db..00000000000 --- a/plotly/validators/layout/_angularaxis.py +++ /dev/null @@ -1,59 +0,0 @@ -import _plotly_utils.basevalidators - - -class AngularAxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='angularaxis', parent_name='layout', **kwargs - ): - super(AngularAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'AngularAxis'), - data_docs=kwargs.pop( - 'data_docs', """ - domain - Polar chart subplots are not supported yet. - This key has currently no effect. - endpadding - Legacy polar charts are deprecated! Please - switch to "polar" subplots. - range - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Defines the start - and end point of this angular axis. - showline - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Determines whether - or not the line bounding this angular axis will - be shown on the figure. - showticklabels - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Determines whether - or not the angular axis ticks will feature tick - labels. - tickcolor - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the color of - the tick lines on this angular axis. - ticklen - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the length of - the tick lines on this angular axis. - tickorientation - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the - orientation (from the paper perspective) of the - angular axis tick labels. - ticksuffix - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the length of - the tick lines on this angular axis. - visible - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Determines whether - or not this axis will be visible. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_annotationdefaults.py b/plotly/validators/layout/_annotationdefaults.py deleted file mode 100644 index 4d5680a395f..00000000000 --- a/plotly/validators/layout/_annotationdefaults.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AnnotationValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='annotationdefaults', parent_name='layout', **kwargs - ): - super(AnnotationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Annotation'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/_annotations.py b/plotly/validators/layout/_annotations.py deleted file mode 100644 index cdb87b92ddf..00000000000 --- a/plotly/validators/layout/_annotations.py +++ /dev/null @@ -1,281 +0,0 @@ -import _plotly_utils.basevalidators - - -class AnnotationsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, plotly_name='annotations', parent_name='layout', **kwargs - ): - super(AnnotationsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Annotation'), - data_docs=kwargs.pop( - 'data_docs', """ - align - Sets the horizontal alignment of the `text` - within the box. Has an effect only if `text` - spans more two or more lines (i.e. `text` - contains one or more
HTML tags) or if an - explicit width is set to override the text - width. - arrowcolor - Sets the color of the annotation arrow. - arrowhead - Sets the end annotation arrow head style. - arrowside - Sets the annotation arrow head position. - arrowsize - Sets the size of the end annotation arrow head, - relative to `arrowwidth`. A value of 1 - (default) gives a head about 3x as wide as the - line. - arrowwidth - Sets the width (in px) of annotation arrow - line. - ax - Sets the x component of the arrow tail about - the arrow head. If `axref` is `pixel`, a - positive (negative) component corresponds to - an arrow pointing from right to left (left to - right). If `axref` is an axis, this is an - absolute value on that axis, like `x`, NOT a - relative value. - axref - Indicates in what terms the tail of the - annotation (ax,ay) is specified. If `pixel`, - `ax` is a relative offset in pixels from `x`. - If set to an x axis id (e.g. "x" or "x2"), `ax` - is specified in the same terms as that axis. - This is useful for trendline annotations which - should continue to indicate the correct trend - when zoomed. - ay - Sets the y component of the arrow tail about - the arrow head. If `ayref` is `pixel`, a - positive (negative) component corresponds to - an arrow pointing from bottom to top (top to - bottom). If `ayref` is an axis, this is an - absolute value on that axis, like `y`, NOT a - relative value. - ayref - Indicates in what terms the tail of the - annotation (ax,ay) is specified. If `pixel`, - `ay` is a relative offset in pixels from `y`. - If set to a y axis id (e.g. "y" or "y2"), `ay` - is specified in the same terms as that axis. - This is useful for trendline annotations which - should continue to indicate the correct trend - when zoomed. - bgcolor - Sets the background color of the annotation. - bordercolor - Sets the color of the border enclosing the - annotation `text`. - borderpad - Sets the padding (in px) between the `text` and - the enclosing border. - borderwidth - Sets the width (in px) of the border enclosing - the annotation `text`. - captureevents - Determines whether the annotation text box - captures mouse move and click events, or allows - those events to pass through to data points in - the plot that may be behind the annotation. By - default `captureevents` is False unless - `hovertext` is provided. If you use the event - `plotly_clickannotation` without `hovertext` - you must explicitly enable `captureevents`. - clicktoshow - Makes this annotation respond to clicks on the - plot. If you click a data point that exactly - matches the `x` and `y` values of this - annotation, and it is hidden (visible: false), - it will appear. In "onoff" mode, you must click - the same point again to make it disappear, so - if you click multiple points, you can show - multiple annotations. In "onout" mode, a click - anywhere else in the plot (on another data - point or not) will hide this annotation. If you - need to show/hide this annotation in response - to different `x` or `y` values, you can set - `xclick` and/or `yclick`. This is useful for - example to label the side of a bar. To label - markers though, `standoff` is preferred over - `xclick` and `yclick`. - font - Sets the annotation text font. - height - Sets an explicit height for the text box. null - (default) lets the text set the box height. - Taller text will be clipped. - hoverlabel - plotly.graph_objs.layout.annotation.Hoverlabel - instance or dict with compatible properties - hovertext - Sets text to appear when hovering over this - annotation. If omitted or blank, no hover label - will appear. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - opacity - Sets the opacity of the annotation (text + - arrow). - showarrow - Determines whether or not the annotation is - drawn with an arrow. If True, `text` is placed - near the arrow's tail. If False, `text` lines - up with the `x` and `y` provided. - standoff - Sets a distance, in pixels, to move the end - arrowhead away from the position it is pointing - at, for example to point at the edge of a - marker independent of zoom. Note that this - shortens the arrow from the `ax` / `ay` vector, - in contrast to `xshift` / `yshift` which moves - everything by this amount. - startarrowhead - Sets the start annotation arrow head style. - startarrowsize - Sets the size of the start annotation arrow - head, relative to `arrowwidth`. A value of 1 - (default) gives a head about 3x as wide as the - line. - startstandoff - Sets a distance, in pixels, to move the start - arrowhead away from the position it is pointing - at, for example to point at the edge of a - marker independent of zoom. Note that this - shortens the arrow from the `ax` / `ay` vector, - in contrast to `xshift` / `yshift` which moves - everything by this amount. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - text - Sets the text associated with this annotation. - Plotly uses a subset of HTML tags to do things - like newline (
), bold (), italics - (), hyperlinks (). - Tags , , are also - supported. - textangle - Sets the angle at which the `text` is drawn - with respect to the horizontal. - valign - Sets the vertical alignment of the `text` - within the box. Has an effect only if an - explicit height is set to override the text - height. - visible - Determines whether or not this annotation is - visible. - width - Sets an explicit width for the text box. null - (default) lets the text set the box width. - Wider text will be clipped. There is no - automatic wrapping; use
to start a new - line. - x - Sets the annotation's x position. If the axis - `type` is "log", then you must take the log of - your desired range. If the axis `type` is - "date", it should be date strings, like date - data, though Date objects and unix milliseconds - will be accepted and converted to strings. If - the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order - it appears. - xanchor - Sets the text box's horizontal position anchor - This anchor binds the `x` position to the - "left", "center" or "right" of the annotation. - For example, if `x` is set to 1, `xref` to - "paper" and `xanchor` to "right" then the - right-most portion of the annotation lines up - with the right-most edge of the plotting area. - If "auto", the anchor is equivalent to "center" - for data-referenced annotations or if there is - an arrow, whereas for paper-referenced with no - arrow, the anchor picked corresponds to the - closest side. - xclick - Toggle this annotation when clicking a data - point whose `x` value is `xclick` rather than - the annotation's `x` value. - xref - Sets the annotation's x coordinate axis. If set - to an x axis id (e.g. "x" or "x2"), the `x` - position refers to an x coordinate If set to - "paper", the `x` position refers to the - distance from the left side of the plotting - area in normalized coordinates where 0 (1) - corresponds to the left (right) side. - xshift - Shifts the position of the whole annotation and - arrow to the right (positive) or left - (negative) by this many pixels. - y - Sets the annotation's y position. If the axis - `type` is "log", then you must take the log of - your desired range. If the axis `type` is - "date", it should be date strings, like date - data, though Date objects and unix milliseconds - will be accepted and converted to strings. If - the axis `type` is "category", it should be - numbers, using the scale where each category is - assigned a serial number from zero in the order - it appears. - yanchor - Sets the text box's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the annotation. - For example, if `y` is set to 1, `yref` to - "paper" and `yanchor` to "top" then the top- - most portion of the annotation lines up with - the top-most edge of the plotting area. If - "auto", the anchor is equivalent to "middle" - for data-referenced annotations or if there is - an arrow, whereas for paper-referenced with no - arrow, the anchor picked corresponds to the - closest side. - yclick - Toggle this annotation when clicking a data - point whose `y` value is `yclick` rather than - the annotation's `y` value. - yref - Sets the annotation's y coordinate axis. If set - to an y axis id (e.g. "y" or "y2"), the `y` - position refers to an y coordinate If set to - "paper", the `y` position refers to the - distance from the bottom of the plotting area - in normalized coordinates where 0 (1) - corresponds to the bottom (top). - yshift - Shifts the position of the whole annotation and - arrow up (positive) or down (negative) by this - many pixels. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_autosize.py b/plotly/validators/layout/_autosize.py deleted file mode 100644 index 70c348b776a..00000000000 --- a/plotly/validators/layout/_autosize.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutosizeValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='autosize', parent_name='layout', **kwargs): - super(AutosizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/_bargap.py b/plotly/validators/layout/_bargap.py deleted file mode 100644 index dc34e63e110..00000000000 --- a/plotly/validators/layout/_bargap.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BargapValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='bargap', parent_name='layout', **kwargs): - super(BargapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/_bargroupgap.py b/plotly/validators/layout/_bargroupgap.py deleted file mode 100644 index e5d20f792f5..00000000000 --- a/plotly/validators/layout/_bargroupgap.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class BargroupgapValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='bargroupgap', parent_name='layout', **kwargs - ): - super(BargroupgapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/_barmode.py b/plotly/validators/layout/_barmode.py deleted file mode 100644 index 5c992d39591..00000000000 --- a/plotly/validators/layout/_barmode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BarmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='barmode', parent_name='layout', **kwargs): - super(BarmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['stack', 'group', 'overlay', 'relative'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/_barnorm.py b/plotly/validators/layout/_barnorm.py deleted file mode 100644 index c1a45739194..00000000000 --- a/plotly/validators/layout/_barnorm.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class BarnormValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='barnorm', parent_name='layout', **kwargs): - super(BarnormValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['', 'fraction', 'percent']), - **kwargs - ) diff --git a/plotly/validators/layout/_boxgap.py b/plotly/validators/layout/_boxgap.py deleted file mode 100644 index 9c44418cf61..00000000000 --- a/plotly/validators/layout/_boxgap.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BoxgapValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='boxgap', parent_name='layout', **kwargs): - super(BoxgapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/_boxgroupgap.py b/plotly/validators/layout/_boxgroupgap.py deleted file mode 100644 index 76dd45a95ab..00000000000 --- a/plotly/validators/layout/_boxgroupgap.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class BoxgroupgapValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='boxgroupgap', parent_name='layout', **kwargs - ): - super(BoxgroupgapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/_boxmode.py b/plotly/validators/layout/_boxmode.py deleted file mode 100644 index cdda1d803cb..00000000000 --- a/plotly/validators/layout/_boxmode.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class BoxmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='boxmode', parent_name='layout', **kwargs): - super(BoxmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['group', 'overlay']), - **kwargs - ) diff --git a/plotly/validators/layout/_calendar.py b/plotly/validators/layout/_calendar.py deleted file mode 100644 index 438a2be18a6..00000000000 --- a/plotly/validators/layout/_calendar.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class CalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='calendar', parent_name='layout', **kwargs): - super(CalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/_clickmode.py b/plotly/validators/layout/_clickmode.py deleted file mode 100644 index 0bb6cc2ff0e..00000000000 --- a/plotly/validators/layout/_clickmode.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ClickmodeValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='clickmode', parent_name='layout', **kwargs - ): - super(ClickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - extras=kwargs.pop('extras', ['none']), - flags=kwargs.pop('flags', ['event', 'select']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/_colorscale.py b/plotly/validators/layout/_colorscale.py deleted file mode 100644 index e08c5588cd8..00000000000 --- a/plotly/validators/layout/_colorscale.py +++ /dev/null @@ -1,30 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='layout', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Colorscale'), - data_docs=kwargs.pop( - 'data_docs', """ - diverging - Sets the default diverging colorscale. Note - that `autocolorscale` must be true for this - attribute to work. - sequential - Sets the default sequential colorscale for - positive values. Note that `autocolorscale` - must be true for this attribute to work. - sequentialminus - Sets the default sequential colorscale for - negative values. Note that `autocolorscale` - must be true for this attribute to work. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_colorway.py b/plotly/validators/layout/_colorway.py deleted file mode 100644 index ff32e65f782..00000000000 --- a/plotly/validators/layout/_colorway.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorwayValidator(_plotly_utils.basevalidators.ColorlistValidator): - - def __init__(self, plotly_name='colorway', parent_name='layout', **kwargs): - super(ColorwayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/_datarevision.py b/plotly/validators/layout/_datarevision.py deleted file mode 100644 index 43330a2c75c..00000000000 --- a/plotly/validators/layout/_datarevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class DatarevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='datarevision', parent_name='layout', **kwargs - ): - super(DatarevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/_direction.py b/plotly/validators/layout/_direction.py deleted file mode 100644 index 224b7611d65..00000000000 --- a/plotly/validators/layout/_direction.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DirectionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='direction', parent_name='layout', **kwargs - ): - super(DirectionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['clockwise', 'counterclockwise']), - **kwargs - ) diff --git a/plotly/validators/layout/_dragmode.py b/plotly/validators/layout/_dragmode.py deleted file mode 100644 index 4dc9ce32f55..00000000000 --- a/plotly/validators/layout/_dragmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DragmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='dragmode', parent_name='layout', **kwargs): - super(DragmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'modebar'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'zoom', 'pan', 'select', 'lasso', 'orbit', 'turntable', - False - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/_editrevision.py b/plotly/validators/layout/_editrevision.py deleted file mode 100644 index 89f20d9503c..00000000000 --- a/plotly/validators/layout/_editrevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class EditrevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='editrevision', parent_name='layout', **kwargs - ): - super(EditrevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/_extendpiecolors.py b/plotly/validators/layout/_extendpiecolors.py deleted file mode 100644 index 1edd1b916f2..00000000000 --- a/plotly/validators/layout/_extendpiecolors.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExtendpiecolorsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='extendpiecolors', parent_name='layout', **kwargs - ): - super(ExtendpiecolorsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/_font.py b/plotly/validators/layout/_font.py deleted file mode 100644 index f051d6e601e..00000000000 --- a/plotly/validators/layout/_font.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='font', parent_name='layout', **kwargs): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_geo.py b/plotly/validators/layout/_geo.py deleted file mode 100644 index 94f57dbd0ab..00000000000 --- a/plotly/validators/layout/_geo.py +++ /dev/null @@ -1,92 +0,0 @@ -import _plotly_utils.basevalidators - - -class GeoValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='geo', parent_name='layout', **kwargs): - super(GeoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Geo'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Set the background color of the map - center - plotly.graph_objs.layout.geo.Center instance or - dict with compatible properties - coastlinecolor - Sets the coastline color. - coastlinewidth - Sets the coastline stroke width (in px). - countrycolor - Sets line color of the country boundaries. - countrywidth - Sets line width (in px) of the country - boundaries. - domain - plotly.graph_objs.layout.geo.Domain instance or - dict with compatible properties - framecolor - Sets the color the frame. - framewidth - Sets the stroke width (in px) of the frame. - lakecolor - Sets the color of the lakes. - landcolor - Sets the land mass color. - lataxis - plotly.graph_objs.layout.geo.Lataxis instance - or dict with compatible properties - lonaxis - plotly.graph_objs.layout.geo.Lonaxis instance - or dict with compatible properties - oceancolor - Sets the ocean color - projection - plotly.graph_objs.layout.geo.Projection - instance or dict with compatible properties - resolution - Sets the resolution of the base layers. The - values have units of km/mm e.g. 110 corresponds - to a scale ratio of 1:110,000,000. - rivercolor - Sets color of the rivers. - riverwidth - Sets the stroke width (in px) of the rivers. - scope - Set the scope of the map. - showcoastlines - Sets whether or not the coastlines are drawn. - showcountries - Sets whether or not country boundaries are - drawn. - showframe - Sets whether or not a frame is drawn around the - map. - showlakes - Sets whether or not lakes are drawn. - showland - Sets whether or not land masses are filled in - color. - showocean - Sets whether or not oceans are filled in color. - showrivers - Sets whether or not rivers are drawn. - showsubunits - Sets whether or not boundaries of subunits - within countries (e.g. states, provinces) are - drawn. - subunitcolor - Sets the color of the subunits boundaries. - subunitwidth - Sets the stroke width (in px) of the subunits - boundaries. - uirevision - Controls persistence of user-driven changes in - the view (projection and center). Defaults to - `layout.uirevision`. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_grid.py b/plotly/validators/layout/_grid.py deleted file mode 100644 index 48714662535..00000000000 --- a/plotly/validators/layout/_grid.py +++ /dev/null @@ -1,95 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='grid', parent_name='layout', **kwargs): - super(GridValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Grid'), - data_docs=kwargs.pop( - 'data_docs', """ - columns - The number of columns in the grid. If you - provide a 2D `subplots` array, the length of - its longest row is used as the default. If you - give an `xaxes` array, its length is used as - the default. But it's also possible to have a - different length, if you want to leave a row at - the end for non-cartesian subplots. - domain - plotly.graph_objs.layout.grid.Domain instance - or dict with compatible properties - pattern - If no `subplots`, `xaxes`, or `yaxes` are given - but we do have `rows` and `columns`, we can - generate defaults using consecutive axis IDs, - in two ways: "coupled" gives one x axis per - column and one y axis per row. "independent" - uses a new xy pair for each cell, left-to-right - across each row then iterating rows according - to `roworder`. - roworder - Is the first row the top or the bottom? Note - that columns are always enumerated from left to - right. - rows - The number of rows in the grid. If you provide - a 2D `subplots` array or a `yaxes` array, its - length is used as the default. But it's also - possible to have a different length, if you - want to leave a row at the end for non- - cartesian subplots. - subplots - Used for freeform grids, where some axes may be - shared across subplots but others are not. Each - entry should be a cartesian subplot id, like - "xy" or "x3y2", or "" to leave that cell empty. - You may reuse x axes within the same column, - and y axes within the same row. Non-cartesian - subplots and traces that support `domain` can - place themselves in this grid separately using - the `gridcell` attribute. - xaxes - Used with `yaxes` when the x and y axes are - shared across columns and rows. Each entry - should be an x axis id like "x", "x2", etc., or - "" to not put an x axis in that column. Entries - other than "" must be unique. Ignored if - `subplots` is present. If missing but `yaxes` - is present, will generate consecutive IDs. - xgap - Horizontal space between grid cells, expressed - as a fraction of the total width available to - one cell. Defaults to 0.1 for coupled-axes - grids and 0.2 for independent grids. - xside - Sets where the x axis labels and titles go. - "bottom" means the very bottom of the grid. - "bottom plot" is the lowest plot that each x - axis is used in. "top" and "top plot" are - similar. - yaxes - Used with `yaxes` when the x and y axes are - shared across columns and rows. Each entry - should be an y axis id like "y", "y2", etc., or - "" to not put a y axis in that row. Entries - other than "" must be unique. Ignored if - `subplots` is present. If missing but `xaxes` - is present, will generate consecutive IDs. - ygap - Vertical space between grid cells, expressed as - a fraction of the total height available to one - cell. Defaults to 0.1 for coupled-axes grids - and 0.3 for independent grids. - yside - Sets where the y axis labels and titles go. - "left" means the very left edge of the grid. - *left plot* is the leftmost plot that each y - axis is used in. "right" and *right plot* are - similar. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_height.py b/plotly/validators/layout/_height.py deleted file mode 100644 index 3bc75f66c27..00000000000 --- a/plotly/validators/layout/_height.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class HeightValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='height', parent_name='layout', **kwargs): - super(HeightValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 10), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/_hiddenlabels.py b/plotly/validators/layout/_hiddenlabels.py deleted file mode 100644 index 96a8455a2c5..00000000000 --- a/plotly/validators/layout/_hiddenlabels.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HiddenlabelsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='hiddenlabels', parent_name='layout', **kwargs - ): - super(HiddenlabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/_hiddenlabelssrc.py b/plotly/validators/layout/_hiddenlabelssrc.py deleted file mode 100644 index d5cad26e6c2..00000000000 --- a/plotly/validators/layout/_hiddenlabelssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HiddenlabelssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hiddenlabelssrc', parent_name='layout', **kwargs - ): - super(HiddenlabelssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/_hidesources.py b/plotly/validators/layout/_hidesources.py deleted file mode 100644 index ec9cdb3abce..00000000000 --- a/plotly/validators/layout/_hidesources.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HidesourcesValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='hidesources', parent_name='layout', **kwargs - ): - super(HidesourcesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/_hoverdistance.py b/plotly/validators/layout/_hoverdistance.py deleted file mode 100644 index bac0bff7954..00000000000 --- a/plotly/validators/layout/_hoverdistance.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverdistanceValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='hoverdistance', parent_name='layout', **kwargs - ): - super(HoverdistanceValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/_hoverlabel.py b/plotly/validators/layout/_hoverlabel.py deleted file mode 100644 index 0e634b5e9b2..00000000000 --- a/plotly/validators/layout/_hoverlabel.py +++ /dev/null @@ -1,37 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='layout', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of all hover labels - on graph - bordercolor - Sets the border color of all hover labels on - graph. - font - Sets the default hover label font used by all - traces on the graph. - namelength - Sets the default length (in number of - characters) of the trace name in the hover - labels for all traces. -1 shows the whole name - regardless of length. 0-3 shows the first 0-3 - characters, and an integer >3 will show the - whole name if it is less than that many - characters, but if it is longer, will truncate - to `namelength - 3` characters and add an - ellipsis. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_hovermode.py b/plotly/validators/layout/_hovermode.py deleted file mode 100644 index 64cb409ae4c..00000000000 --- a/plotly/validators/layout/_hovermode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovermodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='hovermode', parent_name='layout', **kwargs - ): - super(HovermodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'modebar'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['x', 'y', 'closest', False]), - **kwargs - ) diff --git a/plotly/validators/layout/_imagedefaults.py b/plotly/validators/layout/_imagedefaults.py deleted file mode 100644 index e9bf8128944..00000000000 --- a/plotly/validators/layout/_imagedefaults.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ImageValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='imagedefaults', parent_name='layout', **kwargs - ): - super(ImageValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Image'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/_images.py b/plotly/validators/layout/_images.py deleted file mode 100644 index 67eed1930be..00000000000 --- a/plotly/validators/layout/_images.py +++ /dev/null @@ -1,93 +0,0 @@ -import _plotly_utils.basevalidators - - -class ImagesValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__(self, plotly_name='images', parent_name='layout', **kwargs): - super(ImagesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Image'), - data_docs=kwargs.pop( - 'data_docs', """ - layer - Specifies whether images are drawn below or - above traces. When `xref` and `yref` are both - set to `paper`, image is drawn below the entire - plot area. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - opacity - Sets the opacity of the image. - sizex - Sets the image container size horizontally. The - image will be sized based on the `position` - value. When `xref` is set to `paper`, units are - sized relative to the plot width. - sizey - Sets the image container size vertically. The - image will be sized based on the `position` - value. When `yref` is set to `paper`, units are - sized relative to the plot height. - sizing - Specifies which dimension of the image to - constrain. - source - Specifies the URL of the image to be used. The - URL must be accessible from the domain where - the plot code is run, and can be either - relative or absolute. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - visible - Determines whether or not this image is - visible. - x - Sets the image's x position. When `xref` is set - to `paper`, units are sized relative to the - plot height. See `xref` for more info - xanchor - Sets the anchor for the x position - xref - Sets the images's x coordinate axis. If set to - a x axis id (e.g. "x" or "x2"), the `x` - position refers to an x data coordinate If set - to "paper", the `x` position refers to the - distance from the left of plot in normalized - coordinates where 0 (1) corresponds to the left - (right). - y - Sets the image's y position. When `yref` is set - to `paper`, units are sized relative to the - plot height. See `yref` for more info - yanchor - Sets the anchor for the y position. - yref - Sets the images's y coordinate axis. If set to - a y axis id (e.g. "y" or "y2"), the `y` - position refers to a y data coordinate. If set - to "paper", the `y` position refers to the - distance from the bottom of the plot in - normalized coordinates where 0 (1) corresponds - to the bottom (top). -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_legend.py b/plotly/validators/layout/_legend.py deleted file mode 100644 index 7ade1fc0069..00000000000 --- a/plotly/validators/layout/_legend.py +++ /dev/null @@ -1,62 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='legend', parent_name='layout', **kwargs): - super(LegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Legend'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the legend background color. - bordercolor - Sets the color of the border enclosing the - legend. - borderwidth - Sets the width (in px) of the border enclosing - the legend. - font - Sets the font used to text the legend items. - orientation - Sets the orientation of the legend. - tracegroupgap - Sets the amount of vertical space (in px) - between legend groups. - traceorder - Determines the order at which the legend items - are displayed. If "normal", the items are - displayed top-to-bottom in the same order as - the input data. If "reversed", the items are - displayed in the opposite order as "normal". If - "grouped", the items are displayed in groups - (when a trace `legendgroup` is provided). if - "grouped+reversed", the items are displayed in - the opposite order as "grouped". - uirevision - Controls persistence of legend-driven changes - in trace and pie label visibility. Defaults to - `layout.uirevision`. - valign - Sets the vertical alignment of the symbols with - respect to their associated text. - x - Sets the x position (in normalized coordinates) - of the legend. - xanchor - Sets the legend's horizontal position anchor. - This anchor binds the `x` position to the - "left", "center" or "right" of the legend. - y - Sets the y position (in normalized coordinates) - of the legend. - yanchor - Sets the legend's vertical position anchor This - anchor binds the `y` position to the "top", - "middle" or "bottom" of the legend. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_mapbox.py b/plotly/validators/layout/_mapbox.py deleted file mode 100644 index 5a74cfb17fd..00000000000 --- a/plotly/validators/layout/_mapbox.py +++ /dev/null @@ -1,52 +0,0 @@ -import _plotly_utils.basevalidators - - -class MapboxValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='mapbox', parent_name='layout', **kwargs): - super(MapboxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Mapbox'), - data_docs=kwargs.pop( - 'data_docs', """ - accesstoken - Sets the mapbox access token to be used for - this mapbox map. Alternatively, the mapbox - access token can be set in the configuration - options under `mapboxAccessToken`. - bearing - Sets the bearing angle of the map in degrees - counter-clockwise from North (mapbox.bearing). - center - plotly.graph_objs.layout.mapbox.Center instance - or dict with compatible properties - domain - plotly.graph_objs.layout.mapbox.Domain instance - or dict with compatible properties - layers - plotly.graph_objs.layout.mapbox.Layer instance - or dict with compatible properties - layerdefaults - When used in a template (as - layout.template.layout.mapbox.layerdefaults), - sets the default property values to use for - elements of layout.mapbox.layers - pitch - Sets the pitch angle of the map (in degrees, - where 0 means perpendicular to the surface of - the map) (mapbox.pitch). - style - Sets the Mapbox map style. Either input one of - the default Mapbox style names or the URL to a - custom style or a valid Mapbox style JSON. - uirevision - Controls persistence of user-driven changes in - the view: `center`, `zoom`, `bearing`, `pitch`. - Defaults to `layout.uirevision`. - zoom - Sets the zoom level of the map (mapbox.zoom). -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_margin.py b/plotly/validators/layout/_margin.py deleted file mode 100644 index eeea6f425f2..00000000000 --- a/plotly/validators/layout/_margin.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarginValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='margin', parent_name='layout', **kwargs): - super(MarginValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Margin'), - data_docs=kwargs.pop( - 'data_docs', """ - autoexpand - - b - Sets the bottom margin (in px). - l - Sets the left margin (in px). - pad - Sets the amount of padding (in px) between the - plotting area and the axis lines - r - Sets the right margin (in px). - t - Sets the top margin (in px). -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_meta.py b/plotly/validators/layout/_meta.py deleted file mode 100644 index 5961a1c1cfe..00000000000 --- a/plotly/validators/layout/_meta.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class MetaValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='meta', parent_name='layout', **kwargs): - super(MetaValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/_metasrc.py b/plotly/validators/layout/_metasrc.py deleted file mode 100644 index daf9a3e8003..00000000000 --- a/plotly/validators/layout/_metasrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class MetasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='metasrc', parent_name='layout', **kwargs): - super(MetasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/_modebar.py b/plotly/validators/layout/_modebar.py deleted file mode 100644 index cbcd3dd64d0..00000000000 --- a/plotly/validators/layout/_modebar.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class ModebarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='modebar', parent_name='layout', **kwargs): - super(ModebarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Modebar'), - data_docs=kwargs.pop( - 'data_docs', """ - activecolor - Sets the color of the active or hovered on - icons in the modebar. - bgcolor - Sets the background color of the modebar. - color - Sets the color of the icons in the modebar. - orientation - Sets the orientation of the modebar. - uirevision - Controls persistence of user-driven changes - related to the modebar, including `hovermode`, - `dragmode`, and `showspikes` at both the root - level and inside subplots. Defaults to - `layout.uirevision`. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_orientation.py b/plotly/validators/layout/_orientation.py deleted file mode 100644 index 153ac363c20..00000000000 --- a/plotly/validators/layout/_orientation.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OrientationValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, plotly_name='orientation', parent_name='layout', **kwargs - ): - super(OrientationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/_paper_bgcolor.py b/plotly/validators/layout/_paper_bgcolor.py deleted file mode 100644 index edb0974af45..00000000000 --- a/plotly/validators/layout/_paper_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class PaperBgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='paper_bgcolor', parent_name='layout', **kwargs - ): - super(PaperBgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/_piecolorway.py b/plotly/validators/layout/_piecolorway.py deleted file mode 100644 index e2248ca8213..00000000000 --- a/plotly/validators/layout/_piecolorway.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class PiecolorwayValidator(_plotly_utils.basevalidators.ColorlistValidator): - - def __init__( - self, plotly_name='piecolorway', parent_name='layout', **kwargs - ): - super(PiecolorwayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/_plot_bgcolor.py b/plotly/validators/layout/_plot_bgcolor.py deleted file mode 100644 index 4e38c49a951..00000000000 --- a/plotly/validators/layout/_plot_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class PlotBgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='plot_bgcolor', parent_name='layout', **kwargs - ): - super(PlotBgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/_polar.py b/plotly/validators/layout/_polar.py deleted file mode 100644 index 7d3b4d030d0..00000000000 --- a/plotly/validators/layout/_polar.py +++ /dev/null @@ -1,62 +0,0 @@ -import _plotly_utils.basevalidators - - -class PolarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='polar', parent_name='layout', **kwargs): - super(PolarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Polar'), - data_docs=kwargs.pop( - 'data_docs', """ - angularaxis - plotly.graph_objs.layout.polar.AngularAxis - instance or dict with compatible properties - bargap - Sets the gap between bars of adjacent location - coordinates. Values are unitless, they - represent fractions of the minimum difference - in bar positions in the data. - barmode - Determines how bars at the same location - coordinate are displayed on the graph. With - "stack", the bars are stacked on top of one - another With "overlay", the bars are plotted - over one another, you might need to an - "opacity" to see multiple bars. - bgcolor - Set the background color of the subplot - domain - plotly.graph_objs.layout.polar.Domain instance - or dict with compatible properties - gridshape - Determines if the radial axis grid lines and - angular axis line are drawn as "circular" - sectors or as "linear" (polygon) sectors. Has - an effect only when the angular axis has `type` - "category". Note that `radialaxis.angle` is - snapped to the angle of the closest vertex when - `gridshape` is "circular" (so that radial axis - scale is the same as the data scale). - hole - Sets the fraction of the radius to cut out of - the polar subplot. - radialaxis - plotly.graph_objs.layout.polar.RadialAxis - instance or dict with compatible properties - sector - Sets angular span of this polar subplot with - two angles (in degrees). Sector are assumed to - be spanned in the counterclockwise direction - with 0 corresponding to rightmost limit of the - polar subplot. - uirevision - Controls persistence of user-driven changes in - axis attributes, if not overridden in the - individual axes. Defaults to - `layout.uirevision`. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_radialaxis.py b/plotly/validators/layout/_radialaxis.py deleted file mode 100644 index dc217e1de2f..00000000000 --- a/plotly/validators/layout/_radialaxis.py +++ /dev/null @@ -1,64 +0,0 @@ -import _plotly_utils.basevalidators - - -class RadialAxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='radialaxis', parent_name='layout', **kwargs - ): - super(RadialAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'RadialAxis'), - data_docs=kwargs.pop( - 'data_docs', """ - domain - Polar chart subplots are not supported yet. - This key has currently no effect. - endpadding - Legacy polar charts are deprecated! Please - switch to "polar" subplots. - orientation - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the - orientation (an angle with respect to the - origin) of the radial axis. - range - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Defines the start - and end point of this radial axis. - showline - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Determines whether - or not the line bounding this radial axis will - be shown on the figure. - showticklabels - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Determines whether - or not the radial axis ticks will feature tick - labels. - tickcolor - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the color of - the tick lines on this radial axis. - ticklen - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the length of - the tick lines on this radial axis. - tickorientation - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the - orientation (from the paper perspective) of the - radial axis tick labels. - ticksuffix - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Sets the length of - the tick lines on this radial axis. - visible - Legacy polar charts are deprecated! Please - switch to "polar" subplots. Determines whether - or not this axis will be visible. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_scene.py b/plotly/validators/layout/_scene.py deleted file mode 100644 index 926afc6778f..00000000000 --- a/plotly/validators/layout/_scene.py +++ /dev/null @@ -1,66 +0,0 @@ -import _plotly_utils.basevalidators - - -class SceneValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='scene', parent_name='layout', **kwargs): - super(SceneValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scene'), - data_docs=kwargs.pop( - 'data_docs', """ - annotations - plotly.graph_objs.layout.scene.Annotation - instance or dict with compatible properties - annotationdefaults - When used in a template (as layout.template.lay - out.scene.annotationdefaults), sets the default - property values to use for elements of - layout.scene.annotations - aspectmode - If "cube", this scene's axes are drawn as a - cube, regardless of the axes' ranges. If - "data", this scene's axes are drawn in - proportion with the axes' ranges. If "manual", - this scene's axes are drawn in proportion with - the input of "aspectratio" (the default - behavior if "aspectratio" is provided). If - "auto", this scene's axes are drawn using the - results of "data" except when one axis is more - than four times the size of the two others, - where in that case the results of "cube" are - used. - aspectratio - Sets this scene's axis aspectratio. - bgcolor - - camera - plotly.graph_objs.layout.scene.Camera instance - or dict with compatible properties - domain - plotly.graph_objs.layout.scene.Domain instance - or dict with compatible properties - dragmode - Determines the mode of drag interactions for - this scene. - hovermode - Determines the mode of hover interactions for - this scene. - uirevision - Controls persistence of user-driven changes in - camera attributes. Defaults to - `layout.uirevision`. - xaxis - plotly.graph_objs.layout.scene.XAxis instance - or dict with compatible properties - yaxis - plotly.graph_objs.layout.scene.YAxis instance - or dict with compatible properties - zaxis - plotly.graph_objs.layout.scene.ZAxis instance - or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_selectdirection.py b/plotly/validators/layout/_selectdirection.py deleted file mode 100644 index 1c00dfce185..00000000000 --- a/plotly/validators/layout/_selectdirection.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectdirectionValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, plotly_name='selectdirection', parent_name='layout', **kwargs - ): - super(SelectdirectionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['h', 'v', 'd', 'any']), - **kwargs - ) diff --git a/plotly/validators/layout/_selectionrevision.py b/plotly/validators/layout/_selectionrevision.py deleted file mode 100644 index e40103ff533..00000000000 --- a/plotly/validators/layout/_selectionrevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectionrevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectionrevision', parent_name='layout', **kwargs - ): - super(SelectionrevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/_separators.py b/plotly/validators/layout/_separators.py deleted file mode 100644 index 09d4bebbb63..00000000000 --- a/plotly/validators/layout/_separators.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatorsValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='separators', parent_name='layout', **kwargs - ): - super(SeparatorsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/_shapedefaults.py b/plotly/validators/layout/_shapedefaults.py deleted file mode 100644 index 05185137b47..00000000000 --- a/plotly/validators/layout/_shapedefaults.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShapeValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='shapedefaults', parent_name='layout', **kwargs - ): - super(ShapeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Shape'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/_shapes.py b/plotly/validators/layout/_shapes.py deleted file mode 100644 index 73664bd5a52..00000000000 --- a/plotly/validators/layout/_shapes.py +++ /dev/null @@ -1,162 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShapesValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__(self, plotly_name='shapes', parent_name='layout', **kwargs): - super(ShapesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Shape'), - data_docs=kwargs.pop( - 'data_docs', """ - fillcolor - Sets the color filling the shape's interior. - layer - Specifies whether shapes are drawn below or - above traces. - line - plotly.graph_objs.layout.shape.Line instance or - dict with compatible properties - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - opacity - Sets the opacity of the shape. - path - For `type` "path" - a valid SVG path with the - pixel values replaced by data values in - `xsizemode`/`ysizemode` being "scaled" and - taken unmodified as pixels relative to - `xanchor` and `yanchor` in case of "pixel" size - mode. There are a few restrictions / quirks - only absolute instructions, not relative. So - the allowed segments are: M, L, H, V, Q, C, T, - S, and Z arcs (A) are not allowed because - radius rx and ry are relative. In the future we - could consider supporting relative commands, - but we would have to decide on how to handle - date and log axes. Note that even as is, Q and - C Bezier paths that are smooth on linear axes - may not be smooth on log, and vice versa. no - chained "polybezier" commands - specify the - segment type for each one. On category axes, - values are numbers scaled to the serial numbers - of categories because using the categories - themselves there would be no way to describe - fractional positions On data axes: because - space and T are both normal components of path - strings, we can't use either to separate date - from time parts. Therefore we'll use underscore - for this purpose: 2015-02-21_13:45:56.789 - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - type - Specifies the shape type to be drawn. If - "line", a line is drawn from (`x0`,`y0`) to - (`x1`,`y1`) with respect to the axes' sizing - mode. If "circle", a circle is drawn from - ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius - (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 - -`y0`)|) with respect to the axes' sizing mode. - If "rect", a rectangle is drawn linking - (`x0`,`y0`), (`x1`,`y0`), (`x1`,`y1`), - (`x0`,`y1`), (`x0`,`y0`) with respect to the - axes' sizing mode. If "path", draw a custom SVG - path using `path`. with respect to the axes' - sizing mode. - visible - Determines whether or not this shape is - visible. - x0 - Sets the shape's starting x position. See - `type` and `xsizemode` for more info. - x1 - Sets the shape's end x position. See `type` and - `xsizemode` for more info. - xanchor - Only relevant in conjunction with `xsizemode` - set to "pixel". Specifies the anchor point on - the x axis to which `x0`, `x1` and x - coordinates within `path` are relative to. E.g. - useful to attach a pixel sized shape to a - certain data value. No effect when `xsizemode` - not set to "pixel". - xref - Sets the shape's x coordinate axis. If set to - an x axis id (e.g. "x" or "x2"), the `x` - position refers to an x coordinate. If set to - "paper", the `x` position refers to the - distance from the left side of the plotting - area in normalized coordinates where 0 (1) - corresponds to the left (right) side. If the - axis `type` is "log", then you must take the - log of your desired range. If the axis `type` - is "date", then you must convert the date to - unix time in milliseconds. - xsizemode - Sets the shapes's sizing mode along the x axis. - If set to "scaled", `x0`, `x1` and x - coordinates within `path` refer to data values - on the x axis or a fraction of the plot area's - width (`xref` set to "paper"). If set to - "pixel", `xanchor` specifies the x position in - terms of data or plot fraction but `x0`, `x1` - and x coordinates within `path` are pixels - relative to `xanchor`. This way, the shape can - have a fixed width while maintaining a position - relative to data or plot fraction. - y0 - Sets the shape's starting y position. See - `type` and `ysizemode` for more info. - y1 - Sets the shape's end y position. See `type` and - `ysizemode` for more info. - yanchor - Only relevant in conjunction with `ysizemode` - set to "pixel". Specifies the anchor point on - the y axis to which `y0`, `y1` and y - coordinates within `path` are relative to. E.g. - useful to attach a pixel sized shape to a - certain data value. No effect when `ysizemode` - not set to "pixel". - yref - Sets the annotation's y coordinate axis. If set - to an y axis id (e.g. "y" or "y2"), the `y` - position refers to an y coordinate If set to - "paper", the `y` position refers to the - distance from the bottom of the plotting area - in normalized coordinates where 0 (1) - corresponds to the bottom (top). - ysizemode - Sets the shapes's sizing mode along the y axis. - If set to "scaled", `y0`, `y1` and y - coordinates within `path` refer to data values - on the y axis or a fraction of the plot area's - height (`yref` set to "paper"). If set to - "pixel", `yanchor` specifies the y position in - terms of data or plot fraction but `y0`, `y1` - and y coordinates within `path` are pixels - relative to `yanchor`. This way, the shape can - have a fixed height while maintaining a - position relative to data or plot fraction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_showlegend.py b/plotly/validators/layout/_showlegend.py deleted file mode 100644 index 048ac5e401d..00000000000 --- a/plotly/validators/layout/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='layout', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'legend'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/_sliderdefaults.py b/plotly/validators/layout/_sliderdefaults.py deleted file mode 100644 index 76cef00d805..00000000000 --- a/plotly/validators/layout/_sliderdefaults.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SliderValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='sliderdefaults', parent_name='layout', **kwargs - ): - super(SliderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Slider'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/_sliders.py b/plotly/validators/layout/_sliders.py deleted file mode 100644 index ce1e3b564d9..00000000000 --- a/plotly/validators/layout/_sliders.py +++ /dev/null @@ -1,107 +0,0 @@ -import _plotly_utils.basevalidators - - -class SlidersValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__(self, plotly_name='sliders', parent_name='layout', **kwargs): - super(SlidersValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Slider'), - data_docs=kwargs.pop( - 'data_docs', """ - active - Determines which button (by index starting from - 0) is considered active. - activebgcolor - Sets the background color of the slider grip - while dragging. - bgcolor - Sets the background color of the slider. - bordercolor - Sets the color of the border enclosing the - slider. - borderwidth - Sets the width (in px) of the border enclosing - the slider. - currentvalue - plotly.graph_objs.layout.slider.Currentvalue - instance or dict with compatible properties - font - Sets the font of the slider step labels. - len - Sets the length of the slider This measure - excludes the padding of both ends. That is, the - slider's length is this length minus the - padding on both ends. - lenmode - Determines whether this slider length is set in - units of plot "fraction" or in *pixels. Use - `len` to set the value. - minorticklen - Sets the length in pixels of minor step tick - marks - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - pad - Set the padding of the slider component along - each side. - steps - plotly.graph_objs.layout.slider.Step instance - or dict with compatible properties - stepdefaults - When used in a template (as - layout.template.layout.slider.stepdefaults), - sets the default property values to use for - elements of layout.slider.steps - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - tickcolor - Sets the color of the border enclosing the - slider. - ticklen - Sets the length in pixels of step tick marks - tickwidth - Sets the tick width (in px). - transition - plotly.graph_objs.layout.slider.Transition - instance or dict with compatible properties - visible - Determines whether or not the slider is - visible. - x - Sets the x position (in normalized coordinates) - of the slider. - xanchor - Sets the slider's horizontal position anchor. - This anchor binds the `x` position to the - "left", "center" or "right" of the range - selector. - y - Sets the y position (in normalized coordinates) - of the slider. - yanchor - Sets the slider's vertical position anchor This - anchor binds the `y` position to the "top", - "middle" or "bottom" of the range selector. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_spikedistance.py b/plotly/validators/layout/_spikedistance.py deleted file mode 100644 index 4a795005eaf..00000000000 --- a/plotly/validators/layout/_spikedistance.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikedistanceValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='spikedistance', parent_name='layout', **kwargs - ): - super(SpikedistanceValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/_template.py b/plotly/validators/layout/_template.py deleted file mode 100644 index 0decffc279b..00000000000 --- a/plotly/validators/layout/_template.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateValidator(_plotly_utils.basevalidators.BaseTemplateValidator): - - def __init__(self, plotly_name='template', parent_name='layout', **kwargs): - super(TemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Template'), - data_docs=kwargs.pop( - 'data_docs', """ - data - plotly.graph_objs.layout.template.Data instance - or dict with compatible properties - layout - plotly.graph_objs.layout.template.Layout - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_ternary.py b/plotly/validators/layout/_ternary.py deleted file mode 100644 index e656a803e82..00000000000 --- a/plotly/validators/layout/_ternary.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class TernaryValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='ternary', parent_name='layout', **kwargs): - super(TernaryValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Ternary'), - data_docs=kwargs.pop( - 'data_docs', """ - aaxis - plotly.graph_objs.layout.ternary.Aaxis instance - or dict with compatible properties - baxis - plotly.graph_objs.layout.ternary.Baxis instance - or dict with compatible properties - bgcolor - Set the background color of the subplot - caxis - plotly.graph_objs.layout.ternary.Caxis instance - or dict with compatible properties - domain - plotly.graph_objs.layout.ternary.Domain - instance or dict with compatible properties - sum - The number each triplet should sum to, and the - maximum range of each axis - uirevision - Controls persistence of user-driven changes in - axis `min` and `title`, if not overridden in - the individual axes. Defaults to - `layout.uirevision`. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_title.py b/plotly/validators/layout/_title.py deleted file mode 100644 index 7969f70f74e..00000000000 --- a/plotly/validators/layout/_title.py +++ /dev/null @@ -1,68 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__(self, plotly_name='title', parent_name='layout', **kwargs): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets the title font. Note that the title's font - used to be customized by the now deprecated - `titlefont` attribute. - pad - Sets the padding of the title. Each padding - value only applies when the corresponding - `xanchor`/`yanchor` value is set accordingly. - E.g. for left padding to take effect, `xanchor` - must be set to "left". The same rule applies if - `xanchor`/`yanchor` is determined - automatically. Padding is muted if the - respective anchor value is "middle*/*center". - text - Sets the plot's title. Note that before the - existence of `title.text`, the title's contents - used to be defined as the `title` attribute - itself. This behavior has been deprecated. - x - Sets the x position with respect to `xref` in - normalized coordinates from 0 (left) to 1 - (right). - xanchor - Sets the title's horizontal alignment with - respect to its x position. "left" means that - the title starts at x, "right" means that the - title ends at x and "center" means that the - title's center is at x. "auto" divides `xref` - by three and calculates the `xanchor` value - automatically based on the value of `x`. - xref - Sets the container `x` refers to. "container" - spans the entire `width` of the plot. "paper" - refers to the width of the plotting area only. - y - Sets the y position with respect to `yref` in - normalized coordinates from 0 (bottom) to 1 - (top). "auto" places the baseline of the title - onto the vertical center of the top margin. - yanchor - Sets the title's vertical alignment with - respect to its y position. "top" means that the - title's cap line is at y, "bottom" means that - the title's baseline is at y and "middle" means - that the title's midline is at y. "auto" - divides `yref` by three and calculates the - `yanchor` value automatically based on the - value of `y`. - yref - Sets the container `y` refers to. "container" - spans the entire `height` of the plot. "paper" - refers to the height of the plotting area only. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_transition.py b/plotly/validators/layout/_transition.py deleted file mode 100644 index 882d05c9c74..00000000000 --- a/plotly/validators/layout/_transition.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class TransitionValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='transition', parent_name='layout', **kwargs - ): - super(TransitionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Transition'), - data_docs=kwargs.pop( - 'data_docs', """ - duration - The duration of the transition, in - milliseconds. If equal to zero, updates are - synchronous. - easing - The easing function used for the transition - ordering - Determines whether the figure's layout or - traces smoothly transitions during updates that - make both traces and layout change. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_uirevision.py b/plotly/validators/layout/_uirevision.py deleted file mode 100644 index 0e083690c71..00000000000 --- a/plotly/validators/layout/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='layout', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/_updatemenudefaults.py b/plotly/validators/layout/_updatemenudefaults.py deleted file mode 100644 index 95a0878c069..00000000000 --- a/plotly/validators/layout/_updatemenudefaults.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class UpdatemenuValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='updatemenudefaults', parent_name='layout', **kwargs - ): - super(UpdatemenuValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Updatemenu'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/_updatemenus.py b/plotly/validators/layout/_updatemenus.py deleted file mode 100644 index 710a0deddf0..00000000000 --- a/plotly/validators/layout/_updatemenus.py +++ /dev/null @@ -1,98 +0,0 @@ -import _plotly_utils.basevalidators - - -class UpdatemenusValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, plotly_name='updatemenus', parent_name='layout', **kwargs - ): - super(UpdatemenusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Updatemenu'), - data_docs=kwargs.pop( - 'data_docs', """ - active - Determines which button (by index starting from - 0) is considered active. - bgcolor - Sets the background color of the update menu - buttons. - bordercolor - Sets the color of the border enclosing the - update menu. - borderwidth - Sets the width (in px) of the border enclosing - the update menu. - buttons - plotly.graph_objs.layout.updatemenu.Button - instance or dict with compatible properties - buttondefaults - When used in a template (as layout.template.lay - out.updatemenu.buttondefaults), sets the - default property values to use for elements of - layout.updatemenu.buttons - direction - Determines the direction in which the buttons - are laid out, whether in a dropdown menu or a - row/column of buttons. For `left` and `up`, the - buttons will still appear in left-to-right or - top-to-bottom order respectively. - font - Sets the font of the update menu button text. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - pad - Sets the padding around the buttons or dropdown - menu. - showactive - Highlights active dropdown item or active - button if true. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - type - Determines whether the buttons are accessible - via a dropdown menu or whether the buttons are - stacked horizontally or vertically - visible - Determines whether or not the update menu is - visible. - x - Sets the x position (in normalized coordinates) - of the update menu. - xanchor - Sets the update menu's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the range - selector. - y - Sets the y position (in normalized coordinates) - of the update menu. - yanchor - Sets the update menu's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the range - selector. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_violingap.py b/plotly/validators/layout/_violingap.py deleted file mode 100644 index def88db3fcb..00000000000 --- a/plotly/validators/layout/_violingap.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ViolingapValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='violingap', parent_name='layout', **kwargs - ): - super(ViolingapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/_violingroupgap.py b/plotly/validators/layout/_violingroupgap.py deleted file mode 100644 index 1da0a2e41a0..00000000000 --- a/plotly/validators/layout/_violingroupgap.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ViolingroupgapValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='violingroupgap', parent_name='layout', **kwargs - ): - super(ViolingroupgapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/_violinmode.py b/plotly/validators/layout/_violinmode.py deleted file mode 100644 index 8aa5192ce32..00000000000 --- a/plotly/validators/layout/_violinmode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ViolinmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='violinmode', parent_name='layout', **kwargs - ): - super(ViolinmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['group', 'overlay']), - **kwargs - ) diff --git a/plotly/validators/layout/_width.py b/plotly/validators/layout/_width.py deleted file mode 100644 index b17f7c0367f..00000000000 --- a/plotly/validators/layout/_width.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='width', parent_name='layout', **kwargs): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 10), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/_xaxis.py b/plotly/validators/layout/_xaxis.py deleted file mode 100644 index 2f734d618ea..00000000000 --- a/plotly/validators/layout/_xaxis.py +++ /dev/null @@ -1,426 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='xaxis', parent_name='layout', **kwargs): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'XAxis'), - data_docs=kwargs.pop( - 'data_docs', """ - anchor - If set to an opposite-letter axis id (e.g. - `x2`, `y`), this axis is bound to the - corresponding opposite-letter axis. If set to - "free", this axis' position is determined by - `position`. - automargin - Determines whether long tick labels - automatically grow the figure margins. - autorange - Determines whether or not the range of this - axis is computed in relation to the input data. - See `rangemode` for more info. If `range` is - provided, then `autorange` is set to False. - calendar - Sets the calendar system to use for `range` and - `tick0` if this is a date axis. This does not - set the calendar for interpreting data on this - axis, that's specified in the trace or via the - global `layout.calendar` - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - constrain - If this axis needs to be compressed (either due - to its own `scaleanchor` and `scaleratio` or - those of the other axis), determines how that - happens: by increasing the "range" (default), - or by decreasing the "domain". - constraintoward - If this axis needs to be compressed (either due - to its own `scaleanchor` and `scaleratio` or - those of the other axis), determines which - direction we push the originally specified plot - area. Options are "left", "center" (default), - and "right" for x axes, and "top", "middle" - (default), and "bottom" for y axes. - dividercolor - Sets the color of the dividers Only has an - effect on "multicategory" axes. - dividerwidth - Sets the width (in px) of the dividers Only has - an effect on "multicategory" axes. - domain - Sets the domain of this axis (in plot - fraction). - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - fixedrange - Determines whether or not this axis is zoom- - able. If true, then zoom is disabled. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - layer - Sets the layer on which this axis is displayed. - If *above traces*, this axis is displayed above - all the subplot's traces If *below traces*, - this axis is displayed below all the subplot's - traces, but above the grid lines. Useful when - used together with scatter-like traces with - `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - matches - If set to another axis id (e.g. `x2`, `y`), the - range of this axis will match the range of the - corresponding axis in data-coordinates space. - Moreover, matching axes share auto-range - values, category lists and histogram auto-bins. - Note that setting axes simultaneously in both a - `scaleanchor` and a `matches` constraint is - currently forbidden. Moreover, note that - matching axes must have the same `type`. - mirror - Determines if the axis lines or/and ticks are - mirrored to the opposite side of the plotting - area. If True, the axis lines are mirrored. If - "ticks", the axis lines and ticks are mirrored. - If False, mirroring is disable. If "all", axis - lines are mirrored on all shared-axes subplots. - If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - overlaying - If set a same-letter axis id, this axis is - overlaid on top of the corresponding same- - letter axis, with traces and axes visible for - both axes. If False, this axis does not overlay - any same-letter axes. In this case, for axes - with overlapping domains only the highest- - numbered axis will be visible. - position - Sets the position of this axis in the plotting - space (in normalized coordinates). Only has an - effect if `anchor` is set to "free". - range - Sets the range of this axis. If the axis `type` - is "log", then you must take the log of your - desired range (e.g. to set the range from 1 to - 100, set the range from 0 to 2). If the axis - `type` is "date", it should be date strings, - like date data, though Date objects and unix - milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it - should be numbers, using the scale where each - category is assigned a serial number from zero - in the order it appears. - rangemode - If "normal", the range is computed in relation - to the extrema of the input data. If *tozero*`, - the range extends to 0, regardless of the input - data If "nonnegative", the range is non- - negative, regardless of the input data. Applies - only to linear axes. - rangeselector - plotly.graph_objs.layout.xaxis.Rangeselector - instance or dict with compatible properties - rangeslider - plotly.graph_objs.layout.xaxis.Rangeslider - instance or dict with compatible properties - scaleanchor - If set to another axis id (e.g. `x2`, `y`), the - range of this axis changes together with the - range of the corresponding axis such that the - scale of pixels per unit is in a constant - ratio. Both axes are still zoomable, but when - you zoom one, the other will zoom the same - amount, keeping a fixed midpoint. `constrain` - and `constraintoward` determine how we enforce - the constraint. You can chain these, ie `yaxis: - {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` - but you can only link axes of the same `type`. - The linked axis can have the opposite letter - (to constrain the aspect ratio) or the same - letter (to match scales across subplots). Loops - (`yaxis: {scaleanchor: *x*}, xaxis: - {scaleanchor: *y*}` or longer) are redundant - and the last constraint encountered will be - ignored to avoid possible inconsistent - constraints via `scaleratio`. Note that setting - axes simultaneously in both a `scaleanchor` and - a `matches` constraint is currently forbidden. - scaleratio - If this axis is linked to another by - `scaleanchor`, this determines the pixel to - unit scale ratio. For example, if this value is - 10, then every unit on this axis spans 10 times - the number of pixels as a unit on the linked - axis. Use this for example to create an - elevation profile where the vertical scale is - exaggerated a fixed amount with respect to the - horizontal. - separatethousands - If "true", even 4-digit integers are separated - showdividers - Determines whether or not a dividers are drawn - between the category levels of this axis. Only - has an effect on "multicategory" axes. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showspikes - Determines whether or not spikes (aka - droplines) are drawn for this axis. Note: This - only takes affect when hovermode = closest - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - side - Determines whether a x (y) axis is positioned - at the "bottom" ("left") or "top" ("right") of - the plotting area. - spikecolor - Sets the spike color. If undefined, will use - the series color - spikedash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - spikemode - Determines the drawing mode for the spike line - If "toaxis", the line is drawn from the data - point to the axis the series is plotted on. If - "across", the line is drawn across the entire - plot area, and supercedes "toaxis". If - "marker", then a marker dot is drawn on the - axis the series is plotted on - spikesnap - Determines whether spikelines are stuck to the - cursor or to the closest datapoints. - spikethickness - Sets the width (in px) of the zero line. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.xaxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.xaxis.tickformatstopdefaults), sets the - default property values to use for elements of - layout.xaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - tickson - Determines where ticks and grid lines are drawn - with respect to their corresponding tick - labels. Only has an effect for axes of `type` - "category" or "multicategory". When set to - "boundaries", ticks and grid lines are drawn - half a category to the left/bottom of labels. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.xaxis.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use layout.xaxis.title.font - instead. Sets this axis' title font. Note that - the title's font used to be customized by the - now deprecated `titlefont` attribute. - type - Sets the axis type. By default, plotly attempts - to determined the axis type by looking into the - data of the traces that referenced the axis in - question. - uirevision - Controls persistence of user-driven changes in - axis `range`, `autorange`, and `title` if in - `editable: true` configuration. Defaults to - `layout.uirevision`. - visible - A single toggle to hide the axis while - preserving interaction like dragging. Default - is true when a cheater plot is present on the - axis, otherwise false - zeroline - Determines whether or not a line is drawn at - along the 0 value of this axis. If True, the - zero line is drawn on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/_yaxis.py b/plotly/validators/layout/_yaxis.py deleted file mode 100644 index e24f082df3c..00000000000 --- a/plotly/validators/layout/_yaxis.py +++ /dev/null @@ -1,420 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='yaxis', parent_name='layout', **kwargs): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'YAxis'), - data_docs=kwargs.pop( - 'data_docs', """ - anchor - If set to an opposite-letter axis id (e.g. - `x2`, `y`), this axis is bound to the - corresponding opposite-letter axis. If set to - "free", this axis' position is determined by - `position`. - automargin - Determines whether long tick labels - automatically grow the figure margins. - autorange - Determines whether or not the range of this - axis is computed in relation to the input data. - See `rangemode` for more info. If `range` is - provided, then `autorange` is set to False. - calendar - Sets the calendar system to use for `range` and - `tick0` if this is a date axis. This does not - set the calendar for interpreting data on this - axis, that's specified in the trace or via the - global `layout.calendar` - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - constrain - If this axis needs to be compressed (either due - to its own `scaleanchor` and `scaleratio` or - those of the other axis), determines how that - happens: by increasing the "range" (default), - or by decreasing the "domain". - constraintoward - If this axis needs to be compressed (either due - to its own `scaleanchor` and `scaleratio` or - those of the other axis), determines which - direction we push the originally specified plot - area. Options are "left", "center" (default), - and "right" for x axes, and "top", "middle" - (default), and "bottom" for y axes. - dividercolor - Sets the color of the dividers Only has an - effect on "multicategory" axes. - dividerwidth - Sets the width (in px) of the dividers Only has - an effect on "multicategory" axes. - domain - Sets the domain of this axis (in plot - fraction). - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - fixedrange - Determines whether or not this axis is zoom- - able. If true, then zoom is disabled. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - layer - Sets the layer on which this axis is displayed. - If *above traces*, this axis is displayed above - all the subplot's traces If *below traces*, - this axis is displayed below all the subplot's - traces, but above the grid lines. Useful when - used together with scatter-like traces with - `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - matches - If set to another axis id (e.g. `x2`, `y`), the - range of this axis will match the range of the - corresponding axis in data-coordinates space. - Moreover, matching axes share auto-range - values, category lists and histogram auto-bins. - Note that setting axes simultaneously in both a - `scaleanchor` and a `matches` constraint is - currently forbidden. Moreover, note that - matching axes must have the same `type`. - mirror - Determines if the axis lines or/and ticks are - mirrored to the opposite side of the plotting - area. If True, the axis lines are mirrored. If - "ticks", the axis lines and ticks are mirrored. - If False, mirroring is disable. If "all", axis - lines are mirrored on all shared-axes subplots. - If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - overlaying - If set a same-letter axis id, this axis is - overlaid on top of the corresponding same- - letter axis, with traces and axes visible for - both axes. If False, this axis does not overlay - any same-letter axes. In this case, for axes - with overlapping domains only the highest- - numbered axis will be visible. - position - Sets the position of this axis in the plotting - space (in normalized coordinates). Only has an - effect if `anchor` is set to "free". - range - Sets the range of this axis. If the axis `type` - is "log", then you must take the log of your - desired range (e.g. to set the range from 1 to - 100, set the range from 0 to 2). If the axis - `type` is "date", it should be date strings, - like date data, though Date objects and unix - milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it - should be numbers, using the scale where each - category is assigned a serial number from zero - in the order it appears. - rangemode - If "normal", the range is computed in relation - to the extrema of the input data. If *tozero*`, - the range extends to 0, regardless of the input - data If "nonnegative", the range is non- - negative, regardless of the input data. Applies - only to linear axes. - scaleanchor - If set to another axis id (e.g. `x2`, `y`), the - range of this axis changes together with the - range of the corresponding axis such that the - scale of pixels per unit is in a constant - ratio. Both axes are still zoomable, but when - you zoom one, the other will zoom the same - amount, keeping a fixed midpoint. `constrain` - and `constraintoward` determine how we enforce - the constraint. You can chain these, ie `yaxis: - {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` - but you can only link axes of the same `type`. - The linked axis can have the opposite letter - (to constrain the aspect ratio) or the same - letter (to match scales across subplots). Loops - (`yaxis: {scaleanchor: *x*}, xaxis: - {scaleanchor: *y*}` or longer) are redundant - and the last constraint encountered will be - ignored to avoid possible inconsistent - constraints via `scaleratio`. Note that setting - axes simultaneously in both a `scaleanchor` and - a `matches` constraint is currently forbidden. - scaleratio - If this axis is linked to another by - `scaleanchor`, this determines the pixel to - unit scale ratio. For example, if this value is - 10, then every unit on this axis spans 10 times - the number of pixels as a unit on the linked - axis. Use this for example to create an - elevation profile where the vertical scale is - exaggerated a fixed amount with respect to the - horizontal. - separatethousands - If "true", even 4-digit integers are separated - showdividers - Determines whether or not a dividers are drawn - between the category levels of this axis. Only - has an effect on "multicategory" axes. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showspikes - Determines whether or not spikes (aka - droplines) are drawn for this axis. Note: This - only takes affect when hovermode = closest - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - side - Determines whether a x (y) axis is positioned - at the "bottom" ("left") or "top" ("right") of - the plotting area. - spikecolor - Sets the spike color. If undefined, will use - the series color - spikedash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - spikemode - Determines the drawing mode for the spike line - If "toaxis", the line is drawn from the data - point to the axis the series is plotted on. If - "across", the line is drawn across the entire - plot area, and supercedes "toaxis". If - "marker", then a marker dot is drawn on the - axis the series is plotted on - spikesnap - Determines whether spikelines are stuck to the - cursor or to the closest datapoints. - spikethickness - Sets the width (in px) of the zero line. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.yaxis.Tickformatstop - instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.yaxis.tickformatstopdefaults), sets the - default property values to use for elements of - layout.yaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - tickson - Determines where ticks and grid lines are drawn - with respect to their corresponding tick - labels. Only has an effect for axes of `type` - "category" or "multicategory". When set to - "boundaries", ticks and grid lines are drawn - half a category to the left/bottom of labels. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.yaxis.Title instance - or dict with compatible properties - titlefont - Deprecated: Please use layout.yaxis.title.font - instead. Sets this axis' title font. Note that - the title's font used to be customized by the - now deprecated `titlefont` attribute. - type - Sets the axis type. By default, plotly attempts - to determined the axis type by looking into the - data of the traces that referenced the axis in - question. - uirevision - Controls persistence of user-driven changes in - axis `range`, `autorange`, and `title` if in - `editable: true` configuration. Defaults to - `layout.uirevision`. - visible - A single toggle to hide the axis while - preserving interaction like dragging. Default - is true when a cheater plot is present on the - axis, otherwise false - zeroline - Determines whether or not a line is drawn at - along the 0 value of this axis. If True, the - zero line is drawn on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/angularaxis/__init__.py b/plotly/validators/layout/angularaxis/__init__.py index f5b56d3caf6..202c44c65ec 100644 --- a/plotly/validators/layout/angularaxis/__init__.py +++ b/plotly/validators/layout/angularaxis/__init__.py @@ -1,10 +1,227 @@ -from ._visible import VisibleValidator -from ._ticksuffix import TicksuffixValidator -from ._tickorientation import TickorientationValidator -from ._ticklen import TicklenValidator -from ._tickcolor import TickcolorValidator -from ._showticklabels import ShowticklabelsValidator -from ._showline import ShowlineValidator -from ._range import RangeValidator -from ._endpadding import EndpaddingValidator -from ._domain import DomainValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='visible', + parent_name='layout.angularaxis', + **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='layout.angularaxis', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickorientationValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='tickorientation', + parent_name='layout.angularaxis', + **kwargs + ): + super(TickorientationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['horizontal', 'vertical']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='layout.angularaxis', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='layout.angularaxis', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='layout.angularaxis', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showline', + parent_name='layout.angularaxis', + **kwargs + ): + super(ShowlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='range', parent_name='layout.angularaxis', **kwargs + ): + super(RangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'dflt': 0, + 'editType': 'plot' + }, { + 'valType': 'number', + 'dflt': 360, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndpaddingValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='endpadding', + parent_name='layout.angularaxis', + **kwargs + ): + super(EndpaddingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DomainValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='domain', parent_name='layout.angularaxis', **kwargs + ): + super(DomainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/angularaxis/_domain.py b/plotly/validators/layout/angularaxis/_domain.py deleted file mode 100644 index f6bac78fe39..00000000000 --- a/plotly/validators/layout/angularaxis/_domain.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class DomainValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='domain', parent_name='layout.angularaxis', **kwargs - ): - super(DomainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/angularaxis/_endpadding.py b/plotly/validators/layout/angularaxis/_endpadding.py deleted file mode 100644 index 4608a938750..00000000000 --- a/plotly/validators/layout/angularaxis/_endpadding.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndpaddingValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='endpadding', - parent_name='layout.angularaxis', - **kwargs - ): - super(EndpaddingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/angularaxis/_range.py b/plotly/validators/layout/angularaxis/_range.py deleted file mode 100644 index a998c55428d..00000000000 --- a/plotly/validators/layout/angularaxis/_range.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='range', parent_name='layout.angularaxis', **kwargs - ): - super(RangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'dflt': 0, - 'editType': 'plot' - }, { - 'valType': 'number', - 'dflt': 360, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/angularaxis/_showline.py b/plotly/validators/layout/angularaxis/_showline.py deleted file mode 100644 index 0fccf2c5951..00000000000 --- a/plotly/validators/layout/angularaxis/_showline.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showline', - parent_name='layout.angularaxis', - **kwargs - ): - super(ShowlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/angularaxis/_showticklabels.py b/plotly/validators/layout/angularaxis/_showticklabels.py deleted file mode 100644 index b2e8df91bb9..00000000000 --- a/plotly/validators/layout/angularaxis/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='layout.angularaxis', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/angularaxis/_tickcolor.py b/plotly/validators/layout/angularaxis/_tickcolor.py deleted file mode 100644 index 7fdba1a8bf7..00000000000 --- a/plotly/validators/layout/angularaxis/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='layout.angularaxis', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/angularaxis/_ticklen.py b/plotly/validators/layout/angularaxis/_ticklen.py deleted file mode 100644 index f8995dbef7e..00000000000 --- a/plotly/validators/layout/angularaxis/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='layout.angularaxis', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/angularaxis/_tickorientation.py b/plotly/validators/layout/angularaxis/_tickorientation.py deleted file mode 100644 index 91b2e1059f9..00000000000 --- a/plotly/validators/layout/angularaxis/_tickorientation.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickorientationValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='tickorientation', - parent_name='layout.angularaxis', - **kwargs - ): - super(TickorientationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['horizontal', 'vertical']), - **kwargs - ) diff --git a/plotly/validators/layout/angularaxis/_ticksuffix.py b/plotly/validators/layout/angularaxis/_ticksuffix.py deleted file mode 100644 index f0de62f57a6..00000000000 --- a/plotly/validators/layout/angularaxis/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='layout.angularaxis', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/angularaxis/_visible.py b/plotly/validators/layout/angularaxis/_visible.py deleted file mode 100644 index 59126a3b1ab..00000000000 --- a/plotly/validators/layout/angularaxis/_visible.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='visible', - parent_name='layout.angularaxis', - **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/__init__.py b/plotly/validators/layout/annotation/__init__.py index 456be7c5f9d..73f5e5086cf 100644 --- a/plotly/validators/layout/annotation/__init__.py +++ b/plotly/validators/layout/annotation/__init__.py @@ -1,43 +1,860 @@ -from ._yshift import YshiftValidator -from ._yref import YrefValidator -from ._yclick import YclickValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xshift import XshiftValidator -from ._xref import XrefValidator -from ._xclick import XclickValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._valign import ValignValidator -from ._textangle import TextangleValidator -from ._text import TextValidator -from ._templateitemname import TemplateitemnameValidator -from ._startstandoff import StartstandoffValidator -from ._startarrowsize import StartarrowsizeValidator -from ._startarrowhead import StartarrowheadValidator -from ._standoff import StandoffValidator -from ._showarrow import ShowarrowValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._hovertext import HovertextValidator -from ._hoverlabel import HoverlabelValidator -from ._height import HeightValidator -from ._font import FontValidator -from ._clicktoshow import ClicktoshowValidator -from ._captureevents import CaptureeventsValidator -from ._borderwidth import BorderwidthValidator -from ._borderpad import BorderpadValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator -from ._ayref import AyrefValidator -from ._ay import AyValidator -from ._axref import AxrefValidator -from ._ax import AxValidator -from ._arrowwidth import ArrowwidthValidator -from ._arrowsize import ArrowsizeValidator -from ._arrowside import ArrowsideValidator -from ._arrowhead import ArrowheadValidator -from ._arrowcolor import ArrowcolorValidator -from ._align import AlignValidator + + +import _plotly_utils.basevalidators + + +class YshiftValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='yshift', parent_name='layout.annotation', **kwargs + ): + super(YshiftValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='yref', parent_name='layout.annotation', **kwargs + ): + super(YrefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['paper', '/^y([2-9]|[1-9][0-9]+)?$/'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YclickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='yclick', parent_name='layout.annotation', **kwargs + ): + super(YclickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='yanchor', parent_name='layout.annotation', **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='y', parent_name='layout.annotation', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XshiftValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='xshift', parent_name='layout.annotation', **kwargs + ): + super(XshiftValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xref', parent_name='layout.annotation', **kwargs + ): + super(XrefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['paper', '/^x([2-9]|[1-9][0-9]+)?$/'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XclickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='xclick', parent_name='layout.annotation', **kwargs + ): + super(XclickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xanchor', parent_name='layout.annotation', **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='x', parent_name='layout.annotation', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='layout.annotation', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='layout.annotation', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValignValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='valign', parent_name='layout.annotation', **kwargs + ): + super(ValignValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='textangle', + parent_name='layout.annotation', + **kwargs + ): + super(TextangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='text', parent_name='layout.annotation', **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.annotation', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StartstandoffValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='startstandoff', + parent_name='layout.annotation', + **kwargs + ): + super(StartstandoffValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StartarrowsizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='startarrowsize', + parent_name='layout.annotation', + **kwargs + ): + super(StartarrowsizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + min=kwargs.pop('min', 0.3), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StartarrowheadValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='startarrowhead', + parent_name='layout.annotation', + **kwargs + ): + super(StartarrowheadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + max=kwargs.pop('max', 8), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StandoffValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='standoff', + parent_name='layout.annotation', + **kwargs + ): + super(StandoffValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowarrowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showarrow', + parent_name='layout.annotation', + **kwargs + ): + super(ShowarrowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='layout.annotation', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='layout.annotation', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hovertext', + parent_name='layout.annotation', + **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='hoverlabel', + parent_name='layout.annotation', + **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover label. + By default uses the annotation's `bgcolor` made + opaque, or white if it was transparent. + bordercolor + Sets the border color of the hover label. By + default uses either dark grey or white, for + maximum contrast with `hoverlabel.bgcolor`. + font + Sets the hover label text font. By default uses + the global hover font and size, with color from + `hoverlabel.bordercolor`. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HeightValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='height', parent_name='layout.annotation', **kwargs + ): + super(HeightValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='layout.annotation', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ClicktoshowValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='clicktoshow', + parent_name='layout.annotation', + **kwargs + ): + super(ClicktoshowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', [False, 'onoff', 'onout']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CaptureeventsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='captureevents', + parent_name='layout.annotation', + **kwargs + ): + super(CaptureeventsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='layout.annotation', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderpad', + parent_name='layout.annotation', + **kwargs + ): + super(BorderpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='layout.annotation', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='layout.annotation', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AyrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ayref', parent_name='layout.annotation', **kwargs + ): + super(AyrefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['pixel', '/^y([2-9]|[1-9][0-9]+)?$/'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AyValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='ay', parent_name='layout.annotation', **kwargs + ): + super(AyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AxrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='axref', parent_name='layout.annotation', **kwargs + ): + super(AxrefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['pixel', '/^x([2-9]|[1-9][0-9]+)?$/'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AxValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='ax', parent_name='layout.annotation', **kwargs + ): + super(AxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrowwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='arrowwidth', + parent_name='layout.annotation', + **kwargs + ): + super(ArrowwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + min=kwargs.pop('min', 0.1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrowsizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='arrowsize', + parent_name='layout.annotation', + **kwargs + ): + super(ArrowsizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + min=kwargs.pop('min', 0.3), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrowsideValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, + plotly_name='arrowside', + parent_name='layout.annotation', + **kwargs + ): + super(ArrowsideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + extras=kwargs.pop('extras', ['none']), + flags=kwargs.pop('flags', ['end', 'start']), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrowheadValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='arrowhead', + parent_name='layout.annotation', + **kwargs + ): + super(ArrowheadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + max=kwargs.pop('max', 8), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrowcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='arrowcolor', + parent_name='layout.annotation', + **kwargs + ): + super(ArrowcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AlignValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='align', parent_name='layout.annotation', **kwargs + ): + super(AlignValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) diff --git a/plotly/validators/layout/annotation/_align.py b/plotly/validators/layout/annotation/_align.py deleted file mode 100644 index ee7ba980c76..00000000000 --- a/plotly/validators/layout/annotation/_align.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AlignValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='align', parent_name='layout.annotation', **kwargs - ): - super(AlignValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_arrowcolor.py b/plotly/validators/layout/annotation/_arrowcolor.py deleted file mode 100644 index c6202be0ec8..00000000000 --- a/plotly/validators/layout/annotation/_arrowcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrowcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='arrowcolor', - parent_name='layout.annotation', - **kwargs - ): - super(ArrowcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_arrowhead.py b/plotly/validators/layout/annotation/_arrowhead.py deleted file mode 100644 index f80eed45e9a..00000000000 --- a/plotly/validators/layout/annotation/_arrowhead.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrowheadValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='arrowhead', - parent_name='layout.annotation', - **kwargs - ): - super(ArrowheadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - max=kwargs.pop('max', 8), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_arrowside.py b/plotly/validators/layout/annotation/_arrowside.py deleted file mode 100644 index 5430d2c81a7..00000000000 --- a/plotly/validators/layout/annotation/_arrowside.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrowsideValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, - plotly_name='arrowside', - parent_name='layout.annotation', - **kwargs - ): - super(ArrowsideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - extras=kwargs.pop('extras', ['none']), - flags=kwargs.pop('flags', ['end', 'start']), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_arrowsize.py b/plotly/validators/layout/annotation/_arrowsize.py deleted file mode 100644 index f7cd878028a..00000000000 --- a/plotly/validators/layout/annotation/_arrowsize.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrowsizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='arrowsize', - parent_name='layout.annotation', - **kwargs - ): - super(ArrowsizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - min=kwargs.pop('min', 0.3), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_arrowwidth.py b/plotly/validators/layout/annotation/_arrowwidth.py deleted file mode 100644 index c5cbbf7a5bb..00000000000 --- a/plotly/validators/layout/annotation/_arrowwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrowwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='arrowwidth', - parent_name='layout.annotation', - **kwargs - ): - super(ArrowwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - min=kwargs.pop('min', 0.1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_ax.py b/plotly/validators/layout/annotation/_ax.py deleted file mode 100644 index 0fb1c328cc8..00000000000 --- a/plotly/validators/layout/annotation/_ax.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AxValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='ax', parent_name='layout.annotation', **kwargs - ): - super(AxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_axref.py b/plotly/validators/layout/annotation/_axref.py deleted file mode 100644 index aa3cf47336f..00000000000 --- a/plotly/validators/layout/annotation/_axref.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class AxrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='axref', parent_name='layout.annotation', **kwargs - ): - super(AxrefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['pixel', '/^x([2-9]|[1-9][0-9]+)?$/'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_ay.py b/plotly/validators/layout/annotation/_ay.py deleted file mode 100644 index d4b139934fc..00000000000 --- a/plotly/validators/layout/annotation/_ay.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AyValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='ay', parent_name='layout.annotation', **kwargs - ): - super(AyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_ayref.py b/plotly/validators/layout/annotation/_ayref.py deleted file mode 100644 index 800e3f34bda..00000000000 --- a/plotly/validators/layout/annotation/_ayref.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class AyrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ayref', parent_name='layout.annotation', **kwargs - ): - super(AyrefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['pixel', '/^y([2-9]|[1-9][0-9]+)?$/'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_bgcolor.py b/plotly/validators/layout/annotation/_bgcolor.py deleted file mode 100644 index 8642b73228e..00000000000 --- a/plotly/validators/layout/annotation/_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='layout.annotation', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_bordercolor.py b/plotly/validators/layout/annotation/_bordercolor.py deleted file mode 100644 index a7126b713db..00000000000 --- a/plotly/validators/layout/annotation/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='layout.annotation', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_borderpad.py b/plotly/validators/layout/annotation/_borderpad.py deleted file mode 100644 index c4940704ec1..00000000000 --- a/plotly/validators/layout/annotation/_borderpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderpad', - parent_name='layout.annotation', - **kwargs - ): - super(BorderpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_borderwidth.py b/plotly/validators/layout/annotation/_borderwidth.py deleted file mode 100644 index 806277df19a..00000000000 --- a/plotly/validators/layout/annotation/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='layout.annotation', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_captureevents.py b/plotly/validators/layout/annotation/_captureevents.py deleted file mode 100644 index 167475b0c6e..00000000000 --- a/plotly/validators/layout/annotation/_captureevents.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CaptureeventsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='captureevents', - parent_name='layout.annotation', - **kwargs - ): - super(CaptureeventsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_clicktoshow.py b/plotly/validators/layout/annotation/_clicktoshow.py deleted file mode 100644 index 1f0e0f67e69..00000000000 --- a/plotly/validators/layout/annotation/_clicktoshow.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ClicktoshowValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='clicktoshow', - parent_name='layout.annotation', - **kwargs - ): - super(ClicktoshowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', [False, 'onoff', 'onout']), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_font.py b/plotly/validators/layout/annotation/_font.py deleted file mode 100644 index b5604a76e4c..00000000000 --- a/plotly/validators/layout/annotation/_font.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='layout.annotation', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_height.py b/plotly/validators/layout/annotation/_height.py deleted file mode 100644 index d24e44d4c97..00000000000 --- a/plotly/validators/layout/annotation/_height.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HeightValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='height', parent_name='layout.annotation', **kwargs - ): - super(HeightValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_hoverlabel.py b/plotly/validators/layout/annotation/_hoverlabel.py deleted file mode 100644 index 92c6ce394cc..00000000000 --- a/plotly/validators/layout/annotation/_hoverlabel.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='hoverlabel', - parent_name='layout.annotation', - **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover label. - By default uses the annotation's `bgcolor` made - opaque, or white if it was transparent. - bordercolor - Sets the border color of the hover label. By - default uses either dark grey or white, for - maximum contrast with `hoverlabel.bgcolor`. - font - Sets the hover label text font. By default uses - the global hover font and size, with color from - `hoverlabel.bordercolor`. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_hovertext.py b/plotly/validators/layout/annotation/_hovertext.py deleted file mode 100644 index 88f597f3ffc..00000000000 --- a/plotly/validators/layout/annotation/_hovertext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hovertext', - parent_name='layout.annotation', - **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_name.py b/plotly/validators/layout/annotation/_name.py deleted file mode 100644 index 794061dd8e2..00000000000 --- a/plotly/validators/layout/annotation/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='layout.annotation', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_opacity.py b/plotly/validators/layout/annotation/_opacity.py deleted file mode 100644 index 3822bf10a9d..00000000000 --- a/plotly/validators/layout/annotation/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='layout.annotation', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_showarrow.py b/plotly/validators/layout/annotation/_showarrow.py deleted file mode 100644 index 14b801adc4e..00000000000 --- a/plotly/validators/layout/annotation/_showarrow.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowarrowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showarrow', - parent_name='layout.annotation', - **kwargs - ): - super(ShowarrowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_standoff.py b/plotly/validators/layout/annotation/_standoff.py deleted file mode 100644 index 84f78d97562..00000000000 --- a/plotly/validators/layout/annotation/_standoff.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class StandoffValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='standoff', - parent_name='layout.annotation', - **kwargs - ): - super(StandoffValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_startarrowhead.py b/plotly/validators/layout/annotation/_startarrowhead.py deleted file mode 100644 index 61e0cee66e8..00000000000 --- a/plotly/validators/layout/annotation/_startarrowhead.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartarrowheadValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='startarrowhead', - parent_name='layout.annotation', - **kwargs - ): - super(StartarrowheadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - max=kwargs.pop('max', 8), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_startarrowsize.py b/plotly/validators/layout/annotation/_startarrowsize.py deleted file mode 100644 index 19306571bfc..00000000000 --- a/plotly/validators/layout/annotation/_startarrowsize.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartarrowsizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='startarrowsize', - parent_name='layout.annotation', - **kwargs - ): - super(StartarrowsizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - min=kwargs.pop('min', 0.3), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_startstandoff.py b/plotly/validators/layout/annotation/_startstandoff.py deleted file mode 100644 index 672882953f4..00000000000 --- a/plotly/validators/layout/annotation/_startstandoff.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartstandoffValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='startstandoff', - parent_name='layout.annotation', - **kwargs - ): - super(StartstandoffValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_templateitemname.py b/plotly/validators/layout/annotation/_templateitemname.py deleted file mode 100644 index 6322ea07658..00000000000 --- a/plotly/validators/layout/annotation/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.annotation', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_text.py b/plotly/validators/layout/annotation/_text.py deleted file mode 100644 index 29d0e1c75f9..00000000000 --- a/plotly/validators/layout/annotation/_text.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='text', parent_name='layout.annotation', **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_textangle.py b/plotly/validators/layout/annotation/_textangle.py deleted file mode 100644 index 22e381a7c34..00000000000 --- a/plotly/validators/layout/annotation/_textangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='textangle', - parent_name='layout.annotation', - **kwargs - ): - super(TextangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_valign.py b/plotly/validators/layout/annotation/_valign.py deleted file mode 100644 index 23e0b9c043b..00000000000 --- a/plotly/validators/layout/annotation/_valign.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValignValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='valign', parent_name='layout.annotation', **kwargs - ): - super(ValignValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_visible.py b/plotly/validators/layout/annotation/_visible.py deleted file mode 100644 index 3479258e31b..00000000000 --- a/plotly/validators/layout/annotation/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='layout.annotation', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_width.py b/plotly/validators/layout/annotation/_width.py deleted file mode 100644 index 6b06e8e4f91..00000000000 --- a/plotly/validators/layout/annotation/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='layout.annotation', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_x.py b/plotly/validators/layout/annotation/_x.py deleted file mode 100644 index cfe345ee917..00000000000 --- a/plotly/validators/layout/annotation/_x.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='x', parent_name='layout.annotation', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_xanchor.py b/plotly/validators/layout/annotation/_xanchor.py deleted file mode 100644 index 2e3209a18a3..00000000000 --- a/plotly/validators/layout/annotation/_xanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xanchor', parent_name='layout.annotation', **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_xclick.py b/plotly/validators/layout/annotation/_xclick.py deleted file mode 100644 index 37d3469ca4e..00000000000 --- a/plotly/validators/layout/annotation/_xclick.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XclickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='xclick', parent_name='layout.annotation', **kwargs - ): - super(XclickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_xref.py b/plotly/validators/layout/annotation/_xref.py deleted file mode 100644 index 7cd4136a4b1..00000000000 --- a/plotly/validators/layout/annotation/_xref.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class XrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xref', parent_name='layout.annotation', **kwargs - ): - super(XrefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['paper', '/^x([2-9]|[1-9][0-9]+)?$/'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_xshift.py b/plotly/validators/layout/annotation/_xshift.py deleted file mode 100644 index 71cedfce462..00000000000 --- a/plotly/validators/layout/annotation/_xshift.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XshiftValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='xshift', parent_name='layout.annotation', **kwargs - ): - super(XshiftValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_y.py b/plotly/validators/layout/annotation/_y.py deleted file mode 100644 index 40d76c1cd82..00000000000 --- a/plotly/validators/layout/annotation/_y.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='y', parent_name='layout.annotation', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_yanchor.py b/plotly/validators/layout/annotation/_yanchor.py deleted file mode 100644 index 458a777213e..00000000000 --- a/plotly/validators/layout/annotation/_yanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='yanchor', parent_name='layout.annotation', **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_yclick.py b/plotly/validators/layout/annotation/_yclick.py deleted file mode 100644 index e3ab4c0516f..00000000000 --- a/plotly/validators/layout/annotation/_yclick.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YclickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='yclick', parent_name='layout.annotation', **kwargs - ): - super(YclickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_yref.py b/plotly/validators/layout/annotation/_yref.py deleted file mode 100644 index 405012434da..00000000000 --- a/plotly/validators/layout/annotation/_yref.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class YrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='yref', parent_name='layout.annotation', **kwargs - ): - super(YrefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['paper', '/^y([2-9]|[1-9][0-9]+)?$/'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/_yshift.py b/plotly/validators/layout/annotation/_yshift.py deleted file mode 100644 index 0ff98e81ddb..00000000000 --- a/plotly/validators/layout/annotation/_yshift.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YshiftValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='yshift', parent_name='layout.annotation', **kwargs - ): - super(YshiftValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/font/__init__.py b/plotly/validators/layout/annotation/font/__init__.py index 199d72e71c6..ecfff569392 100644 --- a/plotly/validators/layout/annotation/font/__init__.py +++ b/plotly/validators/layout/annotation/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.annotation.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.annotation.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.annotation.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/annotation/font/_color.py b/plotly/validators/layout/annotation/font/_color.py deleted file mode 100644 index 0c91a9d6155..00000000000 --- a/plotly/validators/layout/annotation/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.annotation.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/font/_family.py b/plotly/validators/layout/annotation/font/_family.py deleted file mode 100644 index 54f89fec9ff..00000000000 --- a/plotly/validators/layout/annotation/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.annotation.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/font/_size.py b/plotly/validators/layout/annotation/font/_size.py deleted file mode 100644 index 089fa51ea94..00000000000 --- a/plotly/validators/layout/annotation/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.annotation.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/hoverlabel/__init__.py b/plotly/validators/layout/annotation/hoverlabel/__init__.py index 8a3e67d64aa..76d11a67be3 100644 --- a/plotly/validators/layout/annotation/hoverlabel/__init__.py +++ b/plotly/validators/layout/annotation/hoverlabel/__init__.py @@ -1,3 +1,83 @@ -from ._font import FontValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='layout.annotation.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='layout.annotation.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='layout.annotation.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/annotation/hoverlabel/_bgcolor.py b/plotly/validators/layout/annotation/hoverlabel/_bgcolor.py deleted file mode 100644 index 5b6aeb91cbf..00000000000 --- a/plotly/validators/layout/annotation/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='layout.annotation.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/hoverlabel/_bordercolor.py b/plotly/validators/layout/annotation/hoverlabel/_bordercolor.py deleted file mode 100644 index 01e6bf00bad..00000000000 --- a/plotly/validators/layout/annotation/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='layout.annotation.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/hoverlabel/_font.py b/plotly/validators/layout/annotation/hoverlabel/_font.py deleted file mode 100644 index 543212f7558..00000000000 --- a/plotly/validators/layout/annotation/hoverlabel/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='layout.annotation.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/hoverlabel/font/__init__.py b/plotly/validators/layout/annotation/hoverlabel/font/__init__.py index 199d72e71c6..96dc63ba9d0 100644 --- a/plotly/validators/layout/annotation/hoverlabel/font/__init__.py +++ b/plotly/validators/layout/annotation/hoverlabel/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.annotation.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.annotation.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.annotation.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/annotation/hoverlabel/font/_color.py b/plotly/validators/layout/annotation/hoverlabel/font/_color.py deleted file mode 100644 index c4160432f96..00000000000 --- a/plotly/validators/layout/annotation/hoverlabel/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.annotation.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/hoverlabel/font/_family.py b/plotly/validators/layout/annotation/hoverlabel/font/_family.py deleted file mode 100644 index 5130f47f5c2..00000000000 --- a/plotly/validators/layout/annotation/hoverlabel/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.annotation.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/annotation/hoverlabel/font/_size.py b/plotly/validators/layout/annotation/hoverlabel/font/_size.py deleted file mode 100644 index c9b779f0f2f..00000000000 --- a/plotly/validators/layout/annotation/hoverlabel/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.annotation.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/colorscale/__init__.py b/plotly/validators/layout/colorscale/__init__.py index 6d137ca4068..48f421c8f27 100644 --- a/plotly/validators/layout/colorscale/__init__.py +++ b/plotly/validators/layout/colorscale/__init__.py @@ -1,3 +1,62 @@ -from ._sequentialminus import SequentialminusValidator -from ._sequential import SequentialValidator -from ._diverging import DivergingValidator + + +import _plotly_utils.basevalidators + + +class SequentialminusValidator( + _plotly_utils.basevalidators.ColorscaleValidator +): + + def __init__( + self, + plotly_name='sequentialminus', + parent_name='layout.colorscale', + **kwargs + ): + super(SequentialminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SequentialValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='sequential', + parent_name='layout.colorscale', + **kwargs + ): + super(SequentialValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DivergingValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='diverging', + parent_name='layout.colorscale', + **kwargs + ): + super(DivergingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/colorscale/_diverging.py b/plotly/validators/layout/colorscale/_diverging.py deleted file mode 100644 index cbb18a70a18..00000000000 --- a/plotly/validators/layout/colorscale/_diverging.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class DivergingValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='diverging', - parent_name='layout.colorscale', - **kwargs - ): - super(DivergingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/colorscale/_sequential.py b/plotly/validators/layout/colorscale/_sequential.py deleted file mode 100644 index b683e38fddc..00000000000 --- a/plotly/validators/layout/colorscale/_sequential.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SequentialValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='sequential', - parent_name='layout.colorscale', - **kwargs - ): - super(SequentialValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/colorscale/_sequentialminus.py b/plotly/validators/layout/colorscale/_sequentialminus.py deleted file mode 100644 index 42bdd2e9795..00000000000 --- a/plotly/validators/layout/colorscale/_sequentialminus.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SequentialminusValidator( - _plotly_utils.basevalidators.ColorscaleValidator -): - - def __init__( - self, - plotly_name='sequentialminus', - parent_name='layout.colorscale', - **kwargs - ): - super(SequentialminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/font/__init__.py b/plotly/validators/layout/font/__init__.py index 199d72e71c6..25eef965dab 100644 --- a/plotly/validators/layout/font/__init__.py +++ b/plotly/validators/layout/font/__init__.py @@ -1,3 +1,54 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='layout.font', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='layout.font', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='layout.font', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/font/_color.py b/plotly/validators/layout/font/_color.py deleted file mode 100644 index 15202c06433..00000000000 --- a/plotly/validators/layout/font/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='layout.font', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/font/_family.py b/plotly/validators/layout/font/_family.py deleted file mode 100644 index 644060c3967..00000000000 --- a/plotly/validators/layout/font/_family.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='layout.font', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/font/_size.py b/plotly/validators/layout/font/_size.py deleted file mode 100644 index f133006b3bf..00000000000 --- a/plotly/validators/layout/font/_size.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='layout.font', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/__init__.py b/plotly/validators/layout/geo/__init__.py index d80c90cd4fa..a8ca4dc2495 100644 --- a/plotly/validators/layout/geo/__init__.py +++ b/plotly/validators/layout/geo/__init__.py @@ -1,30 +1,620 @@ -from ._uirevision import UirevisionValidator -from ._subunitwidth import SubunitwidthValidator -from ._subunitcolor import SubunitcolorValidator -from ._showsubunits import ShowsubunitsValidator -from ._showrivers import ShowriversValidator -from ._showocean import ShowoceanValidator -from ._showland import ShowlandValidator -from ._showlakes import ShowlakesValidator -from ._showframe import ShowframeValidator -from ._showcountries import ShowcountriesValidator -from ._showcoastlines import ShowcoastlinesValidator -from ._scope import ScopeValidator -from ._riverwidth import RiverwidthValidator -from ._rivercolor import RivercolorValidator -from ._resolution import ResolutionValidator -from ._projection import ProjectionValidator -from ._oceancolor import OceancolorValidator -from ._lonaxis import LonaxisValidator -from ._lataxis import LataxisValidator -from ._landcolor import LandcolorValidator -from ._lakecolor import LakecolorValidator -from ._framewidth import FramewidthValidator -from ._framecolor import FramecolorValidator -from ._domain import DomainValidator -from ._countrywidth import CountrywidthValidator -from ._countrycolor import CountrycolorValidator -from ._coastlinewidth import CoastlinewidthValidator -from ._coastlinecolor import CoastlinecolorValidator -from ._center import CenterValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='layout.geo', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SubunitwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='subunitwidth', parent_name='layout.geo', **kwargs + ): + super(SubunitwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SubunitcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='subunitcolor', parent_name='layout.geo', **kwargs + ): + super(SubunitcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowsubunitsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showsubunits', parent_name='layout.geo', **kwargs + ): + super(ShowsubunitsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowriversValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showrivers', parent_name='layout.geo', **kwargs + ): + super(ShowriversValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowoceanValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showocean', parent_name='layout.geo', **kwargs + ): + super(ShowoceanValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlandValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showland', parent_name='layout.geo', **kwargs + ): + super(ShowlandValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlakesValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlakes', parent_name='layout.geo', **kwargs + ): + super(ShowlakesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowframeValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showframe', parent_name='layout.geo', **kwargs + ): + super(ShowframeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowcountriesValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showcountries', parent_name='layout.geo', **kwargs + ): + super(ShowcountriesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowcoastlinesValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showcoastlines', parent_name='layout.geo', **kwargs + ): + super(ShowcoastlinesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScopeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='scope', parent_name='layout.geo', **kwargs + ): + super(ScopeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'world', 'usa', 'europe', 'asia', 'africa', + 'north america', 'south america' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RiverwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='riverwidth', parent_name='layout.geo', **kwargs + ): + super(RiverwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RivercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='rivercolor', parent_name='layout.geo', **kwargs + ): + super(RivercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ResolutionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='resolution', parent_name='layout.geo', **kwargs + ): + super(ResolutionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + coerce_number=kwargs.pop('coerce_number', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [110, 50]), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ProjectionValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='projection', parent_name='layout.geo', **kwargs + ): + super(ProjectionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Projection'), + data_docs=kwargs.pop( + 'data_docs', """ + parallels + For conic projection types only. Sets the + parallels (tangent, secant) where the cone + intersects the sphere. + rotation + plotly.graph_objs.layout.geo.projection.Rotatio + n instance or dict with compatible properties + scale + 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. + type + Sets the projection type. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OceancolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='oceancolor', parent_name='layout.geo', **kwargs + ): + super(OceancolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LonaxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='lonaxis', parent_name='layout.geo', **kwargs + ): + super(LonaxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Lonaxis'), + data_docs=kwargs.pop( + 'data_docs', """ + dtick + Sets the graticule's longitude/latitude tick + step. + gridcolor + Sets the graticule's stroke color. + gridwidth + Sets the graticule's stroke width (in px). + range + Sets the range of this axis (in degrees), sets + the map's clipped coordinates. + showgrid + Sets whether or not graticule are shown on the + map. + tick0 + Sets the graticule's starting tick + longitude/latitude. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LataxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='lataxis', parent_name='layout.geo', **kwargs + ): + super(LataxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Lataxis'), + data_docs=kwargs.pop( + 'data_docs', """ + dtick + Sets the graticule's longitude/latitude tick + step. + gridcolor + Sets the graticule's stroke color. + gridwidth + Sets the graticule's stroke width (in px). + range + Sets the range of this axis (in degrees), sets + the map's clipped coordinates. + showgrid + Sets whether or not graticule are shown on the + map. + tick0 + Sets the graticule's starting tick + longitude/latitude. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LandcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='landcolor', parent_name='layout.geo', **kwargs + ): + super(LandcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LakecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='lakecolor', parent_name='layout.geo', **kwargs + ): + super(LakecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FramewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='framewidth', parent_name='layout.geo', **kwargs + ): + super(FramewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FramecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='framecolor', parent_name='layout.geo', **kwargs + ): + super(FramecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='domain', parent_name='layout.geo', **kwargs + ): + super(DomainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Domain'), + data_docs=kwargs.pop( + 'data_docs', """ + column + If there is a layout grid, use the domain for + this column in the grid for this geo subplot . + 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. + row + If there is a layout grid, use the domain for + this row in the grid for this geo subplot . + 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. + x + 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. + y + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CountrywidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='countrywidth', parent_name='layout.geo', **kwargs + ): + super(CountrywidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CountrycolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='countrycolor', parent_name='layout.geo', **kwargs + ): + super(CountrycolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CoastlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='coastlinewidth', parent_name='layout.geo', **kwargs + ): + super(CoastlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CoastlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='coastlinecolor', parent_name='layout.geo', **kwargs + ): + super(CoastlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CenterValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='center', parent_name='layout.geo', **kwargs + ): + super(CenterValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Center'), + data_docs=kwargs.pop( + 'data_docs', """ + lat + 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. + lon + Sets the longitude of the map's center. By + default, the map's longitude center lies at the + middle of the longitude range for scoped + projection and above `projection.rotation.lon` + otherwise. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='layout.geo', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/geo/_bgcolor.py b/plotly/validators/layout/geo/_bgcolor.py deleted file mode 100644 index bc4b6bde1b9..00000000000 --- a/plotly/validators/layout/geo/_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='layout.geo', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_center.py b/plotly/validators/layout/geo/_center.py deleted file mode 100644 index 97c1c29185d..00000000000 --- a/plotly/validators/layout/geo/_center.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class CenterValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='center', parent_name='layout.geo', **kwargs - ): - super(CenterValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Center'), - data_docs=kwargs.pop( - 'data_docs', """ - lat - 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. - lon - Sets the longitude of the map's center. By - default, the map's longitude center lies at the - middle of the longitude range for scoped - projection and above `projection.rotation.lon` - otherwise. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_coastlinecolor.py b/plotly/validators/layout/geo/_coastlinecolor.py deleted file mode 100644 index 2936247aeb7..00000000000 --- a/plotly/validators/layout/geo/_coastlinecolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CoastlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='coastlinecolor', parent_name='layout.geo', **kwargs - ): - super(CoastlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_coastlinewidth.py b/plotly/validators/layout/geo/_coastlinewidth.py deleted file mode 100644 index 2785521d055..00000000000 --- a/plotly/validators/layout/geo/_coastlinewidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CoastlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='coastlinewidth', parent_name='layout.geo', **kwargs - ): - super(CoastlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_countrycolor.py b/plotly/validators/layout/geo/_countrycolor.py deleted file mode 100644 index 523ab2001f0..00000000000 --- a/plotly/validators/layout/geo/_countrycolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CountrycolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='countrycolor', parent_name='layout.geo', **kwargs - ): - super(CountrycolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_countrywidth.py b/plotly/validators/layout/geo/_countrywidth.py deleted file mode 100644 index e0522fe8b8a..00000000000 --- a/plotly/validators/layout/geo/_countrywidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CountrywidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='countrywidth', parent_name='layout.geo', **kwargs - ): - super(CountrywidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_domain.py b/plotly/validators/layout/geo/_domain.py deleted file mode 100644 index 6471e8bb54d..00000000000 --- a/plotly/validators/layout/geo/_domain.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='domain', parent_name='layout.geo', **kwargs - ): - super(DomainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Domain'), - data_docs=kwargs.pop( - 'data_docs', """ - column - If there is a layout grid, use the domain for - this column in the grid for this geo subplot . - 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. - row - If there is a layout grid, use the domain for - this row in the grid for this geo subplot . - 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. - x - 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. - y - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_framecolor.py b/plotly/validators/layout/geo/_framecolor.py deleted file mode 100644 index 5113e648f6f..00000000000 --- a/plotly/validators/layout/geo/_framecolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FramecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='framecolor', parent_name='layout.geo', **kwargs - ): - super(FramecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_framewidth.py b/plotly/validators/layout/geo/_framewidth.py deleted file mode 100644 index e34c83afb33..00000000000 --- a/plotly/validators/layout/geo/_framewidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class FramewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='framewidth', parent_name='layout.geo', **kwargs - ): - super(FramewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_lakecolor.py b/plotly/validators/layout/geo/_lakecolor.py deleted file mode 100644 index a202af32198..00000000000 --- a/plotly/validators/layout/geo/_lakecolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LakecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='lakecolor', parent_name='layout.geo', **kwargs - ): - super(LakecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_landcolor.py b/plotly/validators/layout/geo/_landcolor.py deleted file mode 100644 index e08bc056ca9..00000000000 --- a/plotly/validators/layout/geo/_landcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LandcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='landcolor', parent_name='layout.geo', **kwargs - ): - super(LandcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_lataxis.py b/plotly/validators/layout/geo/_lataxis.py deleted file mode 100644 index 91758548829..00000000000 --- a/plotly/validators/layout/geo/_lataxis.py +++ /dev/null @@ -1,34 +0,0 @@ -import _plotly_utils.basevalidators - - -class LataxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='lataxis', parent_name='layout.geo', **kwargs - ): - super(LataxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Lataxis'), - data_docs=kwargs.pop( - 'data_docs', """ - dtick - Sets the graticule's longitude/latitude tick - step. - gridcolor - Sets the graticule's stroke color. - gridwidth - Sets the graticule's stroke width (in px). - range - Sets the range of this axis (in degrees), sets - the map's clipped coordinates. - showgrid - Sets whether or not graticule are shown on the - map. - tick0 - Sets the graticule's starting tick - longitude/latitude. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_lonaxis.py b/plotly/validators/layout/geo/_lonaxis.py deleted file mode 100644 index b533a99a84d..00000000000 --- a/plotly/validators/layout/geo/_lonaxis.py +++ /dev/null @@ -1,34 +0,0 @@ -import _plotly_utils.basevalidators - - -class LonaxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='lonaxis', parent_name='layout.geo', **kwargs - ): - super(LonaxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Lonaxis'), - data_docs=kwargs.pop( - 'data_docs', """ - dtick - Sets the graticule's longitude/latitude tick - step. - gridcolor - Sets the graticule's stroke color. - gridwidth - Sets the graticule's stroke width (in px). - range - Sets the range of this axis (in degrees), sets - the map's clipped coordinates. - showgrid - Sets whether or not graticule are shown on the - map. - tick0 - Sets the graticule's starting tick - longitude/latitude. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_oceancolor.py b/plotly/validators/layout/geo/_oceancolor.py deleted file mode 100644 index 9a74a7c8543..00000000000 --- a/plotly/validators/layout/geo/_oceancolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OceancolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='oceancolor', parent_name='layout.geo', **kwargs - ): - super(OceancolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_projection.py b/plotly/validators/layout/geo/_projection.py deleted file mode 100644 index e0e65a4357e..00000000000 --- a/plotly/validators/layout/geo/_projection.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class ProjectionValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='projection', parent_name='layout.geo', **kwargs - ): - super(ProjectionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Projection'), - data_docs=kwargs.pop( - 'data_docs', """ - parallels - For conic projection types only. Sets the - parallels (tangent, secant) where the cone - intersects the sphere. - rotation - plotly.graph_objs.layout.geo.projection.Rotatio - n instance or dict with compatible properties - scale - 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. - type - Sets the projection type. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_resolution.py b/plotly/validators/layout/geo/_resolution.py deleted file mode 100644 index 5a21f0a6ba5..00000000000 --- a/plotly/validators/layout/geo/_resolution.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ResolutionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='resolution', parent_name='layout.geo', **kwargs - ): - super(ResolutionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - coerce_number=kwargs.pop('coerce_number', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [110, 50]), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_rivercolor.py b/plotly/validators/layout/geo/_rivercolor.py deleted file mode 100644 index 35d12c3f9f9..00000000000 --- a/plotly/validators/layout/geo/_rivercolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class RivercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='rivercolor', parent_name='layout.geo', **kwargs - ): - super(RivercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_riverwidth.py b/plotly/validators/layout/geo/_riverwidth.py deleted file mode 100644 index 72f4c57f6f7..00000000000 --- a/plotly/validators/layout/geo/_riverwidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class RiverwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='riverwidth', parent_name='layout.geo', **kwargs - ): - super(RiverwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_scope.py b/plotly/validators/layout/geo/_scope.py deleted file mode 100644 index eaf4379aa2f..00000000000 --- a/plotly/validators/layout/geo/_scope.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScopeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='scope', parent_name='layout.geo', **kwargs - ): - super(ScopeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'world', 'usa', 'europe', 'asia', 'africa', - 'north america', 'south america' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_showcoastlines.py b/plotly/validators/layout/geo/_showcoastlines.py deleted file mode 100644 index b45d2774030..00000000000 --- a/plotly/validators/layout/geo/_showcoastlines.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowcoastlinesValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showcoastlines', parent_name='layout.geo', **kwargs - ): - super(ShowcoastlinesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_showcountries.py b/plotly/validators/layout/geo/_showcountries.py deleted file mode 100644 index 53bb5e6867d..00000000000 --- a/plotly/validators/layout/geo/_showcountries.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowcountriesValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showcountries', parent_name='layout.geo', **kwargs - ): - super(ShowcountriesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_showframe.py b/plotly/validators/layout/geo/_showframe.py deleted file mode 100644 index 189829585f8..00000000000 --- a/plotly/validators/layout/geo/_showframe.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowframeValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showframe', parent_name='layout.geo', **kwargs - ): - super(ShowframeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_showlakes.py b/plotly/validators/layout/geo/_showlakes.py deleted file mode 100644 index dfdd7b57b89..00000000000 --- a/plotly/validators/layout/geo/_showlakes.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlakesValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlakes', parent_name='layout.geo', **kwargs - ): - super(ShowlakesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_showland.py b/plotly/validators/layout/geo/_showland.py deleted file mode 100644 index f2d5ab8efb4..00000000000 --- a/plotly/validators/layout/geo/_showland.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlandValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showland', parent_name='layout.geo', **kwargs - ): - super(ShowlandValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_showocean.py b/plotly/validators/layout/geo/_showocean.py deleted file mode 100644 index e62864f95dc..00000000000 --- a/plotly/validators/layout/geo/_showocean.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowoceanValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showocean', parent_name='layout.geo', **kwargs - ): - super(ShowoceanValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_showrivers.py b/plotly/validators/layout/geo/_showrivers.py deleted file mode 100644 index b9ea6cb76d3..00000000000 --- a/plotly/validators/layout/geo/_showrivers.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowriversValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showrivers', parent_name='layout.geo', **kwargs - ): - super(ShowriversValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_showsubunits.py b/plotly/validators/layout/geo/_showsubunits.py deleted file mode 100644 index 9ec66ac3971..00000000000 --- a/plotly/validators/layout/geo/_showsubunits.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowsubunitsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showsubunits', parent_name='layout.geo', **kwargs - ): - super(ShowsubunitsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_subunitcolor.py b/plotly/validators/layout/geo/_subunitcolor.py deleted file mode 100644 index d92b0a889fe..00000000000 --- a/plotly/validators/layout/geo/_subunitcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SubunitcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='subunitcolor', parent_name='layout.geo', **kwargs - ): - super(SubunitcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_subunitwidth.py b/plotly/validators/layout/geo/_subunitwidth.py deleted file mode 100644 index 271be78f4c8..00000000000 --- a/plotly/validators/layout/geo/_subunitwidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SubunitwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='subunitwidth', parent_name='layout.geo', **kwargs - ): - super(SubunitwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/_uirevision.py b/plotly/validators/layout/geo/_uirevision.py deleted file mode 100644 index 7a8e01e6fb3..00000000000 --- a/plotly/validators/layout/geo/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='layout.geo', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/center/__init__.py b/plotly/validators/layout/geo/center/__init__.py index ab3107d7843..95efd4b9e63 100644 --- a/plotly/validators/layout/geo/center/__init__.py +++ b/plotly/validators/layout/geo/center/__init__.py @@ -1,2 +1,34 @@ -from ._lon import LonValidator -from ._lat import LatValidator + + +import _plotly_utils.basevalidators + + +class LonValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='lon', parent_name='layout.geo.center', **kwargs + ): + super(LonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LatValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='lat', parent_name='layout.geo.center', **kwargs + ): + super(LatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/geo/center/_lat.py b/plotly/validators/layout/geo/center/_lat.py deleted file mode 100644 index 19305a836d9..00000000000 --- a/plotly/validators/layout/geo/center/_lat.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LatValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='lat', parent_name='layout.geo.center', **kwargs - ): - super(LatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/center/_lon.py b/plotly/validators/layout/geo/center/_lon.py deleted file mode 100644 index 7e07b9bada1..00000000000 --- a/plotly/validators/layout/geo/center/_lon.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LonValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='lon', parent_name='layout.geo.center', **kwargs - ): - super(LonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/domain/__init__.py b/plotly/validators/layout/geo/domain/__init__.py index 6cf32248236..e26b4a01e3d 100644 --- a/plotly/validators/layout/geo/domain/__init__.py +++ b/plotly/validators/layout/geo/domain/__init__.py @@ -1,4 +1,102 @@ -from ._y import YValidator -from ._x import XValidator -from ._row import RowValidator -from ._column import ColumnValidator + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='y', parent_name='layout.geo.domain', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='x', parent_name='layout.geo.domain', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RowValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='row', parent_name='layout.geo.domain', **kwargs + ): + super(RowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='column', parent_name='layout.geo.domain', **kwargs + ): + super(ColumnValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/geo/domain/_column.py b/plotly/validators/layout/geo/domain/_column.py deleted file mode 100644 index a07f74c364c..00000000000 --- a/plotly/validators/layout/geo/domain/_column.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='column', parent_name='layout.geo.domain', **kwargs - ): - super(ColumnValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/domain/_row.py b/plotly/validators/layout/geo/domain/_row.py deleted file mode 100644 index dd3842ffff9..00000000000 --- a/plotly/validators/layout/geo/domain/_row.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class RowValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='row', parent_name='layout.geo.domain', **kwargs - ): - super(RowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/domain/_x.py b/plotly/validators/layout/geo/domain/_x.py deleted file mode 100644 index 6f2ff58713e..00000000000 --- a/plotly/validators/layout/geo/domain/_x.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='x', parent_name='layout.geo.domain', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/domain/_y.py b/plotly/validators/layout/geo/domain/_y.py deleted file mode 100644 index 75be1151ed7..00000000000 --- a/plotly/validators/layout/geo/domain/_y.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='y', parent_name='layout.geo.domain', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/lataxis/__init__.py b/plotly/validators/layout/geo/lataxis/__init__.py index e9a6ba6b230..1e64696a302 100644 --- a/plotly/validators/layout/geo/lataxis/__init__.py +++ b/plotly/validators/layout/geo/lataxis/__init__.py @@ -1,6 +1,123 @@ -from ._tick0 import Tick0Validator -from ._showgrid import ShowgridValidator -from ._range import RangeValidator -from ._gridwidth import GridwidthValidator -from ._gridcolor import GridcolorValidator -from ._dtick import DtickValidator + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='tick0', parent_name='layout.geo.lataxis', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showgrid', + parent_name='layout.geo.lataxis', + **kwargs + ): + super(ShowgridValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='range', parent_name='layout.geo.lataxis', **kwargs + ): + super(RangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'editType': 'plot' + }, { + 'valType': 'number', + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='gridwidth', + parent_name='layout.geo.lataxis', + **kwargs + ): + super(GridwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='gridcolor', + parent_name='layout.geo.lataxis', + **kwargs + ): + super(GridcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='dtick', parent_name='layout.geo.lataxis', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/geo/lataxis/_dtick.py b/plotly/validators/layout/geo/lataxis/_dtick.py deleted file mode 100644 index 200011d555e..00000000000 --- a/plotly/validators/layout/geo/lataxis/_dtick.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='dtick', parent_name='layout.geo.lataxis', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/lataxis/_gridcolor.py b/plotly/validators/layout/geo/lataxis/_gridcolor.py deleted file mode 100644 index b0322abb52b..00000000000 --- a/plotly/validators/layout/geo/lataxis/_gridcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='gridcolor', - parent_name='layout.geo.lataxis', - **kwargs - ): - super(GridcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/lataxis/_gridwidth.py b/plotly/validators/layout/geo/lataxis/_gridwidth.py deleted file mode 100644 index d1221ed5d52..00000000000 --- a/plotly/validators/layout/geo/lataxis/_gridwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='gridwidth', - parent_name='layout.geo.lataxis', - **kwargs - ): - super(GridwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/lataxis/_range.py b/plotly/validators/layout/geo/lataxis/_range.py deleted file mode 100644 index 65605ecbfd4..00000000000 --- a/plotly/validators/layout/geo/lataxis/_range.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='range', parent_name='layout.geo.lataxis', **kwargs - ): - super(RangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'editType': 'plot' - }, { - 'valType': 'number', - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/lataxis/_showgrid.py b/plotly/validators/layout/geo/lataxis/_showgrid.py deleted file mode 100644 index 9e309cd6137..00000000000 --- a/plotly/validators/layout/geo/lataxis/_showgrid.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showgrid', - parent_name='layout.geo.lataxis', - **kwargs - ): - super(ShowgridValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/lataxis/_tick0.py b/plotly/validators/layout/geo/lataxis/_tick0.py deleted file mode 100644 index 94b78573421..00000000000 --- a/plotly/validators/layout/geo/lataxis/_tick0.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='tick0', parent_name='layout.geo.lataxis', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/lonaxis/__init__.py b/plotly/validators/layout/geo/lonaxis/__init__.py index e9a6ba6b230..fa021f694dc 100644 --- a/plotly/validators/layout/geo/lonaxis/__init__.py +++ b/plotly/validators/layout/geo/lonaxis/__init__.py @@ -1,6 +1,123 @@ -from ._tick0 import Tick0Validator -from ._showgrid import ShowgridValidator -from ._range import RangeValidator -from ._gridwidth import GridwidthValidator -from ._gridcolor import GridcolorValidator -from ._dtick import DtickValidator + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='tick0', parent_name='layout.geo.lonaxis', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showgrid', + parent_name='layout.geo.lonaxis', + **kwargs + ): + super(ShowgridValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='range', parent_name='layout.geo.lonaxis', **kwargs + ): + super(RangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'editType': 'plot' + }, { + 'valType': 'number', + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='gridwidth', + parent_name='layout.geo.lonaxis', + **kwargs + ): + super(GridwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='gridcolor', + parent_name='layout.geo.lonaxis', + **kwargs + ): + super(GridcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='dtick', parent_name='layout.geo.lonaxis', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/geo/lonaxis/_dtick.py b/plotly/validators/layout/geo/lonaxis/_dtick.py deleted file mode 100644 index 68327a18399..00000000000 --- a/plotly/validators/layout/geo/lonaxis/_dtick.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='dtick', parent_name='layout.geo.lonaxis', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/lonaxis/_gridcolor.py b/plotly/validators/layout/geo/lonaxis/_gridcolor.py deleted file mode 100644 index 6e760070722..00000000000 --- a/plotly/validators/layout/geo/lonaxis/_gridcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='gridcolor', - parent_name='layout.geo.lonaxis', - **kwargs - ): - super(GridcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/lonaxis/_gridwidth.py b/plotly/validators/layout/geo/lonaxis/_gridwidth.py deleted file mode 100644 index d08fb4029d5..00000000000 --- a/plotly/validators/layout/geo/lonaxis/_gridwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='gridwidth', - parent_name='layout.geo.lonaxis', - **kwargs - ): - super(GridwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/lonaxis/_range.py b/plotly/validators/layout/geo/lonaxis/_range.py deleted file mode 100644 index 47d0ec5ec1c..00000000000 --- a/plotly/validators/layout/geo/lonaxis/_range.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='range', parent_name='layout.geo.lonaxis', **kwargs - ): - super(RangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'editType': 'plot' - }, { - 'valType': 'number', - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/lonaxis/_showgrid.py b/plotly/validators/layout/geo/lonaxis/_showgrid.py deleted file mode 100644 index cea57b2db41..00000000000 --- a/plotly/validators/layout/geo/lonaxis/_showgrid.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showgrid', - parent_name='layout.geo.lonaxis', - **kwargs - ): - super(ShowgridValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/lonaxis/_tick0.py b/plotly/validators/layout/geo/lonaxis/_tick0.py deleted file mode 100644 index 31ed6333d7b..00000000000 --- a/plotly/validators/layout/geo/lonaxis/_tick0.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='tick0', parent_name='layout.geo.lonaxis', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/projection/__init__.py b/plotly/validators/layout/geo/projection/__init__.py index e50803d2093..f8a56721525 100644 --- a/plotly/validators/layout/geo/projection/__init__.py +++ b/plotly/validators/layout/geo/projection/__init__.py @@ -1,4 +1,116 @@ -from ._type import TypeValidator -from ._scale import ScaleValidator -from ._rotation import RotationValidator -from ._parallels import ParallelsValidator + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='type', + parent_name='layout.geo.projection', + **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'equirectangular', 'mercator', 'orthographic', + 'natural earth', 'kavrayskiy7', 'miller', 'robinson', + 'eckert4', 'azimuthal equal area', 'azimuthal equidistant', + 'conic equal area', 'conic conformal', 'conic equidistant', + 'gnomonic', 'stereographic', 'mollweide', 'hammer', + 'transverse mercator', 'albers usa', 'winkel tripel', + 'aitoff', 'sinusoidal' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScaleValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='scale', + parent_name='layout.geo.projection', + **kwargs + ): + super(ScaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RotationValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='rotation', + parent_name='layout.geo.projection', + **kwargs + ): + super(RotationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Rotation'), + data_docs=kwargs.pop( + 'data_docs', """ + lat + Rotates the map along meridians (in degrees + North). + lon + Rotates the map along parallels (in degrees + East). Defaults to the center of the + `lonaxis.range` values. + roll + Roll the map (in degrees) For example, a roll + of 180 makes the map appear upside down. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ParallelsValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='parallels', + parent_name='layout.geo.projection', + **kwargs + ): + super(ParallelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'editType': 'plot' + }, { + 'valType': 'number', + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/geo/projection/_parallels.py b/plotly/validators/layout/geo/projection/_parallels.py deleted file mode 100644 index 10be6b9d7a8..00000000000 --- a/plotly/validators/layout/geo/projection/_parallels.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class ParallelsValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='parallels', - parent_name='layout.geo.projection', - **kwargs - ): - super(ParallelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'editType': 'plot' - }, { - 'valType': 'number', - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/projection/_rotation.py b/plotly/validators/layout/geo/projection/_rotation.py deleted file mode 100644 index 2387a3d49e7..00000000000 --- a/plotly/validators/layout/geo/projection/_rotation.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class RotationValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='rotation', - parent_name='layout.geo.projection', - **kwargs - ): - super(RotationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Rotation'), - data_docs=kwargs.pop( - 'data_docs', """ - lat - Rotates the map along meridians (in degrees - North). - lon - Rotates the map along parallels (in degrees - East). Defaults to the center of the - `lonaxis.range` values. - roll - Roll the map (in degrees) For example, a roll - of 180 makes the map appear upside down. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/geo/projection/_scale.py b/plotly/validators/layout/geo/projection/_scale.py deleted file mode 100644 index f3b76b0c177..00000000000 --- a/plotly/validators/layout/geo/projection/_scale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScaleValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='scale', - parent_name='layout.geo.projection', - **kwargs - ): - super(ScaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/projection/_type.py b/plotly/validators/layout/geo/projection/_type.py deleted file mode 100644 index 3ffd86051b9..00000000000 --- a/plotly/validators/layout/geo/projection/_type.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='type', - parent_name='layout.geo.projection', - **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'equirectangular', 'mercator', 'orthographic', - 'natural earth', 'kavrayskiy7', 'miller', 'robinson', - 'eckert4', 'azimuthal equal area', 'azimuthal equidistant', - 'conic equal area', 'conic conformal', 'conic equidistant', - 'gnomonic', 'stereographic', 'mollweide', 'hammer', - 'transverse mercator', 'albers usa', 'winkel tripel', - 'aitoff', 'sinusoidal' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/geo/projection/rotation/__init__.py b/plotly/validators/layout/geo/projection/rotation/__init__.py index e8823f9d7c9..6da7535d9e0 100644 --- a/plotly/validators/layout/geo/projection/rotation/__init__.py +++ b/plotly/validators/layout/geo/projection/rotation/__init__.py @@ -1,3 +1,60 @@ -from ._roll import RollValidator -from ._lon import LonValidator -from ._lat import LatValidator + + +import _plotly_utils.basevalidators + + +class RollValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='roll', + parent_name='layout.geo.projection.rotation', + **kwargs + ): + super(RollValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LonValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='lon', + parent_name='layout.geo.projection.rotation', + **kwargs + ): + super(LonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LatValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='lat', + parent_name='layout.geo.projection.rotation', + **kwargs + ): + super(LatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/geo/projection/rotation/_lat.py b/plotly/validators/layout/geo/projection/rotation/_lat.py deleted file mode 100644 index b30ec7eae30..00000000000 --- a/plotly/validators/layout/geo/projection/rotation/_lat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LatValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='lat', - parent_name='layout.geo.projection.rotation', - **kwargs - ): - super(LatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/projection/rotation/_lon.py b/plotly/validators/layout/geo/projection/rotation/_lon.py deleted file mode 100644 index 981da52a4df..00000000000 --- a/plotly/validators/layout/geo/projection/rotation/_lon.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LonValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='lon', - parent_name='layout.geo.projection.rotation', - **kwargs - ): - super(LonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/geo/projection/rotation/_roll.py b/plotly/validators/layout/geo/projection/rotation/_roll.py deleted file mode 100644 index 729e06d4fcc..00000000000 --- a/plotly/validators/layout/geo/projection/rotation/_roll.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class RollValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='roll', - parent_name='layout.geo.projection.rotation', - **kwargs - ): - super(RollValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/grid/__init__.py b/plotly/validators/layout/grid/__init__.py index ecd5d89215b..41b61bef81c 100644 --- a/plotly/validators/layout/grid/__init__.py +++ b/plotly/validators/layout/grid/__init__.py @@ -1,12 +1,259 @@ -from ._yside import YsideValidator -from ._ygap import YgapValidator -from ._yaxes import YaxesValidator -from ._xside import XsideValidator -from ._xgap import XgapValidator -from ._xaxes import XaxesValidator -from ._subplots import SubplotsValidator -from ._rows import RowsValidator -from ._roworder import RoworderValidator -from ._pattern import PatternValidator -from ._domain import DomainValidator -from ._columns import ColumnsValidator + + +import _plotly_utils.basevalidators + + +class YsideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='yside', parent_name='layout.grid', **kwargs + ): + super(YsideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['left', 'left plot', 'right plot', 'right'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YgapValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ygap', parent_name='layout.grid', **kwargs + ): + super(YgapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YaxesValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='yaxes', parent_name='layout.grid', **kwargs + ): + super(YaxesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + free_length=kwargs.pop('free_length', True), + items=kwargs.pop( + 'items', { + 'valType': 'enumerated', + 'values': ['/^y([2-9]|[1-9][0-9]+)?$/', ''], + 'editType': 'plot' + } + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xside', parent_name='layout.grid', **kwargs + ): + super(XsideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['bottom', 'bottom plot', 'top plot', 'top'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XgapValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='xgap', parent_name='layout.grid', **kwargs + ): + super(XgapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XaxesValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='xaxes', parent_name='layout.grid', **kwargs + ): + super(XaxesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + free_length=kwargs.pop('free_length', True), + items=kwargs.pop( + 'items', { + 'valType': 'enumerated', + 'values': ['/^x([2-9]|[1-9][0-9]+)?$/', ''], + 'editType': 'plot' + } + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SubplotsValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='subplots', parent_name='layout.grid', **kwargs + ): + super(SubplotsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dimensions=kwargs.pop('dimensions', 2), + edit_type=kwargs.pop('edit_type', 'plot'), + free_length=kwargs.pop('free_length', True), + items=kwargs.pop( + 'items', { + 'valType': + 'enumerated', + 'values': + ['/^x([2-9]|[1-9][0-9]+)?y([2-9]|[1-9][0-9]+)?$/', ''], + 'editType': + 'plot' + } + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RowsValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='rows', parent_name='layout.grid', **kwargs + ): + super(RowsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RoworderValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='roworder', parent_name='layout.grid', **kwargs + ): + super(RoworderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['top to bottom', 'bottom to top']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PatternValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='pattern', parent_name='layout.grid', **kwargs + ): + super(PatternValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['independent', 'coupled']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='domain', parent_name='layout.grid', **kwargs + ): + super(DomainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Domain'), + data_docs=kwargs.pop( + 'data_docs', """ + x + 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. + y + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColumnsValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='columns', parent_name='layout.grid', **kwargs + ): + super(ColumnsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/grid/_columns.py b/plotly/validators/layout/grid/_columns.py deleted file mode 100644 index 60b8757624a..00000000000 --- a/plotly/validators/layout/grid/_columns.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColumnsValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='columns', parent_name='layout.grid', **kwargs - ): - super(ColumnsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/grid/_domain.py b/plotly/validators/layout/grid/_domain.py deleted file mode 100644 index 1a6eebf6bc7..00000000000 --- a/plotly/validators/layout/grid/_domain.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='domain', parent_name='layout.grid', **kwargs - ): - super(DomainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Domain'), - data_docs=kwargs.pop( - 'data_docs', """ - x - 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. - y - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/grid/_pattern.py b/plotly/validators/layout/grid/_pattern.py deleted file mode 100644 index 3d7fe047803..00000000000 --- a/plotly/validators/layout/grid/_pattern.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class PatternValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='pattern', parent_name='layout.grid', **kwargs - ): - super(PatternValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['independent', 'coupled']), - **kwargs - ) diff --git a/plotly/validators/layout/grid/_roworder.py b/plotly/validators/layout/grid/_roworder.py deleted file mode 100644 index b14f2c6e91e..00000000000 --- a/plotly/validators/layout/grid/_roworder.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class RoworderValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='roworder', parent_name='layout.grid', **kwargs - ): - super(RoworderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['top to bottom', 'bottom to top']), - **kwargs - ) diff --git a/plotly/validators/layout/grid/_rows.py b/plotly/validators/layout/grid/_rows.py deleted file mode 100644 index 150f9e7c9eb..00000000000 --- a/plotly/validators/layout/grid/_rows.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class RowsValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='rows', parent_name='layout.grid', **kwargs - ): - super(RowsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/grid/_subplots.py b/plotly/validators/layout/grid/_subplots.py deleted file mode 100644 index 7d354c56829..00000000000 --- a/plotly/validators/layout/grid/_subplots.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class SubplotsValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='subplots', parent_name='layout.grid', **kwargs - ): - super(SubplotsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dimensions=kwargs.pop('dimensions', 2), - edit_type=kwargs.pop('edit_type', 'plot'), - free_length=kwargs.pop('free_length', True), - items=kwargs.pop( - 'items', { - 'valType': - 'enumerated', - 'values': - ['/^x([2-9]|[1-9][0-9]+)?y([2-9]|[1-9][0-9]+)?$/', ''], - 'editType': - 'plot' - } - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/grid/_xaxes.py b/plotly/validators/layout/grid/_xaxes.py deleted file mode 100644 index 2df88b7368c..00000000000 --- a/plotly/validators/layout/grid/_xaxes.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class XaxesValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='xaxes', parent_name='layout.grid', **kwargs - ): - super(XaxesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - free_length=kwargs.pop('free_length', True), - items=kwargs.pop( - 'items', { - 'valType': 'enumerated', - 'values': ['/^x([2-9]|[1-9][0-9]+)?$/', ''], - 'editType': 'plot' - } - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/grid/_xgap.py b/plotly/validators/layout/grid/_xgap.py deleted file mode 100644 index 065569bf51e..00000000000 --- a/plotly/validators/layout/grid/_xgap.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XgapValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='xgap', parent_name='layout.grid', **kwargs - ): - super(XgapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/grid/_xside.py b/plotly/validators/layout/grid/_xside.py deleted file mode 100644 index 30464fec1c4..00000000000 --- a/plotly/validators/layout/grid/_xside.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xside', parent_name='layout.grid', **kwargs - ): - super(XsideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['bottom', 'bottom plot', 'top plot', 'top'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/grid/_yaxes.py b/plotly/validators/layout/grid/_yaxes.py deleted file mode 100644 index 210145267d0..00000000000 --- a/plotly/validators/layout/grid/_yaxes.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class YaxesValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='yaxes', parent_name='layout.grid', **kwargs - ): - super(YaxesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - free_length=kwargs.pop('free_length', True), - items=kwargs.pop( - 'items', { - 'valType': 'enumerated', - 'values': ['/^y([2-9]|[1-9][0-9]+)?$/', ''], - 'editType': 'plot' - } - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/grid/_ygap.py b/plotly/validators/layout/grid/_ygap.py deleted file mode 100644 index ff1c3161c50..00000000000 --- a/plotly/validators/layout/grid/_ygap.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YgapValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ygap', parent_name='layout.grid', **kwargs - ): - super(YgapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/grid/_yside.py b/plotly/validators/layout/grid/_yside.py deleted file mode 100644 index 04e08e1124d..00000000000 --- a/plotly/validators/layout/grid/_yside.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='yside', parent_name='layout.grid', **kwargs - ): - super(YsideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['left', 'left plot', 'right plot', 'right'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/grid/domain/__init__.py b/plotly/validators/layout/grid/domain/__init__.py index a98ad8c5d93..f44616c01b1 100644 --- a/plotly/validators/layout/grid/domain/__init__.py +++ b/plotly/validators/layout/grid/domain/__init__.py @@ -1,2 +1,66 @@ -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='y', parent_name='layout.grid.domain', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='x', parent_name='layout.grid.domain', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/grid/domain/_x.py b/plotly/validators/layout/grid/domain/_x.py deleted file mode 100644 index 60a69821e78..00000000000 --- a/plotly/validators/layout/grid/domain/_x.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='x', parent_name='layout.grid.domain', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/grid/domain/_y.py b/plotly/validators/layout/grid/domain/_y.py deleted file mode 100644 index 0a95ef91d9e..00000000000 --- a/plotly/validators/layout/grid/domain/_y.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='y', parent_name='layout.grid.domain', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/hoverlabel/__init__.py b/plotly/validators/layout/hoverlabel/__init__.py index ef96a1b1464..eb0768aa846 100644 --- a/plotly/validators/layout/hoverlabel/__init__.py +++ b/plotly/validators/layout/hoverlabel/__init__.py @@ -1,4 +1,98 @@ -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='layout.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='layout.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='layout.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='layout.hoverlabel', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/hoverlabel/_bgcolor.py b/plotly/validators/layout/hoverlabel/_bgcolor.py deleted file mode 100644 index 87dc81ced01..00000000000 --- a/plotly/validators/layout/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='layout.hoverlabel', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/hoverlabel/_bordercolor.py b/plotly/validators/layout/hoverlabel/_bordercolor.py deleted file mode 100644 index 92f388950fd..00000000000 --- a/plotly/validators/layout/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='layout.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/hoverlabel/_font.py b/plotly/validators/layout/hoverlabel/_font.py deleted file mode 100644 index 5cef090b255..00000000000 --- a/plotly/validators/layout/hoverlabel/_font.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='layout.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/hoverlabel/_namelength.py b/plotly/validators/layout/hoverlabel/_namelength.py deleted file mode 100644 index d73813e9eb3..00000000000 --- a/plotly/validators/layout/hoverlabel/_namelength.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='layout.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/hoverlabel/font/__init__.py b/plotly/validators/layout/hoverlabel/font/__init__.py index 199d72e71c6..2ed67626ab7 100644 --- a/plotly/validators/layout/hoverlabel/font/__init__.py +++ b/plotly/validators/layout/hoverlabel/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/hoverlabel/font/_color.py b/plotly/validators/layout/hoverlabel/font/_color.py deleted file mode 100644 index 6911684bcb5..00000000000 --- a/plotly/validators/layout/hoverlabel/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/hoverlabel/font/_family.py b/plotly/validators/layout/hoverlabel/font/_family.py deleted file mode 100644 index 511598d2927..00000000000 --- a/plotly/validators/layout/hoverlabel/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/hoverlabel/font/_size.py b/plotly/validators/layout/hoverlabel/font/_size.py deleted file mode 100644 index bc32f93157d..00000000000 --- a/plotly/validators/layout/hoverlabel/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/image/__init__.py b/plotly/validators/layout/image/__init__.py index 3b246adf701..e0d7d911a00 100644 --- a/plotly/validators/layout/image/__init__.py +++ b/plotly/validators/layout/image/__init__.py @@ -1,15 +1,266 @@ -from ._yref import YrefValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xref import XrefValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._visible import VisibleValidator -from ._templateitemname import TemplateitemnameValidator -from ._source import SourceValidator -from ._sizing import SizingValidator -from ._sizey import SizeyValidator -from ._sizex import SizexValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._layer import LayerValidator + + +import _plotly_utils.basevalidators + + +class YrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='yref', parent_name='layout.image', **kwargs + ): + super(YrefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['paper', '/^y([2-9]|[1-9][0-9]+)?$/'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='yanchor', parent_name='layout.image', **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='y', parent_name='layout.image', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xref', parent_name='layout.image', **kwargs + ): + super(XrefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['paper', '/^x([2-9]|[1-9][0-9]+)?$/'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xanchor', parent_name='layout.image', **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='x', parent_name='layout.image', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='layout.image', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.image', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SourceValidator(_plotly_utils.basevalidators.ImageUriValidator): + + def __init__( + self, plotly_name='source', parent_name='layout.image', **kwargs + ): + super(SourceValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizingValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='sizing', parent_name='layout.image', **kwargs + ): + super(SizingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fill', 'contain', 'stretch']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeyValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sizey', parent_name='layout.image', **kwargs + ): + super(SizeyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizexValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sizex', parent_name='layout.image', **kwargs + ): + super(SizexValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='layout.image', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='layout.image', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='layer', parent_name='layout.image', **kwargs + ): + super(LayerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['below', 'above']), + **kwargs + ) diff --git a/plotly/validators/layout/image/_layer.py b/plotly/validators/layout/image/_layer.py deleted file mode 100644 index 7f956052c37..00000000000 --- a/plotly/validators/layout/image/_layer.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='layer', parent_name='layout.image', **kwargs - ): - super(LayerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['below', 'above']), - **kwargs - ) diff --git a/plotly/validators/layout/image/_name.py b/plotly/validators/layout/image/_name.py deleted file mode 100644 index f47992b94a8..00000000000 --- a/plotly/validators/layout/image/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='layout.image', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/image/_opacity.py b/plotly/validators/layout/image/_opacity.py deleted file mode 100644 index 8bc6e924dbd..00000000000 --- a/plotly/validators/layout/image/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='layout.image', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/image/_sizex.py b/plotly/validators/layout/image/_sizex.py deleted file mode 100644 index 152564ffd4e..00000000000 --- a/plotly/validators/layout/image/_sizex.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizexValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sizex', parent_name='layout.image', **kwargs - ): - super(SizexValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/image/_sizey.py b/plotly/validators/layout/image/_sizey.py deleted file mode 100644 index 5aebb46565b..00000000000 --- a/plotly/validators/layout/image/_sizey.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeyValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sizey', parent_name='layout.image', **kwargs - ): - super(SizeyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/image/_sizing.py b/plotly/validators/layout/image/_sizing.py deleted file mode 100644 index bf275ea2e04..00000000000 --- a/plotly/validators/layout/image/_sizing.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizingValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='sizing', parent_name='layout.image', **kwargs - ): - super(SizingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fill', 'contain', 'stretch']), - **kwargs - ) diff --git a/plotly/validators/layout/image/_source.py b/plotly/validators/layout/image/_source.py deleted file mode 100644 index 23d2c329521..00000000000 --- a/plotly/validators/layout/image/_source.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SourceValidator(_plotly_utils.basevalidators.ImageUriValidator): - - def __init__( - self, plotly_name='source', parent_name='layout.image', **kwargs - ): - super(SourceValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/image/_templateitemname.py b/plotly/validators/layout/image/_templateitemname.py deleted file mode 100644 index 38629f03531..00000000000 --- a/plotly/validators/layout/image/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.image', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/image/_visible.py b/plotly/validators/layout/image/_visible.py deleted file mode 100644 index 449e9d9c4fc..00000000000 --- a/plotly/validators/layout/image/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='layout.image', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/image/_x.py b/plotly/validators/layout/image/_x.py deleted file mode 100644 index f2e30544517..00000000000 --- a/plotly/validators/layout/image/_x.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='x', parent_name='layout.image', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/image/_xanchor.py b/plotly/validators/layout/image/_xanchor.py deleted file mode 100644 index 1e7b472098d..00000000000 --- a/plotly/validators/layout/image/_xanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xanchor', parent_name='layout.image', **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/layout/image/_xref.py b/plotly/validators/layout/image/_xref.py deleted file mode 100644 index a869a4ecd4b..00000000000 --- a/plotly/validators/layout/image/_xref.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class XrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xref', parent_name='layout.image', **kwargs - ): - super(XrefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['paper', '/^x([2-9]|[1-9][0-9]+)?$/'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/image/_y.py b/plotly/validators/layout/image/_y.py deleted file mode 100644 index 3122246c5d9..00000000000 --- a/plotly/validators/layout/image/_y.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='y', parent_name='layout.image', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/image/_yanchor.py b/plotly/validators/layout/image/_yanchor.py deleted file mode 100644 index d663cbdea05..00000000000 --- a/plotly/validators/layout/image/_yanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='yanchor', parent_name='layout.image', **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/layout/image/_yref.py b/plotly/validators/layout/image/_yref.py deleted file mode 100644 index b92efba89c2..00000000000 --- a/plotly/validators/layout/image/_yref.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class YrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='yref', parent_name='layout.image', **kwargs - ): - super(YrefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['paper', '/^y([2-9]|[1-9][0-9]+)?$/'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/legend/__init__.py b/plotly/validators/layout/legend/__init__.py index 1d6725f0310..1db3522cddf 100644 --- a/plotly/validators/layout/legend/__init__.py +++ b/plotly/validators/layout/legend/__init__.py @@ -1,13 +1,255 @@ -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._valign import ValignValidator -from ._uirevision import UirevisionValidator -from ._traceorder import TraceorderValidator -from ._tracegroupgap import TracegroupgapValidator -from ._orientation import OrientationValidator -from ._font import FontValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='yanchor', parent_name='layout.legend', **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'legend'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='y', parent_name='layout.legend', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'legend'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xanchor', parent_name='layout.legend', **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'legend'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='x', parent_name='layout.legend', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'legend'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValignValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='valign', parent_name='layout.legend', **kwargs + ): + super(ValignValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'legend'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='layout.legend', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TraceorderValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='traceorder', parent_name='layout.legend', **kwargs + ): + super(TraceorderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'legend'), + extras=kwargs.pop('extras', ['normal']), + flags=kwargs.pop('flags', ['reversed', 'grouped']), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracegroupgapValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tracegroupgap', + parent_name='layout.legend', + **kwargs + ): + super(TracegroupgapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'legend'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OrientationValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='orientation', parent_name='layout.legend', **kwargs + ): + super(OrientationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'legend'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['v', 'h']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='layout.legend', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='borderwidth', parent_name='layout.legend', **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'legend'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bordercolor', parent_name='layout.legend', **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'legend'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='layout.legend', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'legend'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/legend/_bgcolor.py b/plotly/validators/layout/legend/_bgcolor.py deleted file mode 100644 index bc193e5be20..00000000000 --- a/plotly/validators/layout/legend/_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='layout.legend', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'legend'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/legend/_bordercolor.py b/plotly/validators/layout/legend/_bordercolor.py deleted file mode 100644 index 81b369e9430..00000000000 --- a/plotly/validators/layout/legend/_bordercolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bordercolor', parent_name='layout.legend', **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'legend'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/legend/_borderwidth.py b/plotly/validators/layout/legend/_borderwidth.py deleted file mode 100644 index d10d754b4f6..00000000000 --- a/plotly/validators/layout/legend/_borderwidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='borderwidth', parent_name='layout.legend', **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'legend'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/legend/_font.py b/plotly/validators/layout/legend/_font.py deleted file mode 100644 index f76a0808070..00000000000 --- a/plotly/validators/layout/legend/_font.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='layout.legend', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/legend/_orientation.py b/plotly/validators/layout/legend/_orientation.py deleted file mode 100644 index d147e408b86..00000000000 --- a/plotly/validators/layout/legend/_orientation.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class OrientationValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='orientation', parent_name='layout.legend', **kwargs - ): - super(OrientationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'legend'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['v', 'h']), - **kwargs - ) diff --git a/plotly/validators/layout/legend/_tracegroupgap.py b/plotly/validators/layout/legend/_tracegroupgap.py deleted file mode 100644 index 258d2b21149..00000000000 --- a/plotly/validators/layout/legend/_tracegroupgap.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracegroupgapValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tracegroupgap', - parent_name='layout.legend', - **kwargs - ): - super(TracegroupgapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'legend'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/legend/_traceorder.py b/plotly/validators/layout/legend/_traceorder.py deleted file mode 100644 index c6262859032..00000000000 --- a/plotly/validators/layout/legend/_traceorder.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TraceorderValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='traceorder', parent_name='layout.legend', **kwargs - ): - super(TraceorderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'legend'), - extras=kwargs.pop('extras', ['normal']), - flags=kwargs.pop('flags', ['reversed', 'grouped']), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/legend/_uirevision.py b/plotly/validators/layout/legend/_uirevision.py deleted file mode 100644 index ed546454c38..00000000000 --- a/plotly/validators/layout/legend/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='layout.legend', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/legend/_valign.py b/plotly/validators/layout/legend/_valign.py deleted file mode 100644 index 455ca5eed3b..00000000000 --- a/plotly/validators/layout/legend/_valign.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValignValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='valign', parent_name='layout.legend', **kwargs - ): - super(ValignValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'legend'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/layout/legend/_x.py b/plotly/validators/layout/legend/_x.py deleted file mode 100644 index 576841a0e94..00000000000 --- a/plotly/validators/layout/legend/_x.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='x', parent_name='layout.legend', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'legend'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/legend/_xanchor.py b/plotly/validators/layout/legend/_xanchor.py deleted file mode 100644 index 661fc3573a8..00000000000 --- a/plotly/validators/layout/legend/_xanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xanchor', parent_name='layout.legend', **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'legend'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/layout/legend/_y.py b/plotly/validators/layout/legend/_y.py deleted file mode 100644 index 21a0a7db866..00000000000 --- a/plotly/validators/layout/legend/_y.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='y', parent_name='layout.legend', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'legend'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/legend/_yanchor.py b/plotly/validators/layout/legend/_yanchor.py deleted file mode 100644 index 4aa681e3410..00000000000 --- a/plotly/validators/layout/legend/_yanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='yanchor', parent_name='layout.legend', **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'legend'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/layout/legend/font/__init__.py b/plotly/validators/layout/legend/font/__init__.py index 199d72e71c6..453be6de5b9 100644 --- a/plotly/validators/layout/legend/font/__init__.py +++ b/plotly/validators/layout/legend/font/__init__.py @@ -1,3 +1,54 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='layout.legend.font', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'legend'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='layout.legend.font', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'legend'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='layout.legend.font', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'legend'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/legend/font/_color.py b/plotly/validators/layout/legend/font/_color.py deleted file mode 100644 index 6a94b9093c5..00000000000 --- a/plotly/validators/layout/legend/font/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='layout.legend.font', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'legend'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/legend/font/_family.py b/plotly/validators/layout/legend/font/_family.py deleted file mode 100644 index 1d8666f8e0e..00000000000 --- a/plotly/validators/layout/legend/font/_family.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='layout.legend.font', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'legend'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/legend/font/_size.py b/plotly/validators/layout/legend/font/_size.py deleted file mode 100644 index 7f41c374860..00000000000 --- a/plotly/validators/layout/legend/font/_size.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='layout.legend.font', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'legend'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/__init__.py b/plotly/validators/layout/mapbox/__init__.py index dfcf25420dc..d25ce6c0b4c 100644 --- a/plotly/validators/layout/mapbox/__init__.py +++ b/plotly/validators/layout/mapbox/__init__.py @@ -1,10 +1,300 @@ -from ._zoom import ZoomValidator -from ._uirevision import UirevisionValidator -from ._style import StyleValidator -from ._pitch import PitchValidator -from ._layerdefaults import LayerValidator -from ._layers import LayersValidator -from ._domain import DomainValidator -from ._center import CenterValidator -from ._bearing import BearingValidator -from ._accesstoken import AccesstokenValidator + + +import _plotly_utils.basevalidators + + +class ZoomValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='zoom', parent_name='layout.mapbox', **kwargs + ): + super(ZoomValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='layout.mapbox', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StyleValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='style', parent_name='layout.mapbox', **kwargs + ): + super(StyleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 'basic', 'streets', 'outdoors', 'light', 'dark', + 'satellite', 'satellite-streets' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PitchValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='pitch', parent_name='layout.mapbox', **kwargs + ): + super(PitchValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LayerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='layerdefaults', + parent_name='layout.mapbox', + **kwargs + ): + super(LayerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Layer'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LayersValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, plotly_name='layers', parent_name='layout.mapbox', **kwargs + ): + super(LayersValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Layer'), + data_docs=kwargs.pop( + 'data_docs', """ + below + 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. + circle + plotly.graph_objs.layout.mapbox.layer.Circle + instance or dict with compatible properties + color + Sets the primary layer color. If `type` is + "circle", color corresponds to the circle color + (mapbox.layer.paint.circle-color) If `type` is + "line", color corresponds to the line color + (mapbox.layer.paint.line-color) If `type` is + "fill", color 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) + fill + plotly.graph_objs.layout.mapbox.layer.Fill + instance or dict with compatible properties + line + plotly.graph_objs.layout.mapbox.layer.Line + instance or dict with compatible properties + maxzoom + Sets the maximum zoom level + (mapbox.layer.maxzoom). At zoom levels equal to + or greater than the maxzoom, the layer will be + hidden. + minzoom + Sets the minimum zoom level + (mapbox.layer.minzoom). At zoom levels less + than the minzoom, the layer will be hidden. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + opacity + Sets the opacity of the layer. If `type` is + "circle", opacity corresponds to the circle + opacity (mapbox.layer.paint.circle-opacity) If + `type` is "line", opacity corresponds to the + line opacity (mapbox.layer.paint.line-opacity) + If `type` is "fill", opacity corresponds to the + fill opacity (mapbox.layer.paint.fill-opacity) + If `type` is "symbol", opacity corresponds to + the icon/text opacity (mapbox.layer.paint.text- + opacity) + source + Sets the source data for this layer + (mapbox.layer.source). Source can be either a + URL, a geojson object (with `sourcetype` set to + "geojson") or an array of tile URLS (with + `sourcetype` set to "vector"). + sourcelayer + Specifies the layer to use from a vector tile + source (mapbox.layer.source-layer). Required + for "vector" source type that supports multiple + layers. + sourcetype + Sets the source type for this layer. Support + for "raster", "image" and "video" source types + is coming soon. + symbol + plotly.graph_objs.layout.mapbox.layer.Symbol + instance or dict with compatible properties + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + type + Sets the layer type (mapbox.layer.type). + Support for "raster", "background" types is + coming soon. Note that "line" and "fill" are + not compatible with Point GeoJSON geometries. + visible + Determines whether this layer is displayed +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='domain', parent_name='layout.mapbox', **kwargs + ): + super(DomainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Domain'), + data_docs=kwargs.pop( + 'data_docs', """ + column + If there is a layout grid, use the domain for + this column in the grid for this mapbox subplot + . + row + If there is a layout grid, use the domain for + this row in the grid for this mapbox subplot . + x + Sets the horizontal domain of this mapbox + subplot (in plot fraction). + y + Sets the vertical domain of this mapbox subplot + (in plot fraction). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CenterValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='center', parent_name='layout.mapbox', **kwargs + ): + super(CenterValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Center'), + data_docs=kwargs.pop( + 'data_docs', """ + lat + Sets the latitude of the center of the map (in + degrees North). + lon + Sets the longitude of the center of the map (in + degrees East). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BearingValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='bearing', parent_name='layout.mapbox', **kwargs + ): + super(BearingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AccesstokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='accesstoken', parent_name='layout.mapbox', **kwargs + ): + super(AccesstokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) diff --git a/plotly/validators/layout/mapbox/_accesstoken.py b/plotly/validators/layout/mapbox/_accesstoken.py deleted file mode 100644 index 24d0a106eef..00000000000 --- a/plotly/validators/layout/mapbox/_accesstoken.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class AccesstokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='accesstoken', parent_name='layout.mapbox', **kwargs - ): - super(AccesstokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/_bearing.py b/plotly/validators/layout/mapbox/_bearing.py deleted file mode 100644 index 33d95eace51..00000000000 --- a/plotly/validators/layout/mapbox/_bearing.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BearingValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='bearing', parent_name='layout.mapbox', **kwargs - ): - super(BearingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/_center.py b/plotly/validators/layout/mapbox/_center.py deleted file mode 100644 index 81e7150b8f8..00000000000 --- a/plotly/validators/layout/mapbox/_center.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class CenterValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='center', parent_name='layout.mapbox', **kwargs - ): - super(CenterValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Center'), - data_docs=kwargs.pop( - 'data_docs', """ - lat - Sets the latitude of the center of the map (in - degrees North). - lon - Sets the longitude of the center of the map (in - degrees East). -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/_domain.py b/plotly/validators/layout/mapbox/_domain.py deleted file mode 100644 index 443b1e9fa8e..00000000000 --- a/plotly/validators/layout/mapbox/_domain.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='domain', parent_name='layout.mapbox', **kwargs - ): - super(DomainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Domain'), - data_docs=kwargs.pop( - 'data_docs', """ - column - If there is a layout grid, use the domain for - this column in the grid for this mapbox subplot - . - row - If there is a layout grid, use the domain for - this row in the grid for this mapbox subplot . - x - Sets the horizontal domain of this mapbox - subplot (in plot fraction). - y - Sets the vertical domain of this mapbox subplot - (in plot fraction). -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/_layerdefaults.py b/plotly/validators/layout/mapbox/_layerdefaults.py deleted file mode 100644 index 3453b59e4b7..00000000000 --- a/plotly/validators/layout/mapbox/_layerdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LayerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='layerdefaults', - parent_name='layout.mapbox', - **kwargs - ): - super(LayerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Layer'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/_layers.py b/plotly/validators/layout/mapbox/_layers.py deleted file mode 100644 index faa2feb8040..00000000000 --- a/plotly/validators/layout/mapbox/_layers.py +++ /dev/null @@ -1,108 +0,0 @@ -import _plotly_utils.basevalidators - - -class LayersValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, plotly_name='layers', parent_name='layout.mapbox', **kwargs - ): - super(LayersValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Layer'), - data_docs=kwargs.pop( - 'data_docs', """ - below - 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. - circle - plotly.graph_objs.layout.mapbox.layer.Circle - instance or dict with compatible properties - color - Sets the primary layer color. If `type` is - "circle", color corresponds to the circle color - (mapbox.layer.paint.circle-color) If `type` is - "line", color corresponds to the line color - (mapbox.layer.paint.line-color) If `type` is - "fill", color 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) - fill - plotly.graph_objs.layout.mapbox.layer.Fill - instance or dict with compatible properties - line - plotly.graph_objs.layout.mapbox.layer.Line - instance or dict with compatible properties - maxzoom - Sets the maximum zoom level - (mapbox.layer.maxzoom). At zoom levels equal to - or greater than the maxzoom, the layer will be - hidden. - minzoom - Sets the minimum zoom level - (mapbox.layer.minzoom). At zoom levels less - than the minzoom, the layer will be hidden. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - opacity - Sets the opacity of the layer. If `type` is - "circle", opacity corresponds to the circle - opacity (mapbox.layer.paint.circle-opacity) If - `type` is "line", opacity corresponds to the - line opacity (mapbox.layer.paint.line-opacity) - If `type` is "fill", opacity corresponds to the - fill opacity (mapbox.layer.paint.fill-opacity) - If `type` is "symbol", opacity corresponds to - the icon/text opacity (mapbox.layer.paint.text- - opacity) - source - Sets the source data for this layer - (mapbox.layer.source). Source can be either a - URL, a geojson object (with `sourcetype` set to - "geojson") or an array of tile URLS (with - `sourcetype` set to "vector"). - sourcelayer - Specifies the layer to use from a vector tile - source (mapbox.layer.source-layer). Required - for "vector" source type that supports multiple - layers. - sourcetype - Sets the source type for this layer. Support - for "raster", "image" and "video" source types - is coming soon. - symbol - plotly.graph_objs.layout.mapbox.layer.Symbol - instance or dict with compatible properties - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - type - Sets the layer type (mapbox.layer.type). - Support for "raster", "background" types is - coming soon. Note that "line" and "fill" are - not compatible with Point GeoJSON geometries. - visible - Determines whether this layer is displayed -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/_pitch.py b/plotly/validators/layout/mapbox/_pitch.py deleted file mode 100644 index 8cdba543117..00000000000 --- a/plotly/validators/layout/mapbox/_pitch.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class PitchValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='pitch', parent_name='layout.mapbox', **kwargs - ): - super(PitchValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/_style.py b/plotly/validators/layout/mapbox/_style.py deleted file mode 100644 index 5eb3605b428..00000000000 --- a/plotly/validators/layout/mapbox/_style.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class StyleValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='style', parent_name='layout.mapbox', **kwargs - ): - super(StyleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 'basic', 'streets', 'outdoors', 'light', 'dark', - 'satellite', 'satellite-streets' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/_uirevision.py b/plotly/validators/layout/mapbox/_uirevision.py deleted file mode 100644 index 398c1488351..00000000000 --- a/plotly/validators/layout/mapbox/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='layout.mapbox', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/_zoom.py b/plotly/validators/layout/mapbox/_zoom.py deleted file mode 100644 index 85cb211f8b5..00000000000 --- a/plotly/validators/layout/mapbox/_zoom.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZoomValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='zoom', parent_name='layout.mapbox', **kwargs - ): - super(ZoomValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/center/__init__.py b/plotly/validators/layout/mapbox/center/__init__.py index ab3107d7843..8a7cb0de311 100644 --- a/plotly/validators/layout/mapbox/center/__init__.py +++ b/plotly/validators/layout/mapbox/center/__init__.py @@ -1,2 +1,34 @@ -from ._lon import LonValidator -from ._lat import LatValidator + + +import _plotly_utils.basevalidators + + +class LonValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='lon', parent_name='layout.mapbox.center', **kwargs + ): + super(LonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LatValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='lat', parent_name='layout.mapbox.center', **kwargs + ): + super(LatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/mapbox/center/_lat.py b/plotly/validators/layout/mapbox/center/_lat.py deleted file mode 100644 index 8d19137cc2f..00000000000 --- a/plotly/validators/layout/mapbox/center/_lat.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LatValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='lat', parent_name='layout.mapbox.center', **kwargs - ): - super(LatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/center/_lon.py b/plotly/validators/layout/mapbox/center/_lon.py deleted file mode 100644 index 2f019887fce..00000000000 --- a/plotly/validators/layout/mapbox/center/_lon.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LonValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='lon', parent_name='layout.mapbox.center', **kwargs - ): - super(LonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/domain/__init__.py b/plotly/validators/layout/mapbox/domain/__init__.py index 6cf32248236..99e179ba122 100644 --- a/plotly/validators/layout/mapbox/domain/__init__.py +++ b/plotly/validators/layout/mapbox/domain/__init__.py @@ -1,4 +1,105 @@ -from ._y import YValidator -from ._x import XValidator -from ._row import RowValidator -from ._column import ColumnValidator + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='y', parent_name='layout.mapbox.domain', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='x', parent_name='layout.mapbox.domain', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RowValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='row', parent_name='layout.mapbox.domain', **kwargs + ): + super(RowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='column', + parent_name='layout.mapbox.domain', + **kwargs + ): + super(ColumnValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/mapbox/domain/_column.py b/plotly/validators/layout/mapbox/domain/_column.py deleted file mode 100644 index 7e197da28d9..00000000000 --- a/plotly/validators/layout/mapbox/domain/_column.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='column', - parent_name='layout.mapbox.domain', - **kwargs - ): - super(ColumnValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/domain/_row.py b/plotly/validators/layout/mapbox/domain/_row.py deleted file mode 100644 index abab787f63d..00000000000 --- a/plotly/validators/layout/mapbox/domain/_row.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class RowValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='row', parent_name='layout.mapbox.domain', **kwargs - ): - super(RowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/domain/_x.py b/plotly/validators/layout/mapbox/domain/_x.py deleted file mode 100644 index bac0ea5d541..00000000000 --- a/plotly/validators/layout/mapbox/domain/_x.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='x', parent_name='layout.mapbox.domain', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/domain/_y.py b/plotly/validators/layout/mapbox/domain/_y.py deleted file mode 100644 index 4cabfbde41d..00000000000 --- a/plotly/validators/layout/mapbox/domain/_y.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='y', parent_name='layout.mapbox.domain', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/__init__.py b/plotly/validators/layout/mapbox/layer/__init__.py index 524725f86af..f6d71041dc3 100644 --- a/plotly/validators/layout/mapbox/layer/__init__.py +++ b/plotly/validators/layout/mapbox/layer/__init__.py @@ -1,16 +1,369 @@ -from ._visible import VisibleValidator -from ._type import TypeValidator -from ._templateitemname import TemplateitemnameValidator -from ._symbol import SymbolValidator -from ._sourcetype import SourcetypeValidator -from ._sourcelayer import SourcelayerValidator -from ._source import SourceValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._minzoom import MinzoomValidator -from ._maxzoom import MaxzoomValidator -from ._line import LineValidator -from ._fill import FillValidator -from ._color import ColorValidator -from ._circle import CircleValidator -from ._below import BelowValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='visible', + parent_name='layout.mapbox.layer', + **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='layout.mapbox.layer', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['circle', 'line', 'fill', 'symbol']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.mapbox.layer', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymbolValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='symbol', + parent_name='layout.mapbox.layer', + **kwargs + ): + super(SymbolValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Symbol'), + data_docs=kwargs.pop( + 'data_docs', """ + icon + Sets the symbol icon image + (mapbox.layer.layout.icon-image). Full list: + https://www.mapbox.com/maki-icons/ + iconsize + Sets the symbol icon size + (mapbox.layer.layout.icon-size). Has an effect + only when `type` is set to "symbol". + placement + Sets the symbol and/or text placement + (mapbox.layer.layout.symbol-placement). If + `placement` is "point", the label is placed + where the geometry is located If `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 + text + Sets the symbol text (mapbox.layer.layout.text- + field). + textfont + Sets the icon text font + (color=mapbox.layer.paint.text-color, + size=mapbox.layer.layout.text-size). Has an + effect only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with + respects to the (x,y) coordinates. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SourcetypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='sourcetype', + parent_name='layout.mapbox.layer', + **kwargs + ): + super(SourcetypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['geojson', 'vector']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SourcelayerValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='sourcelayer', + parent_name='layout.mapbox.layer', + **kwargs + ): + super(SourcelayerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SourceValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='source', + parent_name='layout.mapbox.layer', + **kwargs + ): + super(SourceValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='layout.mapbox.layer', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='layout.mapbox.layer', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MinzoomValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='minzoom', + parent_name='layout.mapbox.layer', + **kwargs + ): + super(MinzoomValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 24), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxzoomValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxzoom', + parent_name='layout.mapbox.layer', + **kwargs + ): + super(MaxzoomValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 24), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='layout.mapbox.layer', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + dash + Sets the length of dashes and gaps + (mapbox.layer.paint.line-dasharray). Has an + effect only when `type` is set to "line". + dashsrc + Sets the source reference on plot.ly for dash + . + width + Sets the line width (mapbox.layer.paint.line- + width). Has an effect only when `type` is set + to "line". +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='fill', parent_name='layout.mapbox.layer', **kwargs + ): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Fill'), + data_docs=kwargs.pop( + 'data_docs', """ + outlinecolor + Sets the fill outline color + (mapbox.layer.paint.fill-outline-color). Has an + effect only when `type` is set to "fill". +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='layout.mapbox.layer', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CircleValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='circle', + parent_name='layout.mapbox.layer', + **kwargs + ): + super(CircleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Circle'), + data_docs=kwargs.pop( + 'data_docs', """ + radius + Sets the circle radius + (mapbox.layer.paint.circle-radius). Has an + effect only when `type` is set to "circle". +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BelowValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='below', parent_name='layout.mapbox.layer', **kwargs + ): + super(BelowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/mapbox/layer/_below.py b/plotly/validators/layout/mapbox/layer/_below.py deleted file mode 100644 index 4f514b22bfd..00000000000 --- a/plotly/validators/layout/mapbox/layer/_below.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BelowValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='below', parent_name='layout.mapbox.layer', **kwargs - ): - super(BelowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/_circle.py b/plotly/validators/layout/mapbox/layer/_circle.py deleted file mode 100644 index a45ccf294eb..00000000000 --- a/plotly/validators/layout/mapbox/layer/_circle.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class CircleValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='circle', - parent_name='layout.mapbox.layer', - **kwargs - ): - super(CircleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Circle'), - data_docs=kwargs.pop( - 'data_docs', """ - radius - Sets the circle radius - (mapbox.layer.paint.circle-radius). Has an - effect only when `type` is set to "circle". -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/_color.py b/plotly/validators/layout/mapbox/layer/_color.py deleted file mode 100644 index 74aa1bddc04..00000000000 --- a/plotly/validators/layout/mapbox/layer/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='layout.mapbox.layer', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/_fill.py b/plotly/validators/layout/mapbox/layer/_fill.py deleted file mode 100644 index a8421f436e5..00000000000 --- a/plotly/validators/layout/mapbox/layer/_fill.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='fill', parent_name='layout.mapbox.layer', **kwargs - ): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Fill'), - data_docs=kwargs.pop( - 'data_docs', """ - outlinecolor - Sets the fill outline color - (mapbox.layer.paint.fill-outline-color). Has an - effect only when `type` is set to "fill". -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/_line.py b/plotly/validators/layout/mapbox/layer/_line.py deleted file mode 100644 index 381e65fff4e..00000000000 --- a/plotly/validators/layout/mapbox/layer/_line.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='layout.mapbox.layer', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - dash - Sets the length of dashes and gaps - (mapbox.layer.paint.line-dasharray). Has an - effect only when `type` is set to "line". - dashsrc - Sets the source reference on plot.ly for dash - . - width - Sets the line width (mapbox.layer.paint.line- - width). Has an effect only when `type` is set - to "line". -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/_maxzoom.py b/plotly/validators/layout/mapbox/layer/_maxzoom.py deleted file mode 100644 index f1763749241..00000000000 --- a/plotly/validators/layout/mapbox/layer/_maxzoom.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxzoomValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxzoom', - parent_name='layout.mapbox.layer', - **kwargs - ): - super(MaxzoomValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 24), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/_minzoom.py b/plotly/validators/layout/mapbox/layer/_minzoom.py deleted file mode 100644 index e17aec9864a..00000000000 --- a/plotly/validators/layout/mapbox/layer/_minzoom.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MinzoomValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='minzoom', - parent_name='layout.mapbox.layer', - **kwargs - ): - super(MinzoomValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 24), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/_name.py b/plotly/validators/layout/mapbox/layer/_name.py deleted file mode 100644 index a683c6533a9..00000000000 --- a/plotly/validators/layout/mapbox/layer/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='layout.mapbox.layer', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/_opacity.py b/plotly/validators/layout/mapbox/layer/_opacity.py deleted file mode 100644 index aceb3b49c27..00000000000 --- a/plotly/validators/layout/mapbox/layer/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='layout.mapbox.layer', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/_source.py b/plotly/validators/layout/mapbox/layer/_source.py deleted file mode 100644 index 152230cea67..00000000000 --- a/plotly/validators/layout/mapbox/layer/_source.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SourceValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='source', - parent_name='layout.mapbox.layer', - **kwargs - ): - super(SourceValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/_sourcelayer.py b/plotly/validators/layout/mapbox/layer/_sourcelayer.py deleted file mode 100644 index d70c2c0cfe4..00000000000 --- a/plotly/validators/layout/mapbox/layer/_sourcelayer.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SourcelayerValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='sourcelayer', - parent_name='layout.mapbox.layer', - **kwargs - ): - super(SourcelayerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/_sourcetype.py b/plotly/validators/layout/mapbox/layer/_sourcetype.py deleted file mode 100644 index fe9e02ed6c9..00000000000 --- a/plotly/validators/layout/mapbox/layer/_sourcetype.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SourcetypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='sourcetype', - parent_name='layout.mapbox.layer', - **kwargs - ): - super(SourcetypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['geojson', 'vector']), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/_symbol.py b/plotly/validators/layout/mapbox/layer/_symbol.py deleted file mode 100644 index ebbd0070d42..00000000000 --- a/plotly/validators/layout/mapbox/layer/_symbol.py +++ /dev/null @@ -1,49 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='symbol', - parent_name='layout.mapbox.layer', - **kwargs - ): - super(SymbolValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Symbol'), - data_docs=kwargs.pop( - 'data_docs', """ - icon - Sets the symbol icon image - (mapbox.layer.layout.icon-image). Full list: - https://www.mapbox.com/maki-icons/ - iconsize - Sets the symbol icon size - (mapbox.layer.layout.icon-size). Has an effect - only when `type` is set to "symbol". - placement - Sets the symbol and/or text placement - (mapbox.layer.layout.symbol-placement). If - `placement` is "point", the label is placed - where the geometry is located If `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 - text - Sets the symbol text (mapbox.layer.layout.text- - field). - textfont - Sets the icon text font - (color=mapbox.layer.paint.text-color, - size=mapbox.layer.layout.text-size). Has an - effect only when `type` is set to "symbol". - textposition - Sets the positions of the `text` elements with - respects to the (x,y) coordinates. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/_templateitemname.py b/plotly/validators/layout/mapbox/layer/_templateitemname.py deleted file mode 100644 index 3a78256c73e..00000000000 --- a/plotly/validators/layout/mapbox/layer/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.mapbox.layer', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/_type.py b/plotly/validators/layout/mapbox/layer/_type.py deleted file mode 100644 index aaafcf05aa4..00000000000 --- a/plotly/validators/layout/mapbox/layer/_type.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='layout.mapbox.layer', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['circle', 'line', 'fill', 'symbol']), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/_visible.py b/plotly/validators/layout/mapbox/layer/_visible.py deleted file mode 100644 index 551f5c6c7e9..00000000000 --- a/plotly/validators/layout/mapbox/layer/_visible.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='visible', - parent_name='layout.mapbox.layer', - **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/circle/__init__.py b/plotly/validators/layout/mapbox/layer/circle/__init__.py index 42599ad609a..36c915dbdcb 100644 --- a/plotly/validators/layout/mapbox/layer/circle/__init__.py +++ b/plotly/validators/layout/mapbox/layer/circle/__init__.py @@ -1 +1,20 @@ -from ._radius import RadiusValidator + + +import _plotly_utils.basevalidators + + +class RadiusValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='radius', + parent_name='layout.mapbox.layer.circle', + **kwargs + ): + super(RadiusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/mapbox/layer/circle/_radius.py b/plotly/validators/layout/mapbox/layer/circle/_radius.py deleted file mode 100644 index 34024e9fe45..00000000000 --- a/plotly/validators/layout/mapbox/layer/circle/_radius.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class RadiusValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='radius', - parent_name='layout.mapbox.layer.circle', - **kwargs - ): - super(RadiusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/fill/__init__.py b/plotly/validators/layout/mapbox/layer/fill/__init__.py index 0e7deb56f3e..796bb7e7217 100644 --- a/plotly/validators/layout/mapbox/layer/fill/__init__.py +++ b/plotly/validators/layout/mapbox/layer/fill/__init__.py @@ -1 +1,20 @@ -from ._outlinecolor import OutlinecolorValidator + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='layout.mapbox.layer.fill', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/mapbox/layer/fill/_outlinecolor.py b/plotly/validators/layout/mapbox/layer/fill/_outlinecolor.py deleted file mode 100644 index b8632bb6042..00000000000 --- a/plotly/validators/layout/mapbox/layer/fill/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='layout.mapbox.layer.fill', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/line/__init__.py b/plotly/validators/layout/mapbox/layer/line/__init__.py index e7000d74b84..978c69658ef 100644 --- a/plotly/validators/layout/mapbox/layer/line/__init__.py +++ b/plotly/validators/layout/mapbox/layer/line/__init__.py @@ -1,3 +1,60 @@ -from ._width import WidthValidator -from ._dashsrc import DashsrcValidator -from ._dash import DashValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='layout.mapbox.layer.line', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='dashsrc', + parent_name='layout.mapbox.layer.line', + **kwargs + ): + super(DashsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='dash', + parent_name='layout.mapbox.layer.line', + **kwargs + ): + super(DashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/layout/mapbox/layer/line/_dash.py b/plotly/validators/layout/mapbox/layer/line/_dash.py deleted file mode 100644 index 09c4b8d473c..00000000000 --- a/plotly/validators/layout/mapbox/layer/line/_dash.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='dash', - parent_name='layout.mapbox.layer.line', - **kwargs - ): - super(DashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/line/_dashsrc.py b/plotly/validators/layout/mapbox/layer/line/_dashsrc.py deleted file mode 100644 index 320da765bbe..00000000000 --- a/plotly/validators/layout/mapbox/layer/line/_dashsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='dashsrc', - parent_name='layout.mapbox.layer.line', - **kwargs - ): - super(DashsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/line/_width.py b/plotly/validators/layout/mapbox/layer/line/_width.py deleted file mode 100644 index 8b0962cd4eb..00000000000 --- a/plotly/validators/layout/mapbox/layer/line/_width.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='layout.mapbox.layer.line', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/symbol/__init__.py b/plotly/validators/layout/mapbox/layer/symbol/__init__.py index 29888b2da9b..5a423d037cd 100644 --- a/plotly/validators/layout/mapbox/layer/symbol/__init__.py +++ b/plotly/validators/layout/mapbox/layer/symbol/__init__.py @@ -1,6 +1,152 @@ -from ._textposition import TextpositionValidator -from ._textfont import TextfontValidator -from ._text import TextValidator -from ._placement import PlacementValidator -from ._iconsize import IconsizeValidator -from ._icon import IconValidator + + +import _plotly_utils.basevalidators + + +class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='textposition', + parent_name='layout.mapbox.layer.symbol', + **kwargs + ): + super(TextpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 'top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', + 'bottom center', 'bottom right' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='layout.mapbox.layer.symbol', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='layout.mapbox.layer.symbol', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PlacementValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='placement', + parent_name='layout.mapbox.layer.symbol', + **kwargs + ): + super(PlacementValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['point', 'line', 'line-center']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IconsizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='iconsize', + parent_name='layout.mapbox.layer.symbol', + **kwargs + ): + super(IconsizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IconValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='icon', + parent_name='layout.mapbox.layer.symbol', + **kwargs + ): + super(IconValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/mapbox/layer/symbol/_icon.py b/plotly/validators/layout/mapbox/layer/symbol/_icon.py deleted file mode 100644 index 794abe94168..00000000000 --- a/plotly/validators/layout/mapbox/layer/symbol/_icon.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class IconValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='icon', - parent_name='layout.mapbox.layer.symbol', - **kwargs - ): - super(IconValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/symbol/_iconsize.py b/plotly/validators/layout/mapbox/layer/symbol/_iconsize.py deleted file mode 100644 index 25bf36d703d..00000000000 --- a/plotly/validators/layout/mapbox/layer/symbol/_iconsize.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class IconsizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='iconsize', - parent_name='layout.mapbox.layer.symbol', - **kwargs - ): - super(IconsizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/symbol/_placement.py b/plotly/validators/layout/mapbox/layer/symbol/_placement.py deleted file mode 100644 index 69a77a0aa7f..00000000000 --- a/plotly/validators/layout/mapbox/layer/symbol/_placement.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class PlacementValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='placement', - parent_name='layout.mapbox.layer.symbol', - **kwargs - ): - super(PlacementValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['point', 'line', 'line-center']), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/symbol/_text.py b/plotly/validators/layout/mapbox/layer/symbol/_text.py deleted file mode 100644 index 67549f9c548..00000000000 --- a/plotly/validators/layout/mapbox/layer/symbol/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='layout.mapbox.layer.symbol', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/symbol/_textfont.py b/plotly/validators/layout/mapbox/layer/symbol/_textfont.py deleted file mode 100644 index 2df0ecdab08..00000000000 --- a/plotly/validators/layout/mapbox/layer/symbol/_textfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='layout.mapbox.layer.symbol', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/symbol/_textposition.py b/plotly/validators/layout/mapbox/layer/symbol/_textposition.py deleted file mode 100644 index c3e82016a5b..00000000000 --- a/plotly/validators/layout/mapbox/layer/symbol/_textposition.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='textposition', - parent_name='layout.mapbox.layer.symbol', - **kwargs - ): - super(TextpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 'top left', 'top center', 'top right', 'middle left', - 'middle center', 'middle right', 'bottom left', - 'bottom center', 'bottom right' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/symbol/textfont/__init__.py b/plotly/validators/layout/mapbox/layer/symbol/textfont/__init__.py index 199d72e71c6..63b436082dd 100644 --- a/plotly/validators/layout/mapbox/layer/symbol/textfont/__init__.py +++ b/plotly/validators/layout/mapbox/layer/symbol/textfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.mapbox.layer.symbol.textfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.mapbox.layer.symbol.textfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.mapbox.layer.symbol.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/mapbox/layer/symbol/textfont/_color.py b/plotly/validators/layout/mapbox/layer/symbol/textfont/_color.py deleted file mode 100644 index 887a9d7d94b..00000000000 --- a/plotly/validators/layout/mapbox/layer/symbol/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.mapbox.layer.symbol.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/symbol/textfont/_family.py b/plotly/validators/layout/mapbox/layer/symbol/textfont/_family.py deleted file mode 100644 index 1b4ab6269f4..00000000000 --- a/plotly/validators/layout/mapbox/layer/symbol/textfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.mapbox.layer.symbol.textfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/mapbox/layer/symbol/textfont/_size.py b/plotly/validators/layout/mapbox/layer/symbol/textfont/_size.py deleted file mode 100644 index 546a54f075e..00000000000 --- a/plotly/validators/layout/mapbox/layer/symbol/textfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.mapbox.layer.symbol.textfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/margin/__init__.py b/plotly/validators/layout/margin/__init__.py index 7d24ee5aeb1..6d6756b7e99 100644 --- a/plotly/validators/layout/margin/__init__.py +++ b/plotly/validators/layout/margin/__init__.py @@ -1,6 +1,99 @@ -from ._t import TValidator -from ._r import RValidator -from ._pad import PadValidator -from ._l import LValidator -from ._b import BValidator -from ._autoexpand import AutoexpandValidator + + +import _plotly_utils.basevalidators + + +class TValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='t', parent_name='layout.margin', **kwargs): + super(TValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='r', parent_name='layout.margin', **kwargs): + super(RValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='pad', parent_name='layout.margin', **kwargs + ): + super(PadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='l', parent_name='layout.margin', **kwargs): + super(LValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='b', parent_name='layout.margin', **kwargs): + super(BValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutoexpandValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autoexpand', parent_name='layout.margin', **kwargs + ): + super(AutoexpandValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/margin/_autoexpand.py b/plotly/validators/layout/margin/_autoexpand.py deleted file mode 100644 index bfe6a978cf1..00000000000 --- a/plotly/validators/layout/margin/_autoexpand.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutoexpandValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autoexpand', parent_name='layout.margin', **kwargs - ): - super(AutoexpandValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/margin/_b.py b/plotly/validators/layout/margin/_b.py deleted file mode 100644 index dbe67371f26..00000000000 --- a/plotly/validators/layout/margin/_b.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class BValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='b', parent_name='layout.margin', **kwargs): - super(BValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/margin/_l.py b/plotly/validators/layout/margin/_l.py deleted file mode 100644 index 69170c71e1b..00000000000 --- a/plotly/validators/layout/margin/_l.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class LValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='l', parent_name='layout.margin', **kwargs): - super(LValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/margin/_pad.py b/plotly/validators/layout/margin/_pad.py deleted file mode 100644 index fd5637ea85e..00000000000 --- a/plotly/validators/layout/margin/_pad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class PadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='pad', parent_name='layout.margin', **kwargs - ): - super(PadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/margin/_r.py b/plotly/validators/layout/margin/_r.py deleted file mode 100644 index 511dc811958..00000000000 --- a/plotly/validators/layout/margin/_r.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class RValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='r', parent_name='layout.margin', **kwargs): - super(RValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/margin/_t.py b/plotly/validators/layout/margin/_t.py deleted file mode 100644 index 02ec82aafc9..00000000000 --- a/plotly/validators/layout/margin/_t.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='t', parent_name='layout.margin', **kwargs): - super(TValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/modebar/__init__.py b/plotly/validators/layout/modebar/__init__.py index d5e61a71a4e..1b347f8aaef 100644 --- a/plotly/validators/layout/modebar/__init__.py +++ b/plotly/validators/layout/modebar/__init__.py @@ -1,5 +1,92 @@ -from ._uirevision import UirevisionValidator -from ._orientation import OrientationValidator -from ._color import ColorValidator -from ._bgcolor import BgcolorValidator -from ._activecolor import ActivecolorValidator + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='layout.modebar', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OrientationValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='orientation', + parent_name='layout.modebar', + **kwargs + ): + super(OrientationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'modebar'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['v', 'h']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='layout.modebar', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'modebar'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='layout.modebar', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'modebar'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ActivecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='activecolor', + parent_name='layout.modebar', + **kwargs + ): + super(ActivecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'modebar'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/modebar/_activecolor.py b/plotly/validators/layout/modebar/_activecolor.py deleted file mode 100644 index ed7b6f7adcc..00000000000 --- a/plotly/validators/layout/modebar/_activecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ActivecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='activecolor', - parent_name='layout.modebar', - **kwargs - ): - super(ActivecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'modebar'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/modebar/_bgcolor.py b/plotly/validators/layout/modebar/_bgcolor.py deleted file mode 100644 index 57fe8de3088..00000000000 --- a/plotly/validators/layout/modebar/_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='layout.modebar', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'modebar'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/modebar/_color.py b/plotly/validators/layout/modebar/_color.py deleted file mode 100644 index 66cd66cb943..00000000000 --- a/plotly/validators/layout/modebar/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='layout.modebar', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'modebar'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/modebar/_orientation.py b/plotly/validators/layout/modebar/_orientation.py deleted file mode 100644 index 08cb4db820d..00000000000 --- a/plotly/validators/layout/modebar/_orientation.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OrientationValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='orientation', - parent_name='layout.modebar', - **kwargs - ): - super(OrientationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'modebar'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['v', 'h']), - **kwargs - ) diff --git a/plotly/validators/layout/modebar/_uirevision.py b/plotly/validators/layout/modebar/_uirevision.py deleted file mode 100644 index 2fab6d06afc..00000000000 --- a/plotly/validators/layout/modebar/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='layout.modebar', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/__init__.py b/plotly/validators/layout/polar/__init__.py index 3dac4e6417e..58dd4f22549 100644 --- a/plotly/validators/layout/polar/__init__.py +++ b/plotly/validators/layout/polar/__init__.py @@ -1,10 +1,721 @@ -from ._uirevision import UirevisionValidator -from ._sector import SectorValidator -from ._radialaxis import RadialAxisValidator -from ._hole import HoleValidator -from ._gridshape import GridshapeValidator -from ._domain import DomainValidator -from ._bgcolor import BgcolorValidator -from ._barmode import BarmodeValidator -from ._bargap import BargapValidator -from ._angularaxis import AngularAxisValidator + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='layout.polar', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SectorValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='sector', parent_name='layout.polar', **kwargs + ): + super(SectorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'editType': 'plot' + }, { + 'valType': 'number', + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RadialAxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='radialaxis', parent_name='layout.polar', **kwargs + ): + super(RadialAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'RadialAxis'), + data_docs=kwargs.pop( + 'data_docs', """ + angle + Sets the angle (in degrees) from which the + radial axis is drawn. Note that by default, + radial axis line on the theta=0 line + corresponds to a line pointing right (like what + mathematicians prefer). Defaults to the first + `polar.sector` angle. + autorange + Determines whether or not the range of this + axis is computed in relation to the input data. + See `rangemode` for more info. If `range` is + provided, then `autorange` is set to False. + calendar + Sets the calendar system to use for `range` and + `tick0` if this is a date axis. This does not + set the calendar for interpreting data on this + axis, that's specified in the trace or via the + global `layout.calendar` + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + layer + Sets the layer on which this axis is displayed. + If *above traces*, this axis is displayed above + all the subplot's traces If *below traces*, + this axis is displayed below all the subplot's + traces, but above the grid lines. Useful when + used together with scatter-like traces with + `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + range + Sets the range of this axis. If the axis `type` + is "log", then you must take the log of your + desired range (e.g. to set the range from 1 to + 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, + like date data, though Date objects and unix + milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it + should be numbers, using the scale where each + category is assigned a serial number from zero + in the order it appears. + rangemode + If *tozero*`, the range extends to 0, + regardless of the input data If "nonnegative", + the range is non-negative, regardless of the + input data. If "normal", the range is computed + in relation to the extrema of the input data + (same behavior as for cartesian axes). + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines on which side of radial axis line + the tick and tick labels appear. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.polar.radialaxis.Tickf + ormatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.polar.radialaxis.tickformatstopdefaults), + sets the default property values to use for + elements of + layout.polar.radialaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.polar.radialaxis.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + layout.polar.radialaxis.title.font instead. + Sets this axis' title font. Note that the + title's font used to be customized by the now + deprecated `titlefont` attribute. + type + Sets the axis type. By default, plotly attempts + to determined the axis type by looking into the + data of the traces that referenced the axis in + question. + uirevision + Controls persistence of user-driven changes in + axis `range`, `autorange`, `angle`, and `title` + if in `editable: true` configuration. Defaults + to `polar.uirevision`. + visible + A single toggle to hide the axis while + preserving interaction like dragging. Default + is true when a cheater plot is present on the + axis, otherwise false +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoleValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='hole', parent_name='layout.polar', **kwargs + ): + super(HoleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridshapeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='gridshape', parent_name='layout.polar', **kwargs + ): + super(GridshapeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['circular', 'linear']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='domain', parent_name='layout.polar', **kwargs + ): + super(DomainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Domain'), + data_docs=kwargs.pop( + 'data_docs', """ + column + If there is a layout grid, use the domain for + this column in the grid for this polar subplot + . + row + If there is a layout grid, use the domain for + this row in the grid for this polar subplot . + x + Sets the horizontal domain of this polar + subplot (in plot fraction). + y + Sets the vertical domain of this polar subplot + (in plot fraction). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='layout.polar', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BarmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='barmode', parent_name='layout.polar', **kwargs + ): + super(BarmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['stack', 'overlay']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BargapValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='bargap', parent_name='layout.polar', **kwargs + ): + super(BargapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AngularAxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='angularaxis', parent_name='layout.polar', **kwargs + ): + super(AngularAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'AngularAxis'), + data_docs=kwargs.pop( + 'data_docs', """ + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + direction + Sets the direction corresponding to positive + angles. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + layer + Sets the layer on which this axis is displayed. + If *above traces*, this axis is displayed above + all the subplot's traces If *below traces*, + this axis is displayed below all the subplot's + traces, but above the grid lines. Useful when + used together with scatter-like traces with + `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + period + Set the angular period. Has an effect only when + `angularaxis.type` is "category". + rotation + Sets that start position (in degrees) of the + angular axis By default, polar subplots with + `direction` set to "counterclockwise" get a + `rotation` of 0 which corresponds to 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), + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thetaunit + Sets the format unit of the formatted "theta" + values. Has an effect only when + `angularaxis.type` is "linear". + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.polar.angularaxis.Tick + formatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.polar.angularaxis.tickformatstopdefaults), + sets the default property values to use for + elements of + layout.polar.angularaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + type + Sets the angular axis type. If "linear", set + `thetaunit` to determine the unit in which axis + value are shown. If *category, use `period` to + set the number of integer coordinates around + polar axis. + uirevision + Controls persistence of user-driven changes in + axis `rotation`. Defaults to + `polar.uirevision`. + visible + A single toggle to hide the axis while + preserving interaction like dragging. Default + is true when a cheater plot is present on the + axis, otherwise false +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/polar/_angularaxis.py b/plotly/validators/layout/polar/_angularaxis.py deleted file mode 100644 index c77e2383fff..00000000000 --- a/plotly/validators/layout/polar/_angularaxis.py +++ /dev/null @@ -1,259 +0,0 @@ -import _plotly_utils.basevalidators - - -class AngularAxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='angularaxis', parent_name='layout.polar', **kwargs - ): - super(AngularAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'AngularAxis'), - data_docs=kwargs.pop( - 'data_docs', """ - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - direction - Sets the direction corresponding to positive - angles. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - layer - Sets the layer on which this axis is displayed. - If *above traces*, this axis is displayed above - all the subplot's traces If *below traces*, - this axis is displayed below all the subplot's - traces, but above the grid lines. Useful when - used together with scatter-like traces with - `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - period - Set the angular period. Has an effect only when - `angularaxis.type` is "category". - rotation - Sets that start position (in degrees) of the - angular axis By default, polar subplots with - `direction` set to "counterclockwise" get a - `rotation` of 0 which corresponds to 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), - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thetaunit - Sets the format unit of the formatted "theta" - values. Has an effect only when - `angularaxis.type` is "linear". - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.polar.angularaxis.Tick - formatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.polar.angularaxis.tickformatstopdefaults), - sets the default property values to use for - elements of - layout.polar.angularaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - type - Sets the angular axis type. If "linear", set - `thetaunit` to determine the unit in which axis - value are shown. If *category, use `period` to - set the number of integer coordinates around - polar axis. - uirevision - Controls persistence of user-driven changes in - axis `rotation`. Defaults to - `polar.uirevision`. - visible - A single toggle to hide the axis while - preserving interaction like dragging. Default - is true when a cheater plot is present on the - axis, otherwise false -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/polar/_bargap.py b/plotly/validators/layout/polar/_bargap.py deleted file mode 100644 index a4d7dbf034f..00000000000 --- a/plotly/validators/layout/polar/_bargap.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class BargapValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='bargap', parent_name='layout.polar', **kwargs - ): - super(BargapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/_barmode.py b/plotly/validators/layout/polar/_barmode.py deleted file mode 100644 index 79bb9aa3a9c..00000000000 --- a/plotly/validators/layout/polar/_barmode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BarmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='barmode', parent_name='layout.polar', **kwargs - ): - super(BarmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['stack', 'overlay']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/_bgcolor.py b/plotly/validators/layout/polar/_bgcolor.py deleted file mode 100644 index 9067a8298ce..00000000000 --- a/plotly/validators/layout/polar/_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='layout.polar', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/_domain.py b/plotly/validators/layout/polar/_domain.py deleted file mode 100644 index d3ac3946f42..00000000000 --- a/plotly/validators/layout/polar/_domain.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='domain', parent_name='layout.polar', **kwargs - ): - super(DomainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Domain'), - data_docs=kwargs.pop( - 'data_docs', """ - column - If there is a layout grid, use the domain for - this column in the grid for this polar subplot - . - row - If there is a layout grid, use the domain for - this row in the grid for this polar subplot . - x - Sets the horizontal domain of this polar - subplot (in plot fraction). - y - Sets the vertical domain of this polar subplot - (in plot fraction). -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/polar/_gridshape.py b/plotly/validators/layout/polar/_gridshape.py deleted file mode 100644 index 57f5888d68b..00000000000 --- a/plotly/validators/layout/polar/_gridshape.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridshapeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='gridshape', parent_name='layout.polar', **kwargs - ): - super(GridshapeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['circular', 'linear']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/_hole.py b/plotly/validators/layout/polar/_hole.py deleted file mode 100644 index dc59c845ac0..00000000000 --- a/plotly/validators/layout/polar/_hole.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoleValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='hole', parent_name='layout.polar', **kwargs - ): - super(HoleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/_radialaxis.py b/plotly/validators/layout/polar/_radialaxis.py deleted file mode 100644 index 413be57a4a0..00000000000 --- a/plotly/validators/layout/polar/_radialaxis.py +++ /dev/null @@ -1,289 +0,0 @@ -import _plotly_utils.basevalidators - - -class RadialAxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='radialaxis', parent_name='layout.polar', **kwargs - ): - super(RadialAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'RadialAxis'), - data_docs=kwargs.pop( - 'data_docs', """ - angle - Sets the angle (in degrees) from which the - radial axis is drawn. Note that by default, - radial axis line on the theta=0 line - corresponds to a line pointing right (like what - mathematicians prefer). Defaults to the first - `polar.sector` angle. - autorange - Determines whether or not the range of this - axis is computed in relation to the input data. - See `rangemode` for more info. If `range` is - provided, then `autorange` is set to False. - calendar - Sets the calendar system to use for `range` and - `tick0` if this is a date axis. This does not - set the calendar for interpreting data on this - axis, that's specified in the trace or via the - global `layout.calendar` - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - layer - Sets the layer on which this axis is displayed. - If *above traces*, this axis is displayed above - all the subplot's traces If *below traces*, - this axis is displayed below all the subplot's - traces, but above the grid lines. Useful when - used together with scatter-like traces with - `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - range - Sets the range of this axis. If the axis `type` - is "log", then you must take the log of your - desired range (e.g. to set the range from 1 to - 100, set the range from 0 to 2). If the axis - `type` is "date", it should be date strings, - like date data, though Date objects and unix - milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it - should be numbers, using the scale where each - category is assigned a serial number from zero - in the order it appears. - rangemode - If *tozero*`, the range extends to 0, - regardless of the input data If "nonnegative", - the range is non-negative, regardless of the - input data. If "normal", the range is computed - in relation to the extrema of the input data - (same behavior as for cartesian axes). - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - side - Determines on which side of radial axis line - the tick and tick labels appear. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.polar.radialaxis.Tickf - ormatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.polar.radialaxis.tickformatstopdefaults), - sets the default property values to use for - elements of - layout.polar.radialaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.polar.radialaxis.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - layout.polar.radialaxis.title.font instead. - Sets this axis' title font. Note that the - title's font used to be customized by the now - deprecated `titlefont` attribute. - type - Sets the axis type. By default, plotly attempts - to determined the axis type by looking into the - data of the traces that referenced the axis in - question. - uirevision - Controls persistence of user-driven changes in - axis `range`, `autorange`, `angle`, and `title` - if in `editable: true` configuration. Defaults - to `polar.uirevision`. - visible - A single toggle to hide the axis while - preserving interaction like dragging. Default - is true when a cheater plot is present on the - axis, otherwise false -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/polar/_sector.py b/plotly/validators/layout/polar/_sector.py deleted file mode 100644 index d701b9eb4c3..00000000000 --- a/plotly/validators/layout/polar/_sector.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class SectorValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='sector', parent_name='layout.polar', **kwargs - ): - super(SectorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'editType': 'plot' - }, { - 'valType': 'number', - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/_uirevision.py b/plotly/validators/layout/polar/_uirevision.py deleted file mode 100644 index 69132a6cb5a..00000000000 --- a/plotly/validators/layout/polar/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='layout.polar', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/__init__.py b/plotly/validators/layout/polar/angularaxis/__init__.py index fe3f2a05ae0..a6cf88801f9 100644 --- a/plotly/validators/layout/polar/angularaxis/__init__.py +++ b/plotly/validators/layout/polar/angularaxis/__init__.py @@ -1,44 +1,977 @@ -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._type import TypeValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thetaunit import ThetaunitValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showline import ShowlineValidator -from ._showgrid import ShowgridValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._rotation import RotationValidator -from ._period import PeriodValidator -from ._nticks import NticksValidator -from ._linewidth import LinewidthValidator -from ._linecolor import LinecolorValidator -from ._layer import LayerValidator -from ._hoverformat import HoverformatValidator -from ._gridwidth import GridwidthValidator -from ._gridcolor import GridcolorValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._direction import DirectionValidator -from ._color import ColorValidator -from ._categoryorder import CategoryorderValidator -from ._categoryarraysrc import CategoryarraysrcValidator -from ._categoryarray import CategoryarrayValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='visible', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='uirevision', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='type', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['-', 'linear', 'category']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThetaunitValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thetaunit', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(ThetaunitValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['radians', 'degrees']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showline', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(ShowlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showgrid', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(ShowgridValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RotationValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='rotation', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(RotationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PeriodValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='period', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(PeriodValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='linewidth', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(LinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='linecolor', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(LinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='layer', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(LayerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['above traces', 'below traces']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hoverformat', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(HoverformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='gridwidth', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(GridwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='gridcolor', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(GridcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DirectionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='direction', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(DirectionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['counterclockwise', 'clockwise']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='categoryorder', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(CategoryorderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'trace', 'category ascending', 'category descending', + 'array' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='categoryarraysrc', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(CategoryarraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='categoryarray', + parent_name='layout.polar.angularaxis', + **kwargs + ): + super(CategoryarrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/layout/polar/angularaxis/_categoryarray.py b/plotly/validators/layout/polar/angularaxis/_categoryarray.py deleted file mode 100644 index 3b6c7753ee3..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_categoryarray.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='categoryarray', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(CategoryarrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_categoryarraysrc.py b/plotly/validators/layout/polar/angularaxis/_categoryarraysrc.py deleted file mode 100644 index 59be89af0a1..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_categoryarraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='categoryarraysrc', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(CategoryarraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_categoryorder.py b/plotly/validators/layout/polar/angularaxis/_categoryorder.py deleted file mode 100644 index 5cc950494ff..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_categoryorder.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='categoryorder', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(CategoryorderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'trace', 'category ascending', 'category descending', - 'array' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_color.py b/plotly/validators/layout/polar/angularaxis/_color.py deleted file mode 100644 index a3d96799de0..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_direction.py b/plotly/validators/layout/polar/angularaxis/_direction.py deleted file mode 100644 index 60643adcadc..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_direction.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DirectionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='direction', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(DirectionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['counterclockwise', 'clockwise']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_dtick.py b/plotly/validators/layout/polar/angularaxis/_dtick.py deleted file mode 100644 index d6fdef0a492..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_exponentformat.py b/plotly/validators/layout/polar/angularaxis/_exponentformat.py deleted file mode 100644 index 20c6ff15b7f..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_gridcolor.py b/plotly/validators/layout/polar/angularaxis/_gridcolor.py deleted file mode 100644 index 4006edd74c3..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_gridcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='gridcolor', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(GridcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_gridwidth.py b/plotly/validators/layout/polar/angularaxis/_gridwidth.py deleted file mode 100644 index ea2c9a9391f..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_gridwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='gridwidth', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(GridwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_hoverformat.py b/plotly/validators/layout/polar/angularaxis/_hoverformat.py deleted file mode 100644 index 9ba438eb922..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_hoverformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hoverformat', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(HoverformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_layer.py b/plotly/validators/layout/polar/angularaxis/_layer.py deleted file mode 100644 index fe904f72d19..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_layer.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='layer', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(LayerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['above traces', 'below traces']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_linecolor.py b/plotly/validators/layout/polar/angularaxis/_linecolor.py deleted file mode 100644 index 6cb03784b66..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_linecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='linecolor', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(LinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_linewidth.py b/plotly/validators/layout/polar/angularaxis/_linewidth.py deleted file mode 100644 index c0275af4610..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_linewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='linewidth', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(LinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_nticks.py b/plotly/validators/layout/polar/angularaxis/_nticks.py deleted file mode 100644 index 2ebc54433f9..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_period.py b/plotly/validators/layout/polar/angularaxis/_period.py deleted file mode 100644 index fbf9ba20e6c..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_period.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class PeriodValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='period', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(PeriodValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_rotation.py b/plotly/validators/layout/polar/angularaxis/_rotation.py deleted file mode 100644 index 9cba944ca1f..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_rotation.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class RotationValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='rotation', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(RotationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_separatethousands.py b/plotly/validators/layout/polar/angularaxis/_separatethousands.py deleted file mode 100644 index 555b50928af..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_showexponent.py b/plotly/validators/layout/polar/angularaxis/_showexponent.py deleted file mode 100644 index 2a768bafa02..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_showgrid.py b/plotly/validators/layout/polar/angularaxis/_showgrid.py deleted file mode 100644 index 2a274e23ed9..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_showgrid.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showgrid', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(ShowgridValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_showline.py b/plotly/validators/layout/polar/angularaxis/_showline.py deleted file mode 100644 index 1acc15cf803..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_showline.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showline', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(ShowlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_showticklabels.py b/plotly/validators/layout/polar/angularaxis/_showticklabels.py deleted file mode 100644 index bf1e7a9c04e..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_showtickprefix.py b/plotly/validators/layout/polar/angularaxis/_showtickprefix.py deleted file mode 100644 index ebaba131511..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_showticksuffix.py b/plotly/validators/layout/polar/angularaxis/_showticksuffix.py deleted file mode 100644 index fa4b03e36ef..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_thetaunit.py b/plotly/validators/layout/polar/angularaxis/_thetaunit.py deleted file mode 100644 index 99ebc2b7f78..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_thetaunit.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThetaunitValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thetaunit', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(ThetaunitValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['radians', 'degrees']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_tick0.py b/plotly/validators/layout/polar/angularaxis/_tick0.py deleted file mode 100644 index b4b53718979..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_tickangle.py b/plotly/validators/layout/polar/angularaxis/_tickangle.py deleted file mode 100644 index 3ce11a717a5..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_tickcolor.py b/plotly/validators/layout/polar/angularaxis/_tickcolor.py deleted file mode 100644 index a996059efbc..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_tickfont.py b/plotly/validators/layout/polar/angularaxis/_tickfont.py deleted file mode 100644 index d508aa54c88..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_tickformat.py b/plotly/validators/layout/polar/angularaxis/_tickformat.py deleted file mode 100644 index 4b6a5e6d8e6..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_tickformatstopdefaults.py b/plotly/validators/layout/polar/angularaxis/_tickformatstopdefaults.py deleted file mode 100644 index ad71a3c4b26..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_tickformatstops.py b/plotly/validators/layout/polar/angularaxis/_tickformatstops.py deleted file mode 100644 index a8fd011161f..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_ticklen.py b/plotly/validators/layout/polar/angularaxis/_ticklen.py deleted file mode 100644 index e0a8bf7b296..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_tickmode.py b/plotly/validators/layout/polar/angularaxis/_tickmode.py deleted file mode 100644 index 8dc2fd2e6d9..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_tickprefix.py b/plotly/validators/layout/polar/angularaxis/_tickprefix.py deleted file mode 100644 index a774403d6a2..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_ticks.py b/plotly/validators/layout/polar/angularaxis/_ticks.py deleted file mode 100644 index 8913a5be083..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_ticksuffix.py b/plotly/validators/layout/polar/angularaxis/_ticksuffix.py deleted file mode 100644 index 8ff50ab7054..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_ticktext.py b/plotly/validators/layout/polar/angularaxis/_ticktext.py deleted file mode 100644 index be6f7cfbe7d..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_ticktextsrc.py b/plotly/validators/layout/polar/angularaxis/_ticktextsrc.py deleted file mode 100644 index 3083739a112..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_tickvals.py b/plotly/validators/layout/polar/angularaxis/_tickvals.py deleted file mode 100644 index c8c4ef87a08..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_tickvalssrc.py b/plotly/validators/layout/polar/angularaxis/_tickvalssrc.py deleted file mode 100644 index 5c79f3e87f8..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_tickwidth.py b/plotly/validators/layout/polar/angularaxis/_tickwidth.py deleted file mode 100644 index 5ccd7e1ce21..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_type.py b/plotly/validators/layout/polar/angularaxis/_type.py deleted file mode 100644 index 5eaafc49e37..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_type.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='type', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['-', 'linear', 'category']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_uirevision.py b/plotly/validators/layout/polar/angularaxis/_uirevision.py deleted file mode 100644 index 0e5683f77f6..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_uirevision.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='uirevision', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/_visible.py b/plotly/validators/layout/polar/angularaxis/_visible.py deleted file mode 100644 index 5e718e90b73..00000000000 --- a/plotly/validators/layout/polar/angularaxis/_visible.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='visible', - parent_name='layout.polar.angularaxis', - **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/tickfont/__init__.py b/plotly/validators/layout/polar/angularaxis/tickfont/__init__.py index 199d72e71c6..4193ba494e2 100644 --- a/plotly/validators/layout/polar/angularaxis/tickfont/__init__.py +++ b/plotly/validators/layout/polar/angularaxis/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.polar.angularaxis.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.polar.angularaxis.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.polar.angularaxis.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/polar/angularaxis/tickfont/_color.py b/plotly/validators/layout/polar/angularaxis/tickfont/_color.py deleted file mode 100644 index 68b708a4057..00000000000 --- a/plotly/validators/layout/polar/angularaxis/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.polar.angularaxis.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/tickfont/_family.py b/plotly/validators/layout/polar/angularaxis/tickfont/_family.py deleted file mode 100644 index 50e40cc046d..00000000000 --- a/plotly/validators/layout/polar/angularaxis/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.polar.angularaxis.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/tickfont/_size.py b/plotly/validators/layout/polar/angularaxis/tickfont/_size.py deleted file mode 100644 index 46fa68f11a3..00000000000 --- a/plotly/validators/layout/polar/angularaxis/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.polar.angularaxis.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/tickformatstop/__init__.py b/plotly/validators/layout/polar/angularaxis/tickformatstop/__init__.py index 3f6c06cac47..eee46cdafdf 100644 --- a/plotly/validators/layout/polar/angularaxis/tickformatstop/__init__.py +++ b/plotly/validators/layout/polar/angularaxis/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='layout.polar.angularaxis.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.polar.angularaxis.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='layout.polar.angularaxis.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='layout.polar.angularaxis.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='layout.polar.angularaxis.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'plot' + }, { + 'valType': 'any', + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/polar/angularaxis/tickformatstop/_dtickrange.py b/plotly/validators/layout/polar/angularaxis/tickformatstop/_dtickrange.py deleted file mode 100644 index d030cc4d3bd..00000000000 --- a/plotly/validators/layout/polar/angularaxis/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='layout.polar.angularaxis.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'plot' - }, { - 'valType': 'any', - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/tickformatstop/_enabled.py b/plotly/validators/layout/polar/angularaxis/tickformatstop/_enabled.py deleted file mode 100644 index 10f395d88d6..00000000000 --- a/plotly/validators/layout/polar/angularaxis/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='layout.polar.angularaxis.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/tickformatstop/_name.py b/plotly/validators/layout/polar/angularaxis/tickformatstop/_name.py deleted file mode 100644 index 975913cbbf3..00000000000 --- a/plotly/validators/layout/polar/angularaxis/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='layout.polar.angularaxis.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/tickformatstop/_templateitemname.py b/plotly/validators/layout/polar/angularaxis/tickformatstop/_templateitemname.py deleted file mode 100644 index a66e1a130d2..00000000000 --- a/plotly/validators/layout/polar/angularaxis/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.polar.angularaxis.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/angularaxis/tickformatstop/_value.py b/plotly/validators/layout/polar/angularaxis/tickformatstop/_value.py deleted file mode 100644 index bb2387e07cb..00000000000 --- a/plotly/validators/layout/polar/angularaxis/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='layout.polar.angularaxis.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/domain/__init__.py b/plotly/validators/layout/polar/domain/__init__.py index 6cf32248236..f619999c1b5 100644 --- a/plotly/validators/layout/polar/domain/__init__.py +++ b/plotly/validators/layout/polar/domain/__init__.py @@ -1,4 +1,105 @@ -from ._y import YValidator -from ._x import XValidator -from ._row import RowValidator -from ._column import ColumnValidator + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='y', parent_name='layout.polar.domain', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='x', parent_name='layout.polar.domain', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RowValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='row', parent_name='layout.polar.domain', **kwargs + ): + super(RowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='column', + parent_name='layout.polar.domain', + **kwargs + ): + super(ColumnValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/polar/domain/_column.py b/plotly/validators/layout/polar/domain/_column.py deleted file mode 100644 index 72ff5ee99d1..00000000000 --- a/plotly/validators/layout/polar/domain/_column.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='column', - parent_name='layout.polar.domain', - **kwargs - ): - super(ColumnValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/domain/_row.py b/plotly/validators/layout/polar/domain/_row.py deleted file mode 100644 index 4399a2243bf..00000000000 --- a/plotly/validators/layout/polar/domain/_row.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class RowValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='row', parent_name='layout.polar.domain', **kwargs - ): - super(RowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/domain/_x.py b/plotly/validators/layout/polar/domain/_x.py deleted file mode 100644 index 5f743f4d816..00000000000 --- a/plotly/validators/layout/polar/domain/_x.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='x', parent_name='layout.polar.domain', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/domain/_y.py b/plotly/validators/layout/polar/domain/_y.py deleted file mode 100644 index ede11870afd..00000000000 --- a/plotly/validators/layout/polar/domain/_y.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='y', parent_name='layout.polar.domain', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/__init__.py b/plotly/validators/layout/polar/radialaxis/__init__.py index a1b32fcb156..04eeb906556 100644 --- a/plotly/validators/layout/polar/radialaxis/__init__.py +++ b/plotly/validators/layout/polar/radialaxis/__init__.py @@ -1,47 +1,1081 @@ -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._type import TypeValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._side import SideValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showline import ShowlineValidator -from ._showgrid import ShowgridValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._rangemode import RangemodeValidator -from ._range import RangeValidator -from ._nticks import NticksValidator -from ._linewidth import LinewidthValidator -from ._linecolor import LinecolorValidator -from ._layer import LayerValidator -from ._hoverformat import HoverformatValidator -from ._gridwidth import GridwidthValidator -from ._gridcolor import GridcolorValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._color import ColorValidator -from ._categoryorder import CategoryorderValidator -from ._categoryarraysrc import CategoryarraysrcValidator -from ._categoryarray import CategoryarrayValidator -from ._calendar import CalendarValidator -from ._autorange import AutorangeValidator -from ._angle import AngleValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='visible', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='uirevision', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='type', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['-', 'linear', 'log', 'date', 'category'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this axis' title font. Note that the + title's font used to be customized by the now + deprecated `titlefont` attribute. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['clockwise', 'counterclockwise']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showline', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(ShowlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showgrid', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(ShowgridValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='rangemode', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(RangemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['tozero', 'nonnegative', 'normal']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='range', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(RangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'autorange': False}), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'plot', + 'impliedEdits': { + '^autorange': False + } + }, + { + 'valType': 'any', + 'editType': 'plot', + 'impliedEdits': { + '^autorange': False + } + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='linewidth', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(LinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='linecolor', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(LinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='layer', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(LayerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['above traces', 'below traces']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hoverformat', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(HoverformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='gridwidth', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(GridwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='gridcolor', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(GridcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='categoryorder', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(CategoryorderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'trace', 'category ascending', 'category descending', + 'array' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='categoryarraysrc', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(CategoryarraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='categoryarray', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(CategoryarrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='calendar', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(CalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutorangeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='autorange', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(AutorangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'reversed']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AngleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='angle', + parent_name='layout.polar.radialaxis', + **kwargs + ): + super(AngleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/polar/radialaxis/_angle.py b/plotly/validators/layout/polar/radialaxis/_angle.py deleted file mode 100644 index 838f85682fe..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_angle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class AngleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='angle', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(AngleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_autorange.py b/plotly/validators/layout/polar/radialaxis/_autorange.py deleted file mode 100644 index d5c34f767eb..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_autorange.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutorangeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='autorange', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(AutorangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'reversed']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_calendar.py b/plotly/validators/layout/polar/radialaxis/_calendar.py deleted file mode 100644 index afca12e09df..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_calendar.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class CalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='calendar', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(CalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_categoryarray.py b/plotly/validators/layout/polar/radialaxis/_categoryarray.py deleted file mode 100644 index 46bbb54b695..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_categoryarray.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='categoryarray', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(CategoryarrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_categoryarraysrc.py b/plotly/validators/layout/polar/radialaxis/_categoryarraysrc.py deleted file mode 100644 index 32f77137489..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_categoryarraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='categoryarraysrc', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(CategoryarraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_categoryorder.py b/plotly/validators/layout/polar/radialaxis/_categoryorder.py deleted file mode 100644 index fce3e6024b7..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_categoryorder.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='categoryorder', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(CategoryorderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'trace', 'category ascending', 'category descending', - 'array' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_color.py b/plotly/validators/layout/polar/radialaxis/_color.py deleted file mode 100644 index 0abc1aff804..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_dtick.py b/plotly/validators/layout/polar/radialaxis/_dtick.py deleted file mode 100644 index ab4179abf91..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_exponentformat.py b/plotly/validators/layout/polar/radialaxis/_exponentformat.py deleted file mode 100644 index 3ac9d525581..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_gridcolor.py b/plotly/validators/layout/polar/radialaxis/_gridcolor.py deleted file mode 100644 index fe8b8dd34a0..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_gridcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='gridcolor', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(GridcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_gridwidth.py b/plotly/validators/layout/polar/radialaxis/_gridwidth.py deleted file mode 100644 index 4031604bca0..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_gridwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='gridwidth', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(GridwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_hoverformat.py b/plotly/validators/layout/polar/radialaxis/_hoverformat.py deleted file mode 100644 index 37cbf93bc2f..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_hoverformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hoverformat', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(HoverformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_layer.py b/plotly/validators/layout/polar/radialaxis/_layer.py deleted file mode 100644 index 14d0988c961..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_layer.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='layer', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(LayerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['above traces', 'below traces']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_linecolor.py b/plotly/validators/layout/polar/radialaxis/_linecolor.py deleted file mode 100644 index 3cf3c3533c2..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_linecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='linecolor', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(LinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_linewidth.py b/plotly/validators/layout/polar/radialaxis/_linewidth.py deleted file mode 100644 index 32ab482364c..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_linewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='linewidth', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(LinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_nticks.py b/plotly/validators/layout/polar/radialaxis/_nticks.py deleted file mode 100644 index 5fde38cd4a0..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_range.py b/plotly/validators/layout/polar/radialaxis/_range.py deleted file mode 100644 index 4e982eec7c0..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_range.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='range', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(RangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'autorange': False}), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'plot', - 'impliedEdits': { - '^autorange': False - } - }, - { - 'valType': 'any', - 'editType': 'plot', - 'impliedEdits': { - '^autorange': False - } - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_rangemode.py b/plotly/validators/layout/polar/radialaxis/_rangemode.py deleted file mode 100644 index 69523196059..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_rangemode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='rangemode', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(RangemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['tozero', 'nonnegative', 'normal']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_separatethousands.py b/plotly/validators/layout/polar/radialaxis/_separatethousands.py deleted file mode 100644 index 72ab7c3e9c9..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_showexponent.py b/plotly/validators/layout/polar/radialaxis/_showexponent.py deleted file mode 100644 index 71e51f2356d..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_showgrid.py b/plotly/validators/layout/polar/radialaxis/_showgrid.py deleted file mode 100644 index 06a69caec29..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_showgrid.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showgrid', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(ShowgridValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_showline.py b/plotly/validators/layout/polar/radialaxis/_showline.py deleted file mode 100644 index 9c3a30c724f..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_showline.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showline', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(ShowlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_showticklabels.py b/plotly/validators/layout/polar/radialaxis/_showticklabels.py deleted file mode 100644 index b727610d8df..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_showtickprefix.py b/plotly/validators/layout/polar/radialaxis/_showtickprefix.py deleted file mode 100644 index 6cc7e76cc34..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_showticksuffix.py b/plotly/validators/layout/polar/radialaxis/_showticksuffix.py deleted file mode 100644 index 497a278195b..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_side.py b/plotly/validators/layout/polar/radialaxis/_side.py deleted file mode 100644 index 5fdcfd35918..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['clockwise', 'counterclockwise']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_tick0.py b/plotly/validators/layout/polar/radialaxis/_tick0.py deleted file mode 100644 index 650f67df988..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_tickangle.py b/plotly/validators/layout/polar/radialaxis/_tickangle.py deleted file mode 100644 index 01720cbb8a1..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_tickcolor.py b/plotly/validators/layout/polar/radialaxis/_tickcolor.py deleted file mode 100644 index e8c70a7110e..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_tickfont.py b/plotly/validators/layout/polar/radialaxis/_tickfont.py deleted file mode 100644 index 527708174d8..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_tickformat.py b/plotly/validators/layout/polar/radialaxis/_tickformat.py deleted file mode 100644 index 77db8151bc1..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_tickformatstopdefaults.py b/plotly/validators/layout/polar/radialaxis/_tickformatstopdefaults.py deleted file mode 100644 index 170d853e8ba..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_tickformatstops.py b/plotly/validators/layout/polar/radialaxis/_tickformatstops.py deleted file mode 100644 index 580461acd60..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_ticklen.py b/plotly/validators/layout/polar/radialaxis/_ticklen.py deleted file mode 100644 index 806f4b2e70d..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_tickmode.py b/plotly/validators/layout/polar/radialaxis/_tickmode.py deleted file mode 100644 index b2463e32df0..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_tickprefix.py b/plotly/validators/layout/polar/radialaxis/_tickprefix.py deleted file mode 100644 index 53d598c0c1c..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_ticks.py b/plotly/validators/layout/polar/radialaxis/_ticks.py deleted file mode 100644 index 8ef835685aa..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_ticksuffix.py b/plotly/validators/layout/polar/radialaxis/_ticksuffix.py deleted file mode 100644 index 43c469672e1..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_ticktext.py b/plotly/validators/layout/polar/radialaxis/_ticktext.py deleted file mode 100644 index f042d40ae6a..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_ticktextsrc.py b/plotly/validators/layout/polar/radialaxis/_ticktextsrc.py deleted file mode 100644 index 3c1549484c8..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_tickvals.py b/plotly/validators/layout/polar/radialaxis/_tickvals.py deleted file mode 100644 index 26bd3a52021..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_tickvalssrc.py b/plotly/validators/layout/polar/radialaxis/_tickvalssrc.py deleted file mode 100644 index b8dd5c98cb6..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_tickwidth.py b/plotly/validators/layout/polar/radialaxis/_tickwidth.py deleted file mode 100644 index 638339c5713..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_title.py b/plotly/validators/layout/polar/radialaxis/_title.py deleted file mode 100644 index 82698132dd3..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_title.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this axis' title font. Note that the - title's font used to be customized by the now - deprecated `titlefont` attribute. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_type.py b/plotly/validators/layout/polar/radialaxis/_type.py deleted file mode 100644 index 4f1432fcc30..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_type.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='type', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['-', 'linear', 'log', 'date', 'category'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_uirevision.py b/plotly/validators/layout/polar/radialaxis/_uirevision.py deleted file mode 100644 index 3067a89d285..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_uirevision.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='uirevision', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/_visible.py b/plotly/validators/layout/polar/radialaxis/_visible.py deleted file mode 100644 index f97afbff2a4..00000000000 --- a/plotly/validators/layout/polar/radialaxis/_visible.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='visible', - parent_name='layout.polar.radialaxis', - **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/tickfont/__init__.py b/plotly/validators/layout/polar/radialaxis/tickfont/__init__.py index 199d72e71c6..ff81487d226 100644 --- a/plotly/validators/layout/polar/radialaxis/tickfont/__init__.py +++ b/plotly/validators/layout/polar/radialaxis/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.polar.radialaxis.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.polar.radialaxis.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.polar.radialaxis.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/polar/radialaxis/tickfont/_color.py b/plotly/validators/layout/polar/radialaxis/tickfont/_color.py deleted file mode 100644 index 50f5e70d35b..00000000000 --- a/plotly/validators/layout/polar/radialaxis/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.polar.radialaxis.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/tickfont/_family.py b/plotly/validators/layout/polar/radialaxis/tickfont/_family.py deleted file mode 100644 index 2378a83235c..00000000000 --- a/plotly/validators/layout/polar/radialaxis/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.polar.radialaxis.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/tickfont/_size.py b/plotly/validators/layout/polar/radialaxis/tickfont/_size.py deleted file mode 100644 index 5f16e8da6ea..00000000000 --- a/plotly/validators/layout/polar/radialaxis/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.polar.radialaxis.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/tickformatstop/__init__.py b/plotly/validators/layout/polar/radialaxis/tickformatstop/__init__.py index 3f6c06cac47..b81898289b7 100644 --- a/plotly/validators/layout/polar/radialaxis/tickformatstop/__init__.py +++ b/plotly/validators/layout/polar/radialaxis/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='layout.polar.radialaxis.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.polar.radialaxis.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='layout.polar.radialaxis.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='layout.polar.radialaxis.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='layout.polar.radialaxis.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'plot' + }, { + 'valType': 'any', + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/polar/radialaxis/tickformatstop/_dtickrange.py b/plotly/validators/layout/polar/radialaxis/tickformatstop/_dtickrange.py deleted file mode 100644 index 7011ffac6a4..00000000000 --- a/plotly/validators/layout/polar/radialaxis/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='layout.polar.radialaxis.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'plot' - }, { - 'valType': 'any', - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/tickformatstop/_enabled.py b/plotly/validators/layout/polar/radialaxis/tickformatstop/_enabled.py deleted file mode 100644 index c64b71df6e9..00000000000 --- a/plotly/validators/layout/polar/radialaxis/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='layout.polar.radialaxis.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/tickformatstop/_name.py b/plotly/validators/layout/polar/radialaxis/tickformatstop/_name.py deleted file mode 100644 index 006b8730364..00000000000 --- a/plotly/validators/layout/polar/radialaxis/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='layout.polar.radialaxis.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/tickformatstop/_templateitemname.py b/plotly/validators/layout/polar/radialaxis/tickformatstop/_templateitemname.py deleted file mode 100644 index 12113472dd0..00000000000 --- a/plotly/validators/layout/polar/radialaxis/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.polar.radialaxis.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/tickformatstop/_value.py b/plotly/validators/layout/polar/radialaxis/tickformatstop/_value.py deleted file mode 100644 index 5637442bc65..00000000000 --- a/plotly/validators/layout/polar/radialaxis/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='layout.polar.radialaxis.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/title/__init__.py b/plotly/validators/layout/polar/radialaxis/title/__init__.py index db7b0c34947..760f03e03e8 100644 --- a/plotly/validators/layout/polar/radialaxis/title/__init__.py +++ b/plotly/validators/layout/polar/radialaxis/title/__init__.py @@ -1,2 +1,63 @@ -from ._text import TextValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='layout.polar.radialaxis.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='layout.polar.radialaxis.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/polar/radialaxis/title/_font.py b/plotly/validators/layout/polar/radialaxis/title/_font.py deleted file mode 100644 index ac1064036ed..00000000000 --- a/plotly/validators/layout/polar/radialaxis/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='layout.polar.radialaxis.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/title/_text.py b/plotly/validators/layout/polar/radialaxis/title/_text.py deleted file mode 100644 index 95b13e699c9..00000000000 --- a/plotly/validators/layout/polar/radialaxis/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='layout.polar.radialaxis.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/title/font/__init__.py b/plotly/validators/layout/polar/radialaxis/title/font/__init__.py index 199d72e71c6..c7a4cdb2961 100644 --- a/plotly/validators/layout/polar/radialaxis/title/font/__init__.py +++ b/plotly/validators/layout/polar/radialaxis/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.polar.radialaxis.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.polar.radialaxis.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.polar.radialaxis.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/polar/radialaxis/title/font/_color.py b/plotly/validators/layout/polar/radialaxis/title/font/_color.py deleted file mode 100644 index d1ec6510feb..00000000000 --- a/plotly/validators/layout/polar/radialaxis/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.polar.radialaxis.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/title/font/_family.py b/plotly/validators/layout/polar/radialaxis/title/font/_family.py deleted file mode 100644 index a65931314ca..00000000000 --- a/plotly/validators/layout/polar/radialaxis/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.polar.radialaxis.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/polar/radialaxis/title/font/_size.py b/plotly/validators/layout/polar/radialaxis/title/font/_size.py deleted file mode 100644 index 5186defad9d..00000000000 --- a/plotly/validators/layout/polar/radialaxis/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.polar.radialaxis.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/radialaxis/__init__.py b/plotly/validators/layout/radialaxis/__init__.py index b773a44149f..e61b0b78910 100644 --- a/plotly/validators/layout/radialaxis/__init__.py +++ b/plotly/validators/layout/radialaxis/__init__.py @@ -1,11 +1,239 @@ -from ._visible import VisibleValidator -from ._ticksuffix import TicksuffixValidator -from ._tickorientation import TickorientationValidator -from ._ticklen import TicklenValidator -from ._tickcolor import TickcolorValidator -from ._showticklabels import ShowticklabelsValidator -from ._showline import ShowlineValidator -from ._range import RangeValidator -from ._orientation import OrientationValidator -from ._endpadding import EndpaddingValidator -from ._domain import DomainValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='layout.radialaxis', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='layout.radialaxis', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickorientationValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='tickorientation', + parent_name='layout.radialaxis', + **kwargs + ): + super(TickorientationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['horizontal', 'vertical']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ticklen', parent_name='layout.radialaxis', **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='layout.radialaxis', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='layout.radialaxis', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showline', + parent_name='layout.radialaxis', + **kwargs + ): + super(ShowlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='range', parent_name='layout.radialaxis', **kwargs + ): + super(RangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'editType': 'plot' + }, { + 'valType': 'number', + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OrientationValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='orientation', + parent_name='layout.radialaxis', + **kwargs + ): + super(OrientationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EndpaddingValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='endpadding', + parent_name='layout.radialaxis', + **kwargs + ): + super(EndpaddingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DomainValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='domain', parent_name='layout.radialaxis', **kwargs + ): + super(DomainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/radialaxis/_domain.py b/plotly/validators/layout/radialaxis/_domain.py deleted file mode 100644 index 3289e376ea4..00000000000 --- a/plotly/validators/layout/radialaxis/_domain.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class DomainValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='domain', parent_name='layout.radialaxis', **kwargs - ): - super(DomainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/radialaxis/_endpadding.py b/plotly/validators/layout/radialaxis/_endpadding.py deleted file mode 100644 index 86d12e24203..00000000000 --- a/plotly/validators/layout/radialaxis/_endpadding.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EndpaddingValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='endpadding', - parent_name='layout.radialaxis', - **kwargs - ): - super(EndpaddingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/radialaxis/_orientation.py b/plotly/validators/layout/radialaxis/_orientation.py deleted file mode 100644 index a41823310df..00000000000 --- a/plotly/validators/layout/radialaxis/_orientation.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OrientationValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='orientation', - parent_name='layout.radialaxis', - **kwargs - ): - super(OrientationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/radialaxis/_range.py b/plotly/validators/layout/radialaxis/_range.py deleted file mode 100644 index 4ea65f2e153..00000000000 --- a/plotly/validators/layout/radialaxis/_range.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='range', parent_name='layout.radialaxis', **kwargs - ): - super(RangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'editType': 'plot' - }, { - 'valType': 'number', - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/radialaxis/_showline.py b/plotly/validators/layout/radialaxis/_showline.py deleted file mode 100644 index 41413568e5f..00000000000 --- a/plotly/validators/layout/radialaxis/_showline.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showline', - parent_name='layout.radialaxis', - **kwargs - ): - super(ShowlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/radialaxis/_showticklabels.py b/plotly/validators/layout/radialaxis/_showticklabels.py deleted file mode 100644 index 30530f17bbd..00000000000 --- a/plotly/validators/layout/radialaxis/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='layout.radialaxis', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/radialaxis/_tickcolor.py b/plotly/validators/layout/radialaxis/_tickcolor.py deleted file mode 100644 index 75f22405b47..00000000000 --- a/plotly/validators/layout/radialaxis/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='layout.radialaxis', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/radialaxis/_ticklen.py b/plotly/validators/layout/radialaxis/_ticklen.py deleted file mode 100644 index 66f7672ba33..00000000000 --- a/plotly/validators/layout/radialaxis/_ticklen.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ticklen', parent_name='layout.radialaxis', **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/radialaxis/_tickorientation.py b/plotly/validators/layout/radialaxis/_tickorientation.py deleted file mode 100644 index 62b1dfbe361..00000000000 --- a/plotly/validators/layout/radialaxis/_tickorientation.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickorientationValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='tickorientation', - parent_name='layout.radialaxis', - **kwargs - ): - super(TickorientationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['horizontal', 'vertical']), - **kwargs - ) diff --git a/plotly/validators/layout/radialaxis/_ticksuffix.py b/plotly/validators/layout/radialaxis/_ticksuffix.py deleted file mode 100644 index 0e75e37b871..00000000000 --- a/plotly/validators/layout/radialaxis/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='layout.radialaxis', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/radialaxis/_visible.py b/plotly/validators/layout/radialaxis/_visible.py deleted file mode 100644 index 1cef82489b9..00000000000 --- a/plotly/validators/layout/radialaxis/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='layout.radialaxis', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/__init__.py b/plotly/validators/layout/scene/__init__.py index 587092eb63d..cd1ae72322b 100644 --- a/plotly/validators/layout/scene/__init__.py +++ b/plotly/validators/layout/scene/__init__.py @@ -1,13 +1,1312 @@ -from ._zaxis import ZAxisValidator -from ._yaxis import YAxisValidator -from ._xaxis import XAxisValidator -from ._uirevision import UirevisionValidator -from ._hovermode import HovermodeValidator -from ._dragmode import DragmodeValidator -from ._domain import DomainValidator -from ._camera import CameraValidator -from ._bgcolor import BgcolorValidator -from ._aspectratio import AspectratioValidator -from ._aspectmode import AspectmodeValidator -from ._annotationdefaults import AnnotationValidator -from ._annotations import AnnotationsValidator + + +import _plotly_utils.basevalidators + + +class ZAxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='zaxis', parent_name='layout.scene', **kwargs + ): + super(ZAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ZAxis'), + data_docs=kwargs.pop( + 'data_docs', """ + autorange + Determines whether or not the range of this + axis is computed in relation to the input data. + See `rangemode` for more info. If `range` is + provided, then `autorange` is set to False. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and + `tick0` if this is a date axis. This does not + set the calendar for interpreting data on this + axis, that's specified in the trace or via the + global `layout.calendar` + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + mirror + Determines if the axis lines or/and ticks are + mirrored to the opposite side of the plotting + area. If True, the axis lines are mirrored. If + "ticks", the axis lines and ticks are mirrored. + If False, mirroring is disable. If "all", axis + lines are mirrored on all shared-axes subplots. + If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + range + Sets the range of this axis. If the axis `type` + is "log", then you must take the log of your + desired range (e.g. to set the range from 1 to + 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, + like date data, though Date objects and unix + milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it + should be numbers, using the scale where each + category is assigned a serial number from zero + in the order it appears. + rangemode + If "normal", the range is computed in relation + to the extrema of the input data. If *tozero*`, + the range extends to 0, regardless of the input + data If "nonnegative", the range is non- + negative, regardless of the input data. Applies + only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a + background color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showspikes + Sets whether or not spikes starting from data + points to this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall + boundaries are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.scene.zaxis.Tickformat + stop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.scene.zaxis.tickformatstopdefaults), sets + the default property values to use for elements + of layout.scene.zaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.scene.zaxis.Title + instance or dict with compatible properties + titlefont + 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. + type + Sets the axis type. By default, plotly attempts + to determined the axis type by looking into the + data of the traces that referenced the axis in + question. + visible + A single toggle to hide the axis while + preserving interaction like dragging. Default + is true when a cheater plot is present on the + axis, otherwise false + zeroline + Determines whether or not a line is drawn at + along the 0 value of this axis. If True, the + zero line is drawn on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='yaxis', parent_name='layout.scene', **kwargs + ): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'YAxis'), + data_docs=kwargs.pop( + 'data_docs', """ + autorange + Determines whether or not the range of this + axis is computed in relation to the input data. + See `rangemode` for more info. If `range` is + provided, then `autorange` is set to False. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and + `tick0` if this is a date axis. This does not + set the calendar for interpreting data on this + axis, that's specified in the trace or via the + global `layout.calendar` + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + mirror + Determines if the axis lines or/and ticks are + mirrored to the opposite side of the plotting + area. If True, the axis lines are mirrored. If + "ticks", the axis lines and ticks are mirrored. + If False, mirroring is disable. If "all", axis + lines are mirrored on all shared-axes subplots. + If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + range + Sets the range of this axis. If the axis `type` + is "log", then you must take the log of your + desired range (e.g. to set the range from 1 to + 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, + like date data, though Date objects and unix + milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it + should be numbers, using the scale where each + category is assigned a serial number from zero + in the order it appears. + rangemode + If "normal", the range is computed in relation + to the extrema of the input data. If *tozero*`, + the range extends to 0, regardless of the input + data If "nonnegative", the range is non- + negative, regardless of the input data. Applies + only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a + background color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showspikes + Sets whether or not spikes starting from data + points to this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall + boundaries are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.scene.yaxis.Tickformat + stop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.scene.yaxis.tickformatstopdefaults), sets + the default property values to use for elements + of layout.scene.yaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.scene.yaxis.Title + instance or dict with compatible properties + titlefont + 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. + type + Sets the axis type. By default, plotly attempts + to determined the axis type by looking into the + data of the traces that referenced the axis in + question. + visible + A single toggle to hide the axis while + preserving interaction like dragging. Default + is true when a cheater plot is present on the + axis, otherwise false + zeroline + Determines whether or not a line is drawn at + along the 0 value of this axis. If True, the + zero line is drawn on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='xaxis', parent_name='layout.scene', **kwargs + ): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'XAxis'), + data_docs=kwargs.pop( + 'data_docs', """ + autorange + Determines whether or not the range of this + axis is computed in relation to the input data. + See `rangemode` for more info. If `range` is + provided, then `autorange` is set to False. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and + `tick0` if this is a date axis. This does not + set the calendar for interpreting data on this + axis, that's specified in the trace or via the + global `layout.calendar` + categoryarray + Sets the order in which categories on this axis + appear. Only has an effect if `categoryorder` + is set to "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + mirror + Determines if the axis lines or/and ticks are + mirrored to the opposite side of the plotting + area. If True, the axis lines are mirrored. If + "ticks", the axis lines and ticks are mirrored. + If False, mirroring is disable. If "all", axis + lines are mirrored on all shared-axes subplots. + If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + range + Sets the range of this axis. If the axis `type` + is "log", then you must take the log of your + desired range (e.g. to set the range from 1 to + 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, + like date data, though Date objects and unix + milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it + should be numbers, using the scale where each + category is assigned a serial number from zero + in the order it appears. + rangemode + If "normal", the range is computed in relation + to the extrema of the input data. If *tozero*`, + the range extends to 0, regardless of the input + data If "nonnegative", the range is non- + negative, regardless of the input data. Applies + only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a + background color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showspikes + Sets whether or not spikes starting from data + points to this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall + boundaries are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.scene.xaxis.Tickformat + stop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.scene.xaxis.tickformatstopdefaults), sets + the default property values to use for elements + of layout.scene.xaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.scene.xaxis.Title + instance or dict with compatible properties + titlefont + 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. + type + Sets the axis type. By default, plotly attempts + to determined the axis type by looking into the + data of the traces that referenced the axis in + question. + visible + A single toggle to hide the axis while + preserving interaction like dragging. Default + is true when a cheater plot is present on the + axis, otherwise false + zeroline + Determines whether or not a line is drawn at + along the 0 value of this axis. If True, the + zero line is drawn on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='layout.scene', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovermodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='hovermode', parent_name='layout.scene', **kwargs + ): + super(HovermodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'modebar'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['closest', False]), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DragmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='dragmode', parent_name='layout.scene', **kwargs + ): + super(DragmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['orbit', 'turntable', 'zoom', 'pan', False] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='domain', parent_name='layout.scene', **kwargs + ): + super(DomainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Domain'), + data_docs=kwargs.pop( + 'data_docs', """ + column + If there is a layout grid, use the domain for + this column in the grid for this scene subplot + . + row + If there is a layout grid, use the domain for + this row in the grid for this scene subplot . + x + Sets the horizontal domain of this scene + subplot (in plot fraction). + y + Sets the vertical domain of this scene subplot + (in plot fraction). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CameraValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='camera', parent_name='layout.scene', **kwargs + ): + super(CameraValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Camera'), + data_docs=kwargs.pop( + 'data_docs', """ + center + 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. + eye + Sets the (x,y,z) components of the 'eye' camera + vector. This vector determines the view point + about the origin of this scene. + projection + plotly.graph_objs.layout.scene.camera.Projectio + n instance or dict with compatible properties + up + 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 + that the z axis points up. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='layout.scene', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AspectratioValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='aspectratio', parent_name='layout.scene', **kwargs + ): + super(AspectratioValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Aspectratio'), + data_docs=kwargs.pop( + 'data_docs', """ + x + + y + + z + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AspectmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='aspectmode', parent_name='layout.scene', **kwargs + ): + super(AspectmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'cube', 'data', 'manual']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AnnotationValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='annotationdefaults', + parent_name='layout.scene', + **kwargs + ): + super(AnnotationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Annotation'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AnnotationsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, plotly_name='annotations', parent_name='layout.scene', **kwargs + ): + super(AnnotationsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Annotation'), + data_docs=kwargs.pop( + 'data_docs', """ + align + Sets the horizontal alignment of the `text` + within the box. Has an effect only if `text` + spans more two or more lines (i.e. `text` + contains one or more
HTML tags) or if an + explicit width is set to override the text + width. + arrowcolor + Sets the color of the annotation arrow. + arrowhead + Sets the end annotation arrow head style. + arrowside + Sets the annotation arrow head position. + arrowsize + Sets the size of the end annotation arrow head, + relative to `arrowwidth`. A value of 1 + (default) gives a head about 3x as wide as the + line. + arrowwidth + Sets the width (in px) of annotation arrow + line. + ax + Sets the x component of the arrow tail about + the arrow head (in pixels). + ay + Sets the y component of the arrow tail about + the arrow head (in pixels). + bgcolor + Sets the background color of the annotation. + bordercolor + Sets the color of the border enclosing the + annotation `text`. + borderpad + Sets the padding (in px) between the `text` and + the enclosing border. + borderwidth + Sets the width (in px) of the border enclosing + the annotation `text`. + captureevents + Determines whether the annotation text box + captures mouse move and click events, or allows + those events to pass through to data points in + the plot that may be behind the annotation. By + default `captureevents` is False unless + `hovertext` is provided. If you use the event + `plotly_clickannotation` without `hovertext` + you must explicitly enable `captureevents`. + font + Sets the annotation text font. + height + Sets an explicit height for the text box. null + (default) lets the text set the box height. + Taller text will be clipped. + hoverlabel + plotly.graph_objs.layout.scene.annotation.Hover + label instance or dict with compatible + properties + hovertext + Sets text to appear when hovering over this + annotation. If omitted or blank, no hover label + will appear. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + opacity + Sets the opacity of the annotation (text + + arrow). + showarrow + Determines whether or not the annotation is + drawn with an arrow. If True, `text` is placed + near the arrow's tail. If False, `text` lines + up with the `x` and `y` provided. + standoff + Sets a distance, in pixels, to move the end + arrowhead away from the position it is pointing + at, for example to point at the edge of a + marker independent of zoom. Note that this + shortens the arrow from the `ax` / `ay` vector, + in contrast to `xshift` / `yshift` which moves + everything by this amount. + startarrowhead + Sets the start annotation arrow head style. + startarrowsize + Sets the size of the start annotation arrow + head, relative to `arrowwidth`. A value of 1 + (default) gives a head about 3x as wide as the + line. + startstandoff + Sets a distance, in pixels, to move the start + arrowhead away from the position it is pointing + at, for example to point at the edge of a + marker independent of zoom. Note that this + shortens the arrow from the `ax` / `ay` vector, + in contrast to `xshift` / `yshift` which moves + everything by this amount. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + text + Sets the text associated with this annotation. + Plotly uses a subset of HTML tags to do things + like newline (
), bold (), italics + (), hyperlinks (). + Tags , , are also + supported. + textangle + Sets the angle at which the `text` is drawn + with respect to the horizontal. + valign + Sets the vertical alignment of the `text` + within the box. Has an effect only if an + explicit height is set to override the text + height. + visible + Determines whether or not this annotation is + visible. + width + Sets an explicit width for the text box. null + (default) lets the text set the box width. + Wider text will be clipped. There is no + automatic wrapping; use
to start a new + line. + x + Sets the annotation's x position. + xanchor + Sets the text box's horizontal position anchor + This anchor binds the `x` position to the + "left", "center" or "right" of the annotation. + For example, if `x` is set to 1, `xref` to + "paper" and `xanchor` to "right" then the + right-most portion of the annotation lines up + with the right-most edge of the plotting area. + If "auto", the anchor is equivalent to "center" + for data-referenced annotations or if there is + an arrow, whereas for paper-referenced with no + arrow, the anchor picked corresponds to the + closest side. + xshift + Shifts the position of the whole annotation and + arrow to the right (positive) or left + (negative) by this many pixels. + y + Sets the annotation's y position. + yanchor + Sets the text box's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the annotation. + For example, if `y` is set to 1, `yref` to + "paper" and `yanchor` to "top" then the top- + most portion of the annotation lines up with + the top-most edge of the plotting area. If + "auto", the anchor is equivalent to "middle" + for data-referenced annotations or if there is + an arrow, whereas for paper-referenced with no + arrow, the anchor picked corresponds to the + closest side. + yshift + Shifts the position of the whole annotation and + arrow up (positive) or down (negative) by this + many pixels. + z + Sets the annotation's z position. +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/scene/_annotationdefaults.py b/plotly/validators/layout/scene/_annotationdefaults.py deleted file mode 100644 index 811cf1c9a6e..00000000000 --- a/plotly/validators/layout/scene/_annotationdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AnnotationValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='annotationdefaults', - parent_name='layout.scene', - **kwargs - ): - super(AnnotationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Annotation'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/scene/_annotations.py b/plotly/validators/layout/scene/_annotations.py deleted file mode 100644 index c06c6ead0dd..00000000000 --- a/plotly/validators/layout/scene/_annotations.py +++ /dev/null @@ -1,197 +0,0 @@ -import _plotly_utils.basevalidators - - -class AnnotationsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, plotly_name='annotations', parent_name='layout.scene', **kwargs - ): - super(AnnotationsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Annotation'), - data_docs=kwargs.pop( - 'data_docs', """ - align - Sets the horizontal alignment of the `text` - within the box. Has an effect only if `text` - spans more two or more lines (i.e. `text` - contains one or more
HTML tags) or if an - explicit width is set to override the text - width. - arrowcolor - Sets the color of the annotation arrow. - arrowhead - Sets the end annotation arrow head style. - arrowside - Sets the annotation arrow head position. - arrowsize - Sets the size of the end annotation arrow head, - relative to `arrowwidth`. A value of 1 - (default) gives a head about 3x as wide as the - line. - arrowwidth - Sets the width (in px) of annotation arrow - line. - ax - Sets the x component of the arrow tail about - the arrow head (in pixels). - ay - Sets the y component of the arrow tail about - the arrow head (in pixels). - bgcolor - Sets the background color of the annotation. - bordercolor - Sets the color of the border enclosing the - annotation `text`. - borderpad - Sets the padding (in px) between the `text` and - the enclosing border. - borderwidth - Sets the width (in px) of the border enclosing - the annotation `text`. - captureevents - Determines whether the annotation text box - captures mouse move and click events, or allows - those events to pass through to data points in - the plot that may be behind the annotation. By - default `captureevents` is False unless - `hovertext` is provided. If you use the event - `plotly_clickannotation` without `hovertext` - you must explicitly enable `captureevents`. - font - Sets the annotation text font. - height - Sets an explicit height for the text box. null - (default) lets the text set the box height. - Taller text will be clipped. - hoverlabel - plotly.graph_objs.layout.scene.annotation.Hover - label instance or dict with compatible - properties - hovertext - Sets text to appear when hovering over this - annotation. If omitted or blank, no hover label - will appear. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - opacity - Sets the opacity of the annotation (text + - arrow). - showarrow - Determines whether or not the annotation is - drawn with an arrow. If True, `text` is placed - near the arrow's tail. If False, `text` lines - up with the `x` and `y` provided. - standoff - Sets a distance, in pixels, to move the end - arrowhead away from the position it is pointing - at, for example to point at the edge of a - marker independent of zoom. Note that this - shortens the arrow from the `ax` / `ay` vector, - in contrast to `xshift` / `yshift` which moves - everything by this amount. - startarrowhead - Sets the start annotation arrow head style. - startarrowsize - Sets the size of the start annotation arrow - head, relative to `arrowwidth`. A value of 1 - (default) gives a head about 3x as wide as the - line. - startstandoff - Sets a distance, in pixels, to move the start - arrowhead away from the position it is pointing - at, for example to point at the edge of a - marker independent of zoom. Note that this - shortens the arrow from the `ax` / `ay` vector, - in contrast to `xshift` / `yshift` which moves - everything by this amount. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - text - Sets the text associated with this annotation. - Plotly uses a subset of HTML tags to do things - like newline (
), bold (), italics - (), hyperlinks (). - Tags , , are also - supported. - textangle - Sets the angle at which the `text` is drawn - with respect to the horizontal. - valign - Sets the vertical alignment of the `text` - within the box. Has an effect only if an - explicit height is set to override the text - height. - visible - Determines whether or not this annotation is - visible. - width - Sets an explicit width for the text box. null - (default) lets the text set the box width. - Wider text will be clipped. There is no - automatic wrapping; use
to start a new - line. - x - Sets the annotation's x position. - xanchor - Sets the text box's horizontal position anchor - This anchor binds the `x` position to the - "left", "center" or "right" of the annotation. - For example, if `x` is set to 1, `xref` to - "paper" and `xanchor` to "right" then the - right-most portion of the annotation lines up - with the right-most edge of the plotting area. - If "auto", the anchor is equivalent to "center" - for data-referenced annotations or if there is - an arrow, whereas for paper-referenced with no - arrow, the anchor picked corresponds to the - closest side. - xshift - Shifts the position of the whole annotation and - arrow to the right (positive) or left - (negative) by this many pixels. - y - Sets the annotation's y position. - yanchor - Sets the text box's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the annotation. - For example, if `y` is set to 1, `yref` to - "paper" and `yanchor` to "top" then the top- - most portion of the annotation lines up with - the top-most edge of the plotting area. If - "auto", the anchor is equivalent to "middle" - for data-referenced annotations or if there is - an arrow, whereas for paper-referenced with no - arrow, the anchor picked corresponds to the - closest side. - yshift - Shifts the position of the whole annotation and - arrow up (positive) or down (negative) by this - many pixels. - z - Sets the annotation's z position. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/_aspectmode.py b/plotly/validators/layout/scene/_aspectmode.py deleted file mode 100644 index 5243c89b57e..00000000000 --- a/plotly/validators/layout/scene/_aspectmode.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class AspectmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='aspectmode', parent_name='layout.scene', **kwargs - ): - super(AspectmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'cube', 'data', 'manual']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/_aspectratio.py b/plotly/validators/layout/scene/_aspectratio.py deleted file mode 100644 index e7252eede3f..00000000000 --- a/plotly/validators/layout/scene/_aspectratio.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class AspectratioValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='aspectratio', parent_name='layout.scene', **kwargs - ): - super(AspectratioValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Aspectratio'), - data_docs=kwargs.pop( - 'data_docs', """ - x - - y - - z - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/_bgcolor.py b/plotly/validators/layout/scene/_bgcolor.py deleted file mode 100644 index e28f5c3fc62..00000000000 --- a/plotly/validators/layout/scene/_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='layout.scene', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/_camera.py b/plotly/validators/layout/scene/_camera.py deleted file mode 100644 index bfc8414a5c2..00000000000 --- a/plotly/validators/layout/scene/_camera.py +++ /dev/null @@ -1,37 +0,0 @@ -import _plotly_utils.basevalidators - - -class CameraValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='camera', parent_name='layout.scene', **kwargs - ): - super(CameraValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Camera'), - data_docs=kwargs.pop( - 'data_docs', """ - center - 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. - eye - Sets the (x,y,z) components of the 'eye' camera - vector. This vector determines the view point - about the origin of this scene. - projection - plotly.graph_objs.layout.scene.camera.Projectio - n instance or dict with compatible properties - up - 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 - that the z axis points up. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/_domain.py b/plotly/validators/layout/scene/_domain.py deleted file mode 100644 index d93066d2d64..00000000000 --- a/plotly/validators/layout/scene/_domain.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='domain', parent_name='layout.scene', **kwargs - ): - super(DomainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Domain'), - data_docs=kwargs.pop( - 'data_docs', """ - column - If there is a layout grid, use the domain for - this column in the grid for this scene subplot - . - row - If there is a layout grid, use the domain for - this row in the grid for this scene subplot . - x - Sets the horizontal domain of this scene - subplot (in plot fraction). - y - Sets the vertical domain of this scene subplot - (in plot fraction). -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/_dragmode.py b/plotly/validators/layout/scene/_dragmode.py deleted file mode 100644 index 0c67850d48e..00000000000 --- a/plotly/validators/layout/scene/_dragmode.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class DragmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='dragmode', parent_name='layout.scene', **kwargs - ): - super(DragmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['orbit', 'turntable', 'zoom', 'pan', False] - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/_hovermode.py b/plotly/validators/layout/scene/_hovermode.py deleted file mode 100644 index 63a64eb4a52..00000000000 --- a/plotly/validators/layout/scene/_hovermode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovermodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='hovermode', parent_name='layout.scene', **kwargs - ): - super(HovermodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'modebar'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['closest', False]), - **kwargs - ) diff --git a/plotly/validators/layout/scene/_uirevision.py b/plotly/validators/layout/scene/_uirevision.py deleted file mode 100644 index 23c134f1ab4..00000000000 --- a/plotly/validators/layout/scene/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='layout.scene', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/_xaxis.py b/plotly/validators/layout/scene/_xaxis.py deleted file mode 100644 index 40f073580c2..00000000000 --- a/plotly/validators/layout/scene/_xaxis.py +++ /dev/null @@ -1,299 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='xaxis', parent_name='layout.scene', **kwargs - ): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'XAxis'), - data_docs=kwargs.pop( - 'data_docs', """ - autorange - Determines whether or not the range of this - axis is computed in relation to the input data. - See `rangemode` for more info. If `range` is - provided, then `autorange` is set to False. - backgroundcolor - Sets the background color of this axis' wall. - calendar - Sets the calendar system to use for `range` and - `tick0` if this is a date axis. This does not - set the calendar for interpreting data on this - axis, that's specified in the trace or via the - global `layout.calendar` - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - mirror - Determines if the axis lines or/and ticks are - mirrored to the opposite side of the plotting - area. If True, the axis lines are mirrored. If - "ticks", the axis lines and ticks are mirrored. - If False, mirroring is disable. If "all", axis - lines are mirrored on all shared-axes subplots. - If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - range - Sets the range of this axis. If the axis `type` - is "log", then you must take the log of your - desired range (e.g. to set the range from 1 to - 100, set the range from 0 to 2). If the axis - `type` is "date", it should be date strings, - like date data, though Date objects and unix - milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it - should be numbers, using the scale where each - category is assigned a serial number from zero - in the order it appears. - rangemode - If "normal", the range is computed in relation - to the extrema of the input data. If *tozero*`, - the range extends to 0, regardless of the input - data If "nonnegative", the range is non- - negative, regardless of the input data. Applies - only to linear axes. - separatethousands - If "true", even 4-digit integers are separated - showaxeslabels - Sets whether or not this axis is labeled - showbackground - Sets whether or not this axis' wall has a - background color. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showspikes - Sets whether or not spikes starting from data - points to this axis' wall are shown on hover. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - spikecolor - Sets the color of the spikes. - spikesides - Sets whether or not spikes extending from the - projection data points to this axis' wall - boundaries are shown on hover. - spikethickness - Sets the thickness (in px) of the spikes. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.scene.xaxis.Tickformat - stop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.scene.xaxis.tickformatstopdefaults), sets - the default property values to use for elements - of layout.scene.xaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.scene.xaxis.Title - instance or dict with compatible properties - titlefont - 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. - type - Sets the axis type. By default, plotly attempts - to determined the axis type by looking into the - data of the traces that referenced the axis in - question. - visible - A single toggle to hide the axis while - preserving interaction like dragging. Default - is true when a cheater plot is present on the - axis, otherwise false - zeroline - Determines whether or not a line is drawn at - along the 0 value of this axis. If True, the - zero line is drawn on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/_yaxis.py b/plotly/validators/layout/scene/_yaxis.py deleted file mode 100644 index 02241a2b993..00000000000 --- a/plotly/validators/layout/scene/_yaxis.py +++ /dev/null @@ -1,299 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='yaxis', parent_name='layout.scene', **kwargs - ): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'YAxis'), - data_docs=kwargs.pop( - 'data_docs', """ - autorange - Determines whether or not the range of this - axis is computed in relation to the input data. - See `rangemode` for more info. If `range` is - provided, then `autorange` is set to False. - backgroundcolor - Sets the background color of this axis' wall. - calendar - Sets the calendar system to use for `range` and - `tick0` if this is a date axis. This does not - set the calendar for interpreting data on this - axis, that's specified in the trace or via the - global `layout.calendar` - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - mirror - Determines if the axis lines or/and ticks are - mirrored to the opposite side of the plotting - area. If True, the axis lines are mirrored. If - "ticks", the axis lines and ticks are mirrored. - If False, mirroring is disable. If "all", axis - lines are mirrored on all shared-axes subplots. - If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - range - Sets the range of this axis. If the axis `type` - is "log", then you must take the log of your - desired range (e.g. to set the range from 1 to - 100, set the range from 0 to 2). If the axis - `type` is "date", it should be date strings, - like date data, though Date objects and unix - milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it - should be numbers, using the scale where each - category is assigned a serial number from zero - in the order it appears. - rangemode - If "normal", the range is computed in relation - to the extrema of the input data. If *tozero*`, - the range extends to 0, regardless of the input - data If "nonnegative", the range is non- - negative, regardless of the input data. Applies - only to linear axes. - separatethousands - If "true", even 4-digit integers are separated - showaxeslabels - Sets whether or not this axis is labeled - showbackground - Sets whether or not this axis' wall has a - background color. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showspikes - Sets whether or not spikes starting from data - points to this axis' wall are shown on hover. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - spikecolor - Sets the color of the spikes. - spikesides - Sets whether or not spikes extending from the - projection data points to this axis' wall - boundaries are shown on hover. - spikethickness - Sets the thickness (in px) of the spikes. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.scene.yaxis.Tickformat - stop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.scene.yaxis.tickformatstopdefaults), sets - the default property values to use for elements - of layout.scene.yaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.scene.yaxis.Title - instance or dict with compatible properties - titlefont - 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. - type - Sets the axis type. By default, plotly attempts - to determined the axis type by looking into the - data of the traces that referenced the axis in - question. - visible - A single toggle to hide the axis while - preserving interaction like dragging. Default - is true when a cheater plot is present on the - axis, otherwise false - zeroline - Determines whether or not a line is drawn at - along the 0 value of this axis. If True, the - zero line is drawn on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/_zaxis.py b/plotly/validators/layout/scene/_zaxis.py deleted file mode 100644 index b7629ed4fed..00000000000 --- a/plotly/validators/layout/scene/_zaxis.py +++ /dev/null @@ -1,299 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZAxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='zaxis', parent_name='layout.scene', **kwargs - ): - super(ZAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ZAxis'), - data_docs=kwargs.pop( - 'data_docs', """ - autorange - Determines whether or not the range of this - axis is computed in relation to the input data. - See `rangemode` for more info. If `range` is - provided, then `autorange` is set to False. - backgroundcolor - Sets the background color of this axis' wall. - calendar - Sets the calendar system to use for `range` and - `tick0` if this is a date axis. This does not - set the calendar for interpreting data on this - axis, that's specified in the trace or via the - global `layout.calendar` - categoryarray - Sets the order in which categories on this axis - appear. Only has an effect if `categoryorder` - is set to "array". Used with `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the case of - categorical variables. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - mirror - Determines if the axis lines or/and ticks are - mirrored to the opposite side of the plotting - area. If True, the axis lines are mirrored. If - "ticks", the axis lines and ticks are mirrored. - If False, mirroring is disable. If "all", axis - lines are mirrored on all shared-axes subplots. - If "allticks", axis lines and ticks are - mirrored on all shared-axes subplots. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - range - Sets the range of this axis. If the axis `type` - is "log", then you must take the log of your - desired range (e.g. to set the range from 1 to - 100, set the range from 0 to 2). If the axis - `type` is "date", it should be date strings, - like date data, though Date objects and unix - milliseconds will be accepted and converted to - strings. If the axis `type` is "category", it - should be numbers, using the scale where each - category is assigned a serial number from zero - in the order it appears. - rangemode - If "normal", the range is computed in relation - to the extrema of the input data. If *tozero*`, - the range extends to 0, regardless of the input - data If "nonnegative", the range is non- - negative, regardless of the input data. Applies - only to linear axes. - separatethousands - If "true", even 4-digit integers are separated - showaxeslabels - Sets whether or not this axis is labeled - showbackground - Sets whether or not this axis' wall has a - background color. - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showspikes - Sets whether or not spikes starting from data - points to this axis' wall are shown on hover. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - spikecolor - Sets the color of the spikes. - spikesides - Sets whether or not spikes extending from the - projection data points to this axis' wall - boundaries are shown on hover. - spikethickness - Sets the thickness (in px) of the spikes. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.scene.zaxis.Tickformat - stop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.scene.zaxis.tickformatstopdefaults), sets - the default property values to use for elements - of layout.scene.zaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.scene.zaxis.Title - instance or dict with compatible properties - titlefont - 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. - type - Sets the axis type. By default, plotly attempts - to determined the axis type by looking into the - data of the traces that referenced the axis in - question. - visible - A single toggle to hide the axis while - preserving interaction like dragging. Default - is true when a cheater plot is present on the - axis, otherwise false - zeroline - Determines whether or not a line is drawn at - along the 0 value of this axis. If True, the - zero line is drawn on top of the grid lines. - zerolinecolor - Sets the line color of the zero line. - zerolinewidth - Sets the width (in px) of the zero line. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/__init__.py b/plotly/validators/layout/scene/annotation/__init__.py index 55b283d3939..dc4559605d4 100644 --- a/plotly/validators/layout/scene/annotation/__init__.py +++ b/plotly/validators/layout/scene/annotation/__init__.py @@ -1,37 +1,790 @@ -from ._z import ZValidator -from ._yshift import YshiftValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xshift import XshiftValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._valign import ValignValidator -from ._textangle import TextangleValidator -from ._text import TextValidator -from ._templateitemname import TemplateitemnameValidator -from ._startstandoff import StartstandoffValidator -from ._startarrowsize import StartarrowsizeValidator -from ._startarrowhead import StartarrowheadValidator -from ._standoff import StandoffValidator -from ._showarrow import ShowarrowValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._hovertext import HovertextValidator -from ._hoverlabel import HoverlabelValidator -from ._height import HeightValidator -from ._font import FontValidator -from ._captureevents import CaptureeventsValidator -from ._borderwidth import BorderwidthValidator -from ._borderpad import BorderpadValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator -from ._ay import AyValidator -from ._ax import AxValidator -from ._arrowwidth import ArrowwidthValidator -from ._arrowsize import ArrowsizeValidator -from ._arrowside import ArrowsideValidator -from ._arrowhead import ArrowheadValidator -from ._arrowcolor import ArrowcolorValidator -from ._align import AlignValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='z', parent_name='layout.scene.annotation', **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YshiftValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='yshift', + parent_name='layout.scene.annotation', + **kwargs + ): + super(YshiftValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='layout.scene.annotation', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='y', parent_name='layout.scene.annotation', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XshiftValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xshift', + parent_name='layout.scene.annotation', + **kwargs + ): + super(XshiftValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='layout.scene.annotation', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='x', parent_name='layout.scene.annotation', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='layout.scene.annotation', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='visible', + parent_name='layout.scene.annotation', + **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValignValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='valign', + parent_name='layout.scene.annotation', + **kwargs + ): + super(ValignValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='textangle', + parent_name='layout.scene.annotation', + **kwargs + ): + super(TextangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='layout.scene.annotation', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.scene.annotation', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StartstandoffValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='startstandoff', + parent_name='layout.scene.annotation', + **kwargs + ): + super(StartstandoffValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StartarrowsizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='startarrowsize', + parent_name='layout.scene.annotation', + **kwargs + ): + super(StartarrowsizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0.3), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StartarrowheadValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='startarrowhead', + parent_name='layout.scene.annotation', + **kwargs + ): + super(StartarrowheadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 8), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StandoffValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='standoff', + parent_name='layout.scene.annotation', + **kwargs + ): + super(StandoffValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowarrowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showarrow', + parent_name='layout.scene.annotation', + **kwargs + ): + super(ShowarrowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='layout.scene.annotation', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='layout.scene.annotation', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hovertext', + parent_name='layout.scene.annotation', + **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='hoverlabel', + parent_name='layout.scene.annotation', + **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover label. + By default uses the annotation's `bgcolor` made + opaque, or white if it was transparent. + bordercolor + Sets the border color of the hover label. By + default uses either dark grey or white, for + maximum contrast with `hoverlabel.bgcolor`. + font + Sets the hover label text font. By default uses + the global hover font and size, with color from + `hoverlabel.bordercolor`. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HeightValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='height', + parent_name='layout.scene.annotation', + **kwargs + ): + super(HeightValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='layout.scene.annotation', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CaptureeventsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='captureevents', + parent_name='layout.scene.annotation', + **kwargs + ): + super(CaptureeventsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='layout.scene.annotation', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderpad', + parent_name='layout.scene.annotation', + **kwargs + ): + super(BorderpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='layout.scene.annotation', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='layout.scene.annotation', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AyValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ay', + parent_name='layout.scene.annotation', + **kwargs + ): + super(AyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ax', + parent_name='layout.scene.annotation', + **kwargs + ): + super(AxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrowwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='arrowwidth', + parent_name='layout.scene.annotation', + **kwargs + ): + super(ArrowwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0.1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrowsizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='arrowsize', + parent_name='layout.scene.annotation', + **kwargs + ): + super(ArrowsizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0.3), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrowsideValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, + plotly_name='arrowside', + parent_name='layout.scene.annotation', + **kwargs + ): + super(ArrowsideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['none']), + flags=kwargs.pop('flags', ['end', 'start']), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrowheadValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='arrowhead', + parent_name='layout.scene.annotation', + **kwargs + ): + super(ArrowheadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 8), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrowcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='arrowcolor', + parent_name='layout.scene.annotation', + **kwargs + ): + super(ArrowcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AlignValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='align', + parent_name='layout.scene.annotation', + **kwargs + ): + super(AlignValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) diff --git a/plotly/validators/layout/scene/annotation/_align.py b/plotly/validators/layout/scene/annotation/_align.py deleted file mode 100644 index cea14814a2c..00000000000 --- a/plotly/validators/layout/scene/annotation/_align.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AlignValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='align', - parent_name='layout.scene.annotation', - **kwargs - ): - super(AlignValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_arrowcolor.py b/plotly/validators/layout/scene/annotation/_arrowcolor.py deleted file mode 100644 index a3604c6f3c5..00000000000 --- a/plotly/validators/layout/scene/annotation/_arrowcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrowcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='arrowcolor', - parent_name='layout.scene.annotation', - **kwargs - ): - super(ArrowcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_arrowhead.py b/plotly/validators/layout/scene/annotation/_arrowhead.py deleted file mode 100644 index bd3fd2e62c0..00000000000 --- a/plotly/validators/layout/scene/annotation/_arrowhead.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrowheadValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='arrowhead', - parent_name='layout.scene.annotation', - **kwargs - ): - super(ArrowheadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 8), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_arrowside.py b/plotly/validators/layout/scene/annotation/_arrowside.py deleted file mode 100644 index 8e605e76abb..00000000000 --- a/plotly/validators/layout/scene/annotation/_arrowside.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrowsideValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, - plotly_name='arrowside', - parent_name='layout.scene.annotation', - **kwargs - ): - super(ArrowsideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['none']), - flags=kwargs.pop('flags', ['end', 'start']), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_arrowsize.py b/plotly/validators/layout/scene/annotation/_arrowsize.py deleted file mode 100644 index 560823bb749..00000000000 --- a/plotly/validators/layout/scene/annotation/_arrowsize.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrowsizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='arrowsize', - parent_name='layout.scene.annotation', - **kwargs - ): - super(ArrowsizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0.3), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_arrowwidth.py b/plotly/validators/layout/scene/annotation/_arrowwidth.py deleted file mode 100644 index e195aa95687..00000000000 --- a/plotly/validators/layout/scene/annotation/_arrowwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrowwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='arrowwidth', - parent_name='layout.scene.annotation', - **kwargs - ): - super(ArrowwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0.1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_ax.py b/plotly/validators/layout/scene/annotation/_ax.py deleted file mode 100644 index 10222e9a5c0..00000000000 --- a/plotly/validators/layout/scene/annotation/_ax.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class AxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ax', - parent_name='layout.scene.annotation', - **kwargs - ): - super(AxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_ay.py b/plotly/validators/layout/scene/annotation/_ay.py deleted file mode 100644 index 0535eb065d6..00000000000 --- a/plotly/validators/layout/scene/annotation/_ay.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class AyValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ay', - parent_name='layout.scene.annotation', - **kwargs - ): - super(AyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_bgcolor.py b/plotly/validators/layout/scene/annotation/_bgcolor.py deleted file mode 100644 index 24f1005848c..00000000000 --- a/plotly/validators/layout/scene/annotation/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='layout.scene.annotation', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_bordercolor.py b/plotly/validators/layout/scene/annotation/_bordercolor.py deleted file mode 100644 index 6978caaeec6..00000000000 --- a/plotly/validators/layout/scene/annotation/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='layout.scene.annotation', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_borderpad.py b/plotly/validators/layout/scene/annotation/_borderpad.py deleted file mode 100644 index b3a0d47c117..00000000000 --- a/plotly/validators/layout/scene/annotation/_borderpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderpad', - parent_name='layout.scene.annotation', - **kwargs - ): - super(BorderpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_borderwidth.py b/plotly/validators/layout/scene/annotation/_borderwidth.py deleted file mode 100644 index 2f39dbed553..00000000000 --- a/plotly/validators/layout/scene/annotation/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='layout.scene.annotation', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_captureevents.py b/plotly/validators/layout/scene/annotation/_captureevents.py deleted file mode 100644 index 05720954501..00000000000 --- a/plotly/validators/layout/scene/annotation/_captureevents.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CaptureeventsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='captureevents', - parent_name='layout.scene.annotation', - **kwargs - ): - super(CaptureeventsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_font.py b/plotly/validators/layout/scene/annotation/_font.py deleted file mode 100644 index 157f5e88ad2..00000000000 --- a/plotly/validators/layout/scene/annotation/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='layout.scene.annotation', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_height.py b/plotly/validators/layout/scene/annotation/_height.py deleted file mode 100644 index c27529eec61..00000000000 --- a/plotly/validators/layout/scene/annotation/_height.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class HeightValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='height', - parent_name='layout.scene.annotation', - **kwargs - ): - super(HeightValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_hoverlabel.py b/plotly/validators/layout/scene/annotation/_hoverlabel.py deleted file mode 100644 index 110bbc32413..00000000000 --- a/plotly/validators/layout/scene/annotation/_hoverlabel.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='hoverlabel', - parent_name='layout.scene.annotation', - **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover label. - By default uses the annotation's `bgcolor` made - opaque, or white if it was transparent. - bordercolor - Sets the border color of the hover label. By - default uses either dark grey or white, for - maximum contrast with `hoverlabel.bgcolor`. - font - Sets the hover label text font. By default uses - the global hover font and size, with color from - `hoverlabel.bordercolor`. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_hovertext.py b/plotly/validators/layout/scene/annotation/_hovertext.py deleted file mode 100644 index 8a4a0407606..00000000000 --- a/plotly/validators/layout/scene/annotation/_hovertext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hovertext', - parent_name='layout.scene.annotation', - **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_name.py b/plotly/validators/layout/scene/annotation/_name.py deleted file mode 100644 index f375d401c7f..00000000000 --- a/plotly/validators/layout/scene/annotation/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='layout.scene.annotation', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_opacity.py b/plotly/validators/layout/scene/annotation/_opacity.py deleted file mode 100644 index 5d40ea746dd..00000000000 --- a/plotly/validators/layout/scene/annotation/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='layout.scene.annotation', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_showarrow.py b/plotly/validators/layout/scene/annotation/_showarrow.py deleted file mode 100644 index 3c2f1fc1df4..00000000000 --- a/plotly/validators/layout/scene/annotation/_showarrow.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowarrowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showarrow', - parent_name='layout.scene.annotation', - **kwargs - ): - super(ShowarrowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_standoff.py b/plotly/validators/layout/scene/annotation/_standoff.py deleted file mode 100644 index 15d60509b44..00000000000 --- a/plotly/validators/layout/scene/annotation/_standoff.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class StandoffValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='standoff', - parent_name='layout.scene.annotation', - **kwargs - ): - super(StandoffValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_startarrowhead.py b/plotly/validators/layout/scene/annotation/_startarrowhead.py deleted file mode 100644 index 62dd5a258b1..00000000000 --- a/plotly/validators/layout/scene/annotation/_startarrowhead.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartarrowheadValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='startarrowhead', - parent_name='layout.scene.annotation', - **kwargs - ): - super(StartarrowheadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 8), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_startarrowsize.py b/plotly/validators/layout/scene/annotation/_startarrowsize.py deleted file mode 100644 index 7f98e50a938..00000000000 --- a/plotly/validators/layout/scene/annotation/_startarrowsize.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartarrowsizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='startarrowsize', - parent_name='layout.scene.annotation', - **kwargs - ): - super(StartarrowsizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0.3), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_startstandoff.py b/plotly/validators/layout/scene/annotation/_startstandoff.py deleted file mode 100644 index 7f789acbd32..00000000000 --- a/plotly/validators/layout/scene/annotation/_startstandoff.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartstandoffValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='startstandoff', - parent_name='layout.scene.annotation', - **kwargs - ): - super(StartstandoffValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_templateitemname.py b/plotly/validators/layout/scene/annotation/_templateitemname.py deleted file mode 100644 index cb4154ad410..00000000000 --- a/plotly/validators/layout/scene/annotation/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.scene.annotation', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_text.py b/plotly/validators/layout/scene/annotation/_text.py deleted file mode 100644 index 6135de2869f..00000000000 --- a/plotly/validators/layout/scene/annotation/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='layout.scene.annotation', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_textangle.py b/plotly/validators/layout/scene/annotation/_textangle.py deleted file mode 100644 index bdea7ea1af1..00000000000 --- a/plotly/validators/layout/scene/annotation/_textangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='textangle', - parent_name='layout.scene.annotation', - **kwargs - ): - super(TextangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_valign.py b/plotly/validators/layout/scene/annotation/_valign.py deleted file mode 100644 index 350c633a6ab..00000000000 --- a/plotly/validators/layout/scene/annotation/_valign.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValignValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='valign', - parent_name='layout.scene.annotation', - **kwargs - ): - super(ValignValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_visible.py b/plotly/validators/layout/scene/annotation/_visible.py deleted file mode 100644 index ecb7fcb4ebc..00000000000 --- a/plotly/validators/layout/scene/annotation/_visible.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='visible', - parent_name='layout.scene.annotation', - **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_width.py b/plotly/validators/layout/scene/annotation/_width.py deleted file mode 100644 index aeb65b26c5c..00000000000 --- a/plotly/validators/layout/scene/annotation/_width.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='layout.scene.annotation', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_x.py b/plotly/validators/layout/scene/annotation/_x.py deleted file mode 100644 index 1259e945d59..00000000000 --- a/plotly/validators/layout/scene/annotation/_x.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='x', parent_name='layout.scene.annotation', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_xanchor.py b/plotly/validators/layout/scene/annotation/_xanchor.py deleted file mode 100644 index 300e05a1d73..00000000000 --- a/plotly/validators/layout/scene/annotation/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='layout.scene.annotation', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_xshift.py b/plotly/validators/layout/scene/annotation/_xshift.py deleted file mode 100644 index 42399f20d7a..00000000000 --- a/plotly/validators/layout/scene/annotation/_xshift.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class XshiftValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xshift', - parent_name='layout.scene.annotation', - **kwargs - ): - super(XshiftValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_y.py b/plotly/validators/layout/scene/annotation/_y.py deleted file mode 100644 index dced2e8bec5..00000000000 --- a/plotly/validators/layout/scene/annotation/_y.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='y', parent_name='layout.scene.annotation', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_yanchor.py b/plotly/validators/layout/scene/annotation/_yanchor.py deleted file mode 100644 index c31ea7d8a51..00000000000 --- a/plotly/validators/layout/scene/annotation/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='layout.scene.annotation', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_yshift.py b/plotly/validators/layout/scene/annotation/_yshift.py deleted file mode 100644 index 385e19fa0e9..00000000000 --- a/plotly/validators/layout/scene/annotation/_yshift.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class YshiftValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='yshift', - parent_name='layout.scene.annotation', - **kwargs - ): - super(YshiftValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/_z.py b/plotly/validators/layout/scene/annotation/_z.py deleted file mode 100644 index 37d34d1b8f7..00000000000 --- a/plotly/validators/layout/scene/annotation/_z.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='z', parent_name='layout.scene.annotation', **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/font/__init__.py b/plotly/validators/layout/scene/annotation/font/__init__.py index 199d72e71c6..6e29b809dc3 100644 --- a/plotly/validators/layout/scene/annotation/font/__init__.py +++ b/plotly/validators/layout/scene/annotation/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.scene.annotation.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.scene.annotation.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.scene.annotation.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/annotation/font/_color.py b/plotly/validators/layout/scene/annotation/font/_color.py deleted file mode 100644 index 0ff7f85be3e..00000000000 --- a/plotly/validators/layout/scene/annotation/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.scene.annotation.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/font/_family.py b/plotly/validators/layout/scene/annotation/font/_family.py deleted file mode 100644 index c79a0e844b7..00000000000 --- a/plotly/validators/layout/scene/annotation/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.scene.annotation.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/font/_size.py b/plotly/validators/layout/scene/annotation/font/_size.py deleted file mode 100644 index 586c76dc294..00000000000 --- a/plotly/validators/layout/scene/annotation/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.scene.annotation.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/hoverlabel/__init__.py b/plotly/validators/layout/scene/annotation/hoverlabel/__init__.py index 8a3e67d64aa..5bb6e0f4978 100644 --- a/plotly/validators/layout/scene/annotation/hoverlabel/__init__.py +++ b/plotly/validators/layout/scene/annotation/hoverlabel/__init__.py @@ -1,3 +1,83 @@ -from ._font import FontValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='layout.scene.annotation.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='layout.scene.annotation.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='layout.scene.annotation.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/annotation/hoverlabel/_bgcolor.py b/plotly/validators/layout/scene/annotation/hoverlabel/_bgcolor.py deleted file mode 100644 index faba50de438..00000000000 --- a/plotly/validators/layout/scene/annotation/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='layout.scene.annotation.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/hoverlabel/_bordercolor.py b/plotly/validators/layout/scene/annotation/hoverlabel/_bordercolor.py deleted file mode 100644 index d9d472f2fbd..00000000000 --- a/plotly/validators/layout/scene/annotation/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='layout.scene.annotation.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/hoverlabel/_font.py b/plotly/validators/layout/scene/annotation/hoverlabel/_font.py deleted file mode 100644 index a3e47a07d9e..00000000000 --- a/plotly/validators/layout/scene/annotation/hoverlabel/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='layout.scene.annotation.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/hoverlabel/font/__init__.py b/plotly/validators/layout/scene/annotation/hoverlabel/font/__init__.py index 199d72e71c6..8866b4eaa32 100644 --- a/plotly/validators/layout/scene/annotation/hoverlabel/font/__init__.py +++ b/plotly/validators/layout/scene/annotation/hoverlabel/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.scene.annotation.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.scene.annotation.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.scene.annotation.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/annotation/hoverlabel/font/_color.py b/plotly/validators/layout/scene/annotation/hoverlabel/font/_color.py deleted file mode 100644 index 716fa909b7b..00000000000 --- a/plotly/validators/layout/scene/annotation/hoverlabel/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.scene.annotation.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/hoverlabel/font/_family.py b/plotly/validators/layout/scene/annotation/hoverlabel/font/_family.py deleted file mode 100644 index 0dd197495fa..00000000000 --- a/plotly/validators/layout/scene/annotation/hoverlabel/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.scene.annotation.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/scene/annotation/hoverlabel/font/_size.py b/plotly/validators/layout/scene/annotation/hoverlabel/font/_size.py deleted file mode 100644 index be5f13a33c4..00000000000 --- a/plotly/validators/layout/scene/annotation/hoverlabel/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.scene.annotation.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/aspectratio/__init__.py b/plotly/validators/layout/scene/aspectratio/__init__.py index 438e2dc9c6d..96cbece504b 100644 --- a/plotly/validators/layout/scene/aspectratio/__init__.py +++ b/plotly/validators/layout/scene/aspectratio/__init__.py @@ -1,3 +1,72 @@ -from ._z import ZValidator -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='z', + parent_name='layout.scene.aspectratio', + **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop( + 'implied_edits', {'^aspectmode': 'manual'} + ), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='y', + parent_name='layout.scene.aspectratio', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop( + 'implied_edits', {'^aspectmode': 'manual'} + ), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='x', + parent_name='layout.scene.aspectratio', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop( + 'implied_edits', {'^aspectmode': 'manual'} + ), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/aspectratio/_x.py b/plotly/validators/layout/scene/aspectratio/_x.py deleted file mode 100644 index d78575d0e47..00000000000 --- a/plotly/validators/layout/scene/aspectratio/_x.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='x', - parent_name='layout.scene.aspectratio', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop( - 'implied_edits', {'^aspectmode': 'manual'} - ), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/aspectratio/_y.py b/plotly/validators/layout/scene/aspectratio/_y.py deleted file mode 100644 index 24d8b338f38..00000000000 --- a/plotly/validators/layout/scene/aspectratio/_y.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='y', - parent_name='layout.scene.aspectratio', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop( - 'implied_edits', {'^aspectmode': 'manual'} - ), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/aspectratio/_z.py b/plotly/validators/layout/scene/aspectratio/_z.py deleted file mode 100644 index daf52e879d1..00000000000 --- a/plotly/validators/layout/scene/aspectratio/_z.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='z', - parent_name='layout.scene.aspectratio', - **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop( - 'implied_edits', {'^aspectmode': 'manual'} - ), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/camera/__init__.py b/plotly/validators/layout/scene/camera/__init__.py index 5670d748fe5..79f470e86b2 100644 --- a/plotly/validators/layout/scene/camera/__init__.py +++ b/plotly/validators/layout/scene/camera/__init__.py @@ -1,4 +1,108 @@ -from ._up import UpValidator -from ._projection import ProjectionValidator -from ._eye import EyeValidator -from ._center import CenterValidator + + +import _plotly_utils.basevalidators + + +class UpValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='up', parent_name='layout.scene.camera', **kwargs + ): + super(UpValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Up'), + data_docs=kwargs.pop( + 'data_docs', """ + x + + y + + z + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ProjectionValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='projection', + parent_name='layout.scene.camera', + **kwargs + ): + super(ProjectionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Projection'), + data_docs=kwargs.pop( + 'data_docs', """ + type + Sets the projection type. The projection type + could be either "perspective" or + "orthographic". The default is "perspective". +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EyeValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='eye', parent_name='layout.scene.camera', **kwargs + ): + super(EyeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Eye'), + data_docs=kwargs.pop( + 'data_docs', """ + x + + y + + z + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CenterValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='center', + parent_name='layout.scene.camera', + **kwargs + ): + super(CenterValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Center'), + data_docs=kwargs.pop( + 'data_docs', """ + x + + y + + z + +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/scene/camera/_center.py b/plotly/validators/layout/scene/camera/_center.py deleted file mode 100644 index fa99ebcd50b..00000000000 --- a/plotly/validators/layout/scene/camera/_center.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class CenterValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='center', - parent_name='layout.scene.camera', - **kwargs - ): - super(CenterValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Center'), - data_docs=kwargs.pop( - 'data_docs', """ - x - - y - - z - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/camera/_eye.py b/plotly/validators/layout/scene/camera/_eye.py deleted file mode 100644 index eb4e0fd667b..00000000000 --- a/plotly/validators/layout/scene/camera/_eye.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class EyeValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='eye', parent_name='layout.scene.camera', **kwargs - ): - super(EyeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Eye'), - data_docs=kwargs.pop( - 'data_docs', """ - x - - y - - z - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/camera/_projection.py b/plotly/validators/layout/scene/camera/_projection.py deleted file mode 100644 index a1758a512a1..00000000000 --- a/plotly/validators/layout/scene/camera/_projection.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class ProjectionValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='projection', - parent_name='layout.scene.camera', - **kwargs - ): - super(ProjectionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Projection'), - data_docs=kwargs.pop( - 'data_docs', """ - type - Sets the projection type. The projection type - could be either "perspective" or - "orthographic". The default is "perspective". -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/camera/_up.py b/plotly/validators/layout/scene/camera/_up.py deleted file mode 100644 index c024198a0df..00000000000 --- a/plotly/validators/layout/scene/camera/_up.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class UpValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='up', parent_name='layout.scene.camera', **kwargs - ): - super(UpValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Up'), - data_docs=kwargs.pop( - 'data_docs', """ - x - - y - - z - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/camera/center/__init__.py b/plotly/validators/layout/scene/camera/center/__init__.py index 438e2dc9c6d..0366935cb42 100644 --- a/plotly/validators/layout/scene/camera/center/__init__.py +++ b/plotly/validators/layout/scene/camera/center/__init__.py @@ -1,3 +1,60 @@ -from ._z import ZValidator -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='z', + parent_name='layout.scene.camera.center', + **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'camera'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='y', + parent_name='layout.scene.camera.center', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'camera'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='x', + parent_name='layout.scene.camera.center', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'camera'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/camera/center/_x.py b/plotly/validators/layout/scene/camera/center/_x.py deleted file mode 100644 index aa9e0608f31..00000000000 --- a/plotly/validators/layout/scene/camera/center/_x.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='x', - parent_name='layout.scene.camera.center', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'camera'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/camera/center/_y.py b/plotly/validators/layout/scene/camera/center/_y.py deleted file mode 100644 index 6048ec73a3f..00000000000 --- a/plotly/validators/layout/scene/camera/center/_y.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='y', - parent_name='layout.scene.camera.center', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'camera'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/camera/center/_z.py b/plotly/validators/layout/scene/camera/center/_z.py deleted file mode 100644 index aa35a11ed33..00000000000 --- a/plotly/validators/layout/scene/camera/center/_z.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='z', - parent_name='layout.scene.camera.center', - **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'camera'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/camera/eye/__init__.py b/plotly/validators/layout/scene/camera/eye/__init__.py index 438e2dc9c6d..773d46ff21e 100644 --- a/plotly/validators/layout/scene/camera/eye/__init__.py +++ b/plotly/validators/layout/scene/camera/eye/__init__.py @@ -1,3 +1,51 @@ -from ._z import ZValidator -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='z', parent_name='layout.scene.camera.eye', **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'camera'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='layout.scene.camera.eye', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'camera'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='layout.scene.camera.eye', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'camera'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/camera/eye/_x.py b/plotly/validators/layout/scene/camera/eye/_x.py deleted file mode 100644 index e7b873c238b..00000000000 --- a/plotly/validators/layout/scene/camera/eye/_x.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='layout.scene.camera.eye', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'camera'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/camera/eye/_y.py b/plotly/validators/layout/scene/camera/eye/_y.py deleted file mode 100644 index c8f0b8b6ec1..00000000000 --- a/plotly/validators/layout/scene/camera/eye/_y.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='layout.scene.camera.eye', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'camera'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/camera/eye/_z.py b/plotly/validators/layout/scene/camera/eye/_z.py deleted file mode 100644 index b770a106b3e..00000000000 --- a/plotly/validators/layout/scene/camera/eye/_z.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='z', parent_name='layout.scene.camera.eye', **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'camera'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/camera/projection/__init__.py b/plotly/validators/layout/scene/camera/projection/__init__.py index 37ac7f69123..a9ecc280f10 100644 --- a/plotly/validators/layout/scene/camera/projection/__init__.py +++ b/plotly/validators/layout/scene/camera/projection/__init__.py @@ -1 +1,21 @@ -from ._type import TypeValidator + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='type', + parent_name='layout.scene.camera.projection', + **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['perspective', 'orthographic']), + **kwargs + ) diff --git a/plotly/validators/layout/scene/camera/projection/_type.py b/plotly/validators/layout/scene/camera/projection/_type.py deleted file mode 100644 index 67fa194c583..00000000000 --- a/plotly/validators/layout/scene/camera/projection/_type.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='type', - parent_name='layout.scene.camera.projection', - **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['perspective', 'orthographic']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/camera/up/__init__.py b/plotly/validators/layout/scene/camera/up/__init__.py index 438e2dc9c6d..c447b50aa4d 100644 --- a/plotly/validators/layout/scene/camera/up/__init__.py +++ b/plotly/validators/layout/scene/camera/up/__init__.py @@ -1,3 +1,51 @@ -from ._z import ZValidator -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='z', parent_name='layout.scene.camera.up', **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'camera'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='layout.scene.camera.up', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'camera'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='layout.scene.camera.up', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'camera'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/camera/up/_x.py b/plotly/validators/layout/scene/camera/up/_x.py deleted file mode 100644 index e93d7bbce75..00000000000 --- a/plotly/validators/layout/scene/camera/up/_x.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='layout.scene.camera.up', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'camera'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/camera/up/_y.py b/plotly/validators/layout/scene/camera/up/_y.py deleted file mode 100644 index 3dd1cd49d48..00000000000 --- a/plotly/validators/layout/scene/camera/up/_y.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='layout.scene.camera.up', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'camera'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/camera/up/_z.py b/plotly/validators/layout/scene/camera/up/_z.py deleted file mode 100644 index f8327c06178..00000000000 --- a/plotly/validators/layout/scene/camera/up/_z.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='z', parent_name='layout.scene.camera.up', **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'camera'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/domain/__init__.py b/plotly/validators/layout/scene/domain/__init__.py index 6cf32248236..a54a3ef4452 100644 --- a/plotly/validators/layout/scene/domain/__init__.py +++ b/plotly/validators/layout/scene/domain/__init__.py @@ -1,4 +1,105 @@ -from ._y import YValidator -from ._x import XValidator -from ._row import RowValidator -from ._column import ColumnValidator + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='y', parent_name='layout.scene.domain', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='x', parent_name='layout.scene.domain', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RowValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='row', parent_name='layout.scene.domain', **kwargs + ): + super(RowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='column', + parent_name='layout.scene.domain', + **kwargs + ): + super(ColumnValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/domain/_column.py b/plotly/validators/layout/scene/domain/_column.py deleted file mode 100644 index 29bd3175292..00000000000 --- a/plotly/validators/layout/scene/domain/_column.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='column', - parent_name='layout.scene.domain', - **kwargs - ): - super(ColumnValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/domain/_row.py b/plotly/validators/layout/scene/domain/_row.py deleted file mode 100644 index b9026038eca..00000000000 --- a/plotly/validators/layout/scene/domain/_row.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class RowValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='row', parent_name='layout.scene.domain', **kwargs - ): - super(RowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/domain/_x.py b/plotly/validators/layout/scene/domain/_x.py deleted file mode 100644 index 903377dc399..00000000000 --- a/plotly/validators/layout/scene/domain/_x.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='x', parent_name='layout.scene.domain', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/domain/_y.py b/plotly/validators/layout/scene/domain/_y.py deleted file mode 100644 index ef25c9143ee..00000000000 --- a/plotly/validators/layout/scene/domain/_y.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='y', parent_name='layout.scene.domain', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/__init__.py b/plotly/validators/layout/scene/xaxis/__init__.py index fdd72c76306..19b3f491f13 100644 --- a/plotly/validators/layout/scene/xaxis/__init__.py +++ b/plotly/validators/layout/scene/xaxis/__init__.py @@ -1,54 +1,1196 @@ -from ._zerolinewidth import ZerolinewidthValidator -from ._zerolinecolor import ZerolinecolorValidator -from ._zeroline import ZerolineValidator -from ._visible import VisibleValidator -from ._type import TypeValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._spikethickness import SpikethicknessValidator -from ._spikesides import SpikesidesValidator -from ._spikecolor import SpikecolorValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showspikes import ShowspikesValidator -from ._showline import ShowlineValidator -from ._showgrid import ShowgridValidator -from ._showexponent import ShowexponentValidator -from ._showbackground import ShowbackgroundValidator -from ._showaxeslabels import ShowaxeslabelsValidator -from ._separatethousands import SeparatethousandsValidator -from ._rangemode import RangemodeValidator -from ._range import RangeValidator -from ._nticks import NticksValidator -from ._mirror import MirrorValidator -from ._linewidth import LinewidthValidator -from ._linecolor import LinecolorValidator -from ._hoverformat import HoverformatValidator -from ._gridwidth import GridwidthValidator -from ._gridcolor import GridcolorValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._color import ColorValidator -from ._categoryorder import CategoryorderValidator -from ._categoryarraysrc import CategoryarraysrcValidator -from ._categoryarray import CategoryarrayValidator -from ._calendar import CalendarValidator -from ._backgroundcolor import BackgroundcolorValidator -from ._autorange import AutorangeValidator + + +import _plotly_utils.basevalidators + + +class ZerolinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='zerolinewidth', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(ZerolinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZerolinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='zerolinecolor', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(ZerolinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZerolineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='zeroline', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(ZerolineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='visible', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='layout.scene.xaxis', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['-', 'linear', 'log', 'date', 'category'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='layout.scene.xaxis', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this axis' title font. Note that the + title's font used to be customized by the now + deprecated `titlefont` attribute. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ticks', parent_name='layout.scene.xaxis', **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='tick0', parent_name='layout.scene.xaxis', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikethicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='spikethickness', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(SpikethicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikesidesValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='spikesides', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(SpikesidesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='spikecolor', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(SpikecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowspikesValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showspikes', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(ShowspikesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showline', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(ShowlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showgrid', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(ShowgridValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowbackgroundValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showbackground', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(ShowbackgroundValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowaxeslabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showaxeslabels', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(ShowaxeslabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='rangemode', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(RangemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['normal', 'tozero', 'nonnegative']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='range', parent_name='layout.scene.xaxis', **kwargs + ): + super(RangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', False), + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'autorange': False}), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'plot', + 'impliedEdits': { + '^autorange': False + } + }, + { + 'valType': 'any', + 'editType': 'plot', + 'impliedEdits': { + '^autorange': False + } + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nticks', parent_name='layout.scene.xaxis', **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MirrorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='mirror', parent_name='layout.scene.xaxis', **kwargs + ): + super(MirrorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [True, 'ticks', False, 'all', 'allticks'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='linewidth', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(LinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='linecolor', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(LinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hoverformat', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(HoverformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='gridwidth', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(GridwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='gridcolor', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(GridcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='dtick', parent_name='layout.scene.xaxis', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='layout.scene.xaxis', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='categoryorder', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(CategoryorderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'trace', 'category ascending', 'category descending', + 'array' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='categoryarraysrc', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(CategoryarraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='categoryarray', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(CategoryarrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='calendar', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(CalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BackgroundcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='backgroundcolor', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(BackgroundcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutorangeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='autorange', + parent_name='layout.scene.xaxis', + **kwargs + ): + super(AutorangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'reversed']), + **kwargs + ) diff --git a/plotly/validators/layout/scene/xaxis/_autorange.py b/plotly/validators/layout/scene/xaxis/_autorange.py deleted file mode 100644 index 53f05d66c3b..00000000000 --- a/plotly/validators/layout/scene/xaxis/_autorange.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutorangeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='autorange', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(AutorangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'reversed']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_backgroundcolor.py b/plotly/validators/layout/scene/xaxis/_backgroundcolor.py deleted file mode 100644 index f3f4eb91c5a..00000000000 --- a/plotly/validators/layout/scene/xaxis/_backgroundcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BackgroundcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='backgroundcolor', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(BackgroundcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_calendar.py b/plotly/validators/layout/scene/xaxis/_calendar.py deleted file mode 100644 index 42b0b02570f..00000000000 --- a/plotly/validators/layout/scene/xaxis/_calendar.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class CalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='calendar', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(CalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_categoryarray.py b/plotly/validators/layout/scene/xaxis/_categoryarray.py deleted file mode 100644 index dd7f67b3917..00000000000 --- a/plotly/validators/layout/scene/xaxis/_categoryarray.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='categoryarray', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(CategoryarrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_categoryarraysrc.py b/plotly/validators/layout/scene/xaxis/_categoryarraysrc.py deleted file mode 100644 index 09abd035367..00000000000 --- a/plotly/validators/layout/scene/xaxis/_categoryarraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='categoryarraysrc', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(CategoryarraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_categoryorder.py b/plotly/validators/layout/scene/xaxis/_categoryorder.py deleted file mode 100644 index a37915acd42..00000000000 --- a/plotly/validators/layout/scene/xaxis/_categoryorder.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='categoryorder', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(CategoryorderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'trace', 'category ascending', 'category descending', - 'array' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_color.py b/plotly/validators/layout/scene/xaxis/_color.py deleted file mode 100644 index 62a31d4b99f..00000000000 --- a/plotly/validators/layout/scene/xaxis/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='layout.scene.xaxis', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_dtick.py b/plotly/validators/layout/scene/xaxis/_dtick.py deleted file mode 100644 index 42302d814d2..00000000000 --- a/plotly/validators/layout/scene/xaxis/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='dtick', parent_name='layout.scene.xaxis', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_exponentformat.py b/plotly/validators/layout/scene/xaxis/_exponentformat.py deleted file mode 100644 index 92dc4195678..00000000000 --- a/plotly/validators/layout/scene/xaxis/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_gridcolor.py b/plotly/validators/layout/scene/xaxis/_gridcolor.py deleted file mode 100644 index 2a783e0897e..00000000000 --- a/plotly/validators/layout/scene/xaxis/_gridcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='gridcolor', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(GridcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_gridwidth.py b/plotly/validators/layout/scene/xaxis/_gridwidth.py deleted file mode 100644 index 7f31e0f37b8..00000000000 --- a/plotly/validators/layout/scene/xaxis/_gridwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='gridwidth', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(GridwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_hoverformat.py b/plotly/validators/layout/scene/xaxis/_hoverformat.py deleted file mode 100644 index 5cc743a6076..00000000000 --- a/plotly/validators/layout/scene/xaxis/_hoverformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hoverformat', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(HoverformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_linecolor.py b/plotly/validators/layout/scene/xaxis/_linecolor.py deleted file mode 100644 index 862b0307aef..00000000000 --- a/plotly/validators/layout/scene/xaxis/_linecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='linecolor', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(LinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_linewidth.py b/plotly/validators/layout/scene/xaxis/_linewidth.py deleted file mode 100644 index 84bd3e8643c..00000000000 --- a/plotly/validators/layout/scene/xaxis/_linewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='linewidth', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(LinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_mirror.py b/plotly/validators/layout/scene/xaxis/_mirror.py deleted file mode 100644 index a3087f98e39..00000000000 --- a/plotly/validators/layout/scene/xaxis/_mirror.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class MirrorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='mirror', parent_name='layout.scene.xaxis', **kwargs - ): - super(MirrorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [True, 'ticks', False, 'all', 'allticks'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_nticks.py b/plotly/validators/layout/scene/xaxis/_nticks.py deleted file mode 100644 index ec92220d43b..00000000000 --- a/plotly/validators/layout/scene/xaxis/_nticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nticks', parent_name='layout.scene.xaxis', **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_range.py b/plotly/validators/layout/scene/xaxis/_range.py deleted file mode 100644 index e45df3dca32..00000000000 --- a/plotly/validators/layout/scene/xaxis/_range.py +++ /dev/null @@ -1,35 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='range', parent_name='layout.scene.xaxis', **kwargs - ): - super(RangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', False), - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'autorange': False}), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'plot', - 'impliedEdits': { - '^autorange': False - } - }, - { - 'valType': 'any', - 'editType': 'plot', - 'impliedEdits': { - '^autorange': False - } - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_rangemode.py b/plotly/validators/layout/scene/xaxis/_rangemode.py deleted file mode 100644 index d4ea73d8535..00000000000 --- a/plotly/validators/layout/scene/xaxis/_rangemode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='rangemode', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(RangemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['normal', 'tozero', 'nonnegative']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_separatethousands.py b/plotly/validators/layout/scene/xaxis/_separatethousands.py deleted file mode 100644 index 85944d3be83..00000000000 --- a/plotly/validators/layout/scene/xaxis/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_showaxeslabels.py b/plotly/validators/layout/scene/xaxis/_showaxeslabels.py deleted file mode 100644 index 7df3a3e8b4d..00000000000 --- a/plotly/validators/layout/scene/xaxis/_showaxeslabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowaxeslabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showaxeslabels', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(ShowaxeslabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_showbackground.py b/plotly/validators/layout/scene/xaxis/_showbackground.py deleted file mode 100644 index ccccf0728e8..00000000000 --- a/plotly/validators/layout/scene/xaxis/_showbackground.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowbackgroundValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showbackground', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(ShowbackgroundValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_showexponent.py b/plotly/validators/layout/scene/xaxis/_showexponent.py deleted file mode 100644 index f91212c383f..00000000000 --- a/plotly/validators/layout/scene/xaxis/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_showgrid.py b/plotly/validators/layout/scene/xaxis/_showgrid.py deleted file mode 100644 index f3218520e77..00000000000 --- a/plotly/validators/layout/scene/xaxis/_showgrid.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showgrid', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(ShowgridValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_showline.py b/plotly/validators/layout/scene/xaxis/_showline.py deleted file mode 100644 index 98acde713d0..00000000000 --- a/plotly/validators/layout/scene/xaxis/_showline.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showline', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(ShowlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_showspikes.py b/plotly/validators/layout/scene/xaxis/_showspikes.py deleted file mode 100644 index be4bb0e0d86..00000000000 --- a/plotly/validators/layout/scene/xaxis/_showspikes.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowspikesValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showspikes', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(ShowspikesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_showticklabels.py b/plotly/validators/layout/scene/xaxis/_showticklabels.py deleted file mode 100644 index 8f6f72e9888..00000000000 --- a/plotly/validators/layout/scene/xaxis/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_showtickprefix.py b/plotly/validators/layout/scene/xaxis/_showtickprefix.py deleted file mode 100644 index 85106d73ce3..00000000000 --- a/plotly/validators/layout/scene/xaxis/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_showticksuffix.py b/plotly/validators/layout/scene/xaxis/_showticksuffix.py deleted file mode 100644 index bc09453103a..00000000000 --- a/plotly/validators/layout/scene/xaxis/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_spikecolor.py b/plotly/validators/layout/scene/xaxis/_spikecolor.py deleted file mode 100644 index 2306ca75604..00000000000 --- a/plotly/validators/layout/scene/xaxis/_spikecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='spikecolor', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(SpikecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_spikesides.py b/plotly/validators/layout/scene/xaxis/_spikesides.py deleted file mode 100644 index 4e2984715dc..00000000000 --- a/plotly/validators/layout/scene/xaxis/_spikesides.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikesidesValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='spikesides', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(SpikesidesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_spikethickness.py b/plotly/validators/layout/scene/xaxis/_spikethickness.py deleted file mode 100644 index 6a24e31647b..00000000000 --- a/plotly/validators/layout/scene/xaxis/_spikethickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikethicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='spikethickness', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(SpikethicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_tick0.py b/plotly/validators/layout/scene/xaxis/_tick0.py deleted file mode 100644 index b1d82100f39..00000000000 --- a/plotly/validators/layout/scene/xaxis/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='tick0', parent_name='layout.scene.xaxis', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_tickangle.py b/plotly/validators/layout/scene/xaxis/_tickangle.py deleted file mode 100644 index 0a4926a1de3..00000000000 --- a/plotly/validators/layout/scene/xaxis/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_tickcolor.py b/plotly/validators/layout/scene/xaxis/_tickcolor.py deleted file mode 100644 index 461580e66fd..00000000000 --- a/plotly/validators/layout/scene/xaxis/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_tickfont.py b/plotly/validators/layout/scene/xaxis/_tickfont.py deleted file mode 100644 index 116662123d2..00000000000 --- a/plotly/validators/layout/scene/xaxis/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_tickformat.py b/plotly/validators/layout/scene/xaxis/_tickformat.py deleted file mode 100644 index bcf26c03b78..00000000000 --- a/plotly/validators/layout/scene/xaxis/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_tickformatstopdefaults.py b/plotly/validators/layout/scene/xaxis/_tickformatstopdefaults.py deleted file mode 100644 index 1c8e6ccd2bc..00000000000 --- a/plotly/validators/layout/scene/xaxis/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_tickformatstops.py b/plotly/validators/layout/scene/xaxis/_tickformatstops.py deleted file mode 100644 index 669cd27cf62..00000000000 --- a/plotly/validators/layout/scene/xaxis/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_ticklen.py b/plotly/validators/layout/scene/xaxis/_ticklen.py deleted file mode 100644 index 03c7640b94c..00000000000 --- a/plotly/validators/layout/scene/xaxis/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_tickmode.py b/plotly/validators/layout/scene/xaxis/_tickmode.py deleted file mode 100644 index 8d43d8c40b6..00000000000 --- a/plotly/validators/layout/scene/xaxis/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_tickprefix.py b/plotly/validators/layout/scene/xaxis/_tickprefix.py deleted file mode 100644 index 8cb8048c2a4..00000000000 --- a/plotly/validators/layout/scene/xaxis/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_ticks.py b/plotly/validators/layout/scene/xaxis/_ticks.py deleted file mode 100644 index 7d4345de2a8..00000000000 --- a/plotly/validators/layout/scene/xaxis/_ticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ticks', parent_name='layout.scene.xaxis', **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_ticksuffix.py b/plotly/validators/layout/scene/xaxis/_ticksuffix.py deleted file mode 100644 index 940c64b82b5..00000000000 --- a/plotly/validators/layout/scene/xaxis/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_ticktext.py b/plotly/validators/layout/scene/xaxis/_ticktext.py deleted file mode 100644 index b2e32d3a0ed..00000000000 --- a/plotly/validators/layout/scene/xaxis/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_ticktextsrc.py b/plotly/validators/layout/scene/xaxis/_ticktextsrc.py deleted file mode 100644 index 3beaaa84f72..00000000000 --- a/plotly/validators/layout/scene/xaxis/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_tickvals.py b/plotly/validators/layout/scene/xaxis/_tickvals.py deleted file mode 100644 index cc9498f4505..00000000000 --- a/plotly/validators/layout/scene/xaxis/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_tickvalssrc.py b/plotly/validators/layout/scene/xaxis/_tickvalssrc.py deleted file mode 100644 index 417688ad286..00000000000 --- a/plotly/validators/layout/scene/xaxis/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_tickwidth.py b/plotly/validators/layout/scene/xaxis/_tickwidth.py deleted file mode 100644 index 6c2a33b472e..00000000000 --- a/plotly/validators/layout/scene/xaxis/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_title.py b/plotly/validators/layout/scene/xaxis/_title.py deleted file mode 100644 index 35e3beef570..00000000000 --- a/plotly/validators/layout/scene/xaxis/_title.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='layout.scene.xaxis', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this axis' title font. Note that the - title's font used to be customized by the now - deprecated `titlefont` attribute. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_type.py b/plotly/validators/layout/scene/xaxis/_type.py deleted file mode 100644 index 5567aa14cee..00000000000 --- a/plotly/validators/layout/scene/xaxis/_type.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='layout.scene.xaxis', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['-', 'linear', 'log', 'date', 'category'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_visible.py b/plotly/validators/layout/scene/xaxis/_visible.py deleted file mode 100644 index 3ebd8d690ea..00000000000 --- a/plotly/validators/layout/scene/xaxis/_visible.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='visible', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_zeroline.py b/plotly/validators/layout/scene/xaxis/_zeroline.py deleted file mode 100644 index 89489c70c73..00000000000 --- a/plotly/validators/layout/scene/xaxis/_zeroline.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZerolineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='zeroline', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(ZerolineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_zerolinecolor.py b/plotly/validators/layout/scene/xaxis/_zerolinecolor.py deleted file mode 100644 index c162f8ac6ad..00000000000 --- a/plotly/validators/layout/scene/xaxis/_zerolinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZerolinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='zerolinecolor', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(ZerolinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/_zerolinewidth.py b/plotly/validators/layout/scene/xaxis/_zerolinewidth.py deleted file mode 100644 index e7ec266256f..00000000000 --- a/plotly/validators/layout/scene/xaxis/_zerolinewidth.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZerolinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='zerolinewidth', - parent_name='layout.scene.xaxis', - **kwargs - ): - super(ZerolinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/tickfont/__init__.py b/plotly/validators/layout/scene/xaxis/tickfont/__init__.py index 199d72e71c6..76d9fb3da61 100644 --- a/plotly/validators/layout/scene/xaxis/tickfont/__init__.py +++ b/plotly/validators/layout/scene/xaxis/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.scene.xaxis.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.scene.xaxis.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.scene.xaxis.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/xaxis/tickfont/_color.py b/plotly/validators/layout/scene/xaxis/tickfont/_color.py deleted file mode 100644 index 0f7d87cd33b..00000000000 --- a/plotly/validators/layout/scene/xaxis/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.scene.xaxis.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/tickfont/_family.py b/plotly/validators/layout/scene/xaxis/tickfont/_family.py deleted file mode 100644 index e2b918d2b6d..00000000000 --- a/plotly/validators/layout/scene/xaxis/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.scene.xaxis.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/tickfont/_size.py b/plotly/validators/layout/scene/xaxis/tickfont/_size.py deleted file mode 100644 index 58a9b6c923a..00000000000 --- a/plotly/validators/layout/scene/xaxis/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.scene.xaxis.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/tickformatstop/__init__.py b/plotly/validators/layout/scene/xaxis/tickformatstop/__init__.py index 3f6c06cac47..96568a5334c 100644 --- a/plotly/validators/layout/scene/xaxis/tickformatstop/__init__.py +++ b/plotly/validators/layout/scene/xaxis/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='layout.scene.xaxis.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.scene.xaxis.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='layout.scene.xaxis.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='layout.scene.xaxis.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='layout.scene.xaxis.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'plot' + }, { + 'valType': 'any', + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/xaxis/tickformatstop/_dtickrange.py b/plotly/validators/layout/scene/xaxis/tickformatstop/_dtickrange.py deleted file mode 100644 index 89a02d8699e..00000000000 --- a/plotly/validators/layout/scene/xaxis/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='layout.scene.xaxis.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'plot' - }, { - 'valType': 'any', - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/tickformatstop/_enabled.py b/plotly/validators/layout/scene/xaxis/tickformatstop/_enabled.py deleted file mode 100644 index c15d972c2de..00000000000 --- a/plotly/validators/layout/scene/xaxis/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='layout.scene.xaxis.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/tickformatstop/_name.py b/plotly/validators/layout/scene/xaxis/tickformatstop/_name.py deleted file mode 100644 index a41398b103e..00000000000 --- a/plotly/validators/layout/scene/xaxis/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='layout.scene.xaxis.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/tickformatstop/_templateitemname.py b/plotly/validators/layout/scene/xaxis/tickformatstop/_templateitemname.py deleted file mode 100644 index d516fc8fc81..00000000000 --- a/plotly/validators/layout/scene/xaxis/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.scene.xaxis.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/tickformatstop/_value.py b/plotly/validators/layout/scene/xaxis/tickformatstop/_value.py deleted file mode 100644 index ae5e8b1725f..00000000000 --- a/plotly/validators/layout/scene/xaxis/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='layout.scene.xaxis.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/title/__init__.py b/plotly/validators/layout/scene/xaxis/title/__init__.py index db7b0c34947..9d1363d98ab 100644 --- a/plotly/validators/layout/scene/xaxis/title/__init__.py +++ b/plotly/validators/layout/scene/xaxis/title/__init__.py @@ -1,2 +1,63 @@ -from ._text import TextValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='layout.scene.xaxis.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='layout.scene.xaxis.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/scene/xaxis/title/_font.py b/plotly/validators/layout/scene/xaxis/title/_font.py deleted file mode 100644 index d2202dc80e2..00000000000 --- a/plotly/validators/layout/scene/xaxis/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='layout.scene.xaxis.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/title/_text.py b/plotly/validators/layout/scene/xaxis/title/_text.py deleted file mode 100644 index 92e745c394d..00000000000 --- a/plotly/validators/layout/scene/xaxis/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='layout.scene.xaxis.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/title/font/__init__.py b/plotly/validators/layout/scene/xaxis/title/font/__init__.py index 199d72e71c6..5af26fcd35f 100644 --- a/plotly/validators/layout/scene/xaxis/title/font/__init__.py +++ b/plotly/validators/layout/scene/xaxis/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.scene.xaxis.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.scene.xaxis.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.scene.xaxis.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/xaxis/title/font/_color.py b/plotly/validators/layout/scene/xaxis/title/font/_color.py deleted file mode 100644 index e115d3820cd..00000000000 --- a/plotly/validators/layout/scene/xaxis/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.scene.xaxis.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/title/font/_family.py b/plotly/validators/layout/scene/xaxis/title/font/_family.py deleted file mode 100644 index ba0d182c662..00000000000 --- a/plotly/validators/layout/scene/xaxis/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.scene.xaxis.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/scene/xaxis/title/font/_size.py b/plotly/validators/layout/scene/xaxis/title/font/_size.py deleted file mode 100644 index 3c906f99aa1..00000000000 --- a/plotly/validators/layout/scene/xaxis/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.scene.xaxis.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/__init__.py b/plotly/validators/layout/scene/yaxis/__init__.py index fdd72c76306..1bd1fbab828 100644 --- a/plotly/validators/layout/scene/yaxis/__init__.py +++ b/plotly/validators/layout/scene/yaxis/__init__.py @@ -1,54 +1,1196 @@ -from ._zerolinewidth import ZerolinewidthValidator -from ._zerolinecolor import ZerolinecolorValidator -from ._zeroline import ZerolineValidator -from ._visible import VisibleValidator -from ._type import TypeValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._spikethickness import SpikethicknessValidator -from ._spikesides import SpikesidesValidator -from ._spikecolor import SpikecolorValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showspikes import ShowspikesValidator -from ._showline import ShowlineValidator -from ._showgrid import ShowgridValidator -from ._showexponent import ShowexponentValidator -from ._showbackground import ShowbackgroundValidator -from ._showaxeslabels import ShowaxeslabelsValidator -from ._separatethousands import SeparatethousandsValidator -from ._rangemode import RangemodeValidator -from ._range import RangeValidator -from ._nticks import NticksValidator -from ._mirror import MirrorValidator -from ._linewidth import LinewidthValidator -from ._linecolor import LinecolorValidator -from ._hoverformat import HoverformatValidator -from ._gridwidth import GridwidthValidator -from ._gridcolor import GridcolorValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._color import ColorValidator -from ._categoryorder import CategoryorderValidator -from ._categoryarraysrc import CategoryarraysrcValidator -from ._categoryarray import CategoryarrayValidator -from ._calendar import CalendarValidator -from ._backgroundcolor import BackgroundcolorValidator -from ._autorange import AutorangeValidator + + +import _plotly_utils.basevalidators + + +class ZerolinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='zerolinewidth', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(ZerolinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZerolinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='zerolinecolor', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(ZerolinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZerolineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='zeroline', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(ZerolineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='visible', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='layout.scene.yaxis', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['-', 'linear', 'log', 'date', 'category'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='layout.scene.yaxis', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this axis' title font. Note that the + title's font used to be customized by the now + deprecated `titlefont` attribute. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ticks', parent_name='layout.scene.yaxis', **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='tick0', parent_name='layout.scene.yaxis', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikethicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='spikethickness', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(SpikethicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikesidesValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='spikesides', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(SpikesidesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='spikecolor', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(SpikecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowspikesValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showspikes', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(ShowspikesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showline', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(ShowlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showgrid', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(ShowgridValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowbackgroundValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showbackground', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(ShowbackgroundValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowaxeslabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showaxeslabels', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(ShowaxeslabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='rangemode', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(RangemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['normal', 'tozero', 'nonnegative']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='range', parent_name='layout.scene.yaxis', **kwargs + ): + super(RangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', False), + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'autorange': False}), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'plot', + 'impliedEdits': { + '^autorange': False + } + }, + { + 'valType': 'any', + 'editType': 'plot', + 'impliedEdits': { + '^autorange': False + } + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nticks', parent_name='layout.scene.yaxis', **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MirrorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='mirror', parent_name='layout.scene.yaxis', **kwargs + ): + super(MirrorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [True, 'ticks', False, 'all', 'allticks'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='linewidth', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(LinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='linecolor', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(LinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hoverformat', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(HoverformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='gridwidth', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(GridwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='gridcolor', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(GridcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='dtick', parent_name='layout.scene.yaxis', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='layout.scene.yaxis', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='categoryorder', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(CategoryorderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'trace', 'category ascending', 'category descending', + 'array' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='categoryarraysrc', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(CategoryarraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='categoryarray', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(CategoryarrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='calendar', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(CalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BackgroundcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='backgroundcolor', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(BackgroundcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutorangeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='autorange', + parent_name='layout.scene.yaxis', + **kwargs + ): + super(AutorangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'reversed']), + **kwargs + ) diff --git a/plotly/validators/layout/scene/yaxis/_autorange.py b/plotly/validators/layout/scene/yaxis/_autorange.py deleted file mode 100644 index b6e2dc16369..00000000000 --- a/plotly/validators/layout/scene/yaxis/_autorange.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutorangeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='autorange', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(AutorangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'reversed']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_backgroundcolor.py b/plotly/validators/layout/scene/yaxis/_backgroundcolor.py deleted file mode 100644 index bf324c4db95..00000000000 --- a/plotly/validators/layout/scene/yaxis/_backgroundcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BackgroundcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='backgroundcolor', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(BackgroundcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_calendar.py b/plotly/validators/layout/scene/yaxis/_calendar.py deleted file mode 100644 index f301c76e47d..00000000000 --- a/plotly/validators/layout/scene/yaxis/_calendar.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class CalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='calendar', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(CalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_categoryarray.py b/plotly/validators/layout/scene/yaxis/_categoryarray.py deleted file mode 100644 index 207e4cfc377..00000000000 --- a/plotly/validators/layout/scene/yaxis/_categoryarray.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='categoryarray', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(CategoryarrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_categoryarraysrc.py b/plotly/validators/layout/scene/yaxis/_categoryarraysrc.py deleted file mode 100644 index e1b591742aa..00000000000 --- a/plotly/validators/layout/scene/yaxis/_categoryarraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='categoryarraysrc', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(CategoryarraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_categoryorder.py b/plotly/validators/layout/scene/yaxis/_categoryorder.py deleted file mode 100644 index 4b53904f1aa..00000000000 --- a/plotly/validators/layout/scene/yaxis/_categoryorder.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='categoryorder', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(CategoryorderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'trace', 'category ascending', 'category descending', - 'array' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_color.py b/plotly/validators/layout/scene/yaxis/_color.py deleted file mode 100644 index adf03715060..00000000000 --- a/plotly/validators/layout/scene/yaxis/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='layout.scene.yaxis', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_dtick.py b/plotly/validators/layout/scene/yaxis/_dtick.py deleted file mode 100644 index b8ae7701987..00000000000 --- a/plotly/validators/layout/scene/yaxis/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='dtick', parent_name='layout.scene.yaxis', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_exponentformat.py b/plotly/validators/layout/scene/yaxis/_exponentformat.py deleted file mode 100644 index 3718ed3b351..00000000000 --- a/plotly/validators/layout/scene/yaxis/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_gridcolor.py b/plotly/validators/layout/scene/yaxis/_gridcolor.py deleted file mode 100644 index 6ff1bc43615..00000000000 --- a/plotly/validators/layout/scene/yaxis/_gridcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='gridcolor', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(GridcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_gridwidth.py b/plotly/validators/layout/scene/yaxis/_gridwidth.py deleted file mode 100644 index c4d0847bc5e..00000000000 --- a/plotly/validators/layout/scene/yaxis/_gridwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='gridwidth', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(GridwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_hoverformat.py b/plotly/validators/layout/scene/yaxis/_hoverformat.py deleted file mode 100644 index e76c2555183..00000000000 --- a/plotly/validators/layout/scene/yaxis/_hoverformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hoverformat', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(HoverformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_linecolor.py b/plotly/validators/layout/scene/yaxis/_linecolor.py deleted file mode 100644 index b9ce7af3868..00000000000 --- a/plotly/validators/layout/scene/yaxis/_linecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='linecolor', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(LinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_linewidth.py b/plotly/validators/layout/scene/yaxis/_linewidth.py deleted file mode 100644 index cc6d2c9ea0b..00000000000 --- a/plotly/validators/layout/scene/yaxis/_linewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='linewidth', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(LinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_mirror.py b/plotly/validators/layout/scene/yaxis/_mirror.py deleted file mode 100644 index 867c4b2514a..00000000000 --- a/plotly/validators/layout/scene/yaxis/_mirror.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class MirrorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='mirror', parent_name='layout.scene.yaxis', **kwargs - ): - super(MirrorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [True, 'ticks', False, 'all', 'allticks'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_nticks.py b/plotly/validators/layout/scene/yaxis/_nticks.py deleted file mode 100644 index da1d99d916d..00000000000 --- a/plotly/validators/layout/scene/yaxis/_nticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nticks', parent_name='layout.scene.yaxis', **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_range.py b/plotly/validators/layout/scene/yaxis/_range.py deleted file mode 100644 index 04c5d672b7d..00000000000 --- a/plotly/validators/layout/scene/yaxis/_range.py +++ /dev/null @@ -1,35 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='range', parent_name='layout.scene.yaxis', **kwargs - ): - super(RangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', False), - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'autorange': False}), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'plot', - 'impliedEdits': { - '^autorange': False - } - }, - { - 'valType': 'any', - 'editType': 'plot', - 'impliedEdits': { - '^autorange': False - } - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_rangemode.py b/plotly/validators/layout/scene/yaxis/_rangemode.py deleted file mode 100644 index eb4067ea281..00000000000 --- a/plotly/validators/layout/scene/yaxis/_rangemode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='rangemode', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(RangemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['normal', 'tozero', 'nonnegative']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_separatethousands.py b/plotly/validators/layout/scene/yaxis/_separatethousands.py deleted file mode 100644 index c33214ad009..00000000000 --- a/plotly/validators/layout/scene/yaxis/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_showaxeslabels.py b/plotly/validators/layout/scene/yaxis/_showaxeslabels.py deleted file mode 100644 index 39695fa28c5..00000000000 --- a/plotly/validators/layout/scene/yaxis/_showaxeslabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowaxeslabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showaxeslabels', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(ShowaxeslabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_showbackground.py b/plotly/validators/layout/scene/yaxis/_showbackground.py deleted file mode 100644 index a703774eca8..00000000000 --- a/plotly/validators/layout/scene/yaxis/_showbackground.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowbackgroundValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showbackground', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(ShowbackgroundValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_showexponent.py b/plotly/validators/layout/scene/yaxis/_showexponent.py deleted file mode 100644 index 7b0fd6b065d..00000000000 --- a/plotly/validators/layout/scene/yaxis/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_showgrid.py b/plotly/validators/layout/scene/yaxis/_showgrid.py deleted file mode 100644 index 403e2e27df4..00000000000 --- a/plotly/validators/layout/scene/yaxis/_showgrid.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showgrid', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(ShowgridValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_showline.py b/plotly/validators/layout/scene/yaxis/_showline.py deleted file mode 100644 index 5c17d9bb7c5..00000000000 --- a/plotly/validators/layout/scene/yaxis/_showline.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showline', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(ShowlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_showspikes.py b/plotly/validators/layout/scene/yaxis/_showspikes.py deleted file mode 100644 index fe5a877c3bd..00000000000 --- a/plotly/validators/layout/scene/yaxis/_showspikes.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowspikesValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showspikes', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(ShowspikesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_showticklabels.py b/plotly/validators/layout/scene/yaxis/_showticklabels.py deleted file mode 100644 index aa1cc5495b0..00000000000 --- a/plotly/validators/layout/scene/yaxis/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_showtickprefix.py b/plotly/validators/layout/scene/yaxis/_showtickprefix.py deleted file mode 100644 index 598b6ed0a9c..00000000000 --- a/plotly/validators/layout/scene/yaxis/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_showticksuffix.py b/plotly/validators/layout/scene/yaxis/_showticksuffix.py deleted file mode 100644 index 62cb8d035f3..00000000000 --- a/plotly/validators/layout/scene/yaxis/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_spikecolor.py b/plotly/validators/layout/scene/yaxis/_spikecolor.py deleted file mode 100644 index f7f8efaa230..00000000000 --- a/plotly/validators/layout/scene/yaxis/_spikecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='spikecolor', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(SpikecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_spikesides.py b/plotly/validators/layout/scene/yaxis/_spikesides.py deleted file mode 100644 index 983f233aeba..00000000000 --- a/plotly/validators/layout/scene/yaxis/_spikesides.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikesidesValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='spikesides', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(SpikesidesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_spikethickness.py b/plotly/validators/layout/scene/yaxis/_spikethickness.py deleted file mode 100644 index e5552db66aa..00000000000 --- a/plotly/validators/layout/scene/yaxis/_spikethickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikethicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='spikethickness', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(SpikethicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_tick0.py b/plotly/validators/layout/scene/yaxis/_tick0.py deleted file mode 100644 index c4d2e2fe685..00000000000 --- a/plotly/validators/layout/scene/yaxis/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='tick0', parent_name='layout.scene.yaxis', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_tickangle.py b/plotly/validators/layout/scene/yaxis/_tickangle.py deleted file mode 100644 index 00e11117e30..00000000000 --- a/plotly/validators/layout/scene/yaxis/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_tickcolor.py b/plotly/validators/layout/scene/yaxis/_tickcolor.py deleted file mode 100644 index ad123e95d1c..00000000000 --- a/plotly/validators/layout/scene/yaxis/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_tickfont.py b/plotly/validators/layout/scene/yaxis/_tickfont.py deleted file mode 100644 index 0f3a015944c..00000000000 --- a/plotly/validators/layout/scene/yaxis/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_tickformat.py b/plotly/validators/layout/scene/yaxis/_tickformat.py deleted file mode 100644 index 16c1bfbfb87..00000000000 --- a/plotly/validators/layout/scene/yaxis/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_tickformatstopdefaults.py b/plotly/validators/layout/scene/yaxis/_tickformatstopdefaults.py deleted file mode 100644 index 0ea1d73ef97..00000000000 --- a/plotly/validators/layout/scene/yaxis/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_tickformatstops.py b/plotly/validators/layout/scene/yaxis/_tickformatstops.py deleted file mode 100644 index 2972a2af6d0..00000000000 --- a/plotly/validators/layout/scene/yaxis/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_ticklen.py b/plotly/validators/layout/scene/yaxis/_ticklen.py deleted file mode 100644 index a9ea0c7d599..00000000000 --- a/plotly/validators/layout/scene/yaxis/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_tickmode.py b/plotly/validators/layout/scene/yaxis/_tickmode.py deleted file mode 100644 index 4b75430a8f3..00000000000 --- a/plotly/validators/layout/scene/yaxis/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_tickprefix.py b/plotly/validators/layout/scene/yaxis/_tickprefix.py deleted file mode 100644 index 0a40d7812fe..00000000000 --- a/plotly/validators/layout/scene/yaxis/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_ticks.py b/plotly/validators/layout/scene/yaxis/_ticks.py deleted file mode 100644 index 21cc2d7288f..00000000000 --- a/plotly/validators/layout/scene/yaxis/_ticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ticks', parent_name='layout.scene.yaxis', **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_ticksuffix.py b/plotly/validators/layout/scene/yaxis/_ticksuffix.py deleted file mode 100644 index 9d41d98b007..00000000000 --- a/plotly/validators/layout/scene/yaxis/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_ticktext.py b/plotly/validators/layout/scene/yaxis/_ticktext.py deleted file mode 100644 index e447e40012d..00000000000 --- a/plotly/validators/layout/scene/yaxis/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_ticktextsrc.py b/plotly/validators/layout/scene/yaxis/_ticktextsrc.py deleted file mode 100644 index 825a7dd15db..00000000000 --- a/plotly/validators/layout/scene/yaxis/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_tickvals.py b/plotly/validators/layout/scene/yaxis/_tickvals.py deleted file mode 100644 index f091a55283c..00000000000 --- a/plotly/validators/layout/scene/yaxis/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_tickvalssrc.py b/plotly/validators/layout/scene/yaxis/_tickvalssrc.py deleted file mode 100644 index 3cfdc8c6e72..00000000000 --- a/plotly/validators/layout/scene/yaxis/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_tickwidth.py b/plotly/validators/layout/scene/yaxis/_tickwidth.py deleted file mode 100644 index 1133bb2e8d0..00000000000 --- a/plotly/validators/layout/scene/yaxis/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_title.py b/plotly/validators/layout/scene/yaxis/_title.py deleted file mode 100644 index b63b7b0849f..00000000000 --- a/plotly/validators/layout/scene/yaxis/_title.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='layout.scene.yaxis', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this axis' title font. Note that the - title's font used to be customized by the now - deprecated `titlefont` attribute. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_type.py b/plotly/validators/layout/scene/yaxis/_type.py deleted file mode 100644 index 9a93543771d..00000000000 --- a/plotly/validators/layout/scene/yaxis/_type.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='layout.scene.yaxis', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['-', 'linear', 'log', 'date', 'category'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_visible.py b/plotly/validators/layout/scene/yaxis/_visible.py deleted file mode 100644 index 8193f43a1ad..00000000000 --- a/plotly/validators/layout/scene/yaxis/_visible.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='visible', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_zeroline.py b/plotly/validators/layout/scene/yaxis/_zeroline.py deleted file mode 100644 index a21fc6dae9c..00000000000 --- a/plotly/validators/layout/scene/yaxis/_zeroline.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZerolineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='zeroline', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(ZerolineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_zerolinecolor.py b/plotly/validators/layout/scene/yaxis/_zerolinecolor.py deleted file mode 100644 index 9f5426d6b61..00000000000 --- a/plotly/validators/layout/scene/yaxis/_zerolinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZerolinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='zerolinecolor', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(ZerolinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/_zerolinewidth.py b/plotly/validators/layout/scene/yaxis/_zerolinewidth.py deleted file mode 100644 index 56cc31fc186..00000000000 --- a/plotly/validators/layout/scene/yaxis/_zerolinewidth.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZerolinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='zerolinewidth', - parent_name='layout.scene.yaxis', - **kwargs - ): - super(ZerolinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/tickfont/__init__.py b/plotly/validators/layout/scene/yaxis/tickfont/__init__.py index 199d72e71c6..425b79d11db 100644 --- a/plotly/validators/layout/scene/yaxis/tickfont/__init__.py +++ b/plotly/validators/layout/scene/yaxis/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.scene.yaxis.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.scene.yaxis.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.scene.yaxis.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/yaxis/tickfont/_color.py b/plotly/validators/layout/scene/yaxis/tickfont/_color.py deleted file mode 100644 index 2bd85fc723e..00000000000 --- a/plotly/validators/layout/scene/yaxis/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.scene.yaxis.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/tickfont/_family.py b/plotly/validators/layout/scene/yaxis/tickfont/_family.py deleted file mode 100644 index 8307e40ab9a..00000000000 --- a/plotly/validators/layout/scene/yaxis/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.scene.yaxis.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/tickfont/_size.py b/plotly/validators/layout/scene/yaxis/tickfont/_size.py deleted file mode 100644 index 504e005c7fd..00000000000 --- a/plotly/validators/layout/scene/yaxis/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.scene.yaxis.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/tickformatstop/__init__.py b/plotly/validators/layout/scene/yaxis/tickformatstop/__init__.py index 3f6c06cac47..5b3ec89ca37 100644 --- a/plotly/validators/layout/scene/yaxis/tickformatstop/__init__.py +++ b/plotly/validators/layout/scene/yaxis/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='layout.scene.yaxis.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.scene.yaxis.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='layout.scene.yaxis.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='layout.scene.yaxis.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='layout.scene.yaxis.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'plot' + }, { + 'valType': 'any', + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/yaxis/tickformatstop/_dtickrange.py b/plotly/validators/layout/scene/yaxis/tickformatstop/_dtickrange.py deleted file mode 100644 index 75136b1600c..00000000000 --- a/plotly/validators/layout/scene/yaxis/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='layout.scene.yaxis.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'plot' - }, { - 'valType': 'any', - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/tickformatstop/_enabled.py b/plotly/validators/layout/scene/yaxis/tickformatstop/_enabled.py deleted file mode 100644 index 0c6da23e4be..00000000000 --- a/plotly/validators/layout/scene/yaxis/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='layout.scene.yaxis.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/tickformatstop/_name.py b/plotly/validators/layout/scene/yaxis/tickformatstop/_name.py deleted file mode 100644 index f4fca44f93c..00000000000 --- a/plotly/validators/layout/scene/yaxis/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='layout.scene.yaxis.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/tickformatstop/_templateitemname.py b/plotly/validators/layout/scene/yaxis/tickformatstop/_templateitemname.py deleted file mode 100644 index 60ea515a6af..00000000000 --- a/plotly/validators/layout/scene/yaxis/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.scene.yaxis.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/tickformatstop/_value.py b/plotly/validators/layout/scene/yaxis/tickformatstop/_value.py deleted file mode 100644 index a16b184eb85..00000000000 --- a/plotly/validators/layout/scene/yaxis/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='layout.scene.yaxis.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/title/__init__.py b/plotly/validators/layout/scene/yaxis/title/__init__.py index db7b0c34947..5f782103c99 100644 --- a/plotly/validators/layout/scene/yaxis/title/__init__.py +++ b/plotly/validators/layout/scene/yaxis/title/__init__.py @@ -1,2 +1,63 @@ -from ._text import TextValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='layout.scene.yaxis.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='layout.scene.yaxis.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/scene/yaxis/title/_font.py b/plotly/validators/layout/scene/yaxis/title/_font.py deleted file mode 100644 index f6d613858f8..00000000000 --- a/plotly/validators/layout/scene/yaxis/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='layout.scene.yaxis.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/title/_text.py b/plotly/validators/layout/scene/yaxis/title/_text.py deleted file mode 100644 index 13bf0ae8ce7..00000000000 --- a/plotly/validators/layout/scene/yaxis/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='layout.scene.yaxis.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/title/font/__init__.py b/plotly/validators/layout/scene/yaxis/title/font/__init__.py index 199d72e71c6..c758d168133 100644 --- a/plotly/validators/layout/scene/yaxis/title/font/__init__.py +++ b/plotly/validators/layout/scene/yaxis/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.scene.yaxis.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.scene.yaxis.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.scene.yaxis.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/yaxis/title/font/_color.py b/plotly/validators/layout/scene/yaxis/title/font/_color.py deleted file mode 100644 index fb2d06a4983..00000000000 --- a/plotly/validators/layout/scene/yaxis/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.scene.yaxis.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/title/font/_family.py b/plotly/validators/layout/scene/yaxis/title/font/_family.py deleted file mode 100644 index 46d619b3fd2..00000000000 --- a/plotly/validators/layout/scene/yaxis/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.scene.yaxis.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/scene/yaxis/title/font/_size.py b/plotly/validators/layout/scene/yaxis/title/font/_size.py deleted file mode 100644 index 4ee02aaa66e..00000000000 --- a/plotly/validators/layout/scene/yaxis/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.scene.yaxis.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/__init__.py b/plotly/validators/layout/scene/zaxis/__init__.py index fdd72c76306..2d9146f553e 100644 --- a/plotly/validators/layout/scene/zaxis/__init__.py +++ b/plotly/validators/layout/scene/zaxis/__init__.py @@ -1,54 +1,1196 @@ -from ._zerolinewidth import ZerolinewidthValidator -from ._zerolinecolor import ZerolinecolorValidator -from ._zeroline import ZerolineValidator -from ._visible import VisibleValidator -from ._type import TypeValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._spikethickness import SpikethicknessValidator -from ._spikesides import SpikesidesValidator -from ._spikecolor import SpikecolorValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showspikes import ShowspikesValidator -from ._showline import ShowlineValidator -from ._showgrid import ShowgridValidator -from ._showexponent import ShowexponentValidator -from ._showbackground import ShowbackgroundValidator -from ._showaxeslabels import ShowaxeslabelsValidator -from ._separatethousands import SeparatethousandsValidator -from ._rangemode import RangemodeValidator -from ._range import RangeValidator -from ._nticks import NticksValidator -from ._mirror import MirrorValidator -from ._linewidth import LinewidthValidator -from ._linecolor import LinecolorValidator -from ._hoverformat import HoverformatValidator -from ._gridwidth import GridwidthValidator -from ._gridcolor import GridcolorValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._color import ColorValidator -from ._categoryorder import CategoryorderValidator -from ._categoryarraysrc import CategoryarraysrcValidator -from ._categoryarray import CategoryarrayValidator -from ._calendar import CalendarValidator -from ._backgroundcolor import BackgroundcolorValidator -from ._autorange import AutorangeValidator + + +import _plotly_utils.basevalidators + + +class ZerolinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='zerolinewidth', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(ZerolinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZerolinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='zerolinecolor', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(ZerolinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZerolineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='zeroline', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(ZerolineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='visible', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='layout.scene.zaxis', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['-', 'linear', 'log', 'date', 'category'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='layout.scene.zaxis', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this axis' title font. Note that the + title's font used to be customized by the now + deprecated `titlefont` attribute. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ticks', parent_name='layout.scene.zaxis', **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='tick0', parent_name='layout.scene.zaxis', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikethicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='spikethickness', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(SpikethicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikesidesValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='spikesides', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(SpikesidesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='spikecolor', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(SpikecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowspikesValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showspikes', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(ShowspikesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showline', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(ShowlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showgrid', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(ShowgridValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowbackgroundValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showbackground', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(ShowbackgroundValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowaxeslabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showaxeslabels', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(ShowaxeslabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='rangemode', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(RangemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['normal', 'tozero', 'nonnegative']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='range', parent_name='layout.scene.zaxis', **kwargs + ): + super(RangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', False), + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'autorange': False}), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'plot', + 'impliedEdits': { + '^autorange': False + } + }, + { + 'valType': 'any', + 'editType': 'plot', + 'impliedEdits': { + '^autorange': False + } + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nticks', parent_name='layout.scene.zaxis', **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MirrorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='mirror', parent_name='layout.scene.zaxis', **kwargs + ): + super(MirrorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [True, 'ticks', False, 'all', 'allticks'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='linewidth', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(LinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='linecolor', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(LinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hoverformat', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(HoverformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='gridwidth', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(GridwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='gridcolor', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(GridcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='dtick', parent_name='layout.scene.zaxis', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='layout.scene.zaxis', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='categoryorder', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(CategoryorderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'trace', 'category ascending', 'category descending', + 'array' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='categoryarraysrc', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(CategoryarraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='categoryarray', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(CategoryarrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='calendar', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(CalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BackgroundcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='backgroundcolor', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(BackgroundcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutorangeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='autorange', + parent_name='layout.scene.zaxis', + **kwargs + ): + super(AutorangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'reversed']), + **kwargs + ) diff --git a/plotly/validators/layout/scene/zaxis/_autorange.py b/plotly/validators/layout/scene/zaxis/_autorange.py deleted file mode 100644 index ee291d5e813..00000000000 --- a/plotly/validators/layout/scene/zaxis/_autorange.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutorangeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='autorange', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(AutorangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'reversed']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_backgroundcolor.py b/plotly/validators/layout/scene/zaxis/_backgroundcolor.py deleted file mode 100644 index 738fe750dbf..00000000000 --- a/plotly/validators/layout/scene/zaxis/_backgroundcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BackgroundcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='backgroundcolor', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(BackgroundcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_calendar.py b/plotly/validators/layout/scene/zaxis/_calendar.py deleted file mode 100644 index 26077878609..00000000000 --- a/plotly/validators/layout/scene/zaxis/_calendar.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class CalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='calendar', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(CalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_categoryarray.py b/plotly/validators/layout/scene/zaxis/_categoryarray.py deleted file mode 100644 index 65cf87b3fe2..00000000000 --- a/plotly/validators/layout/scene/zaxis/_categoryarray.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='categoryarray', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(CategoryarrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_categoryarraysrc.py b/plotly/validators/layout/scene/zaxis/_categoryarraysrc.py deleted file mode 100644 index 4fb5152078a..00000000000 --- a/plotly/validators/layout/scene/zaxis/_categoryarraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='categoryarraysrc', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(CategoryarraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_categoryorder.py b/plotly/validators/layout/scene/zaxis/_categoryorder.py deleted file mode 100644 index e37aade6ad6..00000000000 --- a/plotly/validators/layout/scene/zaxis/_categoryorder.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='categoryorder', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(CategoryorderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'trace', 'category ascending', 'category descending', - 'array' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_color.py b/plotly/validators/layout/scene/zaxis/_color.py deleted file mode 100644 index cd0dcfe124d..00000000000 --- a/plotly/validators/layout/scene/zaxis/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='layout.scene.zaxis', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_dtick.py b/plotly/validators/layout/scene/zaxis/_dtick.py deleted file mode 100644 index 54189063174..00000000000 --- a/plotly/validators/layout/scene/zaxis/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='dtick', parent_name='layout.scene.zaxis', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_exponentformat.py b/plotly/validators/layout/scene/zaxis/_exponentformat.py deleted file mode 100644 index 5c00e9baafa..00000000000 --- a/plotly/validators/layout/scene/zaxis/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_gridcolor.py b/plotly/validators/layout/scene/zaxis/_gridcolor.py deleted file mode 100644 index 0d3f8555557..00000000000 --- a/plotly/validators/layout/scene/zaxis/_gridcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='gridcolor', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(GridcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_gridwidth.py b/plotly/validators/layout/scene/zaxis/_gridwidth.py deleted file mode 100644 index dac1ce8eb87..00000000000 --- a/plotly/validators/layout/scene/zaxis/_gridwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='gridwidth', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(GridwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_hoverformat.py b/plotly/validators/layout/scene/zaxis/_hoverformat.py deleted file mode 100644 index ebe6cce8d58..00000000000 --- a/plotly/validators/layout/scene/zaxis/_hoverformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hoverformat', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(HoverformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_linecolor.py b/plotly/validators/layout/scene/zaxis/_linecolor.py deleted file mode 100644 index a3ba342bd29..00000000000 --- a/plotly/validators/layout/scene/zaxis/_linecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='linecolor', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(LinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_linewidth.py b/plotly/validators/layout/scene/zaxis/_linewidth.py deleted file mode 100644 index d63be2e6d38..00000000000 --- a/plotly/validators/layout/scene/zaxis/_linewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='linewidth', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(LinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_mirror.py b/plotly/validators/layout/scene/zaxis/_mirror.py deleted file mode 100644 index 0993399579e..00000000000 --- a/plotly/validators/layout/scene/zaxis/_mirror.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class MirrorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='mirror', parent_name='layout.scene.zaxis', **kwargs - ): - super(MirrorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [True, 'ticks', False, 'all', 'allticks'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_nticks.py b/plotly/validators/layout/scene/zaxis/_nticks.py deleted file mode 100644 index fc2b972f882..00000000000 --- a/plotly/validators/layout/scene/zaxis/_nticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nticks', parent_name='layout.scene.zaxis', **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_range.py b/plotly/validators/layout/scene/zaxis/_range.py deleted file mode 100644 index 65d6380d97a..00000000000 --- a/plotly/validators/layout/scene/zaxis/_range.py +++ /dev/null @@ -1,35 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='range', parent_name='layout.scene.zaxis', **kwargs - ): - super(RangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', False), - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'autorange': False}), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'plot', - 'impliedEdits': { - '^autorange': False - } - }, - { - 'valType': 'any', - 'editType': 'plot', - 'impliedEdits': { - '^autorange': False - } - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_rangemode.py b/plotly/validators/layout/scene/zaxis/_rangemode.py deleted file mode 100644 index 8b2828e7e5a..00000000000 --- a/plotly/validators/layout/scene/zaxis/_rangemode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='rangemode', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(RangemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['normal', 'tozero', 'nonnegative']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_separatethousands.py b/plotly/validators/layout/scene/zaxis/_separatethousands.py deleted file mode 100644 index aec46e9f043..00000000000 --- a/plotly/validators/layout/scene/zaxis/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_showaxeslabels.py b/plotly/validators/layout/scene/zaxis/_showaxeslabels.py deleted file mode 100644 index c09be11447e..00000000000 --- a/plotly/validators/layout/scene/zaxis/_showaxeslabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowaxeslabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showaxeslabels', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(ShowaxeslabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_showbackground.py b/plotly/validators/layout/scene/zaxis/_showbackground.py deleted file mode 100644 index 38f23d75a54..00000000000 --- a/plotly/validators/layout/scene/zaxis/_showbackground.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowbackgroundValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showbackground', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(ShowbackgroundValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_showexponent.py b/plotly/validators/layout/scene/zaxis/_showexponent.py deleted file mode 100644 index 98367fb7c8a..00000000000 --- a/plotly/validators/layout/scene/zaxis/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_showgrid.py b/plotly/validators/layout/scene/zaxis/_showgrid.py deleted file mode 100644 index eafaa59bd92..00000000000 --- a/plotly/validators/layout/scene/zaxis/_showgrid.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showgrid', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(ShowgridValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_showline.py b/plotly/validators/layout/scene/zaxis/_showline.py deleted file mode 100644 index 377b1be75c4..00000000000 --- a/plotly/validators/layout/scene/zaxis/_showline.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showline', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(ShowlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_showspikes.py b/plotly/validators/layout/scene/zaxis/_showspikes.py deleted file mode 100644 index fe46a7e3e23..00000000000 --- a/plotly/validators/layout/scene/zaxis/_showspikes.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowspikesValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showspikes', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(ShowspikesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_showticklabels.py b/plotly/validators/layout/scene/zaxis/_showticklabels.py deleted file mode 100644 index b8d3a94fc13..00000000000 --- a/plotly/validators/layout/scene/zaxis/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_showtickprefix.py b/plotly/validators/layout/scene/zaxis/_showtickprefix.py deleted file mode 100644 index 4e0d4cb4b7e..00000000000 --- a/plotly/validators/layout/scene/zaxis/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_showticksuffix.py b/plotly/validators/layout/scene/zaxis/_showticksuffix.py deleted file mode 100644 index 01ede698d1b..00000000000 --- a/plotly/validators/layout/scene/zaxis/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_spikecolor.py b/plotly/validators/layout/scene/zaxis/_spikecolor.py deleted file mode 100644 index e38f26393d2..00000000000 --- a/plotly/validators/layout/scene/zaxis/_spikecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='spikecolor', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(SpikecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_spikesides.py b/plotly/validators/layout/scene/zaxis/_spikesides.py deleted file mode 100644 index f65fdbc7307..00000000000 --- a/plotly/validators/layout/scene/zaxis/_spikesides.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikesidesValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='spikesides', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(SpikesidesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_spikethickness.py b/plotly/validators/layout/scene/zaxis/_spikethickness.py deleted file mode 100644 index 354ccd45ade..00000000000 --- a/plotly/validators/layout/scene/zaxis/_spikethickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikethicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='spikethickness', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(SpikethicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_tick0.py b/plotly/validators/layout/scene/zaxis/_tick0.py deleted file mode 100644 index 7c65089f3bc..00000000000 --- a/plotly/validators/layout/scene/zaxis/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='tick0', parent_name='layout.scene.zaxis', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_tickangle.py b/plotly/validators/layout/scene/zaxis/_tickangle.py deleted file mode 100644 index 0676f6f8701..00000000000 --- a/plotly/validators/layout/scene/zaxis/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_tickcolor.py b/plotly/validators/layout/scene/zaxis/_tickcolor.py deleted file mode 100644 index fa3a90abf75..00000000000 --- a/plotly/validators/layout/scene/zaxis/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_tickfont.py b/plotly/validators/layout/scene/zaxis/_tickfont.py deleted file mode 100644 index 379d7b29a1c..00000000000 --- a/plotly/validators/layout/scene/zaxis/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_tickformat.py b/plotly/validators/layout/scene/zaxis/_tickformat.py deleted file mode 100644 index 6f58816100f..00000000000 --- a/plotly/validators/layout/scene/zaxis/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_tickformatstopdefaults.py b/plotly/validators/layout/scene/zaxis/_tickformatstopdefaults.py deleted file mode 100644 index eb6c1963dad..00000000000 --- a/plotly/validators/layout/scene/zaxis/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_tickformatstops.py b/plotly/validators/layout/scene/zaxis/_tickformatstops.py deleted file mode 100644 index 9fc047ce666..00000000000 --- a/plotly/validators/layout/scene/zaxis/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_ticklen.py b/plotly/validators/layout/scene/zaxis/_ticklen.py deleted file mode 100644 index 378f4cf0725..00000000000 --- a/plotly/validators/layout/scene/zaxis/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_tickmode.py b/plotly/validators/layout/scene/zaxis/_tickmode.py deleted file mode 100644 index c95da5f697e..00000000000 --- a/plotly/validators/layout/scene/zaxis/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_tickprefix.py b/plotly/validators/layout/scene/zaxis/_tickprefix.py deleted file mode 100644 index e4710ec73bf..00000000000 --- a/plotly/validators/layout/scene/zaxis/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_ticks.py b/plotly/validators/layout/scene/zaxis/_ticks.py deleted file mode 100644 index 12f4bae65f6..00000000000 --- a/plotly/validators/layout/scene/zaxis/_ticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ticks', parent_name='layout.scene.zaxis', **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_ticksuffix.py b/plotly/validators/layout/scene/zaxis/_ticksuffix.py deleted file mode 100644 index b25fe974aed..00000000000 --- a/plotly/validators/layout/scene/zaxis/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_ticktext.py b/plotly/validators/layout/scene/zaxis/_ticktext.py deleted file mode 100644 index a6b1301aacb..00000000000 --- a/plotly/validators/layout/scene/zaxis/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_ticktextsrc.py b/plotly/validators/layout/scene/zaxis/_ticktextsrc.py deleted file mode 100644 index 9cec1b77779..00000000000 --- a/plotly/validators/layout/scene/zaxis/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_tickvals.py b/plotly/validators/layout/scene/zaxis/_tickvals.py deleted file mode 100644 index 0abbb9548ee..00000000000 --- a/plotly/validators/layout/scene/zaxis/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_tickvalssrc.py b/plotly/validators/layout/scene/zaxis/_tickvalssrc.py deleted file mode 100644 index b18e8e58905..00000000000 --- a/plotly/validators/layout/scene/zaxis/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_tickwidth.py b/plotly/validators/layout/scene/zaxis/_tickwidth.py deleted file mode 100644 index c19fa84133d..00000000000 --- a/plotly/validators/layout/scene/zaxis/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_title.py b/plotly/validators/layout/scene/zaxis/_title.py deleted file mode 100644 index 9ffa6e3404d..00000000000 --- a/plotly/validators/layout/scene/zaxis/_title.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='layout.scene.zaxis', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this axis' title font. Note that the - title's font used to be customized by the now - deprecated `titlefont` attribute. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_type.py b/plotly/validators/layout/scene/zaxis/_type.py deleted file mode 100644 index 22f34f90d0b..00000000000 --- a/plotly/validators/layout/scene/zaxis/_type.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='layout.scene.zaxis', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['-', 'linear', 'log', 'date', 'category'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_visible.py b/plotly/validators/layout/scene/zaxis/_visible.py deleted file mode 100644 index 5fbe822d580..00000000000 --- a/plotly/validators/layout/scene/zaxis/_visible.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='visible', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_zeroline.py b/plotly/validators/layout/scene/zaxis/_zeroline.py deleted file mode 100644 index ef617d8d3a4..00000000000 --- a/plotly/validators/layout/scene/zaxis/_zeroline.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZerolineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='zeroline', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(ZerolineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_zerolinecolor.py b/plotly/validators/layout/scene/zaxis/_zerolinecolor.py deleted file mode 100644 index 078a98b7294..00000000000 --- a/plotly/validators/layout/scene/zaxis/_zerolinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZerolinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='zerolinecolor', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(ZerolinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/_zerolinewidth.py b/plotly/validators/layout/scene/zaxis/_zerolinewidth.py deleted file mode 100644 index c7248b9508b..00000000000 --- a/plotly/validators/layout/scene/zaxis/_zerolinewidth.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZerolinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='zerolinewidth', - parent_name='layout.scene.zaxis', - **kwargs - ): - super(ZerolinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/tickfont/__init__.py b/plotly/validators/layout/scene/zaxis/tickfont/__init__.py index 199d72e71c6..30a2f55721e 100644 --- a/plotly/validators/layout/scene/zaxis/tickfont/__init__.py +++ b/plotly/validators/layout/scene/zaxis/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.scene.zaxis.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.scene.zaxis.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.scene.zaxis.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/zaxis/tickfont/_color.py b/plotly/validators/layout/scene/zaxis/tickfont/_color.py deleted file mode 100644 index de6c17953d9..00000000000 --- a/plotly/validators/layout/scene/zaxis/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.scene.zaxis.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/tickfont/_family.py b/plotly/validators/layout/scene/zaxis/tickfont/_family.py deleted file mode 100644 index 3a9659f3d4c..00000000000 --- a/plotly/validators/layout/scene/zaxis/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.scene.zaxis.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/tickfont/_size.py b/plotly/validators/layout/scene/zaxis/tickfont/_size.py deleted file mode 100644 index 9f3b86c8b2a..00000000000 --- a/plotly/validators/layout/scene/zaxis/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.scene.zaxis.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/tickformatstop/__init__.py b/plotly/validators/layout/scene/zaxis/tickformatstop/__init__.py index 3f6c06cac47..07164364752 100644 --- a/plotly/validators/layout/scene/zaxis/tickformatstop/__init__.py +++ b/plotly/validators/layout/scene/zaxis/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='layout.scene.zaxis.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.scene.zaxis.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='layout.scene.zaxis.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='layout.scene.zaxis.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='layout.scene.zaxis.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'plot' + }, { + 'valType': 'any', + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/zaxis/tickformatstop/_dtickrange.py b/plotly/validators/layout/scene/zaxis/tickformatstop/_dtickrange.py deleted file mode 100644 index 4b1691aa527..00000000000 --- a/plotly/validators/layout/scene/zaxis/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='layout.scene.zaxis.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'plot' - }, { - 'valType': 'any', - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/tickformatstop/_enabled.py b/plotly/validators/layout/scene/zaxis/tickformatstop/_enabled.py deleted file mode 100644 index d83e16407bb..00000000000 --- a/plotly/validators/layout/scene/zaxis/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='layout.scene.zaxis.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/tickformatstop/_name.py b/plotly/validators/layout/scene/zaxis/tickformatstop/_name.py deleted file mode 100644 index d5e2a9e4a58..00000000000 --- a/plotly/validators/layout/scene/zaxis/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='layout.scene.zaxis.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/tickformatstop/_templateitemname.py b/plotly/validators/layout/scene/zaxis/tickformatstop/_templateitemname.py deleted file mode 100644 index b228a58e54c..00000000000 --- a/plotly/validators/layout/scene/zaxis/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.scene.zaxis.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/tickformatstop/_value.py b/plotly/validators/layout/scene/zaxis/tickformatstop/_value.py deleted file mode 100644 index 020756a4c6c..00000000000 --- a/plotly/validators/layout/scene/zaxis/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='layout.scene.zaxis.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/title/__init__.py b/plotly/validators/layout/scene/zaxis/title/__init__.py index db7b0c34947..35bddb6e0c1 100644 --- a/plotly/validators/layout/scene/zaxis/title/__init__.py +++ b/plotly/validators/layout/scene/zaxis/title/__init__.py @@ -1,2 +1,63 @@ -from ._text import TextValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='layout.scene.zaxis.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='layout.scene.zaxis.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/scene/zaxis/title/_font.py b/plotly/validators/layout/scene/zaxis/title/_font.py deleted file mode 100644 index 88843e086fc..00000000000 --- a/plotly/validators/layout/scene/zaxis/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='layout.scene.zaxis.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/title/_text.py b/plotly/validators/layout/scene/zaxis/title/_text.py deleted file mode 100644 index fb09d37cdcc..00000000000 --- a/plotly/validators/layout/scene/zaxis/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='layout.scene.zaxis.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/title/font/__init__.py b/plotly/validators/layout/scene/zaxis/title/font/__init__.py index 199d72e71c6..10c27f106da 100644 --- a/plotly/validators/layout/scene/zaxis/title/font/__init__.py +++ b/plotly/validators/layout/scene/zaxis/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.scene.zaxis.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.scene.zaxis.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.scene.zaxis.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/scene/zaxis/title/font/_color.py b/plotly/validators/layout/scene/zaxis/title/font/_color.py deleted file mode 100644 index 6fd558d6a2d..00000000000 --- a/plotly/validators/layout/scene/zaxis/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.scene.zaxis.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/title/font/_family.py b/plotly/validators/layout/scene/zaxis/title/font/_family.py deleted file mode 100644 index 50fb245a1b8..00000000000 --- a/plotly/validators/layout/scene/zaxis/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.scene.zaxis.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/scene/zaxis/title/font/_size.py b/plotly/validators/layout/scene/zaxis/title/font/_size.py deleted file mode 100644 index 449fcb19447..00000000000 --- a/plotly/validators/layout/scene/zaxis/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.scene.zaxis.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/shape/__init__.py b/plotly/validators/layout/shape/__init__.py index ea2006f291e..7b995872ee6 100644 --- a/plotly/validators/layout/shape/__init__.py +++ b/plotly/validators/layout/shape/__init__.py @@ -1,19 +1,342 @@ -from ._ysizemode import YsizemodeValidator -from ._yref import YrefValidator -from ._yanchor import YanchorValidator -from ._y1 import Y1Validator -from ._y0 import Y0Validator -from ._xsizemode import XsizemodeValidator -from ._xref import XrefValidator -from ._xanchor import XanchorValidator -from ._x1 import X1Validator -from ._x0 import X0Validator -from ._visible import VisibleValidator -from ._type import TypeValidator -from ._templateitemname import TemplateitemnameValidator -from ._path import PathValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._line import LineValidator -from ._layer import LayerValidator -from ._fillcolor import FillcolorValidator + + +import _plotly_utils.basevalidators + + +class YsizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ysizemode', parent_name='layout.shape', **kwargs + ): + super(YsizemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['scaled', 'pixel']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='yref', parent_name='layout.shape', **kwargs + ): + super(YrefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['paper', '/^y([2-9]|[1-9][0-9]+)?$/'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='yanchor', parent_name='layout.shape', **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Y1Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='y1', parent_name='layout.shape', **kwargs): + super(Y1Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Y0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='y0', parent_name='layout.shape', **kwargs): + super(Y0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xsizemode', parent_name='layout.shape', **kwargs + ): + super(XsizemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['scaled', 'pixel']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xref', parent_name='layout.shape', **kwargs + ): + super(XrefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['paper', '/^x([2-9]|[1-9][0-9]+)?$/'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='xanchor', parent_name='layout.shape', **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class X1Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='x1', parent_name='layout.shape', **kwargs): + super(X1Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class X0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='x0', parent_name='layout.shape', **kwargs): + super(X0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='layout.shape', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='layout.shape', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['circle', 'rect', 'path', 'line']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.shape', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PathValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='path', parent_name='layout.shape', **kwargs + ): + super(PathValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='layout.shape', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='layout.shape', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='layout.shape', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + width + Sets the line width (in px). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='layer', parent_name='layout.shape', **kwargs + ): + super(LayerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['below', 'above']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='fillcolor', parent_name='layout.shape', **kwargs + ): + super(FillcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/shape/_fillcolor.py b/plotly/validators/layout/shape/_fillcolor.py deleted file mode 100644 index 1eb225a4299..00000000000 --- a/plotly/validators/layout/shape/_fillcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='fillcolor', parent_name='layout.shape', **kwargs - ): - super(FillcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_layer.py b/plotly/validators/layout/shape/_layer.py deleted file mode 100644 index 64d5abcbdb0..00000000000 --- a/plotly/validators/layout/shape/_layer.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='layer', parent_name='layout.shape', **kwargs - ): - super(LayerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['below', 'above']), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_line.py b/plotly/validators/layout/shape/_line.py deleted file mode 100644 index f601236be44..00000000000 --- a/plotly/validators/layout/shape/_line.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='layout.shape', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - width - Sets the line width (in px). -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_name.py b/plotly/validators/layout/shape/_name.py deleted file mode 100644 index 8eed3ee7ca6..00000000000 --- a/plotly/validators/layout/shape/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='layout.shape', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_opacity.py b/plotly/validators/layout/shape/_opacity.py deleted file mode 100644 index 9e0f7e66e82..00000000000 --- a/plotly/validators/layout/shape/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='layout.shape', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_path.py b/plotly/validators/layout/shape/_path.py deleted file mode 100644 index ec72d43efe1..00000000000 --- a/plotly/validators/layout/shape/_path.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class PathValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='path', parent_name='layout.shape', **kwargs - ): - super(PathValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_templateitemname.py b/plotly/validators/layout/shape/_templateitemname.py deleted file mode 100644 index 3836ccc4cd6..00000000000 --- a/plotly/validators/layout/shape/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.shape', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_type.py b/plotly/validators/layout/shape/_type.py deleted file mode 100644 index dd474ecb1a9..00000000000 --- a/plotly/validators/layout/shape/_type.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='layout.shape', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['circle', 'rect', 'path', 'line']), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_visible.py b/plotly/validators/layout/shape/_visible.py deleted file mode 100644 index 116c8dd773c..00000000000 --- a/plotly/validators/layout/shape/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='layout.shape', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_x0.py b/plotly/validators/layout/shape/_x0.py deleted file mode 100644 index 367a62c03e3..00000000000 --- a/plotly/validators/layout/shape/_x0.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class X0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='x0', parent_name='layout.shape', **kwargs): - super(X0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_x1.py b/plotly/validators/layout/shape/_x1.py deleted file mode 100644 index e57784ece34..00000000000 --- a/plotly/validators/layout/shape/_x1.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class X1Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='x1', parent_name='layout.shape', **kwargs): - super(X1Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_xanchor.py b/plotly/validators/layout/shape/_xanchor.py deleted file mode 100644 index 6fc3f7976a6..00000000000 --- a/plotly/validators/layout/shape/_xanchor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='xanchor', parent_name='layout.shape', **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_xref.py b/plotly/validators/layout/shape/_xref.py deleted file mode 100644 index 8de76132d37..00000000000 --- a/plotly/validators/layout/shape/_xref.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class XrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xref', parent_name='layout.shape', **kwargs - ): - super(XrefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['paper', '/^x([2-9]|[1-9][0-9]+)?$/'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_xsizemode.py b/plotly/validators/layout/shape/_xsizemode.py deleted file mode 100644 index 53791c0c63d..00000000000 --- a/plotly/validators/layout/shape/_xsizemode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xsizemode', parent_name='layout.shape', **kwargs - ): - super(XsizemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['scaled', 'pixel']), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_y0.py b/plotly/validators/layout/shape/_y0.py deleted file mode 100644 index 8c61dc5d405..00000000000 --- a/plotly/validators/layout/shape/_y0.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class Y0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='y0', parent_name='layout.shape', **kwargs): - super(Y0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_y1.py b/plotly/validators/layout/shape/_y1.py deleted file mode 100644 index a62bcf5246b..00000000000 --- a/plotly/validators/layout/shape/_y1.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class Y1Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='y1', parent_name='layout.shape', **kwargs): - super(Y1Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_yanchor.py b/plotly/validators/layout/shape/_yanchor.py deleted file mode 100644 index 1985170c79f..00000000000 --- a/plotly/validators/layout/shape/_yanchor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='yanchor', parent_name='layout.shape', **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_yref.py b/plotly/validators/layout/shape/_yref.py deleted file mode 100644 index a48251b4521..00000000000 --- a/plotly/validators/layout/shape/_yref.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class YrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='yref', parent_name='layout.shape', **kwargs - ): - super(YrefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['paper', '/^y([2-9]|[1-9][0-9]+)?$/'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/shape/_ysizemode.py b/plotly/validators/layout/shape/_ysizemode.py deleted file mode 100644 index 9bbf27f6736..00000000000 --- a/plotly/validators/layout/shape/_ysizemode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ysizemode', parent_name='layout.shape', **kwargs - ): - super(YsizemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['scaled', 'pixel']), - **kwargs - ) diff --git a/plotly/validators/layout/shape/line/__init__.py b/plotly/validators/layout/shape/line/__init__.py index d027d05e065..9afd6c6d430 100644 --- a/plotly/validators/layout/shape/line/__init__.py +++ b/plotly/validators/layout/shape/line/__init__.py @@ -1,3 +1,58 @@ -from ._width import WidthValidator -from ._dash import DashValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='layout.shape.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='dash', parent_name='layout.shape.line', **kwargs + ): + super(DashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='layout.shape.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/shape/line/_color.py b/plotly/validators/layout/shape/line/_color.py deleted file mode 100644 index ebff6e5d70d..00000000000 --- a/plotly/validators/layout/shape/line/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='layout.shape.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/shape/line/_dash.py b/plotly/validators/layout/shape/line/_dash.py deleted file mode 100644 index 0a168ffd07c..00000000000 --- a/plotly/validators/layout/shape/line/_dash.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='dash', parent_name='layout.shape.line', **kwargs - ): - super(DashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/shape/line/_width.py b/plotly/validators/layout/shape/line/_width.py deleted file mode 100644 index daa14667c7b..00000000000 --- a/plotly/validators/layout/shape/line/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='layout.shape.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+arraydraw'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/__init__.py b/plotly/validators/layout/slider/__init__.py index 11039560539..1dbaa77efd2 100644 --- a/plotly/validators/layout/slider/__init__.py +++ b/plotly/validators/layout/slider/__init__.py @@ -1,24 +1,553 @@ -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._visible import VisibleValidator -from ._transition import TransitionValidator -from ._tickwidth import TickwidthValidator -from ._ticklen import TicklenValidator -from ._tickcolor import TickcolorValidator -from ._templateitemname import TemplateitemnameValidator -from ._stepdefaults import StepValidator -from ._steps import StepsValidator -from ._pad import PadValidator -from ._name import NameValidator -from ._minorticklen import MinorticklenValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._font import FontValidator -from ._currentvalue import CurrentvalueValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator -from ._activebgcolor import ActivebgcolorValidator -from ._active import ActiveValidator + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='yanchor', parent_name='layout.slider', **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='y', parent_name='layout.slider', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xanchor', parent_name='layout.slider', **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='x', parent_name='layout.slider', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='layout.slider', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TransitionValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='transition', parent_name='layout.slider', **kwargs + ): + super(TransitionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Transition'), + data_docs=kwargs.pop( + 'data_docs', """ + duration + Sets the duration of the slider transition + easing + Sets the easing function of the slider + transition +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='tickwidth', parent_name='layout.slider', **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ticklen', parent_name='layout.slider', **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='tickcolor', parent_name='layout.slider', **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.slider', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StepValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='stepdefaults', + parent_name='layout.slider', + **kwargs + ): + super(StepValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Step'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StepsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, plotly_name='steps', parent_name='layout.slider', **kwargs + ): + super(StepsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Step'), + data_docs=kwargs.pop( + 'data_docs', """ + args + Sets the arguments values to be passed to the + Plotly method set in `method` on slide. + execute + When true, the API method is executed. When + false, all other behaviors are the same and + command execution is skipped. This may be + useful when hooking into, for example, the + `plotly_sliderchange` method and executing the + API command manually without losing the benefit + of the slider automatically binding to the + state of the plot through the specification of + `method` and `args`. + label + Sets the text label to appear on the slider + method + Sets the Plotly method to be called when the + slider value is changed. If the `skip` method + is used, the API slider will function as normal + but 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 slider events manually via JavaScript. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + Sets the value of the slider step, used to + refer to the step programatically. Defaults to + the slider label if not provided. + visible + Determines whether or not this step is included + in the slider. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PadValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='pad', parent_name='layout.slider', **kwargs + ): + super(PadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Pad'), + data_docs=kwargs.pop( + 'data_docs', """ + b + The amount of padding (in px) along the bottom + of the component. + l + The amount of padding (in px) on the left side + of the component. + r + The amount of padding (in px) on the right side + of the component. + t + The amount of padding (in px) along the top of + the component. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='layout.slider', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MinorticklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='minorticklen', + parent_name='layout.slider', + **kwargs + ): + super(MinorticklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='lenmode', parent_name='layout.slider', **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='len', parent_name='layout.slider', **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='layout.slider', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CurrentvalueValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='currentvalue', + parent_name='layout.slider', + **kwargs + ): + super(CurrentvalueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Currentvalue'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets the font of the current value label text. + offset + The amount of space, in pixels, between the + current value label and the slider. + prefix + When currentvalue.visible is true, this sets + the prefix of the label. + suffix + When currentvalue.visible is true, this sets + the suffix of the label. + visible + Shows the currently-selected value above the + slider. + xanchor + The alignment of the value readout relative to + the length of the slider. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='borderwidth', parent_name='layout.slider', **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bordercolor', parent_name='layout.slider', **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='layout.slider', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ActivebgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='activebgcolor', + parent_name='layout.slider', + **kwargs + ): + super(ActivebgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ActiveValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='active', parent_name='layout.slider', **kwargs + ): + super(ActiveValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/slider/_active.py b/plotly/validators/layout/slider/_active.py deleted file mode 100644 index 396a0064ed7..00000000000 --- a/plotly/validators/layout/slider/_active.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ActiveValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='active', parent_name='layout.slider', **kwargs - ): - super(ActiveValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_activebgcolor.py b/plotly/validators/layout/slider/_activebgcolor.py deleted file mode 100644 index 3360958c599..00000000000 --- a/plotly/validators/layout/slider/_activebgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ActivebgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='activebgcolor', - parent_name='layout.slider', - **kwargs - ): - super(ActivebgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_bgcolor.py b/plotly/validators/layout/slider/_bgcolor.py deleted file mode 100644 index 28267f9eae8..00000000000 --- a/plotly/validators/layout/slider/_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='layout.slider', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_bordercolor.py b/plotly/validators/layout/slider/_bordercolor.py deleted file mode 100644 index 836eb88445e..00000000000 --- a/plotly/validators/layout/slider/_bordercolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bordercolor', parent_name='layout.slider', **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_borderwidth.py b/plotly/validators/layout/slider/_borderwidth.py deleted file mode 100644 index 6923c634566..00000000000 --- a/plotly/validators/layout/slider/_borderwidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='borderwidth', parent_name='layout.slider', **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_currentvalue.py b/plotly/validators/layout/slider/_currentvalue.py deleted file mode 100644 index ffc999a940f..00000000000 --- a/plotly/validators/layout/slider/_currentvalue.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class CurrentvalueValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='currentvalue', - parent_name='layout.slider', - **kwargs - ): - super(CurrentvalueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Currentvalue'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets the font of the current value label text. - offset - The amount of space, in pixels, between the - current value label and the slider. - prefix - When currentvalue.visible is true, this sets - the prefix of the label. - suffix - When currentvalue.visible is true, this sets - the suffix of the label. - visible - Shows the currently-selected value above the - slider. - xanchor - The alignment of the value readout relative to - the length of the slider. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_font.py b/plotly/validators/layout/slider/_font.py deleted file mode 100644 index 91ef99d2bc9..00000000000 --- a/plotly/validators/layout/slider/_font.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='layout.slider', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_len.py b/plotly/validators/layout/slider/_len.py deleted file mode 100644 index 30e11dbd393..00000000000 --- a/plotly/validators/layout/slider/_len.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='len', parent_name='layout.slider', **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_lenmode.py b/plotly/validators/layout/slider/_lenmode.py deleted file mode 100644 index 644f340406e..00000000000 --- a/plotly/validators/layout/slider/_lenmode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='lenmode', parent_name='layout.slider', **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_minorticklen.py b/plotly/validators/layout/slider/_minorticklen.py deleted file mode 100644 index 8e983133f50..00000000000 --- a/plotly/validators/layout/slider/_minorticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class MinorticklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='minorticklen', - parent_name='layout.slider', - **kwargs - ): - super(MinorticklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_name.py b/plotly/validators/layout/slider/_name.py deleted file mode 100644 index 00109cf04b6..00000000000 --- a/plotly/validators/layout/slider/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='layout.slider', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_pad.py b/plotly/validators/layout/slider/_pad.py deleted file mode 100644 index 4c596a4903d..00000000000 --- a/plotly/validators/layout/slider/_pad.py +++ /dev/null @@ -1,30 +0,0 @@ -import _plotly_utils.basevalidators - - -class PadValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='pad', parent_name='layout.slider', **kwargs - ): - super(PadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Pad'), - data_docs=kwargs.pop( - 'data_docs', """ - b - The amount of padding (in px) along the bottom - of the component. - l - The amount of padding (in px) on the left side - of the component. - r - The amount of padding (in px) on the right side - of the component. - t - The amount of padding (in px) along the top of - the component. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_stepdefaults.py b/plotly/validators/layout/slider/_stepdefaults.py deleted file mode 100644 index 1642076074e..00000000000 --- a/plotly/validators/layout/slider/_stepdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class StepValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='stepdefaults', - parent_name='layout.slider', - **kwargs - ): - super(StepValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Step'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_steps.py b/plotly/validators/layout/slider/_steps.py deleted file mode 100644 index bdb4c293e75..00000000000 --- a/plotly/validators/layout/slider/_steps.py +++ /dev/null @@ -1,69 +0,0 @@ -import _plotly_utils.basevalidators - - -class StepsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, plotly_name='steps', parent_name='layout.slider', **kwargs - ): - super(StepsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Step'), - data_docs=kwargs.pop( - 'data_docs', """ - args - Sets the arguments values to be passed to the - Plotly method set in `method` on slide. - execute - When true, the API method is executed. When - false, all other behaviors are the same and - command execution is skipped. This may be - useful when hooking into, for example, the - `plotly_sliderchange` method and executing the - API command manually without losing the benefit - of the slider automatically binding to the - state of the plot through the specification of - `method` and `args`. - label - Sets the text label to appear on the slider - method - Sets the Plotly method to be called when the - slider value is changed. If the `skip` method - is used, the API slider will function as normal - but 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 slider events manually via JavaScript. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - Sets the value of the slider step, used to - refer to the step programatically. Defaults to - the slider label if not provided. - visible - Determines whether or not this step is included - in the slider. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_templateitemname.py b/plotly/validators/layout/slider/_templateitemname.py deleted file mode 100644 index 1c32e56a8b4..00000000000 --- a/plotly/validators/layout/slider/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.slider', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_tickcolor.py b/plotly/validators/layout/slider/_tickcolor.py deleted file mode 100644 index 95971f76753..00000000000 --- a/plotly/validators/layout/slider/_tickcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='tickcolor', parent_name='layout.slider', **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_ticklen.py b/plotly/validators/layout/slider/_ticklen.py deleted file mode 100644 index 675850e6295..00000000000 --- a/plotly/validators/layout/slider/_ticklen.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ticklen', parent_name='layout.slider', **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_tickwidth.py b/plotly/validators/layout/slider/_tickwidth.py deleted file mode 100644 index b8916e48b4e..00000000000 --- a/plotly/validators/layout/slider/_tickwidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='tickwidth', parent_name='layout.slider', **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_transition.py b/plotly/validators/layout/slider/_transition.py deleted file mode 100644 index f830c9b220d..00000000000 --- a/plotly/validators/layout/slider/_transition.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class TransitionValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='transition', parent_name='layout.slider', **kwargs - ): - super(TransitionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Transition'), - data_docs=kwargs.pop( - 'data_docs', """ - duration - Sets the duration of the slider transition - easing - Sets the easing function of the slider - transition -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_visible.py b/plotly/validators/layout/slider/_visible.py deleted file mode 100644 index f995ba73d10..00000000000 --- a/plotly/validators/layout/slider/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='layout.slider', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_x.py b/plotly/validators/layout/slider/_x.py deleted file mode 100644 index ef062688d51..00000000000 --- a/plotly/validators/layout/slider/_x.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='x', parent_name='layout.slider', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_xanchor.py b/plotly/validators/layout/slider/_xanchor.py deleted file mode 100644 index 2641587858f..00000000000 --- a/plotly/validators/layout/slider/_xanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xanchor', parent_name='layout.slider', **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_y.py b/plotly/validators/layout/slider/_y.py deleted file mode 100644 index e19f0655623..00000000000 --- a/plotly/validators/layout/slider/_y.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='y', parent_name='layout.slider', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/_yanchor.py b/plotly/validators/layout/slider/_yanchor.py deleted file mode 100644 index 5346b801aa5..00000000000 --- a/plotly/validators/layout/slider/_yanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='yanchor', parent_name='layout.slider', **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/layout/slider/currentvalue/__init__.py b/plotly/validators/layout/slider/currentvalue/__init__.py index 4c520d55af0..9e15f01464d 100644 --- a/plotly/validators/layout/slider/currentvalue/__init__.py +++ b/plotly/validators/layout/slider/currentvalue/__init__.py @@ -1,6 +1,144 @@ -from ._xanchor import XanchorValidator -from ._visible import VisibleValidator -from ._suffix import SuffixValidator -from ._prefix import PrefixValidator -from ._offset import OffsetValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='layout.slider.currentvalue', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='visible', + parent_name='layout.slider.currentvalue', + **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='suffix', + parent_name='layout.slider.currentvalue', + **kwargs + ): + super(SuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PrefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='prefix', + parent_name='layout.slider.currentvalue', + **kwargs + ): + super(PrefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OffsetValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='offset', + parent_name='layout.slider.currentvalue', + **kwargs + ): + super(OffsetValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='layout.slider.currentvalue', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/slider/currentvalue/_font.py b/plotly/validators/layout/slider/currentvalue/_font.py deleted file mode 100644 index c6a5b572c26..00000000000 --- a/plotly/validators/layout/slider/currentvalue/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='layout.slider.currentvalue', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/slider/currentvalue/_offset.py b/plotly/validators/layout/slider/currentvalue/_offset.py deleted file mode 100644 index 5ee69aa7228..00000000000 --- a/plotly/validators/layout/slider/currentvalue/_offset.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OffsetValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='offset', - parent_name='layout.slider.currentvalue', - **kwargs - ): - super(OffsetValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/currentvalue/_prefix.py b/plotly/validators/layout/slider/currentvalue/_prefix.py deleted file mode 100644 index 1154ab2961b..00000000000 --- a/plotly/validators/layout/slider/currentvalue/_prefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class PrefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='prefix', - parent_name='layout.slider.currentvalue', - **kwargs - ): - super(PrefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/currentvalue/_suffix.py b/plotly/validators/layout/slider/currentvalue/_suffix.py deleted file mode 100644 index 4d534e51ea9..00000000000 --- a/plotly/validators/layout/slider/currentvalue/_suffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='suffix', - parent_name='layout.slider.currentvalue', - **kwargs - ): - super(SuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/currentvalue/_visible.py b/plotly/validators/layout/slider/currentvalue/_visible.py deleted file mode 100644 index c0f5af93683..00000000000 --- a/plotly/validators/layout/slider/currentvalue/_visible.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='visible', - parent_name='layout.slider.currentvalue', - **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/currentvalue/_xanchor.py b/plotly/validators/layout/slider/currentvalue/_xanchor.py deleted file mode 100644 index a3a8f3fb68f..00000000000 --- a/plotly/validators/layout/slider/currentvalue/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='layout.slider.currentvalue', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/layout/slider/currentvalue/font/__init__.py b/plotly/validators/layout/slider/currentvalue/font/__init__.py index 199d72e71c6..90a126b71d6 100644 --- a/plotly/validators/layout/slider/currentvalue/font/__init__.py +++ b/plotly/validators/layout/slider/currentvalue/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.slider.currentvalue.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.slider.currentvalue.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.slider.currentvalue.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/slider/currentvalue/font/_color.py b/plotly/validators/layout/slider/currentvalue/font/_color.py deleted file mode 100644 index 539d78574ce..00000000000 --- a/plotly/validators/layout/slider/currentvalue/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.slider.currentvalue.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/currentvalue/font/_family.py b/plotly/validators/layout/slider/currentvalue/font/_family.py deleted file mode 100644 index dcca9138907..00000000000 --- a/plotly/validators/layout/slider/currentvalue/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.slider.currentvalue.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/slider/currentvalue/font/_size.py b/plotly/validators/layout/slider/currentvalue/font/_size.py deleted file mode 100644 index 887559d08f6..00000000000 --- a/plotly/validators/layout/slider/currentvalue/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.slider.currentvalue.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/font/__init__.py b/plotly/validators/layout/slider/font/__init__.py index 199d72e71c6..cfd80a1fca9 100644 --- a/plotly/validators/layout/slider/font/__init__.py +++ b/plotly/validators/layout/slider/font/__init__.py @@ -1,3 +1,54 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='layout.slider.font', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='layout.slider.font', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='layout.slider.font', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/slider/font/_color.py b/plotly/validators/layout/slider/font/_color.py deleted file mode 100644 index 09f9e74b20f..00000000000 --- a/plotly/validators/layout/slider/font/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='layout.slider.font', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/font/_family.py b/plotly/validators/layout/slider/font/_family.py deleted file mode 100644 index 6229ca56393..00000000000 --- a/plotly/validators/layout/slider/font/_family.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='layout.slider.font', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/slider/font/_size.py b/plotly/validators/layout/slider/font/_size.py deleted file mode 100644 index c6ea0a989c3..00000000000 --- a/plotly/validators/layout/slider/font/_size.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='layout.slider.font', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/pad/__init__.py b/plotly/validators/layout/slider/pad/__init__.py index f2aa8ac13b5..99f3b652023 100644 --- a/plotly/validators/layout/slider/pad/__init__.py +++ b/plotly/validators/layout/slider/pad/__init__.py @@ -1,4 +1,68 @@ -from ._t import TValidator -from ._r import RValidator -from ._l import LValidator -from ._b import BValidator + + +import _plotly_utils.basevalidators + + +class TValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='t', parent_name='layout.slider.pad', **kwargs + ): + super(TValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='r', parent_name='layout.slider.pad', **kwargs + ): + super(RValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='l', parent_name='layout.slider.pad', **kwargs + ): + super(LValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='b', parent_name='layout.slider.pad', **kwargs + ): + super(BValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/slider/pad/_b.py b/plotly/validators/layout/slider/pad/_b.py deleted file mode 100644 index 8ed9f7a026f..00000000000 --- a/plotly/validators/layout/slider/pad/_b.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='b', parent_name='layout.slider.pad', **kwargs - ): - super(BValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/pad/_l.py b/plotly/validators/layout/slider/pad/_l.py deleted file mode 100644 index be5fd61c3ee..00000000000 --- a/plotly/validators/layout/slider/pad/_l.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='l', parent_name='layout.slider.pad', **kwargs - ): - super(LValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/pad/_r.py b/plotly/validators/layout/slider/pad/_r.py deleted file mode 100644 index a946c7d04d1..00000000000 --- a/plotly/validators/layout/slider/pad/_r.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class RValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='r', parent_name='layout.slider.pad', **kwargs - ): - super(RValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/pad/_t.py b/plotly/validators/layout/slider/pad/_t.py deleted file mode 100644 index 71f8189b683..00000000000 --- a/plotly/validators/layout/slider/pad/_t.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='t', parent_name='layout.slider.pad', **kwargs - ): - super(TValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/step/__init__.py b/plotly/validators/layout/slider/step/__init__.py index 98bfb89e97e..ae449c865ad 100644 --- a/plotly/validators/layout/slider/step/__init__.py +++ b/plotly/validators/layout/slider/step/__init__.py @@ -1,8 +1,163 @@ -from ._visible import VisibleValidator -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._method import MethodValidator -from ._label import LabelValidator -from ._execute import ExecuteValidator -from ._args import ArgsValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='visible', + parent_name='layout.slider.step', + **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='value', parent_name='layout.slider.step', **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.slider.step', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='layout.slider.step', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MethodValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='method', parent_name='layout.slider.step', **kwargs + ): + super(MethodValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['restyle', 'relayout', 'animate', 'update', 'skip'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='label', parent_name='layout.slider.step', **kwargs + ): + super(LabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExecuteValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='execute', + parent_name='layout.slider.step', + **kwargs + ): + super(ExecuteValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArgsValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='args', parent_name='layout.slider.step', **kwargs + ): + super(ArgsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + free_length=kwargs.pop('free_length', True), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'arraydraw' + }, { + 'valType': 'any', + 'editType': 'arraydraw' + }, { + 'valType': 'any', + 'editType': 'arraydraw' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/slider/step/_args.py b/plotly/validators/layout/slider/step/_args.py deleted file mode 100644 index 7e7066069b9..00000000000 --- a/plotly/validators/layout/slider/step/_args.py +++ /dev/null @@ -1,30 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArgsValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='args', parent_name='layout.slider.step', **kwargs - ): - super(ArgsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - free_length=kwargs.pop('free_length', True), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'arraydraw' - }, { - 'valType': 'any', - 'editType': 'arraydraw' - }, { - 'valType': 'any', - 'editType': 'arraydraw' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/step/_execute.py b/plotly/validators/layout/slider/step/_execute.py deleted file mode 100644 index f43eea2c39a..00000000000 --- a/plotly/validators/layout/slider/step/_execute.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExecuteValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='execute', - parent_name='layout.slider.step', - **kwargs - ): - super(ExecuteValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/step/_label.py b/plotly/validators/layout/slider/step/_label.py deleted file mode 100644 index aa40a30cd69..00000000000 --- a/plotly/validators/layout/slider/step/_label.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='label', parent_name='layout.slider.step', **kwargs - ): - super(LabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/step/_method.py b/plotly/validators/layout/slider/step/_method.py deleted file mode 100644 index 424b1e9a587..00000000000 --- a/plotly/validators/layout/slider/step/_method.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class MethodValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='method', parent_name='layout.slider.step', **kwargs - ): - super(MethodValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['restyle', 'relayout', 'animate', 'update', 'skip'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/slider/step/_name.py b/plotly/validators/layout/slider/step/_name.py deleted file mode 100644 index c393b9c13e9..00000000000 --- a/plotly/validators/layout/slider/step/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='layout.slider.step', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/step/_templateitemname.py b/plotly/validators/layout/slider/step/_templateitemname.py deleted file mode 100644 index 9ab58f356a6..00000000000 --- a/plotly/validators/layout/slider/step/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.slider.step', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/step/_value.py b/plotly/validators/layout/slider/step/_value.py deleted file mode 100644 index a1231f75a07..00000000000 --- a/plotly/validators/layout/slider/step/_value.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='value', parent_name='layout.slider.step', **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/step/_visible.py b/plotly/validators/layout/slider/step/_visible.py deleted file mode 100644 index d0bf83bf33c..00000000000 --- a/plotly/validators/layout/slider/step/_visible.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='visible', - parent_name='layout.slider.step', - **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/transition/__init__.py b/plotly/validators/layout/slider/transition/__init__.py index a128142121f..be9c3c2c5e8 100644 --- a/plotly/validators/layout/slider/transition/__init__.py +++ b/plotly/validators/layout/slider/transition/__init__.py @@ -1,2 +1,54 @@ -from ._easing import EasingValidator -from ._duration import DurationValidator + + +import _plotly_utils.basevalidators + + +class EasingValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='easing', + parent_name='layout.slider.transition', + **kwargs + ): + super(EasingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'linear', 'quad', 'cubic', 'sin', 'exp', 'circle', + 'elastic', 'back', 'bounce', 'linear-in', 'quad-in', + 'cubic-in', 'sin-in', 'exp-in', 'circle-in', 'elastic-in', + 'back-in', 'bounce-in', 'linear-out', 'quad-out', + 'cubic-out', 'sin-out', 'exp-out', 'circle-out', + 'elastic-out', 'back-out', 'bounce-out', 'linear-in-out', + 'quad-in-out', 'cubic-in-out', 'sin-in-out', 'exp-in-out', + 'circle-in-out', 'elastic-in-out', 'back-in-out', + 'bounce-in-out' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DurationValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='duration', + parent_name='layout.slider.transition', + **kwargs + ): + super(DurationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/slider/transition/_duration.py b/plotly/validators/layout/slider/transition/_duration.py deleted file mode 100644 index 76009eea763..00000000000 --- a/plotly/validators/layout/slider/transition/_duration.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DurationValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='duration', - parent_name='layout.slider.transition', - **kwargs - ): - super(DurationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/slider/transition/_easing.py b/plotly/validators/layout/slider/transition/_easing.py deleted file mode 100644 index 4a4c4d06245..00000000000 --- a/plotly/validators/layout/slider/transition/_easing.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class EasingValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='easing', - parent_name='layout.slider.transition', - **kwargs - ): - super(EasingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'linear', 'quad', 'cubic', 'sin', 'exp', 'circle', - 'elastic', 'back', 'bounce', 'linear-in', 'quad-in', - 'cubic-in', 'sin-in', 'exp-in', 'circle-in', 'elastic-in', - 'back-in', 'bounce-in', 'linear-out', 'quad-out', - 'cubic-out', 'sin-out', 'exp-out', 'circle-out', - 'elastic-out', 'back-out', 'bounce-out', 'linear-in-out', - 'quad-in-out', 'cubic-in-out', 'sin-in-out', 'exp-in-out', - 'circle-in-out', 'elastic-in-out', 'back-in-out', - 'bounce-in-out' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/template/__init__.py b/plotly/validators/layout/template/__init__.py index 720a1c7931c..1ca73de9683 100644 --- a/plotly/validators/layout/template/__init__.py +++ b/plotly/validators/layout/template/__init__.py @@ -1,2 +1,156 @@ -from ._layout import LayoutValidator -from ._data import DataValidator + + +import _plotly_utils.basevalidators + + +class LayoutValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='layout', parent_name='layout.template', **kwargs + ): + super(LayoutValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Layout'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DataValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='data', parent_name='layout.template', **kwargs + ): + super(DataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Data'), + data_docs=kwargs.pop( + 'data_docs', """ + area + plotly.graph_objs.layout.template.data.Area + instance or dict with compatible properties + barpolar + plotly.graph_objs.layout.template.data.Barpolar + instance or dict with compatible properties + bar + plotly.graph_objs.layout.template.data.Bar + instance or dict with compatible properties + box + plotly.graph_objs.layout.template.data.Box + instance or dict with compatible properties + candlestick + plotly.graph_objs.layout.template.data.Candlest + ick instance or dict with compatible properties + carpet + plotly.graph_objs.layout.template.data.Carpet + instance or dict with compatible properties + choropleth + plotly.graph_objs.layout.template.data.Chorople + th instance or dict with compatible properties + cone + plotly.graph_objs.layout.template.data.Cone + instance or dict with compatible properties + contourcarpet + plotly.graph_objs.layout.template.data.Contourc + arpet instance or dict with compatible + properties + contour + plotly.graph_objs.layout.template.data.Contour + instance or dict with compatible properties + heatmapgl + plotly.graph_objs.layout.template.data.Heatmapg + l instance or dict with compatible properties + heatmap + plotly.graph_objs.layout.template.data.Heatmap + instance or dict with compatible properties + histogram2dcontour + plotly.graph_objs.layout.template.data.Histogra + m2dContour instance or dict with compatible + properties + histogram2d + plotly.graph_objs.layout.template.data.Histogra + m2d instance or dict with compatible properties + histogram + plotly.graph_objs.layout.template.data.Histogra + m instance or dict with compatible properties + isosurface + plotly.graph_objs.layout.template.data.Isosurfa + ce instance or dict with compatible properties + mesh3d + plotly.graph_objs.layout.template.data.Mesh3d + instance or dict with compatible properties + ohlc + plotly.graph_objs.layout.template.data.Ohlc + instance or dict with compatible properties + parcats + plotly.graph_objs.layout.template.data.Parcats + instance or dict with compatible properties + parcoords + plotly.graph_objs.layout.template.data.Parcoord + s instance or dict with compatible properties + pie + plotly.graph_objs.layout.template.data.Pie + instance or dict with compatible properties + pointcloud + plotly.graph_objs.layout.template.data.Pointclo + ud instance or dict with compatible properties + sankey + plotly.graph_objs.layout.template.data.Sankey + instance or dict with compatible properties + scatter3d + plotly.graph_objs.layout.template.data.Scatter3 + d instance or dict with compatible properties + scattercarpet + plotly.graph_objs.layout.template.data.Scatterc + arpet instance or dict with compatible + properties + scattergeo + plotly.graph_objs.layout.template.data.Scatterg + eo instance or dict with compatible properties + scattergl + plotly.graph_objs.layout.template.data.Scatterg + l instance or dict with compatible properties + scattermapbox + plotly.graph_objs.layout.template.data.Scatterm + apbox instance or dict with compatible + properties + scatterpolargl + plotly.graph_objs.layout.template.data.Scatterp + olargl instance or dict with compatible + properties + scatterpolar + plotly.graph_objs.layout.template.data.Scatterp + olar instance or dict with compatible + properties + scatter + plotly.graph_objs.layout.template.data.Scatter + instance or dict with compatible properties + scatterternary + plotly.graph_objs.layout.template.data.Scattert + ernary instance or dict with compatible + properties + splom + plotly.graph_objs.layout.template.data.Splom + instance or dict with compatible properties + streamtube + plotly.graph_objs.layout.template.data.Streamtu + be instance or dict with compatible properties + surface + plotly.graph_objs.layout.template.data.Surface + instance or dict with compatible properties + table + plotly.graph_objs.layout.template.data.Table + instance or dict with compatible properties + violin + plotly.graph_objs.layout.template.data.Violin + instance or dict with compatible properties +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/template/_data.py b/plotly/validators/layout/template/_data.py deleted file mode 100644 index c81d242de5c..00000000000 --- a/plotly/validators/layout/template/_data.py +++ /dev/null @@ -1,136 +0,0 @@ -import _plotly_utils.basevalidators - - -class DataValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='data', parent_name='layout.template', **kwargs - ): - super(DataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Data'), - data_docs=kwargs.pop( - 'data_docs', """ - area - plotly.graph_objs.layout.template.data.Area - instance or dict with compatible properties - barpolar - plotly.graph_objs.layout.template.data.Barpolar - instance or dict with compatible properties - bar - plotly.graph_objs.layout.template.data.Bar - instance or dict with compatible properties - box - plotly.graph_objs.layout.template.data.Box - instance or dict with compatible properties - candlestick - plotly.graph_objs.layout.template.data.Candlest - ick instance or dict with compatible properties - carpet - plotly.graph_objs.layout.template.data.Carpet - instance or dict with compatible properties - choropleth - plotly.graph_objs.layout.template.data.Chorople - th instance or dict with compatible properties - cone - plotly.graph_objs.layout.template.data.Cone - instance or dict with compatible properties - contourcarpet - plotly.graph_objs.layout.template.data.Contourc - arpet instance or dict with compatible - properties - contour - plotly.graph_objs.layout.template.data.Contour - instance or dict with compatible properties - heatmapgl - plotly.graph_objs.layout.template.data.Heatmapg - l instance or dict with compatible properties - heatmap - plotly.graph_objs.layout.template.data.Heatmap - instance or dict with compatible properties - histogram2dcontour - plotly.graph_objs.layout.template.data.Histogra - m2dContour instance or dict with compatible - properties - histogram2d - plotly.graph_objs.layout.template.data.Histogra - m2d instance or dict with compatible properties - histogram - plotly.graph_objs.layout.template.data.Histogra - m instance or dict with compatible properties - isosurface - plotly.graph_objs.layout.template.data.Isosurfa - ce instance or dict with compatible properties - mesh3d - plotly.graph_objs.layout.template.data.Mesh3d - instance or dict with compatible properties - ohlc - plotly.graph_objs.layout.template.data.Ohlc - instance or dict with compatible properties - parcats - plotly.graph_objs.layout.template.data.Parcats - instance or dict with compatible properties - parcoords - plotly.graph_objs.layout.template.data.Parcoord - s instance or dict with compatible properties - pie - plotly.graph_objs.layout.template.data.Pie - instance or dict with compatible properties - pointcloud - plotly.graph_objs.layout.template.data.Pointclo - ud instance or dict with compatible properties - sankey - plotly.graph_objs.layout.template.data.Sankey - instance or dict with compatible properties - scatter3d - plotly.graph_objs.layout.template.data.Scatter3 - d instance or dict with compatible properties - scattercarpet - plotly.graph_objs.layout.template.data.Scatterc - arpet instance or dict with compatible - properties - scattergeo - plotly.graph_objs.layout.template.data.Scatterg - eo instance or dict with compatible properties - scattergl - plotly.graph_objs.layout.template.data.Scatterg - l instance or dict with compatible properties - scattermapbox - plotly.graph_objs.layout.template.data.Scatterm - apbox instance or dict with compatible - properties - scatterpolargl - plotly.graph_objs.layout.template.data.Scatterp - olargl instance or dict with compatible - properties - scatterpolar - plotly.graph_objs.layout.template.data.Scatterp - olar instance or dict with compatible - properties - scatter - plotly.graph_objs.layout.template.data.Scatter - instance or dict with compatible properties - scatterternary - plotly.graph_objs.layout.template.data.Scattert - ernary instance or dict with compatible - properties - splom - plotly.graph_objs.layout.template.data.Splom - instance or dict with compatible properties - streamtube - plotly.graph_objs.layout.template.data.Streamtu - be instance or dict with compatible properties - surface - plotly.graph_objs.layout.template.data.Surface - instance or dict with compatible properties - table - plotly.graph_objs.layout.template.data.Table - instance or dict with compatible properties - violin - plotly.graph_objs.layout.template.data.Violin - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/template/_layout.py b/plotly/validators/layout/template/_layout.py deleted file mode 100644 index 324aaee33d5..00000000000 --- a/plotly/validators/layout/template/_layout.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LayoutValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='layout', parent_name='layout.template', **kwargs - ): - super(LayoutValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Layout'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/__init__.py b/plotly/validators/layout/template/data/__init__.py index 7ca215d2884..37d77eaac25 100644 --- a/plotly/validators/layout/template/data/__init__.py +++ b/plotly/validators/layout/template/data/__init__.py @@ -1,37 +1,787 @@ -from ._violin import ViolinsValidator -from ._table import TablesValidator -from ._surface import SurfacesValidator -from ._streamtube import StreamtubesValidator -from ._splom import SplomsValidator -from ._scatterternary import ScatterternarysValidator -from ._scatter import ScattersValidator -from ._scatterpolar import ScatterpolarsValidator -from ._scatterpolargl import ScatterpolarglsValidator -from ._scattermapbox import ScattermapboxsValidator -from ._scattergl import ScatterglsValidator -from ._scattergeo import ScattergeosValidator -from ._scattercarpet import ScattercarpetsValidator -from ._scatter3d import Scatter3dsValidator -from ._sankey import SankeysValidator -from ._pointcloud import PointcloudsValidator -from ._pie import PiesValidator -from ._parcoords import ParcoordssValidator -from ._parcats import ParcatssValidator -from ._ohlc import OhlcsValidator -from ._mesh3d import Mesh3dsValidator -from ._isosurface import IsosurfacesValidator -from ._histogram import HistogramsValidator -from ._histogram2d import Histogram2dsValidator -from ._histogram2dcontour import Histogram2dContoursValidator -from ._heatmap import HeatmapsValidator -from ._heatmapgl import HeatmapglsValidator -from ._contour import ContoursValidator -from ._contourcarpet import ContourcarpetsValidator -from ._cone import ConesValidator -from ._choropleth import ChoroplethsValidator -from ._carpet import CarpetsValidator -from ._candlestick import CandlesticksValidator -from ._box import BoxsValidator -from ._bar import BarsValidator -from ._barpolar import BarpolarsValidator -from ._area import AreasValidator + + +import _plotly_utils.basevalidators + + +class ViolinsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='violin', + parent_name='layout.template.data', + **kwargs + ): + super(ViolinsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Violin'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TablesValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='table', + parent_name='layout.template.data', + **kwargs + ): + super(TablesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Table'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SurfacesValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='surface', + parent_name='layout.template.data', + **kwargs + ): + super(SurfacesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Surface'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamtubesValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='streamtube', + parent_name='layout.template.data', + **kwargs + ): + super(StreamtubesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Streamtube'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SplomsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='splom', + parent_name='layout.template.data', + **kwargs + ): + super(SplomsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Splom'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScatterternarysValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='scatterternary', + parent_name='layout.template.data', + **kwargs + ): + super(ScatterternarysValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scatterternary'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScattersValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='scatter', + parent_name='layout.template.data', + **kwargs + ): + super(ScattersValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scatter'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScatterpolarsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='scatterpolar', + parent_name='layout.template.data', + **kwargs + ): + super(ScatterpolarsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scatterpolar'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScatterpolarglsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='scatterpolargl', + parent_name='layout.template.data', + **kwargs + ): + super(ScatterpolarglsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scatterpolargl'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScattermapboxsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='scattermapbox', + parent_name='layout.template.data', + **kwargs + ): + super(ScattermapboxsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scattermapbox'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScatterglsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='scattergl', + parent_name='layout.template.data', + **kwargs + ): + super(ScatterglsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scattergl'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScattergeosValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='scattergeo', + parent_name='layout.template.data', + **kwargs + ): + super(ScattergeosValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scattergeo'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScattercarpetsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='scattercarpet', + parent_name='layout.template.data', + **kwargs + ): + super(ScattercarpetsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scattercarpet'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Scatter3dsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='scatter3d', + parent_name='layout.template.data', + **kwargs + ): + super(Scatter3dsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Scatter3d'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SankeysValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='sankey', + parent_name='layout.template.data', + **kwargs + ): + super(SankeysValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Sankey'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PointcloudsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='pointcloud', + parent_name='layout.template.data', + **kwargs + ): + super(PointcloudsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Pointcloud'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PiesValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, plotly_name='pie', parent_name='layout.template.data', **kwargs + ): + super(PiesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Pie'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ParcoordssValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='parcoords', + parent_name='layout.template.data', + **kwargs + ): + super(ParcoordssValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Parcoords'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ParcatssValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='parcats', + parent_name='layout.template.data', + **kwargs + ): + super(ParcatssValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Parcats'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OhlcsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, plotly_name='ohlc', parent_name='layout.template.data', **kwargs + ): + super(OhlcsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Ohlc'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Mesh3dsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='mesh3d', + parent_name='layout.template.data', + **kwargs + ): + super(Mesh3dsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Mesh3d'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IsosurfacesValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='isosurface', + parent_name='layout.template.data', + **kwargs + ): + super(IsosurfacesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Isosurface'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HistogramsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='histogram', + parent_name='layout.template.data', + **kwargs + ): + super(HistogramsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Histogram'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Histogram2dsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='histogram2d', + parent_name='layout.template.data', + **kwargs + ): + super(Histogram2dsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Histogram2d'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Histogram2dContoursValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='histogram2dcontour', + parent_name='layout.template.data', + **kwargs + ): + super(Histogram2dContoursValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Histogram2dContour'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HeatmapsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='heatmap', + parent_name='layout.template.data', + **kwargs + ): + super(HeatmapsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Heatmap'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HeatmapglsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='heatmapgl', + parent_name='layout.template.data', + **kwargs + ): + super(HeatmapglsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Heatmapgl'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ContoursValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='contour', + parent_name='layout.template.data', + **kwargs + ): + super(ContoursValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Contour'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ContourcarpetsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='contourcarpet', + parent_name='layout.template.data', + **kwargs + ): + super(ContourcarpetsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Contourcarpet'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConesValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, plotly_name='cone', parent_name='layout.template.data', **kwargs + ): + super(ConesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Cone'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ChoroplethsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='choropleth', + parent_name='layout.template.data', + **kwargs + ): + super(ChoroplethsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Choropleth'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CarpetsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='carpet', + parent_name='layout.template.data', + **kwargs + ): + super(CarpetsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Carpet'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CandlesticksValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='candlestick', + parent_name='layout.template.data', + **kwargs + ): + super(CandlesticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Candlestick'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BoxsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, plotly_name='box', parent_name='layout.template.data', **kwargs + ): + super(BoxsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Box'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BarsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, plotly_name='bar', parent_name='layout.template.data', **kwargs + ): + super(BarsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Bar'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BarpolarsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='barpolar', + parent_name='layout.template.data', + **kwargs + ): + super(BarpolarsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Barpolar'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AreasValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, plotly_name='area', parent_name='layout.template.data', **kwargs + ): + super(AreasValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Area'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) diff --git a/plotly/validators/layout/template/data/_area.py b/plotly/validators/layout/template/data/_area.py deleted file mode 100644 index 3727d62c703..00000000000 --- a/plotly/validators/layout/template/data/_area.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AreasValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, plotly_name='area', parent_name='layout.template.data', **kwargs - ): - super(AreasValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Area'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_bar.py b/plotly/validators/layout/template/data/_bar.py deleted file mode 100644 index 1478fdad61e..00000000000 --- a/plotly/validators/layout/template/data/_bar.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BarsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, plotly_name='bar', parent_name='layout.template.data', **kwargs - ): - super(BarsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Bar'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_barpolar.py b/plotly/validators/layout/template/data/_barpolar.py deleted file mode 100644 index a7e1fefab9e..00000000000 --- a/plotly/validators/layout/template/data/_barpolar.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BarpolarsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='barpolar', - parent_name='layout.template.data', - **kwargs - ): - super(BarpolarsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Barpolar'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_box.py b/plotly/validators/layout/template/data/_box.py deleted file mode 100644 index f6b02732158..00000000000 --- a/plotly/validators/layout/template/data/_box.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BoxsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, plotly_name='box', parent_name='layout.template.data', **kwargs - ): - super(BoxsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Box'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_candlestick.py b/plotly/validators/layout/template/data/_candlestick.py deleted file mode 100644 index c621904edb4..00000000000 --- a/plotly/validators/layout/template/data/_candlestick.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class CandlesticksValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='candlestick', - parent_name='layout.template.data', - **kwargs - ): - super(CandlesticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Candlestick'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_carpet.py b/plotly/validators/layout/template/data/_carpet.py deleted file mode 100644 index b8e8406d594..00000000000 --- a/plotly/validators/layout/template/data/_carpet.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CarpetsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='carpet', - parent_name='layout.template.data', - **kwargs - ): - super(CarpetsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Carpet'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_choropleth.py b/plotly/validators/layout/template/data/_choropleth.py deleted file mode 100644 index e86be98dc02..00000000000 --- a/plotly/validators/layout/template/data/_choropleth.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ChoroplethsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='choropleth', - parent_name='layout.template.data', - **kwargs - ): - super(ChoroplethsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Choropleth'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_cone.py b/plotly/validators/layout/template/data/_cone.py deleted file mode 100644 index 9d4e1d042ad..00000000000 --- a/plotly/validators/layout/template/data/_cone.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConesValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, plotly_name='cone', parent_name='layout.template.data', **kwargs - ): - super(ConesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Cone'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_contour.py b/plotly/validators/layout/template/data/_contour.py deleted file mode 100644 index a0744beb8db..00000000000 --- a/plotly/validators/layout/template/data/_contour.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ContoursValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='contour', - parent_name='layout.template.data', - **kwargs - ): - super(ContoursValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Contour'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_contourcarpet.py b/plotly/validators/layout/template/data/_contourcarpet.py deleted file mode 100644 index 2311351de9a..00000000000 --- a/plotly/validators/layout/template/data/_contourcarpet.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ContourcarpetsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='contourcarpet', - parent_name='layout.template.data', - **kwargs - ): - super(ContourcarpetsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Contourcarpet'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_heatmap.py b/plotly/validators/layout/template/data/_heatmap.py deleted file mode 100644 index 33d42a10b8f..00000000000 --- a/plotly/validators/layout/template/data/_heatmap.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class HeatmapsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='heatmap', - parent_name='layout.template.data', - **kwargs - ): - super(HeatmapsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Heatmap'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_heatmapgl.py b/plotly/validators/layout/template/data/_heatmapgl.py deleted file mode 100644 index bedab12f860..00000000000 --- a/plotly/validators/layout/template/data/_heatmapgl.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class HeatmapglsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='heatmapgl', - parent_name='layout.template.data', - **kwargs - ): - super(HeatmapglsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Heatmapgl'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_histogram.py b/plotly/validators/layout/template/data/_histogram.py deleted file mode 100644 index 60561f47dcd..00000000000 --- a/plotly/validators/layout/template/data/_histogram.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class HistogramsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='histogram', - parent_name='layout.template.data', - **kwargs - ): - super(HistogramsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Histogram'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_histogram2d.py b/plotly/validators/layout/template/data/_histogram2d.py deleted file mode 100644 index f50ed4930ae..00000000000 --- a/plotly/validators/layout/template/data/_histogram2d.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class Histogram2dsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='histogram2d', - parent_name='layout.template.data', - **kwargs - ): - super(Histogram2dsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Histogram2d'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_histogram2dcontour.py b/plotly/validators/layout/template/data/_histogram2dcontour.py deleted file mode 100644 index 8f74e42f14b..00000000000 --- a/plotly/validators/layout/template/data/_histogram2dcontour.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class Histogram2dContoursValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='histogram2dcontour', - parent_name='layout.template.data', - **kwargs - ): - super(Histogram2dContoursValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Histogram2dContour'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_isosurface.py b/plotly/validators/layout/template/data/_isosurface.py deleted file mode 100644 index f575db21fe0..00000000000 --- a/plotly/validators/layout/template/data/_isosurface.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class IsosurfacesValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='isosurface', - parent_name='layout.template.data', - **kwargs - ): - super(IsosurfacesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Isosurface'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_mesh3d.py b/plotly/validators/layout/template/data/_mesh3d.py deleted file mode 100644 index 71757acf2c7..00000000000 --- a/plotly/validators/layout/template/data/_mesh3d.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Mesh3dsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='mesh3d', - parent_name='layout.template.data', - **kwargs - ): - super(Mesh3dsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Mesh3d'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_ohlc.py b/plotly/validators/layout/template/data/_ohlc.py deleted file mode 100644 index f63d92d8743..00000000000 --- a/plotly/validators/layout/template/data/_ohlc.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class OhlcsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, plotly_name='ohlc', parent_name='layout.template.data', **kwargs - ): - super(OhlcsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Ohlc'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_parcats.py b/plotly/validators/layout/template/data/_parcats.py deleted file mode 100644 index 759fc8f2bce..00000000000 --- a/plotly/validators/layout/template/data/_parcats.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ParcatssValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='parcats', - parent_name='layout.template.data', - **kwargs - ): - super(ParcatssValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Parcats'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_parcoords.py b/plotly/validators/layout/template/data/_parcoords.py deleted file mode 100644 index 82fea9e4221..00000000000 --- a/plotly/validators/layout/template/data/_parcoords.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ParcoordssValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='parcoords', - parent_name='layout.template.data', - **kwargs - ): - super(ParcoordssValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Parcoords'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_pie.py b/plotly/validators/layout/template/data/_pie.py deleted file mode 100644 index c5ba5fb4a66..00000000000 --- a/plotly/validators/layout/template/data/_pie.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class PiesValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, plotly_name='pie', parent_name='layout.template.data', **kwargs - ): - super(PiesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Pie'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_pointcloud.py b/plotly/validators/layout/template/data/_pointcloud.py deleted file mode 100644 index cb844fb28c0..00000000000 --- a/plotly/validators/layout/template/data/_pointcloud.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class PointcloudsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='pointcloud', - parent_name='layout.template.data', - **kwargs - ): - super(PointcloudsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Pointcloud'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_sankey.py b/plotly/validators/layout/template/data/_sankey.py deleted file mode 100644 index 8683e2bb3ea..00000000000 --- a/plotly/validators/layout/template/data/_sankey.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SankeysValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='sankey', - parent_name='layout.template.data', - **kwargs - ): - super(SankeysValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Sankey'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_scatter.py b/plotly/validators/layout/template/data/_scatter.py deleted file mode 100644 index 338fd68ffc6..00000000000 --- a/plotly/validators/layout/template/data/_scatter.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScattersValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='scatter', - parent_name='layout.template.data', - **kwargs - ): - super(ScattersValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scatter'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_scatter3d.py b/plotly/validators/layout/template/data/_scatter3d.py deleted file mode 100644 index 2b3c170ec5e..00000000000 --- a/plotly/validators/layout/template/data/_scatter3d.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Scatter3dsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='scatter3d', - parent_name='layout.template.data', - **kwargs - ): - super(Scatter3dsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scatter3d'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_scattercarpet.py b/plotly/validators/layout/template/data/_scattercarpet.py deleted file mode 100644 index 527101a8e8d..00000000000 --- a/plotly/validators/layout/template/data/_scattercarpet.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScattercarpetsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='scattercarpet', - parent_name='layout.template.data', - **kwargs - ): - super(ScattercarpetsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scattercarpet'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_scattergeo.py b/plotly/validators/layout/template/data/_scattergeo.py deleted file mode 100644 index f385ba29066..00000000000 --- a/plotly/validators/layout/template/data/_scattergeo.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScattergeosValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='scattergeo', - parent_name='layout.template.data', - **kwargs - ): - super(ScattergeosValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scattergeo'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_scattergl.py b/plotly/validators/layout/template/data/_scattergl.py deleted file mode 100644 index 5bd24288917..00000000000 --- a/plotly/validators/layout/template/data/_scattergl.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScatterglsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='scattergl', - parent_name='layout.template.data', - **kwargs - ): - super(ScatterglsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scattergl'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_scattermapbox.py b/plotly/validators/layout/template/data/_scattermapbox.py deleted file mode 100644 index 693177ae287..00000000000 --- a/plotly/validators/layout/template/data/_scattermapbox.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScattermapboxsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='scattermapbox', - parent_name='layout.template.data', - **kwargs - ): - super(ScattermapboxsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scattermapbox'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_scatterpolar.py b/plotly/validators/layout/template/data/_scatterpolar.py deleted file mode 100644 index 97881bc95e5..00000000000 --- a/plotly/validators/layout/template/data/_scatterpolar.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScatterpolarsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='scatterpolar', - parent_name='layout.template.data', - **kwargs - ): - super(ScatterpolarsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scatterpolar'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_scatterpolargl.py b/plotly/validators/layout/template/data/_scatterpolargl.py deleted file mode 100644 index ceb4d8ddb29..00000000000 --- a/plotly/validators/layout/template/data/_scatterpolargl.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScatterpolarglsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='scatterpolargl', - parent_name='layout.template.data', - **kwargs - ): - super(ScatterpolarglsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scatterpolargl'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_scatterternary.py b/plotly/validators/layout/template/data/_scatterternary.py deleted file mode 100644 index 0b69c9c23c7..00000000000 --- a/plotly/validators/layout/template/data/_scatterternary.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScatterternarysValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='scatterternary', - parent_name='layout.template.data', - **kwargs - ): - super(ScatterternarysValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Scatterternary'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_splom.py b/plotly/validators/layout/template/data/_splom.py deleted file mode 100644 index e8ed88229bc..00000000000 --- a/plotly/validators/layout/template/data/_splom.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SplomsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='splom', - parent_name='layout.template.data', - **kwargs - ): - super(SplomsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Splom'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_streamtube.py b/plotly/validators/layout/template/data/_streamtube.py deleted file mode 100644 index 2070888cc91..00000000000 --- a/plotly/validators/layout/template/data/_streamtube.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamtubesValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='streamtube', - parent_name='layout.template.data', - **kwargs - ): - super(StreamtubesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Streamtube'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_surface.py b/plotly/validators/layout/template/data/_surface.py deleted file mode 100644 index 104f08b8569..00000000000 --- a/plotly/validators/layout/template/data/_surface.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SurfacesValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='surface', - parent_name='layout.template.data', - **kwargs - ): - super(SurfacesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Surface'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_table.py b/plotly/validators/layout/template/data/_table.py deleted file mode 100644 index e58e8081fd7..00000000000 --- a/plotly/validators/layout/template/data/_table.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TablesValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='table', - parent_name='layout.template.data', - **kwargs - ): - super(TablesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Table'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/template/data/_violin.py b/plotly/validators/layout/template/data/_violin.py deleted file mode 100644 index b3e1c8396f6..00000000000 --- a/plotly/validators/layout/template/data/_violin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ViolinsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='violin', - parent_name='layout.template.data', - **kwargs - ): - super(ViolinsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Violin'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/__init__.py b/plotly/validators/layout/ternary/__init__.py index 00edec29fcb..ac183f64c4f 100644 --- a/plotly/validators/layout/ternary/__init__.py +++ b/plotly/validators/layout/ternary/__init__.py @@ -1,7 +1,754 @@ -from ._uirevision import UirevisionValidator -from ._sum import SumValidator -from ._domain import DomainValidator -from ._caxis import CaxisValidator -from ._bgcolor import BgcolorValidator -from ._baxis import BaxisValidator -from ._aaxis import AaxisValidator + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='layout.ternary', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SumValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sum', parent_name='layout.ternary', **kwargs + ): + super(SumValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='domain', parent_name='layout.ternary', **kwargs + ): + super(DomainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Domain'), + data_docs=kwargs.pop( + 'data_docs', """ + column + If there is a layout grid, use the domain for + this column in the grid for this ternary + subplot . + row + If there is a layout grid, use the domain for + this row in the grid for this ternary subplot . + x + Sets the horizontal domain of this ternary + subplot (in plot fraction). + y + Sets the vertical domain of this ternary + subplot (in plot fraction). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CaxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='caxis', parent_name='layout.ternary', **kwargs + ): + super(CaxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Caxis'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + layer + Sets the layer on which this axis is displayed. + If *above traces*, this axis is displayed above + all the subplot's traces If *below traces*, + this axis is displayed below all the subplot's + traces, but above the grid lines. Useful when + used together with scatter-like traces with + `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + 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. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.ternary.caxis.Tickform + atstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.ternary.caxis.tickformatstopdefaults), sets + the default property values to use for elements + of layout.ternary.caxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.ternary.caxis.Title + instance or dict with compatible properties + titlefont + 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. + uirevision + Controls persistence of user-driven changes in + axis `min`, and `title` if in `editable: true` + configuration. Defaults to + `ternary.uirevision`. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='layout.ternary', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BaxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='baxis', parent_name='layout.ternary', **kwargs + ): + super(BaxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Baxis'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + layer + Sets the layer on which this axis is displayed. + If *above traces*, this axis is displayed above + all the subplot's traces If *below traces*, + this axis is displayed below all the subplot's + traces, but above the grid lines. Useful when + used together with scatter-like traces with + `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + 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. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.ternary.baxis.Tickform + atstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.ternary.baxis.tickformatstopdefaults), sets + the default property values to use for elements + of layout.ternary.baxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.ternary.baxis.Title + instance or dict with compatible properties + titlefont + 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. + uirevision + Controls persistence of user-driven changes in + axis `min`, and `title` if in `editable: true` + configuration. Defaults to + `ternary.uirevision`. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AaxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='aaxis', parent_name='layout.ternary', **kwargs + ): + super(AaxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Aaxis'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets default for all colors associated with + this axis all at once: line, font, tick, and + grid colors. Grid color is lightened by + blending this with the plot background + Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + layer + Sets the layer on which this axis is displayed. + If *above traces*, this axis is displayed above + all the subplot's traces If *below traces*, + this axis is displayed below all the subplot's + traces, but above the grid lines. Useful when + used together with scatter-like traces with + `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + 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. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showgrid + Determines whether or not grid lines are drawn. + If True, the grid lines are drawn at every tick + mark. + showline + Determines whether or not a line bounding this + axis is drawn. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.layout.ternary.aaxis.Tickform + atstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.lay + out.ternary.aaxis.tickformatstopdefaults), sets + the default property values to use for elements + of layout.ternary.aaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.layout.ternary.aaxis.Title + instance or dict with compatible properties + titlefont + 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. + uirevision + Controls persistence of user-driven changes in + axis `min`, and `title` if in `editable: true` + configuration. Defaults to + `ternary.uirevision`. +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/_aaxis.py b/plotly/validators/layout/ternary/_aaxis.py deleted file mode 100644 index 98b0cfaff28..00000000000 --- a/plotly/validators/layout/ternary/_aaxis.py +++ /dev/null @@ -1,221 +0,0 @@ -import _plotly_utils.basevalidators - - -class AaxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='aaxis', parent_name='layout.ternary', **kwargs - ): - super(AaxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Aaxis'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - layer - Sets the layer on which this axis is displayed. - If *above traces*, this axis is displayed above - all the subplot's traces If *below traces*, - this axis is displayed below all the subplot's - traces, but above the grid lines. Useful when - used together with scatter-like traces with - `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - min - 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. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.ternary.aaxis.Tickform - atstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.ternary.aaxis.tickformatstopdefaults), sets - the default property values to use for elements - of layout.ternary.aaxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.ternary.aaxis.Title - instance or dict with compatible properties - titlefont - 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. - uirevision - Controls persistence of user-driven changes in - axis `min`, and `title` if in `editable: true` - configuration. Defaults to - `ternary.uirevision`. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/_baxis.py b/plotly/validators/layout/ternary/_baxis.py deleted file mode 100644 index f44535c77c5..00000000000 --- a/plotly/validators/layout/ternary/_baxis.py +++ /dev/null @@ -1,221 +0,0 @@ -import _plotly_utils.basevalidators - - -class BaxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='baxis', parent_name='layout.ternary', **kwargs - ): - super(BaxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Baxis'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - layer - Sets the layer on which this axis is displayed. - If *above traces*, this axis is displayed above - all the subplot's traces If *below traces*, - this axis is displayed below all the subplot's - traces, but above the grid lines. Useful when - used together with scatter-like traces with - `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - min - 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. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.ternary.baxis.Tickform - atstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.ternary.baxis.tickformatstopdefaults), sets - the default property values to use for elements - of layout.ternary.baxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.ternary.baxis.Title - instance or dict with compatible properties - titlefont - 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. - uirevision - Controls persistence of user-driven changes in - axis `min`, and `title` if in `editable: true` - configuration. Defaults to - `ternary.uirevision`. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/_bgcolor.py b/plotly/validators/layout/ternary/_bgcolor.py deleted file mode 100644 index a04d0c94e66..00000000000 --- a/plotly/validators/layout/ternary/_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='layout.ternary', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/_caxis.py b/plotly/validators/layout/ternary/_caxis.py deleted file mode 100644 index f1c58fb87ec..00000000000 --- a/plotly/validators/layout/ternary/_caxis.py +++ /dev/null @@ -1,221 +0,0 @@ -import _plotly_utils.basevalidators - - -class CaxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='caxis', parent_name='layout.ternary', **kwargs - ): - super(CaxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Caxis'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets default for all colors associated with - this axis all at once: line, font, tick, and - grid colors. Grid color is lightened by - blending this with the plot background - Individual pieces can override this. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - gridcolor - Sets the color of the grid lines. - gridwidth - Sets the width (in px) of the grid lines. - hoverformat - Sets the hover text formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - layer - Sets the layer on which this axis is displayed. - If *above traces*, this axis is displayed above - all the subplot's traces If *below traces*, - this axis is displayed below all the subplot's - traces, but above the grid lines. Useful when - used together with scatter-like traces with - `cliponaxis` set to False to show markers - and/or text nodes above this axis. - linecolor - Sets the axis line color. - linewidth - Sets the width (in px) of the axis line. - min - 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. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showgrid - Determines whether or not grid lines are drawn. - If True, the grid lines are drawn at every tick - mark. - showline - Determines whether or not a line bounding this - axis is drawn. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the tick font. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.layout.ternary.caxis.Tickform - atstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.lay - out.ternary.caxis.tickformatstopdefaults), sets - the default property values to use for elements - of layout.ternary.caxis.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.layout.ternary.caxis.Title - instance or dict with compatible properties - titlefont - 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. - uirevision - Controls persistence of user-driven changes in - axis `min`, and `title` if in `editable: true` - configuration. Defaults to - `ternary.uirevision`. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/_domain.py b/plotly/validators/layout/ternary/_domain.py deleted file mode 100644 index 15bd8e6697c..00000000000 --- a/plotly/validators/layout/ternary/_domain.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='domain', parent_name='layout.ternary', **kwargs - ): - super(DomainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Domain'), - data_docs=kwargs.pop( - 'data_docs', """ - column - If there is a layout grid, use the domain for - this column in the grid for this ternary - subplot . - row - If there is a layout grid, use the domain for - this row in the grid for this ternary subplot . - x - Sets the horizontal domain of this ternary - subplot (in plot fraction). - y - Sets the vertical domain of this ternary - subplot (in plot fraction). -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/_sum.py b/plotly/validators/layout/ternary/_sum.py deleted file mode 100644 index 0d4b0d5d536..00000000000 --- a/plotly/validators/layout/ternary/_sum.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SumValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sum', parent_name='layout.ternary', **kwargs - ): - super(SumValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/_uirevision.py b/plotly/validators/layout/ternary/_uirevision.py deleted file mode 100644 index ee25b611343..00000000000 --- a/plotly/validators/layout/ternary/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='layout.ternary', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/__init__.py b/plotly/validators/layout/ternary/aaxis/__init__.py index 69683527680..8f5053690bd 100644 --- a/plotly/validators/layout/ternary/aaxis/__init__.py +++ b/plotly/validators/layout/ternary/aaxis/__init__.py @@ -1,37 +1,838 @@ -from ._uirevision import UirevisionValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showline import ShowlineValidator -from ._showgrid import ShowgridValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._nticks import NticksValidator -from ._min import MinValidator -from ._linewidth import LinewidthValidator -from ._linecolor import LinecolorValidator -from ._layer import LayerValidator -from ._hoverformat import HoverformatValidator -from ._gridwidth import GridwidthValidator -from ._gridcolor import GridcolorValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='uirevision', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this axis' title font. Note that the + title's font used to be customized by the now + deprecated `titlefont` attribute. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showline', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(ShowlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showgrid', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(ShowgridValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MinValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='min', parent_name='layout.ternary.aaxis', **kwargs + ): + super(MinValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='linewidth', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(LinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='linecolor', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(LinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='layer', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(LayerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['above traces', 'below traces']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hoverformat', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(HoverformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='gridwidth', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(GridwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='gridcolor', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(GridcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.ternary.aaxis', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/aaxis/_color.py b/plotly/validators/layout/ternary/aaxis/_color.py deleted file mode 100644 index 2101f246cb9..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_dtick.py b/plotly/validators/layout/ternary/aaxis/_dtick.py deleted file mode 100644 index 2945f53b0f7..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_exponentformat.py b/plotly/validators/layout/ternary/aaxis/_exponentformat.py deleted file mode 100644 index 49db800054e..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_gridcolor.py b/plotly/validators/layout/ternary/aaxis/_gridcolor.py deleted file mode 100644 index ae204c38af3..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_gridcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='gridcolor', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(GridcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_gridwidth.py b/plotly/validators/layout/ternary/aaxis/_gridwidth.py deleted file mode 100644 index d368aad8afc..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_gridwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='gridwidth', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(GridwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_hoverformat.py b/plotly/validators/layout/ternary/aaxis/_hoverformat.py deleted file mode 100644 index 66fb3079f26..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_hoverformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hoverformat', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(HoverformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_layer.py b/plotly/validators/layout/ternary/aaxis/_layer.py deleted file mode 100644 index fb1b7e05c7a..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_layer.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='layer', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(LayerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['above traces', 'below traces']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_linecolor.py b/plotly/validators/layout/ternary/aaxis/_linecolor.py deleted file mode 100644 index b9316745108..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_linecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='linecolor', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(LinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_linewidth.py b/plotly/validators/layout/ternary/aaxis/_linewidth.py deleted file mode 100644 index fbb62a2d707..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_linewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='linewidth', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(LinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_min.py b/plotly/validators/layout/ternary/aaxis/_min.py deleted file mode 100644 index 9e6baa5f721..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_min.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class MinValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='min', parent_name='layout.ternary.aaxis', **kwargs - ): - super(MinValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_nticks.py b/plotly/validators/layout/ternary/aaxis/_nticks.py deleted file mode 100644 index 01e2cf18e78..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_separatethousands.py b/plotly/validators/layout/ternary/aaxis/_separatethousands.py deleted file mode 100644 index 81bfbe02107..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_showexponent.py b/plotly/validators/layout/ternary/aaxis/_showexponent.py deleted file mode 100644 index 339b1512d2d..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_showgrid.py b/plotly/validators/layout/ternary/aaxis/_showgrid.py deleted file mode 100644 index eaa6120b8b8..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_showgrid.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showgrid', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(ShowgridValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_showline.py b/plotly/validators/layout/ternary/aaxis/_showline.py deleted file mode 100644 index 032079e368b..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_showline.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showline', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(ShowlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_showticklabels.py b/plotly/validators/layout/ternary/aaxis/_showticklabels.py deleted file mode 100644 index da90ad4a644..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_showtickprefix.py b/plotly/validators/layout/ternary/aaxis/_showtickprefix.py deleted file mode 100644 index 9143d58bfc8..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_showticksuffix.py b/plotly/validators/layout/ternary/aaxis/_showticksuffix.py deleted file mode 100644 index a1768b8aea5..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_tick0.py b/plotly/validators/layout/ternary/aaxis/_tick0.py deleted file mode 100644 index fae550ea26c..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_tickangle.py b/plotly/validators/layout/ternary/aaxis/_tickangle.py deleted file mode 100644 index 0d2dd4b5ecb..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_tickcolor.py b/plotly/validators/layout/ternary/aaxis/_tickcolor.py deleted file mode 100644 index acb2b52c904..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_tickfont.py b/plotly/validators/layout/ternary/aaxis/_tickfont.py deleted file mode 100644 index 7537495175e..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_tickformat.py b/plotly/validators/layout/ternary/aaxis/_tickformat.py deleted file mode 100644 index c4e690806bf..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_tickformatstopdefaults.py b/plotly/validators/layout/ternary/aaxis/_tickformatstopdefaults.py deleted file mode 100644 index 84a65926d93..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_tickformatstops.py b/plotly/validators/layout/ternary/aaxis/_tickformatstops.py deleted file mode 100644 index 1d0c66169a5..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_ticklen.py b/plotly/validators/layout/ternary/aaxis/_ticklen.py deleted file mode 100644 index fdc74cabf55..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_tickmode.py b/plotly/validators/layout/ternary/aaxis/_tickmode.py deleted file mode 100644 index f67eb67b3d2..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_tickprefix.py b/plotly/validators/layout/ternary/aaxis/_tickprefix.py deleted file mode 100644 index dccc9c5c144..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_ticks.py b/plotly/validators/layout/ternary/aaxis/_ticks.py deleted file mode 100644 index 484a83846b7..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_ticksuffix.py b/plotly/validators/layout/ternary/aaxis/_ticksuffix.py deleted file mode 100644 index ab922f73dad..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_ticktext.py b/plotly/validators/layout/ternary/aaxis/_ticktext.py deleted file mode 100644 index fb5ec006057..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_ticktextsrc.py b/plotly/validators/layout/ternary/aaxis/_ticktextsrc.py deleted file mode 100644 index 47a4ea445af..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_tickvals.py b/plotly/validators/layout/ternary/aaxis/_tickvals.py deleted file mode 100644 index afde5f90449..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_tickvalssrc.py b/plotly/validators/layout/ternary/aaxis/_tickvalssrc.py deleted file mode 100644 index a0b30a784a5..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_tickwidth.py b/plotly/validators/layout/ternary/aaxis/_tickwidth.py deleted file mode 100644 index fa7f3fbeeb7..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_title.py b/plotly/validators/layout/ternary/aaxis/_title.py deleted file mode 100644 index 59c507a4d23..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_title.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this axis' title font. Note that the - title's font used to be customized by the now - deprecated `titlefont` attribute. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/_uirevision.py b/plotly/validators/layout/ternary/aaxis/_uirevision.py deleted file mode 100644 index df7c6a9a3b6..00000000000 --- a/plotly/validators/layout/ternary/aaxis/_uirevision.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='uirevision', - parent_name='layout.ternary.aaxis', - **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/tickfont/__init__.py b/plotly/validators/layout/ternary/aaxis/tickfont/__init__.py index 199d72e71c6..13d914b231e 100644 --- a/plotly/validators/layout/ternary/aaxis/tickfont/__init__.py +++ b/plotly/validators/layout/ternary/aaxis/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.ternary.aaxis.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.ternary.aaxis.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.ternary.aaxis.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/aaxis/tickfont/_color.py b/plotly/validators/layout/ternary/aaxis/tickfont/_color.py deleted file mode 100644 index f5c97e8d901..00000000000 --- a/plotly/validators/layout/ternary/aaxis/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.ternary.aaxis.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/tickfont/_family.py b/plotly/validators/layout/ternary/aaxis/tickfont/_family.py deleted file mode 100644 index 32b0b3efceb..00000000000 --- a/plotly/validators/layout/ternary/aaxis/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.ternary.aaxis.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/tickfont/_size.py b/plotly/validators/layout/ternary/aaxis/tickfont/_size.py deleted file mode 100644 index 03dcb0fb209..00000000000 --- a/plotly/validators/layout/ternary/aaxis/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.ternary.aaxis.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/tickformatstop/__init__.py b/plotly/validators/layout/ternary/aaxis/tickformatstop/__init__.py index 3f6c06cac47..5653f6e2e21 100644 --- a/plotly/validators/layout/ternary/aaxis/tickformatstop/__init__.py +++ b/plotly/validators/layout/ternary/aaxis/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='layout.ternary.aaxis.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.ternary.aaxis.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='layout.ternary.aaxis.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='layout.ternary.aaxis.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='layout.ternary.aaxis.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'plot' + }, { + 'valType': 'any', + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/aaxis/tickformatstop/_dtickrange.py b/plotly/validators/layout/ternary/aaxis/tickformatstop/_dtickrange.py deleted file mode 100644 index 65041bdc6d1..00000000000 --- a/plotly/validators/layout/ternary/aaxis/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='layout.ternary.aaxis.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'plot' - }, { - 'valType': 'any', - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/tickformatstop/_enabled.py b/plotly/validators/layout/ternary/aaxis/tickformatstop/_enabled.py deleted file mode 100644 index c7bf2948e12..00000000000 --- a/plotly/validators/layout/ternary/aaxis/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='layout.ternary.aaxis.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/tickformatstop/_name.py b/plotly/validators/layout/ternary/aaxis/tickformatstop/_name.py deleted file mode 100644 index 542ae038db3..00000000000 --- a/plotly/validators/layout/ternary/aaxis/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='layout.ternary.aaxis.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/tickformatstop/_templateitemname.py b/plotly/validators/layout/ternary/aaxis/tickformatstop/_templateitemname.py deleted file mode 100644 index 649e03aae43..00000000000 --- a/plotly/validators/layout/ternary/aaxis/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.ternary.aaxis.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/tickformatstop/_value.py b/plotly/validators/layout/ternary/aaxis/tickformatstop/_value.py deleted file mode 100644 index 8b52c645429..00000000000 --- a/plotly/validators/layout/ternary/aaxis/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='layout.ternary.aaxis.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/title/__init__.py b/plotly/validators/layout/ternary/aaxis/title/__init__.py index db7b0c34947..7aa7e15cbcf 100644 --- a/plotly/validators/layout/ternary/aaxis/title/__init__.py +++ b/plotly/validators/layout/ternary/aaxis/title/__init__.py @@ -1,2 +1,63 @@ -from ._text import TextValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='layout.ternary.aaxis.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='layout.ternary.aaxis.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/aaxis/title/_font.py b/plotly/validators/layout/ternary/aaxis/title/_font.py deleted file mode 100644 index 9cc57c864f3..00000000000 --- a/plotly/validators/layout/ternary/aaxis/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='layout.ternary.aaxis.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/title/_text.py b/plotly/validators/layout/ternary/aaxis/title/_text.py deleted file mode 100644 index 8324ec5d71e..00000000000 --- a/plotly/validators/layout/ternary/aaxis/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='layout.ternary.aaxis.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/title/font/__init__.py b/plotly/validators/layout/ternary/aaxis/title/font/__init__.py index 199d72e71c6..f6768bb9616 100644 --- a/plotly/validators/layout/ternary/aaxis/title/font/__init__.py +++ b/plotly/validators/layout/ternary/aaxis/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.ternary.aaxis.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.ternary.aaxis.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.ternary.aaxis.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/aaxis/title/font/_color.py b/plotly/validators/layout/ternary/aaxis/title/font/_color.py deleted file mode 100644 index addae3b1fe8..00000000000 --- a/plotly/validators/layout/ternary/aaxis/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.ternary.aaxis.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/title/font/_family.py b/plotly/validators/layout/ternary/aaxis/title/font/_family.py deleted file mode 100644 index 49804d25c8d..00000000000 --- a/plotly/validators/layout/ternary/aaxis/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.ternary.aaxis.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/aaxis/title/font/_size.py b/plotly/validators/layout/ternary/aaxis/title/font/_size.py deleted file mode 100644 index 56eaf39f949..00000000000 --- a/plotly/validators/layout/ternary/aaxis/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.ternary.aaxis.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/__init__.py b/plotly/validators/layout/ternary/baxis/__init__.py index 69683527680..98d079580e2 100644 --- a/plotly/validators/layout/ternary/baxis/__init__.py +++ b/plotly/validators/layout/ternary/baxis/__init__.py @@ -1,37 +1,838 @@ -from ._uirevision import UirevisionValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showline import ShowlineValidator -from ._showgrid import ShowgridValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._nticks import NticksValidator -from ._min import MinValidator -from ._linewidth import LinewidthValidator -from ._linecolor import LinecolorValidator -from ._layer import LayerValidator -from ._hoverformat import HoverformatValidator -from ._gridwidth import GridwidthValidator -from ._gridcolor import GridcolorValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='uirevision', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this axis' title font. Note that the + title's font used to be customized by the now + deprecated `titlefont` attribute. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showline', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(ShowlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showgrid', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(ShowgridValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MinValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='min', parent_name='layout.ternary.baxis', **kwargs + ): + super(MinValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='linewidth', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(LinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='linecolor', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(LinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='layer', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(LayerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['above traces', 'below traces']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hoverformat', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(HoverformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='gridwidth', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(GridwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='gridcolor', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(GridcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.ternary.baxis', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/baxis/_color.py b/plotly/validators/layout/ternary/baxis/_color.py deleted file mode 100644 index e5b2b520e51..00000000000 --- a/plotly/validators/layout/ternary/baxis/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_dtick.py b/plotly/validators/layout/ternary/baxis/_dtick.py deleted file mode 100644 index bde38bf338d..00000000000 --- a/plotly/validators/layout/ternary/baxis/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_exponentformat.py b/plotly/validators/layout/ternary/baxis/_exponentformat.py deleted file mode 100644 index f58222abb73..00000000000 --- a/plotly/validators/layout/ternary/baxis/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_gridcolor.py b/plotly/validators/layout/ternary/baxis/_gridcolor.py deleted file mode 100644 index c8c288900d8..00000000000 --- a/plotly/validators/layout/ternary/baxis/_gridcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='gridcolor', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(GridcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_gridwidth.py b/plotly/validators/layout/ternary/baxis/_gridwidth.py deleted file mode 100644 index f8d05651922..00000000000 --- a/plotly/validators/layout/ternary/baxis/_gridwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='gridwidth', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(GridwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_hoverformat.py b/plotly/validators/layout/ternary/baxis/_hoverformat.py deleted file mode 100644 index 6bdbdc3a3a6..00000000000 --- a/plotly/validators/layout/ternary/baxis/_hoverformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hoverformat', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(HoverformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_layer.py b/plotly/validators/layout/ternary/baxis/_layer.py deleted file mode 100644 index 3dc8f9d6c22..00000000000 --- a/plotly/validators/layout/ternary/baxis/_layer.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='layer', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(LayerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['above traces', 'below traces']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_linecolor.py b/plotly/validators/layout/ternary/baxis/_linecolor.py deleted file mode 100644 index 3d15919cc4d..00000000000 --- a/plotly/validators/layout/ternary/baxis/_linecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='linecolor', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(LinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_linewidth.py b/plotly/validators/layout/ternary/baxis/_linewidth.py deleted file mode 100644 index a816a43eef7..00000000000 --- a/plotly/validators/layout/ternary/baxis/_linewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='linewidth', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(LinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_min.py b/plotly/validators/layout/ternary/baxis/_min.py deleted file mode 100644 index ffadc6f84f8..00000000000 --- a/plotly/validators/layout/ternary/baxis/_min.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class MinValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='min', parent_name='layout.ternary.baxis', **kwargs - ): - super(MinValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_nticks.py b/plotly/validators/layout/ternary/baxis/_nticks.py deleted file mode 100644 index 80db887f032..00000000000 --- a/plotly/validators/layout/ternary/baxis/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_separatethousands.py b/plotly/validators/layout/ternary/baxis/_separatethousands.py deleted file mode 100644 index 86e215084d9..00000000000 --- a/plotly/validators/layout/ternary/baxis/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_showexponent.py b/plotly/validators/layout/ternary/baxis/_showexponent.py deleted file mode 100644 index b3851db070f..00000000000 --- a/plotly/validators/layout/ternary/baxis/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_showgrid.py b/plotly/validators/layout/ternary/baxis/_showgrid.py deleted file mode 100644 index 919c70d9d22..00000000000 --- a/plotly/validators/layout/ternary/baxis/_showgrid.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showgrid', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(ShowgridValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_showline.py b/plotly/validators/layout/ternary/baxis/_showline.py deleted file mode 100644 index 52babbd90f8..00000000000 --- a/plotly/validators/layout/ternary/baxis/_showline.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showline', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(ShowlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_showticklabels.py b/plotly/validators/layout/ternary/baxis/_showticklabels.py deleted file mode 100644 index 46be89ff32f..00000000000 --- a/plotly/validators/layout/ternary/baxis/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_showtickprefix.py b/plotly/validators/layout/ternary/baxis/_showtickprefix.py deleted file mode 100644 index d8beb821666..00000000000 --- a/plotly/validators/layout/ternary/baxis/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_showticksuffix.py b/plotly/validators/layout/ternary/baxis/_showticksuffix.py deleted file mode 100644 index 7d5c1c1d7d0..00000000000 --- a/plotly/validators/layout/ternary/baxis/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_tick0.py b/plotly/validators/layout/ternary/baxis/_tick0.py deleted file mode 100644 index 21184a47ece..00000000000 --- a/plotly/validators/layout/ternary/baxis/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_tickangle.py b/plotly/validators/layout/ternary/baxis/_tickangle.py deleted file mode 100644 index bbad8c0fa3f..00000000000 --- a/plotly/validators/layout/ternary/baxis/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_tickcolor.py b/plotly/validators/layout/ternary/baxis/_tickcolor.py deleted file mode 100644 index 6f585b821ba..00000000000 --- a/plotly/validators/layout/ternary/baxis/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_tickfont.py b/plotly/validators/layout/ternary/baxis/_tickfont.py deleted file mode 100644 index 7067892aa4c..00000000000 --- a/plotly/validators/layout/ternary/baxis/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_tickformat.py b/plotly/validators/layout/ternary/baxis/_tickformat.py deleted file mode 100644 index 647c1345ea9..00000000000 --- a/plotly/validators/layout/ternary/baxis/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_tickformatstopdefaults.py b/plotly/validators/layout/ternary/baxis/_tickformatstopdefaults.py deleted file mode 100644 index 9db908b046b..00000000000 --- a/plotly/validators/layout/ternary/baxis/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_tickformatstops.py b/plotly/validators/layout/ternary/baxis/_tickformatstops.py deleted file mode 100644 index b4a883cf523..00000000000 --- a/plotly/validators/layout/ternary/baxis/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_ticklen.py b/plotly/validators/layout/ternary/baxis/_ticklen.py deleted file mode 100644 index be14eea4f2c..00000000000 --- a/plotly/validators/layout/ternary/baxis/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_tickmode.py b/plotly/validators/layout/ternary/baxis/_tickmode.py deleted file mode 100644 index a15db462b76..00000000000 --- a/plotly/validators/layout/ternary/baxis/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_tickprefix.py b/plotly/validators/layout/ternary/baxis/_tickprefix.py deleted file mode 100644 index 465dd7092db..00000000000 --- a/plotly/validators/layout/ternary/baxis/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_ticks.py b/plotly/validators/layout/ternary/baxis/_ticks.py deleted file mode 100644 index f024ab1080c..00000000000 --- a/plotly/validators/layout/ternary/baxis/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_ticksuffix.py b/plotly/validators/layout/ternary/baxis/_ticksuffix.py deleted file mode 100644 index 856bcfdf9ce..00000000000 --- a/plotly/validators/layout/ternary/baxis/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_ticktext.py b/plotly/validators/layout/ternary/baxis/_ticktext.py deleted file mode 100644 index fd62922120a..00000000000 --- a/plotly/validators/layout/ternary/baxis/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_ticktextsrc.py b/plotly/validators/layout/ternary/baxis/_ticktextsrc.py deleted file mode 100644 index 497ac505e4d..00000000000 --- a/plotly/validators/layout/ternary/baxis/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_tickvals.py b/plotly/validators/layout/ternary/baxis/_tickvals.py deleted file mode 100644 index 037d393ff26..00000000000 --- a/plotly/validators/layout/ternary/baxis/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_tickvalssrc.py b/plotly/validators/layout/ternary/baxis/_tickvalssrc.py deleted file mode 100644 index 28915d2b0d1..00000000000 --- a/plotly/validators/layout/ternary/baxis/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_tickwidth.py b/plotly/validators/layout/ternary/baxis/_tickwidth.py deleted file mode 100644 index 46594443642..00000000000 --- a/plotly/validators/layout/ternary/baxis/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_title.py b/plotly/validators/layout/ternary/baxis/_title.py deleted file mode 100644 index 167a940fb1b..00000000000 --- a/plotly/validators/layout/ternary/baxis/_title.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this axis' title font. Note that the - title's font used to be customized by the now - deprecated `titlefont` attribute. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/_uirevision.py b/plotly/validators/layout/ternary/baxis/_uirevision.py deleted file mode 100644 index f394a11be6c..00000000000 --- a/plotly/validators/layout/ternary/baxis/_uirevision.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='uirevision', - parent_name='layout.ternary.baxis', - **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/tickfont/__init__.py b/plotly/validators/layout/ternary/baxis/tickfont/__init__.py index 199d72e71c6..4c46f480982 100644 --- a/plotly/validators/layout/ternary/baxis/tickfont/__init__.py +++ b/plotly/validators/layout/ternary/baxis/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.ternary.baxis.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.ternary.baxis.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.ternary.baxis.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/baxis/tickfont/_color.py b/plotly/validators/layout/ternary/baxis/tickfont/_color.py deleted file mode 100644 index 6405c694bce..00000000000 --- a/plotly/validators/layout/ternary/baxis/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.ternary.baxis.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/tickfont/_family.py b/plotly/validators/layout/ternary/baxis/tickfont/_family.py deleted file mode 100644 index fc6420ee4de..00000000000 --- a/plotly/validators/layout/ternary/baxis/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.ternary.baxis.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/tickfont/_size.py b/plotly/validators/layout/ternary/baxis/tickfont/_size.py deleted file mode 100644 index f440d19f38c..00000000000 --- a/plotly/validators/layout/ternary/baxis/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.ternary.baxis.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/tickformatstop/__init__.py b/plotly/validators/layout/ternary/baxis/tickformatstop/__init__.py index 3f6c06cac47..f8fc07ac8f1 100644 --- a/plotly/validators/layout/ternary/baxis/tickformatstop/__init__.py +++ b/plotly/validators/layout/ternary/baxis/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='layout.ternary.baxis.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.ternary.baxis.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='layout.ternary.baxis.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='layout.ternary.baxis.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='layout.ternary.baxis.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'plot' + }, { + 'valType': 'any', + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/baxis/tickformatstop/_dtickrange.py b/plotly/validators/layout/ternary/baxis/tickformatstop/_dtickrange.py deleted file mode 100644 index acd92f6f1b4..00000000000 --- a/plotly/validators/layout/ternary/baxis/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='layout.ternary.baxis.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'plot' - }, { - 'valType': 'any', - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/tickformatstop/_enabled.py b/plotly/validators/layout/ternary/baxis/tickformatstop/_enabled.py deleted file mode 100644 index 850fea7e638..00000000000 --- a/plotly/validators/layout/ternary/baxis/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='layout.ternary.baxis.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/tickformatstop/_name.py b/plotly/validators/layout/ternary/baxis/tickformatstop/_name.py deleted file mode 100644 index 8ac3faa1699..00000000000 --- a/plotly/validators/layout/ternary/baxis/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='layout.ternary.baxis.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/tickformatstop/_templateitemname.py b/plotly/validators/layout/ternary/baxis/tickformatstop/_templateitemname.py deleted file mode 100644 index 287ce86ea6d..00000000000 --- a/plotly/validators/layout/ternary/baxis/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.ternary.baxis.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/tickformatstop/_value.py b/plotly/validators/layout/ternary/baxis/tickformatstop/_value.py deleted file mode 100644 index 8d843eae934..00000000000 --- a/plotly/validators/layout/ternary/baxis/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='layout.ternary.baxis.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/title/__init__.py b/plotly/validators/layout/ternary/baxis/title/__init__.py index db7b0c34947..5c89c40f419 100644 --- a/plotly/validators/layout/ternary/baxis/title/__init__.py +++ b/plotly/validators/layout/ternary/baxis/title/__init__.py @@ -1,2 +1,63 @@ -from ._text import TextValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='layout.ternary.baxis.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='layout.ternary.baxis.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/baxis/title/_font.py b/plotly/validators/layout/ternary/baxis/title/_font.py deleted file mode 100644 index 5baba2749d8..00000000000 --- a/plotly/validators/layout/ternary/baxis/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='layout.ternary.baxis.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/title/_text.py b/plotly/validators/layout/ternary/baxis/title/_text.py deleted file mode 100644 index 39e3ff6bb01..00000000000 --- a/plotly/validators/layout/ternary/baxis/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='layout.ternary.baxis.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/title/font/__init__.py b/plotly/validators/layout/ternary/baxis/title/font/__init__.py index 199d72e71c6..7750e596240 100644 --- a/plotly/validators/layout/ternary/baxis/title/font/__init__.py +++ b/plotly/validators/layout/ternary/baxis/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.ternary.baxis.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.ternary.baxis.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.ternary.baxis.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/baxis/title/font/_color.py b/plotly/validators/layout/ternary/baxis/title/font/_color.py deleted file mode 100644 index ebe6995129d..00000000000 --- a/plotly/validators/layout/ternary/baxis/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.ternary.baxis.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/title/font/_family.py b/plotly/validators/layout/ternary/baxis/title/font/_family.py deleted file mode 100644 index 409a6e3c103..00000000000 --- a/plotly/validators/layout/ternary/baxis/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.ternary.baxis.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/baxis/title/font/_size.py b/plotly/validators/layout/ternary/baxis/title/font/_size.py deleted file mode 100644 index 5c6e91f6485..00000000000 --- a/plotly/validators/layout/ternary/baxis/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.ternary.baxis.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/__init__.py b/plotly/validators/layout/ternary/caxis/__init__.py index 69683527680..c347257b84b 100644 --- a/plotly/validators/layout/ternary/caxis/__init__.py +++ b/plotly/validators/layout/ternary/caxis/__init__.py @@ -1,37 +1,838 @@ -from ._uirevision import UirevisionValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showline import ShowlineValidator -from ._showgrid import ShowgridValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._nticks import NticksValidator -from ._min import MinValidator -from ._linewidth import LinewidthValidator -from ._linecolor import LinecolorValidator -from ._layer import LayerValidator -from ._hoverformat import HoverformatValidator -from ._gridwidth import GridwidthValidator -from ._gridcolor import GridcolorValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='uirevision', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this axis' title font. Note that the + title's font used to be customized by the now + deprecated `titlefont` attribute. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showline', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(ShowlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showgrid', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(ShowgridValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MinValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='min', parent_name='layout.ternary.caxis', **kwargs + ): + super(MinValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='linewidth', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(LinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='linecolor', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(LinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='layer', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(LayerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['above traces', 'below traces']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hoverformat', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(HoverformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='gridwidth', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(GridwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='gridcolor', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(GridcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.ternary.caxis', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/caxis/_color.py b/plotly/validators/layout/ternary/caxis/_color.py deleted file mode 100644 index 124c8b73b6e..00000000000 --- a/plotly/validators/layout/ternary/caxis/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_dtick.py b/plotly/validators/layout/ternary/caxis/_dtick.py deleted file mode 100644 index bbe1a1cd623..00000000000 --- a/plotly/validators/layout/ternary/caxis/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_exponentformat.py b/plotly/validators/layout/ternary/caxis/_exponentformat.py deleted file mode 100644 index 0d18cfe5abe..00000000000 --- a/plotly/validators/layout/ternary/caxis/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_gridcolor.py b/plotly/validators/layout/ternary/caxis/_gridcolor.py deleted file mode 100644 index 6b7242ffab9..00000000000 --- a/plotly/validators/layout/ternary/caxis/_gridcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='gridcolor', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(GridcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_gridwidth.py b/plotly/validators/layout/ternary/caxis/_gridwidth.py deleted file mode 100644 index cb0425c1dc2..00000000000 --- a/plotly/validators/layout/ternary/caxis/_gridwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='gridwidth', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(GridwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_hoverformat.py b/plotly/validators/layout/ternary/caxis/_hoverformat.py deleted file mode 100644 index 32d3d228c01..00000000000 --- a/plotly/validators/layout/ternary/caxis/_hoverformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hoverformat', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(HoverformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_layer.py b/plotly/validators/layout/ternary/caxis/_layer.py deleted file mode 100644 index 7c1aa3d7fd1..00000000000 --- a/plotly/validators/layout/ternary/caxis/_layer.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='layer', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(LayerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['above traces', 'below traces']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_linecolor.py b/plotly/validators/layout/ternary/caxis/_linecolor.py deleted file mode 100644 index 0e483b94831..00000000000 --- a/plotly/validators/layout/ternary/caxis/_linecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='linecolor', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(LinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_linewidth.py b/plotly/validators/layout/ternary/caxis/_linewidth.py deleted file mode 100644 index d48e4110ae3..00000000000 --- a/plotly/validators/layout/ternary/caxis/_linewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='linewidth', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(LinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_min.py b/plotly/validators/layout/ternary/caxis/_min.py deleted file mode 100644 index 4dde66c2ce4..00000000000 --- a/plotly/validators/layout/ternary/caxis/_min.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class MinValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='min', parent_name='layout.ternary.caxis', **kwargs - ): - super(MinValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_nticks.py b/plotly/validators/layout/ternary/caxis/_nticks.py deleted file mode 100644 index 06b93f517bd..00000000000 --- a/plotly/validators/layout/ternary/caxis/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_separatethousands.py b/plotly/validators/layout/ternary/caxis/_separatethousands.py deleted file mode 100644 index 9c68d34b7c5..00000000000 --- a/plotly/validators/layout/ternary/caxis/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_showexponent.py b/plotly/validators/layout/ternary/caxis/_showexponent.py deleted file mode 100644 index b2f601b91a1..00000000000 --- a/plotly/validators/layout/ternary/caxis/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_showgrid.py b/plotly/validators/layout/ternary/caxis/_showgrid.py deleted file mode 100644 index 590f899268d..00000000000 --- a/plotly/validators/layout/ternary/caxis/_showgrid.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showgrid', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(ShowgridValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_showline.py b/plotly/validators/layout/ternary/caxis/_showline.py deleted file mode 100644 index 48e1461f8e9..00000000000 --- a/plotly/validators/layout/ternary/caxis/_showline.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showline', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(ShowlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_showticklabels.py b/plotly/validators/layout/ternary/caxis/_showticklabels.py deleted file mode 100644 index fad0c36202c..00000000000 --- a/plotly/validators/layout/ternary/caxis/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_showtickprefix.py b/plotly/validators/layout/ternary/caxis/_showtickprefix.py deleted file mode 100644 index 7da7f82729f..00000000000 --- a/plotly/validators/layout/ternary/caxis/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_showticksuffix.py b/plotly/validators/layout/ternary/caxis/_showticksuffix.py deleted file mode 100644 index 0c4fc7c8579..00000000000 --- a/plotly/validators/layout/ternary/caxis/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_tick0.py b/plotly/validators/layout/ternary/caxis/_tick0.py deleted file mode 100644 index 2aaf7ff2a38..00000000000 --- a/plotly/validators/layout/ternary/caxis/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_tickangle.py b/plotly/validators/layout/ternary/caxis/_tickangle.py deleted file mode 100644 index 305b76a5449..00000000000 --- a/plotly/validators/layout/ternary/caxis/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_tickcolor.py b/plotly/validators/layout/ternary/caxis/_tickcolor.py deleted file mode 100644 index 298bb70e6d5..00000000000 --- a/plotly/validators/layout/ternary/caxis/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_tickfont.py b/plotly/validators/layout/ternary/caxis/_tickfont.py deleted file mode 100644 index 3a40fbb9b0c..00000000000 --- a/plotly/validators/layout/ternary/caxis/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_tickformat.py b/plotly/validators/layout/ternary/caxis/_tickformat.py deleted file mode 100644 index f1f596fedea..00000000000 --- a/plotly/validators/layout/ternary/caxis/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_tickformatstopdefaults.py b/plotly/validators/layout/ternary/caxis/_tickformatstopdefaults.py deleted file mode 100644 index 69a1b69e43a..00000000000 --- a/plotly/validators/layout/ternary/caxis/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_tickformatstops.py b/plotly/validators/layout/ternary/caxis/_tickformatstops.py deleted file mode 100644 index 2e816a8ceaa..00000000000 --- a/plotly/validators/layout/ternary/caxis/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_ticklen.py b/plotly/validators/layout/ternary/caxis/_ticklen.py deleted file mode 100644 index 336dcc41471..00000000000 --- a/plotly/validators/layout/ternary/caxis/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_tickmode.py b/plotly/validators/layout/ternary/caxis/_tickmode.py deleted file mode 100644 index bc25dd84be2..00000000000 --- a/plotly/validators/layout/ternary/caxis/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_tickprefix.py b/plotly/validators/layout/ternary/caxis/_tickprefix.py deleted file mode 100644 index 8745dc45e85..00000000000 --- a/plotly/validators/layout/ternary/caxis/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_ticks.py b/plotly/validators/layout/ternary/caxis/_ticks.py deleted file mode 100644 index fe9101ccf99..00000000000 --- a/plotly/validators/layout/ternary/caxis/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_ticksuffix.py b/plotly/validators/layout/ternary/caxis/_ticksuffix.py deleted file mode 100644 index da921549137..00000000000 --- a/plotly/validators/layout/ternary/caxis/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_ticktext.py b/plotly/validators/layout/ternary/caxis/_ticktext.py deleted file mode 100644 index 972eb717ed4..00000000000 --- a/plotly/validators/layout/ternary/caxis/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_ticktextsrc.py b/plotly/validators/layout/ternary/caxis/_ticktextsrc.py deleted file mode 100644 index 8330a27188c..00000000000 --- a/plotly/validators/layout/ternary/caxis/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_tickvals.py b/plotly/validators/layout/ternary/caxis/_tickvals.py deleted file mode 100644 index 16176806187..00000000000 --- a/plotly/validators/layout/ternary/caxis/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_tickvalssrc.py b/plotly/validators/layout/ternary/caxis/_tickvalssrc.py deleted file mode 100644 index 4d6eb3e3fd8..00000000000 --- a/plotly/validators/layout/ternary/caxis/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_tickwidth.py b/plotly/validators/layout/ternary/caxis/_tickwidth.py deleted file mode 100644 index c26520e084f..00000000000 --- a/plotly/validators/layout/ternary/caxis/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_title.py b/plotly/validators/layout/ternary/caxis/_title.py deleted file mode 100644 index 16b6415c17b..00000000000 --- a/plotly/validators/layout/ternary/caxis/_title.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this axis' title font. Note that the - title's font used to be customized by the now - deprecated `titlefont` attribute. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/_uirevision.py b/plotly/validators/layout/ternary/caxis/_uirevision.py deleted file mode 100644 index f4381fe6f7a..00000000000 --- a/plotly/validators/layout/ternary/caxis/_uirevision.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='uirevision', - parent_name='layout.ternary.caxis', - **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/tickfont/__init__.py b/plotly/validators/layout/ternary/caxis/tickfont/__init__.py index 199d72e71c6..91fefaca222 100644 --- a/plotly/validators/layout/ternary/caxis/tickfont/__init__.py +++ b/plotly/validators/layout/ternary/caxis/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.ternary.caxis.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.ternary.caxis.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.ternary.caxis.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/caxis/tickfont/_color.py b/plotly/validators/layout/ternary/caxis/tickfont/_color.py deleted file mode 100644 index 741df153c7c..00000000000 --- a/plotly/validators/layout/ternary/caxis/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.ternary.caxis.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/tickfont/_family.py b/plotly/validators/layout/ternary/caxis/tickfont/_family.py deleted file mode 100644 index dcc6acc6597..00000000000 --- a/plotly/validators/layout/ternary/caxis/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.ternary.caxis.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/tickfont/_size.py b/plotly/validators/layout/ternary/caxis/tickfont/_size.py deleted file mode 100644 index 4c12ae75e5d..00000000000 --- a/plotly/validators/layout/ternary/caxis/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.ternary.caxis.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/tickformatstop/__init__.py b/plotly/validators/layout/ternary/caxis/tickformatstop/__init__.py index 3f6c06cac47..31b17ee4297 100644 --- a/plotly/validators/layout/ternary/caxis/tickformatstop/__init__.py +++ b/plotly/validators/layout/ternary/caxis/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='layout.ternary.caxis.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.ternary.caxis.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='layout.ternary.caxis.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='layout.ternary.caxis.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='layout.ternary.caxis.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'plot' + }, { + 'valType': 'any', + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/caxis/tickformatstop/_dtickrange.py b/plotly/validators/layout/ternary/caxis/tickformatstop/_dtickrange.py deleted file mode 100644 index 1e9679f1e1d..00000000000 --- a/plotly/validators/layout/ternary/caxis/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='layout.ternary.caxis.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'plot' - }, { - 'valType': 'any', - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/tickformatstop/_enabled.py b/plotly/validators/layout/ternary/caxis/tickformatstop/_enabled.py deleted file mode 100644 index ba773f627c5..00000000000 --- a/plotly/validators/layout/ternary/caxis/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='layout.ternary.caxis.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/tickformatstop/_name.py b/plotly/validators/layout/ternary/caxis/tickformatstop/_name.py deleted file mode 100644 index 7cb11eae81d..00000000000 --- a/plotly/validators/layout/ternary/caxis/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='layout.ternary.caxis.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/tickformatstop/_templateitemname.py b/plotly/validators/layout/ternary/caxis/tickformatstop/_templateitemname.py deleted file mode 100644 index ae7806f8c52..00000000000 --- a/plotly/validators/layout/ternary/caxis/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.ternary.caxis.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/tickformatstop/_value.py b/plotly/validators/layout/ternary/caxis/tickformatstop/_value.py deleted file mode 100644 index 9dbb6b3e857..00000000000 --- a/plotly/validators/layout/ternary/caxis/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='layout.ternary.caxis.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/title/__init__.py b/plotly/validators/layout/ternary/caxis/title/__init__.py index db7b0c34947..01b923924b1 100644 --- a/plotly/validators/layout/ternary/caxis/title/__init__.py +++ b/plotly/validators/layout/ternary/caxis/title/__init__.py @@ -1,2 +1,63 @@ -from ._text import TextValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='layout.ternary.caxis.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='layout.ternary.caxis.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/caxis/title/_font.py b/plotly/validators/layout/ternary/caxis/title/_font.py deleted file mode 100644 index c8eaf1cc55c..00000000000 --- a/plotly/validators/layout/ternary/caxis/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='layout.ternary.caxis.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/title/_text.py b/plotly/validators/layout/ternary/caxis/title/_text.py deleted file mode 100644 index 5da65b08881..00000000000 --- a/plotly/validators/layout/ternary/caxis/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='layout.ternary.caxis.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/title/font/__init__.py b/plotly/validators/layout/ternary/caxis/title/font/__init__.py index 199d72e71c6..ff823de5338 100644 --- a/plotly/validators/layout/ternary/caxis/title/font/__init__.py +++ b/plotly/validators/layout/ternary/caxis/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.ternary.caxis.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.ternary.caxis.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.ternary.caxis.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/caxis/title/font/_color.py b/plotly/validators/layout/ternary/caxis/title/font/_color.py deleted file mode 100644 index 3ab9a38dd55..00000000000 --- a/plotly/validators/layout/ternary/caxis/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.ternary.caxis.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/title/font/_family.py b/plotly/validators/layout/ternary/caxis/title/font/_family.py deleted file mode 100644 index e3872569774..00000000000 --- a/plotly/validators/layout/ternary/caxis/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.ternary.caxis.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/caxis/title/font/_size.py b/plotly/validators/layout/ternary/caxis/title/font/_size.py deleted file mode 100644 index 7fb52945609..00000000000 --- a/plotly/validators/layout/ternary/caxis/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.ternary.caxis.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/domain/__init__.py b/plotly/validators/layout/ternary/domain/__init__.py index 6cf32248236..ef43fe3e5cc 100644 --- a/plotly/validators/layout/ternary/domain/__init__.py +++ b/plotly/validators/layout/ternary/domain/__init__.py @@ -1,4 +1,105 @@ -from ._y import YValidator -from ._x import XValidator -from ._row import RowValidator -from ._column import ColumnValidator + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='y', parent_name='layout.ternary.domain', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='x', parent_name='layout.ternary.domain', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RowValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='row', parent_name='layout.ternary.domain', **kwargs + ): + super(RowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='column', + parent_name='layout.ternary.domain', + **kwargs + ): + super(ColumnValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/ternary/domain/_column.py b/plotly/validators/layout/ternary/domain/_column.py deleted file mode 100644 index 755159c8cf8..00000000000 --- a/plotly/validators/layout/ternary/domain/_column.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='column', - parent_name='layout.ternary.domain', - **kwargs - ): - super(ColumnValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/domain/_row.py b/plotly/validators/layout/ternary/domain/_row.py deleted file mode 100644 index a1218702d9c..00000000000 --- a/plotly/validators/layout/ternary/domain/_row.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class RowValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='row', parent_name='layout.ternary.domain', **kwargs - ): - super(RowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/domain/_x.py b/plotly/validators/layout/ternary/domain/_x.py deleted file mode 100644 index 2b6daa2df75..00000000000 --- a/plotly/validators/layout/ternary/domain/_x.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='x', parent_name='layout.ternary.domain', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/ternary/domain/_y.py b/plotly/validators/layout/ternary/domain/_y.py deleted file mode 100644 index 8a463a33717..00000000000 --- a/plotly/validators/layout/ternary/domain/_y.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='y', parent_name='layout.ternary.domain', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/title/__init__.py b/plotly/validators/layout/title/__init__.py index 87c8be3422c..113fea7e342 100644 --- a/plotly/validators/layout/title/__init__.py +++ b/plotly/validators/layout/title/__init__.py @@ -1,9 +1,195 @@ -from ._yref import YrefValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xref import XrefValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._text import TextValidator -from ._pad import PadValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class YrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='yref', parent_name='layout.title', **kwargs + ): + super(YrefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['container', 'paper']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='yanchor', parent_name='layout.title', **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='y', parent_name='layout.title', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xref', parent_name='layout.title', **kwargs + ): + super(XrefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['container', 'paper']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xanchor', parent_name='layout.title', **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='x', parent_name='layout.title', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='text', parent_name='layout.title', **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PadValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='pad', parent_name='layout.title', **kwargs + ): + super(PadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Pad'), + data_docs=kwargs.pop( + 'data_docs', """ + b + The amount of padding (in px) along the bottom + of the component. + l + The amount of padding (in px) on the left side + of the component. + r + The amount of padding (in px) on the right side + of the component. + t + The amount of padding (in px) along the top of + the component. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='layout.title', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/title/_font.py b/plotly/validators/layout/title/_font.py deleted file mode 100644 index 91a21bfcce7..00000000000 --- a/plotly/validators/layout/title/_font.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='layout.title', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/title/_pad.py b/plotly/validators/layout/title/_pad.py deleted file mode 100644 index 316cb931f6e..00000000000 --- a/plotly/validators/layout/title/_pad.py +++ /dev/null @@ -1,30 +0,0 @@ -import _plotly_utils.basevalidators - - -class PadValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='pad', parent_name='layout.title', **kwargs - ): - super(PadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Pad'), - data_docs=kwargs.pop( - 'data_docs', """ - b - The amount of padding (in px) along the bottom - of the component. - l - The amount of padding (in px) on the left side - of the component. - r - The amount of padding (in px) on the right side - of the component. - t - The amount of padding (in px) along the top of - the component. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/title/_text.py b/plotly/validators/layout/title/_text.py deleted file mode 100644 index d8bc6aeb4bd..00000000000 --- a/plotly/validators/layout/title/_text.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='text', parent_name='layout.title', **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/title/_x.py b/plotly/validators/layout/title/_x.py deleted file mode 100644 index 57dfd7a6a45..00000000000 --- a/plotly/validators/layout/title/_x.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='x', parent_name='layout.title', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/title/_xanchor.py b/plotly/validators/layout/title/_xanchor.py deleted file mode 100644 index afcfa7ea8dd..00000000000 --- a/plotly/validators/layout/title/_xanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xanchor', parent_name='layout.title', **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/layout/title/_xref.py b/plotly/validators/layout/title/_xref.py deleted file mode 100644 index 4745c77811d..00000000000 --- a/plotly/validators/layout/title/_xref.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xref', parent_name='layout.title', **kwargs - ): - super(XrefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['container', 'paper']), - **kwargs - ) diff --git a/plotly/validators/layout/title/_y.py b/plotly/validators/layout/title/_y.py deleted file mode 100644 index 91b2bc23c2c..00000000000 --- a/plotly/validators/layout/title/_y.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='y', parent_name='layout.title', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/title/_yanchor.py b/plotly/validators/layout/title/_yanchor.py deleted file mode 100644 index 396e07e47a7..00000000000 --- a/plotly/validators/layout/title/_yanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='yanchor', parent_name='layout.title', **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/layout/title/_yref.py b/plotly/validators/layout/title/_yref.py deleted file mode 100644 index d23ef6bf264..00000000000 --- a/plotly/validators/layout/title/_yref.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YrefValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='yref', parent_name='layout.title', **kwargs - ): - super(YrefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['container', 'paper']), - **kwargs - ) diff --git a/plotly/validators/layout/title/font/__init__.py b/plotly/validators/layout/title/font/__init__.py index 199d72e71c6..7b6173e1eab 100644 --- a/plotly/validators/layout/title/font/__init__.py +++ b/plotly/validators/layout/title/font/__init__.py @@ -1,3 +1,54 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='layout.title.font', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='layout.title.font', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='layout.title.font', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/title/font/_color.py b/plotly/validators/layout/title/font/_color.py deleted file mode 100644 index 838cb004877..00000000000 --- a/plotly/validators/layout/title/font/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='layout.title.font', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/title/font/_family.py b/plotly/validators/layout/title/font/_family.py deleted file mode 100644 index b644a4f903b..00000000000 --- a/plotly/validators/layout/title/font/_family.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='layout.title.font', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/title/font/_size.py b/plotly/validators/layout/title/font/_size.py deleted file mode 100644 index 6a02b754928..00000000000 --- a/plotly/validators/layout/title/font/_size.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='layout.title.font', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/title/pad/__init__.py b/plotly/validators/layout/title/pad/__init__.py index f2aa8ac13b5..838425be182 100644 --- a/plotly/validators/layout/title/pad/__init__.py +++ b/plotly/validators/layout/title/pad/__init__.py @@ -1,4 +1,68 @@ -from ._t import TValidator -from ._r import RValidator -from ._l import LValidator -from ._b import BValidator + + +import _plotly_utils.basevalidators + + +class TValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='t', parent_name='layout.title.pad', **kwargs + ): + super(TValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='r', parent_name='layout.title.pad', **kwargs + ): + super(RValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='l', parent_name='layout.title.pad', **kwargs + ): + super(LValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='b', parent_name='layout.title.pad', **kwargs + ): + super(BValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/title/pad/_b.py b/plotly/validators/layout/title/pad/_b.py deleted file mode 100644 index 709fb506c02..00000000000 --- a/plotly/validators/layout/title/pad/_b.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='b', parent_name='layout.title.pad', **kwargs - ): - super(BValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/title/pad/_l.py b/plotly/validators/layout/title/pad/_l.py deleted file mode 100644 index 5b80bcff232..00000000000 --- a/plotly/validators/layout/title/pad/_l.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='l', parent_name='layout.title.pad', **kwargs - ): - super(LValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/title/pad/_r.py b/plotly/validators/layout/title/pad/_r.py deleted file mode 100644 index 49b8af09896..00000000000 --- a/plotly/validators/layout/title/pad/_r.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class RValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='r', parent_name='layout.title.pad', **kwargs - ): - super(RValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/title/pad/_t.py b/plotly/validators/layout/title/pad/_t.py deleted file mode 100644 index b8ff1139b99..00000000000 --- a/plotly/validators/layout/title/pad/_t.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='t', parent_name='layout.title.pad', **kwargs - ): - super(TValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/transition/__init__.py b/plotly/validators/layout/transition/__init__.py index 8e2fb8bdf4d..6cd39737cde 100644 --- a/plotly/validators/layout/transition/__init__.py +++ b/plotly/validators/layout/transition/__init__.py @@ -1,3 +1,72 @@ -from ._ordering import OrderingValidator -from ._easing import EasingValidator -from ._duration import DurationValidator + + +import _plotly_utils.basevalidators + + +class OrderingValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ordering', + parent_name='layout.transition', + **kwargs + ): + super(OrderingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['layout first', 'traces first']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EasingValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='easing', parent_name='layout.transition', **kwargs + ): + super(EasingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'linear', 'quad', 'cubic', 'sin', 'exp', 'circle', + 'elastic', 'back', 'bounce', 'linear-in', 'quad-in', + 'cubic-in', 'sin-in', 'exp-in', 'circle-in', 'elastic-in', + 'back-in', 'bounce-in', 'linear-out', 'quad-out', + 'cubic-out', 'sin-out', 'exp-out', 'circle-out', + 'elastic-out', 'back-out', 'bounce-out', 'linear-in-out', + 'quad-in-out', 'cubic-in-out', 'sin-in-out', 'exp-in-out', + 'circle-in-out', 'elastic-in-out', 'back-in-out', + 'bounce-in-out' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DurationValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='duration', + parent_name='layout.transition', + **kwargs + ): + super(DurationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/transition/_duration.py b/plotly/validators/layout/transition/_duration.py deleted file mode 100644 index 6cb87f51339..00000000000 --- a/plotly/validators/layout/transition/_duration.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DurationValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='duration', - parent_name='layout.transition', - **kwargs - ): - super(DurationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/transition/_easing.py b/plotly/validators/layout/transition/_easing.py deleted file mode 100644 index ee2f43d3b8c..00000000000 --- a/plotly/validators/layout/transition/_easing.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class EasingValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='easing', parent_name='layout.transition', **kwargs - ): - super(EasingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'linear', 'quad', 'cubic', 'sin', 'exp', 'circle', - 'elastic', 'back', 'bounce', 'linear-in', 'quad-in', - 'cubic-in', 'sin-in', 'exp-in', 'circle-in', 'elastic-in', - 'back-in', 'bounce-in', 'linear-out', 'quad-out', - 'cubic-out', 'sin-out', 'exp-out', 'circle-out', - 'elastic-out', 'back-out', 'bounce-out', 'linear-in-out', - 'quad-in-out', 'cubic-in-out', 'sin-in-out', 'exp-in-out', - 'circle-in-out', 'elastic-in-out', 'back-in-out', - 'bounce-in-out' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/transition/_ordering.py b/plotly/validators/layout/transition/_ordering.py deleted file mode 100644 index 3e7405beb84..00000000000 --- a/plotly/validators/layout/transition/_ordering.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OrderingValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ordering', - parent_name='layout.transition', - **kwargs - ): - super(OrderingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['layout first', 'traces first']), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/__init__.py b/plotly/validators/layout/updatemenu/__init__.py index cdac88a09e1..10caea1f8e6 100644 --- a/plotly/validators/layout/updatemenu/__init__.py +++ b/plotly/validators/layout/updatemenu/__init__.py @@ -1,18 +1,423 @@ -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._visible import VisibleValidator -from ._type import TypeValidator -from ._templateitemname import TemplateitemnameValidator -from ._showactive import ShowactiveValidator -from ._pad import PadValidator -from ._name import NameValidator -from ._font import FontValidator -from ._direction import DirectionValidator -from ._buttondefaults import ButtonValidator -from ._buttons import ButtonsValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator -from ._active import ActiveValidator + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='yanchor', parent_name='layout.updatemenu', **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='layout.updatemenu', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xanchor', parent_name='layout.updatemenu', **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='layout.updatemenu', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='layout.updatemenu', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='layout.updatemenu', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['dropdown', 'buttons']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.updatemenu', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowactiveValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showactive', + parent_name='layout.updatemenu', + **kwargs + ): + super(ShowactiveValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PadValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='pad', parent_name='layout.updatemenu', **kwargs + ): + super(PadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Pad'), + data_docs=kwargs.pop( + 'data_docs', """ + b + The amount of padding (in px) along the bottom + of the component. + l + The amount of padding (in px) on the left side + of the component. + r + The amount of padding (in px) on the right side + of the component. + t + The amount of padding (in px) along the top of + the component. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='layout.updatemenu', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='layout.updatemenu', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DirectionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='direction', + parent_name='layout.updatemenu', + **kwargs + ): + super(DirectionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['left', 'right', 'up', 'down']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ButtonValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='buttondefaults', + parent_name='layout.updatemenu', + **kwargs + ): + super(ButtonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Button'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ButtonsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, plotly_name='buttons', parent_name='layout.updatemenu', **kwargs + ): + super(ButtonsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Button'), + data_docs=kwargs.pop( + 'data_docs', """ + args + Sets the arguments values to be passed to the + Plotly method set in `method` on click. + execute + When true, the API method is executed. When + false, all other behaviors are the same and + command execution is skipped. This may be + useful when hooking into, for example, the + `plotly_buttonclicked` method and executing the + API command manually without losing the benefit + of the updatemenu automatically binding to the + state of the plot through the specification of + `method` and `args`. + label + Sets the text label to appear on the button. + method + Sets the Plotly method to be called on click. + If the `skip` method is used, the API + updatemenu will function as normal but 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. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + visible + Determines whether or not this button is + visible. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='layout.updatemenu', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='layout.updatemenu', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='layout.updatemenu', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ActiveValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='active', parent_name='layout.updatemenu', **kwargs + ): + super(ActiveValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/updatemenu/_active.py b/plotly/validators/layout/updatemenu/_active.py deleted file mode 100644 index 9b948678671..00000000000 --- a/plotly/validators/layout/updatemenu/_active.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ActiveValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='active', parent_name='layout.updatemenu', **kwargs - ): - super(ActiveValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_bgcolor.py b/plotly/validators/layout/updatemenu/_bgcolor.py deleted file mode 100644 index cf897d867a3..00000000000 --- a/plotly/validators/layout/updatemenu/_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='layout.updatemenu', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_bordercolor.py b/plotly/validators/layout/updatemenu/_bordercolor.py deleted file mode 100644 index ca5dfe24460..00000000000 --- a/plotly/validators/layout/updatemenu/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='layout.updatemenu', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_borderwidth.py b/plotly/validators/layout/updatemenu/_borderwidth.py deleted file mode 100644 index 61d0f9adc13..00000000000 --- a/plotly/validators/layout/updatemenu/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='layout.updatemenu', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_buttondefaults.py b/plotly/validators/layout/updatemenu/_buttondefaults.py deleted file mode 100644 index a6f003c503b..00000000000 --- a/plotly/validators/layout/updatemenu/_buttondefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ButtonValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='buttondefaults', - parent_name='layout.updatemenu', - **kwargs - ): - super(ButtonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Button'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_buttons.py b/plotly/validators/layout/updatemenu/_buttons.py deleted file mode 100644 index 561c1f8551a..00000000000 --- a/plotly/validators/layout/updatemenu/_buttons.py +++ /dev/null @@ -1,65 +0,0 @@ -import _plotly_utils.basevalidators - - -class ButtonsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, plotly_name='buttons', parent_name='layout.updatemenu', **kwargs - ): - super(ButtonsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Button'), - data_docs=kwargs.pop( - 'data_docs', """ - args - Sets the arguments values to be passed to the - Plotly method set in `method` on click. - execute - When true, the API method is executed. When - false, all other behaviors are the same and - command execution is skipped. This may be - useful when hooking into, for example, the - `plotly_buttonclicked` method and executing the - API command manually without losing the benefit - of the updatemenu automatically binding to the - state of the plot through the specification of - `method` and `args`. - label - Sets the text label to appear on the button. - method - Sets the Plotly method to be called on click. - If the `skip` method is used, the API - updatemenu will function as normal but 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. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - visible - Determines whether or not this button is - visible. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_direction.py b/plotly/validators/layout/updatemenu/_direction.py deleted file mode 100644 index 5cb71f353bf..00000000000 --- a/plotly/validators/layout/updatemenu/_direction.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DirectionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='direction', - parent_name='layout.updatemenu', - **kwargs - ): - super(DirectionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['left', 'right', 'up', 'down']), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_font.py b/plotly/validators/layout/updatemenu/_font.py deleted file mode 100644 index ed6e1f61f22..00000000000 --- a/plotly/validators/layout/updatemenu/_font.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='layout.updatemenu', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_name.py b/plotly/validators/layout/updatemenu/_name.py deleted file mode 100644 index 8a92b541c02..00000000000 --- a/plotly/validators/layout/updatemenu/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='layout.updatemenu', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_pad.py b/plotly/validators/layout/updatemenu/_pad.py deleted file mode 100644 index 69f43e4a088..00000000000 --- a/plotly/validators/layout/updatemenu/_pad.py +++ /dev/null @@ -1,30 +0,0 @@ -import _plotly_utils.basevalidators - - -class PadValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='pad', parent_name='layout.updatemenu', **kwargs - ): - super(PadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Pad'), - data_docs=kwargs.pop( - 'data_docs', """ - b - The amount of padding (in px) along the bottom - of the component. - l - The amount of padding (in px) on the left side - of the component. - r - The amount of padding (in px) on the right side - of the component. - t - The amount of padding (in px) along the top of - the component. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_showactive.py b/plotly/validators/layout/updatemenu/_showactive.py deleted file mode 100644 index 7950864132e..00000000000 --- a/plotly/validators/layout/updatemenu/_showactive.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowactiveValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showactive', - parent_name='layout.updatemenu', - **kwargs - ): - super(ShowactiveValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_templateitemname.py b/plotly/validators/layout/updatemenu/_templateitemname.py deleted file mode 100644 index a70664530e1..00000000000 --- a/plotly/validators/layout/updatemenu/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.updatemenu', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_type.py b/plotly/validators/layout/updatemenu/_type.py deleted file mode 100644 index 1f037a2e940..00000000000 --- a/plotly/validators/layout/updatemenu/_type.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='layout.updatemenu', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['dropdown', 'buttons']), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_visible.py b/plotly/validators/layout/updatemenu/_visible.py deleted file mode 100644 index 302adcc2169..00000000000 --- a/plotly/validators/layout/updatemenu/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='layout.updatemenu', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_x.py b/plotly/validators/layout/updatemenu/_x.py deleted file mode 100644 index 0e1451dd356..00000000000 --- a/plotly/validators/layout/updatemenu/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='layout.updatemenu', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_xanchor.py b/plotly/validators/layout/updatemenu/_xanchor.py deleted file mode 100644 index 6e3c3571067..00000000000 --- a/plotly/validators/layout/updatemenu/_xanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xanchor', parent_name='layout.updatemenu', **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_y.py b/plotly/validators/layout/updatemenu/_y.py deleted file mode 100644 index 1fae6e1b4c3..00000000000 --- a/plotly/validators/layout/updatemenu/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='layout.updatemenu', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/_yanchor.py b/plotly/validators/layout/updatemenu/_yanchor.py deleted file mode 100644 index 9aee33babde..00000000000 --- a/plotly/validators/layout/updatemenu/_yanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='yanchor', parent_name='layout.updatemenu', **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/button/__init__.py b/plotly/validators/layout/updatemenu/button/__init__.py index 2e11115e446..8f527b396b3 100644 --- a/plotly/validators/layout/updatemenu/button/__init__.py +++ b/plotly/validators/layout/updatemenu/button/__init__.py @@ -1,7 +1,158 @@ -from ._visible import VisibleValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._method import MethodValidator -from ._label import LabelValidator -from ._execute import ExecuteValidator -from ._args import ArgsValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='visible', + parent_name='layout.updatemenu.button', + **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.updatemenu.button', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='layout.updatemenu.button', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MethodValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='method', + parent_name='layout.updatemenu.button', + **kwargs + ): + super(MethodValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['restyle', 'relayout', 'animate', 'update', 'skip'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='label', + parent_name='layout.updatemenu.button', + **kwargs + ): + super(LabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExecuteValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='execute', + parent_name='layout.updatemenu.button', + **kwargs + ): + super(ExecuteValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArgsValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='args', + parent_name='layout.updatemenu.button', + **kwargs + ): + super(ArgsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + free_length=kwargs.pop('free_length', True), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'arraydraw' + }, { + 'valType': 'any', + 'editType': 'arraydraw' + }, { + 'valType': 'any', + 'editType': 'arraydraw' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/updatemenu/button/_args.py b/plotly/validators/layout/updatemenu/button/_args.py deleted file mode 100644 index 10b3f0543ae..00000000000 --- a/plotly/validators/layout/updatemenu/button/_args.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArgsValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='args', - parent_name='layout.updatemenu.button', - **kwargs - ): - super(ArgsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - free_length=kwargs.pop('free_length', True), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'arraydraw' - }, { - 'valType': 'any', - 'editType': 'arraydraw' - }, { - 'valType': 'any', - 'editType': 'arraydraw' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/button/_execute.py b/plotly/validators/layout/updatemenu/button/_execute.py deleted file mode 100644 index 24b0d0810d7..00000000000 --- a/plotly/validators/layout/updatemenu/button/_execute.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExecuteValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='execute', - parent_name='layout.updatemenu.button', - **kwargs - ): - super(ExecuteValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/button/_label.py b/plotly/validators/layout/updatemenu/button/_label.py deleted file mode 100644 index b0c99b77571..00000000000 --- a/plotly/validators/layout/updatemenu/button/_label.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='label', - parent_name='layout.updatemenu.button', - **kwargs - ): - super(LabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/button/_method.py b/plotly/validators/layout/updatemenu/button/_method.py deleted file mode 100644 index a0b54d96ccc..00000000000 --- a/plotly/validators/layout/updatemenu/button/_method.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class MethodValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='method', - parent_name='layout.updatemenu.button', - **kwargs - ): - super(MethodValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['restyle', 'relayout', 'animate', 'update', 'skip'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/button/_name.py b/plotly/validators/layout/updatemenu/button/_name.py deleted file mode 100644 index 7b117fe0d96..00000000000 --- a/plotly/validators/layout/updatemenu/button/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='layout.updatemenu.button', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/button/_templateitemname.py b/plotly/validators/layout/updatemenu/button/_templateitemname.py deleted file mode 100644 index e528b46b023..00000000000 --- a/plotly/validators/layout/updatemenu/button/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.updatemenu.button', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/button/_visible.py b/plotly/validators/layout/updatemenu/button/_visible.py deleted file mode 100644 index 417068d4182..00000000000 --- a/plotly/validators/layout/updatemenu/button/_visible.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='visible', - parent_name='layout.updatemenu.button', - **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/font/__init__.py b/plotly/validators/layout/updatemenu/font/__init__.py index 199d72e71c6..f40904ab064 100644 --- a/plotly/validators/layout/updatemenu/font/__init__.py +++ b/plotly/validators/layout/updatemenu/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.updatemenu.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.updatemenu.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.updatemenu.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/updatemenu/font/_color.py b/plotly/validators/layout/updatemenu/font/_color.py deleted file mode 100644 index f247b7f2583..00000000000 --- a/plotly/validators/layout/updatemenu/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.updatemenu.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/font/_family.py b/plotly/validators/layout/updatemenu/font/_family.py deleted file mode 100644 index 5d12ad7412a..00000000000 --- a/plotly/validators/layout/updatemenu/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.updatemenu.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/font/_size.py b/plotly/validators/layout/updatemenu/font/_size.py deleted file mode 100644 index 9629a283e9e..00000000000 --- a/plotly/validators/layout/updatemenu/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.updatemenu.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/pad/__init__.py b/plotly/validators/layout/updatemenu/pad/__init__.py index f2aa8ac13b5..0b3b9ec8c30 100644 --- a/plotly/validators/layout/updatemenu/pad/__init__.py +++ b/plotly/validators/layout/updatemenu/pad/__init__.py @@ -1,4 +1,68 @@ -from ._t import TValidator -from ._r import RValidator -from ._l import LValidator -from ._b import BValidator + + +import _plotly_utils.basevalidators + + +class TValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='t', parent_name='layout.updatemenu.pad', **kwargs + ): + super(TValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='r', parent_name='layout.updatemenu.pad', **kwargs + ): + super(RValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='l', parent_name='layout.updatemenu.pad', **kwargs + ): + super(LValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='b', parent_name='layout.updatemenu.pad', **kwargs + ): + super(BValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'arraydraw'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/updatemenu/pad/_b.py b/plotly/validators/layout/updatemenu/pad/_b.py deleted file mode 100644 index e5bb26c3be8..00000000000 --- a/plotly/validators/layout/updatemenu/pad/_b.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='b', parent_name='layout.updatemenu.pad', **kwargs - ): - super(BValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/pad/_l.py b/plotly/validators/layout/updatemenu/pad/_l.py deleted file mode 100644 index cdaf4cfde8e..00000000000 --- a/plotly/validators/layout/updatemenu/pad/_l.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='l', parent_name='layout.updatemenu.pad', **kwargs - ): - super(LValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/pad/_r.py b/plotly/validators/layout/updatemenu/pad/_r.py deleted file mode 100644 index c25eaaf78d6..00000000000 --- a/plotly/validators/layout/updatemenu/pad/_r.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class RValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='r', parent_name='layout.updatemenu.pad', **kwargs - ): - super(RValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/updatemenu/pad/_t.py b/plotly/validators/layout/updatemenu/pad/_t.py deleted file mode 100644 index 4e538595bdc..00000000000 --- a/plotly/validators/layout/updatemenu/pad/_t.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='t', parent_name='layout.updatemenu.pad', **kwargs - ): - super(TValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'arraydraw'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/__init__.py b/plotly/validators/layout/xaxis/__init__.py index 4a2f0f1171d..3105c400d29 100644 --- a/plotly/validators/layout/xaxis/__init__.py +++ b/plotly/validators/layout/xaxis/__init__.py @@ -1,73 +1,1570 @@ -from ._zerolinewidth import ZerolinewidthValidator -from ._zerolinecolor import ZerolinecolorValidator -from ._zeroline import ZerolineValidator -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._type import TypeValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._tickson import TicksonValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._spikethickness import SpikethicknessValidator -from ._spikesnap import SpikesnapValidator -from ._spikemode import SpikemodeValidator -from ._spikedash import SpikedashValidator -from ._spikecolor import SpikecolorValidator -from ._side import SideValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showspikes import ShowspikesValidator -from ._showline import ShowlineValidator -from ._showgrid import ShowgridValidator -from ._showexponent import ShowexponentValidator -from ._showdividers import ShowdividersValidator -from ._separatethousands import SeparatethousandsValidator -from ._scaleratio import ScaleratioValidator -from ._scaleanchor import ScaleanchorValidator -from ._rangeslider import RangesliderValidator -from ._rangeselector import RangeselectorValidator -from ._rangemode import RangemodeValidator -from ._range import RangeValidator -from ._position import PositionValidator -from ._overlaying import OverlayingValidator -from ._nticks import NticksValidator -from ._mirror import MirrorValidator -from ._matches import MatchesValidator -from ._linewidth import LinewidthValidator -from ._linecolor import LinecolorValidator -from ._layer import LayerValidator -from ._hoverformat import HoverformatValidator -from ._gridwidth import GridwidthValidator -from ._gridcolor import GridcolorValidator -from ._fixedrange import FixedrangeValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._domain import DomainValidator -from ._dividerwidth import DividerwidthValidator -from ._dividercolor import DividercolorValidator -from ._constraintoward import ConstraintowardValidator -from ._constrain import ConstrainValidator -from ._color import ColorValidator -from ._categoryorder import CategoryorderValidator -from ._categoryarraysrc import CategoryarraysrcValidator -from ._categoryarray import CategoryarrayValidator -from ._calendar import CalendarValidator -from ._autorange import AutorangeValidator -from ._automargin import AutomarginValidator -from ._anchor import AnchorValidator + + +import _plotly_utils.basevalidators + + +class ZerolinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='zerolinewidth', + parent_name='layout.xaxis', + **kwargs + ): + super(ZerolinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZerolinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='zerolinecolor', + parent_name='layout.xaxis', + **kwargs + ): + super(ZerolinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZerolineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='zeroline', parent_name='layout.xaxis', **kwargs + ): + super(ZerolineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='layout.xaxis', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='layout.xaxis', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='layout.xaxis', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', + ['-', 'linear', 'log', 'date', 'category', 'multicategory'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='layout.xaxis', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this axis' title font. Note that the + title's font used to be customized by the now + deprecated `titlefont` attribute. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='tickwidth', parent_name='layout.xaxis', **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='tickvalssrc', parent_name='layout.xaxis', **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='tickvals', parent_name='layout.xaxis', **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='ticktextsrc', parent_name='layout.xaxis', **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ticktext', parent_name='layout.xaxis', **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='ticksuffix', parent_name='layout.xaxis', **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksonValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='tickson', parent_name='layout.xaxis', **kwargs + ): + super(TicksonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['labels', 'boundaries']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ticks', parent_name='layout.xaxis', **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='tickprefix', parent_name='layout.xaxis', **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='tickmode', parent_name='layout.xaxis', **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ticklen', parent_name='layout.xaxis', **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='layout.xaxis', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='layout.xaxis', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='tickformat', parent_name='layout.xaxis', **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='tickfont', parent_name='layout.xaxis', **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='tickcolor', parent_name='layout.xaxis', **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, plotly_name='tickangle', parent_name='layout.xaxis', **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='tick0', parent_name='layout.xaxis', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikethicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='spikethickness', + parent_name='layout.xaxis', + **kwargs + ): + super(SpikethicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikesnapValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='spikesnap', parent_name='layout.xaxis', **kwargs + ): + super(SpikesnapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['data', 'cursor']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikemodeValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='spikemode', parent_name='layout.xaxis', **kwargs + ): + super(SpikemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + flags=kwargs.pop('flags', ['toaxis', 'across', 'marker']), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikedashValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='spikedash', parent_name='layout.xaxis', **kwargs + ): + super(SpikedashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='spikecolor', parent_name='layout.xaxis', **kwargs + ): + super(SpikecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='side', parent_name='layout.xaxis', **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['top', 'bottom', 'left', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='layout.xaxis', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='layout.xaxis', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='layout.xaxis', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowspikesValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showspikes', parent_name='layout.xaxis', **kwargs + ): + super(ShowspikesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'modebar'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showline', parent_name='layout.xaxis', **kwargs + ): + super(ShowlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks+layoutstyle'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showgrid', parent_name='layout.xaxis', **kwargs + ): + super(ShowgridValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='showexponent', parent_name='layout.xaxis', **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowdividersValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showdividers', parent_name='layout.xaxis', **kwargs + ): + super(ShowdividersValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='layout.xaxis', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScaleratioValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='scaleratio', parent_name='layout.xaxis', **kwargs + ): + super(ScaleratioValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScaleanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='scaleanchor', parent_name='layout.xaxis', **kwargs + ): + super(ScaleanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', + ['/^x([2-9]|[1-9][0-9]+)?$/', '/^y([2-9]|[1-9][0-9]+)?$/'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangesliderValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='rangeslider', parent_name='layout.xaxis', **kwargs + ): + super(RangesliderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Rangeslider'), + data_docs=kwargs.pop( + 'data_docs', """ + autorange + 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. + bgcolor + Sets the background color of the range slider. + bordercolor + Sets the border color of the range slider. + borderwidth + Sets the border width of the range slider. + range + 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. + thickness + The height of the range slider as a fraction of + the total plot area height. + visible + Determines whether or not the range slider will + be visible. If visible, perpendicular axes will + be set to `fixedrange` + yaxis + plotly.graph_objs.layout.xaxis.rangeslider.YAxi + s instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangeselectorValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='rangeselector', + parent_name='layout.xaxis', + **kwargs + ): + super(RangeselectorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Rangeselector'), + data_docs=kwargs.pop( + 'data_docs', """ + activecolor + Sets the background color of the active range + selector button. + bgcolor + Sets the background color of the range selector + buttons. + bordercolor + Sets the color of the border enclosing the + range selector. + borderwidth + Sets the width (in px) of the border enclosing + the range selector. + buttons + Sets the specifications for each buttons. By + default, a range selector comes with no + buttons. + buttondefaults + When used in a template (as layout.template.lay + out.xaxis.rangeselector.buttondefaults), sets + the default property values to use for elements + of layout.xaxis.rangeselector.buttons + font + Sets the font of the range selector button + text. + visible + 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". + x + Sets the x position (in normalized coordinates) + of the range selector. + xanchor + Sets the range selector's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the range + selector. + y + Sets the y position (in normalized coordinates) + of the range selector. + yanchor + Sets the range selector's vertical position + anchor This anchor binds the `y` position to + the "top", "middle" or "bottom" of the range + selector. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='rangemode', parent_name='layout.xaxis', **kwargs + ): + super(RangemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['normal', 'tozero', 'nonnegative']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='range', parent_name='layout.xaxis', **kwargs + ): + super(RangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'axrange'), + implied_edits=kwargs.pop('implied_edits', {'autorange': False}), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'axrange', + 'impliedEdits': { + '^autorange': False + }, + 'anim': True + }, + { + 'valType': 'any', + 'editType': 'axrange', + 'impliedEdits': { + '^autorange': False + }, + 'anim': True + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PositionValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='position', parent_name='layout.xaxis', **kwargs + ): + super(PositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OverlayingValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='overlaying', parent_name='layout.xaxis', **kwargs + ): + super(OverlayingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'free', '/^x([2-9]|[1-9][0-9]+)?$/', + '/^y([2-9]|[1-9][0-9]+)?$/' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nticks', parent_name='layout.xaxis', **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MirrorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='mirror', parent_name='layout.xaxis', **kwargs + ): + super(MirrorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks+layoutstyle'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [True, 'ticks', False, 'all', 'allticks'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MatchesValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='matches', parent_name='layout.xaxis', **kwargs + ): + super(MatchesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', + ['/^x([2-9]|[1-9][0-9]+)?$/', '/^y([2-9]|[1-9][0-9]+)?$/'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='linewidth', parent_name='layout.xaxis', **kwargs + ): + super(LinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks+layoutstyle'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='linecolor', parent_name='layout.xaxis', **kwargs + ): + super(LinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='layer', parent_name='layout.xaxis', **kwargs + ): + super(LayerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['above traces', 'below traces']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hoverformat', parent_name='layout.xaxis', **kwargs + ): + super(HoverformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='gridwidth', parent_name='layout.xaxis', **kwargs + ): + super(GridwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='gridcolor', parent_name='layout.xaxis', **kwargs + ): + super(GridcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FixedrangeValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='fixedrange', parent_name='layout.xaxis', **kwargs + ): + super(FixedrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='layout.xaxis', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='dtick', parent_name='layout.xaxis', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DomainValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='domain', parent_name='layout.xaxis', **kwargs + ): + super(DomainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DividerwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='dividerwidth', parent_name='layout.xaxis', **kwargs + ): + super(DividerwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DividercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='dividercolor', parent_name='layout.xaxis', **kwargs + ): + super(DividercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConstraintowardValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='constraintoward', + parent_name='layout.xaxis', + **kwargs + ): + super(ConstraintowardValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', + ['left', 'center', 'right', 'top', 'middle', 'bottom'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConstrainValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='constrain', parent_name='layout.xaxis', **kwargs + ): + super(ConstrainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['range', 'domain']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='layout.xaxis', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='categoryorder', + parent_name='layout.xaxis', + **kwargs + ): + super(CategoryorderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'trace', 'category ascending', 'category descending', + 'array' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='categoryarraysrc', + parent_name='layout.xaxis', + **kwargs + ): + super(CategoryarraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='categoryarray', + parent_name='layout.xaxis', + **kwargs + ): + super(CategoryarrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='calendar', parent_name='layout.xaxis', **kwargs + ): + super(CalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutorangeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='autorange', parent_name='layout.xaxis', **kwargs + ): + super(AutorangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'axrange'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'reversed']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutomarginValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='automargin', parent_name='layout.xaxis', **kwargs + ): + super(AutomarginValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AnchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='anchor', parent_name='layout.xaxis', **kwargs + ): + super(AnchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'free', '/^x([2-9]|[1-9][0-9]+)?$/', + '/^y([2-9]|[1-9][0-9]+)?$/' + ] + ), + **kwargs + ) diff --git a/plotly/validators/layout/xaxis/_anchor.py b/plotly/validators/layout/xaxis/_anchor.py deleted file mode 100644 index db4ae08fdaf..00000000000 --- a/plotly/validators/layout/xaxis/_anchor.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class AnchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='anchor', parent_name='layout.xaxis', **kwargs - ): - super(AnchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'free', '/^x([2-9]|[1-9][0-9]+)?$/', - '/^y([2-9]|[1-9][0-9]+)?$/' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_automargin.py b/plotly/validators/layout/xaxis/_automargin.py deleted file mode 100644 index ecacfbcbe53..00000000000 --- a/plotly/validators/layout/xaxis/_automargin.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutomarginValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='automargin', parent_name='layout.xaxis', **kwargs - ): - super(AutomarginValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_autorange.py b/plotly/validators/layout/xaxis/_autorange.py deleted file mode 100644 index 6a9983824df..00000000000 --- a/plotly/validators/layout/xaxis/_autorange.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutorangeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='autorange', parent_name='layout.xaxis', **kwargs - ): - super(AutorangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'axrange'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'reversed']), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_calendar.py b/plotly/validators/layout/xaxis/_calendar.py deleted file mode 100644 index 91871302555..00000000000 --- a/plotly/validators/layout/xaxis/_calendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class CalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='calendar', parent_name='layout.xaxis', **kwargs - ): - super(CalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_categoryarray.py b/plotly/validators/layout/xaxis/_categoryarray.py deleted file mode 100644 index 87c1814d18b..00000000000 --- a/plotly/validators/layout/xaxis/_categoryarray.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='categoryarray', - parent_name='layout.xaxis', - **kwargs - ): - super(CategoryarrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_categoryarraysrc.py b/plotly/validators/layout/xaxis/_categoryarraysrc.py deleted file mode 100644 index 4c3efccb71e..00000000000 --- a/plotly/validators/layout/xaxis/_categoryarraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='categoryarraysrc', - parent_name='layout.xaxis', - **kwargs - ): - super(CategoryarraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_categoryorder.py b/plotly/validators/layout/xaxis/_categoryorder.py deleted file mode 100644 index 14ba3d61142..00000000000 --- a/plotly/validators/layout/xaxis/_categoryorder.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='categoryorder', - parent_name='layout.xaxis', - **kwargs - ): - super(CategoryorderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'trace', 'category ascending', 'category descending', - 'array' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_color.py b/plotly/validators/layout/xaxis/_color.py deleted file mode 100644 index 597a1fb05f8..00000000000 --- a/plotly/validators/layout/xaxis/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='layout.xaxis', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_constrain.py b/plotly/validators/layout/xaxis/_constrain.py deleted file mode 100644 index 8c038a339f2..00000000000 --- a/plotly/validators/layout/xaxis/_constrain.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConstrainValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='constrain', parent_name='layout.xaxis', **kwargs - ): - super(ConstrainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['range', 'domain']), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_constraintoward.py b/plotly/validators/layout/xaxis/_constraintoward.py deleted file mode 100644 index a2c331cfd9f..00000000000 --- a/plotly/validators/layout/xaxis/_constraintoward.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConstraintowardValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='constraintoward', - parent_name='layout.xaxis', - **kwargs - ): - super(ConstraintowardValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', - ['left', 'center', 'right', 'top', 'middle', 'bottom'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_dividercolor.py b/plotly/validators/layout/xaxis/_dividercolor.py deleted file mode 100644 index 5b96feb95eb..00000000000 --- a/plotly/validators/layout/xaxis/_dividercolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class DividercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='dividercolor', parent_name='layout.xaxis', **kwargs - ): - super(DividercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_dividerwidth.py b/plotly/validators/layout/xaxis/_dividerwidth.py deleted file mode 100644 index 41c37dbcd92..00000000000 --- a/plotly/validators/layout/xaxis/_dividerwidth.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class DividerwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='dividerwidth', parent_name='layout.xaxis', **kwargs - ): - super(DividerwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_domain.py b/plotly/validators/layout/xaxis/_domain.py deleted file mode 100644 index 42fb4839e59..00000000000 --- a/plotly/validators/layout/xaxis/_domain.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class DomainValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='domain', parent_name='layout.xaxis', **kwargs - ): - super(DomainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_dtick.py b/plotly/validators/layout/xaxis/_dtick.py deleted file mode 100644 index dec17a66a5f..00000000000 --- a/plotly/validators/layout/xaxis/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='dtick', parent_name='layout.xaxis', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_exponentformat.py b/plotly/validators/layout/xaxis/_exponentformat.py deleted file mode 100644 index a96e75a54e0..00000000000 --- a/plotly/validators/layout/xaxis/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='layout.xaxis', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_fixedrange.py b/plotly/validators/layout/xaxis/_fixedrange.py deleted file mode 100644 index 91c768a5a9f..00000000000 --- a/plotly/validators/layout/xaxis/_fixedrange.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FixedrangeValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='fixedrange', parent_name='layout.xaxis', **kwargs - ): - super(FixedrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_gridcolor.py b/plotly/validators/layout/xaxis/_gridcolor.py deleted file mode 100644 index ba1e8c55970..00000000000 --- a/plotly/validators/layout/xaxis/_gridcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='gridcolor', parent_name='layout.xaxis', **kwargs - ): - super(GridcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_gridwidth.py b/plotly/validators/layout/xaxis/_gridwidth.py deleted file mode 100644 index 495c6307481..00000000000 --- a/plotly/validators/layout/xaxis/_gridwidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='gridwidth', parent_name='layout.xaxis', **kwargs - ): - super(GridwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_hoverformat.py b/plotly/validators/layout/xaxis/_hoverformat.py deleted file mode 100644 index 9fb095f8896..00000000000 --- a/plotly/validators/layout/xaxis/_hoverformat.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hoverformat', parent_name='layout.xaxis', **kwargs - ): - super(HoverformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_layer.py b/plotly/validators/layout/xaxis/_layer.py deleted file mode 100644 index 729855f9427..00000000000 --- a/plotly/validators/layout/xaxis/_layer.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='layer', parent_name='layout.xaxis', **kwargs - ): - super(LayerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['above traces', 'below traces']), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_linecolor.py b/plotly/validators/layout/xaxis/_linecolor.py deleted file mode 100644 index 8e8333ccbcb..00000000000 --- a/plotly/validators/layout/xaxis/_linecolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='linecolor', parent_name='layout.xaxis', **kwargs - ): - super(LinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_linewidth.py b/plotly/validators/layout/xaxis/_linewidth.py deleted file mode 100644 index 84f3ff8f9fe..00000000000 --- a/plotly/validators/layout/xaxis/_linewidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='linewidth', parent_name='layout.xaxis', **kwargs - ): - super(LinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks+layoutstyle'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_matches.py b/plotly/validators/layout/xaxis/_matches.py deleted file mode 100644 index 23e85144d78..00000000000 --- a/plotly/validators/layout/xaxis/_matches.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class MatchesValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='matches', parent_name='layout.xaxis', **kwargs - ): - super(MatchesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', - ['/^x([2-9]|[1-9][0-9]+)?$/', '/^y([2-9]|[1-9][0-9]+)?$/'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_mirror.py b/plotly/validators/layout/xaxis/_mirror.py deleted file mode 100644 index 32d8cf98661..00000000000 --- a/plotly/validators/layout/xaxis/_mirror.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class MirrorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='mirror', parent_name='layout.xaxis', **kwargs - ): - super(MirrorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks+layoutstyle'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [True, 'ticks', False, 'all', 'allticks'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_nticks.py b/plotly/validators/layout/xaxis/_nticks.py deleted file mode 100644 index 49ec824869a..00000000000 --- a/plotly/validators/layout/xaxis/_nticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nticks', parent_name='layout.xaxis', **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_overlaying.py b/plotly/validators/layout/xaxis/_overlaying.py deleted file mode 100644 index 6fbaa94cc30..00000000000 --- a/plotly/validators/layout/xaxis/_overlaying.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class OverlayingValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='overlaying', parent_name='layout.xaxis', **kwargs - ): - super(OverlayingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'free', '/^x([2-9]|[1-9][0-9]+)?$/', - '/^y([2-9]|[1-9][0-9]+)?$/' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_position.py b/plotly/validators/layout/xaxis/_position.py deleted file mode 100644 index 0379a660a55..00000000000 --- a/plotly/validators/layout/xaxis/_position.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class PositionValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='position', parent_name='layout.xaxis', **kwargs - ): - super(PositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_range.py b/plotly/validators/layout/xaxis/_range.py deleted file mode 100644 index f0d15399f7c..00000000000 --- a/plotly/validators/layout/xaxis/_range.py +++ /dev/null @@ -1,37 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='range', parent_name='layout.xaxis', **kwargs - ): - super(RangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'axrange'), - implied_edits=kwargs.pop('implied_edits', {'autorange': False}), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'axrange', - 'impliedEdits': { - '^autorange': False - }, - 'anim': True - }, - { - 'valType': 'any', - 'editType': 'axrange', - 'impliedEdits': { - '^autorange': False - }, - 'anim': True - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_rangemode.py b/plotly/validators/layout/xaxis/_rangemode.py deleted file mode 100644 index ffe615b31a3..00000000000 --- a/plotly/validators/layout/xaxis/_rangemode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='rangemode', parent_name='layout.xaxis', **kwargs - ): - super(RangemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['normal', 'tozero', 'nonnegative']), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_rangeselector.py b/plotly/validators/layout/xaxis/_rangeselector.py deleted file mode 100644 index e90c08d2847..00000000000 --- a/plotly/validators/layout/xaxis/_rangeselector.py +++ /dev/null @@ -1,66 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangeselectorValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='rangeselector', - parent_name='layout.xaxis', - **kwargs - ): - super(RangeselectorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Rangeselector'), - data_docs=kwargs.pop( - 'data_docs', """ - activecolor - Sets the background color of the active range - selector button. - bgcolor - Sets the background color of the range selector - buttons. - bordercolor - Sets the color of the border enclosing the - range selector. - borderwidth - Sets the width (in px) of the border enclosing - the range selector. - buttons - Sets the specifications for each buttons. By - default, a range selector comes with no - buttons. - buttondefaults - When used in a template (as layout.template.lay - out.xaxis.rangeselector.buttondefaults), sets - the default property values to use for elements - of layout.xaxis.rangeselector.buttons - font - Sets the font of the range selector button - text. - visible - 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". - x - Sets the x position (in normalized coordinates) - of the range selector. - xanchor - Sets the range selector's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the range - selector. - y - Sets the y position (in normalized coordinates) - of the range selector. - yanchor - Sets the range selector's vertical position - anchor This anchor binds the `y` position to - the "top", "middle" or "bottom" of the range - selector. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_rangeslider.py b/plotly/validators/layout/xaxis/_rangeslider.py deleted file mode 100644 index c4013c20e1f..00000000000 --- a/plotly/validators/layout/xaxis/_rangeslider.py +++ /dev/null @@ -1,51 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangesliderValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='rangeslider', parent_name='layout.xaxis', **kwargs - ): - super(RangesliderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Rangeslider'), - data_docs=kwargs.pop( - 'data_docs', """ - autorange - 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. - bgcolor - Sets the background color of the range slider. - bordercolor - Sets the border color of the range slider. - borderwidth - Sets the border width of the range slider. - range - 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. - thickness - The height of the range slider as a fraction of - the total plot area height. - visible - Determines whether or not the range slider will - be visible. If visible, perpendicular axes will - be set to `fixedrange` - yaxis - plotly.graph_objs.layout.xaxis.rangeslider.YAxi - s instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_scaleanchor.py b/plotly/validators/layout/xaxis/_scaleanchor.py deleted file mode 100644 index 0a7a050405e..00000000000 --- a/plotly/validators/layout/xaxis/_scaleanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScaleanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='scaleanchor', parent_name='layout.xaxis', **kwargs - ): - super(ScaleanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', - ['/^x([2-9]|[1-9][0-9]+)?$/', '/^y([2-9]|[1-9][0-9]+)?$/'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_scaleratio.py b/plotly/validators/layout/xaxis/_scaleratio.py deleted file mode 100644 index 165fe014b67..00000000000 --- a/plotly/validators/layout/xaxis/_scaleratio.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScaleratioValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='scaleratio', parent_name='layout.xaxis', **kwargs - ): - super(ScaleratioValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_separatethousands.py b/plotly/validators/layout/xaxis/_separatethousands.py deleted file mode 100644 index 4aea44dff85..00000000000 --- a/plotly/validators/layout/xaxis/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='layout.xaxis', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_showdividers.py b/plotly/validators/layout/xaxis/_showdividers.py deleted file mode 100644 index 67d96f30d30..00000000000 --- a/plotly/validators/layout/xaxis/_showdividers.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowdividersValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showdividers', parent_name='layout.xaxis', **kwargs - ): - super(ShowdividersValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_showexponent.py b/plotly/validators/layout/xaxis/_showexponent.py deleted file mode 100644 index f1d3448ac5f..00000000000 --- a/plotly/validators/layout/xaxis/_showexponent.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='showexponent', parent_name='layout.xaxis', **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_showgrid.py b/plotly/validators/layout/xaxis/_showgrid.py deleted file mode 100644 index eb4359f081c..00000000000 --- a/plotly/validators/layout/xaxis/_showgrid.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showgrid', parent_name='layout.xaxis', **kwargs - ): - super(ShowgridValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_showline.py b/plotly/validators/layout/xaxis/_showline.py deleted file mode 100644 index 108456e3e19..00000000000 --- a/plotly/validators/layout/xaxis/_showline.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showline', parent_name='layout.xaxis', **kwargs - ): - super(ShowlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks+layoutstyle'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_showspikes.py b/plotly/validators/layout/xaxis/_showspikes.py deleted file mode 100644 index e28c09c35c0..00000000000 --- a/plotly/validators/layout/xaxis/_showspikes.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowspikesValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showspikes', parent_name='layout.xaxis', **kwargs - ): - super(ShowspikesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'modebar'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_showticklabels.py b/plotly/validators/layout/xaxis/_showticklabels.py deleted file mode 100644 index ccf55f71145..00000000000 --- a/plotly/validators/layout/xaxis/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='layout.xaxis', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_showtickprefix.py b/plotly/validators/layout/xaxis/_showtickprefix.py deleted file mode 100644 index 4627b700b5d..00000000000 --- a/plotly/validators/layout/xaxis/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='layout.xaxis', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_showticksuffix.py b/plotly/validators/layout/xaxis/_showticksuffix.py deleted file mode 100644 index 2da5870d170..00000000000 --- a/plotly/validators/layout/xaxis/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='layout.xaxis', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_side.py b/plotly/validators/layout/xaxis/_side.py deleted file mode 100644 index 221fa2b6994..00000000000 --- a/plotly/validators/layout/xaxis/_side.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='side', parent_name='layout.xaxis', **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['top', 'bottom', 'left', 'right']), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_spikecolor.py b/plotly/validators/layout/xaxis/_spikecolor.py deleted file mode 100644 index 19e30b3507c..00000000000 --- a/plotly/validators/layout/xaxis/_spikecolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='spikecolor', parent_name='layout.xaxis', **kwargs - ): - super(SpikecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_spikedash.py b/plotly/validators/layout/xaxis/_spikedash.py deleted file mode 100644 index edf376b4095..00000000000 --- a/plotly/validators/layout/xaxis/_spikedash.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikedashValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='spikedash', parent_name='layout.xaxis', **kwargs - ): - super(SpikedashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_spikemode.py b/plotly/validators/layout/xaxis/_spikemode.py deleted file mode 100644 index 637bbec5653..00000000000 --- a/plotly/validators/layout/xaxis/_spikemode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikemodeValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='spikemode', parent_name='layout.xaxis', **kwargs - ): - super(SpikemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - flags=kwargs.pop('flags', ['toaxis', 'across', 'marker']), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_spikesnap.py b/plotly/validators/layout/xaxis/_spikesnap.py deleted file mode 100644 index d26db99376b..00000000000 --- a/plotly/validators/layout/xaxis/_spikesnap.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikesnapValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='spikesnap', parent_name='layout.xaxis', **kwargs - ): - super(SpikesnapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['data', 'cursor']), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_spikethickness.py b/plotly/validators/layout/xaxis/_spikethickness.py deleted file mode 100644 index 1c4e907a263..00000000000 --- a/plotly/validators/layout/xaxis/_spikethickness.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikethicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='spikethickness', - parent_name='layout.xaxis', - **kwargs - ): - super(SpikethicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_tick0.py b/plotly/validators/layout/xaxis/_tick0.py deleted file mode 100644 index 7c9918cec64..00000000000 --- a/plotly/validators/layout/xaxis/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='tick0', parent_name='layout.xaxis', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_tickangle.py b/plotly/validators/layout/xaxis/_tickangle.py deleted file mode 100644 index 35cbb0f9cf5..00000000000 --- a/plotly/validators/layout/xaxis/_tickangle.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, plotly_name='tickangle', parent_name='layout.xaxis', **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_tickcolor.py b/plotly/validators/layout/xaxis/_tickcolor.py deleted file mode 100644 index cbd50e78704..00000000000 --- a/plotly/validators/layout/xaxis/_tickcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='tickcolor', parent_name='layout.xaxis', **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_tickfont.py b/plotly/validators/layout/xaxis/_tickfont.py deleted file mode 100644 index e5fe89527df..00000000000 --- a/plotly/validators/layout/xaxis/_tickfont.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='tickfont', parent_name='layout.xaxis', **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_tickformat.py b/plotly/validators/layout/xaxis/_tickformat.py deleted file mode 100644 index f3d8cb6f80e..00000000000 --- a/plotly/validators/layout/xaxis/_tickformat.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='tickformat', parent_name='layout.xaxis', **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_tickformatstopdefaults.py b/plotly/validators/layout/xaxis/_tickformatstopdefaults.py deleted file mode 100644 index 10472ae7c11..00000000000 --- a/plotly/validators/layout/xaxis/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='layout.xaxis', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_tickformatstops.py b/plotly/validators/layout/xaxis/_tickformatstops.py deleted file mode 100644 index 13a12bfbc83..00000000000 --- a/plotly/validators/layout/xaxis/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='layout.xaxis', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_ticklen.py b/plotly/validators/layout/xaxis/_ticklen.py deleted file mode 100644 index 8484185539b..00000000000 --- a/plotly/validators/layout/xaxis/_ticklen.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ticklen', parent_name='layout.xaxis', **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_tickmode.py b/plotly/validators/layout/xaxis/_tickmode.py deleted file mode 100644 index 22e45044e75..00000000000 --- a/plotly/validators/layout/xaxis/_tickmode.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='tickmode', parent_name='layout.xaxis', **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_tickprefix.py b/plotly/validators/layout/xaxis/_tickprefix.py deleted file mode 100644 index 9e95f47c598..00000000000 --- a/plotly/validators/layout/xaxis/_tickprefix.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='tickprefix', parent_name='layout.xaxis', **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_ticks.py b/plotly/validators/layout/xaxis/_ticks.py deleted file mode 100644 index 09343bb01e0..00000000000 --- a/plotly/validators/layout/xaxis/_ticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ticks', parent_name='layout.xaxis', **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_tickson.py b/plotly/validators/layout/xaxis/_tickson.py deleted file mode 100644 index 0e2e52ade28..00000000000 --- a/plotly/validators/layout/xaxis/_tickson.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksonValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='tickson', parent_name='layout.xaxis', **kwargs - ): - super(TicksonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['labels', 'boundaries']), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_ticksuffix.py b/plotly/validators/layout/xaxis/_ticksuffix.py deleted file mode 100644 index 611056ed46c..00000000000 --- a/plotly/validators/layout/xaxis/_ticksuffix.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='ticksuffix', parent_name='layout.xaxis', **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_ticktext.py b/plotly/validators/layout/xaxis/_ticktext.py deleted file mode 100644 index 2930380f0c6..00000000000 --- a/plotly/validators/layout/xaxis/_ticktext.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ticktext', parent_name='layout.xaxis', **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_ticktextsrc.py b/plotly/validators/layout/xaxis/_ticktextsrc.py deleted file mode 100644 index 6b0ebacc0c5..00000000000 --- a/plotly/validators/layout/xaxis/_ticktextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='ticktextsrc', parent_name='layout.xaxis', **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_tickvals.py b/plotly/validators/layout/xaxis/_tickvals.py deleted file mode 100644 index 3a6adfbb005..00000000000 --- a/plotly/validators/layout/xaxis/_tickvals.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='tickvals', parent_name='layout.xaxis', **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_tickvalssrc.py b/plotly/validators/layout/xaxis/_tickvalssrc.py deleted file mode 100644 index 3b45ab43c87..00000000000 --- a/plotly/validators/layout/xaxis/_tickvalssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='tickvalssrc', parent_name='layout.xaxis', **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_tickwidth.py b/plotly/validators/layout/xaxis/_tickwidth.py deleted file mode 100644 index 8b0d68c6dda..00000000000 --- a/plotly/validators/layout/xaxis/_tickwidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='tickwidth', parent_name='layout.xaxis', **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_title.py b/plotly/validators/layout/xaxis/_title.py deleted file mode 100644 index 35a6e32c8eb..00000000000 --- a/plotly/validators/layout/xaxis/_title.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='layout.xaxis', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this axis' title font. Note that the - title's font used to be customized by the now - deprecated `titlefont` attribute. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_type.py b/plotly/validators/layout/xaxis/_type.py deleted file mode 100644 index 2ae83899243..00000000000 --- a/plotly/validators/layout/xaxis/_type.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='layout.xaxis', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', - ['-', 'linear', 'log', 'date', 'category', 'multicategory'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_uirevision.py b/plotly/validators/layout/xaxis/_uirevision.py deleted file mode 100644 index 9575246ac4c..00000000000 --- a/plotly/validators/layout/xaxis/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='layout.xaxis', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_visible.py b/plotly/validators/layout/xaxis/_visible.py deleted file mode 100644 index e4e1b09ef83..00000000000 --- a/plotly/validators/layout/xaxis/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='layout.xaxis', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_zeroline.py b/plotly/validators/layout/xaxis/_zeroline.py deleted file mode 100644 index c5a6f4f5bb0..00000000000 --- a/plotly/validators/layout/xaxis/_zeroline.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZerolineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='zeroline', parent_name='layout.xaxis', **kwargs - ): - super(ZerolineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_zerolinecolor.py b/plotly/validators/layout/xaxis/_zerolinecolor.py deleted file mode 100644 index ad2cf1a2987..00000000000 --- a/plotly/validators/layout/xaxis/_zerolinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZerolinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='zerolinecolor', - parent_name='layout.xaxis', - **kwargs - ): - super(ZerolinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/_zerolinewidth.py b/plotly/validators/layout/xaxis/_zerolinewidth.py deleted file mode 100644 index 7e7d554b842..00000000000 --- a/plotly/validators/layout/xaxis/_zerolinewidth.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZerolinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='zerolinewidth', - parent_name='layout.xaxis', - **kwargs - ): - super(ZerolinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/__init__.py b/plotly/validators/layout/xaxis/rangeselector/__init__.py index 7d3ef7db357..542fd20036e 100644 --- a/plotly/validators/layout/xaxis/rangeselector/__init__.py +++ b/plotly/validators/layout/xaxis/rangeselector/__init__.py @@ -1,12 +1,319 @@ -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._visible import VisibleValidator -from ._font import FontValidator -from ._buttondefaults import ButtonValidator -from ._buttons import ButtonsValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator -from ._activecolor import ActivecolorValidator + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='layout.xaxis.rangeselector', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='y', + parent_name='layout.xaxis.rangeselector', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='layout.xaxis.rangeselector', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='x', + parent_name='layout.xaxis.rangeselector', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='visible', + parent_name='layout.xaxis.rangeselector', + **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='layout.xaxis.rangeselector', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ButtonValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='buttondefaults', + parent_name='layout.xaxis.rangeselector', + **kwargs + ): + super(ButtonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Button'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ButtonsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, + plotly_name='buttons', + parent_name='layout.xaxis.rangeselector', + **kwargs + ): + super(ButtonsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Button'), + data_docs=kwargs.pop( + 'data_docs', """ + count + Sets the number of steps to take to update the + range. Use with `step` to specify the update + interval. + label + Sets the text label to appear on the button. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + step + The unit of measurement that the `count` value + will set the range by. + stepmode + Sets the range update mode. If "backward", the + range update shifts the start of range back + "count" times "step" milliseconds. If "todate", + the range update shifts the start of range back + to the first timestamp from "count" times + "step" milliseconds back. For example, with + `step` set to "year" and `count` set to 1 the + range update shifts the start of the range back + to January 01 of the current year. Month and + year "todate" are currently available only for + the built-in (Gregorian) calendar. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + visible + Determines whether or not this button is + visible. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='layout.xaxis.rangeselector', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='layout.xaxis.rangeselector', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='layout.xaxis.rangeselector', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ActivecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='activecolor', + parent_name='layout.xaxis.rangeselector', + **kwargs + ): + super(ActivecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/xaxis/rangeselector/_activecolor.py b/plotly/validators/layout/xaxis/rangeselector/_activecolor.py deleted file mode 100644 index 33539d1efb9..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/_activecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ActivecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='activecolor', - parent_name='layout.xaxis.rangeselector', - **kwargs - ): - super(ActivecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/_bgcolor.py b/plotly/validators/layout/xaxis/rangeselector/_bgcolor.py deleted file mode 100644 index 52c034256d8..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='layout.xaxis.rangeselector', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/_bordercolor.py b/plotly/validators/layout/xaxis/rangeselector/_bordercolor.py deleted file mode 100644 index 4523360222d..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='layout.xaxis.rangeselector', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/_borderwidth.py b/plotly/validators/layout/xaxis/rangeselector/_borderwidth.py deleted file mode 100644 index 000d6991a0d..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='layout.xaxis.rangeselector', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/_buttondefaults.py b/plotly/validators/layout/xaxis/rangeselector/_buttondefaults.py deleted file mode 100644 index 1a6ea38d79a..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/_buttondefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ButtonValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='buttondefaults', - parent_name='layout.xaxis.rangeselector', - **kwargs - ): - super(ButtonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Button'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/_buttons.py b/plotly/validators/layout/xaxis/rangeselector/_buttons.py deleted file mode 100644 index d6514371363..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/_buttons.py +++ /dev/null @@ -1,66 +0,0 @@ -import _plotly_utils.basevalidators - - -class ButtonsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, - plotly_name='buttons', - parent_name='layout.xaxis.rangeselector', - **kwargs - ): - super(ButtonsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Button'), - data_docs=kwargs.pop( - 'data_docs', """ - count - Sets the number of steps to take to update the - range. Use with `step` to specify the update - interval. - label - Sets the text label to appear on the button. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - step - The unit of measurement that the `count` value - will set the range by. - stepmode - Sets the range update mode. If "backward", the - range update shifts the start of range back - "count" times "step" milliseconds. If "todate", - the range update shifts the start of range back - to the first timestamp from "count" times - "step" milliseconds back. For example, with - `step` set to "year" and `count` set to 1 the - range update shifts the start of the range back - to January 01 of the current year. Month and - year "todate" are currently available only for - the built-in (Gregorian) calendar. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - visible - Determines whether or not this button is - visible. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/_font.py b/plotly/validators/layout/xaxis/rangeselector/_font.py deleted file mode 100644 index c8ed59fa886..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='layout.xaxis.rangeselector', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/_visible.py b/plotly/validators/layout/xaxis/rangeselector/_visible.py deleted file mode 100644 index 960ce77f710..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/_visible.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='visible', - parent_name='layout.xaxis.rangeselector', - **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/_x.py b/plotly/validators/layout/xaxis/rangeselector/_x.py deleted file mode 100644 index 0155d359cec..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/_x.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='x', - parent_name='layout.xaxis.rangeselector', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/_xanchor.py b/plotly/validators/layout/xaxis/rangeselector/_xanchor.py deleted file mode 100644 index de4ea004def..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='layout.xaxis.rangeselector', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/_y.py b/plotly/validators/layout/xaxis/rangeselector/_y.py deleted file mode 100644 index d039a638995..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/_y.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='y', - parent_name='layout.xaxis.rangeselector', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/_yanchor.py b/plotly/validators/layout/xaxis/rangeselector/_yanchor.py deleted file mode 100644 index 3a75cca91c1..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='layout.xaxis.rangeselector', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/button/__init__.py b/plotly/validators/layout/xaxis/rangeselector/button/__init__.py index 6d27cca0182..c97a7095b6a 100644 --- a/plotly/validators/layout/xaxis/rangeselector/button/__init__.py +++ b/plotly/validators/layout/xaxis/rangeselector/button/__init__.py @@ -1,7 +1,146 @@ -from ._visible import VisibleValidator -from ._templateitemname import TemplateitemnameValidator -from ._stepmode import StepmodeValidator -from ._step import StepValidator -from ._name import NameValidator -from ._label import LabelValidator -from ._count import CountValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='visible', + parent_name='layout.xaxis.rangeselector.button', + **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.xaxis.rangeselector.button', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StepmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='stepmode', + parent_name='layout.xaxis.rangeselector.button', + **kwargs + ): + super(StepmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['backward', 'todate']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StepValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='step', + parent_name='layout.xaxis.rangeselector.button', + **kwargs + ): + super(StepValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', + ['month', 'year', 'day', 'hour', 'minute', 'second', 'all'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='layout.xaxis.rangeselector.button', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='label', + parent_name='layout.xaxis.rangeselector.button', + **kwargs + ): + super(LabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CountValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='count', + parent_name='layout.xaxis.rangeselector.button', + **kwargs + ): + super(CountValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/xaxis/rangeselector/button/_count.py b/plotly/validators/layout/xaxis/rangeselector/button/_count.py deleted file mode 100644 index 542f73d91ef..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/button/_count.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CountValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='count', - parent_name='layout.xaxis.rangeselector.button', - **kwargs - ): - super(CountValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/button/_label.py b/plotly/validators/layout/xaxis/rangeselector/button/_label.py deleted file mode 100644 index 4c3d04f2ad2..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/button/_label.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='label', - parent_name='layout.xaxis.rangeselector.button', - **kwargs - ): - super(LabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/button/_name.py b/plotly/validators/layout/xaxis/rangeselector/button/_name.py deleted file mode 100644 index 820a8ba0c1f..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/button/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='layout.xaxis.rangeselector.button', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/button/_step.py b/plotly/validators/layout/xaxis/rangeselector/button/_step.py deleted file mode 100644 index 27345e9d2a1..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/button/_step.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class StepValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='step', - parent_name='layout.xaxis.rangeselector.button', - **kwargs - ): - super(StepValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', - ['month', 'year', 'day', 'hour', 'minute', 'second', 'all'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/button/_stepmode.py b/plotly/validators/layout/xaxis/rangeselector/button/_stepmode.py deleted file mode 100644 index abfb8196723..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/button/_stepmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class StepmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='stepmode', - parent_name='layout.xaxis.rangeselector.button', - **kwargs - ): - super(StepmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['backward', 'todate']), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/button/_templateitemname.py b/plotly/validators/layout/xaxis/rangeselector/button/_templateitemname.py deleted file mode 100644 index 49057acd78b..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/button/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.xaxis.rangeselector.button', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/button/_visible.py b/plotly/validators/layout/xaxis/rangeselector/button/_visible.py deleted file mode 100644 index e1900a214c7..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/button/_visible.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='visible', - parent_name='layout.xaxis.rangeselector.button', - **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/font/__init__.py b/plotly/validators/layout/xaxis/rangeselector/font/__init__.py index 199d72e71c6..c1765895ffa 100644 --- a/plotly/validators/layout/xaxis/rangeselector/font/__init__.py +++ b/plotly/validators/layout/xaxis/rangeselector/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.xaxis.rangeselector.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.xaxis.rangeselector.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.xaxis.rangeselector.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/xaxis/rangeselector/font/_color.py b/plotly/validators/layout/xaxis/rangeselector/font/_color.py deleted file mode 100644 index 1cccfa1696f..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.xaxis.rangeselector.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/font/_family.py b/plotly/validators/layout/xaxis/rangeselector/font/_family.py deleted file mode 100644 index c13f2986536..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.xaxis.rangeselector.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeselector/font/_size.py b/plotly/validators/layout/xaxis/rangeselector/font/_size.py deleted file mode 100644 index 679e7964cb3..00000000000 --- a/plotly/validators/layout/xaxis/rangeselector/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.xaxis.rangeselector.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeslider/__init__.py b/plotly/validators/layout/xaxis/rangeslider/__init__.py index f8e02bfe7f5..3f5c796d43f 100644 --- a/plotly/validators/layout/xaxis/rangeslider/__init__.py +++ b/plotly/validators/layout/xaxis/rangeslider/__init__.py @@ -1,8 +1,197 @@ -from ._yaxis import YAxisValidator -from ._visible import VisibleValidator -from ._thickness import ThicknessValidator -from ._range import RangeValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator -from ._autorange import AutorangeValidator + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='yaxis', + parent_name='layout.xaxis.rangeslider', + **kwargs + ): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'YAxis'), + data_docs=kwargs.pop( + 'data_docs', """ + range + Sets the range of this axis for the + rangeslider. + rangemode + Determines whether or not the range of this + axis in the rangeslider use the same value than + in the main plot when 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='visible', + parent_name='layout.xaxis.rangeslider', + **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='layout.xaxis.rangeslider', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='range', + parent_name='layout.xaxis.rangeslider', + **kwargs + ): + super(RangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'autorange': False}), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'calc', + 'impliedEdits': { + '^autorange': False + } + }, + { + 'valType': 'any', + 'editType': 'calc', + 'impliedEdits': { + '^autorange': False + } + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='layout.xaxis.rangeslider', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='layout.xaxis.rangeslider', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='layout.xaxis.rangeslider', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutorangeValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autorange', + parent_name='layout.xaxis.rangeslider', + **kwargs + ): + super(AutorangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/xaxis/rangeslider/_autorange.py b/plotly/validators/layout/xaxis/rangeslider/_autorange.py deleted file mode 100644 index 38a9d78fee4..00000000000 --- a/plotly/validators/layout/xaxis/rangeslider/_autorange.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutorangeValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autorange', - parent_name='layout.xaxis.rangeslider', - **kwargs - ): - super(AutorangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeslider/_bgcolor.py b/plotly/validators/layout/xaxis/rangeslider/_bgcolor.py deleted file mode 100644 index e339c05a2e2..00000000000 --- a/plotly/validators/layout/xaxis/rangeslider/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='layout.xaxis.rangeslider', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeslider/_bordercolor.py b/plotly/validators/layout/xaxis/rangeslider/_bordercolor.py deleted file mode 100644 index 9fb8a25aedc..00000000000 --- a/plotly/validators/layout/xaxis/rangeslider/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='layout.xaxis.rangeslider', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeslider/_borderwidth.py b/plotly/validators/layout/xaxis/rangeslider/_borderwidth.py deleted file mode 100644 index 0f9f42dfffe..00000000000 --- a/plotly/validators/layout/xaxis/rangeslider/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='layout.xaxis.rangeslider', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeslider/_range.py b/plotly/validators/layout/xaxis/rangeslider/_range.py deleted file mode 100644 index 0775e394f4f..00000000000 --- a/plotly/validators/layout/xaxis/rangeslider/_range.py +++ /dev/null @@ -1,37 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='range', - parent_name='layout.xaxis.rangeslider', - **kwargs - ): - super(RangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'autorange': False}), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'calc', - 'impliedEdits': { - '^autorange': False - } - }, - { - 'valType': 'any', - 'editType': 'calc', - 'impliedEdits': { - '^autorange': False - } - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeslider/_thickness.py b/plotly/validators/layout/xaxis/rangeslider/_thickness.py deleted file mode 100644 index ee59a3ff006..00000000000 --- a/plotly/validators/layout/xaxis/rangeslider/_thickness.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='layout.xaxis.rangeslider', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeslider/_visible.py b/plotly/validators/layout/xaxis/rangeslider/_visible.py deleted file mode 100644 index 4d1a6f04707..00000000000 --- a/plotly/validators/layout/xaxis/rangeslider/_visible.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='visible', - parent_name='layout.xaxis.rangeslider', - **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeslider/_yaxis.py b/plotly/validators/layout/xaxis/rangeslider/_yaxis.py deleted file mode 100644 index 0e5ea218264..00000000000 --- a/plotly/validators/layout/xaxis/rangeslider/_yaxis.py +++ /dev/null @@ -1,32 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='yaxis', - parent_name='layout.xaxis.rangeslider', - **kwargs - ): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'YAxis'), - data_docs=kwargs.pop( - 'data_docs', """ - range - Sets the range of this axis for the - rangeslider. - rangemode - Determines whether or not the range of this - axis in the rangeslider use the same value than - in the main plot when 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeslider/yaxis/__init__.py b/plotly/validators/layout/xaxis/rangeslider/yaxis/__init__.py index 37e0eeb3402..ba8a4a13b48 100644 --- a/plotly/validators/layout/xaxis/rangeslider/yaxis/__init__.py +++ b/plotly/validators/layout/xaxis/rangeslider/yaxis/__init__.py @@ -1,2 +1,52 @@ -from ._rangemode import RangemodeValidator -from ._range import RangeValidator + + +import _plotly_utils.basevalidators + + +class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='rangemode', + parent_name='layout.xaxis.rangeslider.yaxis', + **kwargs + ): + super(RangemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['auto', 'fixed', 'match']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='range', + parent_name='layout.xaxis.rangeslider.yaxis', + **kwargs + ): + super(RangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'plot' + }, { + 'valType': 'any', + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/xaxis/rangeslider/yaxis/_range.py b/plotly/validators/layout/xaxis/rangeslider/yaxis/_range.py deleted file mode 100644 index 64b26b6947b..00000000000 --- a/plotly/validators/layout/xaxis/rangeslider/yaxis/_range.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='range', - parent_name='layout.xaxis.rangeslider.yaxis', - **kwargs - ): - super(RangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'plot' - }, { - 'valType': 'any', - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/rangeslider/yaxis/_rangemode.py b/plotly/validators/layout/xaxis/rangeslider/yaxis/_rangemode.py deleted file mode 100644 index ec7ed15cdb7..00000000000 --- a/plotly/validators/layout/xaxis/rangeslider/yaxis/_rangemode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='rangemode', - parent_name='layout.xaxis.rangeslider.yaxis', - **kwargs - ): - super(RangemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['auto', 'fixed', 'match']), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/tickfont/__init__.py b/plotly/validators/layout/xaxis/tickfont/__init__.py index 199d72e71c6..9244c594ee5 100644 --- a/plotly/validators/layout/xaxis/tickfont/__init__.py +++ b/plotly/validators/layout/xaxis/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.xaxis.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.xaxis.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.xaxis.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/xaxis/tickfont/_color.py b/plotly/validators/layout/xaxis/tickfont/_color.py deleted file mode 100644 index 9fd0e041dbf..00000000000 --- a/plotly/validators/layout/xaxis/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.xaxis.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/tickfont/_family.py b/plotly/validators/layout/xaxis/tickfont/_family.py deleted file mode 100644 index 116a0b7fb67..00000000000 --- a/plotly/validators/layout/xaxis/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.xaxis.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/tickfont/_size.py b/plotly/validators/layout/xaxis/tickfont/_size.py deleted file mode 100644 index 5d216103be3..00000000000 --- a/plotly/validators/layout/xaxis/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.xaxis.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/tickformatstop/__init__.py b/plotly/validators/layout/xaxis/tickformatstop/__init__.py index 3f6c06cac47..eafcb0dfc96 100644 --- a/plotly/validators/layout/xaxis/tickformatstop/__init__.py +++ b/plotly/validators/layout/xaxis/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='layout.xaxis.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.xaxis.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='layout.xaxis.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='layout.xaxis.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='layout.xaxis.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'ticks' + }, { + 'valType': 'any', + 'editType': 'ticks' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/xaxis/tickformatstop/_dtickrange.py b/plotly/validators/layout/xaxis/tickformatstop/_dtickrange.py deleted file mode 100644 index bdf414d092a..00000000000 --- a/plotly/validators/layout/xaxis/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='layout.xaxis.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'ticks' - }, { - 'valType': 'any', - 'editType': 'ticks' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/tickformatstop/_enabled.py b/plotly/validators/layout/xaxis/tickformatstop/_enabled.py deleted file mode 100644 index fbbd33d072b..00000000000 --- a/plotly/validators/layout/xaxis/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='layout.xaxis.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/tickformatstop/_name.py b/plotly/validators/layout/xaxis/tickformatstop/_name.py deleted file mode 100644 index 162361ff60f..00000000000 --- a/plotly/validators/layout/xaxis/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='layout.xaxis.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/tickformatstop/_templateitemname.py b/plotly/validators/layout/xaxis/tickformatstop/_templateitemname.py deleted file mode 100644 index 5b8b7d557df..00000000000 --- a/plotly/validators/layout/xaxis/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.xaxis.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/tickformatstop/_value.py b/plotly/validators/layout/xaxis/tickformatstop/_value.py deleted file mode 100644 index 93338a3cf32..00000000000 --- a/plotly/validators/layout/xaxis/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='layout.xaxis.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/title/__init__.py b/plotly/validators/layout/xaxis/title/__init__.py index db7b0c34947..471566fe08d 100644 --- a/plotly/validators/layout/xaxis/title/__init__.py +++ b/plotly/validators/layout/xaxis/title/__init__.py @@ -1,2 +1,57 @@ -from ._text import TextValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='text', parent_name='layout.xaxis.title', **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='layout.xaxis.title', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/xaxis/title/_font.py b/plotly/validators/layout/xaxis/title/_font.py deleted file mode 100644 index 3ee355fae6e..00000000000 --- a/plotly/validators/layout/xaxis/title/_font.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='layout.xaxis.title', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/title/_text.py b/plotly/validators/layout/xaxis/title/_text.py deleted file mode 100644 index b8ca216a89f..00000000000 --- a/plotly/validators/layout/xaxis/title/_text.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='text', parent_name='layout.xaxis.title', **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/title/font/__init__.py b/plotly/validators/layout/xaxis/title/font/__init__.py index 199d72e71c6..2ba29fd2043 100644 --- a/plotly/validators/layout/xaxis/title/font/__init__.py +++ b/plotly/validators/layout/xaxis/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.xaxis.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.xaxis.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.xaxis.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/xaxis/title/font/_color.py b/plotly/validators/layout/xaxis/title/font/_color.py deleted file mode 100644 index 1281fafca0c..00000000000 --- a/plotly/validators/layout/xaxis/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.xaxis.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/title/font/_family.py b/plotly/validators/layout/xaxis/title/font/_family.py deleted file mode 100644 index e5fbcae7f5e..00000000000 --- a/plotly/validators/layout/xaxis/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.xaxis.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/xaxis/title/font/_size.py b/plotly/validators/layout/xaxis/title/font/_size.py deleted file mode 100644 index 879159ec751..00000000000 --- a/plotly/validators/layout/xaxis/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.xaxis.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/__init__.py b/plotly/validators/layout/yaxis/__init__.py index e1ef749756c..0d64f451d74 100644 --- a/plotly/validators/layout/yaxis/__init__.py +++ b/plotly/validators/layout/yaxis/__init__.py @@ -1,71 +1,1449 @@ -from ._zerolinewidth import ZerolinewidthValidator -from ._zerolinecolor import ZerolinecolorValidator -from ._zeroline import ZerolineValidator -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._type import TypeValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._tickson import TicksonValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._spikethickness import SpikethicknessValidator -from ._spikesnap import SpikesnapValidator -from ._spikemode import SpikemodeValidator -from ._spikedash import SpikedashValidator -from ._spikecolor import SpikecolorValidator -from ._side import SideValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showspikes import ShowspikesValidator -from ._showline import ShowlineValidator -from ._showgrid import ShowgridValidator -from ._showexponent import ShowexponentValidator -from ._showdividers import ShowdividersValidator -from ._separatethousands import SeparatethousandsValidator -from ._scaleratio import ScaleratioValidator -from ._scaleanchor import ScaleanchorValidator -from ._rangemode import RangemodeValidator -from ._range import RangeValidator -from ._position import PositionValidator -from ._overlaying import OverlayingValidator -from ._nticks import NticksValidator -from ._mirror import MirrorValidator -from ._matches import MatchesValidator -from ._linewidth import LinewidthValidator -from ._linecolor import LinecolorValidator -from ._layer import LayerValidator -from ._hoverformat import HoverformatValidator -from ._gridwidth import GridwidthValidator -from ._gridcolor import GridcolorValidator -from ._fixedrange import FixedrangeValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._domain import DomainValidator -from ._dividerwidth import DividerwidthValidator -from ._dividercolor import DividercolorValidator -from ._constraintoward import ConstraintowardValidator -from ._constrain import ConstrainValidator -from ._color import ColorValidator -from ._categoryorder import CategoryorderValidator -from ._categoryarraysrc import CategoryarraysrcValidator -from ._categoryarray import CategoryarrayValidator -from ._calendar import CalendarValidator -from ._autorange import AutorangeValidator -from ._automargin import AutomarginValidator -from ._anchor import AnchorValidator + + +import _plotly_utils.basevalidators + + +class ZerolinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='zerolinewidth', + parent_name='layout.yaxis', + **kwargs + ): + super(ZerolinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZerolinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='zerolinecolor', + parent_name='layout.yaxis', + **kwargs + ): + super(ZerolinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZerolineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='zeroline', parent_name='layout.yaxis', **kwargs + ): + super(ZerolineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='layout.yaxis', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='layout.yaxis', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='layout.yaxis', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', + ['-', 'linear', 'log', 'date', 'category', 'multicategory'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='layout.yaxis', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this axis' title font. Note that the + title's font used to be customized by the now + deprecated `titlefont` attribute. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='tickwidth', parent_name='layout.yaxis', **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='tickvalssrc', parent_name='layout.yaxis', **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='tickvals', parent_name='layout.yaxis', **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='ticktextsrc', parent_name='layout.yaxis', **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ticktext', parent_name='layout.yaxis', **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='ticksuffix', parent_name='layout.yaxis', **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksonValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='tickson', parent_name='layout.yaxis', **kwargs + ): + super(TicksonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['labels', 'boundaries']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ticks', parent_name='layout.yaxis', **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='tickprefix', parent_name='layout.yaxis', **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='tickmode', parent_name='layout.yaxis', **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ticklen', parent_name='layout.yaxis', **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='layout.yaxis', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='layout.yaxis', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='tickformat', parent_name='layout.yaxis', **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='tickfont', parent_name='layout.yaxis', **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='tickcolor', parent_name='layout.yaxis', **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, plotly_name='tickangle', parent_name='layout.yaxis', **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='tick0', parent_name='layout.yaxis', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikethicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='spikethickness', + parent_name='layout.yaxis', + **kwargs + ): + super(SpikethicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikesnapValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='spikesnap', parent_name='layout.yaxis', **kwargs + ): + super(SpikesnapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['data', 'cursor']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikemodeValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='spikemode', parent_name='layout.yaxis', **kwargs + ): + super(SpikemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + flags=kwargs.pop('flags', ['toaxis', 'across', 'marker']), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikedashValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='spikedash', parent_name='layout.yaxis', **kwargs + ): + super(SpikedashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpikecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='spikecolor', parent_name='layout.yaxis', **kwargs + ): + super(SpikecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='side', parent_name='layout.yaxis', **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['top', 'bottom', 'left', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='layout.yaxis', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='layout.yaxis', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='layout.yaxis', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowspikesValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showspikes', parent_name='layout.yaxis', **kwargs + ): + super(ShowspikesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'modebar'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showline', parent_name='layout.yaxis', **kwargs + ): + super(ShowlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks+layoutstyle'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showgrid', parent_name='layout.yaxis', **kwargs + ): + super(ShowgridValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='showexponent', parent_name='layout.yaxis', **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowdividersValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showdividers', parent_name='layout.yaxis', **kwargs + ): + super(ShowdividersValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='layout.yaxis', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScaleratioValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='scaleratio', parent_name='layout.yaxis', **kwargs + ): + super(ScaleratioValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScaleanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='scaleanchor', parent_name='layout.yaxis', **kwargs + ): + super(ScaleanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', + ['/^x([2-9]|[1-9][0-9]+)?$/', '/^y([2-9]|[1-9][0-9]+)?$/'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='rangemode', parent_name='layout.yaxis', **kwargs + ): + super(RangemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['normal', 'tozero', 'nonnegative']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='range', parent_name='layout.yaxis', **kwargs + ): + super(RangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'axrange'), + implied_edits=kwargs.pop('implied_edits', {'autorange': False}), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'axrange', + 'impliedEdits': { + '^autorange': False + }, + 'anim': True + }, + { + 'valType': 'any', + 'editType': 'axrange', + 'impliedEdits': { + '^autorange': False + }, + 'anim': True + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PositionValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='position', parent_name='layout.yaxis', **kwargs + ): + super(PositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OverlayingValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='overlaying', parent_name='layout.yaxis', **kwargs + ): + super(OverlayingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'free', '/^x([2-9]|[1-9][0-9]+)?$/', + '/^y([2-9]|[1-9][0-9]+)?$/' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nticks', parent_name='layout.yaxis', **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MirrorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='mirror', parent_name='layout.yaxis', **kwargs + ): + super(MirrorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks+layoutstyle'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [True, 'ticks', False, 'all', 'allticks'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MatchesValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='matches', parent_name='layout.yaxis', **kwargs + ): + super(MatchesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', + ['/^x([2-9]|[1-9][0-9]+)?$/', '/^y([2-9]|[1-9][0-9]+)?$/'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='linewidth', parent_name='layout.yaxis', **kwargs + ): + super(LinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks+layoutstyle'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='linecolor', parent_name='layout.yaxis', **kwargs + ): + super(LinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'layoutstyle'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='layer', parent_name='layout.yaxis', **kwargs + ): + super(LayerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['above traces', 'below traces']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hoverformat', parent_name='layout.yaxis', **kwargs + ): + super(HoverformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='gridwidth', parent_name='layout.yaxis', **kwargs + ): + super(GridwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='gridcolor', parent_name='layout.yaxis', **kwargs + ): + super(GridcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FixedrangeValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='fixedrange', parent_name='layout.yaxis', **kwargs + ): + super(FixedrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='layout.yaxis', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='dtick', parent_name='layout.yaxis', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DomainValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='domain', parent_name='layout.yaxis', **kwargs + ): + super(DomainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'plot' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DividerwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='dividerwidth', parent_name='layout.yaxis', **kwargs + ): + super(DividerwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DividercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='dividercolor', parent_name='layout.yaxis', **kwargs + ): + super(DividercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConstraintowardValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='constraintoward', + parent_name='layout.yaxis', + **kwargs + ): + super(ConstraintowardValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', + ['left', 'center', 'right', 'top', 'middle', 'bottom'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConstrainValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='constrain', parent_name='layout.yaxis', **kwargs + ): + super(ConstrainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['range', 'domain']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='layout.yaxis', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='categoryorder', + parent_name='layout.yaxis', + **kwargs + ): + super(CategoryorderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'trace', 'category ascending', 'category descending', + 'array' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='categoryarraysrc', + parent_name='layout.yaxis', + **kwargs + ): + super(CategoryarraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='categoryarray', + parent_name='layout.yaxis', + **kwargs + ): + super(CategoryarrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='calendar', parent_name='layout.yaxis', **kwargs + ): + super(CalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutorangeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='autorange', parent_name='layout.yaxis', **kwargs + ): + super(AutorangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'axrange'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'reversed']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutomarginValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='automargin', parent_name='layout.yaxis', **kwargs + ): + super(AutomarginValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AnchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='anchor', parent_name='layout.yaxis', **kwargs + ): + super(AnchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'free', '/^x([2-9]|[1-9][0-9]+)?$/', + '/^y([2-9]|[1-9][0-9]+)?$/' + ] + ), + **kwargs + ) diff --git a/plotly/validators/layout/yaxis/_anchor.py b/plotly/validators/layout/yaxis/_anchor.py deleted file mode 100644 index ebcb7537f7d..00000000000 --- a/plotly/validators/layout/yaxis/_anchor.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class AnchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='anchor', parent_name='layout.yaxis', **kwargs - ): - super(AnchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'free', '/^x([2-9]|[1-9][0-9]+)?$/', - '/^y([2-9]|[1-9][0-9]+)?$/' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_automargin.py b/plotly/validators/layout/yaxis/_automargin.py deleted file mode 100644 index e42d40fb124..00000000000 --- a/plotly/validators/layout/yaxis/_automargin.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutomarginValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='automargin', parent_name='layout.yaxis', **kwargs - ): - super(AutomarginValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_autorange.py b/plotly/validators/layout/yaxis/_autorange.py deleted file mode 100644 index a122f0401ac..00000000000 --- a/plotly/validators/layout/yaxis/_autorange.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutorangeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='autorange', parent_name='layout.yaxis', **kwargs - ): - super(AutorangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'axrange'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'reversed']), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_calendar.py b/plotly/validators/layout/yaxis/_calendar.py deleted file mode 100644 index 25d5a176ba9..00000000000 --- a/plotly/validators/layout/yaxis/_calendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class CalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='calendar', parent_name='layout.yaxis', **kwargs - ): - super(CalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_categoryarray.py b/plotly/validators/layout/yaxis/_categoryarray.py deleted file mode 100644 index 0faf80f512a..00000000000 --- a/plotly/validators/layout/yaxis/_categoryarray.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='categoryarray', - parent_name='layout.yaxis', - **kwargs - ): - super(CategoryarrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_categoryarraysrc.py b/plotly/validators/layout/yaxis/_categoryarraysrc.py deleted file mode 100644 index 29c030467b3..00000000000 --- a/plotly/validators/layout/yaxis/_categoryarraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='categoryarraysrc', - parent_name='layout.yaxis', - **kwargs - ): - super(CategoryarraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_categoryorder.py b/plotly/validators/layout/yaxis/_categoryorder.py deleted file mode 100644 index 5394d1a3f9f..00000000000 --- a/plotly/validators/layout/yaxis/_categoryorder.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='categoryorder', - parent_name='layout.yaxis', - **kwargs - ): - super(CategoryorderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'trace', 'category ascending', 'category descending', - 'array' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_color.py b/plotly/validators/layout/yaxis/_color.py deleted file mode 100644 index 7dcb9007b6c..00000000000 --- a/plotly/validators/layout/yaxis/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='layout.yaxis', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_constrain.py b/plotly/validators/layout/yaxis/_constrain.py deleted file mode 100644 index 2e87ae7ba5e..00000000000 --- a/plotly/validators/layout/yaxis/_constrain.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConstrainValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='constrain', parent_name='layout.yaxis', **kwargs - ): - super(ConstrainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['range', 'domain']), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_constraintoward.py b/plotly/validators/layout/yaxis/_constraintoward.py deleted file mode 100644 index 208f1e39162..00000000000 --- a/plotly/validators/layout/yaxis/_constraintoward.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConstraintowardValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='constraintoward', - parent_name='layout.yaxis', - **kwargs - ): - super(ConstraintowardValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', - ['left', 'center', 'right', 'top', 'middle', 'bottom'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_dividercolor.py b/plotly/validators/layout/yaxis/_dividercolor.py deleted file mode 100644 index e29bc2e8bd8..00000000000 --- a/plotly/validators/layout/yaxis/_dividercolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class DividercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='dividercolor', parent_name='layout.yaxis', **kwargs - ): - super(DividercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_dividerwidth.py b/plotly/validators/layout/yaxis/_dividerwidth.py deleted file mode 100644 index ee8415d5d7a..00000000000 --- a/plotly/validators/layout/yaxis/_dividerwidth.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class DividerwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='dividerwidth', parent_name='layout.yaxis', **kwargs - ): - super(DividerwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_domain.py b/plotly/validators/layout/yaxis/_domain.py deleted file mode 100644 index dc29e5b4d29..00000000000 --- a/plotly/validators/layout/yaxis/_domain.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class DomainValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='domain', parent_name='layout.yaxis', **kwargs - ): - super(DomainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'plot' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_dtick.py b/plotly/validators/layout/yaxis/_dtick.py deleted file mode 100644 index 418e2cccdf2..00000000000 --- a/plotly/validators/layout/yaxis/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='dtick', parent_name='layout.yaxis', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_exponentformat.py b/plotly/validators/layout/yaxis/_exponentformat.py deleted file mode 100644 index 7a7d04507b9..00000000000 --- a/plotly/validators/layout/yaxis/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='layout.yaxis', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_fixedrange.py b/plotly/validators/layout/yaxis/_fixedrange.py deleted file mode 100644 index f0a67d59361..00000000000 --- a/plotly/validators/layout/yaxis/_fixedrange.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FixedrangeValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='fixedrange', parent_name='layout.yaxis', **kwargs - ): - super(FixedrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_gridcolor.py b/plotly/validators/layout/yaxis/_gridcolor.py deleted file mode 100644 index 6c20c35c674..00000000000 --- a/plotly/validators/layout/yaxis/_gridcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='gridcolor', parent_name='layout.yaxis', **kwargs - ): - super(GridcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_gridwidth.py b/plotly/validators/layout/yaxis/_gridwidth.py deleted file mode 100644 index b536b7beaa5..00000000000 --- a/plotly/validators/layout/yaxis/_gridwidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class GridwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='gridwidth', parent_name='layout.yaxis', **kwargs - ): - super(GridwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_hoverformat.py b/plotly/validators/layout/yaxis/_hoverformat.py deleted file mode 100644 index ba5e069d5f7..00000000000 --- a/plotly/validators/layout/yaxis/_hoverformat.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hoverformat', parent_name='layout.yaxis', **kwargs - ): - super(HoverformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_layer.py b/plotly/validators/layout/yaxis/_layer.py deleted file mode 100644 index 320fe3c8f3d..00000000000 --- a/plotly/validators/layout/yaxis/_layer.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LayerValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='layer', parent_name='layout.yaxis', **kwargs - ): - super(LayerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['above traces', 'below traces']), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_linecolor.py b/plotly/validators/layout/yaxis/_linecolor.py deleted file mode 100644 index 873f24fb371..00000000000 --- a/plotly/validators/layout/yaxis/_linecolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='linecolor', parent_name='layout.yaxis', **kwargs - ): - super(LinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'layoutstyle'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_linewidth.py b/plotly/validators/layout/yaxis/_linewidth.py deleted file mode 100644 index 8ecc110ada3..00000000000 --- a/plotly/validators/layout/yaxis/_linewidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='linewidth', parent_name='layout.yaxis', **kwargs - ): - super(LinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks+layoutstyle'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_matches.py b/plotly/validators/layout/yaxis/_matches.py deleted file mode 100644 index 1036c39ec55..00000000000 --- a/plotly/validators/layout/yaxis/_matches.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class MatchesValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='matches', parent_name='layout.yaxis', **kwargs - ): - super(MatchesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', - ['/^x([2-9]|[1-9][0-9]+)?$/', '/^y([2-9]|[1-9][0-9]+)?$/'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_mirror.py b/plotly/validators/layout/yaxis/_mirror.py deleted file mode 100644 index 66687db81b7..00000000000 --- a/plotly/validators/layout/yaxis/_mirror.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class MirrorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='mirror', parent_name='layout.yaxis', **kwargs - ): - super(MirrorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks+layoutstyle'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [True, 'ticks', False, 'all', 'allticks'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_nticks.py b/plotly/validators/layout/yaxis/_nticks.py deleted file mode 100644 index 2e728882710..00000000000 --- a/plotly/validators/layout/yaxis/_nticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nticks', parent_name='layout.yaxis', **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_overlaying.py b/plotly/validators/layout/yaxis/_overlaying.py deleted file mode 100644 index 7f75ae847ab..00000000000 --- a/plotly/validators/layout/yaxis/_overlaying.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class OverlayingValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='overlaying', parent_name='layout.yaxis', **kwargs - ): - super(OverlayingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'free', '/^x([2-9]|[1-9][0-9]+)?$/', - '/^y([2-9]|[1-9][0-9]+)?$/' - ] - ), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_position.py b/plotly/validators/layout/yaxis/_position.py deleted file mode 100644 index 274f844b9a6..00000000000 --- a/plotly/validators/layout/yaxis/_position.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class PositionValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='position', parent_name='layout.yaxis', **kwargs - ): - super(PositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_range.py b/plotly/validators/layout/yaxis/_range.py deleted file mode 100644 index d102e4bfe90..00000000000 --- a/plotly/validators/layout/yaxis/_range.py +++ /dev/null @@ -1,37 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='range', parent_name='layout.yaxis', **kwargs - ): - super(RangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'axrange'), - implied_edits=kwargs.pop('implied_edits', {'autorange': False}), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'axrange', - 'impliedEdits': { - '^autorange': False - }, - 'anim': True - }, - { - 'valType': 'any', - 'editType': 'axrange', - 'impliedEdits': { - '^autorange': False - }, - 'anim': True - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_rangemode.py b/plotly/validators/layout/yaxis/_rangemode.py deleted file mode 100644 index 0d5c8898286..00000000000 --- a/plotly/validators/layout/yaxis/_rangemode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='rangemode', parent_name='layout.yaxis', **kwargs - ): - super(RangemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['normal', 'tozero', 'nonnegative']), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_scaleanchor.py b/plotly/validators/layout/yaxis/_scaleanchor.py deleted file mode 100644 index ff32e70cfed..00000000000 --- a/plotly/validators/layout/yaxis/_scaleanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScaleanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='scaleanchor', parent_name='layout.yaxis', **kwargs - ): - super(ScaleanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', - ['/^x([2-9]|[1-9][0-9]+)?$/', '/^y([2-9]|[1-9][0-9]+)?$/'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_scaleratio.py b/plotly/validators/layout/yaxis/_scaleratio.py deleted file mode 100644 index 8ed9895e8a4..00000000000 --- a/plotly/validators/layout/yaxis/_scaleratio.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScaleratioValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='scaleratio', parent_name='layout.yaxis', **kwargs - ): - super(ScaleratioValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_separatethousands.py b/plotly/validators/layout/yaxis/_separatethousands.py deleted file mode 100644 index 699a65bfd6d..00000000000 --- a/plotly/validators/layout/yaxis/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='layout.yaxis', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_showdividers.py b/plotly/validators/layout/yaxis/_showdividers.py deleted file mode 100644 index 3b5cc1e4f99..00000000000 --- a/plotly/validators/layout/yaxis/_showdividers.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowdividersValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showdividers', parent_name='layout.yaxis', **kwargs - ): - super(ShowdividersValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_showexponent.py b/plotly/validators/layout/yaxis/_showexponent.py deleted file mode 100644 index 290bdbdd0cc..00000000000 --- a/plotly/validators/layout/yaxis/_showexponent.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='showexponent', parent_name='layout.yaxis', **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_showgrid.py b/plotly/validators/layout/yaxis/_showgrid.py deleted file mode 100644 index 914ffec768e..00000000000 --- a/plotly/validators/layout/yaxis/_showgrid.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowgridValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showgrid', parent_name='layout.yaxis', **kwargs - ): - super(ShowgridValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_showline.py b/plotly/validators/layout/yaxis/_showline.py deleted file mode 100644 index c075ace665e..00000000000 --- a/plotly/validators/layout/yaxis/_showline.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showline', parent_name='layout.yaxis', **kwargs - ): - super(ShowlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks+layoutstyle'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_showspikes.py b/plotly/validators/layout/yaxis/_showspikes.py deleted file mode 100644 index eaf5bfb8457..00000000000 --- a/plotly/validators/layout/yaxis/_showspikes.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowspikesValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showspikes', parent_name='layout.yaxis', **kwargs - ): - super(ShowspikesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'modebar'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_showticklabels.py b/plotly/validators/layout/yaxis/_showticklabels.py deleted file mode 100644 index 435423a5d27..00000000000 --- a/plotly/validators/layout/yaxis/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='layout.yaxis', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_showtickprefix.py b/plotly/validators/layout/yaxis/_showtickprefix.py deleted file mode 100644 index c72e64168b2..00000000000 --- a/plotly/validators/layout/yaxis/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='layout.yaxis', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_showticksuffix.py b/plotly/validators/layout/yaxis/_showticksuffix.py deleted file mode 100644 index 6f5fd56c784..00000000000 --- a/plotly/validators/layout/yaxis/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='layout.yaxis', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_side.py b/plotly/validators/layout/yaxis/_side.py deleted file mode 100644 index 18085bd34aa..00000000000 --- a/plotly/validators/layout/yaxis/_side.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='side', parent_name='layout.yaxis', **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['top', 'bottom', 'left', 'right']), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_spikecolor.py b/plotly/validators/layout/yaxis/_spikecolor.py deleted file mode 100644 index 79a16f8e817..00000000000 --- a/plotly/validators/layout/yaxis/_spikecolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='spikecolor', parent_name='layout.yaxis', **kwargs - ): - super(SpikecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_spikedash.py b/plotly/validators/layout/yaxis/_spikedash.py deleted file mode 100644 index 60731a4061c..00000000000 --- a/plotly/validators/layout/yaxis/_spikedash.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikedashValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='spikedash', parent_name='layout.yaxis', **kwargs - ): - super(SpikedashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_spikemode.py b/plotly/validators/layout/yaxis/_spikemode.py deleted file mode 100644 index aff142db923..00000000000 --- a/plotly/validators/layout/yaxis/_spikemode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikemodeValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='spikemode', parent_name='layout.yaxis', **kwargs - ): - super(SpikemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - flags=kwargs.pop('flags', ['toaxis', 'across', 'marker']), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_spikesnap.py b/plotly/validators/layout/yaxis/_spikesnap.py deleted file mode 100644 index db5665e531d..00000000000 --- a/plotly/validators/layout/yaxis/_spikesnap.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikesnapValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='spikesnap', parent_name='layout.yaxis', **kwargs - ): - super(SpikesnapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['data', 'cursor']), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_spikethickness.py b/plotly/validators/layout/yaxis/_spikethickness.py deleted file mode 100644 index 6ed7e707d33..00000000000 --- a/plotly/validators/layout/yaxis/_spikethickness.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpikethicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='spikethickness', - parent_name='layout.yaxis', - **kwargs - ): - super(SpikethicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_tick0.py b/plotly/validators/layout/yaxis/_tick0.py deleted file mode 100644 index 63b5776b252..00000000000 --- a/plotly/validators/layout/yaxis/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='tick0', parent_name='layout.yaxis', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_tickangle.py b/plotly/validators/layout/yaxis/_tickangle.py deleted file mode 100644 index 2c14d39ba8c..00000000000 --- a/plotly/validators/layout/yaxis/_tickangle.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, plotly_name='tickangle', parent_name='layout.yaxis', **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_tickcolor.py b/plotly/validators/layout/yaxis/_tickcolor.py deleted file mode 100644 index 6affd9d1cb0..00000000000 --- a/plotly/validators/layout/yaxis/_tickcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='tickcolor', parent_name='layout.yaxis', **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_tickfont.py b/plotly/validators/layout/yaxis/_tickfont.py deleted file mode 100644 index 96df07b396f..00000000000 --- a/plotly/validators/layout/yaxis/_tickfont.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='tickfont', parent_name='layout.yaxis', **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_tickformat.py b/plotly/validators/layout/yaxis/_tickformat.py deleted file mode 100644 index 471401e53ab..00000000000 --- a/plotly/validators/layout/yaxis/_tickformat.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='tickformat', parent_name='layout.yaxis', **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_tickformatstopdefaults.py b/plotly/validators/layout/yaxis/_tickformatstopdefaults.py deleted file mode 100644 index cb24e598be0..00000000000 --- a/plotly/validators/layout/yaxis/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='layout.yaxis', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_tickformatstops.py b/plotly/validators/layout/yaxis/_tickformatstops.py deleted file mode 100644 index 09f293a2707..00000000000 --- a/plotly/validators/layout/yaxis/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='layout.yaxis', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_ticklen.py b/plotly/validators/layout/yaxis/_ticklen.py deleted file mode 100644 index b9a0648e5b4..00000000000 --- a/plotly/validators/layout/yaxis/_ticklen.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ticklen', parent_name='layout.yaxis', **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_tickmode.py b/plotly/validators/layout/yaxis/_tickmode.py deleted file mode 100644 index 0696f24c659..00000000000 --- a/plotly/validators/layout/yaxis/_tickmode.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='tickmode', parent_name='layout.yaxis', **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_tickprefix.py b/plotly/validators/layout/yaxis/_tickprefix.py deleted file mode 100644 index 5076767a1bf..00000000000 --- a/plotly/validators/layout/yaxis/_tickprefix.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='tickprefix', parent_name='layout.yaxis', **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_ticks.py b/plotly/validators/layout/yaxis/_ticks.py deleted file mode 100644 index b2d4075dd1f..00000000000 --- a/plotly/validators/layout/yaxis/_ticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ticks', parent_name='layout.yaxis', **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_tickson.py b/plotly/validators/layout/yaxis/_tickson.py deleted file mode 100644 index b6b9e291cc4..00000000000 --- a/plotly/validators/layout/yaxis/_tickson.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksonValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='tickson', parent_name='layout.yaxis', **kwargs - ): - super(TicksonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['labels', 'boundaries']), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_ticksuffix.py b/plotly/validators/layout/yaxis/_ticksuffix.py deleted file mode 100644 index eb129628c67..00000000000 --- a/plotly/validators/layout/yaxis/_ticksuffix.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='ticksuffix', parent_name='layout.yaxis', **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_ticktext.py b/plotly/validators/layout/yaxis/_ticktext.py deleted file mode 100644 index b7de2b2881b..00000000000 --- a/plotly/validators/layout/yaxis/_ticktext.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ticktext', parent_name='layout.yaxis', **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_ticktextsrc.py b/plotly/validators/layout/yaxis/_ticktextsrc.py deleted file mode 100644 index 5e71a469211..00000000000 --- a/plotly/validators/layout/yaxis/_ticktextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='ticktextsrc', parent_name='layout.yaxis', **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_tickvals.py b/plotly/validators/layout/yaxis/_tickvals.py deleted file mode 100644 index 7a757f849a7..00000000000 --- a/plotly/validators/layout/yaxis/_tickvals.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='tickvals', parent_name='layout.yaxis', **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_tickvalssrc.py b/plotly/validators/layout/yaxis/_tickvalssrc.py deleted file mode 100644 index 6482600b42c..00000000000 --- a/plotly/validators/layout/yaxis/_tickvalssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='tickvalssrc', parent_name='layout.yaxis', **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_tickwidth.py b/plotly/validators/layout/yaxis/_tickwidth.py deleted file mode 100644 index 64ea4f65704..00000000000 --- a/plotly/validators/layout/yaxis/_tickwidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='tickwidth', parent_name='layout.yaxis', **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_title.py b/plotly/validators/layout/yaxis/_title.py deleted file mode 100644 index a06211f980b..00000000000 --- a/plotly/validators/layout/yaxis/_title.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='layout.yaxis', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this axis' title font. Note that the - title's font used to be customized by the now - deprecated `titlefont` attribute. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_type.py b/plotly/validators/layout/yaxis/_type.py deleted file mode 100644 index 57e123e6078..00000000000 --- a/plotly/validators/layout/yaxis/_type.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='layout.yaxis', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', - ['-', 'linear', 'log', 'date', 'category', 'multicategory'] - ), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_uirevision.py b/plotly/validators/layout/yaxis/_uirevision.py deleted file mode 100644 index 6ebff111acd..00000000000 --- a/plotly/validators/layout/yaxis/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='layout.yaxis', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_visible.py b/plotly/validators/layout/yaxis/_visible.py deleted file mode 100644 index be1017f748a..00000000000 --- a/plotly/validators/layout/yaxis/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='layout.yaxis', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_zeroline.py b/plotly/validators/layout/yaxis/_zeroline.py deleted file mode 100644 index 473271df8c4..00000000000 --- a/plotly/validators/layout/yaxis/_zeroline.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZerolineValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='zeroline', parent_name='layout.yaxis', **kwargs - ): - super(ZerolineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_zerolinecolor.py b/plotly/validators/layout/yaxis/_zerolinecolor.py deleted file mode 100644 index bc21378ad59..00000000000 --- a/plotly/validators/layout/yaxis/_zerolinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZerolinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='zerolinecolor', - parent_name='layout.yaxis', - **kwargs - ): - super(ZerolinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/_zerolinewidth.py b/plotly/validators/layout/yaxis/_zerolinewidth.py deleted file mode 100644 index 90c95a6d1e9..00000000000 --- a/plotly/validators/layout/yaxis/_zerolinewidth.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZerolinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='zerolinewidth', - parent_name='layout.yaxis', - **kwargs - ): - super(ZerolinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/tickfont/__init__.py b/plotly/validators/layout/yaxis/tickfont/__init__.py index 199d72e71c6..a8cfd8e60cd 100644 --- a/plotly/validators/layout/yaxis/tickfont/__init__.py +++ b/plotly/validators/layout/yaxis/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.yaxis.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.yaxis.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.yaxis.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/yaxis/tickfont/_color.py b/plotly/validators/layout/yaxis/tickfont/_color.py deleted file mode 100644 index e8959c33077..00000000000 --- a/plotly/validators/layout/yaxis/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.yaxis.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/tickfont/_family.py b/plotly/validators/layout/yaxis/tickfont/_family.py deleted file mode 100644 index 598adb1736d..00000000000 --- a/plotly/validators/layout/yaxis/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.yaxis.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/tickfont/_size.py b/plotly/validators/layout/yaxis/tickfont/_size.py deleted file mode 100644 index b765e7dfcf2..00000000000 --- a/plotly/validators/layout/yaxis/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.yaxis.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/tickformatstop/__init__.py b/plotly/validators/layout/yaxis/tickformatstop/__init__.py index 3f6c06cac47..6071d4f4f10 100644 --- a/plotly/validators/layout/yaxis/tickformatstop/__init__.py +++ b/plotly/validators/layout/yaxis/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='layout.yaxis.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='layout.yaxis.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='layout.yaxis.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='layout.yaxis.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='layout.yaxis.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'ticks' + }, { + 'valType': 'any', + 'editType': 'ticks' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/layout/yaxis/tickformatstop/_dtickrange.py b/plotly/validators/layout/yaxis/tickformatstop/_dtickrange.py deleted file mode 100644 index 29784e4305a..00000000000 --- a/plotly/validators/layout/yaxis/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='layout.yaxis.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'ticks' - }, { - 'valType': 'any', - 'editType': 'ticks' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/tickformatstop/_enabled.py b/plotly/validators/layout/yaxis/tickformatstop/_enabled.py deleted file mode 100644 index 44ee33c5b26..00000000000 --- a/plotly/validators/layout/yaxis/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='layout.yaxis.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/tickformatstop/_name.py b/plotly/validators/layout/yaxis/tickformatstop/_name.py deleted file mode 100644 index d7b63848653..00000000000 --- a/plotly/validators/layout/yaxis/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='layout.yaxis.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/tickformatstop/_templateitemname.py b/plotly/validators/layout/yaxis/tickformatstop/_templateitemname.py deleted file mode 100644 index 8982de44e04..00000000000 --- a/plotly/validators/layout/yaxis/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='layout.yaxis.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/tickformatstop/_value.py b/plotly/validators/layout/yaxis/tickformatstop/_value.py deleted file mode 100644 index 6ff1a3a4768..00000000000 --- a/plotly/validators/layout/yaxis/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='layout.yaxis.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/title/__init__.py b/plotly/validators/layout/yaxis/title/__init__.py index db7b0c34947..3563207ab65 100644 --- a/plotly/validators/layout/yaxis/title/__init__.py +++ b/plotly/validators/layout/yaxis/title/__init__.py @@ -1,2 +1,57 @@ -from ._text import TextValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='text', parent_name='layout.yaxis.title', **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='layout.yaxis.title', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/layout/yaxis/title/_font.py b/plotly/validators/layout/yaxis/title/_font.py deleted file mode 100644 index 37b8077dc00..00000000000 --- a/plotly/validators/layout/yaxis/title/_font.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='layout.yaxis.title', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/title/_text.py b/plotly/validators/layout/yaxis/title/_text.py deleted file mode 100644 index db41b531473..00000000000 --- a/plotly/validators/layout/yaxis/title/_text.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='text', parent_name='layout.yaxis.title', **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/title/font/__init__.py b/plotly/validators/layout/yaxis/title/font/__init__.py index 199d72e71c6..71da8cbbaaa 100644 --- a/plotly/validators/layout/yaxis/title/font/__init__.py +++ b/plotly/validators/layout/yaxis/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='layout.yaxis.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='layout.yaxis.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='layout.yaxis.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'ticks'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/layout/yaxis/title/font/_color.py b/plotly/validators/layout/yaxis/title/font/_color.py deleted file mode 100644 index 1c04869ee36..00000000000 --- a/plotly/validators/layout/yaxis/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='layout.yaxis.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/title/font/_family.py b/plotly/validators/layout/yaxis/title/font/_family.py deleted file mode 100644 index beb602603cb..00000000000 --- a/plotly/validators/layout/yaxis/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='layout.yaxis.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/layout/yaxis/title/font/_size.py b/plotly/validators/layout/yaxis/title/font/_size.py deleted file mode 100644 index 48943590501..00000000000 --- a/plotly/validators/layout/yaxis/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='layout.yaxis.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'ticks'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/__init__.py b/plotly/validators/mesh3d/__init__.py index 279cfcbceed..2fc36aef889 100644 --- a/plotly/validators/mesh3d/__init__.py +++ b/plotly/validators/mesh3d/__init__.py @@ -1,60 +1,1307 @@ -from ._zsrc import ZsrcValidator -from ._zcalendar import ZcalendarValidator -from ._z import ZValidator -from ._ysrc import YsrcValidator -from ._ycalendar import YcalendarValidator -from ._y import YValidator -from ._xsrc import XsrcValidator -from ._xcalendar import XcalendarValidator -from ._x import XValidator -from ._visible import VisibleValidator -from ._vertexcolorsrc import VertexcolorsrcValidator -from ._vertexcolor import VertexcolorValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._showscale import ShowscaleValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._scene import SceneValidator -from ._reversescale import ReversescaleValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._lightposition import LightpositionValidator -from ._lighting import LightingValidator -from ._legendgroup import LegendgroupValidator -from ._ksrc import KsrcValidator -from ._k import KValidator -from ._jsrc import JsrcValidator -from ._j import JValidator -from ._isrc import IsrcValidator -from ._intensitysrc import IntensitysrcValidator -from ._intensity import IntensityValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._i import IValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._flatshading import FlatshadingValidator -from ._facecolorsrc import FacecolorsrcValidator -from ._facecolor import FacecolorValidator -from ._delaunayaxis import DelaunayaxisValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._contour import ContourValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator -from ._alphahull import AlphahullValidator + + +import _plotly_utils.basevalidators + + +class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='zsrc', parent_name='mesh3d', **kwargs): + super(ZsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='zcalendar', parent_name='mesh3d', **kwargs + ): + super(ZcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='z', parent_name='mesh3d', **kwargs): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='mesh3d', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ycalendar', parent_name='mesh3d', **kwargs + ): + super(YcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='mesh3d', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='mesh3d', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xcalendar', parent_name='mesh3d', **kwargs + ): + super(XcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='mesh3d', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='mesh3d', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VertexcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='vertexcolorsrc', parent_name='mesh3d', **kwargs + ): + super(VertexcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VertexcolorValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='vertexcolor', parent_name='mesh3d', **kwargs + ): + super(VertexcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='mesh3d', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='mesh3d', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='textsrc', parent_name='mesh3d', **kwargs): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='mesh3d', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='mesh3d', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='mesh3d', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='mesh3d', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='mesh3d', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SceneValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='scene', parent_name='mesh3d', **kwargs): + super(SceneValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'scene'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='reversescale', parent_name='mesh3d', **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='opacity', parent_name='mesh3d', **kwargs): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='mesh3d', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LightpositionValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='lightposition', parent_name='mesh3d', **kwargs + ): + super(LightpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Lightposition'), + data_docs=kwargs.pop( + 'data_docs', """ + x + Numeric vector, representing the X coordinate + for each vertex. + y + Numeric vector, representing the Y coordinate + for each vertex. + z + Numeric vector, representing the Z coordinate + for each vertex. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LightingValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='lighting', parent_name='mesh3d', **kwargs): + super(LightingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Lighting'), + data_docs=kwargs.pop( + 'data_docs', """ + ambient + Ambient light increases overall color + visibility but can wash out the image. + diffuse + Represents the extent that incident rays are + reflected in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids + math issues arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of + the viewing angle; e.g. paper is reflective + when viewing it from the edge of the paper + (almost 90 degrees), causing shine. + roughness + Alters specular reflection; the rougher the + surface, the wider and less contrasty the + shine. + specular + Represents the level that incident rays are + reflected in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids + math issues arising from degenerate geometry. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='mesh3d', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class KsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ksrc', parent_name='mesh3d', **kwargs): + super(KsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class KValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='k', parent_name='mesh3d', **kwargs): + super(KValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class JsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='jsrc', parent_name='mesh3d', **kwargs): + super(JsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class JValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='j', parent_name='mesh3d', **kwargs): + super(JValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='isrc', parent_name='mesh3d', **kwargs): + super(IsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IntensitysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='intensitysrc', parent_name='mesh3d', **kwargs + ): + super(IntensitysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IntensityValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='intensity', parent_name='mesh3d', **kwargs + ): + super(IntensityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='mesh3d', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='mesh3d', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='i', parent_name='mesh3d', **kwargs): + super(IValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='mesh3d', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='mesh3d', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertemplatesrc', parent_name='mesh3d', **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='mesh3d', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='mesh3d', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='mesh3d', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='mesh3d', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FlatshadingValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='flatshading', parent_name='mesh3d', **kwargs + ): + super(FlatshadingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FacecolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='facecolorsrc', parent_name='mesh3d', **kwargs + ): + super(FacecolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FacecolorValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='facecolor', parent_name='mesh3d', **kwargs + ): + super(FacecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DelaunayaxisValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='delaunayaxis', parent_name='mesh3d', **kwargs + ): + super(DelaunayaxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['x', 'y', 'z']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='mesh3d', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='mesh3d', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ContourValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='contour', parent_name='mesh3d', **kwargs): + super(ContourValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Contour'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the color of the contour lines. + show + Sets whether or not dynamic contours are shown + on hover + width + Sets the width of the contour lines. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='mesh3d', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='colorbar', parent_name='mesh3d', **kwargs): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.mesh3d.colorbar.Tickformatsto + p instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.mesh3d.colorbar.tickformatstopdefaults), sets + the default property values to use for elements + of mesh3d.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.mesh3d.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + mesh3d.colorbar.title.font instead. Sets this + color bar's title font. Note that the title's + font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use + mesh3d.colorbar.title.side instead. Determines + the location of color bar's title with respect + to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__(self, plotly_name='color', parent_name='mesh3d', **kwargs): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop('colorscale_path', 'mesh3d.colorscale'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmin', parent_name='mesh3d', **kwargs): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmid', parent_name='mesh3d', **kwargs): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmax', parent_name='mesh3d', **kwargs): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='cauto', parent_name='mesh3d', **kwargs): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autocolorscale', parent_name='mesh3d', **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AlphahullValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='alphahull', parent_name='mesh3d', **kwargs + ): + super(AlphahullValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/mesh3d/_alphahull.py b/plotly/validators/mesh3d/_alphahull.py deleted file mode 100644 index 2246b1bb35f..00000000000 --- a/plotly/validators/mesh3d/_alphahull.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AlphahullValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='alphahull', parent_name='mesh3d', **kwargs - ): - super(AlphahullValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_autocolorscale.py b/plotly/validators/mesh3d/_autocolorscale.py deleted file mode 100644 index a84f6c3bc5a..00000000000 --- a/plotly/validators/mesh3d/_autocolorscale.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autocolorscale', parent_name='mesh3d', **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_cauto.py b/plotly/validators/mesh3d/_cauto.py deleted file mode 100644 index 577ab9b43de..00000000000 --- a/plotly/validators/mesh3d/_cauto.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='cauto', parent_name='mesh3d', **kwargs): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_cmax.py b/plotly/validators/mesh3d/_cmax.py deleted file mode 100644 index be1475a8487..00000000000 --- a/plotly/validators/mesh3d/_cmax.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmax', parent_name='mesh3d', **kwargs): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_cmid.py b/plotly/validators/mesh3d/_cmid.py deleted file mode 100644 index 9c69711baf8..00000000000 --- a/plotly/validators/mesh3d/_cmid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmid', parent_name='mesh3d', **kwargs): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_cmin.py b/plotly/validators/mesh3d/_cmin.py deleted file mode 100644 index db499ab5a6e..00000000000 --- a/plotly/validators/mesh3d/_cmin.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmin', parent_name='mesh3d', **kwargs): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_color.py b/plotly/validators/mesh3d/_color.py deleted file mode 100644 index b5436051a75..00000000000 --- a/plotly/validators/mesh3d/_color.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__(self, plotly_name='color', parent_name='mesh3d', **kwargs): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop('colorscale_path', 'mesh3d.colorscale'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_colorbar.py b/plotly/validators/mesh3d/_colorbar.py deleted file mode 100644 index 538dc3afd66..00000000000 --- a/plotly/validators/mesh3d/_colorbar.py +++ /dev/null @@ -1,224 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='colorbar', parent_name='mesh3d', **kwargs): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.mesh3d.colorbar.Tickformatsto - p instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.mesh3d.colorbar.tickformatstopdefaults), sets - the default property values to use for elements - of mesh3d.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.mesh3d.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - mesh3d.colorbar.title.font instead. Sets this - color bar's title font. Note that the title's - font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use - mesh3d.colorbar.title.side instead. Determines - the location of color bar's title with respect - to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_colorscale.py b/plotly/validators/mesh3d/_colorscale.py deleted file mode 100644 index eb775815c9f..00000000000 --- a/plotly/validators/mesh3d/_colorscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='mesh3d', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_contour.py b/plotly/validators/mesh3d/_contour.py deleted file mode 100644 index beb08921275..00000000000 --- a/plotly/validators/mesh3d/_contour.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ContourValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='contour', parent_name='mesh3d', **kwargs): - super(ContourValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Contour'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the color of the contour lines. - show - Sets whether or not dynamic contours are shown - on hover - width - Sets the width of the contour lines. -""" - ), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_customdata.py b/plotly/validators/mesh3d/_customdata.py deleted file mode 100644 index 22deeb617f0..00000000000 --- a/plotly/validators/mesh3d/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='mesh3d', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_customdatasrc.py b/plotly/validators/mesh3d/_customdatasrc.py deleted file mode 100644 index e803c484ee2..00000000000 --- a/plotly/validators/mesh3d/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='mesh3d', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_delaunayaxis.py b/plotly/validators/mesh3d/_delaunayaxis.py deleted file mode 100644 index e57f14db458..00000000000 --- a/plotly/validators/mesh3d/_delaunayaxis.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DelaunayaxisValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='delaunayaxis', parent_name='mesh3d', **kwargs - ): - super(DelaunayaxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['x', 'y', 'z']), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_facecolor.py b/plotly/validators/mesh3d/_facecolor.py deleted file mode 100644 index 14f12517b5f..00000000000 --- a/plotly/validators/mesh3d/_facecolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FacecolorValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='facecolor', parent_name='mesh3d', **kwargs - ): - super(FacecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_facecolorsrc.py b/plotly/validators/mesh3d/_facecolorsrc.py deleted file mode 100644 index 5d9b2362edb..00000000000 --- a/plotly/validators/mesh3d/_facecolorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FacecolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='facecolorsrc', parent_name='mesh3d', **kwargs - ): - super(FacecolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_flatshading.py b/plotly/validators/mesh3d/_flatshading.py deleted file mode 100644 index d92036206cd..00000000000 --- a/plotly/validators/mesh3d/_flatshading.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FlatshadingValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='flatshading', parent_name='mesh3d', **kwargs - ): - super(FlatshadingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_hoverinfo.py b/plotly/validators/mesh3d/_hoverinfo.py deleted file mode 100644 index 53b49be7023..00000000000 --- a/plotly/validators/mesh3d/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='mesh3d', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_hoverinfosrc.py b/plotly/validators/mesh3d/_hoverinfosrc.py deleted file mode 100644 index 5f378e4c95a..00000000000 --- a/plotly/validators/mesh3d/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='mesh3d', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_hoverlabel.py b/plotly/validators/mesh3d/_hoverlabel.py deleted file mode 100644 index 3433aa754eb..00000000000 --- a/plotly/validators/mesh3d/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='mesh3d', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_hovertemplate.py b/plotly/validators/mesh3d/_hovertemplate.py deleted file mode 100644 index 08b0416c42f..00000000000 --- a/plotly/validators/mesh3d/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='mesh3d', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_hovertemplatesrc.py b/plotly/validators/mesh3d/_hovertemplatesrc.py deleted file mode 100644 index bfb29062d7e..00000000000 --- a/plotly/validators/mesh3d/_hovertemplatesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertemplatesrc', parent_name='mesh3d', **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_hovertext.py b/plotly/validators/mesh3d/_hovertext.py deleted file mode 100644 index c3e4fb937e5..00000000000 --- a/plotly/validators/mesh3d/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='mesh3d', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_hovertextsrc.py b/plotly/validators/mesh3d/_hovertextsrc.py deleted file mode 100644 index 61b1b72ec8b..00000000000 --- a/plotly/validators/mesh3d/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='mesh3d', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_i.py b/plotly/validators/mesh3d/_i.py deleted file mode 100644 index 4e8020c9a9c..00000000000 --- a/plotly/validators/mesh3d/_i.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='i', parent_name='mesh3d', **kwargs): - super(IValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_ids.py b/plotly/validators/mesh3d/_ids.py deleted file mode 100644 index 56d1475ba0b..00000000000 --- a/plotly/validators/mesh3d/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='mesh3d', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_idssrc.py b/plotly/validators/mesh3d/_idssrc.py deleted file mode 100644 index 8e1d253807b..00000000000 --- a/plotly/validators/mesh3d/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='mesh3d', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_intensity.py b/plotly/validators/mesh3d/_intensity.py deleted file mode 100644 index 5fc0f66458a..00000000000 --- a/plotly/validators/mesh3d/_intensity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IntensityValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='intensity', parent_name='mesh3d', **kwargs - ): - super(IntensityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_intensitysrc.py b/plotly/validators/mesh3d/_intensitysrc.py deleted file mode 100644 index b682d9a8819..00000000000 --- a/plotly/validators/mesh3d/_intensitysrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IntensitysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='intensitysrc', parent_name='mesh3d', **kwargs - ): - super(IntensitysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_isrc.py b/plotly/validators/mesh3d/_isrc.py deleted file mode 100644 index 2a11622a6e7..00000000000 --- a/plotly/validators/mesh3d/_isrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='isrc', parent_name='mesh3d', **kwargs): - super(IsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_j.py b/plotly/validators/mesh3d/_j.py deleted file mode 100644 index 8deb42ada53..00000000000 --- a/plotly/validators/mesh3d/_j.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class JValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='j', parent_name='mesh3d', **kwargs): - super(JValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_jsrc.py b/plotly/validators/mesh3d/_jsrc.py deleted file mode 100644 index 26b692252d3..00000000000 --- a/plotly/validators/mesh3d/_jsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class JsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='jsrc', parent_name='mesh3d', **kwargs): - super(JsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_k.py b/plotly/validators/mesh3d/_k.py deleted file mode 100644 index 0dd9b1a6dda..00000000000 --- a/plotly/validators/mesh3d/_k.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class KValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='k', parent_name='mesh3d', **kwargs): - super(KValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_ksrc.py b/plotly/validators/mesh3d/_ksrc.py deleted file mode 100644 index a9b00e7ac42..00000000000 --- a/plotly/validators/mesh3d/_ksrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class KsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ksrc', parent_name='mesh3d', **kwargs): - super(KsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_legendgroup.py b/plotly/validators/mesh3d/_legendgroup.py deleted file mode 100644 index 68daf44a3c6..00000000000 --- a/plotly/validators/mesh3d/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='mesh3d', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_lighting.py b/plotly/validators/mesh3d/_lighting.py deleted file mode 100644 index 0ffefc349be..00000000000 --- a/plotly/validators/mesh3d/_lighting.py +++ /dev/null @@ -1,40 +0,0 @@ -import _plotly_utils.basevalidators - - -class LightingValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='lighting', parent_name='mesh3d', **kwargs): - super(LightingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Lighting'), - data_docs=kwargs.pop( - 'data_docs', """ - ambient - Ambient light increases overall color - visibility but can wash out the image. - diffuse - Represents the extent that incident rays are - reflected in a range of angles. - facenormalsepsilon - Epsilon for face normals calculation avoids - math issues arising from degenerate geometry. - fresnel - Represents the reflectance as a dependency of - the viewing angle; e.g. paper is reflective - when viewing it from the edge of the paper - (almost 90 degrees), causing shine. - roughness - Alters specular reflection; the rougher the - surface, the wider and less contrasty the - shine. - specular - Represents the level that incident rays are - reflected in a single direction, causing shine. - vertexnormalsepsilon - Epsilon for vertex normals calculation avoids - math issues arising from degenerate geometry. -""" - ), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_lightposition.py b/plotly/validators/mesh3d/_lightposition.py deleted file mode 100644 index 0fce4badbb4..00000000000 --- a/plotly/validators/mesh3d/_lightposition.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class LightpositionValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='lightposition', parent_name='mesh3d', **kwargs - ): - super(LightpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Lightposition'), - data_docs=kwargs.pop( - 'data_docs', """ - x - Numeric vector, representing the X coordinate - for each vertex. - y - Numeric vector, representing the Y coordinate - for each vertex. - z - Numeric vector, representing the Z coordinate - for each vertex. -""" - ), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_name.py b/plotly/validators/mesh3d/_name.py deleted file mode 100644 index 87620122b10..00000000000 --- a/plotly/validators/mesh3d/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='mesh3d', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_opacity.py b/plotly/validators/mesh3d/_opacity.py deleted file mode 100644 index 1c8ddc796d7..00000000000 --- a/plotly/validators/mesh3d/_opacity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='opacity', parent_name='mesh3d', **kwargs): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_reversescale.py b/plotly/validators/mesh3d/_reversescale.py deleted file mode 100644 index 1c6630046df..00000000000 --- a/plotly/validators/mesh3d/_reversescale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='reversescale', parent_name='mesh3d', **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_scene.py b/plotly/validators/mesh3d/_scene.py deleted file mode 100644 index d23ae359ed0..00000000000 --- a/plotly/validators/mesh3d/_scene.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class SceneValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='scene', parent_name='mesh3d', **kwargs): - super(SceneValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'scene'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_selectedpoints.py b/plotly/validators/mesh3d/_selectedpoints.py deleted file mode 100644 index 006807356a7..00000000000 --- a/plotly/validators/mesh3d/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='mesh3d', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_showlegend.py b/plotly/validators/mesh3d/_showlegend.py deleted file mode 100644 index 94a9af5a80a..00000000000 --- a/plotly/validators/mesh3d/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='mesh3d', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_showscale.py b/plotly/validators/mesh3d/_showscale.py deleted file mode 100644 index aa2308fc71a..00000000000 --- a/plotly/validators/mesh3d/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='mesh3d', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_stream.py b/plotly/validators/mesh3d/_stream.py deleted file mode 100644 index df152d3ef2d..00000000000 --- a/plotly/validators/mesh3d/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='mesh3d', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_text.py b/plotly/validators/mesh3d/_text.py deleted file mode 100644 index 94dba69cdd3..00000000000 --- a/plotly/validators/mesh3d/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='mesh3d', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_textsrc.py b/plotly/validators/mesh3d/_textsrc.py deleted file mode 100644 index 2b33e570b2a..00000000000 --- a/plotly/validators/mesh3d/_textsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='textsrc', parent_name='mesh3d', **kwargs): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_uid.py b/plotly/validators/mesh3d/_uid.py deleted file mode 100644 index c53d8f163ec..00000000000 --- a/plotly/validators/mesh3d/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='mesh3d', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_uirevision.py b/plotly/validators/mesh3d/_uirevision.py deleted file mode 100644 index 1065f7107fa..00000000000 --- a/plotly/validators/mesh3d/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='mesh3d', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_vertexcolor.py b/plotly/validators/mesh3d/_vertexcolor.py deleted file mode 100644 index d1bca23deb0..00000000000 --- a/plotly/validators/mesh3d/_vertexcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VertexcolorValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='vertexcolor', parent_name='mesh3d', **kwargs - ): - super(VertexcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_vertexcolorsrc.py b/plotly/validators/mesh3d/_vertexcolorsrc.py deleted file mode 100644 index da08fb19360..00000000000 --- a/plotly/validators/mesh3d/_vertexcolorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VertexcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='vertexcolorsrc', parent_name='mesh3d', **kwargs - ): - super(VertexcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_visible.py b/plotly/validators/mesh3d/_visible.py deleted file mode 100644 index a765d7199ba..00000000000 --- a/plotly/validators/mesh3d/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='mesh3d', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_x.py b/plotly/validators/mesh3d/_x.py deleted file mode 100644 index 5d9731c2cbe..00000000000 --- a/plotly/validators/mesh3d/_x.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='mesh3d', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_xcalendar.py b/plotly/validators/mesh3d/_xcalendar.py deleted file mode 100644 index 01558f7da78..00000000000 --- a/plotly/validators/mesh3d/_xcalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xcalendar', parent_name='mesh3d', **kwargs - ): - super(XcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_xsrc.py b/plotly/validators/mesh3d/_xsrc.py deleted file mode 100644 index e2121d99c4b..00000000000 --- a/plotly/validators/mesh3d/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='mesh3d', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_y.py b/plotly/validators/mesh3d/_y.py deleted file mode 100644 index 650d3008c65..00000000000 --- a/plotly/validators/mesh3d/_y.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='mesh3d', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_ycalendar.py b/plotly/validators/mesh3d/_ycalendar.py deleted file mode 100644 index 87022bddd5e..00000000000 --- a/plotly/validators/mesh3d/_ycalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ycalendar', parent_name='mesh3d', **kwargs - ): - super(YcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_ysrc.py b/plotly/validators/mesh3d/_ysrc.py deleted file mode 100644 index 46717645318..00000000000 --- a/plotly/validators/mesh3d/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='mesh3d', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_z.py b/plotly/validators/mesh3d/_z.py deleted file mode 100644 index 0643a1f41ec..00000000000 --- a/plotly/validators/mesh3d/_z.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='z', parent_name='mesh3d', **kwargs): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_zcalendar.py b/plotly/validators/mesh3d/_zcalendar.py deleted file mode 100644 index 4f3d21640f9..00000000000 --- a/plotly/validators/mesh3d/_zcalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='zcalendar', parent_name='mesh3d', **kwargs - ): - super(ZcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/mesh3d/_zsrc.py b/plotly/validators/mesh3d/_zsrc.py deleted file mode 100644 index 54a53e6b938..00000000000 --- a/plotly/validators/mesh3d/_zsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='zsrc', parent_name='mesh3d', **kwargs): - super(ZsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/__init__.py b/plotly/validators/mesh3d/colorbar/__init__.py index 3dab31f7e02..69e40e1ecad 100644 --- a/plotly/validators/mesh3d/colorbar/__init__.py +++ b/plotly/validators/mesh3d/colorbar/__init__.py @@ -1,41 +1,867 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ypad', parent_name='mesh3d.colorbar', **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='yanchor', parent_name='mesh3d.colorbar', **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='mesh3d.colorbar', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='xpad', parent_name='mesh3d.colorbar', **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xanchor', parent_name='mesh3d.colorbar', **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='mesh3d.colorbar', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='mesh3d.colorbar', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='tickwidth', parent_name='mesh3d.colorbar', **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='tickvals', parent_name='mesh3d.colorbar', **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ticktext', parent_name='mesh3d.colorbar', **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ticks', parent_name='mesh3d.colorbar', **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='tickmode', parent_name='mesh3d.colorbar', **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ticklen', parent_name='mesh3d.colorbar', **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='tickfont', parent_name='mesh3d.colorbar', **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='tickcolor', parent_name='mesh3d.colorbar', **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, plotly_name='tickangle', parent_name='mesh3d.colorbar', **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='tick0', parent_name='mesh3d.colorbar', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='thickness', parent_name='mesh3d.colorbar', **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nticks', parent_name='mesh3d.colorbar', **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='lenmode', parent_name='mesh3d.colorbar', **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='len', parent_name='mesh3d.colorbar', **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='dtick', parent_name='mesh3d.colorbar', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='mesh3d.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='mesh3d.colorbar', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/mesh3d/colorbar/_bgcolor.py b/plotly/validators/mesh3d/colorbar/_bgcolor.py deleted file mode 100644 index 4d1cbbce725..00000000000 --- a/plotly/validators/mesh3d/colorbar/_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='mesh3d.colorbar', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_bordercolor.py b/plotly/validators/mesh3d/colorbar/_bordercolor.py deleted file mode 100644 index 923b28b55d6..00000000000 --- a/plotly/validators/mesh3d/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_borderwidth.py b/plotly/validators/mesh3d/colorbar/_borderwidth.py deleted file mode 100644 index 5c6fdfd8b50..00000000000 --- a/plotly/validators/mesh3d/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_dtick.py b/plotly/validators/mesh3d/colorbar/_dtick.py deleted file mode 100644 index 9e5d0ba8d93..00000000000 --- a/plotly/validators/mesh3d/colorbar/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='dtick', parent_name='mesh3d.colorbar', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_exponentformat.py b/plotly/validators/mesh3d/colorbar/_exponentformat.py deleted file mode 100644 index 7d861f1add6..00000000000 --- a/plotly/validators/mesh3d/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_len.py b/plotly/validators/mesh3d/colorbar/_len.py deleted file mode 100644 index 893031b7a35..00000000000 --- a/plotly/validators/mesh3d/colorbar/_len.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='len', parent_name='mesh3d.colorbar', **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_lenmode.py b/plotly/validators/mesh3d/colorbar/_lenmode.py deleted file mode 100644 index 42fbc076f5c..00000000000 --- a/plotly/validators/mesh3d/colorbar/_lenmode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='lenmode', parent_name='mesh3d.colorbar', **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_nticks.py b/plotly/validators/mesh3d/colorbar/_nticks.py deleted file mode 100644 index b6c44e41842..00000000000 --- a/plotly/validators/mesh3d/colorbar/_nticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nticks', parent_name='mesh3d.colorbar', **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_outlinecolor.py b/plotly/validators/mesh3d/colorbar/_outlinecolor.py deleted file mode 100644 index b3da36366f7..00000000000 --- a/plotly/validators/mesh3d/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_outlinewidth.py b/plotly/validators/mesh3d/colorbar/_outlinewidth.py deleted file mode 100644 index 6f0eba47fd6..00000000000 --- a/plotly/validators/mesh3d/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_separatethousands.py b/plotly/validators/mesh3d/colorbar/_separatethousands.py deleted file mode 100644 index 331190bb99e..00000000000 --- a/plotly/validators/mesh3d/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_showexponent.py b/plotly/validators/mesh3d/colorbar/_showexponent.py deleted file mode 100644 index 05bf207b6fa..00000000000 --- a/plotly/validators/mesh3d/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_showticklabels.py b/plotly/validators/mesh3d/colorbar/_showticklabels.py deleted file mode 100644 index 930dae0b003..00000000000 --- a/plotly/validators/mesh3d/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_showtickprefix.py b/plotly/validators/mesh3d/colorbar/_showtickprefix.py deleted file mode 100644 index 70254e3a56d..00000000000 --- a/plotly/validators/mesh3d/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_showticksuffix.py b/plotly/validators/mesh3d/colorbar/_showticksuffix.py deleted file mode 100644 index feb05e61716..00000000000 --- a/plotly/validators/mesh3d/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_thickness.py b/plotly/validators/mesh3d/colorbar/_thickness.py deleted file mode 100644 index 7a3ffe0c9b0..00000000000 --- a/plotly/validators/mesh3d/colorbar/_thickness.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='thickness', parent_name='mesh3d.colorbar', **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_thicknessmode.py b/plotly/validators/mesh3d/colorbar/_thicknessmode.py deleted file mode 100644 index c861c492b88..00000000000 --- a/plotly/validators/mesh3d/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_tick0.py b/plotly/validators/mesh3d/colorbar/_tick0.py deleted file mode 100644 index 3eac4a32cea..00000000000 --- a/plotly/validators/mesh3d/colorbar/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='tick0', parent_name='mesh3d.colorbar', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_tickangle.py b/plotly/validators/mesh3d/colorbar/_tickangle.py deleted file mode 100644 index 5af8eaf35ee..00000000000 --- a/plotly/validators/mesh3d/colorbar/_tickangle.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, plotly_name='tickangle', parent_name='mesh3d.colorbar', **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_tickcolor.py b/plotly/validators/mesh3d/colorbar/_tickcolor.py deleted file mode 100644 index 4a96933a36f..00000000000 --- a/plotly/validators/mesh3d/colorbar/_tickcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='tickcolor', parent_name='mesh3d.colorbar', **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_tickfont.py b/plotly/validators/mesh3d/colorbar/_tickfont.py deleted file mode 100644 index da481681b21..00000000000 --- a/plotly/validators/mesh3d/colorbar/_tickfont.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='tickfont', parent_name='mesh3d.colorbar', **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_tickformat.py b/plotly/validators/mesh3d/colorbar/_tickformat.py deleted file mode 100644 index 0a0fb3c7ece..00000000000 --- a/plotly/validators/mesh3d/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_tickformatstopdefaults.py b/plotly/validators/mesh3d/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index a6d4fad7bd0..00000000000 --- a/plotly/validators/mesh3d/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_tickformatstops.py b/plotly/validators/mesh3d/colorbar/_tickformatstops.py deleted file mode 100644 index 10a4ceafc1f..00000000000 --- a/plotly/validators/mesh3d/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_ticklen.py b/plotly/validators/mesh3d/colorbar/_ticklen.py deleted file mode 100644 index fd3f88cadd6..00000000000 --- a/plotly/validators/mesh3d/colorbar/_ticklen.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ticklen', parent_name='mesh3d.colorbar', **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_tickmode.py b/plotly/validators/mesh3d/colorbar/_tickmode.py deleted file mode 100644 index 849daaaeca7..00000000000 --- a/plotly/validators/mesh3d/colorbar/_tickmode.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='tickmode', parent_name='mesh3d.colorbar', **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_tickprefix.py b/plotly/validators/mesh3d/colorbar/_tickprefix.py deleted file mode 100644 index d94030734c9..00000000000 --- a/plotly/validators/mesh3d/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_ticks.py b/plotly/validators/mesh3d/colorbar/_ticks.py deleted file mode 100644 index 8028457c8a8..00000000000 --- a/plotly/validators/mesh3d/colorbar/_ticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ticks', parent_name='mesh3d.colorbar', **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_ticksuffix.py b/plotly/validators/mesh3d/colorbar/_ticksuffix.py deleted file mode 100644 index 366b7025b45..00000000000 --- a/plotly/validators/mesh3d/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_ticktext.py b/plotly/validators/mesh3d/colorbar/_ticktext.py deleted file mode 100644 index 6c2162ce32d..00000000000 --- a/plotly/validators/mesh3d/colorbar/_ticktext.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ticktext', parent_name='mesh3d.colorbar', **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_ticktextsrc.py b/plotly/validators/mesh3d/colorbar/_ticktextsrc.py deleted file mode 100644 index 49791187528..00000000000 --- a/plotly/validators/mesh3d/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_tickvals.py b/plotly/validators/mesh3d/colorbar/_tickvals.py deleted file mode 100644 index e4e2b89d54a..00000000000 --- a/plotly/validators/mesh3d/colorbar/_tickvals.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='tickvals', parent_name='mesh3d.colorbar', **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_tickvalssrc.py b/plotly/validators/mesh3d/colorbar/_tickvalssrc.py deleted file mode 100644 index 46de01b1063..00000000000 --- a/plotly/validators/mesh3d/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='mesh3d.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_tickwidth.py b/plotly/validators/mesh3d/colorbar/_tickwidth.py deleted file mode 100644 index 7fea1b904c9..00000000000 --- a/plotly/validators/mesh3d/colorbar/_tickwidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='tickwidth', parent_name='mesh3d.colorbar', **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_title.py b/plotly/validators/mesh3d/colorbar/_title.py deleted file mode 100644 index aa4c4e4b43a..00000000000 --- a/plotly/validators/mesh3d/colorbar/_title.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='mesh3d.colorbar', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_x.py b/plotly/validators/mesh3d/colorbar/_x.py deleted file mode 100644 index 38aa078fb5e..00000000000 --- a/plotly/validators/mesh3d/colorbar/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='mesh3d.colorbar', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_xanchor.py b/plotly/validators/mesh3d/colorbar/_xanchor.py deleted file mode 100644 index 2cf09b38108..00000000000 --- a/plotly/validators/mesh3d/colorbar/_xanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xanchor', parent_name='mesh3d.colorbar', **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_xpad.py b/plotly/validators/mesh3d/colorbar/_xpad.py deleted file mode 100644 index 1659a8661da..00000000000 --- a/plotly/validators/mesh3d/colorbar/_xpad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='xpad', parent_name='mesh3d.colorbar', **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_y.py b/plotly/validators/mesh3d/colorbar/_y.py deleted file mode 100644 index c6557c79f6c..00000000000 --- a/plotly/validators/mesh3d/colorbar/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='mesh3d.colorbar', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_yanchor.py b/plotly/validators/mesh3d/colorbar/_yanchor.py deleted file mode 100644 index 1a487defa52..00000000000 --- a/plotly/validators/mesh3d/colorbar/_yanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='yanchor', parent_name='mesh3d.colorbar', **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/_ypad.py b/plotly/validators/mesh3d/colorbar/_ypad.py deleted file mode 100644 index ad2f0a93748..00000000000 --- a/plotly/validators/mesh3d/colorbar/_ypad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ypad', parent_name='mesh3d.colorbar', **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/tickfont/__init__.py b/plotly/validators/mesh3d/colorbar/tickfont/__init__.py index 199d72e71c6..ff0efcf73b6 100644 --- a/plotly/validators/mesh3d/colorbar/tickfont/__init__.py +++ b/plotly/validators/mesh3d/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='mesh3d.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='mesh3d.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='mesh3d.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/mesh3d/colorbar/tickfont/_color.py b/plotly/validators/mesh3d/colorbar/tickfont/_color.py deleted file mode 100644 index 2a6d4f484c2..00000000000 --- a/plotly/validators/mesh3d/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='mesh3d.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/tickfont/_family.py b/plotly/validators/mesh3d/colorbar/tickfont/_family.py deleted file mode 100644 index f7263b27e2f..00000000000 --- a/plotly/validators/mesh3d/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='mesh3d.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/tickfont/_size.py b/plotly/validators/mesh3d/colorbar/tickfont/_size.py deleted file mode 100644 index 0b755397553..00000000000 --- a/plotly/validators/mesh3d/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='mesh3d.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/tickformatstop/__init__.py b/plotly/validators/mesh3d/colorbar/tickformatstop/__init__.py index 3f6c06cac47..3fd70465b6a 100644 --- a/plotly/validators/mesh3d/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/mesh3d/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='mesh3d.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='mesh3d.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='mesh3d.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='mesh3d.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='mesh3d.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/mesh3d/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/mesh3d/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 43e822e0de6..00000000000 --- a/plotly/validators/mesh3d/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='mesh3d.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/tickformatstop/_enabled.py b/plotly/validators/mesh3d/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index 140553d49f6..00000000000 --- a/plotly/validators/mesh3d/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='mesh3d.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/tickformatstop/_name.py b/plotly/validators/mesh3d/colorbar/tickformatstop/_name.py deleted file mode 100644 index 4b886385364..00000000000 --- a/plotly/validators/mesh3d/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='mesh3d.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/mesh3d/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 8d6fad7c176..00000000000 --- a/plotly/validators/mesh3d/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='mesh3d.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/tickformatstop/_value.py b/plotly/validators/mesh3d/colorbar/tickformatstop/_value.py deleted file mode 100644 index e41e81afb43..00000000000 --- a/plotly/validators/mesh3d/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='mesh3d.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/title/__init__.py b/plotly/validators/mesh3d/colorbar/title/__init__.py index 33c9c145bb8..d4236a2c758 100644 --- a/plotly/validators/mesh3d/colorbar/title/__init__.py +++ b/plotly/validators/mesh3d/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='mesh3d.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='mesh3d.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='mesh3d.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/mesh3d/colorbar/title/_font.py b/plotly/validators/mesh3d/colorbar/title/_font.py deleted file mode 100644 index 711044c7477..00000000000 --- a/plotly/validators/mesh3d/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='mesh3d.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/title/_side.py b/plotly/validators/mesh3d/colorbar/title/_side.py deleted file mode 100644 index 7e002cb390f..00000000000 --- a/plotly/validators/mesh3d/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='mesh3d.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/title/_text.py b/plotly/validators/mesh3d/colorbar/title/_text.py deleted file mode 100644 index 1203406a48a..00000000000 --- a/plotly/validators/mesh3d/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='mesh3d.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/title/font/__init__.py b/plotly/validators/mesh3d/colorbar/title/font/__init__.py index 199d72e71c6..6d292c78b0a 100644 --- a/plotly/validators/mesh3d/colorbar/title/font/__init__.py +++ b/plotly/validators/mesh3d/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='mesh3d.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='mesh3d.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='mesh3d.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/mesh3d/colorbar/title/font/_color.py b/plotly/validators/mesh3d/colorbar/title/font/_color.py deleted file mode 100644 index 054592e5a22..00000000000 --- a/plotly/validators/mesh3d/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='mesh3d.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/title/font/_family.py b/plotly/validators/mesh3d/colorbar/title/font/_family.py deleted file mode 100644 index a0505a9b8d3..00000000000 --- a/plotly/validators/mesh3d/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='mesh3d.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/mesh3d/colorbar/title/font/_size.py b/plotly/validators/mesh3d/colorbar/title/font/_size.py deleted file mode 100644 index ef06869b167..00000000000 --- a/plotly/validators/mesh3d/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='mesh3d.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/contour/__init__.py b/plotly/validators/mesh3d/contour/__init__.py index 54b6fd53570..6b4b6590753 100644 --- a/plotly/validators/mesh3d/contour/__init__.py +++ b/plotly/validators/mesh3d/contour/__init__.py @@ -1,3 +1,53 @@ -from ._width import WidthValidator -from ._show import ShowValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='mesh3d.contour', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 16), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='show', parent_name='mesh3d.contour', **kwargs + ): + super(ShowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='mesh3d.contour', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/mesh3d/contour/_color.py b/plotly/validators/mesh3d/contour/_color.py deleted file mode 100644 index dbfb51d6465..00000000000 --- a/plotly/validators/mesh3d/contour/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='mesh3d.contour', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/contour/_show.py b/plotly/validators/mesh3d/contour/_show.py deleted file mode 100644 index b06b7e99778..00000000000 --- a/plotly/validators/mesh3d/contour/_show.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='show', parent_name='mesh3d.contour', **kwargs - ): - super(ShowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/contour/_width.py b/plotly/validators/mesh3d/contour/_width.py deleted file mode 100644 index e060e6033e6..00000000000 --- a/plotly/validators/mesh3d/contour/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='mesh3d.contour', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 16), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/hoverlabel/__init__.py b/plotly/validators/mesh3d/hoverlabel/__init__.py index 856f769ba33..b658267b43a 100644 --- a/plotly/validators/mesh3d/hoverlabel/__init__.py +++ b/plotly/validators/mesh3d/hoverlabel/__init__.py @@ -1,7 +1,170 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='mesh3d.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='mesh3d.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='mesh3d.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='mesh3d.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='mesh3d.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='mesh3d.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='mesh3d.hoverlabel', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/mesh3d/hoverlabel/_bgcolor.py b/plotly/validators/mesh3d/hoverlabel/_bgcolor.py deleted file mode 100644 index e56db16e682..00000000000 --- a/plotly/validators/mesh3d/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='mesh3d.hoverlabel', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/hoverlabel/_bgcolorsrc.py b/plotly/validators/mesh3d/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index aa901b7d9c3..00000000000 --- a/plotly/validators/mesh3d/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='mesh3d.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/hoverlabel/_bordercolor.py b/plotly/validators/mesh3d/hoverlabel/_bordercolor.py deleted file mode 100644 index a8912290be6..00000000000 --- a/plotly/validators/mesh3d/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='mesh3d.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/hoverlabel/_bordercolorsrc.py b/plotly/validators/mesh3d/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index d891035388c..00000000000 --- a/plotly/validators/mesh3d/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='mesh3d.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/hoverlabel/_font.py b/plotly/validators/mesh3d/hoverlabel/_font.py deleted file mode 100644 index 898aade081b..00000000000 --- a/plotly/validators/mesh3d/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='mesh3d.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/mesh3d/hoverlabel/_namelength.py b/plotly/validators/mesh3d/hoverlabel/_namelength.py deleted file mode 100644 index ead5916ddd2..00000000000 --- a/plotly/validators/mesh3d/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='mesh3d.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/hoverlabel/_namelengthsrc.py b/plotly/validators/mesh3d/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 2f2514c61d4..00000000000 --- a/plotly/validators/mesh3d/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='mesh3d.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/hoverlabel/font/__init__.py b/plotly/validators/mesh3d/hoverlabel/font/__init__.py index 1d2c591d1e5..01ce43d5fc4 100644 --- a/plotly/validators/mesh3d/hoverlabel/font/__init__.py +++ b/plotly/validators/mesh3d/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='mesh3d.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='mesh3d.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='mesh3d.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='mesh3d.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='mesh3d.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='mesh3d.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/mesh3d/hoverlabel/font/_color.py b/plotly/validators/mesh3d/hoverlabel/font/_color.py deleted file mode 100644 index 44b3bb7c05a..00000000000 --- a/plotly/validators/mesh3d/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='mesh3d.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/hoverlabel/font/_colorsrc.py b/plotly/validators/mesh3d/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 93c32026f13..00000000000 --- a/plotly/validators/mesh3d/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='mesh3d.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/hoverlabel/font/_family.py b/plotly/validators/mesh3d/hoverlabel/font/_family.py deleted file mode 100644 index ce4bece5fd7..00000000000 --- a/plotly/validators/mesh3d/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='mesh3d.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/mesh3d/hoverlabel/font/_familysrc.py b/plotly/validators/mesh3d/hoverlabel/font/_familysrc.py deleted file mode 100644 index a5741d1fac9..00000000000 --- a/plotly/validators/mesh3d/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='mesh3d.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/hoverlabel/font/_size.py b/plotly/validators/mesh3d/hoverlabel/font/_size.py deleted file mode 100644 index 19996bd8236..00000000000 --- a/plotly/validators/mesh3d/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='mesh3d.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/hoverlabel/font/_sizesrc.py b/plotly/validators/mesh3d/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 794adf08540..00000000000 --- a/plotly/validators/mesh3d/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='mesh3d.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/lighting/__init__.py b/plotly/validators/mesh3d/lighting/__init__.py index 6abe696b0d7..286327c81de 100644 --- a/plotly/validators/mesh3d/lighting/__init__.py +++ b/plotly/validators/mesh3d/lighting/__init__.py @@ -1,7 +1,143 @@ -from ._vertexnormalsepsilon import VertexnormalsepsilonValidator -from ._specular import SpecularValidator -from ._roughness import RoughnessValidator -from ._fresnel import FresnelValidator -from ._facenormalsepsilon import FacenormalsepsilonValidator -from ._diffuse import DiffuseValidator -from ._ambient import AmbientValidator + + +import _plotly_utils.basevalidators + + +class VertexnormalsepsilonValidator( + _plotly_utils.basevalidators.NumberValidator +): + + def __init__( + self, + plotly_name='vertexnormalsepsilon', + parent_name='mesh3d.lighting', + **kwargs + ): + super(VertexnormalsepsilonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpecularValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='specular', parent_name='mesh3d.lighting', **kwargs + ): + super(SpecularValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 2), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RoughnessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='roughness', parent_name='mesh3d.lighting', **kwargs + ): + super(RoughnessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FresnelValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='fresnel', parent_name='mesh3d.lighting', **kwargs + ): + super(FresnelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 5), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FacenormalsepsilonValidator( + _plotly_utils.basevalidators.NumberValidator +): + + def __init__( + self, + plotly_name='facenormalsepsilon', + parent_name='mesh3d.lighting', + **kwargs + ): + super(FacenormalsepsilonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DiffuseValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='diffuse', parent_name='mesh3d.lighting', **kwargs + ): + super(DiffuseValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AmbientValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ambient', parent_name='mesh3d.lighting', **kwargs + ): + super(AmbientValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/mesh3d/lighting/_ambient.py b/plotly/validators/mesh3d/lighting/_ambient.py deleted file mode 100644 index 0c56e18c4bd..00000000000 --- a/plotly/validators/mesh3d/lighting/_ambient.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class AmbientValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ambient', parent_name='mesh3d.lighting', **kwargs - ): - super(AmbientValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/lighting/_diffuse.py b/plotly/validators/mesh3d/lighting/_diffuse.py deleted file mode 100644 index 45407531fc1..00000000000 --- a/plotly/validators/mesh3d/lighting/_diffuse.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class DiffuseValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='diffuse', parent_name='mesh3d.lighting', **kwargs - ): - super(DiffuseValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/lighting/_facenormalsepsilon.py b/plotly/validators/mesh3d/lighting/_facenormalsepsilon.py deleted file mode 100644 index 77ed53ab40e..00000000000 --- a/plotly/validators/mesh3d/lighting/_facenormalsepsilon.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class FacenormalsepsilonValidator( - _plotly_utils.basevalidators.NumberValidator -): - - def __init__( - self, - plotly_name='facenormalsepsilon', - parent_name='mesh3d.lighting', - **kwargs - ): - super(FacenormalsepsilonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/lighting/_fresnel.py b/plotly/validators/mesh3d/lighting/_fresnel.py deleted file mode 100644 index 5493e696e07..00000000000 --- a/plotly/validators/mesh3d/lighting/_fresnel.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FresnelValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='fresnel', parent_name='mesh3d.lighting', **kwargs - ): - super(FresnelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 5), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/lighting/_roughness.py b/plotly/validators/mesh3d/lighting/_roughness.py deleted file mode 100644 index 79e36fe7752..00000000000 --- a/plotly/validators/mesh3d/lighting/_roughness.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class RoughnessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='roughness', parent_name='mesh3d.lighting', **kwargs - ): - super(RoughnessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/lighting/_specular.py b/plotly/validators/mesh3d/lighting/_specular.py deleted file mode 100644 index 239c10ac614..00000000000 --- a/plotly/validators/mesh3d/lighting/_specular.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpecularValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='specular', parent_name='mesh3d.lighting', **kwargs - ): - super(SpecularValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 2), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/lighting/_vertexnormalsepsilon.py b/plotly/validators/mesh3d/lighting/_vertexnormalsepsilon.py deleted file mode 100644 index 1db0695a516..00000000000 --- a/plotly/validators/mesh3d/lighting/_vertexnormalsepsilon.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class VertexnormalsepsilonValidator( - _plotly_utils.basevalidators.NumberValidator -): - - def __init__( - self, - plotly_name='vertexnormalsepsilon', - parent_name='mesh3d.lighting', - **kwargs - ): - super(VertexnormalsepsilonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/lightposition/__init__.py b/plotly/validators/mesh3d/lightposition/__init__.py index 438e2dc9c6d..f0f684fd801 100644 --- a/plotly/validators/mesh3d/lightposition/__init__.py +++ b/plotly/validators/mesh3d/lightposition/__init__.py @@ -1,3 +1,57 @@ -from ._z import ZValidator -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='z', parent_name='mesh3d.lightposition', **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 100000), + min=kwargs.pop('min', -100000), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='mesh3d.lightposition', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 100000), + min=kwargs.pop('min', -100000), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='mesh3d.lightposition', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 100000), + min=kwargs.pop('min', -100000), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/mesh3d/lightposition/_x.py b/plotly/validators/mesh3d/lightposition/_x.py deleted file mode 100644 index c3573d1e837..00000000000 --- a/plotly/validators/mesh3d/lightposition/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='mesh3d.lightposition', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 100000), - min=kwargs.pop('min', -100000), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/lightposition/_y.py b/plotly/validators/mesh3d/lightposition/_y.py deleted file mode 100644 index e22d9b236d3..00000000000 --- a/plotly/validators/mesh3d/lightposition/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='mesh3d.lightposition', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 100000), - min=kwargs.pop('min', -100000), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/lightposition/_z.py b/plotly/validators/mesh3d/lightposition/_z.py deleted file mode 100644 index ff56372ed11..00000000000 --- a/plotly/validators/mesh3d/lightposition/_z.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='z', parent_name='mesh3d.lightposition', **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 100000), - min=kwargs.pop('min', -100000), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/stream/__init__.py b/plotly/validators/mesh3d/stream/__init__.py index 2f4f2047594..fffb83e48a0 100644 --- a/plotly/validators/mesh3d/stream/__init__.py +++ b/plotly/validators/mesh3d/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='mesh3d.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='mesh3d.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/mesh3d/stream/_maxpoints.py b/plotly/validators/mesh3d/stream/_maxpoints.py deleted file mode 100644 index 7f93399241f..00000000000 --- a/plotly/validators/mesh3d/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='mesh3d.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/mesh3d/stream/_token.py b/plotly/validators/mesh3d/stream/_token.py deleted file mode 100644 index 7acbac7c339..00000000000 --- a/plotly/validators/mesh3d/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='mesh3d.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/ohlc/__init__.py b/plotly/validators/ohlc/__init__.py index 67c3a742406..7ce96cb34f1 100644 --- a/plotly/validators/ohlc/__init__.py +++ b/plotly/validators/ohlc/__init__.py @@ -1,37 +1,659 @@ -from ._yaxis import YAxisValidator -from ._xsrc import XsrcValidator -from ._xcalendar import XcalendarValidator -from ._xaxis import XAxisValidator -from ._x import XValidator -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._tickwidth import TickwidthValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._opensrc import OpensrcValidator -from ._open import OpenValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._lowsrc import LowsrcValidator -from ._low import LowValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._increasing import IncreasingValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._highsrc import HighsrcValidator -from ._high import HighValidator -from ._decreasing import DecreasingValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._closesrc import ClosesrcValidator -from ._close import CloseValidator + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='yaxis', parent_name='ohlc', **kwargs): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='ohlc', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='xcalendar', parent_name='ohlc', **kwargs): + super(XcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='xaxis', parent_name='ohlc', **kwargs): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='ohlc', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='ohlc', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='uirevision', parent_name='ohlc', **kwargs): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='ohlc', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='tickwidth', parent_name='ohlc', **kwargs): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 0.5), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='textsrc', parent_name='ohlc', **kwargs): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='ohlc', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='ohlc', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='showlegend', parent_name='ohlc', **kwargs): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='ohlc', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpensrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='opensrc', parent_name='ohlc', **kwargs): + super(OpensrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpenValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='open', parent_name='ohlc', **kwargs): + super(OpenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='opacity', parent_name='ohlc', **kwargs): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='ohlc', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LowsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='lowsrc', parent_name='ohlc', **kwargs): + super(LowsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LowValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='low', parent_name='ohlc', **kwargs): + super(LowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='line', parent_name='ohlc', **kwargs): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + Note that this style setting can also be set + per direction via `increasing.line.dash` and + `decreasing.line.dash`. + width + [object Object] Note that this style setting + can also be set per direction via + `increasing.line.width` and + `decreasing.line.width`. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='ohlc', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IncreasingValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='increasing', parent_name='ohlc', **kwargs): + super(IncreasingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Increasing'), + data_docs=kwargs.pop( + 'data_docs', """ + line + plotly.graph_objs.ohlc.increasing.Line instance + or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='ohlc', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='ohlc', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='ohlc', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='hovertext', parent_name='ohlc', **kwargs): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='hoverlabel', parent_name='ohlc', **kwargs): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . + split + Show hover information (open, close, high, low) + in separate labels. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='ohlc', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__(self, plotly_name='hoverinfo', parent_name='ohlc', **kwargs): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HighsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='highsrc', parent_name='ohlc', **kwargs): + super(HighsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HighValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='high', parent_name='ohlc', **kwargs): + super(HighValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DecreasingValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='decreasing', parent_name='ohlc', **kwargs): + super(DecreasingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Decreasing'), + data_docs=kwargs.pop( + 'data_docs', """ + line + plotly.graph_objs.ohlc.decreasing.Line instance + or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='ohlc', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='customdata', parent_name='ohlc', **kwargs): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ClosesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='closesrc', parent_name='ohlc', **kwargs): + super(ClosesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CloseValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='close', parent_name='ohlc', **kwargs): + super(CloseValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/ohlc/_close.py b/plotly/validators/ohlc/_close.py deleted file mode 100644 index 36f778c08e9..00000000000 --- a/plotly/validators/ohlc/_close.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class CloseValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='close', parent_name='ohlc', **kwargs): - super(CloseValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_closesrc.py b/plotly/validators/ohlc/_closesrc.py deleted file mode 100644 index 7d192cb7910..00000000000 --- a/plotly/validators/ohlc/_closesrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ClosesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='closesrc', parent_name='ohlc', **kwargs): - super(ClosesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_customdata.py b/plotly/validators/ohlc/_customdata.py deleted file mode 100644 index 2c66c2a39f7..00000000000 --- a/plotly/validators/ohlc/_customdata.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='customdata', parent_name='ohlc', **kwargs): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_customdatasrc.py b/plotly/validators/ohlc/_customdatasrc.py deleted file mode 100644 index 2b9b5719255..00000000000 --- a/plotly/validators/ohlc/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='ohlc', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_decreasing.py b/plotly/validators/ohlc/_decreasing.py deleted file mode 100644 index ef1c5c99377..00000000000 --- a/plotly/validators/ohlc/_decreasing.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DecreasingValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='decreasing', parent_name='ohlc', **kwargs): - super(DecreasingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Decreasing'), - data_docs=kwargs.pop( - 'data_docs', """ - line - plotly.graph_objs.ohlc.decreasing.Line instance - or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/ohlc/_high.py b/plotly/validators/ohlc/_high.py deleted file mode 100644 index f2457218a74..00000000000 --- a/plotly/validators/ohlc/_high.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class HighValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='high', parent_name='ohlc', **kwargs): - super(HighValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_highsrc.py b/plotly/validators/ohlc/_highsrc.py deleted file mode 100644 index 6f43d6d915c..00000000000 --- a/plotly/validators/ohlc/_highsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class HighsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='highsrc', parent_name='ohlc', **kwargs): - super(HighsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_hoverinfo.py b/plotly/validators/ohlc/_hoverinfo.py deleted file mode 100644 index a09b4829521..00000000000 --- a/plotly/validators/ohlc/_hoverinfo.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__(self, plotly_name='hoverinfo', parent_name='ohlc', **kwargs): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_hoverinfosrc.py b/plotly/validators/ohlc/_hoverinfosrc.py deleted file mode 100644 index 3b05a7dabf8..00000000000 --- a/plotly/validators/ohlc/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='ohlc', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_hoverlabel.py b/plotly/validators/ohlc/_hoverlabel.py deleted file mode 100644 index 277945ce6d2..00000000000 --- a/plotly/validators/ohlc/_hoverlabel.py +++ /dev/null @@ -1,45 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='hoverlabel', parent_name='ohlc', **kwargs): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . - split - Show hover information (open, close, high, low) - in separate labels. -""" - ), - **kwargs - ) diff --git a/plotly/validators/ohlc/_hovertext.py b/plotly/validators/ohlc/_hovertext.py deleted file mode 100644 index 6c0ab331c23..00000000000 --- a/plotly/validators/ohlc/_hovertext.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='hovertext', parent_name='ohlc', **kwargs): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_hovertextsrc.py b/plotly/validators/ohlc/_hovertextsrc.py deleted file mode 100644 index eab2903abaa..00000000000 --- a/plotly/validators/ohlc/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='ohlc', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_ids.py b/plotly/validators/ohlc/_ids.py deleted file mode 100644 index 1edd5f23de6..00000000000 --- a/plotly/validators/ohlc/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='ohlc', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_idssrc.py b/plotly/validators/ohlc/_idssrc.py deleted file mode 100644 index ca70bd08601..00000000000 --- a/plotly/validators/ohlc/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='ohlc', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_increasing.py b/plotly/validators/ohlc/_increasing.py deleted file mode 100644 index ef13cb44184..00000000000 --- a/plotly/validators/ohlc/_increasing.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class IncreasingValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='increasing', parent_name='ohlc', **kwargs): - super(IncreasingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Increasing'), - data_docs=kwargs.pop( - 'data_docs', """ - line - plotly.graph_objs.ohlc.increasing.Line instance - or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/ohlc/_legendgroup.py b/plotly/validators/ohlc/_legendgroup.py deleted file mode 100644 index 5d480981b54..00000000000 --- a/plotly/validators/ohlc/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='ohlc', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_line.py b/plotly/validators/ohlc/_line.py deleted file mode 100644 index e4d122f4abb..00000000000 --- a/plotly/validators/ohlc/_line.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='line', parent_name='ohlc', **kwargs): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - Note that this style setting can also be set - per direction via `increasing.line.dash` and - `decreasing.line.dash`. - width - [object Object] Note that this style setting - can also be set per direction via - `increasing.line.width` and - `decreasing.line.width`. -""" - ), - **kwargs - ) diff --git a/plotly/validators/ohlc/_low.py b/plotly/validators/ohlc/_low.py deleted file mode 100644 index a0ca915e2d7..00000000000 --- a/plotly/validators/ohlc/_low.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class LowValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='low', parent_name='ohlc', **kwargs): - super(LowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_lowsrc.py b/plotly/validators/ohlc/_lowsrc.py deleted file mode 100644 index 7bdd508ded3..00000000000 --- a/plotly/validators/ohlc/_lowsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class LowsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='lowsrc', parent_name='ohlc', **kwargs): - super(LowsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_name.py b/plotly/validators/ohlc/_name.py deleted file mode 100644 index 0233cfbd147..00000000000 --- a/plotly/validators/ohlc/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='ohlc', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_opacity.py b/plotly/validators/ohlc/_opacity.py deleted file mode 100644 index 892f7050105..00000000000 --- a/plotly/validators/ohlc/_opacity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='opacity', parent_name='ohlc', **kwargs): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_open.py b/plotly/validators/ohlc/_open.py deleted file mode 100644 index 2c6dbea78da..00000000000 --- a/plotly/validators/ohlc/_open.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpenValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='open', parent_name='ohlc', **kwargs): - super(OpenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_opensrc.py b/plotly/validators/ohlc/_opensrc.py deleted file mode 100644 index 45e552d9a1e..00000000000 --- a/plotly/validators/ohlc/_opensrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpensrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='opensrc', parent_name='ohlc', **kwargs): - super(OpensrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_selectedpoints.py b/plotly/validators/ohlc/_selectedpoints.py deleted file mode 100644 index c7d558782f4..00000000000 --- a/plotly/validators/ohlc/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='ohlc', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_showlegend.py b/plotly/validators/ohlc/_showlegend.py deleted file mode 100644 index ae2b251d3af..00000000000 --- a/plotly/validators/ohlc/_showlegend.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='showlegend', parent_name='ohlc', **kwargs): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_stream.py b/plotly/validators/ohlc/_stream.py deleted file mode 100644 index 220fefb9231..00000000000 --- a/plotly/validators/ohlc/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='ohlc', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/ohlc/_text.py b/plotly/validators/ohlc/_text.py deleted file mode 100644 index 98c4c3f4337..00000000000 --- a/plotly/validators/ohlc/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='ohlc', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_textsrc.py b/plotly/validators/ohlc/_textsrc.py deleted file mode 100644 index d81964b3c36..00000000000 --- a/plotly/validators/ohlc/_textsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='textsrc', parent_name='ohlc', **kwargs): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_tickwidth.py b/plotly/validators/ohlc/_tickwidth.py deleted file mode 100644 index 0ee2f2d9267..00000000000 --- a/plotly/validators/ohlc/_tickwidth.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='tickwidth', parent_name='ohlc', **kwargs): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 0.5), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_uid.py b/plotly/validators/ohlc/_uid.py deleted file mode 100644 index baf74d59729..00000000000 --- a/plotly/validators/ohlc/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='ohlc', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_uirevision.py b/plotly/validators/ohlc/_uirevision.py deleted file mode 100644 index 5b5fa82fdaa..00000000000 --- a/plotly/validators/ohlc/_uirevision.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='uirevision', parent_name='ohlc', **kwargs): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_visible.py b/plotly/validators/ohlc/_visible.py deleted file mode 100644 index 46a164319a3..00000000000 --- a/plotly/validators/ohlc/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='ohlc', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/ohlc/_x.py b/plotly/validators/ohlc/_x.py deleted file mode 100644 index e6fe30c9b6e..00000000000 --- a/plotly/validators/ohlc/_x.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='ohlc', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_xaxis.py b/plotly/validators/ohlc/_xaxis.py deleted file mode 100644 index 8c78f8d59b1..00000000000 --- a/plotly/validators/ohlc/_xaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='xaxis', parent_name='ohlc', **kwargs): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_xcalendar.py b/plotly/validators/ohlc/_xcalendar.py deleted file mode 100644 index 8bfd0e3f859..00000000000 --- a/plotly/validators/ohlc/_xcalendar.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='xcalendar', parent_name='ohlc', **kwargs): - super(XcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/ohlc/_xsrc.py b/plotly/validators/ohlc/_xsrc.py deleted file mode 100644 index d15e1f1337f..00000000000 --- a/plotly/validators/ohlc/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='ohlc', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/_yaxis.py b/plotly/validators/ohlc/_yaxis.py deleted file mode 100644 index 69c25219f93..00000000000 --- a/plotly/validators/ohlc/_yaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='yaxis', parent_name='ohlc', **kwargs): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/decreasing/__init__.py b/plotly/validators/ohlc/decreasing/__init__.py index 180bd6ac8ad..4b774732cae 100644 --- a/plotly/validators/ohlc/decreasing/__init__.py +++ b/plotly/validators/ohlc/decreasing/__init__.py @@ -1 +1,29 @@ -from ._line import LineValidator + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='ohlc.decreasing', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + width + Sets the line width (in px). +""" + ), + **kwargs + ) diff --git a/plotly/validators/ohlc/decreasing/_line.py b/plotly/validators/ohlc/decreasing/_line.py deleted file mode 100644 index 0237b3c9ecf..00000000000 --- a/plotly/validators/ohlc/decreasing/_line.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='ohlc.decreasing', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - width - Sets the line width (in px). -""" - ), - **kwargs - ) diff --git a/plotly/validators/ohlc/decreasing/line/__init__.py b/plotly/validators/ohlc/decreasing/line/__init__.py index d027d05e065..99ecc1fcafd 100644 --- a/plotly/validators/ohlc/decreasing/line/__init__.py +++ b/plotly/validators/ohlc/decreasing/line/__init__.py @@ -1,3 +1,64 @@ -from ._width import WidthValidator -from ._dash import DashValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='ohlc.decreasing.line', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashValidator(_plotly_utils.basevalidators.DashValidator): + + def __init__( + self, plotly_name='dash', parent_name='ohlc.decreasing.line', **kwargs + ): + super(DashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='ohlc.decreasing.line', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/ohlc/decreasing/line/_color.py b/plotly/validators/ohlc/decreasing/line/_color.py deleted file mode 100644 index f8d0d1fbf20..00000000000 --- a/plotly/validators/ohlc/decreasing/line/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='ohlc.decreasing.line', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/ohlc/decreasing/line/_dash.py b/plotly/validators/ohlc/decreasing/line/_dash.py deleted file mode 100644 index 3291318f937..00000000000 --- a/plotly/validators/ohlc/decreasing/line/_dash.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashValidator(_plotly_utils.basevalidators.DashValidator): - - def __init__( - self, plotly_name='dash', parent_name='ohlc.decreasing.line', **kwargs - ): - super(DashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/ohlc/decreasing/line/_width.py b/plotly/validators/ohlc/decreasing/line/_width.py deleted file mode 100644 index 5bdfac13fc8..00000000000 --- a/plotly/validators/ohlc/decreasing/line/_width.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='ohlc.decreasing.line', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/ohlc/hoverlabel/__init__.py b/plotly/validators/ohlc/hoverlabel/__init__.py index 437d45e8685..d6f38b14a1b 100644 --- a/plotly/validators/ohlc/hoverlabel/__init__.py +++ b/plotly/validators/ohlc/hoverlabel/__init__.py @@ -1,8 +1,187 @@ -from ._split import SplitValidator -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class SplitValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='split', parent_name='ohlc.hoverlabel', **kwargs + ): + super(SplitValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='ohlc.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='ohlc.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='ohlc.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='ohlc.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='ohlc.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='ohlc.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='ohlc.hoverlabel', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/ohlc/hoverlabel/_bgcolor.py b/plotly/validators/ohlc/hoverlabel/_bgcolor.py deleted file mode 100644 index eb82a64b715..00000000000 --- a/plotly/validators/ohlc/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='ohlc.hoverlabel', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/ohlc/hoverlabel/_bgcolorsrc.py b/plotly/validators/ohlc/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 734dc9bb0b7..00000000000 --- a/plotly/validators/ohlc/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='ohlc.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/hoverlabel/_bordercolor.py b/plotly/validators/ohlc/hoverlabel/_bordercolor.py deleted file mode 100644 index d8fd83a1d4d..00000000000 --- a/plotly/validators/ohlc/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='ohlc.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/ohlc/hoverlabel/_bordercolorsrc.py b/plotly/validators/ohlc/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index f0fb598c980..00000000000 --- a/plotly/validators/ohlc/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='ohlc.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/hoverlabel/_font.py b/plotly/validators/ohlc/hoverlabel/_font.py deleted file mode 100644 index 1828cf8985e..00000000000 --- a/plotly/validators/ohlc/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='ohlc.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/ohlc/hoverlabel/_namelength.py b/plotly/validators/ohlc/hoverlabel/_namelength.py deleted file mode 100644 index df589f695f2..00000000000 --- a/plotly/validators/ohlc/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='ohlc.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/ohlc/hoverlabel/_namelengthsrc.py b/plotly/validators/ohlc/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 713c6d97fd0..00000000000 --- a/plotly/validators/ohlc/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='ohlc.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/hoverlabel/_split.py b/plotly/validators/ohlc/hoverlabel/_split.py deleted file mode 100644 index 7b24d6579a3..00000000000 --- a/plotly/validators/ohlc/hoverlabel/_split.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SplitValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='split', parent_name='ohlc.hoverlabel', **kwargs - ): - super(SplitValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/hoverlabel/font/__init__.py b/plotly/validators/ohlc/hoverlabel/font/__init__.py index 1d2c591d1e5..c9bc7ccf012 100644 --- a/plotly/validators/ohlc/hoverlabel/font/__init__.py +++ b/plotly/validators/ohlc/hoverlabel/font/__init__.py @@ -1,6 +1,123 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='ohlc.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='ohlc.hoverlabel.font', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='ohlc.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='ohlc.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='ohlc.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='ohlc.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/ohlc/hoverlabel/font/_color.py b/plotly/validators/ohlc/hoverlabel/font/_color.py deleted file mode 100644 index 36ba783c87f..00000000000 --- a/plotly/validators/ohlc/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='ohlc.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/ohlc/hoverlabel/font/_colorsrc.py b/plotly/validators/ohlc/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 9ccd8f5c4c4..00000000000 --- a/plotly/validators/ohlc/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='ohlc.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/hoverlabel/font/_family.py b/plotly/validators/ohlc/hoverlabel/font/_family.py deleted file mode 100644 index 1ab8e5654db..00000000000 --- a/plotly/validators/ohlc/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='ohlc.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/ohlc/hoverlabel/font/_familysrc.py b/plotly/validators/ohlc/hoverlabel/font/_familysrc.py deleted file mode 100644 index fef950d3f0f..00000000000 --- a/plotly/validators/ohlc/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='ohlc.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/hoverlabel/font/_size.py b/plotly/validators/ohlc/hoverlabel/font/_size.py deleted file mode 100644 index 0675601f54b..00000000000 --- a/plotly/validators/ohlc/hoverlabel/font/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='ohlc.hoverlabel.font', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/ohlc/hoverlabel/font/_sizesrc.py b/plotly/validators/ohlc/hoverlabel/font/_sizesrc.py deleted file mode 100644 index c0867345c4e..00000000000 --- a/plotly/validators/ohlc/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='ohlc.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/increasing/__init__.py b/plotly/validators/ohlc/increasing/__init__.py index 180bd6ac8ad..0464b08c7a0 100644 --- a/plotly/validators/ohlc/increasing/__init__.py +++ b/plotly/validators/ohlc/increasing/__init__.py @@ -1 +1,29 @@ -from ._line import LineValidator + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='ohlc.increasing', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + width + Sets the line width (in px). +""" + ), + **kwargs + ) diff --git a/plotly/validators/ohlc/increasing/_line.py b/plotly/validators/ohlc/increasing/_line.py deleted file mode 100644 index dd548e7e4ae..00000000000 --- a/plotly/validators/ohlc/increasing/_line.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='ohlc.increasing', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - width - Sets the line width (in px). -""" - ), - **kwargs - ) diff --git a/plotly/validators/ohlc/increasing/line/__init__.py b/plotly/validators/ohlc/increasing/line/__init__.py index d027d05e065..5ed28fb000f 100644 --- a/plotly/validators/ohlc/increasing/line/__init__.py +++ b/plotly/validators/ohlc/increasing/line/__init__.py @@ -1,3 +1,64 @@ -from ._width import WidthValidator -from ._dash import DashValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='ohlc.increasing.line', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashValidator(_plotly_utils.basevalidators.DashValidator): + + def __init__( + self, plotly_name='dash', parent_name='ohlc.increasing.line', **kwargs + ): + super(DashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='ohlc.increasing.line', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/ohlc/increasing/line/_color.py b/plotly/validators/ohlc/increasing/line/_color.py deleted file mode 100644 index 0603f3fb76f..00000000000 --- a/plotly/validators/ohlc/increasing/line/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='ohlc.increasing.line', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/ohlc/increasing/line/_dash.py b/plotly/validators/ohlc/increasing/line/_dash.py deleted file mode 100644 index faeccb3a9e4..00000000000 --- a/plotly/validators/ohlc/increasing/line/_dash.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashValidator(_plotly_utils.basevalidators.DashValidator): - - def __init__( - self, plotly_name='dash', parent_name='ohlc.increasing.line', **kwargs - ): - super(DashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/ohlc/increasing/line/_width.py b/plotly/validators/ohlc/increasing/line/_width.py deleted file mode 100644 index f05de70c066..00000000000 --- a/plotly/validators/ohlc/increasing/line/_width.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='ohlc.increasing.line', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/ohlc/line/__init__.py b/plotly/validators/ohlc/line/__init__.py index eb6697b755a..d1ac44ee730 100644 --- a/plotly/validators/ohlc/line/__init__.py +++ b/plotly/validators/ohlc/line/__init__.py @@ -1,2 +1,36 @@ -from ._width import WidthValidator -from ._dash import DashValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='width', parent_name='ohlc.line', **kwargs): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashValidator(_plotly_utils.basevalidators.DashValidator): + + def __init__(self, plotly_name='dash', parent_name='ohlc.line', **kwargs): + super(DashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) diff --git a/plotly/validators/ohlc/line/_dash.py b/plotly/validators/ohlc/line/_dash.py deleted file mode 100644 index 604c4ea783c..00000000000 --- a/plotly/validators/ohlc/line/_dash.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashValidator(_plotly_utils.basevalidators.DashValidator): - - def __init__(self, plotly_name='dash', parent_name='ohlc.line', **kwargs): - super(DashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/ohlc/line/_width.py b/plotly/validators/ohlc/line/_width.py deleted file mode 100644 index 4c11d67274e..00000000000 --- a/plotly/validators/ohlc/line/_width.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='width', parent_name='ohlc.line', **kwargs): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/ohlc/stream/__init__.py b/plotly/validators/ohlc/stream/__init__.py index 2f4f2047594..2e0ebbcc6db 100644 --- a/plotly/validators/ohlc/stream/__init__.py +++ b/plotly/validators/ohlc/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='ohlc.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='ohlc.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/ohlc/stream/_maxpoints.py b/plotly/validators/ohlc/stream/_maxpoints.py deleted file mode 100644 index e31c0ece464..00000000000 --- a/plotly/validators/ohlc/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='ohlc.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/ohlc/stream/_token.py b/plotly/validators/ohlc/stream/_token.py deleted file mode 100644 index 3c6d475c898..00000000000 --- a/plotly/validators/ohlc/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='ohlc.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/parcats/__init__.py b/plotly/validators/parcats/__init__.py index 2b5b7a47a7c..a9312014343 100644 --- a/plotly/validators/parcats/__init__.py +++ b/plotly/validators/parcats/__init__.py @@ -1,19 +1,550 @@ -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._tickfont import TickfontValidator -from ._stream import StreamValidator -from ._sortpaths import SortpathsValidator -from ._name import NameValidator -from ._line import LineValidator -from ._labelfont import LabelfontValidator -from ._hovertemplate import HovertemplateValidator -from ._hoveron import HoveronValidator -from ._hoverinfo import HoverinfoValidator -from ._domain import DomainValidator -from ._dimensiondefaults import DimensionValidator -from ._dimensions import DimensionsValidator -from ._countssrc import CountssrcValidator -from ._counts import CountsValidator -from ._bundlecolors import BundlecolorsValidator -from ._arrangement import ArrangementValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='parcats', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='parcats', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='parcats', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='tickfont', parent_name='parcats', **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='parcats', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SortpathsValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='sortpaths', parent_name='parcats', **kwargs + ): + super(SortpathsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['forward', 'backward']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='parcats', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='line', parent_name='parcats', **kwargs): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `line.colorscale`. Has an effect + only if in `line.color`is set to a numerical + array. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette + will be chosen according to whether numbers in + the `color` array are all positive, all + negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `line.color`) or the bounds set in + `line.cmin` and `line.cmax` Has an effect only + if in `line.color`is set to a numerical array. + Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `line.color`is set to a + numerical array. Value should have the same + units as in `line.color` and if set, + `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `line.cmin` and/or `line.cmax` to be + equidistant to this point. Has an effect only + if in `line.color`is set to a numerical array. + Value should have the same units as in + `line.color`. Has no effect when `line.cauto` + is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `line.color`is set to a + numerical array. Value should have the same + units as in `line.color` and if set, + `line.cmax` must be set as well. + color + Sets thelinecolor. It accepts either a specific + color or an array of numbers that are mapped to + the colorscale relative to the max and min + values of the array or relative to `line.cmin` + and `line.cmax` if set. + colorbar + plotly.graph_objs.parcats.line.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `line.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`line.cmin` and `line.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + variables `count` and `probability`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". + reversescale + Reverses the color mapping if true. Has an + effect only if in `line.color`is set to a + numerical array. If true, `line.cmin` will + correspond to the last color in the array and + `line.cmax` will correspond to the first color. + shape + Sets the shape of the paths. If `linear`, paths + are composed of straight lines. If `hspline`, + paths are composed of horizontal curved splines + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `line.color`is set to a numerical array. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='labelfont', parent_name='parcats', **kwargs + ): + super(LabelfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Labelfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='parcats', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoveronValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='hoveron', parent_name='parcats', **kwargs): + super(HoveronValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['category', 'color', 'dimension']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='parcats', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'plot'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['count', 'probability']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='domain', parent_name='parcats', **kwargs): + super(DomainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Domain'), + data_docs=kwargs.pop( + 'data_docs', """ + column + If there is a layout grid, use the domain for + this column in the grid for this parcats trace + . + row + If there is a layout grid, use the domain for + this row in the grid for this parcats trace . + x + Sets the horizontal domain of this parcats + trace (in plot fraction). + y + Sets the vertical domain of this parcats trace + (in plot fraction). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DimensionValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='dimensiondefaults', parent_name='parcats', **kwargs + ): + super(DimensionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Dimension'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DimensionsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, plotly_name='dimensions', parent_name='parcats', **kwargs + ): + super(DimensionsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Dimension'), + data_docs=kwargs.pop( + 'data_docs', """ + categoryarray + Sets the order in which categories in this + dimension appear. Only has an effect if + `categoryorder` is set to "array". Used with + `categoryorder`. + categoryarraysrc + Sets the source reference on plot.ly for + categoryarray . + categoryorder + Specifies the ordering logic for the categories + in the dimension. By default, plotly uses + "trace", which specifies the order that is + present in the data supplied. Set + `categoryorder` to *category ascending* or + *category descending* if order should be + determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" + to derive the ordering from the attribute + `categoryarray`. If a category is not found in + the `categoryarray` array, the sorting behavior + for that attribute will be identical to the + "trace" mode. The unspecified categories will + follow the categories in `categoryarray`. + displayindex + The display index of dimension, from left to + right, zero indexed, defaults to dimension + index. + label + The shown name of the dimension. + ticktext + Sets alternative tick labels for the categories + in this dimension. Only has an effect if + `categoryorder` is set to "array". Should be an + array the same length as `categoryarray` Used + with `categoryorder`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + values + Dimension values. `values[n]` represents the + category value of the `n`th point in the + dataset, therefore the `values` vector for all + dimensions must be the same (longer vectors + will be truncated). + valuessrc + Sets the source reference on plot.ly for + values . + visible + Shows the dimension when set to `true` (the + default). Hides the dimension for `false`. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CountssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='countssrc', parent_name='parcats', **kwargs + ): + super(CountssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CountsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='counts', parent_name='parcats', **kwargs): + super(CountsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BundlecolorsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='bundlecolors', parent_name='parcats', **kwargs + ): + super(BundlecolorsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrangementValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='arrangement', parent_name='parcats', **kwargs + ): + super(ArrangementValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['perpendicular', 'freeform', 'fixed'] + ), + **kwargs + ) diff --git a/plotly/validators/parcats/_arrangement.py b/plotly/validators/parcats/_arrangement.py deleted file mode 100644 index 305b3d4ef9b..00000000000 --- a/plotly/validators/parcats/_arrangement.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrangementValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='arrangement', parent_name='parcats', **kwargs - ): - super(ArrangementValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['perpendicular', 'freeform', 'fixed'] - ), - **kwargs - ) diff --git a/plotly/validators/parcats/_bundlecolors.py b/plotly/validators/parcats/_bundlecolors.py deleted file mode 100644 index 23f870e9f00..00000000000 --- a/plotly/validators/parcats/_bundlecolors.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BundlecolorsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='bundlecolors', parent_name='parcats', **kwargs - ): - super(BundlecolorsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/_counts.py b/plotly/validators/parcats/_counts.py deleted file mode 100644 index bf7ab7b6446..00000000000 --- a/plotly/validators/parcats/_counts.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CountsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='counts', parent_name='parcats', **kwargs): - super(CountsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/_countssrc.py b/plotly/validators/parcats/_countssrc.py deleted file mode 100644 index c1b63193398..00000000000 --- a/plotly/validators/parcats/_countssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CountssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='countssrc', parent_name='parcats', **kwargs - ): - super(CountssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/_dimensiondefaults.py b/plotly/validators/parcats/_dimensiondefaults.py deleted file mode 100644 index 12f0dfaf108..00000000000 --- a/plotly/validators/parcats/_dimensiondefaults.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DimensionValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='dimensiondefaults', parent_name='parcats', **kwargs - ): - super(DimensionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Dimension'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/parcats/_dimensions.py b/plotly/validators/parcats/_dimensions.py deleted file mode 100644 index 710922d522e..00000000000 --- a/plotly/validators/parcats/_dimensions.py +++ /dev/null @@ -1,68 +0,0 @@ -import _plotly_utils.basevalidators - - -class DimensionsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, plotly_name='dimensions', parent_name='parcats', **kwargs - ): - super(DimensionsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Dimension'), - data_docs=kwargs.pop( - 'data_docs', """ - categoryarray - Sets the order in which categories in this - dimension appear. Only has an effect if - `categoryorder` is set to "array". Used with - `categoryorder`. - categoryarraysrc - Sets the source reference on plot.ly for - categoryarray . - categoryorder - Specifies the ordering logic for the categories - in the dimension. By default, plotly uses - "trace", which specifies the order that is - present in the data supplied. Set - `categoryorder` to *category ascending* or - *category descending* if order should be - determined by the alphanumerical order of the - category names. Set `categoryorder` to "array" - to derive the ordering from the attribute - `categoryarray`. If a category is not found in - the `categoryarray` array, the sorting behavior - for that attribute will be identical to the - "trace" mode. The unspecified categories will - follow the categories in `categoryarray`. - displayindex - The display index of dimension, from left to - right, zero indexed, defaults to dimension - index. - label - The shown name of the dimension. - ticktext - Sets alternative tick labels for the categories - in this dimension. Only has an effect if - `categoryorder` is set to "array". Should be an - array the same length as `categoryarray` Used - with `categoryorder`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - values - Dimension values. `values[n]` represents the - category value of the `n`th point in the - dataset, therefore the `values` vector for all - dimensions must be the same (longer vectors - will be truncated). - valuessrc - Sets the source reference on plot.ly for - values . - visible - Shows the dimension when set to `true` (the - default). Hides the dimension for `false`. -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcats/_domain.py b/plotly/validators/parcats/_domain.py deleted file mode 100644 index 28b3971251b..00000000000 --- a/plotly/validators/parcats/_domain.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='domain', parent_name='parcats', **kwargs): - super(DomainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Domain'), - data_docs=kwargs.pop( - 'data_docs', """ - column - If there is a layout grid, use the domain for - this column in the grid for this parcats trace - . - row - If there is a layout grid, use the domain for - this row in the grid for this parcats trace . - x - Sets the horizontal domain of this parcats - trace (in plot fraction). - y - Sets the vertical domain of this parcats trace - (in plot fraction). -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcats/_hoverinfo.py b/plotly/validators/parcats/_hoverinfo.py deleted file mode 100644 index e783e459ec3..00000000000 --- a/plotly/validators/parcats/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='parcats', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'plot'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['count', 'probability']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/_hoveron.py b/plotly/validators/parcats/_hoveron.py deleted file mode 100644 index 1323d4b9cf2..00000000000 --- a/plotly/validators/parcats/_hoveron.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoveronValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='hoveron', parent_name='parcats', **kwargs): - super(HoveronValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['category', 'color', 'dimension']), - **kwargs - ) diff --git a/plotly/validators/parcats/_hovertemplate.py b/plotly/validators/parcats/_hovertemplate.py deleted file mode 100644 index ff0c833fe78..00000000000 --- a/plotly/validators/parcats/_hovertemplate.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='parcats', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/_labelfont.py b/plotly/validators/parcats/_labelfont.py deleted file mode 100644 index 94ce262bf55..00000000000 --- a/plotly/validators/parcats/_labelfont.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='labelfont', parent_name='parcats', **kwargs - ): - super(LabelfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Labelfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcats/_line.py b/plotly/validators/parcats/_line.py deleted file mode 100644 index 909fb386d1b..00000000000 --- a/plotly/validators/parcats/_line.py +++ /dev/null @@ -1,116 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='line', parent_name='parcats', **kwargs): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `line.colorscale`. Has an effect - only if in `line.color`is set to a numerical - array. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette - will be chosen according to whether numbers in - the `color` array are all positive, all - negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `line.color`) or the bounds set in - `line.cmin` and `line.cmax` Has an effect only - if in `line.color`is set to a numerical array. - Defaults to `false` when `line.cmin` and - `line.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `line.color`is set to a - numerical array. Value should have the same - units as in `line.color` and if set, - `line.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `line.cmin` and/or `line.cmax` to be - equidistant to this point. Has an effect only - if in `line.color`is set to a numerical array. - Value should have the same units as in - `line.color`. Has no effect when `line.cauto` - is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `line.color`is set to a - numerical array. Value should have the same - units as in `line.color` and if set, - `line.cmax` must be set as well. - color - Sets thelinecolor. It accepts either a specific - color or an array of numbers that are mapped to - the colorscale relative to the max and min - values of the array or relative to `line.cmin` - and `line.cmax` if set. - colorbar - plotly.graph_objs.parcats.line.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `line.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`line.cmin` and `line.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - variables `count` and `probability`. Anything - contained in tag `` is displayed in the - secondary box, for example - "{fullData.name}". - reversescale - Reverses the color mapping if true. Has an - effect only if in `line.color`is set to a - numerical array. If true, `line.cmin` will - correspond to the last color in the array and - `line.cmax` will correspond to the first color. - shape - Sets the shape of the paths. If `linear`, paths - are composed of straight lines. If `hspline`, - paths are composed of horizontal curved splines - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `line.color`is set to a numerical array. -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcats/_name.py b/plotly/validators/parcats/_name.py deleted file mode 100644 index 5360bb6ca70..00000000000 --- a/plotly/validators/parcats/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='parcats', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/_sortpaths.py b/plotly/validators/parcats/_sortpaths.py deleted file mode 100644 index 8496fbcf219..00000000000 --- a/plotly/validators/parcats/_sortpaths.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SortpathsValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='sortpaths', parent_name='parcats', **kwargs - ): - super(SortpathsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['forward', 'backward']), - **kwargs - ) diff --git a/plotly/validators/parcats/_stream.py b/plotly/validators/parcats/_stream.py deleted file mode 100644 index 87c7a3cb7e4..00000000000 --- a/plotly/validators/parcats/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='parcats', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcats/_tickfont.py b/plotly/validators/parcats/_tickfont.py deleted file mode 100644 index 98a1ef2ed48..00000000000 --- a/plotly/validators/parcats/_tickfont.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='tickfont', parent_name='parcats', **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcats/_uid.py b/plotly/validators/parcats/_uid.py deleted file mode 100644 index 02108c52e28..00000000000 --- a/plotly/validators/parcats/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='parcats', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/_uirevision.py b/plotly/validators/parcats/_uirevision.py deleted file mode 100644 index a2e97fb627c..00000000000 --- a/plotly/validators/parcats/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='parcats', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/_visible.py b/plotly/validators/parcats/_visible.py deleted file mode 100644 index 79a8b610278..00000000000 --- a/plotly/validators/parcats/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='parcats', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/parcats/dimension/__init__.py b/plotly/validators/parcats/dimension/__init__.py index 57b6e6c9c67..d995c6a2da9 100644 --- a/plotly/validators/parcats/dimension/__init__.py +++ b/plotly/validators/parcats/dimension/__init__.py @@ -1,10 +1,197 @@ -from ._visible import VisibleValidator -from ._valuessrc import ValuessrcValidator -from ._values import ValuesValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._label import LabelValidator -from ._displayindex import DisplayindexValidator -from ._categoryorder import CategoryorderValidator -from ._categoryarraysrc import CategoryarraysrcValidator -from ._categoryarray import CategoryarrayValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='parcats.dimension', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValuessrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='valuessrc', + parent_name='parcats.dimension', + **kwargs + ): + super(ValuessrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValuesValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='values', parent_name='parcats.dimension', **kwargs + ): + super(ValuesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='parcats.dimension', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='parcats.dimension', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='label', parent_name='parcats.dimension', **kwargs + ): + super(LabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DisplayindexValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='displayindex', + parent_name='parcats.dimension', + **kwargs + ): + super(DisplayindexValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='categoryorder', + parent_name='parcats.dimension', + **kwargs + ): + super(CategoryorderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'trace', 'category ascending', 'category descending', + 'array' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='categoryarraysrc', + parent_name='parcats.dimension', + **kwargs + ): + super(CategoryarraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='categoryarray', + parent_name='parcats.dimension', + **kwargs + ): + super(CategoryarrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/parcats/dimension/_categoryarray.py b/plotly/validators/parcats/dimension/_categoryarray.py deleted file mode 100644 index 3552819bfac..00000000000 --- a/plotly/validators/parcats/dimension/_categoryarray.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='categoryarray', - parent_name='parcats.dimension', - **kwargs - ): - super(CategoryarrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/parcats/dimension/_categoryarraysrc.py b/plotly/validators/parcats/dimension/_categoryarraysrc.py deleted file mode 100644 index 8e4f01efc86..00000000000 --- a/plotly/validators/parcats/dimension/_categoryarraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryarraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='categoryarraysrc', - parent_name='parcats.dimension', - **kwargs - ): - super(CategoryarraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/dimension/_categoryorder.py b/plotly/validators/parcats/dimension/_categoryorder.py deleted file mode 100644 index ff7c36fddd7..00000000000 --- a/plotly/validators/parcats/dimension/_categoryorder.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class CategoryorderValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='categoryorder', - parent_name='parcats.dimension', - **kwargs - ): - super(CategoryorderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'trace', 'category ascending', 'category descending', - 'array' - ] - ), - **kwargs - ) diff --git a/plotly/validators/parcats/dimension/_displayindex.py b/plotly/validators/parcats/dimension/_displayindex.py deleted file mode 100644 index b755cdf31f4..00000000000 --- a/plotly/validators/parcats/dimension/_displayindex.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class DisplayindexValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='displayindex', - parent_name='parcats.dimension', - **kwargs - ): - super(DisplayindexValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/dimension/_label.py b/plotly/validators/parcats/dimension/_label.py deleted file mode 100644 index c141bde31e3..00000000000 --- a/plotly/validators/parcats/dimension/_label.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='label', parent_name='parcats.dimension', **kwargs - ): - super(LabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/dimension/_ticktext.py b/plotly/validators/parcats/dimension/_ticktext.py deleted file mode 100644 index 0a76d71e5a8..00000000000 --- a/plotly/validators/parcats/dimension/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='parcats.dimension', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/parcats/dimension/_ticktextsrc.py b/plotly/validators/parcats/dimension/_ticktextsrc.py deleted file mode 100644 index e393be1bb6f..00000000000 --- a/plotly/validators/parcats/dimension/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='parcats.dimension', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/dimension/_values.py b/plotly/validators/parcats/dimension/_values.py deleted file mode 100644 index 410f19cf78d..00000000000 --- a/plotly/validators/parcats/dimension/_values.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValuesValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='values', parent_name='parcats.dimension', **kwargs - ): - super(ValuesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/parcats/dimension/_valuessrc.py b/plotly/validators/parcats/dimension/_valuessrc.py deleted file mode 100644 index 689d82c3567..00000000000 --- a/plotly/validators/parcats/dimension/_valuessrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValuessrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='valuessrc', - parent_name='parcats.dimension', - **kwargs - ): - super(ValuessrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/dimension/_visible.py b/plotly/validators/parcats/dimension/_visible.py deleted file mode 100644 index 3cf95477a57..00000000000 --- a/plotly/validators/parcats/dimension/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='parcats.dimension', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/domain/__init__.py b/plotly/validators/parcats/domain/__init__.py index 6cf32248236..85df7d78466 100644 --- a/plotly/validators/parcats/domain/__init__.py +++ b/plotly/validators/parcats/domain/__init__.py @@ -1,4 +1,102 @@ -from ._y import YValidator -from ._x import XValidator -from ._row import RowValidator -from ._column import ColumnValidator + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='y', parent_name='parcats.domain', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='x', parent_name='parcats.domain', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RowValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='row', parent_name='parcats.domain', **kwargs + ): + super(RowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='column', parent_name='parcats.domain', **kwargs + ): + super(ColumnValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/parcats/domain/_column.py b/plotly/validators/parcats/domain/_column.py deleted file mode 100644 index b82a7402b8e..00000000000 --- a/plotly/validators/parcats/domain/_column.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='column', parent_name='parcats.domain', **kwargs - ): - super(ColumnValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/domain/_row.py b/plotly/validators/parcats/domain/_row.py deleted file mode 100644 index d43937ed436..00000000000 --- a/plotly/validators/parcats/domain/_row.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class RowValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='row', parent_name='parcats.domain', **kwargs - ): - super(RowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/domain/_x.py b/plotly/validators/parcats/domain/_x.py deleted file mode 100644 index ea7f5739f95..00000000000 --- a/plotly/validators/parcats/domain/_x.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='x', parent_name='parcats.domain', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/domain/_y.py b/plotly/validators/parcats/domain/_y.py deleted file mode 100644 index 84135a5821a..00000000000 --- a/plotly/validators/parcats/domain/_y.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='y', parent_name='parcats.domain', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/labelfont/__init__.py b/plotly/validators/parcats/labelfont/__init__.py index 199d72e71c6..440d338fdf9 100644 --- a/plotly/validators/parcats/labelfont/__init__.py +++ b/plotly/validators/parcats/labelfont/__init__.py @@ -1,3 +1,54 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='parcats.labelfont', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='parcats.labelfont', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='parcats.labelfont', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/parcats/labelfont/_color.py b/plotly/validators/parcats/labelfont/_color.py deleted file mode 100644 index bc4816d379d..00000000000 --- a/plotly/validators/parcats/labelfont/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='parcats.labelfont', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/labelfont/_family.py b/plotly/validators/parcats/labelfont/_family.py deleted file mode 100644 index d4495670b2f..00000000000 --- a/plotly/validators/parcats/labelfont/_family.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='parcats.labelfont', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/parcats/labelfont/_size.py b/plotly/validators/parcats/labelfont/_size.py deleted file mode 100644 index 72716a92faa..00000000000 --- a/plotly/validators/parcats/labelfont/_size.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='parcats.labelfont', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/__init__.py b/plotly/validators/parcats/line/__init__.py index 34adf73ddda..58ec5e5912a 100644 --- a/plotly/validators/parcats/line/__init__.py +++ b/plotly/validators/parcats/line/__init__.py @@ -1,13 +1,453 @@ -from ._showscale import ShowscaleValidator -from ._shape import ShapeValidator -from ._reversescale import ReversescaleValidator -from ._hovertemplate import HovertemplateValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='parcats.line', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShapeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='shape', parent_name='parcats.line', **kwargs + ): + super(ShapeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['linear', 'hspline']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='reversescale', parent_name='parcats.line', **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hovertemplate', + parent_name='parcats.line', + **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='parcats.line', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='parcats.line', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='parcats.line', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.parcats.line.colorbar.Tickfor + matstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.parcats.line.colorbar.tickformatstopdefaults) + , sets the default property values to use for + elements of + parcats.line.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.parcats.line.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + parcats.line.colorbar.title.font instead. Sets + this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + parcats.line.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='parcats.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'parcats.line.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='parcats.line', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='parcats.line', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='parcats.line', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='parcats.line', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='parcats.line', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/parcats/line/_autocolorscale.py b/plotly/validators/parcats/line/_autocolorscale.py deleted file mode 100644 index bfd40644a76..00000000000 --- a/plotly/validators/parcats/line/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='parcats.line', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/_cauto.py b/plotly/validators/parcats/line/_cauto.py deleted file mode 100644 index 2e4ea4a4007..00000000000 --- a/plotly/validators/parcats/line/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='parcats.line', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/_cmax.py b/plotly/validators/parcats/line/_cmax.py deleted file mode 100644 index 702ac46e9fb..00000000000 --- a/plotly/validators/parcats/line/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='parcats.line', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/_cmid.py b/plotly/validators/parcats/line/_cmid.py deleted file mode 100644 index 5e573287b51..00000000000 --- a/plotly/validators/parcats/line/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='parcats.line', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/_cmin.py b/plotly/validators/parcats/line/_cmin.py deleted file mode 100644 index 8409e1472f3..00000000000 --- a/plotly/validators/parcats/line/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='parcats.line', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/_color.py b/plotly/validators/parcats/line/_color.py deleted file mode 100644 index 5aa4ae76571..00000000000 --- a/plotly/validators/parcats/line/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='parcats.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'parcats.line.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/parcats/line/_colorbar.py b/plotly/validators/parcats/line/_colorbar.py deleted file mode 100644 index 783f10968f2..00000000000 --- a/plotly/validators/parcats/line/_colorbar.py +++ /dev/null @@ -1,228 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='parcats.line', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.parcats.line.colorbar.Tickfor - matstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.parcats.line.colorbar.tickformatstopdefaults) - , sets the default property values to use for - elements of - parcats.line.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.parcats.line.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - parcats.line.colorbar.title.font instead. Sets - this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - parcats.line.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcats/line/_colorscale.py b/plotly/validators/parcats/line/_colorscale.py deleted file mode 100644 index dee2e8db95d..00000000000 --- a/plotly/validators/parcats/line/_colorscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='parcats.line', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/_colorsrc.py b/plotly/validators/parcats/line/_colorsrc.py deleted file mode 100644 index 6786f6b2a42..00000000000 --- a/plotly/validators/parcats/line/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='parcats.line', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/_hovertemplate.py b/plotly/validators/parcats/line/_hovertemplate.py deleted file mode 100644 index 223ba3b8c45..00000000000 --- a/plotly/validators/parcats/line/_hovertemplate.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hovertemplate', - parent_name='parcats.line', - **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/_reversescale.py b/plotly/validators/parcats/line/_reversescale.py deleted file mode 100644 index 412311c4ac0..00000000000 --- a/plotly/validators/parcats/line/_reversescale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='reversescale', parent_name='parcats.line', **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/_shape.py b/plotly/validators/parcats/line/_shape.py deleted file mode 100644 index 59d3054e2b1..00000000000 --- a/plotly/validators/parcats/line/_shape.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShapeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='shape', parent_name='parcats.line', **kwargs - ): - super(ShapeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['linear', 'hspline']), - **kwargs - ) diff --git a/plotly/validators/parcats/line/_showscale.py b/plotly/validators/parcats/line/_showscale.py deleted file mode 100644 index 3e12c86c972..00000000000 --- a/plotly/validators/parcats/line/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='parcats.line', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/__init__.py b/plotly/validators/parcats/line/colorbar/__init__.py index 3dab31f7e02..7335a7ce27b 100644 --- a/plotly/validators/parcats/line/colorbar/__init__.py +++ b/plotly/validators/parcats/line/colorbar/__init__.py @@ -1,41 +1,927 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ypad', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='parcats.line.colorbar', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xpad', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='parcats.line.colorbar', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='len', parent_name='parcats.line.colorbar', **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='parcats.line.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/parcats/line/colorbar/_bgcolor.py b/plotly/validators/parcats/line/colorbar/_bgcolor.py deleted file mode 100644 index 0495c5e0724..00000000000 --- a/plotly/validators/parcats/line/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_bordercolor.py b/plotly/validators/parcats/line/colorbar/_bordercolor.py deleted file mode 100644 index dab80b7eea4..00000000000 --- a/plotly/validators/parcats/line/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_borderwidth.py b/plotly/validators/parcats/line/colorbar/_borderwidth.py deleted file mode 100644 index 3a7bcee7f20..00000000000 --- a/plotly/validators/parcats/line/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_dtick.py b/plotly/validators/parcats/line/colorbar/_dtick.py deleted file mode 100644 index fac994f98fd..00000000000 --- a/plotly/validators/parcats/line/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_exponentformat.py b/plotly/validators/parcats/line/colorbar/_exponentformat.py deleted file mode 100644 index 8f8efc45fa1..00000000000 --- a/plotly/validators/parcats/line/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_len.py b/plotly/validators/parcats/line/colorbar/_len.py deleted file mode 100644 index fca342d6aaa..00000000000 --- a/plotly/validators/parcats/line/colorbar/_len.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='len', parent_name='parcats.line.colorbar', **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_lenmode.py b/plotly/validators/parcats/line/colorbar/_lenmode.py deleted file mode 100644 index bcb4aa6f6f7..00000000000 --- a/plotly/validators/parcats/line/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_nticks.py b/plotly/validators/parcats/line/colorbar/_nticks.py deleted file mode 100644 index 8be7a2424b4..00000000000 --- a/plotly/validators/parcats/line/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_outlinecolor.py b/plotly/validators/parcats/line/colorbar/_outlinecolor.py deleted file mode 100644 index afacfe223b2..00000000000 --- a/plotly/validators/parcats/line/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_outlinewidth.py b/plotly/validators/parcats/line/colorbar/_outlinewidth.py deleted file mode 100644 index 6c532391992..00000000000 --- a/plotly/validators/parcats/line/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_separatethousands.py b/plotly/validators/parcats/line/colorbar/_separatethousands.py deleted file mode 100644 index 2933c3d7dca..00000000000 --- a/plotly/validators/parcats/line/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_showexponent.py b/plotly/validators/parcats/line/colorbar/_showexponent.py deleted file mode 100644 index fa0618de0c8..00000000000 --- a/plotly/validators/parcats/line/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_showticklabels.py b/plotly/validators/parcats/line/colorbar/_showticklabels.py deleted file mode 100644 index 3fd2f25f19d..00000000000 --- a/plotly/validators/parcats/line/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_showtickprefix.py b/plotly/validators/parcats/line/colorbar/_showtickprefix.py deleted file mode 100644 index 2d5d2820fb5..00000000000 --- a/plotly/validators/parcats/line/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_showticksuffix.py b/plotly/validators/parcats/line/colorbar/_showticksuffix.py deleted file mode 100644 index 338bb34a0d0..00000000000 --- a/plotly/validators/parcats/line/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_thickness.py b/plotly/validators/parcats/line/colorbar/_thickness.py deleted file mode 100644 index 00ea093f31a..00000000000 --- a/plotly/validators/parcats/line/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_thicknessmode.py b/plotly/validators/parcats/line/colorbar/_thicknessmode.py deleted file mode 100644 index 38151279efe..00000000000 --- a/plotly/validators/parcats/line/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_tick0.py b/plotly/validators/parcats/line/colorbar/_tick0.py deleted file mode 100644 index 947211663ed..00000000000 --- a/plotly/validators/parcats/line/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_tickangle.py b/plotly/validators/parcats/line/colorbar/_tickangle.py deleted file mode 100644 index 6fa562b10f1..00000000000 --- a/plotly/validators/parcats/line/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_tickcolor.py b/plotly/validators/parcats/line/colorbar/_tickcolor.py deleted file mode 100644 index ec3c9c6a2c3..00000000000 --- a/plotly/validators/parcats/line/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_tickfont.py b/plotly/validators/parcats/line/colorbar/_tickfont.py deleted file mode 100644 index 6cb2703a8c6..00000000000 --- a/plotly/validators/parcats/line/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_tickformat.py b/plotly/validators/parcats/line/colorbar/_tickformat.py deleted file mode 100644 index 3fb235bb834..00000000000 --- a/plotly/validators/parcats/line/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_tickformatstopdefaults.py b/plotly/validators/parcats/line/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 7e8d7585678..00000000000 --- a/plotly/validators/parcats/line/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_tickformatstops.py b/plotly/validators/parcats/line/colorbar/_tickformatstops.py deleted file mode 100644 index 92c8a7a06d5..00000000000 --- a/plotly/validators/parcats/line/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_ticklen.py b/plotly/validators/parcats/line/colorbar/_ticklen.py deleted file mode 100644 index 0050a78671b..00000000000 --- a/plotly/validators/parcats/line/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_tickmode.py b/plotly/validators/parcats/line/colorbar/_tickmode.py deleted file mode 100644 index f927ad2f959..00000000000 --- a/plotly/validators/parcats/line/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_tickprefix.py b/plotly/validators/parcats/line/colorbar/_tickprefix.py deleted file mode 100644 index ab3b5afb0ab..00000000000 --- a/plotly/validators/parcats/line/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_ticks.py b/plotly/validators/parcats/line/colorbar/_ticks.py deleted file mode 100644 index ffb9194bbb4..00000000000 --- a/plotly/validators/parcats/line/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_ticksuffix.py b/plotly/validators/parcats/line/colorbar/_ticksuffix.py deleted file mode 100644 index ddd6854f0fd..00000000000 --- a/plotly/validators/parcats/line/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_ticktext.py b/plotly/validators/parcats/line/colorbar/_ticktext.py deleted file mode 100644 index 3cae3d990a6..00000000000 --- a/plotly/validators/parcats/line/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_ticktextsrc.py b/plotly/validators/parcats/line/colorbar/_ticktextsrc.py deleted file mode 100644 index 8f6fb1c44d2..00000000000 --- a/plotly/validators/parcats/line/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_tickvals.py b/plotly/validators/parcats/line/colorbar/_tickvals.py deleted file mode 100644 index cb24bb279a8..00000000000 --- a/plotly/validators/parcats/line/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_tickvalssrc.py b/plotly/validators/parcats/line/colorbar/_tickvalssrc.py deleted file mode 100644 index 1800a9dab4d..00000000000 --- a/plotly/validators/parcats/line/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_tickwidth.py b/plotly/validators/parcats/line/colorbar/_tickwidth.py deleted file mode 100644 index a9425c56a28..00000000000 --- a/plotly/validators/parcats/line/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_title.py b/plotly/validators/parcats/line/colorbar/_title.py deleted file mode 100644 index e1041aa264c..00000000000 --- a/plotly/validators/parcats/line/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_x.py b/plotly/validators/parcats/line/colorbar/_x.py deleted file mode 100644 index 88d05eb7c52..00000000000 --- a/plotly/validators/parcats/line/colorbar/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='parcats.line.colorbar', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_xanchor.py b/plotly/validators/parcats/line/colorbar/_xanchor.py deleted file mode 100644 index 5ed789d15f0..00000000000 --- a/plotly/validators/parcats/line/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_xpad.py b/plotly/validators/parcats/line/colorbar/_xpad.py deleted file mode 100644 index b2f534f1877..00000000000 --- a/plotly/validators/parcats/line/colorbar/_xpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xpad', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_y.py b/plotly/validators/parcats/line/colorbar/_y.py deleted file mode 100644 index 58d930d9f7c..00000000000 --- a/plotly/validators/parcats/line/colorbar/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='parcats.line.colorbar', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_yanchor.py b/plotly/validators/parcats/line/colorbar/_yanchor.py deleted file mode 100644 index abbd33fd486..00000000000 --- a/plotly/validators/parcats/line/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/_ypad.py b/plotly/validators/parcats/line/colorbar/_ypad.py deleted file mode 100644 index 12fbc675d2b..00000000000 --- a/plotly/validators/parcats/line/colorbar/_ypad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ypad', - parent_name='parcats.line.colorbar', - **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/tickfont/__init__.py b/plotly/validators/parcats/line/colorbar/tickfont/__init__.py index 199d72e71c6..fb236a6e6bd 100644 --- a/plotly/validators/parcats/line/colorbar/tickfont/__init__.py +++ b/plotly/validators/parcats/line/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='parcats.line.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='parcats.line.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='parcats.line.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/parcats/line/colorbar/tickfont/_color.py b/plotly/validators/parcats/line/colorbar/tickfont/_color.py deleted file mode 100644 index eed877a737f..00000000000 --- a/plotly/validators/parcats/line/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='parcats.line.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/tickfont/_family.py b/plotly/validators/parcats/line/colorbar/tickfont/_family.py deleted file mode 100644 index b90c27e6bbf..00000000000 --- a/plotly/validators/parcats/line/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='parcats.line.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/tickfont/_size.py b/plotly/validators/parcats/line/colorbar/tickfont/_size.py deleted file mode 100644 index afbd9cbf1d4..00000000000 --- a/plotly/validators/parcats/line/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='parcats.line.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/tickformatstop/__init__.py b/plotly/validators/parcats/line/colorbar/tickformatstop/__init__.py index 3f6c06cac47..7bdb7528776 100644 --- a/plotly/validators/parcats/line/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/parcats/line/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='parcats.line.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='parcats.line.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='parcats.line.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='parcats.line.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='parcats.line.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/parcats/line/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/parcats/line/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index fa044531f59..00000000000 --- a/plotly/validators/parcats/line/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='parcats.line.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/tickformatstop/_enabled.py b/plotly/validators/parcats/line/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index fa9ed0e16eb..00000000000 --- a/plotly/validators/parcats/line/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='parcats.line.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/tickformatstop/_name.py b/plotly/validators/parcats/line/colorbar/tickformatstop/_name.py deleted file mode 100644 index c313227b983..00000000000 --- a/plotly/validators/parcats/line/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='parcats.line.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/parcats/line/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index d5b435cdd8b..00000000000 --- a/plotly/validators/parcats/line/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='parcats.line.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/tickformatstop/_value.py b/plotly/validators/parcats/line/colorbar/tickformatstop/_value.py deleted file mode 100644 index bb33bc32d49..00000000000 --- a/plotly/validators/parcats/line/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='parcats.line.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/title/__init__.py b/plotly/validators/parcats/line/colorbar/title/__init__.py index 33c9c145bb8..42fb4f12f7e 100644 --- a/plotly/validators/parcats/line/colorbar/title/__init__.py +++ b/plotly/validators/parcats/line/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='parcats.line.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='parcats.line.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='parcats.line.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/parcats/line/colorbar/title/_font.py b/plotly/validators/parcats/line/colorbar/title/_font.py deleted file mode 100644 index 0d0ff6e180e..00000000000 --- a/plotly/validators/parcats/line/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='parcats.line.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/title/_side.py b/plotly/validators/parcats/line/colorbar/title/_side.py deleted file mode 100644 index 8b98635f3d4..00000000000 --- a/plotly/validators/parcats/line/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='parcats.line.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/title/_text.py b/plotly/validators/parcats/line/colorbar/title/_text.py deleted file mode 100644 index 09ca5d580a3..00000000000 --- a/plotly/validators/parcats/line/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='parcats.line.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/title/font/__init__.py b/plotly/validators/parcats/line/colorbar/title/font/__init__.py index 199d72e71c6..af5d9af50da 100644 --- a/plotly/validators/parcats/line/colorbar/title/font/__init__.py +++ b/plotly/validators/parcats/line/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='parcats.line.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='parcats.line.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='parcats.line.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/parcats/line/colorbar/title/font/_color.py b/plotly/validators/parcats/line/colorbar/title/font/_color.py deleted file mode 100644 index e2b88f57677..00000000000 --- a/plotly/validators/parcats/line/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='parcats.line.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/title/font/_family.py b/plotly/validators/parcats/line/colorbar/title/font/_family.py deleted file mode 100644 index 85a1d52925d..00000000000 --- a/plotly/validators/parcats/line/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='parcats.line.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/parcats/line/colorbar/title/font/_size.py b/plotly/validators/parcats/line/colorbar/title/font/_size.py deleted file mode 100644 index 5d60533a59b..00000000000 --- a/plotly/validators/parcats/line/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='parcats.line.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/stream/__init__.py b/plotly/validators/parcats/stream/__init__.py index 2f4f2047594..9aea6eda056 100644 --- a/plotly/validators/parcats/stream/__init__.py +++ b/plotly/validators/parcats/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='parcats.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='parcats.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/parcats/stream/_maxpoints.py b/plotly/validators/parcats/stream/_maxpoints.py deleted file mode 100644 index c4d9a6b50d1..00000000000 --- a/plotly/validators/parcats/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='parcats.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcats/stream/_token.py b/plotly/validators/parcats/stream/_token.py deleted file mode 100644 index 5497c186d09..00000000000 --- a/plotly/validators/parcats/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='parcats.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/parcats/tickfont/__init__.py b/plotly/validators/parcats/tickfont/__init__.py index 199d72e71c6..5cb793aa557 100644 --- a/plotly/validators/parcats/tickfont/__init__.py +++ b/plotly/validators/parcats/tickfont/__init__.py @@ -1,3 +1,54 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='parcats.tickfont', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='parcats.tickfont', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='parcats.tickfont', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/parcats/tickfont/_color.py b/plotly/validators/parcats/tickfont/_color.py deleted file mode 100644 index f489cfef5bc..00000000000 --- a/plotly/validators/parcats/tickfont/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='parcats.tickfont', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcats/tickfont/_family.py b/plotly/validators/parcats/tickfont/_family.py deleted file mode 100644 index 70ce3ff94f0..00000000000 --- a/plotly/validators/parcats/tickfont/_family.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='parcats.tickfont', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/parcats/tickfont/_size.py b/plotly/validators/parcats/tickfont/_size.py deleted file mode 100644 index c03b99250fe..00000000000 --- a/plotly/validators/parcats/tickfont/_size.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='parcats.tickfont', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/__init__.py b/plotly/validators/parcoords/__init__.py index 4e60469ec3a..113a7e22578 100644 --- a/plotly/validators/parcoords/__init__.py +++ b/plotly/validators/parcoords/__init__.py @@ -1,22 +1,628 @@ -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._tickfont import TickfontValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._rangefont import RangefontValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._labelfont import LabelfontValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._domain import DomainValidator -from ._dimensiondefaults import DimensionValidator -from ._dimensions import DimensionsValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='parcoords', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='parcoords', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='parcoords', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='tickfont', parent_name='parcoords', **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='parcoords', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='parcoords', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='parcoords', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangefontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='rangefont', parent_name='parcoords', **kwargs + ): + super(RangefontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Rangefont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='parcoords', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='parcoords', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='line', parent_name='parcoords', **kwargs): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `line.colorscale`. Has an effect + only if in `line.color`is set to a numerical + array. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette + will be chosen according to whether numbers in + the `color` array are all positive, all + negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `line.color`) or the bounds set in + `line.cmin` and `line.cmax` Has an effect only + if in `line.color`is set to a numerical array. + Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `line.color`is set to a + numerical array. Value should have the same + units as in `line.color` and if set, + `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `line.cmin` and/or `line.cmax` to be + equidistant to this point. Has an effect only + if in `line.color`is set to a numerical array. + Value should have the same units as in + `line.color`. Has no effect when `line.cauto` + is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `line.color`is set to a + numerical array. Value should have the same + units as in `line.color` and if set, + `line.cmax` must be set as well. + color + Sets thelinecolor. It accepts either a specific + color or an array of numbers that are mapped to + the colorscale relative to the max and min + values of the array or relative to `line.cmin` + and `line.cmax` if set. + colorbar + plotly.graph_objs.parcoords.line.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `line.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`line.cmin` and `line.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `line.color`is set to a + numerical array. If true, `line.cmin` will + correspond to the last color in the array and + `line.cmax` will correspond to the first color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `line.color`is set to a numerical array. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='parcoords', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='labelfont', parent_name='parcoords', **kwargs + ): + super(LabelfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Labelfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='parcoords', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='parcoords', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='parcoords', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='parcoords', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='domain', parent_name='parcoords', **kwargs + ): + super(DomainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Domain'), + data_docs=kwargs.pop( + 'data_docs', """ + column + If there is a layout grid, use the domain for + this column in the grid for this parcoords + trace . + row + If there is a layout grid, use the domain for + this row in the grid for this parcoords trace . + x + Sets the horizontal domain of this parcoords + trace (in plot fraction). + y + Sets the vertical domain of this parcoords + trace (in plot fraction). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DimensionValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='dimensiondefaults', + parent_name='parcoords', + **kwargs + ): + super(DimensionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Dimension'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DimensionsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, plotly_name='dimensions', parent_name='parcoords', **kwargs + ): + super(DimensionsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Dimension'), + data_docs=kwargs.pop( + 'data_docs', """ + constraintrange + The domain range to which the filter on the + dimension is constrained. Must be an array of + `[fromValue, toValue]` with `fromValue <= + toValue`, or if `multiselect` is not disabled, + you may give an array of arrays, where each + inner array is `[fromValue, toValue]`. + label + The shown name of the dimension. + multiselect + Do we allow multiple selection ranges or just a + single range? + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + range + The domain range that represents the full, + shown axis extent. Defaults to the `values` + extent. Must be an array of `[fromValue, + toValue]` with finite numbers as elements. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + tickformat + Sets the tick label formatting rule using d3 + formatting mini-language which is similar to + those of Python. See https://github.com/d3/d3-f + ormat/blob/master/README.md#locale_format + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + values + Dimension values. `values[n]` represents the + value of the `n`th point in the dataset, + therefore the `values` vector for all + dimensions must be the same (longer vectors + will be truncated). Each value must be a finite + number. + valuessrc + Sets the source reference on plot.ly for + values . + visible + Shows the dimension when set to `true` (the + default). Hides the dimension for `false`. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='parcoords', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='parcoords', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/parcoords/_customdata.py b/plotly/validators/parcoords/_customdata.py deleted file mode 100644 index 8b68382c0d6..00000000000 --- a/plotly/validators/parcoords/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='parcoords', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/parcoords/_customdatasrc.py b/plotly/validators/parcoords/_customdatasrc.py deleted file mode 100644 index 84e9ee1c7ca..00000000000 --- a/plotly/validators/parcoords/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='parcoords', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/_dimensiondefaults.py b/plotly/validators/parcoords/_dimensiondefaults.py deleted file mode 100644 index f75fa95ffae..00000000000 --- a/plotly/validators/parcoords/_dimensiondefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DimensionValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='dimensiondefaults', - parent_name='parcoords', - **kwargs - ): - super(DimensionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Dimension'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/parcoords/_dimensions.py b/plotly/validators/parcoords/_dimensions.py deleted file mode 100644 index bbf3600d5ab..00000000000 --- a/plotly/validators/parcoords/_dimensions.py +++ /dev/null @@ -1,89 +0,0 @@ -import _plotly_utils.basevalidators - - -class DimensionsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, plotly_name='dimensions', parent_name='parcoords', **kwargs - ): - super(DimensionsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Dimension'), - data_docs=kwargs.pop( - 'data_docs', """ - constraintrange - The domain range to which the filter on the - dimension is constrained. Must be an array of - `[fromValue, toValue]` with `fromValue <= - toValue`, or if `multiselect` is not disabled, - you may give an array of arrays, where each - inner array is `[fromValue, toValue]`. - label - The shown name of the dimension. - multiselect - Do we allow multiple selection ranges or just a - single range? - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - range - The domain range that represents the full, - shown axis extent. Defaults to the `values` - extent. Must be an array of `[fromValue, - toValue]` with finite numbers as elements. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - tickformat - Sets the tick label formatting rule using d3 - formatting mini-language which is similar to - those of Python. See https://github.com/d3/d3-f - ormat/blob/master/README.md#locale_format - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - values - Dimension values. `values[n]` represents the - value of the `n`th point in the dataset, - therefore the `values` vector for all - dimensions must be the same (longer vectors - will be truncated). Each value must be a finite - number. - valuessrc - Sets the source reference on plot.ly for - values . - visible - Shows the dimension when set to `true` (the - default). Hides the dimension for `false`. -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcoords/_domain.py b/plotly/validators/parcoords/_domain.py deleted file mode 100644 index aefbab88793..00000000000 --- a/plotly/validators/parcoords/_domain.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='domain', parent_name='parcoords', **kwargs - ): - super(DomainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Domain'), - data_docs=kwargs.pop( - 'data_docs', """ - column - If there is a layout grid, use the domain for - this column in the grid for this parcoords - trace . - row - If there is a layout grid, use the domain for - this row in the grid for this parcoords trace . - x - Sets the horizontal domain of this parcoords - trace (in plot fraction). - y - Sets the vertical domain of this parcoords - trace (in plot fraction). -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcoords/_hoverinfo.py b/plotly/validators/parcoords/_hoverinfo.py deleted file mode 100644 index f9b630c89d6..00000000000 --- a/plotly/validators/parcoords/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='parcoords', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/_hoverinfosrc.py b/plotly/validators/parcoords/_hoverinfosrc.py deleted file mode 100644 index cc4665a3413..00000000000 --- a/plotly/validators/parcoords/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='parcoords', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/_ids.py b/plotly/validators/parcoords/_ids.py deleted file mode 100644 index 8d70834527e..00000000000 --- a/plotly/validators/parcoords/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='parcoords', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/parcoords/_idssrc.py b/plotly/validators/parcoords/_idssrc.py deleted file mode 100644 index abb87b46320..00000000000 --- a/plotly/validators/parcoords/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='parcoords', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/_labelfont.py b/plotly/validators/parcoords/_labelfont.py deleted file mode 100644 index d89fc13b284..00000000000 --- a/plotly/validators/parcoords/_labelfont.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='labelfont', parent_name='parcoords', **kwargs - ): - super(LabelfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Labelfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcoords/_legendgroup.py b/plotly/validators/parcoords/_legendgroup.py deleted file mode 100644 index fa7999f0df6..00000000000 --- a/plotly/validators/parcoords/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='parcoords', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/_line.py b/plotly/validators/parcoords/_line.py deleted file mode 100644 index 535759be5e8..00000000000 --- a/plotly/validators/parcoords/_line.py +++ /dev/null @@ -1,92 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='line', parent_name='parcoords', **kwargs): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `line.colorscale`. Has an effect - only if in `line.color`is set to a numerical - array. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette - will be chosen according to whether numbers in - the `color` array are all positive, all - negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `line.color`) or the bounds set in - `line.cmin` and `line.cmax` Has an effect only - if in `line.color`is set to a numerical array. - Defaults to `false` when `line.cmin` and - `line.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `line.color`is set to a - numerical array. Value should have the same - units as in `line.color` and if set, - `line.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `line.cmin` and/or `line.cmax` to be - equidistant to this point. Has an effect only - if in `line.color`is set to a numerical array. - Value should have the same units as in - `line.color`. Has no effect when `line.cauto` - is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `line.color`is set to a - numerical array. Value should have the same - units as in `line.color` and if set, - `line.cmax` must be set as well. - color - Sets thelinecolor. It accepts either a specific - color or an array of numbers that are mapped to - the colorscale relative to the max and min - values of the array or relative to `line.cmin` - and `line.cmax` if set. - colorbar - plotly.graph_objs.parcoords.line.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `line.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`line.cmin` and `line.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `line.color`is set to a - numerical array. If true, `line.cmin` will - correspond to the last color in the array and - `line.cmax` will correspond to the first color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `line.color`is set to a numerical array. -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcoords/_name.py b/plotly/validators/parcoords/_name.py deleted file mode 100644 index 545c655e79f..00000000000 --- a/plotly/validators/parcoords/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='parcoords', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/_opacity.py b/plotly/validators/parcoords/_opacity.py deleted file mode 100644 index 298c04956ac..00000000000 --- a/plotly/validators/parcoords/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='parcoords', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/_rangefont.py b/plotly/validators/parcoords/_rangefont.py deleted file mode 100644 index 02d1e526289..00000000000 --- a/plotly/validators/parcoords/_rangefont.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangefontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='rangefont', parent_name='parcoords', **kwargs - ): - super(RangefontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Rangefont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcoords/_selectedpoints.py b/plotly/validators/parcoords/_selectedpoints.py deleted file mode 100644 index 06e7b297dd7..00000000000 --- a/plotly/validators/parcoords/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='parcoords', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/_showlegend.py b/plotly/validators/parcoords/_showlegend.py deleted file mode 100644 index 54155b92ee0..00000000000 --- a/plotly/validators/parcoords/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='parcoords', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/_stream.py b/plotly/validators/parcoords/_stream.py deleted file mode 100644 index e589dceb969..00000000000 --- a/plotly/validators/parcoords/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='parcoords', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcoords/_tickfont.py b/plotly/validators/parcoords/_tickfont.py deleted file mode 100644 index 88c82340cdd..00000000000 --- a/plotly/validators/parcoords/_tickfont.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='tickfont', parent_name='parcoords', **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcoords/_uid.py b/plotly/validators/parcoords/_uid.py deleted file mode 100644 index 516c2d63fad..00000000000 --- a/plotly/validators/parcoords/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='parcoords', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/_uirevision.py b/plotly/validators/parcoords/_uirevision.py deleted file mode 100644 index 955bfbe3c11..00000000000 --- a/plotly/validators/parcoords/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='parcoords', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/_visible.py b/plotly/validators/parcoords/_visible.py deleted file mode 100644 index 5243db2b9e3..00000000000 --- a/plotly/validators/parcoords/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='parcoords', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/parcoords/dimension/__init__.py b/plotly/validators/parcoords/dimension/__init__.py index 02232196a99..a365c69c8d4 100644 --- a/plotly/validators/parcoords/dimension/__init__.py +++ b/plotly/validators/parcoords/dimension/__init__.py @@ -1,14 +1,297 @@ -from ._visible import VisibleValidator -from ._valuessrc import ValuessrcValidator -from ._values import ValuesValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._tickformat import TickformatValidator -from ._templateitemname import TemplateitemnameValidator -from ._range import RangeValidator -from ._name import NameValidator -from ._multiselect import MultiselectValidator -from ._label import LabelValidator -from ._constraintrange import ConstraintrangeValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='visible', + parent_name='parcoords.dimension', + **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValuessrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='valuessrc', + parent_name='parcoords.dimension', + **kwargs + ): + super(ValuessrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValuesValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='values', + parent_name='parcoords.dimension', + **kwargs + ): + super(ValuesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='parcoords.dimension', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='parcoords.dimension', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='parcoords.dimension', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='parcoords.dimension', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='parcoords.dimension', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='parcoords.dimension', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='range', parent_name='parcoords.dimension', **kwargs + ): + super(RangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'editType': 'calc' + }, { + 'valType': 'number', + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='parcoords.dimension', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MultiselectValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='multiselect', + parent_name='parcoords.dimension', + **kwargs + ): + super(MultiselectValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='label', parent_name='parcoords.dimension', **kwargs + ): + super(LabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConstraintrangeValidator( + _plotly_utils.basevalidators.InfoArrayValidator +): + + def __init__( + self, + plotly_name='constraintrange', + parent_name='parcoords.dimension', + **kwargs + ): + super(ConstraintrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dimensions=kwargs.pop('dimensions', '1-2'), + edit_type=kwargs.pop('edit_type', 'calc'), + free_length=kwargs.pop('free_length', True), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'editType': 'calc' + }, { + 'valType': 'number', + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/parcoords/dimension/_constraintrange.py b/plotly/validators/parcoords/dimension/_constraintrange.py deleted file mode 100644 index f0a28d14303..00000000000 --- a/plotly/validators/parcoords/dimension/_constraintrange.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConstraintrangeValidator( - _plotly_utils.basevalidators.InfoArrayValidator -): - - def __init__( - self, - plotly_name='constraintrange', - parent_name='parcoords.dimension', - **kwargs - ): - super(ConstraintrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dimensions=kwargs.pop('dimensions', '1-2'), - edit_type=kwargs.pop('edit_type', 'calc'), - free_length=kwargs.pop('free_length', True), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'editType': 'calc' - }, { - 'valType': 'number', - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/dimension/_label.py b/plotly/validators/parcoords/dimension/_label.py deleted file mode 100644 index 75f01439392..00000000000 --- a/plotly/validators/parcoords/dimension/_label.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='label', parent_name='parcoords.dimension', **kwargs - ): - super(LabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/dimension/_multiselect.py b/plotly/validators/parcoords/dimension/_multiselect.py deleted file mode 100644 index 7d6fcee9ab6..00000000000 --- a/plotly/validators/parcoords/dimension/_multiselect.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class MultiselectValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='multiselect', - parent_name='parcoords.dimension', - **kwargs - ): - super(MultiselectValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/dimension/_name.py b/plotly/validators/parcoords/dimension/_name.py deleted file mode 100644 index 1b897f9e02c..00000000000 --- a/plotly/validators/parcoords/dimension/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='parcoords.dimension', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/dimension/_range.py b/plotly/validators/parcoords/dimension/_range.py deleted file mode 100644 index 0183c30078c..00000000000 --- a/plotly/validators/parcoords/dimension/_range.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class RangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='range', parent_name='parcoords.dimension', **kwargs - ): - super(RangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'editType': 'calc' - }, { - 'valType': 'number', - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/dimension/_templateitemname.py b/plotly/validators/parcoords/dimension/_templateitemname.py deleted file mode 100644 index c4ca04c1bea..00000000000 --- a/plotly/validators/parcoords/dimension/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='parcoords.dimension', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/dimension/_tickformat.py b/plotly/validators/parcoords/dimension/_tickformat.py deleted file mode 100644 index eb1bd9449b5..00000000000 --- a/plotly/validators/parcoords/dimension/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='parcoords.dimension', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/dimension/_ticktext.py b/plotly/validators/parcoords/dimension/_ticktext.py deleted file mode 100644 index b02d7a35eb8..00000000000 --- a/plotly/validators/parcoords/dimension/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='parcoords.dimension', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/parcoords/dimension/_ticktextsrc.py b/plotly/validators/parcoords/dimension/_ticktextsrc.py deleted file mode 100644 index 819259893a6..00000000000 --- a/plotly/validators/parcoords/dimension/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='parcoords.dimension', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/dimension/_tickvals.py b/plotly/validators/parcoords/dimension/_tickvals.py deleted file mode 100644 index a90c94a98eb..00000000000 --- a/plotly/validators/parcoords/dimension/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='parcoords.dimension', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/parcoords/dimension/_tickvalssrc.py b/plotly/validators/parcoords/dimension/_tickvalssrc.py deleted file mode 100644 index ea74f22377b..00000000000 --- a/plotly/validators/parcoords/dimension/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='parcoords.dimension', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/dimension/_values.py b/plotly/validators/parcoords/dimension/_values.py deleted file mode 100644 index 0d3271301cc..00000000000 --- a/plotly/validators/parcoords/dimension/_values.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValuesValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='values', - parent_name='parcoords.dimension', - **kwargs - ): - super(ValuesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/parcoords/dimension/_valuessrc.py b/plotly/validators/parcoords/dimension/_valuessrc.py deleted file mode 100644 index 05fd3e0cb10..00000000000 --- a/plotly/validators/parcoords/dimension/_valuessrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValuessrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='valuessrc', - parent_name='parcoords.dimension', - **kwargs - ): - super(ValuessrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/dimension/_visible.py b/plotly/validators/parcoords/dimension/_visible.py deleted file mode 100644 index b41ac3b2582..00000000000 --- a/plotly/validators/parcoords/dimension/_visible.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='visible', - parent_name='parcoords.dimension', - **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/domain/__init__.py b/plotly/validators/parcoords/domain/__init__.py index 6cf32248236..4d10c7e3090 100644 --- a/plotly/validators/parcoords/domain/__init__.py +++ b/plotly/validators/parcoords/domain/__init__.py @@ -1,4 +1,102 @@ -from ._y import YValidator -from ._x import XValidator -from ._row import RowValidator -from ._column import ColumnValidator + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='y', parent_name='parcoords.domain', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='x', parent_name='parcoords.domain', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RowValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='row', parent_name='parcoords.domain', **kwargs + ): + super(RowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='column', parent_name='parcoords.domain', **kwargs + ): + super(ColumnValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/parcoords/domain/_column.py b/plotly/validators/parcoords/domain/_column.py deleted file mode 100644 index 29c06eddc78..00000000000 --- a/plotly/validators/parcoords/domain/_column.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='column', parent_name='parcoords.domain', **kwargs - ): - super(ColumnValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/domain/_row.py b/plotly/validators/parcoords/domain/_row.py deleted file mode 100644 index eafa74635e2..00000000000 --- a/plotly/validators/parcoords/domain/_row.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class RowValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='row', parent_name='parcoords.domain', **kwargs - ): - super(RowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/domain/_x.py b/plotly/validators/parcoords/domain/_x.py deleted file mode 100644 index cf5f24735cd..00000000000 --- a/plotly/validators/parcoords/domain/_x.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='x', parent_name='parcoords.domain', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/domain/_y.py b/plotly/validators/parcoords/domain/_y.py deleted file mode 100644 index bc0f98a1cb2..00000000000 --- a/plotly/validators/parcoords/domain/_y.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='y', parent_name='parcoords.domain', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/labelfont/__init__.py b/plotly/validators/parcoords/labelfont/__init__.py index 199d72e71c6..559d4eaa324 100644 --- a/plotly/validators/parcoords/labelfont/__init__.py +++ b/plotly/validators/parcoords/labelfont/__init__.py @@ -1,3 +1,57 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='parcoords.labelfont', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='parcoords.labelfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='parcoords.labelfont', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/parcoords/labelfont/_color.py b/plotly/validators/parcoords/labelfont/_color.py deleted file mode 100644 index bc5f0c846a8..00000000000 --- a/plotly/validators/parcoords/labelfont/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='parcoords.labelfont', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/labelfont/_family.py b/plotly/validators/parcoords/labelfont/_family.py deleted file mode 100644 index 8e4281c7dee..00000000000 --- a/plotly/validators/parcoords/labelfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='parcoords.labelfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/parcoords/labelfont/_size.py b/plotly/validators/parcoords/labelfont/_size.py deleted file mode 100644 index 400acccb284..00000000000 --- a/plotly/validators/parcoords/labelfont/_size.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='parcoords.labelfont', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/__init__.py b/plotly/validators/parcoords/line/__init__.py index 580935b3d09..5fa91ef7599 100644 --- a/plotly/validators/parcoords/line/__init__.py +++ b/plotly/validators/parcoords/line/__init__.py @@ -1,11 +1,418 @@ -from ._showscale import ShowscaleValidator -from ._reversescale import ReversescaleValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='parcoords.line', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='parcoords.line', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='parcoords.line', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='parcoords.line', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='parcoords.line', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.parcoords.line.colorbar.Tickf + ormatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.parcoords.line.colorbar.tickformatstopdefault + s), sets the default property values to use for + elements of + parcoords.line.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.parcoords.line.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + parcoords.line.colorbar.title.font instead. + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + parcoords.line.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='parcoords.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'parcoords.line.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='parcoords.line', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='parcoords.line', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='parcoords.line', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='parcoords.line', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='parcoords.line', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/parcoords/line/_autocolorscale.py b/plotly/validators/parcoords/line/_autocolorscale.py deleted file mode 100644 index cab4610d077..00000000000 --- a/plotly/validators/parcoords/line/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='parcoords.line', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/_cauto.py b/plotly/validators/parcoords/line/_cauto.py deleted file mode 100644 index 3e9a5c87bf5..00000000000 --- a/plotly/validators/parcoords/line/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='parcoords.line', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/_cmax.py b/plotly/validators/parcoords/line/_cmax.py deleted file mode 100644 index 53819d315c0..00000000000 --- a/plotly/validators/parcoords/line/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='parcoords.line', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/_cmid.py b/plotly/validators/parcoords/line/_cmid.py deleted file mode 100644 index b1c57f66ad1..00000000000 --- a/plotly/validators/parcoords/line/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='parcoords.line', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/_cmin.py b/plotly/validators/parcoords/line/_cmin.py deleted file mode 100644 index 96becb37561..00000000000 --- a/plotly/validators/parcoords/line/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='parcoords.line', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/_color.py b/plotly/validators/parcoords/line/_color.py deleted file mode 100644 index bd2c1479409..00000000000 --- a/plotly/validators/parcoords/line/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='parcoords.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'parcoords.line.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/_colorbar.py b/plotly/validators/parcoords/line/_colorbar.py deleted file mode 100644 index 7cddbae656a..00000000000 --- a/plotly/validators/parcoords/line/_colorbar.py +++ /dev/null @@ -1,228 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='parcoords.line', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.parcoords.line.colorbar.Tickf - ormatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.parcoords.line.colorbar.tickformatstopdefault - s), sets the default property values to use for - elements of - parcoords.line.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.parcoords.line.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - parcoords.line.colorbar.title.font instead. - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - parcoords.line.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/_colorscale.py b/plotly/validators/parcoords/line/_colorscale.py deleted file mode 100644 index 9ff3e17363b..00000000000 --- a/plotly/validators/parcoords/line/_colorscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='parcoords.line', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/_colorsrc.py b/plotly/validators/parcoords/line/_colorsrc.py deleted file mode 100644 index 906731808fd..00000000000 --- a/plotly/validators/parcoords/line/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='parcoords.line', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/_reversescale.py b/plotly/validators/parcoords/line/_reversescale.py deleted file mode 100644 index 1e18946f4e0..00000000000 --- a/plotly/validators/parcoords/line/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='parcoords.line', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/_showscale.py b/plotly/validators/parcoords/line/_showscale.py deleted file mode 100644 index 83bf43ee0b1..00000000000 --- a/plotly/validators/parcoords/line/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='parcoords.line', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/__init__.py b/plotly/validators/parcoords/line/colorbar/__init__.py index 3dab31f7e02..f6ca2ea9578 100644 --- a/plotly/validators/parcoords/line/colorbar/__init__.py +++ b/plotly/validators/parcoords/line/colorbar/__init__.py @@ -1,41 +1,930 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ypad', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='parcoords.line.colorbar', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xpad', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='parcoords.line.colorbar', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='len', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='parcoords.line.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/parcoords/line/colorbar/_bgcolor.py b/plotly/validators/parcoords/line/colorbar/_bgcolor.py deleted file mode 100644 index dd9429e0a09..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_bordercolor.py b/plotly/validators/parcoords/line/colorbar/_bordercolor.py deleted file mode 100644 index 430ae86c5d5..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_borderwidth.py b/plotly/validators/parcoords/line/colorbar/_borderwidth.py deleted file mode 100644 index 488dd277c10..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_dtick.py b/plotly/validators/parcoords/line/colorbar/_dtick.py deleted file mode 100644 index 9af9d8f023b..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_exponentformat.py b/plotly/validators/parcoords/line/colorbar/_exponentformat.py deleted file mode 100644 index addc3178315..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_len.py b/plotly/validators/parcoords/line/colorbar/_len.py deleted file mode 100644 index 873b5f05954..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_len.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='len', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_lenmode.py b/plotly/validators/parcoords/line/colorbar/_lenmode.py deleted file mode 100644 index 80b4ccc17b3..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_nticks.py b/plotly/validators/parcoords/line/colorbar/_nticks.py deleted file mode 100644 index a34222da158..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_outlinecolor.py b/plotly/validators/parcoords/line/colorbar/_outlinecolor.py deleted file mode 100644 index a2c2b607d1e..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_outlinewidth.py b/plotly/validators/parcoords/line/colorbar/_outlinewidth.py deleted file mode 100644 index dd024ec86ce..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_separatethousands.py b/plotly/validators/parcoords/line/colorbar/_separatethousands.py deleted file mode 100644 index 0f79d13c402..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_showexponent.py b/plotly/validators/parcoords/line/colorbar/_showexponent.py deleted file mode 100644 index f093ad22cdd..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_showticklabels.py b/plotly/validators/parcoords/line/colorbar/_showticklabels.py deleted file mode 100644 index 5be6814e9ae..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_showtickprefix.py b/plotly/validators/parcoords/line/colorbar/_showtickprefix.py deleted file mode 100644 index 7ad33c80f79..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_showticksuffix.py b/plotly/validators/parcoords/line/colorbar/_showticksuffix.py deleted file mode 100644 index ddd71dfa98d..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_thickness.py b/plotly/validators/parcoords/line/colorbar/_thickness.py deleted file mode 100644 index cc659955776..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_thicknessmode.py b/plotly/validators/parcoords/line/colorbar/_thicknessmode.py deleted file mode 100644 index 5a7a2533712..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_tick0.py b/plotly/validators/parcoords/line/colorbar/_tick0.py deleted file mode 100644 index 6a9a370d856..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_tickangle.py b/plotly/validators/parcoords/line/colorbar/_tickangle.py deleted file mode 100644 index aec4e6b76f3..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_tickcolor.py b/plotly/validators/parcoords/line/colorbar/_tickcolor.py deleted file mode 100644 index b2d97fe2dd4..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_tickfont.py b/plotly/validators/parcoords/line/colorbar/_tickfont.py deleted file mode 100644 index 03bd8aed458..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_tickformat.py b/plotly/validators/parcoords/line/colorbar/_tickformat.py deleted file mode 100644 index 439810fb5b8..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_tickformatstopdefaults.py b/plotly/validators/parcoords/line/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index d9922e138ba..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_tickformatstops.py b/plotly/validators/parcoords/line/colorbar/_tickformatstops.py deleted file mode 100644 index acb4c0c07bb..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_ticklen.py b/plotly/validators/parcoords/line/colorbar/_ticklen.py deleted file mode 100644 index 28de317e7d2..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_tickmode.py b/plotly/validators/parcoords/line/colorbar/_tickmode.py deleted file mode 100644 index 2d49276e30e..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_tickprefix.py b/plotly/validators/parcoords/line/colorbar/_tickprefix.py deleted file mode 100644 index 783b6db38f1..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_ticks.py b/plotly/validators/parcoords/line/colorbar/_ticks.py deleted file mode 100644 index d7e80ca44b5..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_ticksuffix.py b/plotly/validators/parcoords/line/colorbar/_ticksuffix.py deleted file mode 100644 index c2436ef7e76..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_ticktext.py b/plotly/validators/parcoords/line/colorbar/_ticktext.py deleted file mode 100644 index 65c4772173e..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_ticktextsrc.py b/plotly/validators/parcoords/line/colorbar/_ticktextsrc.py deleted file mode 100644 index 2f39587fc73..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_tickvals.py b/plotly/validators/parcoords/line/colorbar/_tickvals.py deleted file mode 100644 index 8a1827af0a8..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_tickvalssrc.py b/plotly/validators/parcoords/line/colorbar/_tickvalssrc.py deleted file mode 100644 index f84a65bc1cf..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_tickwidth.py b/plotly/validators/parcoords/line/colorbar/_tickwidth.py deleted file mode 100644 index db292fc598a..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_title.py b/plotly/validators/parcoords/line/colorbar/_title.py deleted file mode 100644 index d1ed0dcd4ac..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_x.py b/plotly/validators/parcoords/line/colorbar/_x.py deleted file mode 100644 index c2f65da4a25..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='parcoords.line.colorbar', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_xanchor.py b/plotly/validators/parcoords/line/colorbar/_xanchor.py deleted file mode 100644 index 4b4526a32b5..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_xpad.py b/plotly/validators/parcoords/line/colorbar/_xpad.py deleted file mode 100644 index 283dcc913de..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_xpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xpad', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_y.py b/plotly/validators/parcoords/line/colorbar/_y.py deleted file mode 100644 index b5d1f00a9a4..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='parcoords.line.colorbar', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_yanchor.py b/plotly/validators/parcoords/line/colorbar/_yanchor.py deleted file mode 100644 index f82f92a36e3..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/_ypad.py b/plotly/validators/parcoords/line/colorbar/_ypad.py deleted file mode 100644 index dd43b339c2e..00000000000 --- a/plotly/validators/parcoords/line/colorbar/_ypad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ypad', - parent_name='parcoords.line.colorbar', - **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/tickfont/__init__.py b/plotly/validators/parcoords/line/colorbar/tickfont/__init__.py index 199d72e71c6..e18baf383a0 100644 --- a/plotly/validators/parcoords/line/colorbar/tickfont/__init__.py +++ b/plotly/validators/parcoords/line/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='parcoords.line.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='parcoords.line.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='parcoords.line.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/parcoords/line/colorbar/tickfont/_color.py b/plotly/validators/parcoords/line/colorbar/tickfont/_color.py deleted file mode 100644 index 95444708665..00000000000 --- a/plotly/validators/parcoords/line/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='parcoords.line.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/tickfont/_family.py b/plotly/validators/parcoords/line/colorbar/tickfont/_family.py deleted file mode 100644 index ef9f3ae373a..00000000000 --- a/plotly/validators/parcoords/line/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='parcoords.line.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/tickfont/_size.py b/plotly/validators/parcoords/line/colorbar/tickfont/_size.py deleted file mode 100644 index bdaf2c72a17..00000000000 --- a/plotly/validators/parcoords/line/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='parcoords.line.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/tickformatstop/__init__.py b/plotly/validators/parcoords/line/colorbar/tickformatstop/__init__.py index 3f6c06cac47..a43206bf19d 100644 --- a/plotly/validators/parcoords/line/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/parcoords/line/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='parcoords.line.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='parcoords.line.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='parcoords.line.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='parcoords.line.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='parcoords.line.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/parcoords/line/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/parcoords/line/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index c4dc3ac3eeb..00000000000 --- a/plotly/validators/parcoords/line/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='parcoords.line.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/tickformatstop/_enabled.py b/plotly/validators/parcoords/line/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index c68f7fe8eab..00000000000 --- a/plotly/validators/parcoords/line/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='parcoords.line.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/tickformatstop/_name.py b/plotly/validators/parcoords/line/colorbar/tickformatstop/_name.py deleted file mode 100644 index d7854afd34c..00000000000 --- a/plotly/validators/parcoords/line/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='parcoords.line.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/parcoords/line/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 6d5caefafdc..00000000000 --- a/plotly/validators/parcoords/line/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='parcoords.line.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/tickformatstop/_value.py b/plotly/validators/parcoords/line/colorbar/tickformatstop/_value.py deleted file mode 100644 index d722002536a..00000000000 --- a/plotly/validators/parcoords/line/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='parcoords.line.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/title/__init__.py b/plotly/validators/parcoords/line/colorbar/title/__init__.py index 33c9c145bb8..a207c4d5b15 100644 --- a/plotly/validators/parcoords/line/colorbar/title/__init__.py +++ b/plotly/validators/parcoords/line/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='parcoords.line.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='parcoords.line.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='parcoords.line.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/parcoords/line/colorbar/title/_font.py b/plotly/validators/parcoords/line/colorbar/title/_font.py deleted file mode 100644 index 62e798f90f4..00000000000 --- a/plotly/validators/parcoords/line/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='parcoords.line.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/title/_side.py b/plotly/validators/parcoords/line/colorbar/title/_side.py deleted file mode 100644 index 73b6d2d3277..00000000000 --- a/plotly/validators/parcoords/line/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='parcoords.line.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/title/_text.py b/plotly/validators/parcoords/line/colorbar/title/_text.py deleted file mode 100644 index 167bca4b2d3..00000000000 --- a/plotly/validators/parcoords/line/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='parcoords.line.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/title/font/__init__.py b/plotly/validators/parcoords/line/colorbar/title/font/__init__.py index 199d72e71c6..c03cb56035f 100644 --- a/plotly/validators/parcoords/line/colorbar/title/font/__init__.py +++ b/plotly/validators/parcoords/line/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='parcoords.line.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='parcoords.line.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='parcoords.line.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/parcoords/line/colorbar/title/font/_color.py b/plotly/validators/parcoords/line/colorbar/title/font/_color.py deleted file mode 100644 index d1882441a67..00000000000 --- a/plotly/validators/parcoords/line/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='parcoords.line.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/title/font/_family.py b/plotly/validators/parcoords/line/colorbar/title/font/_family.py deleted file mode 100644 index 8c21ef001df..00000000000 --- a/plotly/validators/parcoords/line/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='parcoords.line.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/parcoords/line/colorbar/title/font/_size.py b/plotly/validators/parcoords/line/colorbar/title/font/_size.py deleted file mode 100644 index 83b7e937dd5..00000000000 --- a/plotly/validators/parcoords/line/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='parcoords.line.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/rangefont/__init__.py b/plotly/validators/parcoords/rangefont/__init__.py index 199d72e71c6..a85bf5c34ef 100644 --- a/plotly/validators/parcoords/rangefont/__init__.py +++ b/plotly/validators/parcoords/rangefont/__init__.py @@ -1,3 +1,57 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='parcoords.rangefont', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='parcoords.rangefont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='parcoords.rangefont', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/parcoords/rangefont/_color.py b/plotly/validators/parcoords/rangefont/_color.py deleted file mode 100644 index 3d0cdad53b5..00000000000 --- a/plotly/validators/parcoords/rangefont/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='parcoords.rangefont', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/rangefont/_family.py b/plotly/validators/parcoords/rangefont/_family.py deleted file mode 100644 index f9427c92142..00000000000 --- a/plotly/validators/parcoords/rangefont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='parcoords.rangefont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/parcoords/rangefont/_size.py b/plotly/validators/parcoords/rangefont/_size.py deleted file mode 100644 index 1336e7f4c92..00000000000 --- a/plotly/validators/parcoords/rangefont/_size.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='parcoords.rangefont', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/stream/__init__.py b/plotly/validators/parcoords/stream/__init__.py index 2f4f2047594..66cf7ed8a04 100644 --- a/plotly/validators/parcoords/stream/__init__.py +++ b/plotly/validators/parcoords/stream/__init__.py @@ -1,2 +1,41 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='parcoords.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='parcoords.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/parcoords/stream/_maxpoints.py b/plotly/validators/parcoords/stream/_maxpoints.py deleted file mode 100644 index d432d66bca4..00000000000 --- a/plotly/validators/parcoords/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='parcoords.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/parcoords/stream/_token.py b/plotly/validators/parcoords/stream/_token.py deleted file mode 100644 index 465a12c430e..00000000000 --- a/plotly/validators/parcoords/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='parcoords.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/parcoords/tickfont/__init__.py b/plotly/validators/parcoords/tickfont/__init__.py index 199d72e71c6..4e454f16b02 100644 --- a/plotly/validators/parcoords/tickfont/__init__.py +++ b/plotly/validators/parcoords/tickfont/__init__.py @@ -1,3 +1,54 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='parcoords.tickfont', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='parcoords.tickfont', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='parcoords.tickfont', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/parcoords/tickfont/_color.py b/plotly/validators/parcoords/tickfont/_color.py deleted file mode 100644 index aa3c272fab2..00000000000 --- a/plotly/validators/parcoords/tickfont/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='parcoords.tickfont', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/parcoords/tickfont/_family.py b/plotly/validators/parcoords/tickfont/_family.py deleted file mode 100644 index 6e78a1f4d02..00000000000 --- a/plotly/validators/parcoords/tickfont/_family.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='parcoords.tickfont', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/parcoords/tickfont/_size.py b/plotly/validators/parcoords/tickfont/_size.py deleted file mode 100644 index 91ae5a607c2..00000000000 --- a/plotly/validators/parcoords/tickfont/_size.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='parcoords.tickfont', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/__init__.py b/plotly/validators/pie/__init__.py index d88e05f1be6..c5dca54b57c 100644 --- a/plotly/validators/pie/__init__.py +++ b/plotly/validators/pie/__init__.py @@ -1,44 +1,887 @@ -from ._visible import VisibleValidator -from ._valuessrc import ValuessrcValidator -from ._values import ValuesValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._title import TitleValidator -from ._textsrc import TextsrcValidator -from ._textpositionsrc import TextpositionsrcValidator -from ._textposition import TextpositionValidator -from ._textinfo import TextinfoValidator -from ._textfont import TextfontValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._sort import SortValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._scalegroup import ScalegroupValidator -from ._rotation import RotationValidator -from ._pullsrc import PullsrcValidator -from ._pull import PullValidator -from ._outsidetextfont import OutsidetextfontValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._marker import MarkerValidator -from ._legendgroup import LegendgroupValidator -from ._labelssrc import LabelssrcValidator -from ._labels import LabelsValidator -from ._label0 import Label0Validator -from ._insidetextfont import InsidetextfontValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._hole import HoleValidator -from ._domain import DomainValidator -from ._dlabel import DlabelValidator -from ._direction import DirectionValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='pie', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValuessrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='valuessrc', parent_name='pie', **kwargs): + super(ValuessrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValuesValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='values', parent_name='pie', **kwargs): + super(ValuesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='uirevision', parent_name='pie', **kwargs): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='pie', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__(self, plotly_name='title', parent_name='pie', **kwargs): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets the font used for `title`. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + position + Specifies the location of the `title`. Note + that the title's position used to be set by the + now deprecated `titleposition` attribute. + text + Sets the title of the pie chart. If it is + empty, no title is displayed. Note that before + the existence of `title.text`, the title's + contents used to be defined as the `title` + attribute itself. This behavior has been + deprecated. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='textsrc', parent_name='pie', **kwargs): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textpositionsrc', parent_name='pie', **kwargs + ): + super(TextpositionsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='textposition', parent_name='pie', **kwargs + ): + super(TextpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['inside', 'outside', 'auto', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__(self, plotly_name='textinfo', parent_name='pie', **kwargs): + super(TextinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['none']), + flags=kwargs.pop('flags', ['label', 'text', 'value', 'percent']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='textfont', parent_name='pie', **kwargs): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='text', parent_name='pie', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='pie', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SortValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='sort', parent_name='pie', **kwargs): + super(SortValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='showlegend', parent_name='pie', **kwargs): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='pie', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScalegroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='scalegroup', parent_name='pie', **kwargs): + super(ScalegroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RotationValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='rotation', parent_name='pie', **kwargs): + super(RotationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 360), + min=kwargs.pop('min', -360), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PullsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='pullsrc', parent_name='pie', **kwargs): + super(PullsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PullValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='pull', parent_name='pie', **kwargs): + super(PullValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutsidetextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='outsidetextfont', parent_name='pie', **kwargs + ): + super(OutsidetextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Outsidetextfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='opacity', parent_name='pie', **kwargs): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='pie', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='marker', parent_name='pie', **kwargs): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + colors + Sets the color of each sector of this pie + chart. If not specified, the default trace + color set is used to pick the sector colors. + colorssrc + Sets the source reference on plot.ly for + colors . + line + plotly.graph_objs.pie.marker.Line instance or + dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='legendgroup', parent_name='pie', **kwargs): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='labelssrc', parent_name='pie', **kwargs): + super(LabelssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='labels', parent_name='pie', **kwargs): + super(LabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Label0Validator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='label0', parent_name='pie', **kwargs): + super(Label0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class InsidetextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='insidetextfont', parent_name='pie', **kwargs + ): + super(InsidetextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Insidetextfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='pie', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='pie', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='pie', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='hovertext', parent_name='pie', **kwargs): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertemplatesrc', parent_name='pie', **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='pie', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='hoverlabel', parent_name='pie', **kwargs): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='pie', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__(self, plotly_name='hoverinfo', parent_name='pie', **kwargs): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop( + 'flags', ['label', 'text', 'value', 'percent', 'name'] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoleValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='hole', parent_name='pie', **kwargs): + super(HoleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='domain', parent_name='pie', **kwargs): + super(DomainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Domain'), + data_docs=kwargs.pop( + 'data_docs', """ + column + If there is a layout grid, use the domain for + this column in the grid for this pie trace . + row + If there is a layout grid, use the domain for + this row in the grid for this pie trace . + x + Sets the horizontal domain of this pie trace + (in plot fraction). + y + Sets the vertical domain of this pie trace (in + plot fraction). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DlabelValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='dlabel', parent_name='pie', **kwargs): + super(DlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DirectionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='direction', parent_name='pie', **kwargs): + super(DirectionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['clockwise', 'counterclockwise']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='pie', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='customdata', parent_name='pie', **kwargs): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/pie/_customdata.py b/plotly/validators/pie/_customdata.py deleted file mode 100644 index 16590e8364d..00000000000 --- a/plotly/validators/pie/_customdata.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='customdata', parent_name='pie', **kwargs): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/pie/_customdatasrc.py b/plotly/validators/pie/_customdatasrc.py deleted file mode 100644 index 49c1dc575b4..00000000000 --- a/plotly/validators/pie/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='pie', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_direction.py b/plotly/validators/pie/_direction.py deleted file mode 100644 index 9d15e5ca1f3..00000000000 --- a/plotly/validators/pie/_direction.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class DirectionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='direction', parent_name='pie', **kwargs): - super(DirectionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['clockwise', 'counterclockwise']), - **kwargs - ) diff --git a/plotly/validators/pie/_dlabel.py b/plotly/validators/pie/_dlabel.py deleted file mode 100644 index 44de3483220..00000000000 --- a/plotly/validators/pie/_dlabel.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class DlabelValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='dlabel', parent_name='pie', **kwargs): - super(DlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_domain.py b/plotly/validators/pie/_domain.py deleted file mode 100644 index c97f35560d3..00000000000 --- a/plotly/validators/pie/_domain.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='domain', parent_name='pie', **kwargs): - super(DomainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Domain'), - data_docs=kwargs.pop( - 'data_docs', """ - column - If there is a layout grid, use the domain for - this column in the grid for this pie trace . - row - If there is a layout grid, use the domain for - this row in the grid for this pie trace . - x - Sets the horizontal domain of this pie trace - (in plot fraction). - y - Sets the vertical domain of this pie trace (in - plot fraction). -""" - ), - **kwargs - ) diff --git a/plotly/validators/pie/_hole.py b/plotly/validators/pie/_hole.py deleted file mode 100644 index 51547c47195..00000000000 --- a/plotly/validators/pie/_hole.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoleValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='hole', parent_name='pie', **kwargs): - super(HoleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/_hoverinfo.py b/plotly/validators/pie/_hoverinfo.py deleted file mode 100644 index 7c640a36ec2..00000000000 --- a/plotly/validators/pie/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__(self, plotly_name='hoverinfo', parent_name='pie', **kwargs): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop( - 'flags', ['label', 'text', 'value', 'percent', 'name'] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_hoverinfosrc.py b/plotly/validators/pie/_hoverinfosrc.py deleted file mode 100644 index ac052921711..00000000000 --- a/plotly/validators/pie/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='pie', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_hoverlabel.py b/plotly/validators/pie/_hoverlabel.py deleted file mode 100644 index d23cfc2c75f..00000000000 --- a/plotly/validators/pie/_hoverlabel.py +++ /dev/null @@ -1,42 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='hoverlabel', parent_name='pie', **kwargs): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/pie/_hovertemplate.py b/plotly/validators/pie/_hovertemplate.py deleted file mode 100644 index df6de49a796..00000000000 --- a/plotly/validators/pie/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='pie', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_hovertemplatesrc.py b/plotly/validators/pie/_hovertemplatesrc.py deleted file mode 100644 index 5da44573746..00000000000 --- a/plotly/validators/pie/_hovertemplatesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertemplatesrc', parent_name='pie', **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_hovertext.py b/plotly/validators/pie/_hovertext.py deleted file mode 100644 index 04ce4c53762..00000000000 --- a/plotly/validators/pie/_hovertext.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='hovertext', parent_name='pie', **kwargs): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_hovertextsrc.py b/plotly/validators/pie/_hovertextsrc.py deleted file mode 100644 index e3b3acf59d6..00000000000 --- a/plotly/validators/pie/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='pie', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_ids.py b/plotly/validators/pie/_ids.py deleted file mode 100644 index c951155668c..00000000000 --- a/plotly/validators/pie/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='pie', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/pie/_idssrc.py b/plotly/validators/pie/_idssrc.py deleted file mode 100644 index 76ba7046a48..00000000000 --- a/plotly/validators/pie/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='pie', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_insidetextfont.py b/plotly/validators/pie/_insidetextfont.py deleted file mode 100644 index 1db003c9c23..00000000000 --- a/plotly/validators/pie/_insidetextfont.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class InsidetextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='insidetextfont', parent_name='pie', **kwargs - ): - super(InsidetextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Insidetextfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/pie/_label0.py b/plotly/validators/pie/_label0.py deleted file mode 100644 index e9bf47f83d5..00000000000 --- a/plotly/validators/pie/_label0.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class Label0Validator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='label0', parent_name='pie', **kwargs): - super(Label0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_labels.py b/plotly/validators/pie/_labels.py deleted file mode 100644 index 4c2bad8a49f..00000000000 --- a/plotly/validators/pie/_labels.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='labels', parent_name='pie', **kwargs): - super(LabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/pie/_labelssrc.py b/plotly/validators/pie/_labelssrc.py deleted file mode 100644 index e1a1696989f..00000000000 --- a/plotly/validators/pie/_labelssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='labelssrc', parent_name='pie', **kwargs): - super(LabelssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_legendgroup.py b/plotly/validators/pie/_legendgroup.py deleted file mode 100644 index 6ccede257ce..00000000000 --- a/plotly/validators/pie/_legendgroup.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='legendgroup', parent_name='pie', **kwargs): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_marker.py b/plotly/validators/pie/_marker.py deleted file mode 100644 index 99ddc5400f2..00000000000 --- a/plotly/validators/pie/_marker.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='marker', parent_name='pie', **kwargs): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - colors - Sets the color of each sector of this pie - chart. If not specified, the default trace - color set is used to pick the sector colors. - colorssrc - Sets the source reference on plot.ly for - colors . - line - plotly.graph_objs.pie.marker.Line instance or - dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/pie/_name.py b/plotly/validators/pie/_name.py deleted file mode 100644 index 9f0c9d45cfd..00000000000 --- a/plotly/validators/pie/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='pie', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_opacity.py b/plotly/validators/pie/_opacity.py deleted file mode 100644 index cb52688f465..00000000000 --- a/plotly/validators/pie/_opacity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='opacity', parent_name='pie', **kwargs): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/_outsidetextfont.py b/plotly/validators/pie/_outsidetextfont.py deleted file mode 100644 index aede65cea83..00000000000 --- a/plotly/validators/pie/_outsidetextfont.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutsidetextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='outsidetextfont', parent_name='pie', **kwargs - ): - super(OutsidetextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Outsidetextfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/pie/_pull.py b/plotly/validators/pie/_pull.py deleted file mode 100644 index df2a7a410ac..00000000000 --- a/plotly/validators/pie/_pull.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class PullValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='pull', parent_name='pie', **kwargs): - super(PullValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/_pullsrc.py b/plotly/validators/pie/_pullsrc.py deleted file mode 100644 index 8a14af24f38..00000000000 --- a/plotly/validators/pie/_pullsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class PullsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='pullsrc', parent_name='pie', **kwargs): - super(PullsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_rotation.py b/plotly/validators/pie/_rotation.py deleted file mode 100644 index 38193ea4197..00000000000 --- a/plotly/validators/pie/_rotation.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class RotationValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='rotation', parent_name='pie', **kwargs): - super(RotationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 360), - min=kwargs.pop('min', -360), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/_scalegroup.py b/plotly/validators/pie/_scalegroup.py deleted file mode 100644 index 9022ce5e1c6..00000000000 --- a/plotly/validators/pie/_scalegroup.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScalegroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='scalegroup', parent_name='pie', **kwargs): - super(ScalegroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_selectedpoints.py b/plotly/validators/pie/_selectedpoints.py deleted file mode 100644 index ff1cc826102..00000000000 --- a/plotly/validators/pie/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='pie', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_showlegend.py b/plotly/validators/pie/_showlegend.py deleted file mode 100644 index c20afb8c47b..00000000000 --- a/plotly/validators/pie/_showlegend.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='showlegend', parent_name='pie', **kwargs): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_sort.py b/plotly/validators/pie/_sort.py deleted file mode 100644 index dd6962aae9a..00000000000 --- a/plotly/validators/pie/_sort.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class SortValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='sort', parent_name='pie', **kwargs): - super(SortValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/_stream.py b/plotly/validators/pie/_stream.py deleted file mode 100644 index ee74df77482..00000000000 --- a/plotly/validators/pie/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='pie', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/pie/_text.py b/plotly/validators/pie/_text.py deleted file mode 100644 index f4d6b8dd871..00000000000 --- a/plotly/validators/pie/_text.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='text', parent_name='pie', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/pie/_textfont.py b/plotly/validators/pie/_textfont.py deleted file mode 100644 index ae389b2662c..00000000000 --- a/plotly/validators/pie/_textfont.py +++ /dev/null @@ -1,45 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='textfont', parent_name='pie', **kwargs): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/pie/_textinfo.py b/plotly/validators/pie/_textinfo.py deleted file mode 100644 index 535f06b2e6c..00000000000 --- a/plotly/validators/pie/_textinfo.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__(self, plotly_name='textinfo', parent_name='pie', **kwargs): - super(TextinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['none']), - flags=kwargs.pop('flags', ['label', 'text', 'value', 'percent']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_textposition.py b/plotly/validators/pie/_textposition.py deleted file mode 100644 index 0b053a2a40e..00000000000 --- a/plotly/validators/pie/_textposition.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='textposition', parent_name='pie', **kwargs - ): - super(TextpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['inside', 'outside', 'auto', 'none']), - **kwargs - ) diff --git a/plotly/validators/pie/_textpositionsrc.py b/plotly/validators/pie/_textpositionsrc.py deleted file mode 100644 index 75a7b20bf62..00000000000 --- a/plotly/validators/pie/_textpositionsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textpositionsrc', parent_name='pie', **kwargs - ): - super(TextpositionsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_textsrc.py b/plotly/validators/pie/_textsrc.py deleted file mode 100644 index 8aaba46f209..00000000000 --- a/plotly/validators/pie/_textsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='textsrc', parent_name='pie', **kwargs): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_title.py b/plotly/validators/pie/_title.py deleted file mode 100644 index d2ef724cdc5..00000000000 --- a/plotly/validators/pie/_title.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__(self, plotly_name='title', parent_name='pie', **kwargs): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets the font used for `title`. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - position - Specifies the location of the `title`. Note - that the title's position used to be set by the - now deprecated `titleposition` attribute. - text - Sets the title of the pie chart. If it is - empty, no title is displayed. Note that before - the existence of `title.text`, the title's - contents used to be defined as the `title` - attribute itself. This behavior has been - deprecated. -""" - ), - **kwargs - ) diff --git a/plotly/validators/pie/_uid.py b/plotly/validators/pie/_uid.py deleted file mode 100644 index 919e4a060de..00000000000 --- a/plotly/validators/pie/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='pie', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_uirevision.py b/plotly/validators/pie/_uirevision.py deleted file mode 100644 index db0930c1f33..00000000000 --- a/plotly/validators/pie/_uirevision.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='uirevision', parent_name='pie', **kwargs): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_values.py b/plotly/validators/pie/_values.py deleted file mode 100644 index 463dbce641f..00000000000 --- a/plotly/validators/pie/_values.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValuesValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='values', parent_name='pie', **kwargs): - super(ValuesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/pie/_valuessrc.py b/plotly/validators/pie/_valuessrc.py deleted file mode 100644 index 862750242d3..00000000000 --- a/plotly/validators/pie/_valuessrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValuessrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='valuessrc', parent_name='pie', **kwargs): - super(ValuessrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/_visible.py b/plotly/validators/pie/_visible.py deleted file mode 100644 index 8ffa8240740..00000000000 --- a/plotly/validators/pie/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='pie', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/pie/domain/__init__.py b/plotly/validators/pie/domain/__init__.py index 6cf32248236..5bdba524a93 100644 --- a/plotly/validators/pie/domain/__init__.py +++ b/plotly/validators/pie/domain/__init__.py @@ -1,4 +1,96 @@ -from ._y import YValidator -from ._x import XValidator -from ._row import RowValidator -from ._column import ColumnValidator + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__(self, plotly_name='y', parent_name='pie.domain', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__(self, plotly_name='x', parent_name='pie.domain', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RowValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__(self, plotly_name='row', parent_name='pie.domain', **kwargs): + super(RowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='column', parent_name='pie.domain', **kwargs + ): + super(ColumnValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/pie/domain/_column.py b/plotly/validators/pie/domain/_column.py deleted file mode 100644 index bae15637942..00000000000 --- a/plotly/validators/pie/domain/_column.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='column', parent_name='pie.domain', **kwargs - ): - super(ColumnValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/domain/_row.py b/plotly/validators/pie/domain/_row.py deleted file mode 100644 index 933e9aa7457..00000000000 --- a/plotly/validators/pie/domain/_row.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class RowValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__(self, plotly_name='row', parent_name='pie.domain', **kwargs): - super(RowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/domain/_x.py b/plotly/validators/pie/domain/_x.py deleted file mode 100644 index d618e3d4b0e..00000000000 --- a/plotly/validators/pie/domain/_x.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__(self, plotly_name='x', parent_name='pie.domain', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/domain/_y.py b/plotly/validators/pie/domain/_y.py deleted file mode 100644 index 437ced3a491..00000000000 --- a/plotly/validators/pie/domain/_y.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__(self, plotly_name='y', parent_name='pie.domain', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/hoverlabel/__init__.py b/plotly/validators/pie/hoverlabel/__init__.py index 856f769ba33..4846e4cc5b4 100644 --- a/plotly/validators/pie/hoverlabel/__init__.py +++ b/plotly/validators/pie/hoverlabel/__init__.py @@ -1,7 +1,164 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='pie.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='namelength', parent_name='pie.hoverlabel', **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='pie.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='pie.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='pie.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='bgcolorsrc', parent_name='pie.hoverlabel', **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='pie.hoverlabel', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/pie/hoverlabel/_bgcolor.py b/plotly/validators/pie/hoverlabel/_bgcolor.py deleted file mode 100644 index b87e223afcc..00000000000 --- a/plotly/validators/pie/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='pie.hoverlabel', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/hoverlabel/_bgcolorsrc.py b/plotly/validators/pie/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 0865582d8eb..00000000000 --- a/plotly/validators/pie/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='bgcolorsrc', parent_name='pie.hoverlabel', **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/hoverlabel/_bordercolor.py b/plotly/validators/pie/hoverlabel/_bordercolor.py deleted file mode 100644 index 422a993796c..00000000000 --- a/plotly/validators/pie/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='pie.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/hoverlabel/_bordercolorsrc.py b/plotly/validators/pie/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index ed2ba4e2df1..00000000000 --- a/plotly/validators/pie/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='pie.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/hoverlabel/_font.py b/plotly/validators/pie/hoverlabel/_font.py deleted file mode 100644 index 09d0ffee4fb..00000000000 --- a/plotly/validators/pie/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='pie.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/pie/hoverlabel/_namelength.py b/plotly/validators/pie/hoverlabel/_namelength.py deleted file mode 100644 index d07f122aa51..00000000000 --- a/plotly/validators/pie/hoverlabel/_namelength.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='namelength', parent_name='pie.hoverlabel', **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/hoverlabel/_namelengthsrc.py b/plotly/validators/pie/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 9ba13a5b2ec..00000000000 --- a/plotly/validators/pie/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='pie.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/hoverlabel/font/__init__.py b/plotly/validators/pie/hoverlabel/font/__init__.py index 1d2c591d1e5..6f9a4603ac7 100644 --- a/plotly/validators/pie/hoverlabel/font/__init__.py +++ b/plotly/validators/pie/hoverlabel/font/__init__.py @@ -1,6 +1,120 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='pie.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='pie.hoverlabel.font', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='pie.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='pie.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='pie.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='pie.hoverlabel.font', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/pie/hoverlabel/font/_color.py b/plotly/validators/pie/hoverlabel/font/_color.py deleted file mode 100644 index 7b5d3fa0b0c..00000000000 --- a/plotly/validators/pie/hoverlabel/font/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='pie.hoverlabel.font', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/hoverlabel/font/_colorsrc.py b/plotly/validators/pie/hoverlabel/font/_colorsrc.py deleted file mode 100644 index cbdeff8dfff..00000000000 --- a/plotly/validators/pie/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='pie.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/hoverlabel/font/_family.py b/plotly/validators/pie/hoverlabel/font/_family.py deleted file mode 100644 index 5a2668d6ef0..00000000000 --- a/plotly/validators/pie/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='pie.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/pie/hoverlabel/font/_familysrc.py b/plotly/validators/pie/hoverlabel/font/_familysrc.py deleted file mode 100644 index d724443c25d..00000000000 --- a/plotly/validators/pie/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='pie.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/hoverlabel/font/_size.py b/plotly/validators/pie/hoverlabel/font/_size.py deleted file mode 100644 index 21491ef3981..00000000000 --- a/plotly/validators/pie/hoverlabel/font/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='pie.hoverlabel.font', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/hoverlabel/font/_sizesrc.py b/plotly/validators/pie/hoverlabel/font/_sizesrc.py deleted file mode 100644 index fd8e94f7710..00000000000 --- a/plotly/validators/pie/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='pie.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/insidetextfont/__init__.py b/plotly/validators/pie/insidetextfont/__init__.py index 1d2c591d1e5..4edcd45594f 100644 --- a/plotly/validators/pie/insidetextfont/__init__.py +++ b/plotly/validators/pie/insidetextfont/__init__.py @@ -1,6 +1,117 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='pie.insidetextfont', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='pie.insidetextfont', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='pie.insidetextfont', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='pie.insidetextfont', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='pie.insidetextfont', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='pie.insidetextfont', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/pie/insidetextfont/_color.py b/plotly/validators/pie/insidetextfont/_color.py deleted file mode 100644 index 55c31d83482..00000000000 --- a/plotly/validators/pie/insidetextfont/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='pie.insidetextfont', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/insidetextfont/_colorsrc.py b/plotly/validators/pie/insidetextfont/_colorsrc.py deleted file mode 100644 index 0d7d6fedfec..00000000000 --- a/plotly/validators/pie/insidetextfont/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='pie.insidetextfont', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/insidetextfont/_family.py b/plotly/validators/pie/insidetextfont/_family.py deleted file mode 100644 index f9c4cdd5c8a..00000000000 --- a/plotly/validators/pie/insidetextfont/_family.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='pie.insidetextfont', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/pie/insidetextfont/_familysrc.py b/plotly/validators/pie/insidetextfont/_familysrc.py deleted file mode 100644 index 18fe5b767cb..00000000000 --- a/plotly/validators/pie/insidetextfont/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='pie.insidetextfont', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/insidetextfont/_size.py b/plotly/validators/pie/insidetextfont/_size.py deleted file mode 100644 index cf042f0c20f..00000000000 --- a/plotly/validators/pie/insidetextfont/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='pie.insidetextfont', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/insidetextfont/_sizesrc.py b/plotly/validators/pie/insidetextfont/_sizesrc.py deleted file mode 100644 index c441d8782e0..00000000000 --- a/plotly/validators/pie/insidetextfont/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='pie.insidetextfont', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/marker/__init__.py b/plotly/validators/pie/marker/__init__.py index 899d77e755b..e5637daf4be 100644 --- a/plotly/validators/pie/marker/__init__.py +++ b/plotly/validators/pie/marker/__init__.py @@ -1,3 +1,64 @@ -from ._line import LineValidator -from ._colorssrc import ColorssrcValidator -from ._colors import ColorsValidator + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='line', parent_name='pie.marker', **kwargs): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the color of the line enclosing each + sector. + colorsrc + Sets the source reference on plot.ly for color + . + width + Sets the width (in px) of the line enclosing + each sector. + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorssrc', parent_name='pie.marker', **kwargs + ): + super(ColorssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='colors', parent_name='pie.marker', **kwargs + ): + super(ColorsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/pie/marker/_colors.py b/plotly/validators/pie/marker/_colors.py deleted file mode 100644 index f2431665648..00000000000 --- a/plotly/validators/pie/marker/_colors.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='colors', parent_name='pie.marker', **kwargs - ): - super(ColorsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/pie/marker/_colorssrc.py b/plotly/validators/pie/marker/_colorssrc.py deleted file mode 100644 index 7198e3499a3..00000000000 --- a/plotly/validators/pie/marker/_colorssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorssrc', parent_name='pie.marker', **kwargs - ): - super(ColorssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/marker/_line.py b/plotly/validators/pie/marker/_line.py deleted file mode 100644 index f45b40baf8a..00000000000 --- a/plotly/validators/pie/marker/_line.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='line', parent_name='pie.marker', **kwargs): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the color of the line enclosing each - sector. - colorsrc - Sets the source reference on plot.ly for color - . - width - Sets the width (in px) of the line enclosing - each sector. - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/pie/marker/line/__init__.py b/plotly/validators/pie/marker/line/__init__.py index 1c7b37b04f2..71f596bd135 100644 --- a/plotly/validators/pie/marker/line/__init__.py +++ b/plotly/validators/pie/marker/line/__init__.py @@ -1,4 +1,71 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='widthsrc', parent_name='pie.marker.line', **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='pie.marker.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='pie.marker.line', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='pie.marker.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/pie/marker/line/_color.py b/plotly/validators/pie/marker/line/_color.py deleted file mode 100644 index b66b358d887..00000000000 --- a/plotly/validators/pie/marker/line/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='pie.marker.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/marker/line/_colorsrc.py b/plotly/validators/pie/marker/line/_colorsrc.py deleted file mode 100644 index 686c0d57d50..00000000000 --- a/plotly/validators/pie/marker/line/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='pie.marker.line', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/marker/line/_width.py b/plotly/validators/pie/marker/line/_width.py deleted file mode 100644 index 941a159cd95..00000000000 --- a/plotly/validators/pie/marker/line/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='pie.marker.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/marker/line/_widthsrc.py b/plotly/validators/pie/marker/line/_widthsrc.py deleted file mode 100644 index 05b69861831..00000000000 --- a/plotly/validators/pie/marker/line/_widthsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='widthsrc', parent_name='pie.marker.line', **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/outsidetextfont/__init__.py b/plotly/validators/pie/outsidetextfont/__init__.py index 1d2c591d1e5..079bab726b9 100644 --- a/plotly/validators/pie/outsidetextfont/__init__.py +++ b/plotly/validators/pie/outsidetextfont/__init__.py @@ -1,6 +1,120 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='pie.outsidetextfont', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='pie.outsidetextfont', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='pie.outsidetextfont', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='pie.outsidetextfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='pie.outsidetextfont', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='pie.outsidetextfont', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/pie/outsidetextfont/_color.py b/plotly/validators/pie/outsidetextfont/_color.py deleted file mode 100644 index b5fe0dd4939..00000000000 --- a/plotly/validators/pie/outsidetextfont/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='pie.outsidetextfont', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/outsidetextfont/_colorsrc.py b/plotly/validators/pie/outsidetextfont/_colorsrc.py deleted file mode 100644 index cde65c127a3..00000000000 --- a/plotly/validators/pie/outsidetextfont/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='pie.outsidetextfont', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/outsidetextfont/_family.py b/plotly/validators/pie/outsidetextfont/_family.py deleted file mode 100644 index 0812b0647f0..00000000000 --- a/plotly/validators/pie/outsidetextfont/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='pie.outsidetextfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/pie/outsidetextfont/_familysrc.py b/plotly/validators/pie/outsidetextfont/_familysrc.py deleted file mode 100644 index 75e85dc9d4a..00000000000 --- a/plotly/validators/pie/outsidetextfont/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='pie.outsidetextfont', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/outsidetextfont/_size.py b/plotly/validators/pie/outsidetextfont/_size.py deleted file mode 100644 index 041593bafc4..00000000000 --- a/plotly/validators/pie/outsidetextfont/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='pie.outsidetextfont', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/outsidetextfont/_sizesrc.py b/plotly/validators/pie/outsidetextfont/_sizesrc.py deleted file mode 100644 index 1490b817ca0..00000000000 --- a/plotly/validators/pie/outsidetextfont/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='pie.outsidetextfont', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/stream/__init__.py b/plotly/validators/pie/stream/__init__.py index 2f4f2047594..1b6c803f1cc 100644 --- a/plotly/validators/pie/stream/__init__.py +++ b/plotly/validators/pie/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='pie.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='pie.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/pie/stream/_maxpoints.py b/plotly/validators/pie/stream/_maxpoints.py deleted file mode 100644 index f7b7045537b..00000000000 --- a/plotly/validators/pie/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='pie.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/stream/_token.py b/plotly/validators/pie/stream/_token.py deleted file mode 100644 index 6d091487de0..00000000000 --- a/plotly/validators/pie/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='pie.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/pie/textfont/__init__.py b/plotly/validators/pie/textfont/__init__.py index 1d2c591d1e5..625a51eee6f 100644 --- a/plotly/validators/pie/textfont/__init__.py +++ b/plotly/validators/pie/textfont/__init__.py @@ -1,6 +1,108 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='sizesrc', parent_name='pie.textfont', **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='pie.textfont', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='familysrc', parent_name='pie.textfont', **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='pie.textfont', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='pie.textfont', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='pie.textfont', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/pie/textfont/_color.py b/plotly/validators/pie/textfont/_color.py deleted file mode 100644 index 6d7175c293d..00000000000 --- a/plotly/validators/pie/textfont/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='pie.textfont', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/textfont/_colorsrc.py b/plotly/validators/pie/textfont/_colorsrc.py deleted file mode 100644 index 142fe68ff5c..00000000000 --- a/plotly/validators/pie/textfont/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='pie.textfont', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/textfont/_family.py b/plotly/validators/pie/textfont/_family.py deleted file mode 100644 index 16cac7c3837..00000000000 --- a/plotly/validators/pie/textfont/_family.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='pie.textfont', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/pie/textfont/_familysrc.py b/plotly/validators/pie/textfont/_familysrc.py deleted file mode 100644 index 30fb40da718..00000000000 --- a/plotly/validators/pie/textfont/_familysrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='familysrc', parent_name='pie.textfont', **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/textfont/_size.py b/plotly/validators/pie/textfont/_size.py deleted file mode 100644 index 61a9fb9e462..00000000000 --- a/plotly/validators/pie/textfont/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='pie.textfont', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/textfont/_sizesrc.py b/plotly/validators/pie/textfont/_sizesrc.py deleted file mode 100644 index c201e897a06..00000000000 --- a/plotly/validators/pie/textfont/_sizesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='sizesrc', parent_name='pie.textfont', **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/title/__init__.py b/plotly/validators/pie/title/__init__.py index 4f9b500eee2..9336f10e655 100644 --- a/plotly/validators/pie/title/__init__.py +++ b/plotly/validators/pie/title/__init__.py @@ -1,3 +1,85 @@ -from ._text import TextValidator -from ._position import PositionValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='pie.title', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='position', parent_name='pie.title', **kwargs + ): + super(PositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'top left', 'top center', 'top right', 'middle center', + 'bottom left', 'bottom center', 'bottom right' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='font', parent_name='pie.title', **kwargs): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) diff --git a/plotly/validators/pie/title/_font.py b/plotly/validators/pie/title/_font.py deleted file mode 100644 index b62eda83d54..00000000000 --- a/plotly/validators/pie/title/_font.py +++ /dev/null @@ -1,45 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='font', parent_name='pie.title', **kwargs): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/pie/title/_position.py b/plotly/validators/pie/title/_position.py deleted file mode 100644 index 87f74e6d987..00000000000 --- a/plotly/validators/pie/title/_position.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class PositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='position', parent_name='pie.title', **kwargs - ): - super(PositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'top left', 'top center', 'top right', 'middle center', - 'bottom left', 'bottom center', 'bottom right' - ] - ), - **kwargs - ) diff --git a/plotly/validators/pie/title/_text.py b/plotly/validators/pie/title/_text.py deleted file mode 100644 index 7b192833dcf..00000000000 --- a/plotly/validators/pie/title/_text.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='pie.title', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/title/font/__init__.py b/plotly/validators/pie/title/font/__init__.py index 1d2c591d1e5..f5c2537ccdd 100644 --- a/plotly/validators/pie/title/font/__init__.py +++ b/plotly/validators/pie/title/font/__init__.py @@ -1,6 +1,108 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='sizesrc', parent_name='pie.title.font', **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='pie.title.font', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='familysrc', parent_name='pie.title.font', **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='pie.title.font', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='pie.title.font', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='pie.title.font', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/pie/title/font/_color.py b/plotly/validators/pie/title/font/_color.py deleted file mode 100644 index 2e2e822d01b..00000000000 --- a/plotly/validators/pie/title/font/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='pie.title.font', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/title/font/_colorsrc.py b/plotly/validators/pie/title/font/_colorsrc.py deleted file mode 100644 index 683c464c90a..00000000000 --- a/plotly/validators/pie/title/font/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='pie.title.font', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/title/font/_family.py b/plotly/validators/pie/title/font/_family.py deleted file mode 100644 index 35558adda7f..00000000000 --- a/plotly/validators/pie/title/font/_family.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='pie.title.font', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/pie/title/font/_familysrc.py b/plotly/validators/pie/title/font/_familysrc.py deleted file mode 100644 index 2796c481146..00000000000 --- a/plotly/validators/pie/title/font/_familysrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='familysrc', parent_name='pie.title.font', **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pie/title/font/_size.py b/plotly/validators/pie/title/font/_size.py deleted file mode 100644 index e4cf1f8f835..00000000000 --- a/plotly/validators/pie/title/font/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='pie.title.font', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pie/title/font/_sizesrc.py b/plotly/validators/pie/title/font/_sizesrc.py deleted file mode 100644 index d6348b05eea..00000000000 --- a/plotly/validators/pie/title/font/_sizesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='sizesrc', parent_name='pie.title.font', **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/__init__.py b/plotly/validators/pointcloud/__init__.py index da629ff3bc7..d738f8ebef4 100644 --- a/plotly/validators/pointcloud/__init__.py +++ b/plotly/validators/pointcloud/__init__.py @@ -1,33 +1,630 @@ -from ._ysrc import YsrcValidator -from ._yboundssrc import YboundssrcValidator -from ._ybounds import YboundsValidator -from ._yaxis import YAxisValidator -from ._y import YValidator -from ._xysrc import XysrcValidator -from ._xy import XyValidator -from ._xsrc import XsrcValidator -from ._xboundssrc import XboundssrcValidator -from ._xbounds import XboundsValidator -from ._xaxis import XAxisValidator -from ._x import XValidator -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._marker import MarkerValidator -from ._legendgroup import LegendgroupValidator -from ._indicessrc import IndicessrcValidator -from ._indices import IndicesValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='pointcloud', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YboundssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='yboundssrc', parent_name='pointcloud', **kwargs + ): + super(YboundssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YboundsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ybounds', parent_name='pointcloud', **kwargs + ): + super(YboundsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='yaxis', parent_name='pointcloud', **kwargs + ): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='pointcloud', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='xysrc', parent_name='pointcloud', **kwargs + ): + super(XysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XyValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='xy', parent_name='pointcloud', **kwargs): + super(XyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='pointcloud', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XboundssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='xboundssrc', parent_name='pointcloud', **kwargs + ): + super(XboundssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XboundsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='xbounds', parent_name='pointcloud', **kwargs + ): + super(XboundsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='xaxis', parent_name='pointcloud', **kwargs + ): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='pointcloud', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='pointcloud', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='pointcloud', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='pointcloud', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textsrc', parent_name='pointcloud', **kwargs + ): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='pointcloud', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='pointcloud', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='pointcloud', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='pointcloud', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='pointcloud', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='pointcloud', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='pointcloud', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + blend + Determines if colors are blended together for a + translucency effect in case `opacity` is + specified as a value less then `1`. Setting + `blend` to `true` reduces zoom/pan speed if + used with large numbers of points. + border + plotly.graph_objs.pointcloud.marker.Border + instance or dict with compatible properties + color + Sets the marker fill color. It accepts a + specific color.If the color is not fully opaque + and there are hundreds of thousandsof points, + it may cause slower zooming and panning. + opacity + Sets the marker opacity. The default value is + `1` (fully opaque). If the markers are not + fully opaque and there are hundreds of + thousands of points, it may cause slower + zooming and panning. Opacity fades the color + even if `blend` is left on `false` even if + there is no translucency effect in that case. + sizemax + Sets the maximum size (in px) of the rendered + marker points. Effective when the `pointcloud` + shows only few points. + sizemin + Sets the minimum size (in px) of the rendered + marker points, effective when the `pointcloud` + shows a million or more points. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='pointcloud', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IndicessrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='indicessrc', parent_name='pointcloud', **kwargs + ): + super(IndicessrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IndicesValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='indices', parent_name='pointcloud', **kwargs + ): + super(IndicesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='pointcloud', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='pointcloud', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='pointcloud', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='pointcloud', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='pointcloud', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='pointcloud', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='pointcloud', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/pointcloud/_customdata.py b/plotly/validators/pointcloud/_customdata.py deleted file mode 100644 index d5c61c3716a..00000000000 --- a/plotly/validators/pointcloud/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='pointcloud', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_customdatasrc.py b/plotly/validators/pointcloud/_customdatasrc.py deleted file mode 100644 index 1f825cf09ea..00000000000 --- a/plotly/validators/pointcloud/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='pointcloud', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_hoverinfo.py b/plotly/validators/pointcloud/_hoverinfo.py deleted file mode 100644 index 5c2c873a6cb..00000000000 --- a/plotly/validators/pointcloud/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='pointcloud', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_hoverinfosrc.py b/plotly/validators/pointcloud/_hoverinfosrc.py deleted file mode 100644 index c837c4686d9..00000000000 --- a/plotly/validators/pointcloud/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='pointcloud', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_hoverlabel.py b/plotly/validators/pointcloud/_hoverlabel.py deleted file mode 100644 index 23d4aef6b70..00000000000 --- a/plotly/validators/pointcloud/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='pointcloud', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_ids.py b/plotly/validators/pointcloud/_ids.py deleted file mode 100644 index a8a2921de1f..00000000000 --- a/plotly/validators/pointcloud/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='pointcloud', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_idssrc.py b/plotly/validators/pointcloud/_idssrc.py deleted file mode 100644 index 1eb6981fdad..00000000000 --- a/plotly/validators/pointcloud/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='pointcloud', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_indices.py b/plotly/validators/pointcloud/_indices.py deleted file mode 100644 index ba6b36f0370..00000000000 --- a/plotly/validators/pointcloud/_indices.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IndicesValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='indices', parent_name='pointcloud', **kwargs - ): - super(IndicesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_indicessrc.py b/plotly/validators/pointcloud/_indicessrc.py deleted file mode 100644 index d66a9b9c5c5..00000000000 --- a/plotly/validators/pointcloud/_indicessrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IndicessrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='indicessrc', parent_name='pointcloud', **kwargs - ): - super(IndicessrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_legendgroup.py b/plotly/validators/pointcloud/_legendgroup.py deleted file mode 100644 index e5283786f85..00000000000 --- a/plotly/validators/pointcloud/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='pointcloud', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_marker.py b/plotly/validators/pointcloud/_marker.py deleted file mode 100644 index c96c871410d..00000000000 --- a/plotly/validators/pointcloud/_marker.py +++ /dev/null @@ -1,48 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='pointcloud', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - blend - Determines if colors are blended together for a - translucency effect in case `opacity` is - specified as a value less then `1`. Setting - `blend` to `true` reduces zoom/pan speed if - used with large numbers of points. - border - plotly.graph_objs.pointcloud.marker.Border - instance or dict with compatible properties - color - Sets the marker fill color. It accepts a - specific color.If the color is not fully opaque - and there are hundreds of thousandsof points, - it may cause slower zooming and panning. - opacity - Sets the marker opacity. The default value is - `1` (fully opaque). If the markers are not - fully opaque and there are hundreds of - thousands of points, it may cause slower - zooming and panning. Opacity fades the color - even if `blend` is left on `false` even if - there is no translucency effect in that case. - sizemax - Sets the maximum size (in px) of the rendered - marker points. Effective when the `pointcloud` - shows only few points. - sizemin - Sets the minimum size (in px) of the rendered - marker points, effective when the `pointcloud` - shows a million or more points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_name.py b/plotly/validators/pointcloud/_name.py deleted file mode 100644 index e6a0325db31..00000000000 --- a/plotly/validators/pointcloud/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='pointcloud', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_opacity.py b/plotly/validators/pointcloud/_opacity.py deleted file mode 100644 index 7a304648940..00000000000 --- a/plotly/validators/pointcloud/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='pointcloud', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_selectedpoints.py b/plotly/validators/pointcloud/_selectedpoints.py deleted file mode 100644 index eb200885f9f..00000000000 --- a/plotly/validators/pointcloud/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='pointcloud', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_showlegend.py b/plotly/validators/pointcloud/_showlegend.py deleted file mode 100644 index c23200954b5..00000000000 --- a/plotly/validators/pointcloud/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='pointcloud', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_stream.py b/plotly/validators/pointcloud/_stream.py deleted file mode 100644 index ee60ff59aa0..00000000000 --- a/plotly/validators/pointcloud/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='pointcloud', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_text.py b/plotly/validators/pointcloud/_text.py deleted file mode 100644 index 85e1c9bce83..00000000000 --- a/plotly/validators/pointcloud/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='pointcloud', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_textsrc.py b/plotly/validators/pointcloud/_textsrc.py deleted file mode 100644 index 5c92994bea3..00000000000 --- a/plotly/validators/pointcloud/_textsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textsrc', parent_name='pointcloud', **kwargs - ): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_uid.py b/plotly/validators/pointcloud/_uid.py deleted file mode 100644 index 8f8c5779e5f..00000000000 --- a/plotly/validators/pointcloud/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='pointcloud', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_uirevision.py b/plotly/validators/pointcloud/_uirevision.py deleted file mode 100644 index c6a1c1788e1..00000000000 --- a/plotly/validators/pointcloud/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='pointcloud', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_visible.py b/plotly/validators/pointcloud/_visible.py deleted file mode 100644 index 9610129e7b6..00000000000 --- a/plotly/validators/pointcloud/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='pointcloud', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_x.py b/plotly/validators/pointcloud/_x.py deleted file mode 100644 index bd0bd0dbe18..00000000000 --- a/plotly/validators/pointcloud/_x.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='pointcloud', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_xaxis.py b/plotly/validators/pointcloud/_xaxis.py deleted file mode 100644 index 17606aec5ca..00000000000 --- a/plotly/validators/pointcloud/_xaxis.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='xaxis', parent_name='pointcloud', **kwargs - ): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_xbounds.py b/plotly/validators/pointcloud/_xbounds.py deleted file mode 100644 index b42f08c06b7..00000000000 --- a/plotly/validators/pointcloud/_xbounds.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XboundsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='xbounds', parent_name='pointcloud', **kwargs - ): - super(XboundsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_xboundssrc.py b/plotly/validators/pointcloud/_xboundssrc.py deleted file mode 100644 index 868f2973d24..00000000000 --- a/plotly/validators/pointcloud/_xboundssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XboundssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='xboundssrc', parent_name='pointcloud', **kwargs - ): - super(XboundssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_xsrc.py b/plotly/validators/pointcloud/_xsrc.py deleted file mode 100644 index 6d03c85ff8d..00000000000 --- a/plotly/validators/pointcloud/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='pointcloud', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_xy.py b/plotly/validators/pointcloud/_xy.py deleted file mode 100644 index f9dac1b2dc7..00000000000 --- a/plotly/validators/pointcloud/_xy.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XyValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='xy', parent_name='pointcloud', **kwargs): - super(XyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_xysrc.py b/plotly/validators/pointcloud/_xysrc.py deleted file mode 100644 index d76bd7de33c..00000000000 --- a/plotly/validators/pointcloud/_xysrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='xysrc', parent_name='pointcloud', **kwargs - ): - super(XysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_y.py b/plotly/validators/pointcloud/_y.py deleted file mode 100644 index afde1583072..00000000000 --- a/plotly/validators/pointcloud/_y.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='pointcloud', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_yaxis.py b/plotly/validators/pointcloud/_yaxis.py deleted file mode 100644 index fe261ee4d50..00000000000 --- a/plotly/validators/pointcloud/_yaxis.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='yaxis', parent_name='pointcloud', **kwargs - ): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_ybounds.py b/plotly/validators/pointcloud/_ybounds.py deleted file mode 100644 index c0e3a0afe05..00000000000 --- a/plotly/validators/pointcloud/_ybounds.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YboundsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ybounds', parent_name='pointcloud', **kwargs - ): - super(YboundsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_yboundssrc.py b/plotly/validators/pointcloud/_yboundssrc.py deleted file mode 100644 index 5115763d339..00000000000 --- a/plotly/validators/pointcloud/_yboundssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YboundssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='yboundssrc', parent_name='pointcloud', **kwargs - ): - super(YboundssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/_ysrc.py b/plotly/validators/pointcloud/_ysrc.py deleted file mode 100644 index 52f13d21dd3..00000000000 --- a/plotly/validators/pointcloud/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='pointcloud', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/hoverlabel/__init__.py b/plotly/validators/pointcloud/hoverlabel/__init__.py index 856f769ba33..7cec5aba2e7 100644 --- a/plotly/validators/pointcloud/hoverlabel/__init__.py +++ b/plotly/validators/pointcloud/hoverlabel/__init__.py @@ -1,7 +1,176 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='pointcloud.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='pointcloud.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='pointcloud.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='pointcloud.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='pointcloud.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='pointcloud.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='pointcloud.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/pointcloud/hoverlabel/_bgcolor.py b/plotly/validators/pointcloud/hoverlabel/_bgcolor.py deleted file mode 100644 index a95ced1300f..00000000000 --- a/plotly/validators/pointcloud/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='pointcloud.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/hoverlabel/_bgcolorsrc.py b/plotly/validators/pointcloud/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 66eef14ce25..00000000000 --- a/plotly/validators/pointcloud/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='pointcloud.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/hoverlabel/_bordercolor.py b/plotly/validators/pointcloud/hoverlabel/_bordercolor.py deleted file mode 100644 index 682c9e54c07..00000000000 --- a/plotly/validators/pointcloud/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='pointcloud.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/hoverlabel/_bordercolorsrc.py b/plotly/validators/pointcloud/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index f62dd389077..00000000000 --- a/plotly/validators/pointcloud/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='pointcloud.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/hoverlabel/_font.py b/plotly/validators/pointcloud/hoverlabel/_font.py deleted file mode 100644 index 0658a02fe7a..00000000000 --- a/plotly/validators/pointcloud/hoverlabel/_font.py +++ /dev/null @@ -1,50 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='pointcloud.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/pointcloud/hoverlabel/_namelength.py b/plotly/validators/pointcloud/hoverlabel/_namelength.py deleted file mode 100644 index c85bf17747b..00000000000 --- a/plotly/validators/pointcloud/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='pointcloud.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/hoverlabel/_namelengthsrc.py b/plotly/validators/pointcloud/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 75cc2b9edb9..00000000000 --- a/plotly/validators/pointcloud/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='pointcloud.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/hoverlabel/font/__init__.py b/plotly/validators/pointcloud/hoverlabel/font/__init__.py index 1d2c591d1e5..26df2ab8e5e 100644 --- a/plotly/validators/pointcloud/hoverlabel/font/__init__.py +++ b/plotly/validators/pointcloud/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='pointcloud.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='pointcloud.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='pointcloud.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='pointcloud.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='pointcloud.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='pointcloud.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/pointcloud/hoverlabel/font/_color.py b/plotly/validators/pointcloud/hoverlabel/font/_color.py deleted file mode 100644 index e5583f7c37c..00000000000 --- a/plotly/validators/pointcloud/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='pointcloud.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/hoverlabel/font/_colorsrc.py b/plotly/validators/pointcloud/hoverlabel/font/_colorsrc.py deleted file mode 100644 index e603396ca53..00000000000 --- a/plotly/validators/pointcloud/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='pointcloud.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/hoverlabel/font/_family.py b/plotly/validators/pointcloud/hoverlabel/font/_family.py deleted file mode 100644 index dc8e7186aab..00000000000 --- a/plotly/validators/pointcloud/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='pointcloud.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/pointcloud/hoverlabel/font/_familysrc.py b/plotly/validators/pointcloud/hoverlabel/font/_familysrc.py deleted file mode 100644 index 9f38d4e8e36..00000000000 --- a/plotly/validators/pointcloud/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='pointcloud.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/hoverlabel/font/_size.py b/plotly/validators/pointcloud/hoverlabel/font/_size.py deleted file mode 100644 index 5003351f66b..00000000000 --- a/plotly/validators/pointcloud/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='pointcloud.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/hoverlabel/font/_sizesrc.py b/plotly/validators/pointcloud/hoverlabel/font/_sizesrc.py deleted file mode 100644 index e6bc103e559..00000000000 --- a/plotly/validators/pointcloud/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='pointcloud.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/marker/__init__.py b/plotly/validators/pointcloud/marker/__init__.py index a0775408237..e860954709d 100644 --- a/plotly/validators/pointcloud/marker/__init__.py +++ b/plotly/validators/pointcloud/marker/__init__.py @@ -1,6 +1,120 @@ -from ._sizemin import SizeminValidator -from ._sizemax import SizemaxValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator -from ._border import BorderValidator -from ._blend import BlendValidator + + +import _plotly_utils.basevalidators + + +class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sizemin', parent_name='pointcloud.marker', **kwargs + ): + super(SizeminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 2), + min=kwargs.pop('min', 0.1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizemaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sizemax', parent_name='pointcloud.marker', **kwargs + ): + super(SizemaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0.1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='pointcloud.marker', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='pointcloud.marker', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='border', parent_name='pointcloud.marker', **kwargs + ): + super(BorderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Border'), + data_docs=kwargs.pop( + 'data_docs', """ + arearatio + Specifies what fraction of the marker area is + covered with the border. + color + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BlendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='blend', parent_name='pointcloud.marker', **kwargs + ): + super(BlendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/pointcloud/marker/_blend.py b/plotly/validators/pointcloud/marker/_blend.py deleted file mode 100644 index 6c933de0b13..00000000000 --- a/plotly/validators/pointcloud/marker/_blend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BlendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='blend', parent_name='pointcloud.marker', **kwargs - ): - super(BlendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/marker/_border.py b/plotly/validators/pointcloud/marker/_border.py deleted file mode 100644 index 37c0e225992..00000000000 --- a/plotly/validators/pointcloud/marker/_border.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='border', parent_name='pointcloud.marker', **kwargs - ): - super(BorderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Border'), - data_docs=kwargs.pop( - 'data_docs', """ - arearatio - Specifies what fraction of the marker area is - covered with the border. - color - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/pointcloud/marker/_color.py b/plotly/validators/pointcloud/marker/_color.py deleted file mode 100644 index abd6c4aa8ca..00000000000 --- a/plotly/validators/pointcloud/marker/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='pointcloud.marker', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/marker/_opacity.py b/plotly/validators/pointcloud/marker/_opacity.py deleted file mode 100644 index bb1e09e2338..00000000000 --- a/plotly/validators/pointcloud/marker/_opacity.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='pointcloud.marker', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/marker/_sizemax.py b/plotly/validators/pointcloud/marker/_sizemax.py deleted file mode 100644 index f2f6a627ac9..00000000000 --- a/plotly/validators/pointcloud/marker/_sizemax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizemaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sizemax', parent_name='pointcloud.marker', **kwargs - ): - super(SizemaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0.1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/marker/_sizemin.py b/plotly/validators/pointcloud/marker/_sizemin.py deleted file mode 100644 index 2a715f22539..00000000000 --- a/plotly/validators/pointcloud/marker/_sizemin.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sizemin', parent_name='pointcloud.marker', **kwargs - ): - super(SizeminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 2), - min=kwargs.pop('min', 0.1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/marker/border/__init__.py b/plotly/validators/pointcloud/marker/border/__init__.py index 408a3b9ba9a..6526447e98b 100644 --- a/plotly/validators/pointcloud/marker/border/__init__.py +++ b/plotly/validators/pointcloud/marker/border/__init__.py @@ -1,2 +1,43 @@ -from ._color import ColorValidator -from ._arearatio import ArearatioValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='pointcloud.marker.border', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArearatioValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='arearatio', + parent_name='pointcloud.marker.border', + **kwargs + ): + super(ArearatioValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/pointcloud/marker/border/_arearatio.py b/plotly/validators/pointcloud/marker/border/_arearatio.py deleted file mode 100644 index 01dd87d6664..00000000000 --- a/plotly/validators/pointcloud/marker/border/_arearatio.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArearatioValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='arearatio', - parent_name='pointcloud.marker.border', - **kwargs - ): - super(ArearatioValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/marker/border/_color.py b/plotly/validators/pointcloud/marker/border/_color.py deleted file mode 100644 index c274d3c67d5..00000000000 --- a/plotly/validators/pointcloud/marker/border/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='pointcloud.marker.border', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/stream/__init__.py b/plotly/validators/pointcloud/stream/__init__.py index 2f4f2047594..3873962762e 100644 --- a/plotly/validators/pointcloud/stream/__init__.py +++ b/plotly/validators/pointcloud/stream/__init__.py @@ -1,2 +1,41 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='pointcloud.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='pointcloud.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/pointcloud/stream/_maxpoints.py b/plotly/validators/pointcloud/stream/_maxpoints.py deleted file mode 100644 index 0507c08853a..00000000000 --- a/plotly/validators/pointcloud/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='pointcloud.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/pointcloud/stream/_token.py b/plotly/validators/pointcloud/stream/_token.py deleted file mode 100644 index d1af03bcfe6..00000000000 --- a/plotly/validators/pointcloud/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='pointcloud.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/sankey/__init__.py b/plotly/validators/sankey/__init__.py index d1b74cccea8..0e0f23bad56 100644 --- a/plotly/validators/sankey/__init__.py +++ b/plotly/validators/sankey/__init__.py @@ -1,23 +1,600 @@ -from ._visible import VisibleValidator -from ._valuesuffix import ValuesuffixValidator -from ._valueformat import ValueformatValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textfont import TextfontValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._orientation import OrientationValidator -from ._opacity import OpacityValidator -from ._node import NodeValidator -from ._name import NameValidator -from ._link import LinkValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfo import HoverinfoValidator -from ._domain import DomainValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._arrangement import ArrangementValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='sankey', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValuesuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='valuesuffix', parent_name='sankey', **kwargs + ): + super(ValuesuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='valueformat', parent_name='sankey', **kwargs + ): + super(ValueformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='sankey', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='sankey', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='textfont', parent_name='sankey', **kwargs): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='sankey', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='sankey', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='sankey', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OrientationValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='orientation', parent_name='sankey', **kwargs + ): + super(OrientationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['v', 'h']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='opacity', parent_name='sankey', **kwargs): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NodeValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='node', parent_name='sankey', **kwargs): + super(NodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Node'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the `node` color. It can be a single + value, or an array for specifying color for + each `node`. If `node.color` is omitted, then + the default `Plotly` color palette will be + cycled through to have a variety of colors. + These defaults are not fully opaque, to allow + some visibility of what is beneath the node. + colorsrc + Sets the source reference on plot.ly for color + . + groups + Groups of nodes. Each group is defined by an + array with the indices of the nodes it + contains. Multiple groups can be specified. + hoverinfo + Determines which trace information appear when + hovering nodes. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverlabel + plotly.graph_objs.sankey.node.Hoverlabel + instance or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + variables `value` and `label`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + label + The shown name of the node. + labelsrc + Sets the source reference on plot.ly for label + . + line + plotly.graph_objs.sankey.node.Line instance or + dict with compatible properties + pad + Sets the padding (in px) between the `nodes`. + thickness + Sets the thickness (in px) of the `nodes`. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='sankey', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LinkValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='link', parent_name='sankey', **kwargs): + super(LinkValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Link'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the `link` color. It can be a single + value, or an array for specifying color for + each `link`. If `link.color` is omitted, then + by default, a translucent grey link will be + used. + colorscales + plotly.graph_objs.sankey.link.Colorscale + instance or dict with compatible properties + colorscaledefaults + When used in a template (as layout.template.dat + a.sankey.link.colorscaledefaults), sets the + default property values to use for elements of + sankey.link.colorscales + colorsrc + Sets the source reference on plot.ly for color + . + hoverinfo + Determines which trace information appear when + hovering links. If `none` or `skip` are set, no + information is displayed upon hovering. But, if + `none` is set, click and hover events are still + fired. + hoverlabel + plotly.graph_objs.sankey.link.Hoverlabel + instance or dict with compatible properties + hovertemplate + Template string used for rendering the + information that appear on hover box. Note that + this will override `hoverinfo`. Variables are + inserted using %{variable}, for example "y: + %{y}". Numbers are formatted using d3-format's + syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". See https://github.com/d3/d + 3-format/blob/master/README.md#locale_format + for details on the formatting syntax. The + variables available in `hovertemplate` are the + ones emitted as event data described at this + link https://plot.ly/javascript/plotlyjs- + events/#event-data. Additionally, every + attributes that can be specified per-point (the + ones that are `arrayOk: true`) are available. + variables `value` and `label`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". + hovertemplatesrc + Sets the source reference on plot.ly for + hovertemplate . + label + The shown name of the link. + labelsrc + Sets the source reference on plot.ly for label + . + line + plotly.graph_objs.sankey.link.Line instance or + dict with compatible properties + source + An integer number `[0..nodes.length - 1]` that + represents the source node. + sourcesrc + Sets the source reference on plot.ly for + source . + target + An integer number `[0..nodes.length - 1]` that + represents the target node. + targetsrc + Sets the source reference on plot.ly for + target . + value + A numeric value representing the flow volume + value. + valuesrc + Sets the source reference on plot.ly for value + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='sankey', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='sankey', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='sankey', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='sankey', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='sankey', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', []), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='domain', parent_name='sankey', **kwargs): + super(DomainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Domain'), + data_docs=kwargs.pop( + 'data_docs', """ + column + If there is a layout grid, use the domain for + this column in the grid for this sankey trace . + row + If there is a layout grid, use the domain for + this row in the grid for this sankey trace . + x + Sets the horizontal domain of this sankey trace + (in plot fraction). + y + Sets the vertical domain of this sankey trace + (in plot fraction). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='sankey', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='sankey', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrangementValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='arrangement', parent_name='sankey', **kwargs + ): + super(ArrangementValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['snap', 'perpendicular', 'freeform', 'fixed'] + ), + **kwargs + ) diff --git a/plotly/validators/sankey/_arrangement.py b/plotly/validators/sankey/_arrangement.py deleted file mode 100644 index badd295394c..00000000000 --- a/plotly/validators/sankey/_arrangement.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrangementValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='arrangement', parent_name='sankey', **kwargs - ): - super(ArrangementValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['snap', 'perpendicular', 'freeform', 'fixed'] - ), - **kwargs - ) diff --git a/plotly/validators/sankey/_customdata.py b/plotly/validators/sankey/_customdata.py deleted file mode 100644 index 24e9c6170ef..00000000000 --- a/plotly/validators/sankey/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='sankey', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/sankey/_customdatasrc.py b/plotly/validators/sankey/_customdatasrc.py deleted file mode 100644 index 1c734d9d984..00000000000 --- a/plotly/validators/sankey/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='sankey', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/_domain.py b/plotly/validators/sankey/_domain.py deleted file mode 100644 index 34225edb5fd..00000000000 --- a/plotly/validators/sankey/_domain.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='domain', parent_name='sankey', **kwargs): - super(DomainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Domain'), - data_docs=kwargs.pop( - 'data_docs', """ - column - If there is a layout grid, use the domain for - this column in the grid for this sankey trace . - row - If there is a layout grid, use the domain for - this row in the grid for this sankey trace . - x - Sets the horizontal domain of this sankey trace - (in plot fraction). - y - Sets the vertical domain of this sankey trace - (in plot fraction). -""" - ), - **kwargs - ) diff --git a/plotly/validators/sankey/_hoverinfo.py b/plotly/validators/sankey/_hoverinfo.py deleted file mode 100644 index 1e4ce177c90..00000000000 --- a/plotly/validators/sankey/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='sankey', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', []), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/_hoverlabel.py b/plotly/validators/sankey/_hoverlabel.py deleted file mode 100644 index a7e5725fd4f..00000000000 --- a/plotly/validators/sankey/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='sankey', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/sankey/_ids.py b/plotly/validators/sankey/_ids.py deleted file mode 100644 index 5508bad3b2f..00000000000 --- a/plotly/validators/sankey/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='sankey', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/sankey/_idssrc.py b/plotly/validators/sankey/_idssrc.py deleted file mode 100644 index 69addcb64f3..00000000000 --- a/plotly/validators/sankey/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='sankey', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/_legendgroup.py b/plotly/validators/sankey/_legendgroup.py deleted file mode 100644 index ee3a802cd80..00000000000 --- a/plotly/validators/sankey/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='sankey', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/_link.py b/plotly/validators/sankey/_link.py deleted file mode 100644 index 02b888b4efd..00000000000 --- a/plotly/validators/sankey/_link.py +++ /dev/null @@ -1,91 +0,0 @@ -import _plotly_utils.basevalidators - - -class LinkValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='link', parent_name='sankey', **kwargs): - super(LinkValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Link'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the `link` color. It can be a single - value, or an array for specifying color for - each `link`. If `link.color` is omitted, then - by default, a translucent grey link will be - used. - colorscales - plotly.graph_objs.sankey.link.Colorscale - instance or dict with compatible properties - colorscaledefaults - When used in a template (as layout.template.dat - a.sankey.link.colorscaledefaults), sets the - default property values to use for elements of - sankey.link.colorscales - colorsrc - Sets the source reference on plot.ly for color - . - hoverinfo - Determines which trace information appear when - hovering links. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverlabel - plotly.graph_objs.sankey.link.Hoverlabel - instance or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - variables `value` and `label`. Anything - contained in tag `` is displayed in the - secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - label - The shown name of the link. - labelsrc - Sets the source reference on plot.ly for label - . - line - plotly.graph_objs.sankey.link.Line instance or - dict with compatible properties - source - An integer number `[0..nodes.length - 1]` that - represents the source node. - sourcesrc - Sets the source reference on plot.ly for - source . - target - An integer number `[0..nodes.length - 1]` that - represents the target node. - targetsrc - Sets the source reference on plot.ly for - target . - value - A numeric value representing the flow volume - value. - valuesrc - Sets the source reference on plot.ly for value - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/sankey/_name.py b/plotly/validators/sankey/_name.py deleted file mode 100644 index f1878dcd10c..00000000000 --- a/plotly/validators/sankey/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='sankey', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/_node.py b/plotly/validators/sankey/_node.py deleted file mode 100644 index d2891864f38..00000000000 --- a/plotly/validators/sankey/_node.py +++ /dev/null @@ -1,75 +0,0 @@ -import _plotly_utils.basevalidators - - -class NodeValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='node', parent_name='sankey', **kwargs): - super(NodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Node'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the `node` color. It can be a single - value, or an array for specifying color for - each `node`. If `node.color` is omitted, then - the default `Plotly` color palette will be - cycled through to have a variety of colors. - These defaults are not fully opaque, to allow - some visibility of what is beneath the node. - colorsrc - Sets the source reference on plot.ly for color - . - groups - Groups of nodes. Each group is defined by an - array with the indices of the nodes it - contains. Multiple groups can be specified. - hoverinfo - Determines which trace information appear when - hovering nodes. If `none` or `skip` are set, no - information is displayed upon hovering. But, if - `none` is set, click and hover events are still - fired. - hoverlabel - plotly.graph_objs.sankey.node.Hoverlabel - instance or dict with compatible properties - hovertemplate - Template string used for rendering the - information that appear on hover box. Note that - this will override `hoverinfo`. Variables are - inserted using %{variable}, for example "y: - %{y}". Numbers are formatted using d3-format's - syntax %{variable:d3-format}, for example - "Price: %{y:$.2f}". See https://github.com/d3/d - 3-format/blob/master/README.md#locale_format - for details on the formatting syntax. The - variables available in `hovertemplate` are the - ones emitted as event data described at this - link https://plot.ly/javascript/plotlyjs- - events/#event-data. Additionally, every - attributes that can be specified per-point (the - ones that are `arrayOk: true`) are available. - variables `value` and `label`. Anything - contained in tag `` is displayed in the - secondary box, for example - "{fullData.name}". - hovertemplatesrc - Sets the source reference on plot.ly for - hovertemplate . - label - The shown name of the node. - labelsrc - Sets the source reference on plot.ly for label - . - line - plotly.graph_objs.sankey.node.Line instance or - dict with compatible properties - pad - Sets the padding (in px) between the `nodes`. - thickness - Sets the thickness (in px) of the `nodes`. -""" - ), - **kwargs - ) diff --git a/plotly/validators/sankey/_opacity.py b/plotly/validators/sankey/_opacity.py deleted file mode 100644 index 87f9f0be136..00000000000 --- a/plotly/validators/sankey/_opacity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='opacity', parent_name='sankey', **kwargs): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/_orientation.py b/plotly/validators/sankey/_orientation.py deleted file mode 100644 index f07e61376ed..00000000000 --- a/plotly/validators/sankey/_orientation.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class OrientationValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='orientation', parent_name='sankey', **kwargs - ): - super(OrientationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['v', 'h']), - **kwargs - ) diff --git a/plotly/validators/sankey/_selectedpoints.py b/plotly/validators/sankey/_selectedpoints.py deleted file mode 100644 index 3d8cbfeaabf..00000000000 --- a/plotly/validators/sankey/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='sankey', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/_showlegend.py b/plotly/validators/sankey/_showlegend.py deleted file mode 100644 index 14c4a248587..00000000000 --- a/plotly/validators/sankey/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='sankey', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/_stream.py b/plotly/validators/sankey/_stream.py deleted file mode 100644 index 81d5ab93916..00000000000 --- a/plotly/validators/sankey/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='sankey', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/sankey/_textfont.py b/plotly/validators/sankey/_textfont.py deleted file mode 100644 index 14412d6c22e..00000000000 --- a/plotly/validators/sankey/_textfont.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='textfont', parent_name='sankey', **kwargs): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/sankey/_uid.py b/plotly/validators/sankey/_uid.py deleted file mode 100644 index f105670811a..00000000000 --- a/plotly/validators/sankey/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='sankey', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/_uirevision.py b/plotly/validators/sankey/_uirevision.py deleted file mode 100644 index 262a8bd16c7..00000000000 --- a/plotly/validators/sankey/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='sankey', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/_valueformat.py b/plotly/validators/sankey/_valueformat.py deleted file mode 100644 index 4ce7d64ee26..00000000000 --- a/plotly/validators/sankey/_valueformat.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='valueformat', parent_name='sankey', **kwargs - ): - super(ValueformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/_valuesuffix.py b/plotly/validators/sankey/_valuesuffix.py deleted file mode 100644 index 13746524fff..00000000000 --- a/plotly/validators/sankey/_valuesuffix.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValuesuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='valuesuffix', parent_name='sankey', **kwargs - ): - super(ValuesuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/_visible.py b/plotly/validators/sankey/_visible.py deleted file mode 100644 index 4c7c3328091..00000000000 --- a/plotly/validators/sankey/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='sankey', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/sankey/domain/__init__.py b/plotly/validators/sankey/domain/__init__.py index 6cf32248236..b65c6ea6681 100644 --- a/plotly/validators/sankey/domain/__init__.py +++ b/plotly/validators/sankey/domain/__init__.py @@ -1,4 +1,98 @@ -from ._y import YValidator -from ._x import XValidator -from ._row import RowValidator -from ._column import ColumnValidator + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__(self, plotly_name='y', parent_name='sankey.domain', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__(self, plotly_name='x', parent_name='sankey.domain', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RowValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='row', parent_name='sankey.domain', **kwargs + ): + super(RowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='column', parent_name='sankey.domain', **kwargs + ): + super(ColumnValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/sankey/domain/_column.py b/plotly/validators/sankey/domain/_column.py deleted file mode 100644 index 2cf44059ff1..00000000000 --- a/plotly/validators/sankey/domain/_column.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='column', parent_name='sankey.domain', **kwargs - ): - super(ColumnValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/domain/_row.py b/plotly/validators/sankey/domain/_row.py deleted file mode 100644 index eebf2574178..00000000000 --- a/plotly/validators/sankey/domain/_row.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class RowValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='row', parent_name='sankey.domain', **kwargs - ): - super(RowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/domain/_x.py b/plotly/validators/sankey/domain/_x.py deleted file mode 100644 index fd371fbe55f..00000000000 --- a/plotly/validators/sankey/domain/_x.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__(self, plotly_name='x', parent_name='sankey.domain', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/domain/_y.py b/plotly/validators/sankey/domain/_y.py deleted file mode 100644 index ef8b0d520ab..00000000000 --- a/plotly/validators/sankey/domain/_y.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__(self, plotly_name='y', parent_name='sankey.domain', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/hoverlabel/__init__.py b/plotly/validators/sankey/hoverlabel/__init__.py index 856f769ba33..7326b87e444 100644 --- a/plotly/validators/sankey/hoverlabel/__init__.py +++ b/plotly/validators/sankey/hoverlabel/__init__.py @@ -1,7 +1,170 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='sankey.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='sankey.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='sankey.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='sankey.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='sankey.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='sankey.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='sankey.hoverlabel', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/sankey/hoverlabel/_bgcolor.py b/plotly/validators/sankey/hoverlabel/_bgcolor.py deleted file mode 100644 index 88af384bf82..00000000000 --- a/plotly/validators/sankey/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='sankey.hoverlabel', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/hoverlabel/_bgcolorsrc.py b/plotly/validators/sankey/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 73b711456b2..00000000000 --- a/plotly/validators/sankey/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='sankey.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/hoverlabel/_bordercolor.py b/plotly/validators/sankey/hoverlabel/_bordercolor.py deleted file mode 100644 index e78aa8ed5c9..00000000000 --- a/plotly/validators/sankey/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='sankey.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/hoverlabel/_bordercolorsrc.py b/plotly/validators/sankey/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 96445e864df..00000000000 --- a/plotly/validators/sankey/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='sankey.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/hoverlabel/_font.py b/plotly/validators/sankey/hoverlabel/_font.py deleted file mode 100644 index 86f3f69beab..00000000000 --- a/plotly/validators/sankey/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='sankey.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/sankey/hoverlabel/_namelength.py b/plotly/validators/sankey/hoverlabel/_namelength.py deleted file mode 100644 index d0652d6e7e5..00000000000 --- a/plotly/validators/sankey/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='sankey.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/hoverlabel/_namelengthsrc.py b/plotly/validators/sankey/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 19c4e15c451..00000000000 --- a/plotly/validators/sankey/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='sankey.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/hoverlabel/font/__init__.py b/plotly/validators/sankey/hoverlabel/font/__init__.py index 1d2c591d1e5..2db816a882f 100644 --- a/plotly/validators/sankey/hoverlabel/font/__init__.py +++ b/plotly/validators/sankey/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='sankey.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='sankey.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='sankey.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='sankey.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='sankey.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='sankey.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/sankey/hoverlabel/font/_color.py b/plotly/validators/sankey/hoverlabel/font/_color.py deleted file mode 100644 index 90fb9c7d861..00000000000 --- a/plotly/validators/sankey/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='sankey.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/hoverlabel/font/_colorsrc.py b/plotly/validators/sankey/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 57572067cd5..00000000000 --- a/plotly/validators/sankey/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='sankey.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/hoverlabel/font/_family.py b/plotly/validators/sankey/hoverlabel/font/_family.py deleted file mode 100644 index cf2bbe603b3..00000000000 --- a/plotly/validators/sankey/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='sankey.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/sankey/hoverlabel/font/_familysrc.py b/plotly/validators/sankey/hoverlabel/font/_familysrc.py deleted file mode 100644 index 9904968ae5c..00000000000 --- a/plotly/validators/sankey/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='sankey.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/hoverlabel/font/_size.py b/plotly/validators/sankey/hoverlabel/font/_size.py deleted file mode 100644 index 49293799689..00000000000 --- a/plotly/validators/sankey/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='sankey.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/hoverlabel/font/_sizesrc.py b/plotly/validators/sankey/hoverlabel/font/_sizesrc.py deleted file mode 100644 index e01e2030a55..00000000000 --- a/plotly/validators/sankey/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='sankey.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/__init__.py b/plotly/validators/sankey/link/__init__.py index 78bd32426d5..93d8495fb2b 100644 --- a/plotly/validators/sankey/link/__init__.py +++ b/plotly/validators/sankey/link/__init__.py @@ -1,17 +1,390 @@ -from ._valuesrc import ValuesrcValidator -from ._value import ValueValidator -from ._targetsrc import TargetsrcValidator -from ._target import TargetValidator -from ._sourcesrc import SourcesrcValidator -from ._source import SourceValidator -from ._line import LineValidator -from ._labelsrc import LabelsrcValidator -from ._label import LabelValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfo import HoverinfoValidator -from ._colorsrc import ColorsrcValidator -from ._colorscaledefaults import ColorscaleValidator -from ._colorscales import ColorscalesValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ValuesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='valuesrc', parent_name='sankey.link', **kwargs + ): + super(ValuesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='value', parent_name='sankey.link', **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TargetsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='targetsrc', parent_name='sankey.link', **kwargs + ): + super(TargetsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TargetValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='target', parent_name='sankey.link', **kwargs + ): + super(TargetValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SourcesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='sourcesrc', parent_name='sankey.link', **kwargs + ): + super(SourcesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SourceValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='source', parent_name='sankey.link', **kwargs + ): + super(SourceValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='sankey.link', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the color of the `line` around each + `link`. + colorsrc + Sets the source reference on plot.ly for color + . + width + Sets the width (in px) of the `line` around + each `link`. + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='labelsrc', parent_name='sankey.link', **kwargs + ): + super(LabelsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='label', parent_name='sankey.link', **kwargs + ): + super(LabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertemplatesrc', + parent_name='sankey.link', + **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='sankey.link', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='sankey.link', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='sankey.link', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['all', 'none', 'skip']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='sankey.link', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='colorscaledefaults', + parent_name='sankey.link', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Colorscale'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscalesValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, plotly_name='colorscales', parent_name='sankey.link', **kwargs + ): + super(ColorscalesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Colorscale'), + data_docs=kwargs.pop( + 'data_docs', """ + cmax + Sets the upper bound of the color domain. + cmin + Sets the lower bound of the color domain. + colorscale + Sets the colorscale. The colorscale must be an + array containing arrays mapping a normalized + value to an rgb, rgba, hex, hsl, hsv, or named + color string. At minimum, a mapping for the + lowest (0) and highest (1) values are required. + For example, `[[0, 'rgb(0,0,255)', [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use`cmin` and + `cmax`. Alternatively, `colorscale` may be a + palette name string of the following list: Grey + s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, + Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth + ,Electric,Viridis,Cividis. + label + The label of the links to color based on their + concentration within a flow. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='sankey.link', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/sankey/link/_color.py b/plotly/validators/sankey/link/_color.py deleted file mode 100644 index 25e584348c5..00000000000 --- a/plotly/validators/sankey/link/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='sankey.link', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/_colorscaledefaults.py b/plotly/validators/sankey/link/_colorscaledefaults.py deleted file mode 100644 index ff5e8af16a0..00000000000 --- a/plotly/validators/sankey/link/_colorscaledefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='colorscaledefaults', - parent_name='sankey.link', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Colorscale'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/sankey/link/_colorscales.py b/plotly/validators/sankey/link/_colorscales.py deleted file mode 100644 index 81cf634abd1..00000000000 --- a/plotly/validators/sankey/link/_colorscales.py +++ /dev/null @@ -1,62 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscalesValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, plotly_name='colorscales', parent_name='sankey.link', **kwargs - ): - super(ColorscalesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Colorscale'), - data_docs=kwargs.pop( - 'data_docs', """ - cmax - Sets the upper bound of the color domain. - cmin - Sets the lower bound of the color domain. - colorscale - Sets the colorscale. The colorscale must be an - array containing arrays mapping a normalized - value to an rgb, rgba, hex, hsl, hsv, or named - color string. At minimum, a mapping for the - lowest (0) and highest (1) values are required. - For example, `[[0, 'rgb(0,0,255)', [1, - 'rgb(255,0,0)']]`. To control the bounds of the - colorscale in color space, use`cmin` and - `cmax`. Alternatively, `colorscale` may be a - palette name string of the following list: Grey - s,YlGnBu,Greens,YlOrRd,Bluered,RdBu,Reds,Blues, - Picnic,Rainbow,Portland,Jet,Hot,Blackbody,Earth - ,Electric,Viridis,Cividis. - label - The label of the links to color based on their - concentration within a flow. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. -""" - ), - **kwargs - ) diff --git a/plotly/validators/sankey/link/_colorsrc.py b/plotly/validators/sankey/link/_colorsrc.py deleted file mode 100644 index bb3ffde249e..00000000000 --- a/plotly/validators/sankey/link/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='sankey.link', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/_hoverinfo.py b/plotly/validators/sankey/link/_hoverinfo.py deleted file mode 100644 index c96d71c01fc..00000000000 --- a/plotly/validators/sankey/link/_hoverinfo.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='sankey.link', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['all', 'none', 'skip']), - **kwargs - ) diff --git a/plotly/validators/sankey/link/_hoverlabel.py b/plotly/validators/sankey/link/_hoverlabel.py deleted file mode 100644 index f2c30252328..00000000000 --- a/plotly/validators/sankey/link/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='sankey.link', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/sankey/link/_hovertemplate.py b/plotly/validators/sankey/link/_hovertemplate.py deleted file mode 100644 index d039c7bfa63..00000000000 --- a/plotly/validators/sankey/link/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='sankey.link', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/_hovertemplatesrc.py b/plotly/validators/sankey/link/_hovertemplatesrc.py deleted file mode 100644 index 9a6d8dd3d9e..00000000000 --- a/plotly/validators/sankey/link/_hovertemplatesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertemplatesrc', - parent_name='sankey.link', - **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/_label.py b/plotly/validators/sankey/link/_label.py deleted file mode 100644 index 3058ef7510f..00000000000 --- a/plotly/validators/sankey/link/_label.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='label', parent_name='sankey.link', **kwargs - ): - super(LabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/_labelsrc.py b/plotly/validators/sankey/link/_labelsrc.py deleted file mode 100644 index 559e18aeef3..00000000000 --- a/plotly/validators/sankey/link/_labelsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='labelsrc', parent_name='sankey.link', **kwargs - ): - super(LabelsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/_line.py b/plotly/validators/sankey/link/_line.py deleted file mode 100644 index 736e37825bb..00000000000 --- a/plotly/validators/sankey/link/_line.py +++ /dev/null @@ -1,30 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='sankey.link', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the color of the `line` around each - `link`. - colorsrc - Sets the source reference on plot.ly for color - . - width - Sets the width (in px) of the `line` around - each `link`. - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/sankey/link/_source.py b/plotly/validators/sankey/link/_source.py deleted file mode 100644 index 42cd392de61..00000000000 --- a/plotly/validators/sankey/link/_source.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SourceValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='source', parent_name='sankey.link', **kwargs - ): - super(SourceValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/_sourcesrc.py b/plotly/validators/sankey/link/_sourcesrc.py deleted file mode 100644 index 5cb27bd98c7..00000000000 --- a/plotly/validators/sankey/link/_sourcesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SourcesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='sourcesrc', parent_name='sankey.link', **kwargs - ): - super(SourcesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/_target.py b/plotly/validators/sankey/link/_target.py deleted file mode 100644 index c2bc4d4d333..00000000000 --- a/plotly/validators/sankey/link/_target.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TargetValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='target', parent_name='sankey.link', **kwargs - ): - super(TargetValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/_targetsrc.py b/plotly/validators/sankey/link/_targetsrc.py deleted file mode 100644 index 986f36f72b9..00000000000 --- a/plotly/validators/sankey/link/_targetsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TargetsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='targetsrc', parent_name='sankey.link', **kwargs - ): - super(TargetsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/_value.py b/plotly/validators/sankey/link/_value.py deleted file mode 100644 index 0ddc405ab58..00000000000 --- a/plotly/validators/sankey/link/_value.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='value', parent_name='sankey.link', **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/_valuesrc.py b/plotly/validators/sankey/link/_valuesrc.py deleted file mode 100644 index 9858b058d9d..00000000000 --- a/plotly/validators/sankey/link/_valuesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValuesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='valuesrc', parent_name='sankey.link', **kwargs - ): - super(ValuesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/colorscale/__init__.py b/plotly/validators/sankey/link/colorscale/__init__.py index fc04165e005..9618f03f47b 100644 --- a/plotly/validators/sankey/link/colorscale/__init__.py +++ b/plotly/validators/sankey/link/colorscale/__init__.py @@ -1,6 +1,123 @@ -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._label import LabelValidator -from ._colorscale import ColorscaleValidator -from ._cmin import CminValidator -from ._cmax import CmaxValidator + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='sankey.link.colorscale', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='sankey.link.colorscale', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='label', + parent_name='sankey.link.colorscale', + **kwargs + ): + super(LabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='sankey.link.colorscale', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmin', + parent_name='sankey.link.colorscale', + **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmax', + parent_name='sankey.link.colorscale', + **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/sankey/link/colorscale/_cmax.py b/plotly/validators/sankey/link/colorscale/_cmax.py deleted file mode 100644 index 57b962d0d6f..00000000000 --- a/plotly/validators/sankey/link/colorscale/_cmax.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmax', - parent_name='sankey.link.colorscale', - **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/colorscale/_cmin.py b/plotly/validators/sankey/link/colorscale/_cmin.py deleted file mode 100644 index 1e2ca82a877..00000000000 --- a/plotly/validators/sankey/link/colorscale/_cmin.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmin', - parent_name='sankey.link.colorscale', - **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/colorscale/_colorscale.py b/plotly/validators/sankey/link/colorscale/_colorscale.py deleted file mode 100644 index b6a4b146ea0..00000000000 --- a/plotly/validators/sankey/link/colorscale/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='sankey.link.colorscale', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/colorscale/_label.py b/plotly/validators/sankey/link/colorscale/_label.py deleted file mode 100644 index 69e85701715..00000000000 --- a/plotly/validators/sankey/link/colorscale/_label.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='label', - parent_name='sankey.link.colorscale', - **kwargs - ): - super(LabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/colorscale/_name.py b/plotly/validators/sankey/link/colorscale/_name.py deleted file mode 100644 index 6f1399e0d6e..00000000000 --- a/plotly/validators/sankey/link/colorscale/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='sankey.link.colorscale', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/colorscale/_templateitemname.py b/plotly/validators/sankey/link/colorscale/_templateitemname.py deleted file mode 100644 index 7e07dd53d44..00000000000 --- a/plotly/validators/sankey/link/colorscale/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='sankey.link.colorscale', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/hoverlabel/__init__.py b/plotly/validators/sankey/link/hoverlabel/__init__.py index 856f769ba33..7833c979f05 100644 --- a/plotly/validators/sankey/link/hoverlabel/__init__.py +++ b/plotly/validators/sankey/link/hoverlabel/__init__.py @@ -1,7 +1,176 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='sankey.link.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='sankey.link.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='sankey.link.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='sankey.link.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='sankey.link.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='sankey.link.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='sankey.link.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/sankey/link/hoverlabel/_bgcolor.py b/plotly/validators/sankey/link/hoverlabel/_bgcolor.py deleted file mode 100644 index 449cd417f4d..00000000000 --- a/plotly/validators/sankey/link/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='sankey.link.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/hoverlabel/_bgcolorsrc.py b/plotly/validators/sankey/link/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 6b3075bd018..00000000000 --- a/plotly/validators/sankey/link/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='sankey.link.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/hoverlabel/_bordercolor.py b/plotly/validators/sankey/link/hoverlabel/_bordercolor.py deleted file mode 100644 index 30a9bc244df..00000000000 --- a/plotly/validators/sankey/link/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='sankey.link.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/hoverlabel/_bordercolorsrc.py b/plotly/validators/sankey/link/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 06efd784997..00000000000 --- a/plotly/validators/sankey/link/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='sankey.link.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/hoverlabel/_font.py b/plotly/validators/sankey/link/hoverlabel/_font.py deleted file mode 100644 index c27788a8a6a..00000000000 --- a/plotly/validators/sankey/link/hoverlabel/_font.py +++ /dev/null @@ -1,50 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='sankey.link.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/sankey/link/hoverlabel/_namelength.py b/plotly/validators/sankey/link/hoverlabel/_namelength.py deleted file mode 100644 index 08943f50ac5..00000000000 --- a/plotly/validators/sankey/link/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='sankey.link.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/hoverlabel/_namelengthsrc.py b/plotly/validators/sankey/link/hoverlabel/_namelengthsrc.py deleted file mode 100644 index b8addfc24c0..00000000000 --- a/plotly/validators/sankey/link/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='sankey.link.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/hoverlabel/font/__init__.py b/plotly/validators/sankey/link/hoverlabel/font/__init__.py index 1d2c591d1e5..885a0abbacb 100644 --- a/plotly/validators/sankey/link/hoverlabel/font/__init__.py +++ b/plotly/validators/sankey/link/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='sankey.link.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='sankey.link.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='sankey.link.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='sankey.link.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='sankey.link.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='sankey.link.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/sankey/link/hoverlabel/font/_color.py b/plotly/validators/sankey/link/hoverlabel/font/_color.py deleted file mode 100644 index b8b2a130dd1..00000000000 --- a/plotly/validators/sankey/link/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='sankey.link.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/hoverlabel/font/_colorsrc.py b/plotly/validators/sankey/link/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 9e7407f0f1d..00000000000 --- a/plotly/validators/sankey/link/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='sankey.link.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/hoverlabel/font/_family.py b/plotly/validators/sankey/link/hoverlabel/font/_family.py deleted file mode 100644 index 9e0750a5144..00000000000 --- a/plotly/validators/sankey/link/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='sankey.link.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/sankey/link/hoverlabel/font/_familysrc.py b/plotly/validators/sankey/link/hoverlabel/font/_familysrc.py deleted file mode 100644 index 1286295a465..00000000000 --- a/plotly/validators/sankey/link/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='sankey.link.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/hoverlabel/font/_size.py b/plotly/validators/sankey/link/hoverlabel/font/_size.py deleted file mode 100644 index 7ac106462a8..00000000000 --- a/plotly/validators/sankey/link/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='sankey.link.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/hoverlabel/font/_sizesrc.py b/plotly/validators/sankey/link/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 802597c8de4..00000000000 --- a/plotly/validators/sankey/link/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='sankey.link.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/line/__init__.py b/plotly/validators/sankey/link/line/__init__.py index 1c7b37b04f2..8f25383ccc3 100644 --- a/plotly/validators/sankey/link/line/__init__.py +++ b/plotly/validators/sankey/link/line/__init__.py @@ -1,4 +1,71 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='widthsrc', parent_name='sankey.link.line', **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='sankey.link.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='sankey.link.line', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='sankey.link.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/sankey/link/line/_color.py b/plotly/validators/sankey/link/line/_color.py deleted file mode 100644 index 61ed537c660..00000000000 --- a/plotly/validators/sankey/link/line/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='sankey.link.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/line/_colorsrc.py b/plotly/validators/sankey/link/line/_colorsrc.py deleted file mode 100644 index db5ffdb11f4..00000000000 --- a/plotly/validators/sankey/link/line/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='sankey.link.line', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/line/_width.py b/plotly/validators/sankey/link/line/_width.py deleted file mode 100644 index 85bb1753c18..00000000000 --- a/plotly/validators/sankey/link/line/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='sankey.link.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/link/line/_widthsrc.py b/plotly/validators/sankey/link/line/_widthsrc.py deleted file mode 100644 index 9c4796d6819..00000000000 --- a/plotly/validators/sankey/link/line/_widthsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='widthsrc', parent_name='sankey.link.line', **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/__init__.py b/plotly/validators/sankey/node/__init__.py index 9ed5a1f4be9..fcc4f7c31b6 100644 --- a/plotly/validators/sankey/node/__init__.py +++ b/plotly/validators/sankey/node/__init__.py @@ -1,12 +1,264 @@ -from ._thickness import ThicknessValidator -from ._pad import PadValidator -from ._line import LineValidator -from ._labelsrc import LabelsrcValidator -from ._label import LabelValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfo import HoverinfoValidator -from ._groups import GroupsValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='thickness', parent_name='sankey.node', **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='pad', parent_name='sankey.node', **kwargs): + super(PadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='sankey.node', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the color of the `line` around each + `node`. + colorsrc + Sets the source reference on plot.ly for color + . + width + Sets the width (in px) of the `line` around + each `node`. + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='labelsrc', parent_name='sankey.node', **kwargs + ): + super(LabelsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='label', parent_name='sankey.node', **kwargs + ): + super(LabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertemplatesrc', + parent_name='sankey.node', + **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='sankey.node', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='sankey.node', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='sankey.node', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['all', 'none', 'skip']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GroupsValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, plotly_name='groups', parent_name='sankey.node', **kwargs + ): + super(GroupsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dimensions=kwargs.pop('dimensions', 2), + edit_type=kwargs.pop('edit_type', 'calc'), + free_length=kwargs.pop('free_length', True), + items=kwargs.pop( + 'items', { + 'valType': 'number', + 'editType': 'calc' + } + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='sankey.node', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='sankey.node', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/sankey/node/_color.py b/plotly/validators/sankey/node/_color.py deleted file mode 100644 index 9759c62ae0f..00000000000 --- a/plotly/validators/sankey/node/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='sankey.node', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/_colorsrc.py b/plotly/validators/sankey/node/_colorsrc.py deleted file mode 100644 index fff6e360753..00000000000 --- a/plotly/validators/sankey/node/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='sankey.node', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/_groups.py b/plotly/validators/sankey/node/_groups.py deleted file mode 100644 index 204e48c0c1a..00000000000 --- a/plotly/validators/sankey/node/_groups.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class GroupsValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, plotly_name='groups', parent_name='sankey.node', **kwargs - ): - super(GroupsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dimensions=kwargs.pop('dimensions', 2), - edit_type=kwargs.pop('edit_type', 'calc'), - free_length=kwargs.pop('free_length', True), - items=kwargs.pop( - 'items', { - 'valType': 'number', - 'editType': 'calc' - } - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/_hoverinfo.py b/plotly/validators/sankey/node/_hoverinfo.py deleted file mode 100644 index 52be8458662..00000000000 --- a/plotly/validators/sankey/node/_hoverinfo.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='sankey.node', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['all', 'none', 'skip']), - **kwargs - ) diff --git a/plotly/validators/sankey/node/_hoverlabel.py b/plotly/validators/sankey/node/_hoverlabel.py deleted file mode 100644 index 458fdfc9f0b..00000000000 --- a/plotly/validators/sankey/node/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='sankey.node', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/sankey/node/_hovertemplate.py b/plotly/validators/sankey/node/_hovertemplate.py deleted file mode 100644 index fa9bff9ddb4..00000000000 --- a/plotly/validators/sankey/node/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='sankey.node', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/_hovertemplatesrc.py b/plotly/validators/sankey/node/_hovertemplatesrc.py deleted file mode 100644 index a753b837167..00000000000 --- a/plotly/validators/sankey/node/_hovertemplatesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertemplatesrc', - parent_name='sankey.node', - **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/_label.py b/plotly/validators/sankey/node/_label.py deleted file mode 100644 index 7ab74a19749..00000000000 --- a/plotly/validators/sankey/node/_label.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='label', parent_name='sankey.node', **kwargs - ): - super(LabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/_labelsrc.py b/plotly/validators/sankey/node/_labelsrc.py deleted file mode 100644 index 49e9a4d83f1..00000000000 --- a/plotly/validators/sankey/node/_labelsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='labelsrc', parent_name='sankey.node', **kwargs - ): - super(LabelsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/_line.py b/plotly/validators/sankey/node/_line.py deleted file mode 100644 index c163cca8cac..00000000000 --- a/plotly/validators/sankey/node/_line.py +++ /dev/null @@ -1,30 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='sankey.node', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the color of the `line` around each - `node`. - colorsrc - Sets the source reference on plot.ly for color - . - width - Sets the width (in px) of the `line` around - each `node`. - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/sankey/node/_pad.py b/plotly/validators/sankey/node/_pad.py deleted file mode 100644 index 89336dc3fa6..00000000000 --- a/plotly/validators/sankey/node/_pad.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class PadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='pad', parent_name='sankey.node', **kwargs): - super(PadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/_thickness.py b/plotly/validators/sankey/node/_thickness.py deleted file mode 100644 index 01a73464d84..00000000000 --- a/plotly/validators/sankey/node/_thickness.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='thickness', parent_name='sankey.node', **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/hoverlabel/__init__.py b/plotly/validators/sankey/node/hoverlabel/__init__.py index 856f769ba33..f1d54d362bd 100644 --- a/plotly/validators/sankey/node/hoverlabel/__init__.py +++ b/plotly/validators/sankey/node/hoverlabel/__init__.py @@ -1,7 +1,176 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='sankey.node.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='sankey.node.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='sankey.node.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='sankey.node.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='sankey.node.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='sankey.node.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='sankey.node.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/sankey/node/hoverlabel/_bgcolor.py b/plotly/validators/sankey/node/hoverlabel/_bgcolor.py deleted file mode 100644 index 5cb25371394..00000000000 --- a/plotly/validators/sankey/node/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='sankey.node.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/hoverlabel/_bgcolorsrc.py b/plotly/validators/sankey/node/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index ae25f0f7574..00000000000 --- a/plotly/validators/sankey/node/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='sankey.node.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/hoverlabel/_bordercolor.py b/plotly/validators/sankey/node/hoverlabel/_bordercolor.py deleted file mode 100644 index fb43b0a3d14..00000000000 --- a/plotly/validators/sankey/node/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='sankey.node.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/hoverlabel/_bordercolorsrc.py b/plotly/validators/sankey/node/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index e56dbd67f4c..00000000000 --- a/plotly/validators/sankey/node/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='sankey.node.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/hoverlabel/_font.py b/plotly/validators/sankey/node/hoverlabel/_font.py deleted file mode 100644 index 2f47cb092a2..00000000000 --- a/plotly/validators/sankey/node/hoverlabel/_font.py +++ /dev/null @@ -1,50 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='sankey.node.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/sankey/node/hoverlabel/_namelength.py b/plotly/validators/sankey/node/hoverlabel/_namelength.py deleted file mode 100644 index aaa40cfa931..00000000000 --- a/plotly/validators/sankey/node/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='sankey.node.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/hoverlabel/_namelengthsrc.py b/plotly/validators/sankey/node/hoverlabel/_namelengthsrc.py deleted file mode 100644 index a94c2f8de6e..00000000000 --- a/plotly/validators/sankey/node/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='sankey.node.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/hoverlabel/font/__init__.py b/plotly/validators/sankey/node/hoverlabel/font/__init__.py index 1d2c591d1e5..6c7f565fe4f 100644 --- a/plotly/validators/sankey/node/hoverlabel/font/__init__.py +++ b/plotly/validators/sankey/node/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='sankey.node.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='sankey.node.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='sankey.node.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='sankey.node.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='sankey.node.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='sankey.node.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/sankey/node/hoverlabel/font/_color.py b/plotly/validators/sankey/node/hoverlabel/font/_color.py deleted file mode 100644 index 9ebfbb77b89..00000000000 --- a/plotly/validators/sankey/node/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='sankey.node.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/hoverlabel/font/_colorsrc.py b/plotly/validators/sankey/node/hoverlabel/font/_colorsrc.py deleted file mode 100644 index daca34c05aa..00000000000 --- a/plotly/validators/sankey/node/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='sankey.node.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/hoverlabel/font/_family.py b/plotly/validators/sankey/node/hoverlabel/font/_family.py deleted file mode 100644 index e4bbd5153ea..00000000000 --- a/plotly/validators/sankey/node/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='sankey.node.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/sankey/node/hoverlabel/font/_familysrc.py b/plotly/validators/sankey/node/hoverlabel/font/_familysrc.py deleted file mode 100644 index df46008d5ec..00000000000 --- a/plotly/validators/sankey/node/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='sankey.node.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/hoverlabel/font/_size.py b/plotly/validators/sankey/node/hoverlabel/font/_size.py deleted file mode 100644 index a1a07f15e96..00000000000 --- a/plotly/validators/sankey/node/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='sankey.node.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/hoverlabel/font/_sizesrc.py b/plotly/validators/sankey/node/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 4569571bb09..00000000000 --- a/plotly/validators/sankey/node/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='sankey.node.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/line/__init__.py b/plotly/validators/sankey/node/line/__init__.py index 1c7b37b04f2..633c379096b 100644 --- a/plotly/validators/sankey/node/line/__init__.py +++ b/plotly/validators/sankey/node/line/__init__.py @@ -1,4 +1,71 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='widthsrc', parent_name='sankey.node.line', **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='sankey.node.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='sankey.node.line', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='sankey.node.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/sankey/node/line/_color.py b/plotly/validators/sankey/node/line/_color.py deleted file mode 100644 index b811279cf90..00000000000 --- a/plotly/validators/sankey/node/line/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='sankey.node.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/line/_colorsrc.py b/plotly/validators/sankey/node/line/_colorsrc.py deleted file mode 100644 index 65b5c9cd0c8..00000000000 --- a/plotly/validators/sankey/node/line/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='sankey.node.line', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/line/_width.py b/plotly/validators/sankey/node/line/_width.py deleted file mode 100644 index 9c03095c764..00000000000 --- a/plotly/validators/sankey/node/line/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='sankey.node.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/node/line/_widthsrc.py b/plotly/validators/sankey/node/line/_widthsrc.py deleted file mode 100644 index 9d610fc3b57..00000000000 --- a/plotly/validators/sankey/node/line/_widthsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='widthsrc', parent_name='sankey.node.line', **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/stream/__init__.py b/plotly/validators/sankey/stream/__init__.py index 2f4f2047594..9f21555fc8a 100644 --- a/plotly/validators/sankey/stream/__init__.py +++ b/plotly/validators/sankey/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='sankey.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='sankey.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/sankey/stream/_maxpoints.py b/plotly/validators/sankey/stream/_maxpoints.py deleted file mode 100644 index d24694ac380..00000000000 --- a/plotly/validators/sankey/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='sankey.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/sankey/stream/_token.py b/plotly/validators/sankey/stream/_token.py deleted file mode 100644 index e7162402943..00000000000 --- a/plotly/validators/sankey/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='sankey.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/sankey/textfont/__init__.py b/plotly/validators/sankey/textfont/__init__.py index 199d72e71c6..5060cb7be77 100644 --- a/plotly/validators/sankey/textfont/__init__.py +++ b/plotly/validators/sankey/textfont/__init__.py @@ -1,3 +1,54 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='sankey.textfont', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='sankey.textfont', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='sankey.textfont', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/sankey/textfont/_color.py b/plotly/validators/sankey/textfont/_color.py deleted file mode 100644 index bce0efe936b..00000000000 --- a/plotly/validators/sankey/textfont/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='sankey.textfont', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/sankey/textfont/_family.py b/plotly/validators/sankey/textfont/_family.py deleted file mode 100644 index a939c228ab3..00000000000 --- a/plotly/validators/sankey/textfont/_family.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='sankey.textfont', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/sankey/textfont/_size.py b/plotly/validators/sankey/textfont/_size.py deleted file mode 100644 index 17d3981f2e2..00000000000 --- a/plotly/validators/sankey/textfont/_size.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='sankey.textfont', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/__init__.py b/plotly/validators/scatter/__init__.py index 789ed1b189f..83bd070afbc 100644 --- a/plotly/validators/scatter/__init__.py +++ b/plotly/validators/scatter/__init__.py @@ -1,57 +1,1324 @@ -from ._ysrc import YsrcValidator -from ._ycalendar import YcalendarValidator -from ._yaxis import YAxisValidator -from ._y0 import Y0Validator -from ._y import YValidator -from ._xsrc import XsrcValidator -from ._xcalendar import XcalendarValidator -from ._xaxis import XAxisValidator -from ._x0 import X0Validator -from ._x import XValidator -from ._visible import VisibleValidator -from ._unselected import UnselectedValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._tsrc import TsrcValidator -from ._textsrc import TextsrcValidator -from ._textpositionsrc import TextpositionsrcValidator -from ._textposition import TextpositionValidator -from ._textfont import TextfontValidator -from ._text import TextValidator -from ._t import TValidator -from ._stream import StreamValidator -from ._stackgroup import StackgroupValidator -from ._stackgaps import StackgapsValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._selected import SelectedValidator -from ._rsrc import RsrcValidator -from ._r import RValidator -from ._orientation import OrientationValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._mode import ModeValidator -from ._marker import MarkerValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoveron import HoveronValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._groupnorm import GroupnormValidator -from ._fillcolor import FillcolorValidator -from ._fill import FillValidator -from ._error_y import ErrorYValidator -from ._error_x import ErrorXValidator -from ._dy import DyValidator -from ._dx import DxValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._connectgaps import ConnectgapsValidator -from ._cliponaxis import CliponaxisValidator + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='scatter', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ycalendar', parent_name='scatter', **kwargs + ): + super(YcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='yaxis', parent_name='scatter', **kwargs): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Y0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='y0', parent_name='scatter', **kwargs): + super(Y0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='scatter', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='scatter', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xcalendar', parent_name='scatter', **kwargs + ): + super(XcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='xaxis', parent_name='scatter', **kwargs): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class X0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='x0', parent_name='scatter', **kwargs): + super(X0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='scatter', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='scatter', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='unselected', parent_name='scatter', **kwargs + ): + super(UnselectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Unselected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.scatter.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scatter.unselected.Textfont + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='scatter', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='scatter', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='tsrc', parent_name='scatter', **kwargs): + super(TsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='textsrc', parent_name='scatter', **kwargs): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textpositionsrc', parent_name='scatter', **kwargs + ): + super(TextpositionsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='textposition', parent_name='scatter', **kwargs + ): + super(TextpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 'top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', + 'bottom center', 'bottom right' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='textfont', parent_name='scatter', **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='scatter', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='t', parent_name='scatter', **kwargs): + super(TValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='scatter', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StackgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='stackgroup', parent_name='scatter', **kwargs + ): + super(StackgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StackgapsValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='stackgaps', parent_name='scatter', **kwargs + ): + super(StackgapsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['infer zero', 'interpolate']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='scatter', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='scatter', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='selected', parent_name='scatter', **kwargs + ): + super(SelectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Selected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.scatter.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scatter.selected.Textfont + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='rsrc', parent_name='scatter', **kwargs): + super(RsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='r', parent_name='scatter', **kwargs): + super(RValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OrientationValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='orientation', parent_name='scatter', **kwargs + ): + super(OrientationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['v', 'h']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='opacity', parent_name='scatter', **kwargs): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='scatter', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__(self, plotly_name='mode', parent_name='scatter', **kwargs): + super(ModeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['none']), + flags=kwargs.pop('flags', ['lines', 'markers', 'text']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='marker', parent_name='scatter', **kwargs): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scatter.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + gradient + plotly.graph_objs.scatter.marker.Gradient + instance or dict with compatible properties + line + plotly.graph_objs.scatter.marker.Line instance + or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on + the graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='line', parent_name='scatter', **kwargs): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the + lines are drawn using spline interpolation. The + other available values correspond to step-wise + line shapes. + simplify + Simplifies lines by removing nearly-collinear + points. When transitioning lines, it may be + desirable to disable this so that the number of + points along the resulting SVG path is + unaffected. + smoothing + Has an effect only if `shape` is set to + "spline" Sets the amount of smoothing. 0 + corresponds to no smoothing (equivalent to a + "linear" shape). + width + Sets the line width (in px). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='scatter', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='scatter', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='scatter', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='scatter', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='scatter', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertemplatesrc', parent_name='scatter', **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='scatter', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoveronValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__(self, plotly_name='hoveron', parent_name='scatter', **kwargs): + super(HoveronValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + flags=kwargs.pop('flags', ['points', 'fills']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='scatter', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='scatter', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='scatter', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GroupnormValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='groupnorm', parent_name='scatter', **kwargs + ): + super(GroupnormValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['', 'fraction', 'percent']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='fillcolor', parent_name='scatter', **kwargs + ): + super(FillcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='fill', parent_name='scatter', **kwargs): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 'none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', + 'toself', 'tonext' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ErrorYValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='error_y', parent_name='scatter', **kwargs): + super(ErrorYValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ErrorY'), + data_docs=kwargs.pop( + 'data_docs', """ + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ErrorXValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='error_x', parent_name='scatter', **kwargs): + super(ErrorXValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ErrorX'), + data_docs=kwargs.pop( + 'data_docs', """ + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DyValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='dy', parent_name='scatter', **kwargs): + super(DyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='dx', parent_name='scatter', **kwargs): + super(DxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='scatter', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='scatter', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='connectgaps', parent_name='scatter', **kwargs + ): + super(ConnectgapsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CliponaxisValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cliponaxis', parent_name='scatter', **kwargs + ): + super(CliponaxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scatter/_cliponaxis.py b/plotly/validators/scatter/_cliponaxis.py deleted file mode 100644 index aa4a2717cbc..00000000000 --- a/plotly/validators/scatter/_cliponaxis.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CliponaxisValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cliponaxis', parent_name='scatter', **kwargs - ): - super(CliponaxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_connectgaps.py b/plotly/validators/scatter/_connectgaps.py deleted file mode 100644 index bb447d1b39a..00000000000 --- a/plotly/validators/scatter/_connectgaps.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='connectgaps', parent_name='scatter', **kwargs - ): - super(ConnectgapsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_customdata.py b/plotly/validators/scatter/_customdata.py deleted file mode 100644 index 289de3d13fd..00000000000 --- a/plotly/validators/scatter/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='scatter', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter/_customdatasrc.py b/plotly/validators/scatter/_customdatasrc.py deleted file mode 100644 index 5ec5f5c0b34..00000000000 --- a/plotly/validators/scatter/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='scatter', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_dx.py b/plotly/validators/scatter/_dx.py deleted file mode 100644 index 423b842fba4..00000000000 --- a/plotly/validators/scatter/_dx.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class DxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='dx', parent_name='scatter', **kwargs): - super(DxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_dy.py b/plotly/validators/scatter/_dy.py deleted file mode 100644 index ea889debac7..00000000000 --- a/plotly/validators/scatter/_dy.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class DyValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='dy', parent_name='scatter', **kwargs): - super(DyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_error_x.py b/plotly/validators/scatter/_error_x.py deleted file mode 100644 index 77521688d98..00000000000 --- a/plotly/validators/scatter/_error_x.py +++ /dev/null @@ -1,73 +0,0 @@ -import _plotly_utils.basevalidators - - -class ErrorXValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='error_x', parent_name='scatter', **kwargs): - super(ErrorXValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ErrorX'), - data_docs=kwargs.pop( - 'data_docs', """ - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - copy_ystyle - - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/_error_y.py b/plotly/validators/scatter/_error_y.py deleted file mode 100644 index 6a2b8dee81d..00000000000 --- a/plotly/validators/scatter/_error_y.py +++ /dev/null @@ -1,71 +0,0 @@ -import _plotly_utils.basevalidators - - -class ErrorYValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='error_y', parent_name='scatter', **kwargs): - super(ErrorYValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ErrorY'), - data_docs=kwargs.pop( - 'data_docs', """ - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/_fill.py b/plotly/validators/scatter/_fill.py deleted file mode 100644 index b1dcdeb006e..00000000000 --- a/plotly/validators/scatter/_fill.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='fill', parent_name='scatter', **kwargs): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 'none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', - 'toself', 'tonext' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatter/_fillcolor.py b/plotly/validators/scatter/_fillcolor.py deleted file mode 100644 index c824664acba..00000000000 --- a/plotly/validators/scatter/_fillcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='fillcolor', parent_name='scatter', **kwargs - ): - super(FillcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/_groupnorm.py b/plotly/validators/scatter/_groupnorm.py deleted file mode 100644 index dd810b04d12..00000000000 --- a/plotly/validators/scatter/_groupnorm.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class GroupnormValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='groupnorm', parent_name='scatter', **kwargs - ): - super(GroupnormValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['', 'fraction', 'percent']), - **kwargs - ) diff --git a/plotly/validators/scatter/_hoverinfo.py b/plotly/validators/scatter/_hoverinfo.py deleted file mode 100644 index b3e22da6753..00000000000 --- a/plotly/validators/scatter/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='scatter', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_hoverinfosrc.py b/plotly/validators/scatter/_hoverinfosrc.py deleted file mode 100644 index 17b4226ac45..00000000000 --- a/plotly/validators/scatter/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='scatter', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_hoverlabel.py b/plotly/validators/scatter/_hoverlabel.py deleted file mode 100644 index b7c56d65ab4..00000000000 --- a/plotly/validators/scatter/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='scatter', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/_hoveron.py b/plotly/validators/scatter/_hoveron.py deleted file mode 100644 index fcb5b2cfe6e..00000000000 --- a/plotly/validators/scatter/_hoveron.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoveronValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__(self, plotly_name='hoveron', parent_name='scatter', **kwargs): - super(HoveronValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - flags=kwargs.pop('flags', ['points', 'fills']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_hovertemplate.py b/plotly/validators/scatter/_hovertemplate.py deleted file mode 100644 index c985d9e30ee..00000000000 --- a/plotly/validators/scatter/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='scatter', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_hovertemplatesrc.py b/plotly/validators/scatter/_hovertemplatesrc.py deleted file mode 100644 index 654f490afbe..00000000000 --- a/plotly/validators/scatter/_hovertemplatesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertemplatesrc', parent_name='scatter', **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_hovertext.py b/plotly/validators/scatter/_hovertext.py deleted file mode 100644 index 4af137b9471..00000000000 --- a/plotly/validators/scatter/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='scatter', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_hovertextsrc.py b/plotly/validators/scatter/_hovertextsrc.py deleted file mode 100644 index 9a1692c0282..00000000000 --- a/plotly/validators/scatter/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='scatter', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_ids.py b/plotly/validators/scatter/_ids.py deleted file mode 100644 index e423373fc57..00000000000 --- a/plotly/validators/scatter/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='scatter', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter/_idssrc.py b/plotly/validators/scatter/_idssrc.py deleted file mode 100644 index 6aaa884589e..00000000000 --- a/plotly/validators/scatter/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='scatter', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_legendgroup.py b/plotly/validators/scatter/_legendgroup.py deleted file mode 100644 index 7d38b1a157f..00000000000 --- a/plotly/validators/scatter/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='scatter', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_line.py b/plotly/validators/scatter/_line.py deleted file mode 100644 index fb3e2a5c68a..00000000000 --- a/plotly/validators/scatter/_line.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='line', parent_name='scatter', **kwargs): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - shape - Determines the line shape. With "spline" the - lines are drawn using spline interpolation. The - other available values correspond to step-wise - line shapes. - simplify - Simplifies lines by removing nearly-collinear - points. When transitioning lines, it may be - desirable to disable this so that the number of - points along the resulting SVG path is - unaffected. - smoothing - Has an effect only if `shape` is set to - "spline" Sets the amount of smoothing. 0 - corresponds to no smoothing (equivalent to a - "linear" shape). - width - Sets the line width (in px). -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/_marker.py b/plotly/validators/scatter/_marker.py deleted file mode 100644 index 87636ada700..00000000000 --- a/plotly/validators/scatter/_marker.py +++ /dev/null @@ -1,135 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='marker', parent_name='scatter', **kwargs): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scatter.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - gradient - plotly.graph_objs.scatter.marker.Gradient - instance or dict with compatible properties - line - plotly.graph_objs.scatter.marker.Line instance - or dict with compatible properties - maxdisplayed - Sets a maximum number of points to be drawn on - the graph. 0 corresponds to no limit. - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/_mode.py b/plotly/validators/scatter/_mode.py deleted file mode 100644 index 617260bfe87..00000000000 --- a/plotly/validators/scatter/_mode.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__(self, plotly_name='mode', parent_name='scatter', **kwargs): - super(ModeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['none']), - flags=kwargs.pop('flags', ['lines', 'markers', 'text']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_name.py b/plotly/validators/scatter/_name.py deleted file mode 100644 index 566370864b0..00000000000 --- a/plotly/validators/scatter/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='scatter', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_opacity.py b/plotly/validators/scatter/_opacity.py deleted file mode 100644 index e16ca4603fa..00000000000 --- a/plotly/validators/scatter/_opacity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='opacity', parent_name='scatter', **kwargs): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/_orientation.py b/plotly/validators/scatter/_orientation.py deleted file mode 100644 index c7ef9b208a9..00000000000 --- a/plotly/validators/scatter/_orientation.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class OrientationValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='orientation', parent_name='scatter', **kwargs - ): - super(OrientationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['v', 'h']), - **kwargs - ) diff --git a/plotly/validators/scatter/_r.py b/plotly/validators/scatter/_r.py deleted file mode 100644 index f1f628a1dad..00000000000 --- a/plotly/validators/scatter/_r.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class RValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='r', parent_name='scatter', **kwargs): - super(RValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter/_rsrc.py b/plotly/validators/scatter/_rsrc.py deleted file mode 100644 index 2693992e6b8..00000000000 --- a/plotly/validators/scatter/_rsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class RsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='rsrc', parent_name='scatter', **kwargs): - super(RsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_selected.py b/plotly/validators/scatter/_selected.py deleted file mode 100644 index 360c8660369..00000000000 --- a/plotly/validators/scatter/_selected.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='selected', parent_name='scatter', **kwargs - ): - super(SelectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Selected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.scatter.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scatter.selected.Textfont - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/_selectedpoints.py b/plotly/validators/scatter/_selectedpoints.py deleted file mode 100644 index 3b187c96cd1..00000000000 --- a/plotly/validators/scatter/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='scatter', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_showlegend.py b/plotly/validators/scatter/_showlegend.py deleted file mode 100644 index cc0cfc87db4..00000000000 --- a/plotly/validators/scatter/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='scatter', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_stackgaps.py b/plotly/validators/scatter/_stackgaps.py deleted file mode 100644 index 675cb137a2c..00000000000 --- a/plotly/validators/scatter/_stackgaps.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class StackgapsValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='stackgaps', parent_name='scatter', **kwargs - ): - super(StackgapsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['infer zero', 'interpolate']), - **kwargs - ) diff --git a/plotly/validators/scatter/_stackgroup.py b/plotly/validators/scatter/_stackgroup.py deleted file mode 100644 index ecb78f3b33c..00000000000 --- a/plotly/validators/scatter/_stackgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class StackgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='stackgroup', parent_name='scatter', **kwargs - ): - super(StackgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_stream.py b/plotly/validators/scatter/_stream.py deleted file mode 100644 index c28fa3fee18..00000000000 --- a/plotly/validators/scatter/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='scatter', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/_t.py b/plotly/validators/scatter/_t.py deleted file mode 100644 index 65ba483a9ad..00000000000 --- a/plotly/validators/scatter/_t.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='t', parent_name='scatter', **kwargs): - super(TValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter/_text.py b/plotly/validators/scatter/_text.py deleted file mode 100644 index f56fb34fee1..00000000000 --- a/plotly/validators/scatter/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='scatter', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_textfont.py b/plotly/validators/scatter/_textfont.py deleted file mode 100644 index 5ed0d0691b1..00000000000 --- a/plotly/validators/scatter/_textfont.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='textfont', parent_name='scatter', **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/_textposition.py b/plotly/validators/scatter/_textposition.py deleted file mode 100644 index 0ba8559379e..00000000000 --- a/plotly/validators/scatter/_textposition.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='textposition', parent_name='scatter', **kwargs - ): - super(TextpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 'top left', 'top center', 'top right', 'middle left', - 'middle center', 'middle right', 'bottom left', - 'bottom center', 'bottom right' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatter/_textpositionsrc.py b/plotly/validators/scatter/_textpositionsrc.py deleted file mode 100644 index 3387f8fc03b..00000000000 --- a/plotly/validators/scatter/_textpositionsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textpositionsrc', parent_name='scatter', **kwargs - ): - super(TextpositionsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_textsrc.py b/plotly/validators/scatter/_textsrc.py deleted file mode 100644 index 80484a2b9c3..00000000000 --- a/plotly/validators/scatter/_textsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='textsrc', parent_name='scatter', **kwargs): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_tsrc.py b/plotly/validators/scatter/_tsrc.py deleted file mode 100644 index fad3c1d1627..00000000000 --- a/plotly/validators/scatter/_tsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='tsrc', parent_name='scatter', **kwargs): - super(TsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_uid.py b/plotly/validators/scatter/_uid.py deleted file mode 100644 index 819ebcfae70..00000000000 --- a/plotly/validators/scatter/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='scatter', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_uirevision.py b/plotly/validators/scatter/_uirevision.py deleted file mode 100644 index 530c8f52591..00000000000 --- a/plotly/validators/scatter/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='scatter', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_unselected.py b/plotly/validators/scatter/_unselected.py deleted file mode 100644 index 4352a944808..00000000000 --- a/plotly/validators/scatter/_unselected.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='unselected', parent_name='scatter', **kwargs - ): - super(UnselectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Unselected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.scatter.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scatter.unselected.Textfont - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/_visible.py b/plotly/validators/scatter/_visible.py deleted file mode 100644 index 95e1e1a801d..00000000000 --- a/plotly/validators/scatter/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='scatter', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/scatter/_x.py b/plotly/validators/scatter/_x.py deleted file mode 100644 index a36aca3dc37..00000000000 --- a/plotly/validators/scatter/_x.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='scatter', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter/_x0.py b/plotly/validators/scatter/_x0.py deleted file mode 100644 index cf3ef837e3d..00000000000 --- a/plotly/validators/scatter/_x0.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class X0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='x0', parent_name='scatter', **kwargs): - super(X0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_xaxis.py b/plotly/validators/scatter/_xaxis.py deleted file mode 100644 index f5e7ed21f3c..00000000000 --- a/plotly/validators/scatter/_xaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='xaxis', parent_name='scatter', **kwargs): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_xcalendar.py b/plotly/validators/scatter/_xcalendar.py deleted file mode 100644 index 4f7e4ad4356..00000000000 --- a/plotly/validators/scatter/_xcalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xcalendar', parent_name='scatter', **kwargs - ): - super(XcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatter/_xsrc.py b/plotly/validators/scatter/_xsrc.py deleted file mode 100644 index be1d8c2ec54..00000000000 --- a/plotly/validators/scatter/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='scatter', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_y.py b/plotly/validators/scatter/_y.py deleted file mode 100644 index 4678fd97ed2..00000000000 --- a/plotly/validators/scatter/_y.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='scatter', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter/_y0.py b/plotly/validators/scatter/_y0.py deleted file mode 100644 index 693388c217a..00000000000 --- a/plotly/validators/scatter/_y0.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class Y0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='y0', parent_name='scatter', **kwargs): - super(Y0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_yaxis.py b/plotly/validators/scatter/_yaxis.py deleted file mode 100644 index 13be404001f..00000000000 --- a/plotly/validators/scatter/_yaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='yaxis', parent_name='scatter', **kwargs): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/_ycalendar.py b/plotly/validators/scatter/_ycalendar.py deleted file mode 100644 index 65bcb98967e..00000000000 --- a/plotly/validators/scatter/_ycalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ycalendar', parent_name='scatter', **kwargs - ): - super(YcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatter/_ysrc.py b/plotly/validators/scatter/_ysrc.py deleted file mode 100644 index 1b62fa3792f..00000000000 --- a/plotly/validators/scatter/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='scatter', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_x/__init__.py b/plotly/validators/scatter/error_x/__init__.py index c4605e01877..dec87130b22 100644 --- a/plotly/validators/scatter/error_x/__init__.py +++ b/plotly/validators/scatter/error_x/__init__.py @@ -1,15 +1,279 @@ -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._valueminus import ValueminusValidator -from ._value import ValueValidator -from ._type import TypeValidator -from ._tracerefminus import TracerefminusValidator -from ._traceref import TracerefValidator -from ._thickness import ThicknessValidator -from ._symmetric import SymmetricValidator -from ._copy_ystyle import CopyYstyleValidator -from ._color import ColorValidator -from ._arraysrc import ArraysrcValidator -from ._arrayminussrc import ArrayminussrcValidator -from ._arrayminus import ArrayminusValidator -from ._array import ArrayValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scatter.error_x', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='scatter.error_x', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='valueminus', + parent_name='scatter.error_x', + **kwargs + ): + super(ValueminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='value', parent_name='scatter.error_x', **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='scatter.error_x', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['percent', 'constant', 'sqrt', 'data'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='tracerefminus', + parent_name='scatter.error_x', + **kwargs + ): + super(TracerefminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='traceref', parent_name='scatter.error_x', **kwargs + ): + super(TracerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='thickness', parent_name='scatter.error_x', **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='symmetric', parent_name='scatter.error_x', **kwargs + ): + super(SymmetricValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CopyYstyleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='copy_ystyle', + parent_name='scatter.error_x', + **kwargs + ): + super(CopyYstyleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scatter.error_x', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='arraysrc', parent_name='scatter.error_x', **kwargs + ): + super(ArraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='arrayminussrc', + parent_name='scatter.error_x', + **kwargs + ): + super(ArrayminussrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='arrayminus', + parent_name='scatter.error_x', + **kwargs + ): + super(ArrayminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='array', parent_name='scatter.error_x', **kwargs + ): + super(ArrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/scatter/error_x/_array.py b/plotly/validators/scatter/error_x/_array.py deleted file mode 100644 index 0e6584aa2ff..00000000000 --- a/plotly/validators/scatter/error_x/_array.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='array', parent_name='scatter.error_x', **kwargs - ): - super(ArrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_x/_arrayminus.py b/plotly/validators/scatter/error_x/_arrayminus.py deleted file mode 100644 index f63ba57ddcf..00000000000 --- a/plotly/validators/scatter/error_x/_arrayminus.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='arrayminus', - parent_name='scatter.error_x', - **kwargs - ): - super(ArrayminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_x/_arrayminussrc.py b/plotly/validators/scatter/error_x/_arrayminussrc.py deleted file mode 100644 index 19843aa224a..00000000000 --- a/plotly/validators/scatter/error_x/_arrayminussrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='arrayminussrc', - parent_name='scatter.error_x', - **kwargs - ): - super(ArrayminussrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_x/_arraysrc.py b/plotly/validators/scatter/error_x/_arraysrc.py deleted file mode 100644 index 54e9b55238e..00000000000 --- a/plotly/validators/scatter/error_x/_arraysrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='arraysrc', parent_name='scatter.error_x', **kwargs - ): - super(ArraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_x/_color.py b/plotly/validators/scatter/error_x/_color.py deleted file mode 100644 index 11c75e3d667..00000000000 --- a/plotly/validators/scatter/error_x/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scatter.error_x', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_x/_copy_ystyle.py b/plotly/validators/scatter/error_x/_copy_ystyle.py deleted file mode 100644 index 0ff5054ffae..00000000000 --- a/plotly/validators/scatter/error_x/_copy_ystyle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CopyYstyleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='copy_ystyle', - parent_name='scatter.error_x', - **kwargs - ): - super(CopyYstyleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_x/_symmetric.py b/plotly/validators/scatter/error_x/_symmetric.py deleted file mode 100644 index cdc784518a7..00000000000 --- a/plotly/validators/scatter/error_x/_symmetric.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='symmetric', parent_name='scatter.error_x', **kwargs - ): - super(SymmetricValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_x/_thickness.py b/plotly/validators/scatter/error_x/_thickness.py deleted file mode 100644 index aea6443dab7..00000000000 --- a/plotly/validators/scatter/error_x/_thickness.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='thickness', parent_name='scatter.error_x', **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_x/_traceref.py b/plotly/validators/scatter/error_x/_traceref.py deleted file mode 100644 index f194cca314b..00000000000 --- a/plotly/validators/scatter/error_x/_traceref.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='traceref', parent_name='scatter.error_x', **kwargs - ): - super(TracerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_x/_tracerefminus.py b/plotly/validators/scatter/error_x/_tracerefminus.py deleted file mode 100644 index 81eb6fc4fb3..00000000000 --- a/plotly/validators/scatter/error_x/_tracerefminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='tracerefminus', - parent_name='scatter.error_x', - **kwargs - ): - super(TracerefminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_x/_type.py b/plotly/validators/scatter/error_x/_type.py deleted file mode 100644 index 72d9156b4c9..00000000000 --- a/plotly/validators/scatter/error_x/_type.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='scatter.error_x', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['percent', 'constant', 'sqrt', 'data'] - ), - **kwargs - ) diff --git a/plotly/validators/scatter/error_x/_value.py b/plotly/validators/scatter/error_x/_value.py deleted file mode 100644 index 3b711d57f18..00000000000 --- a/plotly/validators/scatter/error_x/_value.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='value', parent_name='scatter.error_x', **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_x/_valueminus.py b/plotly/validators/scatter/error_x/_valueminus.py deleted file mode 100644 index bf601a64bbe..00000000000 --- a/plotly/validators/scatter/error_x/_valueminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='valueminus', - parent_name='scatter.error_x', - **kwargs - ): - super(ValueminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_x/_visible.py b/plotly/validators/scatter/error_x/_visible.py deleted file mode 100644 index 69e3d1a2ee9..00000000000 --- a/plotly/validators/scatter/error_x/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='scatter.error_x', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_x/_width.py b/plotly/validators/scatter/error_x/_width.py deleted file mode 100644 index aae9032919e..00000000000 --- a/plotly/validators/scatter/error_x/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scatter.error_x', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_y/__init__.py b/plotly/validators/scatter/error_y/__init__.py index 2fc70c4058d..1fb0b38f254 100644 --- a/plotly/validators/scatter/error_y/__init__.py +++ b/plotly/validators/scatter/error_y/__init__.py @@ -1,14 +1,259 @@ -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._valueminus import ValueminusValidator -from ._value import ValueValidator -from ._type import TypeValidator -from ._tracerefminus import TracerefminusValidator -from ._traceref import TracerefValidator -from ._thickness import ThicknessValidator -from ._symmetric import SymmetricValidator -from ._color import ColorValidator -from ._arraysrc import ArraysrcValidator -from ._arrayminussrc import ArrayminussrcValidator -from ._arrayminus import ArrayminusValidator -from ._array import ArrayValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scatter.error_y', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='scatter.error_y', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='valueminus', + parent_name='scatter.error_y', + **kwargs + ): + super(ValueminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='value', parent_name='scatter.error_y', **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='scatter.error_y', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['percent', 'constant', 'sqrt', 'data'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='tracerefminus', + parent_name='scatter.error_y', + **kwargs + ): + super(TracerefminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='traceref', parent_name='scatter.error_y', **kwargs + ): + super(TracerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='thickness', parent_name='scatter.error_y', **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='symmetric', parent_name='scatter.error_y', **kwargs + ): + super(SymmetricValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scatter.error_y', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='arraysrc', parent_name='scatter.error_y', **kwargs + ): + super(ArraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='arrayminussrc', + parent_name='scatter.error_y', + **kwargs + ): + super(ArrayminussrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='arrayminus', + parent_name='scatter.error_y', + **kwargs + ): + super(ArrayminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='array', parent_name='scatter.error_y', **kwargs + ): + super(ArrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/scatter/error_y/_array.py b/plotly/validators/scatter/error_y/_array.py deleted file mode 100644 index cb8d534f74d..00000000000 --- a/plotly/validators/scatter/error_y/_array.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='array', parent_name='scatter.error_y', **kwargs - ): - super(ArrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_y/_arrayminus.py b/plotly/validators/scatter/error_y/_arrayminus.py deleted file mode 100644 index f95b0308b27..00000000000 --- a/plotly/validators/scatter/error_y/_arrayminus.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='arrayminus', - parent_name='scatter.error_y', - **kwargs - ): - super(ArrayminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_y/_arrayminussrc.py b/plotly/validators/scatter/error_y/_arrayminussrc.py deleted file mode 100644 index d5716ed9409..00000000000 --- a/plotly/validators/scatter/error_y/_arrayminussrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='arrayminussrc', - parent_name='scatter.error_y', - **kwargs - ): - super(ArrayminussrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_y/_arraysrc.py b/plotly/validators/scatter/error_y/_arraysrc.py deleted file mode 100644 index f826a036855..00000000000 --- a/plotly/validators/scatter/error_y/_arraysrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='arraysrc', parent_name='scatter.error_y', **kwargs - ): - super(ArraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_y/_color.py b/plotly/validators/scatter/error_y/_color.py deleted file mode 100644 index 7d6567ea1ed..00000000000 --- a/plotly/validators/scatter/error_y/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scatter.error_y', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_y/_symmetric.py b/plotly/validators/scatter/error_y/_symmetric.py deleted file mode 100644 index b252ebc85b4..00000000000 --- a/plotly/validators/scatter/error_y/_symmetric.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='symmetric', parent_name='scatter.error_y', **kwargs - ): - super(SymmetricValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_y/_thickness.py b/plotly/validators/scatter/error_y/_thickness.py deleted file mode 100644 index a0d18c77b39..00000000000 --- a/plotly/validators/scatter/error_y/_thickness.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='thickness', parent_name='scatter.error_y', **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_y/_traceref.py b/plotly/validators/scatter/error_y/_traceref.py deleted file mode 100644 index 5cc657838bf..00000000000 --- a/plotly/validators/scatter/error_y/_traceref.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='traceref', parent_name='scatter.error_y', **kwargs - ): - super(TracerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_y/_tracerefminus.py b/plotly/validators/scatter/error_y/_tracerefminus.py deleted file mode 100644 index d9d1f8aebc1..00000000000 --- a/plotly/validators/scatter/error_y/_tracerefminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='tracerefminus', - parent_name='scatter.error_y', - **kwargs - ): - super(TracerefminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_y/_type.py b/plotly/validators/scatter/error_y/_type.py deleted file mode 100644 index a3c04bfba35..00000000000 --- a/plotly/validators/scatter/error_y/_type.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='scatter.error_y', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['percent', 'constant', 'sqrt', 'data'] - ), - **kwargs - ) diff --git a/plotly/validators/scatter/error_y/_value.py b/plotly/validators/scatter/error_y/_value.py deleted file mode 100644 index c1e34dbe895..00000000000 --- a/plotly/validators/scatter/error_y/_value.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='value', parent_name='scatter.error_y', **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_y/_valueminus.py b/plotly/validators/scatter/error_y/_valueminus.py deleted file mode 100644 index 5f0ea4c8815..00000000000 --- a/plotly/validators/scatter/error_y/_valueminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='valueminus', - parent_name='scatter.error_y', - **kwargs - ): - super(ValueminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_y/_visible.py b/plotly/validators/scatter/error_y/_visible.py deleted file mode 100644 index bfd139a8e80..00000000000 --- a/plotly/validators/scatter/error_y/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='scatter.error_y', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/error_y/_width.py b/plotly/validators/scatter/error_y/_width.py deleted file mode 100644 index e4564810bb4..00000000000 --- a/plotly/validators/scatter/error_y/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scatter.error_y', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/hoverlabel/__init__.py b/plotly/validators/scatter/hoverlabel/__init__.py index 856f769ba33..3c1714b30bc 100644 --- a/plotly/validators/scatter/hoverlabel/__init__.py +++ b/plotly/validators/scatter/hoverlabel/__init__.py @@ -1,7 +1,173 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='scatter.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='scatter.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='scatter.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='scatter.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scatter.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='scatter.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scatter.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter/hoverlabel/_bgcolor.py b/plotly/validators/scatter/hoverlabel/_bgcolor.py deleted file mode 100644 index beb4a8cbbc2..00000000000 --- a/plotly/validators/scatter/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scatter.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/hoverlabel/_bgcolorsrc.py b/plotly/validators/scatter/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 402d4c4006f..00000000000 --- a/plotly/validators/scatter/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='scatter.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/hoverlabel/_bordercolor.py b/plotly/validators/scatter/hoverlabel/_bordercolor.py deleted file mode 100644 index f8bcdb703fe..00000000000 --- a/plotly/validators/scatter/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scatter.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/hoverlabel/_bordercolorsrc.py b/plotly/validators/scatter/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index c2548c281be..00000000000 --- a/plotly/validators/scatter/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='scatter.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/hoverlabel/_font.py b/plotly/validators/scatter/hoverlabel/_font.py deleted file mode 100644 index 455717a993d..00000000000 --- a/plotly/validators/scatter/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='scatter.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/hoverlabel/_namelength.py b/plotly/validators/scatter/hoverlabel/_namelength.py deleted file mode 100644 index cb10c034186..00000000000 --- a/plotly/validators/scatter/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='scatter.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/hoverlabel/_namelengthsrc.py b/plotly/validators/scatter/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 9dd3f75fed5..00000000000 --- a/plotly/validators/scatter/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='scatter.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/hoverlabel/font/__init__.py b/plotly/validators/scatter/hoverlabel/font/__init__.py index 1d2c591d1e5..aaadbb3bb54 100644 --- a/plotly/validators/scatter/hoverlabel/font/__init__.py +++ b/plotly/validators/scatter/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scatter.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatter.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='scatter.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatter.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatter.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatter.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter/hoverlabel/font/_color.py b/plotly/validators/scatter/hoverlabel/font/_color.py deleted file mode 100644 index 2ed0978c74a..00000000000 --- a/plotly/validators/scatter/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatter.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/hoverlabel/font/_colorsrc.py b/plotly/validators/scatter/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 2a4f066d49e..00000000000 --- a/plotly/validators/scatter/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatter.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/hoverlabel/font/_family.py b/plotly/validators/scatter/hoverlabel/font/_family.py deleted file mode 100644 index c2199160c29..00000000000 --- a/plotly/validators/scatter/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatter.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatter/hoverlabel/font/_familysrc.py b/plotly/validators/scatter/hoverlabel/font/_familysrc.py deleted file mode 100644 index 64e37ec2cd2..00000000000 --- a/plotly/validators/scatter/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='scatter.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/hoverlabel/font/_size.py b/plotly/validators/scatter/hoverlabel/font/_size.py deleted file mode 100644 index 8f99447f2e3..00000000000 --- a/plotly/validators/scatter/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatter.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/hoverlabel/font/_sizesrc.py b/plotly/validators/scatter/hoverlabel/font/_sizesrc.py deleted file mode 100644 index a233a06715c..00000000000 --- a/plotly/validators/scatter/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scatter.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/line/__init__.py b/plotly/validators/scatter/line/__init__.py index 3700fa473f6..0038a1a0248 100644 --- a/plotly/validators/scatter/line/__init__.py +++ b/plotly/validators/scatter/line/__init__.py @@ -1,6 +1,114 @@ -from ._width import WidthValidator -from ._smoothing import SmoothingValidator -from ._simplify import SimplifyValidator -from ._shape import ShapeValidator -from ._dash import DashValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scatter.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='smoothing', parent_name='scatter.line', **kwargs + ): + super(SmoothingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 1.3), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SimplifyValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='simplify', parent_name='scatter.line', **kwargs + ): + super(SimplifyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShapeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='shape', parent_name='scatter.line', **kwargs + ): + super(ShapeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['linear', 'spline', 'hv', 'vh', 'hvh', 'vhv'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashValidator(_plotly_utils.basevalidators.DashValidator): + + def __init__( + self, plotly_name='dash', parent_name='scatter.line', **kwargs + ): + super(DashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scatter.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter/line/_color.py b/plotly/validators/scatter/line/_color.py deleted file mode 100644 index 7f8cefbd859..00000000000 --- a/plotly/validators/scatter/line/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scatter.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/line/_dash.py b/plotly/validators/scatter/line/_dash.py deleted file mode 100644 index cdc102f977b..00000000000 --- a/plotly/validators/scatter/line/_dash.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashValidator(_plotly_utils.basevalidators.DashValidator): - - def __init__( - self, plotly_name='dash', parent_name='scatter.line', **kwargs - ): - super(DashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/scatter/line/_shape.py b/plotly/validators/scatter/line/_shape.py deleted file mode 100644 index e6a8d60a4ff..00000000000 --- a/plotly/validators/scatter/line/_shape.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShapeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='shape', parent_name='scatter.line', **kwargs - ): - super(ShapeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['linear', 'spline', 'hv', 'vh', 'hvh', 'vhv'] - ), - **kwargs - ) diff --git a/plotly/validators/scatter/line/_simplify.py b/plotly/validators/scatter/line/_simplify.py deleted file mode 100644 index c61ed0b5270..00000000000 --- a/plotly/validators/scatter/line/_simplify.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SimplifyValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='simplify', parent_name='scatter.line', **kwargs - ): - super(SimplifyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/line/_smoothing.py b/plotly/validators/scatter/line/_smoothing.py deleted file mode 100644 index 2e353c22355..00000000000 --- a/plotly/validators/scatter/line/_smoothing.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='smoothing', parent_name='scatter.line', **kwargs - ): - super(SmoothingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 1.3), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/line/_width.py b/plotly/validators/scatter/line/_width.py deleted file mode 100644 index 2ad030ed949..00000000000 --- a/plotly/validators/scatter/line/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scatter.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/__init__.py b/plotly/validators/scatter/marker/__init__.py index d137ae66f94..b28baab879a 100644 --- a/plotly/validators/scatter/marker/__init__.py +++ b/plotly/validators/scatter/marker/__init__.py @@ -1,23 +1,797 @@ -from ._symbolsrc import SymbolsrcValidator -from ._symbol import SymbolValidator -from ._sizesrc import SizesrcValidator -from ._sizeref import SizerefValidator -from ._sizemode import SizemodeValidator -from ._sizemin import SizeminValidator -from ._size import SizeValidator -from ._showscale import ShowscaleValidator -from ._reversescale import ReversescaleValidator -from ._opacitysrc import OpacitysrcValidator -from ._opacity import OpacityValidator -from ._maxdisplayed import MaxdisplayedValidator -from ._line import LineValidator -from ._gradient import GradientValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='symbolsrc', parent_name='scatter.marker', **kwargs + ): + super(SymbolsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='symbol', parent_name='scatter.marker', **kwargs + ): + super(SymbolValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, + 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', + 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', + 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', + 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', + 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, + 'star-triangle-down-open', 220, 'star-triangle-down-dot', + 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', + 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, + 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, + 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, + 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='sizesrc', parent_name='scatter.marker', **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sizeref', parent_name='scatter.marker', **kwargs + ): + super(SizerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='sizemode', parent_name='scatter.marker', **kwargs + ): + super(SizemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['diameter', 'area']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sizemin', parent_name='scatter.marker', **kwargs + ): + super(SizeminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='scatter.marker', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='scatter.marker', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scatter.marker', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='opacitysrc', parent_name='scatter.marker', **kwargs + ): + super(OpacitysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='scatter.marker', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxdisplayedValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxdisplayed', + parent_name='scatter.marker', + **kwargs + ): + super(MaxdisplayedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='scatter.marker', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GradientValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='gradient', parent_name='scatter.marker', **kwargs + ): + super(GradientValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Gradient'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the final color of the gradient fill: the + center color for radial, the right for + horizontal, or the bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color + . + type + Sets the type of gradient used to fill the + markers + typesrc + Sets the source reference on plot.ly for type + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='scatter.marker', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='scatter.marker', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='scatter.marker', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scatter.marker.colorbar.Tickf + ormatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scatter.marker.colorbar.tickformatstopdefault + s), sets the default property values to use for + elements of + scatter.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatter.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + scatter.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. + titleside + Deprecated: Please use + scatter.marker.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scatter.marker', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scatter.marker.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='scatter.marker', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='scatter.marker', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='scatter.marker', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='scatter.marker', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scatter.marker', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter/marker/_autocolorscale.py b/plotly/validators/scatter/marker/_autocolorscale.py deleted file mode 100644 index c75ddd56186..00000000000 --- a/plotly/validators/scatter/marker/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scatter.marker', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_cauto.py b/plotly/validators/scatter/marker/_cauto.py deleted file mode 100644 index b4e3add9dfb..00000000000 --- a/plotly/validators/scatter/marker/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='scatter.marker', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_cmax.py b/plotly/validators/scatter/marker/_cmax.py deleted file mode 100644 index 18647246586..00000000000 --- a/plotly/validators/scatter/marker/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='scatter.marker', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_cmid.py b/plotly/validators/scatter/marker/_cmid.py deleted file mode 100644 index 5b7c8e0281f..00000000000 --- a/plotly/validators/scatter/marker/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='scatter.marker', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_cmin.py b/plotly/validators/scatter/marker/_cmin.py deleted file mode 100644 index c25be5af579..00000000000 --- a/plotly/validators/scatter/marker/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='scatter.marker', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_color.py b/plotly/validators/scatter/marker/_color.py deleted file mode 100644 index e14badeff6c..00000000000 --- a/plotly/validators/scatter/marker/_color.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scatter.marker', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scatter.marker.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_colorbar.py b/plotly/validators/scatter/marker/_colorbar.py deleted file mode 100644 index 0174e20f44a..00000000000 --- a/plotly/validators/scatter/marker/_colorbar.py +++ /dev/null @@ -1,228 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='scatter.marker', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scatter.marker.colorbar.Tickf - ormatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scatter.marker.colorbar.tickformatstopdefault - s), sets the default property values to use for - elements of - scatter.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatter.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - scatter.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. - titleside - Deprecated: Please use - scatter.marker.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_colorscale.py b/plotly/validators/scatter/marker/_colorscale.py deleted file mode 100644 index 552626894a9..00000000000 --- a/plotly/validators/scatter/marker/_colorscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='scatter.marker', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_colorsrc.py b/plotly/validators/scatter/marker/_colorsrc.py deleted file mode 100644 index a682438371c..00000000000 --- a/plotly/validators/scatter/marker/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='scatter.marker', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_gradient.py b/plotly/validators/scatter/marker/_gradient.py deleted file mode 100644 index c7d8e7a3243..00000000000 --- a/plotly/validators/scatter/marker/_gradient.py +++ /dev/null @@ -1,31 +0,0 @@ -import _plotly_utils.basevalidators - - -class GradientValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='gradient', parent_name='scatter.marker', **kwargs - ): - super(GradientValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Gradient'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the final color of the gradient fill: the - center color for radial, the right for - horizontal, or the bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color - . - type - Sets the type of gradient used to fill the - markers - typesrc - Sets the source reference on plot.ly for type - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_line.py b/plotly/validators/scatter/marker/_line.py deleted file mode 100644 index 463fdbc5747..00000000000 --- a/plotly/validators/scatter/marker/_line.py +++ /dev/null @@ -1,97 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='scatter.marker', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_maxdisplayed.py b/plotly/validators/scatter/marker/_maxdisplayed.py deleted file mode 100644 index b7feb751de5..00000000000 --- a/plotly/validators/scatter/marker/_maxdisplayed.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxdisplayedValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxdisplayed', - parent_name='scatter.marker', - **kwargs - ): - super(MaxdisplayedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_opacity.py b/plotly/validators/scatter/marker/_opacity.py deleted file mode 100644 index 08d4d30ff62..00000000000 --- a/plotly/validators/scatter/marker/_opacity.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='scatter.marker', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_opacitysrc.py b/plotly/validators/scatter/marker/_opacitysrc.py deleted file mode 100644 index 5d66bdcf687..00000000000 --- a/plotly/validators/scatter/marker/_opacitysrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='opacitysrc', parent_name='scatter.marker', **kwargs - ): - super(OpacitysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_reversescale.py b/plotly/validators/scatter/marker/_reversescale.py deleted file mode 100644 index c7edbe44b39..00000000000 --- a/plotly/validators/scatter/marker/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scatter.marker', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_showscale.py b/plotly/validators/scatter/marker/_showscale.py deleted file mode 100644 index bb68d9eb51a..00000000000 --- a/plotly/validators/scatter/marker/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='scatter.marker', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_size.py b/plotly/validators/scatter/marker/_size.py deleted file mode 100644 index ebe956c8990..00000000000 --- a/plotly/validators/scatter/marker/_size.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='scatter.marker', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_sizemin.py b/plotly/validators/scatter/marker/_sizemin.py deleted file mode 100644 index a8740b37207..00000000000 --- a/plotly/validators/scatter/marker/_sizemin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sizemin', parent_name='scatter.marker', **kwargs - ): - super(SizeminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_sizemode.py b/plotly/validators/scatter/marker/_sizemode.py deleted file mode 100644 index ea55f09e365..00000000000 --- a/plotly/validators/scatter/marker/_sizemode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='sizemode', parent_name='scatter.marker', **kwargs - ): - super(SizemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['diameter', 'area']), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_sizeref.py b/plotly/validators/scatter/marker/_sizeref.py deleted file mode 100644 index 930e4bc4cb7..00000000000 --- a/plotly/validators/scatter/marker/_sizeref.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sizeref', parent_name='scatter.marker', **kwargs - ): - super(SizerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_sizesrc.py b/plotly/validators/scatter/marker/_sizesrc.py deleted file mode 100644 index 793d10fd1b5..00000000000 --- a/plotly/validators/scatter/marker/_sizesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='sizesrc', parent_name='scatter.marker', **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_symbol.py b/plotly/validators/scatter/marker/_symbol.py deleted file mode 100644 index 4fbc1914299..00000000000 --- a/plotly/validators/scatter/marker/_symbol.py +++ /dev/null @@ -1,78 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='symbol', parent_name='scatter.marker', **kwargs - ): - super(SymbolValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, - 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', - 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', - 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', - 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', - 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, - 'star-triangle-down-open', 220, 'star-triangle-down-dot', - 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', - 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, - 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, - 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, - 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/_symbolsrc.py b/plotly/validators/scatter/marker/_symbolsrc.py deleted file mode 100644 index 23b49db4554..00000000000 --- a/plotly/validators/scatter/marker/_symbolsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='symbolsrc', parent_name='scatter.marker', **kwargs - ): - super(SymbolsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/__init__.py b/plotly/validators/scatter/marker/colorbar/__init__.py index 3dab31f7e02..36225683f9d 100644 --- a/plotly/validators/scatter/marker/colorbar/__init__.py +++ b/plotly/validators/scatter/marker/colorbar/__init__.py @@ -1,41 +1,930 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ypad', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='scatter.marker.colorbar', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xpad', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='scatter.marker.colorbar', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='len', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scatter.marker.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter/marker/colorbar/_bgcolor.py b/plotly/validators/scatter/marker/colorbar/_bgcolor.py deleted file mode 100644 index ce3d43a6c0b..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_bordercolor.py b/plotly/validators/scatter/marker/colorbar/_bordercolor.py deleted file mode 100644 index 45c799865ef..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_borderwidth.py b/plotly/validators/scatter/marker/colorbar/_borderwidth.py deleted file mode 100644 index b1a6ef11a2c..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_dtick.py b/plotly/validators/scatter/marker/colorbar/_dtick.py deleted file mode 100644 index 61d31f5fd8a..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_exponentformat.py b/plotly/validators/scatter/marker/colorbar/_exponentformat.py deleted file mode 100644 index 4eb6c6116a9..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_len.py b/plotly/validators/scatter/marker/colorbar/_len.py deleted file mode 100644 index 551cd47cd78..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_len.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='len', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_lenmode.py b/plotly/validators/scatter/marker/colorbar/_lenmode.py deleted file mode 100644 index 3ab3e1ccb30..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_nticks.py b/plotly/validators/scatter/marker/colorbar/_nticks.py deleted file mode 100644 index 788003823fc..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_outlinecolor.py b/plotly/validators/scatter/marker/colorbar/_outlinecolor.py deleted file mode 100644 index 97b8ee8c27b..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_outlinewidth.py b/plotly/validators/scatter/marker/colorbar/_outlinewidth.py deleted file mode 100644 index 70c9327a56a..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_separatethousands.py b/plotly/validators/scatter/marker/colorbar/_separatethousands.py deleted file mode 100644 index 6d7ae384255..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_showexponent.py b/plotly/validators/scatter/marker/colorbar/_showexponent.py deleted file mode 100644 index cb88db580de..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_showticklabels.py b/plotly/validators/scatter/marker/colorbar/_showticklabels.py deleted file mode 100644 index 2ebe4970ba4..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_showtickprefix.py b/plotly/validators/scatter/marker/colorbar/_showtickprefix.py deleted file mode 100644 index b0a386c2a70..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_showticksuffix.py b/plotly/validators/scatter/marker/colorbar/_showticksuffix.py deleted file mode 100644 index e50289d63d9..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_thickness.py b/plotly/validators/scatter/marker/colorbar/_thickness.py deleted file mode 100644 index 9877c35809a..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_thicknessmode.py b/plotly/validators/scatter/marker/colorbar/_thicknessmode.py deleted file mode 100644 index 51a2072ce42..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_tick0.py b/plotly/validators/scatter/marker/colorbar/_tick0.py deleted file mode 100644 index 9e30277016a..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_tickangle.py b/plotly/validators/scatter/marker/colorbar/_tickangle.py deleted file mode 100644 index e5f6653c2a6..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_tickcolor.py b/plotly/validators/scatter/marker/colorbar/_tickcolor.py deleted file mode 100644 index b0333662641..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_tickfont.py b/plotly/validators/scatter/marker/colorbar/_tickfont.py deleted file mode 100644 index a3f8ea8d8a4..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_tickformat.py b/plotly/validators/scatter/marker/colorbar/_tickformat.py deleted file mode 100644 index 3dcc2181b51..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_tickformatstopdefaults.py b/plotly/validators/scatter/marker/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 07195576b22..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_tickformatstops.py b/plotly/validators/scatter/marker/colorbar/_tickformatstops.py deleted file mode 100644 index fe3e3559d9a..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_ticklen.py b/plotly/validators/scatter/marker/colorbar/_ticklen.py deleted file mode 100644 index 924afb452cd..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_tickmode.py b/plotly/validators/scatter/marker/colorbar/_tickmode.py deleted file mode 100644 index d18aeb16084..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_tickprefix.py b/plotly/validators/scatter/marker/colorbar/_tickprefix.py deleted file mode 100644 index f0977c17939..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_ticks.py b/plotly/validators/scatter/marker/colorbar/_ticks.py deleted file mode 100644 index 1f8b6d23b20..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_ticksuffix.py b/plotly/validators/scatter/marker/colorbar/_ticksuffix.py deleted file mode 100644 index 780149f2e0f..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_ticktext.py b/plotly/validators/scatter/marker/colorbar/_ticktext.py deleted file mode 100644 index b9322fe94af..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_ticktextsrc.py b/plotly/validators/scatter/marker/colorbar/_ticktextsrc.py deleted file mode 100644 index 157d4911e38..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_tickvals.py b/plotly/validators/scatter/marker/colorbar/_tickvals.py deleted file mode 100644 index 678aaf3daf2..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_tickvalssrc.py b/plotly/validators/scatter/marker/colorbar/_tickvalssrc.py deleted file mode 100644 index cddb12d634c..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_tickwidth.py b/plotly/validators/scatter/marker/colorbar/_tickwidth.py deleted file mode 100644 index 040c1f9d6d4..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_title.py b/plotly/validators/scatter/marker/colorbar/_title.py deleted file mode 100644 index 5a4377a2b99..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_x.py b/plotly/validators/scatter/marker/colorbar/_x.py deleted file mode 100644 index e4f173eedd0..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='scatter.marker.colorbar', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_xanchor.py b/plotly/validators/scatter/marker/colorbar/_xanchor.py deleted file mode 100644 index 0eb91cc99c6..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_xpad.py b/plotly/validators/scatter/marker/colorbar/_xpad.py deleted file mode 100644 index dc742be80c5..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_xpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xpad', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_y.py b/plotly/validators/scatter/marker/colorbar/_y.py deleted file mode 100644 index e4bf8f520ab..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='scatter.marker.colorbar', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_yanchor.py b/plotly/validators/scatter/marker/colorbar/_yanchor.py deleted file mode 100644 index 3b6c359c776..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/_ypad.py b/plotly/validators/scatter/marker/colorbar/_ypad.py deleted file mode 100644 index b6cdb621c71..00000000000 --- a/plotly/validators/scatter/marker/colorbar/_ypad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ypad', - parent_name='scatter.marker.colorbar', - **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/tickfont/__init__.py b/plotly/validators/scatter/marker/colorbar/tickfont/__init__.py index 199d72e71c6..8f9f59d0e5c 100644 --- a/plotly/validators/scatter/marker/colorbar/tickfont/__init__.py +++ b/plotly/validators/scatter/marker/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatter.marker.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatter.marker.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatter.marker.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter/marker/colorbar/tickfont/_color.py b/plotly/validators/scatter/marker/colorbar/tickfont/_color.py deleted file mode 100644 index 83ef02e7fe7..00000000000 --- a/plotly/validators/scatter/marker/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatter.marker.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/tickfont/_family.py b/plotly/validators/scatter/marker/colorbar/tickfont/_family.py deleted file mode 100644 index 78b6f7c0ab0..00000000000 --- a/plotly/validators/scatter/marker/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatter.marker.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/tickfont/_size.py b/plotly/validators/scatter/marker/colorbar/tickfont/_size.py deleted file mode 100644 index 11dc2bb5d40..00000000000 --- a/plotly/validators/scatter/marker/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatter.marker.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/tickformatstop/__init__.py b/plotly/validators/scatter/marker/colorbar/tickformatstop/__init__.py index 3f6c06cac47..8412120b773 100644 --- a/plotly/validators/scatter/marker/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/scatter/marker/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='scatter.marker.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='scatter.marker.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='scatter.marker.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='scatter.marker.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='scatter.marker.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scatter/marker/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/scatter/marker/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 07c61b1df00..00000000000 --- a/plotly/validators/scatter/marker/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='scatter.marker.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/tickformatstop/_enabled.py b/plotly/validators/scatter/marker/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index 73cc138e51e..00000000000 --- a/plotly/validators/scatter/marker/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='scatter.marker.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/tickformatstop/_name.py b/plotly/validators/scatter/marker/colorbar/tickformatstop/_name.py deleted file mode 100644 index 35a2be852b9..00000000000 --- a/plotly/validators/scatter/marker/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='scatter.marker.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/scatter/marker/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 8b8bf5a8af9..00000000000 --- a/plotly/validators/scatter/marker/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='scatter.marker.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/tickformatstop/_value.py b/plotly/validators/scatter/marker/colorbar/tickformatstop/_value.py deleted file mode 100644 index 534e66686c3..00000000000 --- a/plotly/validators/scatter/marker/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='scatter.marker.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/title/__init__.py b/plotly/validators/scatter/marker/colorbar/title/__init__.py index 33c9c145bb8..84d95ca69ea 100644 --- a/plotly/validators/scatter/marker/colorbar/title/__init__.py +++ b/plotly/validators/scatter/marker/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='scatter.marker.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='scatter.marker.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='scatter.marker.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/scatter/marker/colorbar/title/_font.py b/plotly/validators/scatter/marker/colorbar/title/_font.py deleted file mode 100644 index 3c8ef607693..00000000000 --- a/plotly/validators/scatter/marker/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='scatter.marker.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/title/_side.py b/plotly/validators/scatter/marker/colorbar/title/_side.py deleted file mode 100644 index 15608ab6ae6..00000000000 --- a/plotly/validators/scatter/marker/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='scatter.marker.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/title/_text.py b/plotly/validators/scatter/marker/colorbar/title/_text.py deleted file mode 100644 index 787e178e1ca..00000000000 --- a/plotly/validators/scatter/marker/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='scatter.marker.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/title/font/__init__.py b/plotly/validators/scatter/marker/colorbar/title/font/__init__.py index 199d72e71c6..5defd932647 100644 --- a/plotly/validators/scatter/marker/colorbar/title/font/__init__.py +++ b/plotly/validators/scatter/marker/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatter.marker.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatter.marker.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatter.marker.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter/marker/colorbar/title/font/_color.py b/plotly/validators/scatter/marker/colorbar/title/font/_color.py deleted file mode 100644 index ffde84c7982..00000000000 --- a/plotly/validators/scatter/marker/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatter.marker.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/title/font/_family.py b/plotly/validators/scatter/marker/colorbar/title/font/_family.py deleted file mode 100644 index b2899bfe193..00000000000 --- a/plotly/validators/scatter/marker/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatter.marker.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/colorbar/title/font/_size.py b/plotly/validators/scatter/marker/colorbar/title/font/_size.py deleted file mode 100644 index 784eff93ca4..00000000000 --- a/plotly/validators/scatter/marker/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatter.marker.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/gradient/__init__.py b/plotly/validators/scatter/marker/gradient/__init__.py index 434557c8fea..2af18f5535a 100644 --- a/plotly/validators/scatter/marker/gradient/__init__.py +++ b/plotly/validators/scatter/marker/gradient/__init__.py @@ -1,4 +1,85 @@ -from ._typesrc import TypesrcValidator -from ._type import TypeValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class TypesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='typesrc', + parent_name='scatter.marker.gradient', + **kwargs + ): + super(TypesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='type', + parent_name='scatter.marker.gradient', + **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['radial', 'horizontal', 'vertical', 'none'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatter.marker.gradient', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatter.marker.gradient', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter/marker/gradient/_color.py b/plotly/validators/scatter/marker/gradient/_color.py deleted file mode 100644 index f523339dfa0..00000000000 --- a/plotly/validators/scatter/marker/gradient/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatter.marker.gradient', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/gradient/_colorsrc.py b/plotly/validators/scatter/marker/gradient/_colorsrc.py deleted file mode 100644 index 2dbfe33af92..00000000000 --- a/plotly/validators/scatter/marker/gradient/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatter.marker.gradient', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/gradient/_type.py b/plotly/validators/scatter/marker/gradient/_type.py deleted file mode 100644 index 9428aa3b43e..00000000000 --- a/plotly/validators/scatter/marker/gradient/_type.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='type', - parent_name='scatter.marker.gradient', - **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['radial', 'horizontal', 'vertical', 'none'] - ), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/gradient/_typesrc.py b/plotly/validators/scatter/marker/gradient/_typesrc.py deleted file mode 100644 index a5fa09a4015..00000000000 --- a/plotly/validators/scatter/marker/gradient/_typesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='typesrc', - parent_name='scatter.marker.gradient', - **kwargs - ): - super(TypesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/line/__init__.py b/plotly/validators/scatter/marker/line/__init__.py index c031ca61ce2..bcaa3f2d28b 100644 --- a/plotly/validators/scatter/marker/line/__init__.py +++ b/plotly/validators/scatter/marker/line/__init__.py @@ -1,11 +1,218 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._reversescale import ReversescaleValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='widthsrc', + parent_name='scatter.marker.line', + **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scatter.marker.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scatter.marker.line', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatter.marker.line', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='scatter.marker.line', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scatter.marker.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scatter.marker.line.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='scatter.marker.line', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='scatter.marker.line', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='scatter.marker.line', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='scatter.marker.line', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scatter.marker.line', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter/marker/line/_autocolorscale.py b/plotly/validators/scatter/marker/line/_autocolorscale.py deleted file mode 100644 index b19174c8ad8..00000000000 --- a/plotly/validators/scatter/marker/line/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scatter.marker.line', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/line/_cauto.py b/plotly/validators/scatter/marker/line/_cauto.py deleted file mode 100644 index 3347e987d7a..00000000000 --- a/plotly/validators/scatter/marker/line/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='scatter.marker.line', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/line/_cmax.py b/plotly/validators/scatter/marker/line/_cmax.py deleted file mode 100644 index 58660a38141..00000000000 --- a/plotly/validators/scatter/marker/line/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='scatter.marker.line', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/line/_cmid.py b/plotly/validators/scatter/marker/line/_cmid.py deleted file mode 100644 index 8aaadd3b8f4..00000000000 --- a/plotly/validators/scatter/marker/line/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='scatter.marker.line', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/line/_cmin.py b/plotly/validators/scatter/marker/line/_cmin.py deleted file mode 100644 index bbf6e167d37..00000000000 --- a/plotly/validators/scatter/marker/line/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='scatter.marker.line', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/line/_color.py b/plotly/validators/scatter/marker/line/_color.py deleted file mode 100644 index 8e75cecfefa..00000000000 --- a/plotly/validators/scatter/marker/line/_color.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scatter.marker.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scatter.marker.line.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/line/_colorscale.py b/plotly/validators/scatter/marker/line/_colorscale.py deleted file mode 100644 index 395c8dfbbea..00000000000 --- a/plotly/validators/scatter/marker/line/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='scatter.marker.line', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/line/_colorsrc.py b/plotly/validators/scatter/marker/line/_colorsrc.py deleted file mode 100644 index 5f06ca0e787..00000000000 --- a/plotly/validators/scatter/marker/line/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatter.marker.line', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/line/_reversescale.py b/plotly/validators/scatter/marker/line/_reversescale.py deleted file mode 100644 index 8b98f12eb1f..00000000000 --- a/plotly/validators/scatter/marker/line/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scatter.marker.line', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/line/_width.py b/plotly/validators/scatter/marker/line/_width.py deleted file mode 100644 index 553ac0d7b9a..00000000000 --- a/plotly/validators/scatter/marker/line/_width.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scatter.marker.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/marker/line/_widthsrc.py b/plotly/validators/scatter/marker/line/_widthsrc.py deleted file mode 100644 index f868a608443..00000000000 --- a/plotly/validators/scatter/marker/line/_widthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='widthsrc', - parent_name='scatter.marker.line', - **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/selected/__init__.py b/plotly/validators/scatter/selected/__init__.py index f1a1ef3742f..9aae1a468b3 100644 --- a/plotly/validators/scatter/selected/__init__.py +++ b/plotly/validators/scatter/selected/__init__.py @@ -1,2 +1,48 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='textfont', parent_name='scatter.selected', **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of selected points. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='scatter.selected', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scatter/selected/_marker.py b/plotly/validators/scatter/selected/_marker.py deleted file mode 100644 index 979f04c56ea..00000000000 --- a/plotly/validators/scatter/selected/_marker.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='scatter.selected', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/selected/_textfont.py b/plotly/validators/scatter/selected/_textfont.py deleted file mode 100644 index 6ea628d66f5..00000000000 --- a/plotly/validators/scatter/selected/_textfont.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='textfont', parent_name='scatter.selected', **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/selected/marker/__init__.py b/plotly/validators/scatter/selected/marker/__init__.py index ed9a9070947..bb82debe6c3 100644 --- a/plotly/validators/scatter/selected/marker/__init__.py +++ b/plotly/validators/scatter/selected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatter.selected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scatter.selected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatter.selected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter/selected/marker/_color.py b/plotly/validators/scatter/selected/marker/_color.py deleted file mode 100644 index 500587512f2..00000000000 --- a/plotly/validators/scatter/selected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatter.selected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/selected/marker/_opacity.py b/plotly/validators/scatter/selected/marker/_opacity.py deleted file mode 100644 index 2f9580cfc5d..00000000000 --- a/plotly/validators/scatter/selected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scatter.selected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/selected/marker/_size.py b/plotly/validators/scatter/selected/marker/_size.py deleted file mode 100644 index 4f223796c97..00000000000 --- a/plotly/validators/scatter/selected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatter.selected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/selected/textfont/__init__.py b/plotly/validators/scatter/selected/textfont/__init__.py index 74135b3f315..2bc508eef73 100644 --- a/plotly/validators/scatter/selected/textfont/__init__.py +++ b/plotly/validators/scatter/selected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatter.selected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter/selected/textfont/_color.py b/plotly/validators/scatter/selected/textfont/_color.py deleted file mode 100644 index 87515393cb0..00000000000 --- a/plotly/validators/scatter/selected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatter.selected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/stream/__init__.py b/plotly/validators/scatter/stream/__init__.py index 2f4f2047594..6688d9926e8 100644 --- a/plotly/validators/scatter/stream/__init__.py +++ b/plotly/validators/scatter/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='scatter.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='scatter.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scatter/stream/_maxpoints.py b/plotly/validators/scatter/stream/_maxpoints.py deleted file mode 100644 index 7b8b5954305..00000000000 --- a/plotly/validators/scatter/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='scatter.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/stream/_token.py b/plotly/validators/scatter/stream/_token.py deleted file mode 100644 index 833a6de8155..00000000000 --- a/plotly/validators/scatter/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='scatter.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatter/textfont/__init__.py b/plotly/validators/scatter/textfont/__init__.py index 1d2c591d1e5..0a7e8832520 100644 --- a/plotly/validators/scatter/textfont/__init__.py +++ b/plotly/validators/scatter/textfont/__init__.py @@ -1,6 +1,111 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='sizesrc', parent_name='scatter.textfont', **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='scatter.textfont', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='scatter.textfont', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='scatter.textfont', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='scatter.textfont', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scatter.textfont', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter/textfont/_color.py b/plotly/validators/scatter/textfont/_color.py deleted file mode 100644 index d8954c872c0..00000000000 --- a/plotly/validators/scatter/textfont/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scatter.textfont', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/textfont/_colorsrc.py b/plotly/validators/scatter/textfont/_colorsrc.py deleted file mode 100644 index 98dc70d3a57..00000000000 --- a/plotly/validators/scatter/textfont/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='scatter.textfont', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/textfont/_family.py b/plotly/validators/scatter/textfont/_family.py deleted file mode 100644 index 36821ed7d7e..00000000000 --- a/plotly/validators/scatter/textfont/_family.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='scatter.textfont', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatter/textfont/_familysrc.py b/plotly/validators/scatter/textfont/_familysrc.py deleted file mode 100644 index c3243c0dcd7..00000000000 --- a/plotly/validators/scatter/textfont/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='scatter.textfont', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/textfont/_size.py b/plotly/validators/scatter/textfont/_size.py deleted file mode 100644 index 15f2044db31..00000000000 --- a/plotly/validators/scatter/textfont/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='scatter.textfont', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/textfont/_sizesrc.py b/plotly/validators/scatter/textfont/_sizesrc.py deleted file mode 100644 index 8f6050ec3a8..00000000000 --- a/plotly/validators/scatter/textfont/_sizesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='sizesrc', parent_name='scatter.textfont', **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter/unselected/__init__.py b/plotly/validators/scatter/unselected/__init__.py index f1a1ef3742f..e0fac5c25c8 100644 --- a/plotly/validators/scatter/unselected/__init__.py +++ b/plotly/validators/scatter/unselected/__init__.py @@ -1,2 +1,55 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='scatter.unselected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='scatter.unselected', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of unselected points, + applied only when a selection exists. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scatter/unselected/_marker.py b/plotly/validators/scatter/unselected/_marker.py deleted file mode 100644 index 6d9f26e90d0..00000000000 --- a/plotly/validators/scatter/unselected/_marker.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='scatter.unselected', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of unselected points, - applied only when a selection exists. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/unselected/_textfont.py b/plotly/validators/scatter/unselected/_textfont.py deleted file mode 100644 index 000a2103b55..00000000000 --- a/plotly/validators/scatter/unselected/_textfont.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='scatter.unselected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter/unselected/marker/__init__.py b/plotly/validators/scatter/unselected/marker/__init__.py index ed9a9070947..8b04f377ec2 100644 --- a/plotly/validators/scatter/unselected/marker/__init__.py +++ b/plotly/validators/scatter/unselected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatter.unselected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scatter.unselected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatter.unselected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter/unselected/marker/_color.py b/plotly/validators/scatter/unselected/marker/_color.py deleted file mode 100644 index 8cf55739b27..00000000000 --- a/plotly/validators/scatter/unselected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatter.unselected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/unselected/marker/_opacity.py b/plotly/validators/scatter/unselected/marker/_opacity.py deleted file mode 100644 index 5a7b670fb37..00000000000 --- a/plotly/validators/scatter/unselected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scatter.unselected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/unselected/marker/_size.py b/plotly/validators/scatter/unselected/marker/_size.py deleted file mode 100644 index b55f7847c1e..00000000000 --- a/plotly/validators/scatter/unselected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatter.unselected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter/unselected/textfont/__init__.py b/plotly/validators/scatter/unselected/textfont/__init__.py index 74135b3f315..ad68fc3b0a1 100644 --- a/plotly/validators/scatter/unselected/textfont/__init__.py +++ b/plotly/validators/scatter/unselected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatter.unselected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter/unselected/textfont/_color.py b/plotly/validators/scatter/unselected/textfont/_color.py deleted file mode 100644 index b00e6d35370..00000000000 --- a/plotly/validators/scatter/unselected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatter.unselected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/__init__.py b/plotly/validators/scatter3d/__init__.py index 83b8e103c3b..ab9ae2605cd 100644 --- a/plotly/validators/scatter3d/__init__.py +++ b/plotly/validators/scatter3d/__init__.py @@ -1,45 +1,1244 @@ -from ._zsrc import ZsrcValidator -from ._zcalendar import ZcalendarValidator -from ._z import ZValidator -from ._ysrc import YsrcValidator -from ._ycalendar import YcalendarValidator -from ._y import YValidator -from ._xsrc import XsrcValidator -from ._xcalendar import XcalendarValidator -from ._x import XValidator -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textsrc import TextsrcValidator -from ._textpositionsrc import TextpositionsrcValidator -from ._textposition import TextpositionValidator -from ._textfont import TextfontValidator -from ._text import TextValidator -from ._surfacecolor import SurfacecolorValidator -from ._surfaceaxis import SurfaceaxisValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._scene import SceneValidator -from ._projection import ProjectionValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._mode import ModeValidator -from ._marker import MarkerValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._error_z import ErrorZValidator -from ._error_y import ErrorYValidator -from ._error_x import ErrorXValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._connectgaps import ConnectgapsValidator + + +import _plotly_utils.basevalidators + + +class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='zsrc', parent_name='scatter3d', **kwargs): + super(ZsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='zcalendar', parent_name='scatter3d', **kwargs + ): + super(ZcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='z', parent_name='scatter3d', **kwargs): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='scatter3d', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ycalendar', parent_name='scatter3d', **kwargs + ): + super(YcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='scatter3d', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='scatter3d', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xcalendar', parent_name='scatter3d', **kwargs + ): + super(XcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='scatter3d', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='scatter3d', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='scatter3d', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='scatter3d', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textsrc', parent_name='scatter3d', **kwargs + ): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textpositionsrc', parent_name='scatter3d', **kwargs + ): + super(TextpositionsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='textposition', parent_name='scatter3d', **kwargs + ): + super(TextpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 'top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', + 'bottom center', 'bottom right' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='textfont', parent_name='scatter3d', **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='scatter3d', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SurfacecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='surfacecolor', parent_name='scatter3d', **kwargs + ): + super(SurfacecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SurfaceaxisValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='surfaceaxis', parent_name='scatter3d', **kwargs + ): + super(SurfaceaxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [-1, 0, 1, 2]), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='scatter3d', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='scatter3d', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='scatter3d', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SceneValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='scene', parent_name='scatter3d', **kwargs): + super(SceneValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'scene'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ProjectionValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='projection', parent_name='scatter3d', **kwargs + ): + super(ProjectionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Projection'), + data_docs=kwargs.pop( + 'data_docs', """ + x + plotly.graph_objs.scatter3d.projection.X + instance or dict with compatible properties + y + plotly.graph_objs.scatter3d.projection.Y + instance or dict with compatible properties + z + plotly.graph_objs.scatter3d.projection.Z + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='scatter3d', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='scatter3d', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__(self, plotly_name='mode', parent_name='scatter3d', **kwargs): + super(ModeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['none']), + flags=kwargs.pop('flags', ['lines', 'markers', 'text']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='scatter3d', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scatter3d.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + line + plotly.graph_objs.scatter3d.marker.Line + instance or dict with compatible properties + opacity + Sets the marker opacity. Note that the marker + opacity for scatter3d traces must be a scalar + value for performance reasons. To set a + blending opacity value (i.e. which is not + transparent), set "marker.color" to an rgba + color and use its alpha channel. + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. + symbolsrc + Sets the source reference on plot.ly for + symbol . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='line', parent_name='scatter3d', **kwargs): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `line.colorscale`. Has an effect + only if in `line.color`is set to a numerical + array. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette + will be chosen according to whether numbers in + the `color` array are all positive, all + negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `line.color`) or the bounds set in + `line.cmin` and `line.cmax` Has an effect only + if in `line.color`is set to a numerical array. + Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `line.color`is set to a + numerical array. Value should have the same + units as in `line.color` and if set, + `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `line.cmin` and/or `line.cmax` to be + equidistant to this point. Has an effect only + if in `line.color`is set to a numerical array. + Value should have the same units as in + `line.color`. Has no effect when `line.cauto` + is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `line.color`is set to a + numerical array. Value should have the same + units as in `line.color` and if set, + `line.cmax` must be set as well. + color + Sets thelinecolor. It accepts either a specific + color or an array of numbers that are mapped to + the colorscale relative to the max and min + values of the array or relative to `line.cmin` + and `line.cmax` if set. + colorscale + Sets the colorscale. Has an effect only if in + `line.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`line.cmin` and `line.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + dash + Sets the dash style of the lines. + reversescale + Reverses the color mapping if true. Has an + effect only if in `line.color`is set to a + numerical array. If true, `line.cmin` will + correspond to the last color in the array and + `line.cmax` will correspond to the first color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `line.color`is set to a numerical array. + width + Sets the line width (in px). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='scatter3d', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='scatter3d', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='scatter3d', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='scatter3d', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='scatter3d', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertemplatesrc', + parent_name='scatter3d', + **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='scatter3d', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='scatter3d', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='scatter3d', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='scatter3d', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ErrorZValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='error_z', parent_name='scatter3d', **kwargs + ): + super(ErrorZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ErrorZ'), + data_docs=kwargs.pop( + 'data_docs', """ + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ErrorYValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='error_y', parent_name='scatter3d', **kwargs + ): + super(ErrorYValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ErrorY'), + data_docs=kwargs.pop( + 'data_docs', """ + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + copy_zstyle + + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ErrorXValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='error_x', parent_name='scatter3d', **kwargs + ): + super(ErrorXValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ErrorX'), + data_docs=kwargs.pop( + 'data_docs', """ + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + copy_zstyle + + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='scatter3d', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='scatter3d', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='connectgaps', parent_name='scatter3d', **kwargs + ): + super(ConnectgapsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/_connectgaps.py b/plotly/validators/scatter3d/_connectgaps.py deleted file mode 100644 index 993efa94e3d..00000000000 --- a/plotly/validators/scatter3d/_connectgaps.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='connectgaps', parent_name='scatter3d', **kwargs - ): - super(ConnectgapsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_customdata.py b/plotly/validators/scatter3d/_customdata.py deleted file mode 100644 index 34378e8c6f2..00000000000 --- a/plotly/validators/scatter3d/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='scatter3d', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_customdatasrc.py b/plotly/validators/scatter3d/_customdatasrc.py deleted file mode 100644 index 0c5ef6707d1..00000000000 --- a/plotly/validators/scatter3d/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='scatter3d', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_error_x.py b/plotly/validators/scatter3d/_error_x.py deleted file mode 100644 index b5851233da4..00000000000 --- a/plotly/validators/scatter3d/_error_x.py +++ /dev/null @@ -1,75 +0,0 @@ -import _plotly_utils.basevalidators - - -class ErrorXValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='error_x', parent_name='scatter3d', **kwargs - ): - super(ErrorXValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ErrorX'), - data_docs=kwargs.pop( - 'data_docs', """ - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - copy_zstyle - - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_error_y.py b/plotly/validators/scatter3d/_error_y.py deleted file mode 100644 index 0acfd6a7bbf..00000000000 --- a/plotly/validators/scatter3d/_error_y.py +++ /dev/null @@ -1,75 +0,0 @@ -import _plotly_utils.basevalidators - - -class ErrorYValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='error_y', parent_name='scatter3d', **kwargs - ): - super(ErrorYValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ErrorY'), - data_docs=kwargs.pop( - 'data_docs', """ - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - copy_zstyle - - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_error_z.py b/plotly/validators/scatter3d/_error_z.py deleted file mode 100644 index 5be5bba9ee5..00000000000 --- a/plotly/validators/scatter3d/_error_z.py +++ /dev/null @@ -1,73 +0,0 @@ -import _plotly_utils.basevalidators - - -class ErrorZValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='error_z', parent_name='scatter3d', **kwargs - ): - super(ErrorZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ErrorZ'), - data_docs=kwargs.pop( - 'data_docs', """ - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_hoverinfo.py b/plotly/validators/scatter3d/_hoverinfo.py deleted file mode 100644 index b76a43319f3..00000000000 --- a/plotly/validators/scatter3d/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='scatter3d', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_hoverinfosrc.py b/plotly/validators/scatter3d/_hoverinfosrc.py deleted file mode 100644 index 546bc93b128..00000000000 --- a/plotly/validators/scatter3d/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='scatter3d', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_hoverlabel.py b/plotly/validators/scatter3d/_hoverlabel.py deleted file mode 100644 index b6b97c38a48..00000000000 --- a/plotly/validators/scatter3d/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='scatter3d', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_hovertemplate.py b/plotly/validators/scatter3d/_hovertemplate.py deleted file mode 100644 index d91459ab0a3..00000000000 --- a/plotly/validators/scatter3d/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='scatter3d', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_hovertemplatesrc.py b/plotly/validators/scatter3d/_hovertemplatesrc.py deleted file mode 100644 index 638ccd2dbe3..00000000000 --- a/plotly/validators/scatter3d/_hovertemplatesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertemplatesrc', - parent_name='scatter3d', - **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_hovertext.py b/plotly/validators/scatter3d/_hovertext.py deleted file mode 100644 index 853308605b4..00000000000 --- a/plotly/validators/scatter3d/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='scatter3d', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_hovertextsrc.py b/plotly/validators/scatter3d/_hovertextsrc.py deleted file mode 100644 index 5a272696c26..00000000000 --- a/plotly/validators/scatter3d/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='scatter3d', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_ids.py b/plotly/validators/scatter3d/_ids.py deleted file mode 100644 index 5c7abe9c27a..00000000000 --- a/plotly/validators/scatter3d/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='scatter3d', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_idssrc.py b/plotly/validators/scatter3d/_idssrc.py deleted file mode 100644 index f8767f84202..00000000000 --- a/plotly/validators/scatter3d/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='scatter3d', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_legendgroup.py b/plotly/validators/scatter3d/_legendgroup.py deleted file mode 100644 index 18c998f83d3..00000000000 --- a/plotly/validators/scatter3d/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='scatter3d', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_line.py b/plotly/validators/scatter3d/_line.py deleted file mode 100644 index d44a2df0210..00000000000 --- a/plotly/validators/scatter3d/_line.py +++ /dev/null @@ -1,93 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='line', parent_name='scatter3d', **kwargs): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `line.colorscale`. Has an effect - only if in `line.color`is set to a numerical - array. In case `colorscale` is unspecified or - `autocolorscale` is true, the default palette - will be chosen according to whether numbers in - the `color` array are all positive, all - negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `line.color`) or the bounds set in - `line.cmin` and `line.cmax` Has an effect only - if in `line.color`is set to a numerical array. - Defaults to `false` when `line.cmin` and - `line.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `line.color`is set to a - numerical array. Value should have the same - units as in `line.color` and if set, - `line.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `line.cmin` and/or `line.cmax` to be - equidistant to this point. Has an effect only - if in `line.color`is set to a numerical array. - Value should have the same units as in - `line.color`. Has no effect when `line.cauto` - is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `line.color`is set to a - numerical array. Value should have the same - units as in `line.color` and if set, - `line.cmax` must be set as well. - color - Sets thelinecolor. It accepts either a specific - color or an array of numbers that are mapped to - the colorscale relative to the max and min - values of the array or relative to `line.cmin` - and `line.cmax` if set. - colorscale - Sets the colorscale. Has an effect only if in - `line.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`line.cmin` and `line.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - dash - Sets the dash style of the lines. - reversescale - Reverses the color mapping if true. Has an - effect only if in `line.color`is set to a - numerical array. If true, `line.cmin` will - correspond to the last color in the array and - `line.cmax` will correspond to the first color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `line.color`is set to a numerical array. - width - Sets the line width (in px). -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_marker.py b/plotly/validators/scatter3d/_marker.py deleted file mode 100644 index 7543429a126..00000000000 --- a/plotly/validators/scatter3d/_marker.py +++ /dev/null @@ -1,128 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='scatter3d', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scatter3d.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - line - plotly.graph_objs.scatter3d.marker.Line - instance or dict with compatible properties - opacity - Sets the marker opacity. Note that the marker - opacity for scatter3d traces must be a scalar - value for performance reasons. To set a - blending opacity value (i.e. which is not - transparent), set "marker.color" to an rgba - color and use its alpha channel. - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. - symbolsrc - Sets the source reference on plot.ly for - symbol . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_mode.py b/plotly/validators/scatter3d/_mode.py deleted file mode 100644 index e7f933d7f02..00000000000 --- a/plotly/validators/scatter3d/_mode.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__(self, plotly_name='mode', parent_name='scatter3d', **kwargs): - super(ModeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['none']), - flags=kwargs.pop('flags', ['lines', 'markers', 'text']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_name.py b/plotly/validators/scatter3d/_name.py deleted file mode 100644 index b65e6123ac5..00000000000 --- a/plotly/validators/scatter3d/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='scatter3d', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_opacity.py b/plotly/validators/scatter3d/_opacity.py deleted file mode 100644 index b384d55b3b5..00000000000 --- a/plotly/validators/scatter3d/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='scatter3d', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_projection.py b/plotly/validators/scatter3d/_projection.py deleted file mode 100644 index a79945e73da..00000000000 --- a/plotly/validators/scatter3d/_projection.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class ProjectionValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='projection', parent_name='scatter3d', **kwargs - ): - super(ProjectionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Projection'), - data_docs=kwargs.pop( - 'data_docs', """ - x - plotly.graph_objs.scatter3d.projection.X - instance or dict with compatible properties - y - plotly.graph_objs.scatter3d.projection.Y - instance or dict with compatible properties - z - plotly.graph_objs.scatter3d.projection.Z - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_scene.py b/plotly/validators/scatter3d/_scene.py deleted file mode 100644 index 36a44192049..00000000000 --- a/plotly/validators/scatter3d/_scene.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class SceneValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='scene', parent_name='scatter3d', **kwargs): - super(SceneValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'scene'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_selectedpoints.py b/plotly/validators/scatter3d/_selectedpoints.py deleted file mode 100644 index 851f9443c24..00000000000 --- a/plotly/validators/scatter3d/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='scatter3d', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_showlegend.py b/plotly/validators/scatter3d/_showlegend.py deleted file mode 100644 index 81c5e2858a1..00000000000 --- a/plotly/validators/scatter3d/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='scatter3d', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_stream.py b/plotly/validators/scatter3d/_stream.py deleted file mode 100644 index c6a129f6048..00000000000 --- a/plotly/validators/scatter3d/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='scatter3d', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_surfaceaxis.py b/plotly/validators/scatter3d/_surfaceaxis.py deleted file mode 100644 index 897a53da053..00000000000 --- a/plotly/validators/scatter3d/_surfaceaxis.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SurfaceaxisValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='surfaceaxis', parent_name='scatter3d', **kwargs - ): - super(SurfaceaxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [-1, 0, 1, 2]), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_surfacecolor.py b/plotly/validators/scatter3d/_surfacecolor.py deleted file mode 100644 index bb9e543d154..00000000000 --- a/plotly/validators/scatter3d/_surfacecolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SurfacecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='surfacecolor', parent_name='scatter3d', **kwargs - ): - super(SurfacecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_text.py b/plotly/validators/scatter3d/_text.py deleted file mode 100644 index 4cee5300332..00000000000 --- a/plotly/validators/scatter3d/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='scatter3d', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_textfont.py b/plotly/validators/scatter3d/_textfont.py deleted file mode 100644 index d6541b838c5..00000000000 --- a/plotly/validators/scatter3d/_textfont.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='textfont', parent_name='scatter3d', **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_textposition.py b/plotly/validators/scatter3d/_textposition.py deleted file mode 100644 index a2c27b76d81..00000000000 --- a/plotly/validators/scatter3d/_textposition.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='textposition', parent_name='scatter3d', **kwargs - ): - super(TextpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 'top left', 'top center', 'top right', 'middle left', - 'middle center', 'middle right', 'bottom left', - 'bottom center', 'bottom right' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_textpositionsrc.py b/plotly/validators/scatter3d/_textpositionsrc.py deleted file mode 100644 index 28b502ed573..00000000000 --- a/plotly/validators/scatter3d/_textpositionsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textpositionsrc', parent_name='scatter3d', **kwargs - ): - super(TextpositionsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_textsrc.py b/plotly/validators/scatter3d/_textsrc.py deleted file mode 100644 index 36e512854c9..00000000000 --- a/plotly/validators/scatter3d/_textsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textsrc', parent_name='scatter3d', **kwargs - ): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_uid.py b/plotly/validators/scatter3d/_uid.py deleted file mode 100644 index 9b992c14c4b..00000000000 --- a/plotly/validators/scatter3d/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='scatter3d', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_uirevision.py b/plotly/validators/scatter3d/_uirevision.py deleted file mode 100644 index aaec1fda95f..00000000000 --- a/plotly/validators/scatter3d/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='scatter3d', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_visible.py b/plotly/validators/scatter3d/_visible.py deleted file mode 100644 index 908394ef2b3..00000000000 --- a/plotly/validators/scatter3d/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='scatter3d', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_x.py b/plotly/validators/scatter3d/_x.py deleted file mode 100644 index 272b03e0e51..00000000000 --- a/plotly/validators/scatter3d/_x.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='scatter3d', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_xcalendar.py b/plotly/validators/scatter3d/_xcalendar.py deleted file mode 100644 index 636add91b04..00000000000 --- a/plotly/validators/scatter3d/_xcalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xcalendar', parent_name='scatter3d', **kwargs - ): - super(XcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_xsrc.py b/plotly/validators/scatter3d/_xsrc.py deleted file mode 100644 index 28065c5f70c..00000000000 --- a/plotly/validators/scatter3d/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='scatter3d', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_y.py b/plotly/validators/scatter3d/_y.py deleted file mode 100644 index 5fab3d50baa..00000000000 --- a/plotly/validators/scatter3d/_y.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='scatter3d', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_ycalendar.py b/plotly/validators/scatter3d/_ycalendar.py deleted file mode 100644 index 827bd2e4198..00000000000 --- a/plotly/validators/scatter3d/_ycalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ycalendar', parent_name='scatter3d', **kwargs - ): - super(YcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_ysrc.py b/plotly/validators/scatter3d/_ysrc.py deleted file mode 100644 index 0566b964a11..00000000000 --- a/plotly/validators/scatter3d/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='scatter3d', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_z.py b/plotly/validators/scatter3d/_z.py deleted file mode 100644 index 5b748b89209..00000000000 --- a/plotly/validators/scatter3d/_z.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='z', parent_name='scatter3d', **kwargs): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_zcalendar.py b/plotly/validators/scatter3d/_zcalendar.py deleted file mode 100644 index b1484aa9816..00000000000 --- a/plotly/validators/scatter3d/_zcalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='zcalendar', parent_name='scatter3d', **kwargs - ): - super(ZcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/_zsrc.py b/plotly/validators/scatter3d/_zsrc.py deleted file mode 100644 index 43e886e1ee0..00000000000 --- a/plotly/validators/scatter3d/_zsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='zsrc', parent_name='scatter3d', **kwargs): - super(ZsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_x/__init__.py b/plotly/validators/scatter3d/error_x/__init__.py index a9450d059bf..25d508c75fd 100644 --- a/plotly/validators/scatter3d/error_x/__init__.py +++ b/plotly/validators/scatter3d/error_x/__init__.py @@ -1,15 +1,291 @@ -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._valueminus import ValueminusValidator -from ._value import ValueValidator -from ._type import TypeValidator -from ._tracerefminus import TracerefminusValidator -from ._traceref import TracerefValidator -from ._thickness import ThicknessValidator -from ._symmetric import SymmetricValidator -from ._copy_zstyle import CopyZstyleValidator -from ._color import ColorValidator -from ._arraysrc import ArraysrcValidator -from ._arrayminussrc import ArrayminussrcValidator -from ._arrayminus import ArrayminusValidator -from ._array import ArrayValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scatter3d.error_x', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='scatter3d.error_x', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='valueminus', + parent_name='scatter3d.error_x', + **kwargs + ): + super(ValueminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='value', parent_name='scatter3d.error_x', **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='scatter3d.error_x', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['percent', 'constant', 'sqrt', 'data'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='tracerefminus', + parent_name='scatter3d.error_x', + **kwargs + ): + super(TracerefminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='traceref', + parent_name='scatter3d.error_x', + **kwargs + ): + super(TracerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='scatter3d.error_x', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='symmetric', + parent_name='scatter3d.error_x', + **kwargs + ): + super(SymmetricValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CopyZstyleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='copy_zstyle', + parent_name='scatter3d.error_x', + **kwargs + ): + super(CopyZstyleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scatter3d.error_x', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='arraysrc', + parent_name='scatter3d.error_x', + **kwargs + ): + super(ArraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='arrayminussrc', + parent_name='scatter3d.error_x', + **kwargs + ): + super(ArrayminussrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='arrayminus', + parent_name='scatter3d.error_x', + **kwargs + ): + super(ArrayminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='array', parent_name='scatter3d.error_x', **kwargs + ): + super(ArrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/error_x/_array.py b/plotly/validators/scatter3d/error_x/_array.py deleted file mode 100644 index 7c4411d65ce..00000000000 --- a/plotly/validators/scatter3d/error_x/_array.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='array', parent_name='scatter3d.error_x', **kwargs - ): - super(ArrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_x/_arrayminus.py b/plotly/validators/scatter3d/error_x/_arrayminus.py deleted file mode 100644 index ce6457cdbc9..00000000000 --- a/plotly/validators/scatter3d/error_x/_arrayminus.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='arrayminus', - parent_name='scatter3d.error_x', - **kwargs - ): - super(ArrayminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_x/_arrayminussrc.py b/plotly/validators/scatter3d/error_x/_arrayminussrc.py deleted file mode 100644 index dea2881e6b5..00000000000 --- a/plotly/validators/scatter3d/error_x/_arrayminussrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='arrayminussrc', - parent_name='scatter3d.error_x', - **kwargs - ): - super(ArrayminussrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_x/_arraysrc.py b/plotly/validators/scatter3d/error_x/_arraysrc.py deleted file mode 100644 index 0cf6238e3fd..00000000000 --- a/plotly/validators/scatter3d/error_x/_arraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='arraysrc', - parent_name='scatter3d.error_x', - **kwargs - ): - super(ArraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_x/_color.py b/plotly/validators/scatter3d/error_x/_color.py deleted file mode 100644 index 1b92dfed6ab..00000000000 --- a/plotly/validators/scatter3d/error_x/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scatter3d.error_x', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_x/_copy_zstyle.py b/plotly/validators/scatter3d/error_x/_copy_zstyle.py deleted file mode 100644 index ce2c2dfdf93..00000000000 --- a/plotly/validators/scatter3d/error_x/_copy_zstyle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CopyZstyleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='copy_zstyle', - parent_name='scatter3d.error_x', - **kwargs - ): - super(CopyZstyleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_x/_symmetric.py b/plotly/validators/scatter3d/error_x/_symmetric.py deleted file mode 100644 index 6c78cc209e2..00000000000 --- a/plotly/validators/scatter3d/error_x/_symmetric.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='symmetric', - parent_name='scatter3d.error_x', - **kwargs - ): - super(SymmetricValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_x/_thickness.py b/plotly/validators/scatter3d/error_x/_thickness.py deleted file mode 100644 index 0e2a46af255..00000000000 --- a/plotly/validators/scatter3d/error_x/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='scatter3d.error_x', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_x/_traceref.py b/plotly/validators/scatter3d/error_x/_traceref.py deleted file mode 100644 index 3b98f5623b3..00000000000 --- a/plotly/validators/scatter3d/error_x/_traceref.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='traceref', - parent_name='scatter3d.error_x', - **kwargs - ): - super(TracerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_x/_tracerefminus.py b/plotly/validators/scatter3d/error_x/_tracerefminus.py deleted file mode 100644 index 91b695ccc8c..00000000000 --- a/plotly/validators/scatter3d/error_x/_tracerefminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='tracerefminus', - parent_name='scatter3d.error_x', - **kwargs - ): - super(TracerefminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_x/_type.py b/plotly/validators/scatter3d/error_x/_type.py deleted file mode 100644 index a6edd0ef9cc..00000000000 --- a/plotly/validators/scatter3d/error_x/_type.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='scatter3d.error_x', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['percent', 'constant', 'sqrt', 'data'] - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_x/_value.py b/plotly/validators/scatter3d/error_x/_value.py deleted file mode 100644 index 2c908715086..00000000000 --- a/plotly/validators/scatter3d/error_x/_value.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='value', parent_name='scatter3d.error_x', **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_x/_valueminus.py b/plotly/validators/scatter3d/error_x/_valueminus.py deleted file mode 100644 index 08d37385396..00000000000 --- a/plotly/validators/scatter3d/error_x/_valueminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='valueminus', - parent_name='scatter3d.error_x', - **kwargs - ): - super(ValueminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_x/_visible.py b/plotly/validators/scatter3d/error_x/_visible.py deleted file mode 100644 index 0811bf79d45..00000000000 --- a/plotly/validators/scatter3d/error_x/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='scatter3d.error_x', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_x/_width.py b/plotly/validators/scatter3d/error_x/_width.py deleted file mode 100644 index 6b2c322065c..00000000000 --- a/plotly/validators/scatter3d/error_x/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scatter3d.error_x', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_y/__init__.py b/plotly/validators/scatter3d/error_y/__init__.py index a9450d059bf..aa3e90f9575 100644 --- a/plotly/validators/scatter3d/error_y/__init__.py +++ b/plotly/validators/scatter3d/error_y/__init__.py @@ -1,15 +1,291 @@ -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._valueminus import ValueminusValidator -from ._value import ValueValidator -from ._type import TypeValidator -from ._tracerefminus import TracerefminusValidator -from ._traceref import TracerefValidator -from ._thickness import ThicknessValidator -from ._symmetric import SymmetricValidator -from ._copy_zstyle import CopyZstyleValidator -from ._color import ColorValidator -from ._arraysrc import ArraysrcValidator -from ._arrayminussrc import ArrayminussrcValidator -from ._arrayminus import ArrayminusValidator -from ._array import ArrayValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scatter3d.error_y', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='scatter3d.error_y', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='valueminus', + parent_name='scatter3d.error_y', + **kwargs + ): + super(ValueminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='value', parent_name='scatter3d.error_y', **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='scatter3d.error_y', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['percent', 'constant', 'sqrt', 'data'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='tracerefminus', + parent_name='scatter3d.error_y', + **kwargs + ): + super(TracerefminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='traceref', + parent_name='scatter3d.error_y', + **kwargs + ): + super(TracerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='scatter3d.error_y', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='symmetric', + parent_name='scatter3d.error_y', + **kwargs + ): + super(SymmetricValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CopyZstyleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='copy_zstyle', + parent_name='scatter3d.error_y', + **kwargs + ): + super(CopyZstyleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scatter3d.error_y', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='arraysrc', + parent_name='scatter3d.error_y', + **kwargs + ): + super(ArraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='arrayminussrc', + parent_name='scatter3d.error_y', + **kwargs + ): + super(ArrayminussrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='arrayminus', + parent_name='scatter3d.error_y', + **kwargs + ): + super(ArrayminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='array', parent_name='scatter3d.error_y', **kwargs + ): + super(ArrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/error_y/_array.py b/plotly/validators/scatter3d/error_y/_array.py deleted file mode 100644 index 27112117142..00000000000 --- a/plotly/validators/scatter3d/error_y/_array.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='array', parent_name='scatter3d.error_y', **kwargs - ): - super(ArrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_y/_arrayminus.py b/plotly/validators/scatter3d/error_y/_arrayminus.py deleted file mode 100644 index efde53b245c..00000000000 --- a/plotly/validators/scatter3d/error_y/_arrayminus.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='arrayminus', - parent_name='scatter3d.error_y', - **kwargs - ): - super(ArrayminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_y/_arrayminussrc.py b/plotly/validators/scatter3d/error_y/_arrayminussrc.py deleted file mode 100644 index 81f6ef57e0f..00000000000 --- a/plotly/validators/scatter3d/error_y/_arrayminussrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='arrayminussrc', - parent_name='scatter3d.error_y', - **kwargs - ): - super(ArrayminussrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_y/_arraysrc.py b/plotly/validators/scatter3d/error_y/_arraysrc.py deleted file mode 100644 index f285e57d478..00000000000 --- a/plotly/validators/scatter3d/error_y/_arraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='arraysrc', - parent_name='scatter3d.error_y', - **kwargs - ): - super(ArraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_y/_color.py b/plotly/validators/scatter3d/error_y/_color.py deleted file mode 100644 index fd4e3cc597c..00000000000 --- a/plotly/validators/scatter3d/error_y/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scatter3d.error_y', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_y/_copy_zstyle.py b/plotly/validators/scatter3d/error_y/_copy_zstyle.py deleted file mode 100644 index 3ed48c1db16..00000000000 --- a/plotly/validators/scatter3d/error_y/_copy_zstyle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CopyZstyleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='copy_zstyle', - parent_name='scatter3d.error_y', - **kwargs - ): - super(CopyZstyleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_y/_symmetric.py b/plotly/validators/scatter3d/error_y/_symmetric.py deleted file mode 100644 index 96d1c95552c..00000000000 --- a/plotly/validators/scatter3d/error_y/_symmetric.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='symmetric', - parent_name='scatter3d.error_y', - **kwargs - ): - super(SymmetricValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_y/_thickness.py b/plotly/validators/scatter3d/error_y/_thickness.py deleted file mode 100644 index 1aaa2ffd5b3..00000000000 --- a/plotly/validators/scatter3d/error_y/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='scatter3d.error_y', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_y/_traceref.py b/plotly/validators/scatter3d/error_y/_traceref.py deleted file mode 100644 index 9c7cb87b578..00000000000 --- a/plotly/validators/scatter3d/error_y/_traceref.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='traceref', - parent_name='scatter3d.error_y', - **kwargs - ): - super(TracerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_y/_tracerefminus.py b/plotly/validators/scatter3d/error_y/_tracerefminus.py deleted file mode 100644 index 84c3a9cc09b..00000000000 --- a/plotly/validators/scatter3d/error_y/_tracerefminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='tracerefminus', - parent_name='scatter3d.error_y', - **kwargs - ): - super(TracerefminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_y/_type.py b/plotly/validators/scatter3d/error_y/_type.py deleted file mode 100644 index 81f467f93a3..00000000000 --- a/plotly/validators/scatter3d/error_y/_type.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='scatter3d.error_y', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['percent', 'constant', 'sqrt', 'data'] - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_y/_value.py b/plotly/validators/scatter3d/error_y/_value.py deleted file mode 100644 index 52dfba72638..00000000000 --- a/plotly/validators/scatter3d/error_y/_value.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='value', parent_name='scatter3d.error_y', **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_y/_valueminus.py b/plotly/validators/scatter3d/error_y/_valueminus.py deleted file mode 100644 index e620787e213..00000000000 --- a/plotly/validators/scatter3d/error_y/_valueminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='valueminus', - parent_name='scatter3d.error_y', - **kwargs - ): - super(ValueminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_y/_visible.py b/plotly/validators/scatter3d/error_y/_visible.py deleted file mode 100644 index ea1f7548cb7..00000000000 --- a/plotly/validators/scatter3d/error_y/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='scatter3d.error_y', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_y/_width.py b/plotly/validators/scatter3d/error_y/_width.py deleted file mode 100644 index 618bf789cee..00000000000 --- a/plotly/validators/scatter3d/error_y/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scatter3d.error_y', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_z/__init__.py b/plotly/validators/scatter3d/error_z/__init__.py index 2fc70c4058d..7de0793480c 100644 --- a/plotly/validators/scatter3d/error_z/__init__.py +++ b/plotly/validators/scatter3d/error_z/__init__.py @@ -1,14 +1,271 @@ -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._valueminus import ValueminusValidator -from ._value import ValueValidator -from ._type import TypeValidator -from ._tracerefminus import TracerefminusValidator -from ._traceref import TracerefValidator -from ._thickness import ThicknessValidator -from ._symmetric import SymmetricValidator -from ._color import ColorValidator -from ._arraysrc import ArraysrcValidator -from ._arrayminussrc import ArrayminussrcValidator -from ._arrayminus import ArrayminusValidator -from ._array import ArrayValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scatter3d.error_z', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='scatter3d.error_z', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='valueminus', + parent_name='scatter3d.error_z', + **kwargs + ): + super(ValueminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='value', parent_name='scatter3d.error_z', **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='scatter3d.error_z', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['percent', 'constant', 'sqrt', 'data'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='tracerefminus', + parent_name='scatter3d.error_z', + **kwargs + ): + super(TracerefminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='traceref', + parent_name='scatter3d.error_z', + **kwargs + ): + super(TracerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='scatter3d.error_z', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='symmetric', + parent_name='scatter3d.error_z', + **kwargs + ): + super(SymmetricValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scatter3d.error_z', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='arraysrc', + parent_name='scatter3d.error_z', + **kwargs + ): + super(ArraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='arrayminussrc', + parent_name='scatter3d.error_z', + **kwargs + ): + super(ArrayminussrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='arrayminus', + parent_name='scatter3d.error_z', + **kwargs + ): + super(ArrayminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='array', parent_name='scatter3d.error_z', **kwargs + ): + super(ArrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/error_z/_array.py b/plotly/validators/scatter3d/error_z/_array.py deleted file mode 100644 index 68e141ddac0..00000000000 --- a/plotly/validators/scatter3d/error_z/_array.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='array', parent_name='scatter3d.error_z', **kwargs - ): - super(ArrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_z/_arrayminus.py b/plotly/validators/scatter3d/error_z/_arrayminus.py deleted file mode 100644 index fb0d637e8af..00000000000 --- a/plotly/validators/scatter3d/error_z/_arrayminus.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='arrayminus', - parent_name='scatter3d.error_z', - **kwargs - ): - super(ArrayminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_z/_arrayminussrc.py b/plotly/validators/scatter3d/error_z/_arrayminussrc.py deleted file mode 100644 index 720b81c80b7..00000000000 --- a/plotly/validators/scatter3d/error_z/_arrayminussrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='arrayminussrc', - parent_name='scatter3d.error_z', - **kwargs - ): - super(ArrayminussrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_z/_arraysrc.py b/plotly/validators/scatter3d/error_z/_arraysrc.py deleted file mode 100644 index 71e0a1d6946..00000000000 --- a/plotly/validators/scatter3d/error_z/_arraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='arraysrc', - parent_name='scatter3d.error_z', - **kwargs - ): - super(ArraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_z/_color.py b/plotly/validators/scatter3d/error_z/_color.py deleted file mode 100644 index ad690724d18..00000000000 --- a/plotly/validators/scatter3d/error_z/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scatter3d.error_z', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_z/_symmetric.py b/plotly/validators/scatter3d/error_z/_symmetric.py deleted file mode 100644 index 6d077be870b..00000000000 --- a/plotly/validators/scatter3d/error_z/_symmetric.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='symmetric', - parent_name='scatter3d.error_z', - **kwargs - ): - super(SymmetricValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_z/_thickness.py b/plotly/validators/scatter3d/error_z/_thickness.py deleted file mode 100644 index a298525c429..00000000000 --- a/plotly/validators/scatter3d/error_z/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='scatter3d.error_z', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_z/_traceref.py b/plotly/validators/scatter3d/error_z/_traceref.py deleted file mode 100644 index f471587791b..00000000000 --- a/plotly/validators/scatter3d/error_z/_traceref.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='traceref', - parent_name='scatter3d.error_z', - **kwargs - ): - super(TracerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_z/_tracerefminus.py b/plotly/validators/scatter3d/error_z/_tracerefminus.py deleted file mode 100644 index df75ba6963e..00000000000 --- a/plotly/validators/scatter3d/error_z/_tracerefminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='tracerefminus', - parent_name='scatter3d.error_z', - **kwargs - ): - super(TracerefminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_z/_type.py b/plotly/validators/scatter3d/error_z/_type.py deleted file mode 100644 index e780bec39cc..00000000000 --- a/plotly/validators/scatter3d/error_z/_type.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='scatter3d.error_z', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['percent', 'constant', 'sqrt', 'data'] - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_z/_value.py b/plotly/validators/scatter3d/error_z/_value.py deleted file mode 100644 index bec77a82af9..00000000000 --- a/plotly/validators/scatter3d/error_z/_value.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='value', parent_name='scatter3d.error_z', **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_z/_valueminus.py b/plotly/validators/scatter3d/error_z/_valueminus.py deleted file mode 100644 index e49cde0bd60..00000000000 --- a/plotly/validators/scatter3d/error_z/_valueminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='valueminus', - parent_name='scatter3d.error_z', - **kwargs - ): - super(ValueminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_z/_visible.py b/plotly/validators/scatter3d/error_z/_visible.py deleted file mode 100644 index c551541385c..00000000000 --- a/plotly/validators/scatter3d/error_z/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='scatter3d.error_z', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/error_z/_width.py b/plotly/validators/scatter3d/error_z/_width.py deleted file mode 100644 index 9d8035a8bd4..00000000000 --- a/plotly/validators/scatter3d/error_z/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scatter3d.error_z', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/hoverlabel/__init__.py b/plotly/validators/scatter3d/hoverlabel/__init__.py index 856f769ba33..1504f0cf4ba 100644 --- a/plotly/validators/scatter3d/hoverlabel/__init__.py +++ b/plotly/validators/scatter3d/hoverlabel/__init__.py @@ -1,7 +1,173 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='scatter3d.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='scatter3d.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='scatter3d.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='scatter3d.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scatter3d.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='scatter3d.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scatter3d.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/hoverlabel/_bgcolor.py b/plotly/validators/scatter3d/hoverlabel/_bgcolor.py deleted file mode 100644 index f03d838ddbc..00000000000 --- a/plotly/validators/scatter3d/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scatter3d.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/hoverlabel/_bgcolorsrc.py b/plotly/validators/scatter3d/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 0cf0246bbcc..00000000000 --- a/plotly/validators/scatter3d/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='scatter3d.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/hoverlabel/_bordercolor.py b/plotly/validators/scatter3d/hoverlabel/_bordercolor.py deleted file mode 100644 index 3af5f86c3cf..00000000000 --- a/plotly/validators/scatter3d/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scatter3d.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/hoverlabel/_bordercolorsrc.py b/plotly/validators/scatter3d/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index eec714cf38a..00000000000 --- a/plotly/validators/scatter3d/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='scatter3d.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/hoverlabel/_font.py b/plotly/validators/scatter3d/hoverlabel/_font.py deleted file mode 100644 index 9cdcf15e6c9..00000000000 --- a/plotly/validators/scatter3d/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='scatter3d.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/hoverlabel/_namelength.py b/plotly/validators/scatter3d/hoverlabel/_namelength.py deleted file mode 100644 index b079bf5c752..00000000000 --- a/plotly/validators/scatter3d/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='scatter3d.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/hoverlabel/_namelengthsrc.py b/plotly/validators/scatter3d/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 8c4b2f80607..00000000000 --- a/plotly/validators/scatter3d/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='scatter3d.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/hoverlabel/font/__init__.py b/plotly/validators/scatter3d/hoverlabel/font/__init__.py index 1d2c591d1e5..e17fc32ca0f 100644 --- a/plotly/validators/scatter3d/hoverlabel/font/__init__.py +++ b/plotly/validators/scatter3d/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scatter3d.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatter3d.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='scatter3d.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatter3d.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatter3d.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatter3d.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/hoverlabel/font/_color.py b/plotly/validators/scatter3d/hoverlabel/font/_color.py deleted file mode 100644 index fdbc6593508..00000000000 --- a/plotly/validators/scatter3d/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatter3d.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/hoverlabel/font/_colorsrc.py b/plotly/validators/scatter3d/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 5bbb5f6ecb0..00000000000 --- a/plotly/validators/scatter3d/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatter3d.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/hoverlabel/font/_family.py b/plotly/validators/scatter3d/hoverlabel/font/_family.py deleted file mode 100644 index 8e583b411aa..00000000000 --- a/plotly/validators/scatter3d/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatter3d.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatter3d/hoverlabel/font/_familysrc.py b/plotly/validators/scatter3d/hoverlabel/font/_familysrc.py deleted file mode 100644 index 9ebbabbf03c..00000000000 --- a/plotly/validators/scatter3d/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='scatter3d.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/hoverlabel/font/_size.py b/plotly/validators/scatter3d/hoverlabel/font/_size.py deleted file mode 100644 index 7a3b6df18de..00000000000 --- a/plotly/validators/scatter3d/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatter3d.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/hoverlabel/font/_sizesrc.py b/plotly/validators/scatter3d/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 8dd23f5eb7d..00000000000 --- a/plotly/validators/scatter3d/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scatter3d.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/line/__init__.py b/plotly/validators/scatter3d/line/__init__.py index dddfd48d00b..92cb18dd02e 100644 --- a/plotly/validators/scatter3d/line/__init__.py +++ b/plotly/validators/scatter3d/line/__init__.py @@ -1,12 +1,228 @@ -from ._width import WidthValidator -from ._showscale import ShowscaleValidator -from ._reversescale import ReversescaleValidator -from ._dash import DashValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scatter3d.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='scatter3d.line', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scatter3d.line', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='dash', parent_name='scatter3d.line', **kwargs + ): + super(DashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='scatter3d.line', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='scatter3d.line', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scatter3d.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scatter3d.line.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='scatter3d.line', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='scatter3d.line', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='scatter3d.line', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='scatter3d.line', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scatter3d.line', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/line/_autocolorscale.py b/plotly/validators/scatter3d/line/_autocolorscale.py deleted file mode 100644 index 69801d6c6eb..00000000000 --- a/plotly/validators/scatter3d/line/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scatter3d.line', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/line/_cauto.py b/plotly/validators/scatter3d/line/_cauto.py deleted file mode 100644 index c6f86a618c3..00000000000 --- a/plotly/validators/scatter3d/line/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='scatter3d.line', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/line/_cmax.py b/plotly/validators/scatter3d/line/_cmax.py deleted file mode 100644 index 9d8c4c50122..00000000000 --- a/plotly/validators/scatter3d/line/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='scatter3d.line', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/line/_cmid.py b/plotly/validators/scatter3d/line/_cmid.py deleted file mode 100644 index fa25f827b5b..00000000000 --- a/plotly/validators/scatter3d/line/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='scatter3d.line', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/line/_cmin.py b/plotly/validators/scatter3d/line/_cmin.py deleted file mode 100644 index ae238f3e530..00000000000 --- a/plotly/validators/scatter3d/line/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='scatter3d.line', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/line/_color.py b/plotly/validators/scatter3d/line/_color.py deleted file mode 100644 index 7bf30d97d02..00000000000 --- a/plotly/validators/scatter3d/line/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scatter3d.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scatter3d.line.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/line/_colorscale.py b/plotly/validators/scatter3d/line/_colorscale.py deleted file mode 100644 index e9891d35716..00000000000 --- a/plotly/validators/scatter3d/line/_colorscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='scatter3d.line', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/line/_colorsrc.py b/plotly/validators/scatter3d/line/_colorsrc.py deleted file mode 100644 index c54244584dd..00000000000 --- a/plotly/validators/scatter3d/line/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='scatter3d.line', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/line/_dash.py b/plotly/validators/scatter3d/line/_dash.py deleted file mode 100644 index d87de1e13bc..00000000000 --- a/plotly/validators/scatter3d/line/_dash.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='dash', parent_name='scatter3d.line', **kwargs - ): - super(DashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/line/_reversescale.py b/plotly/validators/scatter3d/line/_reversescale.py deleted file mode 100644 index 343750d451e..00000000000 --- a/plotly/validators/scatter3d/line/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scatter3d.line', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/line/_showscale.py b/plotly/validators/scatter3d/line/_showscale.py deleted file mode 100644 index 999c1980e37..00000000000 --- a/plotly/validators/scatter3d/line/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='scatter3d.line', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/line/_width.py b/plotly/validators/scatter3d/line/_width.py deleted file mode 100644 index 52095206a52..00000000000 --- a/plotly/validators/scatter3d/line/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scatter3d.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/__init__.py b/plotly/validators/scatter3d/marker/__init__.py index b302460a224..22d181e5416 100644 --- a/plotly/validators/scatter3d/marker/__init__.py +++ b/plotly/validators/scatter3d/marker/__init__.py @@ -1,20 +1,675 @@ -from ._symbolsrc import SymbolsrcValidator -from ._symbol import SymbolValidator -from ._sizesrc import SizesrcValidator -from ._sizeref import SizerefValidator -from ._sizemode import SizemodeValidator -from ._sizemin import SizeminValidator -from ._size import SizeValidator -from ._showscale import ShowscaleValidator -from ._reversescale import ReversescaleValidator -from ._opacity import OpacityValidator -from ._line import LineValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='symbolsrc', + parent_name='scatter3d.marker', + **kwargs + ): + super(SymbolsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='symbol', parent_name='scatter3d.marker', **kwargs + ): + super(SymbolValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 'circle', 'circle-open', 'square', 'square-open', + 'diamond', 'diamond-open', 'cross', 'x' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='sizesrc', parent_name='scatter3d.marker', **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sizeref', parent_name='scatter3d.marker', **kwargs + ): + super(SizerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='sizemode', parent_name='scatter3d.marker', **kwargs + ): + super(SizemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['diameter', 'area']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sizemin', parent_name='scatter3d.marker', **kwargs + ): + super(SizeminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='scatter3d.marker', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showscale', + parent_name='scatter3d.marker', + **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scatter3d.marker', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='scatter3d.marker', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='scatter3d.marker', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='scatter3d.marker', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='scatter3d.marker', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='scatter3d.marker', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scatter3d.marker.colorbar.Tic + kformatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scatter3d.marker.colorbar.tickformatstopdefau + lts), sets the default property values to use + for elements of + scatter3d.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatter3d.marker.colorbar.Tit + le instance or dict with compatible properties + titlefont + Deprecated: Please use + scatter3d.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. + titleside + Deprecated: Please use + scatter3d.marker.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scatter3d.marker', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scatter3d.marker.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='scatter3d.marker', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='scatter3d.marker', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='scatter3d.marker', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='scatter3d.marker', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scatter3d.marker', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/marker/_autocolorscale.py b/plotly/validators/scatter3d/marker/_autocolorscale.py deleted file mode 100644 index 7e79f7c9191..00000000000 --- a/plotly/validators/scatter3d/marker/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scatter3d.marker', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_cauto.py b/plotly/validators/scatter3d/marker/_cauto.py deleted file mode 100644 index 6ec8cd12368..00000000000 --- a/plotly/validators/scatter3d/marker/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='scatter3d.marker', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_cmax.py b/plotly/validators/scatter3d/marker/_cmax.py deleted file mode 100644 index eb700981442..00000000000 --- a/plotly/validators/scatter3d/marker/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='scatter3d.marker', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_cmid.py b/plotly/validators/scatter3d/marker/_cmid.py deleted file mode 100644 index f04e1669254..00000000000 --- a/plotly/validators/scatter3d/marker/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='scatter3d.marker', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_cmin.py b/plotly/validators/scatter3d/marker/_cmin.py deleted file mode 100644 index fa8eb836447..00000000000 --- a/plotly/validators/scatter3d/marker/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='scatter3d.marker', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_color.py b/plotly/validators/scatter3d/marker/_color.py deleted file mode 100644 index e64c2337a27..00000000000 --- a/plotly/validators/scatter3d/marker/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scatter3d.marker', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scatter3d.marker.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_colorbar.py b/plotly/validators/scatter3d/marker/_colorbar.py deleted file mode 100644 index 45e8e2bc529..00000000000 --- a/plotly/validators/scatter3d/marker/_colorbar.py +++ /dev/null @@ -1,228 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='scatter3d.marker', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scatter3d.marker.colorbar.Tic - kformatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scatter3d.marker.colorbar.tickformatstopdefau - lts), sets the default property values to use - for elements of - scatter3d.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatter3d.marker.colorbar.Tit - le instance or dict with compatible properties - titlefont - Deprecated: Please use - scatter3d.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. - titleside - Deprecated: Please use - scatter3d.marker.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_colorscale.py b/plotly/validators/scatter3d/marker/_colorscale.py deleted file mode 100644 index 54d8e91ae15..00000000000 --- a/plotly/validators/scatter3d/marker/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='scatter3d.marker', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_colorsrc.py b/plotly/validators/scatter3d/marker/_colorsrc.py deleted file mode 100644 index 0610e9f7b6d..00000000000 --- a/plotly/validators/scatter3d/marker/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='scatter3d.marker', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_line.py b/plotly/validators/scatter3d/marker/_line.py deleted file mode 100644 index c5f4f7b2ec7..00000000000 --- a/plotly/validators/scatter3d/marker/_line.py +++ /dev/null @@ -1,94 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='scatter3d.marker', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_opacity.py b/plotly/validators/scatter3d/marker/_opacity.py deleted file mode 100644 index 0c957c0b108..00000000000 --- a/plotly/validators/scatter3d/marker/_opacity.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='scatter3d.marker', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_reversescale.py b/plotly/validators/scatter3d/marker/_reversescale.py deleted file mode 100644 index bac413d641e..00000000000 --- a/plotly/validators/scatter3d/marker/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scatter3d.marker', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_showscale.py b/plotly/validators/scatter3d/marker/_showscale.py deleted file mode 100644 index 6ba2e72062a..00000000000 --- a/plotly/validators/scatter3d/marker/_showscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showscale', - parent_name='scatter3d.marker', - **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_size.py b/plotly/validators/scatter3d/marker/_size.py deleted file mode 100644 index 65112f0d971..00000000000 --- a/plotly/validators/scatter3d/marker/_size.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='scatter3d.marker', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_sizemin.py b/plotly/validators/scatter3d/marker/_sizemin.py deleted file mode 100644 index c92a0f21293..00000000000 --- a/plotly/validators/scatter3d/marker/_sizemin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sizemin', parent_name='scatter3d.marker', **kwargs - ): - super(SizeminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_sizemode.py b/plotly/validators/scatter3d/marker/_sizemode.py deleted file mode 100644 index ae866a1bd5d..00000000000 --- a/plotly/validators/scatter3d/marker/_sizemode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='sizemode', parent_name='scatter3d.marker', **kwargs - ): - super(SizemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['diameter', 'area']), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_sizeref.py b/plotly/validators/scatter3d/marker/_sizeref.py deleted file mode 100644 index 3cec35b0e83..00000000000 --- a/plotly/validators/scatter3d/marker/_sizeref.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sizeref', parent_name='scatter3d.marker', **kwargs - ): - super(SizerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_sizesrc.py b/plotly/validators/scatter3d/marker/_sizesrc.py deleted file mode 100644 index bbeb228c782..00000000000 --- a/plotly/validators/scatter3d/marker/_sizesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='sizesrc', parent_name='scatter3d.marker', **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_symbol.py b/plotly/validators/scatter3d/marker/_symbol.py deleted file mode 100644 index 0f65a438b42..00000000000 --- a/plotly/validators/scatter3d/marker/_symbol.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='symbol', parent_name='scatter3d.marker', **kwargs - ): - super(SymbolValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 'circle', 'circle-open', 'square', 'square-open', - 'diamond', 'diamond-open', 'cross', 'x' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/_symbolsrc.py b/plotly/validators/scatter3d/marker/_symbolsrc.py deleted file mode 100644 index 9a1cc2a305e..00000000000 --- a/plotly/validators/scatter3d/marker/_symbolsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='symbolsrc', - parent_name='scatter3d.marker', - **kwargs - ): - super(SymbolsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/__init__.py b/plotly/validators/scatter3d/marker/colorbar/__init__.py index 3dab31f7e02..0ffa97ed706 100644 --- a/plotly/validators/scatter3d/marker/colorbar/__init__.py +++ b/plotly/validators/scatter3d/marker/colorbar/__init__.py @@ -1,41 +1,936 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ypad', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='y', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xpad', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='x', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='len', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scatter3d.marker.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_bgcolor.py b/plotly/validators/scatter3d/marker/colorbar/_bgcolor.py deleted file mode 100644 index de2eda58d1f..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_bordercolor.py b/plotly/validators/scatter3d/marker/colorbar/_bordercolor.py deleted file mode 100644 index 41e0a6ffcb1..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_borderwidth.py b/plotly/validators/scatter3d/marker/colorbar/_borderwidth.py deleted file mode 100644 index 006d6e62a73..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_dtick.py b/plotly/validators/scatter3d/marker/colorbar/_dtick.py deleted file mode 100644 index 1d008db9440..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_exponentformat.py b/plotly/validators/scatter3d/marker/colorbar/_exponentformat.py deleted file mode 100644 index 7e646e1baec..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_len.py b/plotly/validators/scatter3d/marker/colorbar/_len.py deleted file mode 100644 index 235fab932d1..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_len.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='len', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_lenmode.py b/plotly/validators/scatter3d/marker/colorbar/_lenmode.py deleted file mode 100644 index c60bd851f76..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_nticks.py b/plotly/validators/scatter3d/marker/colorbar/_nticks.py deleted file mode 100644 index a3ca17d020f..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_outlinecolor.py b/plotly/validators/scatter3d/marker/colorbar/_outlinecolor.py deleted file mode 100644 index d9c6b82b27a..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_outlinewidth.py b/plotly/validators/scatter3d/marker/colorbar/_outlinewidth.py deleted file mode 100644 index bec87ddb179..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_separatethousands.py b/plotly/validators/scatter3d/marker/colorbar/_separatethousands.py deleted file mode 100644 index 73737347d40..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_showexponent.py b/plotly/validators/scatter3d/marker/colorbar/_showexponent.py deleted file mode 100644 index abf89334e66..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_showticklabels.py b/plotly/validators/scatter3d/marker/colorbar/_showticklabels.py deleted file mode 100644 index d13b02b5800..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_showtickprefix.py b/plotly/validators/scatter3d/marker/colorbar/_showtickprefix.py deleted file mode 100644 index 255e920931b..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_showticksuffix.py b/plotly/validators/scatter3d/marker/colorbar/_showticksuffix.py deleted file mode 100644 index 46340ff36e8..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_thickness.py b/plotly/validators/scatter3d/marker/colorbar/_thickness.py deleted file mode 100644 index 2775c73d985..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_thicknessmode.py b/plotly/validators/scatter3d/marker/colorbar/_thicknessmode.py deleted file mode 100644 index e0168cc9998..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_tick0.py b/plotly/validators/scatter3d/marker/colorbar/_tick0.py deleted file mode 100644 index a8bec7ad97c..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_tickangle.py b/plotly/validators/scatter3d/marker/colorbar/_tickangle.py deleted file mode 100644 index a6224ceec7f..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_tickcolor.py b/plotly/validators/scatter3d/marker/colorbar/_tickcolor.py deleted file mode 100644 index b4fd38cf555..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_tickfont.py b/plotly/validators/scatter3d/marker/colorbar/_tickfont.py deleted file mode 100644 index 983bcc20b27..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_tickformat.py b/plotly/validators/scatter3d/marker/colorbar/_tickformat.py deleted file mode 100644 index d64f131c7fe..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_tickformatstopdefaults.py b/plotly/validators/scatter3d/marker/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 5e60f9076c1..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_tickformatstops.py b/plotly/validators/scatter3d/marker/colorbar/_tickformatstops.py deleted file mode 100644 index 82f058a960a..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_ticklen.py b/plotly/validators/scatter3d/marker/colorbar/_ticklen.py deleted file mode 100644 index 8066c5ce7e2..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_tickmode.py b/plotly/validators/scatter3d/marker/colorbar/_tickmode.py deleted file mode 100644 index 902d5a770a4..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_tickprefix.py b/plotly/validators/scatter3d/marker/colorbar/_tickprefix.py deleted file mode 100644 index 1e8089713c8..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_ticks.py b/plotly/validators/scatter3d/marker/colorbar/_ticks.py deleted file mode 100644 index 4e3423b6c89..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_ticksuffix.py b/plotly/validators/scatter3d/marker/colorbar/_ticksuffix.py deleted file mode 100644 index fbcb80c80c8..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_ticktext.py b/plotly/validators/scatter3d/marker/colorbar/_ticktext.py deleted file mode 100644 index e9c3e780818..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_ticktextsrc.py b/plotly/validators/scatter3d/marker/colorbar/_ticktextsrc.py deleted file mode 100644 index 71085f4de84..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_tickvals.py b/plotly/validators/scatter3d/marker/colorbar/_tickvals.py deleted file mode 100644 index 097566b00c5..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_tickvalssrc.py b/plotly/validators/scatter3d/marker/colorbar/_tickvalssrc.py deleted file mode 100644 index fca0e7dcdc9..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_tickwidth.py b/plotly/validators/scatter3d/marker/colorbar/_tickwidth.py deleted file mode 100644 index 130c5f28ad6..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_title.py b/plotly/validators/scatter3d/marker/colorbar/_title.py deleted file mode 100644 index 2a1b44350ba..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_x.py b/plotly/validators/scatter3d/marker/colorbar/_x.py deleted file mode 100644 index c5bd9d00d4a..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_x.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='x', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_xanchor.py b/plotly/validators/scatter3d/marker/colorbar/_xanchor.py deleted file mode 100644 index c2c7ea58b71..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_xpad.py b/plotly/validators/scatter3d/marker/colorbar/_xpad.py deleted file mode 100644 index c3ba4fbcfb5..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_xpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xpad', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_y.py b/plotly/validators/scatter3d/marker/colorbar/_y.py deleted file mode 100644 index dfaca728520..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_y.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='y', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_yanchor.py b/plotly/validators/scatter3d/marker/colorbar/_yanchor.py deleted file mode 100644 index 1e483f207db..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/_ypad.py b/plotly/validators/scatter3d/marker/colorbar/_ypad.py deleted file mode 100644 index d75fa1e63b0..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/_ypad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ypad', - parent_name='scatter3d.marker.colorbar', - **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/tickfont/__init__.py b/plotly/validators/scatter3d/marker/colorbar/tickfont/__init__.py index 199d72e71c6..6a13df1162a 100644 --- a/plotly/validators/scatter3d/marker/colorbar/tickfont/__init__.py +++ b/plotly/validators/scatter3d/marker/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatter3d.marker.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatter3d.marker.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatter3d.marker.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/marker/colorbar/tickfont/_color.py b/plotly/validators/scatter3d/marker/colorbar/tickfont/_color.py deleted file mode 100644 index 2e6ebdf4e05..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatter3d.marker.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/tickfont/_family.py b/plotly/validators/scatter3d/marker/colorbar/tickfont/_family.py deleted file mode 100644 index 72301762538..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatter3d.marker.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/tickfont/_size.py b/plotly/validators/scatter3d/marker/colorbar/tickfont/_size.py deleted file mode 100644 index ecf35cc23f6..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatter3d.marker.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/tickformatstop/__init__.py b/plotly/validators/scatter3d/marker/colorbar/tickformatstop/__init__.py index 3f6c06cac47..17e57613d1d 100644 --- a/plotly/validators/scatter3d/marker/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/scatter3d/marker/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='scatter3d.marker.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='scatter3d.marker.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='scatter3d.marker.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='scatter3d.marker.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='scatter3d.marker.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'calc' + }, { + 'valType': 'any', + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/marker/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/scatter3d/marker/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 94b189345fa..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='scatter3d.marker.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'calc' - }, { - 'valType': 'any', - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/tickformatstop/_enabled.py b/plotly/validators/scatter3d/marker/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index 7738271280f..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='scatter3d.marker.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/tickformatstop/_name.py b/plotly/validators/scatter3d/marker/colorbar/tickformatstop/_name.py deleted file mode 100644 index f46dcccebce..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='scatter3d.marker.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/scatter3d/marker/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 5ac8ac3cc20..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='scatter3d.marker.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/tickformatstop/_value.py b/plotly/validators/scatter3d/marker/colorbar/tickformatstop/_value.py deleted file mode 100644 index d41d89f8df3..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='scatter3d.marker.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/title/__init__.py b/plotly/validators/scatter3d/marker/colorbar/title/__init__.py index 33c9c145bb8..cd210520ba4 100644 --- a/plotly/validators/scatter3d/marker/colorbar/title/__init__.py +++ b/plotly/validators/scatter3d/marker/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='scatter3d.marker.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='scatter3d.marker.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='scatter3d.marker.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/scatter3d/marker/colorbar/title/_font.py b/plotly/validators/scatter3d/marker/colorbar/title/_font.py deleted file mode 100644 index 27c7a168bd7..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='scatter3d.marker.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/title/_side.py b/plotly/validators/scatter3d/marker/colorbar/title/_side.py deleted file mode 100644 index 9ec66902cfc..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='scatter3d.marker.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/title/_text.py b/plotly/validators/scatter3d/marker/colorbar/title/_text.py deleted file mode 100644 index 279ad03ef34..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='scatter3d.marker.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/title/font/__init__.py b/plotly/validators/scatter3d/marker/colorbar/title/font/__init__.py index 199d72e71c6..88c32d9b954 100644 --- a/plotly/validators/scatter3d/marker/colorbar/title/font/__init__.py +++ b/plotly/validators/scatter3d/marker/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatter3d.marker.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatter3d.marker.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatter3d.marker.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/marker/colorbar/title/font/_color.py b/plotly/validators/scatter3d/marker/colorbar/title/font/_color.py deleted file mode 100644 index 1a5bee46bc9..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatter3d.marker.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/title/font/_family.py b/plotly/validators/scatter3d/marker/colorbar/title/font/_family.py deleted file mode 100644 index 352db9de37a..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatter3d.marker.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/colorbar/title/font/_size.py b/plotly/validators/scatter3d/marker/colorbar/title/font/_size.py deleted file mode 100644 index 726a810b3b1..00000000000 --- a/plotly/validators/scatter3d/marker/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatter3d.marker.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/line/__init__.py b/plotly/validators/scatter3d/marker/line/__init__.py index d2ede3f2a6c..920b0442f47 100644 --- a/plotly/validators/scatter3d/marker/line/__init__.py +++ b/plotly/validators/scatter3d/marker/line/__init__.py @@ -1,10 +1,215 @@ -from ._width import WidthValidator -from ._reversescale import ReversescaleValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='scatter3d.marker.line', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scatter3d.marker.line', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatter3d.marker.line', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='scatter3d.marker.line', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatter3d.marker.line', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scatter3d.marker.line.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmin', + parent_name='scatter3d.marker.line', + **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmid', + parent_name='scatter3d.marker.line', + **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmax', + parent_name='scatter3d.marker.line', + **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='cauto', + parent_name='scatter3d.marker.line', + **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scatter3d.marker.line', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/marker/line/_autocolorscale.py b/plotly/validators/scatter3d/marker/line/_autocolorscale.py deleted file mode 100644 index 24d7c87a091..00000000000 --- a/plotly/validators/scatter3d/marker/line/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scatter3d.marker.line', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/line/_cauto.py b/plotly/validators/scatter3d/marker/line/_cauto.py deleted file mode 100644 index 5ed8465cabe..00000000000 --- a/plotly/validators/scatter3d/marker/line/_cauto.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='cauto', - parent_name='scatter3d.marker.line', - **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/line/_cmax.py b/plotly/validators/scatter3d/marker/line/_cmax.py deleted file mode 100644 index f851f1c1798..00000000000 --- a/plotly/validators/scatter3d/marker/line/_cmax.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmax', - parent_name='scatter3d.marker.line', - **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/line/_cmid.py b/plotly/validators/scatter3d/marker/line/_cmid.py deleted file mode 100644 index adbd95b9382..00000000000 --- a/plotly/validators/scatter3d/marker/line/_cmid.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmid', - parent_name='scatter3d.marker.line', - **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/line/_cmin.py b/plotly/validators/scatter3d/marker/line/_cmin.py deleted file mode 100644 index b7cc8dcc77b..00000000000 --- a/plotly/validators/scatter3d/marker/line/_cmin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmin', - parent_name='scatter3d.marker.line', - **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/line/_color.py b/plotly/validators/scatter3d/marker/line/_color.py deleted file mode 100644 index 54ac361ece3..00000000000 --- a/plotly/validators/scatter3d/marker/line/_color.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatter3d.marker.line', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scatter3d.marker.line.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/line/_colorscale.py b/plotly/validators/scatter3d/marker/line/_colorscale.py deleted file mode 100644 index 846a59a0705..00000000000 --- a/plotly/validators/scatter3d/marker/line/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='scatter3d.marker.line', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/line/_colorsrc.py b/plotly/validators/scatter3d/marker/line/_colorsrc.py deleted file mode 100644 index 708a62c49b3..00000000000 --- a/plotly/validators/scatter3d/marker/line/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatter3d.marker.line', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/line/_reversescale.py b/plotly/validators/scatter3d/marker/line/_reversescale.py deleted file mode 100644 index fb7d71dc51c..00000000000 --- a/plotly/validators/scatter3d/marker/line/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scatter3d.marker.line', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/marker/line/_width.py b/plotly/validators/scatter3d/marker/line/_width.py deleted file mode 100644 index 3afce08d188..00000000000 --- a/plotly/validators/scatter3d/marker/line/_width.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='scatter3d.marker.line', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/projection/__init__.py b/plotly/validators/scatter3d/projection/__init__.py index 438e2dc9c6d..a385097d0c6 100644 --- a/plotly/validators/scatter3d/projection/__init__.py +++ b/plotly/validators/scatter3d/projection/__init__.py @@ -1,3 +1,84 @@ -from ._z import ZValidator -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='z', parent_name='scatter3d.projection', **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Z'), + data_docs=kwargs.pop( + 'data_docs', """ + opacity + Sets the projection color. + scale + Sets the scale factor determining the size of + the projection marker points. + show + Sets whether or not projections are shown along + the z axis. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='y', parent_name='scatter3d.projection', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Y'), + data_docs=kwargs.pop( + 'data_docs', """ + opacity + Sets the projection color. + scale + Sets the scale factor determining the size of + the projection marker points. + show + Sets whether or not projections are shown along + the y axis. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='x', parent_name='scatter3d.projection', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'X'), + data_docs=kwargs.pop( + 'data_docs', """ + opacity + Sets the projection color. + scale + Sets the scale factor determining the size of + the projection marker points. + show + Sets whether or not projections are shown along + the x axis. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scatter3d/projection/_x.py b/plotly/validators/scatter3d/projection/_x.py deleted file mode 100644 index 871f4809ee0..00000000000 --- a/plotly/validators/scatter3d/projection/_x.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='x', parent_name='scatter3d.projection', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'X'), - data_docs=kwargs.pop( - 'data_docs', """ - opacity - Sets the projection color. - scale - Sets the scale factor determining the size of - the projection marker points. - show - Sets whether or not projections are shown along - the x axis. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/projection/_y.py b/plotly/validators/scatter3d/projection/_y.py deleted file mode 100644 index dbd86c45f0b..00000000000 --- a/plotly/validators/scatter3d/projection/_y.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='y', parent_name='scatter3d.projection', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Y'), - data_docs=kwargs.pop( - 'data_docs', """ - opacity - Sets the projection color. - scale - Sets the scale factor determining the size of - the projection marker points. - show - Sets whether or not projections are shown along - the y axis. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/projection/_z.py b/plotly/validators/scatter3d/projection/_z.py deleted file mode 100644 index cba5d2818dd..00000000000 --- a/plotly/validators/scatter3d/projection/_z.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='z', parent_name='scatter3d.projection', **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Z'), - data_docs=kwargs.pop( - 'data_docs', """ - opacity - Sets the projection color. - scale - Sets the scale factor determining the size of - the projection marker points. - show - Sets whether or not projections are shown along - the z axis. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatter3d/projection/x/__init__.py b/plotly/validators/scatter3d/projection/x/__init__.py index 5f3d9448b08..288e2136526 100644 --- a/plotly/validators/scatter3d/projection/x/__init__.py +++ b/plotly/validators/scatter3d/projection/x/__init__.py @@ -1,3 +1,64 @@ -from ._show import ShowValidator -from ._scale import ScaleValidator -from ._opacity import OpacityValidator + + +import _plotly_utils.basevalidators + + +class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='show', + parent_name='scatter3d.projection.x', + **kwargs + ): + super(ShowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScaleValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='scale', + parent_name='scatter3d.projection.x', + **kwargs + ): + super(ScaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scatter3d.projection.x', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/projection/x/_opacity.py b/plotly/validators/scatter3d/projection/x/_opacity.py deleted file mode 100644 index b24646524b9..00000000000 --- a/plotly/validators/scatter3d/projection/x/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scatter3d.projection.x', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/projection/x/_scale.py b/plotly/validators/scatter3d/projection/x/_scale.py deleted file mode 100644 index ebfaade5095..00000000000 --- a/plotly/validators/scatter3d/projection/x/_scale.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScaleValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='scale', - parent_name='scatter3d.projection.x', - **kwargs - ): - super(ScaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/projection/x/_show.py b/plotly/validators/scatter3d/projection/x/_show.py deleted file mode 100644 index 32a5ee9a199..00000000000 --- a/plotly/validators/scatter3d/projection/x/_show.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='show', - parent_name='scatter3d.projection.x', - **kwargs - ): - super(ShowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/projection/y/__init__.py b/plotly/validators/scatter3d/projection/y/__init__.py index 5f3d9448b08..33e4ac6c32d 100644 --- a/plotly/validators/scatter3d/projection/y/__init__.py +++ b/plotly/validators/scatter3d/projection/y/__init__.py @@ -1,3 +1,64 @@ -from ._show import ShowValidator -from ._scale import ScaleValidator -from ._opacity import OpacityValidator + + +import _plotly_utils.basevalidators + + +class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='show', + parent_name='scatter3d.projection.y', + **kwargs + ): + super(ShowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScaleValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='scale', + parent_name='scatter3d.projection.y', + **kwargs + ): + super(ScaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scatter3d.projection.y', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/projection/y/_opacity.py b/plotly/validators/scatter3d/projection/y/_opacity.py deleted file mode 100644 index b9681edaaed..00000000000 --- a/plotly/validators/scatter3d/projection/y/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scatter3d.projection.y', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/projection/y/_scale.py b/plotly/validators/scatter3d/projection/y/_scale.py deleted file mode 100644 index 6826b0bc1aa..00000000000 --- a/plotly/validators/scatter3d/projection/y/_scale.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScaleValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='scale', - parent_name='scatter3d.projection.y', - **kwargs - ): - super(ScaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/projection/y/_show.py b/plotly/validators/scatter3d/projection/y/_show.py deleted file mode 100644 index 0ab1b7f37d0..00000000000 --- a/plotly/validators/scatter3d/projection/y/_show.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='show', - parent_name='scatter3d.projection.y', - **kwargs - ): - super(ShowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/projection/z/__init__.py b/plotly/validators/scatter3d/projection/z/__init__.py index 5f3d9448b08..2d248ea9d16 100644 --- a/plotly/validators/scatter3d/projection/z/__init__.py +++ b/plotly/validators/scatter3d/projection/z/__init__.py @@ -1,3 +1,64 @@ -from ._show import ShowValidator -from ._scale import ScaleValidator -from ._opacity import OpacityValidator + + +import _plotly_utils.basevalidators + + +class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='show', + parent_name='scatter3d.projection.z', + **kwargs + ): + super(ShowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScaleValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='scale', + parent_name='scatter3d.projection.z', + **kwargs + ): + super(ScaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scatter3d.projection.z', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/projection/z/_opacity.py b/plotly/validators/scatter3d/projection/z/_opacity.py deleted file mode 100644 index e135bd16d55..00000000000 --- a/plotly/validators/scatter3d/projection/z/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scatter3d.projection.z', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/projection/z/_scale.py b/plotly/validators/scatter3d/projection/z/_scale.py deleted file mode 100644 index a1201bc9f84..00000000000 --- a/plotly/validators/scatter3d/projection/z/_scale.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScaleValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='scale', - parent_name='scatter3d.projection.z', - **kwargs - ): - super(ScaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/projection/z/_show.py b/plotly/validators/scatter3d/projection/z/_show.py deleted file mode 100644 index d192f890e48..00000000000 --- a/plotly/validators/scatter3d/projection/z/_show.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='show', - parent_name='scatter3d.projection.z', - **kwargs - ): - super(ShowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/stream/__init__.py b/plotly/validators/scatter3d/stream/__init__.py index 2f4f2047594..cf2d15be03c 100644 --- a/plotly/validators/scatter3d/stream/__init__.py +++ b/plotly/validators/scatter3d/stream/__init__.py @@ -1,2 +1,41 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='scatter3d.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='scatter3d.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/stream/_maxpoints.py b/plotly/validators/scatter3d/stream/_maxpoints.py deleted file mode 100644 index af22af2579a..00000000000 --- a/plotly/validators/scatter3d/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='scatter3d.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/stream/_token.py b/plotly/validators/scatter3d/stream/_token.py deleted file mode 100644 index 3039ca26c9d..00000000000 --- a/plotly/validators/scatter3d/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='scatter3d.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatter3d/textfont/__init__.py b/plotly/validators/scatter3d/textfont/__init__.py index a5ac78a266e..976a6292f6b 100644 --- a/plotly/validators/scatter3d/textfont/__init__.py +++ b/plotly/validators/scatter3d/textfont/__init__.py @@ -1,5 +1,97 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scatter3d.textfont', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='scatter3d.textfont', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='scatter3d.textfont', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatter3d.textfont', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scatter3d.textfont', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatter3d/textfont/_color.py b/plotly/validators/scatter3d/textfont/_color.py deleted file mode 100644 index a34279bd0c0..00000000000 --- a/plotly/validators/scatter3d/textfont/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scatter3d.textfont', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/textfont/_colorsrc.py b/plotly/validators/scatter3d/textfont/_colorsrc.py deleted file mode 100644 index c7a0ddce8c7..00000000000 --- a/plotly/validators/scatter3d/textfont/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatter3d.textfont', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/textfont/_family.py b/plotly/validators/scatter3d/textfont/_family.py deleted file mode 100644 index e45657daf6b..00000000000 --- a/plotly/validators/scatter3d/textfont/_family.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='scatter3d.textfont', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatter3d/textfont/_size.py b/plotly/validators/scatter3d/textfont/_size.py deleted file mode 100644 index 2c5843dc9f3..00000000000 --- a/plotly/validators/scatter3d/textfont/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='scatter3d.textfont', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatter3d/textfont/_sizesrc.py b/plotly/validators/scatter3d/textfont/_sizesrc.py deleted file mode 100644 index 5e13e1fbadc..00000000000 --- a/plotly/validators/scatter3d/textfont/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scatter3d.textfont', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/__init__.py b/plotly/validators/scattercarpet/__init__.py index d2b27b392ab..9e544c3bd3a 100644 --- a/plotly/validators/scattercarpet/__init__.py +++ b/plotly/validators/scattercarpet/__init__.py @@ -1,41 +1,979 @@ -from ._yaxis import YAxisValidator -from ._xaxis import XAxisValidator -from ._visible import VisibleValidator -from ._unselected import UnselectedValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textsrc import TextsrcValidator -from ._textpositionsrc import TextpositionsrcValidator -from ._textposition import TextpositionValidator -from ._textfont import TextfontValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._selected import SelectedValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._mode import ModeValidator -from ._marker import MarkerValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoveron import HoveronValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._fillcolor import FillcolorValidator -from ._fill import FillValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._connectgaps import ConnectgapsValidator -from ._carpet import CarpetValidator -from ._bsrc import BsrcValidator -from ._b import BValidator -from ._asrc import AsrcValidator -from ._a import AValidator + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='yaxis', parent_name='scattercarpet', **kwargs + ): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='xaxis', parent_name='scattercarpet', **kwargs + ): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='scattercarpet', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='unselected', parent_name='scattercarpet', **kwargs + ): + super(UnselectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Unselected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.scattercarpet.unselected.Mark + er instance or dict with compatible properties + textfont + plotly.graph_objs.scattercarpet.unselected.Text + font instance or dict with compatible + properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='scattercarpet', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='uid', parent_name='scattercarpet', **kwargs + ): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textsrc', parent_name='scattercarpet', **kwargs + ): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='textpositionsrc', + parent_name='scattercarpet', + **kwargs + ): + super(TextpositionsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='textposition', + parent_name='scattercarpet', + **kwargs + ): + super(TextpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 'top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', + 'bottom center', 'bottom right' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='textfont', parent_name='scattercarpet', **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='text', parent_name='scattercarpet', **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='scattercarpet', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='scattercarpet', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='selectedpoints', + parent_name='scattercarpet', + **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='selected', parent_name='scattercarpet', **kwargs + ): + super(SelectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Selected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.scattercarpet.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scattercarpet.selected.Textfo + nt instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='scattercarpet', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='scattercarpet', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='mode', parent_name='scattercarpet', **kwargs + ): + super(ModeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['none']), + flags=kwargs.pop('flags', ['lines', 'markers', 'text']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='scattercarpet', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scattercarpet.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + gradient + plotly.graph_objs.scattercarpet.marker.Gradient + instance or dict with compatible properties + line + plotly.graph_objs.scattercarpet.marker.Line + instance or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on + the graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='scattercarpet', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the + lines are drawn using spline interpolation. The + other available values correspond to step-wise + line shapes. + smoothing + Has an effect only if `shape` is set to + "spline" Sets the amount of smoothing. 0 + corresponds to no smoothing (equivalent to a + "linear" shape). + width + Sets the line width (in px). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='scattercarpet', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='scattercarpet', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ids', parent_name='scattercarpet', **kwargs + ): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertextsrc', + parent_name='scattercarpet', + **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='scattercarpet', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertemplatesrc', + parent_name='scattercarpet', + **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hovertemplate', + parent_name='scattercarpet', + **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoveronValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoveron', parent_name='scattercarpet', **kwargs + ): + super(HoveronValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + flags=kwargs.pop('flags', ['points', 'fills']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='scattercarpet', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hoverinfosrc', + parent_name='scattercarpet', + **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='scattercarpet', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['a', 'b', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='fillcolor', parent_name='scattercarpet', **kwargs + ): + super(FillcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='fill', parent_name='scattercarpet', **kwargs + ): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['none', 'toself', 'tonext']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='customdatasrc', + parent_name='scattercarpet', + **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='scattercarpet', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='connectgaps', parent_name='scattercarpet', **kwargs + ): + super(ConnectgapsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CarpetValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='carpet', parent_name='scattercarpet', **kwargs + ): + super(CarpetValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='bsrc', parent_name='scattercarpet', **kwargs + ): + super(BsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='b', parent_name='scattercarpet', **kwargs): + super(BValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='asrc', parent_name='scattercarpet', **kwargs + ): + super(AsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='a', parent_name='scattercarpet', **kwargs): + super(AValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/_a.py b/plotly/validators/scattercarpet/_a.py deleted file mode 100644 index 53a6893b702..00000000000 --- a/plotly/validators/scattercarpet/_a.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class AValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='a', parent_name='scattercarpet', **kwargs): - super(AValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_asrc.py b/plotly/validators/scattercarpet/_asrc.py deleted file mode 100644 index 8373156ac15..00000000000 --- a/plotly/validators/scattercarpet/_asrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='asrc', parent_name='scattercarpet', **kwargs - ): - super(AsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_b.py b/plotly/validators/scattercarpet/_b.py deleted file mode 100644 index 307cbadc4a8..00000000000 --- a/plotly/validators/scattercarpet/_b.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class BValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='b', parent_name='scattercarpet', **kwargs): - super(BValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_bsrc.py b/plotly/validators/scattercarpet/_bsrc.py deleted file mode 100644 index c72784b6579..00000000000 --- a/plotly/validators/scattercarpet/_bsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='bsrc', parent_name='scattercarpet', **kwargs - ): - super(BsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_carpet.py b/plotly/validators/scattercarpet/_carpet.py deleted file mode 100644 index 7051c463d8c..00000000000 --- a/plotly/validators/scattercarpet/_carpet.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CarpetValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='carpet', parent_name='scattercarpet', **kwargs - ): - super(CarpetValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_connectgaps.py b/plotly/validators/scattercarpet/_connectgaps.py deleted file mode 100644 index f0908e24385..00000000000 --- a/plotly/validators/scattercarpet/_connectgaps.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='connectgaps', parent_name='scattercarpet', **kwargs - ): - super(ConnectgapsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_customdata.py b/plotly/validators/scattercarpet/_customdata.py deleted file mode 100644 index d74ad7fdb4a..00000000000 --- a/plotly/validators/scattercarpet/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='scattercarpet', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_customdatasrc.py b/plotly/validators/scattercarpet/_customdatasrc.py deleted file mode 100644 index 7cb46bfc539..00000000000 --- a/plotly/validators/scattercarpet/_customdatasrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='customdatasrc', - parent_name='scattercarpet', - **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_fill.py b/plotly/validators/scattercarpet/_fill.py deleted file mode 100644 index bdbd0c9160f..00000000000 --- a/plotly/validators/scattercarpet/_fill.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='fill', parent_name='scattercarpet', **kwargs - ): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['none', 'toself', 'tonext']), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_fillcolor.py b/plotly/validators/scattercarpet/_fillcolor.py deleted file mode 100644 index 23e2cef732e..00000000000 --- a/plotly/validators/scattercarpet/_fillcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='fillcolor', parent_name='scattercarpet', **kwargs - ): - super(FillcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_hoverinfo.py b/plotly/validators/scattercarpet/_hoverinfo.py deleted file mode 100644 index f219d0bcc4b..00000000000 --- a/plotly/validators/scattercarpet/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='scattercarpet', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['a', 'b', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_hoverinfosrc.py b/plotly/validators/scattercarpet/_hoverinfosrc.py deleted file mode 100644 index 2be97b7bc6d..00000000000 --- a/plotly/validators/scattercarpet/_hoverinfosrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hoverinfosrc', - parent_name='scattercarpet', - **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_hoverlabel.py b/plotly/validators/scattercarpet/_hoverlabel.py deleted file mode 100644 index e372edf2665..00000000000 --- a/plotly/validators/scattercarpet/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='scattercarpet', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_hoveron.py b/plotly/validators/scattercarpet/_hoveron.py deleted file mode 100644 index 5898fb97d37..00000000000 --- a/plotly/validators/scattercarpet/_hoveron.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoveronValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoveron', parent_name='scattercarpet', **kwargs - ): - super(HoveronValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - flags=kwargs.pop('flags', ['points', 'fills']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_hovertemplate.py b/plotly/validators/scattercarpet/_hovertemplate.py deleted file mode 100644 index a4966508b15..00000000000 --- a/plotly/validators/scattercarpet/_hovertemplate.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hovertemplate', - parent_name='scattercarpet', - **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_hovertemplatesrc.py b/plotly/validators/scattercarpet/_hovertemplatesrc.py deleted file mode 100644 index 24e4fe9913b..00000000000 --- a/plotly/validators/scattercarpet/_hovertemplatesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertemplatesrc', - parent_name='scattercarpet', - **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_hovertext.py b/plotly/validators/scattercarpet/_hovertext.py deleted file mode 100644 index 27d6ea8f314..00000000000 --- a/plotly/validators/scattercarpet/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='scattercarpet', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_hovertextsrc.py b/plotly/validators/scattercarpet/_hovertextsrc.py deleted file mode 100644 index 748253ef5dd..00000000000 --- a/plotly/validators/scattercarpet/_hovertextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertextsrc', - parent_name='scattercarpet', - **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_ids.py b/plotly/validators/scattercarpet/_ids.py deleted file mode 100644 index fd1acfd4d50..00000000000 --- a/plotly/validators/scattercarpet/_ids.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ids', parent_name='scattercarpet', **kwargs - ): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_idssrc.py b/plotly/validators/scattercarpet/_idssrc.py deleted file mode 100644 index a8f3281b146..00000000000 --- a/plotly/validators/scattercarpet/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='scattercarpet', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_legendgroup.py b/plotly/validators/scattercarpet/_legendgroup.py deleted file mode 100644 index 7fe82abf9ca..00000000000 --- a/plotly/validators/scattercarpet/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='scattercarpet', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_line.py b/plotly/validators/scattercarpet/_line.py deleted file mode 100644 index 8b8ea80f68d..00000000000 --- a/plotly/validators/scattercarpet/_line.py +++ /dev/null @@ -1,37 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='scattercarpet', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - shape - Determines the line shape. With "spline" the - lines are drawn using spline interpolation. The - other available values correspond to step-wise - line shapes. - smoothing - Has an effect only if `shape` is set to - "spline" Sets the amount of smoothing. 0 - corresponds to no smoothing (equivalent to a - "linear" shape). - width - Sets the line width (in px). -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_marker.py b/plotly/validators/scattercarpet/_marker.py deleted file mode 100644 index 96b211225ea..00000000000 --- a/plotly/validators/scattercarpet/_marker.py +++ /dev/null @@ -1,137 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='scattercarpet', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scattercarpet.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - gradient - plotly.graph_objs.scattercarpet.marker.Gradient - instance or dict with compatible properties - line - plotly.graph_objs.scattercarpet.marker.Line - instance or dict with compatible properties - maxdisplayed - Sets a maximum number of points to be drawn on - the graph. 0 corresponds to no limit. - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_mode.py b/plotly/validators/scattercarpet/_mode.py deleted file mode 100644 index 712bd384051..00000000000 --- a/plotly/validators/scattercarpet/_mode.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='mode', parent_name='scattercarpet', **kwargs - ): - super(ModeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['none']), - flags=kwargs.pop('flags', ['lines', 'markers', 'text']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_name.py b/plotly/validators/scattercarpet/_name.py deleted file mode 100644 index 16506117476..00000000000 --- a/plotly/validators/scattercarpet/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='scattercarpet', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_opacity.py b/plotly/validators/scattercarpet/_opacity.py deleted file mode 100644 index 2a90f735e72..00000000000 --- a/plotly/validators/scattercarpet/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='scattercarpet', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_selected.py b/plotly/validators/scattercarpet/_selected.py deleted file mode 100644 index 16efb9ae396..00000000000 --- a/plotly/validators/scattercarpet/_selected.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='selected', parent_name='scattercarpet', **kwargs - ): - super(SelectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Selected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.scattercarpet.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scattercarpet.selected.Textfo - nt instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_selectedpoints.py b/plotly/validators/scattercarpet/_selectedpoints.py deleted file mode 100644 index 211d5d9748a..00000000000 --- a/plotly/validators/scattercarpet/_selectedpoints.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='selectedpoints', - parent_name='scattercarpet', - **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_showlegend.py b/plotly/validators/scattercarpet/_showlegend.py deleted file mode 100644 index f1e6424b2cb..00000000000 --- a/plotly/validators/scattercarpet/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='scattercarpet', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_stream.py b/plotly/validators/scattercarpet/_stream.py deleted file mode 100644 index d658baee0a8..00000000000 --- a/plotly/validators/scattercarpet/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='scattercarpet', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_text.py b/plotly/validators/scattercarpet/_text.py deleted file mode 100644 index e0bdfe83ef0..00000000000 --- a/plotly/validators/scattercarpet/_text.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='text', parent_name='scattercarpet', **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_textfont.py b/plotly/validators/scattercarpet/_textfont.py deleted file mode 100644 index ed7b3f8a5a6..00000000000 --- a/plotly/validators/scattercarpet/_textfont.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='textfont', parent_name='scattercarpet', **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_textposition.py b/plotly/validators/scattercarpet/_textposition.py deleted file mode 100644 index 36bc5f1dd68..00000000000 --- a/plotly/validators/scattercarpet/_textposition.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='textposition', - parent_name='scattercarpet', - **kwargs - ): - super(TextpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 'top left', 'top center', 'top right', 'middle left', - 'middle center', 'middle right', 'bottom left', - 'bottom center', 'bottom right' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_textpositionsrc.py b/plotly/validators/scattercarpet/_textpositionsrc.py deleted file mode 100644 index 2759b846129..00000000000 --- a/plotly/validators/scattercarpet/_textpositionsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='textpositionsrc', - parent_name='scattercarpet', - **kwargs - ): - super(TextpositionsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_textsrc.py b/plotly/validators/scattercarpet/_textsrc.py deleted file mode 100644 index 48410e12cd2..00000000000 --- a/plotly/validators/scattercarpet/_textsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textsrc', parent_name='scattercarpet', **kwargs - ): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_uid.py b/plotly/validators/scattercarpet/_uid.py deleted file mode 100644 index 1c46b5f9d0a..00000000000 --- a/plotly/validators/scattercarpet/_uid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='uid', parent_name='scattercarpet', **kwargs - ): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_uirevision.py b/plotly/validators/scattercarpet/_uirevision.py deleted file mode 100644 index 670bd0173c1..00000000000 --- a/plotly/validators/scattercarpet/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='scattercarpet', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_unselected.py b/plotly/validators/scattercarpet/_unselected.py deleted file mode 100644 index 4be934c3490..00000000000 --- a/plotly/validators/scattercarpet/_unselected.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='unselected', parent_name='scattercarpet', **kwargs - ): - super(UnselectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Unselected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.scattercarpet.unselected.Mark - er instance or dict with compatible properties - textfont - plotly.graph_objs.scattercarpet.unselected.Text - font instance or dict with compatible - properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_visible.py b/plotly/validators/scattercarpet/_visible.py deleted file mode 100644 index 8ffa675938c..00000000000 --- a/plotly/validators/scattercarpet/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='scattercarpet', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_xaxis.py b/plotly/validators/scattercarpet/_xaxis.py deleted file mode 100644 index 463941fbdbb..00000000000 --- a/plotly/validators/scattercarpet/_xaxis.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='xaxis', parent_name='scattercarpet', **kwargs - ): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/_yaxis.py b/plotly/validators/scattercarpet/_yaxis.py deleted file mode 100644 index 01daea9bc0e..00000000000 --- a/plotly/validators/scattercarpet/_yaxis.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='yaxis', parent_name='scattercarpet', **kwargs - ): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/hoverlabel/__init__.py b/plotly/validators/scattercarpet/hoverlabel/__init__.py index 856f769ba33..06e22885453 100644 --- a/plotly/validators/scattercarpet/hoverlabel/__init__.py +++ b/plotly/validators/scattercarpet/hoverlabel/__init__.py @@ -1,7 +1,176 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='scattercarpet.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='scattercarpet.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='scattercarpet.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='scattercarpet.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scattercarpet.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='scattercarpet.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scattercarpet.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/hoverlabel/_bgcolor.py b/plotly/validators/scattercarpet/hoverlabel/_bgcolor.py deleted file mode 100644 index 715f18bedc9..00000000000 --- a/plotly/validators/scattercarpet/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scattercarpet.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/hoverlabel/_bgcolorsrc.py b/plotly/validators/scattercarpet/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index b0b35d4810a..00000000000 --- a/plotly/validators/scattercarpet/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='scattercarpet.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/hoverlabel/_bordercolor.py b/plotly/validators/scattercarpet/hoverlabel/_bordercolor.py deleted file mode 100644 index 8e86dc6b84c..00000000000 --- a/plotly/validators/scattercarpet/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scattercarpet.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/hoverlabel/_bordercolorsrc.py b/plotly/validators/scattercarpet/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 0cc7dc5fdc7..00000000000 --- a/plotly/validators/scattercarpet/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='scattercarpet.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/hoverlabel/_font.py b/plotly/validators/scattercarpet/hoverlabel/_font.py deleted file mode 100644 index 6aa7eb64a75..00000000000 --- a/plotly/validators/scattercarpet/hoverlabel/_font.py +++ /dev/null @@ -1,50 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='scattercarpet.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/hoverlabel/_namelength.py b/plotly/validators/scattercarpet/hoverlabel/_namelength.py deleted file mode 100644 index fcbeda9b700..00000000000 --- a/plotly/validators/scattercarpet/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='scattercarpet.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/hoverlabel/_namelengthsrc.py b/plotly/validators/scattercarpet/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 882b5dde257..00000000000 --- a/plotly/validators/scattercarpet/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='scattercarpet.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/hoverlabel/font/__init__.py b/plotly/validators/scattercarpet/hoverlabel/font/__init__.py index 1d2c591d1e5..9c38ff1f60f 100644 --- a/plotly/validators/scattercarpet/hoverlabel/font/__init__.py +++ b/plotly/validators/scattercarpet/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scattercarpet.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattercarpet.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='scattercarpet.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scattercarpet.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scattercarpet.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattercarpet.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/hoverlabel/font/_color.py b/plotly/validators/scattercarpet/hoverlabel/font/_color.py deleted file mode 100644 index c1e1f8a0ecb..00000000000 --- a/plotly/validators/scattercarpet/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattercarpet.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/hoverlabel/font/_colorsrc.py b/plotly/validators/scattercarpet/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 4ccda1e19b5..00000000000 --- a/plotly/validators/scattercarpet/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scattercarpet.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/hoverlabel/font/_family.py b/plotly/validators/scattercarpet/hoverlabel/font/_family.py deleted file mode 100644 index b6e760b8d9b..00000000000 --- a/plotly/validators/scattercarpet/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scattercarpet.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/hoverlabel/font/_familysrc.py b/plotly/validators/scattercarpet/hoverlabel/font/_familysrc.py deleted file mode 100644 index 891517ec5cc..00000000000 --- a/plotly/validators/scattercarpet/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='scattercarpet.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/hoverlabel/font/_size.py b/plotly/validators/scattercarpet/hoverlabel/font/_size.py deleted file mode 100644 index f8015496bca..00000000000 --- a/plotly/validators/scattercarpet/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattercarpet.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/hoverlabel/font/_sizesrc.py b/plotly/validators/scattercarpet/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 3b19bbe10fd..00000000000 --- a/plotly/validators/scattercarpet/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scattercarpet.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/line/__init__.py b/plotly/validators/scattercarpet/line/__init__.py index 633e654df05..585cf6f5a6f 100644 --- a/plotly/validators/scattercarpet/line/__init__.py +++ b/plotly/validators/scattercarpet/line/__init__.py @@ -1,5 +1,98 @@ -from ._width import WidthValidator -from ._smoothing import SmoothingValidator -from ._shape import ShapeValidator -from ._dash import DashValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scattercarpet.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='smoothing', + parent_name='scattercarpet.line', + **kwargs + ): + super(SmoothingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 1.3), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShapeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='shape', parent_name='scattercarpet.line', **kwargs + ): + super(ShapeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['linear', 'spline']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashValidator(_plotly_utils.basevalidators.DashValidator): + + def __init__( + self, plotly_name='dash', parent_name='scattercarpet.line', **kwargs + ): + super(DashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scattercarpet.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/line/_color.py b/plotly/validators/scattercarpet/line/_color.py deleted file mode 100644 index 9c53aa166b9..00000000000 --- a/plotly/validators/scattercarpet/line/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scattercarpet.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/line/_dash.py b/plotly/validators/scattercarpet/line/_dash.py deleted file mode 100644 index a2469e36e81..00000000000 --- a/plotly/validators/scattercarpet/line/_dash.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashValidator(_plotly_utils.basevalidators.DashValidator): - - def __init__( - self, plotly_name='dash', parent_name='scattercarpet.line', **kwargs - ): - super(DashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/line/_shape.py b/plotly/validators/scattercarpet/line/_shape.py deleted file mode 100644 index cbcb52b806f..00000000000 --- a/plotly/validators/scattercarpet/line/_shape.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShapeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='shape', parent_name='scattercarpet.line', **kwargs - ): - super(ShapeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['linear', 'spline']), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/line/_smoothing.py b/plotly/validators/scattercarpet/line/_smoothing.py deleted file mode 100644 index 9a55e6c56b2..00000000000 --- a/plotly/validators/scattercarpet/line/_smoothing.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='smoothing', - parent_name='scattercarpet.line', - **kwargs - ): - super(SmoothingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 1.3), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/line/_width.py b/plotly/validators/scattercarpet/line/_width.py deleted file mode 100644 index ee5a9364a2f..00000000000 --- a/plotly/validators/scattercarpet/line/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scattercarpet.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/__init__.py b/plotly/validators/scattercarpet/marker/__init__.py index d137ae66f94..034e701cbd6 100644 --- a/plotly/validators/scattercarpet/marker/__init__.py +++ b/plotly/validators/scattercarpet/marker/__init__.py @@ -1,23 +1,842 @@ -from ._symbolsrc import SymbolsrcValidator -from ._symbol import SymbolValidator -from ._sizesrc import SizesrcValidator -from ._sizeref import SizerefValidator -from ._sizemode import SizemodeValidator -from ._sizemin import SizeminValidator -from ._size import SizeValidator -from ._showscale import ShowscaleValidator -from ._reversescale import ReversescaleValidator -from ._opacitysrc import OpacitysrcValidator -from ._opacity import OpacityValidator -from ._maxdisplayed import MaxdisplayedValidator -from ._line import LineValidator -from ._gradient import GradientValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='symbolsrc', + parent_name='scattercarpet.marker', + **kwargs + ): + super(SymbolsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='symbol', + parent_name='scattercarpet.marker', + **kwargs + ): + super(SymbolValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, + 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', + 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', + 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', + 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', + 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, + 'star-triangle-down-open', 220, 'star-triangle-down-dot', + 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', + 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, + 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, + 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, + 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scattercarpet.marker', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='sizeref', + parent_name='scattercarpet.marker', + **kwargs + ): + super(SizerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='sizemode', + parent_name='scattercarpet.marker', + **kwargs + ): + super(SizemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['diameter', 'area']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='sizemin', + parent_name='scattercarpet.marker', + **kwargs + ): + super(SizeminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='scattercarpet.marker', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showscale', + parent_name='scattercarpet.marker', + **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scattercarpet.marker', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='opacitysrc', + parent_name='scattercarpet.marker', + **kwargs + ): + super(OpacitysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scattercarpet.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxdisplayedValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxdisplayed', + parent_name='scattercarpet.marker', + **kwargs + ): + super(MaxdisplayedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='scattercarpet.marker', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GradientValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='gradient', + parent_name='scattercarpet.marker', + **kwargs + ): + super(GradientValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Gradient'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the final color of the gradient fill: the + center color for radial, the right for + horizontal, or the bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color + . + type + Sets the type of gradient used to fill the + markers + typesrc + Sets the source reference on plot.ly for type + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scattercarpet.marker', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='scattercarpet.marker', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='colorbar', + parent_name='scattercarpet.marker', + **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scattercarpet.marker.colorbar + .Tickformatstop instance or dict with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scattercarpet.marker.colorbar.tickformatstopd + efaults), sets the default property values to + use for elements of + scattercarpet.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scattercarpet.marker.colorbar + .Title instance or dict with compatible + properties + titlefont + Deprecated: Please use + scattercarpet.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. + titleside + Deprecated: Please use + scattercarpet.marker.colorbar.title.side + instead. Determines the location of color bar's + title with respect to the color bar. Note that + the title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattercarpet.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scattercarpet.marker.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='scattercarpet.marker', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='scattercarpet.marker', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='scattercarpet.marker', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='cauto', + parent_name='scattercarpet.marker', + **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scattercarpet.marker', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/marker/_autocolorscale.py b/plotly/validators/scattercarpet/marker/_autocolorscale.py deleted file mode 100644 index e82da856966..00000000000 --- a/plotly/validators/scattercarpet/marker/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scattercarpet.marker', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_cauto.py b/plotly/validators/scattercarpet/marker/_cauto.py deleted file mode 100644 index e1bdcd1d9ed..00000000000 --- a/plotly/validators/scattercarpet/marker/_cauto.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='cauto', - parent_name='scattercarpet.marker', - **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_cmax.py b/plotly/validators/scattercarpet/marker/_cmax.py deleted file mode 100644 index faad54b4946..00000000000 --- a/plotly/validators/scattercarpet/marker/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='scattercarpet.marker', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_cmid.py b/plotly/validators/scattercarpet/marker/_cmid.py deleted file mode 100644 index 69b86e6c6c3..00000000000 --- a/plotly/validators/scattercarpet/marker/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='scattercarpet.marker', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_cmin.py b/plotly/validators/scattercarpet/marker/_cmin.py deleted file mode 100644 index 94cb192fa7b..00000000000 --- a/plotly/validators/scattercarpet/marker/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='scattercarpet.marker', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_color.py b/plotly/validators/scattercarpet/marker/_color.py deleted file mode 100644 index b840123378d..00000000000 --- a/plotly/validators/scattercarpet/marker/_color.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattercarpet.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scattercarpet.marker.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_colorbar.py b/plotly/validators/scattercarpet/marker/_colorbar.py deleted file mode 100644 index ccee121d16a..00000000000 --- a/plotly/validators/scattercarpet/marker/_colorbar.py +++ /dev/null @@ -1,232 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='colorbar', - parent_name='scattercarpet.marker', - **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scattercarpet.marker.colorbar - .Tickformatstop instance or dict with - compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scattercarpet.marker.colorbar.tickformatstopd - efaults), sets the default property values to - use for elements of - scattercarpet.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scattercarpet.marker.colorbar - .Title instance or dict with compatible - properties - titlefont - Deprecated: Please use - scattercarpet.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. - titleside - Deprecated: Please use - scattercarpet.marker.colorbar.title.side - instead. Determines the location of color bar's - title with respect to the color bar. Note that - the title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_colorscale.py b/plotly/validators/scattercarpet/marker/_colorscale.py deleted file mode 100644 index 7caf6ae8e24..00000000000 --- a/plotly/validators/scattercarpet/marker/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='scattercarpet.marker', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_colorsrc.py b/plotly/validators/scattercarpet/marker/_colorsrc.py deleted file mode 100644 index d7e0ba22eb8..00000000000 --- a/plotly/validators/scattercarpet/marker/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scattercarpet.marker', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_gradient.py b/plotly/validators/scattercarpet/marker/_gradient.py deleted file mode 100644 index 8e2f374d8e0..00000000000 --- a/plotly/validators/scattercarpet/marker/_gradient.py +++ /dev/null @@ -1,34 +0,0 @@ -import _plotly_utils.basevalidators - - -class GradientValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='gradient', - parent_name='scattercarpet.marker', - **kwargs - ): - super(GradientValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Gradient'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the final color of the gradient fill: the - center color for radial, the right for - horizontal, or the bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color - . - type - Sets the type of gradient used to fill the - markers - typesrc - Sets the source reference on plot.ly for type - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_line.py b/plotly/validators/scattercarpet/marker/_line.py deleted file mode 100644 index 8ef6fd24626..00000000000 --- a/plotly/validators/scattercarpet/marker/_line.py +++ /dev/null @@ -1,97 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='scattercarpet.marker', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_maxdisplayed.py b/plotly/validators/scattercarpet/marker/_maxdisplayed.py deleted file mode 100644 index cce604163be..00000000000 --- a/plotly/validators/scattercarpet/marker/_maxdisplayed.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxdisplayedValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxdisplayed', - parent_name='scattercarpet.marker', - **kwargs - ): - super(MaxdisplayedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_opacity.py b/plotly/validators/scattercarpet/marker/_opacity.py deleted file mode 100644 index 87ba53b3729..00000000000 --- a/plotly/validators/scattercarpet/marker/_opacity.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scattercarpet.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_opacitysrc.py b/plotly/validators/scattercarpet/marker/_opacitysrc.py deleted file mode 100644 index f3fad9bf761..00000000000 --- a/plotly/validators/scattercarpet/marker/_opacitysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='opacitysrc', - parent_name='scattercarpet.marker', - **kwargs - ): - super(OpacitysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_reversescale.py b/plotly/validators/scattercarpet/marker/_reversescale.py deleted file mode 100644 index d92a5186c00..00000000000 --- a/plotly/validators/scattercarpet/marker/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scattercarpet.marker', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_showscale.py b/plotly/validators/scattercarpet/marker/_showscale.py deleted file mode 100644 index 6855bcce16c..00000000000 --- a/plotly/validators/scattercarpet/marker/_showscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showscale', - parent_name='scattercarpet.marker', - **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_size.py b/plotly/validators/scattercarpet/marker/_size.py deleted file mode 100644 index d0f675d1c80..00000000000 --- a/plotly/validators/scattercarpet/marker/_size.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='scattercarpet.marker', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_sizemin.py b/plotly/validators/scattercarpet/marker/_sizemin.py deleted file mode 100644 index 506ec49ff35..00000000000 --- a/plotly/validators/scattercarpet/marker/_sizemin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='sizemin', - parent_name='scattercarpet.marker', - **kwargs - ): - super(SizeminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_sizemode.py b/plotly/validators/scattercarpet/marker/_sizemode.py deleted file mode 100644 index b751e98236c..00000000000 --- a/plotly/validators/scattercarpet/marker/_sizemode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='sizemode', - parent_name='scattercarpet.marker', - **kwargs - ): - super(SizemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['diameter', 'area']), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_sizeref.py b/plotly/validators/scattercarpet/marker/_sizeref.py deleted file mode 100644 index b2f0c3a4b65..00000000000 --- a/plotly/validators/scattercarpet/marker/_sizeref.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='sizeref', - parent_name='scattercarpet.marker', - **kwargs - ): - super(SizerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_sizesrc.py b/plotly/validators/scattercarpet/marker/_sizesrc.py deleted file mode 100644 index 4312239a57e..00000000000 --- a/plotly/validators/scattercarpet/marker/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scattercarpet.marker', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_symbol.py b/plotly/validators/scattercarpet/marker/_symbol.py deleted file mode 100644 index edf99e637c9..00000000000 --- a/plotly/validators/scattercarpet/marker/_symbol.py +++ /dev/null @@ -1,81 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='symbol', - parent_name='scattercarpet.marker', - **kwargs - ): - super(SymbolValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, - 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', - 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', - 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', - 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', - 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, - 'star-triangle-down-open', 220, 'star-triangle-down-dot', - 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', - 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, - 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, - 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, - 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/_symbolsrc.py b/plotly/validators/scattercarpet/marker/_symbolsrc.py deleted file mode 100644 index 8573f9da75c..00000000000 --- a/plotly/validators/scattercarpet/marker/_symbolsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='symbolsrc', - parent_name='scattercarpet.marker', - **kwargs - ): - super(SymbolsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/__init__.py b/plotly/validators/scattercarpet/marker/colorbar/__init__.py index 3dab31f7e02..aec57f684b3 100644 --- a/plotly/validators/scattercarpet/marker/colorbar/__init__.py +++ b/plotly/validators/scattercarpet/marker/colorbar/__init__.py @@ -1,41 +1,936 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ypad', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='y', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xpad', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='x', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='len', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scattercarpet.marker.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_bgcolor.py b/plotly/validators/scattercarpet/marker/colorbar/_bgcolor.py deleted file mode 100644 index 197558be7ea..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_bordercolor.py b/plotly/validators/scattercarpet/marker/colorbar/_bordercolor.py deleted file mode 100644 index 235974b162e..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_borderwidth.py b/plotly/validators/scattercarpet/marker/colorbar/_borderwidth.py deleted file mode 100644 index af4e96a3e0a..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_dtick.py b/plotly/validators/scattercarpet/marker/colorbar/_dtick.py deleted file mode 100644 index 75d59c741d2..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_exponentformat.py b/plotly/validators/scattercarpet/marker/colorbar/_exponentformat.py deleted file mode 100644 index 2457688961b..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_len.py b/plotly/validators/scattercarpet/marker/colorbar/_len.py deleted file mode 100644 index 1a63444415c..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_len.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='len', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_lenmode.py b/plotly/validators/scattercarpet/marker/colorbar/_lenmode.py deleted file mode 100644 index 7e20574cee3..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_nticks.py b/plotly/validators/scattercarpet/marker/colorbar/_nticks.py deleted file mode 100644 index ea1c0ed10cd..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_outlinecolor.py b/plotly/validators/scattercarpet/marker/colorbar/_outlinecolor.py deleted file mode 100644 index bdd247311e9..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_outlinewidth.py b/plotly/validators/scattercarpet/marker/colorbar/_outlinewidth.py deleted file mode 100644 index 76482ac5737..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_separatethousands.py b/plotly/validators/scattercarpet/marker/colorbar/_separatethousands.py deleted file mode 100644 index 84c9f9a238c..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_showexponent.py b/plotly/validators/scattercarpet/marker/colorbar/_showexponent.py deleted file mode 100644 index 5f2a794a4bc..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_showticklabels.py b/plotly/validators/scattercarpet/marker/colorbar/_showticklabels.py deleted file mode 100644 index d4cdae545a1..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_showtickprefix.py b/plotly/validators/scattercarpet/marker/colorbar/_showtickprefix.py deleted file mode 100644 index 26ab0a37310..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_showticksuffix.py b/plotly/validators/scattercarpet/marker/colorbar/_showticksuffix.py deleted file mode 100644 index 0e6ae585c60..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_thickness.py b/plotly/validators/scattercarpet/marker/colorbar/_thickness.py deleted file mode 100644 index 1d4dfa2938c..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_thicknessmode.py b/plotly/validators/scattercarpet/marker/colorbar/_thicknessmode.py deleted file mode 100644 index f88f33fb4f8..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_tick0.py b/plotly/validators/scattercarpet/marker/colorbar/_tick0.py deleted file mode 100644 index 75302cc5109..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_tickangle.py b/plotly/validators/scattercarpet/marker/colorbar/_tickangle.py deleted file mode 100644 index bf0c3ed98c1..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_tickcolor.py b/plotly/validators/scattercarpet/marker/colorbar/_tickcolor.py deleted file mode 100644 index c45a7b364d7..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_tickfont.py b/plotly/validators/scattercarpet/marker/colorbar/_tickfont.py deleted file mode 100644 index b41f7959cad..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_tickformat.py b/plotly/validators/scattercarpet/marker/colorbar/_tickformat.py deleted file mode 100644 index ace3f580fbf..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_tickformatstopdefaults.py b/plotly/validators/scattercarpet/marker/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 711ea67d50a..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_tickformatstops.py b/plotly/validators/scattercarpet/marker/colorbar/_tickformatstops.py deleted file mode 100644 index 95e8b1370d9..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_ticklen.py b/plotly/validators/scattercarpet/marker/colorbar/_ticklen.py deleted file mode 100644 index ae83f92d376..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_tickmode.py b/plotly/validators/scattercarpet/marker/colorbar/_tickmode.py deleted file mode 100644 index 186ca542ecf..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_tickprefix.py b/plotly/validators/scattercarpet/marker/colorbar/_tickprefix.py deleted file mode 100644 index 493a42e6612..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_ticks.py b/plotly/validators/scattercarpet/marker/colorbar/_ticks.py deleted file mode 100644 index 7fd9bb53615..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_ticksuffix.py b/plotly/validators/scattercarpet/marker/colorbar/_ticksuffix.py deleted file mode 100644 index 9cc90179a3a..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_ticktext.py b/plotly/validators/scattercarpet/marker/colorbar/_ticktext.py deleted file mode 100644 index 9877293cdaf..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_ticktextsrc.py b/plotly/validators/scattercarpet/marker/colorbar/_ticktextsrc.py deleted file mode 100644 index bc754e8e502..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_tickvals.py b/plotly/validators/scattercarpet/marker/colorbar/_tickvals.py deleted file mode 100644 index 52f1f1890be..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_tickvalssrc.py b/plotly/validators/scattercarpet/marker/colorbar/_tickvalssrc.py deleted file mode 100644 index e2197fc4e31..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_tickwidth.py b/plotly/validators/scattercarpet/marker/colorbar/_tickwidth.py deleted file mode 100644 index 5f61c0ce7f7..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_title.py b/plotly/validators/scattercarpet/marker/colorbar/_title.py deleted file mode 100644 index 16eb0fbbe47..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_x.py b/plotly/validators/scattercarpet/marker/colorbar/_x.py deleted file mode 100644 index b0f9c307878..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_x.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='x', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_xanchor.py b/plotly/validators/scattercarpet/marker/colorbar/_xanchor.py deleted file mode 100644 index b1a4b15bb71..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_xpad.py b/plotly/validators/scattercarpet/marker/colorbar/_xpad.py deleted file mode 100644 index c4c2ffad9de..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_xpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xpad', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_y.py b/plotly/validators/scattercarpet/marker/colorbar/_y.py deleted file mode 100644 index 051b6c905be..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_y.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='y', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_yanchor.py b/plotly/validators/scattercarpet/marker/colorbar/_yanchor.py deleted file mode 100644 index fb251a3e158..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/_ypad.py b/plotly/validators/scattercarpet/marker/colorbar/_ypad.py deleted file mode 100644 index dfd991b57eb..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/_ypad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ypad', - parent_name='scattercarpet.marker.colorbar', - **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/tickfont/__init__.py b/plotly/validators/scattercarpet/marker/colorbar/tickfont/__init__.py index 199d72e71c6..1fe9c7bb4da 100644 --- a/plotly/validators/scattercarpet/marker/colorbar/tickfont/__init__.py +++ b/plotly/validators/scattercarpet/marker/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattercarpet.marker.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scattercarpet.marker.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattercarpet.marker.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/tickfont/_color.py b/plotly/validators/scattercarpet/marker/colorbar/tickfont/_color.py deleted file mode 100644 index c3def86eac5..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattercarpet.marker.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/tickfont/_family.py b/plotly/validators/scattercarpet/marker/colorbar/tickfont/_family.py deleted file mode 100644 index 6b9ee69b6a6..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scattercarpet.marker.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/tickfont/_size.py b/plotly/validators/scattercarpet/marker/colorbar/tickfont/_size.py deleted file mode 100644 index f032a8420a0..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattercarpet.marker.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/__init__.py b/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/__init__.py index 3f6c06cac47..4eefcaaefb8 100644 --- a/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='scattercarpet.marker.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='scattercarpet.marker.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='scattercarpet.marker.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='scattercarpet.marker.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='scattercarpet.marker.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 3064679c860..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='scattercarpet.marker.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/_enabled.py b/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index 028d1b969f9..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='scattercarpet.marker.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/_name.py b/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/_name.py deleted file mode 100644 index 0d970784b8c..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='scattercarpet.marker.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 675f415fe33..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='scattercarpet.marker.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/_value.py b/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/_value.py deleted file mode 100644 index d52756be4f5..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='scattercarpet.marker.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/title/__init__.py b/plotly/validators/scattercarpet/marker/colorbar/title/__init__.py index 33c9c145bb8..5133bfb9237 100644 --- a/plotly/validators/scattercarpet/marker/colorbar/title/__init__.py +++ b/plotly/validators/scattercarpet/marker/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='scattercarpet.marker.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='scattercarpet.marker.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='scattercarpet.marker.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/title/_font.py b/plotly/validators/scattercarpet/marker/colorbar/title/_font.py deleted file mode 100644 index 8241e6d75cc..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='scattercarpet.marker.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/title/_side.py b/plotly/validators/scattercarpet/marker/colorbar/title/_side.py deleted file mode 100644 index 4f990b1bf44..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='scattercarpet.marker.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/title/_text.py b/plotly/validators/scattercarpet/marker/colorbar/title/_text.py deleted file mode 100644 index ea6d63d97b9..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='scattercarpet.marker.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/title/font/__init__.py b/plotly/validators/scattercarpet/marker/colorbar/title/font/__init__.py index 199d72e71c6..12281b3b886 100644 --- a/plotly/validators/scattercarpet/marker/colorbar/title/font/__init__.py +++ b/plotly/validators/scattercarpet/marker/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattercarpet.marker.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scattercarpet.marker.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattercarpet.marker.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/title/font/_color.py b/plotly/validators/scattercarpet/marker/colorbar/title/font/_color.py deleted file mode 100644 index f501d3ee78d..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattercarpet.marker.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/title/font/_family.py b/plotly/validators/scattercarpet/marker/colorbar/title/font/_family.py deleted file mode 100644 index 8608f9343df..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scattercarpet.marker.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/colorbar/title/font/_size.py b/plotly/validators/scattercarpet/marker/colorbar/title/font/_size.py deleted file mode 100644 index 778e62e25ae..00000000000 --- a/plotly/validators/scattercarpet/marker/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattercarpet.marker.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/gradient/__init__.py b/plotly/validators/scattercarpet/marker/gradient/__init__.py index 434557c8fea..0acad4d6f5c 100644 --- a/plotly/validators/scattercarpet/marker/gradient/__init__.py +++ b/plotly/validators/scattercarpet/marker/gradient/__init__.py @@ -1,4 +1,85 @@ -from ._typesrc import TypesrcValidator -from ._type import TypeValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class TypesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='typesrc', + parent_name='scattercarpet.marker.gradient', + **kwargs + ): + super(TypesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='type', + parent_name='scattercarpet.marker.gradient', + **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['radial', 'horizontal', 'vertical', 'none'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scattercarpet.marker.gradient', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattercarpet.marker.gradient', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/marker/gradient/_color.py b/plotly/validators/scattercarpet/marker/gradient/_color.py deleted file mode 100644 index 934990df0a4..00000000000 --- a/plotly/validators/scattercarpet/marker/gradient/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattercarpet.marker.gradient', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/gradient/_colorsrc.py b/plotly/validators/scattercarpet/marker/gradient/_colorsrc.py deleted file mode 100644 index 9212bb17583..00000000000 --- a/plotly/validators/scattercarpet/marker/gradient/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scattercarpet.marker.gradient', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/gradient/_type.py b/plotly/validators/scattercarpet/marker/gradient/_type.py deleted file mode 100644 index a8ee74aa860..00000000000 --- a/plotly/validators/scattercarpet/marker/gradient/_type.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='type', - parent_name='scattercarpet.marker.gradient', - **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['radial', 'horizontal', 'vertical', 'none'] - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/gradient/_typesrc.py b/plotly/validators/scattercarpet/marker/gradient/_typesrc.py deleted file mode 100644 index b3f505316e2..00000000000 --- a/plotly/validators/scattercarpet/marker/gradient/_typesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='typesrc', - parent_name='scattercarpet.marker.gradient', - **kwargs - ): - super(TypesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/line/__init__.py b/plotly/validators/scattercarpet/marker/line/__init__.py index c031ca61ce2..4665a5e042a 100644 --- a/plotly/validators/scattercarpet/marker/line/__init__.py +++ b/plotly/validators/scattercarpet/marker/line/__init__.py @@ -1,11 +1,235 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._reversescale import ReversescaleValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='widthsrc', + parent_name='scattercarpet.marker.line', + **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='scattercarpet.marker.line', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scattercarpet.marker.line', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scattercarpet.marker.line', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='scattercarpet.marker.line', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattercarpet.marker.line', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scattercarpet.marker.line.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmin', + parent_name='scattercarpet.marker.line', + **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmid', + parent_name='scattercarpet.marker.line', + **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmax', + parent_name='scattercarpet.marker.line', + **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='cauto', + parent_name='scattercarpet.marker.line', + **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scattercarpet.marker.line', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/marker/line/_autocolorscale.py b/plotly/validators/scattercarpet/marker/line/_autocolorscale.py deleted file mode 100644 index c0f6a91a3c4..00000000000 --- a/plotly/validators/scattercarpet/marker/line/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scattercarpet.marker.line', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/line/_cauto.py b/plotly/validators/scattercarpet/marker/line/_cauto.py deleted file mode 100644 index 9f0096ca22f..00000000000 --- a/plotly/validators/scattercarpet/marker/line/_cauto.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='cauto', - parent_name='scattercarpet.marker.line', - **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/line/_cmax.py b/plotly/validators/scattercarpet/marker/line/_cmax.py deleted file mode 100644 index ea0b97f1e4e..00000000000 --- a/plotly/validators/scattercarpet/marker/line/_cmax.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmax', - parent_name='scattercarpet.marker.line', - **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/line/_cmid.py b/plotly/validators/scattercarpet/marker/line/_cmid.py deleted file mode 100644 index 893177ffe55..00000000000 --- a/plotly/validators/scattercarpet/marker/line/_cmid.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmid', - parent_name='scattercarpet.marker.line', - **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/line/_cmin.py b/plotly/validators/scattercarpet/marker/line/_cmin.py deleted file mode 100644 index 8227d0622fa..00000000000 --- a/plotly/validators/scattercarpet/marker/line/_cmin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmin', - parent_name='scattercarpet.marker.line', - **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/line/_color.py b/plotly/validators/scattercarpet/marker/line/_color.py deleted file mode 100644 index 550e108902c..00000000000 --- a/plotly/validators/scattercarpet/marker/line/_color.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattercarpet.marker.line', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scattercarpet.marker.line.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/line/_colorscale.py b/plotly/validators/scattercarpet/marker/line/_colorscale.py deleted file mode 100644 index f22f95b2189..00000000000 --- a/plotly/validators/scattercarpet/marker/line/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='scattercarpet.marker.line', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/line/_colorsrc.py b/plotly/validators/scattercarpet/marker/line/_colorsrc.py deleted file mode 100644 index 10ba45f9d9c..00000000000 --- a/plotly/validators/scattercarpet/marker/line/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scattercarpet.marker.line', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/line/_reversescale.py b/plotly/validators/scattercarpet/marker/line/_reversescale.py deleted file mode 100644 index 6bb0be84554..00000000000 --- a/plotly/validators/scattercarpet/marker/line/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scattercarpet.marker.line', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/line/_width.py b/plotly/validators/scattercarpet/marker/line/_width.py deleted file mode 100644 index de11e8295e5..00000000000 --- a/plotly/validators/scattercarpet/marker/line/_width.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='scattercarpet.marker.line', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/marker/line/_widthsrc.py b/plotly/validators/scattercarpet/marker/line/_widthsrc.py deleted file mode 100644 index 4b3549db66f..00000000000 --- a/plotly/validators/scattercarpet/marker/line/_widthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='widthsrc', - parent_name='scattercarpet.marker.line', - **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/selected/__init__.py b/plotly/validators/scattercarpet/selected/__init__.py index f1a1ef3742f..31890f976b4 100644 --- a/plotly/validators/scattercarpet/selected/__init__.py +++ b/plotly/validators/scattercarpet/selected/__init__.py @@ -1,2 +1,54 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='scattercarpet.selected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of selected points. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='scattercarpet.selected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/selected/_marker.py b/plotly/validators/scattercarpet/selected/_marker.py deleted file mode 100644 index 7b31965b0e3..00000000000 --- a/plotly/validators/scattercarpet/selected/_marker.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='scattercarpet.selected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/selected/_textfont.py b/plotly/validators/scattercarpet/selected/_textfont.py deleted file mode 100644 index 283715a5842..00000000000 --- a/plotly/validators/scattercarpet/selected/_textfont.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='scattercarpet.selected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/selected/marker/__init__.py b/plotly/validators/scattercarpet/selected/marker/__init__.py index ed9a9070947..67542f2ea7f 100644 --- a/plotly/validators/scattercarpet/selected/marker/__init__.py +++ b/plotly/validators/scattercarpet/selected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattercarpet.selected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scattercarpet.selected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattercarpet.selected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/selected/marker/_color.py b/plotly/validators/scattercarpet/selected/marker/_color.py deleted file mode 100644 index 856de213813..00000000000 --- a/plotly/validators/scattercarpet/selected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattercarpet.selected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/selected/marker/_opacity.py b/plotly/validators/scattercarpet/selected/marker/_opacity.py deleted file mode 100644 index c3a0d7d9d46..00000000000 --- a/plotly/validators/scattercarpet/selected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scattercarpet.selected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/selected/marker/_size.py b/plotly/validators/scattercarpet/selected/marker/_size.py deleted file mode 100644 index ccfdeee9108..00000000000 --- a/plotly/validators/scattercarpet/selected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattercarpet.selected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/selected/textfont/__init__.py b/plotly/validators/scattercarpet/selected/textfont/__init__.py index 74135b3f315..e7785e1942d 100644 --- a/plotly/validators/scattercarpet/selected/textfont/__init__.py +++ b/plotly/validators/scattercarpet/selected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattercarpet.selected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/selected/textfont/_color.py b/plotly/validators/scattercarpet/selected/textfont/_color.py deleted file mode 100644 index 4613468a752..00000000000 --- a/plotly/validators/scattercarpet/selected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattercarpet.selected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/stream/__init__.py b/plotly/validators/scattercarpet/stream/__init__.py index 2f4f2047594..1c3f7b58800 100644 --- a/plotly/validators/scattercarpet/stream/__init__.py +++ b/plotly/validators/scattercarpet/stream/__init__.py @@ -1,2 +1,44 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='token', + parent_name='scattercarpet.stream', + **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='scattercarpet.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/stream/_maxpoints.py b/plotly/validators/scattercarpet/stream/_maxpoints.py deleted file mode 100644 index 89a3a0cb6e6..00000000000 --- a/plotly/validators/scattercarpet/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='scattercarpet.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/stream/_token.py b/plotly/validators/scattercarpet/stream/_token.py deleted file mode 100644 index 29b0562127b..00000000000 --- a/plotly/validators/scattercarpet/stream/_token.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='token', - parent_name='scattercarpet.stream', - **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/textfont/__init__.py b/plotly/validators/scattercarpet/textfont/__init__.py index 1d2c591d1e5..31815266d63 100644 --- a/plotly/validators/scattercarpet/textfont/__init__.py +++ b/plotly/validators/scattercarpet/textfont/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scattercarpet.textfont', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattercarpet.textfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='scattercarpet.textfont', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scattercarpet.textfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scattercarpet.textfont', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattercarpet.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/textfont/_color.py b/plotly/validators/scattercarpet/textfont/_color.py deleted file mode 100644 index d46e7322fa9..00000000000 --- a/plotly/validators/scattercarpet/textfont/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattercarpet.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/textfont/_colorsrc.py b/plotly/validators/scattercarpet/textfont/_colorsrc.py deleted file mode 100644 index 23994fb60b1..00000000000 --- a/plotly/validators/scattercarpet/textfont/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scattercarpet.textfont', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/textfont/_family.py b/plotly/validators/scattercarpet/textfont/_family.py deleted file mode 100644 index 4bf20d47426..00000000000 --- a/plotly/validators/scattercarpet/textfont/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scattercarpet.textfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/textfont/_familysrc.py b/plotly/validators/scattercarpet/textfont/_familysrc.py deleted file mode 100644 index 2c63a3a0e05..00000000000 --- a/plotly/validators/scattercarpet/textfont/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='scattercarpet.textfont', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/textfont/_size.py b/plotly/validators/scattercarpet/textfont/_size.py deleted file mode 100644 index fa9d328a1b1..00000000000 --- a/plotly/validators/scattercarpet/textfont/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattercarpet.textfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/textfont/_sizesrc.py b/plotly/validators/scattercarpet/textfont/_sizesrc.py deleted file mode 100644 index 2a9f8426991..00000000000 --- a/plotly/validators/scattercarpet/textfont/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scattercarpet.textfont', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/unselected/__init__.py b/plotly/validators/scattercarpet/unselected/__init__.py index f1a1ef3742f..d4e61a676b5 100644 --- a/plotly/validators/scattercarpet/unselected/__init__.py +++ b/plotly/validators/scattercarpet/unselected/__init__.py @@ -1,2 +1,58 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='scattercarpet.unselected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='scattercarpet.unselected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of unselected points, + applied only when a selection exists. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/unselected/_marker.py b/plotly/validators/scattercarpet/unselected/_marker.py deleted file mode 100644 index d72371d701c..00000000000 --- a/plotly/validators/scattercarpet/unselected/_marker.py +++ /dev/null @@ -1,30 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='scattercarpet.unselected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of unselected points, - applied only when a selection exists. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/unselected/_textfont.py b/plotly/validators/scattercarpet/unselected/_textfont.py deleted file mode 100644 index 27f673d7657..00000000000 --- a/plotly/validators/scattercarpet/unselected/_textfont.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='scattercarpet.unselected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/unselected/marker/__init__.py b/plotly/validators/scattercarpet/unselected/marker/__init__.py index ed9a9070947..efe3200df44 100644 --- a/plotly/validators/scattercarpet/unselected/marker/__init__.py +++ b/plotly/validators/scattercarpet/unselected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattercarpet.unselected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scattercarpet.unselected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattercarpet.unselected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/unselected/marker/_color.py b/plotly/validators/scattercarpet/unselected/marker/_color.py deleted file mode 100644 index 13bf09f764d..00000000000 --- a/plotly/validators/scattercarpet/unselected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattercarpet.unselected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/unselected/marker/_opacity.py b/plotly/validators/scattercarpet/unselected/marker/_opacity.py deleted file mode 100644 index 24dd0c12955..00000000000 --- a/plotly/validators/scattercarpet/unselected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scattercarpet.unselected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/unselected/marker/_size.py b/plotly/validators/scattercarpet/unselected/marker/_size.py deleted file mode 100644 index 23462e85561..00000000000 --- a/plotly/validators/scattercarpet/unselected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattercarpet.unselected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattercarpet/unselected/textfont/__init__.py b/plotly/validators/scattercarpet/unselected/textfont/__init__.py index 74135b3f315..d73aac6bf06 100644 --- a/plotly/validators/scattercarpet/unselected/textfont/__init__.py +++ b/plotly/validators/scattercarpet/unselected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattercarpet.unselected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattercarpet/unselected/textfont/_color.py b/plotly/validators/scattercarpet/unselected/textfont/_color.py deleted file mode 100644 index d3c49341c15..00000000000 --- a/plotly/validators/scattercarpet/unselected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattercarpet.unselected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/__init__.py b/plotly/validators/scattergeo/__init__.py index 055537ce9e9..50fc52bb95d 100644 --- a/plotly/validators/scattergeo/__init__.py +++ b/plotly/validators/scattergeo/__init__.py @@ -1,41 +1,934 @@ -from ._visible import VisibleValidator -from ._unselected import UnselectedValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textsrc import TextsrcValidator -from ._textpositionsrc import TextpositionsrcValidator -from ._textposition import TextpositionValidator -from ._textfont import TextfontValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._selected import SelectedValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._mode import ModeValidator -from ._marker import MarkerValidator -from ._lonsrc import LonsrcValidator -from ._lon import LonValidator -from ._locationssrc import LocationssrcValidator -from ._locations import LocationsValidator -from ._locationmode import LocationmodeValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._latsrc import LatsrcValidator -from ._lat import LatValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._geo import GeoValidator -from ._fillcolor import FillcolorValidator -from ._fill import FillValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._connectgaps import ConnectgapsValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='scattergeo', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='unselected', parent_name='scattergeo', **kwargs + ): + super(UnselectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Unselected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.scattergeo.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scattergeo.unselected.Textfon + t instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='scattergeo', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='scattergeo', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textsrc', parent_name='scattergeo', **kwargs + ): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='textpositionsrc', + parent_name='scattergeo', + **kwargs + ): + super(TextpositionsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='textposition', parent_name='scattergeo', **kwargs + ): + super(TextpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 'top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', + 'bottom center', 'bottom right' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='textfont', parent_name='scattergeo', **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='scattergeo', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='scattergeo', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='scattergeo', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='scattergeo', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='selected', parent_name='scattergeo', **kwargs + ): + super(SelectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Selected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.scattergeo.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scattergeo.selected.Textfont + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='scattergeo', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='scattergeo', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__(self, plotly_name='mode', parent_name='scattergeo', **kwargs): + super(ModeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['none']), + flags=kwargs.pop('flags', ['lines', 'markers', 'text']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='scattergeo', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scattergeo.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + gradient + plotly.graph_objs.scattergeo.marker.Gradient + instance or dict with compatible properties + line + plotly.graph_objs.scattergeo.marker.Line + instance or dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LonsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='lonsrc', parent_name='scattergeo', **kwargs + ): + super(LonsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LonValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='lon', parent_name='scattergeo', **kwargs): + super(LonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LocationssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='locationssrc', parent_name='scattergeo', **kwargs + ): + super(LocationssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LocationsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='locations', parent_name='scattergeo', **kwargs + ): + super(LocationsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LocationmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='locationmode', parent_name='scattergeo', **kwargs + ): + super(LocationmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['ISO-3', 'USA-states', 'country names'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='line', parent_name='scattergeo', **kwargs): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + width + Sets the line width (in px). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='scattergeo', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LatsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='latsrc', parent_name='scattergeo', **kwargs + ): + super(LatsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LatValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='lat', parent_name='scattergeo', **kwargs): + super(LatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='scattergeo', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='scattergeo', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='scattergeo', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='scattergeo', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertemplatesrc', + parent_name='scattergeo', + **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='scattergeo', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='scattergeo', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='scattergeo', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='scattergeo', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop( + 'flags', ['lon', 'lat', 'location', 'text', 'name'] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GeoValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='geo', parent_name='scattergeo', **kwargs): + super(GeoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'geo'), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='fillcolor', parent_name='scattergeo', **kwargs + ): + super(FillcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='fill', parent_name='scattergeo', **kwargs): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['none', 'toself']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='scattergeo', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='scattergeo', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='connectgaps', parent_name='scattergeo', **kwargs + ): + super(ConnectgapsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/_connectgaps.py b/plotly/validators/scattergeo/_connectgaps.py deleted file mode 100644 index 4631b5661c0..00000000000 --- a/plotly/validators/scattergeo/_connectgaps.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='connectgaps', parent_name='scattergeo', **kwargs - ): - super(ConnectgapsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_customdata.py b/plotly/validators/scattergeo/_customdata.py deleted file mode 100644 index 892927d0190..00000000000 --- a/plotly/validators/scattergeo/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='scattergeo', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_customdatasrc.py b/plotly/validators/scattergeo/_customdatasrc.py deleted file mode 100644 index e9afe07313a..00000000000 --- a/plotly/validators/scattergeo/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='scattergeo', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_fill.py b/plotly/validators/scattergeo/_fill.py deleted file mode 100644 index 86ac21d3393..00000000000 --- a/plotly/validators/scattergeo/_fill.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='fill', parent_name='scattergeo', **kwargs): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['none', 'toself']), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_fillcolor.py b/plotly/validators/scattergeo/_fillcolor.py deleted file mode 100644 index 1983f35f352..00000000000 --- a/plotly/validators/scattergeo/_fillcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='fillcolor', parent_name='scattergeo', **kwargs - ): - super(FillcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_geo.py b/plotly/validators/scattergeo/_geo.py deleted file mode 100644 index 18d4225758f..00000000000 --- a/plotly/validators/scattergeo/_geo.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class GeoValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='geo', parent_name='scattergeo', **kwargs): - super(GeoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'geo'), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_hoverinfo.py b/plotly/validators/scattergeo/_hoverinfo.py deleted file mode 100644 index c1133029db5..00000000000 --- a/plotly/validators/scattergeo/_hoverinfo.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='scattergeo', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop( - 'flags', ['lon', 'lat', 'location', 'text', 'name'] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_hoverinfosrc.py b/plotly/validators/scattergeo/_hoverinfosrc.py deleted file mode 100644 index 1e42278cd4b..00000000000 --- a/plotly/validators/scattergeo/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='scattergeo', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_hoverlabel.py b/plotly/validators/scattergeo/_hoverlabel.py deleted file mode 100644 index 39aeead97ee..00000000000 --- a/plotly/validators/scattergeo/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='scattergeo', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_hovertemplate.py b/plotly/validators/scattergeo/_hovertemplate.py deleted file mode 100644 index b22b03b81f7..00000000000 --- a/plotly/validators/scattergeo/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='scattergeo', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_hovertemplatesrc.py b/plotly/validators/scattergeo/_hovertemplatesrc.py deleted file mode 100644 index 0c1b40a5645..00000000000 --- a/plotly/validators/scattergeo/_hovertemplatesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertemplatesrc', - parent_name='scattergeo', - **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_hovertext.py b/plotly/validators/scattergeo/_hovertext.py deleted file mode 100644 index b5785a68b8b..00000000000 --- a/plotly/validators/scattergeo/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='scattergeo', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_hovertextsrc.py b/plotly/validators/scattergeo/_hovertextsrc.py deleted file mode 100644 index 8d1d2e7542d..00000000000 --- a/plotly/validators/scattergeo/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='scattergeo', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_ids.py b/plotly/validators/scattergeo/_ids.py deleted file mode 100644 index aa112cfe7b6..00000000000 --- a/plotly/validators/scattergeo/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='scattergeo', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_idssrc.py b/plotly/validators/scattergeo/_idssrc.py deleted file mode 100644 index 15f87693fcd..00000000000 --- a/plotly/validators/scattergeo/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='scattergeo', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_lat.py b/plotly/validators/scattergeo/_lat.py deleted file mode 100644 index b461162a91b..00000000000 --- a/plotly/validators/scattergeo/_lat.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class LatValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='lat', parent_name='scattergeo', **kwargs): - super(LatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_latsrc.py b/plotly/validators/scattergeo/_latsrc.py deleted file mode 100644 index eed045d42ba..00000000000 --- a/plotly/validators/scattergeo/_latsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LatsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='latsrc', parent_name='scattergeo', **kwargs - ): - super(LatsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_legendgroup.py b/plotly/validators/scattergeo/_legendgroup.py deleted file mode 100644 index ea34c731910..00000000000 --- a/plotly/validators/scattergeo/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='scattergeo', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_line.py b/plotly/validators/scattergeo/_line.py deleted file mode 100644 index ce79bb54fd7..00000000000 --- a/plotly/validators/scattergeo/_line.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='line', parent_name='scattergeo', **kwargs): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - width - Sets the line width (in px). -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_locationmode.py b/plotly/validators/scattergeo/_locationmode.py deleted file mode 100644 index 6851b3d8628..00000000000 --- a/plotly/validators/scattergeo/_locationmode.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LocationmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='locationmode', parent_name='scattergeo', **kwargs - ): - super(LocationmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['ISO-3', 'USA-states', 'country names'] - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_locations.py b/plotly/validators/scattergeo/_locations.py deleted file mode 100644 index 319be85a421..00000000000 --- a/plotly/validators/scattergeo/_locations.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LocationsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='locations', parent_name='scattergeo', **kwargs - ): - super(LocationsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_locationssrc.py b/plotly/validators/scattergeo/_locationssrc.py deleted file mode 100644 index b3c6d5dbc77..00000000000 --- a/plotly/validators/scattergeo/_locationssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LocationssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='locationssrc', parent_name='scattergeo', **kwargs - ): - super(LocationssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_lon.py b/plotly/validators/scattergeo/_lon.py deleted file mode 100644 index 3d575c77572..00000000000 --- a/plotly/validators/scattergeo/_lon.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class LonValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='lon', parent_name='scattergeo', **kwargs): - super(LonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_lonsrc.py b/plotly/validators/scattergeo/_lonsrc.py deleted file mode 100644 index 82124ef923f..00000000000 --- a/plotly/validators/scattergeo/_lonsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LonsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='lonsrc', parent_name='scattergeo', **kwargs - ): - super(LonsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_marker.py b/plotly/validators/scattergeo/_marker.py deleted file mode 100644 index 65e2c326fbb..00000000000 --- a/plotly/validators/scattergeo/_marker.py +++ /dev/null @@ -1,134 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='scattergeo', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scattergeo.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - gradient - plotly.graph_objs.scattergeo.marker.Gradient - instance or dict with compatible properties - line - plotly.graph_objs.scattergeo.marker.Line - instance or dict with compatible properties - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_mode.py b/plotly/validators/scattergeo/_mode.py deleted file mode 100644 index bb56b84182a..00000000000 --- a/plotly/validators/scattergeo/_mode.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__(self, plotly_name='mode', parent_name='scattergeo', **kwargs): - super(ModeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['none']), - flags=kwargs.pop('flags', ['lines', 'markers', 'text']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_name.py b/plotly/validators/scattergeo/_name.py deleted file mode 100644 index 7ff58e8669c..00000000000 --- a/plotly/validators/scattergeo/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='scattergeo', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_opacity.py b/plotly/validators/scattergeo/_opacity.py deleted file mode 100644 index b32a3f96c5d..00000000000 --- a/plotly/validators/scattergeo/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='scattergeo', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_selected.py b/plotly/validators/scattergeo/_selected.py deleted file mode 100644 index f3b988ffb75..00000000000 --- a/plotly/validators/scattergeo/_selected.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='selected', parent_name='scattergeo', **kwargs - ): - super(SelectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Selected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.scattergeo.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scattergeo.selected.Textfont - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_selectedpoints.py b/plotly/validators/scattergeo/_selectedpoints.py deleted file mode 100644 index fb32912b401..00000000000 --- a/plotly/validators/scattergeo/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='scattergeo', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_showlegend.py b/plotly/validators/scattergeo/_showlegend.py deleted file mode 100644 index 9957a80b848..00000000000 --- a/plotly/validators/scattergeo/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='scattergeo', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_stream.py b/plotly/validators/scattergeo/_stream.py deleted file mode 100644 index d8f30251c40..00000000000 --- a/plotly/validators/scattergeo/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='scattergeo', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_text.py b/plotly/validators/scattergeo/_text.py deleted file mode 100644 index 8b02c824a87..00000000000 --- a/plotly/validators/scattergeo/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='scattergeo', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_textfont.py b/plotly/validators/scattergeo/_textfont.py deleted file mode 100644 index 5583f48a5b6..00000000000 --- a/plotly/validators/scattergeo/_textfont.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='textfont', parent_name='scattergeo', **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_textposition.py b/plotly/validators/scattergeo/_textposition.py deleted file mode 100644 index 37d749102a6..00000000000 --- a/plotly/validators/scattergeo/_textposition.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='textposition', parent_name='scattergeo', **kwargs - ): - super(TextpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 'top left', 'top center', 'top right', 'middle left', - 'middle center', 'middle right', 'bottom left', - 'bottom center', 'bottom right' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_textpositionsrc.py b/plotly/validators/scattergeo/_textpositionsrc.py deleted file mode 100644 index 410804d2156..00000000000 --- a/plotly/validators/scattergeo/_textpositionsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='textpositionsrc', - parent_name='scattergeo', - **kwargs - ): - super(TextpositionsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_textsrc.py b/plotly/validators/scattergeo/_textsrc.py deleted file mode 100644 index 6552b64ef3c..00000000000 --- a/plotly/validators/scattergeo/_textsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textsrc', parent_name='scattergeo', **kwargs - ): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_uid.py b/plotly/validators/scattergeo/_uid.py deleted file mode 100644 index 5a553291ff3..00000000000 --- a/plotly/validators/scattergeo/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='scattergeo', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_uirevision.py b/plotly/validators/scattergeo/_uirevision.py deleted file mode 100644 index a5bc00d03a6..00000000000 --- a/plotly/validators/scattergeo/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='scattergeo', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_unselected.py b/plotly/validators/scattergeo/_unselected.py deleted file mode 100644 index d9a42c3c600..00000000000 --- a/plotly/validators/scattergeo/_unselected.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='unselected', parent_name='scattergeo', **kwargs - ): - super(UnselectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Unselected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.scattergeo.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scattergeo.unselected.Textfon - t instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/_visible.py b/plotly/validators/scattergeo/_visible.py deleted file mode 100644 index e9acd850759..00000000000 --- a/plotly/validators/scattergeo/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='scattergeo', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/scattergeo/hoverlabel/__init__.py b/plotly/validators/scattergeo/hoverlabel/__init__.py index 856f769ba33..d6b6fb8fdde 100644 --- a/plotly/validators/scattergeo/hoverlabel/__init__.py +++ b/plotly/validators/scattergeo/hoverlabel/__init__.py @@ -1,7 +1,176 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='scattergeo.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='scattergeo.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='scattergeo.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='scattergeo.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scattergeo.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='scattergeo.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scattergeo.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/hoverlabel/_bgcolor.py b/plotly/validators/scattergeo/hoverlabel/_bgcolor.py deleted file mode 100644 index c9fbd2e3410..00000000000 --- a/plotly/validators/scattergeo/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scattergeo.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/hoverlabel/_bgcolorsrc.py b/plotly/validators/scattergeo/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 2c86d490036..00000000000 --- a/plotly/validators/scattergeo/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='scattergeo.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/hoverlabel/_bordercolor.py b/plotly/validators/scattergeo/hoverlabel/_bordercolor.py deleted file mode 100644 index caf774eefd9..00000000000 --- a/plotly/validators/scattergeo/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scattergeo.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/hoverlabel/_bordercolorsrc.py b/plotly/validators/scattergeo/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index c87523d2ddf..00000000000 --- a/plotly/validators/scattergeo/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='scattergeo.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/hoverlabel/_font.py b/plotly/validators/scattergeo/hoverlabel/_font.py deleted file mode 100644 index df0794b23f7..00000000000 --- a/plotly/validators/scattergeo/hoverlabel/_font.py +++ /dev/null @@ -1,50 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='scattergeo.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/hoverlabel/_namelength.py b/plotly/validators/scattergeo/hoverlabel/_namelength.py deleted file mode 100644 index d772f6440a1..00000000000 --- a/plotly/validators/scattergeo/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='scattergeo.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/hoverlabel/_namelengthsrc.py b/plotly/validators/scattergeo/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 2732b333cec..00000000000 --- a/plotly/validators/scattergeo/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='scattergeo.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/hoverlabel/font/__init__.py b/plotly/validators/scattergeo/hoverlabel/font/__init__.py index 1d2c591d1e5..691c569dd48 100644 --- a/plotly/validators/scattergeo/hoverlabel/font/__init__.py +++ b/plotly/validators/scattergeo/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scattergeo.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattergeo.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='scattergeo.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scattergeo.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scattergeo.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergeo.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/hoverlabel/font/_color.py b/plotly/validators/scattergeo/hoverlabel/font/_color.py deleted file mode 100644 index 4c2a69cc6ce..00000000000 --- a/plotly/validators/scattergeo/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergeo.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/hoverlabel/font/_colorsrc.py b/plotly/validators/scattergeo/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 585fddcca73..00000000000 --- a/plotly/validators/scattergeo/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scattergeo.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/hoverlabel/font/_family.py b/plotly/validators/scattergeo/hoverlabel/font/_family.py deleted file mode 100644 index 5123c365792..00000000000 --- a/plotly/validators/scattergeo/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scattergeo.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattergeo/hoverlabel/font/_familysrc.py b/plotly/validators/scattergeo/hoverlabel/font/_familysrc.py deleted file mode 100644 index c77cb405e84..00000000000 --- a/plotly/validators/scattergeo/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='scattergeo.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/hoverlabel/font/_size.py b/plotly/validators/scattergeo/hoverlabel/font/_size.py deleted file mode 100644 index 1e126771137..00000000000 --- a/plotly/validators/scattergeo/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattergeo.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/hoverlabel/font/_sizesrc.py b/plotly/validators/scattergeo/hoverlabel/font/_sizesrc.py deleted file mode 100644 index fdf9465c17e..00000000000 --- a/plotly/validators/scattergeo/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scattergeo.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/line/__init__.py b/plotly/validators/scattergeo/line/__init__.py index d027d05e065..c3885cb76e6 100644 --- a/plotly/validators/scattergeo/line/__init__.py +++ b/plotly/validators/scattergeo/line/__init__.py @@ -1,3 +1,58 @@ -from ._width import WidthValidator -from ._dash import DashValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scattergeo.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashValidator(_plotly_utils.basevalidators.DashValidator): + + def __init__( + self, plotly_name='dash', parent_name='scattergeo.line', **kwargs + ): + super(DashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scattergeo.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/line/_color.py b/plotly/validators/scattergeo/line/_color.py deleted file mode 100644 index fc4f1d87e00..00000000000 --- a/plotly/validators/scattergeo/line/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scattergeo.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/line/_dash.py b/plotly/validators/scattergeo/line/_dash.py deleted file mode 100644 index 9265372a653..00000000000 --- a/plotly/validators/scattergeo/line/_dash.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashValidator(_plotly_utils.basevalidators.DashValidator): - - def __init__( - self, plotly_name='dash', parent_name='scattergeo.line', **kwargs - ): - super(DashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/line/_width.py b/plotly/validators/scattergeo/line/_width.py deleted file mode 100644 index 9c4569dffd5..00000000000 --- a/plotly/validators/scattergeo/line/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scattergeo.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/__init__.py b/plotly/validators/scattergeo/marker/__init__.py index 3552efc04c8..fc3f353f1e2 100644 --- a/plotly/validators/scattergeo/marker/__init__.py +++ b/plotly/validators/scattergeo/marker/__init__.py @@ -1,22 +1,799 @@ -from ._symbolsrc import SymbolsrcValidator -from ._symbol import SymbolValidator -from ._sizesrc import SizesrcValidator -from ._sizeref import SizerefValidator -from ._sizemode import SizemodeValidator -from ._sizemin import SizeminValidator -from ._size import SizeValidator -from ._showscale import ShowscaleValidator -from ._reversescale import ReversescaleValidator -from ._opacitysrc import OpacitysrcValidator -from ._opacity import OpacityValidator -from ._line import LineValidator -from ._gradient import GradientValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='symbolsrc', + parent_name='scattergeo.marker', + **kwargs + ): + super(SymbolsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='symbol', parent_name='scattergeo.marker', **kwargs + ): + super(SymbolValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, + 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', + 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', + 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', + 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', + 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, + 'star-triangle-down-open', 220, 'star-triangle-down-dot', + 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', + 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, + 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, + 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, + 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='sizesrc', parent_name='scattergeo.marker', **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sizeref', parent_name='scattergeo.marker', **kwargs + ): + super(SizerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='sizemode', + parent_name='scattergeo.marker', + **kwargs + ): + super(SizemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['diameter', 'area']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sizemin', parent_name='scattergeo.marker', **kwargs + ): + super(SizeminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='scattergeo.marker', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showscale', + parent_name='scattergeo.marker', + **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scattergeo.marker', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='opacitysrc', + parent_name='scattergeo.marker', + **kwargs + ): + super(OpacitysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='scattergeo.marker', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='scattergeo.marker', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GradientValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='gradient', + parent_name='scattergeo.marker', + **kwargs + ): + super(GradientValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Gradient'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the final color of the gradient fill: the + center color for radial, the right for + horizontal, or the bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color + . + type + Sets the type of gradient used to fill the + markers + typesrc + Sets the source reference on plot.ly for type + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scattergeo.marker', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='scattergeo.marker', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='colorbar', + parent_name='scattergeo.marker', + **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scattergeo.marker.colorbar.Ti + ckformatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scattergeo.marker.colorbar.tickformatstopdefa + ults), sets the default property values to use + for elements of + scattergeo.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scattergeo.marker.colorbar.Ti + tle instance or dict with compatible properties + titlefont + Deprecated: Please use + scattergeo.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. + titleside + Deprecated: Please use + scattergeo.marker.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scattergeo.marker', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scattergeo.marker.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='scattergeo.marker', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='scattergeo.marker', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='scattergeo.marker', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='scattergeo.marker', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scattergeo.marker', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/marker/_autocolorscale.py b/plotly/validators/scattergeo/marker/_autocolorscale.py deleted file mode 100644 index 54e7e4c9685..00000000000 --- a/plotly/validators/scattergeo/marker/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scattergeo.marker', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_cauto.py b/plotly/validators/scattergeo/marker/_cauto.py deleted file mode 100644 index a82f29fc9a9..00000000000 --- a/plotly/validators/scattergeo/marker/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='scattergeo.marker', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_cmax.py b/plotly/validators/scattergeo/marker/_cmax.py deleted file mode 100644 index aee531d4205..00000000000 --- a/plotly/validators/scattergeo/marker/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='scattergeo.marker', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_cmid.py b/plotly/validators/scattergeo/marker/_cmid.py deleted file mode 100644 index 66620d698b5..00000000000 --- a/plotly/validators/scattergeo/marker/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='scattergeo.marker', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_cmin.py b/plotly/validators/scattergeo/marker/_cmin.py deleted file mode 100644 index b249b7895f1..00000000000 --- a/plotly/validators/scattergeo/marker/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='scattergeo.marker', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_color.py b/plotly/validators/scattergeo/marker/_color.py deleted file mode 100644 index c753353c737..00000000000 --- a/plotly/validators/scattergeo/marker/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scattergeo.marker', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scattergeo.marker.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_colorbar.py b/plotly/validators/scattergeo/marker/_colorbar.py deleted file mode 100644 index 1f1cd2c6c33..00000000000 --- a/plotly/validators/scattergeo/marker/_colorbar.py +++ /dev/null @@ -1,231 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='colorbar', - parent_name='scattergeo.marker', - **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scattergeo.marker.colorbar.Ti - ckformatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scattergeo.marker.colorbar.tickformatstopdefa - ults), sets the default property values to use - for elements of - scattergeo.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scattergeo.marker.colorbar.Ti - tle instance or dict with compatible properties - titlefont - Deprecated: Please use - scattergeo.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. - titleside - Deprecated: Please use - scattergeo.marker.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_colorscale.py b/plotly/validators/scattergeo/marker/_colorscale.py deleted file mode 100644 index 6e659388a71..00000000000 --- a/plotly/validators/scattergeo/marker/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='scattergeo.marker', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_colorsrc.py b/plotly/validators/scattergeo/marker/_colorsrc.py deleted file mode 100644 index 68db6ab41be..00000000000 --- a/plotly/validators/scattergeo/marker/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scattergeo.marker', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_gradient.py b/plotly/validators/scattergeo/marker/_gradient.py deleted file mode 100644 index ecbe8fc8bce..00000000000 --- a/plotly/validators/scattergeo/marker/_gradient.py +++ /dev/null @@ -1,34 +0,0 @@ -import _plotly_utils.basevalidators - - -class GradientValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='gradient', - parent_name='scattergeo.marker', - **kwargs - ): - super(GradientValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Gradient'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the final color of the gradient fill: the - center color for radial, the right for - horizontal, or the bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color - . - type - Sets the type of gradient used to fill the - markers - typesrc - Sets the source reference on plot.ly for type - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_line.py b/plotly/validators/scattergeo/marker/_line.py deleted file mode 100644 index 31d10a44629..00000000000 --- a/plotly/validators/scattergeo/marker/_line.py +++ /dev/null @@ -1,97 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='scattergeo.marker', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_opacity.py b/plotly/validators/scattergeo/marker/_opacity.py deleted file mode 100644 index 82f766d698b..00000000000 --- a/plotly/validators/scattergeo/marker/_opacity.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='scattergeo.marker', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_opacitysrc.py b/plotly/validators/scattergeo/marker/_opacitysrc.py deleted file mode 100644 index 7712e7e0a9a..00000000000 --- a/plotly/validators/scattergeo/marker/_opacitysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='opacitysrc', - parent_name='scattergeo.marker', - **kwargs - ): - super(OpacitysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_reversescale.py b/plotly/validators/scattergeo/marker/_reversescale.py deleted file mode 100644 index a6b396e3639..00000000000 --- a/plotly/validators/scattergeo/marker/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scattergeo.marker', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_showscale.py b/plotly/validators/scattergeo/marker/_showscale.py deleted file mode 100644 index 58cdd5e312e..00000000000 --- a/plotly/validators/scattergeo/marker/_showscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showscale', - parent_name='scattergeo.marker', - **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_size.py b/plotly/validators/scattergeo/marker/_size.py deleted file mode 100644 index e303e04fd72..00000000000 --- a/plotly/validators/scattergeo/marker/_size.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='scattergeo.marker', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_sizemin.py b/plotly/validators/scattergeo/marker/_sizemin.py deleted file mode 100644 index 214ce95326e..00000000000 --- a/plotly/validators/scattergeo/marker/_sizemin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sizemin', parent_name='scattergeo.marker', **kwargs - ): - super(SizeminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_sizemode.py b/plotly/validators/scattergeo/marker/_sizemode.py deleted file mode 100644 index ba363ddbef1..00000000000 --- a/plotly/validators/scattergeo/marker/_sizemode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='sizemode', - parent_name='scattergeo.marker', - **kwargs - ): - super(SizemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['diameter', 'area']), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_sizeref.py b/plotly/validators/scattergeo/marker/_sizeref.py deleted file mode 100644 index d66ba2986b7..00000000000 --- a/plotly/validators/scattergeo/marker/_sizeref.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sizeref', parent_name='scattergeo.marker', **kwargs - ): - super(SizerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_sizesrc.py b/plotly/validators/scattergeo/marker/_sizesrc.py deleted file mode 100644 index b75d1db9b82..00000000000 --- a/plotly/validators/scattergeo/marker/_sizesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='sizesrc', parent_name='scattergeo.marker', **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_symbol.py b/plotly/validators/scattergeo/marker/_symbol.py deleted file mode 100644 index f428696d6e9..00000000000 --- a/plotly/validators/scattergeo/marker/_symbol.py +++ /dev/null @@ -1,78 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='symbol', parent_name='scattergeo.marker', **kwargs - ): - super(SymbolValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, - 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', - 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', - 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', - 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', - 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, - 'star-triangle-down-open', 220, 'star-triangle-down-dot', - 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', - 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, - 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, - 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, - 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/_symbolsrc.py b/plotly/validators/scattergeo/marker/_symbolsrc.py deleted file mode 100644 index 31f6dd820df..00000000000 --- a/plotly/validators/scattergeo/marker/_symbolsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='symbolsrc', - parent_name='scattergeo.marker', - **kwargs - ): - super(SymbolsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/__init__.py b/plotly/validators/scattergeo/marker/colorbar/__init__.py index 3dab31f7e02..5e415d3e173 100644 --- a/plotly/validators/scattergeo/marker/colorbar/__init__.py +++ b/plotly/validators/scattergeo/marker/colorbar/__init__.py @@ -1,41 +1,936 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ypad', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='y', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xpad', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='x', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='len', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scattergeo.marker.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_bgcolor.py b/plotly/validators/scattergeo/marker/colorbar/_bgcolor.py deleted file mode 100644 index cc5a65b47a2..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_bordercolor.py b/plotly/validators/scattergeo/marker/colorbar/_bordercolor.py deleted file mode 100644 index 33253bec842..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_borderwidth.py b/plotly/validators/scattergeo/marker/colorbar/_borderwidth.py deleted file mode 100644 index 875b571930b..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_dtick.py b/plotly/validators/scattergeo/marker/colorbar/_dtick.py deleted file mode 100644 index 3c29e830b64..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_exponentformat.py b/plotly/validators/scattergeo/marker/colorbar/_exponentformat.py deleted file mode 100644 index b4133a974f8..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_len.py b/plotly/validators/scattergeo/marker/colorbar/_len.py deleted file mode 100644 index 31c429fdd3f..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_len.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='len', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_lenmode.py b/plotly/validators/scattergeo/marker/colorbar/_lenmode.py deleted file mode 100644 index 1b8ab01b228..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_nticks.py b/plotly/validators/scattergeo/marker/colorbar/_nticks.py deleted file mode 100644 index 25ce6be2a4f..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_outlinecolor.py b/plotly/validators/scattergeo/marker/colorbar/_outlinecolor.py deleted file mode 100644 index 21730028412..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_outlinewidth.py b/plotly/validators/scattergeo/marker/colorbar/_outlinewidth.py deleted file mode 100644 index 0ba106bb152..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_separatethousands.py b/plotly/validators/scattergeo/marker/colorbar/_separatethousands.py deleted file mode 100644 index f5f045f9c0a..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_showexponent.py b/plotly/validators/scattergeo/marker/colorbar/_showexponent.py deleted file mode 100644 index ebc08be1b64..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_showticklabels.py b/plotly/validators/scattergeo/marker/colorbar/_showticklabels.py deleted file mode 100644 index 1be3fb733f8..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_showtickprefix.py b/plotly/validators/scattergeo/marker/colorbar/_showtickprefix.py deleted file mode 100644 index 4481060cf1f..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_showticksuffix.py b/plotly/validators/scattergeo/marker/colorbar/_showticksuffix.py deleted file mode 100644 index 1da0dcee3dd..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_thickness.py b/plotly/validators/scattergeo/marker/colorbar/_thickness.py deleted file mode 100644 index d065cd173fb..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_thicknessmode.py b/plotly/validators/scattergeo/marker/colorbar/_thicknessmode.py deleted file mode 100644 index d4d387efe26..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_tick0.py b/plotly/validators/scattergeo/marker/colorbar/_tick0.py deleted file mode 100644 index 8dd56b2a8ee..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_tickangle.py b/plotly/validators/scattergeo/marker/colorbar/_tickangle.py deleted file mode 100644 index beb8f87f51b..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_tickcolor.py b/plotly/validators/scattergeo/marker/colorbar/_tickcolor.py deleted file mode 100644 index 333e7525117..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_tickfont.py b/plotly/validators/scattergeo/marker/colorbar/_tickfont.py deleted file mode 100644 index 698feab8af1..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_tickformat.py b/plotly/validators/scattergeo/marker/colorbar/_tickformat.py deleted file mode 100644 index f298fd107de..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_tickformatstopdefaults.py b/plotly/validators/scattergeo/marker/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index c0dafaae8f0..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_tickformatstops.py b/plotly/validators/scattergeo/marker/colorbar/_tickformatstops.py deleted file mode 100644 index a82ff24a41c..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_ticklen.py b/plotly/validators/scattergeo/marker/colorbar/_ticklen.py deleted file mode 100644 index 1c0cd292f84..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_tickmode.py b/plotly/validators/scattergeo/marker/colorbar/_tickmode.py deleted file mode 100644 index 09bb2b2a3f1..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_tickprefix.py b/plotly/validators/scattergeo/marker/colorbar/_tickprefix.py deleted file mode 100644 index 18f56a9fd54..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_ticks.py b/plotly/validators/scattergeo/marker/colorbar/_ticks.py deleted file mode 100644 index 18e5a4f2744..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_ticksuffix.py b/plotly/validators/scattergeo/marker/colorbar/_ticksuffix.py deleted file mode 100644 index d45bfa6adcd..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_ticktext.py b/plotly/validators/scattergeo/marker/colorbar/_ticktext.py deleted file mode 100644 index 40a0e576924..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_ticktextsrc.py b/plotly/validators/scattergeo/marker/colorbar/_ticktextsrc.py deleted file mode 100644 index 5c0b711a617..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_tickvals.py b/plotly/validators/scattergeo/marker/colorbar/_tickvals.py deleted file mode 100644 index 4961e273dab..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_tickvalssrc.py b/plotly/validators/scattergeo/marker/colorbar/_tickvalssrc.py deleted file mode 100644 index 272bec7d08d..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_tickwidth.py b/plotly/validators/scattergeo/marker/colorbar/_tickwidth.py deleted file mode 100644 index f484d3565e8..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_title.py b/plotly/validators/scattergeo/marker/colorbar/_title.py deleted file mode 100644 index e584a0b07ef..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_x.py b/plotly/validators/scattergeo/marker/colorbar/_x.py deleted file mode 100644 index cbb07789861..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_x.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='x', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_xanchor.py b/plotly/validators/scattergeo/marker/colorbar/_xanchor.py deleted file mode 100644 index e3f1ae730da..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_xpad.py b/plotly/validators/scattergeo/marker/colorbar/_xpad.py deleted file mode 100644 index f8224e1c44b..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_xpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xpad', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_y.py b/plotly/validators/scattergeo/marker/colorbar/_y.py deleted file mode 100644 index 59dadf8b7fd..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_y.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='y', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_yanchor.py b/plotly/validators/scattergeo/marker/colorbar/_yanchor.py deleted file mode 100644 index ec4b8fbaa63..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/_ypad.py b/plotly/validators/scattergeo/marker/colorbar/_ypad.py deleted file mode 100644 index 23cb6adbfd9..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/_ypad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ypad', - parent_name='scattergeo.marker.colorbar', - **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/tickfont/__init__.py b/plotly/validators/scattergeo/marker/colorbar/tickfont/__init__.py index 199d72e71c6..b043d86dac2 100644 --- a/plotly/validators/scattergeo/marker/colorbar/tickfont/__init__.py +++ b/plotly/validators/scattergeo/marker/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattergeo.marker.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scattergeo.marker.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergeo.marker.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/marker/colorbar/tickfont/_color.py b/plotly/validators/scattergeo/marker/colorbar/tickfont/_color.py deleted file mode 100644 index 4aaf8d7cb3f..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergeo.marker.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/tickfont/_family.py b/plotly/validators/scattergeo/marker/colorbar/tickfont/_family.py deleted file mode 100644 index 08fbb196308..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scattergeo.marker.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/tickfont/_size.py b/plotly/validators/scattergeo/marker/colorbar/tickfont/_size.py deleted file mode 100644 index 299e2b6ad40..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattergeo.marker.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/tickformatstop/__init__.py b/plotly/validators/scattergeo/marker/colorbar/tickformatstop/__init__.py index 3f6c06cac47..7cee87092bb 100644 --- a/plotly/validators/scattergeo/marker/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/scattergeo/marker/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='scattergeo.marker.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='scattergeo.marker.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='scattergeo.marker.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='scattergeo.marker.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='scattergeo.marker.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'calc' + }, { + 'valType': 'any', + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/marker/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/scattergeo/marker/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index a0d3fdf3ebb..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='scattergeo.marker.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'calc' - }, { - 'valType': 'any', - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/tickformatstop/_enabled.py b/plotly/validators/scattergeo/marker/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index c4400159ffa..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='scattergeo.marker.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/tickformatstop/_name.py b/plotly/validators/scattergeo/marker/colorbar/tickformatstop/_name.py deleted file mode 100644 index d25c447e9dc..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='scattergeo.marker.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/scattergeo/marker/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 144f9e4e251..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='scattergeo.marker.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/tickformatstop/_value.py b/plotly/validators/scattergeo/marker/colorbar/tickformatstop/_value.py deleted file mode 100644 index 8f2500974bd..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='scattergeo.marker.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/title/__init__.py b/plotly/validators/scattergeo/marker/colorbar/title/__init__.py index 33c9c145bb8..26aff665482 100644 --- a/plotly/validators/scattergeo/marker/colorbar/title/__init__.py +++ b/plotly/validators/scattergeo/marker/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='scattergeo.marker.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='scattergeo.marker.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='scattergeo.marker.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/scattergeo/marker/colorbar/title/_font.py b/plotly/validators/scattergeo/marker/colorbar/title/_font.py deleted file mode 100644 index eea4bdcbe5a..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='scattergeo.marker.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/title/_side.py b/plotly/validators/scattergeo/marker/colorbar/title/_side.py deleted file mode 100644 index 13b3b87d333..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='scattergeo.marker.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/title/_text.py b/plotly/validators/scattergeo/marker/colorbar/title/_text.py deleted file mode 100644 index ed18803eb50..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='scattergeo.marker.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/title/font/__init__.py b/plotly/validators/scattergeo/marker/colorbar/title/font/__init__.py index 199d72e71c6..2fbe8809ef8 100644 --- a/plotly/validators/scattergeo/marker/colorbar/title/font/__init__.py +++ b/plotly/validators/scattergeo/marker/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattergeo.marker.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scattergeo.marker.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergeo.marker.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/marker/colorbar/title/font/_color.py b/plotly/validators/scattergeo/marker/colorbar/title/font/_color.py deleted file mode 100644 index 5e3235b4e18..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergeo.marker.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/title/font/_family.py b/plotly/validators/scattergeo/marker/colorbar/title/font/_family.py deleted file mode 100644 index ed35b3c0d40..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scattergeo.marker.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/colorbar/title/font/_size.py b/plotly/validators/scattergeo/marker/colorbar/title/font/_size.py deleted file mode 100644 index b2c7bf73d16..00000000000 --- a/plotly/validators/scattergeo/marker/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattergeo.marker.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/gradient/__init__.py b/plotly/validators/scattergeo/marker/gradient/__init__.py index 434557c8fea..9c432c5a551 100644 --- a/plotly/validators/scattergeo/marker/gradient/__init__.py +++ b/plotly/validators/scattergeo/marker/gradient/__init__.py @@ -1,4 +1,85 @@ -from ._typesrc import TypesrcValidator -from ._type import TypeValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class TypesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='typesrc', + parent_name='scattergeo.marker.gradient', + **kwargs + ): + super(TypesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='type', + parent_name='scattergeo.marker.gradient', + **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['radial', 'horizontal', 'vertical', 'none'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scattergeo.marker.gradient', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergeo.marker.gradient', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/marker/gradient/_color.py b/plotly/validators/scattergeo/marker/gradient/_color.py deleted file mode 100644 index 0dc292da1c4..00000000000 --- a/plotly/validators/scattergeo/marker/gradient/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergeo.marker.gradient', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/gradient/_colorsrc.py b/plotly/validators/scattergeo/marker/gradient/_colorsrc.py deleted file mode 100644 index 43fcaf2dc02..00000000000 --- a/plotly/validators/scattergeo/marker/gradient/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scattergeo.marker.gradient', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/gradient/_type.py b/plotly/validators/scattergeo/marker/gradient/_type.py deleted file mode 100644 index 0ee09d1baa2..00000000000 --- a/plotly/validators/scattergeo/marker/gradient/_type.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='type', - parent_name='scattergeo.marker.gradient', - **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['radial', 'horizontal', 'vertical', 'none'] - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/gradient/_typesrc.py b/plotly/validators/scattergeo/marker/gradient/_typesrc.py deleted file mode 100644 index 2f4f8c076f7..00000000000 --- a/plotly/validators/scattergeo/marker/gradient/_typesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='typesrc', - parent_name='scattergeo.marker.gradient', - **kwargs - ): - super(TypesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/line/__init__.py b/plotly/validators/scattergeo/marker/line/__init__.py index c031ca61ce2..9b399f4d668 100644 --- a/plotly/validators/scattergeo/marker/line/__init__.py +++ b/plotly/validators/scattergeo/marker/line/__init__.py @@ -1,11 +1,235 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._reversescale import ReversescaleValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='widthsrc', + parent_name='scattergeo.marker.line', + **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='scattergeo.marker.line', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scattergeo.marker.line', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scattergeo.marker.line', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='scattergeo.marker.line', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergeo.marker.line', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scattergeo.marker.line.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmin', + parent_name='scattergeo.marker.line', + **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmid', + parent_name='scattergeo.marker.line', + **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmax', + parent_name='scattergeo.marker.line', + **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='cauto', + parent_name='scattergeo.marker.line', + **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scattergeo.marker.line', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/marker/line/_autocolorscale.py b/plotly/validators/scattergeo/marker/line/_autocolorscale.py deleted file mode 100644 index 8fea49d7ead..00000000000 --- a/plotly/validators/scattergeo/marker/line/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scattergeo.marker.line', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/line/_cauto.py b/plotly/validators/scattergeo/marker/line/_cauto.py deleted file mode 100644 index df23aa52645..00000000000 --- a/plotly/validators/scattergeo/marker/line/_cauto.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='cauto', - parent_name='scattergeo.marker.line', - **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/line/_cmax.py b/plotly/validators/scattergeo/marker/line/_cmax.py deleted file mode 100644 index d7b9e8a15c3..00000000000 --- a/plotly/validators/scattergeo/marker/line/_cmax.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmax', - parent_name='scattergeo.marker.line', - **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/line/_cmid.py b/plotly/validators/scattergeo/marker/line/_cmid.py deleted file mode 100644 index 64bfaadd766..00000000000 --- a/plotly/validators/scattergeo/marker/line/_cmid.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmid', - parent_name='scattergeo.marker.line', - **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/line/_cmin.py b/plotly/validators/scattergeo/marker/line/_cmin.py deleted file mode 100644 index 2c8ced024ec..00000000000 --- a/plotly/validators/scattergeo/marker/line/_cmin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmin', - parent_name='scattergeo.marker.line', - **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/line/_color.py b/plotly/validators/scattergeo/marker/line/_color.py deleted file mode 100644 index de0b442c40e..00000000000 --- a/plotly/validators/scattergeo/marker/line/_color.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergeo.marker.line', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scattergeo.marker.line.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/line/_colorscale.py b/plotly/validators/scattergeo/marker/line/_colorscale.py deleted file mode 100644 index a8d53499c78..00000000000 --- a/plotly/validators/scattergeo/marker/line/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='scattergeo.marker.line', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/line/_colorsrc.py b/plotly/validators/scattergeo/marker/line/_colorsrc.py deleted file mode 100644 index bc858d07e35..00000000000 --- a/plotly/validators/scattergeo/marker/line/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scattergeo.marker.line', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/line/_reversescale.py b/plotly/validators/scattergeo/marker/line/_reversescale.py deleted file mode 100644 index ed5a2a432c9..00000000000 --- a/plotly/validators/scattergeo/marker/line/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scattergeo.marker.line', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/line/_width.py b/plotly/validators/scattergeo/marker/line/_width.py deleted file mode 100644 index 34f0213196f..00000000000 --- a/plotly/validators/scattergeo/marker/line/_width.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='scattergeo.marker.line', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/marker/line/_widthsrc.py b/plotly/validators/scattergeo/marker/line/_widthsrc.py deleted file mode 100644 index 00149320f1a..00000000000 --- a/plotly/validators/scattergeo/marker/line/_widthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='widthsrc', - parent_name='scattergeo.marker.line', - **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/selected/__init__.py b/plotly/validators/scattergeo/selected/__init__.py index f1a1ef3742f..cddf38d1c6d 100644 --- a/plotly/validators/scattergeo/selected/__init__.py +++ b/plotly/validators/scattergeo/selected/__init__.py @@ -1,2 +1,54 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='scattergeo.selected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of selected points. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='scattergeo.selected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scattergeo/selected/_marker.py b/plotly/validators/scattergeo/selected/_marker.py deleted file mode 100644 index 3860656ebfa..00000000000 --- a/plotly/validators/scattergeo/selected/_marker.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='scattergeo.selected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/selected/_textfont.py b/plotly/validators/scattergeo/selected/_textfont.py deleted file mode 100644 index 49e01cd784f..00000000000 --- a/plotly/validators/scattergeo/selected/_textfont.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='scattergeo.selected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/selected/marker/__init__.py b/plotly/validators/scattergeo/selected/marker/__init__.py index ed9a9070947..eefdb7c40a6 100644 --- a/plotly/validators/scattergeo/selected/marker/__init__.py +++ b/plotly/validators/scattergeo/selected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattergeo.selected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scattergeo.selected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergeo.selected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/selected/marker/_color.py b/plotly/validators/scattergeo/selected/marker/_color.py deleted file mode 100644 index 793c47d71b2..00000000000 --- a/plotly/validators/scattergeo/selected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergeo.selected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/selected/marker/_opacity.py b/plotly/validators/scattergeo/selected/marker/_opacity.py deleted file mode 100644 index 36e038652ba..00000000000 --- a/plotly/validators/scattergeo/selected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scattergeo.selected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/selected/marker/_size.py b/plotly/validators/scattergeo/selected/marker/_size.py deleted file mode 100644 index bc0071d98f2..00000000000 --- a/plotly/validators/scattergeo/selected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattergeo.selected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/selected/textfont/__init__.py b/plotly/validators/scattergeo/selected/textfont/__init__.py index 74135b3f315..41540726722 100644 --- a/plotly/validators/scattergeo/selected/textfont/__init__.py +++ b/plotly/validators/scattergeo/selected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergeo.selected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/selected/textfont/_color.py b/plotly/validators/scattergeo/selected/textfont/_color.py deleted file mode 100644 index f9d87ef1db8..00000000000 --- a/plotly/validators/scattergeo/selected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergeo.selected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/stream/__init__.py b/plotly/validators/scattergeo/stream/__init__.py index 2f4f2047594..50e278c875a 100644 --- a/plotly/validators/scattergeo/stream/__init__.py +++ b/plotly/validators/scattergeo/stream/__init__.py @@ -1,2 +1,41 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='scattergeo.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='scattergeo.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/stream/_maxpoints.py b/plotly/validators/scattergeo/stream/_maxpoints.py deleted file mode 100644 index 3e2167ae762..00000000000 --- a/plotly/validators/scattergeo/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='scattergeo.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/stream/_token.py b/plotly/validators/scattergeo/stream/_token.py deleted file mode 100644 index 36ab8022e87..00000000000 --- a/plotly/validators/scattergeo/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='scattergeo.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattergeo/textfont/__init__.py b/plotly/validators/scattergeo/textfont/__init__.py index 1d2c591d1e5..5e0dbafe07a 100644 --- a/plotly/validators/scattergeo/textfont/__init__.py +++ b/plotly/validators/scattergeo/textfont/__init__.py @@ -1,6 +1,120 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scattergeo.textfont', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='scattergeo.textfont', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='scattergeo.textfont', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scattergeo.textfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scattergeo.textfont', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scattergeo.textfont', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/textfont/_color.py b/plotly/validators/scattergeo/textfont/_color.py deleted file mode 100644 index 3621d0d80dc..00000000000 --- a/plotly/validators/scattergeo/textfont/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scattergeo.textfont', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/textfont/_colorsrc.py b/plotly/validators/scattergeo/textfont/_colorsrc.py deleted file mode 100644 index 973b92a54bc..00000000000 --- a/plotly/validators/scattergeo/textfont/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scattergeo.textfont', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/textfont/_family.py b/plotly/validators/scattergeo/textfont/_family.py deleted file mode 100644 index c1ff68a0ac1..00000000000 --- a/plotly/validators/scattergeo/textfont/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scattergeo.textfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattergeo/textfont/_familysrc.py b/plotly/validators/scattergeo/textfont/_familysrc.py deleted file mode 100644 index 2b815995bb6..00000000000 --- a/plotly/validators/scattergeo/textfont/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='scattergeo.textfont', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/textfont/_size.py b/plotly/validators/scattergeo/textfont/_size.py deleted file mode 100644 index 12d32e50837..00000000000 --- a/plotly/validators/scattergeo/textfont/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='scattergeo.textfont', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/textfont/_sizesrc.py b/plotly/validators/scattergeo/textfont/_sizesrc.py deleted file mode 100644 index 0807b1a6cac..00000000000 --- a/plotly/validators/scattergeo/textfont/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scattergeo.textfont', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/unselected/__init__.py b/plotly/validators/scattergeo/unselected/__init__.py index f1a1ef3742f..cf7457be364 100644 --- a/plotly/validators/scattergeo/unselected/__init__.py +++ b/plotly/validators/scattergeo/unselected/__init__.py @@ -1,2 +1,58 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='scattergeo.unselected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='scattergeo.unselected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of unselected points, + applied only when a selection exists. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scattergeo/unselected/_marker.py b/plotly/validators/scattergeo/unselected/_marker.py deleted file mode 100644 index d019f895b89..00000000000 --- a/plotly/validators/scattergeo/unselected/_marker.py +++ /dev/null @@ -1,30 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='scattergeo.unselected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of unselected points, - applied only when a selection exists. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/unselected/_textfont.py b/plotly/validators/scattergeo/unselected/_textfont.py deleted file mode 100644 index 1ba0a450fbd..00000000000 --- a/plotly/validators/scattergeo/unselected/_textfont.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='scattergeo.unselected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergeo/unselected/marker/__init__.py b/plotly/validators/scattergeo/unselected/marker/__init__.py index ed9a9070947..393ab62b1b4 100644 --- a/plotly/validators/scattergeo/unselected/marker/__init__.py +++ b/plotly/validators/scattergeo/unselected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattergeo.unselected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scattergeo.unselected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergeo.unselected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/unselected/marker/_color.py b/plotly/validators/scattergeo/unselected/marker/_color.py deleted file mode 100644 index 7d3e7a1ac05..00000000000 --- a/plotly/validators/scattergeo/unselected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergeo.unselected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/unselected/marker/_opacity.py b/plotly/validators/scattergeo/unselected/marker/_opacity.py deleted file mode 100644 index a2c81285dfe..00000000000 --- a/plotly/validators/scattergeo/unselected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scattergeo.unselected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/unselected/marker/_size.py b/plotly/validators/scattergeo/unselected/marker/_size.py deleted file mode 100644 index f03282f0882..00000000000 --- a/plotly/validators/scattergeo/unselected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattergeo.unselected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergeo/unselected/textfont/__init__.py b/plotly/validators/scattergeo/unselected/textfont/__init__.py index 74135b3f315..0a65cf09a98 100644 --- a/plotly/validators/scattergeo/unselected/textfont/__init__.py +++ b/plotly/validators/scattergeo/unselected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergeo.unselected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergeo/unselected/textfont/_color.py b/plotly/validators/scattergeo/unselected/textfont/_color.py deleted file mode 100644 index 83ac85cb758..00000000000 --- a/plotly/validators/scattergeo/unselected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergeo.unselected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/__init__.py b/plotly/validators/scattergl/__init__.py index d06cad1bb01..e05d8efc15a 100644 --- a/plotly/validators/scattergl/__init__.py +++ b/plotly/validators/scattergl/__init__.py @@ -1,47 +1,1157 @@ -from ._ysrc import YsrcValidator -from ._ycalendar import YcalendarValidator -from ._yaxis import YAxisValidator -from ._y0 import Y0Validator -from ._y import YValidator -from ._xsrc import XsrcValidator -from ._xcalendar import XcalendarValidator -from ._xaxis import XAxisValidator -from ._x0 import X0Validator -from ._x import XValidator -from ._visible import VisibleValidator -from ._unselected import UnselectedValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textsrc import TextsrcValidator -from ._textpositionsrc import TextpositionsrcValidator -from ._textposition import TextpositionValidator -from ._textfont import TextfontValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._selected import SelectedValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._mode import ModeValidator -from ._marker import MarkerValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._fillcolor import FillcolorValidator -from ._fill import FillValidator -from ._error_y import ErrorYValidator -from ._error_x import ErrorXValidator -from ._dy import DyValidator -from ._dx import DxValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._connectgaps import ConnectgapsValidator + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='scattergl', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ycalendar', parent_name='scattergl', **kwargs + ): + super(YcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='yaxis', parent_name='scattergl', **kwargs): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Y0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='y0', parent_name='scattergl', **kwargs): + super(Y0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='scattergl', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='scattergl', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xcalendar', parent_name='scattergl', **kwargs + ): + super(XcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='xaxis', parent_name='scattergl', **kwargs): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class X0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='x0', parent_name='scattergl', **kwargs): + super(X0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='scattergl', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='scattergl', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='unselected', parent_name='scattergl', **kwargs + ): + super(UnselectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Unselected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.scattergl.unselected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scattergl.unselected.Textfont + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='scattergl', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='scattergl', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textsrc', parent_name='scattergl', **kwargs + ): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textpositionsrc', parent_name='scattergl', **kwargs + ): + super(TextpositionsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='textposition', parent_name='scattergl', **kwargs + ): + super(TextpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 'top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', + 'bottom center', 'bottom right' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='textfont', parent_name='scattergl', **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='scattergl', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='scattergl', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='scattergl', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='scattergl', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='selected', parent_name='scattergl', **kwargs + ): + super(SelectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Selected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.scattergl.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scattergl.selected.Textfont + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='scattergl', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='scattergl', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__(self, plotly_name='mode', parent_name='scattergl', **kwargs): + super(ModeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['none']), + flags=kwargs.pop('flags', ['lines', 'markers', 'text']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='scattergl', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scattergl.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + line + plotly.graph_objs.scattergl.marker.Line + instance or dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='line', parent_name='scattergl', **kwargs): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the line color. + dash + Sets the style of the lines. + shape + Determines the line shape. The values + correspond to step-wise line shapes. + width + Sets the line width (in px). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='scattergl', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='scattergl', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='scattergl', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='scattergl', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='scattergl', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertemplatesrc', + parent_name='scattergl', + **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='scattergl', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='scattergl', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='scattergl', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='scattergl', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='fillcolor', parent_name='scattergl', **kwargs + ): + super(FillcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='fill', parent_name='scattergl', **kwargs): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 'none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', + 'toself', 'tonext' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ErrorYValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='error_y', parent_name='scattergl', **kwargs + ): + super(ErrorYValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ErrorY'), + data_docs=kwargs.pop( + 'data_docs', """ + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ErrorXValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='error_x', parent_name='scattergl', **kwargs + ): + super(ErrorXValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ErrorX'), + data_docs=kwargs.pop( + 'data_docs', """ + array + Sets the data corresponding the length of each + error bar. Values are plotted relative to the + underlying data. + arrayminus + Sets the data corresponding the length of each + error bar in the bottom (left) direction for + vertical (horizontal) bars Values are plotted + relative to the underlying data. + arrayminussrc + Sets the source reference on plot.ly for + arrayminus . + arraysrc + Sets the source reference on plot.ly for array + . + color + Sets the stoke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have + the same length in both direction (top/bottom + for vertical bars, left/right for horizontal + bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error + bars. If *constant`, the bar lengths are of a + constant value. Set this constant in `value`. + If "percent", the bar lengths correspond to a + percentage of underlying data. Set this + percentage in `value`. If "sqrt", the bar + lengths correspond to the sqaure of the + underlying data. If "array", the bar lengths + are set with data set `array`. + value + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars. + valueminus + Sets the value of either the percentage (if + `type` is set to "percent") or the constant (if + `type` is set to "constant") corresponding to + the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + visible + Determines whether or not this set of error + bars is visible. + width + Sets the width (in px) of the cross-bar at both + ends of the error bars. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DyValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='dy', parent_name='scattergl', **kwargs): + super(DyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='dx', parent_name='scattergl', **kwargs): + super(DxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='scattergl', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='scattergl', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='connectgaps', parent_name='scattergl', **kwargs + ): + super(ConnectgapsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scattergl/_connectgaps.py b/plotly/validators/scattergl/_connectgaps.py deleted file mode 100644 index 31fbe27530b..00000000000 --- a/plotly/validators/scattergl/_connectgaps.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='connectgaps', parent_name='scattergl', **kwargs - ): - super(ConnectgapsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_customdata.py b/plotly/validators/scattergl/_customdata.py deleted file mode 100644 index d6a9b15336e..00000000000 --- a/plotly/validators/scattergl/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='scattergl', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_customdatasrc.py b/plotly/validators/scattergl/_customdatasrc.py deleted file mode 100644 index e285611cad4..00000000000 --- a/plotly/validators/scattergl/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='scattergl', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_dx.py b/plotly/validators/scattergl/_dx.py deleted file mode 100644 index 64300485c87..00000000000 --- a/plotly/validators/scattergl/_dx.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class DxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='dx', parent_name='scattergl', **kwargs): - super(DxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_dy.py b/plotly/validators/scattergl/_dy.py deleted file mode 100644 index 9578be96f01..00000000000 --- a/plotly/validators/scattergl/_dy.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class DyValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='dy', parent_name='scattergl', **kwargs): - super(DyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_error_x.py b/plotly/validators/scattergl/_error_x.py deleted file mode 100644 index e770cda85f4..00000000000 --- a/plotly/validators/scattergl/_error_x.py +++ /dev/null @@ -1,75 +0,0 @@ -import _plotly_utils.basevalidators - - -class ErrorXValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='error_x', parent_name='scattergl', **kwargs - ): - super(ErrorXValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ErrorX'), - data_docs=kwargs.pop( - 'data_docs', """ - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - copy_ystyle - - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/_error_y.py b/plotly/validators/scattergl/_error_y.py deleted file mode 100644 index da5e4c9c8f8..00000000000 --- a/plotly/validators/scattergl/_error_y.py +++ /dev/null @@ -1,73 +0,0 @@ -import _plotly_utils.basevalidators - - -class ErrorYValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='error_y', parent_name='scattergl', **kwargs - ): - super(ErrorYValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ErrorY'), - data_docs=kwargs.pop( - 'data_docs', """ - array - Sets the data corresponding the length of each - error bar. Values are plotted relative to the - underlying data. - arrayminus - Sets the data corresponding the length of each - error bar in the bottom (left) direction for - vertical (horizontal) bars Values are plotted - relative to the underlying data. - arrayminussrc - Sets the source reference on plot.ly for - arrayminus . - arraysrc - Sets the source reference on plot.ly for array - . - color - Sets the stoke color of the error bars. - symmetric - Determines whether or not the error bars have - the same length in both direction (top/bottom - for vertical bars, left/right for horizontal - bars. - thickness - Sets the thickness (in px) of the error bars. - traceref - - tracerefminus - - type - Determines the rule used to generate the error - bars. If *constant`, the bar lengths are of a - constant value. Set this constant in `value`. - If "percent", the bar lengths correspond to a - percentage of underlying data. Set this - percentage in `value`. If "sqrt", the bar - lengths correspond to the sqaure of the - underlying data. If "array", the bar lengths - are set with data set `array`. - value - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars. - valueminus - Sets the value of either the percentage (if - `type` is set to "percent") or the constant (if - `type` is set to "constant") corresponding to - the lengths of the error bars in the bottom - (left) direction for vertical (horizontal) bars - visible - Determines whether or not this set of error - bars is visible. - width - Sets the width (in px) of the cross-bar at both - ends of the error bars. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/_fill.py b/plotly/validators/scattergl/_fill.py deleted file mode 100644 index beddc52d578..00000000000 --- a/plotly/validators/scattergl/_fill.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='fill', parent_name='scattergl', **kwargs): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 'none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', - 'toself', 'tonext' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/_fillcolor.py b/plotly/validators/scattergl/_fillcolor.py deleted file mode 100644 index 6c30afd88b2..00000000000 --- a/plotly/validators/scattergl/_fillcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='fillcolor', parent_name='scattergl', **kwargs - ): - super(FillcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_hoverinfo.py b/plotly/validators/scattergl/_hoverinfo.py deleted file mode 100644 index 91338250af2..00000000000 --- a/plotly/validators/scattergl/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='scattergl', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_hoverinfosrc.py b/plotly/validators/scattergl/_hoverinfosrc.py deleted file mode 100644 index 51d7bfc978b..00000000000 --- a/plotly/validators/scattergl/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='scattergl', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_hoverlabel.py b/plotly/validators/scattergl/_hoverlabel.py deleted file mode 100644 index f67326af2c6..00000000000 --- a/plotly/validators/scattergl/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='scattergl', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/_hovertemplate.py b/plotly/validators/scattergl/_hovertemplate.py deleted file mode 100644 index 5796a040241..00000000000 --- a/plotly/validators/scattergl/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='scattergl', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_hovertemplatesrc.py b/plotly/validators/scattergl/_hovertemplatesrc.py deleted file mode 100644 index 13f2bb25aab..00000000000 --- a/plotly/validators/scattergl/_hovertemplatesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertemplatesrc', - parent_name='scattergl', - **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_hovertext.py b/plotly/validators/scattergl/_hovertext.py deleted file mode 100644 index 4b8877bac2e..00000000000 --- a/plotly/validators/scattergl/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='scattergl', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_hovertextsrc.py b/plotly/validators/scattergl/_hovertextsrc.py deleted file mode 100644 index 362d31d4f05..00000000000 --- a/plotly/validators/scattergl/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='scattergl', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_ids.py b/plotly/validators/scattergl/_ids.py deleted file mode 100644 index 9990836e8b7..00000000000 --- a/plotly/validators/scattergl/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='scattergl', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_idssrc.py b/plotly/validators/scattergl/_idssrc.py deleted file mode 100644 index 3ae9847f44f..00000000000 --- a/plotly/validators/scattergl/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='scattergl', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_legendgroup.py b/plotly/validators/scattergl/_legendgroup.py deleted file mode 100644 index 1982e3cc628..00000000000 --- a/plotly/validators/scattergl/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='scattergl', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_line.py b/plotly/validators/scattergl/_line.py deleted file mode 100644 index f2aa10051cc..00000000000 --- a/plotly/validators/scattergl/_line.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='line', parent_name='scattergl', **kwargs): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the line color. - dash - Sets the style of the lines. - shape - Determines the line shape. The values - correspond to step-wise line shapes. - width - Sets the line width (in px). -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/_marker.py b/plotly/validators/scattergl/_marker.py deleted file mode 100644 index d75e5365814..00000000000 --- a/plotly/validators/scattergl/_marker.py +++ /dev/null @@ -1,131 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='scattergl', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scattergl.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - line - plotly.graph_objs.scattergl.marker.Line - instance or dict with compatible properties - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/_mode.py b/plotly/validators/scattergl/_mode.py deleted file mode 100644 index eced058b243..00000000000 --- a/plotly/validators/scattergl/_mode.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__(self, plotly_name='mode', parent_name='scattergl', **kwargs): - super(ModeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['none']), - flags=kwargs.pop('flags', ['lines', 'markers', 'text']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_name.py b/plotly/validators/scattergl/_name.py deleted file mode 100644 index 9bf0fd80fd4..00000000000 --- a/plotly/validators/scattergl/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='scattergl', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_opacity.py b/plotly/validators/scattergl/_opacity.py deleted file mode 100644 index 89a151d8081..00000000000 --- a/plotly/validators/scattergl/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='scattergl', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_selected.py b/plotly/validators/scattergl/_selected.py deleted file mode 100644 index 409861a7a5f..00000000000 --- a/plotly/validators/scattergl/_selected.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='selected', parent_name='scattergl', **kwargs - ): - super(SelectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Selected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.scattergl.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scattergl.selected.Textfont - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/_selectedpoints.py b/plotly/validators/scattergl/_selectedpoints.py deleted file mode 100644 index 62bac539390..00000000000 --- a/plotly/validators/scattergl/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='scattergl', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_showlegend.py b/plotly/validators/scattergl/_showlegend.py deleted file mode 100644 index 38d2b663f13..00000000000 --- a/plotly/validators/scattergl/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='scattergl', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_stream.py b/plotly/validators/scattergl/_stream.py deleted file mode 100644 index c55c6bce7e7..00000000000 --- a/plotly/validators/scattergl/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='scattergl', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/_text.py b/plotly/validators/scattergl/_text.py deleted file mode 100644 index 867cf1eb04c..00000000000 --- a/plotly/validators/scattergl/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='scattergl', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_textfont.py b/plotly/validators/scattergl/_textfont.py deleted file mode 100644 index 94a0537e5e8..00000000000 --- a/plotly/validators/scattergl/_textfont.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='textfont', parent_name='scattergl', **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/_textposition.py b/plotly/validators/scattergl/_textposition.py deleted file mode 100644 index dfd308913ec..00000000000 --- a/plotly/validators/scattergl/_textposition.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='textposition', parent_name='scattergl', **kwargs - ): - super(TextpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 'top left', 'top center', 'top right', 'middle left', - 'middle center', 'middle right', 'bottom left', - 'bottom center', 'bottom right' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/_textpositionsrc.py b/plotly/validators/scattergl/_textpositionsrc.py deleted file mode 100644 index 3439db87090..00000000000 --- a/plotly/validators/scattergl/_textpositionsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textpositionsrc', parent_name='scattergl', **kwargs - ): - super(TextpositionsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_textsrc.py b/plotly/validators/scattergl/_textsrc.py deleted file mode 100644 index 316abebd952..00000000000 --- a/plotly/validators/scattergl/_textsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textsrc', parent_name='scattergl', **kwargs - ): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_uid.py b/plotly/validators/scattergl/_uid.py deleted file mode 100644 index 16c23d72f1a..00000000000 --- a/plotly/validators/scattergl/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='scattergl', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_uirevision.py b/plotly/validators/scattergl/_uirevision.py deleted file mode 100644 index 02410d4d054..00000000000 --- a/plotly/validators/scattergl/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='scattergl', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_unselected.py b/plotly/validators/scattergl/_unselected.py deleted file mode 100644 index 7e0c4542d7f..00000000000 --- a/plotly/validators/scattergl/_unselected.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='unselected', parent_name='scattergl', **kwargs - ): - super(UnselectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Unselected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.scattergl.unselected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scattergl.unselected.Textfont - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/_visible.py b/plotly/validators/scattergl/_visible.py deleted file mode 100644 index ef86f1b0229..00000000000 --- a/plotly/validators/scattergl/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='scattergl', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/scattergl/_x.py b/plotly/validators/scattergl/_x.py deleted file mode 100644 index 17b228a496e..00000000000 --- a/plotly/validators/scattergl/_x.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='scattergl', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_x0.py b/plotly/validators/scattergl/_x0.py deleted file mode 100644 index a38fc494a4c..00000000000 --- a/plotly/validators/scattergl/_x0.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class X0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='x0', parent_name='scattergl', **kwargs): - super(X0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_xaxis.py b/plotly/validators/scattergl/_xaxis.py deleted file mode 100644 index 94a7be18ea6..00000000000 --- a/plotly/validators/scattergl/_xaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='xaxis', parent_name='scattergl', **kwargs): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_xcalendar.py b/plotly/validators/scattergl/_xcalendar.py deleted file mode 100644 index 40e10fa080b..00000000000 --- a/plotly/validators/scattergl/_xcalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xcalendar', parent_name='scattergl', **kwargs - ): - super(XcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/_xsrc.py b/plotly/validators/scattergl/_xsrc.py deleted file mode 100644 index 12b2d87637a..00000000000 --- a/plotly/validators/scattergl/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='scattergl', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_y.py b/plotly/validators/scattergl/_y.py deleted file mode 100644 index 9ed0ba96a2e..00000000000 --- a/plotly/validators/scattergl/_y.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='scattergl', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_y0.py b/plotly/validators/scattergl/_y0.py deleted file mode 100644 index f4563db3767..00000000000 --- a/plotly/validators/scattergl/_y0.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class Y0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='y0', parent_name='scattergl', **kwargs): - super(Y0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_yaxis.py b/plotly/validators/scattergl/_yaxis.py deleted file mode 100644 index 0430494b228..00000000000 --- a/plotly/validators/scattergl/_yaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='yaxis', parent_name='scattergl', **kwargs): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/_ycalendar.py b/plotly/validators/scattergl/_ycalendar.py deleted file mode 100644 index f1c0ee4e8f9..00000000000 --- a/plotly/validators/scattergl/_ycalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ycalendar', parent_name='scattergl', **kwargs - ): - super(YcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/_ysrc.py b/plotly/validators/scattergl/_ysrc.py deleted file mode 100644 index 4df7e409abc..00000000000 --- a/plotly/validators/scattergl/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='scattergl', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_x/__init__.py b/plotly/validators/scattergl/error_x/__init__.py index c4605e01877..df29083ac75 100644 --- a/plotly/validators/scattergl/error_x/__init__.py +++ b/plotly/validators/scattergl/error_x/__init__.py @@ -1,15 +1,291 @@ -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._valueminus import ValueminusValidator -from ._value import ValueValidator -from ._type import TypeValidator -from ._tracerefminus import TracerefminusValidator -from ._traceref import TracerefValidator -from ._thickness import ThicknessValidator -from ._symmetric import SymmetricValidator -from ._copy_ystyle import CopyYstyleValidator -from ._color import ColorValidator -from ._arraysrc import ArraysrcValidator -from ._arrayminussrc import ArrayminussrcValidator -from ._arrayminus import ArrayminusValidator -from ._array import ArrayValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scattergl.error_x', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='scattergl.error_x', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='valueminus', + parent_name='scattergl.error_x', + **kwargs + ): + super(ValueminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='value', parent_name='scattergl.error_x', **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='scattergl.error_x', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['percent', 'constant', 'sqrt', 'data'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='tracerefminus', + parent_name='scattergl.error_x', + **kwargs + ): + super(TracerefminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='traceref', + parent_name='scattergl.error_x', + **kwargs + ): + super(TracerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='scattergl.error_x', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='symmetric', + parent_name='scattergl.error_x', + **kwargs + ): + super(SymmetricValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CopyYstyleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='copy_ystyle', + parent_name='scattergl.error_x', + **kwargs + ): + super(CopyYstyleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scattergl.error_x', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='arraysrc', + parent_name='scattergl.error_x', + **kwargs + ): + super(ArraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='arrayminussrc', + parent_name='scattergl.error_x', + **kwargs + ): + super(ArrayminussrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='arrayminus', + parent_name='scattergl.error_x', + **kwargs + ): + super(ArrayminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='array', parent_name='scattergl.error_x', **kwargs + ): + super(ArrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/scattergl/error_x/_array.py b/plotly/validators/scattergl/error_x/_array.py deleted file mode 100644 index c5e7945e499..00000000000 --- a/plotly/validators/scattergl/error_x/_array.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='array', parent_name='scattergl.error_x', **kwargs - ): - super(ArrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_x/_arrayminus.py b/plotly/validators/scattergl/error_x/_arrayminus.py deleted file mode 100644 index 92c5fc63fd9..00000000000 --- a/plotly/validators/scattergl/error_x/_arrayminus.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='arrayminus', - parent_name='scattergl.error_x', - **kwargs - ): - super(ArrayminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_x/_arrayminussrc.py b/plotly/validators/scattergl/error_x/_arrayminussrc.py deleted file mode 100644 index 833ff3cabef..00000000000 --- a/plotly/validators/scattergl/error_x/_arrayminussrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='arrayminussrc', - parent_name='scattergl.error_x', - **kwargs - ): - super(ArrayminussrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_x/_arraysrc.py b/plotly/validators/scattergl/error_x/_arraysrc.py deleted file mode 100644 index f09f59d1bb4..00000000000 --- a/plotly/validators/scattergl/error_x/_arraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='arraysrc', - parent_name='scattergl.error_x', - **kwargs - ): - super(ArraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_x/_color.py b/plotly/validators/scattergl/error_x/_color.py deleted file mode 100644 index c70e08810f6..00000000000 --- a/plotly/validators/scattergl/error_x/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scattergl.error_x', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_x/_copy_ystyle.py b/plotly/validators/scattergl/error_x/_copy_ystyle.py deleted file mode 100644 index ceb51ab834f..00000000000 --- a/plotly/validators/scattergl/error_x/_copy_ystyle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CopyYstyleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='copy_ystyle', - parent_name='scattergl.error_x', - **kwargs - ): - super(CopyYstyleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_x/_symmetric.py b/plotly/validators/scattergl/error_x/_symmetric.py deleted file mode 100644 index 5890f19ce33..00000000000 --- a/plotly/validators/scattergl/error_x/_symmetric.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='symmetric', - parent_name='scattergl.error_x', - **kwargs - ): - super(SymmetricValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_x/_thickness.py b/plotly/validators/scattergl/error_x/_thickness.py deleted file mode 100644 index 1d368c8aab4..00000000000 --- a/plotly/validators/scattergl/error_x/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='scattergl.error_x', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_x/_traceref.py b/plotly/validators/scattergl/error_x/_traceref.py deleted file mode 100644 index afb0169ae09..00000000000 --- a/plotly/validators/scattergl/error_x/_traceref.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='traceref', - parent_name='scattergl.error_x', - **kwargs - ): - super(TracerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_x/_tracerefminus.py b/plotly/validators/scattergl/error_x/_tracerefminus.py deleted file mode 100644 index 5c2595956a8..00000000000 --- a/plotly/validators/scattergl/error_x/_tracerefminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='tracerefminus', - parent_name='scattergl.error_x', - **kwargs - ): - super(TracerefminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_x/_type.py b/plotly/validators/scattergl/error_x/_type.py deleted file mode 100644 index 316ff3271f6..00000000000 --- a/plotly/validators/scattergl/error_x/_type.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='scattergl.error_x', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['percent', 'constant', 'sqrt', 'data'] - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_x/_value.py b/plotly/validators/scattergl/error_x/_value.py deleted file mode 100644 index f7c318888ef..00000000000 --- a/plotly/validators/scattergl/error_x/_value.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='value', parent_name='scattergl.error_x', **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_x/_valueminus.py b/plotly/validators/scattergl/error_x/_valueminus.py deleted file mode 100644 index 6ca36cd63c1..00000000000 --- a/plotly/validators/scattergl/error_x/_valueminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='valueminus', - parent_name='scattergl.error_x', - **kwargs - ): - super(ValueminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_x/_visible.py b/plotly/validators/scattergl/error_x/_visible.py deleted file mode 100644 index 10a5690cd3e..00000000000 --- a/plotly/validators/scattergl/error_x/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='scattergl.error_x', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_x/_width.py b/plotly/validators/scattergl/error_x/_width.py deleted file mode 100644 index abeda91fabe..00000000000 --- a/plotly/validators/scattergl/error_x/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scattergl.error_x', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_y/__init__.py b/plotly/validators/scattergl/error_y/__init__.py index 2fc70c4058d..5dea807b017 100644 --- a/plotly/validators/scattergl/error_y/__init__.py +++ b/plotly/validators/scattergl/error_y/__init__.py @@ -1,14 +1,271 @@ -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._valueminus import ValueminusValidator -from ._value import ValueValidator -from ._type import TypeValidator -from ._tracerefminus import TracerefminusValidator -from ._traceref import TracerefValidator -from ._thickness import ThicknessValidator -from ._symmetric import SymmetricValidator -from ._color import ColorValidator -from ._arraysrc import ArraysrcValidator -from ._arrayminussrc import ArrayminussrcValidator -from ._arrayminus import ArrayminusValidator -from ._array import ArrayValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scattergl.error_y', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='scattergl.error_y', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='valueminus', + parent_name='scattergl.error_y', + **kwargs + ): + super(ValueminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='value', parent_name='scattergl.error_y', **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='scattergl.error_y', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', ['percent', 'constant', 'sqrt', 'data'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='tracerefminus', + parent_name='scattergl.error_y', + **kwargs + ): + super(TracerefminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='traceref', + parent_name='scattergl.error_y', + **kwargs + ): + super(TracerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='scattergl.error_y', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='symmetric', + parent_name='scattergl.error_y', + **kwargs + ): + super(SymmetricValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scattergl.error_y', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='arraysrc', + parent_name='scattergl.error_y', + **kwargs + ): + super(ArraysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='arrayminussrc', + parent_name='scattergl.error_y', + **kwargs + ): + super(ArrayminussrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='arrayminus', + parent_name='scattergl.error_y', + **kwargs + ): + super(ArrayminusValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='array', parent_name='scattergl.error_y', **kwargs + ): + super(ArrayValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/scattergl/error_y/_array.py b/plotly/validators/scattergl/error_y/_array.py deleted file mode 100644 index 9729bac4125..00000000000 --- a/plotly/validators/scattergl/error_y/_array.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='array', parent_name='scattergl.error_y', **kwargs - ): - super(ArrayValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_y/_arrayminus.py b/plotly/validators/scattergl/error_y/_arrayminus.py deleted file mode 100644 index 0411e0f9b37..00000000000 --- a/plotly/validators/scattergl/error_y/_arrayminus.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminusValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='arrayminus', - parent_name='scattergl.error_y', - **kwargs - ): - super(ArrayminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_y/_arrayminussrc.py b/plotly/validators/scattergl/error_y/_arrayminussrc.py deleted file mode 100644 index 49635974d02..00000000000 --- a/plotly/validators/scattergl/error_y/_arrayminussrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArrayminussrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='arrayminussrc', - parent_name='scattergl.error_y', - **kwargs - ): - super(ArrayminussrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_y/_arraysrc.py b/plotly/validators/scattergl/error_y/_arraysrc.py deleted file mode 100644 index 23ab6074b8f..00000000000 --- a/plotly/validators/scattergl/error_y/_arraysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ArraysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='arraysrc', - parent_name='scattergl.error_y', - **kwargs - ): - super(ArraysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_y/_color.py b/plotly/validators/scattergl/error_y/_color.py deleted file mode 100644 index 6ce21a851d7..00000000000 --- a/plotly/validators/scattergl/error_y/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scattergl.error_y', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_y/_symmetric.py b/plotly/validators/scattergl/error_y/_symmetric.py deleted file mode 100644 index 9ac2d50366a..00000000000 --- a/plotly/validators/scattergl/error_y/_symmetric.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymmetricValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='symmetric', - parent_name='scattergl.error_y', - **kwargs - ): - super(SymmetricValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_y/_thickness.py b/plotly/validators/scattergl/error_y/_thickness.py deleted file mode 100644 index d83818326e7..00000000000 --- a/plotly/validators/scattergl/error_y/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='scattergl.error_y', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_y/_traceref.py b/plotly/validators/scattergl/error_y/_traceref.py deleted file mode 100644 index 057e58819ed..00000000000 --- a/plotly/validators/scattergl/error_y/_traceref.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='traceref', - parent_name='scattergl.error_y', - **kwargs - ): - super(TracerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_y/_tracerefminus.py b/plotly/validators/scattergl/error_y/_tracerefminus.py deleted file mode 100644 index aaf48ff5cac..00000000000 --- a/plotly/validators/scattergl/error_y/_tracerefminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TracerefminusValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='tracerefminus', - parent_name='scattergl.error_y', - **kwargs - ): - super(TracerefminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_y/_type.py b/plotly/validators/scattergl/error_y/_type.py deleted file mode 100644 index e742ed2e9ff..00000000000 --- a/plotly/validators/scattergl/error_y/_type.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='scattergl.error_y', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', ['percent', 'constant', 'sqrt', 'data'] - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_y/_value.py b/plotly/validators/scattergl/error_y/_value.py deleted file mode 100644 index 7d884146464..00000000000 --- a/plotly/validators/scattergl/error_y/_value.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='value', parent_name='scattergl.error_y', **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_y/_valueminus.py b/plotly/validators/scattergl/error_y/_valueminus.py deleted file mode 100644 index 6e2e2b58767..00000000000 --- a/plotly/validators/scattergl/error_y/_valueminus.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueminusValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='valueminus', - parent_name='scattergl.error_y', - **kwargs - ): - super(ValueminusValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_y/_visible.py b/plotly/validators/scattergl/error_y/_visible.py deleted file mode 100644 index 0bbb7456c26..00000000000 --- a/plotly/validators/scattergl/error_y/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='scattergl.error_y', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/error_y/_width.py b/plotly/validators/scattergl/error_y/_width.py deleted file mode 100644 index 62fbbdd6182..00000000000 --- a/plotly/validators/scattergl/error_y/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scattergl.error_y', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/hoverlabel/__init__.py b/plotly/validators/scattergl/hoverlabel/__init__.py index 856f769ba33..21a416647b8 100644 --- a/plotly/validators/scattergl/hoverlabel/__init__.py +++ b/plotly/validators/scattergl/hoverlabel/__init__.py @@ -1,7 +1,173 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='scattergl.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='scattergl.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='scattergl.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='scattergl.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scattergl.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='scattergl.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scattergl.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergl/hoverlabel/_bgcolor.py b/plotly/validators/scattergl/hoverlabel/_bgcolor.py deleted file mode 100644 index 916de87a13e..00000000000 --- a/plotly/validators/scattergl/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scattergl.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/hoverlabel/_bgcolorsrc.py b/plotly/validators/scattergl/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index b040c531fd9..00000000000 --- a/plotly/validators/scattergl/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='scattergl.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/hoverlabel/_bordercolor.py b/plotly/validators/scattergl/hoverlabel/_bordercolor.py deleted file mode 100644 index 1a60b32d409..00000000000 --- a/plotly/validators/scattergl/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scattergl.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/hoverlabel/_bordercolorsrc.py b/plotly/validators/scattergl/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index a1e4a3ab4f3..00000000000 --- a/plotly/validators/scattergl/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='scattergl.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/hoverlabel/_font.py b/plotly/validators/scattergl/hoverlabel/_font.py deleted file mode 100644 index d5e37b624cc..00000000000 --- a/plotly/validators/scattergl/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='scattergl.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/hoverlabel/_namelength.py b/plotly/validators/scattergl/hoverlabel/_namelength.py deleted file mode 100644 index 775bb1144ae..00000000000 --- a/plotly/validators/scattergl/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='scattergl.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/hoverlabel/_namelengthsrc.py b/plotly/validators/scattergl/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 3fc92d4af27..00000000000 --- a/plotly/validators/scattergl/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='scattergl.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/hoverlabel/font/__init__.py b/plotly/validators/scattergl/hoverlabel/font/__init__.py index 1d2c591d1e5..9ceb376b563 100644 --- a/plotly/validators/scattergl/hoverlabel/font/__init__.py +++ b/plotly/validators/scattergl/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scattergl.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattergl.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='scattergl.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scattergl.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scattergl.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergl.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergl/hoverlabel/font/_color.py b/plotly/validators/scattergl/hoverlabel/font/_color.py deleted file mode 100644 index ac165d1720c..00000000000 --- a/plotly/validators/scattergl/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergl.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/hoverlabel/font/_colorsrc.py b/plotly/validators/scattergl/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 61864f0bea2..00000000000 --- a/plotly/validators/scattergl/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scattergl.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/hoverlabel/font/_family.py b/plotly/validators/scattergl/hoverlabel/font/_family.py deleted file mode 100644 index 329dc635c1b..00000000000 --- a/plotly/validators/scattergl/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scattergl.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattergl/hoverlabel/font/_familysrc.py b/plotly/validators/scattergl/hoverlabel/font/_familysrc.py deleted file mode 100644 index a369b4c043e..00000000000 --- a/plotly/validators/scattergl/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='scattergl.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/hoverlabel/font/_size.py b/plotly/validators/scattergl/hoverlabel/font/_size.py deleted file mode 100644 index 85790ee13a3..00000000000 --- a/plotly/validators/scattergl/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattergl.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/hoverlabel/font/_sizesrc.py b/plotly/validators/scattergl/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 46aeadb4e22..00000000000 --- a/plotly/validators/scattergl/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scattergl.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/line/__init__.py b/plotly/validators/scattergl/line/__init__.py index 158af14294f..d50b584fa12 100644 --- a/plotly/validators/scattergl/line/__init__.py +++ b/plotly/validators/scattergl/line/__init__.py @@ -1,4 +1,76 @@ -from ._width import WidthValidator -from ._shape import ShapeValidator -from ._dash import DashValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scattergl.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShapeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='shape', parent_name='scattergl.line', **kwargs + ): + super(ShapeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['linear', 'hv', 'vh', 'hvh', 'vhv']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='dash', parent_name='scattergl.line', **kwargs + ): + super(DashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scattergl.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergl/line/_color.py b/plotly/validators/scattergl/line/_color.py deleted file mode 100644 index 891123a54c6..00000000000 --- a/plotly/validators/scattergl/line/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scattergl.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/line/_dash.py b/plotly/validators/scattergl/line/_dash.py deleted file mode 100644 index 287108c1c74..00000000000 --- a/plotly/validators/scattergl/line/_dash.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='dash', parent_name='scattergl.line', **kwargs - ): - super(DashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/line/_shape.py b/plotly/validators/scattergl/line/_shape.py deleted file mode 100644 index 08c82a8a7f9..00000000000 --- a/plotly/validators/scattergl/line/_shape.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShapeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='shape', parent_name='scattergl.line', **kwargs - ): - super(ShapeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['linear', 'hv', 'vh', 'hvh', 'vhv']), - **kwargs - ) diff --git a/plotly/validators/scattergl/line/_width.py b/plotly/validators/scattergl/line/_width.py deleted file mode 100644 index 4a9e97956a8..00000000000 --- a/plotly/validators/scattergl/line/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scattergl.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/__init__.py b/plotly/validators/scattergl/marker/__init__.py index bad65b61294..e482936d4a9 100644 --- a/plotly/validators/scattergl/marker/__init__.py +++ b/plotly/validators/scattergl/marker/__init__.py @@ -1,21 +1,754 @@ -from ._symbolsrc import SymbolsrcValidator -from ._symbol import SymbolValidator -from ._sizesrc import SizesrcValidator -from ._sizeref import SizerefValidator -from ._sizemode import SizemodeValidator -from ._sizemin import SizeminValidator -from ._size import SizeValidator -from ._showscale import ShowscaleValidator -from ._reversescale import ReversescaleValidator -from ._opacitysrc import OpacitysrcValidator -from ._opacity import OpacityValidator -from ._line import LineValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='symbolsrc', + parent_name='scattergl.marker', + **kwargs + ): + super(SymbolsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='symbol', parent_name='scattergl.marker', **kwargs + ): + super(SymbolValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, + 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', + 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', + 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', + 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', + 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, + 'star-triangle-down-open', 220, 'star-triangle-down-dot', + 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', + 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, + 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, + 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, + 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='sizesrc', parent_name='scattergl.marker', **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sizeref', parent_name='scattergl.marker', **kwargs + ): + super(SizerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='sizemode', parent_name='scattergl.marker', **kwargs + ): + super(SizemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['diameter', 'area']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sizemin', parent_name='scattergl.marker', **kwargs + ): + super(SizeminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='scattergl.marker', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showscale', + parent_name='scattergl.marker', + **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scattergl.marker', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='opacitysrc', + parent_name='scattergl.marker', + **kwargs + ): + super(OpacitysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='scattergl.marker', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='scattergl.marker', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='scattergl.marker', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='scattergl.marker', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='scattergl.marker', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scattergl.marker.colorbar.Tic + kformatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scattergl.marker.colorbar.tickformatstopdefau + lts), sets the default property values to use + for elements of + scattergl.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scattergl.marker.colorbar.Tit + le instance or dict with compatible properties + titlefont + Deprecated: Please use + scattergl.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. + titleside + Deprecated: Please use + scattergl.marker.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scattergl.marker', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scattergl.marker.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='scattergl.marker', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='scattergl.marker', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='scattergl.marker', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='scattergl.marker', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scattergl.marker', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergl/marker/_autocolorscale.py b/plotly/validators/scattergl/marker/_autocolorscale.py deleted file mode 100644 index f2ebbf76d18..00000000000 --- a/plotly/validators/scattergl/marker/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scattergl.marker', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_cauto.py b/plotly/validators/scattergl/marker/_cauto.py deleted file mode 100644 index 7c566500288..00000000000 --- a/plotly/validators/scattergl/marker/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='scattergl.marker', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_cmax.py b/plotly/validators/scattergl/marker/_cmax.py deleted file mode 100644 index f643aa2cfab..00000000000 --- a/plotly/validators/scattergl/marker/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='scattergl.marker', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_cmid.py b/plotly/validators/scattergl/marker/_cmid.py deleted file mode 100644 index f8152aa53fd..00000000000 --- a/plotly/validators/scattergl/marker/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='scattergl.marker', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_cmin.py b/plotly/validators/scattergl/marker/_cmin.py deleted file mode 100644 index 42015466b58..00000000000 --- a/plotly/validators/scattergl/marker/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='scattergl.marker', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_color.py b/plotly/validators/scattergl/marker/_color.py deleted file mode 100644 index 711d9c59943..00000000000 --- a/plotly/validators/scattergl/marker/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scattergl.marker', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scattergl.marker.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_colorbar.py b/plotly/validators/scattergl/marker/_colorbar.py deleted file mode 100644 index 939fa3ec12f..00000000000 --- a/plotly/validators/scattergl/marker/_colorbar.py +++ /dev/null @@ -1,228 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='scattergl.marker', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scattergl.marker.colorbar.Tic - kformatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scattergl.marker.colorbar.tickformatstopdefau - lts), sets the default property values to use - for elements of - scattergl.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scattergl.marker.colorbar.Tit - le instance or dict with compatible properties - titlefont - Deprecated: Please use - scattergl.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. - titleside - Deprecated: Please use - scattergl.marker.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_colorscale.py b/plotly/validators/scattergl/marker/_colorscale.py deleted file mode 100644 index 073b9761835..00000000000 --- a/plotly/validators/scattergl/marker/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='scattergl.marker', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_colorsrc.py b/plotly/validators/scattergl/marker/_colorsrc.py deleted file mode 100644 index bcab0c35a4a..00000000000 --- a/plotly/validators/scattergl/marker/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='scattergl.marker', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_line.py b/plotly/validators/scattergl/marker/_line.py deleted file mode 100644 index 1e426521484..00000000000 --- a/plotly/validators/scattergl/marker/_line.py +++ /dev/null @@ -1,97 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='scattergl.marker', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_opacity.py b/plotly/validators/scattergl/marker/_opacity.py deleted file mode 100644 index 87dbca60e70..00000000000 --- a/plotly/validators/scattergl/marker/_opacity.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='scattergl.marker', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_opacitysrc.py b/plotly/validators/scattergl/marker/_opacitysrc.py deleted file mode 100644 index 19adfaaeb9f..00000000000 --- a/plotly/validators/scattergl/marker/_opacitysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='opacitysrc', - parent_name='scattergl.marker', - **kwargs - ): - super(OpacitysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_reversescale.py b/plotly/validators/scattergl/marker/_reversescale.py deleted file mode 100644 index 00aff026ff0..00000000000 --- a/plotly/validators/scattergl/marker/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scattergl.marker', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_showscale.py b/plotly/validators/scattergl/marker/_showscale.py deleted file mode 100644 index 9af3f0a67df..00000000000 --- a/plotly/validators/scattergl/marker/_showscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showscale', - parent_name='scattergl.marker', - **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_size.py b/plotly/validators/scattergl/marker/_size.py deleted file mode 100644 index 783694c1cb2..00000000000 --- a/plotly/validators/scattergl/marker/_size.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='scattergl.marker', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_sizemin.py b/plotly/validators/scattergl/marker/_sizemin.py deleted file mode 100644 index a5ed7626b98..00000000000 --- a/plotly/validators/scattergl/marker/_sizemin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sizemin', parent_name='scattergl.marker', **kwargs - ): - super(SizeminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_sizemode.py b/plotly/validators/scattergl/marker/_sizemode.py deleted file mode 100644 index f0623796dfc..00000000000 --- a/plotly/validators/scattergl/marker/_sizemode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='sizemode', parent_name='scattergl.marker', **kwargs - ): - super(SizemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['diameter', 'area']), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_sizeref.py b/plotly/validators/scattergl/marker/_sizeref.py deleted file mode 100644 index d87737cd742..00000000000 --- a/plotly/validators/scattergl/marker/_sizeref.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sizeref', parent_name='scattergl.marker', **kwargs - ): - super(SizerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_sizesrc.py b/plotly/validators/scattergl/marker/_sizesrc.py deleted file mode 100644 index bc80d2b1303..00000000000 --- a/plotly/validators/scattergl/marker/_sizesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='sizesrc', parent_name='scattergl.marker', **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_symbol.py b/plotly/validators/scattergl/marker/_symbol.py deleted file mode 100644 index 13df22e84cc..00000000000 --- a/plotly/validators/scattergl/marker/_symbol.py +++ /dev/null @@ -1,78 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='symbol', parent_name='scattergl.marker', **kwargs - ): - super(SymbolValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, - 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', - 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', - 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', - 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', - 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, - 'star-triangle-down-open', 220, 'star-triangle-down-dot', - 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', - 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, - 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, - 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, - 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/_symbolsrc.py b/plotly/validators/scattergl/marker/_symbolsrc.py deleted file mode 100644 index 22dcee744a5..00000000000 --- a/plotly/validators/scattergl/marker/_symbolsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='symbolsrc', - parent_name='scattergl.marker', - **kwargs - ): - super(SymbolsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/__init__.py b/plotly/validators/scattergl/marker/colorbar/__init__.py index 3dab31f7e02..3558c8b58d4 100644 --- a/plotly/validators/scattergl/marker/colorbar/__init__.py +++ b/plotly/validators/scattergl/marker/colorbar/__init__.py @@ -1,41 +1,936 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ypad', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='y', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xpad', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='x', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='len', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scattergl.marker.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergl/marker/colorbar/_bgcolor.py b/plotly/validators/scattergl/marker/colorbar/_bgcolor.py deleted file mode 100644 index 16443630a6b..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_bordercolor.py b/plotly/validators/scattergl/marker/colorbar/_bordercolor.py deleted file mode 100644 index 9fbb6b1c62b..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_borderwidth.py b/plotly/validators/scattergl/marker/colorbar/_borderwidth.py deleted file mode 100644 index f83639ef641..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_dtick.py b/plotly/validators/scattergl/marker/colorbar/_dtick.py deleted file mode 100644 index 071ea29d7bf..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_exponentformat.py b/plotly/validators/scattergl/marker/colorbar/_exponentformat.py deleted file mode 100644 index 669e32913f3..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_len.py b/plotly/validators/scattergl/marker/colorbar/_len.py deleted file mode 100644 index c95ef5810e1..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_len.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='len', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_lenmode.py b/plotly/validators/scattergl/marker/colorbar/_lenmode.py deleted file mode 100644 index e7dff69d4e1..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_nticks.py b/plotly/validators/scattergl/marker/colorbar/_nticks.py deleted file mode 100644 index bd288c95161..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_outlinecolor.py b/plotly/validators/scattergl/marker/colorbar/_outlinecolor.py deleted file mode 100644 index bdfcfbef1a4..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_outlinewidth.py b/plotly/validators/scattergl/marker/colorbar/_outlinewidth.py deleted file mode 100644 index d808c67fcf4..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_separatethousands.py b/plotly/validators/scattergl/marker/colorbar/_separatethousands.py deleted file mode 100644 index 964044b1e27..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_showexponent.py b/plotly/validators/scattergl/marker/colorbar/_showexponent.py deleted file mode 100644 index cf28b5119c5..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_showticklabels.py b/plotly/validators/scattergl/marker/colorbar/_showticklabels.py deleted file mode 100644 index c0ceb59d9dd..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_showtickprefix.py b/plotly/validators/scattergl/marker/colorbar/_showtickprefix.py deleted file mode 100644 index e9d0fe2b236..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_showticksuffix.py b/plotly/validators/scattergl/marker/colorbar/_showticksuffix.py deleted file mode 100644 index e752c7757b6..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_thickness.py b/plotly/validators/scattergl/marker/colorbar/_thickness.py deleted file mode 100644 index 03c0062fb3b..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_thicknessmode.py b/plotly/validators/scattergl/marker/colorbar/_thicknessmode.py deleted file mode 100644 index 6f51f16939e..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_tick0.py b/plotly/validators/scattergl/marker/colorbar/_tick0.py deleted file mode 100644 index 020eabb34aa..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_tickangle.py b/plotly/validators/scattergl/marker/colorbar/_tickangle.py deleted file mode 100644 index a5656d3b1a8..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_tickcolor.py b/plotly/validators/scattergl/marker/colorbar/_tickcolor.py deleted file mode 100644 index 6b7424aa7f0..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_tickfont.py b/plotly/validators/scattergl/marker/colorbar/_tickfont.py deleted file mode 100644 index 1420e1d6b75..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_tickformat.py b/plotly/validators/scattergl/marker/colorbar/_tickformat.py deleted file mode 100644 index 2bf8fdab3ca..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_tickformatstopdefaults.py b/plotly/validators/scattergl/marker/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 313a8c6c5fc..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_tickformatstops.py b/plotly/validators/scattergl/marker/colorbar/_tickformatstops.py deleted file mode 100644 index efc265aec97..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_ticklen.py b/plotly/validators/scattergl/marker/colorbar/_ticklen.py deleted file mode 100644 index c3186d93eb8..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_tickmode.py b/plotly/validators/scattergl/marker/colorbar/_tickmode.py deleted file mode 100644 index c9db26e980a..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_tickprefix.py b/plotly/validators/scattergl/marker/colorbar/_tickprefix.py deleted file mode 100644 index 96727fd86a1..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_ticks.py b/plotly/validators/scattergl/marker/colorbar/_ticks.py deleted file mode 100644 index 31b3f4cf3e5..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_ticksuffix.py b/plotly/validators/scattergl/marker/colorbar/_ticksuffix.py deleted file mode 100644 index b6ae6b6912f..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_ticktext.py b/plotly/validators/scattergl/marker/colorbar/_ticktext.py deleted file mode 100644 index fb20762ce9a..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_ticktextsrc.py b/plotly/validators/scattergl/marker/colorbar/_ticktextsrc.py deleted file mode 100644 index 043368d6d09..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_tickvals.py b/plotly/validators/scattergl/marker/colorbar/_tickvals.py deleted file mode 100644 index c35635da65e..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_tickvalssrc.py b/plotly/validators/scattergl/marker/colorbar/_tickvalssrc.py deleted file mode 100644 index 9eb64508145..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_tickwidth.py b/plotly/validators/scattergl/marker/colorbar/_tickwidth.py deleted file mode 100644 index 4ef050dc4f3..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_title.py b/plotly/validators/scattergl/marker/colorbar/_title.py deleted file mode 100644 index 74619c7b71d..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_x.py b/plotly/validators/scattergl/marker/colorbar/_x.py deleted file mode 100644 index 9632f5d73b7..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_x.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='x', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_xanchor.py b/plotly/validators/scattergl/marker/colorbar/_xanchor.py deleted file mode 100644 index 85f071f97aa..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_xpad.py b/plotly/validators/scattergl/marker/colorbar/_xpad.py deleted file mode 100644 index 55ddf155a5f..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_xpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xpad', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_y.py b/plotly/validators/scattergl/marker/colorbar/_y.py deleted file mode 100644 index cce3181f04a..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_y.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='y', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_yanchor.py b/plotly/validators/scattergl/marker/colorbar/_yanchor.py deleted file mode 100644 index 4574fe7625b..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/_ypad.py b/plotly/validators/scattergl/marker/colorbar/_ypad.py deleted file mode 100644 index 9a8add25c7f..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/_ypad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ypad', - parent_name='scattergl.marker.colorbar', - **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/tickfont/__init__.py b/plotly/validators/scattergl/marker/colorbar/tickfont/__init__.py index 199d72e71c6..1154f692c7a 100644 --- a/plotly/validators/scattergl/marker/colorbar/tickfont/__init__.py +++ b/plotly/validators/scattergl/marker/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattergl.marker.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scattergl.marker.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergl.marker.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergl/marker/colorbar/tickfont/_color.py b/plotly/validators/scattergl/marker/colorbar/tickfont/_color.py deleted file mode 100644 index 3a04c50bb89..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergl.marker.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/tickfont/_family.py b/plotly/validators/scattergl/marker/colorbar/tickfont/_family.py deleted file mode 100644 index f86d66f8082..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scattergl.marker.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/tickfont/_size.py b/plotly/validators/scattergl/marker/colorbar/tickfont/_size.py deleted file mode 100644 index f5fdf5bb7b5..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattergl.marker.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/tickformatstop/__init__.py b/plotly/validators/scattergl/marker/colorbar/tickformatstop/__init__.py index 3f6c06cac47..f281bafd2d9 100644 --- a/plotly/validators/scattergl/marker/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/scattergl/marker/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='scattergl.marker.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='scattergl.marker.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='scattergl.marker.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='scattergl.marker.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='scattergl.marker.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'calc' + }, { + 'valType': 'any', + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scattergl/marker/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/scattergl/marker/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 6420101188a..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='scattergl.marker.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'calc' - }, { - 'valType': 'any', - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/tickformatstop/_enabled.py b/plotly/validators/scattergl/marker/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index c68c0b26d65..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='scattergl.marker.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/tickformatstop/_name.py b/plotly/validators/scattergl/marker/colorbar/tickformatstop/_name.py deleted file mode 100644 index 505d1193b6b..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='scattergl.marker.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/scattergl/marker/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 63f6f975093..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='scattergl.marker.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/tickformatstop/_value.py b/plotly/validators/scattergl/marker/colorbar/tickformatstop/_value.py deleted file mode 100644 index 3d6ac8eefe4..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='scattergl.marker.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/title/__init__.py b/plotly/validators/scattergl/marker/colorbar/title/__init__.py index 33c9c145bb8..6c44eb0eca9 100644 --- a/plotly/validators/scattergl/marker/colorbar/title/__init__.py +++ b/plotly/validators/scattergl/marker/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='scattergl.marker.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='scattergl.marker.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='scattergl.marker.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/scattergl/marker/colorbar/title/_font.py b/plotly/validators/scattergl/marker/colorbar/title/_font.py deleted file mode 100644 index 56a1e8c707d..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='scattergl.marker.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/title/_side.py b/plotly/validators/scattergl/marker/colorbar/title/_side.py deleted file mode 100644 index 2b93a1c15fc..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='scattergl.marker.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/title/_text.py b/plotly/validators/scattergl/marker/colorbar/title/_text.py deleted file mode 100644 index 519b7f85e17..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='scattergl.marker.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/title/font/__init__.py b/plotly/validators/scattergl/marker/colorbar/title/font/__init__.py index 199d72e71c6..c8813e1dd16 100644 --- a/plotly/validators/scattergl/marker/colorbar/title/font/__init__.py +++ b/plotly/validators/scattergl/marker/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattergl.marker.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scattergl.marker.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergl.marker.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergl/marker/colorbar/title/font/_color.py b/plotly/validators/scattergl/marker/colorbar/title/font/_color.py deleted file mode 100644 index a8f7a5d6bf4..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergl.marker.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/title/font/_family.py b/plotly/validators/scattergl/marker/colorbar/title/font/_family.py deleted file mode 100644 index 4b59054d589..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scattergl.marker.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/colorbar/title/font/_size.py b/plotly/validators/scattergl/marker/colorbar/title/font/_size.py deleted file mode 100644 index bf6e6c0dd1d..00000000000 --- a/plotly/validators/scattergl/marker/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattergl.marker.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/line/__init__.py b/plotly/validators/scattergl/marker/line/__init__.py index c031ca61ce2..532549a8129 100644 --- a/plotly/validators/scattergl/marker/line/__init__.py +++ b/plotly/validators/scattergl/marker/line/__init__.py @@ -1,11 +1,235 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._reversescale import ReversescaleValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='widthsrc', + parent_name='scattergl.marker.line', + **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='scattergl.marker.line', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scattergl.marker.line', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scattergl.marker.line', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='scattergl.marker.line', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergl.marker.line', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scattergl.marker.line.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmin', + parent_name='scattergl.marker.line', + **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmid', + parent_name='scattergl.marker.line', + **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmax', + parent_name='scattergl.marker.line', + **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='cauto', + parent_name='scattergl.marker.line', + **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scattergl.marker.line', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergl/marker/line/_autocolorscale.py b/plotly/validators/scattergl/marker/line/_autocolorscale.py deleted file mode 100644 index b89919ab382..00000000000 --- a/plotly/validators/scattergl/marker/line/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scattergl.marker.line', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/line/_cauto.py b/plotly/validators/scattergl/marker/line/_cauto.py deleted file mode 100644 index 9681b087724..00000000000 --- a/plotly/validators/scattergl/marker/line/_cauto.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='cauto', - parent_name='scattergl.marker.line', - **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/line/_cmax.py b/plotly/validators/scattergl/marker/line/_cmax.py deleted file mode 100644 index b7b9518d84f..00000000000 --- a/plotly/validators/scattergl/marker/line/_cmax.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmax', - parent_name='scattergl.marker.line', - **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/line/_cmid.py b/plotly/validators/scattergl/marker/line/_cmid.py deleted file mode 100644 index c8962db980b..00000000000 --- a/plotly/validators/scattergl/marker/line/_cmid.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmid', - parent_name='scattergl.marker.line', - **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/line/_cmin.py b/plotly/validators/scattergl/marker/line/_cmin.py deleted file mode 100644 index 8bb038ef49a..00000000000 --- a/plotly/validators/scattergl/marker/line/_cmin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmin', - parent_name='scattergl.marker.line', - **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/line/_color.py b/plotly/validators/scattergl/marker/line/_color.py deleted file mode 100644 index 3ee64df1f82..00000000000 --- a/plotly/validators/scattergl/marker/line/_color.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergl.marker.line', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scattergl.marker.line.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/line/_colorscale.py b/plotly/validators/scattergl/marker/line/_colorscale.py deleted file mode 100644 index 8fb706e36e4..00000000000 --- a/plotly/validators/scattergl/marker/line/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='scattergl.marker.line', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/line/_colorsrc.py b/plotly/validators/scattergl/marker/line/_colorsrc.py deleted file mode 100644 index a740661ee12..00000000000 --- a/plotly/validators/scattergl/marker/line/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scattergl.marker.line', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/line/_reversescale.py b/plotly/validators/scattergl/marker/line/_reversescale.py deleted file mode 100644 index 41f6b33e7d6..00000000000 --- a/plotly/validators/scattergl/marker/line/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scattergl.marker.line', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/line/_width.py b/plotly/validators/scattergl/marker/line/_width.py deleted file mode 100644 index 3835e3a9749..00000000000 --- a/plotly/validators/scattergl/marker/line/_width.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='scattergl.marker.line', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/marker/line/_widthsrc.py b/plotly/validators/scattergl/marker/line/_widthsrc.py deleted file mode 100644 index b35156203f5..00000000000 --- a/plotly/validators/scattergl/marker/line/_widthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='widthsrc', - parent_name='scattergl.marker.line', - **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/selected/__init__.py b/plotly/validators/scattergl/selected/__init__.py index f1a1ef3742f..cc38f906101 100644 --- a/plotly/validators/scattergl/selected/__init__.py +++ b/plotly/validators/scattergl/selected/__init__.py @@ -1,2 +1,51 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='scattergl.selected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of selected points. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='scattergl.selected', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scattergl/selected/_marker.py b/plotly/validators/scattergl/selected/_marker.py deleted file mode 100644 index e98cd1a0de9..00000000000 --- a/plotly/validators/scattergl/selected/_marker.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='scattergl.selected', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/selected/_textfont.py b/plotly/validators/scattergl/selected/_textfont.py deleted file mode 100644 index 2805b7fe124..00000000000 --- a/plotly/validators/scattergl/selected/_textfont.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='scattergl.selected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/selected/marker/__init__.py b/plotly/validators/scattergl/selected/marker/__init__.py index ed9a9070947..6dc398e4383 100644 --- a/plotly/validators/scattergl/selected/marker/__init__.py +++ b/plotly/validators/scattergl/selected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattergl.selected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scattergl.selected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergl.selected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergl/selected/marker/_color.py b/plotly/validators/scattergl/selected/marker/_color.py deleted file mode 100644 index 1a8b3fe7b13..00000000000 --- a/plotly/validators/scattergl/selected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergl.selected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/selected/marker/_opacity.py b/plotly/validators/scattergl/selected/marker/_opacity.py deleted file mode 100644 index 2aab70b67e3..00000000000 --- a/plotly/validators/scattergl/selected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scattergl.selected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/selected/marker/_size.py b/plotly/validators/scattergl/selected/marker/_size.py deleted file mode 100644 index f60af57cb86..00000000000 --- a/plotly/validators/scattergl/selected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattergl.selected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/selected/textfont/__init__.py b/plotly/validators/scattergl/selected/textfont/__init__.py index 74135b3f315..b04a88e5e04 100644 --- a/plotly/validators/scattergl/selected/textfont/__init__.py +++ b/plotly/validators/scattergl/selected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergl.selected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergl/selected/textfont/_color.py b/plotly/validators/scattergl/selected/textfont/_color.py deleted file mode 100644 index 6778a50b093..00000000000 --- a/plotly/validators/scattergl/selected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergl.selected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/stream/__init__.py b/plotly/validators/scattergl/stream/__init__.py index 2f4f2047594..fed726f16c7 100644 --- a/plotly/validators/scattergl/stream/__init__.py +++ b/plotly/validators/scattergl/stream/__init__.py @@ -1,2 +1,41 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='scattergl.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='scattergl.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scattergl/stream/_maxpoints.py b/plotly/validators/scattergl/stream/_maxpoints.py deleted file mode 100644 index ac932e02fd9..00000000000 --- a/plotly/validators/scattergl/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='scattergl.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/stream/_token.py b/plotly/validators/scattergl/stream/_token.py deleted file mode 100644 index 0e09c7c2fb3..00000000000 --- a/plotly/validators/scattergl/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='scattergl.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattergl/textfont/__init__.py b/plotly/validators/scattergl/textfont/__init__.py index 1d2c591d1e5..03ec1497fbe 100644 --- a/plotly/validators/scattergl/textfont/__init__.py +++ b/plotly/validators/scattergl/textfont/__init__.py @@ -1,6 +1,117 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scattergl.textfont', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='scattergl.textfont', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='scattergl.textfont', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='scattergl.textfont', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scattergl.textfont', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scattergl.textfont', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergl/textfont/_color.py b/plotly/validators/scattergl/textfont/_color.py deleted file mode 100644 index 8a04d856096..00000000000 --- a/plotly/validators/scattergl/textfont/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scattergl.textfont', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/textfont/_colorsrc.py b/plotly/validators/scattergl/textfont/_colorsrc.py deleted file mode 100644 index 42c17c19c0d..00000000000 --- a/plotly/validators/scattergl/textfont/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scattergl.textfont', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/textfont/_family.py b/plotly/validators/scattergl/textfont/_family.py deleted file mode 100644 index 4145c248fea..00000000000 --- a/plotly/validators/scattergl/textfont/_family.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='scattergl.textfont', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattergl/textfont/_familysrc.py b/plotly/validators/scattergl/textfont/_familysrc.py deleted file mode 100644 index d53d424adda..00000000000 --- a/plotly/validators/scattergl/textfont/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='scattergl.textfont', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/textfont/_size.py b/plotly/validators/scattergl/textfont/_size.py deleted file mode 100644 index 7a7368d50e9..00000000000 --- a/plotly/validators/scattergl/textfont/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='scattergl.textfont', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/textfont/_sizesrc.py b/plotly/validators/scattergl/textfont/_sizesrc.py deleted file mode 100644 index 932474c100a..00000000000 --- a/plotly/validators/scattergl/textfont/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scattergl.textfont', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattergl/unselected/__init__.py b/plotly/validators/scattergl/unselected/__init__.py index f1a1ef3742f..0a1d4b869df 100644 --- a/plotly/validators/scattergl/unselected/__init__.py +++ b/plotly/validators/scattergl/unselected/__init__.py @@ -1,2 +1,58 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='scattergl.unselected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='scattergl.unselected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of unselected points, + applied only when a selection exists. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scattergl/unselected/_marker.py b/plotly/validators/scattergl/unselected/_marker.py deleted file mode 100644 index 88de4115d61..00000000000 --- a/plotly/validators/scattergl/unselected/_marker.py +++ /dev/null @@ -1,30 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='scattergl.unselected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of unselected points, - applied only when a selection exists. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/unselected/_textfont.py b/plotly/validators/scattergl/unselected/_textfont.py deleted file mode 100644 index 41d74bc2dd1..00000000000 --- a/plotly/validators/scattergl/unselected/_textfont.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='scattergl.unselected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattergl/unselected/marker/__init__.py b/plotly/validators/scattergl/unselected/marker/__init__.py index ed9a9070947..aad87a2b59d 100644 --- a/plotly/validators/scattergl/unselected/marker/__init__.py +++ b/plotly/validators/scattergl/unselected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattergl.unselected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scattergl.unselected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergl.unselected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergl/unselected/marker/_color.py b/plotly/validators/scattergl/unselected/marker/_color.py deleted file mode 100644 index 6ab4774f1b5..00000000000 --- a/plotly/validators/scattergl/unselected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergl.unselected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/unselected/marker/_opacity.py b/plotly/validators/scattergl/unselected/marker/_opacity.py deleted file mode 100644 index e55c0937b0f..00000000000 --- a/plotly/validators/scattergl/unselected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scattergl.unselected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/unselected/marker/_size.py b/plotly/validators/scattergl/unselected/marker/_size.py deleted file mode 100644 index 8ece19fe3d2..00000000000 --- a/plotly/validators/scattergl/unselected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattergl.unselected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattergl/unselected/textfont/__init__.py b/plotly/validators/scattergl/unselected/textfont/__init__.py index 74135b3f315..4f0d1114d65 100644 --- a/plotly/validators/scattergl/unselected/textfont/__init__.py +++ b/plotly/validators/scattergl/unselected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattergl.unselected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattergl/unselected/textfont/_color.py b/plotly/validators/scattergl/unselected/textfont/_color.py deleted file mode 100644 index d58a5e4dd10..00000000000 --- a/plotly/validators/scattergl/unselected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattergl.unselected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/__init__.py b/plotly/validators/scattermapbox/__init__.py index 800c11291eb..39a7349d183 100644 --- a/plotly/validators/scattermapbox/__init__.py +++ b/plotly/validators/scattermapbox/__init__.py @@ -1,37 +1,868 @@ -from ._visible import VisibleValidator -from ._unselected import UnselectedValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textsrc import TextsrcValidator -from ._textposition import TextpositionValidator -from ._textfont import TextfontValidator -from ._text import TextValidator -from ._subplot import SubplotValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._selected import SelectedValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._mode import ModeValidator -from ._marker import MarkerValidator -from ._lonsrc import LonsrcValidator -from ._lon import LonValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._latsrc import LatsrcValidator -from ._lat import LatValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._fillcolor import FillcolorValidator -from ._fill import FillValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._connectgaps import ConnectgapsValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='scattermapbox', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='unselected', parent_name='scattermapbox', **kwargs + ): + super(UnselectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Unselected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.scattermapbox.unselected.Mark + er instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='scattermapbox', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='uid', parent_name='scattermapbox', **kwargs + ): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textsrc', parent_name='scattermapbox', **kwargs + ): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='textposition', + parent_name='scattermapbox', + **kwargs + ): + super(TextpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 'top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', + 'bottom center', 'bottom right' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='textfont', parent_name='scattermapbox', **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='text', parent_name='scattermapbox', **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SubplotValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='subplot', parent_name='scattermapbox', **kwargs + ): + super(SubplotValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'mapbox'), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='scattermapbox', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='scattermapbox', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='selectedpoints', + parent_name='scattermapbox', + **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='selected', parent_name='scattermapbox', **kwargs + ): + super(SelectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Selected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.scattermapbox.selected.Marker + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='scattermapbox', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='scattermapbox', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='mode', parent_name='scattermapbox', **kwargs + ): + super(ModeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['none']), + flags=kwargs.pop('flags', ['lines', 'markers', 'text']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='scattermapbox', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scattermapbox.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol. Full list: + https://www.mapbox.com/maki-icons/ Note that + the array `marker.color` and `marker.size` are + only available for "circle" symbols. + symbolsrc + Sets the source reference on plot.ly for + symbol . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LonsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='lonsrc', parent_name='scattermapbox', **kwargs + ): + super(LonsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LonValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='lon', parent_name='scattermapbox', **kwargs + ): + super(LonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='scattermapbox', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the line color. + width + Sets the line width (in px). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='scattermapbox', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LatsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='latsrc', parent_name='scattermapbox', **kwargs + ): + super(LatsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LatValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='lat', parent_name='scattermapbox', **kwargs + ): + super(LatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='scattermapbox', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ids', parent_name='scattermapbox', **kwargs + ): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertextsrc', + parent_name='scattermapbox', + **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='scattermapbox', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertemplatesrc', + parent_name='scattermapbox', + **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hovertemplate', + parent_name='scattermapbox', + **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='scattermapbox', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hoverinfosrc', + parent_name='scattermapbox', + **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='scattermapbox', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['lon', 'lat', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='fillcolor', parent_name='scattermapbox', **kwargs + ): + super(FillcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='fill', parent_name='scattermapbox', **kwargs + ): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['none', 'toself']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='customdatasrc', + parent_name='scattermapbox', + **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='scattermapbox', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='connectgaps', parent_name='scattermapbox', **kwargs + ): + super(ConnectgapsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scattermapbox/_connectgaps.py b/plotly/validators/scattermapbox/_connectgaps.py deleted file mode 100644 index 82650ec84a7..00000000000 --- a/plotly/validators/scattermapbox/_connectgaps.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='connectgaps', parent_name='scattermapbox', **kwargs - ): - super(ConnectgapsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_customdata.py b/plotly/validators/scattermapbox/_customdata.py deleted file mode 100644 index ffea94b39d0..00000000000 --- a/plotly/validators/scattermapbox/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='scattermapbox', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_customdatasrc.py b/plotly/validators/scattermapbox/_customdatasrc.py deleted file mode 100644 index 67ae3bfb2ee..00000000000 --- a/plotly/validators/scattermapbox/_customdatasrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='customdatasrc', - parent_name='scattermapbox', - **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_fill.py b/plotly/validators/scattermapbox/_fill.py deleted file mode 100644 index af7412b1b85..00000000000 --- a/plotly/validators/scattermapbox/_fill.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='fill', parent_name='scattermapbox', **kwargs - ): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['none', 'toself']), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_fillcolor.py b/plotly/validators/scattermapbox/_fillcolor.py deleted file mode 100644 index 92959e8da3a..00000000000 --- a/plotly/validators/scattermapbox/_fillcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='fillcolor', parent_name='scattermapbox', **kwargs - ): - super(FillcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_hoverinfo.py b/plotly/validators/scattermapbox/_hoverinfo.py deleted file mode 100644 index e4636d53d0b..00000000000 --- a/plotly/validators/scattermapbox/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='scattermapbox', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['lon', 'lat', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_hoverinfosrc.py b/plotly/validators/scattermapbox/_hoverinfosrc.py deleted file mode 100644 index eee9e254531..00000000000 --- a/plotly/validators/scattermapbox/_hoverinfosrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hoverinfosrc', - parent_name='scattermapbox', - **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_hoverlabel.py b/plotly/validators/scattermapbox/_hoverlabel.py deleted file mode 100644 index b86eb9ae5e3..00000000000 --- a/plotly/validators/scattermapbox/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='scattermapbox', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_hovertemplate.py b/plotly/validators/scattermapbox/_hovertemplate.py deleted file mode 100644 index 620638e27c4..00000000000 --- a/plotly/validators/scattermapbox/_hovertemplate.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hovertemplate', - parent_name='scattermapbox', - **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_hovertemplatesrc.py b/plotly/validators/scattermapbox/_hovertemplatesrc.py deleted file mode 100644 index 5557e7e32d4..00000000000 --- a/plotly/validators/scattermapbox/_hovertemplatesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertemplatesrc', - parent_name='scattermapbox', - **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_hovertext.py b/plotly/validators/scattermapbox/_hovertext.py deleted file mode 100644 index b96beea50e6..00000000000 --- a/plotly/validators/scattermapbox/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='scattermapbox', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_hovertextsrc.py b/plotly/validators/scattermapbox/_hovertextsrc.py deleted file mode 100644 index f220a4f7479..00000000000 --- a/plotly/validators/scattermapbox/_hovertextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertextsrc', - parent_name='scattermapbox', - **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_ids.py b/plotly/validators/scattermapbox/_ids.py deleted file mode 100644 index 1c11e49f47c..00000000000 --- a/plotly/validators/scattermapbox/_ids.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ids', parent_name='scattermapbox', **kwargs - ): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_idssrc.py b/plotly/validators/scattermapbox/_idssrc.py deleted file mode 100644 index 97aeb5753a3..00000000000 --- a/plotly/validators/scattermapbox/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='scattermapbox', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_lat.py b/plotly/validators/scattermapbox/_lat.py deleted file mode 100644 index d8b19c6866a..00000000000 --- a/plotly/validators/scattermapbox/_lat.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LatValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='lat', parent_name='scattermapbox', **kwargs - ): - super(LatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_latsrc.py b/plotly/validators/scattermapbox/_latsrc.py deleted file mode 100644 index 59482320450..00000000000 --- a/plotly/validators/scattermapbox/_latsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LatsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='latsrc', parent_name='scattermapbox', **kwargs - ): - super(LatsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_legendgroup.py b/plotly/validators/scattermapbox/_legendgroup.py deleted file mode 100644 index 16d2f7724f7..00000000000 --- a/plotly/validators/scattermapbox/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='scattermapbox', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_line.py b/plotly/validators/scattermapbox/_line.py deleted file mode 100644 index c7c9ac67810..00000000000 --- a/plotly/validators/scattermapbox/_line.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='scattermapbox', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the line color. - width - Sets the line width (in px). -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_lon.py b/plotly/validators/scattermapbox/_lon.py deleted file mode 100644 index 9d7c82220dc..00000000000 --- a/plotly/validators/scattermapbox/_lon.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LonValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='lon', parent_name='scattermapbox', **kwargs - ): - super(LonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_lonsrc.py b/plotly/validators/scattermapbox/_lonsrc.py deleted file mode 100644 index 72577fc6149..00000000000 --- a/plotly/validators/scattermapbox/_lonsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LonsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='lonsrc', parent_name='scattermapbox', **kwargs - ): - super(LonsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_marker.py b/plotly/validators/scattermapbox/_marker.py deleted file mode 100644 index f79b1d537f1..00000000000 --- a/plotly/validators/scattermapbox/_marker.py +++ /dev/null @@ -1,126 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='scattermapbox', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scattermapbox.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol. Full list: - https://www.mapbox.com/maki-icons/ Note that - the array `marker.color` and `marker.size` are - only available for "circle" symbols. - symbolsrc - Sets the source reference on plot.ly for - symbol . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_mode.py b/plotly/validators/scattermapbox/_mode.py deleted file mode 100644 index 7d11bb86911..00000000000 --- a/plotly/validators/scattermapbox/_mode.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='mode', parent_name='scattermapbox', **kwargs - ): - super(ModeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['none']), - flags=kwargs.pop('flags', ['lines', 'markers', 'text']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_name.py b/plotly/validators/scattermapbox/_name.py deleted file mode 100644 index 3b683227b78..00000000000 --- a/plotly/validators/scattermapbox/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='scattermapbox', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_opacity.py b/plotly/validators/scattermapbox/_opacity.py deleted file mode 100644 index 9e8aa178b28..00000000000 --- a/plotly/validators/scattermapbox/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='scattermapbox', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_selected.py b/plotly/validators/scattermapbox/_selected.py deleted file mode 100644 index 029b00151d8..00000000000 --- a/plotly/validators/scattermapbox/_selected.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='selected', parent_name='scattermapbox', **kwargs - ): - super(SelectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Selected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.scattermapbox.selected.Marker - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_selectedpoints.py b/plotly/validators/scattermapbox/_selectedpoints.py deleted file mode 100644 index 3ff74ed7e42..00000000000 --- a/plotly/validators/scattermapbox/_selectedpoints.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='selectedpoints', - parent_name='scattermapbox', - **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_showlegend.py b/plotly/validators/scattermapbox/_showlegend.py deleted file mode 100644 index 4360bf08ac7..00000000000 --- a/plotly/validators/scattermapbox/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='scattermapbox', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_stream.py b/plotly/validators/scattermapbox/_stream.py deleted file mode 100644 index 3a2ea41c8cb..00000000000 --- a/plotly/validators/scattermapbox/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='scattermapbox', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_subplot.py b/plotly/validators/scattermapbox/_subplot.py deleted file mode 100644 index b3522e65378..00000000000 --- a/plotly/validators/scattermapbox/_subplot.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SubplotValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='subplot', parent_name='scattermapbox', **kwargs - ): - super(SubplotValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'mapbox'), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_text.py b/plotly/validators/scattermapbox/_text.py deleted file mode 100644 index ef0e3b74777..00000000000 --- a/plotly/validators/scattermapbox/_text.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='text', parent_name='scattermapbox', **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_textfont.py b/plotly/validators/scattermapbox/_textfont.py deleted file mode 100644 index 9dd6f8ec434..00000000000 --- a/plotly/validators/scattermapbox/_textfont.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='textfont', parent_name='scattermapbox', **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_textposition.py b/plotly/validators/scattermapbox/_textposition.py deleted file mode 100644 index 5bf080c9607..00000000000 --- a/plotly/validators/scattermapbox/_textposition.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='textposition', - parent_name='scattermapbox', - **kwargs - ): - super(TextpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 'top left', 'top center', 'top right', 'middle left', - 'middle center', 'middle right', 'bottom left', - 'bottom center', 'bottom right' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_textsrc.py b/plotly/validators/scattermapbox/_textsrc.py deleted file mode 100644 index adf9829a48e..00000000000 --- a/plotly/validators/scattermapbox/_textsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textsrc', parent_name='scattermapbox', **kwargs - ): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_uid.py b/plotly/validators/scattermapbox/_uid.py deleted file mode 100644 index ea8b9261af5..00000000000 --- a/plotly/validators/scattermapbox/_uid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='uid', parent_name='scattermapbox', **kwargs - ): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_uirevision.py b/plotly/validators/scattermapbox/_uirevision.py deleted file mode 100644 index 782e5994be8..00000000000 --- a/plotly/validators/scattermapbox/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='scattermapbox', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_unselected.py b/plotly/validators/scattermapbox/_unselected.py deleted file mode 100644 index 4fa3b999dd5..00000000000 --- a/plotly/validators/scattermapbox/_unselected.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='unselected', parent_name='scattermapbox', **kwargs - ): - super(UnselectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Unselected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.scattermapbox.unselected.Mark - er instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/_visible.py b/plotly/validators/scattermapbox/_visible.py deleted file mode 100644 index ef5acc159e4..00000000000 --- a/plotly/validators/scattermapbox/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='scattermapbox', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/hoverlabel/__init__.py b/plotly/validators/scattermapbox/hoverlabel/__init__.py index 856f769ba33..c79f5e25be0 100644 --- a/plotly/validators/scattermapbox/hoverlabel/__init__.py +++ b/plotly/validators/scattermapbox/hoverlabel/__init__.py @@ -1,7 +1,176 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='scattermapbox.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='scattermapbox.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='scattermapbox.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='scattermapbox.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scattermapbox.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='scattermapbox.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scattermapbox.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattermapbox/hoverlabel/_bgcolor.py b/plotly/validators/scattermapbox/hoverlabel/_bgcolor.py deleted file mode 100644 index c14ba7a0242..00000000000 --- a/plotly/validators/scattermapbox/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scattermapbox.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/hoverlabel/_bgcolorsrc.py b/plotly/validators/scattermapbox/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index b730969d451..00000000000 --- a/plotly/validators/scattermapbox/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='scattermapbox.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/hoverlabel/_bordercolor.py b/plotly/validators/scattermapbox/hoverlabel/_bordercolor.py deleted file mode 100644 index fddd01fad1a..00000000000 --- a/plotly/validators/scattermapbox/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scattermapbox.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/hoverlabel/_bordercolorsrc.py b/plotly/validators/scattermapbox/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 210d8038465..00000000000 --- a/plotly/validators/scattermapbox/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='scattermapbox.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/hoverlabel/_font.py b/plotly/validators/scattermapbox/hoverlabel/_font.py deleted file mode 100644 index 35ad95d2acd..00000000000 --- a/plotly/validators/scattermapbox/hoverlabel/_font.py +++ /dev/null @@ -1,50 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='scattermapbox.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/hoverlabel/_namelength.py b/plotly/validators/scattermapbox/hoverlabel/_namelength.py deleted file mode 100644 index bdbe0ac92a7..00000000000 --- a/plotly/validators/scattermapbox/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='scattermapbox.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/hoverlabel/_namelengthsrc.py b/plotly/validators/scattermapbox/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 85f864775ff..00000000000 --- a/plotly/validators/scattermapbox/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='scattermapbox.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/hoverlabel/font/__init__.py b/plotly/validators/scattermapbox/hoverlabel/font/__init__.py index 1d2c591d1e5..d09828eee24 100644 --- a/plotly/validators/scattermapbox/hoverlabel/font/__init__.py +++ b/plotly/validators/scattermapbox/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scattermapbox.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattermapbox.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='scattermapbox.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scattermapbox.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scattermapbox.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattermapbox.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattermapbox/hoverlabel/font/_color.py b/plotly/validators/scattermapbox/hoverlabel/font/_color.py deleted file mode 100644 index 57ded148002..00000000000 --- a/plotly/validators/scattermapbox/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattermapbox.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/hoverlabel/font/_colorsrc.py b/plotly/validators/scattermapbox/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 84b01ab40f0..00000000000 --- a/plotly/validators/scattermapbox/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scattermapbox.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/hoverlabel/font/_family.py b/plotly/validators/scattermapbox/hoverlabel/font/_family.py deleted file mode 100644 index 2becdd159b9..00000000000 --- a/plotly/validators/scattermapbox/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scattermapbox.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/hoverlabel/font/_familysrc.py b/plotly/validators/scattermapbox/hoverlabel/font/_familysrc.py deleted file mode 100644 index d13e85d8526..00000000000 --- a/plotly/validators/scattermapbox/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='scattermapbox.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/hoverlabel/font/_size.py b/plotly/validators/scattermapbox/hoverlabel/font/_size.py deleted file mode 100644 index 180b8fa8b69..00000000000 --- a/plotly/validators/scattermapbox/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattermapbox.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/hoverlabel/font/_sizesrc.py b/plotly/validators/scattermapbox/hoverlabel/font/_sizesrc.py deleted file mode 100644 index ea17ea5ff35..00000000000 --- a/plotly/validators/scattermapbox/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scattermapbox.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/line/__init__.py b/plotly/validators/scattermapbox/line/__init__.py index 7806a9a1cdc..2d21c32bdc9 100644 --- a/plotly/validators/scattermapbox/line/__init__.py +++ b/plotly/validators/scattermapbox/line/__init__.py @@ -1,2 +1,37 @@ -from ._width import WidthValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scattermapbox.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scattermapbox.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattermapbox/line/_color.py b/plotly/validators/scattermapbox/line/_color.py deleted file mode 100644 index 5e670325151..00000000000 --- a/plotly/validators/scattermapbox/line/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scattermapbox.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/line/_width.py b/plotly/validators/scattermapbox/line/_width.py deleted file mode 100644 index 15088576b3e..00000000000 --- a/plotly/validators/scattermapbox/line/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scattermapbox.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/__init__.py b/plotly/validators/scattermapbox/marker/__init__.py index 08cc71e3222..6de42120ada 100644 --- a/plotly/validators/scattermapbox/marker/__init__.py +++ b/plotly/validators/scattermapbox/marker/__init__.py @@ -1,20 +1,624 @@ -from ._symbolsrc import SymbolsrcValidator -from ._symbol import SymbolValidator -from ._sizesrc import SizesrcValidator -from ._sizeref import SizerefValidator -from ._sizemode import SizemodeValidator -from ._sizemin import SizeminValidator -from ._size import SizeValidator -from ._showscale import ShowscaleValidator -from ._reversescale import ReversescaleValidator -from ._opacitysrc import OpacitysrcValidator -from ._opacity import OpacityValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='symbolsrc', + parent_name='scattermapbox.marker', + **kwargs + ): + super(SymbolsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymbolValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='symbol', + parent_name='scattermapbox.marker', + **kwargs + ): + super(SymbolValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scattermapbox.marker', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='sizeref', + parent_name='scattermapbox.marker', + **kwargs + ): + super(SizerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='sizemode', + parent_name='scattermapbox.marker', + **kwargs + ): + super(SizemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['diameter', 'area']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='sizemin', + parent_name='scattermapbox.marker', + **kwargs + ): + super(SizeminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='scattermapbox.marker', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showscale', + parent_name='scattermapbox.marker', + **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scattermapbox.marker', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='opacitysrc', + parent_name='scattermapbox.marker', + **kwargs + ): + super(OpacitysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scattermapbox.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scattermapbox.marker', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='scattermapbox.marker', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='colorbar', + parent_name='scattermapbox.marker', + **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scattermapbox.marker.colorbar + .Tickformatstop instance or dict with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scattermapbox.marker.colorbar.tickformatstopd + efaults), sets the default property values to + use for elements of + scattermapbox.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scattermapbox.marker.colorbar + .Title instance or dict with compatible + properties + titlefont + Deprecated: Please use + scattermapbox.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. + titleside + Deprecated: Please use + scattermapbox.marker.colorbar.title.side + instead. Determines the location of color bar's + title with respect to the color bar. Note that + the title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattermapbox.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scattermapbox.marker.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='scattermapbox.marker', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='scattermapbox.marker', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='scattermapbox.marker', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='cauto', + parent_name='scattermapbox.marker', + **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scattermapbox.marker', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattermapbox/marker/_autocolorscale.py b/plotly/validators/scattermapbox/marker/_autocolorscale.py deleted file mode 100644 index ae1b9f5600b..00000000000 --- a/plotly/validators/scattermapbox/marker/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scattermapbox.marker', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_cauto.py b/plotly/validators/scattermapbox/marker/_cauto.py deleted file mode 100644 index 0b63b4260d9..00000000000 --- a/plotly/validators/scattermapbox/marker/_cauto.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='cauto', - parent_name='scattermapbox.marker', - **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_cmax.py b/plotly/validators/scattermapbox/marker/_cmax.py deleted file mode 100644 index 12ecbfc29f7..00000000000 --- a/plotly/validators/scattermapbox/marker/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='scattermapbox.marker', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_cmid.py b/plotly/validators/scattermapbox/marker/_cmid.py deleted file mode 100644 index 147c08f8ad7..00000000000 --- a/plotly/validators/scattermapbox/marker/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='scattermapbox.marker', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_cmin.py b/plotly/validators/scattermapbox/marker/_cmin.py deleted file mode 100644 index 9f9dc681aee..00000000000 --- a/plotly/validators/scattermapbox/marker/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='scattermapbox.marker', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_color.py b/plotly/validators/scattermapbox/marker/_color.py deleted file mode 100644 index b71f9c5d4ba..00000000000 --- a/plotly/validators/scattermapbox/marker/_color.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattermapbox.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scattermapbox.marker.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_colorbar.py b/plotly/validators/scattermapbox/marker/_colorbar.py deleted file mode 100644 index d82d97109ec..00000000000 --- a/plotly/validators/scattermapbox/marker/_colorbar.py +++ /dev/null @@ -1,232 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='colorbar', - parent_name='scattermapbox.marker', - **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scattermapbox.marker.colorbar - .Tickformatstop instance or dict with - compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scattermapbox.marker.colorbar.tickformatstopd - efaults), sets the default property values to - use for elements of - scattermapbox.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scattermapbox.marker.colorbar - .Title instance or dict with compatible - properties - titlefont - Deprecated: Please use - scattermapbox.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. - titleside - Deprecated: Please use - scattermapbox.marker.colorbar.title.side - instead. Determines the location of color bar's - title with respect to the color bar. Note that - the title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_colorscale.py b/plotly/validators/scattermapbox/marker/_colorscale.py deleted file mode 100644 index edd145479c8..00000000000 --- a/plotly/validators/scattermapbox/marker/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='scattermapbox.marker', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_colorsrc.py b/plotly/validators/scattermapbox/marker/_colorsrc.py deleted file mode 100644 index e1c2e55c4bd..00000000000 --- a/plotly/validators/scattermapbox/marker/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scattermapbox.marker', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_opacity.py b/plotly/validators/scattermapbox/marker/_opacity.py deleted file mode 100644 index fbd786f9bd3..00000000000 --- a/plotly/validators/scattermapbox/marker/_opacity.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scattermapbox.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_opacitysrc.py b/plotly/validators/scattermapbox/marker/_opacitysrc.py deleted file mode 100644 index e53fb14c310..00000000000 --- a/plotly/validators/scattermapbox/marker/_opacitysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='opacitysrc', - parent_name='scattermapbox.marker', - **kwargs - ): - super(OpacitysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_reversescale.py b/plotly/validators/scattermapbox/marker/_reversescale.py deleted file mode 100644 index 902c92c0b9f..00000000000 --- a/plotly/validators/scattermapbox/marker/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scattermapbox.marker', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_showscale.py b/plotly/validators/scattermapbox/marker/_showscale.py deleted file mode 100644 index 05902fbad3c..00000000000 --- a/plotly/validators/scattermapbox/marker/_showscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showscale', - parent_name='scattermapbox.marker', - **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_size.py b/plotly/validators/scattermapbox/marker/_size.py deleted file mode 100644 index 39b0b678c7f..00000000000 --- a/plotly/validators/scattermapbox/marker/_size.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='scattermapbox.marker', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_sizemin.py b/plotly/validators/scattermapbox/marker/_sizemin.py deleted file mode 100644 index cdee567e568..00000000000 --- a/plotly/validators/scattermapbox/marker/_sizemin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='sizemin', - parent_name='scattermapbox.marker', - **kwargs - ): - super(SizeminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_sizemode.py b/plotly/validators/scattermapbox/marker/_sizemode.py deleted file mode 100644 index 19852386cf4..00000000000 --- a/plotly/validators/scattermapbox/marker/_sizemode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='sizemode', - parent_name='scattermapbox.marker', - **kwargs - ): - super(SizemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['diameter', 'area']), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_sizeref.py b/plotly/validators/scattermapbox/marker/_sizeref.py deleted file mode 100644 index bd04e31617d..00000000000 --- a/plotly/validators/scattermapbox/marker/_sizeref.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='sizeref', - parent_name='scattermapbox.marker', - **kwargs - ): - super(SizerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_sizesrc.py b/plotly/validators/scattermapbox/marker/_sizesrc.py deleted file mode 100644 index aa1dace6d64..00000000000 --- a/plotly/validators/scattermapbox/marker/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scattermapbox.marker', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_symbol.py b/plotly/validators/scattermapbox/marker/_symbol.py deleted file mode 100644 index 5f3c3d88e0f..00000000000 --- a/plotly/validators/scattermapbox/marker/_symbol.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='symbol', - parent_name='scattermapbox.marker', - **kwargs - ): - super(SymbolValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/_symbolsrc.py b/plotly/validators/scattermapbox/marker/_symbolsrc.py deleted file mode 100644 index 5b3711ad30c..00000000000 --- a/plotly/validators/scattermapbox/marker/_symbolsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='symbolsrc', - parent_name='scattermapbox.marker', - **kwargs - ): - super(SymbolsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/__init__.py b/plotly/validators/scattermapbox/marker/colorbar/__init__.py index 3dab31f7e02..9d8e3636024 100644 --- a/plotly/validators/scattermapbox/marker/colorbar/__init__.py +++ b/plotly/validators/scattermapbox/marker/colorbar/__init__.py @@ -1,41 +1,936 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ypad', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='y', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xpad', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='x', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='len', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scattermapbox.marker.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_bgcolor.py b/plotly/validators/scattermapbox/marker/colorbar/_bgcolor.py deleted file mode 100644 index c36ac77776c..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_bordercolor.py b/plotly/validators/scattermapbox/marker/colorbar/_bordercolor.py deleted file mode 100644 index 698cf149aeb..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_borderwidth.py b/plotly/validators/scattermapbox/marker/colorbar/_borderwidth.py deleted file mode 100644 index 384adad4e5b..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_dtick.py b/plotly/validators/scattermapbox/marker/colorbar/_dtick.py deleted file mode 100644 index 8892c9cceb7..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_exponentformat.py b/plotly/validators/scattermapbox/marker/colorbar/_exponentformat.py deleted file mode 100644 index 780120507ee..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_len.py b/plotly/validators/scattermapbox/marker/colorbar/_len.py deleted file mode 100644 index fdce8468a2b..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_len.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='len', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_lenmode.py b/plotly/validators/scattermapbox/marker/colorbar/_lenmode.py deleted file mode 100644 index 1ba8feee714..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_nticks.py b/plotly/validators/scattermapbox/marker/colorbar/_nticks.py deleted file mode 100644 index 8a1bc4c4626..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_outlinecolor.py b/plotly/validators/scattermapbox/marker/colorbar/_outlinecolor.py deleted file mode 100644 index 1e506fbaa4f..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_outlinewidth.py b/plotly/validators/scattermapbox/marker/colorbar/_outlinewidth.py deleted file mode 100644 index 1082409c4ea..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_separatethousands.py b/plotly/validators/scattermapbox/marker/colorbar/_separatethousands.py deleted file mode 100644 index b348b19eb5e..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_showexponent.py b/plotly/validators/scattermapbox/marker/colorbar/_showexponent.py deleted file mode 100644 index 2d9c4ca655e..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_showticklabels.py b/plotly/validators/scattermapbox/marker/colorbar/_showticklabels.py deleted file mode 100644 index 1c5b7231921..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_showtickprefix.py b/plotly/validators/scattermapbox/marker/colorbar/_showtickprefix.py deleted file mode 100644 index 23f1ed8e787..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_showticksuffix.py b/plotly/validators/scattermapbox/marker/colorbar/_showticksuffix.py deleted file mode 100644 index 67fdb9bfc66..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_thickness.py b/plotly/validators/scattermapbox/marker/colorbar/_thickness.py deleted file mode 100644 index f2184f2306d..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_thicknessmode.py b/plotly/validators/scattermapbox/marker/colorbar/_thicknessmode.py deleted file mode 100644 index 1b438ca5d05..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_tick0.py b/plotly/validators/scattermapbox/marker/colorbar/_tick0.py deleted file mode 100644 index 860322b837c..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_tickangle.py b/plotly/validators/scattermapbox/marker/colorbar/_tickangle.py deleted file mode 100644 index 54b949bd929..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_tickcolor.py b/plotly/validators/scattermapbox/marker/colorbar/_tickcolor.py deleted file mode 100644 index ee70d014baa..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_tickfont.py b/plotly/validators/scattermapbox/marker/colorbar/_tickfont.py deleted file mode 100644 index 476feddd7e3..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_tickformat.py b/plotly/validators/scattermapbox/marker/colorbar/_tickformat.py deleted file mode 100644 index f2fd0081dbf..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_tickformatstopdefaults.py b/plotly/validators/scattermapbox/marker/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index abf92069ba9..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_tickformatstops.py b/plotly/validators/scattermapbox/marker/colorbar/_tickformatstops.py deleted file mode 100644 index 257fe90997a..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_ticklen.py b/plotly/validators/scattermapbox/marker/colorbar/_ticklen.py deleted file mode 100644 index 59fd4b99c8e..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_tickmode.py b/plotly/validators/scattermapbox/marker/colorbar/_tickmode.py deleted file mode 100644 index c651297a62a..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_tickprefix.py b/plotly/validators/scattermapbox/marker/colorbar/_tickprefix.py deleted file mode 100644 index 5e123bfc485..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_ticks.py b/plotly/validators/scattermapbox/marker/colorbar/_ticks.py deleted file mode 100644 index 2a8d1ecd963..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_ticksuffix.py b/plotly/validators/scattermapbox/marker/colorbar/_ticksuffix.py deleted file mode 100644 index 43da501db71..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_ticktext.py b/plotly/validators/scattermapbox/marker/colorbar/_ticktext.py deleted file mode 100644 index b8e9a10eb16..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_ticktextsrc.py b/plotly/validators/scattermapbox/marker/colorbar/_ticktextsrc.py deleted file mode 100644 index 3c88837de3b..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_tickvals.py b/plotly/validators/scattermapbox/marker/colorbar/_tickvals.py deleted file mode 100644 index 136da495b1f..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_tickvalssrc.py b/plotly/validators/scattermapbox/marker/colorbar/_tickvalssrc.py deleted file mode 100644 index acbaf43d852..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_tickwidth.py b/plotly/validators/scattermapbox/marker/colorbar/_tickwidth.py deleted file mode 100644 index 4036fd6436b..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_title.py b/plotly/validators/scattermapbox/marker/colorbar/_title.py deleted file mode 100644 index 7c643ea8de0..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_x.py b/plotly/validators/scattermapbox/marker/colorbar/_x.py deleted file mode 100644 index cb3f4e5123f..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_x.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='x', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_xanchor.py b/plotly/validators/scattermapbox/marker/colorbar/_xanchor.py deleted file mode 100644 index c15ec80b502..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_xpad.py b/plotly/validators/scattermapbox/marker/colorbar/_xpad.py deleted file mode 100644 index 9822cd28584..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_xpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xpad', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_y.py b/plotly/validators/scattermapbox/marker/colorbar/_y.py deleted file mode 100644 index 560a658d3ae..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_y.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='y', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_yanchor.py b/plotly/validators/scattermapbox/marker/colorbar/_yanchor.py deleted file mode 100644 index ab9c2b0197a..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/_ypad.py b/plotly/validators/scattermapbox/marker/colorbar/_ypad.py deleted file mode 100644 index 49603c83ac7..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/_ypad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ypad', - parent_name='scattermapbox.marker.colorbar', - **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/tickfont/__init__.py b/plotly/validators/scattermapbox/marker/colorbar/tickfont/__init__.py index 199d72e71c6..cfccc2bfe1b 100644 --- a/plotly/validators/scattermapbox/marker/colorbar/tickfont/__init__.py +++ b/plotly/validators/scattermapbox/marker/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattermapbox.marker.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scattermapbox.marker.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattermapbox.marker.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/tickfont/_color.py b/plotly/validators/scattermapbox/marker/colorbar/tickfont/_color.py deleted file mode 100644 index 9793538509a..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattermapbox.marker.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/tickfont/_family.py b/plotly/validators/scattermapbox/marker/colorbar/tickfont/_family.py deleted file mode 100644 index e8fd929f8e7..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scattermapbox.marker.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/tickfont/_size.py b/plotly/validators/scattermapbox/marker/colorbar/tickfont/_size.py deleted file mode 100644 index bdabe4e652f..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattermapbox.marker.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/__init__.py b/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/__init__.py index 3f6c06cac47..4e3c0b38d02 100644 --- a/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='scattermapbox.marker.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='scattermapbox.marker.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='scattermapbox.marker.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='scattermapbox.marker.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='scattermapbox.marker.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'calc' + }, { + 'valType': 'any', + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 8a9f78c6913..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='scattermapbox.marker.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'calc' - }, { - 'valType': 'any', - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/_enabled.py b/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index c2199d0d2e1..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='scattermapbox.marker.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/_name.py b/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/_name.py deleted file mode 100644 index c183952b815..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='scattermapbox.marker.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index c35a3721b51..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='scattermapbox.marker.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/_value.py b/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/_value.py deleted file mode 100644 index b4d4ddbf2b8..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='scattermapbox.marker.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/title/__init__.py b/plotly/validators/scattermapbox/marker/colorbar/title/__init__.py index 33c9c145bb8..c5f69882b8d 100644 --- a/plotly/validators/scattermapbox/marker/colorbar/title/__init__.py +++ b/plotly/validators/scattermapbox/marker/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='scattermapbox.marker.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='scattermapbox.marker.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='scattermapbox.marker.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/title/_font.py b/plotly/validators/scattermapbox/marker/colorbar/title/_font.py deleted file mode 100644 index e5fde18e92a..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='scattermapbox.marker.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/title/_side.py b/plotly/validators/scattermapbox/marker/colorbar/title/_side.py deleted file mode 100644 index fc109715260..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='scattermapbox.marker.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/title/_text.py b/plotly/validators/scattermapbox/marker/colorbar/title/_text.py deleted file mode 100644 index 83a7f182af0..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='scattermapbox.marker.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/title/font/__init__.py b/plotly/validators/scattermapbox/marker/colorbar/title/font/__init__.py index 199d72e71c6..28032bb3c71 100644 --- a/plotly/validators/scattermapbox/marker/colorbar/title/font/__init__.py +++ b/plotly/validators/scattermapbox/marker/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattermapbox.marker.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scattermapbox.marker.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattermapbox.marker.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/title/font/_color.py b/plotly/validators/scattermapbox/marker/colorbar/title/font/_color.py deleted file mode 100644 index 4ae141835cf..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattermapbox.marker.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/title/font/_family.py b/plotly/validators/scattermapbox/marker/colorbar/title/font/_family.py deleted file mode 100644 index 6a8aafe22db..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scattermapbox.marker.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/marker/colorbar/title/font/_size.py b/plotly/validators/scattermapbox/marker/colorbar/title/font/_size.py deleted file mode 100644 index f7b4211e0eb..00000000000 --- a/plotly/validators/scattermapbox/marker/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattermapbox.marker.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/selected/__init__.py b/plotly/validators/scattermapbox/selected/__init__.py index 3604b0284fc..5a073db90b3 100644 --- a/plotly/validators/scattermapbox/selected/__init__.py +++ b/plotly/validators/scattermapbox/selected/__init__.py @@ -1 +1,29 @@ -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='scattermapbox.selected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scattermapbox/selected/_marker.py b/plotly/validators/scattermapbox/selected/_marker.py deleted file mode 100644 index 593117bf958..00000000000 --- a/plotly/validators/scattermapbox/selected/_marker.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='scattermapbox.selected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/selected/marker/__init__.py b/plotly/validators/scattermapbox/selected/marker/__init__.py index ed9a9070947..15e4b07d952 100644 --- a/plotly/validators/scattermapbox/selected/marker/__init__.py +++ b/plotly/validators/scattermapbox/selected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattermapbox.selected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scattermapbox.selected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattermapbox.selected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattermapbox/selected/marker/_color.py b/plotly/validators/scattermapbox/selected/marker/_color.py deleted file mode 100644 index f1859de076c..00000000000 --- a/plotly/validators/scattermapbox/selected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattermapbox.selected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/selected/marker/_opacity.py b/plotly/validators/scattermapbox/selected/marker/_opacity.py deleted file mode 100644 index 3e77e9e4068..00000000000 --- a/plotly/validators/scattermapbox/selected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scattermapbox.selected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/selected/marker/_size.py b/plotly/validators/scattermapbox/selected/marker/_size.py deleted file mode 100644 index 67915e5d179..00000000000 --- a/plotly/validators/scattermapbox/selected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattermapbox.selected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/stream/__init__.py b/plotly/validators/scattermapbox/stream/__init__.py index 2f4f2047594..0cd2deb9da9 100644 --- a/plotly/validators/scattermapbox/stream/__init__.py +++ b/plotly/validators/scattermapbox/stream/__init__.py @@ -1,2 +1,44 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='token', + parent_name='scattermapbox.stream', + **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='scattermapbox.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scattermapbox/stream/_maxpoints.py b/plotly/validators/scattermapbox/stream/_maxpoints.py deleted file mode 100644 index 6a755f62cc4..00000000000 --- a/plotly/validators/scattermapbox/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='scattermapbox.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/stream/_token.py b/plotly/validators/scattermapbox/stream/_token.py deleted file mode 100644 index de25e6c3374..00000000000 --- a/plotly/validators/scattermapbox/stream/_token.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='token', - parent_name='scattermapbox.stream', - **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/textfont/__init__.py b/plotly/validators/scattermapbox/textfont/__init__.py index 199d72e71c6..d9d2e48502b 100644 --- a/plotly/validators/scattermapbox/textfont/__init__.py +++ b/plotly/validators/scattermapbox/textfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattermapbox.textfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scattermapbox.textfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattermapbox.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattermapbox/textfont/_color.py b/plotly/validators/scattermapbox/textfont/_color.py deleted file mode 100644 index defb27ab6f7..00000000000 --- a/plotly/validators/scattermapbox/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattermapbox.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/textfont/_family.py b/plotly/validators/scattermapbox/textfont/_family.py deleted file mode 100644 index 4ed39d103a6..00000000000 --- a/plotly/validators/scattermapbox/textfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scattermapbox.textfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/textfont/_size.py b/plotly/validators/scattermapbox/textfont/_size.py deleted file mode 100644 index 2fd139f92c7..00000000000 --- a/plotly/validators/scattermapbox/textfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattermapbox.textfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/unselected/__init__.py b/plotly/validators/scattermapbox/unselected/__init__.py index 3604b0284fc..8727a25cacd 100644 --- a/plotly/validators/scattermapbox/unselected/__init__.py +++ b/plotly/validators/scattermapbox/unselected/__init__.py @@ -1 +1,32 @@ -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='scattermapbox.unselected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of unselected points, + applied only when a selection exists. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scattermapbox/unselected/_marker.py b/plotly/validators/scattermapbox/unselected/_marker.py deleted file mode 100644 index 8258d9e14f1..00000000000 --- a/plotly/validators/scattermapbox/unselected/_marker.py +++ /dev/null @@ -1,30 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='scattermapbox.unselected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of unselected points, - applied only when a selection exists. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/unselected/marker/__init__.py b/plotly/validators/scattermapbox/unselected/marker/__init__.py index ed9a9070947..9dcf6619993 100644 --- a/plotly/validators/scattermapbox/unselected/marker/__init__.py +++ b/plotly/validators/scattermapbox/unselected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scattermapbox.unselected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scattermapbox.unselected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scattermapbox.unselected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scattermapbox/unselected/marker/_color.py b/plotly/validators/scattermapbox/unselected/marker/_color.py deleted file mode 100644 index 0c4d0339ef9..00000000000 --- a/plotly/validators/scattermapbox/unselected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scattermapbox.unselected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/unselected/marker/_opacity.py b/plotly/validators/scattermapbox/unselected/marker/_opacity.py deleted file mode 100644 index af6578e93ed..00000000000 --- a/plotly/validators/scattermapbox/unselected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scattermapbox.unselected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scattermapbox/unselected/marker/_size.py b/plotly/validators/scattermapbox/unselected/marker/_size.py deleted file mode 100644 index 8e5cfa91418..00000000000 --- a/plotly/validators/scattermapbox/unselected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scattermapbox.unselected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/__init__.py b/plotly/validators/scatterpolar/__init__.py index 1380d5362c1..5f40f05241e 100644 --- a/plotly/validators/scatterpolar/__init__.py +++ b/plotly/validators/scatterpolar/__init__.py @@ -1,45 +1,1035 @@ -from ._visible import VisibleValidator -from ._unselected import UnselectedValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._thetaunit import ThetaunitValidator -from ._thetasrc import ThetasrcValidator -from ._theta0 import Theta0Validator -from ._theta import ThetaValidator -from ._textsrc import TextsrcValidator -from ._textpositionsrc import TextpositionsrcValidator -from ._textposition import TextpositionValidator -from ._textfont import TextfontValidator -from ._text import TextValidator -from ._subplot import SubplotValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._selected import SelectedValidator -from ._rsrc import RsrcValidator -from ._r0 import R0Validator -from ._r import RValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._mode import ModeValidator -from ._marker import MarkerValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoveron import HoveronValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._fillcolor import FillcolorValidator -from ._fill import FillValidator -from ._dtheta import DthetaValidator -from ._dr import DrValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._connectgaps import ConnectgapsValidator -from ._cliponaxis import CliponaxisValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='scatterpolar', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='unselected', parent_name='scatterpolar', **kwargs + ): + super(UnselectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Unselected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.scatterpolar.unselected.Marke + r instance or dict with compatible properties + textfont + plotly.graph_objs.scatterpolar.unselected.Textf + ont instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='scatterpolar', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='uid', parent_name='scatterpolar', **kwargs + ): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThetaunitValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='thetaunit', parent_name='scatterpolar', **kwargs + ): + super(ThetaunitValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['radians', 'degrees', 'gradians']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThetasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='thetasrc', parent_name='scatterpolar', **kwargs + ): + super(ThetasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Theta0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='theta0', parent_name='scatterpolar', **kwargs + ): + super(Theta0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThetaValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='theta', parent_name='scatterpolar', **kwargs + ): + super(ThetaValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textsrc', parent_name='scatterpolar', **kwargs + ): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='textpositionsrc', + parent_name='scatterpolar', + **kwargs + ): + super(TextpositionsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='textposition', parent_name='scatterpolar', **kwargs + ): + super(TextpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 'top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', + 'bottom center', 'bottom right' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='textfont', parent_name='scatterpolar', **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='text', parent_name='scatterpolar', **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SubplotValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='subplot', parent_name='scatterpolar', **kwargs + ): + super(SubplotValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'polar'), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='scatterpolar', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='scatterpolar', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='selectedpoints', + parent_name='scatterpolar', + **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='selected', parent_name='scatterpolar', **kwargs + ): + super(SelectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Selected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.scatterpolar.selected.Marker + instance or dict with compatible properties + textfont + plotly.graph_objs.scatterpolar.selected.Textfon + t instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='rsrc', parent_name='scatterpolar', **kwargs + ): + super(RsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class R0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='r0', parent_name='scatterpolar', **kwargs): + super(R0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='r', parent_name='scatterpolar', **kwargs): + super(RValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='scatterpolar', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='scatterpolar', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='mode', parent_name='scatterpolar', **kwargs + ): + super(ModeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['none']), + flags=kwargs.pop('flags', ['lines', 'markers', 'text']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='scatterpolar', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scatterpolar.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + gradient + plotly.graph_objs.scatterpolar.marker.Gradient + instance or dict with compatible properties + line + plotly.graph_objs.scatterpolar.marker.Line + instance or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on + the graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='scatterpolar', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the + lines are drawn using spline interpolation. The + other available values correspond to step-wise + line shapes. + smoothing + Has an effect only if `shape` is set to + "spline" Sets the amount of smoothing. 0 + corresponds to no smoothing (equivalent to a + "linear" shape). + width + Sets the line width (in px). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='scatterpolar', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='scatterpolar', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ids', parent_name='scatterpolar', **kwargs + ): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='scatterpolar', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='scatterpolar', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertemplatesrc', + parent_name='scatterpolar', + **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hovertemplate', + parent_name='scatterpolar', + **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoveronValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoveron', parent_name='scatterpolar', **kwargs + ): + super(HoveronValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + flags=kwargs.pop('flags', ['points', 'fills']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='scatterpolar', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='scatterpolar', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='scatterpolar', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['r', 'theta', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='fillcolor', parent_name='scatterpolar', **kwargs + ): + super(FillcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='fill', parent_name='scatterpolar', **kwargs + ): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['none', 'toself', 'tonext']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DthetaValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='dtheta', parent_name='scatterpolar', **kwargs + ): + super(DthetaValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DrValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='dr', parent_name='scatterpolar', **kwargs): + super(DrValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='customdatasrc', + parent_name='scatterpolar', + **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='scatterpolar', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='connectgaps', parent_name='scatterpolar', **kwargs + ): + super(ConnectgapsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CliponaxisValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cliponaxis', parent_name='scatterpolar', **kwargs + ): + super(CliponaxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/_cliponaxis.py b/plotly/validators/scatterpolar/_cliponaxis.py deleted file mode 100644 index 7d2378383d5..00000000000 --- a/plotly/validators/scatterpolar/_cliponaxis.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CliponaxisValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cliponaxis', parent_name='scatterpolar', **kwargs - ): - super(CliponaxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_connectgaps.py b/plotly/validators/scatterpolar/_connectgaps.py deleted file mode 100644 index 9e0a78327c4..00000000000 --- a/plotly/validators/scatterpolar/_connectgaps.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='connectgaps', parent_name='scatterpolar', **kwargs - ): - super(ConnectgapsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_customdata.py b/plotly/validators/scatterpolar/_customdata.py deleted file mode 100644 index a1175c073db..00000000000 --- a/plotly/validators/scatterpolar/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='scatterpolar', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_customdatasrc.py b/plotly/validators/scatterpolar/_customdatasrc.py deleted file mode 100644 index 40aa9e85a28..00000000000 --- a/plotly/validators/scatterpolar/_customdatasrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='customdatasrc', - parent_name='scatterpolar', - **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_dr.py b/plotly/validators/scatterpolar/_dr.py deleted file mode 100644 index 124bb36cd0d..00000000000 --- a/plotly/validators/scatterpolar/_dr.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class DrValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='dr', parent_name='scatterpolar', **kwargs): - super(DrValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_dtheta.py b/plotly/validators/scatterpolar/_dtheta.py deleted file mode 100644 index 118ab449865..00000000000 --- a/plotly/validators/scatterpolar/_dtheta.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class DthetaValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='dtheta', parent_name='scatterpolar', **kwargs - ): - super(DthetaValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_fill.py b/plotly/validators/scatterpolar/_fill.py deleted file mode 100644 index 5a786ed97af..00000000000 --- a/plotly/validators/scatterpolar/_fill.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='fill', parent_name='scatterpolar', **kwargs - ): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['none', 'toself', 'tonext']), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_fillcolor.py b/plotly/validators/scatterpolar/_fillcolor.py deleted file mode 100644 index 349c0f2393d..00000000000 --- a/plotly/validators/scatterpolar/_fillcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='fillcolor', parent_name='scatterpolar', **kwargs - ): - super(FillcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_hoverinfo.py b/plotly/validators/scatterpolar/_hoverinfo.py deleted file mode 100644 index d3315eb9342..00000000000 --- a/plotly/validators/scatterpolar/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='scatterpolar', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['r', 'theta', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_hoverinfosrc.py b/plotly/validators/scatterpolar/_hoverinfosrc.py deleted file mode 100644 index b29aa786446..00000000000 --- a/plotly/validators/scatterpolar/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='scatterpolar', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_hoverlabel.py b/plotly/validators/scatterpolar/_hoverlabel.py deleted file mode 100644 index 63e5620769d..00000000000 --- a/plotly/validators/scatterpolar/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='scatterpolar', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_hoveron.py b/plotly/validators/scatterpolar/_hoveron.py deleted file mode 100644 index 4dbeb6a7322..00000000000 --- a/plotly/validators/scatterpolar/_hoveron.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoveronValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoveron', parent_name='scatterpolar', **kwargs - ): - super(HoveronValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - flags=kwargs.pop('flags', ['points', 'fills']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_hovertemplate.py b/plotly/validators/scatterpolar/_hovertemplate.py deleted file mode 100644 index e8b54b1cfda..00000000000 --- a/plotly/validators/scatterpolar/_hovertemplate.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hovertemplate', - parent_name='scatterpolar', - **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_hovertemplatesrc.py b/plotly/validators/scatterpolar/_hovertemplatesrc.py deleted file mode 100644 index a2007e4ad08..00000000000 --- a/plotly/validators/scatterpolar/_hovertemplatesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertemplatesrc', - parent_name='scatterpolar', - **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_hovertext.py b/plotly/validators/scatterpolar/_hovertext.py deleted file mode 100644 index d94172448bd..00000000000 --- a/plotly/validators/scatterpolar/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='scatterpolar', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_hovertextsrc.py b/plotly/validators/scatterpolar/_hovertextsrc.py deleted file mode 100644 index 6a1d00b7baf..00000000000 --- a/plotly/validators/scatterpolar/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='scatterpolar', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_ids.py b/plotly/validators/scatterpolar/_ids.py deleted file mode 100644 index 51215059e22..00000000000 --- a/plotly/validators/scatterpolar/_ids.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ids', parent_name='scatterpolar', **kwargs - ): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_idssrc.py b/plotly/validators/scatterpolar/_idssrc.py deleted file mode 100644 index 8f62ddd4f53..00000000000 --- a/plotly/validators/scatterpolar/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='scatterpolar', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_legendgroup.py b/plotly/validators/scatterpolar/_legendgroup.py deleted file mode 100644 index 2627a227c65..00000000000 --- a/plotly/validators/scatterpolar/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='scatterpolar', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_line.py b/plotly/validators/scatterpolar/_line.py deleted file mode 100644 index 0beb272c47a..00000000000 --- a/plotly/validators/scatterpolar/_line.py +++ /dev/null @@ -1,37 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='scatterpolar', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - shape - Determines the line shape. With "spline" the - lines are drawn using spline interpolation. The - other available values correspond to step-wise - line shapes. - smoothing - Has an effect only if `shape` is set to - "spline" Sets the amount of smoothing. 0 - corresponds to no smoothing (equivalent to a - "linear" shape). - width - Sets the line width (in px). -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_marker.py b/plotly/validators/scatterpolar/_marker.py deleted file mode 100644 index 35c12480cea..00000000000 --- a/plotly/validators/scatterpolar/_marker.py +++ /dev/null @@ -1,137 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='scatterpolar', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scatterpolar.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - gradient - plotly.graph_objs.scatterpolar.marker.Gradient - instance or dict with compatible properties - line - plotly.graph_objs.scatterpolar.marker.Line - instance or dict with compatible properties - maxdisplayed - Sets a maximum number of points to be drawn on - the graph. 0 corresponds to no limit. - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_mode.py b/plotly/validators/scatterpolar/_mode.py deleted file mode 100644 index 30833fa5cb8..00000000000 --- a/plotly/validators/scatterpolar/_mode.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='mode', parent_name='scatterpolar', **kwargs - ): - super(ModeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['none']), - flags=kwargs.pop('flags', ['lines', 'markers', 'text']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_name.py b/plotly/validators/scatterpolar/_name.py deleted file mode 100644 index 6574d54eaf0..00000000000 --- a/plotly/validators/scatterpolar/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='scatterpolar', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_opacity.py b/plotly/validators/scatterpolar/_opacity.py deleted file mode 100644 index 55a7f3d9d8d..00000000000 --- a/plotly/validators/scatterpolar/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='scatterpolar', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_r.py b/plotly/validators/scatterpolar/_r.py deleted file mode 100644 index 6c3c61d0506..00000000000 --- a/plotly/validators/scatterpolar/_r.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class RValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='r', parent_name='scatterpolar', **kwargs): - super(RValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_r0.py b/plotly/validators/scatterpolar/_r0.py deleted file mode 100644 index 13fef0b4c72..00000000000 --- a/plotly/validators/scatterpolar/_r0.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class R0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='r0', parent_name='scatterpolar', **kwargs): - super(R0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_rsrc.py b/plotly/validators/scatterpolar/_rsrc.py deleted file mode 100644 index b233ff04efc..00000000000 --- a/plotly/validators/scatterpolar/_rsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class RsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='rsrc', parent_name='scatterpolar', **kwargs - ): - super(RsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_selected.py b/plotly/validators/scatterpolar/_selected.py deleted file mode 100644 index 5a93fda3ab1..00000000000 --- a/plotly/validators/scatterpolar/_selected.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='selected', parent_name='scatterpolar', **kwargs - ): - super(SelectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Selected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.scatterpolar.selected.Marker - instance or dict with compatible properties - textfont - plotly.graph_objs.scatterpolar.selected.Textfon - t instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_selectedpoints.py b/plotly/validators/scatterpolar/_selectedpoints.py deleted file mode 100644 index bd7e0c81f03..00000000000 --- a/plotly/validators/scatterpolar/_selectedpoints.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='selectedpoints', - parent_name='scatterpolar', - **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_showlegend.py b/plotly/validators/scatterpolar/_showlegend.py deleted file mode 100644 index 919df79cb71..00000000000 --- a/plotly/validators/scatterpolar/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='scatterpolar', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_stream.py b/plotly/validators/scatterpolar/_stream.py deleted file mode 100644 index 1093f55519b..00000000000 --- a/plotly/validators/scatterpolar/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='scatterpolar', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_subplot.py b/plotly/validators/scatterpolar/_subplot.py deleted file mode 100644 index 8b3e632115f..00000000000 --- a/plotly/validators/scatterpolar/_subplot.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SubplotValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='subplot', parent_name='scatterpolar', **kwargs - ): - super(SubplotValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'polar'), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_text.py b/plotly/validators/scatterpolar/_text.py deleted file mode 100644 index 318e3d9213a..00000000000 --- a/plotly/validators/scatterpolar/_text.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='text', parent_name='scatterpolar', **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_textfont.py b/plotly/validators/scatterpolar/_textfont.py deleted file mode 100644 index bb7f42fe02f..00000000000 --- a/plotly/validators/scatterpolar/_textfont.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='textfont', parent_name='scatterpolar', **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_textposition.py b/plotly/validators/scatterpolar/_textposition.py deleted file mode 100644 index b91fb985966..00000000000 --- a/plotly/validators/scatterpolar/_textposition.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='textposition', parent_name='scatterpolar', **kwargs - ): - super(TextpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 'top left', 'top center', 'top right', 'middle left', - 'middle center', 'middle right', 'bottom left', - 'bottom center', 'bottom right' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_textpositionsrc.py b/plotly/validators/scatterpolar/_textpositionsrc.py deleted file mode 100644 index cd993a9a3d5..00000000000 --- a/plotly/validators/scatterpolar/_textpositionsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='textpositionsrc', - parent_name='scatterpolar', - **kwargs - ): - super(TextpositionsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_textsrc.py b/plotly/validators/scatterpolar/_textsrc.py deleted file mode 100644 index 2ed9a79439d..00000000000 --- a/plotly/validators/scatterpolar/_textsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textsrc', parent_name='scatterpolar', **kwargs - ): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_theta.py b/plotly/validators/scatterpolar/_theta.py deleted file mode 100644 index 2547d96d36f..00000000000 --- a/plotly/validators/scatterpolar/_theta.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThetaValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='theta', parent_name='scatterpolar', **kwargs - ): - super(ThetaValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_theta0.py b/plotly/validators/scatterpolar/_theta0.py deleted file mode 100644 index 2058010229c..00000000000 --- a/plotly/validators/scatterpolar/_theta0.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class Theta0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='theta0', parent_name='scatterpolar', **kwargs - ): - super(Theta0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_thetasrc.py b/plotly/validators/scatterpolar/_thetasrc.py deleted file mode 100644 index f4a071dac4b..00000000000 --- a/plotly/validators/scatterpolar/_thetasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThetasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='thetasrc', parent_name='scatterpolar', **kwargs - ): - super(ThetasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_thetaunit.py b/plotly/validators/scatterpolar/_thetaunit.py deleted file mode 100644 index a51eecfbd9f..00000000000 --- a/plotly/validators/scatterpolar/_thetaunit.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThetaunitValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='thetaunit', parent_name='scatterpolar', **kwargs - ): - super(ThetaunitValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['radians', 'degrees', 'gradians']), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_uid.py b/plotly/validators/scatterpolar/_uid.py deleted file mode 100644 index 95be0ad0a2d..00000000000 --- a/plotly/validators/scatterpolar/_uid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='uid', parent_name='scatterpolar', **kwargs - ): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_uirevision.py b/plotly/validators/scatterpolar/_uirevision.py deleted file mode 100644 index 4fb950c6f90..00000000000 --- a/plotly/validators/scatterpolar/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='scatterpolar', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_unselected.py b/plotly/validators/scatterpolar/_unselected.py deleted file mode 100644 index 198d5fc8228..00000000000 --- a/plotly/validators/scatterpolar/_unselected.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='unselected', parent_name='scatterpolar', **kwargs - ): - super(UnselectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Unselected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.scatterpolar.unselected.Marke - r instance or dict with compatible properties - textfont - plotly.graph_objs.scatterpolar.unselected.Textf - ont instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/_visible.py b/plotly/validators/scatterpolar/_visible.py deleted file mode 100644 index fa72d65b24f..00000000000 --- a/plotly/validators/scatterpolar/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='scatterpolar', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/hoverlabel/__init__.py b/plotly/validators/scatterpolar/hoverlabel/__init__.py index 856f769ba33..9ec2f5698e7 100644 --- a/plotly/validators/scatterpolar/hoverlabel/__init__.py +++ b/plotly/validators/scatterpolar/hoverlabel/__init__.py @@ -1,7 +1,176 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='scatterpolar.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='scatterpolar.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='scatterpolar.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='scatterpolar.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scatterpolar.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='scatterpolar.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scatterpolar.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/hoverlabel/_bgcolor.py b/plotly/validators/scatterpolar/hoverlabel/_bgcolor.py deleted file mode 100644 index 9d3f58c67cb..00000000000 --- a/plotly/validators/scatterpolar/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scatterpolar.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/hoverlabel/_bgcolorsrc.py b/plotly/validators/scatterpolar/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 1cc8c1c8557..00000000000 --- a/plotly/validators/scatterpolar/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='scatterpolar.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/hoverlabel/_bordercolor.py b/plotly/validators/scatterpolar/hoverlabel/_bordercolor.py deleted file mode 100644 index 2121b3b849c..00000000000 --- a/plotly/validators/scatterpolar/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scatterpolar.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/hoverlabel/_bordercolorsrc.py b/plotly/validators/scatterpolar/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 3cb582e2ed6..00000000000 --- a/plotly/validators/scatterpolar/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='scatterpolar.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/hoverlabel/_font.py b/plotly/validators/scatterpolar/hoverlabel/_font.py deleted file mode 100644 index 27c1eb3cef5..00000000000 --- a/plotly/validators/scatterpolar/hoverlabel/_font.py +++ /dev/null @@ -1,50 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='scatterpolar.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/hoverlabel/_namelength.py b/plotly/validators/scatterpolar/hoverlabel/_namelength.py deleted file mode 100644 index 052031d1def..00000000000 --- a/plotly/validators/scatterpolar/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='scatterpolar.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/hoverlabel/_namelengthsrc.py b/plotly/validators/scatterpolar/hoverlabel/_namelengthsrc.py deleted file mode 100644 index e9535470018..00000000000 --- a/plotly/validators/scatterpolar/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='scatterpolar.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/hoverlabel/font/__init__.py b/plotly/validators/scatterpolar/hoverlabel/font/__init__.py index 1d2c591d1e5..91fd7998bf6 100644 --- a/plotly/validators/scatterpolar/hoverlabel/font/__init__.py +++ b/plotly/validators/scatterpolar/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scatterpolar.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterpolar.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='scatterpolar.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatterpolar.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatterpolar.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolar.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/hoverlabel/font/_color.py b/plotly/validators/scatterpolar/hoverlabel/font/_color.py deleted file mode 100644 index e0fee8f31bc..00000000000 --- a/plotly/validators/scatterpolar/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolar.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/hoverlabel/font/_colorsrc.py b/plotly/validators/scatterpolar/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 0c0c2174f8e..00000000000 --- a/plotly/validators/scatterpolar/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatterpolar.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/hoverlabel/font/_family.py b/plotly/validators/scatterpolar/hoverlabel/font/_family.py deleted file mode 100644 index f3610890eaa..00000000000 --- a/plotly/validators/scatterpolar/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatterpolar.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/hoverlabel/font/_familysrc.py b/plotly/validators/scatterpolar/hoverlabel/font/_familysrc.py deleted file mode 100644 index 78593253a18..00000000000 --- a/plotly/validators/scatterpolar/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='scatterpolar.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/hoverlabel/font/_size.py b/plotly/validators/scatterpolar/hoverlabel/font/_size.py deleted file mode 100644 index 625fd068074..00000000000 --- a/plotly/validators/scatterpolar/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterpolar.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/hoverlabel/font/_sizesrc.py b/plotly/validators/scatterpolar/hoverlabel/font/_sizesrc.py deleted file mode 100644 index bda5373000d..00000000000 --- a/plotly/validators/scatterpolar/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scatterpolar.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/line/__init__.py b/plotly/validators/scatterpolar/line/__init__.py index 633e654df05..cf077f2f3a9 100644 --- a/plotly/validators/scatterpolar/line/__init__.py +++ b/plotly/validators/scatterpolar/line/__init__.py @@ -1,5 +1,98 @@ -from ._width import WidthValidator -from ._smoothing import SmoothingValidator -from ._shape import ShapeValidator -from ._dash import DashValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scatterpolar.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='smoothing', + parent_name='scatterpolar.line', + **kwargs + ): + super(SmoothingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 1.3), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShapeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='shape', parent_name='scatterpolar.line', **kwargs + ): + super(ShapeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['linear', 'spline']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashValidator(_plotly_utils.basevalidators.DashValidator): + + def __init__( + self, plotly_name='dash', parent_name='scatterpolar.line', **kwargs + ): + super(DashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scatterpolar.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/line/_color.py b/plotly/validators/scatterpolar/line/_color.py deleted file mode 100644 index 9493516a54b..00000000000 --- a/plotly/validators/scatterpolar/line/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scatterpolar.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/line/_dash.py b/plotly/validators/scatterpolar/line/_dash.py deleted file mode 100644 index a899e15808a..00000000000 --- a/plotly/validators/scatterpolar/line/_dash.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashValidator(_plotly_utils.basevalidators.DashValidator): - - def __init__( - self, plotly_name='dash', parent_name='scatterpolar.line', **kwargs - ): - super(DashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/line/_shape.py b/plotly/validators/scatterpolar/line/_shape.py deleted file mode 100644 index c71307e36fb..00000000000 --- a/plotly/validators/scatterpolar/line/_shape.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShapeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='shape', parent_name='scatterpolar.line', **kwargs - ): - super(ShapeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['linear', 'spline']), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/line/_smoothing.py b/plotly/validators/scatterpolar/line/_smoothing.py deleted file mode 100644 index 109381185b4..00000000000 --- a/plotly/validators/scatterpolar/line/_smoothing.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='smoothing', - parent_name='scatterpolar.line', - **kwargs - ): - super(SmoothingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 1.3), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/line/_width.py b/plotly/validators/scatterpolar/line/_width.py deleted file mode 100644 index 22a698cac4f..00000000000 --- a/plotly/validators/scatterpolar/line/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scatterpolar.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/__init__.py b/plotly/validators/scatterpolar/marker/__init__.py index d137ae66f94..b814d86adc5 100644 --- a/plotly/validators/scatterpolar/marker/__init__.py +++ b/plotly/validators/scatterpolar/marker/__init__.py @@ -1,23 +1,837 @@ -from ._symbolsrc import SymbolsrcValidator -from ._symbol import SymbolValidator -from ._sizesrc import SizesrcValidator -from ._sizeref import SizerefValidator -from ._sizemode import SizemodeValidator -from ._sizemin import SizeminValidator -from ._size import SizeValidator -from ._showscale import ShowscaleValidator -from ._reversescale import ReversescaleValidator -from ._opacitysrc import OpacitysrcValidator -from ._opacity import OpacityValidator -from ._maxdisplayed import MaxdisplayedValidator -from ._line import LineValidator -from ._gradient import GradientValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='symbolsrc', + parent_name='scatterpolar.marker', + **kwargs + ): + super(SymbolsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='symbol', + parent_name='scatterpolar.marker', + **kwargs + ): + super(SymbolValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, + 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', + 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', + 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', + 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', + 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, + 'star-triangle-down-open', 220, 'star-triangle-down-dot', + 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', + 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, + 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, + 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, + 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scatterpolar.marker', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='sizeref', + parent_name='scatterpolar.marker', + **kwargs + ): + super(SizerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='sizemode', + parent_name='scatterpolar.marker', + **kwargs + ): + super(SizemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['diameter', 'area']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='sizemin', + parent_name='scatterpolar.marker', + **kwargs + ): + super(SizeminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='scatterpolar.marker', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showscale', + parent_name='scatterpolar.marker', + **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scatterpolar.marker', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='opacitysrc', + parent_name='scatterpolar.marker', + **kwargs + ): + super(OpacitysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scatterpolar.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxdisplayedValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxdisplayed', + parent_name='scatterpolar.marker', + **kwargs + ): + super(MaxdisplayedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='scatterpolar.marker', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GradientValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='gradient', + parent_name='scatterpolar.marker', + **kwargs + ): + super(GradientValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Gradient'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the final color of the gradient fill: the + center color for radial, the right for + horizontal, or the bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color + . + type + Sets the type of gradient used to fill the + markers + typesrc + Sets the source reference on plot.ly for type + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatterpolar.marker', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='scatterpolar.marker', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='colorbar', + parent_name='scatterpolar.marker', + **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scatterpolar.marker.colorbar. + Tickformatstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scatterpolar.marker.colorbar.tickformatstopde + faults), sets the default property values to + use for elements of + scatterpolar.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatterpolar.marker.colorbar. + Title instance or dict with compatible + properties + titlefont + Deprecated: Please use + scatterpolar.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. + titleside + Deprecated: Please use + scatterpolar.marker.colorbar.title.side + instead. Determines the location of color bar's + title with respect to the color bar. Note that + the title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scatterpolar.marker', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scatterpolar.marker.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='scatterpolar.marker', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='scatterpolar.marker', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='scatterpolar.marker', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='scatterpolar.marker', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scatterpolar.marker', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/marker/_autocolorscale.py b/plotly/validators/scatterpolar/marker/_autocolorscale.py deleted file mode 100644 index 1ee8ac0dc7d..00000000000 --- a/plotly/validators/scatterpolar/marker/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scatterpolar.marker', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_cauto.py b/plotly/validators/scatterpolar/marker/_cauto.py deleted file mode 100644 index 4336c698af9..00000000000 --- a/plotly/validators/scatterpolar/marker/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='scatterpolar.marker', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_cmax.py b/plotly/validators/scatterpolar/marker/_cmax.py deleted file mode 100644 index 5b0363d16d8..00000000000 --- a/plotly/validators/scatterpolar/marker/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='scatterpolar.marker', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_cmid.py b/plotly/validators/scatterpolar/marker/_cmid.py deleted file mode 100644 index eaa4d9122de..00000000000 --- a/plotly/validators/scatterpolar/marker/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='scatterpolar.marker', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_cmin.py b/plotly/validators/scatterpolar/marker/_cmin.py deleted file mode 100644 index 9ac3cb5c197..00000000000 --- a/plotly/validators/scatterpolar/marker/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='scatterpolar.marker', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_color.py b/plotly/validators/scatterpolar/marker/_color.py deleted file mode 100644 index 5bdcabb4807..00000000000 --- a/plotly/validators/scatterpolar/marker/_color.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scatterpolar.marker', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scatterpolar.marker.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_colorbar.py b/plotly/validators/scatterpolar/marker/_colorbar.py deleted file mode 100644 index 4b48932aa59..00000000000 --- a/plotly/validators/scatterpolar/marker/_colorbar.py +++ /dev/null @@ -1,232 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='colorbar', - parent_name='scatterpolar.marker', - **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scatterpolar.marker.colorbar. - Tickformatstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scatterpolar.marker.colorbar.tickformatstopde - faults), sets the default property values to - use for elements of - scatterpolar.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatterpolar.marker.colorbar. - Title instance or dict with compatible - properties - titlefont - Deprecated: Please use - scatterpolar.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. - titleside - Deprecated: Please use - scatterpolar.marker.colorbar.title.side - instead. Determines the location of color bar's - title with respect to the color bar. Note that - the title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_colorscale.py b/plotly/validators/scatterpolar/marker/_colorscale.py deleted file mode 100644 index c6d87b70852..00000000000 --- a/plotly/validators/scatterpolar/marker/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='scatterpolar.marker', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_colorsrc.py b/plotly/validators/scatterpolar/marker/_colorsrc.py deleted file mode 100644 index be7af1f466f..00000000000 --- a/plotly/validators/scatterpolar/marker/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatterpolar.marker', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_gradient.py b/plotly/validators/scatterpolar/marker/_gradient.py deleted file mode 100644 index 6037b15f5b1..00000000000 --- a/plotly/validators/scatterpolar/marker/_gradient.py +++ /dev/null @@ -1,34 +0,0 @@ -import _plotly_utils.basevalidators - - -class GradientValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='gradient', - parent_name='scatterpolar.marker', - **kwargs - ): - super(GradientValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Gradient'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the final color of the gradient fill: the - center color for radial, the right for - horizontal, or the bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color - . - type - Sets the type of gradient used to fill the - markers - typesrc - Sets the source reference on plot.ly for type - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_line.py b/plotly/validators/scatterpolar/marker/_line.py deleted file mode 100644 index 7b4b714747c..00000000000 --- a/plotly/validators/scatterpolar/marker/_line.py +++ /dev/null @@ -1,97 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='scatterpolar.marker', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_maxdisplayed.py b/plotly/validators/scatterpolar/marker/_maxdisplayed.py deleted file mode 100644 index 565795b32a5..00000000000 --- a/plotly/validators/scatterpolar/marker/_maxdisplayed.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxdisplayedValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxdisplayed', - parent_name='scatterpolar.marker', - **kwargs - ): - super(MaxdisplayedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_opacity.py b/plotly/validators/scatterpolar/marker/_opacity.py deleted file mode 100644 index 05ffc63c3f0..00000000000 --- a/plotly/validators/scatterpolar/marker/_opacity.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scatterpolar.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_opacitysrc.py b/plotly/validators/scatterpolar/marker/_opacitysrc.py deleted file mode 100644 index ed96e59a15a..00000000000 --- a/plotly/validators/scatterpolar/marker/_opacitysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='opacitysrc', - parent_name='scatterpolar.marker', - **kwargs - ): - super(OpacitysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_reversescale.py b/plotly/validators/scatterpolar/marker/_reversescale.py deleted file mode 100644 index d5adb847398..00000000000 --- a/plotly/validators/scatterpolar/marker/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scatterpolar.marker', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_showscale.py b/plotly/validators/scatterpolar/marker/_showscale.py deleted file mode 100644 index 93383002c43..00000000000 --- a/plotly/validators/scatterpolar/marker/_showscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showscale', - parent_name='scatterpolar.marker', - **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_size.py b/plotly/validators/scatterpolar/marker/_size.py deleted file mode 100644 index 746c1fdcb6a..00000000000 --- a/plotly/validators/scatterpolar/marker/_size.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='scatterpolar.marker', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_sizemin.py b/plotly/validators/scatterpolar/marker/_sizemin.py deleted file mode 100644 index a87b852822b..00000000000 --- a/plotly/validators/scatterpolar/marker/_sizemin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='sizemin', - parent_name='scatterpolar.marker', - **kwargs - ): - super(SizeminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_sizemode.py b/plotly/validators/scatterpolar/marker/_sizemode.py deleted file mode 100644 index f5b97a47c24..00000000000 --- a/plotly/validators/scatterpolar/marker/_sizemode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='sizemode', - parent_name='scatterpolar.marker', - **kwargs - ): - super(SizemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['diameter', 'area']), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_sizeref.py b/plotly/validators/scatterpolar/marker/_sizeref.py deleted file mode 100644 index 95a54b2384e..00000000000 --- a/plotly/validators/scatterpolar/marker/_sizeref.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='sizeref', - parent_name='scatterpolar.marker', - **kwargs - ): - super(SizerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_sizesrc.py b/plotly/validators/scatterpolar/marker/_sizesrc.py deleted file mode 100644 index 4e66b9b0a5a..00000000000 --- a/plotly/validators/scatterpolar/marker/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scatterpolar.marker', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_symbol.py b/plotly/validators/scatterpolar/marker/_symbol.py deleted file mode 100644 index 6b755fff617..00000000000 --- a/plotly/validators/scatterpolar/marker/_symbol.py +++ /dev/null @@ -1,81 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='symbol', - parent_name='scatterpolar.marker', - **kwargs - ): - super(SymbolValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, - 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', - 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', - 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', - 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', - 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, - 'star-triangle-down-open', 220, 'star-triangle-down-dot', - 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', - 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, - 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, - 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, - 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/_symbolsrc.py b/plotly/validators/scatterpolar/marker/_symbolsrc.py deleted file mode 100644 index cffc954fcf9..00000000000 --- a/plotly/validators/scatterpolar/marker/_symbolsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='symbolsrc', - parent_name='scatterpolar.marker', - **kwargs - ): - super(SymbolsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/__init__.py b/plotly/validators/scatterpolar/marker/colorbar/__init__.py index 3dab31f7e02..5aa32f4787f 100644 --- a/plotly/validators/scatterpolar/marker/colorbar/__init__.py +++ b/plotly/validators/scatterpolar/marker/colorbar/__init__.py @@ -1,41 +1,936 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ypad', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='y', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xpad', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='x', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='len', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scatterpolar.marker.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_bgcolor.py b/plotly/validators/scatterpolar/marker/colorbar/_bgcolor.py deleted file mode 100644 index 704dd15da63..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_bordercolor.py b/plotly/validators/scatterpolar/marker/colorbar/_bordercolor.py deleted file mode 100644 index 6df45f7f3e6..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_borderwidth.py b/plotly/validators/scatterpolar/marker/colorbar/_borderwidth.py deleted file mode 100644 index 9b014c2af2c..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_dtick.py b/plotly/validators/scatterpolar/marker/colorbar/_dtick.py deleted file mode 100644 index 3784eee219d..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_exponentformat.py b/plotly/validators/scatterpolar/marker/colorbar/_exponentformat.py deleted file mode 100644 index b2bc3299a44..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_len.py b/plotly/validators/scatterpolar/marker/colorbar/_len.py deleted file mode 100644 index fa2b91f2b43..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_len.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='len', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_lenmode.py b/plotly/validators/scatterpolar/marker/colorbar/_lenmode.py deleted file mode 100644 index 6e538b6017e..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_nticks.py b/plotly/validators/scatterpolar/marker/colorbar/_nticks.py deleted file mode 100644 index 1305b165c10..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_outlinecolor.py b/plotly/validators/scatterpolar/marker/colorbar/_outlinecolor.py deleted file mode 100644 index 4e4c035e730..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_outlinewidth.py b/plotly/validators/scatterpolar/marker/colorbar/_outlinewidth.py deleted file mode 100644 index a80b8e0e2f9..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_separatethousands.py b/plotly/validators/scatterpolar/marker/colorbar/_separatethousands.py deleted file mode 100644 index 418eb1fc953..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_showexponent.py b/plotly/validators/scatterpolar/marker/colorbar/_showexponent.py deleted file mode 100644 index 46dbc192ecc..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_showticklabels.py b/plotly/validators/scatterpolar/marker/colorbar/_showticklabels.py deleted file mode 100644 index fcc5e4ad686..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_showtickprefix.py b/plotly/validators/scatterpolar/marker/colorbar/_showtickprefix.py deleted file mode 100644 index cbddc3dbffa..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_showticksuffix.py b/plotly/validators/scatterpolar/marker/colorbar/_showticksuffix.py deleted file mode 100644 index babaefba2aa..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_thickness.py b/plotly/validators/scatterpolar/marker/colorbar/_thickness.py deleted file mode 100644 index a546e49d678..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_thicknessmode.py b/plotly/validators/scatterpolar/marker/colorbar/_thicknessmode.py deleted file mode 100644 index 955420ee59e..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_tick0.py b/plotly/validators/scatterpolar/marker/colorbar/_tick0.py deleted file mode 100644 index 467eca4fc74..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_tickangle.py b/plotly/validators/scatterpolar/marker/colorbar/_tickangle.py deleted file mode 100644 index 685fa406d15..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_tickcolor.py b/plotly/validators/scatterpolar/marker/colorbar/_tickcolor.py deleted file mode 100644 index 6210e337bf4..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_tickfont.py b/plotly/validators/scatterpolar/marker/colorbar/_tickfont.py deleted file mode 100644 index e7202e2081f..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_tickformat.py b/plotly/validators/scatterpolar/marker/colorbar/_tickformat.py deleted file mode 100644 index 95f501ce21e..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_tickformatstopdefaults.py b/plotly/validators/scatterpolar/marker/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index ab41b0ea49a..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_tickformatstops.py b/plotly/validators/scatterpolar/marker/colorbar/_tickformatstops.py deleted file mode 100644 index 3be301909cb..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_ticklen.py b/plotly/validators/scatterpolar/marker/colorbar/_ticklen.py deleted file mode 100644 index 9940684b4db..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_tickmode.py b/plotly/validators/scatterpolar/marker/colorbar/_tickmode.py deleted file mode 100644 index 5a39340bcc0..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_tickprefix.py b/plotly/validators/scatterpolar/marker/colorbar/_tickprefix.py deleted file mode 100644 index 8be7036a75b..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_ticks.py b/plotly/validators/scatterpolar/marker/colorbar/_ticks.py deleted file mode 100644 index 7a5e00302f8..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_ticksuffix.py b/plotly/validators/scatterpolar/marker/colorbar/_ticksuffix.py deleted file mode 100644 index e866c7c5594..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_ticktext.py b/plotly/validators/scatterpolar/marker/colorbar/_ticktext.py deleted file mode 100644 index 08a1b7fdeb3..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_ticktextsrc.py b/plotly/validators/scatterpolar/marker/colorbar/_ticktextsrc.py deleted file mode 100644 index b2e1b271c3e..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_tickvals.py b/plotly/validators/scatterpolar/marker/colorbar/_tickvals.py deleted file mode 100644 index a79c268fd3c..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_tickvalssrc.py b/plotly/validators/scatterpolar/marker/colorbar/_tickvalssrc.py deleted file mode 100644 index 0dc7dd1c05c..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_tickwidth.py b/plotly/validators/scatterpolar/marker/colorbar/_tickwidth.py deleted file mode 100644 index 118a86ded9e..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_title.py b/plotly/validators/scatterpolar/marker/colorbar/_title.py deleted file mode 100644 index 1b8111814c1..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_x.py b/plotly/validators/scatterpolar/marker/colorbar/_x.py deleted file mode 100644 index dfcf96ec2b7..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_x.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='x', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_xanchor.py b/plotly/validators/scatterpolar/marker/colorbar/_xanchor.py deleted file mode 100644 index beb47aa740c..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_xpad.py b/plotly/validators/scatterpolar/marker/colorbar/_xpad.py deleted file mode 100644 index e8ec2e66493..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_xpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xpad', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_y.py b/plotly/validators/scatterpolar/marker/colorbar/_y.py deleted file mode 100644 index 95652064564..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_y.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='y', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_yanchor.py b/plotly/validators/scatterpolar/marker/colorbar/_yanchor.py deleted file mode 100644 index 6162a841832..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/_ypad.py b/plotly/validators/scatterpolar/marker/colorbar/_ypad.py deleted file mode 100644 index 17c4d74c425..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/_ypad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ypad', - parent_name='scatterpolar.marker.colorbar', - **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/tickfont/__init__.py b/plotly/validators/scatterpolar/marker/colorbar/tickfont/__init__.py index 199d72e71c6..8089426830d 100644 --- a/plotly/validators/scatterpolar/marker/colorbar/tickfont/__init__.py +++ b/plotly/validators/scatterpolar/marker/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterpolar.marker.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatterpolar.marker.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolar.marker.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/tickfont/_color.py b/plotly/validators/scatterpolar/marker/colorbar/tickfont/_color.py deleted file mode 100644 index cbfe45e8fff..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolar.marker.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/tickfont/_family.py b/plotly/validators/scatterpolar/marker/colorbar/tickfont/_family.py deleted file mode 100644 index 98de8998f78..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatterpolar.marker.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/tickfont/_size.py b/plotly/validators/scatterpolar/marker/colorbar/tickfont/_size.py deleted file mode 100644 index 7e12ab7b332..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterpolar.marker.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/__init__.py b/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/__init__.py index 3f6c06cac47..6c542ed8531 100644 --- a/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='scatterpolar.marker.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='scatterpolar.marker.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='scatterpolar.marker.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='scatterpolar.marker.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='scatterpolar.marker.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index b6e5683aa95..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='scatterpolar.marker.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/_enabled.py b/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index 00f40a47674..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='scatterpolar.marker.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/_name.py b/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/_name.py deleted file mode 100644 index e04c8138383..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='scatterpolar.marker.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index f31d18ba458..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='scatterpolar.marker.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/_value.py b/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/_value.py deleted file mode 100644 index 8a61d9484e8..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='scatterpolar.marker.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/title/__init__.py b/plotly/validators/scatterpolar/marker/colorbar/title/__init__.py index 33c9c145bb8..18241ea4155 100644 --- a/plotly/validators/scatterpolar/marker/colorbar/title/__init__.py +++ b/plotly/validators/scatterpolar/marker/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='scatterpolar.marker.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='scatterpolar.marker.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='scatterpolar.marker.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/title/_font.py b/plotly/validators/scatterpolar/marker/colorbar/title/_font.py deleted file mode 100644 index b43205a17f7..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='scatterpolar.marker.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/title/_side.py b/plotly/validators/scatterpolar/marker/colorbar/title/_side.py deleted file mode 100644 index 6c329b4c4da..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='scatterpolar.marker.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/title/_text.py b/plotly/validators/scatterpolar/marker/colorbar/title/_text.py deleted file mode 100644 index b9ee6d29b5d..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='scatterpolar.marker.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/title/font/__init__.py b/plotly/validators/scatterpolar/marker/colorbar/title/font/__init__.py index 199d72e71c6..bee4941a850 100644 --- a/plotly/validators/scatterpolar/marker/colorbar/title/font/__init__.py +++ b/plotly/validators/scatterpolar/marker/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterpolar.marker.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatterpolar.marker.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolar.marker.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/title/font/_color.py b/plotly/validators/scatterpolar/marker/colorbar/title/font/_color.py deleted file mode 100644 index 99b8f0dcbea..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolar.marker.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/title/font/_family.py b/plotly/validators/scatterpolar/marker/colorbar/title/font/_family.py deleted file mode 100644 index d44dcf6b4c8..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatterpolar.marker.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/colorbar/title/font/_size.py b/plotly/validators/scatterpolar/marker/colorbar/title/font/_size.py deleted file mode 100644 index c397babc584..00000000000 --- a/plotly/validators/scatterpolar/marker/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterpolar.marker.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/gradient/__init__.py b/plotly/validators/scatterpolar/marker/gradient/__init__.py index 434557c8fea..0ec3f4cab74 100644 --- a/plotly/validators/scatterpolar/marker/gradient/__init__.py +++ b/plotly/validators/scatterpolar/marker/gradient/__init__.py @@ -1,4 +1,85 @@ -from ._typesrc import TypesrcValidator -from ._type import TypeValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class TypesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='typesrc', + parent_name='scatterpolar.marker.gradient', + **kwargs + ): + super(TypesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='type', + parent_name='scatterpolar.marker.gradient', + **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['radial', 'horizontal', 'vertical', 'none'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatterpolar.marker.gradient', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolar.marker.gradient', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/marker/gradient/_color.py b/plotly/validators/scatterpolar/marker/gradient/_color.py deleted file mode 100644 index 30652f29676..00000000000 --- a/plotly/validators/scatterpolar/marker/gradient/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolar.marker.gradient', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/gradient/_colorsrc.py b/plotly/validators/scatterpolar/marker/gradient/_colorsrc.py deleted file mode 100644 index f113134fc14..00000000000 --- a/plotly/validators/scatterpolar/marker/gradient/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatterpolar.marker.gradient', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/gradient/_type.py b/plotly/validators/scatterpolar/marker/gradient/_type.py deleted file mode 100644 index 96be18ea844..00000000000 --- a/plotly/validators/scatterpolar/marker/gradient/_type.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='type', - parent_name='scatterpolar.marker.gradient', - **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['radial', 'horizontal', 'vertical', 'none'] - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/gradient/_typesrc.py b/plotly/validators/scatterpolar/marker/gradient/_typesrc.py deleted file mode 100644 index 8e13fa711df..00000000000 --- a/plotly/validators/scatterpolar/marker/gradient/_typesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='typesrc', - parent_name='scatterpolar.marker.gradient', - **kwargs - ): - super(TypesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/line/__init__.py b/plotly/validators/scatterpolar/marker/line/__init__.py index c031ca61ce2..4242fb90cb7 100644 --- a/plotly/validators/scatterpolar/marker/line/__init__.py +++ b/plotly/validators/scatterpolar/marker/line/__init__.py @@ -1,11 +1,236 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._reversescale import ReversescaleValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='widthsrc', + parent_name='scatterpolar.marker.line', + **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='scatterpolar.marker.line', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scatterpolar.marker.line', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatterpolar.marker.line', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='scatterpolar.marker.line', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolar.marker.line', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scatterpolar.marker.line.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmin', + parent_name='scatterpolar.marker.line', + **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmid', + parent_name='scatterpolar.marker.line', + **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmax', + parent_name='scatterpolar.marker.line', + **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='cauto', + parent_name='scatterpolar.marker.line', + **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scatterpolar.marker.line', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/marker/line/_autocolorscale.py b/plotly/validators/scatterpolar/marker/line/_autocolorscale.py deleted file mode 100644 index 7fec58aab03..00000000000 --- a/plotly/validators/scatterpolar/marker/line/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scatterpolar.marker.line', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/line/_cauto.py b/plotly/validators/scatterpolar/marker/line/_cauto.py deleted file mode 100644 index 89bc3e1981a..00000000000 --- a/plotly/validators/scatterpolar/marker/line/_cauto.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='cauto', - parent_name='scatterpolar.marker.line', - **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/line/_cmax.py b/plotly/validators/scatterpolar/marker/line/_cmax.py deleted file mode 100644 index 989f073f59f..00000000000 --- a/plotly/validators/scatterpolar/marker/line/_cmax.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmax', - parent_name='scatterpolar.marker.line', - **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/line/_cmid.py b/plotly/validators/scatterpolar/marker/line/_cmid.py deleted file mode 100644 index 5792b482d6c..00000000000 --- a/plotly/validators/scatterpolar/marker/line/_cmid.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmid', - parent_name='scatterpolar.marker.line', - **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/line/_cmin.py b/plotly/validators/scatterpolar/marker/line/_cmin.py deleted file mode 100644 index ae0dcee89ea..00000000000 --- a/plotly/validators/scatterpolar/marker/line/_cmin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmin', - parent_name='scatterpolar.marker.line', - **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/line/_color.py b/plotly/validators/scatterpolar/marker/line/_color.py deleted file mode 100644 index c62ea43ae0f..00000000000 --- a/plotly/validators/scatterpolar/marker/line/_color.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolar.marker.line', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scatterpolar.marker.line.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/line/_colorscale.py b/plotly/validators/scatterpolar/marker/line/_colorscale.py deleted file mode 100644 index 8b47eca2fe5..00000000000 --- a/plotly/validators/scatterpolar/marker/line/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='scatterpolar.marker.line', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/line/_colorsrc.py b/plotly/validators/scatterpolar/marker/line/_colorsrc.py deleted file mode 100644 index fb289008214..00000000000 --- a/plotly/validators/scatterpolar/marker/line/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatterpolar.marker.line', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/line/_reversescale.py b/plotly/validators/scatterpolar/marker/line/_reversescale.py deleted file mode 100644 index 5639fe3c325..00000000000 --- a/plotly/validators/scatterpolar/marker/line/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scatterpolar.marker.line', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/line/_width.py b/plotly/validators/scatterpolar/marker/line/_width.py deleted file mode 100644 index d389fab07ba..00000000000 --- a/plotly/validators/scatterpolar/marker/line/_width.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='scatterpolar.marker.line', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/marker/line/_widthsrc.py b/plotly/validators/scatterpolar/marker/line/_widthsrc.py deleted file mode 100644 index b75cd89a1a4..00000000000 --- a/plotly/validators/scatterpolar/marker/line/_widthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='widthsrc', - parent_name='scatterpolar.marker.line', - **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/selected/__init__.py b/plotly/validators/scatterpolar/selected/__init__.py index f1a1ef3742f..7f559f917bd 100644 --- a/plotly/validators/scatterpolar/selected/__init__.py +++ b/plotly/validators/scatterpolar/selected/__init__.py @@ -1,2 +1,54 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='scatterpolar.selected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of selected points. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='scatterpolar.selected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/selected/_marker.py b/plotly/validators/scatterpolar/selected/_marker.py deleted file mode 100644 index 38058cc649b..00000000000 --- a/plotly/validators/scatterpolar/selected/_marker.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='scatterpolar.selected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/selected/_textfont.py b/plotly/validators/scatterpolar/selected/_textfont.py deleted file mode 100644 index 92c788b658d..00000000000 --- a/plotly/validators/scatterpolar/selected/_textfont.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='scatterpolar.selected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/selected/marker/__init__.py b/plotly/validators/scatterpolar/selected/marker/__init__.py index ed9a9070947..ea42f2cc5f7 100644 --- a/plotly/validators/scatterpolar/selected/marker/__init__.py +++ b/plotly/validators/scatterpolar/selected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterpolar.selected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scatterpolar.selected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolar.selected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/selected/marker/_color.py b/plotly/validators/scatterpolar/selected/marker/_color.py deleted file mode 100644 index 794f01f0e71..00000000000 --- a/plotly/validators/scatterpolar/selected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolar.selected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/selected/marker/_opacity.py b/plotly/validators/scatterpolar/selected/marker/_opacity.py deleted file mode 100644 index 542da54954d..00000000000 --- a/plotly/validators/scatterpolar/selected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scatterpolar.selected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/selected/marker/_size.py b/plotly/validators/scatterpolar/selected/marker/_size.py deleted file mode 100644 index 554853acdf9..00000000000 --- a/plotly/validators/scatterpolar/selected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterpolar.selected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/selected/textfont/__init__.py b/plotly/validators/scatterpolar/selected/textfont/__init__.py index 74135b3f315..7fb1c80b5f0 100644 --- a/plotly/validators/scatterpolar/selected/textfont/__init__.py +++ b/plotly/validators/scatterpolar/selected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolar.selected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/selected/textfont/_color.py b/plotly/validators/scatterpolar/selected/textfont/_color.py deleted file mode 100644 index 1d09fa6a0b9..00000000000 --- a/plotly/validators/scatterpolar/selected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolar.selected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/stream/__init__.py b/plotly/validators/scatterpolar/stream/__init__.py index 2f4f2047594..09900a66457 100644 --- a/plotly/validators/scatterpolar/stream/__init__.py +++ b/plotly/validators/scatterpolar/stream/__init__.py @@ -1,2 +1,41 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='scatterpolar.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='scatterpolar.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/stream/_maxpoints.py b/plotly/validators/scatterpolar/stream/_maxpoints.py deleted file mode 100644 index cca3a8c6345..00000000000 --- a/plotly/validators/scatterpolar/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='scatterpolar.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/stream/_token.py b/plotly/validators/scatterpolar/stream/_token.py deleted file mode 100644 index 45066947c7c..00000000000 --- a/plotly/validators/scatterpolar/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='scatterpolar.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/textfont/__init__.py b/plotly/validators/scatterpolar/textfont/__init__.py index 1d2c591d1e5..460d137253b 100644 --- a/plotly/validators/scatterpolar/textfont/__init__.py +++ b/plotly/validators/scatterpolar/textfont/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scatterpolar.textfont', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterpolar.textfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='scatterpolar.textfont', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatterpolar.textfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatterpolar.textfont', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolar.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/textfont/_color.py b/plotly/validators/scatterpolar/textfont/_color.py deleted file mode 100644 index 1a3fb873338..00000000000 --- a/plotly/validators/scatterpolar/textfont/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolar.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/textfont/_colorsrc.py b/plotly/validators/scatterpolar/textfont/_colorsrc.py deleted file mode 100644 index c262176cae7..00000000000 --- a/plotly/validators/scatterpolar/textfont/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatterpolar.textfont', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/textfont/_family.py b/plotly/validators/scatterpolar/textfont/_family.py deleted file mode 100644 index 08e931b215f..00000000000 --- a/plotly/validators/scatterpolar/textfont/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatterpolar.textfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/textfont/_familysrc.py b/plotly/validators/scatterpolar/textfont/_familysrc.py deleted file mode 100644 index 115d5a04c37..00000000000 --- a/plotly/validators/scatterpolar/textfont/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='scatterpolar.textfont', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/textfont/_size.py b/plotly/validators/scatterpolar/textfont/_size.py deleted file mode 100644 index 5ad2d500c2e..00000000000 --- a/plotly/validators/scatterpolar/textfont/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterpolar.textfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/textfont/_sizesrc.py b/plotly/validators/scatterpolar/textfont/_sizesrc.py deleted file mode 100644 index 60234a490a1..00000000000 --- a/plotly/validators/scatterpolar/textfont/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scatterpolar.textfont', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/unselected/__init__.py b/plotly/validators/scatterpolar/unselected/__init__.py index f1a1ef3742f..00fd8a6a65f 100644 --- a/plotly/validators/scatterpolar/unselected/__init__.py +++ b/plotly/validators/scatterpolar/unselected/__init__.py @@ -1,2 +1,58 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='scatterpolar.unselected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='scatterpolar.unselected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of unselected points, + applied only when a selection exists. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/unselected/_marker.py b/plotly/validators/scatterpolar/unselected/_marker.py deleted file mode 100644 index 25e4d14c06b..00000000000 --- a/plotly/validators/scatterpolar/unselected/_marker.py +++ /dev/null @@ -1,30 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='scatterpolar.unselected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of unselected points, - applied only when a selection exists. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/unselected/_textfont.py b/plotly/validators/scatterpolar/unselected/_textfont.py deleted file mode 100644 index faf1cf9984f..00000000000 --- a/plotly/validators/scatterpolar/unselected/_textfont.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='scatterpolar.unselected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/unselected/marker/__init__.py b/plotly/validators/scatterpolar/unselected/marker/__init__.py index ed9a9070947..1db1b3099bb 100644 --- a/plotly/validators/scatterpolar/unselected/marker/__init__.py +++ b/plotly/validators/scatterpolar/unselected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterpolar.unselected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scatterpolar.unselected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolar.unselected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/unselected/marker/_color.py b/plotly/validators/scatterpolar/unselected/marker/_color.py deleted file mode 100644 index f588cf19e0e..00000000000 --- a/plotly/validators/scatterpolar/unselected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolar.unselected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/unselected/marker/_opacity.py b/plotly/validators/scatterpolar/unselected/marker/_opacity.py deleted file mode 100644 index 7bfa4210448..00000000000 --- a/plotly/validators/scatterpolar/unselected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scatterpolar.unselected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/unselected/marker/_size.py b/plotly/validators/scatterpolar/unselected/marker/_size.py deleted file mode 100644 index 81d5b167433..00000000000 --- a/plotly/validators/scatterpolar/unselected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterpolar.unselected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolar/unselected/textfont/__init__.py b/plotly/validators/scatterpolar/unselected/textfont/__init__.py index 74135b3f315..7c6ee905769 100644 --- a/plotly/validators/scatterpolar/unselected/textfont/__init__.py +++ b/plotly/validators/scatterpolar/unselected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolar.unselected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolar/unselected/textfont/_color.py b/plotly/validators/scatterpolar/unselected/textfont/_color.py deleted file mode 100644 index 16bfde0d06c..00000000000 --- a/plotly/validators/scatterpolar/unselected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolar.unselected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/__init__.py b/plotly/validators/scatterpolargl/__init__.py index 813d83f8a52..7c10d99bc8a 100644 --- a/plotly/validators/scatterpolargl/__init__.py +++ b/plotly/validators/scatterpolargl/__init__.py @@ -1,43 +1,1011 @@ -from ._visible import VisibleValidator -from ._unselected import UnselectedValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._thetaunit import ThetaunitValidator -from ._thetasrc import ThetasrcValidator -from ._theta0 import Theta0Validator -from ._theta import ThetaValidator -from ._textsrc import TextsrcValidator -from ._textpositionsrc import TextpositionsrcValidator -from ._textposition import TextpositionValidator -from ._textfont import TextfontValidator -from ._text import TextValidator -from ._subplot import SubplotValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._selected import SelectedValidator -from ._rsrc import RsrcValidator -from ._r0 import R0Validator -from ._r import RValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._mode import ModeValidator -from ._marker import MarkerValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._fillcolor import FillcolorValidator -from ._fill import FillValidator -from ._dtheta import DthetaValidator -from ._dr import DrValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._connectgaps import ConnectgapsValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='scatterpolargl', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='unselected', parent_name='scatterpolargl', **kwargs + ): + super(UnselectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Unselected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.scatterpolargl.unselected.Mar + ker instance or dict with compatible properties + textfont + plotly.graph_objs.scatterpolargl.unselected.Tex + tfont instance or dict with compatible + properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='scatterpolargl', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='uid', parent_name='scatterpolargl', **kwargs + ): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThetaunitValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='thetaunit', parent_name='scatterpolargl', **kwargs + ): + super(ThetaunitValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['radians', 'degrees', 'gradians']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThetasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='thetasrc', parent_name='scatterpolargl', **kwargs + ): + super(ThetasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Theta0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='theta0', parent_name='scatterpolargl', **kwargs + ): + super(Theta0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThetaValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='theta', parent_name='scatterpolargl', **kwargs + ): + super(ThetaValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textsrc', parent_name='scatterpolargl', **kwargs + ): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='textpositionsrc', + parent_name='scatterpolargl', + **kwargs + ): + super(TextpositionsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='textposition', + parent_name='scatterpolargl', + **kwargs + ): + super(TextpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 'top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', + 'bottom center', 'bottom right' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='textfont', parent_name='scatterpolargl', **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='text', parent_name='scatterpolargl', **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SubplotValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='subplot', parent_name='scatterpolargl', **kwargs + ): + super(SubplotValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'polar'), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='scatterpolargl', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='scatterpolargl', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='selectedpoints', + parent_name='scatterpolargl', + **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='selected', parent_name='scatterpolargl', **kwargs + ): + super(SelectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Selected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.scatterpolargl.selected.Marke + r instance or dict with compatible properties + textfont + plotly.graph_objs.scatterpolargl.selected.Textf + ont instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='rsrc', parent_name='scatterpolargl', **kwargs + ): + super(RsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class R0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='r0', parent_name='scatterpolargl', **kwargs + ): + super(R0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='r', parent_name='scatterpolargl', **kwargs + ): + super(RValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='scatterpolargl', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='scatterpolargl', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='mode', parent_name='scatterpolargl', **kwargs + ): + super(ModeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['none']), + flags=kwargs.pop('flags', ['lines', 'markers', 'text']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='scatterpolargl', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scatterpolargl.marker.ColorBa + r instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + line + plotly.graph_objs.scatterpolargl.marker.Line + instance or dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='scatterpolargl', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the line color. + dash + Sets the style of the lines. + shape + Determines the line shape. The values + correspond to step-wise line shapes. + width + Sets the line width (in px). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='legendgroup', + parent_name='scatterpolargl', + **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='scatterpolargl', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ids', parent_name='scatterpolargl', **kwargs + ): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertextsrc', + parent_name='scatterpolargl', + **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='scatterpolargl', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertemplatesrc', + parent_name='scatterpolargl', + **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hovertemplate', + parent_name='scatterpolargl', + **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='scatterpolargl', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hoverinfosrc', + parent_name='scatterpolargl', + **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='scatterpolargl', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['r', 'theta', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='fillcolor', parent_name='scatterpolargl', **kwargs + ): + super(FillcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='fill', parent_name='scatterpolargl', **kwargs + ): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 'none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', + 'toself', 'tonext' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DthetaValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='dtheta', parent_name='scatterpolargl', **kwargs + ): + super(DthetaValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DrValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='dr', parent_name='scatterpolargl', **kwargs + ): + super(DrValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='customdatasrc', + parent_name='scatterpolargl', + **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='scatterpolargl', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='connectgaps', + parent_name='scatterpolargl', + **kwargs + ): + super(ConnectgapsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/_connectgaps.py b/plotly/validators/scatterpolargl/_connectgaps.py deleted file mode 100644 index 34fa13ac19c..00000000000 --- a/plotly/validators/scatterpolargl/_connectgaps.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='connectgaps', - parent_name='scatterpolargl', - **kwargs - ): - super(ConnectgapsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_customdata.py b/plotly/validators/scatterpolargl/_customdata.py deleted file mode 100644 index 2ff1ce78042..00000000000 --- a/plotly/validators/scatterpolargl/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='scatterpolargl', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_customdatasrc.py b/plotly/validators/scatterpolargl/_customdatasrc.py deleted file mode 100644 index 7ca735165f9..00000000000 --- a/plotly/validators/scatterpolargl/_customdatasrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='customdatasrc', - parent_name='scatterpolargl', - **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_dr.py b/plotly/validators/scatterpolargl/_dr.py deleted file mode 100644 index 74cf6c7c315..00000000000 --- a/plotly/validators/scatterpolargl/_dr.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class DrValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='dr', parent_name='scatterpolargl', **kwargs - ): - super(DrValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_dtheta.py b/plotly/validators/scatterpolargl/_dtheta.py deleted file mode 100644 index 14fe2756b7c..00000000000 --- a/plotly/validators/scatterpolargl/_dtheta.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class DthetaValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='dtheta', parent_name='scatterpolargl', **kwargs - ): - super(DthetaValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_fill.py b/plotly/validators/scatterpolargl/_fill.py deleted file mode 100644 index 181de12f6e1..00000000000 --- a/plotly/validators/scatterpolargl/_fill.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='fill', parent_name='scatterpolargl', **kwargs - ): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 'none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', - 'toself', 'tonext' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_fillcolor.py b/plotly/validators/scatterpolargl/_fillcolor.py deleted file mode 100644 index c22fe275369..00000000000 --- a/plotly/validators/scatterpolargl/_fillcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='fillcolor', parent_name='scatterpolargl', **kwargs - ): - super(FillcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_hoverinfo.py b/plotly/validators/scatterpolargl/_hoverinfo.py deleted file mode 100644 index be64cc2b664..00000000000 --- a/plotly/validators/scatterpolargl/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='scatterpolargl', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['r', 'theta', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_hoverinfosrc.py b/plotly/validators/scatterpolargl/_hoverinfosrc.py deleted file mode 100644 index dfeeae0093f..00000000000 --- a/plotly/validators/scatterpolargl/_hoverinfosrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hoverinfosrc', - parent_name='scatterpolargl', - **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_hoverlabel.py b/plotly/validators/scatterpolargl/_hoverlabel.py deleted file mode 100644 index 9b636972248..00000000000 --- a/plotly/validators/scatterpolargl/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='scatterpolargl', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_hovertemplate.py b/plotly/validators/scatterpolargl/_hovertemplate.py deleted file mode 100644 index 07fe80e74f3..00000000000 --- a/plotly/validators/scatterpolargl/_hovertemplate.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hovertemplate', - parent_name='scatterpolargl', - **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_hovertemplatesrc.py b/plotly/validators/scatterpolargl/_hovertemplatesrc.py deleted file mode 100644 index 21cd1faed3a..00000000000 --- a/plotly/validators/scatterpolargl/_hovertemplatesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertemplatesrc', - parent_name='scatterpolargl', - **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_hovertext.py b/plotly/validators/scatterpolargl/_hovertext.py deleted file mode 100644 index 26bc34af4c3..00000000000 --- a/plotly/validators/scatterpolargl/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='scatterpolargl', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_hovertextsrc.py b/plotly/validators/scatterpolargl/_hovertextsrc.py deleted file mode 100644 index 4c64a050c7d..00000000000 --- a/plotly/validators/scatterpolargl/_hovertextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertextsrc', - parent_name='scatterpolargl', - **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_ids.py b/plotly/validators/scatterpolargl/_ids.py deleted file mode 100644 index 545609f80bc..00000000000 --- a/plotly/validators/scatterpolargl/_ids.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ids', parent_name='scatterpolargl', **kwargs - ): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_idssrc.py b/plotly/validators/scatterpolargl/_idssrc.py deleted file mode 100644 index 3fd64f99583..00000000000 --- a/plotly/validators/scatterpolargl/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='scatterpolargl', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_legendgroup.py b/plotly/validators/scatterpolargl/_legendgroup.py deleted file mode 100644 index 0f1e8088294..00000000000 --- a/plotly/validators/scatterpolargl/_legendgroup.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='legendgroup', - parent_name='scatterpolargl', - **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_line.py b/plotly/validators/scatterpolargl/_line.py deleted file mode 100644 index e830edddc7b..00000000000 --- a/plotly/validators/scatterpolargl/_line.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='scatterpolargl', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the line color. - dash - Sets the style of the lines. - shape - Determines the line shape. The values - correspond to step-wise line shapes. - width - Sets the line width (in px). -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_marker.py b/plotly/validators/scatterpolargl/_marker.py deleted file mode 100644 index 2666257e0cf..00000000000 --- a/plotly/validators/scatterpolargl/_marker.py +++ /dev/null @@ -1,131 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='scatterpolargl', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scatterpolargl.marker.ColorBa - r instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - line - plotly.graph_objs.scatterpolargl.marker.Line - instance or dict with compatible properties - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_mode.py b/plotly/validators/scatterpolargl/_mode.py deleted file mode 100644 index bb7447d2d7a..00000000000 --- a/plotly/validators/scatterpolargl/_mode.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='mode', parent_name='scatterpolargl', **kwargs - ): - super(ModeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['none']), - flags=kwargs.pop('flags', ['lines', 'markers', 'text']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_name.py b/plotly/validators/scatterpolargl/_name.py deleted file mode 100644 index efd363246da..00000000000 --- a/plotly/validators/scatterpolargl/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='scatterpolargl', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_opacity.py b/plotly/validators/scatterpolargl/_opacity.py deleted file mode 100644 index 88513302b0d..00000000000 --- a/plotly/validators/scatterpolargl/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='scatterpolargl', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_r.py b/plotly/validators/scatterpolargl/_r.py deleted file mode 100644 index 313dd8f1f03..00000000000 --- a/plotly/validators/scatterpolargl/_r.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class RValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='r', parent_name='scatterpolargl', **kwargs - ): - super(RValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_r0.py b/plotly/validators/scatterpolargl/_r0.py deleted file mode 100644 index 3eef28bcb78..00000000000 --- a/plotly/validators/scatterpolargl/_r0.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class R0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='r0', parent_name='scatterpolargl', **kwargs - ): - super(R0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_rsrc.py b/plotly/validators/scatterpolargl/_rsrc.py deleted file mode 100644 index 84e1d13a4ae..00000000000 --- a/plotly/validators/scatterpolargl/_rsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class RsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='rsrc', parent_name='scatterpolargl', **kwargs - ): - super(RsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_selected.py b/plotly/validators/scatterpolargl/_selected.py deleted file mode 100644 index 8b8347d17c1..00000000000 --- a/plotly/validators/scatterpolargl/_selected.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='selected', parent_name='scatterpolargl', **kwargs - ): - super(SelectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Selected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.scatterpolargl.selected.Marke - r instance or dict with compatible properties - textfont - plotly.graph_objs.scatterpolargl.selected.Textf - ont instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_selectedpoints.py b/plotly/validators/scatterpolargl/_selectedpoints.py deleted file mode 100644 index 17244708279..00000000000 --- a/plotly/validators/scatterpolargl/_selectedpoints.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='selectedpoints', - parent_name='scatterpolargl', - **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_showlegend.py b/plotly/validators/scatterpolargl/_showlegend.py deleted file mode 100644 index e88b27f113b..00000000000 --- a/plotly/validators/scatterpolargl/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='scatterpolargl', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_stream.py b/plotly/validators/scatterpolargl/_stream.py deleted file mode 100644 index 97217364743..00000000000 --- a/plotly/validators/scatterpolargl/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='scatterpolargl', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_subplot.py b/plotly/validators/scatterpolargl/_subplot.py deleted file mode 100644 index bf4c958ed18..00000000000 --- a/plotly/validators/scatterpolargl/_subplot.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SubplotValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='subplot', parent_name='scatterpolargl', **kwargs - ): - super(SubplotValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'polar'), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_text.py b/plotly/validators/scatterpolargl/_text.py deleted file mode 100644 index e3fa2517bf0..00000000000 --- a/plotly/validators/scatterpolargl/_text.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='text', parent_name='scatterpolargl', **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_textfont.py b/plotly/validators/scatterpolargl/_textfont.py deleted file mode 100644 index 351aec1509a..00000000000 --- a/plotly/validators/scatterpolargl/_textfont.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='textfont', parent_name='scatterpolargl', **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_textposition.py b/plotly/validators/scatterpolargl/_textposition.py deleted file mode 100644 index 1235317d42a..00000000000 --- a/plotly/validators/scatterpolargl/_textposition.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='textposition', - parent_name='scatterpolargl', - **kwargs - ): - super(TextpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 'top left', 'top center', 'top right', 'middle left', - 'middle center', 'middle right', 'bottom left', - 'bottom center', 'bottom right' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_textpositionsrc.py b/plotly/validators/scatterpolargl/_textpositionsrc.py deleted file mode 100644 index 13ce37a7514..00000000000 --- a/plotly/validators/scatterpolargl/_textpositionsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='textpositionsrc', - parent_name='scatterpolargl', - **kwargs - ): - super(TextpositionsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_textsrc.py b/plotly/validators/scatterpolargl/_textsrc.py deleted file mode 100644 index 1208acd35e5..00000000000 --- a/plotly/validators/scatterpolargl/_textsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textsrc', parent_name='scatterpolargl', **kwargs - ): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_theta.py b/plotly/validators/scatterpolargl/_theta.py deleted file mode 100644 index 61c6e41534c..00000000000 --- a/plotly/validators/scatterpolargl/_theta.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThetaValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='theta', parent_name='scatterpolargl', **kwargs - ): - super(ThetaValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_theta0.py b/plotly/validators/scatterpolargl/_theta0.py deleted file mode 100644 index 6d552f9fe15..00000000000 --- a/plotly/validators/scatterpolargl/_theta0.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class Theta0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='theta0', parent_name='scatterpolargl', **kwargs - ): - super(Theta0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_thetasrc.py b/plotly/validators/scatterpolargl/_thetasrc.py deleted file mode 100644 index f8027a2de7a..00000000000 --- a/plotly/validators/scatterpolargl/_thetasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThetasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='thetasrc', parent_name='scatterpolargl', **kwargs - ): - super(ThetasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_thetaunit.py b/plotly/validators/scatterpolargl/_thetaunit.py deleted file mode 100644 index 41f2896b36f..00000000000 --- a/plotly/validators/scatterpolargl/_thetaunit.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThetaunitValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='thetaunit', parent_name='scatterpolargl', **kwargs - ): - super(ThetaunitValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['radians', 'degrees', 'gradians']), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_uid.py b/plotly/validators/scatterpolargl/_uid.py deleted file mode 100644 index c191ac4d227..00000000000 --- a/plotly/validators/scatterpolargl/_uid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='uid', parent_name='scatterpolargl', **kwargs - ): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_uirevision.py b/plotly/validators/scatterpolargl/_uirevision.py deleted file mode 100644 index 796fe856803..00000000000 --- a/plotly/validators/scatterpolargl/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='scatterpolargl', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_unselected.py b/plotly/validators/scatterpolargl/_unselected.py deleted file mode 100644 index 749af25d8d9..00000000000 --- a/plotly/validators/scatterpolargl/_unselected.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='unselected', parent_name='scatterpolargl', **kwargs - ): - super(UnselectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Unselected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.scatterpolargl.unselected.Mar - ker instance or dict with compatible properties - textfont - plotly.graph_objs.scatterpolargl.unselected.Tex - tfont instance or dict with compatible - properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/_visible.py b/plotly/validators/scatterpolargl/_visible.py deleted file mode 100644 index 5794b1f2b6a..00000000000 --- a/plotly/validators/scatterpolargl/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='scatterpolargl', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/hoverlabel/__init__.py b/plotly/validators/scatterpolargl/hoverlabel/__init__.py index 856f769ba33..9e59580e6be 100644 --- a/plotly/validators/scatterpolargl/hoverlabel/__init__.py +++ b/plotly/validators/scatterpolargl/hoverlabel/__init__.py @@ -1,7 +1,176 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='scatterpolargl.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='scatterpolargl.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='scatterpolargl.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='scatterpolargl.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scatterpolargl.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='scatterpolargl.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scatterpolargl.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/hoverlabel/_bgcolor.py b/plotly/validators/scatterpolargl/hoverlabel/_bgcolor.py deleted file mode 100644 index 2260dbd44c3..00000000000 --- a/plotly/validators/scatterpolargl/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scatterpolargl.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/hoverlabel/_bgcolorsrc.py b/plotly/validators/scatterpolargl/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 2ee151e3cde..00000000000 --- a/plotly/validators/scatterpolargl/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='scatterpolargl.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/hoverlabel/_bordercolor.py b/plotly/validators/scatterpolargl/hoverlabel/_bordercolor.py deleted file mode 100644 index b5826fd9025..00000000000 --- a/plotly/validators/scatterpolargl/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scatterpolargl.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/hoverlabel/_bordercolorsrc.py b/plotly/validators/scatterpolargl/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index d8386968f9c..00000000000 --- a/plotly/validators/scatterpolargl/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='scatterpolargl.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/hoverlabel/_font.py b/plotly/validators/scatterpolargl/hoverlabel/_font.py deleted file mode 100644 index f5961ed4bf5..00000000000 --- a/plotly/validators/scatterpolargl/hoverlabel/_font.py +++ /dev/null @@ -1,50 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='scatterpolargl.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/hoverlabel/_namelength.py b/plotly/validators/scatterpolargl/hoverlabel/_namelength.py deleted file mode 100644 index c2f00584472..00000000000 --- a/plotly/validators/scatterpolargl/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='scatterpolargl.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/hoverlabel/_namelengthsrc.py b/plotly/validators/scatterpolargl/hoverlabel/_namelengthsrc.py deleted file mode 100644 index cea87abaa62..00000000000 --- a/plotly/validators/scatterpolargl/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='scatterpolargl.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/hoverlabel/font/__init__.py b/plotly/validators/scatterpolargl/hoverlabel/font/__init__.py index 1d2c591d1e5..db6a9968948 100644 --- a/plotly/validators/scatterpolargl/hoverlabel/font/__init__.py +++ b/plotly/validators/scatterpolargl/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scatterpolargl.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterpolargl.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='scatterpolargl.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatterpolargl.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatterpolargl.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolargl.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/hoverlabel/font/_color.py b/plotly/validators/scatterpolargl/hoverlabel/font/_color.py deleted file mode 100644 index 5fdac48950f..00000000000 --- a/plotly/validators/scatterpolargl/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolargl.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/hoverlabel/font/_colorsrc.py b/plotly/validators/scatterpolargl/hoverlabel/font/_colorsrc.py deleted file mode 100644 index c0e7578f1d9..00000000000 --- a/plotly/validators/scatterpolargl/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatterpolargl.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/hoverlabel/font/_family.py b/plotly/validators/scatterpolargl/hoverlabel/font/_family.py deleted file mode 100644 index 5f735e44b22..00000000000 --- a/plotly/validators/scatterpolargl/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatterpolargl.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/hoverlabel/font/_familysrc.py b/plotly/validators/scatterpolargl/hoverlabel/font/_familysrc.py deleted file mode 100644 index 0e1b23046dd..00000000000 --- a/plotly/validators/scatterpolargl/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='scatterpolargl.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/hoverlabel/font/_size.py b/plotly/validators/scatterpolargl/hoverlabel/font/_size.py deleted file mode 100644 index 1bf6a0ed8e3..00000000000 --- a/plotly/validators/scatterpolargl/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterpolargl.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/hoverlabel/font/_sizesrc.py b/plotly/validators/scatterpolargl/hoverlabel/font/_sizesrc.py deleted file mode 100644 index e2ece8862ce..00000000000 --- a/plotly/validators/scatterpolargl/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scatterpolargl.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/line/__init__.py b/plotly/validators/scatterpolargl/line/__init__.py index 158af14294f..32fcc2758ad 100644 --- a/plotly/validators/scatterpolargl/line/__init__.py +++ b/plotly/validators/scatterpolargl/line/__init__.py @@ -1,4 +1,76 @@ -from ._width import WidthValidator -from ._shape import ShapeValidator -from ._dash import DashValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scatterpolargl.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShapeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='shape', parent_name='scatterpolargl.line', **kwargs + ): + super(ShapeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['linear', 'hv', 'vh', 'hvh', 'vhv']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='dash', parent_name='scatterpolargl.line', **kwargs + ): + super(DashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scatterpolargl.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/line/_color.py b/plotly/validators/scatterpolargl/line/_color.py deleted file mode 100644 index 3a8a7e2ab32..00000000000 --- a/plotly/validators/scatterpolargl/line/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scatterpolargl.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/line/_dash.py b/plotly/validators/scatterpolargl/line/_dash.py deleted file mode 100644 index 10292ede237..00000000000 --- a/plotly/validators/scatterpolargl/line/_dash.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='dash', parent_name='scatterpolargl.line', **kwargs - ): - super(DashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/line/_shape.py b/plotly/validators/scatterpolargl/line/_shape.py deleted file mode 100644 index 1475e38305d..00000000000 --- a/plotly/validators/scatterpolargl/line/_shape.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShapeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='shape', parent_name='scatterpolargl.line', **kwargs - ): - super(ShapeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['linear', 'hv', 'vh', 'hvh', 'vhv']), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/line/_width.py b/plotly/validators/scatterpolargl/line/_width.py deleted file mode 100644 index cd0c92892f0..00000000000 --- a/plotly/validators/scatterpolargl/line/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scatterpolargl.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/__init__.py b/plotly/validators/scatterpolargl/marker/__init__.py index bad65b61294..163b36b4036 100644 --- a/plotly/validators/scatterpolargl/marker/__init__.py +++ b/plotly/validators/scatterpolargl/marker/__init__.py @@ -1,21 +1,800 @@ -from ._symbolsrc import SymbolsrcValidator -from ._symbol import SymbolValidator -from ._sizesrc import SizesrcValidator -from ._sizeref import SizerefValidator -from ._sizemode import SizemodeValidator -from ._sizemin import SizeminValidator -from ._size import SizeValidator -from ._showscale import ShowscaleValidator -from ._reversescale import ReversescaleValidator -from ._opacitysrc import OpacitysrcValidator -from ._opacity import OpacityValidator -from ._line import LineValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='symbolsrc', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(SymbolsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='symbol', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(SymbolValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, + 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', + 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', + 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', + 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', + 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, + 'star-triangle-down-open', 220, 'star-triangle-down-dot', + 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', + 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, + 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, + 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, + 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='sizeref', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(SizerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='sizemode', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(SizemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['diameter', 'area']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='sizemin', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(SizeminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showscale', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='opacitysrc', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(OpacitysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='line', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='colorbar', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scatterpolargl.marker.colorba + r.Tickformatstop instance or dict with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scatterpolargl.marker.colorbar.tickformatstop + defaults), sets the default property values to + use for elements of + scatterpolargl.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatterpolargl.marker.colorba + r.Title instance or dict with compatible + properties + titlefont + Deprecated: Please use + 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. + titleside + Deprecated: Please use + scatterpolargl.marker.colorbar.title.side + instead. Determines the location of color bar's + title with respect to the color bar. Note that + the title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scatterpolargl.marker.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmin', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmid', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmax', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='cauto', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scatterpolargl.marker', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/marker/_autocolorscale.py b/plotly/validators/scatterpolargl/marker/_autocolorscale.py deleted file mode 100644 index 32f34bc24f5..00000000000 --- a/plotly/validators/scatterpolargl/marker/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_cauto.py b/plotly/validators/scatterpolargl/marker/_cauto.py deleted file mode 100644 index 89eb97d6d33..00000000000 --- a/plotly/validators/scatterpolargl/marker/_cauto.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='cauto', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_cmax.py b/plotly/validators/scatterpolargl/marker/_cmax.py deleted file mode 100644 index f04ea8a51e0..00000000000 --- a/plotly/validators/scatterpolargl/marker/_cmax.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmax', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_cmid.py b/plotly/validators/scatterpolargl/marker/_cmid.py deleted file mode 100644 index 16b666526a8..00000000000 --- a/plotly/validators/scatterpolargl/marker/_cmid.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmid', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_cmin.py b/plotly/validators/scatterpolargl/marker/_cmin.py deleted file mode 100644 index ed807b78b3e..00000000000 --- a/plotly/validators/scatterpolargl/marker/_cmin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmin', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_color.py b/plotly/validators/scatterpolargl/marker/_color.py deleted file mode 100644 index 465dd5b84a8..00000000000 --- a/plotly/validators/scatterpolargl/marker/_color.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scatterpolargl.marker.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_colorbar.py b/plotly/validators/scatterpolargl/marker/_colorbar.py deleted file mode 100644 index c6833ea60b5..00000000000 --- a/plotly/validators/scatterpolargl/marker/_colorbar.py +++ /dev/null @@ -1,232 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='colorbar', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scatterpolargl.marker.colorba - r.Tickformatstop instance or dict with - compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scatterpolargl.marker.colorbar.tickformatstop - defaults), sets the default property values to - use for elements of - scatterpolargl.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatterpolargl.marker.colorba - r.Title instance or dict with compatible - properties - titlefont - Deprecated: Please use - 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. - titleside - Deprecated: Please use - scatterpolargl.marker.colorbar.title.side - instead. Determines the location of color bar's - title with respect to the color bar. Note that - the title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_colorscale.py b/plotly/validators/scatterpolargl/marker/_colorscale.py deleted file mode 100644 index 1100326c1fd..00000000000 --- a/plotly/validators/scatterpolargl/marker/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_colorsrc.py b/plotly/validators/scatterpolargl/marker/_colorsrc.py deleted file mode 100644 index 5c157391755..00000000000 --- a/plotly/validators/scatterpolargl/marker/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_line.py b/plotly/validators/scatterpolargl/marker/_line.py deleted file mode 100644 index e9bd35f6223..00000000000 --- a/plotly/validators/scatterpolargl/marker/_line.py +++ /dev/null @@ -1,100 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='line', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_opacity.py b/plotly/validators/scatterpolargl/marker/_opacity.py deleted file mode 100644 index c7025d41a40..00000000000 --- a/plotly/validators/scatterpolargl/marker/_opacity.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_opacitysrc.py b/plotly/validators/scatterpolargl/marker/_opacitysrc.py deleted file mode 100644 index f052a5576fb..00000000000 --- a/plotly/validators/scatterpolargl/marker/_opacitysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='opacitysrc', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(OpacitysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_reversescale.py b/plotly/validators/scatterpolargl/marker/_reversescale.py deleted file mode 100644 index bbc431932a3..00000000000 --- a/plotly/validators/scatterpolargl/marker/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_showscale.py b/plotly/validators/scatterpolargl/marker/_showscale.py deleted file mode 100644 index 475ac05c8a9..00000000000 --- a/plotly/validators/scatterpolargl/marker/_showscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showscale', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_size.py b/plotly/validators/scatterpolargl/marker/_size.py deleted file mode 100644 index 4f025dc84fd..00000000000 --- a/plotly/validators/scatterpolargl/marker/_size.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_sizemin.py b/plotly/validators/scatterpolargl/marker/_sizemin.py deleted file mode 100644 index 195f46cfac0..00000000000 --- a/plotly/validators/scatterpolargl/marker/_sizemin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='sizemin', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(SizeminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_sizemode.py b/plotly/validators/scatterpolargl/marker/_sizemode.py deleted file mode 100644 index 3e84c39c528..00000000000 --- a/plotly/validators/scatterpolargl/marker/_sizemode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='sizemode', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(SizemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['diameter', 'area']), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_sizeref.py b/plotly/validators/scatterpolargl/marker/_sizeref.py deleted file mode 100644 index 2e2fa87e4c1..00000000000 --- a/plotly/validators/scatterpolargl/marker/_sizeref.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='sizeref', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(SizerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_sizesrc.py b/plotly/validators/scatterpolargl/marker/_sizesrc.py deleted file mode 100644 index e6c98c12233..00000000000 --- a/plotly/validators/scatterpolargl/marker/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_symbol.py b/plotly/validators/scatterpolargl/marker/_symbol.py deleted file mode 100644 index faf46652f83..00000000000 --- a/plotly/validators/scatterpolargl/marker/_symbol.py +++ /dev/null @@ -1,81 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='symbol', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(SymbolValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, - 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', - 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', - 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', - 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', - 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, - 'star-triangle-down-open', 220, 'star-triangle-down-dot', - 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', - 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, - 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, - 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, - 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/_symbolsrc.py b/plotly/validators/scatterpolargl/marker/_symbolsrc.py deleted file mode 100644 index b645828ea68..00000000000 --- a/plotly/validators/scatterpolargl/marker/_symbolsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='symbolsrc', - parent_name='scatterpolargl.marker', - **kwargs - ): - super(SymbolsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/__init__.py b/plotly/validators/scatterpolargl/marker/colorbar/__init__.py index 3dab31f7e02..bb0d754e5f7 100644 --- a/plotly/validators/scatterpolargl/marker/colorbar/__init__.py +++ b/plotly/validators/scatterpolargl/marker/colorbar/__init__.py @@ -1,41 +1,936 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ypad', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='y', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xpad', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='x', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='len', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scatterpolargl.marker.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_bgcolor.py b/plotly/validators/scatterpolargl/marker/colorbar/_bgcolor.py deleted file mode 100644 index 93fc03fea81..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_bordercolor.py b/plotly/validators/scatterpolargl/marker/colorbar/_bordercolor.py deleted file mode 100644 index 73434298116..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_borderwidth.py b/plotly/validators/scatterpolargl/marker/colorbar/_borderwidth.py deleted file mode 100644 index 9f02008c416..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_dtick.py b/plotly/validators/scatterpolargl/marker/colorbar/_dtick.py deleted file mode 100644 index af66f3b3255..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_exponentformat.py b/plotly/validators/scatterpolargl/marker/colorbar/_exponentformat.py deleted file mode 100644 index 69931bb2a16..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_len.py b/plotly/validators/scatterpolargl/marker/colorbar/_len.py deleted file mode 100644 index 4f2a0cada84..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_len.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='len', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_lenmode.py b/plotly/validators/scatterpolargl/marker/colorbar/_lenmode.py deleted file mode 100644 index 36d9e4c0595..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_nticks.py b/plotly/validators/scatterpolargl/marker/colorbar/_nticks.py deleted file mode 100644 index f256b685131..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_outlinecolor.py b/plotly/validators/scatterpolargl/marker/colorbar/_outlinecolor.py deleted file mode 100644 index d21d441710f..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_outlinewidth.py b/plotly/validators/scatterpolargl/marker/colorbar/_outlinewidth.py deleted file mode 100644 index 3c0cd43eea1..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_separatethousands.py b/plotly/validators/scatterpolargl/marker/colorbar/_separatethousands.py deleted file mode 100644 index 338529eb832..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_showexponent.py b/plotly/validators/scatterpolargl/marker/colorbar/_showexponent.py deleted file mode 100644 index bf0547267bf..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_showticklabels.py b/plotly/validators/scatterpolargl/marker/colorbar/_showticklabels.py deleted file mode 100644 index 5f79e8394aa..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_showtickprefix.py b/plotly/validators/scatterpolargl/marker/colorbar/_showtickprefix.py deleted file mode 100644 index 00c5898f0b3..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_showticksuffix.py b/plotly/validators/scatterpolargl/marker/colorbar/_showticksuffix.py deleted file mode 100644 index 4fb73cfbe69..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_thickness.py b/plotly/validators/scatterpolargl/marker/colorbar/_thickness.py deleted file mode 100644 index 0f318eeb3ac..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_thicknessmode.py b/plotly/validators/scatterpolargl/marker/colorbar/_thicknessmode.py deleted file mode 100644 index c5c4ca0e188..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_tick0.py b/plotly/validators/scatterpolargl/marker/colorbar/_tick0.py deleted file mode 100644 index da3a85badbd..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_tickangle.py b/plotly/validators/scatterpolargl/marker/colorbar/_tickangle.py deleted file mode 100644 index ae0239bdaf4..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_tickcolor.py b/plotly/validators/scatterpolargl/marker/colorbar/_tickcolor.py deleted file mode 100644 index a5287fbd171..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_tickfont.py b/plotly/validators/scatterpolargl/marker/colorbar/_tickfont.py deleted file mode 100644 index e078d1cf5d6..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_tickformat.py b/plotly/validators/scatterpolargl/marker/colorbar/_tickformat.py deleted file mode 100644 index 3d16bb0fc05..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_tickformatstopdefaults.py b/plotly/validators/scatterpolargl/marker/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 18f41f907f4..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_tickformatstops.py b/plotly/validators/scatterpolargl/marker/colorbar/_tickformatstops.py deleted file mode 100644 index 9907b9bc5b4..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_ticklen.py b/plotly/validators/scatterpolargl/marker/colorbar/_ticklen.py deleted file mode 100644 index b415fb592de..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_tickmode.py b/plotly/validators/scatterpolargl/marker/colorbar/_tickmode.py deleted file mode 100644 index 7a1049cfa96..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_tickprefix.py b/plotly/validators/scatterpolargl/marker/colorbar/_tickprefix.py deleted file mode 100644 index 827b8567183..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_ticks.py b/plotly/validators/scatterpolargl/marker/colorbar/_ticks.py deleted file mode 100644 index 1d628a0608f..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_ticksuffix.py b/plotly/validators/scatterpolargl/marker/colorbar/_ticksuffix.py deleted file mode 100644 index 3fb71544619..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_ticktext.py b/plotly/validators/scatterpolargl/marker/colorbar/_ticktext.py deleted file mode 100644 index 281a69fc6a9..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_ticktextsrc.py b/plotly/validators/scatterpolargl/marker/colorbar/_ticktextsrc.py deleted file mode 100644 index be79cd4437e..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_tickvals.py b/plotly/validators/scatterpolargl/marker/colorbar/_tickvals.py deleted file mode 100644 index a6746f03f05..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_tickvalssrc.py b/plotly/validators/scatterpolargl/marker/colorbar/_tickvalssrc.py deleted file mode 100644 index 63b4ba5c52f..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_tickwidth.py b/plotly/validators/scatterpolargl/marker/colorbar/_tickwidth.py deleted file mode 100644 index 1643d060902..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_title.py b/plotly/validators/scatterpolargl/marker/colorbar/_title.py deleted file mode 100644 index 3c36a604054..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_x.py b/plotly/validators/scatterpolargl/marker/colorbar/_x.py deleted file mode 100644 index ded01955341..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_x.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='x', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_xanchor.py b/plotly/validators/scatterpolargl/marker/colorbar/_xanchor.py deleted file mode 100644 index e6144231e19..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_xpad.py b/plotly/validators/scatterpolargl/marker/colorbar/_xpad.py deleted file mode 100644 index cb9b0c7931f..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_xpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xpad', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_y.py b/plotly/validators/scatterpolargl/marker/colorbar/_y.py deleted file mode 100644 index d291bd7743b..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_y.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='y', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_yanchor.py b/plotly/validators/scatterpolargl/marker/colorbar/_yanchor.py deleted file mode 100644 index e58aea71acf..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/_ypad.py b/plotly/validators/scatterpolargl/marker/colorbar/_ypad.py deleted file mode 100644 index 6a0502fd938..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/_ypad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ypad', - parent_name='scatterpolargl.marker.colorbar', - **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/tickfont/__init__.py b/plotly/validators/scatterpolargl/marker/colorbar/tickfont/__init__.py index 199d72e71c6..6332f5d0036 100644 --- a/plotly/validators/scatterpolargl/marker/colorbar/tickfont/__init__.py +++ b/plotly/validators/scatterpolargl/marker/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterpolargl.marker.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatterpolargl.marker.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolargl.marker.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/tickfont/_color.py b/plotly/validators/scatterpolargl/marker/colorbar/tickfont/_color.py deleted file mode 100644 index b129abc88ca..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolargl.marker.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/tickfont/_family.py b/plotly/validators/scatterpolargl/marker/colorbar/tickfont/_family.py deleted file mode 100644 index e205a389b5d..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatterpolargl.marker.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/tickfont/_size.py b/plotly/validators/scatterpolargl/marker/colorbar/tickfont/_size.py deleted file mode 100644 index 975a5b66a0a..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterpolargl.marker.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/__init__.py b/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/__init__.py index 3f6c06cac47..9e47302c8b5 100644 --- a/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='scatterpolargl.marker.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='scatterpolargl.marker.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='scatterpolargl.marker.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='scatterpolargl.marker.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='scatterpolargl.marker.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'calc' + }, { + 'valType': 'any', + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 9af4b5e8832..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='scatterpolargl.marker.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'calc' - }, { - 'valType': 'any', - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/_enabled.py b/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index 28946c1b94e..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='scatterpolargl.marker.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/_name.py b/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/_name.py deleted file mode 100644 index 1c5e5e5ffac..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='scatterpolargl.marker.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 3aca0890a4c..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='scatterpolargl.marker.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/_value.py b/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/_value.py deleted file mode 100644 index c205922c084..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='scatterpolargl.marker.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/title/__init__.py b/plotly/validators/scatterpolargl/marker/colorbar/title/__init__.py index 33c9c145bb8..7176bfb05f0 100644 --- a/plotly/validators/scatterpolargl/marker/colorbar/title/__init__.py +++ b/plotly/validators/scatterpolargl/marker/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='scatterpolargl.marker.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='scatterpolargl.marker.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='scatterpolargl.marker.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/title/_font.py b/plotly/validators/scatterpolargl/marker/colorbar/title/_font.py deleted file mode 100644 index ad0b9a48f33..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='scatterpolargl.marker.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/title/_side.py b/plotly/validators/scatterpolargl/marker/colorbar/title/_side.py deleted file mode 100644 index a62c79e6fb8..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='scatterpolargl.marker.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/title/_text.py b/plotly/validators/scatterpolargl/marker/colorbar/title/_text.py deleted file mode 100644 index d2646ae387d..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='scatterpolargl.marker.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/title/font/__init__.py b/plotly/validators/scatterpolargl/marker/colorbar/title/font/__init__.py index 199d72e71c6..cf0963e0df4 100644 --- a/plotly/validators/scatterpolargl/marker/colorbar/title/font/__init__.py +++ b/plotly/validators/scatterpolargl/marker/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterpolargl.marker.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatterpolargl.marker.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolargl.marker.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/title/font/_color.py b/plotly/validators/scatterpolargl/marker/colorbar/title/font/_color.py deleted file mode 100644 index 17eedb1d65e..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolargl.marker.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/title/font/_family.py b/plotly/validators/scatterpolargl/marker/colorbar/title/font/_family.py deleted file mode 100644 index b5130116527..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatterpolargl.marker.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/colorbar/title/font/_size.py b/plotly/validators/scatterpolargl/marker/colorbar/title/font/_size.py deleted file mode 100644 index d8d5d62cb49..00000000000 --- a/plotly/validators/scatterpolargl/marker/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterpolargl.marker.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/line/__init__.py b/plotly/validators/scatterpolargl/marker/line/__init__.py index c031ca61ce2..121f9f2de6e 100644 --- a/plotly/validators/scatterpolargl/marker/line/__init__.py +++ b/plotly/validators/scatterpolargl/marker/line/__init__.py @@ -1,11 +1,235 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._reversescale import ReversescaleValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='widthsrc', + parent_name='scatterpolargl.marker.line', + **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='scatterpolargl.marker.line', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scatterpolargl.marker.line', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatterpolargl.marker.line', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='scatterpolargl.marker.line', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolargl.marker.line', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scatterpolargl.marker.line.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmin', + parent_name='scatterpolargl.marker.line', + **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmid', + parent_name='scatterpolargl.marker.line', + **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmax', + parent_name='scatterpolargl.marker.line', + **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='cauto', + parent_name='scatterpolargl.marker.line', + **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scatterpolargl.marker.line', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/marker/line/_autocolorscale.py b/plotly/validators/scatterpolargl/marker/line/_autocolorscale.py deleted file mode 100644 index c7b1018ee25..00000000000 --- a/plotly/validators/scatterpolargl/marker/line/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scatterpolargl.marker.line', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/line/_cauto.py b/plotly/validators/scatterpolargl/marker/line/_cauto.py deleted file mode 100644 index b096a94ac24..00000000000 --- a/plotly/validators/scatterpolargl/marker/line/_cauto.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='cauto', - parent_name='scatterpolargl.marker.line', - **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/line/_cmax.py b/plotly/validators/scatterpolargl/marker/line/_cmax.py deleted file mode 100644 index d060f403965..00000000000 --- a/plotly/validators/scatterpolargl/marker/line/_cmax.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmax', - parent_name='scatterpolargl.marker.line', - **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/line/_cmid.py b/plotly/validators/scatterpolargl/marker/line/_cmid.py deleted file mode 100644 index 6c36d6b1d97..00000000000 --- a/plotly/validators/scatterpolargl/marker/line/_cmid.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmid', - parent_name='scatterpolargl.marker.line', - **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/line/_cmin.py b/plotly/validators/scatterpolargl/marker/line/_cmin.py deleted file mode 100644 index 84938e90448..00000000000 --- a/plotly/validators/scatterpolargl/marker/line/_cmin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmin', - parent_name='scatterpolargl.marker.line', - **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/line/_color.py b/plotly/validators/scatterpolargl/marker/line/_color.py deleted file mode 100644 index 9d6215acba5..00000000000 --- a/plotly/validators/scatterpolargl/marker/line/_color.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolargl.marker.line', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scatterpolargl.marker.line.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/line/_colorscale.py b/plotly/validators/scatterpolargl/marker/line/_colorscale.py deleted file mode 100644 index e64fb33afe0..00000000000 --- a/plotly/validators/scatterpolargl/marker/line/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='scatterpolargl.marker.line', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/line/_colorsrc.py b/plotly/validators/scatterpolargl/marker/line/_colorsrc.py deleted file mode 100644 index 5ea0d4a3f25..00000000000 --- a/plotly/validators/scatterpolargl/marker/line/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatterpolargl.marker.line', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/line/_reversescale.py b/plotly/validators/scatterpolargl/marker/line/_reversescale.py deleted file mode 100644 index 82c0da59d72..00000000000 --- a/plotly/validators/scatterpolargl/marker/line/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scatterpolargl.marker.line', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/line/_width.py b/plotly/validators/scatterpolargl/marker/line/_width.py deleted file mode 100644 index 8c0f24c7ffc..00000000000 --- a/plotly/validators/scatterpolargl/marker/line/_width.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='scatterpolargl.marker.line', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/marker/line/_widthsrc.py b/plotly/validators/scatterpolargl/marker/line/_widthsrc.py deleted file mode 100644 index c3897e122e2..00000000000 --- a/plotly/validators/scatterpolargl/marker/line/_widthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='widthsrc', - parent_name='scatterpolargl.marker.line', - **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/selected/__init__.py b/plotly/validators/scatterpolargl/selected/__init__.py index f1a1ef3742f..74c507b8771 100644 --- a/plotly/validators/scatterpolargl/selected/__init__.py +++ b/plotly/validators/scatterpolargl/selected/__init__.py @@ -1,2 +1,54 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='scatterpolargl.selected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of selected points. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='scatterpolargl.selected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/selected/_marker.py b/plotly/validators/scatterpolargl/selected/_marker.py deleted file mode 100644 index fb10661979e..00000000000 --- a/plotly/validators/scatterpolargl/selected/_marker.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='scatterpolargl.selected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/selected/_textfont.py b/plotly/validators/scatterpolargl/selected/_textfont.py deleted file mode 100644 index a7a987f3a62..00000000000 --- a/plotly/validators/scatterpolargl/selected/_textfont.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='scatterpolargl.selected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/selected/marker/__init__.py b/plotly/validators/scatterpolargl/selected/marker/__init__.py index ed9a9070947..bbfbf292b3b 100644 --- a/plotly/validators/scatterpolargl/selected/marker/__init__.py +++ b/plotly/validators/scatterpolargl/selected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterpolargl.selected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scatterpolargl.selected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolargl.selected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/selected/marker/_color.py b/plotly/validators/scatterpolargl/selected/marker/_color.py deleted file mode 100644 index 3c140316a67..00000000000 --- a/plotly/validators/scatterpolargl/selected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolargl.selected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/selected/marker/_opacity.py b/plotly/validators/scatterpolargl/selected/marker/_opacity.py deleted file mode 100644 index 9570498ca42..00000000000 --- a/plotly/validators/scatterpolargl/selected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scatterpolargl.selected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/selected/marker/_size.py b/plotly/validators/scatterpolargl/selected/marker/_size.py deleted file mode 100644 index fe1f5c68b06..00000000000 --- a/plotly/validators/scatterpolargl/selected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterpolargl.selected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/selected/textfont/__init__.py b/plotly/validators/scatterpolargl/selected/textfont/__init__.py index 74135b3f315..c3e7fd9cf35 100644 --- a/plotly/validators/scatterpolargl/selected/textfont/__init__.py +++ b/plotly/validators/scatterpolargl/selected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolargl.selected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/selected/textfont/_color.py b/plotly/validators/scatterpolargl/selected/textfont/_color.py deleted file mode 100644 index 44e5734452c..00000000000 --- a/plotly/validators/scatterpolargl/selected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolargl.selected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/stream/__init__.py b/plotly/validators/scatterpolargl/stream/__init__.py index 2f4f2047594..ebb460c76e1 100644 --- a/plotly/validators/scatterpolargl/stream/__init__.py +++ b/plotly/validators/scatterpolargl/stream/__init__.py @@ -1,2 +1,44 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='token', + parent_name='scatterpolargl.stream', + **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='scatterpolargl.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/stream/_maxpoints.py b/plotly/validators/scatterpolargl/stream/_maxpoints.py deleted file mode 100644 index 50dd969ba7d..00000000000 --- a/plotly/validators/scatterpolargl/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='scatterpolargl.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/stream/_token.py b/plotly/validators/scatterpolargl/stream/_token.py deleted file mode 100644 index d73828089ed..00000000000 --- a/plotly/validators/scatterpolargl/stream/_token.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='token', - parent_name='scatterpolargl.stream', - **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/textfont/__init__.py b/plotly/validators/scatterpolargl/textfont/__init__.py index 1d2c591d1e5..b196abbbace 100644 --- a/plotly/validators/scatterpolargl/textfont/__init__.py +++ b/plotly/validators/scatterpolargl/textfont/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scatterpolargl.textfont', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterpolargl.textfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='scatterpolargl.textfont', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatterpolargl.textfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatterpolargl.textfont', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolargl.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/textfont/_color.py b/plotly/validators/scatterpolargl/textfont/_color.py deleted file mode 100644 index 18d36299930..00000000000 --- a/plotly/validators/scatterpolargl/textfont/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolargl.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/textfont/_colorsrc.py b/plotly/validators/scatterpolargl/textfont/_colorsrc.py deleted file mode 100644 index 01a9ee78e75..00000000000 --- a/plotly/validators/scatterpolargl/textfont/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatterpolargl.textfont', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/textfont/_family.py b/plotly/validators/scatterpolargl/textfont/_family.py deleted file mode 100644 index 0eb42b48f72..00000000000 --- a/plotly/validators/scatterpolargl/textfont/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatterpolargl.textfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/textfont/_familysrc.py b/plotly/validators/scatterpolargl/textfont/_familysrc.py deleted file mode 100644 index bcb851f1bd5..00000000000 --- a/plotly/validators/scatterpolargl/textfont/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='scatterpolargl.textfont', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/textfont/_size.py b/plotly/validators/scatterpolargl/textfont/_size.py deleted file mode 100644 index 841d0b2a797..00000000000 --- a/plotly/validators/scatterpolargl/textfont/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterpolargl.textfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/textfont/_sizesrc.py b/plotly/validators/scatterpolargl/textfont/_sizesrc.py deleted file mode 100644 index be2960295e2..00000000000 --- a/plotly/validators/scatterpolargl/textfont/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scatterpolargl.textfont', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/unselected/__init__.py b/plotly/validators/scatterpolargl/unselected/__init__.py index f1a1ef3742f..c298d9723f6 100644 --- a/plotly/validators/scatterpolargl/unselected/__init__.py +++ b/plotly/validators/scatterpolargl/unselected/__init__.py @@ -1,2 +1,58 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='scatterpolargl.unselected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='scatterpolargl.unselected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of unselected points, + applied only when a selection exists. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/unselected/_marker.py b/plotly/validators/scatterpolargl/unselected/_marker.py deleted file mode 100644 index 51b53eece70..00000000000 --- a/plotly/validators/scatterpolargl/unselected/_marker.py +++ /dev/null @@ -1,30 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='scatterpolargl.unselected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of unselected points, - applied only when a selection exists. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/unselected/_textfont.py b/plotly/validators/scatterpolargl/unselected/_textfont.py deleted file mode 100644 index ecb4e44568d..00000000000 --- a/plotly/validators/scatterpolargl/unselected/_textfont.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='scatterpolargl.unselected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/unselected/marker/__init__.py b/plotly/validators/scatterpolargl/unselected/marker/__init__.py index ed9a9070947..192b13004b0 100644 --- a/plotly/validators/scatterpolargl/unselected/marker/__init__.py +++ b/plotly/validators/scatterpolargl/unselected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterpolargl.unselected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scatterpolargl.unselected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolargl.unselected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/unselected/marker/_color.py b/plotly/validators/scatterpolargl/unselected/marker/_color.py deleted file mode 100644 index 0bcca64a060..00000000000 --- a/plotly/validators/scatterpolargl/unselected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolargl.unselected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/unselected/marker/_opacity.py b/plotly/validators/scatterpolargl/unselected/marker/_opacity.py deleted file mode 100644 index 45186900712..00000000000 --- a/plotly/validators/scatterpolargl/unselected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scatterpolargl.unselected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/unselected/marker/_size.py b/plotly/validators/scatterpolargl/unselected/marker/_size.py deleted file mode 100644 index 4698bd86327..00000000000 --- a/plotly/validators/scatterpolargl/unselected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterpolargl.unselected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterpolargl/unselected/textfont/__init__.py b/plotly/validators/scatterpolargl/unselected/textfont/__init__.py index 74135b3f315..3c8ed24ecad 100644 --- a/plotly/validators/scatterpolargl/unselected/textfont/__init__.py +++ b/plotly/validators/scatterpolargl/unselected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterpolargl.unselected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterpolargl/unselected/textfont/_color.py b/plotly/validators/scatterpolargl/unselected/textfont/_color.py deleted file mode 100644 index 03a34a66b76..00000000000 --- a/plotly/validators/scatterpolargl/unselected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterpolargl.unselected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/__init__.py b/plotly/validators/scatterternary/__init__.py index f1ce2c9a9d3..d1c38d6750c 100644 --- a/plotly/validators/scatterternary/__init__.py +++ b/plotly/validators/scatterternary/__init__.py @@ -1,43 +1,1023 @@ -from ._visible import VisibleValidator -from ._unselected import UnselectedValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textsrc import TextsrcValidator -from ._textpositionsrc import TextpositionsrcValidator -from ._textposition import TextpositionValidator -from ._textfont import TextfontValidator -from ._text import TextValidator -from ._sum import SumValidator -from ._subplot import SubplotValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._selected import SelectedValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._mode import ModeValidator -from ._marker import MarkerValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoveron import HoveronValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._fillcolor import FillcolorValidator -from ._fill import FillValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._csrc import CsrcValidator -from ._connectgaps import ConnectgapsValidator -from ._cliponaxis import CliponaxisValidator -from ._c import CValidator -from ._bsrc import BsrcValidator -from ._b import BValidator -from ._asrc import AsrcValidator -from ._a import AValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='scatterternary', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='unselected', parent_name='scatterternary', **kwargs + ): + super(UnselectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Unselected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.scatterternary.unselected.Mar + ker instance or dict with compatible properties + textfont + plotly.graph_objs.scatterternary.unselected.Tex + tfont instance or dict with compatible + properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='scatterternary', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='uid', parent_name='scatterternary', **kwargs + ): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='textsrc', parent_name='scatterternary', **kwargs + ): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='textpositionsrc', + parent_name='scatterternary', + **kwargs + ): + super(TextpositionsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='textposition', + parent_name='scatterternary', + **kwargs + ): + super(TextpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 'top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', + 'bottom center', 'bottom right' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='textfont', parent_name='scatterternary', **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='text', parent_name='scatterternary', **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SumValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sum', parent_name='scatterternary', **kwargs + ): + super(SumValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SubplotValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='subplot', parent_name='scatterternary', **kwargs + ): + super(SubplotValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'ternary'), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='scatterternary', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='scatterternary', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='selectedpoints', + parent_name='scatterternary', + **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='selected', parent_name='scatterternary', **kwargs + ): + super(SelectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Selected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.scatterternary.selected.Marke + r instance or dict with compatible properties + textfont + plotly.graph_objs.scatterternary.selected.Textf + ont instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='scatterternary', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='scatterternary', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='mode', parent_name='scatterternary', **kwargs + ): + super(ModeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['none']), + flags=kwargs.pop('flags', ['lines', 'markers', 'text']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='scatterternary', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.scatterternary.marker.ColorBa + r instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + gradient + plotly.graph_objs.scatterternary.marker.Gradien + t instance or dict with compatible properties + line + plotly.graph_objs.scatterternary.marker.Line + instance or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on + the graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='scatterternary', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash + type string ("solid", "dot", "dash", + "longdash", "dashdot", or "longdashdot") or a + dash length list in px (eg "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the + lines are drawn using spline interpolation. The + other available values correspond to step-wise + line shapes. + smoothing + Has an effect only if `shape` is set to + "spline" Sets the amount of smoothing. 0 + corresponds to no smoothing (equivalent to a + "linear" shape). + width + Sets the line width (in px). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='legendgroup', + parent_name='scatterternary', + **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='scatterternary', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ids', parent_name='scatterternary', **kwargs + ): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertextsrc', + parent_name='scatterternary', + **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='scatterternary', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertemplatesrc', + parent_name='scatterternary', + **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='hovertemplate', + parent_name='scatterternary', + **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoveronValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoveron', parent_name='scatterternary', **kwargs + ): + super(HoveronValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + flags=kwargs.pop('flags', ['points', 'fills']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='scatterternary', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hoverinfosrc', + parent_name='scatterternary', + **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='scatterternary', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['a', 'b', 'c', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='fillcolor', parent_name='scatterternary', **kwargs + ): + super(FillcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='fill', parent_name='scatterternary', **kwargs + ): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['none', 'toself', 'tonext']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='customdatasrc', + parent_name='scatterternary', + **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='scatterternary', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='csrc', parent_name='scatterternary', **kwargs + ): + super(CsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='connectgaps', + parent_name='scatterternary', + **kwargs + ): + super(ConnectgapsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CliponaxisValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cliponaxis', parent_name='scatterternary', **kwargs + ): + super(CliponaxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='c', parent_name='scatterternary', **kwargs + ): + super(CValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='bsrc', parent_name='scatterternary', **kwargs + ): + super(BsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='b', parent_name='scatterternary', **kwargs + ): + super(BValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='asrc', parent_name='scatterternary', **kwargs + ): + super(AsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='a', parent_name='scatterternary', **kwargs + ): + super(AValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/_a.py b/plotly/validators/scatterternary/_a.py deleted file mode 100644 index 3c2ae57aa23..00000000000 --- a/plotly/validators/scatterternary/_a.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='a', parent_name='scatterternary', **kwargs - ): - super(AValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_asrc.py b/plotly/validators/scatterternary/_asrc.py deleted file mode 100644 index 0c40799349b..00000000000 --- a/plotly/validators/scatterternary/_asrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='asrc', parent_name='scatterternary', **kwargs - ): - super(AsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_b.py b/plotly/validators/scatterternary/_b.py deleted file mode 100644 index 31d232c3e69..00000000000 --- a/plotly/validators/scatterternary/_b.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='b', parent_name='scatterternary', **kwargs - ): - super(BValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_bsrc.py b/plotly/validators/scatterternary/_bsrc.py deleted file mode 100644 index 1263e8a7fa8..00000000000 --- a/plotly/validators/scatterternary/_bsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='bsrc', parent_name='scatterternary', **kwargs - ): - super(BsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_c.py b/plotly/validators/scatterternary/_c.py deleted file mode 100644 index f1938402ac1..00000000000 --- a/plotly/validators/scatterternary/_c.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='c', parent_name='scatterternary', **kwargs - ): - super(CValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_cliponaxis.py b/plotly/validators/scatterternary/_cliponaxis.py deleted file mode 100644 index 3a8514c9ee7..00000000000 --- a/plotly/validators/scatterternary/_cliponaxis.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CliponaxisValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cliponaxis', parent_name='scatterternary', **kwargs - ): - super(CliponaxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_connectgaps.py b/plotly/validators/scatterternary/_connectgaps.py deleted file mode 100644 index 658bf047fdf..00000000000 --- a/plotly/validators/scatterternary/_connectgaps.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ConnectgapsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='connectgaps', - parent_name='scatterternary', - **kwargs - ): - super(ConnectgapsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_csrc.py b/plotly/validators/scatterternary/_csrc.py deleted file mode 100644 index 56581a5151b..00000000000 --- a/plotly/validators/scatterternary/_csrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='csrc', parent_name='scatterternary', **kwargs - ): - super(CsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_customdata.py b/plotly/validators/scatterternary/_customdata.py deleted file mode 100644 index 4e15fb79469..00000000000 --- a/plotly/validators/scatterternary/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='scatterternary', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_customdatasrc.py b/plotly/validators/scatterternary/_customdatasrc.py deleted file mode 100644 index 3912205fccc..00000000000 --- a/plotly/validators/scatterternary/_customdatasrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='customdatasrc', - parent_name='scatterternary', - **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_fill.py b/plotly/validators/scatterternary/_fill.py deleted file mode 100644 index 8b37b3c8ac9..00000000000 --- a/plotly/validators/scatterternary/_fill.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='fill', parent_name='scatterternary', **kwargs - ): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['none', 'toself', 'tonext']), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_fillcolor.py b/plotly/validators/scatterternary/_fillcolor.py deleted file mode 100644 index f911308e1cc..00000000000 --- a/plotly/validators/scatterternary/_fillcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='fillcolor', parent_name='scatterternary', **kwargs - ): - super(FillcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_hoverinfo.py b/plotly/validators/scatterternary/_hoverinfo.py deleted file mode 100644 index 2def79cec88..00000000000 --- a/plotly/validators/scatterternary/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='scatterternary', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['a', 'b', 'c', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_hoverinfosrc.py b/plotly/validators/scatterternary/_hoverinfosrc.py deleted file mode 100644 index cdfdc90559e..00000000000 --- a/plotly/validators/scatterternary/_hoverinfosrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hoverinfosrc', - parent_name='scatterternary', - **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_hoverlabel.py b/plotly/validators/scatterternary/_hoverlabel.py deleted file mode 100644 index 2c9baeba350..00000000000 --- a/plotly/validators/scatterternary/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='scatterternary', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_hoveron.py b/plotly/validators/scatterternary/_hoveron.py deleted file mode 100644 index 8a053f6f952..00000000000 --- a/plotly/validators/scatterternary/_hoveron.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoveronValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoveron', parent_name='scatterternary', **kwargs - ): - super(HoveronValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - flags=kwargs.pop('flags', ['points', 'fills']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_hovertemplate.py b/plotly/validators/scatterternary/_hovertemplate.py deleted file mode 100644 index 97e9a7f109b..00000000000 --- a/plotly/validators/scatterternary/_hovertemplate.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='hovertemplate', - parent_name='scatterternary', - **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_hovertemplatesrc.py b/plotly/validators/scatterternary/_hovertemplatesrc.py deleted file mode 100644 index c098b16bd67..00000000000 --- a/plotly/validators/scatterternary/_hovertemplatesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertemplatesrc', - parent_name='scatterternary', - **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_hovertext.py b/plotly/validators/scatterternary/_hovertext.py deleted file mode 100644 index d6be31b3d39..00000000000 --- a/plotly/validators/scatterternary/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='scatterternary', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_hovertextsrc.py b/plotly/validators/scatterternary/_hovertextsrc.py deleted file mode 100644 index e1ab8622397..00000000000 --- a/plotly/validators/scatterternary/_hovertextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertextsrc', - parent_name='scatterternary', - **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_ids.py b/plotly/validators/scatterternary/_ids.py deleted file mode 100644 index a47c4d1fb6d..00000000000 --- a/plotly/validators/scatterternary/_ids.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ids', parent_name='scatterternary', **kwargs - ): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_idssrc.py b/plotly/validators/scatterternary/_idssrc.py deleted file mode 100644 index 3b61b282ef5..00000000000 --- a/plotly/validators/scatterternary/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='scatterternary', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_legendgroup.py b/plotly/validators/scatterternary/_legendgroup.py deleted file mode 100644 index 7b6908d7a79..00000000000 --- a/plotly/validators/scatterternary/_legendgroup.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='legendgroup', - parent_name='scatterternary', - **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_line.py b/plotly/validators/scatterternary/_line.py deleted file mode 100644 index 2ee3eb1102c..00000000000 --- a/plotly/validators/scatterternary/_line.py +++ /dev/null @@ -1,37 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='scatterternary', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the line color. - dash - Sets the dash style of lines. Set to a dash - type string ("solid", "dot", "dash", - "longdash", "dashdot", or "longdashdot") or a - dash length list in px (eg "5px,10px,2px,2px"). - shape - Determines the line shape. With "spline" the - lines are drawn using spline interpolation. The - other available values correspond to step-wise - line shapes. - smoothing - Has an effect only if `shape` is set to - "spline" Sets the amount of smoothing. 0 - corresponds to no smoothing (equivalent to a - "linear" shape). - width - Sets the line width (in px). -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_marker.py b/plotly/validators/scatterternary/_marker.py deleted file mode 100644 index 1f5c43adf49..00000000000 --- a/plotly/validators/scatterternary/_marker.py +++ /dev/null @@ -1,137 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='scatterternary', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.scatterternary.marker.ColorBa - r instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - gradient - plotly.graph_objs.scatterternary.marker.Gradien - t instance or dict with compatible properties - line - plotly.graph_objs.scatterternary.marker.Line - instance or dict with compatible properties - maxdisplayed - Sets a maximum number of points to be drawn on - the graph. 0 corresponds to no limit. - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_mode.py b/plotly/validators/scatterternary/_mode.py deleted file mode 100644 index 2985f90be27..00000000000 --- a/plotly/validators/scatterternary/_mode.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ModeValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='mode', parent_name='scatterternary', **kwargs - ): - super(ModeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['none']), - flags=kwargs.pop('flags', ['lines', 'markers', 'text']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_name.py b/plotly/validators/scatterternary/_name.py deleted file mode 100644 index 845893e4ed5..00000000000 --- a/plotly/validators/scatterternary/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='scatterternary', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_opacity.py b/plotly/validators/scatterternary/_opacity.py deleted file mode 100644 index 61ed1f69b23..00000000000 --- a/plotly/validators/scatterternary/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='scatterternary', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_selected.py b/plotly/validators/scatterternary/_selected.py deleted file mode 100644 index c49de421628..00000000000 --- a/plotly/validators/scatterternary/_selected.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='selected', parent_name='scatterternary', **kwargs - ): - super(SelectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Selected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.scatterternary.selected.Marke - r instance or dict with compatible properties - textfont - plotly.graph_objs.scatterternary.selected.Textf - ont instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_selectedpoints.py b/plotly/validators/scatterternary/_selectedpoints.py deleted file mode 100644 index 851eac4ae8f..00000000000 --- a/plotly/validators/scatterternary/_selectedpoints.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='selectedpoints', - parent_name='scatterternary', - **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_showlegend.py b/plotly/validators/scatterternary/_showlegend.py deleted file mode 100644 index c9118b90cce..00000000000 --- a/plotly/validators/scatterternary/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='scatterternary', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_stream.py b/plotly/validators/scatterternary/_stream.py deleted file mode 100644 index 8e923373769..00000000000 --- a/plotly/validators/scatterternary/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='scatterternary', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_subplot.py b/plotly/validators/scatterternary/_subplot.py deleted file mode 100644 index 549e312ae47..00000000000 --- a/plotly/validators/scatterternary/_subplot.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SubplotValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='subplot', parent_name='scatterternary', **kwargs - ): - super(SubplotValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'ternary'), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_sum.py b/plotly/validators/scatterternary/_sum.py deleted file mode 100644 index c5344a81037..00000000000 --- a/plotly/validators/scatterternary/_sum.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SumValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sum', parent_name='scatterternary', **kwargs - ): - super(SumValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_text.py b/plotly/validators/scatterternary/_text.py deleted file mode 100644 index d7170dc7c3a..00000000000 --- a/plotly/validators/scatterternary/_text.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='text', parent_name='scatterternary', **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_textfont.py b/plotly/validators/scatterternary/_textfont.py deleted file mode 100644 index 009d1e7d700..00000000000 --- a/plotly/validators/scatterternary/_textfont.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='textfont', parent_name='scatterternary', **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_textposition.py b/plotly/validators/scatterternary/_textposition.py deleted file mode 100644 index ee273d7f786..00000000000 --- a/plotly/validators/scatterternary/_textposition.py +++ /dev/null @@ -1,26 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='textposition', - parent_name='scatterternary', - **kwargs - ): - super(TextpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 'top left', 'top center', 'top right', 'middle left', - 'middle center', 'middle right', 'bottom left', - 'bottom center', 'bottom right' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_textpositionsrc.py b/plotly/validators/scatterternary/_textpositionsrc.py deleted file mode 100644 index d7d81322d42..00000000000 --- a/plotly/validators/scatterternary/_textpositionsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextpositionsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='textpositionsrc', - parent_name='scatterternary', - **kwargs - ): - super(TextpositionsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_textsrc.py b/plotly/validators/scatterternary/_textsrc.py deleted file mode 100644 index d67f7ef3c2f..00000000000 --- a/plotly/validators/scatterternary/_textsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='textsrc', parent_name='scatterternary', **kwargs - ): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_uid.py b/plotly/validators/scatterternary/_uid.py deleted file mode 100644 index ead998b1489..00000000000 --- a/plotly/validators/scatterternary/_uid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='uid', parent_name='scatterternary', **kwargs - ): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_uirevision.py b/plotly/validators/scatterternary/_uirevision.py deleted file mode 100644 index aa2d4295f32..00000000000 --- a/plotly/validators/scatterternary/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='scatterternary', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_unselected.py b/plotly/validators/scatterternary/_unselected.py deleted file mode 100644 index c6ae1688a2b..00000000000 --- a/plotly/validators/scatterternary/_unselected.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='unselected', parent_name='scatterternary', **kwargs - ): - super(UnselectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Unselected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.scatterternary.unselected.Mar - ker instance or dict with compatible properties - textfont - plotly.graph_objs.scatterternary.unselected.Tex - tfont instance or dict with compatible - properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/_visible.py b/plotly/validators/scatterternary/_visible.py deleted file mode 100644 index 087ee63c249..00000000000 --- a/plotly/validators/scatterternary/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='scatterternary', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/scatterternary/hoverlabel/__init__.py b/plotly/validators/scatterternary/hoverlabel/__init__.py index 856f769ba33..8700cbd3538 100644 --- a/plotly/validators/scatterternary/hoverlabel/__init__.py +++ b/plotly/validators/scatterternary/hoverlabel/__init__.py @@ -1,7 +1,176 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='scatterternary.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='scatterternary.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='scatterternary.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='scatterternary.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scatterternary.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='scatterternary.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scatterternary.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/hoverlabel/_bgcolor.py b/plotly/validators/scatterternary/hoverlabel/_bgcolor.py deleted file mode 100644 index e34adc1969d..00000000000 --- a/plotly/validators/scatterternary/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scatterternary.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/hoverlabel/_bgcolorsrc.py b/plotly/validators/scatterternary/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index bd376a91df0..00000000000 --- a/plotly/validators/scatterternary/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='scatterternary.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/hoverlabel/_bordercolor.py b/plotly/validators/scatterternary/hoverlabel/_bordercolor.py deleted file mode 100644 index 3ce8eb3bd86..00000000000 --- a/plotly/validators/scatterternary/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scatterternary.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/hoverlabel/_bordercolorsrc.py b/plotly/validators/scatterternary/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 62efd4290e0..00000000000 --- a/plotly/validators/scatterternary/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='scatterternary.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/hoverlabel/_font.py b/plotly/validators/scatterternary/hoverlabel/_font.py deleted file mode 100644 index 93e8eaad067..00000000000 --- a/plotly/validators/scatterternary/hoverlabel/_font.py +++ /dev/null @@ -1,50 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='scatterternary.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/hoverlabel/_namelength.py b/plotly/validators/scatterternary/hoverlabel/_namelength.py deleted file mode 100644 index b98774d1716..00000000000 --- a/plotly/validators/scatterternary/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='scatterternary.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/hoverlabel/_namelengthsrc.py b/plotly/validators/scatterternary/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 34e74712d3a..00000000000 --- a/plotly/validators/scatterternary/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='scatterternary.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/hoverlabel/font/__init__.py b/plotly/validators/scatterternary/hoverlabel/font/__init__.py index 1d2c591d1e5..28ce8ae10aa 100644 --- a/plotly/validators/scatterternary/hoverlabel/font/__init__.py +++ b/plotly/validators/scatterternary/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scatterternary.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterternary.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='scatterternary.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatterternary.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatterternary.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterternary.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/hoverlabel/font/_color.py b/plotly/validators/scatterternary/hoverlabel/font/_color.py deleted file mode 100644 index f2830f658dd..00000000000 --- a/plotly/validators/scatterternary/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterternary.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/hoverlabel/font/_colorsrc.py b/plotly/validators/scatterternary/hoverlabel/font/_colorsrc.py deleted file mode 100644 index f4232f05f44..00000000000 --- a/plotly/validators/scatterternary/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatterternary.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/hoverlabel/font/_family.py b/plotly/validators/scatterternary/hoverlabel/font/_family.py deleted file mode 100644 index 7964d08c390..00000000000 --- a/plotly/validators/scatterternary/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatterternary.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatterternary/hoverlabel/font/_familysrc.py b/plotly/validators/scatterternary/hoverlabel/font/_familysrc.py deleted file mode 100644 index 4526355256f..00000000000 --- a/plotly/validators/scatterternary/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='scatterternary.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/hoverlabel/font/_size.py b/plotly/validators/scatterternary/hoverlabel/font/_size.py deleted file mode 100644 index 7a78af71f73..00000000000 --- a/plotly/validators/scatterternary/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterternary.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/hoverlabel/font/_sizesrc.py b/plotly/validators/scatterternary/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 3b71fed6384..00000000000 --- a/plotly/validators/scatterternary/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scatterternary.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/line/__init__.py b/plotly/validators/scatterternary/line/__init__.py index 633e654df05..e45444fb1a1 100644 --- a/plotly/validators/scatterternary/line/__init__.py +++ b/plotly/validators/scatterternary/line/__init__.py @@ -1,5 +1,98 @@ -from ._width import WidthValidator -from ._smoothing import SmoothingValidator -from ._shape import ShapeValidator -from ._dash import DashValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='scatterternary.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='smoothing', + parent_name='scatterternary.line', + **kwargs + ): + super(SmoothingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 1.3), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShapeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='shape', parent_name='scatterternary.line', **kwargs + ): + super(ShapeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['linear', 'spline']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DashValidator(_plotly_utils.basevalidators.DashValidator): + + def __init__( + self, plotly_name='dash', parent_name='scatterternary.line', **kwargs + ): + super(DashValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='scatterternary.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/line/_color.py b/plotly/validators/scatterternary/line/_color.py deleted file mode 100644 index 9451cc23fdb..00000000000 --- a/plotly/validators/scatterternary/line/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='scatterternary.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/line/_dash.py b/plotly/validators/scatterternary/line/_dash.py deleted file mode 100644 index 6017a6e4338..00000000000 --- a/plotly/validators/scatterternary/line/_dash.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DashValidator(_plotly_utils.basevalidators.DashValidator): - - def __init__( - self, plotly_name='dash', parent_name='scatterternary.line', **kwargs - ): - super(DashValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', - ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/line/_shape.py b/plotly/validators/scatterternary/line/_shape.py deleted file mode 100644 index 3a2df0a8c24..00000000000 --- a/plotly/validators/scatterternary/line/_shape.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShapeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='shape', parent_name='scatterternary.line', **kwargs - ): - super(ShapeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['linear', 'spline']), - **kwargs - ) diff --git a/plotly/validators/scatterternary/line/_smoothing.py b/plotly/validators/scatterternary/line/_smoothing.py deleted file mode 100644 index 545a5109332..00000000000 --- a/plotly/validators/scatterternary/line/_smoothing.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SmoothingValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='smoothing', - parent_name='scatterternary.line', - **kwargs - ): - super(SmoothingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 1.3), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/line/_width.py b/plotly/validators/scatterternary/line/_width.py deleted file mode 100644 index 730463b1d33..00000000000 --- a/plotly/validators/scatterternary/line/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='scatterternary.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/__init__.py b/plotly/validators/scatterternary/marker/__init__.py index d137ae66f94..8ce41574539 100644 --- a/plotly/validators/scatterternary/marker/__init__.py +++ b/plotly/validators/scatterternary/marker/__init__.py @@ -1,23 +1,857 @@ -from ._symbolsrc import SymbolsrcValidator -from ._symbol import SymbolValidator -from ._sizesrc import SizesrcValidator -from ._sizeref import SizerefValidator -from ._sizemode import SizemodeValidator -from ._sizemin import SizeminValidator -from ._size import SizeValidator -from ._showscale import ShowscaleValidator -from ._reversescale import ReversescaleValidator -from ._opacitysrc import OpacitysrcValidator -from ._opacity import OpacityValidator -from ._maxdisplayed import MaxdisplayedValidator -from ._line import LineValidator -from ._gradient import GradientValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='symbolsrc', + parent_name='scatterternary.marker', + **kwargs + ): + super(SymbolsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='symbol', + parent_name='scatterternary.marker', + **kwargs + ): + super(SymbolValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, + 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', + 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', + 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', + 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', + 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, + 'star-triangle-down-open', 220, 'star-triangle-down-dot', + 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', + 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, + 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, + 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, + 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scatterternary.marker', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='sizeref', + parent_name='scatterternary.marker', + **kwargs + ): + super(SizerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='sizemode', + parent_name='scatterternary.marker', + **kwargs + ): + super(SizemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['diameter', 'area']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='sizemin', + parent_name='scatterternary.marker', + **kwargs + ): + super(SizeminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterternary.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showscale', + parent_name='scatterternary.marker', + **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scatterternary.marker', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='opacitysrc', + parent_name='scatterternary.marker', + **kwargs + ): + super(OpacitysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scatterternary.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxdisplayedValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxdisplayed', + parent_name='scatterternary.marker', + **kwargs + ): + super(MaxdisplayedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='line', + parent_name='scatterternary.marker', + **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class GradientValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='gradient', + parent_name='scatterternary.marker', + **kwargs + ): + super(GradientValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Gradient'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the final color of the gradient fill: the + center color for radial, the right for + horizontal, or the bottom for vertical. + colorsrc + Sets the source reference on plot.ly for color + . + type + Sets the type of gradient used to fill the + markers + typesrc + Sets the source reference on plot.ly for type + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatterternary.marker', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='scatterternary.marker', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='colorbar', + parent_name='scatterternary.marker', + **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.scatterternary.marker.colorba + r.Tickformatstop instance or dict with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.scatterternary.marker.colorbar.tickformatstop + defaults), sets the default property values to + use for elements of + scatterternary.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.scatterternary.marker.colorba + r.Title instance or dict with compatible + properties + titlefont + Deprecated: Please use + 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. + titleside + Deprecated: Please use + scatterternary.marker.colorbar.title.side + instead. Determines the location of color bar's + title with respect to the color bar. Note that + the title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterternary.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scatterternary.marker.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmin', + parent_name='scatterternary.marker', + **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmid', + parent_name='scatterternary.marker', + **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmax', + parent_name='scatterternary.marker', + **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='cauto', + parent_name='scatterternary.marker', + **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scatterternary.marker', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/marker/_autocolorscale.py b/plotly/validators/scatterternary/marker/_autocolorscale.py deleted file mode 100644 index da3c1618f0d..00000000000 --- a/plotly/validators/scatterternary/marker/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scatterternary.marker', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_cauto.py b/plotly/validators/scatterternary/marker/_cauto.py deleted file mode 100644 index 2e541769d82..00000000000 --- a/plotly/validators/scatterternary/marker/_cauto.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='cauto', - parent_name='scatterternary.marker', - **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_cmax.py b/plotly/validators/scatterternary/marker/_cmax.py deleted file mode 100644 index 0f23f32da39..00000000000 --- a/plotly/validators/scatterternary/marker/_cmax.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmax', - parent_name='scatterternary.marker', - **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_cmid.py b/plotly/validators/scatterternary/marker/_cmid.py deleted file mode 100644 index 79b247a3c6b..00000000000 --- a/plotly/validators/scatterternary/marker/_cmid.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmid', - parent_name='scatterternary.marker', - **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_cmin.py b/plotly/validators/scatterternary/marker/_cmin.py deleted file mode 100644 index e81ad2ae28b..00000000000 --- a/plotly/validators/scatterternary/marker/_cmin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmin', - parent_name='scatterternary.marker', - **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_color.py b/plotly/validators/scatterternary/marker/_color.py deleted file mode 100644 index b5a57a5a666..00000000000 --- a/plotly/validators/scatterternary/marker/_color.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterternary.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scatterternary.marker.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_colorbar.py b/plotly/validators/scatterternary/marker/_colorbar.py deleted file mode 100644 index 0f096fd58db..00000000000 --- a/plotly/validators/scatterternary/marker/_colorbar.py +++ /dev/null @@ -1,232 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='colorbar', - parent_name='scatterternary.marker', - **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.scatterternary.marker.colorba - r.Tickformatstop instance or dict with - compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.scatterternary.marker.colorbar.tickformatstop - defaults), sets the default property values to - use for elements of - scatterternary.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.scatterternary.marker.colorba - r.Title instance or dict with compatible - properties - titlefont - Deprecated: Please use - 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. - titleside - Deprecated: Please use - scatterternary.marker.colorbar.title.side - instead. Determines the location of color bar's - title with respect to the color bar. Note that - the title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_colorscale.py b/plotly/validators/scatterternary/marker/_colorscale.py deleted file mode 100644 index 4c7929744c9..00000000000 --- a/plotly/validators/scatterternary/marker/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='scatterternary.marker', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_colorsrc.py b/plotly/validators/scatterternary/marker/_colorsrc.py deleted file mode 100644 index f9bcb106b3f..00000000000 --- a/plotly/validators/scatterternary/marker/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatterternary.marker', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_gradient.py b/plotly/validators/scatterternary/marker/_gradient.py deleted file mode 100644 index e93a1a7d86a..00000000000 --- a/plotly/validators/scatterternary/marker/_gradient.py +++ /dev/null @@ -1,34 +0,0 @@ -import _plotly_utils.basevalidators - - -class GradientValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='gradient', - parent_name='scatterternary.marker', - **kwargs - ): - super(GradientValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Gradient'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the final color of the gradient fill: the - center color for radial, the right for - horizontal, or the bottom for vertical. - colorsrc - Sets the source reference on plot.ly for color - . - type - Sets the type of gradient used to fill the - markers - typesrc - Sets the source reference on plot.ly for type - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_line.py b/plotly/validators/scatterternary/marker/_line.py deleted file mode 100644 index 11499978c78..00000000000 --- a/plotly/validators/scatterternary/marker/_line.py +++ /dev/null @@ -1,100 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='line', - parent_name='scatterternary.marker', - **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_maxdisplayed.py b/plotly/validators/scatterternary/marker/_maxdisplayed.py deleted file mode 100644 index cc9dc51065a..00000000000 --- a/plotly/validators/scatterternary/marker/_maxdisplayed.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxdisplayedValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxdisplayed', - parent_name='scatterternary.marker', - **kwargs - ): - super(MaxdisplayedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_opacity.py b/plotly/validators/scatterternary/marker/_opacity.py deleted file mode 100644 index 02405230df4..00000000000 --- a/plotly/validators/scatterternary/marker/_opacity.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scatterternary.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_opacitysrc.py b/plotly/validators/scatterternary/marker/_opacitysrc.py deleted file mode 100644 index 0373dfe80c0..00000000000 --- a/plotly/validators/scatterternary/marker/_opacitysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='opacitysrc', - parent_name='scatterternary.marker', - **kwargs - ): - super(OpacitysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_reversescale.py b/plotly/validators/scatterternary/marker/_reversescale.py deleted file mode 100644 index f3c85e89db4..00000000000 --- a/plotly/validators/scatterternary/marker/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scatterternary.marker', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_showscale.py b/plotly/validators/scatterternary/marker/_showscale.py deleted file mode 100644 index e8dc8e2187e..00000000000 --- a/plotly/validators/scatterternary/marker/_showscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showscale', - parent_name='scatterternary.marker', - **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_size.py b/plotly/validators/scatterternary/marker/_size.py deleted file mode 100644 index 759fe373748..00000000000 --- a/plotly/validators/scatterternary/marker/_size.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterternary.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_sizemin.py b/plotly/validators/scatterternary/marker/_sizemin.py deleted file mode 100644 index 6be6b8c9746..00000000000 --- a/plotly/validators/scatterternary/marker/_sizemin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='sizemin', - parent_name='scatterternary.marker', - **kwargs - ): - super(SizeminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_sizemode.py b/plotly/validators/scatterternary/marker/_sizemode.py deleted file mode 100644 index 86d2cc4f098..00000000000 --- a/plotly/validators/scatterternary/marker/_sizemode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='sizemode', - parent_name='scatterternary.marker', - **kwargs - ): - super(SizemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['diameter', 'area']), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_sizeref.py b/plotly/validators/scatterternary/marker/_sizeref.py deleted file mode 100644 index e83624be519..00000000000 --- a/plotly/validators/scatterternary/marker/_sizeref.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='sizeref', - parent_name='scatterternary.marker', - **kwargs - ): - super(SizerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_sizesrc.py b/plotly/validators/scatterternary/marker/_sizesrc.py deleted file mode 100644 index a038d9359ce..00000000000 --- a/plotly/validators/scatterternary/marker/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scatterternary.marker', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_symbol.py b/plotly/validators/scatterternary/marker/_symbol.py deleted file mode 100644 index 24b575e86a6..00000000000 --- a/plotly/validators/scatterternary/marker/_symbol.py +++ /dev/null @@ -1,81 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='symbol', - parent_name='scatterternary.marker', - **kwargs - ): - super(SymbolValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, - 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', - 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', - 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', - 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', - 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, - 'star-triangle-down-open', 220, 'star-triangle-down-dot', - 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', - 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, - 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, - 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, - 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' - ] - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/_symbolsrc.py b/plotly/validators/scatterternary/marker/_symbolsrc.py deleted file mode 100644 index f05582a3d05..00000000000 --- a/plotly/validators/scatterternary/marker/_symbolsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='symbolsrc', - parent_name='scatterternary.marker', - **kwargs - ): - super(SymbolsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/__init__.py b/plotly/validators/scatterternary/marker/colorbar/__init__.py index 3dab31f7e02..d651e1f47d6 100644 --- a/plotly/validators/scatterternary/marker/colorbar/__init__.py +++ b/plotly/validators/scatterternary/marker/colorbar/__init__.py @@ -1,41 +1,936 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ypad', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='y', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xpad', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='x', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='len', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='scatterternary.marker.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_bgcolor.py b/plotly/validators/scatterternary/marker/colorbar/_bgcolor.py deleted file mode 100644 index 684970d87e4..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_bordercolor.py b/plotly/validators/scatterternary/marker/colorbar/_bordercolor.py deleted file mode 100644 index c6d3357eac3..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_borderwidth.py b/plotly/validators/scatterternary/marker/colorbar/_borderwidth.py deleted file mode 100644 index d709bdd778a..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_dtick.py b/plotly/validators/scatterternary/marker/colorbar/_dtick.py deleted file mode 100644 index fdf6366e475..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_exponentformat.py b/plotly/validators/scatterternary/marker/colorbar/_exponentformat.py deleted file mode 100644 index 955ee2468ce..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_len.py b/plotly/validators/scatterternary/marker/colorbar/_len.py deleted file mode 100644 index c18947e467b..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_len.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='len', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_lenmode.py b/plotly/validators/scatterternary/marker/colorbar/_lenmode.py deleted file mode 100644 index 0235fd783bc..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_nticks.py b/plotly/validators/scatterternary/marker/colorbar/_nticks.py deleted file mode 100644 index 5bf5f93a205..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_outlinecolor.py b/plotly/validators/scatterternary/marker/colorbar/_outlinecolor.py deleted file mode 100644 index 0adade91e4e..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_outlinewidth.py b/plotly/validators/scatterternary/marker/colorbar/_outlinewidth.py deleted file mode 100644 index c3c62f42054..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_separatethousands.py b/plotly/validators/scatterternary/marker/colorbar/_separatethousands.py deleted file mode 100644 index 232fd4e9c3d..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_showexponent.py b/plotly/validators/scatterternary/marker/colorbar/_showexponent.py deleted file mode 100644 index 0a6a9219930..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_showticklabels.py b/plotly/validators/scatterternary/marker/colorbar/_showticklabels.py deleted file mode 100644 index 7f8857ea824..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_showtickprefix.py b/plotly/validators/scatterternary/marker/colorbar/_showtickprefix.py deleted file mode 100644 index 002902c7541..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_showticksuffix.py b/plotly/validators/scatterternary/marker/colorbar/_showticksuffix.py deleted file mode 100644 index 638af440cc5..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_thickness.py b/plotly/validators/scatterternary/marker/colorbar/_thickness.py deleted file mode 100644 index b5eecfd2f6f..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_thicknessmode.py b/plotly/validators/scatterternary/marker/colorbar/_thicknessmode.py deleted file mode 100644 index 2a5ee537f2d..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_tick0.py b/plotly/validators/scatterternary/marker/colorbar/_tick0.py deleted file mode 100644 index d6a500717e3..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_tickangle.py b/plotly/validators/scatterternary/marker/colorbar/_tickangle.py deleted file mode 100644 index 330ba605f2c..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_tickcolor.py b/plotly/validators/scatterternary/marker/colorbar/_tickcolor.py deleted file mode 100644 index 67fb1e2a518..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_tickfont.py b/plotly/validators/scatterternary/marker/colorbar/_tickfont.py deleted file mode 100644 index 18c72f4f5e7..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_tickformat.py b/plotly/validators/scatterternary/marker/colorbar/_tickformat.py deleted file mode 100644 index f28fb5d2f7b..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_tickformatstopdefaults.py b/plotly/validators/scatterternary/marker/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 3e98505da41..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_tickformatstops.py b/plotly/validators/scatterternary/marker/colorbar/_tickformatstops.py deleted file mode 100644 index 013233f2476..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_ticklen.py b/plotly/validators/scatterternary/marker/colorbar/_ticklen.py deleted file mode 100644 index c9b53437038..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_tickmode.py b/plotly/validators/scatterternary/marker/colorbar/_tickmode.py deleted file mode 100644 index 6d7c318e88c..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_tickprefix.py b/plotly/validators/scatterternary/marker/colorbar/_tickprefix.py deleted file mode 100644 index 62cb05024d0..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_ticks.py b/plotly/validators/scatterternary/marker/colorbar/_ticks.py deleted file mode 100644 index cbf389d985d..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_ticksuffix.py b/plotly/validators/scatterternary/marker/colorbar/_ticksuffix.py deleted file mode 100644 index 6f96fc75636..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_ticktext.py b/plotly/validators/scatterternary/marker/colorbar/_ticktext.py deleted file mode 100644 index 5f4cbedb84c..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_ticktextsrc.py b/plotly/validators/scatterternary/marker/colorbar/_ticktextsrc.py deleted file mode 100644 index e7416a1ad95..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_tickvals.py b/plotly/validators/scatterternary/marker/colorbar/_tickvals.py deleted file mode 100644 index cf3061e5938..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_tickvalssrc.py b/plotly/validators/scatterternary/marker/colorbar/_tickvalssrc.py deleted file mode 100644 index 86994c2a535..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_tickwidth.py b/plotly/validators/scatterternary/marker/colorbar/_tickwidth.py deleted file mode 100644 index 4056d1898c4..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_title.py b/plotly/validators/scatterternary/marker/colorbar/_title.py deleted file mode 100644 index 6b7b41c68b5..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_x.py b/plotly/validators/scatterternary/marker/colorbar/_x.py deleted file mode 100644 index 2f67092d43c..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_x.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='x', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_xanchor.py b/plotly/validators/scatterternary/marker/colorbar/_xanchor.py deleted file mode 100644 index 093094b2cd2..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_xpad.py b/plotly/validators/scatterternary/marker/colorbar/_xpad.py deleted file mode 100644 index 868163f1dc2..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_xpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xpad', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_y.py b/plotly/validators/scatterternary/marker/colorbar/_y.py deleted file mode 100644 index 6ee9389f4af..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_y.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='y', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_yanchor.py b/plotly/validators/scatterternary/marker/colorbar/_yanchor.py deleted file mode 100644 index 4096ac02989..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/_ypad.py b/plotly/validators/scatterternary/marker/colorbar/_ypad.py deleted file mode 100644 index 650c926e1e2..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/_ypad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ypad', - parent_name='scatterternary.marker.colorbar', - **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/tickfont/__init__.py b/plotly/validators/scatterternary/marker/colorbar/tickfont/__init__.py index 199d72e71c6..be7d7fa2e02 100644 --- a/plotly/validators/scatterternary/marker/colorbar/tickfont/__init__.py +++ b/plotly/validators/scatterternary/marker/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterternary.marker.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatterternary.marker.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterternary.marker.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/marker/colorbar/tickfont/_color.py b/plotly/validators/scatterternary/marker/colorbar/tickfont/_color.py deleted file mode 100644 index 5c9193f6a98..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterternary.marker.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/tickfont/_family.py b/plotly/validators/scatterternary/marker/colorbar/tickfont/_family.py deleted file mode 100644 index 6cf58eebe5d..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatterternary.marker.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/tickfont/_size.py b/plotly/validators/scatterternary/marker/colorbar/tickfont/_size.py deleted file mode 100644 index 83849b3f902..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterternary.marker.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/tickformatstop/__init__.py b/plotly/validators/scatterternary/marker/colorbar/tickformatstop/__init__.py index 3f6c06cac47..08555b5c1c4 100644 --- a/plotly/validators/scatterternary/marker/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/scatterternary/marker/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='scatterternary.marker.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='scatterternary.marker.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='scatterternary.marker.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='scatterternary.marker.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='scatterternary.marker.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/marker/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/scatterternary/marker/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 574562f1e31..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='scatterternary.marker.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/tickformatstop/_enabled.py b/plotly/validators/scatterternary/marker/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index 3b0d91d5802..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='scatterternary.marker.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/tickformatstop/_name.py b/plotly/validators/scatterternary/marker/colorbar/tickformatstop/_name.py deleted file mode 100644 index 3ca555720e0..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='scatterternary.marker.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/scatterternary/marker/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 8acecf55251..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='scatterternary.marker.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/tickformatstop/_value.py b/plotly/validators/scatterternary/marker/colorbar/tickformatstop/_value.py deleted file mode 100644 index 75a42e32885..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='scatterternary.marker.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/title/__init__.py b/plotly/validators/scatterternary/marker/colorbar/title/__init__.py index 33c9c145bb8..a812a4d42a3 100644 --- a/plotly/validators/scatterternary/marker/colorbar/title/__init__.py +++ b/plotly/validators/scatterternary/marker/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='scatterternary.marker.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='scatterternary.marker.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='scatterternary.marker.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/scatterternary/marker/colorbar/title/_font.py b/plotly/validators/scatterternary/marker/colorbar/title/_font.py deleted file mode 100644 index 157f43b94cf..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='scatterternary.marker.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/title/_side.py b/plotly/validators/scatterternary/marker/colorbar/title/_side.py deleted file mode 100644 index 79d1e6ef0ff..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='scatterternary.marker.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/title/_text.py b/plotly/validators/scatterternary/marker/colorbar/title/_text.py deleted file mode 100644 index 7f5115083b6..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='scatterternary.marker.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/title/font/__init__.py b/plotly/validators/scatterternary/marker/colorbar/title/font/__init__.py index 199d72e71c6..5ddd0988596 100644 --- a/plotly/validators/scatterternary/marker/colorbar/title/font/__init__.py +++ b/plotly/validators/scatterternary/marker/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterternary.marker.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatterternary.marker.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterternary.marker.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/marker/colorbar/title/font/_color.py b/plotly/validators/scatterternary/marker/colorbar/title/font/_color.py deleted file mode 100644 index b4823a2eab4..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterternary.marker.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/title/font/_family.py b/plotly/validators/scatterternary/marker/colorbar/title/font/_family.py deleted file mode 100644 index 5fd3b9480dd..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatterternary.marker.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/colorbar/title/font/_size.py b/plotly/validators/scatterternary/marker/colorbar/title/font/_size.py deleted file mode 100644 index 8b5069e95aa..00000000000 --- a/plotly/validators/scatterternary/marker/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterternary.marker.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/gradient/__init__.py b/plotly/validators/scatterternary/marker/gradient/__init__.py index 434557c8fea..b9d5423cc3c 100644 --- a/plotly/validators/scatterternary/marker/gradient/__init__.py +++ b/plotly/validators/scatterternary/marker/gradient/__init__.py @@ -1,4 +1,85 @@ -from ._typesrc import TypesrcValidator -from ._type import TypeValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class TypesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='typesrc', + parent_name='scatterternary.marker.gradient', + **kwargs + ): + super(TypesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='type', + parent_name='scatterternary.marker.gradient', + **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['radial', 'horizontal', 'vertical', 'none'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatterternary.marker.gradient', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterternary.marker.gradient', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/marker/gradient/_color.py b/plotly/validators/scatterternary/marker/gradient/_color.py deleted file mode 100644 index 6d6a36387fd..00000000000 --- a/plotly/validators/scatterternary/marker/gradient/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterternary.marker.gradient', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/gradient/_colorsrc.py b/plotly/validators/scatterternary/marker/gradient/_colorsrc.py deleted file mode 100644 index 90950c52c2d..00000000000 --- a/plotly/validators/scatterternary/marker/gradient/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatterternary.marker.gradient', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/gradient/_type.py b/plotly/validators/scatterternary/marker/gradient/_type.py deleted file mode 100644 index 5be07bca3c2..00000000000 --- a/plotly/validators/scatterternary/marker/gradient/_type.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='type', - parent_name='scatterternary.marker.gradient', - **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['radial', 'horizontal', 'vertical', 'none'] - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/gradient/_typesrc.py b/plotly/validators/scatterternary/marker/gradient/_typesrc.py deleted file mode 100644 index c936bbffcf0..00000000000 --- a/plotly/validators/scatterternary/marker/gradient/_typesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='typesrc', - parent_name='scatterternary.marker.gradient', - **kwargs - ): - super(TypesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/line/__init__.py b/plotly/validators/scatterternary/marker/line/__init__.py index c031ca61ce2..401e7aaf64c 100644 --- a/plotly/validators/scatterternary/marker/line/__init__.py +++ b/plotly/validators/scatterternary/marker/line/__init__.py @@ -1,11 +1,235 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._reversescale import ReversescaleValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='widthsrc', + parent_name='scatterternary.marker.line', + **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='width', + parent_name='scatterternary.marker.line', + **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='scatterternary.marker.line', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatterternary.marker.line', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='scatterternary.marker.line', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterternary.marker.line', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'scatterternary.marker.line.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmin', + parent_name='scatterternary.marker.line', + **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmid', + parent_name='scatterternary.marker.line', + **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='cmax', + parent_name='scatterternary.marker.line', + **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='cauto', + parent_name='scatterternary.marker.line', + **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='scatterternary.marker.line', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/marker/line/_autocolorscale.py b/plotly/validators/scatterternary/marker/line/_autocolorscale.py deleted file mode 100644 index 204a3182b48..00000000000 --- a/plotly/validators/scatterternary/marker/line/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='scatterternary.marker.line', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/line/_cauto.py b/plotly/validators/scatterternary/marker/line/_cauto.py deleted file mode 100644 index ac54773e45a..00000000000 --- a/plotly/validators/scatterternary/marker/line/_cauto.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='cauto', - parent_name='scatterternary.marker.line', - **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/line/_cmax.py b/plotly/validators/scatterternary/marker/line/_cmax.py deleted file mode 100644 index 183a9391a05..00000000000 --- a/plotly/validators/scatterternary/marker/line/_cmax.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmax', - parent_name='scatterternary.marker.line', - **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/line/_cmid.py b/plotly/validators/scatterternary/marker/line/_cmid.py deleted file mode 100644 index 02043bd82da..00000000000 --- a/plotly/validators/scatterternary/marker/line/_cmid.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmid', - parent_name='scatterternary.marker.line', - **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/line/_cmin.py b/plotly/validators/scatterternary/marker/line/_cmin.py deleted file mode 100644 index 71ba508fa80..00000000000 --- a/plotly/validators/scatterternary/marker/line/_cmin.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='cmin', - parent_name='scatterternary.marker.line', - **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/line/_color.py b/plotly/validators/scatterternary/marker/line/_color.py deleted file mode 100644 index 566dc82b35e..00000000000 --- a/plotly/validators/scatterternary/marker/line/_color.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterternary.marker.line', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'scatterternary.marker.line.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/line/_colorscale.py b/plotly/validators/scatterternary/marker/line/_colorscale.py deleted file mode 100644 index c2271cdf418..00000000000 --- a/plotly/validators/scatterternary/marker/line/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='scatterternary.marker.line', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/line/_colorsrc.py b/plotly/validators/scatterternary/marker/line/_colorsrc.py deleted file mode 100644 index 47be0644831..00000000000 --- a/plotly/validators/scatterternary/marker/line/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatterternary.marker.line', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/line/_reversescale.py b/plotly/validators/scatterternary/marker/line/_reversescale.py deleted file mode 100644 index 185bba20e8c..00000000000 --- a/plotly/validators/scatterternary/marker/line/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='scatterternary.marker.line', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/line/_width.py b/plotly/validators/scatterternary/marker/line/_width.py deleted file mode 100644 index 69ab8821167..00000000000 --- a/plotly/validators/scatterternary/marker/line/_width.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='width', - parent_name='scatterternary.marker.line', - **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/marker/line/_widthsrc.py b/plotly/validators/scatterternary/marker/line/_widthsrc.py deleted file mode 100644 index 5bf2e1aedd7..00000000000 --- a/plotly/validators/scatterternary/marker/line/_widthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='widthsrc', - parent_name='scatterternary.marker.line', - **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/selected/__init__.py b/plotly/validators/scatterternary/selected/__init__.py index f1a1ef3742f..60d394d6ef2 100644 --- a/plotly/validators/scatterternary/selected/__init__.py +++ b/plotly/validators/scatterternary/selected/__init__.py @@ -1,2 +1,54 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='scatterternary.selected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of selected points. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='scatterternary.selected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scatterternary/selected/_marker.py b/plotly/validators/scatterternary/selected/_marker.py deleted file mode 100644 index fd5713d8110..00000000000 --- a/plotly/validators/scatterternary/selected/_marker.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='scatterternary.selected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/selected/_textfont.py b/plotly/validators/scatterternary/selected/_textfont.py deleted file mode 100644 index 1f5839c7735..00000000000 --- a/plotly/validators/scatterternary/selected/_textfont.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='scatterternary.selected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/selected/marker/__init__.py b/plotly/validators/scatterternary/selected/marker/__init__.py index ed9a9070947..2bcc0af6632 100644 --- a/plotly/validators/scatterternary/selected/marker/__init__.py +++ b/plotly/validators/scatterternary/selected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterternary.selected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scatterternary.selected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterternary.selected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/selected/marker/_color.py b/plotly/validators/scatterternary/selected/marker/_color.py deleted file mode 100644 index a7f80e18538..00000000000 --- a/plotly/validators/scatterternary/selected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterternary.selected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/selected/marker/_opacity.py b/plotly/validators/scatterternary/selected/marker/_opacity.py deleted file mode 100644 index e7ba4123716..00000000000 --- a/plotly/validators/scatterternary/selected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scatterternary.selected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/selected/marker/_size.py b/plotly/validators/scatterternary/selected/marker/_size.py deleted file mode 100644 index 8f9f2e7fe0f..00000000000 --- a/plotly/validators/scatterternary/selected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterternary.selected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/selected/textfont/__init__.py b/plotly/validators/scatterternary/selected/textfont/__init__.py index 74135b3f315..51ce146c57c 100644 --- a/plotly/validators/scatterternary/selected/textfont/__init__.py +++ b/plotly/validators/scatterternary/selected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterternary.selected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/selected/textfont/_color.py b/plotly/validators/scatterternary/selected/textfont/_color.py deleted file mode 100644 index 4f0a5b41c18..00000000000 --- a/plotly/validators/scatterternary/selected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterternary.selected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/stream/__init__.py b/plotly/validators/scatterternary/stream/__init__.py index 2f4f2047594..3eab8bf323a 100644 --- a/plotly/validators/scatterternary/stream/__init__.py +++ b/plotly/validators/scatterternary/stream/__init__.py @@ -1,2 +1,44 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='token', + parent_name='scatterternary.stream', + **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='scatterternary.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/stream/_maxpoints.py b/plotly/validators/scatterternary/stream/_maxpoints.py deleted file mode 100644 index e89b6c47546..00000000000 --- a/plotly/validators/scatterternary/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='scatterternary.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/stream/_token.py b/plotly/validators/scatterternary/stream/_token.py deleted file mode 100644 index ae35f3314b1..00000000000 --- a/plotly/validators/scatterternary/stream/_token.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='token', - parent_name='scatterternary.stream', - **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatterternary/textfont/__init__.py b/plotly/validators/scatterternary/textfont/__init__.py index 1d2c591d1e5..fd870ec4e37 100644 --- a/plotly/validators/scatterternary/textfont/__init__.py +++ b/plotly/validators/scatterternary/textfont/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='scatterternary.textfont', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterternary.textfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='scatterternary.textfont', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='scatterternary.textfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='scatterternary.textfont', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterternary.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/textfont/_color.py b/plotly/validators/scatterternary/textfont/_color.py deleted file mode 100644 index 877be556489..00000000000 --- a/plotly/validators/scatterternary/textfont/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterternary.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/textfont/_colorsrc.py b/plotly/validators/scatterternary/textfont/_colorsrc.py deleted file mode 100644 index 9c572fc3300..00000000000 --- a/plotly/validators/scatterternary/textfont/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='scatterternary.textfont', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/textfont/_family.py b/plotly/validators/scatterternary/textfont/_family.py deleted file mode 100644 index da49e1ed49e..00000000000 --- a/plotly/validators/scatterternary/textfont/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='scatterternary.textfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/scatterternary/textfont/_familysrc.py b/plotly/validators/scatterternary/textfont/_familysrc.py deleted file mode 100644 index 8f9ac27e678..00000000000 --- a/plotly/validators/scatterternary/textfont/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='scatterternary.textfont', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/textfont/_size.py b/plotly/validators/scatterternary/textfont/_size.py deleted file mode 100644 index ceb51add5fb..00000000000 --- a/plotly/validators/scatterternary/textfont/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterternary.textfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/textfont/_sizesrc.py b/plotly/validators/scatterternary/textfont/_sizesrc.py deleted file mode 100644 index 09e56e18e71..00000000000 --- a/plotly/validators/scatterternary/textfont/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='scatterternary.textfont', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/unselected/__init__.py b/plotly/validators/scatterternary/unselected/__init__.py index f1a1ef3742f..0194d86b41d 100644 --- a/plotly/validators/scatterternary/unselected/__init__.py +++ b/plotly/validators/scatterternary/unselected/__init__.py @@ -1,2 +1,58 @@ -from ._textfont import TextfontValidator -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='textfont', + parent_name='scatterternary.unselected', + **kwargs + ): + super(TextfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Textfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the text font color of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='marker', + parent_name='scatterternary.unselected', + **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of unselected points, + applied only when a selection exists. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) diff --git a/plotly/validators/scatterternary/unselected/_marker.py b/plotly/validators/scatterternary/unselected/_marker.py deleted file mode 100644 index 303f28f2c0f..00000000000 --- a/plotly/validators/scatterternary/unselected/_marker.py +++ /dev/null @@ -1,30 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='marker', - parent_name='scatterternary.unselected', - **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of unselected points, - applied only when a selection exists. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/unselected/_textfont.py b/plotly/validators/scatterternary/unselected/_textfont.py deleted file mode 100644 index dbd39bdcc4e..00000000000 --- a/plotly/validators/scatterternary/unselected/_textfont.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='textfont', - parent_name='scatterternary.unselected', - **kwargs - ): - super(TextfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Textfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the text font color of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/scatterternary/unselected/marker/__init__.py b/plotly/validators/scatterternary/unselected/marker/__init__.py index ed9a9070947..70fbadda75b 100644 --- a/plotly/validators/scatterternary/unselected/marker/__init__.py +++ b/plotly/validators/scatterternary/unselected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='scatterternary.unselected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='scatterternary.unselected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterternary.unselected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/unselected/marker/_color.py b/plotly/validators/scatterternary/unselected/marker/_color.py deleted file mode 100644 index af8dfe423ad..00000000000 --- a/plotly/validators/scatterternary/unselected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterternary.unselected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/unselected/marker/_opacity.py b/plotly/validators/scatterternary/unselected/marker/_opacity.py deleted file mode 100644 index 628bd4cf154..00000000000 --- a/plotly/validators/scatterternary/unselected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='scatterternary.unselected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/unselected/marker/_size.py b/plotly/validators/scatterternary/unselected/marker/_size.py deleted file mode 100644 index 51e0283f17d..00000000000 --- a/plotly/validators/scatterternary/unselected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='scatterternary.unselected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/scatterternary/unselected/textfont/__init__.py b/plotly/validators/scatterternary/unselected/textfont/__init__.py index 74135b3f315..715b1a0207b 100644 --- a/plotly/validators/scatterternary/unselected/textfont/__init__.py +++ b/plotly/validators/scatterternary/unselected/textfont/__init__.py @@ -1 +1,20 @@ -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='scatterternary.unselected.textfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/scatterternary/unselected/textfont/_color.py b/plotly/validators/scatterternary/unselected/textfont/_color.py deleted file mode 100644 index 2a027f6af3e..00000000000 --- a/plotly/validators/scatterternary/unselected/textfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='scatterternary.unselected.textfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/__init__.py b/plotly/validators/splom/__init__.py index c105ffdcc60..c981fd1e31e 100644 --- a/plotly/validators/splom/__init__.py +++ b/plotly/validators/splom/__init__.py @@ -1,32 +1,755 @@ -from ._yaxes import YaxesValidator -from ._xaxes import XaxesValidator -from ._visible import VisibleValidator -from ._unselected import UnselectedValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._showupperhalf import ShowupperhalfValidator -from ._showlowerhalf import ShowlowerhalfValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._selected import SelectedValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._marker import MarkerValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._dimensiondefaults import DimensionValidator -from ._dimensions import DimensionsValidator -from ._diagonal import DiagonalValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator + + +import _plotly_utils.basevalidators + + +class YaxesValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__(self, plotly_name='yaxes', parent_name='splom', **kwargs): + super(YaxesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + free_length=kwargs.pop('free_length', True), + items=kwargs.pop( + 'items', { + 'valType': 'subplotid', + 'regex': '/^y([2-9]|[1-9][0-9]+)?$/', + 'editType': 'plot' + } + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XaxesValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__(self, plotly_name='xaxes', parent_name='splom', **kwargs): + super(XaxesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + free_length=kwargs.pop('free_length', True), + items=kwargs.pop( + 'items', { + 'valType': 'subplotid', + 'regex': '/^x([2-9]|[1-9][0-9]+)?$/', + 'editType': 'plot' + } + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='splom', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='unselected', parent_name='splom', **kwargs + ): + super(UnselectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Unselected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.splom.unselected.Marker + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='splom', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='splom', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='textsrc', parent_name='splom', **kwargs): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='splom', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='splom', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowupperhalfValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showupperhalf', parent_name='splom', **kwargs + ): + super(ShowupperhalfValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlowerhalfValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlowerhalf', parent_name='splom', **kwargs + ): + super(ShowlowerhalfValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='splom', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='splom', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='selected', parent_name='splom', **kwargs): + super(SelectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Selected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.splom.selected.Marker + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='opacity', parent_name='splom', **kwargs): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='splom', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='marker', parent_name='splom', **kwargs): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.colorscale`. Has an + effect only if in `marker.color`is set to a + numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.color`) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color`is set to a numerical + array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by + scaling `marker.cmin` and/or `marker.cmax` to + be equidistant to this point. Has an effect + only if in `marker.color`is set to a numerical + array. Value should have the same units as in + `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has + an effect only if in `marker.color`is set to a + numerical array. Value should have the same + units as in `marker.color` and if set, + `marker.cmax` must be set as well. + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + colorbar + plotly.graph_objs.splom.marker.ColorBar + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color`is set to a numerical array. The + colorscale must be an array containing arrays + mapping a normalized value to an rgb, rgba, + hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.cmin` and `marker.cmax`. + Alternatively, `colorscale` may be a palette + name string of the following list: Greys,YlGnBu + ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R + ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri + c,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + line + plotly.graph_objs.splom.marker.Line instance or + dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on plot.ly for + opacity . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.color`is set to a + numerical array. If true, `marker.cmin` will + correspond to the last color in the array and + `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is + displayed for this trace. Has an effect only if + in `marker.color`is set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) + of the rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the + data in `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. + Use with `sizemin` and `sizemode`. + sizesrc + Sets the source reference on plot.ly for size + . + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on plot.ly for + symbol . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='splom', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='splom', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='splom', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='splom', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='hovertext', parent_name='splom', **kwargs): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertemplatesrc', parent_name='splom', **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='splom', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='splom', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='splom', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__(self, plotly_name='hoverinfo', parent_name='splom', **kwargs): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DimensionValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='dimensiondefaults', parent_name='splom', **kwargs + ): + super(DimensionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Dimension'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DimensionsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): + + def __init__( + self, plotly_name='dimensions', parent_name='splom', **kwargs + ): + super(DimensionsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Dimension'), + data_docs=kwargs.pop( + 'data_docs', """ + axis + plotly.graph_objs.splom.dimension.Axis instance + or dict with compatible properties + label + Sets the label corresponding to this splom + dimension. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + values + Sets the dimension values to be plotted. + valuessrc + Sets the source reference on plot.ly for + values . + visible + Determines whether or not this dimension is + shown on the graph. Note that even visible + false dimension contribute to the default grid + generate by this splom trace. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DiagonalValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='diagonal', parent_name='splom', **kwargs): + super(DiagonalValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Diagonal'), + data_docs=kwargs.pop( + 'data_docs', """ + visible + Determines whether or not subplots on the + diagonal are displayed. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='splom', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='splom', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/splom/_customdata.py b/plotly/validators/splom/_customdata.py deleted file mode 100644 index 4cf6c28a0eb..00000000000 --- a/plotly/validators/splom/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='splom', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/splom/_customdatasrc.py b/plotly/validators/splom/_customdatasrc.py deleted file mode 100644 index 3509318f0a5..00000000000 --- a/plotly/validators/splom/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='splom', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_diagonal.py b/plotly/validators/splom/_diagonal.py deleted file mode 100644 index 24a0dfba00c..00000000000 --- a/plotly/validators/splom/_diagonal.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DiagonalValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='diagonal', parent_name='splom', **kwargs): - super(DiagonalValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Diagonal'), - data_docs=kwargs.pop( - 'data_docs', """ - visible - Determines whether or not subplots on the - diagonal are displayed. -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/_dimensiondefaults.py b/plotly/validators/splom/_dimensiondefaults.py deleted file mode 100644 index 25d9852c8aa..00000000000 --- a/plotly/validators/splom/_dimensiondefaults.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DimensionValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='dimensiondefaults', parent_name='splom', **kwargs - ): - super(DimensionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Dimension'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/splom/_dimensions.py b/plotly/validators/splom/_dimensions.py deleted file mode 100644 index 16a05f09441..00000000000 --- a/plotly/validators/splom/_dimensions.py +++ /dev/null @@ -1,55 +0,0 @@ -import _plotly_utils.basevalidators - - -class DimensionsValidator(_plotly_utils.basevalidators.CompoundArrayValidator): - - def __init__( - self, plotly_name='dimensions', parent_name='splom', **kwargs - ): - super(DimensionsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Dimension'), - data_docs=kwargs.pop( - 'data_docs', """ - axis - plotly.graph_objs.splom.dimension.Axis instance - or dict with compatible properties - label - Sets the label corresponding to this splom - dimension. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - values - Sets the dimension values to be plotted. - valuessrc - Sets the source reference on plot.ly for - values . - visible - Determines whether or not this dimension is - shown on the graph. Note that even visible - false dimension contribute to the default grid - generate by this splom trace. -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/_hoverinfo.py b/plotly/validators/splom/_hoverinfo.py deleted file mode 100644 index 2bf07cabd6d..00000000000 --- a/plotly/validators/splom/_hoverinfo.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__(self, plotly_name='hoverinfo', parent_name='splom', **kwargs): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_hoverinfosrc.py b/plotly/validators/splom/_hoverinfosrc.py deleted file mode 100644 index e15388b046f..00000000000 --- a/plotly/validators/splom/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='splom', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_hoverlabel.py b/plotly/validators/splom/_hoverlabel.py deleted file mode 100644 index 8505e008383..00000000000 --- a/plotly/validators/splom/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='splom', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/_hovertemplate.py b/plotly/validators/splom/_hovertemplate.py deleted file mode 100644 index cffdf365c96..00000000000 --- a/plotly/validators/splom/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='splom', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_hovertemplatesrc.py b/plotly/validators/splom/_hovertemplatesrc.py deleted file mode 100644 index 9472797135d..00000000000 --- a/plotly/validators/splom/_hovertemplatesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertemplatesrc', parent_name='splom', **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_hovertext.py b/plotly/validators/splom/_hovertext.py deleted file mode 100644 index 3ca6c4b8ad1..00000000000 --- a/plotly/validators/splom/_hovertext.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='hovertext', parent_name='splom', **kwargs): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_hovertextsrc.py b/plotly/validators/splom/_hovertextsrc.py deleted file mode 100644 index 6d84fb83182..00000000000 --- a/plotly/validators/splom/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='splom', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_ids.py b/plotly/validators/splom/_ids.py deleted file mode 100644 index 5a9c1b58e9c..00000000000 --- a/plotly/validators/splom/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='splom', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/splom/_idssrc.py b/plotly/validators/splom/_idssrc.py deleted file mode 100644 index 8d3e567f7fe..00000000000 --- a/plotly/validators/splom/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='splom', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_legendgroup.py b/plotly/validators/splom/_legendgroup.py deleted file mode 100644 index 92a7d4f46b9..00000000000 --- a/plotly/validators/splom/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='splom', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_marker.py b/plotly/validators/splom/_marker.py deleted file mode 100644 index 73a10d8d392..00000000000 --- a/plotly/validators/splom/_marker.py +++ /dev/null @@ -1,129 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='marker', parent_name='splom', **kwargs): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.colorscale`. Has an - effect only if in `marker.color`is set to a - numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.color`) or the bounds set in - `marker.cmin` and `marker.cmax` Has an effect - only if in `marker.color`is set to a numerical - array. Defaults to `false` when `marker.cmin` - and `marker.cmax` are set by the user. - cmax - Sets the upper bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmin` must be set as well. - cmid - Sets the mid-point of the color domain by - scaling `marker.cmin` and/or `marker.cmax` to - be equidistant to this point. Has an effect - only if in `marker.color`is set to a numerical - array. Value should have the same units as in - `marker.color`. Has no effect when - `marker.cauto` is `false`. - cmin - Sets the lower bound of the color domain. Has - an effect only if in `marker.color`is set to a - numerical array. Value should have the same - units as in `marker.color` and if set, - `marker.cmax` must be set as well. - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - colorbar - plotly.graph_objs.splom.marker.ColorBar - instance or dict with compatible properties - colorscale - Sets the colorscale. Has an effect only if in - `marker.color`is set to a numerical array. The - colorscale must be an array containing arrays - mapping a normalized value to an rgb, rgba, - hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.cmin` and `marker.cmax`. - Alternatively, `colorscale` may be a palette - name string of the following list: Greys,YlGnBu - ,Greens,YlOrRd,Bluered,RdBu,Reds,Blues,Picnic,R - ainbow,Portland,Jet,Hot,Blackbody,Earth,Electri - c,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - line - plotly.graph_objs.splom.marker.Line instance or - dict with compatible properties - opacity - Sets the marker opacity. - opacitysrc - Sets the source reference on plot.ly for - opacity . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.color`is set to a - numerical array. If true, `marker.cmin` will - correspond to the last color in the array and - `marker.cmax` will correspond to the first - color. - showscale - Determines whether or not a colorbar is - displayed for this trace. Has an effect only if - in `marker.color`is set to a numerical array. - size - Sets the marker size (in px). - sizemin - Has an effect only if `marker.size` is set to a - numerical array. Sets the minimum size (in px) - of the rendered marker points. - sizemode - Has an effect only if `marker.size` is set to a - numerical array. Sets the rule for which the - data in `size` is converted to pixels. - sizeref - Has an effect only if `marker.size` is set to a - numerical array. Sets the scale factor used to - determine the rendered size of marker points. - Use with `sizemin` and `sizemode`. - sizesrc - Sets the source reference on plot.ly for size - . - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. - symbolsrc - Sets the source reference on plot.ly for - symbol . -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/_name.py b/plotly/validators/splom/_name.py deleted file mode 100644 index 42891a34d3a..00000000000 --- a/plotly/validators/splom/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='splom', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_opacity.py b/plotly/validators/splom/_opacity.py deleted file mode 100644 index 761c724ddf8..00000000000 --- a/plotly/validators/splom/_opacity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='opacity', parent_name='splom', **kwargs): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/_selected.py b/plotly/validators/splom/_selected.py deleted file mode 100644 index dad5bdceaf6..00000000000 --- a/plotly/validators/splom/_selected.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='selected', parent_name='splom', **kwargs): - super(SelectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Selected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.splom.selected.Marker - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/_selectedpoints.py b/plotly/validators/splom/_selectedpoints.py deleted file mode 100644 index 779adb9543f..00000000000 --- a/plotly/validators/splom/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='splom', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_showlegend.py b/plotly/validators/splom/_showlegend.py deleted file mode 100644 index 0bbc20ac80f..00000000000 --- a/plotly/validators/splom/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='splom', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_showlowerhalf.py b/plotly/validators/splom/_showlowerhalf.py deleted file mode 100644 index 1ca9803db76..00000000000 --- a/plotly/validators/splom/_showlowerhalf.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlowerhalfValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlowerhalf', parent_name='splom', **kwargs - ): - super(ShowlowerhalfValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_showupperhalf.py b/plotly/validators/splom/_showupperhalf.py deleted file mode 100644 index 4141b16c541..00000000000 --- a/plotly/validators/splom/_showupperhalf.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowupperhalfValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showupperhalf', parent_name='splom', **kwargs - ): - super(ShowupperhalfValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_stream.py b/plotly/validators/splom/_stream.py deleted file mode 100644 index cce3919099a..00000000000 --- a/plotly/validators/splom/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='splom', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/_text.py b/plotly/validators/splom/_text.py deleted file mode 100644 index f8e22b5125a..00000000000 --- a/plotly/validators/splom/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='splom', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_textsrc.py b/plotly/validators/splom/_textsrc.py deleted file mode 100644 index b4c7bf6cf56..00000000000 --- a/plotly/validators/splom/_textsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='textsrc', parent_name='splom', **kwargs): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_uid.py b/plotly/validators/splom/_uid.py deleted file mode 100644 index c03ecef7447..00000000000 --- a/plotly/validators/splom/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='splom', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_uirevision.py b/plotly/validators/splom/_uirevision.py deleted file mode 100644 index 17819382c9c..00000000000 --- a/plotly/validators/splom/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='splom', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_unselected.py b/plotly/validators/splom/_unselected.py deleted file mode 100644 index 8aeee242938..00000000000 --- a/plotly/validators/splom/_unselected.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='unselected', parent_name='splom', **kwargs - ): - super(UnselectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Unselected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.splom.unselected.Marker - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/_visible.py b/plotly/validators/splom/_visible.py deleted file mode 100644 index f7b14f626d2..00000000000 --- a/plotly/validators/splom/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='splom', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/splom/_xaxes.py b/plotly/validators/splom/_xaxes.py deleted file mode 100644 index 0f94b41500d..00000000000 --- a/plotly/validators/splom/_xaxes.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class XaxesValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__(self, plotly_name='xaxes', parent_name='splom', **kwargs): - super(XaxesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - free_length=kwargs.pop('free_length', True), - items=kwargs.pop( - 'items', { - 'valType': 'subplotid', - 'regex': '/^x([2-9]|[1-9][0-9]+)?$/', - 'editType': 'plot' - } - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/_yaxes.py b/plotly/validators/splom/_yaxes.py deleted file mode 100644 index d350cc661a8..00000000000 --- a/plotly/validators/splom/_yaxes.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class YaxesValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__(self, plotly_name='yaxes', parent_name='splom', **kwargs): - super(YaxesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - free_length=kwargs.pop('free_length', True), - items=kwargs.pop( - 'items', { - 'valType': 'subplotid', - 'regex': '/^y([2-9]|[1-9][0-9]+)?$/', - 'editType': 'plot' - } - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/diagonal/__init__.py b/plotly/validators/splom/diagonal/__init__.py index 36873797fb7..0c6e87a0f27 100644 --- a/plotly/validators/splom/diagonal/__init__.py +++ b/plotly/validators/splom/diagonal/__init__.py @@ -1 +1,17 @@ -from ._visible import VisibleValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='splom.diagonal', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/splom/diagonal/_visible.py b/plotly/validators/splom/diagonal/_visible.py deleted file mode 100644 index 65af67deb37..00000000000 --- a/plotly/validators/splom/diagonal/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='splom.diagonal', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/dimension/__init__.py b/plotly/validators/splom/dimension/__init__.py index bac85e55747..bc7111b0eea 100644 --- a/plotly/validators/splom/dimension/__init__.py +++ b/plotly/validators/splom/dimension/__init__.py @@ -1,7 +1,135 @@ -from ._visible import VisibleValidator -from ._valuessrc import ValuessrcValidator -from ._values import ValuesValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._label import LabelValidator -from ._axis import AxisValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='splom.dimension', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValuessrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='valuessrc', parent_name='splom.dimension', **kwargs + ): + super(ValuessrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValuesValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='values', parent_name='splom.dimension', **kwargs + ): + super(ValuesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='splom.dimension', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='name', parent_name='splom.dimension', **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LabelValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='label', parent_name='splom.dimension', **kwargs + ): + super(LabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AxisValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='axis', parent_name='splom.dimension', **kwargs + ): + super(AxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Axis'), + data_docs=kwargs.pop( + 'data_docs', """ + matches + 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. + type + 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. +""" + ), + **kwargs + ) diff --git a/plotly/validators/splom/dimension/_axis.py b/plotly/validators/splom/dimension/_axis.py deleted file mode 100644 index 60795ea3ca0..00000000000 --- a/plotly/validators/splom/dimension/_axis.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class AxisValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='axis', parent_name='splom.dimension', **kwargs - ): - super(AxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Axis'), - data_docs=kwargs.pop( - 'data_docs', """ - matches - 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. - type - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/dimension/_label.py b/plotly/validators/splom/dimension/_label.py deleted file mode 100644 index 0bbd095aae9..00000000000 --- a/plotly/validators/splom/dimension/_label.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LabelValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='label', parent_name='splom.dimension', **kwargs - ): - super(LabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/dimension/_name.py b/plotly/validators/splom/dimension/_name.py deleted file mode 100644 index 11f578729dc..00000000000 --- a/plotly/validators/splom/dimension/_name.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='name', parent_name='splom.dimension', **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/dimension/_templateitemname.py b/plotly/validators/splom/dimension/_templateitemname.py deleted file mode 100644 index 6a562dce349..00000000000 --- a/plotly/validators/splom/dimension/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='splom.dimension', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/dimension/_values.py b/plotly/validators/splom/dimension/_values.py deleted file mode 100644 index 50634b22dcc..00000000000 --- a/plotly/validators/splom/dimension/_values.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValuesValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='values', parent_name='splom.dimension', **kwargs - ): - super(ValuesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/splom/dimension/_valuessrc.py b/plotly/validators/splom/dimension/_valuessrc.py deleted file mode 100644 index 675d865aa89..00000000000 --- a/plotly/validators/splom/dimension/_valuessrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValuessrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='valuessrc', parent_name='splom.dimension', **kwargs - ): - super(ValuessrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/dimension/_visible.py b/plotly/validators/splom/dimension/_visible.py deleted file mode 100644 index 22bbb1de309..00000000000 --- a/plotly/validators/splom/dimension/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='splom.dimension', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/dimension/axis/__init__.py b/plotly/validators/splom/dimension/axis/__init__.py index a6db85fff6c..fdcef516277 100644 --- a/plotly/validators/splom/dimension/axis/__init__.py +++ b/plotly/validators/splom/dimension/axis/__init__.py @@ -1,2 +1,38 @@ -from ._type import TypeValidator -from ._matches import MatchesValidator + + +import _plotly_utils.basevalidators + + +class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='type', parent_name='splom.dimension.axis', **kwargs + ): + super(TypeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['linear', 'log', 'date', 'category']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MatchesValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='matches', + parent_name='splom.dimension.axis', + **kwargs + ): + super(MatchesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/splom/dimension/axis/_matches.py b/plotly/validators/splom/dimension/axis/_matches.py deleted file mode 100644 index da235222b6e..00000000000 --- a/plotly/validators/splom/dimension/axis/_matches.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class MatchesValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='matches', - parent_name='splom.dimension.axis', - **kwargs - ): - super(MatchesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/dimension/axis/_type.py b/plotly/validators/splom/dimension/axis/_type.py deleted file mode 100644 index b6b4337b5a6..00000000000 --- a/plotly/validators/splom/dimension/axis/_type.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TypeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='type', parent_name='splom.dimension.axis', **kwargs - ): - super(TypeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['linear', 'log', 'date', 'category']), - **kwargs - ) diff --git a/plotly/validators/splom/hoverlabel/__init__.py b/plotly/validators/splom/hoverlabel/__init__.py index 856f769ba33..2d6f204b392 100644 --- a/plotly/validators/splom/hoverlabel/__init__.py +++ b/plotly/validators/splom/hoverlabel/__init__.py @@ -1,7 +1,170 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='splom.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='splom.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='splom.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='splom.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='splom.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='splom.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='splom.hoverlabel', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/splom/hoverlabel/_bgcolor.py b/plotly/validators/splom/hoverlabel/_bgcolor.py deleted file mode 100644 index 4aa2fda7dcd..00000000000 --- a/plotly/validators/splom/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='splom.hoverlabel', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/hoverlabel/_bgcolorsrc.py b/plotly/validators/splom/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index fffea05663e..00000000000 --- a/plotly/validators/splom/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='splom.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/hoverlabel/_bordercolor.py b/plotly/validators/splom/hoverlabel/_bordercolor.py deleted file mode 100644 index 3678fe4460e..00000000000 --- a/plotly/validators/splom/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='splom.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/hoverlabel/_bordercolorsrc.py b/plotly/validators/splom/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index b9d57771340..00000000000 --- a/plotly/validators/splom/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='splom.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/hoverlabel/_font.py b/plotly/validators/splom/hoverlabel/_font.py deleted file mode 100644 index 7b1dc16302a..00000000000 --- a/plotly/validators/splom/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='splom.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/hoverlabel/_namelength.py b/plotly/validators/splom/hoverlabel/_namelength.py deleted file mode 100644 index fe4b4507208..00000000000 --- a/plotly/validators/splom/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='splom.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/hoverlabel/_namelengthsrc.py b/plotly/validators/splom/hoverlabel/_namelengthsrc.py deleted file mode 100644 index e067e8e977b..00000000000 --- a/plotly/validators/splom/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='splom.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/hoverlabel/font/__init__.py b/plotly/validators/splom/hoverlabel/font/__init__.py index 1d2c591d1e5..eb98ee148ae 100644 --- a/plotly/validators/splom/hoverlabel/font/__init__.py +++ b/plotly/validators/splom/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='splom.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='splom.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='splom.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='splom.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='splom.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='splom.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/splom/hoverlabel/font/_color.py b/plotly/validators/splom/hoverlabel/font/_color.py deleted file mode 100644 index c5936f478e1..00000000000 --- a/plotly/validators/splom/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='splom.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/hoverlabel/font/_colorsrc.py b/plotly/validators/splom/hoverlabel/font/_colorsrc.py deleted file mode 100644 index fe89e16899c..00000000000 --- a/plotly/validators/splom/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='splom.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/hoverlabel/font/_family.py b/plotly/validators/splom/hoverlabel/font/_family.py deleted file mode 100644 index 626aa17c05f..00000000000 --- a/plotly/validators/splom/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='splom.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/splom/hoverlabel/font/_familysrc.py b/plotly/validators/splom/hoverlabel/font/_familysrc.py deleted file mode 100644 index a9e0fed973f..00000000000 --- a/plotly/validators/splom/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='splom.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/hoverlabel/font/_size.py b/plotly/validators/splom/hoverlabel/font/_size.py deleted file mode 100644 index efdb3ad5d6e..00000000000 --- a/plotly/validators/splom/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='splom.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/hoverlabel/font/_sizesrc.py b/plotly/validators/splom/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 11f5d3c23aa..00000000000 --- a/plotly/validators/splom/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='splom.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/__init__.py b/plotly/validators/splom/marker/__init__.py index bad65b61294..f953dcfafd2 100644 --- a/plotly/validators/splom/marker/__init__.py +++ b/plotly/validators/splom/marker/__init__.py @@ -1,21 +1,739 @@ -from ._symbolsrc import SymbolsrcValidator -from ._symbol import SymbolValidator -from ._sizesrc import SizesrcValidator -from ._sizeref import SizerefValidator -from ._sizemode import SizemodeValidator -from ._sizemin import SizeminValidator -from ._size import SizeValidator -from ._showscale import ShowscaleValidator -from ._reversescale import ReversescaleValidator -from ._opacitysrc import OpacitysrcValidator -from ._opacity import OpacityValidator -from ._line import LineValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='symbolsrc', parent_name='splom.marker', **kwargs + ): + super(SymbolsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='symbol', parent_name='splom.marker', **kwargs + ): + super(SymbolValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, + 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', + 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', + 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', + 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', + 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, + 'star-triangle-down-open', 220, 'star-triangle-down-dot', + 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', + 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, + 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, + 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, + 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='sizesrc', parent_name='splom.marker', **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sizeref', parent_name='splom.marker', **kwargs + ): + super(SizerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='sizemode', parent_name='splom.marker', **kwargs + ): + super(SizemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['diameter', 'area']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sizemin', parent_name='splom.marker', **kwargs + ): + super(SizeminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='splom.marker', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'markerSize'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='splom.marker', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='reversescale', parent_name='splom.marker', **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='opacitysrc', parent_name='splom.marker', **kwargs + ): + super(OpacitysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='splom.marker', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='splom.marker', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + autocolorscale + Determines whether the colorscale is a default + palette (`autocolorscale: true`) or the palette + determined by `marker.line.colorscale`. Has an + effect only if in `marker.line.color`is set to + a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the + default palette will be chosen according to + whether numbers in the `color` array are all + positive, all negative or mixed. + cauto + Determines whether or not the color domain is + computed with respect to the input data (here + in `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has + an 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. + cmax + Sets the upper bound of the color domain. Has + an effect only if 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. + cmid + Sets the mid-point of the color domain by + scaling `marker.line.cmin` and/or + `marker.line.cmax` to be equidistant to this + point. Has an effect only if in + `marker.line.color`is 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`. + cmin + Sets the lower bound of the color domain. Has + an effect only if 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. + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color`is set to a numerical array. + The colorscale must be an array containing + arrays mapping a normalized value to an rgb, + rgba, hex, hsl, hsv, or named color string. At + minimum, a mapping for the lowest (0) and + highest (1) values are required. For example, + `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color + space, use`marker.line.cmin` and + `marker.line.cmax`. Alternatively, `colorscale` + may be a palette name string of the following + list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R + eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black + body,Earth,Electric,Viridis,Cividis. + colorsrc + Sets the source reference on plot.ly for color + . + reversescale + Reverses the color mapping if true. Has an + effect only if in `marker.line.color`is set to + a numerical array. If true, `marker.line.cmin` + will correspond to the last color in the array + and `marker.line.cmax` will correspond to the + first color. + width + Sets the width (in px) of the lines bounding + the marker points. + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='splom.marker', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='splom.marker', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='splom.marker', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.splom.marker.colorbar.Tickfor + matstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.splom.marker.colorbar.tickformatstopdefaults) + , sets the default property values to use for + elements of + splom.marker.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.splom.marker.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + splom.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. + titleside + Deprecated: Please use + splom.marker.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='splom.marker', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'splom.marker.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='splom.marker', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='splom.marker', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='splom.marker', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='splom.marker', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='splom.marker', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/splom/marker/_autocolorscale.py b/plotly/validators/splom/marker/_autocolorscale.py deleted file mode 100644 index 229ad0da496..00000000000 --- a/plotly/validators/splom/marker/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='splom.marker', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_cauto.py b/plotly/validators/splom/marker/_cauto.py deleted file mode 100644 index 2b2ed8824b0..00000000000 --- a/plotly/validators/splom/marker/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='splom.marker', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_cmax.py b/plotly/validators/splom/marker/_cmax.py deleted file mode 100644 index f6815e6b3e6..00000000000 --- a/plotly/validators/splom/marker/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='splom.marker', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_cmid.py b/plotly/validators/splom/marker/_cmid.py deleted file mode 100644 index 81001448e40..00000000000 --- a/plotly/validators/splom/marker/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='splom.marker', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_cmin.py b/plotly/validators/splom/marker/_cmin.py deleted file mode 100644 index 9903ec44fcb..00000000000 --- a/plotly/validators/splom/marker/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='splom.marker', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_color.py b/plotly/validators/splom/marker/_color.py deleted file mode 100644 index 7d64287018e..00000000000 --- a/plotly/validators/splom/marker/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='splom.marker', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'splom.marker.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_colorbar.py b/plotly/validators/splom/marker/_colorbar.py deleted file mode 100644 index 38b9c8fdc35..00000000000 --- a/plotly/validators/splom/marker/_colorbar.py +++ /dev/null @@ -1,228 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='splom.marker', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.splom.marker.colorbar.Tickfor - matstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.splom.marker.colorbar.tickformatstopdefaults) - , sets the default property values to use for - elements of - splom.marker.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.splom.marker.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - splom.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. - titleside - Deprecated: Please use - splom.marker.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_colorscale.py b/plotly/validators/splom/marker/_colorscale.py deleted file mode 100644 index f0664d0e7bc..00000000000 --- a/plotly/validators/splom/marker/_colorscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='splom.marker', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_colorsrc.py b/plotly/validators/splom/marker/_colorsrc.py deleted file mode 100644 index 654e7173715..00000000000 --- a/plotly/validators/splom/marker/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='splom.marker', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_line.py b/plotly/validators/splom/marker/_line.py deleted file mode 100644 index 144ebeb3ee8..00000000000 --- a/plotly/validators/splom/marker/_line.py +++ /dev/null @@ -1,97 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='splom.marker', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - autocolorscale - Determines whether the colorscale is a default - palette (`autocolorscale: true`) or the palette - determined by `marker.line.colorscale`. Has an - effect only if in `marker.line.color`is set to - a numerical array. In case `colorscale` is - unspecified or `autocolorscale` is true, the - default palette will be chosen according to - whether numbers in the `color` array are all - positive, all negative or mixed. - cauto - Determines whether or not the color domain is - computed with respect to the input data (here - in `marker.line.color`) or the bounds set in - `marker.line.cmin` and `marker.line.cmax` Has - an 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. - cmax - Sets the upper bound of the color domain. Has - an effect only if 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. - cmid - Sets the mid-point of the color domain by - scaling `marker.line.cmin` and/or - `marker.line.cmax` to be equidistant to this - point. Has an effect only if in - `marker.line.color`is 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`. - cmin - Sets the lower bound of the color domain. Has - an effect only if 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. - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - colorscale - Sets the colorscale. Has an effect only if in - `marker.line.color`is set to a numerical array. - The colorscale must be an array containing - arrays mapping a normalized value to an rgb, - rgba, hex, hsl, hsv, or named color string. At - minimum, a mapping for the lowest (0) and - highest (1) values are required. For example, - `[[0, 'rgb(0,0,255)', [1, 'rgb(255,0,0)']]`. To - control the bounds of the colorscale in color - space, use`marker.line.cmin` and - `marker.line.cmax`. Alternatively, `colorscale` - may be a palette name string of the following - list: Greys,YlGnBu,Greens,YlOrRd,Bluered,RdBu,R - eds,Blues,Picnic,Rainbow,Portland,Jet,Hot,Black - body,Earth,Electric,Viridis,Cividis. - colorsrc - Sets the source reference on plot.ly for color - . - reversescale - Reverses the color mapping if true. Has an - effect only if in `marker.line.color`is set to - a numerical array. If true, `marker.line.cmin` - will correspond to the last color in the array - and `marker.line.cmax` will correspond to the - first color. - width - Sets the width (in px) of the lines bounding - the marker points. - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_opacity.py b/plotly/validators/splom/marker/_opacity.py deleted file mode 100644 index 5a92a02586d..00000000000 --- a/plotly/validators/splom/marker/_opacity.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='splom.marker', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_opacitysrc.py b/plotly/validators/splom/marker/_opacitysrc.py deleted file mode 100644 index 52bcb7b8b34..00000000000 --- a/plotly/validators/splom/marker/_opacitysrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacitysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='opacitysrc', parent_name='splom.marker', **kwargs - ): - super(OpacitysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_reversescale.py b/plotly/validators/splom/marker/_reversescale.py deleted file mode 100644 index cc2ba9fd7a0..00000000000 --- a/plotly/validators/splom/marker/_reversescale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='reversescale', parent_name='splom.marker', **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_showscale.py b/plotly/validators/splom/marker/_showscale.py deleted file mode 100644 index 8b39e7856b6..00000000000 --- a/plotly/validators/splom/marker/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='splom.marker', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_size.py b/plotly/validators/splom/marker/_size.py deleted file mode 100644 index 1563994a8a6..00000000000 --- a/plotly/validators/splom/marker/_size.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='splom.marker', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'markerSize'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_sizemin.py b/plotly/validators/splom/marker/_sizemin.py deleted file mode 100644 index 94fa5d48d55..00000000000 --- a/plotly/validators/splom/marker/_sizemin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sizemin', parent_name='splom.marker', **kwargs - ): - super(SizeminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_sizemode.py b/plotly/validators/splom/marker/_sizemode.py deleted file mode 100644 index b6850f9ed0a..00000000000 --- a/plotly/validators/splom/marker/_sizemode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='sizemode', parent_name='splom.marker', **kwargs - ): - super(SizemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['diameter', 'area']), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_sizeref.py b/plotly/validators/splom/marker/_sizeref.py deleted file mode 100644 index 91c50921951..00000000000 --- a/plotly/validators/splom/marker/_sizeref.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sizeref', parent_name='splom.marker', **kwargs - ): - super(SizerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_sizesrc.py b/plotly/validators/splom/marker/_sizesrc.py deleted file mode 100644 index 62f598c0276..00000000000 --- a/plotly/validators/splom/marker/_sizesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='sizesrc', parent_name='splom.marker', **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_symbol.py b/plotly/validators/splom/marker/_symbol.py deleted file mode 100644 index 1895da08f95..00000000000 --- a/plotly/validators/splom/marker/_symbol.py +++ /dev/null @@ -1,78 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='symbol', parent_name='splom.marker', **kwargs - ): - super(SymbolValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, - 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', - 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', - 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', - 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', - 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, - 'star-triangle-down-open', 220, 'star-triangle-down-dot', - 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', - 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, - 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, - 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, - 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' - ] - ), - **kwargs - ) diff --git a/plotly/validators/splom/marker/_symbolsrc.py b/plotly/validators/splom/marker/_symbolsrc.py deleted file mode 100644 index 1e66b781c90..00000000000 --- a/plotly/validators/splom/marker/_symbolsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='symbolsrc', parent_name='splom.marker', **kwargs - ): - super(SymbolsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/__init__.py b/plotly/validators/splom/marker/colorbar/__init__.py index 3dab31f7e02..55ed10ac8d2 100644 --- a/plotly/validators/splom/marker/colorbar/__init__.py +++ b/plotly/validators/splom/marker/colorbar/__init__.py @@ -1,41 +1,927 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ypad', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='splom.marker.colorbar', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='xpad', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='splom.marker.colorbar', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, + plotly_name='title', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='ticks', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='tick0', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='len', parent_name='splom.marker.colorbar', **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, + plotly_name='dtick', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='splom.marker.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/splom/marker/colorbar/_bgcolor.py b/plotly/validators/splom/marker/colorbar/_bgcolor.py deleted file mode 100644 index 992b6acbc1c..00000000000 --- a/plotly/validators/splom/marker/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_bordercolor.py b/plotly/validators/splom/marker/colorbar/_bordercolor.py deleted file mode 100644 index 61694f98c42..00000000000 --- a/plotly/validators/splom/marker/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_borderwidth.py b/plotly/validators/splom/marker/colorbar/_borderwidth.py deleted file mode 100644 index d8767f4f2d0..00000000000 --- a/plotly/validators/splom/marker/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_dtick.py b/plotly/validators/splom/marker/colorbar/_dtick.py deleted file mode 100644 index 2b6f00bc156..00000000000 --- a/plotly/validators/splom/marker/colorbar/_dtick.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='dtick', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_exponentformat.py b/plotly/validators/splom/marker/colorbar/_exponentformat.py deleted file mode 100644 index fe970553850..00000000000 --- a/plotly/validators/splom/marker/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_len.py b/plotly/validators/splom/marker/colorbar/_len.py deleted file mode 100644 index 5207b159235..00000000000 --- a/plotly/validators/splom/marker/colorbar/_len.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='len', parent_name='splom.marker.colorbar', **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_lenmode.py b/plotly/validators/splom/marker/colorbar/_lenmode.py deleted file mode 100644 index 36663c8ba02..00000000000 --- a/plotly/validators/splom/marker/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_nticks.py b/plotly/validators/splom/marker/colorbar/_nticks.py deleted file mode 100644 index 28f7158e75f..00000000000 --- a/plotly/validators/splom/marker/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_outlinecolor.py b/plotly/validators/splom/marker/colorbar/_outlinecolor.py deleted file mode 100644 index 304e432b935..00000000000 --- a/plotly/validators/splom/marker/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_outlinewidth.py b/plotly/validators/splom/marker/colorbar/_outlinewidth.py deleted file mode 100644 index d1c9f329526..00000000000 --- a/plotly/validators/splom/marker/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_separatethousands.py b/plotly/validators/splom/marker/colorbar/_separatethousands.py deleted file mode 100644 index cf9da6f0afd..00000000000 --- a/plotly/validators/splom/marker/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_showexponent.py b/plotly/validators/splom/marker/colorbar/_showexponent.py deleted file mode 100644 index 4ee8f10fd09..00000000000 --- a/plotly/validators/splom/marker/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_showticklabels.py b/plotly/validators/splom/marker/colorbar/_showticklabels.py deleted file mode 100644 index 6911cf69936..00000000000 --- a/plotly/validators/splom/marker/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_showtickprefix.py b/plotly/validators/splom/marker/colorbar/_showtickprefix.py deleted file mode 100644 index daeeeb98567..00000000000 --- a/plotly/validators/splom/marker/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_showticksuffix.py b/plotly/validators/splom/marker/colorbar/_showticksuffix.py deleted file mode 100644 index 672de19f8b2..00000000000 --- a/plotly/validators/splom/marker/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_thickness.py b/plotly/validators/splom/marker/colorbar/_thickness.py deleted file mode 100644 index b9fae418c67..00000000000 --- a/plotly/validators/splom/marker/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_thicknessmode.py b/plotly/validators/splom/marker/colorbar/_thicknessmode.py deleted file mode 100644 index cbfd5556b99..00000000000 --- a/plotly/validators/splom/marker/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_tick0.py b/plotly/validators/splom/marker/colorbar/_tick0.py deleted file mode 100644 index 0848fe0f56a..00000000000 --- a/plotly/validators/splom/marker/colorbar/_tick0.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, - plotly_name='tick0', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_tickangle.py b/plotly/validators/splom/marker/colorbar/_tickangle.py deleted file mode 100644 index d47c47c8cd6..00000000000 --- a/plotly/validators/splom/marker/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_tickcolor.py b/plotly/validators/splom/marker/colorbar/_tickcolor.py deleted file mode 100644 index c99b3570dc5..00000000000 --- a/plotly/validators/splom/marker/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_tickfont.py b/plotly/validators/splom/marker/colorbar/_tickfont.py deleted file mode 100644 index 09958b48f7b..00000000000 --- a/plotly/validators/splom/marker/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_tickformat.py b/plotly/validators/splom/marker/colorbar/_tickformat.py deleted file mode 100644 index 2426e3d3eb4..00000000000 --- a/plotly/validators/splom/marker/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_tickformatstopdefaults.py b/plotly/validators/splom/marker/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 61d2a1b4f67..00000000000 --- a/plotly/validators/splom/marker/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_tickformatstops.py b/plotly/validators/splom/marker/colorbar/_tickformatstops.py deleted file mode 100644 index 1325a1f6811..00000000000 --- a/plotly/validators/splom/marker/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_ticklen.py b/plotly/validators/splom/marker/colorbar/_ticklen.py deleted file mode 100644 index 04e21a1e0f7..00000000000 --- a/plotly/validators/splom/marker/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_tickmode.py b/plotly/validators/splom/marker/colorbar/_tickmode.py deleted file mode 100644 index 0419bf3e854..00000000000 --- a/plotly/validators/splom/marker/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_tickprefix.py b/plotly/validators/splom/marker/colorbar/_tickprefix.py deleted file mode 100644 index 06dd5d3e813..00000000000 --- a/plotly/validators/splom/marker/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_ticks.py b/plotly/validators/splom/marker/colorbar/_ticks.py deleted file mode 100644 index 4a19bc08629..00000000000 --- a/plotly/validators/splom/marker/colorbar/_ticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='ticks', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_ticksuffix.py b/plotly/validators/splom/marker/colorbar/_ticksuffix.py deleted file mode 100644 index 92ea83c6981..00000000000 --- a/plotly/validators/splom/marker/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_ticktext.py b/plotly/validators/splom/marker/colorbar/_ticktext.py deleted file mode 100644 index 3e2ffbda77e..00000000000 --- a/plotly/validators/splom/marker/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_ticktextsrc.py b/plotly/validators/splom/marker/colorbar/_ticktextsrc.py deleted file mode 100644 index 4b61ab948d2..00000000000 --- a/plotly/validators/splom/marker/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_tickvals.py b/plotly/validators/splom/marker/colorbar/_tickvals.py deleted file mode 100644 index 35f301c65a3..00000000000 --- a/plotly/validators/splom/marker/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_tickvalssrc.py b/plotly/validators/splom/marker/colorbar/_tickvalssrc.py deleted file mode 100644 index f2d81d9d6bb..00000000000 --- a/plotly/validators/splom/marker/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_tickwidth.py b/plotly/validators/splom/marker/colorbar/_tickwidth.py deleted file mode 100644 index ed036b3012a..00000000000 --- a/plotly/validators/splom/marker/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_title.py b/plotly/validators/splom/marker/colorbar/_title.py deleted file mode 100644 index ea23ec68b8f..00000000000 --- a/plotly/validators/splom/marker/colorbar/_title.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, - plotly_name='title', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_x.py b/plotly/validators/splom/marker/colorbar/_x.py deleted file mode 100644 index cd3143287df..00000000000 --- a/plotly/validators/splom/marker/colorbar/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='splom.marker.colorbar', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_xanchor.py b/plotly/validators/splom/marker/colorbar/_xanchor.py deleted file mode 100644 index 5a8530eb8b1..00000000000 --- a/plotly/validators/splom/marker/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_xpad.py b/plotly/validators/splom/marker/colorbar/_xpad.py deleted file mode 100644 index c83a0264c78..00000000000 --- a/plotly/validators/splom/marker/colorbar/_xpad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='xpad', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_y.py b/plotly/validators/splom/marker/colorbar/_y.py deleted file mode 100644 index cda1f1c3603..00000000000 --- a/plotly/validators/splom/marker/colorbar/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='splom.marker.colorbar', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_yanchor.py b/plotly/validators/splom/marker/colorbar/_yanchor.py deleted file mode 100644 index 1eef56d229a..00000000000 --- a/plotly/validators/splom/marker/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/_ypad.py b/plotly/validators/splom/marker/colorbar/_ypad.py deleted file mode 100644 index 602a84a4e6c..00000000000 --- a/plotly/validators/splom/marker/colorbar/_ypad.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ypad', - parent_name='splom.marker.colorbar', - **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/tickfont/__init__.py b/plotly/validators/splom/marker/colorbar/tickfont/__init__.py index 199d72e71c6..66f0400abff 100644 --- a/plotly/validators/splom/marker/colorbar/tickfont/__init__.py +++ b/plotly/validators/splom/marker/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='splom.marker.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='splom.marker.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='splom.marker.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/splom/marker/colorbar/tickfont/_color.py b/plotly/validators/splom/marker/colorbar/tickfont/_color.py deleted file mode 100644 index df26adddd80..00000000000 --- a/plotly/validators/splom/marker/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='splom.marker.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/tickfont/_family.py b/plotly/validators/splom/marker/colorbar/tickfont/_family.py deleted file mode 100644 index 8c5129e5898..00000000000 --- a/plotly/validators/splom/marker/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='splom.marker.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/tickfont/_size.py b/plotly/validators/splom/marker/colorbar/tickfont/_size.py deleted file mode 100644 index 70df4b59355..00000000000 --- a/plotly/validators/splom/marker/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='splom.marker.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/tickformatstop/__init__.py b/plotly/validators/splom/marker/colorbar/tickformatstop/__init__.py index 3f6c06cac47..f1a5d2edc8c 100644 --- a/plotly/validators/splom/marker/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/splom/marker/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='splom.marker.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='splom.marker.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='splom.marker.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='splom.marker.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='splom.marker.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/splom/marker/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/splom/marker/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 33fb65e877b..00000000000 --- a/plotly/validators/splom/marker/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='splom.marker.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/tickformatstop/_enabled.py b/plotly/validators/splom/marker/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index fb24bb10bb8..00000000000 --- a/plotly/validators/splom/marker/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='splom.marker.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/tickformatstop/_name.py b/plotly/validators/splom/marker/colorbar/tickformatstop/_name.py deleted file mode 100644 index 5c35cde79b0..00000000000 --- a/plotly/validators/splom/marker/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='splom.marker.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/splom/marker/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 2204afdb2d7..00000000000 --- a/plotly/validators/splom/marker/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='splom.marker.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/tickformatstop/_value.py b/plotly/validators/splom/marker/colorbar/tickformatstop/_value.py deleted file mode 100644 index 4f0d749144c..00000000000 --- a/plotly/validators/splom/marker/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='splom.marker.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/title/__init__.py b/plotly/validators/splom/marker/colorbar/title/__init__.py index 33c9c145bb8..39bfa6b37ad 100644 --- a/plotly/validators/splom/marker/colorbar/title/__init__.py +++ b/plotly/validators/splom/marker/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='splom.marker.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='splom.marker.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='splom.marker.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/splom/marker/colorbar/title/_font.py b/plotly/validators/splom/marker/colorbar/title/_font.py deleted file mode 100644 index 2e2acf29162..00000000000 --- a/plotly/validators/splom/marker/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='splom.marker.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/title/_side.py b/plotly/validators/splom/marker/colorbar/title/_side.py deleted file mode 100644 index aa83c30b538..00000000000 --- a/plotly/validators/splom/marker/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='splom.marker.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/title/_text.py b/plotly/validators/splom/marker/colorbar/title/_text.py deleted file mode 100644 index 96294764b46..00000000000 --- a/plotly/validators/splom/marker/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='splom.marker.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/title/font/__init__.py b/plotly/validators/splom/marker/colorbar/title/font/__init__.py index 199d72e71c6..41b7f996361 100644 --- a/plotly/validators/splom/marker/colorbar/title/font/__init__.py +++ b/plotly/validators/splom/marker/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='splom.marker.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='splom.marker.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='splom.marker.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/splom/marker/colorbar/title/font/_color.py b/plotly/validators/splom/marker/colorbar/title/font/_color.py deleted file mode 100644 index 2e5700c43a5..00000000000 --- a/plotly/validators/splom/marker/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='splom.marker.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/title/font/_family.py b/plotly/validators/splom/marker/colorbar/title/font/_family.py deleted file mode 100644 index 21631bd3f63..00000000000 --- a/plotly/validators/splom/marker/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='splom.marker.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/splom/marker/colorbar/title/font/_size.py b/plotly/validators/splom/marker/colorbar/title/font/_size.py deleted file mode 100644 index 14fb6dc5915..00000000000 --- a/plotly/validators/splom/marker/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='splom.marker.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/line/__init__.py b/plotly/validators/splom/marker/line/__init__.py index c031ca61ce2..6f8eae66077 100644 --- a/plotly/validators/splom/marker/line/__init__.py +++ b/plotly/validators/splom/marker/line/__init__.py @@ -1,11 +1,217 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._reversescale import ReversescaleValidator -from ._colorsrc import ColorsrcValidator -from ._colorscale import ColorscaleValidator -from ._color import ColorValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='widthsrc', + parent_name='splom.marker.line', + **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='splom.marker.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='reversescale', + parent_name='splom.marker.line', + **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='splom.marker.line', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, + plotly_name='colorscale', + parent_name='splom.marker.line', + **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='splom.marker.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + colorscale_path=kwargs.pop( + 'colorscale_path', 'splom.marker.line.colorscale' + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmin', parent_name='splom.marker.line', **kwargs + ): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmid', parent_name='splom.marker.line', **kwargs + ): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='cmax', parent_name='splom.marker.line', **kwargs + ): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='splom.marker.line', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='autocolorscale', + parent_name='splom.marker.line', + **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/splom/marker/line/_autocolorscale.py b/plotly/validators/splom/marker/line/_autocolorscale.py deleted file mode 100644 index d22af703e8b..00000000000 --- a/plotly/validators/splom/marker/line/_autocolorscale.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='autocolorscale', - parent_name='splom.marker.line', - **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/line/_cauto.py b/plotly/validators/splom/marker/line/_cauto.py deleted file mode 100644 index d76ed2da8da..00000000000 --- a/plotly/validators/splom/marker/line/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='splom.marker.line', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/line/_cmax.py b/plotly/validators/splom/marker/line/_cmax.py deleted file mode 100644 index 49cdfd48d9e..00000000000 --- a/plotly/validators/splom/marker/line/_cmax.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmax', parent_name='splom.marker.line', **kwargs - ): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/line/_cmid.py b/plotly/validators/splom/marker/line/_cmid.py deleted file mode 100644 index 9d01ed5584d..00000000000 --- a/plotly/validators/splom/marker/line/_cmid.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmid', parent_name='splom.marker.line', **kwargs - ): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/line/_cmin.py b/plotly/validators/splom/marker/line/_cmin.py deleted file mode 100644 index fe4f3a0c1b4..00000000000 --- a/plotly/validators/splom/marker/line/_cmin.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='cmin', parent_name='splom.marker.line', **kwargs - ): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/line/_color.py b/plotly/validators/splom/marker/line/_color.py deleted file mode 100644 index e060eaebd55..00000000000 --- a/plotly/validators/splom/marker/line/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='splom.marker.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - colorscale_path=kwargs.pop( - 'colorscale_path', 'splom.marker.line.colorscale' - ), - **kwargs - ) diff --git a/plotly/validators/splom/marker/line/_colorscale.py b/plotly/validators/splom/marker/line/_colorscale.py deleted file mode 100644 index 629853fe5cd..00000000000 --- a/plotly/validators/splom/marker/line/_colorscale.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, - plotly_name='colorscale', - parent_name='splom.marker.line', - **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/line/_colorsrc.py b/plotly/validators/splom/marker/line/_colorsrc.py deleted file mode 100644 index 8432a40913a..00000000000 --- a/plotly/validators/splom/marker/line/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='splom.marker.line', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/line/_reversescale.py b/plotly/validators/splom/marker/line/_reversescale.py deleted file mode 100644 index 8235fee3da7..00000000000 --- a/plotly/validators/splom/marker/line/_reversescale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='reversescale', - parent_name='splom.marker.line', - **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/line/_width.py b/plotly/validators/splom/marker/line/_width.py deleted file mode 100644 index 6a404031697..00000000000 --- a/plotly/validators/splom/marker/line/_width.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='splom.marker.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/marker/line/_widthsrc.py b/plotly/validators/splom/marker/line/_widthsrc.py deleted file mode 100644 index e7e7509d552..00000000000 --- a/plotly/validators/splom/marker/line/_widthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='widthsrc', - parent_name='splom.marker.line', - **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/selected/__init__.py b/plotly/validators/splom/selected/__init__.py index 3604b0284fc..1cdd18b67e8 100644 --- a/plotly/validators/splom/selected/__init__.py +++ b/plotly/validators/splom/selected/__init__.py @@ -1 +1,26 @@ -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='splom.selected', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. +""" + ), + **kwargs + ) diff --git a/plotly/validators/splom/selected/_marker.py b/plotly/validators/splom/selected/_marker.py deleted file mode 100644 index 3b9e80f6c27..00000000000 --- a/plotly/validators/splom/selected/_marker.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='splom.selected', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/selected/marker/__init__.py b/plotly/validators/splom/selected/marker/__init__.py index ed9a9070947..3c6e00d79c7 100644 --- a/plotly/validators/splom/selected/marker/__init__.py +++ b/plotly/validators/splom/selected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='splom.selected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='splom.selected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='splom.selected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/splom/selected/marker/_color.py b/plotly/validators/splom/selected/marker/_color.py deleted file mode 100644 index 621d3677952..00000000000 --- a/plotly/validators/splom/selected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='splom.selected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/selected/marker/_opacity.py b/plotly/validators/splom/selected/marker/_opacity.py deleted file mode 100644 index a493764511c..00000000000 --- a/plotly/validators/splom/selected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='splom.selected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/selected/marker/_size.py b/plotly/validators/splom/selected/marker/_size.py deleted file mode 100644 index ddb1e1d0e2f..00000000000 --- a/plotly/validators/splom/selected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='splom.selected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/stream/__init__.py b/plotly/validators/splom/stream/__init__.py index 2f4f2047594..5ae492050e8 100644 --- a/plotly/validators/splom/stream/__init__.py +++ b/plotly/validators/splom/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='splom.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='splom.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/splom/stream/_maxpoints.py b/plotly/validators/splom/stream/_maxpoints.py deleted file mode 100644 index 2e3933d56aa..00000000000 --- a/plotly/validators/splom/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='splom.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/splom/stream/_token.py b/plotly/validators/splom/stream/_token.py deleted file mode 100644 index fa245574aa6..00000000000 --- a/plotly/validators/splom/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='splom.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/splom/unselected/__init__.py b/plotly/validators/splom/unselected/__init__.py index 3604b0284fc..29fd3daa6c0 100644 --- a/plotly/validators/splom/unselected/__init__.py +++ b/plotly/validators/splom/unselected/__init__.py @@ -1 +1,29 @@ -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='splom.unselected', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of unselected points, + applied only when a selection exists. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) diff --git a/plotly/validators/splom/unselected/_marker.py b/plotly/validators/splom/unselected/_marker.py deleted file mode 100644 index d3cece6ca20..00000000000 --- a/plotly/validators/splom/unselected/_marker.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='splom.unselected', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of unselected points, - applied only when a selection exists. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/splom/unselected/marker/__init__.py b/plotly/validators/splom/unselected/marker/__init__.py index ed9a9070947..42f27171908 100644 --- a/plotly/validators/splom/unselected/marker/__init__.py +++ b/plotly/validators/splom/unselected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='splom.unselected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='splom.unselected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='splom.unselected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/splom/unselected/marker/_color.py b/plotly/validators/splom/unselected/marker/_color.py deleted file mode 100644 index 8080685be68..00000000000 --- a/plotly/validators/splom/unselected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='splom.unselected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/unselected/marker/_opacity.py b/plotly/validators/splom/unselected/marker/_opacity.py deleted file mode 100644 index 8989c035bfb..00000000000 --- a/plotly/validators/splom/unselected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='splom.unselected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/splom/unselected/marker/_size.py b/plotly/validators/splom/unselected/marker/_size.py deleted file mode 100644 index 4c91a953bb7..00000000000 --- a/plotly/validators/splom/unselected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='splom.unselected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/__init__.py b/plotly/validators/streamtube/__init__.py index 6fca458cd91..2a289d2a859 100644 --- a/plotly/validators/streamtube/__init__.py +++ b/plotly/validators/streamtube/__init__.py @@ -1,47 +1,1099 @@ -from ._zsrc import ZsrcValidator -from ._z import ZValidator -from ._ysrc import YsrcValidator -from ._y import YValidator -from ._xsrc import XsrcValidator -from ._x import XValidator -from ._wsrc import WsrcValidator -from ._w import WValidator -from ._vsrc import VsrcValidator -from ._visible import VisibleValidator -from ._v import VValidator -from ._usrc import UsrcValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._u import UValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._starts import StartsValidator -from ._sizeref import SizerefValidator -from ._showscale import ShowscaleValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._scene import SceneValidator -from ._reversescale import ReversescaleValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._maxdisplayed import MaxdisplayedValidator -from ._lightposition import LightpositionValidator -from ._lighting import LightingValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='zsrc', parent_name='streamtube', **kwargs): + super(ZsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='z', parent_name='streamtube', **kwargs): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='streamtube', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='streamtube', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='streamtube', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='streamtube', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='wsrc', parent_name='streamtube', **kwargs): + super(WsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='w', parent_name='streamtube', **kwargs): + super(WValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='vsrc', parent_name='streamtube', **kwargs): + super(VsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='visible', parent_name='streamtube', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='v', parent_name='streamtube', **kwargs): + super(VValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='usrc', parent_name='streamtube', **kwargs): + super(UsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='streamtube', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='streamtube', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='u', parent_name='streamtube', **kwargs): + super(UValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='streamtube', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='stream', parent_name='streamtube', **kwargs + ): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StartsValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='starts', parent_name='streamtube', **kwargs + ): + super(StartsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Starts'), + data_docs=kwargs.pop( + 'data_docs', """ + x + Sets the x components of the starting position + of the streamtubes + xsrc + Sets the source reference on plot.ly for x . + y + Sets the y components of the starting position + of the streamtubes + ysrc + Sets the source reference on plot.ly for y . + z + Sets the z components of the starting position + of the streamtubes + zsrc + Sets the source reference on plot.ly for z . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='sizeref', parent_name='streamtube', **kwargs + ): + super(SizerefValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='streamtube', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='streamtube', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='streamtube', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SceneValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__( + self, plotly_name='scene', parent_name='streamtube', **kwargs + ): + super(SceneValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'scene'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='reversescale', parent_name='streamtube', **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='streamtube', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='streamtube', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxdisplayedValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='maxdisplayed', parent_name='streamtube', **kwargs + ): + super(MaxdisplayedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LightpositionValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='lightposition', parent_name='streamtube', **kwargs + ): + super(LightpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Lightposition'), + data_docs=kwargs.pop( + 'data_docs', """ + x + Numeric vector, representing the X coordinate + for each vertex. + y + Numeric vector, representing the Y coordinate + for each vertex. + z + Numeric vector, representing the Z coordinate + for each vertex. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LightingValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='lighting', parent_name='streamtube', **kwargs + ): + super(LightingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Lighting'), + data_docs=kwargs.pop( + 'data_docs', """ + ambient + Ambient light increases overall color + visibility but can wash out the image. + diffuse + Represents the extent that incident rays are + reflected in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids + math issues arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of + the viewing angle; e.g. paper is reflective + when viewing it from the edge of the paper + (almost 90 degrees), causing shine. + roughness + Alters specular reflection; the rougher the + surface, the wider and less contrasty the + shine. + specular + Represents the level that incident rays are + reflected in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids + math issues arising from degenerate geometry. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='streamtube', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='idssrc', parent_name='streamtube', **kwargs + ): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='streamtube', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='streamtube', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='hovertemplatesrc', + parent_name='streamtube', + **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='streamtube', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='streamtube', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='streamtube', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='streamtube', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop( + 'flags', [ + 'x', 'y', 'z', 'u', 'v', 'w', 'norm', 'divergence', 'text', + 'name' + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='streamtube', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='streamtube', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='streamtube', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='streamtube', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.streamtube.colorbar.Tickforma + tstop instance or dict with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.streamtube.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of streamtube.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.streamtube.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + streamtube.colorbar.title.font instead. Sets + this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + titleside + Deprecated: Please use + streamtube.colorbar.title.side instead. + Determines the location of color bar's title + with respect to the color bar. Note that the + title's location used to be set by the now + deprecated `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmin', parent_name='streamtube', **kwargs): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmid', parent_name='streamtube', **kwargs): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmax', parent_name='streamtube', **kwargs): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='cauto', parent_name='streamtube', **kwargs + ): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autocolorscale', parent_name='streamtube', **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/streamtube/_autocolorscale.py b/plotly/validators/streamtube/_autocolorscale.py deleted file mode 100644 index 611fcc31848..00000000000 --- a/plotly/validators/streamtube/_autocolorscale.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autocolorscale', parent_name='streamtube', **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_cauto.py b/plotly/validators/streamtube/_cauto.py deleted file mode 100644 index 9192291c1f9..00000000000 --- a/plotly/validators/streamtube/_cauto.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='cauto', parent_name='streamtube', **kwargs - ): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_cmax.py b/plotly/validators/streamtube/_cmax.py deleted file mode 100644 index 2374c61727d..00000000000 --- a/plotly/validators/streamtube/_cmax.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmax', parent_name='streamtube', **kwargs): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_cmid.py b/plotly/validators/streamtube/_cmid.py deleted file mode 100644 index a4c4873e2bc..00000000000 --- a/plotly/validators/streamtube/_cmid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmid', parent_name='streamtube', **kwargs): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_cmin.py b/plotly/validators/streamtube/_cmin.py deleted file mode 100644 index 7c467e5fbcb..00000000000 --- a/plotly/validators/streamtube/_cmin.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmin', parent_name='streamtube', **kwargs): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_colorbar.py b/plotly/validators/streamtube/_colorbar.py deleted file mode 100644 index 7d3c6df939c..00000000000 --- a/plotly/validators/streamtube/_colorbar.py +++ /dev/null @@ -1,227 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='streamtube', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.streamtube.colorbar.Tickforma - tstop instance or dict with compatible - properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.streamtube.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of streamtube.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.streamtube.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - streamtube.colorbar.title.font instead. Sets - this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - titleside - Deprecated: Please use - streamtube.colorbar.title.side instead. - Determines the location of color bar's title - with respect to the color bar. Note that the - title's location used to be set by the now - deprecated `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/streamtube/_colorscale.py b/plotly/validators/streamtube/_colorscale.py deleted file mode 100644 index 47fcd5648da..00000000000 --- a/plotly/validators/streamtube/_colorscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='streamtube', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_customdata.py b/plotly/validators/streamtube/_customdata.py deleted file mode 100644 index 629e3013e3c..00000000000 --- a/plotly/validators/streamtube/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='streamtube', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_customdatasrc.py b/plotly/validators/streamtube/_customdatasrc.py deleted file mode 100644 index 2faa1f9ff4d..00000000000 --- a/plotly/validators/streamtube/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='streamtube', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_hoverinfo.py b/plotly/validators/streamtube/_hoverinfo.py deleted file mode 100644 index b57a58084e6..00000000000 --- a/plotly/validators/streamtube/_hoverinfo.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='streamtube', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop( - 'flags', [ - 'x', 'y', 'z', 'u', 'v', 'w', 'norm', 'divergence', 'text', - 'name' - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_hoverinfosrc.py b/plotly/validators/streamtube/_hoverinfosrc.py deleted file mode 100644 index 062725ecc63..00000000000 --- a/plotly/validators/streamtube/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='streamtube', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_hoverlabel.py b/plotly/validators/streamtube/_hoverlabel.py deleted file mode 100644 index 300216a8d79..00000000000 --- a/plotly/validators/streamtube/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='streamtube', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/streamtube/_hovertemplate.py b/plotly/validators/streamtube/_hovertemplate.py deleted file mode 100644 index c367d10dc60..00000000000 --- a/plotly/validators/streamtube/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='streamtube', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_hovertemplatesrc.py b/plotly/validators/streamtube/_hovertemplatesrc.py deleted file mode 100644 index a8d5ce8a48e..00000000000 --- a/plotly/validators/streamtube/_hovertemplatesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='hovertemplatesrc', - parent_name='streamtube', - **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_hovertext.py b/plotly/validators/streamtube/_hovertext.py deleted file mode 100644 index ee32bb6a9c4..00000000000 --- a/plotly/validators/streamtube/_hovertext.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='streamtube', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_ids.py b/plotly/validators/streamtube/_ids.py deleted file mode 100644 index 19db2618e36..00000000000 --- a/plotly/validators/streamtube/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='streamtube', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_idssrc.py b/plotly/validators/streamtube/_idssrc.py deleted file mode 100644 index 71e4e74f7ec..00000000000 --- a/plotly/validators/streamtube/_idssrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='idssrc', parent_name='streamtube', **kwargs - ): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_legendgroup.py b/plotly/validators/streamtube/_legendgroup.py deleted file mode 100644 index 4d06bef37db..00000000000 --- a/plotly/validators/streamtube/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='streamtube', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_lighting.py b/plotly/validators/streamtube/_lighting.py deleted file mode 100644 index 4bef2889dda..00000000000 --- a/plotly/validators/streamtube/_lighting.py +++ /dev/null @@ -1,42 +0,0 @@ -import _plotly_utils.basevalidators - - -class LightingValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='lighting', parent_name='streamtube', **kwargs - ): - super(LightingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Lighting'), - data_docs=kwargs.pop( - 'data_docs', """ - ambient - Ambient light increases overall color - visibility but can wash out the image. - diffuse - Represents the extent that incident rays are - reflected in a range of angles. - facenormalsepsilon - Epsilon for face normals calculation avoids - math issues arising from degenerate geometry. - fresnel - Represents the reflectance as a dependency of - the viewing angle; e.g. paper is reflective - when viewing it from the edge of the paper - (almost 90 degrees), causing shine. - roughness - Alters specular reflection; the rougher the - surface, the wider and less contrasty the - shine. - specular - Represents the level that incident rays are - reflected in a single direction, causing shine. - vertexnormalsepsilon - Epsilon for vertex normals calculation avoids - math issues arising from degenerate geometry. -""" - ), - **kwargs - ) diff --git a/plotly/validators/streamtube/_lightposition.py b/plotly/validators/streamtube/_lightposition.py deleted file mode 100644 index 908addda31f..00000000000 --- a/plotly/validators/streamtube/_lightposition.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class LightpositionValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='lightposition', parent_name='streamtube', **kwargs - ): - super(LightpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Lightposition'), - data_docs=kwargs.pop( - 'data_docs', """ - x - Numeric vector, representing the X coordinate - for each vertex. - y - Numeric vector, representing the Y coordinate - for each vertex. - z - Numeric vector, representing the Z coordinate - for each vertex. -""" - ), - **kwargs - ) diff --git a/plotly/validators/streamtube/_maxdisplayed.py b/plotly/validators/streamtube/_maxdisplayed.py deleted file mode 100644 index 0742f4d1a15..00000000000 --- a/plotly/validators/streamtube/_maxdisplayed.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxdisplayedValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='maxdisplayed', parent_name='streamtube', **kwargs - ): - super(MaxdisplayedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_name.py b/plotly/validators/streamtube/_name.py deleted file mode 100644 index 7908da2e7d3..00000000000 --- a/plotly/validators/streamtube/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='streamtube', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_opacity.py b/plotly/validators/streamtube/_opacity.py deleted file mode 100644 index 94dc7868330..00000000000 --- a/plotly/validators/streamtube/_opacity.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='streamtube', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_reversescale.py b/plotly/validators/streamtube/_reversescale.py deleted file mode 100644 index 553cb0b5a2a..00000000000 --- a/plotly/validators/streamtube/_reversescale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='reversescale', parent_name='streamtube', **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_scene.py b/plotly/validators/streamtube/_scene.py deleted file mode 100644 index f9cedeef6d1..00000000000 --- a/plotly/validators/streamtube/_scene.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SceneValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__( - self, plotly_name='scene', parent_name='streamtube', **kwargs - ): - super(SceneValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'scene'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_selectedpoints.py b/plotly/validators/streamtube/_selectedpoints.py deleted file mode 100644 index e2e15927906..00000000000 --- a/plotly/validators/streamtube/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='streamtube', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_showlegend.py b/plotly/validators/streamtube/_showlegend.py deleted file mode 100644 index 6e99d3d01c9..00000000000 --- a/plotly/validators/streamtube/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='streamtube', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_showscale.py b/plotly/validators/streamtube/_showscale.py deleted file mode 100644 index 450207af508..00000000000 --- a/plotly/validators/streamtube/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='streamtube', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_sizeref.py b/plotly/validators/streamtube/_sizeref.py deleted file mode 100644 index f0deab0f65d..00000000000 --- a/plotly/validators/streamtube/_sizeref.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizerefValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='sizeref', parent_name='streamtube', **kwargs - ): - super(SizerefValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_starts.py b/plotly/validators/streamtube/_starts.py deleted file mode 100644 index 180d3915c75..00000000000 --- a/plotly/validators/streamtube/_starts.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class StartsValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='starts', parent_name='streamtube', **kwargs - ): - super(StartsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Starts'), - data_docs=kwargs.pop( - 'data_docs', """ - x - Sets the x components of the starting position - of the streamtubes - xsrc - Sets the source reference on plot.ly for x . - y - Sets the y components of the starting position - of the streamtubes - ysrc - Sets the source reference on plot.ly for y . - z - Sets the z components of the starting position - of the streamtubes - zsrc - Sets the source reference on plot.ly for z . -""" - ), - **kwargs - ) diff --git a/plotly/validators/streamtube/_stream.py b/plotly/validators/streamtube/_stream.py deleted file mode 100644 index 5e920a4928c..00000000000 --- a/plotly/validators/streamtube/_stream.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='stream', parent_name='streamtube', **kwargs - ): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/streamtube/_text.py b/plotly/validators/streamtube/_text.py deleted file mode 100644 index c93d3d188f9..00000000000 --- a/plotly/validators/streamtube/_text.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='streamtube', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_u.py b/plotly/validators/streamtube/_u.py deleted file mode 100644 index 67b1c48a1bc..00000000000 --- a/plotly/validators/streamtube/_u.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class UValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='u', parent_name='streamtube', **kwargs): - super(UValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_uid.py b/plotly/validators/streamtube/_uid.py deleted file mode 100644 index 2c338e5800f..00000000000 --- a/plotly/validators/streamtube/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='streamtube', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_uirevision.py b/plotly/validators/streamtube/_uirevision.py deleted file mode 100644 index 69bb8d7793c..00000000000 --- a/plotly/validators/streamtube/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='streamtube', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_usrc.py b/plotly/validators/streamtube/_usrc.py deleted file mode 100644 index af3a15e85e3..00000000000 --- a/plotly/validators/streamtube/_usrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class UsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='usrc', parent_name='streamtube', **kwargs): - super(UsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_v.py b/plotly/validators/streamtube/_v.py deleted file mode 100644 index 1825e0a1aae..00000000000 --- a/plotly/validators/streamtube/_v.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class VValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='v', parent_name='streamtube', **kwargs): - super(VValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_visible.py b/plotly/validators/streamtube/_visible.py deleted file mode 100644 index ac46c9d40e7..00000000000 --- a/plotly/validators/streamtube/_visible.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='visible', parent_name='streamtube', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/streamtube/_vsrc.py b/plotly/validators/streamtube/_vsrc.py deleted file mode 100644 index 7629efea7e2..00000000000 --- a/plotly/validators/streamtube/_vsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class VsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='vsrc', parent_name='streamtube', **kwargs): - super(VsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_w.py b/plotly/validators/streamtube/_w.py deleted file mode 100644 index 78e1d754657..00000000000 --- a/plotly/validators/streamtube/_w.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class WValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='w', parent_name='streamtube', **kwargs): - super(WValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_wsrc.py b/plotly/validators/streamtube/_wsrc.py deleted file mode 100644 index 786ca74ea71..00000000000 --- a/plotly/validators/streamtube/_wsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class WsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='wsrc', parent_name='streamtube', **kwargs): - super(WsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_x.py b/plotly/validators/streamtube/_x.py deleted file mode 100644 index 7b7aa0c7902..00000000000 --- a/plotly/validators/streamtube/_x.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='streamtube', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_xsrc.py b/plotly/validators/streamtube/_xsrc.py deleted file mode 100644 index 0a528d2ab8e..00000000000 --- a/plotly/validators/streamtube/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='streamtube', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_y.py b/plotly/validators/streamtube/_y.py deleted file mode 100644 index 8791f3bb559..00000000000 --- a/plotly/validators/streamtube/_y.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='streamtube', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_ysrc.py b/plotly/validators/streamtube/_ysrc.py deleted file mode 100644 index bdc4136d48d..00000000000 --- a/plotly/validators/streamtube/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='streamtube', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_z.py b/plotly/validators/streamtube/_z.py deleted file mode 100644 index d1e04ac322d..00000000000 --- a/plotly/validators/streamtube/_z.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='z', parent_name='streamtube', **kwargs): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/streamtube/_zsrc.py b/plotly/validators/streamtube/_zsrc.py deleted file mode 100644 index b73a89a768e..00000000000 --- a/plotly/validators/streamtube/_zsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='zsrc', parent_name='streamtube', **kwargs): - super(ZsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/__init__.py b/plotly/validators/streamtube/colorbar/__init__.py index 3dab31f7e02..9153d674f97 100644 --- a/plotly/validators/streamtube/colorbar/__init__.py +++ b/plotly/validators/streamtube/colorbar/__init__.py @@ -1,41 +1,909 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ypad', parent_name='streamtube.colorbar', **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='yanchor', + parent_name='streamtube.colorbar', + **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='streamtube.colorbar', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='xpad', parent_name='streamtube.colorbar', **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='xanchor', + parent_name='streamtube.colorbar', + **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='streamtube.colorbar', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='streamtube.colorbar', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='streamtube.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='streamtube.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='tickvals', + parent_name='streamtube.colorbar', + **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='streamtube.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, + plotly_name='ticktext', + parent_name='streamtube.colorbar', + **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='streamtube.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ticks', parent_name='streamtube.colorbar', **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='streamtube.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='tickmode', + parent_name='streamtube.colorbar', + **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ticklen', + parent_name='streamtube.colorbar', + **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='streamtube.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='streamtube.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='streamtube.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickfont', + parent_name='streamtube.colorbar', + **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='streamtube.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='streamtube.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='tick0', parent_name='streamtube.colorbar', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='streamtube.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='streamtube.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='streamtube.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='streamtube.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='streamtube.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='streamtube.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='streamtube.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='streamtube.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='streamtube.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='nticks', + parent_name='streamtube.colorbar', + **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='lenmode', + parent_name='streamtube.colorbar', + **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='len', parent_name='streamtube.colorbar', **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='streamtube.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='dtick', parent_name='streamtube.colorbar', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='streamtube.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='streamtube.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='streamtube.colorbar', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/streamtube/colorbar/_bgcolor.py b/plotly/validators/streamtube/colorbar/_bgcolor.py deleted file mode 100644 index 069a758cc25..00000000000 --- a/plotly/validators/streamtube/colorbar/_bgcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='streamtube.colorbar', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_bordercolor.py b/plotly/validators/streamtube/colorbar/_bordercolor.py deleted file mode 100644 index 9f357561d2d..00000000000 --- a/plotly/validators/streamtube/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='streamtube.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_borderwidth.py b/plotly/validators/streamtube/colorbar/_borderwidth.py deleted file mode 100644 index 7ad42c92a70..00000000000 --- a/plotly/validators/streamtube/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='streamtube.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_dtick.py b/plotly/validators/streamtube/colorbar/_dtick.py deleted file mode 100644 index 63e4ce44f32..00000000000 --- a/plotly/validators/streamtube/colorbar/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='dtick', parent_name='streamtube.colorbar', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_exponentformat.py b/plotly/validators/streamtube/colorbar/_exponentformat.py deleted file mode 100644 index a18b2544d42..00000000000 --- a/plotly/validators/streamtube/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='streamtube.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_len.py b/plotly/validators/streamtube/colorbar/_len.py deleted file mode 100644 index 47a0ff30b2d..00000000000 --- a/plotly/validators/streamtube/colorbar/_len.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='len', parent_name='streamtube.colorbar', **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_lenmode.py b/plotly/validators/streamtube/colorbar/_lenmode.py deleted file mode 100644 index c622e4dd107..00000000000 --- a/plotly/validators/streamtube/colorbar/_lenmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='lenmode', - parent_name='streamtube.colorbar', - **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_nticks.py b/plotly/validators/streamtube/colorbar/_nticks.py deleted file mode 100644 index af2aa35a830..00000000000 --- a/plotly/validators/streamtube/colorbar/_nticks.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='nticks', - parent_name='streamtube.colorbar', - **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_outlinecolor.py b/plotly/validators/streamtube/colorbar/_outlinecolor.py deleted file mode 100644 index 9b2c59e5084..00000000000 --- a/plotly/validators/streamtube/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='streamtube.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_outlinewidth.py b/plotly/validators/streamtube/colorbar/_outlinewidth.py deleted file mode 100644 index 7e6776488ff..00000000000 --- a/plotly/validators/streamtube/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='streamtube.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_separatethousands.py b/plotly/validators/streamtube/colorbar/_separatethousands.py deleted file mode 100644 index 3807cb99238..00000000000 --- a/plotly/validators/streamtube/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='streamtube.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_showexponent.py b/plotly/validators/streamtube/colorbar/_showexponent.py deleted file mode 100644 index 880e49f8d5b..00000000000 --- a/plotly/validators/streamtube/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='streamtube.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_showticklabels.py b/plotly/validators/streamtube/colorbar/_showticklabels.py deleted file mode 100644 index d3a2823aa83..00000000000 --- a/plotly/validators/streamtube/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='streamtube.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_showtickprefix.py b/plotly/validators/streamtube/colorbar/_showtickprefix.py deleted file mode 100644 index 1e2ab27620d..00000000000 --- a/plotly/validators/streamtube/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='streamtube.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_showticksuffix.py b/plotly/validators/streamtube/colorbar/_showticksuffix.py deleted file mode 100644 index 6c7d3e1134e..00000000000 --- a/plotly/validators/streamtube/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='streamtube.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_thickness.py b/plotly/validators/streamtube/colorbar/_thickness.py deleted file mode 100644 index 06825aa719a..00000000000 --- a/plotly/validators/streamtube/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='streamtube.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_thicknessmode.py b/plotly/validators/streamtube/colorbar/_thicknessmode.py deleted file mode 100644 index f05954f7c51..00000000000 --- a/plotly/validators/streamtube/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='streamtube.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_tick0.py b/plotly/validators/streamtube/colorbar/_tick0.py deleted file mode 100644 index 782cbfd0756..00000000000 --- a/plotly/validators/streamtube/colorbar/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='tick0', parent_name='streamtube.colorbar', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_tickangle.py b/plotly/validators/streamtube/colorbar/_tickangle.py deleted file mode 100644 index bf60696a397..00000000000 --- a/plotly/validators/streamtube/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='streamtube.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_tickcolor.py b/plotly/validators/streamtube/colorbar/_tickcolor.py deleted file mode 100644 index 1c76a5281c6..00000000000 --- a/plotly/validators/streamtube/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='streamtube.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_tickfont.py b/plotly/validators/streamtube/colorbar/_tickfont.py deleted file mode 100644 index 0a199a2ff3e..00000000000 --- a/plotly/validators/streamtube/colorbar/_tickfont.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickfont', - parent_name='streamtube.colorbar', - **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_tickformat.py b/plotly/validators/streamtube/colorbar/_tickformat.py deleted file mode 100644 index 754fba78b8f..00000000000 --- a/plotly/validators/streamtube/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='streamtube.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_tickformatstopdefaults.py b/plotly/validators/streamtube/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index ea07d04922b..00000000000 --- a/plotly/validators/streamtube/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='streamtube.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_tickformatstops.py b/plotly/validators/streamtube/colorbar/_tickformatstops.py deleted file mode 100644 index b70caebb126..00000000000 --- a/plotly/validators/streamtube/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='streamtube.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_ticklen.py b/plotly/validators/streamtube/colorbar/_ticklen.py deleted file mode 100644 index 8e545027ff1..00000000000 --- a/plotly/validators/streamtube/colorbar/_ticklen.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ticklen', - parent_name='streamtube.colorbar', - **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_tickmode.py b/plotly/validators/streamtube/colorbar/_tickmode.py deleted file mode 100644 index 6df38ec192d..00000000000 --- a/plotly/validators/streamtube/colorbar/_tickmode.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='tickmode', - parent_name='streamtube.colorbar', - **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_tickprefix.py b/plotly/validators/streamtube/colorbar/_tickprefix.py deleted file mode 100644 index b16355caae1..00000000000 --- a/plotly/validators/streamtube/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='streamtube.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_ticks.py b/plotly/validators/streamtube/colorbar/_ticks.py deleted file mode 100644 index 764a25b772b..00000000000 --- a/plotly/validators/streamtube/colorbar/_ticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ticks', parent_name='streamtube.colorbar', **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_ticksuffix.py b/plotly/validators/streamtube/colorbar/_ticksuffix.py deleted file mode 100644 index 21435cd9611..00000000000 --- a/plotly/validators/streamtube/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='streamtube.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_ticktext.py b/plotly/validators/streamtube/colorbar/_ticktext.py deleted file mode 100644 index 43b51d76b7f..00000000000 --- a/plotly/validators/streamtube/colorbar/_ticktext.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='ticktext', - parent_name='streamtube.colorbar', - **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_ticktextsrc.py b/plotly/validators/streamtube/colorbar/_ticktextsrc.py deleted file mode 100644 index 039c45a6515..00000000000 --- a/plotly/validators/streamtube/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='streamtube.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_tickvals.py b/plotly/validators/streamtube/colorbar/_tickvals.py deleted file mode 100644 index 9fb4206b97e..00000000000 --- a/plotly/validators/streamtube/colorbar/_tickvals.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, - plotly_name='tickvals', - parent_name='streamtube.colorbar', - **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_tickvalssrc.py b/plotly/validators/streamtube/colorbar/_tickvalssrc.py deleted file mode 100644 index 14908f0d942..00000000000 --- a/plotly/validators/streamtube/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='streamtube.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_tickwidth.py b/plotly/validators/streamtube/colorbar/_tickwidth.py deleted file mode 100644 index 216bbddd38f..00000000000 --- a/plotly/validators/streamtube/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='streamtube.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_title.py b/plotly/validators/streamtube/colorbar/_title.py deleted file mode 100644 index 260498056ac..00000000000 --- a/plotly/validators/streamtube/colorbar/_title.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='streamtube.colorbar', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_x.py b/plotly/validators/streamtube/colorbar/_x.py deleted file mode 100644 index a9809637d6f..00000000000 --- a/plotly/validators/streamtube/colorbar/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='streamtube.colorbar', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_xanchor.py b/plotly/validators/streamtube/colorbar/_xanchor.py deleted file mode 100644 index 631b35b1d82..00000000000 --- a/plotly/validators/streamtube/colorbar/_xanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='xanchor', - parent_name='streamtube.colorbar', - **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_xpad.py b/plotly/validators/streamtube/colorbar/_xpad.py deleted file mode 100644 index 4c14b9addd8..00000000000 --- a/plotly/validators/streamtube/colorbar/_xpad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='xpad', parent_name='streamtube.colorbar', **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_y.py b/plotly/validators/streamtube/colorbar/_y.py deleted file mode 100644 index 16147b75809..00000000000 --- a/plotly/validators/streamtube/colorbar/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='streamtube.colorbar', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_yanchor.py b/plotly/validators/streamtube/colorbar/_yanchor.py deleted file mode 100644 index 03224940501..00000000000 --- a/plotly/validators/streamtube/colorbar/_yanchor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='yanchor', - parent_name='streamtube.colorbar', - **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/_ypad.py b/plotly/validators/streamtube/colorbar/_ypad.py deleted file mode 100644 index 65bbe464339..00000000000 --- a/plotly/validators/streamtube/colorbar/_ypad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ypad', parent_name='streamtube.colorbar', **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/tickfont/__init__.py b/plotly/validators/streamtube/colorbar/tickfont/__init__.py index 199d72e71c6..33ec62961e1 100644 --- a/plotly/validators/streamtube/colorbar/tickfont/__init__.py +++ b/plotly/validators/streamtube/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='streamtube.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='streamtube.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='streamtube.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/streamtube/colorbar/tickfont/_color.py b/plotly/validators/streamtube/colorbar/tickfont/_color.py deleted file mode 100644 index 78811ce4588..00000000000 --- a/plotly/validators/streamtube/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='streamtube.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/tickfont/_family.py b/plotly/validators/streamtube/colorbar/tickfont/_family.py deleted file mode 100644 index 7f5b5914934..00000000000 --- a/plotly/validators/streamtube/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='streamtube.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/tickfont/_size.py b/plotly/validators/streamtube/colorbar/tickfont/_size.py deleted file mode 100644 index c9798d7e663..00000000000 --- a/plotly/validators/streamtube/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='streamtube.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/tickformatstop/__init__.py b/plotly/validators/streamtube/colorbar/tickformatstop/__init__.py index 3f6c06cac47..11c3791a773 100644 --- a/plotly/validators/streamtube/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/streamtube/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='streamtube.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='streamtube.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='streamtube.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='streamtube.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='streamtube.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'colorbars' + }, { + 'valType': 'any', + 'editType': 'colorbars' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/streamtube/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/streamtube/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 7af2c05cb5f..00000000000 --- a/plotly/validators/streamtube/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='streamtube.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'colorbars' - }, { - 'valType': 'any', - 'editType': 'colorbars' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/tickformatstop/_enabled.py b/plotly/validators/streamtube/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index 940cf09c71d..00000000000 --- a/plotly/validators/streamtube/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='streamtube.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/tickformatstop/_name.py b/plotly/validators/streamtube/colorbar/tickformatstop/_name.py deleted file mode 100644 index 100240aaf8e..00000000000 --- a/plotly/validators/streamtube/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='streamtube.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/streamtube/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 0aead58d2b4..00000000000 --- a/plotly/validators/streamtube/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='streamtube.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/tickformatstop/_value.py b/plotly/validators/streamtube/colorbar/tickformatstop/_value.py deleted file mode 100644 index 5f332169f96..00000000000 --- a/plotly/validators/streamtube/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='streamtube.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/title/__init__.py b/plotly/validators/streamtube/colorbar/title/__init__.py index 33c9c145bb8..7f3a1d8dbd1 100644 --- a/plotly/validators/streamtube/colorbar/title/__init__.py +++ b/plotly/validators/streamtube/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='streamtube.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='streamtube.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='streamtube.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/streamtube/colorbar/title/_font.py b/plotly/validators/streamtube/colorbar/title/_font.py deleted file mode 100644 index 24ed611eafa..00000000000 --- a/plotly/validators/streamtube/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='streamtube.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/title/_side.py b/plotly/validators/streamtube/colorbar/title/_side.py deleted file mode 100644 index bcccf095aa5..00000000000 --- a/plotly/validators/streamtube/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='streamtube.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/title/_text.py b/plotly/validators/streamtube/colorbar/title/_text.py deleted file mode 100644 index 3782b1657d6..00000000000 --- a/plotly/validators/streamtube/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='streamtube.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/title/font/__init__.py b/plotly/validators/streamtube/colorbar/title/font/__init__.py index 199d72e71c6..a2bae3b3aac 100644 --- a/plotly/validators/streamtube/colorbar/title/font/__init__.py +++ b/plotly/validators/streamtube/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='streamtube.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='streamtube.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='streamtube.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'colorbars'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/streamtube/colorbar/title/font/_color.py b/plotly/validators/streamtube/colorbar/title/font/_color.py deleted file mode 100644 index 4ccc7811003..00000000000 --- a/plotly/validators/streamtube/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='streamtube.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/title/font/_family.py b/plotly/validators/streamtube/colorbar/title/font/_family.py deleted file mode 100644 index 98fca87f333..00000000000 --- a/plotly/validators/streamtube/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='streamtube.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/streamtube/colorbar/title/font/_size.py b/plotly/validators/streamtube/colorbar/title/font/_size.py deleted file mode 100644 index 5aa87a86f59..00000000000 --- a/plotly/validators/streamtube/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='streamtube.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'colorbars'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/hoverlabel/__init__.py b/plotly/validators/streamtube/hoverlabel/__init__.py index 856f769ba33..4263cd547eb 100644 --- a/plotly/validators/streamtube/hoverlabel/__init__.py +++ b/plotly/validators/streamtube/hoverlabel/__init__.py @@ -1,7 +1,176 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='streamtube.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='streamtube.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='streamtube.hoverlabel', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='streamtube.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='streamtube.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='streamtube.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='streamtube.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/streamtube/hoverlabel/_bgcolor.py b/plotly/validators/streamtube/hoverlabel/_bgcolor.py deleted file mode 100644 index a2d3f40240a..00000000000 --- a/plotly/validators/streamtube/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='streamtube.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/hoverlabel/_bgcolorsrc.py b/plotly/validators/streamtube/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index a5e7fce33bc..00000000000 --- a/plotly/validators/streamtube/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='streamtube.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/hoverlabel/_bordercolor.py b/plotly/validators/streamtube/hoverlabel/_bordercolor.py deleted file mode 100644 index 8891187437e..00000000000 --- a/plotly/validators/streamtube/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='streamtube.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/hoverlabel/_bordercolorsrc.py b/plotly/validators/streamtube/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 076e205c75f..00000000000 --- a/plotly/validators/streamtube/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='streamtube.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/hoverlabel/_font.py b/plotly/validators/streamtube/hoverlabel/_font.py deleted file mode 100644 index 5df588ef3db..00000000000 --- a/plotly/validators/streamtube/hoverlabel/_font.py +++ /dev/null @@ -1,50 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='streamtube.hoverlabel', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/streamtube/hoverlabel/_namelength.py b/plotly/validators/streamtube/hoverlabel/_namelength.py deleted file mode 100644 index 16e1f8b34eb..00000000000 --- a/plotly/validators/streamtube/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='streamtube.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/hoverlabel/_namelengthsrc.py b/plotly/validators/streamtube/hoverlabel/_namelengthsrc.py deleted file mode 100644 index d0054494140..00000000000 --- a/plotly/validators/streamtube/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='streamtube.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/hoverlabel/font/__init__.py b/plotly/validators/streamtube/hoverlabel/font/__init__.py index 1d2c591d1e5..02a841ff683 100644 --- a/plotly/validators/streamtube/hoverlabel/font/__init__.py +++ b/plotly/validators/streamtube/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='streamtube.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='streamtube.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='streamtube.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='streamtube.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='streamtube.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='streamtube.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/streamtube/hoverlabel/font/_color.py b/plotly/validators/streamtube/hoverlabel/font/_color.py deleted file mode 100644 index ce64d88ee07..00000000000 --- a/plotly/validators/streamtube/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='streamtube.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/hoverlabel/font/_colorsrc.py b/plotly/validators/streamtube/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 40e1f1acf6d..00000000000 --- a/plotly/validators/streamtube/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='streamtube.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/hoverlabel/font/_family.py b/plotly/validators/streamtube/hoverlabel/font/_family.py deleted file mode 100644 index 0040dd9102b..00000000000 --- a/plotly/validators/streamtube/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='streamtube.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/streamtube/hoverlabel/font/_familysrc.py b/plotly/validators/streamtube/hoverlabel/font/_familysrc.py deleted file mode 100644 index 1b08c72333f..00000000000 --- a/plotly/validators/streamtube/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='streamtube.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/hoverlabel/font/_size.py b/plotly/validators/streamtube/hoverlabel/font/_size.py deleted file mode 100644 index d679a2ff138..00000000000 --- a/plotly/validators/streamtube/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='streamtube.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/hoverlabel/font/_sizesrc.py b/plotly/validators/streamtube/hoverlabel/font/_sizesrc.py deleted file mode 100644 index 2ecb4efde9e..00000000000 --- a/plotly/validators/streamtube/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='streamtube.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/lighting/__init__.py b/plotly/validators/streamtube/lighting/__init__.py index 6abe696b0d7..7b31b9bf4a0 100644 --- a/plotly/validators/streamtube/lighting/__init__.py +++ b/plotly/validators/streamtube/lighting/__init__.py @@ -1,7 +1,158 @@ -from ._vertexnormalsepsilon import VertexnormalsepsilonValidator -from ._specular import SpecularValidator -from ._roughness import RoughnessValidator -from ._fresnel import FresnelValidator -from ._facenormalsepsilon import FacenormalsepsilonValidator -from ._diffuse import DiffuseValidator -from ._ambient import AmbientValidator + + +import _plotly_utils.basevalidators + + +class VertexnormalsepsilonValidator( + _plotly_utils.basevalidators.NumberValidator +): + + def __init__( + self, + plotly_name='vertexnormalsepsilon', + parent_name='streamtube.lighting', + **kwargs + ): + super(VertexnormalsepsilonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpecularValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='specular', + parent_name='streamtube.lighting', + **kwargs + ): + super(SpecularValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 2), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RoughnessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='roughness', + parent_name='streamtube.lighting', + **kwargs + ): + super(RoughnessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FresnelValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='fresnel', + parent_name='streamtube.lighting', + **kwargs + ): + super(FresnelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 5), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FacenormalsepsilonValidator( + _plotly_utils.basevalidators.NumberValidator +): + + def __init__( + self, + plotly_name='facenormalsepsilon', + parent_name='streamtube.lighting', + **kwargs + ): + super(FacenormalsepsilonValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DiffuseValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='diffuse', + parent_name='streamtube.lighting', + **kwargs + ): + super(DiffuseValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AmbientValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='ambient', + parent_name='streamtube.lighting', + **kwargs + ): + super(AmbientValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/streamtube/lighting/_ambient.py b/plotly/validators/streamtube/lighting/_ambient.py deleted file mode 100644 index d093718e278..00000000000 --- a/plotly/validators/streamtube/lighting/_ambient.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class AmbientValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='ambient', - parent_name='streamtube.lighting', - **kwargs - ): - super(AmbientValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/lighting/_diffuse.py b/plotly/validators/streamtube/lighting/_diffuse.py deleted file mode 100644 index 6ff9b131210..00000000000 --- a/plotly/validators/streamtube/lighting/_diffuse.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class DiffuseValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='diffuse', - parent_name='streamtube.lighting', - **kwargs - ): - super(DiffuseValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/lighting/_facenormalsepsilon.py b/plotly/validators/streamtube/lighting/_facenormalsepsilon.py deleted file mode 100644 index 1356b2c575f..00000000000 --- a/plotly/validators/streamtube/lighting/_facenormalsepsilon.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class FacenormalsepsilonValidator( - _plotly_utils.basevalidators.NumberValidator -): - - def __init__( - self, - plotly_name='facenormalsepsilon', - parent_name='streamtube.lighting', - **kwargs - ): - super(FacenormalsepsilonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/lighting/_fresnel.py b/plotly/validators/streamtube/lighting/_fresnel.py deleted file mode 100644 index c8bc156ae1d..00000000000 --- a/plotly/validators/streamtube/lighting/_fresnel.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FresnelValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='fresnel', - parent_name='streamtube.lighting', - **kwargs - ): - super(FresnelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 5), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/lighting/_roughness.py b/plotly/validators/streamtube/lighting/_roughness.py deleted file mode 100644 index d726d078653..00000000000 --- a/plotly/validators/streamtube/lighting/_roughness.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class RoughnessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='roughness', - parent_name='streamtube.lighting', - **kwargs - ): - super(RoughnessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/lighting/_specular.py b/plotly/validators/streamtube/lighting/_specular.py deleted file mode 100644 index ef4c3ae82b7..00000000000 --- a/plotly/validators/streamtube/lighting/_specular.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpecularValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='specular', - parent_name='streamtube.lighting', - **kwargs - ): - super(SpecularValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 2), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/lighting/_vertexnormalsepsilon.py b/plotly/validators/streamtube/lighting/_vertexnormalsepsilon.py deleted file mode 100644 index c8fa29cc134..00000000000 --- a/plotly/validators/streamtube/lighting/_vertexnormalsepsilon.py +++ /dev/null @@ -1,22 +0,0 @@ -import _plotly_utils.basevalidators - - -class VertexnormalsepsilonValidator( - _plotly_utils.basevalidators.NumberValidator -): - - def __init__( - self, - plotly_name='vertexnormalsepsilon', - parent_name='streamtube.lighting', - **kwargs - ): - super(VertexnormalsepsilonValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/lightposition/__init__.py b/plotly/validators/streamtube/lightposition/__init__.py index 438e2dc9c6d..516b2c8b656 100644 --- a/plotly/validators/streamtube/lightposition/__init__.py +++ b/plotly/validators/streamtube/lightposition/__init__.py @@ -1,3 +1,66 @@ -from ._z import ZValidator -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='z', + parent_name='streamtube.lightposition', + **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 100000), + min=kwargs.pop('min', -100000), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='y', + parent_name='streamtube.lightposition', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 100000), + min=kwargs.pop('min', -100000), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='x', + parent_name='streamtube.lightposition', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 100000), + min=kwargs.pop('min', -100000), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/streamtube/lightposition/_x.py b/plotly/validators/streamtube/lightposition/_x.py deleted file mode 100644 index 3bc8fe9e38e..00000000000 --- a/plotly/validators/streamtube/lightposition/_x.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='x', - parent_name='streamtube.lightposition', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 100000), - min=kwargs.pop('min', -100000), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/lightposition/_y.py b/plotly/validators/streamtube/lightposition/_y.py deleted file mode 100644 index b593d5e5a1e..00000000000 --- a/plotly/validators/streamtube/lightposition/_y.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='y', - parent_name='streamtube.lightposition', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 100000), - min=kwargs.pop('min', -100000), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/lightposition/_z.py b/plotly/validators/streamtube/lightposition/_z.py deleted file mode 100644 index 9edc21182b0..00000000000 --- a/plotly/validators/streamtube/lightposition/_z.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='z', - parent_name='streamtube.lightposition', - **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 100000), - min=kwargs.pop('min', -100000), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/streamtube/starts/__init__.py b/plotly/validators/streamtube/starts/__init__.py index ddf1c0a02fe..7eaef5309a4 100644 --- a/plotly/validators/streamtube/starts/__init__.py +++ b/plotly/validators/streamtube/starts/__init__.py @@ -1,6 +1,102 @@ -from ._zsrc import ZsrcValidator -from ._z import ZValidator -from ._ysrc import YsrcValidator -from ._y import YValidator -from ._xsrc import XsrcValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='zsrc', parent_name='streamtube.starts', **kwargs + ): + super(ZsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='z', parent_name='streamtube.starts', **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='ysrc', parent_name='streamtube.starts', **kwargs + ): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='y', parent_name='streamtube.starts', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='xsrc', parent_name='streamtube.starts', **kwargs + ): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='x', parent_name='streamtube.starts', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) diff --git a/plotly/validators/streamtube/starts/_x.py b/plotly/validators/streamtube/starts/_x.py deleted file mode 100644 index 28231ebeefb..00000000000 --- a/plotly/validators/streamtube/starts/_x.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='x', parent_name='streamtube.starts', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/streamtube/starts/_xsrc.py b/plotly/validators/streamtube/starts/_xsrc.py deleted file mode 100644 index 5e4918b796b..00000000000 --- a/plotly/validators/streamtube/starts/_xsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='xsrc', parent_name='streamtube.starts', **kwargs - ): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/starts/_y.py b/plotly/validators/streamtube/starts/_y.py deleted file mode 100644 index 4cb40354c93..00000000000 --- a/plotly/validators/streamtube/starts/_y.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='y', parent_name='streamtube.starts', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/streamtube/starts/_ysrc.py b/plotly/validators/streamtube/starts/_ysrc.py deleted file mode 100644 index 85f911c5f54..00000000000 --- a/plotly/validators/streamtube/starts/_ysrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='ysrc', parent_name='streamtube.starts', **kwargs - ): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/starts/_z.py b/plotly/validators/streamtube/starts/_z.py deleted file mode 100644 index 7695dda282a..00000000000 --- a/plotly/validators/streamtube/starts/_z.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='z', parent_name='streamtube.starts', **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/streamtube/starts/_zsrc.py b/plotly/validators/streamtube/starts/_zsrc.py deleted file mode 100644 index 196a23ee7e6..00000000000 --- a/plotly/validators/streamtube/starts/_zsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='zsrc', parent_name='streamtube.starts', **kwargs - ): - super(ZsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/stream/__init__.py b/plotly/validators/streamtube/stream/__init__.py index 2f4f2047594..52b6e47bcb1 100644 --- a/plotly/validators/streamtube/stream/__init__.py +++ b/plotly/validators/streamtube/stream/__init__.py @@ -1,2 +1,41 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='streamtube.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='maxpoints', + parent_name='streamtube.stream', + **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/streamtube/stream/_maxpoints.py b/plotly/validators/streamtube/stream/_maxpoints.py deleted file mode 100644 index 4b213064116..00000000000 --- a/plotly/validators/streamtube/stream/_maxpoints.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='maxpoints', - parent_name='streamtube.stream', - **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/streamtube/stream/_token.py b/plotly/validators/streamtube/stream/_token.py deleted file mode 100644 index b63d42dc2e0..00000000000 --- a/plotly/validators/streamtube/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='streamtube.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/surface/__init__.py b/plotly/validators/surface/__init__.py index 819ea556706..da94e2f017e 100644 --- a/plotly/validators/surface/__init__.py +++ b/plotly/validators/surface/__init__.py @@ -1,47 +1,1100 @@ -from ._zsrc import ZsrcValidator -from ._zcalendar import ZcalendarValidator -from ._z import ZValidator -from ._ysrc import YsrcValidator -from ._ycalendar import YcalendarValidator -from ._y import YValidator -from ._xsrc import XsrcValidator -from ._xcalendar import XcalendarValidator -from ._x import XValidator -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._surfacecolorsrc import SurfacecolorsrcValidator -from ._surfacecolor import SurfacecolorValidator -from ._stream import StreamValidator -from ._showscale import ShowscaleValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._scene import SceneValidator -from ._reversescale import ReversescaleValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._lightposition import LightpositionValidator -from ._lighting import LightingValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hovertemplatesrc import HovertemplatesrcValidator -from ._hovertemplate import HovertemplateValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._hidesurface import HidesurfaceValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._contours import ContoursValidator -from ._colorscale import ColorscaleValidator -from ._colorbar import ColorBarValidator -from ._cmin import CminValidator -from ._cmid import CmidValidator -from ._cmax import CmaxValidator -from ._cauto import CautoValidator -from ._autocolorscale import AutocolorscaleValidator + + +import _plotly_utils.basevalidators + + +class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='zsrc', parent_name='surface', **kwargs): + super(ZsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='zcalendar', parent_name='surface', **kwargs + ): + super(ZcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='z', parent_name='surface', **kwargs): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='surface', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ycalendar', parent_name='surface', **kwargs + ): + super(YcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='surface', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='surface', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xcalendar', parent_name='surface', **kwargs + ): + super(XcalendarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop( + 'values', [ + 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', + 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', + 'nepali', 'persian', 'jalali', 'taiwan', 'thai', + 'ummalqura' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='surface', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='surface', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='surface', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='surface', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='textsrc', parent_name='surface', **kwargs): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='surface', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SurfacecolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='surfacecolorsrc', parent_name='surface', **kwargs + ): + super(SurfacecolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SurfacecolorValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='surfacecolor', parent_name='surface', **kwargs + ): + super(SurfacecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='surface', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showscale', parent_name='surface', **kwargs + ): + super(ShowscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='surface', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='surface', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SceneValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='scene', parent_name='surface', **kwargs): + super(SceneValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'scene'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='reversescale', parent_name='surface', **kwargs + ): + super(ReversescaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='opacity', parent_name='surface', **kwargs): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='surface', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LightpositionValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='lightposition', parent_name='surface', **kwargs + ): + super(LightpositionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Lightposition'), + data_docs=kwargs.pop( + 'data_docs', """ + x + Numeric vector, representing the X coordinate + for each vertex. + y + Numeric vector, representing the Y coordinate + for each vertex. + z + Numeric vector, representing the Z coordinate + for each vertex. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LightingValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='lighting', parent_name='surface', **kwargs + ): + super(LightingValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Lighting'), + data_docs=kwargs.pop( + 'data_docs', """ + ambient + Ambient light increases overall color + visibility but can wash out the image. + diffuse + Represents the extent that incident rays are + reflected in a range of angles. + fresnel + Represents the reflectance as a dependency of + the viewing angle; e.g. paper is reflective + when viewing it from the edge of the paper + (almost 90 degrees), causing shine. + roughness + Alters specular reflection; the rougher the + surface, the wider and less contrasty the + shine. + specular + Represents the level that incident rays are + reflected in a single direction, causing shine. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='surface', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='surface', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='surface', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='surface', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='surface', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertemplatesrc', parent_name='surface', **kwargs + ): + super(HovertemplatesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertemplate', parent_name='surface', **kwargs + ): + super(HovertemplateValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='surface', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='surface', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='surface', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HidesurfaceValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='hidesurface', parent_name='surface', **kwargs + ): + super(HidesurfaceValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='surface', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='surface', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ContoursValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='contours', parent_name='surface', **kwargs + ): + super(ContoursValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Contours'), + data_docs=kwargs.pop( + 'data_docs', """ + x + plotly.graph_objs.surface.contours.X instance + or dict with compatible properties + y + plotly.graph_objs.surface.contours.Y instance + or dict with compatible properties + z + plotly.graph_objs.surface.contours.Z instance + or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): + + def __init__( + self, plotly_name='colorscale', parent_name='surface', **kwargs + ): + super(ColorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop( + 'implied_edits', {'autocolorscale': False} + ), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='colorbar', parent_name='surface', **kwargs + ): + super(ColorBarValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'ColorBar'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing + this color bar. + dtick + Sets the step in-between ticks on this axis. + Use with `tick0`. Must be a positive number, or + special strings available to "log" and "date" + axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick + number. For example, to set a tick mark at 1, + 10, 100, 1000, ... set dtick to 1. To set tick + marks at 1, 100, 10000, ... set dtick to 2. To + set tick marks at 1, 5, 25, 125, 625, 3125, ... + set dtick to log_10(5), or 0.69897000433. "log" + has several special values; "L", where `f` + is a positive number, gives ticks linearly + spaced in value (but not position). For example + `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 + plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is + ignored for "D1" and "D2". If the axis `type` + is "date", then you must convert the time to + milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to + 86400000.0. "date" also has special values + "M" gives ticks spaced by a number of + months. `n` must be a positive integer. To set + ticks on the 15th of every third month, set + `tick0` to "2000-01-15" and `dtick` to "M3". To + set ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick + exponents. For example, consider the number + 1,000,000,000. If "none", it appears as + 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If + "SI", 1G. If "B", 1B. + len + Sets the length of the color bar This measure + excludes the padding of both ends. That is, the + color bar length is this length minus the + padding on both ends. + lenmode + Determines whether this color bar's length + (i.e. the measure in the color variation + direction) is set in units of plot "fraction" + or in *pixels. Use `len` to set the value. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks + will be chosen automatically to be less than or + equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of + the first tick is shown. If "last", only the + exponent of the last tick is shown. If "none", + no exponents appear. + showticklabels + Determines whether or not the tick labels are + drawn. + showtickprefix + If "all", all tick labels are displayed with a + prefix. If "first", only the first tick is + displayed with a prefix. If "last", only the + last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This + measure excludes the size of the padding, ticks + and labels. + thicknessmode + Determines whether this color bar's thickness + (i.e. the measure in the constant color + direction) is set in units of plot "fraction" + or in "pixels". Use `thickness` to set the + value. + tick0 + Sets the placement of the first tick on this + axis. Use with `dtick`. If the axis `type` is + "log", then you must take the log of your + starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when + `dtick`=*L* (see `dtick` for more info). If + the axis `type` is "date", it should be a date + string, like date data. If the axis `type` is + "category", it should be a number, using the + scale where each category is assigned a serial + number from zero in the order it appears. + tickangle + Sets the angle of the tick labels with respect + to the horizontal. For example, a `tickangle` + of -90 draws the tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 + formatting mini-languages which are very + similar to those in Python. For numbers, see: h + ttps://github.com/d3/d3-format/blob/master/READ + ME.md#locale_format And for dates see: + https://github.com/d3/d3-time- + format/blob/master/README.md#locale_format We + add one item to d3's date formatter: "%{n}f" + for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with + tickformat "%H~%M~%S.%2f" would display + "09~15~23.46" + tickformatstops + plotly.graph_objs.surface.colorbar.Tickformatst + op instance or dict with compatible properties + tickformatstopdefaults + When used in a template (as layout.template.dat + a.surface.colorbar.tickformatstopdefaults), + sets the default property values to use for + elements of surface.colorbar.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", + the number of ticks is set via `nticks`. If + "linear", the placement of the ticks is + determined by a starting position `tick0` and a + tick step `dtick` ("linear" is the default + value if `tick0` and `dtick` are provided). If + "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. + ("array" is the default value if `tickvals` is + provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If + "", this axis' ticks are not drawn. If + "outside" ("inside"), this axis' are drawn + outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position + via `tickvals`. Only has an effect if + `tickmode` is set to "array". Used with + `tickvals`. + ticktextsrc + Sets the source reference on plot.ly for + ticktext . + tickvals + Sets the values at which ticks on this axis + appear. Only has an effect if `tickmode` is set + to "array". Used with `ticktext`. + tickvalssrc + Sets the source reference on plot.ly for + tickvals . + tickwidth + Sets the tick width (in px). + title + plotly.graph_objs.surface.colorbar.Title + instance or dict with compatible properties + titlefont + Deprecated: Please use + surface.colorbar.title.font instead. Sets this + color bar's title font. Note that the title's + font used to be set by the now deprecated + `titlefont` attribute. + titleside + Deprecated: Please use + surface.colorbar.title.side instead. Determines + the location of color bar's title with respect + to the color bar. Note that the title's + location used to be set by the now deprecated + `titleside` attribute. + x + Sets the x position of the color bar (in plot + fraction). + xanchor + Sets this color bar's horizontal position + anchor. This anchor binds the `x` position to + the "left", "center" or "right" of the color + bar. + xpad + Sets the amount of padding (in px) along the x + direction. + y + Sets the y position of the color bar (in plot + fraction). + yanchor + Sets this color bar's vertical position anchor + This anchor binds the `y` position to the + "top", "middle" or "bottom" of the color bar. + ypad + Sets the amount of padding (in px) along the y + direction. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CminValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmin', parent_name='surface', **kwargs): + super(CminValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmidValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmid', parent_name='surface', **kwargs): + super(CmidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='cmax', parent_name='surface', **kwargs): + super(CmaxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'cauto': False}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__(self, plotly_name='cauto', parent_name='surface', **kwargs): + super(CautoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='autocolorscale', parent_name='surface', **kwargs + ): + super(AutocolorscaleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/surface/_autocolorscale.py b/plotly/validators/surface/_autocolorscale.py deleted file mode 100644 index b86161e4f84..00000000000 --- a/plotly/validators/surface/_autocolorscale.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class AutocolorscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='autocolorscale', parent_name='surface', **kwargs - ): - super(AutocolorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/_cauto.py b/plotly/validators/surface/_cauto.py deleted file mode 100644 index 4c152ae9009..00000000000 --- a/plotly/validators/surface/_cauto.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CautoValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__(self, plotly_name='cauto', parent_name='surface', **kwargs): - super(CautoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_cmax.py b/plotly/validators/surface/_cmax.py deleted file mode 100644 index dd143da4b62..00000000000 --- a/plotly/validators/surface/_cmax.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmaxValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmax', parent_name='surface', **kwargs): - super(CmaxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_cmid.py b/plotly/validators/surface/_cmid.py deleted file mode 100644 index 5d042b8589d..00000000000 --- a/plotly/validators/surface/_cmid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CmidValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmid', parent_name='surface', **kwargs): - super(CmidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_cmin.py b/plotly/validators/surface/_cmin.py deleted file mode 100644 index 79edd422459..00000000000 --- a/plotly/validators/surface/_cmin.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class CminValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='cmin', parent_name='surface', **kwargs): - super(CminValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'cauto': False}), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_colorbar.py b/plotly/validators/surface/_colorbar.py deleted file mode 100644 index 0607895e71d..00000000000 --- a/plotly/validators/surface/_colorbar.py +++ /dev/null @@ -1,226 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorBarValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='colorbar', parent_name='surface', **kwargs - ): - super(ColorBarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'ColorBar'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the color of padded area. - bordercolor - Sets the axis line color. - borderwidth - Sets the width (in px) or the border enclosing - this color bar. - dtick - Sets the step in-between ticks on this axis. - Use with `tick0`. Must be a positive number, or - special strings available to "log" and "date" - axes. If the axis `type` is "log", then ticks - are set every 10^(n*dtick) where n is the tick - number. For example, to set a tick mark at 1, - 10, 100, 1000, ... set dtick to 1. To set tick - marks at 1, 100, 10000, ... set dtick to 2. To - set tick marks at 1, 5, 25, 125, 625, 3125, ... - set dtick to log_10(5), or 0.69897000433. "log" - has several special values; "L", where `f` - is a positive number, gives ticks linearly - spaced in value (but not position). For example - `tick0` = 0.1, `dtick` = "L0.5" will put ticks - at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 - plus small digits between, use "D1" (all - digits) or "D2" (only 2 and 5). `tick0` is - ignored for "D1" and "D2". If the axis `type` - is "date", then you must convert the time to - milliseconds. For example, to set the interval - between ticks to one day, set `dtick` to - 86400000.0. "date" also has special values - "M" gives ticks spaced by a number of - months. `n` must be a positive integer. To set - ticks on the 15th of every third month, set - `tick0` to "2000-01-15" and `dtick` to "M3". To - set ticks every 4 years, set `dtick` to "M48" - exponentformat - Determines a formatting rule for the tick - exponents. For example, consider the number - 1,000,000,000. If "none", it appears as - 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If - "power", 1x10^9 (with 9 in a super script). If - "SI", 1G. If "B", 1B. - len - Sets the length of the color bar This measure - excludes the padding of both ends. That is, the - color bar length is this length minus the - padding on both ends. - lenmode - Determines whether this color bar's length - (i.e. the measure in the color variation - direction) is set in units of plot "fraction" - or in *pixels. Use `len` to set the value. - nticks - Specifies the maximum number of ticks for the - particular axis. The actual number of ticks - will be chosen automatically to be less than or - equal to `nticks`. Has an effect only if - `tickmode` is set to "auto". - outlinecolor - Sets the axis line color. - outlinewidth - Sets the width (in px) of the axis line. - separatethousands - If "true", even 4-digit integers are separated - showexponent - If "all", all exponents are shown besides their - significands. If "first", only the exponent of - the first tick is shown. If "last", only the - exponent of the last tick is shown. If "none", - no exponents appear. - showticklabels - Determines whether or not the tick labels are - drawn. - showtickprefix - If "all", all tick labels are displayed with a - prefix. If "first", only the first tick is - displayed with a prefix. If "last", only the - last tick is displayed with a suffix. If - "none", tick prefixes are hidden. - showticksuffix - Same as `showtickprefix` but for tick suffixes. - thickness - Sets the thickness of the color bar This - measure excludes the size of the padding, ticks - and labels. - thicknessmode - Determines whether this color bar's thickness - (i.e. the measure in the constant color - direction) is set in units of plot "fraction" - or in "pixels". Use `thickness` to set the - value. - tick0 - Sets the placement of the first tick on this - axis. Use with `dtick`. If the axis `type` is - "log", then you must take the log of your - starting tick (e.g. to set the starting tick to - 100, set the `tick0` to 2) except when - `dtick`=*L* (see `dtick` for more info). If - the axis `type` is "date", it should be a date - string, like date data. If the axis `type` is - "category", it should be a number, using the - scale where each category is assigned a serial - number from zero in the order it appears. - tickangle - Sets the angle of the tick labels with respect - to the horizontal. For example, a `tickangle` - of -90 draws the tick labels vertically. - tickcolor - Sets the tick color. - tickfont - Sets the color bar's tick label font - tickformat - Sets the tick label formatting rule using d3 - formatting mini-languages which are very - similar to those in Python. For numbers, see: h - ttps://github.com/d3/d3-format/blob/master/READ - ME.md#locale_format And for dates see: - https://github.com/d3/d3-time- - format/blob/master/README.md#locale_format We - add one item to d3's date formatter: "%{n}f" - for fractional seconds with n digits. For - example, *2016-10-13 09:15:23.456* with - tickformat "%H~%M~%S.%2f" would display - "09~15~23.46" - tickformatstops - plotly.graph_objs.surface.colorbar.Tickformatst - op instance or dict with compatible properties - tickformatstopdefaults - When used in a template (as layout.template.dat - a.surface.colorbar.tickformatstopdefaults), - sets the default property values to use for - elements of surface.colorbar.tickformatstops - ticklen - Sets the tick length (in px). - tickmode - Sets the tick mode for this axis. If "auto", - the number of ticks is set via `nticks`. If - "linear", the placement of the ticks is - determined by a starting position `tick0` and a - tick step `dtick` ("linear" is the default - value if `tick0` and `dtick` are provided). If - "array", the placement of the ticks is set via - `tickvals` and the tick text is `ticktext`. - ("array" is the default value if `tickvals` is - provided). - tickprefix - Sets a tick label prefix. - ticks - Determines whether ticks are drawn or not. If - "", this axis' ticks are not drawn. If - "outside" ("inside"), this axis' are drawn - outside (inside) the axis lines. - ticksuffix - Sets a tick label suffix. - ticktext - Sets the text displayed at the ticks position - via `tickvals`. Only has an effect if - `tickmode` is set to "array". Used with - `tickvals`. - ticktextsrc - Sets the source reference on plot.ly for - ticktext . - tickvals - Sets the values at which ticks on this axis - appear. Only has an effect if `tickmode` is set - to "array". Used with `ticktext`. - tickvalssrc - Sets the source reference on plot.ly for - tickvals . - tickwidth - Sets the tick width (in px). - title - plotly.graph_objs.surface.colorbar.Title - instance or dict with compatible properties - titlefont - Deprecated: Please use - surface.colorbar.title.font instead. Sets this - color bar's title font. Note that the title's - font used to be set by the now deprecated - `titlefont` attribute. - titleside - Deprecated: Please use - surface.colorbar.title.side instead. Determines - the location of color bar's title with respect - to the color bar. Note that the title's - location used to be set by the now deprecated - `titleside` attribute. - x - Sets the x position of the color bar (in plot - fraction). - xanchor - Sets this color bar's horizontal position - anchor. This anchor binds the `x` position to - the "left", "center" or "right" of the color - bar. - xpad - Sets the amount of padding (in px) along the x - direction. - y - Sets the y position of the color bar (in plot - fraction). - yanchor - Sets this color bar's vertical position anchor - This anchor binds the `y` position to the - "top", "middle" or "bottom" of the color bar. - ypad - Sets the amount of padding (in px) along the y - direction. -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/_colorscale.py b/plotly/validators/surface/_colorscale.py deleted file mode 100644 index c23ce801db2..00000000000 --- a/plotly/validators/surface/_colorscale.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorscaleValidator(_plotly_utils.basevalidators.ColorscaleValidator): - - def __init__( - self, plotly_name='colorscale', parent_name='surface', **kwargs - ): - super(ColorscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop( - 'implied_edits', {'autocolorscale': False} - ), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/_contours.py b/plotly/validators/surface/_contours.py deleted file mode 100644 index 5bf87a043b6..00000000000 --- a/plotly/validators/surface/_contours.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class ContoursValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='contours', parent_name='surface', **kwargs - ): - super(ContoursValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Contours'), - data_docs=kwargs.pop( - 'data_docs', """ - x - plotly.graph_objs.surface.contours.X instance - or dict with compatible properties - y - plotly.graph_objs.surface.contours.Y instance - or dict with compatible properties - z - plotly.graph_objs.surface.contours.Z instance - or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/_customdata.py b/plotly/validators/surface/_customdata.py deleted file mode 100644 index 85aa6d1590d..00000000000 --- a/plotly/validators/surface/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='surface', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/surface/_customdatasrc.py b/plotly/validators/surface/_customdatasrc.py deleted file mode 100644 index 4abdfc639ba..00000000000 --- a/plotly/validators/surface/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='surface', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_hidesurface.py b/plotly/validators/surface/_hidesurface.py deleted file mode 100644 index 46dd35b5525..00000000000 --- a/plotly/validators/surface/_hidesurface.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HidesurfaceValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='hidesurface', parent_name='surface', **kwargs - ): - super(HidesurfaceValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_hoverinfo.py b/plotly/validators/surface/_hoverinfo.py deleted file mode 100644 index 00adf2930c9..00000000000 --- a/plotly/validators/surface/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='surface', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_hoverinfosrc.py b/plotly/validators/surface/_hoverinfosrc.py deleted file mode 100644 index 498af6fcb00..00000000000 --- a/plotly/validators/surface/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='surface', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_hoverlabel.py b/plotly/validators/surface/_hoverlabel.py deleted file mode 100644 index 117f2710045..00000000000 --- a/plotly/validators/surface/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='surface', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/_hovertemplate.py b/plotly/validators/surface/_hovertemplate.py deleted file mode 100644 index 31f20642d73..00000000000 --- a/plotly/validators/surface/_hovertemplate.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplateValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertemplate', parent_name='surface', **kwargs - ): - super(HovertemplateValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_hovertemplatesrc.py b/plotly/validators/surface/_hovertemplatesrc.py deleted file mode 100644 index d58bcf56d8e..00000000000 --- a/plotly/validators/surface/_hovertemplatesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertemplatesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertemplatesrc', parent_name='surface', **kwargs - ): - super(HovertemplatesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_hovertext.py b/plotly/validators/surface/_hovertext.py deleted file mode 100644 index a68d4eee1ed..00000000000 --- a/plotly/validators/surface/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='surface', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_hovertextsrc.py b/plotly/validators/surface/_hovertextsrc.py deleted file mode 100644 index bcb46a71546..00000000000 --- a/plotly/validators/surface/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='surface', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_ids.py b/plotly/validators/surface/_ids.py deleted file mode 100644 index 8f33900eebc..00000000000 --- a/plotly/validators/surface/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='surface', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/surface/_idssrc.py b/plotly/validators/surface/_idssrc.py deleted file mode 100644 index 88a5acc5a17..00000000000 --- a/plotly/validators/surface/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='surface', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_legendgroup.py b/plotly/validators/surface/_legendgroup.py deleted file mode 100644 index 09ad617d084..00000000000 --- a/plotly/validators/surface/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='surface', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_lighting.py b/plotly/validators/surface/_lighting.py deleted file mode 100644 index c1a4b2d7bda..00000000000 --- a/plotly/validators/surface/_lighting.py +++ /dev/null @@ -1,36 +0,0 @@ -import _plotly_utils.basevalidators - - -class LightingValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='lighting', parent_name='surface', **kwargs - ): - super(LightingValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Lighting'), - data_docs=kwargs.pop( - 'data_docs', """ - ambient - Ambient light increases overall color - visibility but can wash out the image. - diffuse - Represents the extent that incident rays are - reflected in a range of angles. - fresnel - Represents the reflectance as a dependency of - the viewing angle; e.g. paper is reflective - when viewing it from the edge of the paper - (almost 90 degrees), causing shine. - roughness - Alters specular reflection; the rougher the - surface, the wider and less contrasty the - shine. - specular - Represents the level that incident rays are - reflected in a single direction, causing shine. -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/_lightposition.py b/plotly/validators/surface/_lightposition.py deleted file mode 100644 index ed04004cce2..00000000000 --- a/plotly/validators/surface/_lightposition.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class LightpositionValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='lightposition', parent_name='surface', **kwargs - ): - super(LightpositionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Lightposition'), - data_docs=kwargs.pop( - 'data_docs', """ - x - Numeric vector, representing the X coordinate - for each vertex. - y - Numeric vector, representing the Y coordinate - for each vertex. - z - Numeric vector, representing the Z coordinate - for each vertex. -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/_name.py b/plotly/validators/surface/_name.py deleted file mode 100644 index 96f90dc0519..00000000000 --- a/plotly/validators/surface/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='surface', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_opacity.py b/plotly/validators/surface/_opacity.py deleted file mode 100644 index a320db5627d..00000000000 --- a/plotly/validators/surface/_opacity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='opacity', parent_name='surface', **kwargs): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/_reversescale.py b/plotly/validators/surface/_reversescale.py deleted file mode 100644 index e7902df5145..00000000000 --- a/plotly/validators/surface/_reversescale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ReversescaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='reversescale', parent_name='surface', **kwargs - ): - super(ReversescaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/_scene.py b/plotly/validators/surface/_scene.py deleted file mode 100644 index b18adb5ce99..00000000000 --- a/plotly/validators/surface/_scene.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class SceneValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='scene', parent_name='surface', **kwargs): - super(SceneValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'scene'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_selectedpoints.py b/plotly/validators/surface/_selectedpoints.py deleted file mode 100644 index 138d050303d..00000000000 --- a/plotly/validators/surface/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='surface', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_showlegend.py b/plotly/validators/surface/_showlegend.py deleted file mode 100644 index 128dc98ada9..00000000000 --- a/plotly/validators/surface/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='surface', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_showscale.py b/plotly/validators/surface/_showscale.py deleted file mode 100644 index 88932537280..00000000000 --- a/plotly/validators/surface/_showscale.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowscaleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showscale', parent_name='surface', **kwargs - ): - super(ShowscaleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_stream.py b/plotly/validators/surface/_stream.py deleted file mode 100644 index 8a18849a2e5..00000000000 --- a/plotly/validators/surface/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='surface', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/_surfacecolor.py b/plotly/validators/surface/_surfacecolor.py deleted file mode 100644 index 95cd412aaaf..00000000000 --- a/plotly/validators/surface/_surfacecolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SurfacecolorValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='surfacecolor', parent_name='surface', **kwargs - ): - super(SurfacecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/surface/_surfacecolorsrc.py b/plotly/validators/surface/_surfacecolorsrc.py deleted file mode 100644 index 9da2b6f619d..00000000000 --- a/plotly/validators/surface/_surfacecolorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SurfacecolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='surfacecolorsrc', parent_name='surface', **kwargs - ): - super(SurfacecolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_text.py b/plotly/validators/surface/_text.py deleted file mode 100644 index 1d58a44d5d3..00000000000 --- a/plotly/validators/surface/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='surface', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_textsrc.py b/plotly/validators/surface/_textsrc.py deleted file mode 100644 index ab3b4d672f4..00000000000 --- a/plotly/validators/surface/_textsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='textsrc', parent_name='surface', **kwargs): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_uid.py b/plotly/validators/surface/_uid.py deleted file mode 100644 index 03263e5e4c4..00000000000 --- a/plotly/validators/surface/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='surface', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_uirevision.py b/plotly/validators/surface/_uirevision.py deleted file mode 100644 index d361560ecbe..00000000000 --- a/plotly/validators/surface/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='surface', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_visible.py b/plotly/validators/surface/_visible.py deleted file mode 100644 index 0104070c8df..00000000000 --- a/plotly/validators/surface/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='surface', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/surface/_x.py b/plotly/validators/surface/_x.py deleted file mode 100644 index 49b0fdbde25..00000000000 --- a/plotly/validators/surface/_x.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='surface', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/surface/_xcalendar.py b/plotly/validators/surface/_xcalendar.py deleted file mode 100644 index 9cfd3cb09b5..00000000000 --- a/plotly/validators/surface/_xcalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class XcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xcalendar', parent_name='surface', **kwargs - ): - super(XcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/surface/_xsrc.py b/plotly/validators/surface/_xsrc.py deleted file mode 100644 index b2f41dc688a..00000000000 --- a/plotly/validators/surface/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='surface', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_y.py b/plotly/validators/surface/_y.py deleted file mode 100644 index dd2ecce5795..00000000000 --- a/plotly/validators/surface/_y.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='surface', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/surface/_ycalendar.py b/plotly/validators/surface/_ycalendar.py deleted file mode 100644 index 915731321c1..00000000000 --- a/plotly/validators/surface/_ycalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class YcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ycalendar', parent_name='surface', **kwargs - ): - super(YcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/surface/_ysrc.py b/plotly/validators/surface/_ysrc.py deleted file mode 100644 index ae1fa31e99d..00000000000 --- a/plotly/validators/surface/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='surface', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/_z.py b/plotly/validators/surface/_z.py deleted file mode 100644 index c629a65cc8e..00000000000 --- a/plotly/validators/surface/_z.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='z', parent_name='surface', **kwargs): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/surface/_zcalendar.py b/plotly/validators/surface/_zcalendar.py deleted file mode 100644 index 899f7db376e..00000000000 --- a/plotly/validators/surface/_zcalendar.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZcalendarValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='zcalendar', parent_name='surface', **kwargs - ): - super(ZcalendarValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop( - 'values', [ - 'gregorian', 'chinese', 'coptic', 'discworld', 'ethiopian', - 'hebrew', 'islamic', 'julian', 'mayan', 'nanakshahi', - 'nepali', 'persian', 'jalali', 'taiwan', 'thai', - 'ummalqura' - ] - ), - **kwargs - ) diff --git a/plotly/validators/surface/_zsrc.py b/plotly/validators/surface/_zsrc.py deleted file mode 100644 index 5e16dc35ac0..00000000000 --- a/plotly/validators/surface/_zsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='zsrc', parent_name='surface', **kwargs): - super(ZsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/__init__.py b/plotly/validators/surface/colorbar/__init__.py index 3dab31f7e02..0e45bfbf72c 100644 --- a/plotly/validators/surface/colorbar/__init__.py +++ b/plotly/validators/surface/colorbar/__init__.py @@ -1,41 +1,879 @@ -from ._ypad import YpadValidator -from ._yanchor import YanchorValidator -from ._y import YValidator -from ._xpad import XpadValidator -from ._xanchor import XanchorValidator -from ._x import XValidator -from ._title import TitleValidator -from ._tickwidth import TickwidthValidator -from ._tickvalssrc import TickvalssrcValidator -from ._tickvals import TickvalsValidator -from ._ticktextsrc import TicktextsrcValidator -from ._ticktext import TicktextValidator -from ._ticksuffix import TicksuffixValidator -from ._ticks import TicksValidator -from ._tickprefix import TickprefixValidator -from ._tickmode import TickmodeValidator -from ._ticklen import TicklenValidator -from ._tickformatstopdefaults import TickformatstopValidator -from ._tickformatstops import TickformatstopsValidator -from ._tickformat import TickformatValidator -from ._tickfont import TickfontValidator -from ._tickcolor import TickcolorValidator -from ._tickangle import TickangleValidator -from ._tick0 import Tick0Validator -from ._thicknessmode import ThicknessmodeValidator -from ._thickness import ThicknessValidator -from ._showticksuffix import ShowticksuffixValidator -from ._showtickprefix import ShowtickprefixValidator -from ._showticklabels import ShowticklabelsValidator -from ._showexponent import ShowexponentValidator -from ._separatethousands import SeparatethousandsValidator -from ._outlinewidth import OutlinewidthValidator -from ._outlinecolor import OutlinecolorValidator -from ._nticks import NticksValidator -from ._lenmode import LenmodeValidator -from ._len import LenValidator -from ._exponentformat import ExponentformatValidator -from ._dtick import DtickValidator -from ._borderwidth import BorderwidthValidator -from ._bordercolor import BordercolorValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class YpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ypad', parent_name='surface.colorbar', **kwargs + ): + super(YpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='yanchor', parent_name='surface.colorbar', **kwargs + ): + super(YanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['top', 'middle', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='surface.colorbar', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XpadValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='xpad', parent_name='surface.colorbar', **kwargs + ): + super(XpadValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='xanchor', parent_name='surface.colorbar', **kwargs + ): + super(XanchorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='surface.colorbar', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 3), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TitleValidator(_plotly_utils.basevalidators.TitleValidator): + + def __init__( + self, plotly_name='title', parent_name='surface.colorbar', **kwargs + ): + super(TitleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Title'), + data_docs=kwargs.pop( + 'data_docs', """ + font + Sets this color bar's title font. Note that the + title's font used to be set by the now + deprecated `titlefont` attribute. + side + 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. + text + 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='tickwidth', + parent_name='surface.colorbar', + **kwargs + ): + super(TickwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='tickvalssrc', + parent_name='surface.colorbar', + **kwargs + ): + super(TickvalssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='tickvals', parent_name='surface.colorbar', **kwargs + ): + super(TickvalsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='ticktextsrc', + parent_name='surface.colorbar', + **kwargs + ): + super(TicktextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='ticktext', parent_name='surface.colorbar', **kwargs + ): + super(TicktextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='ticksuffix', + parent_name='surface.colorbar', + **kwargs + ): + super(TicksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='ticks', parent_name='surface.colorbar', **kwargs + ): + super(TicksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['outside', 'inside', '']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickprefix', + parent_name='surface.colorbar', + **kwargs + ): + super(TickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='tickmode', parent_name='surface.colorbar', **kwargs + ): + super(TickmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {}), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['auto', 'linear', 'array']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ticklen', parent_name='surface.colorbar', **kwargs + ): + super(TicklenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='tickformatstopdefaults', + parent_name='surface.colorbar', + **kwargs + ): + super(TickformatstopValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop('data_docs', """ +"""), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatstopsValidator( + _plotly_utils.basevalidators.CompoundArrayValidator +): + + def __init__( + self, + plotly_name='tickformatstops', + parent_name='surface.colorbar', + **kwargs + ): + super(TickformatstopsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), + data_docs=kwargs.pop( + 'data_docs', """ + dtickrange + 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" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are + created in the output figure in addition to any + items the figure already has in this array. You + can modify these items in the output figure by + making your own item with `templateitemname` + matching this `name` alongside your + modifications (including `visible: false` or + `enabled: false` to hide it). Has no effect + outside of a template. + templateitemname + Used to refer to a named item in this array in + the template. Named items from the template + will be created even without a matching item in + the input figure, but you can modify one by + making an item with `templateitemname` matching + its `name`, alongside your modifications + (including `visible: false` or `enabled: false` + to hide it). If there is no template or no + matching item, this item will be hidden unless + you explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, + the same as "tickformat" +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickformatValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='tickformat', + parent_name='surface.colorbar', + **kwargs + ): + super(TickformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='tickfont', parent_name='surface.colorbar', **kwargs + ): + super(TickfontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Tickfont'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='tickcolor', + parent_name='surface.colorbar', + **kwargs + ): + super(TickcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): + + def __init__( + self, + plotly_name='tickangle', + parent_name='surface.colorbar', + **kwargs + ): + super(TickangleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='tick0', parent_name='surface.colorbar', **kwargs + ): + super(Tick0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='thicknessmode', + parent_name='surface.colorbar', + **kwargs + ): + super(ThicknessmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='thickness', + parent_name='surface.colorbar', + **kwargs + ): + super(ThicknessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticksuffixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showticksuffix', + parent_name='surface.colorbar', + **kwargs + ): + super(ShowticksuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowtickprefixValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='showtickprefix', + parent_name='surface.colorbar', + **kwargs + ): + super(ShowtickprefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='showticklabels', + parent_name='surface.colorbar', + **kwargs + ): + super(ShowticklabelsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='showexponent', + parent_name='surface.colorbar', + **kwargs + ): + super(ShowexponentValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['all', 'first', 'last', 'none']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SeparatethousandsValidator( + _plotly_utils.basevalidators.BooleanValidator +): + + def __init__( + self, + plotly_name='separatethousands', + parent_name='surface.colorbar', + **kwargs + ): + super(SeparatethousandsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlinewidth', + parent_name='surface.colorbar', + **kwargs + ): + super(OutlinewidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outlinecolor', + parent_name='surface.colorbar', + **kwargs + ): + super(OutlinecolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='nticks', parent_name='surface.colorbar', **kwargs + ): + super(NticksValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='lenmode', parent_name='surface.colorbar', **kwargs + ): + super(LenmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['fraction', 'pixels']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LenValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='len', parent_name='surface.colorbar', **kwargs + ): + super(LenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ExponentformatValidator( + _plotly_utils.basevalidators.EnumeratedValidator +): + + def __init__( + self, + plotly_name='exponentformat', + parent_name='surface.colorbar', + **kwargs + ): + super(ExponentformatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='dtick', parent_name='surface.colorbar', **kwargs + ): + super(DtickValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='borderwidth', + parent_name='surface.colorbar', + **kwargs + ): + super(BorderwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='surface.colorbar', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='surface.colorbar', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/surface/colorbar/_bgcolor.py b/plotly/validators/surface/colorbar/_bgcolor.py deleted file mode 100644 index 306fb26fddc..00000000000 --- a/plotly/validators/surface/colorbar/_bgcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='surface.colorbar', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_bordercolor.py b/plotly/validators/surface/colorbar/_bordercolor.py deleted file mode 100644 index e8e11958f9b..00000000000 --- a/plotly/validators/surface/colorbar/_bordercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='surface.colorbar', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_borderwidth.py b/plotly/validators/surface/colorbar/_borderwidth.py deleted file mode 100644 index 2cce19ed118..00000000000 --- a/plotly/validators/surface/colorbar/_borderwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BorderwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='borderwidth', - parent_name='surface.colorbar', - **kwargs - ): - super(BorderwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_dtick.py b/plotly/validators/surface/colorbar/_dtick.py deleted file mode 100644 index f6ea7bd8515..00000000000 --- a/plotly/validators/surface/colorbar/_dtick.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='dtick', parent_name='surface.colorbar', **kwargs - ): - super(DtickValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_exponentformat.py b/plotly/validators/surface/colorbar/_exponentformat.py deleted file mode 100644 index 6a5f98c5d8a..00000000000 --- a/plotly/validators/surface/colorbar/_exponentformat.py +++ /dev/null @@ -1,23 +0,0 @@ -import _plotly_utils.basevalidators - - -class ExponentformatValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='exponentformat', - parent_name='surface.colorbar', - **kwargs - ): - super(ExponentformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['none', 'e', 'E', 'power', 'SI', 'B'] - ), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_len.py b/plotly/validators/surface/colorbar/_len.py deleted file mode 100644 index 24737474c68..00000000000 --- a/plotly/validators/surface/colorbar/_len.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='len', parent_name='surface.colorbar', **kwargs - ): - super(LenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_lenmode.py b/plotly/validators/surface/colorbar/_lenmode.py deleted file mode 100644 index fd65fa12e4f..00000000000 --- a/plotly/validators/surface/colorbar/_lenmode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class LenmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='lenmode', parent_name='surface.colorbar', **kwargs - ): - super(LenmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_nticks.py b/plotly/validators/surface/colorbar/_nticks.py deleted file mode 100644 index b0be60fee8d..00000000000 --- a/plotly/validators/surface/colorbar/_nticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class NticksValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='nticks', parent_name='surface.colorbar', **kwargs - ): - super(NticksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_outlinecolor.py b/plotly/validators/surface/colorbar/_outlinecolor.py deleted file mode 100644 index 6fa1354e92c..00000000000 --- a/plotly/validators/surface/colorbar/_outlinecolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinecolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outlinecolor', - parent_name='surface.colorbar', - **kwargs - ): - super(OutlinecolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_outlinewidth.py b/plotly/validators/surface/colorbar/_outlinewidth.py deleted file mode 100644 index c64d6de9db7..00000000000 --- a/plotly/validators/surface/colorbar/_outlinewidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlinewidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlinewidth', - parent_name='surface.colorbar', - **kwargs - ): - super(OutlinewidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_separatethousands.py b/plotly/validators/surface/colorbar/_separatethousands.py deleted file mode 100644 index c9c8dad8bd8..00000000000 --- a/plotly/validators/surface/colorbar/_separatethousands.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SeparatethousandsValidator( - _plotly_utils.basevalidators.BooleanValidator -): - - def __init__( - self, - plotly_name='separatethousands', - parent_name='surface.colorbar', - **kwargs - ): - super(SeparatethousandsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_showexponent.py b/plotly/validators/surface/colorbar/_showexponent.py deleted file mode 100644 index d0d37b997e3..00000000000 --- a/plotly/validators/surface/colorbar/_showexponent.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowexponentValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='showexponent', - parent_name='surface.colorbar', - **kwargs - ): - super(ShowexponentValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_showticklabels.py b/plotly/validators/surface/colorbar/_showticklabels.py deleted file mode 100644 index a3d5ac587c6..00000000000 --- a/plotly/validators/surface/colorbar/_showticklabels.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticklabelsValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='showticklabels', - parent_name='surface.colorbar', - **kwargs - ): - super(ShowticklabelsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_showtickprefix.py b/plotly/validators/surface/colorbar/_showtickprefix.py deleted file mode 100644 index d363697231f..00000000000 --- a/plotly/validators/surface/colorbar/_showtickprefix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowtickprefixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showtickprefix', - parent_name='surface.colorbar', - **kwargs - ): - super(ShowtickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_showticksuffix.py b/plotly/validators/surface/colorbar/_showticksuffix.py deleted file mode 100644 index 5353cd0ce87..00000000000 --- a/plotly/validators/surface/colorbar/_showticksuffix.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowticksuffixValidator( - _plotly_utils.basevalidators.EnumeratedValidator -): - - def __init__( - self, - plotly_name='showticksuffix', - parent_name='surface.colorbar', - **kwargs - ): - super(ShowticksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['all', 'first', 'last', 'none']), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_thickness.py b/plotly/validators/surface/colorbar/_thickness.py deleted file mode 100644 index aa8fde7da54..00000000000 --- a/plotly/validators/surface/colorbar/_thickness.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='thickness', - parent_name='surface.colorbar', - **kwargs - ): - super(ThicknessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_thicknessmode.py b/plotly/validators/surface/colorbar/_thicknessmode.py deleted file mode 100644 index 651dfac07d7..00000000000 --- a/plotly/validators/surface/colorbar/_thicknessmode.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ThicknessmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='thicknessmode', - parent_name='surface.colorbar', - **kwargs - ): - super(ThicknessmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['fraction', 'pixels']), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_tick0.py b/plotly/validators/surface/colorbar/_tick0.py deleted file mode 100644 index 89a2213d309..00000000000 --- a/plotly/validators/surface/colorbar/_tick0.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class Tick0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='tick0', parent_name='surface.colorbar', **kwargs - ): - super(Tick0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {'tickmode': 'linear'}), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_tickangle.py b/plotly/validators/surface/colorbar/_tickangle.py deleted file mode 100644 index 5d8593a5305..00000000000 --- a/plotly/validators/surface/colorbar/_tickangle.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickangleValidator(_plotly_utils.basevalidators.AngleValidator): - - def __init__( - self, - plotly_name='tickangle', - parent_name='surface.colorbar', - **kwargs - ): - super(TickangleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_tickcolor.py b/plotly/validators/surface/colorbar/_tickcolor.py deleted file mode 100644 index f25990c704a..00000000000 --- a/plotly/validators/surface/colorbar/_tickcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='tickcolor', - parent_name='surface.colorbar', - **kwargs - ): - super(TickcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_tickfont.py b/plotly/validators/surface/colorbar/_tickfont.py deleted file mode 100644 index e014815a6d3..00000000000 --- a/plotly/validators/surface/colorbar/_tickfont.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickfontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='tickfont', parent_name='surface.colorbar', **kwargs - ): - super(TickfontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickfont'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_tickformat.py b/plotly/validators/surface/colorbar/_tickformat.py deleted file mode 100644 index deb7044d903..00000000000 --- a/plotly/validators/surface/colorbar/_tickformat.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickformat', - parent_name='surface.colorbar', - **kwargs - ): - super(TickformatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_tickformatstopdefaults.py b/plotly/validators/surface/colorbar/_tickformatstopdefaults.py deleted file mode 100644 index 9597117ff2d..00000000000 --- a/plotly/validators/surface/colorbar/_tickformatstopdefaults.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='tickformatstopdefaults', - parent_name='surface.colorbar', - **kwargs - ): - super(TickformatstopValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop('data_docs', """ -"""), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_tickformatstops.py b/plotly/validators/surface/colorbar/_tickformatstops.py deleted file mode 100644 index 85f5eead246..00000000000 --- a/plotly/validators/surface/colorbar/_tickformatstops.py +++ /dev/null @@ -1,56 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickformatstopsValidator( - _plotly_utils.basevalidators.CompoundArrayValidator -): - - def __init__( - self, - plotly_name='tickformatstops', - parent_name='surface.colorbar', - **kwargs - ): - super(TickformatstopsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Tickformatstop'), - data_docs=kwargs.pop( - 'data_docs', """ - dtickrange - 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" - enabled - Determines whether or not this stop is used. If - `false`, this stop is ignored even within its - `dtickrange`. - name - When used in a template, named items are - created in the output figure in addition to any - items the figure already has in this array. You - can modify these items in the output figure by - making your own item with `templateitemname` - matching this `name` alongside your - modifications (including `visible: false` or - `enabled: false` to hide it). Has no effect - outside of a template. - templateitemname - Used to refer to a named item in this array in - the template. Named items from the template - will be created even without a matching item in - the input figure, but you can modify one by - making an item with `templateitemname` matching - its `name`, alongside your modifications - (including `visible: false` or `enabled: false` - to hide it). If there is no template or no - matching item, this item will be hidden unless - you explicitly show it with `visible: true`. - value - string - dtickformat for described zoom level, - the same as "tickformat" -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_ticklen.py b/plotly/validators/surface/colorbar/_ticklen.py deleted file mode 100644 index 63e19a712ae..00000000000 --- a/plotly/validators/surface/colorbar/_ticklen.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicklenValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ticklen', parent_name='surface.colorbar', **kwargs - ): - super(TicklenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_tickmode.py b/plotly/validators/surface/colorbar/_tickmode.py deleted file mode 100644 index c12d68beb90..00000000000 --- a/plotly/validators/surface/colorbar/_tickmode.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='tickmode', parent_name='surface.colorbar', **kwargs - ): - super(TickmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - implied_edits=kwargs.pop('implied_edits', {}), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['auto', 'linear', 'array']), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_tickprefix.py b/plotly/validators/surface/colorbar/_tickprefix.py deleted file mode 100644 index 9f2233f3848..00000000000 --- a/plotly/validators/surface/colorbar/_tickprefix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickprefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='tickprefix', - parent_name='surface.colorbar', - **kwargs - ): - super(TickprefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_ticks.py b/plotly/validators/surface/colorbar/_ticks.py deleted file mode 100644 index ec2fd281e6b..00000000000 --- a/plotly/validators/surface/colorbar/_ticks.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='ticks', parent_name='surface.colorbar', **kwargs - ): - super(TicksValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['outside', 'inside', '']), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_ticksuffix.py b/plotly/validators/surface/colorbar/_ticksuffix.py deleted file mode 100644 index b0727bdad51..00000000000 --- a/plotly/validators/surface/colorbar/_ticksuffix.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicksuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='ticksuffix', - parent_name='surface.colorbar', - **kwargs - ): - super(TicksuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_ticktext.py b/plotly/validators/surface/colorbar/_ticktext.py deleted file mode 100644 index 359e343f1e7..00000000000 --- a/plotly/validators/surface/colorbar/_ticktext.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='ticktext', parent_name='surface.colorbar', **kwargs - ): - super(TicktextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_ticktextsrc.py b/plotly/validators/surface/colorbar/_ticktextsrc.py deleted file mode 100644 index fd4aee5307a..00000000000 --- a/plotly/validators/surface/colorbar/_ticktextsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TicktextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='ticktextsrc', - parent_name='surface.colorbar', - **kwargs - ): - super(TicktextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_tickvals.py b/plotly/validators/surface/colorbar/_tickvals.py deleted file mode 100644 index 7fd1239d22b..00000000000 --- a/plotly/validators/surface/colorbar/_tickvals.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='tickvals', parent_name='surface.colorbar', **kwargs - ): - super(TickvalsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_tickvalssrc.py b/plotly/validators/surface/colorbar/_tickvalssrc.py deleted file mode 100644 index 852567f1729..00000000000 --- a/plotly/validators/surface/colorbar/_tickvalssrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickvalssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='tickvalssrc', - parent_name='surface.colorbar', - **kwargs - ): - super(TickvalssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_tickwidth.py b/plotly/validators/surface/colorbar/_tickwidth.py deleted file mode 100644 index af9a0a424c0..00000000000 --- a/plotly/validators/surface/colorbar/_tickwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class TickwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='tickwidth', - parent_name='surface.colorbar', - **kwargs - ): - super(TickwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_title.py b/plotly/validators/surface/colorbar/_title.py deleted file mode 100644 index 19904f1841c..00000000000 --- a/plotly/validators/surface/colorbar/_title.py +++ /dev/null @@ -1,33 +0,0 @@ -import _plotly_utils.basevalidators - - -class TitleValidator(_plotly_utils.basevalidators.TitleValidator): - - def __init__( - self, plotly_name='title', parent_name='surface.colorbar', **kwargs - ): - super(TitleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Title'), - data_docs=kwargs.pop( - 'data_docs', """ - font - Sets this color bar's title font. Note that the - title's font used to be set by the now - deprecated `titlefont` attribute. - side - 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. - text - 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_x.py b/plotly/validators/surface/colorbar/_x.py deleted file mode 100644 index 21acf6046be..00000000000 --- a/plotly/validators/surface/colorbar/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='surface.colorbar', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_xanchor.py b/plotly/validators/surface/colorbar/_xanchor.py deleted file mode 100644 index e7197e37415..00000000000 --- a/plotly/validators/surface/colorbar/_xanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='xanchor', parent_name='surface.colorbar', **kwargs - ): - super(XanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_xpad.py b/plotly/validators/surface/colorbar/_xpad.py deleted file mode 100644 index ad5bc64b413..00000000000 --- a/plotly/validators/surface/colorbar/_xpad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class XpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='xpad', parent_name='surface.colorbar', **kwargs - ): - super(XpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_y.py b/plotly/validators/surface/colorbar/_y.py deleted file mode 100644 index 20e499de188..00000000000 --- a/plotly/validators/surface/colorbar/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='surface.colorbar', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 3), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_yanchor.py b/plotly/validators/surface/colorbar/_yanchor.py deleted file mode 100644 index 3bb76e3ced0..00000000000 --- a/plotly/validators/surface/colorbar/_yanchor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YanchorValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='yanchor', parent_name='surface.colorbar', **kwargs - ): - super(YanchorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['top', 'middle', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/_ypad.py b/plotly/validators/surface/colorbar/_ypad.py deleted file mode 100644 index c5343c001f9..00000000000 --- a/plotly/validators/surface/colorbar/_ypad.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class YpadValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ypad', parent_name='surface.colorbar', **kwargs - ): - super(YpadValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/tickfont/__init__.py b/plotly/validators/surface/colorbar/tickfont/__init__.py index 199d72e71c6..ea008a625d1 100644 --- a/plotly/validators/surface/colorbar/tickfont/__init__.py +++ b/plotly/validators/surface/colorbar/tickfont/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='surface.colorbar.tickfont', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='surface.colorbar.tickfont', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='surface.colorbar.tickfont', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/surface/colorbar/tickfont/_color.py b/plotly/validators/surface/colorbar/tickfont/_color.py deleted file mode 100644 index f06fe06ffff..00000000000 --- a/plotly/validators/surface/colorbar/tickfont/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='surface.colorbar.tickfont', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/tickfont/_family.py b/plotly/validators/surface/colorbar/tickfont/_family.py deleted file mode 100644 index 81d69773c37..00000000000 --- a/plotly/validators/surface/colorbar/tickfont/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='surface.colorbar.tickfont', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/tickfont/_size.py b/plotly/validators/surface/colorbar/tickfont/_size.py deleted file mode 100644 index 968e2a435d4..00000000000 --- a/plotly/validators/surface/colorbar/tickfont/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='surface.colorbar.tickfont', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/tickformatstop/__init__.py b/plotly/validators/surface/colorbar/tickformatstop/__init__.py index 3f6c06cac47..87691e39f26 100644 --- a/plotly/validators/surface/colorbar/tickformatstop/__init__.py +++ b/plotly/validators/surface/colorbar/tickformatstop/__init__.py @@ -1,5 +1,111 @@ -from ._value import ValueValidator -from ._templateitemname import TemplateitemnameValidator -from ._name import NameValidator -from ._enabled import EnabledValidator -from ._dtickrange import DtickrangeValidator + + +import _plotly_utils.basevalidators + + +class ValueValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='value', + parent_name='surface.colorbar.tickformatstop', + **kwargs + ): + super(ValueValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='templateitemname', + parent_name='surface.colorbar.tickformatstop', + **kwargs + ): + super(TemplateitemnameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='name', + parent_name='surface.colorbar.tickformatstop', + **kwargs + ): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='enabled', + parent_name='surface.colorbar.tickformatstop', + **kwargs + ): + super(EnabledValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__( + self, + plotly_name='dtickrange', + parent_name='surface.colorbar.tickformatstop', + **kwargs + ): + super(DtickrangeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'calc' + }, { + 'valType': 'any', + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/surface/colorbar/tickformatstop/_dtickrange.py b/plotly/validators/surface/colorbar/tickformatstop/_dtickrange.py deleted file mode 100644 index 306615cdc17..00000000000 --- a/plotly/validators/surface/colorbar/tickformatstop/_dtickrange.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class DtickrangeValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__( - self, - plotly_name='dtickrange', - parent_name='surface.colorbar.tickformatstop', - **kwargs - ): - super(DtickrangeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'calc' - }, { - 'valType': 'any', - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/tickformatstop/_enabled.py b/plotly/validators/surface/colorbar/tickformatstop/_enabled.py deleted file mode 100644 index cdb18e2296f..00000000000 --- a/plotly/validators/surface/colorbar/tickformatstop/_enabled.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class EnabledValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='enabled', - parent_name='surface.colorbar.tickformatstop', - **kwargs - ): - super(EnabledValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/tickformatstop/_name.py b/plotly/validators/surface/colorbar/tickformatstop/_name.py deleted file mode 100644 index 1b587b9fb69..00000000000 --- a/plotly/validators/surface/colorbar/tickformatstop/_name.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='name', - parent_name='surface.colorbar.tickformatstop', - **kwargs - ): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/tickformatstop/_templateitemname.py b/plotly/validators/surface/colorbar/tickformatstop/_templateitemname.py deleted file mode 100644 index 78d2ec5ada2..00000000000 --- a/plotly/validators/surface/colorbar/tickformatstop/_templateitemname.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TemplateitemnameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='templateitemname', - parent_name='surface.colorbar.tickformatstop', - **kwargs - ): - super(TemplateitemnameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/tickformatstop/_value.py b/plotly/validators/surface/colorbar/tickformatstop/_value.py deleted file mode 100644 index 9dbbe23c67c..00000000000 --- a/plotly/validators/surface/colorbar/tickformatstop/_value.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValueValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='value', - parent_name='surface.colorbar.tickformatstop', - **kwargs - ): - super(ValueValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/title/__init__.py b/plotly/validators/surface/colorbar/title/__init__.py index 33c9c145bb8..6cca886066d 100644 --- a/plotly/validators/surface/colorbar/title/__init__.py +++ b/plotly/validators/surface/colorbar/title/__init__.py @@ -1,3 +1,84 @@ -from ._text import TextValidator -from ._side import SideValidator -from ._font import FontValidator + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='text', + parent_name='surface.colorbar.title', + **kwargs + ): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, + plotly_name='side', + parent_name='surface.colorbar.title', + **kwargs + ): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['right', 'top', 'bottom']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='font', + parent_name='surface.colorbar.title', + **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + size + +""" + ), + **kwargs + ) diff --git a/plotly/validators/surface/colorbar/title/_font.py b/plotly/validators/surface/colorbar/title/_font.py deleted file mode 100644 index bf88cbe8c33..00000000000 --- a/plotly/validators/surface/colorbar/title/_font.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='font', - parent_name='surface.colorbar.title', - **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - size - -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/title/_side.py b/plotly/validators/surface/colorbar/title/_side.py deleted file mode 100644 index 1d6e6740e19..00000000000 --- a/plotly/validators/surface/colorbar/title/_side.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, - plotly_name='side', - parent_name='surface.colorbar.title', - **kwargs - ): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['right', 'top', 'bottom']), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/title/_text.py b/plotly/validators/surface/colorbar/title/_text.py deleted file mode 100644 index 45ed2f985cc..00000000000 --- a/plotly/validators/surface/colorbar/title/_text.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='text', - parent_name='surface.colorbar.title', - **kwargs - ): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/title/font/__init__.py b/plotly/validators/surface/colorbar/title/font/__init__.py index 199d72e71c6..db600718197 100644 --- a/plotly/validators/surface/colorbar/title/font/__init__.py +++ b/plotly/validators/surface/colorbar/title/font/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._family import FamilyValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='surface.colorbar.title.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='surface.colorbar.title.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='surface.colorbar.title.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/surface/colorbar/title/font/_color.py b/plotly/validators/surface/colorbar/title/font/_color.py deleted file mode 100644 index 29952b4b37f..00000000000 --- a/plotly/validators/surface/colorbar/title/font/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='surface.colorbar.title.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/title/font/_family.py b/plotly/validators/surface/colorbar/title/font/_family.py deleted file mode 100644 index 06ff4c49824..00000000000 --- a/plotly/validators/surface/colorbar/title/font/_family.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='surface.colorbar.title.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/surface/colorbar/title/font/_size.py b/plotly/validators/surface/colorbar/title/font/_size.py deleted file mode 100644 index ca3081c4108..00000000000 --- a/plotly/validators/surface/colorbar/title/font/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='surface.colorbar.title.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/__init__.py b/plotly/validators/surface/contours/__init__.py index 438e2dc9c6d..9b14ba62803 100644 --- a/plotly/validators/surface/contours/__init__.py +++ b/plotly/validators/surface/contours/__init__.py @@ -1,3 +1,129 @@ -from ._z import ZValidator -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='z', parent_name='surface.contours', **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Z'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the color of the contour lines. + highlight + Determines whether or not contour lines about + the z dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour + lines. + highlightwidth + Sets the width of the highlighted contour + lines. + project + plotly.graph_objs.surface.contours.z.Project + instance or dict with compatible properties + show + Determines whether or not contour lines about + the z dimension are drawn. + usecolormap + An alternate to "color". Determines whether or + not the contour lines are colored using the + trace "colorscale". + width + Sets the width of the contour lines. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='y', parent_name='surface.contours', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Y'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the color of the contour lines. + highlight + Determines whether or not contour lines about + the y dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour + lines. + highlightwidth + Sets the width of the highlighted contour + lines. + project + plotly.graph_objs.surface.contours.y.Project + instance or dict with compatible properties + show + Determines whether or not contour lines about + the y dimension are drawn. + usecolormap + An alternate to "color". Determines whether or + not the contour lines are colored using the + trace "colorscale". + width + Sets the width of the contour lines. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='x', parent_name='surface.contours', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'X'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the color of the contour lines. + highlight + Determines whether or not contour lines about + the x dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour + lines. + highlightwidth + Sets the width of the highlighted contour + lines. + project + plotly.graph_objs.surface.contours.x.Project + instance or dict with compatible properties + show + Determines whether or not contour lines about + the x dimension are drawn. + usecolormap + An alternate to "color". Determines whether or + not the contour lines are colored using the + trace "colorscale". + width + Sets the width of the contour lines. +""" + ), + **kwargs + ) diff --git a/plotly/validators/surface/contours/_x.py b/plotly/validators/surface/contours/_x.py deleted file mode 100644 index 88ee165f7bc..00000000000 --- a/plotly/validators/surface/contours/_x.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='x', parent_name='surface.contours', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'X'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the color of the contour lines. - highlight - Determines whether or not contour lines about - the x dimension are highlighted on hover. - highlightcolor - Sets the color of the highlighted contour - lines. - highlightwidth - Sets the width of the highlighted contour - lines. - project - plotly.graph_objs.surface.contours.x.Project - instance or dict with compatible properties - show - Determines whether or not contour lines about - the x dimension are drawn. - usecolormap - An alternate to "color". Determines whether or - not the contour lines are colored using the - trace "colorscale". - width - Sets the width of the contour lines. -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/contours/_y.py b/plotly/validators/surface/contours/_y.py deleted file mode 100644 index 7097e4e6dc1..00000000000 --- a/plotly/validators/surface/contours/_y.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='y', parent_name='surface.contours', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Y'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the color of the contour lines. - highlight - Determines whether or not contour lines about - the y dimension are highlighted on hover. - highlightcolor - Sets the color of the highlighted contour - lines. - highlightwidth - Sets the width of the highlighted contour - lines. - project - plotly.graph_objs.surface.contours.y.Project - instance or dict with compatible properties - show - Determines whether or not contour lines about - the y dimension are drawn. - usecolormap - An alternate to "color". Determines whether or - not the contour lines are colored using the - trace "colorscale". - width - Sets the width of the contour lines. -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/contours/_z.py b/plotly/validators/surface/contours/_z.py deleted file mode 100644 index 32558d0a937..00000000000 --- a/plotly/validators/surface/contours/_z.py +++ /dev/null @@ -1,41 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='z', parent_name='surface.contours', **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Z'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the color of the contour lines. - highlight - Determines whether or not contour lines about - the z dimension are highlighted on hover. - highlightcolor - Sets the color of the highlighted contour - lines. - highlightwidth - Sets the width of the highlighted contour - lines. - project - plotly.graph_objs.surface.contours.z.Project - instance or dict with compatible properties - show - Determines whether or not contour lines about - the z dimension are drawn. - usecolormap - An alternate to "color". Determines whether or - not the contour lines are colored using the - trace "colorscale". - width - Sets the width of the contour lines. -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/contours/x/__init__.py b/plotly/validators/surface/contours/x/__init__.py index fe30afc140a..0883546eb0b 100644 --- a/plotly/validators/surface/contours/x/__init__.py +++ b/plotly/validators/surface/contours/x/__init__.py @@ -1,8 +1,176 @@ -from ._width import WidthValidator -from ._usecolormap import UsecolormapValidator -from ._show import ShowValidator -from ._project import ProjectValidator -from ._highlightwidth import HighlightwidthValidator -from ._highlightcolor import HighlightcolorValidator -from ._highlight import HighlightValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='surface.contours.x', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 16), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UsecolormapValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='usecolormap', + parent_name='surface.contours.x', + **kwargs + ): + super(UsecolormapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='show', parent_name='surface.contours.x', **kwargs + ): + super(ShowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ProjectValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='project', + parent_name='surface.contours.x', + **kwargs + ): + super(ProjectValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Project'), + data_docs=kwargs.pop( + 'data_docs', """ + x + Determines whether or not these contour lines + are projected on 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. + y + Determines whether or not these contour lines + are projected on 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. + z + Determines whether or not these contour lines + are projected on 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HighlightwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='highlightwidth', + parent_name='surface.contours.x', + **kwargs + ): + super(HighlightwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 16), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HighlightcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='highlightcolor', + parent_name='surface.contours.x', + **kwargs + ): + super(HighlightcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HighlightValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='highlight', + parent_name='surface.contours.x', + **kwargs + ): + super(HighlightValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='surface.contours.x', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/surface/contours/x/_color.py b/plotly/validators/surface/contours/x/_color.py deleted file mode 100644 index b35f85cdbb1..00000000000 --- a/plotly/validators/surface/contours/x/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='surface.contours.x', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/x/_highlight.py b/plotly/validators/surface/contours/x/_highlight.py deleted file mode 100644 index e1bd193e8fc..00000000000 --- a/plotly/validators/surface/contours/x/_highlight.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HighlightValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='highlight', - parent_name='surface.contours.x', - **kwargs - ): - super(HighlightValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/x/_highlightcolor.py b/plotly/validators/surface/contours/x/_highlightcolor.py deleted file mode 100644 index cef5f134f77..00000000000 --- a/plotly/validators/surface/contours/x/_highlightcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HighlightcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='highlightcolor', - parent_name='surface.contours.x', - **kwargs - ): - super(HighlightcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/x/_highlightwidth.py b/plotly/validators/surface/contours/x/_highlightwidth.py deleted file mode 100644 index 4b663cbd155..00000000000 --- a/plotly/validators/surface/contours/x/_highlightwidth.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class HighlightwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='highlightwidth', - parent_name='surface.contours.x', - **kwargs - ): - super(HighlightwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 16), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/x/_project.py b/plotly/validators/surface/contours/x/_project.py deleted file mode 100644 index 4a1a02dc8d8..00000000000 --- a/plotly/validators/surface/contours/x/_project.py +++ /dev/null @@ -1,39 +0,0 @@ -import _plotly_utils.basevalidators - - -class ProjectValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='project', - parent_name='surface.contours.x', - **kwargs - ): - super(ProjectValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Project'), - data_docs=kwargs.pop( - 'data_docs', """ - x - Determines whether or not these contour lines - are projected on 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. - y - Determines whether or not these contour lines - are projected on 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. - z - Determines whether or not these contour lines - are projected on 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/contours/x/_show.py b/plotly/validators/surface/contours/x/_show.py deleted file mode 100644 index 4329df607b5..00000000000 --- a/plotly/validators/surface/contours/x/_show.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='show', parent_name='surface.contours.x', **kwargs - ): - super(ShowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/x/_usecolormap.py b/plotly/validators/surface/contours/x/_usecolormap.py deleted file mode 100644 index 6f3f1c884ea..00000000000 --- a/plotly/validators/surface/contours/x/_usecolormap.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class UsecolormapValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='usecolormap', - parent_name='surface.contours.x', - **kwargs - ): - super(UsecolormapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/x/_width.py b/plotly/validators/surface/contours/x/_width.py deleted file mode 100644 index 61127a0c0ea..00000000000 --- a/plotly/validators/surface/contours/x/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='surface.contours.x', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 16), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/x/project/__init__.py b/plotly/validators/surface/contours/x/project/__init__.py index 438e2dc9c6d..6d341fc105d 100644 --- a/plotly/validators/surface/contours/x/project/__init__.py +++ b/plotly/validators/surface/contours/x/project/__init__.py @@ -1,3 +1,60 @@ -from ._z import ZValidator -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='z', + parent_name='surface.contours.x.project', + **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='y', + parent_name='surface.contours.x.project', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='x', + parent_name='surface.contours.x.project', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/surface/contours/x/project/_x.py b/plotly/validators/surface/contours/x/project/_x.py deleted file mode 100644 index 5ea424ec9ce..00000000000 --- a/plotly/validators/surface/contours/x/project/_x.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='x', - parent_name='surface.contours.x.project', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/x/project/_y.py b/plotly/validators/surface/contours/x/project/_y.py deleted file mode 100644 index 2c12c72fe8a..00000000000 --- a/plotly/validators/surface/contours/x/project/_y.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='y', - parent_name='surface.contours.x.project', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/x/project/_z.py b/plotly/validators/surface/contours/x/project/_z.py deleted file mode 100644 index cebc3ac4e2d..00000000000 --- a/plotly/validators/surface/contours/x/project/_z.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='z', - parent_name='surface.contours.x.project', - **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/y/__init__.py b/plotly/validators/surface/contours/y/__init__.py index fe30afc140a..d6f5a85d7c9 100644 --- a/plotly/validators/surface/contours/y/__init__.py +++ b/plotly/validators/surface/contours/y/__init__.py @@ -1,8 +1,176 @@ -from ._width import WidthValidator -from ._usecolormap import UsecolormapValidator -from ._show import ShowValidator -from ._project import ProjectValidator -from ._highlightwidth import HighlightwidthValidator -from ._highlightcolor import HighlightcolorValidator -from ._highlight import HighlightValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='surface.contours.y', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 16), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UsecolormapValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='usecolormap', + parent_name='surface.contours.y', + **kwargs + ): + super(UsecolormapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='show', parent_name='surface.contours.y', **kwargs + ): + super(ShowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ProjectValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='project', + parent_name='surface.contours.y', + **kwargs + ): + super(ProjectValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Project'), + data_docs=kwargs.pop( + 'data_docs', """ + x + Determines whether or not these contour lines + are projected on 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. + y + Determines whether or not these contour lines + are projected on 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. + z + Determines whether or not these contour lines + are projected on 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HighlightwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='highlightwidth', + parent_name='surface.contours.y', + **kwargs + ): + super(HighlightwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 16), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HighlightcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='highlightcolor', + parent_name='surface.contours.y', + **kwargs + ): + super(HighlightcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HighlightValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='highlight', + parent_name='surface.contours.y', + **kwargs + ): + super(HighlightValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='surface.contours.y', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/surface/contours/y/_color.py b/plotly/validators/surface/contours/y/_color.py deleted file mode 100644 index e5319bfe567..00000000000 --- a/plotly/validators/surface/contours/y/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='surface.contours.y', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/y/_highlight.py b/plotly/validators/surface/contours/y/_highlight.py deleted file mode 100644 index 4726cb298be..00000000000 --- a/plotly/validators/surface/contours/y/_highlight.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HighlightValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='highlight', - parent_name='surface.contours.y', - **kwargs - ): - super(HighlightValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/y/_highlightcolor.py b/plotly/validators/surface/contours/y/_highlightcolor.py deleted file mode 100644 index b53405268f4..00000000000 --- a/plotly/validators/surface/contours/y/_highlightcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HighlightcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='highlightcolor', - parent_name='surface.contours.y', - **kwargs - ): - super(HighlightcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/y/_highlightwidth.py b/plotly/validators/surface/contours/y/_highlightwidth.py deleted file mode 100644 index 3312cc0bf22..00000000000 --- a/plotly/validators/surface/contours/y/_highlightwidth.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class HighlightwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='highlightwidth', - parent_name='surface.contours.y', - **kwargs - ): - super(HighlightwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 16), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/y/_project.py b/plotly/validators/surface/contours/y/_project.py deleted file mode 100644 index 46cbe0cd0f9..00000000000 --- a/plotly/validators/surface/contours/y/_project.py +++ /dev/null @@ -1,39 +0,0 @@ -import _plotly_utils.basevalidators - - -class ProjectValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='project', - parent_name='surface.contours.y', - **kwargs - ): - super(ProjectValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Project'), - data_docs=kwargs.pop( - 'data_docs', """ - x - Determines whether or not these contour lines - are projected on 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. - y - Determines whether or not these contour lines - are projected on 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. - z - Determines whether or not these contour lines - are projected on 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/contours/y/_show.py b/plotly/validators/surface/contours/y/_show.py deleted file mode 100644 index 7ce8350a007..00000000000 --- a/plotly/validators/surface/contours/y/_show.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='show', parent_name='surface.contours.y', **kwargs - ): - super(ShowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/y/_usecolormap.py b/plotly/validators/surface/contours/y/_usecolormap.py deleted file mode 100644 index 3c4f4c05ec0..00000000000 --- a/plotly/validators/surface/contours/y/_usecolormap.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class UsecolormapValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='usecolormap', - parent_name='surface.contours.y', - **kwargs - ): - super(UsecolormapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/y/_width.py b/plotly/validators/surface/contours/y/_width.py deleted file mode 100644 index 2d731e950d7..00000000000 --- a/plotly/validators/surface/contours/y/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='surface.contours.y', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 16), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/y/project/__init__.py b/plotly/validators/surface/contours/y/project/__init__.py index 438e2dc9c6d..f9bcffa82aa 100644 --- a/plotly/validators/surface/contours/y/project/__init__.py +++ b/plotly/validators/surface/contours/y/project/__init__.py @@ -1,3 +1,60 @@ -from ._z import ZValidator -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='z', + parent_name='surface.contours.y.project', + **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='y', + parent_name='surface.contours.y.project', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='x', + parent_name='surface.contours.y.project', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/surface/contours/y/project/_x.py b/plotly/validators/surface/contours/y/project/_x.py deleted file mode 100644 index 28a176ca975..00000000000 --- a/plotly/validators/surface/contours/y/project/_x.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='x', - parent_name='surface.contours.y.project', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/y/project/_y.py b/plotly/validators/surface/contours/y/project/_y.py deleted file mode 100644 index a44962ab1ab..00000000000 --- a/plotly/validators/surface/contours/y/project/_y.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='y', - parent_name='surface.contours.y.project', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/y/project/_z.py b/plotly/validators/surface/contours/y/project/_z.py deleted file mode 100644 index e460c1c916d..00000000000 --- a/plotly/validators/surface/contours/y/project/_z.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='z', - parent_name='surface.contours.y.project', - **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/z/__init__.py b/plotly/validators/surface/contours/z/__init__.py index fe30afc140a..2db69367240 100644 --- a/plotly/validators/surface/contours/z/__init__.py +++ b/plotly/validators/surface/contours/z/__init__.py @@ -1,8 +1,176 @@ -from ._width import WidthValidator -from ._usecolormap import UsecolormapValidator -from ._show import ShowValidator -from ._project import ProjectValidator -from ._highlightwidth import HighlightwidthValidator -from ._highlightcolor import HighlightcolorValidator -from ._highlight import HighlightValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='surface.contours.z', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 16), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UsecolormapValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='usecolormap', + parent_name='surface.contours.z', + **kwargs + ): + super(UsecolormapValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='show', parent_name='surface.contours.z', **kwargs + ): + super(ShowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ProjectValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, + plotly_name='project', + parent_name='surface.contours.z', + **kwargs + ): + super(ProjectValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Project'), + data_docs=kwargs.pop( + 'data_docs', """ + x + Determines whether or not these contour lines + are projected on 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. + y + Determines whether or not these contour lines + are projected on 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. + z + Determines whether or not these contour lines + are projected on 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. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HighlightwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='highlightwidth', + parent_name='surface.contours.z', + **kwargs + ): + super(HighlightwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 16), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HighlightcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='highlightcolor', + parent_name='surface.contours.z', + **kwargs + ): + super(HighlightcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HighlightValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='highlight', + parent_name='surface.contours.z', + **kwargs + ): + super(HighlightValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='surface.contours.z', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/surface/contours/z/_color.py b/plotly/validators/surface/contours/z/_color.py deleted file mode 100644 index 696da6ad298..00000000000 --- a/plotly/validators/surface/contours/z/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='surface.contours.z', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/z/_highlight.py b/plotly/validators/surface/contours/z/_highlight.py deleted file mode 100644 index 33d63403788..00000000000 --- a/plotly/validators/surface/contours/z/_highlight.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HighlightValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='highlight', - parent_name='surface.contours.z', - **kwargs - ): - super(HighlightValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/z/_highlightcolor.py b/plotly/validators/surface/contours/z/_highlightcolor.py deleted file mode 100644 index 56fd814eb5f..00000000000 --- a/plotly/validators/surface/contours/z/_highlightcolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HighlightcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='highlightcolor', - parent_name='surface.contours.z', - **kwargs - ): - super(HighlightcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/z/_highlightwidth.py b/plotly/validators/surface/contours/z/_highlightwidth.py deleted file mode 100644 index da01171db51..00000000000 --- a/plotly/validators/surface/contours/z/_highlightwidth.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class HighlightwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='highlightwidth', - parent_name='surface.contours.z', - **kwargs - ): - super(HighlightwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 16), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/z/_project.py b/plotly/validators/surface/contours/z/_project.py deleted file mode 100644 index 1e041226a06..00000000000 --- a/plotly/validators/surface/contours/z/_project.py +++ /dev/null @@ -1,39 +0,0 @@ -import _plotly_utils.basevalidators - - -class ProjectValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, - plotly_name='project', - parent_name='surface.contours.z', - **kwargs - ): - super(ProjectValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Project'), - data_docs=kwargs.pop( - 'data_docs', """ - x - Determines whether or not these contour lines - are projected on 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. - y - Determines whether or not these contour lines - are projected on 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. - z - Determines whether or not these contour lines - are projected on 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. -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/contours/z/_show.py b/plotly/validators/surface/contours/z/_show.py deleted file mode 100644 index e4fa32d8d28..00000000000 --- a/plotly/validators/surface/contours/z/_show.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='show', parent_name='surface.contours.z', **kwargs - ): - super(ShowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/z/_usecolormap.py b/plotly/validators/surface/contours/z/_usecolormap.py deleted file mode 100644 index 733b1407139..00000000000 --- a/plotly/validators/surface/contours/z/_usecolormap.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class UsecolormapValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='usecolormap', - parent_name='surface.contours.z', - **kwargs - ): - super(UsecolormapValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/z/_width.py b/plotly/validators/surface/contours/z/_width.py deleted file mode 100644 index 3e80eeba1eb..00000000000 --- a/plotly/validators/surface/contours/z/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='surface.contours.z', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 16), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/z/project/__init__.py b/plotly/validators/surface/contours/z/project/__init__.py index 438e2dc9c6d..24f168b6d10 100644 --- a/plotly/validators/surface/contours/z/project/__init__.py +++ b/plotly/validators/surface/contours/z/project/__init__.py @@ -1,3 +1,60 @@ -from ._z import ZValidator -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='z', + parent_name='surface.contours.z.project', + **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='y', + parent_name='surface.contours.z.project', + **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, + plotly_name='x', + parent_name='surface.contours.z.project', + **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/surface/contours/z/project/_x.py b/plotly/validators/surface/contours/z/project/_x.py deleted file mode 100644 index 9abd8dd52a9..00000000000 --- a/plotly/validators/surface/contours/z/project/_x.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='x', - parent_name='surface.contours.z.project', - **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/z/project/_y.py b/plotly/validators/surface/contours/z/project/_y.py deleted file mode 100644 index 81041c56461..00000000000 --- a/plotly/validators/surface/contours/z/project/_y.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='y', - parent_name='surface.contours.z.project', - **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/contours/z/project/_z.py b/plotly/validators/surface/contours/z/project/_z.py deleted file mode 100644 index ef4971cae59..00000000000 --- a/plotly/validators/surface/contours/z/project/_z.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, - plotly_name='z', - parent_name='surface.contours.z.project', - **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/hoverlabel/__init__.py b/plotly/validators/surface/hoverlabel/__init__.py index 856f769ba33..86b866f6a00 100644 --- a/plotly/validators/surface/hoverlabel/__init__.py +++ b/plotly/validators/surface/hoverlabel/__init__.py @@ -1,7 +1,173 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='surface.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='surface.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='surface.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='surface.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='surface.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='surface.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bgcolor', + parent_name='surface.hoverlabel', + **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/surface/hoverlabel/_bgcolor.py b/plotly/validators/surface/hoverlabel/_bgcolor.py deleted file mode 100644 index 1cc77962d11..00000000000 --- a/plotly/validators/surface/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bgcolor', - parent_name='surface.hoverlabel', - **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/hoverlabel/_bgcolorsrc.py b/plotly/validators/surface/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index aa0b8a11c42..00000000000 --- a/plotly/validators/surface/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='surface.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/hoverlabel/_bordercolor.py b/plotly/validators/surface/hoverlabel/_bordercolor.py deleted file mode 100644 index 80a0a670fc9..00000000000 --- a/plotly/validators/surface/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='surface.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/hoverlabel/_bordercolorsrc.py b/plotly/validators/surface/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index 911fa20a204..00000000000 --- a/plotly/validators/surface/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='surface.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/hoverlabel/_font.py b/plotly/validators/surface/hoverlabel/_font.py deleted file mode 100644 index 9059875f245..00000000000 --- a/plotly/validators/surface/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='surface.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/surface/hoverlabel/_namelength.py b/plotly/validators/surface/hoverlabel/_namelength.py deleted file mode 100644 index 59443e53e49..00000000000 --- a/plotly/validators/surface/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='surface.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/hoverlabel/_namelengthsrc.py b/plotly/validators/surface/hoverlabel/_namelengthsrc.py deleted file mode 100644 index 20bd92c9eb6..00000000000 --- a/plotly/validators/surface/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='surface.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/hoverlabel/font/__init__.py b/plotly/validators/surface/hoverlabel/font/__init__.py index 1d2c591d1e5..990daf71916 100644 --- a/plotly/validators/surface/hoverlabel/font/__init__.py +++ b/plotly/validators/surface/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='surface.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='surface.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='surface.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='surface.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='surface.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='surface.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/surface/hoverlabel/font/_color.py b/plotly/validators/surface/hoverlabel/font/_color.py deleted file mode 100644 index 7d65a416efc..00000000000 --- a/plotly/validators/surface/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='surface.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/hoverlabel/font/_colorsrc.py b/plotly/validators/surface/hoverlabel/font/_colorsrc.py deleted file mode 100644 index c31144097d8..00000000000 --- a/plotly/validators/surface/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='surface.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/hoverlabel/font/_family.py b/plotly/validators/surface/hoverlabel/font/_family.py deleted file mode 100644 index f47502d383a..00000000000 --- a/plotly/validators/surface/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='surface.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/surface/hoverlabel/font/_familysrc.py b/plotly/validators/surface/hoverlabel/font/_familysrc.py deleted file mode 100644 index 624bf1368cc..00000000000 --- a/plotly/validators/surface/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='surface.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/hoverlabel/font/_size.py b/plotly/validators/surface/hoverlabel/font/_size.py deleted file mode 100644 index c4dcf44299f..00000000000 --- a/plotly/validators/surface/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='surface.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/hoverlabel/font/_sizesrc.py b/plotly/validators/surface/hoverlabel/font/_sizesrc.py deleted file mode 100644 index f50978852b6..00000000000 --- a/plotly/validators/surface/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='surface.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/lighting/__init__.py b/plotly/validators/surface/lighting/__init__.py index 41c014f1ca6..e20adf7b097 100644 --- a/plotly/validators/surface/lighting/__init__.py +++ b/plotly/validators/surface/lighting/__init__.py @@ -1,5 +1,98 @@ -from ._specular import SpecularValidator -from ._roughness import RoughnessValidator -from ._fresnel import FresnelValidator -from ._diffuse import DiffuseValidator -from ._ambient import AmbientValidator + + +import _plotly_utils.basevalidators + + +class SpecularValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='specular', parent_name='surface.lighting', **kwargs + ): + super(SpecularValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 2), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RoughnessValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='roughness', + parent_name='surface.lighting', + **kwargs + ): + super(RoughnessValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FresnelValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='fresnel', parent_name='surface.lighting', **kwargs + ): + super(FresnelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 5), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DiffuseValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='diffuse', parent_name='surface.lighting', **kwargs + ): + super(DiffuseValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AmbientValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='ambient', parent_name='surface.lighting', **kwargs + ): + super(AmbientValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/surface/lighting/_ambient.py b/plotly/validators/surface/lighting/_ambient.py deleted file mode 100644 index 97a139ea165..00000000000 --- a/plotly/validators/surface/lighting/_ambient.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class AmbientValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='ambient', parent_name='surface.lighting', **kwargs - ): - super(AmbientValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/lighting/_diffuse.py b/plotly/validators/surface/lighting/_diffuse.py deleted file mode 100644 index 2c73bde2b7f..00000000000 --- a/plotly/validators/surface/lighting/_diffuse.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class DiffuseValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='diffuse', parent_name='surface.lighting', **kwargs - ): - super(DiffuseValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/lighting/_fresnel.py b/plotly/validators/surface/lighting/_fresnel.py deleted file mode 100644 index 113893ef845..00000000000 --- a/plotly/validators/surface/lighting/_fresnel.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class FresnelValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='fresnel', parent_name='surface.lighting', **kwargs - ): - super(FresnelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 5), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/lighting/_roughness.py b/plotly/validators/surface/lighting/_roughness.py deleted file mode 100644 index a4805de8800..00000000000 --- a/plotly/validators/surface/lighting/_roughness.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class RoughnessValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='roughness', - parent_name='surface.lighting', - **kwargs - ): - super(RoughnessValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/lighting/_specular.py b/plotly/validators/surface/lighting/_specular.py deleted file mode 100644 index 9579b57da7b..00000000000 --- a/plotly/validators/surface/lighting/_specular.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpecularValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='specular', parent_name='surface.lighting', **kwargs - ): - super(SpecularValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 2), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/lightposition/__init__.py b/plotly/validators/surface/lightposition/__init__.py index 438e2dc9c6d..ea1275293ca 100644 --- a/plotly/validators/surface/lightposition/__init__.py +++ b/plotly/validators/surface/lightposition/__init__.py @@ -1,3 +1,57 @@ -from ._z import ZValidator -from ._y import YValidator -from ._x import XValidator + + +import _plotly_utils.basevalidators + + +class ZValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='z', parent_name='surface.lightposition', **kwargs + ): + super(ZValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 100000), + min=kwargs.pop('min', -100000), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='y', parent_name='surface.lightposition', **kwargs + ): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 100000), + min=kwargs.pop('min', -100000), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='x', parent_name='surface.lightposition', **kwargs + ): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 100000), + min=kwargs.pop('min', -100000), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/surface/lightposition/_x.py b/plotly/validators/surface/lightposition/_x.py deleted file mode 100644 index de914af74b6..00000000000 --- a/plotly/validators/surface/lightposition/_x.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='x', parent_name='surface.lightposition', **kwargs - ): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 100000), - min=kwargs.pop('min', -100000), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/lightposition/_y.py b/plotly/validators/surface/lightposition/_y.py deleted file mode 100644 index 51e3476646c..00000000000 --- a/plotly/validators/surface/lightposition/_y.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='y', parent_name='surface.lightposition', **kwargs - ): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 100000), - min=kwargs.pop('min', -100000), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/lightposition/_z.py b/plotly/validators/surface/lightposition/_z.py deleted file mode 100644 index ed739913e36..00000000000 --- a/plotly/validators/surface/lightposition/_z.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ZValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='z', parent_name='surface.lightposition', **kwargs - ): - super(ZValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 100000), - min=kwargs.pop('min', -100000), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/surface/stream/__init__.py b/plotly/validators/surface/stream/__init__.py index 2f4f2047594..5ec613c8bf0 100644 --- a/plotly/validators/surface/stream/__init__.py +++ b/plotly/validators/surface/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='surface.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='surface.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/surface/stream/_maxpoints.py b/plotly/validators/surface/stream/_maxpoints.py deleted file mode 100644 index 5c7de80a219..00000000000 --- a/plotly/validators/surface/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='surface.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/surface/stream/_token.py b/plotly/validators/surface/stream/_token.py deleted file mode 100644 index 3ba755667da..00000000000 --- a/plotly/validators/surface/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='surface.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/table/__init__.py b/plotly/validators/table/__init__.py index 661af2a07a2..f3544e4ac2e 100644 --- a/plotly/validators/table/__init__.py +++ b/plotly/validators/table/__init__.py @@ -1,23 +1,538 @@ -from ._visible import VisibleValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._stream import StreamValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._opacity import OpacityValidator -from ._name import NameValidator -from ._legendgroup import LegendgroupValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._header import HeaderValidator -from ._domain import DomainValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._columnwidthsrc import ColumnwidthsrcValidator -from ._columnwidth import ColumnwidthValidator -from ._columnordersrc import ColumnordersrcValidator -from ._columnorder import ColumnorderValidator -from ._cells import CellsValidator + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='table', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='table', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='table', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='table', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='table', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='table', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='opacity', parent_name='table', **kwargs): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='table', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='table', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='table', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='table', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='table', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='table', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__(self, plotly_name='hoverinfo', parent_name='table', **kwargs): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HeaderValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='header', parent_name='table', **kwargs): + super(HeaderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Header'), + data_docs=kwargs.pop( + 'data_docs', """ + align + Sets the horizontal alignment of the `text` + within the box. Has an effect only if `text` + spans more two or more lines (i.e. `text` + contains one or more
HTML tags) or if an + explicit width is set to override the text + width. + alignsrc + Sets the source reference on plot.ly for align + . + fill + plotly.graph_objs.table.header.Fill instance or + dict with compatible properties + font + plotly.graph_objs.table.header.Font instance or + dict with compatible properties + format + Sets the cell value formatting rule using d3 + formatting mini-language which is similar to + those of Python. See https://github.com/d3/d3-f + ormat/blob/master/README.md#locale_format + formatsrc + Sets the source reference on plot.ly for + format . + height + The height of cells. + line + plotly.graph_objs.table.header.Line instance or + dict with compatible properties + prefix + Prefix for cell values. + prefixsrc + Sets the source reference on plot.ly for + prefix . + suffix + Suffix for cell values. + suffixsrc + Sets the source reference on plot.ly for + suffix . + values + Header cell values. `values[m][n]` represents + the value of the `n`th point in column `m`, + therefore the `values[m]` vector length for all + columns must be the same (longer vectors will + be truncated). Each value must be a finite + number or a string. + valuessrc + Sets the source reference on plot.ly for + values . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='domain', parent_name='table', **kwargs): + super(DomainValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Domain'), + data_docs=kwargs.pop( + 'data_docs', """ + column + If there is a layout grid, use the domain for + this column in the grid for this table trace . + row + If there is a layout grid, use the domain for + this row in the grid for this table trace . + x + Sets the horizontal domain of this table trace + (in plot fraction). + y + Sets the vertical domain of this table trace + (in plot fraction). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='table', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='table', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColumnwidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='columnwidthsrc', parent_name='table', **kwargs + ): + super(ColumnwidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColumnwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='columnwidth', parent_name='table', **kwargs + ): + super(ColumnwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColumnordersrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='columnordersrc', parent_name='table', **kwargs + ): + super(ColumnordersrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColumnorderValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='columnorder', parent_name='table', **kwargs + ): + super(ColumnorderValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CellsValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='cells', parent_name='table', **kwargs): + super(CellsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Cells'), + data_docs=kwargs.pop( + 'data_docs', """ + align + Sets the horizontal alignment of the `text` + within the box. Has an effect only if `text` + spans more two or more lines (i.e. `text` + contains one or more
HTML tags) or if an + explicit width is set to override the text + width. + alignsrc + Sets the source reference on plot.ly for align + . + fill + plotly.graph_objs.table.cells.Fill instance or + dict with compatible properties + font + plotly.graph_objs.table.cells.Font instance or + dict with compatible properties + format + Sets the cell value formatting rule using d3 + formatting mini-language which is similar to + those of Python. See https://github.com/d3/d3-f + ormat/blob/master/README.md#locale_format + formatsrc + Sets the source reference on plot.ly for + format . + height + The height of cells. + line + plotly.graph_objs.table.cells.Line instance or + dict with compatible properties + prefix + Prefix for cell values. + prefixsrc + Sets the source reference on plot.ly for + prefix . + suffix + Suffix for cell values. + suffixsrc + Sets the source reference on plot.ly for + suffix . + values + Cell values. `values[m][n]` represents the + value of the `n`th point in column `m`, + therefore the `values[m]` vector length for all + columns must be the same (longer vectors will + be truncated). Each value must be a finite + number or a string. + valuessrc + Sets the source reference on plot.ly for + values . +""" + ), + **kwargs + ) diff --git a/plotly/validators/table/_cells.py b/plotly/validators/table/_cells.py deleted file mode 100644 index 1ef8c745ca5..00000000000 --- a/plotly/validators/table/_cells.py +++ /dev/null @@ -1,65 +0,0 @@ -import _plotly_utils.basevalidators - - -class CellsValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='cells', parent_name='table', **kwargs): - super(CellsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Cells'), - data_docs=kwargs.pop( - 'data_docs', """ - align - Sets the horizontal alignment of the `text` - within the box. Has an effect only if `text` - spans more two or more lines (i.e. `text` - contains one or more
HTML tags) or if an - explicit width is set to override the text - width. - alignsrc - Sets the source reference on plot.ly for align - . - fill - plotly.graph_objs.table.cells.Fill instance or - dict with compatible properties - font - plotly.graph_objs.table.cells.Font instance or - dict with compatible properties - format - Sets the cell value formatting rule using d3 - formatting mini-language which is similar to - those of Python. See https://github.com/d3/d3-f - ormat/blob/master/README.md#locale_format - formatsrc - Sets the source reference on plot.ly for - format . - height - The height of cells. - line - plotly.graph_objs.table.cells.Line instance or - dict with compatible properties - prefix - Prefix for cell values. - prefixsrc - Sets the source reference on plot.ly for - prefix . - suffix - Suffix for cell values. - suffixsrc - Sets the source reference on plot.ly for - suffix . - values - Cell values. `values[m][n]` represents the - value of the `n`th point in column `m`, - therefore the `values[m]` vector length for all - columns must be the same (longer vectors will - be truncated). Each value must be a finite - number or a string. - valuessrc - Sets the source reference on plot.ly for - values . -""" - ), - **kwargs - ) diff --git a/plotly/validators/table/_columnorder.py b/plotly/validators/table/_columnorder.py deleted file mode 100644 index dfa1a4bfa43..00000000000 --- a/plotly/validators/table/_columnorder.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColumnorderValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='columnorder', parent_name='table', **kwargs - ): - super(ColumnorderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/table/_columnordersrc.py b/plotly/validators/table/_columnordersrc.py deleted file mode 100644 index 674142ef4ca..00000000000 --- a/plotly/validators/table/_columnordersrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColumnordersrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='columnordersrc', parent_name='table', **kwargs - ): - super(ColumnordersrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/_columnwidth.py b/plotly/validators/table/_columnwidth.py deleted file mode 100644 index 07a3d20af7e..00000000000 --- a/plotly/validators/table/_columnwidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColumnwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='columnwidth', parent_name='table', **kwargs - ): - super(ColumnwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/_columnwidthsrc.py b/plotly/validators/table/_columnwidthsrc.py deleted file mode 100644 index ee79a181be5..00000000000 --- a/plotly/validators/table/_columnwidthsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColumnwidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='columnwidthsrc', parent_name='table', **kwargs - ): - super(ColumnwidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/_customdata.py b/plotly/validators/table/_customdata.py deleted file mode 100644 index e0c7750ed23..00000000000 --- a/plotly/validators/table/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='table', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/table/_customdatasrc.py b/plotly/validators/table/_customdatasrc.py deleted file mode 100644 index ff9b67a7cf6..00000000000 --- a/plotly/validators/table/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='table', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/_domain.py b/plotly/validators/table/_domain.py deleted file mode 100644 index d1211ca1fa0..00000000000 --- a/plotly/validators/table/_domain.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class DomainValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='domain', parent_name='table', **kwargs): - super(DomainValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Domain'), - data_docs=kwargs.pop( - 'data_docs', """ - column - If there is a layout grid, use the domain for - this column in the grid for this table trace . - row - If there is a layout grid, use the domain for - this row in the grid for this table trace . - x - Sets the horizontal domain of this table trace - (in plot fraction). - y - Sets the vertical domain of this table trace - (in plot fraction). -""" - ), - **kwargs - ) diff --git a/plotly/validators/table/_header.py b/plotly/validators/table/_header.py deleted file mode 100644 index 3a84e57c306..00000000000 --- a/plotly/validators/table/_header.py +++ /dev/null @@ -1,65 +0,0 @@ -import _plotly_utils.basevalidators - - -class HeaderValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='header', parent_name='table', **kwargs): - super(HeaderValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Header'), - data_docs=kwargs.pop( - 'data_docs', """ - align - Sets the horizontal alignment of the `text` - within the box. Has an effect only if `text` - spans more two or more lines (i.e. `text` - contains one or more
HTML tags) or if an - explicit width is set to override the text - width. - alignsrc - Sets the source reference on plot.ly for align - . - fill - plotly.graph_objs.table.header.Fill instance or - dict with compatible properties - font - plotly.graph_objs.table.header.Font instance or - dict with compatible properties - format - Sets the cell value formatting rule using d3 - formatting mini-language which is similar to - those of Python. See https://github.com/d3/d3-f - ormat/blob/master/README.md#locale_format - formatsrc - Sets the source reference on plot.ly for - format . - height - The height of cells. - line - plotly.graph_objs.table.header.Line instance or - dict with compatible properties - prefix - Prefix for cell values. - prefixsrc - Sets the source reference on plot.ly for - prefix . - suffix - Suffix for cell values. - suffixsrc - Sets the source reference on plot.ly for - suffix . - values - Header cell values. `values[m][n]` represents - the value of the `n`th point in column `m`, - therefore the `values[m]` vector length for all - columns must be the same (longer vectors will - be truncated). Each value must be a finite - number or a string. - valuessrc - Sets the source reference on plot.ly for - values . -""" - ), - **kwargs - ) diff --git a/plotly/validators/table/_hoverinfo.py b/plotly/validators/table/_hoverinfo.py deleted file mode 100644 index 22181d498a6..00000000000 --- a/plotly/validators/table/_hoverinfo.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__(self, plotly_name='hoverinfo', parent_name='table', **kwargs): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/_hoverinfosrc.py b/plotly/validators/table/_hoverinfosrc.py deleted file mode 100644 index e3140d9a02d..00000000000 --- a/plotly/validators/table/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='table', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/_hoverlabel.py b/plotly/validators/table/_hoverlabel.py deleted file mode 100644 index 022d32855b4..00000000000 --- a/plotly/validators/table/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='table', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/table/_ids.py b/plotly/validators/table/_ids.py deleted file mode 100644 index b277fa82ac3..00000000000 --- a/plotly/validators/table/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='table', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/table/_idssrc.py b/plotly/validators/table/_idssrc.py deleted file mode 100644 index cbc2c9179a2..00000000000 --- a/plotly/validators/table/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='table', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/_legendgroup.py b/plotly/validators/table/_legendgroup.py deleted file mode 100644 index 343a69c7c78..00000000000 --- a/plotly/validators/table/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='table', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/_name.py b/plotly/validators/table/_name.py deleted file mode 100644 index c5b76233415..00000000000 --- a/plotly/validators/table/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='table', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/_opacity.py b/plotly/validators/table/_opacity.py deleted file mode 100644 index fc27157f0f8..00000000000 --- a/plotly/validators/table/_opacity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='opacity', parent_name='table', **kwargs): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/_selectedpoints.py b/plotly/validators/table/_selectedpoints.py deleted file mode 100644 index 7f14a12a966..00000000000 --- a/plotly/validators/table/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='table', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/_showlegend.py b/plotly/validators/table/_showlegend.py deleted file mode 100644 index a2e5217eac5..00000000000 --- a/plotly/validators/table/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='table', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/_stream.py b/plotly/validators/table/_stream.py deleted file mode 100644 index c7cb67b946b..00000000000 --- a/plotly/validators/table/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='table', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/table/_uid.py b/plotly/validators/table/_uid.py deleted file mode 100644 index a966b713ff4..00000000000 --- a/plotly/validators/table/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='table', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/_uirevision.py b/plotly/validators/table/_uirevision.py deleted file mode 100644 index e71c0af4cfd..00000000000 --- a/plotly/validators/table/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='table', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/_visible.py b/plotly/validators/table/_visible.py deleted file mode 100644 index ae2b1021001..00000000000 --- a/plotly/validators/table/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='table', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/table/cells/__init__.py b/plotly/validators/table/cells/__init__.py index e3ec984db23..0bf92e246a9 100644 --- a/plotly/validators/table/cells/__init__.py +++ b/plotly/validators/table/cells/__init__.py @@ -1,14 +1,297 @@ -from ._valuessrc import ValuessrcValidator -from ._values import ValuesValidator -from ._suffixsrc import SuffixsrcValidator -from ._suffix import SuffixValidator -from ._prefixsrc import PrefixsrcValidator -from ._prefix import PrefixValidator -from ._line import LineValidator -from ._height import HeightValidator -from ._formatsrc import FormatsrcValidator -from ._format import FormatValidator -from ._font import FontValidator -from ._fill import FillValidator -from ._alignsrc import AlignsrcValidator -from ._align import AlignValidator + + +import _plotly_utils.basevalidators + + +class ValuessrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='valuessrc', parent_name='table.cells', **kwargs + ): + super(ValuessrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValuesValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='values', parent_name='table.cells', **kwargs + ): + super(ValuesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SuffixsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='suffixsrc', parent_name='table.cells', **kwargs + ): + super(SuffixsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='suffix', parent_name='table.cells', **kwargs + ): + super(SuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PrefixsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='prefixsrc', parent_name='table.cells', **kwargs + ): + super(PrefixsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PrefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='prefix', parent_name='table.cells', **kwargs + ): + super(PrefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='table.cells', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + width + + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HeightValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='height', parent_name='table.cells', **kwargs + ): + super(HeightValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FormatsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='formatsrc', parent_name='table.cells', **kwargs + ): + super(FormatsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FormatValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='format', parent_name='table.cells', **kwargs + ): + super(FormatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='table.cells', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='fill', parent_name='table.cells', **kwargs + ): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Fill'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the cell fill color. It accepts either a + specific color or an array of colors or a 2D + array of colors. + colorsrc + Sets the source reference on plot.ly for color + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AlignsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='alignsrc', parent_name='table.cells', **kwargs + ): + super(AlignsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AlignValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='align', parent_name='table.cells', **kwargs + ): + super(AlignValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) diff --git a/plotly/validators/table/cells/_align.py b/plotly/validators/table/cells/_align.py deleted file mode 100644 index 9b46e2c6d91..00000000000 --- a/plotly/validators/table/cells/_align.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class AlignValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='align', parent_name='table.cells', **kwargs - ): - super(AlignValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/table/cells/_alignsrc.py b/plotly/validators/table/cells/_alignsrc.py deleted file mode 100644 index 5e03f5e9ae4..00000000000 --- a/plotly/validators/table/cells/_alignsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AlignsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='alignsrc', parent_name='table.cells', **kwargs - ): - super(AlignsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/cells/_fill.py b/plotly/validators/table/cells/_fill.py deleted file mode 100644 index e1d5db4e55b..00000000000 --- a/plotly/validators/table/cells/_fill.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='fill', parent_name='table.cells', **kwargs - ): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Fill'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the cell fill color. It accepts either a - specific color or an array of colors or a 2D - array of colors. - colorsrc - Sets the source reference on plot.ly for color - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/table/cells/_font.py b/plotly/validators/table/cells/_font.py deleted file mode 100644 index b398daa9ebc..00000000000 --- a/plotly/validators/table/cells/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='table.cells', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/table/cells/_format.py b/plotly/validators/table/cells/_format.py deleted file mode 100644 index 3fe187d2fbd..00000000000 --- a/plotly/validators/table/cells/_format.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FormatValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='format', parent_name='table.cells', **kwargs - ): - super(FormatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/table/cells/_formatsrc.py b/plotly/validators/table/cells/_formatsrc.py deleted file mode 100644 index 0d11d8c139e..00000000000 --- a/plotly/validators/table/cells/_formatsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FormatsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='formatsrc', parent_name='table.cells', **kwargs - ): - super(FormatsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/cells/_height.py b/plotly/validators/table/cells/_height.py deleted file mode 100644 index fca766d3bf3..00000000000 --- a/plotly/validators/table/cells/_height.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HeightValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='height', parent_name='table.cells', **kwargs - ): - super(HeightValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/cells/_line.py b/plotly/validators/table/cells/_line.py deleted file mode 100644 index 506e8900a8e..00000000000 --- a/plotly/validators/table/cells/_line.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='table.cells', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - width - - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/table/cells/_prefix.py b/plotly/validators/table/cells/_prefix.py deleted file mode 100644 index 64f61c4ca4a..00000000000 --- a/plotly/validators/table/cells/_prefix.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class PrefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='prefix', parent_name='table.cells', **kwargs - ): - super(PrefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/cells/_prefixsrc.py b/plotly/validators/table/cells/_prefixsrc.py deleted file mode 100644 index 8e3f0a80b55..00000000000 --- a/plotly/validators/table/cells/_prefixsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class PrefixsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='prefixsrc', parent_name='table.cells', **kwargs - ): - super(PrefixsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/cells/_suffix.py b/plotly/validators/table/cells/_suffix.py deleted file mode 100644 index 767423b52c3..00000000000 --- a/plotly/validators/table/cells/_suffix.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='suffix', parent_name='table.cells', **kwargs - ): - super(SuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/cells/_suffixsrc.py b/plotly/validators/table/cells/_suffixsrc.py deleted file mode 100644 index 4f6acdce928..00000000000 --- a/plotly/validators/table/cells/_suffixsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SuffixsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='suffixsrc', parent_name='table.cells', **kwargs - ): - super(SuffixsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/cells/_values.py b/plotly/validators/table/cells/_values.py deleted file mode 100644 index b6fbcc416f7..00000000000 --- a/plotly/validators/table/cells/_values.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValuesValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='values', parent_name='table.cells', **kwargs - ): - super(ValuesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/table/cells/_valuessrc.py b/plotly/validators/table/cells/_valuessrc.py deleted file mode 100644 index fa5f20822a6..00000000000 --- a/plotly/validators/table/cells/_valuessrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValuessrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='valuessrc', parent_name='table.cells', **kwargs - ): - super(ValuessrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/cells/fill/__init__.py b/plotly/validators/table/cells/fill/__init__.py index e60d2b4c8db..f0f518f88bc 100644 --- a/plotly/validators/table/cells/fill/__init__.py +++ b/plotly/validators/table/cells/fill/__init__.py @@ -1,2 +1,35 @@ -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='table.cells.fill', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='table.cells.fill', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/table/cells/fill/_color.py b/plotly/validators/table/cells/fill/_color.py deleted file mode 100644 index fda65ad5438..00000000000 --- a/plotly/validators/table/cells/fill/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='table.cells.fill', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/cells/fill/_colorsrc.py b/plotly/validators/table/cells/fill/_colorsrc.py deleted file mode 100644 index 7200f515ea4..00000000000 --- a/plotly/validators/table/cells/fill/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='table.cells.fill', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/cells/font/__init__.py b/plotly/validators/table/cells/font/__init__.py index 1d2c591d1e5..0cc9ad5df3c 100644 --- a/plotly/validators/table/cells/font/__init__.py +++ b/plotly/validators/table/cells/font/__init__.py @@ -1,6 +1,111 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='sizesrc', parent_name='table.cells.font', **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='table.cells.font', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='table.cells.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='table.cells.font', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='table.cells.font', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='table.cells.font', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/table/cells/font/_color.py b/plotly/validators/table/cells/font/_color.py deleted file mode 100644 index a5c34d63fc6..00000000000 --- a/plotly/validators/table/cells/font/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='table.cells.font', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/cells/font/_colorsrc.py b/plotly/validators/table/cells/font/_colorsrc.py deleted file mode 100644 index 96e05d80448..00000000000 --- a/plotly/validators/table/cells/font/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='table.cells.font', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/cells/font/_family.py b/plotly/validators/table/cells/font/_family.py deleted file mode 100644 index 06366e20403..00000000000 --- a/plotly/validators/table/cells/font/_family.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='table.cells.font', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/table/cells/font/_familysrc.py b/plotly/validators/table/cells/font/_familysrc.py deleted file mode 100644 index 8b2082a3fae..00000000000 --- a/plotly/validators/table/cells/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='table.cells.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/cells/font/_size.py b/plotly/validators/table/cells/font/_size.py deleted file mode 100644 index 836915b0765..00000000000 --- a/plotly/validators/table/cells/font/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='table.cells.font', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/cells/font/_sizesrc.py b/plotly/validators/table/cells/font/_sizesrc.py deleted file mode 100644 index 0abd1dec1d8..00000000000 --- a/plotly/validators/table/cells/font/_sizesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='sizesrc', parent_name='table.cells.font', **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/cells/line/__init__.py b/plotly/validators/table/cells/line/__init__.py index 1c7b37b04f2..735acaa82d9 100644 --- a/plotly/validators/table/cells/line/__init__.py +++ b/plotly/validators/table/cells/line/__init__.py @@ -1,4 +1,70 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='widthsrc', parent_name='table.cells.line', **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='table.cells.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='colorsrc', parent_name='table.cells.line', **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='table.cells.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/table/cells/line/_color.py b/plotly/validators/table/cells/line/_color.py deleted file mode 100644 index ad6c82c4ecc..00000000000 --- a/plotly/validators/table/cells/line/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='table.cells.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/cells/line/_colorsrc.py b/plotly/validators/table/cells/line/_colorsrc.py deleted file mode 100644 index 2edf807c85b..00000000000 --- a/plotly/validators/table/cells/line/_colorsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='colorsrc', parent_name='table.cells.line', **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/cells/line/_width.py b/plotly/validators/table/cells/line/_width.py deleted file mode 100644 index 381fd463729..00000000000 --- a/plotly/validators/table/cells/line/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='table.cells.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/cells/line/_widthsrc.py b/plotly/validators/table/cells/line/_widthsrc.py deleted file mode 100644 index 0184c51e84b..00000000000 --- a/plotly/validators/table/cells/line/_widthsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='widthsrc', parent_name='table.cells.line', **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/domain/__init__.py b/plotly/validators/table/domain/__init__.py index 6cf32248236..cf3b0bf8175 100644 --- a/plotly/validators/table/domain/__init__.py +++ b/plotly/validators/table/domain/__init__.py @@ -1,4 +1,98 @@ -from ._y import YValidator -from ._x import XValidator -from ._row import RowValidator -from ._column import ColumnValidator + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__(self, plotly_name='y', parent_name='table.domain', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__(self, plotly_name='x', parent_name='table.domain', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + }, + { + 'valType': 'number', + 'min': 0, + 'max': 1, + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class RowValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='row', parent_name='table.domain', **kwargs + ): + super(RowValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, plotly_name='column', parent_name='table.domain', **kwargs + ): + super(ColumnValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/table/domain/_column.py b/plotly/validators/table/domain/_column.py deleted file mode 100644 index 317b97b3303..00000000000 --- a/plotly/validators/table/domain/_column.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColumnValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='column', parent_name='table.domain', **kwargs - ): - super(ColumnValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/domain/_row.py b/plotly/validators/table/domain/_row.py deleted file mode 100644 index 8bcef687774..00000000000 --- a/plotly/validators/table/domain/_row.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class RowValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, plotly_name='row', parent_name='table.domain', **kwargs - ): - super(RowValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/domain/_x.py b/plotly/validators/table/domain/_x.py deleted file mode 100644 index 6b23122461f..00000000000 --- a/plotly/validators/table/domain/_x.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__(self, plotly_name='x', parent_name='table.domain', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/domain/_y.py b/plotly/validators/table/domain/_y.py deleted file mode 100644 index f287863e0fd..00000000000 --- a/plotly/validators/table/domain/_y.py +++ /dev/null @@ -1,29 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__(self, plotly_name='y', parent_name='table.domain', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - }, - { - 'valType': 'number', - 'min': 0, - 'max': 1, - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/header/__init__.py b/plotly/validators/table/header/__init__.py index e3ec984db23..d3406d5bdfb 100644 --- a/plotly/validators/table/header/__init__.py +++ b/plotly/validators/table/header/__init__.py @@ -1,14 +1,297 @@ -from ._valuessrc import ValuessrcValidator -from ._values import ValuesValidator -from ._suffixsrc import SuffixsrcValidator -from ._suffix import SuffixValidator -from ._prefixsrc import PrefixsrcValidator -from ._prefix import PrefixValidator -from ._line import LineValidator -from ._height import HeightValidator -from ._formatsrc import FormatsrcValidator -from ._format import FormatValidator -from ._font import FontValidator -from ._fill import FillValidator -from ._alignsrc import AlignsrcValidator -from ._align import AlignValidator + + +import _plotly_utils.basevalidators + + +class ValuessrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='valuessrc', parent_name='table.header', **kwargs + ): + super(ValuessrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ValuesValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='values', parent_name='table.header', **kwargs + ): + super(ValuesValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SuffixsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='suffixsrc', parent_name='table.header', **kwargs + ): + super(SuffixsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SuffixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='suffix', parent_name='table.header', **kwargs + ): + super(SuffixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PrefixsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='prefixsrc', parent_name='table.header', **kwargs + ): + super(PrefixsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PrefixValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='prefix', parent_name='table.header', **kwargs + ): + super(PrefixValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='table.header', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + width + + widthsrc + Sets the source reference on plot.ly for width + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HeightValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='height', parent_name='table.header', **kwargs + ): + super(HeightValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FormatsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='formatsrc', parent_name='table.header', **kwargs + ): + super(FormatsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FormatValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='format', parent_name='table.header', **kwargs + ): + super(FormatValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='table.header', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='fill', parent_name='table.header', **kwargs + ): + super(FillValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Fill'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the cell fill color. It accepts either a + specific color or an array of colors or a 2D + array of colors. + colorsrc + Sets the source reference on plot.ly for color + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AlignsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='alignsrc', parent_name='table.header', **kwargs + ): + super(AlignsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AlignValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='align', parent_name='table.header', **kwargs + ): + super(AlignValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['left', 'center', 'right']), + **kwargs + ) diff --git a/plotly/validators/table/header/_align.py b/plotly/validators/table/header/_align.py deleted file mode 100644 index 226eaa341de..00000000000 --- a/plotly/validators/table/header/_align.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class AlignValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='align', parent_name='table.header', **kwargs - ): - super(AlignValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['left', 'center', 'right']), - **kwargs - ) diff --git a/plotly/validators/table/header/_alignsrc.py b/plotly/validators/table/header/_alignsrc.py deleted file mode 100644 index 689338a39a7..00000000000 --- a/plotly/validators/table/header/_alignsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AlignsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='alignsrc', parent_name='table.header', **kwargs - ): - super(AlignsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/header/_fill.py b/plotly/validators/table/header/_fill.py deleted file mode 100644 index 415ca6a324c..00000000000 --- a/plotly/validators/table/header/_fill.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='fill', parent_name='table.header', **kwargs - ): - super(FillValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Fill'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the cell fill color. It accepts either a - specific color or an array of colors or a 2D - array of colors. - colorsrc - Sets the source reference on plot.ly for color - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/table/header/_font.py b/plotly/validators/table/header/_font.py deleted file mode 100644 index 563e0b1b258..00000000000 --- a/plotly/validators/table/header/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='table.header', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/table/header/_format.py b/plotly/validators/table/header/_format.py deleted file mode 100644 index 24297d3fc41..00000000000 --- a/plotly/validators/table/header/_format.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FormatValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='format', parent_name='table.header', **kwargs - ): - super(FormatValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/table/header/_formatsrc.py b/plotly/validators/table/header/_formatsrc.py deleted file mode 100644 index 5cdc92ee4ac..00000000000 --- a/plotly/validators/table/header/_formatsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FormatsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='formatsrc', parent_name='table.header', **kwargs - ): - super(FormatsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/header/_height.py b/plotly/validators/table/header/_height.py deleted file mode 100644 index d02bc646b70..00000000000 --- a/plotly/validators/table/header/_height.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HeightValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='height', parent_name='table.header', **kwargs - ): - super(HeightValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/header/_line.py b/plotly/validators/table/header/_line.py deleted file mode 100644 index 2123764b6bb..00000000000 --- a/plotly/validators/table/header/_line.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='table.header', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - width - - widthsrc - Sets the source reference on plot.ly for width - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/table/header/_prefix.py b/plotly/validators/table/header/_prefix.py deleted file mode 100644 index 5a8a7fcd1e5..00000000000 --- a/plotly/validators/table/header/_prefix.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class PrefixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='prefix', parent_name='table.header', **kwargs - ): - super(PrefixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/header/_prefixsrc.py b/plotly/validators/table/header/_prefixsrc.py deleted file mode 100644 index edc92a03a8f..00000000000 --- a/plotly/validators/table/header/_prefixsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class PrefixsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='prefixsrc', parent_name='table.header', **kwargs - ): - super(PrefixsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/header/_suffix.py b/plotly/validators/table/header/_suffix.py deleted file mode 100644 index 6ee8184b89e..00000000000 --- a/plotly/validators/table/header/_suffix.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class SuffixValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='suffix', parent_name='table.header', **kwargs - ): - super(SuffixValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/header/_suffixsrc.py b/plotly/validators/table/header/_suffixsrc.py deleted file mode 100644 index e805f98270c..00000000000 --- a/plotly/validators/table/header/_suffixsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SuffixsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='suffixsrc', parent_name='table.header', **kwargs - ): - super(SuffixsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/header/_values.py b/plotly/validators/table/header/_values.py deleted file mode 100644 index e76e74c4497..00000000000 --- a/plotly/validators/table/header/_values.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValuesValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='values', parent_name='table.header', **kwargs - ): - super(ValuesValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/table/header/_valuessrc.py b/plotly/validators/table/header/_valuessrc.py deleted file mode 100644 index a4c9cda405e..00000000000 --- a/plotly/validators/table/header/_valuessrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ValuessrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='valuessrc', parent_name='table.header', **kwargs - ): - super(ValuessrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/header/fill/__init__.py b/plotly/validators/table/header/fill/__init__.py index e60d2b4c8db..68322e3f5c2 100644 --- a/plotly/validators/table/header/fill/__init__.py +++ b/plotly/validators/table/header/fill/__init__.py @@ -1,2 +1,38 @@ -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='table.header.fill', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='table.header.fill', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/table/header/fill/_color.py b/plotly/validators/table/header/fill/_color.py deleted file mode 100644 index 2d77e99cb53..00000000000 --- a/plotly/validators/table/header/fill/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='table.header.fill', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/header/fill/_colorsrc.py b/plotly/validators/table/header/fill/_colorsrc.py deleted file mode 100644 index 7692416caca..00000000000 --- a/plotly/validators/table/header/fill/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='table.header.fill', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/header/font/__init__.py b/plotly/validators/table/header/font/__init__.py index 1d2c591d1e5..c1766fbcfb3 100644 --- a/plotly/validators/table/header/font/__init__.py +++ b/plotly/validators/table/header/font/__init__.py @@ -1,6 +1,114 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='sizesrc', parent_name='table.header.font', **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='table.header.font', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='table.header.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='family', parent_name='table.header.font', **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='table.header.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='table.header.font', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/table/header/font/_color.py b/plotly/validators/table/header/font/_color.py deleted file mode 100644 index e437fff4965..00000000000 --- a/plotly/validators/table/header/font/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='table.header.font', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/header/font/_colorsrc.py b/plotly/validators/table/header/font/_colorsrc.py deleted file mode 100644 index ba998b85fd3..00000000000 --- a/plotly/validators/table/header/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='table.header.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/header/font/_family.py b/plotly/validators/table/header/font/_family.py deleted file mode 100644 index 4ddb392e30e..00000000000 --- a/plotly/validators/table/header/font/_family.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='family', parent_name='table.header.font', **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/table/header/font/_familysrc.py b/plotly/validators/table/header/font/_familysrc.py deleted file mode 100644 index fa3098fd9eb..00000000000 --- a/plotly/validators/table/header/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='table.header.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/header/font/_size.py b/plotly/validators/table/header/font/_size.py deleted file mode 100644 index a842ed30c41..00000000000 --- a/plotly/validators/table/header/font/_size.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='table.header.font', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/header/font/_sizesrc.py b/plotly/validators/table/header/font/_sizesrc.py deleted file mode 100644 index f7cdfdaa889..00000000000 --- a/plotly/validators/table/header/font/_sizesrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='sizesrc', parent_name='table.header.font', **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/header/line/__init__.py b/plotly/validators/table/header/line/__init__.py index 1c7b37b04f2..debf9b3ba48 100644 --- a/plotly/validators/table/header/line/__init__.py +++ b/plotly/validators/table/header/line/__init__.py @@ -1,4 +1,76 @@ -from ._widthsrc import WidthsrcValidator -from ._width import WidthValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='widthsrc', + parent_name='table.header.line', + **kwargs + ): + super(WidthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='table.header.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='table.header.line', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='table.header.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/table/header/line/_color.py b/plotly/validators/table/header/line/_color.py deleted file mode 100644 index b8b1afcc276..00000000000 --- a/plotly/validators/table/header/line/_color.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='table.header.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/header/line/_colorsrc.py b/plotly/validators/table/header/line/_colorsrc.py deleted file mode 100644 index a7061f1d6a2..00000000000 --- a/plotly/validators/table/header/line/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='table.header.line', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/header/line/_width.py b/plotly/validators/table/header/line/_width.py deleted file mode 100644 index 1b6e7aebb29..00000000000 --- a/plotly/validators/table/header/line/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='table.header.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/header/line/_widthsrc.py b/plotly/validators/table/header/line/_widthsrc.py deleted file mode 100644 index 26f9c5fa103..00000000000 --- a/plotly/validators/table/header/line/_widthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='widthsrc', - parent_name='table.header.line', - **kwargs - ): - super(WidthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/hoverlabel/__init__.py b/plotly/validators/table/hoverlabel/__init__.py index 856f769ba33..3ada40162b2 100644 --- a/plotly/validators/table/hoverlabel/__init__.py +++ b/plotly/validators/table/hoverlabel/__init__.py @@ -1,7 +1,170 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='table.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='table.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='table.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='table.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='table.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='table.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='table.hoverlabel', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/table/hoverlabel/_bgcolor.py b/plotly/validators/table/hoverlabel/_bgcolor.py deleted file mode 100644 index 1cf4cdcf36f..00000000000 --- a/plotly/validators/table/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='table.hoverlabel', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/hoverlabel/_bgcolorsrc.py b/plotly/validators/table/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 61979f15511..00000000000 --- a/plotly/validators/table/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='table.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/hoverlabel/_bordercolor.py b/plotly/validators/table/hoverlabel/_bordercolor.py deleted file mode 100644 index 86b27d2d81a..00000000000 --- a/plotly/validators/table/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='table.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/hoverlabel/_bordercolorsrc.py b/plotly/validators/table/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index e335712ac64..00000000000 --- a/plotly/validators/table/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='table.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/hoverlabel/_font.py b/plotly/validators/table/hoverlabel/_font.py deleted file mode 100644 index 0c65e083cbc..00000000000 --- a/plotly/validators/table/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='table.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/table/hoverlabel/_namelength.py b/plotly/validators/table/hoverlabel/_namelength.py deleted file mode 100644 index a0c8f6e59bd..00000000000 --- a/plotly/validators/table/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='table.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/hoverlabel/_namelengthsrc.py b/plotly/validators/table/hoverlabel/_namelengthsrc.py deleted file mode 100644 index c8ed372667b..00000000000 --- a/plotly/validators/table/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='table.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/hoverlabel/font/__init__.py b/plotly/validators/table/hoverlabel/font/__init__.py index 1d2c591d1e5..3a1b8448826 100644 --- a/plotly/validators/table/hoverlabel/font/__init__.py +++ b/plotly/validators/table/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='table.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='table.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='table.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='table.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='table.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='table.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/table/hoverlabel/font/_color.py b/plotly/validators/table/hoverlabel/font/_color.py deleted file mode 100644 index bdd62b18828..00000000000 --- a/plotly/validators/table/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='table.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/hoverlabel/font/_colorsrc.py b/plotly/validators/table/hoverlabel/font/_colorsrc.py deleted file mode 100644 index 5515098f6c3..00000000000 --- a/plotly/validators/table/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='table.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/hoverlabel/font/_family.py b/plotly/validators/table/hoverlabel/font/_family.py deleted file mode 100644 index f379dcd7e1b..00000000000 --- a/plotly/validators/table/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='table.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/table/hoverlabel/font/_familysrc.py b/plotly/validators/table/hoverlabel/font/_familysrc.py deleted file mode 100644 index 9ba4cfc1ebd..00000000000 --- a/plotly/validators/table/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='table.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/hoverlabel/font/_size.py b/plotly/validators/table/hoverlabel/font/_size.py deleted file mode 100644 index 78fa0351658..00000000000 --- a/plotly/validators/table/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='table.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/table/hoverlabel/font/_sizesrc.py b/plotly/validators/table/hoverlabel/font/_sizesrc.py deleted file mode 100644 index b72198c1d28..00000000000 --- a/plotly/validators/table/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='table.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/stream/__init__.py b/plotly/validators/table/stream/__init__.py index 2f4f2047594..eb452040f26 100644 --- a/plotly/validators/table/stream/__init__.py +++ b/plotly/validators/table/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='table.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='table.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/table/stream/_maxpoints.py b/plotly/validators/table/stream/_maxpoints.py deleted file mode 100644 index 6acae34e467..00000000000 --- a/plotly/validators/table/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='table.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/table/stream/_token.py b/plotly/validators/table/stream/_token.py deleted file mode 100644 index 4c4a8b9d8c7..00000000000 --- a/plotly/validators/table/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='table.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/violin/__init__.py b/plotly/validators/violin/__init__.py index fc3bd849683..0268b7d2469 100644 --- a/plotly/validators/violin/__init__.py +++ b/plotly/validators/violin/__init__.py @@ -1,49 +1,927 @@ -from ._ysrc import YsrcValidator -from ._yaxis import YAxisValidator -from ._y0 import Y0Validator -from ._y import YValidator -from ._xsrc import XsrcValidator -from ._xaxis import XAxisValidator -from ._x0 import X0Validator -from ._x import XValidator -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._unselected import UnselectedValidator -from ._uirevision import UirevisionValidator -from ._uid import UidValidator -from ._textsrc import TextsrcValidator -from ._text import TextValidator -from ._stream import StreamValidator -from ._spanmode import SpanmodeValidator -from ._span import SpanValidator -from ._side import SideValidator -from ._showlegend import ShowlegendValidator -from ._selectedpoints import SelectedpointsValidator -from ._selected import SelectedValidator -from ._scalemode import ScalemodeValidator -from ._scalegroup import ScalegroupValidator -from ._points import PointsValidator -from ._pointpos import PointposValidator -from ._orientation import OrientationValidator -from ._opacity import OpacityValidator -from ._offsetgroup import OffsetgroupValidator -from ._name import NameValidator -from ._meanline import MeanlineValidator -from ._marker import MarkerValidator -from ._line import LineValidator -from ._legendgroup import LegendgroupValidator -from ._jitter import JitterValidator -from ._idssrc import IdssrcValidator -from ._ids import IdsValidator -from ._hovertextsrc import HovertextsrcValidator -from ._hovertext import HovertextValidator -from ._hoveron import HoveronValidator -from ._hoverlabel import HoverlabelValidator -from ._hoverinfosrc import HoverinfosrcValidator -from ._hoverinfo import HoverinfoValidator -from ._fillcolor import FillcolorValidator -from ._customdatasrc import CustomdatasrcValidator -from ._customdata import CustomdataValidator -from ._box import BoxValidator -from ._bandwidth import BandwidthValidator -from ._alignmentgroup import AlignmentgroupValidator + + +import _plotly_utils.basevalidators + + +class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='ysrc', parent_name='violin', **kwargs): + super(YsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='yaxis', parent_name='violin', **kwargs): + super(YAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'y'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class Y0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='y0', parent_name='violin', **kwargs): + super(Y0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class YValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='y', parent_name='violin', **kwargs): + super(YValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='xsrc', parent_name='violin', **kwargs): + super(XsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): + + def __init__(self, plotly_name='xaxis', parent_name='violin', **kwargs): + super(XAxisValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + dflt=kwargs.pop('dflt', 'x'), + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class X0Validator(_plotly_utils.basevalidators.AnyValidator): + + def __init__(self, plotly_name='x0', parent_name='violin', **kwargs): + super(X0Validator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class XValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='x', parent_name='violin', **kwargs): + super(XValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='width', parent_name='violin', **kwargs): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='visible', parent_name='violin', **kwargs): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', [True, False, 'legendonly']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='unselected', parent_name='violin', **kwargs + ): + super(UnselectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Unselected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.violin.unselected.Marker + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='uirevision', parent_name='violin', **kwargs + ): + super(UirevisionValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class UidValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='uid', parent_name='violin', **kwargs): + super(UidValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='textsrc', parent_name='violin', **kwargs): + super(TextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class TextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='text', parent_name='violin', **kwargs): + super(TextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='stream', parent_name='violin', **kwargs): + super(StreamValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Stream'), + data_docs=kwargs.pop( + 'data_docs', """ + maxpoints + Sets the maximum number of points to keep on + the plots from an incoming stream. If + `maxpoints` is set to 50, only the newest 50 + points will be displayed on the plot. + token + The stream id number links a data trace on a + plot with a stream. See + https://plot.ly/settings for more details. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpanmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='spanmode', parent_name='violin', **kwargs): + super(SpanmodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['soft', 'hard', 'manual']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SpanValidator(_plotly_utils.basevalidators.InfoArrayValidator): + + def __init__(self, plotly_name='span', parent_name='violin', **kwargs): + super(SpanValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + items=kwargs.pop( + 'items', [ + { + 'valType': 'any', + 'editType': 'calc' + }, { + 'valType': 'any', + 'editType': 'calc' + } + ] + ), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='side', parent_name='violin', **kwargs): + super(SideValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['both', 'positive', 'negative']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='showlegend', parent_name='violin', **kwargs + ): + super(ShowlegendValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): + + def __init__( + self, plotly_name='selectedpoints', parent_name='violin', **kwargs + ): + super(SelectedpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='selected', parent_name='violin', **kwargs): + super(SelectedValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Selected'), + data_docs=kwargs.pop( + 'data_docs', """ + marker + plotly.graph_objs.violin.selected.Marker + instance or dict with compatible properties +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScalemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='scalemode', parent_name='violin', **kwargs + ): + super(ScalemodeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + values=kwargs.pop('values', ['width', 'count']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ScalegroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='scalegroup', parent_name='violin', **kwargs + ): + super(ScalegroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PointsValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__(self, plotly_name='points', parent_name='violin', **kwargs): + super(PointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', ['all', 'outliers', 'suspectedoutliers', False] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class PointposValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='pointpos', parent_name='violin', **kwargs): + super(PointposValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 2), + min=kwargs.pop('min', -2), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OrientationValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='orientation', parent_name='violin', **kwargs + ): + super(OrientationValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop('values', ['v', 'h']), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='opacity', parent_name='violin', **kwargs): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OffsetgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='offsetgroup', parent_name='violin', **kwargs + ): + super(OffsetgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NameValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__(self, plotly_name='name', parent_name='violin', **kwargs): + super(NameValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MeanlineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='meanline', parent_name='violin', **kwargs): + super(MeanlineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Meanline'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the mean line color. + visible + Determines if a line corresponding to the + sample's mean is shown inside the violins. If + `box.visible` is turned on, the mean line is + drawn inside the inner box. Otherwise, the mean + line is drawn from one side of the violin to + other. + width + Sets the mean line width. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='marker', parent_name='violin', **kwargs): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets themarkercolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + line + plotly.graph_objs.violin.marker.Line instance + or dict with compatible properties + opacity + Sets the marker opacity. + outliercolor + Sets the color of the outlier sample points. + size + Sets the marker size (in px). + symbol + Sets the marker symbol type. Adding 100 is + equivalent to appending "-open" to a symbol + name. Adding 200 is equivalent to appending + "-dot" to a symbol name. Adding 300 is + equivalent to appending "-open-dot" or "dot- + open" to a symbol name. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='line', parent_name='violin', **kwargs): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the color of line bounding the violin(s). + width + Sets the width (in px) of line bounding the + violin(s). +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='legendgroup', parent_name='violin', **kwargs + ): + super(LegendgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class JitterValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__(self, plotly_name='jitter', parent_name='violin', **kwargs): + super(JitterValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__(self, plotly_name='idssrc', parent_name='violin', **kwargs): + super(IdssrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__(self, plotly_name='ids', parent_name='violin', **kwargs): + super(IdsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hovertextsrc', parent_name='violin', **kwargs + ): + super(HovertextsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HovertextValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='hovertext', parent_name='violin', **kwargs + ): + super(HovertextValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoveronValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__(self, plotly_name='hoveron', parent_name='violin', **kwargs): + super(HoveronValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + extras=kwargs.pop('extras', ['all']), + flags=kwargs.pop('flags', ['violins', 'points', 'kde']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='hoverlabel', parent_name='violin', **kwargs + ): + super(HoverlabelValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), + data_docs=kwargs.pop( + 'data_docs', """ + bgcolor + Sets the background color of the hover labels + for this trace + bgcolorsrc + Sets the source reference on plot.ly for + bgcolor . + bordercolor + Sets the border color of the hover labels for + this trace. + bordercolorsrc + Sets the source reference on plot.ly for + bordercolor . + font + Sets the font used in hover labels. + namelength + Sets the length (in number of characters) of + the trace name in the hover labels for this + trace. -1 shows the whole name regardless of + length. 0-3 shows the first 0-3 characters, and + an integer >3 will show the whole name if it is + less than that many characters, but if it is + longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on plot.ly for + namelength . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='hoverinfosrc', parent_name='violin', **kwargs + ): + super(HoverinfosrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): + + def __init__( + self, plotly_name='hoverinfo', parent_name='violin', **kwargs + ): + super(HoverinfoValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + extras=kwargs.pop('extras', ['all', 'none', 'skip']), + flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='fillcolor', parent_name='violin', **kwargs + ): + super(FillcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, plotly_name='customdatasrc', parent_name='violin', **kwargs + ): + super(CustomdatasrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): + + def __init__( + self, plotly_name='customdata', parent_name='violin', **kwargs + ): + super(CustomdataValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'data'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BoxValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='box', parent_name='violin', **kwargs): + super(BoxValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Box'), + data_docs=kwargs.pop( + 'data_docs', """ + fillcolor + Sets the inner box plot fill color. + line + plotly.graph_objs.violin.box.Line instance or + dict with compatible properties + visible + Determines if an miniature box plot is drawn + inside the violins. + width + Sets the width of the inner box plots relative + to the violins' width. For example, with 1, the + inner box plots are as wide as the violins. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BandwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='bandwidth', parent_name='violin', **kwargs + ): + super(BandwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class AlignmentgroupValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='alignmentgroup', parent_name='violin', **kwargs + ): + super(AlignmentgroupValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/violin/_alignmentgroup.py b/plotly/validators/violin/_alignmentgroup.py deleted file mode 100644 index f1a59e22cda..00000000000 --- a/plotly/validators/violin/_alignmentgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class AlignmentgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='alignmentgroup', parent_name='violin', **kwargs - ): - super(AlignmentgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_bandwidth.py b/plotly/validators/violin/_bandwidth.py deleted file mode 100644 index aa87ea3740e..00000000000 --- a/plotly/validators/violin/_bandwidth.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BandwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='bandwidth', parent_name='violin', **kwargs - ): - super(BandwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_box.py b/plotly/validators/violin/_box.py deleted file mode 100644 index df2014badfc..00000000000 --- a/plotly/validators/violin/_box.py +++ /dev/null @@ -1,28 +0,0 @@ -import _plotly_utils.basevalidators - - -class BoxValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='box', parent_name='violin', **kwargs): - super(BoxValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Box'), - data_docs=kwargs.pop( - 'data_docs', """ - fillcolor - Sets the inner box plot fill color. - line - plotly.graph_objs.violin.box.Line instance or - dict with compatible properties - visible - Determines if an miniature box plot is drawn - inside the violins. - width - Sets the width of the inner box plots relative - to the violins' width. For example, with 1, the - inner box plots are as wide as the violins. -""" - ), - **kwargs - ) diff --git a/plotly/validators/violin/_customdata.py b/plotly/validators/violin/_customdata.py deleted file mode 100644 index 8a9015fa41d..00000000000 --- a/plotly/validators/violin/_customdata.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdataValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__( - self, plotly_name='customdata', parent_name='violin', **kwargs - ): - super(CustomdataValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/violin/_customdatasrc.py b/plotly/validators/violin/_customdatasrc.py deleted file mode 100644 index d8aa7b84f16..00000000000 --- a/plotly/validators/violin/_customdatasrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class CustomdatasrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='customdatasrc', parent_name='violin', **kwargs - ): - super(CustomdatasrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_fillcolor.py b/plotly/validators/violin/_fillcolor.py deleted file mode 100644 index a5607dbab1f..00000000000 --- a/plotly/validators/violin/_fillcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='fillcolor', parent_name='violin', **kwargs - ): - super(FillcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/_hoverinfo.py b/plotly/validators/violin/_hoverinfo.py deleted file mode 100644 index 2a83269ead3..00000000000 --- a/plotly/validators/violin/_hoverinfo.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfoValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__( - self, plotly_name='hoverinfo', parent_name='violin', **kwargs - ): - super(HoverinfoValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - extras=kwargs.pop('extras', ['all', 'none', 'skip']), - flags=kwargs.pop('flags', ['x', 'y', 'z', 'text', 'name']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_hoverinfosrc.py b/plotly/validators/violin/_hoverinfosrc.py deleted file mode 100644 index 26e24bcc61d..00000000000 --- a/plotly/validators/violin/_hoverinfosrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverinfosrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hoverinfosrc', parent_name='violin', **kwargs - ): - super(HoverinfosrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_hoverlabel.py b/plotly/validators/violin/_hoverlabel.py deleted file mode 100644 index 423790cd324..00000000000 --- a/plotly/validators/violin/_hoverlabel.py +++ /dev/null @@ -1,44 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoverlabelValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='hoverlabel', parent_name='violin', **kwargs - ): - super(HoverlabelValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Hoverlabel'), - data_docs=kwargs.pop( - 'data_docs', """ - bgcolor - Sets the background color of the hover labels - for this trace - bgcolorsrc - Sets the source reference on plot.ly for - bgcolor . - bordercolor - Sets the border color of the hover labels for - this trace. - bordercolorsrc - Sets the source reference on plot.ly for - bordercolor . - font - Sets the font used in hover labels. - namelength - Sets the length (in number of characters) of - the trace name in the hover labels for this - trace. -1 shows the whole name regardless of - length. 0-3 shows the first 0-3 characters, and - an integer >3 will show the whole name if it is - less than that many characters, but if it is - longer, will truncate to `namelength - 3` - characters and add an ellipsis. - namelengthsrc - Sets the source reference on plot.ly for - namelength . -""" - ), - **kwargs - ) diff --git a/plotly/validators/violin/_hoveron.py b/plotly/validators/violin/_hoveron.py deleted file mode 100644 index 210e5325347..00000000000 --- a/plotly/validators/violin/_hoveron.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HoveronValidator(_plotly_utils.basevalidators.FlaglistValidator): - - def __init__(self, plotly_name='hoveron', parent_name='violin', **kwargs): - super(HoveronValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - extras=kwargs.pop('extras', ['all']), - flags=kwargs.pop('flags', ['violins', 'points', 'kde']), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_hovertext.py b/plotly/validators/violin/_hovertext.py deleted file mode 100644 index 840af94dcee..00000000000 --- a/plotly/validators/violin/_hovertext.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='hovertext', parent_name='violin', **kwargs - ): - super(HovertextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_hovertextsrc.py b/plotly/validators/violin/_hovertextsrc.py deleted file mode 100644 index 6aa1c0801c5..00000000000 --- a/plotly/validators/violin/_hovertextsrc.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class HovertextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, plotly_name='hovertextsrc', parent_name='violin', **kwargs - ): - super(HovertextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_ids.py b/plotly/validators/violin/_ids.py deleted file mode 100644 index 9c31b1d8d2a..00000000000 --- a/plotly/validators/violin/_ids.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdsValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='ids', parent_name='violin', **kwargs): - super(IdsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/violin/_idssrc.py b/plotly/validators/violin/_idssrc.py deleted file mode 100644 index b00849ccb74..00000000000 --- a/plotly/validators/violin/_idssrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class IdssrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='idssrc', parent_name='violin', **kwargs): - super(IdssrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_jitter.py b/plotly/validators/violin/_jitter.py deleted file mode 100644 index f659bb7600d..00000000000 --- a/plotly/validators/violin/_jitter.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class JitterValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='jitter', parent_name='violin', **kwargs): - super(JitterValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/_legendgroup.py b/plotly/validators/violin/_legendgroup.py deleted file mode 100644 index 22e2bd95ce5..00000000000 --- a/plotly/validators/violin/_legendgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class LegendgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='legendgroup', parent_name='violin', **kwargs - ): - super(LegendgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_line.py b/plotly/validators/violin/_line.py deleted file mode 100644 index 19055bb9ebe..00000000000 --- a/plotly/validators/violin/_line.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='line', parent_name='violin', **kwargs): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the color of line bounding the violin(s). - width - Sets the width (in px) of line bounding the - violin(s). -""" - ), - **kwargs - ) diff --git a/plotly/validators/violin/_marker.py b/plotly/validators/violin/_marker.py deleted file mode 100644 index c349da23b81..00000000000 --- a/plotly/validators/violin/_marker.py +++ /dev/null @@ -1,38 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='marker', parent_name='violin', **kwargs): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets themarkercolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.cmin` and `marker.cmax` if set. - line - plotly.graph_objs.violin.marker.Line instance - or dict with compatible properties - opacity - Sets the marker opacity. - outliercolor - Sets the color of the outlier sample points. - size - Sets the marker size (in px). - symbol - Sets the marker symbol type. Adding 100 is - equivalent to appending "-open" to a symbol - name. Adding 200 is equivalent to appending - "-dot" to a symbol name. Adding 300 is - equivalent to appending "-open-dot" or "dot- - open" to a symbol name. -""" - ), - **kwargs - ) diff --git a/plotly/validators/violin/_meanline.py b/plotly/validators/violin/_meanline.py deleted file mode 100644 index 21e432da7e8..00000000000 --- a/plotly/validators/violin/_meanline.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class MeanlineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='meanline', parent_name='violin', **kwargs): - super(MeanlineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Meanline'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the mean line color. - visible - Determines if a line corresponding to the - sample's mean is shown inside the violins. If - `box.visible` is turned on, the mean line is - drawn inside the inner box. Otherwise, the mean - line is drawn from one side of the violin to - other. - width - Sets the mean line width. -""" - ), - **kwargs - ) diff --git a/plotly/validators/violin/_name.py b/plotly/validators/violin/_name.py deleted file mode 100644 index 390a2c5249b..00000000000 --- a/plotly/validators/violin/_name.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class NameValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='name', parent_name='violin', **kwargs): - super(NameValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_offsetgroup.py b/plotly/validators/violin/_offsetgroup.py deleted file mode 100644 index 27d6a65b296..00000000000 --- a/plotly/validators/violin/_offsetgroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OffsetgroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='offsetgroup', parent_name='violin', **kwargs - ): - super(OffsetgroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_opacity.py b/plotly/validators/violin/_opacity.py deleted file mode 100644 index 486273be223..00000000000 --- a/plotly/validators/violin/_opacity.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='opacity', parent_name='violin', **kwargs): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/_orientation.py b/plotly/validators/violin/_orientation.py deleted file mode 100644 index 6a5298c1a4a..00000000000 --- a/plotly/validators/violin/_orientation.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class OrientationValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='orientation', parent_name='violin', **kwargs - ): - super(OrientationValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop('values', ['v', 'h']), - **kwargs - ) diff --git a/plotly/validators/violin/_pointpos.py b/plotly/validators/violin/_pointpos.py deleted file mode 100644 index 24f7d925874..00000000000 --- a/plotly/validators/violin/_pointpos.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class PointposValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='pointpos', parent_name='violin', **kwargs): - super(PointposValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 2), - min=kwargs.pop('min', -2), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/_points.py b/plotly/validators/violin/_points.py deleted file mode 100644 index 6120cfb2254..00000000000 --- a/plotly/validators/violin/_points.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class PointsValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='points', parent_name='violin', **kwargs): - super(PointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', ['all', 'outliers', 'suspectedoutliers', False] - ), - **kwargs - ) diff --git a/plotly/validators/violin/_scalegroup.py b/plotly/validators/violin/_scalegroup.py deleted file mode 100644 index c4babf2d55e..00000000000 --- a/plotly/validators/violin/_scalegroup.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScalegroupValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='scalegroup', parent_name='violin', **kwargs - ): - super(ScalegroupValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_scalemode.py b/plotly/validators/violin/_scalemode.py deleted file mode 100644 index 6af4e6489e6..00000000000 --- a/plotly/validators/violin/_scalemode.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class ScalemodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='scalemode', parent_name='violin', **kwargs - ): - super(ScalemodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['width', 'count']), - **kwargs - ) diff --git a/plotly/validators/violin/_selected.py b/plotly/validators/violin/_selected.py deleted file mode 100644 index cc085aa98c2..00000000000 --- a/plotly/validators/violin/_selected.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='selected', parent_name='violin', **kwargs): - super(SelectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Selected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.violin.selected.Marker - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/violin/_selectedpoints.py b/plotly/validators/violin/_selectedpoints.py deleted file mode 100644 index bbe55c6aa94..00000000000 --- a/plotly/validators/violin/_selectedpoints.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class SelectedpointsValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='selectedpoints', parent_name='violin', **kwargs - ): - super(SelectedpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_showlegend.py b/plotly/validators/violin/_showlegend.py deleted file mode 100644 index 18e3aa4b4f7..00000000000 --- a/plotly/validators/violin/_showlegend.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ShowlegendValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='showlegend', parent_name='violin', **kwargs - ): - super(ShowlegendValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_side.py b/plotly/validators/violin/_side.py deleted file mode 100644 index c515dd90381..00000000000 --- a/plotly/validators/violin/_side.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class SideValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='side', parent_name='violin', **kwargs): - super(SideValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['both', 'positive', 'negative']), - **kwargs - ) diff --git a/plotly/validators/violin/_span.py b/plotly/validators/violin/_span.py deleted file mode 100644 index 44a0a025d0c..00000000000 --- a/plotly/validators/violin/_span.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpanValidator(_plotly_utils.basevalidators.InfoArrayValidator): - - def __init__(self, plotly_name='span', parent_name='violin', **kwargs): - super(SpanValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - items=kwargs.pop( - 'items', [ - { - 'valType': 'any', - 'editType': 'calc' - }, { - 'valType': 'any', - 'editType': 'calc' - } - ] - ), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_spanmode.py b/plotly/validators/violin/_spanmode.py deleted file mode 100644 index 763c6488d3b..00000000000 --- a/plotly/validators/violin/_spanmode.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class SpanmodeValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='spanmode', parent_name='violin', **kwargs): - super(SpanmodeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', ['soft', 'hard', 'manual']), - **kwargs - ) diff --git a/plotly/validators/violin/_stream.py b/plotly/validators/violin/_stream.py deleted file mode 100644 index 096ed2411f9..00000000000 --- a/plotly/validators/violin/_stream.py +++ /dev/null @@ -1,25 +0,0 @@ -import _plotly_utils.basevalidators - - -class StreamValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='stream', parent_name='violin', **kwargs): - super(StreamValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Stream'), - data_docs=kwargs.pop( - 'data_docs', """ - maxpoints - Sets the maximum number of points to keep on - the plots from an incoming stream. If - `maxpoints` is set to 50, only the newest 50 - points will be displayed on the plot. - token - The stream id number links a data trace on a - plot with a stream. See - https://plot.ly/settings for more details. -""" - ), - **kwargs - ) diff --git a/plotly/validators/violin/_text.py b/plotly/validators/violin/_text.py deleted file mode 100644 index 21e7da290ca..00000000000 --- a/plotly/validators/violin/_text.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='text', parent_name='violin', **kwargs): - super(TextValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_textsrc.py b/plotly/validators/violin/_textsrc.py deleted file mode 100644 index 4b97f2d180d..00000000000 --- a/plotly/validators/violin/_textsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class TextsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='textsrc', parent_name='violin', **kwargs): - super(TextsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_uid.py b/plotly/validators/violin/_uid.py deleted file mode 100644 index 523a2994214..00000000000 --- a/plotly/validators/violin/_uid.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class UidValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__(self, plotly_name='uid', parent_name='violin', **kwargs): - super(UidValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_uirevision.py b/plotly/validators/violin/_uirevision.py deleted file mode 100644 index 5ed8d07b15d..00000000000 --- a/plotly/validators/violin/_uirevision.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class UirevisionValidator(_plotly_utils.basevalidators.AnyValidator): - - def __init__( - self, plotly_name='uirevision', parent_name='violin', **kwargs - ): - super(UirevisionValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_unselected.py b/plotly/validators/violin/_unselected.py deleted file mode 100644 index ed687d70bb8..00000000000 --- a/plotly/validators/violin/_unselected.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class UnselectedValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='unselected', parent_name='violin', **kwargs - ): - super(UnselectedValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Unselected'), - data_docs=kwargs.pop( - 'data_docs', """ - marker - plotly.graph_objs.violin.unselected.Marker - instance or dict with compatible properties -""" - ), - **kwargs - ) diff --git a/plotly/validators/violin/_visible.py b/plotly/validators/violin/_visible.py deleted file mode 100644 index c3306b87864..00000000000 --- a/plotly/validators/violin/_visible.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__(self, plotly_name='visible', parent_name='violin', **kwargs): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - role=kwargs.pop('role', 'info'), - values=kwargs.pop('values', [True, False, 'legendonly']), - **kwargs - ) diff --git a/plotly/validators/violin/_width.py b/plotly/validators/violin/_width.py deleted file mode 100644 index 08fbd1ca724..00000000000 --- a/plotly/validators/violin/_width.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__(self, plotly_name='width', parent_name='violin', **kwargs): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_x.py b/plotly/validators/violin/_x.py deleted file mode 100644 index 091cf528fb1..00000000000 --- a/plotly/validators/violin/_x.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='x', parent_name='violin', **kwargs): - super(XValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/violin/_x0.py b/plotly/validators/violin/_x0.py deleted file mode 100644 index d8451ebb2bf..00000000000 --- a/plotly/validators/violin/_x0.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class X0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='x0', parent_name='violin', **kwargs): - super(X0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_xaxis.py b/plotly/validators/violin/_xaxis.py deleted file mode 100644 index a9bca9e4fe8..00000000000 --- a/plotly/validators/violin/_xaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class XAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='xaxis', parent_name='violin', **kwargs): - super(XAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'x'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_xsrc.py b/plotly/validators/violin/_xsrc.py deleted file mode 100644 index aae858df66b..00000000000 --- a/plotly/validators/violin/_xsrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class XsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='xsrc', parent_name='violin', **kwargs): - super(XsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_y.py b/plotly/validators/violin/_y.py deleted file mode 100644 index 9c3a8b3d9ed..00000000000 --- a/plotly/validators/violin/_y.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YValidator(_plotly_utils.basevalidators.DataArrayValidator): - - def __init__(self, plotly_name='y', parent_name='violin', **kwargs): - super(YValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'data'), - **kwargs - ) diff --git a/plotly/validators/violin/_y0.py b/plotly/validators/violin/_y0.py deleted file mode 100644 index b47f8b16b69..00000000000 --- a/plotly/validators/violin/_y0.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class Y0Validator(_plotly_utils.basevalidators.AnyValidator): - - def __init__(self, plotly_name='y0', parent_name='violin', **kwargs): - super(Y0Validator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_yaxis.py b/plotly/validators/violin/_yaxis.py deleted file mode 100644 index f4369157e6c..00000000000 --- a/plotly/validators/violin/_yaxis.py +++ /dev/null @@ -1,14 +0,0 @@ -import _plotly_utils.basevalidators - - -class YAxisValidator(_plotly_utils.basevalidators.SubplotidValidator): - - def __init__(self, plotly_name='yaxis', parent_name='violin', **kwargs): - super(YAxisValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - dflt=kwargs.pop('dflt', 'y'), - edit_type=kwargs.pop('edit_type', 'calc+clearAxisTypes'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/_ysrc.py b/plotly/validators/violin/_ysrc.py deleted file mode 100644 index fdffb756178..00000000000 --- a/plotly/validators/violin/_ysrc.py +++ /dev/null @@ -1,13 +0,0 @@ -import _plotly_utils.basevalidators - - -class YsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__(self, plotly_name='ysrc', parent_name='violin', **kwargs): - super(YsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/box/__init__.py b/plotly/validators/violin/box/__init__.py index 445ae7b9440..067cff3a6ef 100644 --- a/plotly/validators/violin/box/__init__.py +++ b/plotly/validators/violin/box/__init__.py @@ -1,4 +1,75 @@ -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._line import LineValidator -from ._fillcolor import FillcolorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='violin.box', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='violin.box', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__(self, plotly_name='line', parent_name='violin.box', **kwargs): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the inner box plot bounding line color. + width + Sets the inner box plot bounding line width. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='fillcolor', parent_name='violin.box', **kwargs + ): + super(FillcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/violin/box/_fillcolor.py b/plotly/validators/violin/box/_fillcolor.py deleted file mode 100644 index 79d7fde3efe..00000000000 --- a/plotly/validators/violin/box/_fillcolor.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class FillcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='fillcolor', parent_name='violin.box', **kwargs - ): - super(FillcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/box/_line.py b/plotly/validators/violin/box/_line.py deleted file mode 100644 index f605a3fcb01..00000000000 --- a/plotly/validators/violin/box/_line.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__(self, plotly_name='line', parent_name='violin.box', **kwargs): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the inner box plot bounding line color. - width - Sets the inner box plot bounding line width. -""" - ), - **kwargs - ) diff --git a/plotly/validators/violin/box/_visible.py b/plotly/validators/violin/box/_visible.py deleted file mode 100644 index 7fca19fa36d..00000000000 --- a/plotly/validators/violin/box/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='violin.box', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/box/_width.py b/plotly/validators/violin/box/_width.py deleted file mode 100644 index 992f2476701..00000000000 --- a/plotly/validators/violin/box/_width.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='violin.box', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/box/line/__init__.py b/plotly/validators/violin/box/line/__init__.py index 7806a9a1cdc..8c0386c0a80 100644 --- a/plotly/validators/violin/box/line/__init__.py +++ b/plotly/validators/violin/box/line/__init__.py @@ -1,2 +1,35 @@ -from ._width import WidthValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='violin.box.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='violin.box.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/violin/box/line/_color.py b/plotly/validators/violin/box/line/_color.py deleted file mode 100644 index 55ba76244c1..00000000000 --- a/plotly/validators/violin/box/line/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='violin.box.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/box/line/_width.py b/plotly/validators/violin/box/line/_width.py deleted file mode 100644 index c43e1ee4b51..00000000000 --- a/plotly/validators/violin/box/line/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='violin.box.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/hoverlabel/__init__.py b/plotly/validators/violin/hoverlabel/__init__.py index 856f769ba33..d280e51c84c 100644 --- a/plotly/validators/violin/hoverlabel/__init__.py +++ b/plotly/validators/violin/hoverlabel/__init__.py @@ -1,7 +1,170 @@ -from ._namelengthsrc import NamelengthsrcValidator -from ._namelength import NamelengthValidator -from ._font import FontValidator -from ._bordercolorsrc import BordercolorsrcValidator -from ._bordercolor import BordercolorValidator -from ._bgcolorsrc import BgcolorsrcValidator -from ._bgcolor import BgcolorValidator + + +import _plotly_utils.basevalidators + + +class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='namelengthsrc', + parent_name='violin.hoverlabel', + **kwargs + ): + super(NamelengthsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): + + def __init__( + self, + plotly_name='namelength', + parent_name='violin.hoverlabel', + **kwargs + ): + super(NamelengthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', -1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FontValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='font', parent_name='violin.hoverlabel', **kwargs + ): + super(FontValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Font'), + data_docs=kwargs.pop( + 'data_docs', """ + color + + colorsrc + Sets the source reference on plot.ly for color + . + family + HTML font family - the typeface that will be + applied by the web browser. The web browser + will only be able to apply a font if it is + available on the system which it operates. + Provide multiple font families, separated by + commas, to indicate the preference in which to + apply fonts if they aren't available on the + system. The plotly service (at https://plot.ly + or on-premise) generates images on a server, + where only a select number of fonts are + installed and supported. These include "Arial", + "Balto", "Courier New", "Droid Sans",, "Droid + Serif", "Droid Sans Mono", "Gravitas One", "Old + Standard TT", "Open Sans", "Overpass", "PT Sans + Narrow", "Raleway", "Times New Roman". + familysrc + Sets the source reference on plot.ly for + family . + size + + sizesrc + Sets the source reference on plot.ly for size + . +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bordercolorsrc', + parent_name='violin.hoverlabel', + **kwargs + ): + super(BordercolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='bordercolor', + parent_name='violin.hoverlabel', + **kwargs + ): + super(BordercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='bgcolorsrc', + parent_name='violin.hoverlabel', + **kwargs + ): + super(BgcolorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='bgcolor', parent_name='violin.hoverlabel', **kwargs + ): + super(BgcolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/violin/hoverlabel/_bgcolor.py b/plotly/validators/violin/hoverlabel/_bgcolor.py deleted file mode 100644 index 6d37011b041..00000000000 --- a/plotly/validators/violin/hoverlabel/_bgcolor.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='bgcolor', parent_name='violin.hoverlabel', **kwargs - ): - super(BgcolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/hoverlabel/_bgcolorsrc.py b/plotly/validators/violin/hoverlabel/_bgcolorsrc.py deleted file mode 100644 index 081154e790b..00000000000 --- a/plotly/validators/violin/hoverlabel/_bgcolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BgcolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bgcolorsrc', - parent_name='violin.hoverlabel', - **kwargs - ): - super(BgcolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/hoverlabel/_bordercolor.py b/plotly/validators/violin/hoverlabel/_bordercolor.py deleted file mode 100644 index effbae704ff..00000000000 --- a/plotly/validators/violin/hoverlabel/_bordercolor.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='bordercolor', - parent_name='violin.hoverlabel', - **kwargs - ): - super(BordercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/hoverlabel/_bordercolorsrc.py b/plotly/validators/violin/hoverlabel/_bordercolorsrc.py deleted file mode 100644 index bcd8355347e..00000000000 --- a/plotly/validators/violin/hoverlabel/_bordercolorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class BordercolorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='bordercolorsrc', - parent_name='violin.hoverlabel', - **kwargs - ): - super(BordercolorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/hoverlabel/_font.py b/plotly/validators/violin/hoverlabel/_font.py deleted file mode 100644 index 28278a3af16..00000000000 --- a/plotly/validators/violin/hoverlabel/_font.py +++ /dev/null @@ -1,47 +0,0 @@ -import _plotly_utils.basevalidators - - -class FontValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='font', parent_name='violin.hoverlabel', **kwargs - ): - super(FontValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Font'), - data_docs=kwargs.pop( - 'data_docs', """ - color - - colorsrc - Sets the source reference on plot.ly for color - . - family - HTML font family - the typeface that will be - applied by the web browser. The web browser - will only be able to apply a font if it is - available on the system which it operates. - Provide multiple font families, separated by - commas, to indicate the preference in which to - apply fonts if they aren't available on the - system. The plotly service (at https://plot.ly - or on-premise) generates images on a server, - where only a select number of fonts are - installed and supported. These include "Arial", - "Balto", "Courier New", "Droid Sans",, "Droid - Serif", "Droid Sans Mono", "Gravitas One", "Old - Standard TT", "Open Sans", "Overpass", "PT Sans - Narrow", "Raleway", "Times New Roman". - familysrc - Sets the source reference on plot.ly for - family . - size - - sizesrc - Sets the source reference on plot.ly for size - . -""" - ), - **kwargs - ) diff --git a/plotly/validators/violin/hoverlabel/_namelength.py b/plotly/validators/violin/hoverlabel/_namelength.py deleted file mode 100644 index 699933a58b0..00000000000 --- a/plotly/validators/violin/hoverlabel/_namelength.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthValidator(_plotly_utils.basevalidators.IntegerValidator): - - def __init__( - self, - plotly_name='namelength', - parent_name='violin.hoverlabel', - **kwargs - ): - super(NamelengthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', -1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/hoverlabel/_namelengthsrc.py b/plotly/validators/violin/hoverlabel/_namelengthsrc.py deleted file mode 100644 index edc32721181..00000000000 --- a/plotly/validators/violin/hoverlabel/_namelengthsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class NamelengthsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='namelengthsrc', - parent_name='violin.hoverlabel', - **kwargs - ): - super(NamelengthsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/hoverlabel/font/__init__.py b/plotly/validators/violin/hoverlabel/font/__init__.py index 1d2c591d1e5..3d7d270e24e 100644 --- a/plotly/validators/violin/hoverlabel/font/__init__.py +++ b/plotly/validators/violin/hoverlabel/font/__init__.py @@ -1,6 +1,126 @@ -from ._sizesrc import SizesrcValidator -from ._size import SizeValidator -from ._familysrc import FamilysrcValidator -from ._family import FamilyValidator -from ._colorsrc import ColorsrcValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='sizesrc', + parent_name='violin.hoverlabel.font', + **kwargs + ): + super(SizesrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='violin.hoverlabel.font', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + min=kwargs.pop('min', 1), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='familysrc', + parent_name='violin.hoverlabel.font', + **kwargs + ): + super(FamilysrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class FamilyValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, + plotly_name='family', + parent_name='violin.hoverlabel.font', + **kwargs + ): + super(FamilyValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'style'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): + + def __init__( + self, + plotly_name='colorsrc', + parent_name='violin.hoverlabel.font', + **kwargs + ): + super(ColorsrcValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='violin.hoverlabel.font', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', True), + edit_type=kwargs.pop('edit_type', 'none'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/violin/hoverlabel/font/_color.py b/plotly/validators/violin/hoverlabel/font/_color.py deleted file mode 100644 index 1abef475f47..00000000000 --- a/plotly/validators/violin/hoverlabel/font/_color.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='violin.hoverlabel.font', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/hoverlabel/font/_colorsrc.py b/plotly/validators/violin/hoverlabel/font/_colorsrc.py deleted file mode 100644 index cb1429bcadb..00000000000 --- a/plotly/validators/violin/hoverlabel/font/_colorsrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorsrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='colorsrc', - parent_name='violin.hoverlabel.font', - **kwargs - ): - super(ColorsrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/hoverlabel/font/_family.py b/plotly/validators/violin/hoverlabel/font/_family.py deleted file mode 100644 index 415d5951ad6..00000000000 --- a/plotly/validators/violin/hoverlabel/font/_family.py +++ /dev/null @@ -1,21 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilyValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, - plotly_name='family', - parent_name='violin.hoverlabel.font', - **kwargs - ): - super(FamilyValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'style'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/violin/hoverlabel/font/_familysrc.py b/plotly/validators/violin/hoverlabel/font/_familysrc.py deleted file mode 100644 index f7294e0ad4c..00000000000 --- a/plotly/validators/violin/hoverlabel/font/_familysrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class FamilysrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='familysrc', - parent_name='violin.hoverlabel.font', - **kwargs - ): - super(FamilysrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/hoverlabel/font/_size.py b/plotly/validators/violin/hoverlabel/font/_size.py deleted file mode 100644 index ad6172ef6bd..00000000000 --- a/plotly/validators/violin/hoverlabel/font/_size.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='violin.hoverlabel.font', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', True), - edit_type=kwargs.pop('edit_type', 'none'), - min=kwargs.pop('min', 1), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/hoverlabel/font/_sizesrc.py b/plotly/validators/violin/hoverlabel/font/_sizesrc.py deleted file mode 100644 index c01fa0ba5ae..00000000000 --- a/plotly/validators/violin/hoverlabel/font/_sizesrc.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizesrcValidator(_plotly_utils.basevalidators.SrcValidator): - - def __init__( - self, - plotly_name='sizesrc', - parent_name='violin.hoverlabel.font', - **kwargs - ): - super(SizesrcValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'none'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/line/__init__.py b/plotly/validators/violin/line/__init__.py index 7806a9a1cdc..8ee561572c7 100644 --- a/plotly/validators/violin/line/__init__.py +++ b/plotly/validators/violin/line/__init__.py @@ -1,2 +1,35 @@ -from ._width import WidthValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='violin.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='violin.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/violin/line/_color.py b/plotly/validators/violin/line/_color.py deleted file mode 100644 index bdf4cade386..00000000000 --- a/plotly/validators/violin/line/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='violin.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/line/_width.py b/plotly/validators/violin/line/_width.py deleted file mode 100644 index 40e3d12f2d6..00000000000 --- a/plotly/validators/violin/line/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='violin.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/marker/__init__.py b/plotly/validators/violin/marker/__init__.py index 0bc6d87d6bc..e8579506b74 100644 --- a/plotly/validators/violin/marker/__init__.py +++ b/plotly/validators/violin/marker/__init__.py @@ -1,6 +1,196 @@ -from ._symbol import SymbolValidator -from ._size import SizeValidator -from ._outliercolor import OutliercolorValidator -from ._opacity import OpacityValidator -from ._line import LineValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): + + def __init__( + self, plotly_name='symbol', parent_name='violin.marker', **kwargs + ): + super(SymbolValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'style'), + values=kwargs.pop( + 'values', [ + 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, + 'circle-open-dot', 1, 'square', 101, 'square-open', 201, + 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, + 'diamond-open', 202, 'diamond-dot', 302, + 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, + 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', + 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, + 'triangle-up-open', 205, 'triangle-up-dot', 305, + 'triangle-up-open-dot', 6, 'triangle-down', 106, + 'triangle-down-open', 206, 'triangle-down-dot', 306, + 'triangle-down-open-dot', 7, 'triangle-left', 107, + 'triangle-left-open', 207, 'triangle-left-dot', 307, + 'triangle-left-open-dot', 8, 'triangle-right', 108, + 'triangle-right-open', 208, 'triangle-right-dot', 308, + 'triangle-right-open-dot', 9, 'triangle-ne', 109, + 'triangle-ne-open', 209, 'triangle-ne-dot', 309, + 'triangle-ne-open-dot', 10, 'triangle-se', 110, + 'triangle-se-open', 210, 'triangle-se-dot', 310, + 'triangle-se-open-dot', 11, 'triangle-sw', 111, + 'triangle-sw-open', 211, 'triangle-sw-dot', 311, + 'triangle-sw-open-dot', 12, 'triangle-nw', 112, + 'triangle-nw-open', 212, 'triangle-nw-dot', 312, + 'triangle-nw-open-dot', 13, 'pentagon', 113, + 'pentagon-open', 213, 'pentagon-dot', 313, + 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', + 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, + 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, + 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', + 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', + 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', + 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', + 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, + 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, + 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, + 'star-triangle-down-open', 220, 'star-triangle-down-dot', + 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, + 'star-square-open', 221, 'star-square-dot', 321, + 'star-square-open-dot', 22, 'star-diamond', 122, + 'star-diamond-open', 222, 'star-diamond-dot', 322, + 'star-diamond-open-dot', 23, 'diamond-tall', 123, + 'diamond-tall-open', 223, 'diamond-tall-dot', 323, + 'diamond-tall-open-dot', 24, 'diamond-wide', 124, + 'diamond-wide-open', 224, 'diamond-wide-dot', 324, + 'diamond-wide-open-dot', 25, 'hourglass', 125, + 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, + 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', + 128, 'circle-x-open', 29, 'square-cross', 129, + 'square-cross-open', 30, 'square-x', 130, 'square-x-open', + 31, 'diamond-cross', 131, 'diamond-cross-open', 32, + 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, + 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, + 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, + 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, + 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', + 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, + 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, + 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, + 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' + ] + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='size', parent_name='violin.marker', **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'calc'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutliercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outliercolor', + parent_name='violin.marker', + **kwargs + ): + super(OutliercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='opacity', parent_name='violin.marker', **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class LineValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='line', parent_name='violin.marker', **kwargs + ): + super(LineValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Line'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets themarker.linecolor. It accepts either a + specific color or an array of numbers that are + mapped to the colorscale relative to the max + and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if + set. + outliercolor + Sets the border line color of the outlier + sample points. Defaults to marker.color + outlierwidth + Sets the border line width (in px) of the + outlier sample points. + width + Sets the width (in px) of the lines bounding + the marker points. +""" + ), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='violin.marker', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/violin/marker/_color.py b/plotly/validators/violin/marker/_color.py deleted file mode 100644 index 4c9c8282b0e..00000000000 --- a/plotly/validators/violin/marker/_color.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='violin.marker', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/marker/_line.py b/plotly/validators/violin/marker/_line.py deleted file mode 100644 index 177cfb80af6..00000000000 --- a/plotly/validators/violin/marker/_line.py +++ /dev/null @@ -1,34 +0,0 @@ -import _plotly_utils.basevalidators - - -class LineValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='line', parent_name='violin.marker', **kwargs - ): - super(LineValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Line'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets themarker.linecolor. It accepts either a - specific color or an array of numbers that are - mapped to the colorscale relative to the max - and min values of the array or relative to - `marker.line.cmin` and `marker.line.cmax` if - set. - outliercolor - Sets the border line color of the outlier - sample points. Defaults to marker.color - outlierwidth - Sets the border line width (in px) of the - outlier sample points. - width - Sets the width (in px) of the lines bounding - the marker points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/violin/marker/_opacity.py b/plotly/validators/violin/marker/_opacity.py deleted file mode 100644 index 1f3a3e02f74..00000000000 --- a/plotly/validators/violin/marker/_opacity.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='opacity', parent_name='violin.marker', **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/marker/_outliercolor.py b/plotly/validators/violin/marker/_outliercolor.py deleted file mode 100644 index bc33b07a7e1..00000000000 --- a/plotly/validators/violin/marker/_outliercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutliercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outliercolor', - parent_name='violin.marker', - **kwargs - ): - super(OutliercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/marker/_size.py b/plotly/validators/violin/marker/_size.py deleted file mode 100644 index 493a9232542..00000000000 --- a/plotly/validators/violin/marker/_size.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='size', parent_name='violin.marker', **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'calc'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/marker/_symbol.py b/plotly/validators/violin/marker/_symbol.py deleted file mode 100644 index f6a43150aad..00000000000 --- a/plotly/validators/violin/marker/_symbol.py +++ /dev/null @@ -1,78 +0,0 @@ -import _plotly_utils.basevalidators - - -class SymbolValidator(_plotly_utils.basevalidators.EnumeratedValidator): - - def __init__( - self, plotly_name='symbol', parent_name='violin.marker', **kwargs - ): - super(SymbolValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'style'), - values=kwargs.pop( - 'values', [ - 0, 'circle', 100, 'circle-open', 200, 'circle-dot', 300, - 'circle-open-dot', 1, 'square', 101, 'square-open', 201, - 'square-dot', 301, 'square-open-dot', 2, 'diamond', 102, - 'diamond-open', 202, 'diamond-dot', 302, - 'diamond-open-dot', 3, 'cross', 103, 'cross-open', 203, - 'cross-dot', 303, 'cross-open-dot', 4, 'x', 104, 'x-open', - 204, 'x-dot', 304, 'x-open-dot', 5, 'triangle-up', 105, - 'triangle-up-open', 205, 'triangle-up-dot', 305, - 'triangle-up-open-dot', 6, 'triangle-down', 106, - 'triangle-down-open', 206, 'triangle-down-dot', 306, - 'triangle-down-open-dot', 7, 'triangle-left', 107, - 'triangle-left-open', 207, 'triangle-left-dot', 307, - 'triangle-left-open-dot', 8, 'triangle-right', 108, - 'triangle-right-open', 208, 'triangle-right-dot', 308, - 'triangle-right-open-dot', 9, 'triangle-ne', 109, - 'triangle-ne-open', 209, 'triangle-ne-dot', 309, - 'triangle-ne-open-dot', 10, 'triangle-se', 110, - 'triangle-se-open', 210, 'triangle-se-dot', 310, - 'triangle-se-open-dot', 11, 'triangle-sw', 111, - 'triangle-sw-open', 211, 'triangle-sw-dot', 311, - 'triangle-sw-open-dot', 12, 'triangle-nw', 112, - 'triangle-nw-open', 212, 'triangle-nw-dot', 312, - 'triangle-nw-open-dot', 13, 'pentagon', 113, - 'pentagon-open', 213, 'pentagon-dot', 313, - 'pentagon-open-dot', 14, 'hexagon', 114, 'hexagon-open', - 214, 'hexagon-dot', 314, 'hexagon-open-dot', 15, - 'hexagon2', 115, 'hexagon2-open', 215, 'hexagon2-dot', 315, - 'hexagon2-open-dot', 16, 'octagon', 116, 'octagon-open', - 216, 'octagon-dot', 316, 'octagon-open-dot', 17, 'star', - 117, 'star-open', 217, 'star-dot', 317, 'star-open-dot', - 18, 'hexagram', 118, 'hexagram-open', 218, 'hexagram-dot', - 318, 'hexagram-open-dot', 19, 'star-triangle-up', 119, - 'star-triangle-up-open', 219, 'star-triangle-up-dot', 319, - 'star-triangle-up-open-dot', 20, 'star-triangle-down', 120, - 'star-triangle-down-open', 220, 'star-triangle-down-dot', - 320, 'star-triangle-down-open-dot', 21, 'star-square', 121, - 'star-square-open', 221, 'star-square-dot', 321, - 'star-square-open-dot', 22, 'star-diamond', 122, - 'star-diamond-open', 222, 'star-diamond-dot', 322, - 'star-diamond-open-dot', 23, 'diamond-tall', 123, - 'diamond-tall-open', 223, 'diamond-tall-dot', 323, - 'diamond-tall-open-dot', 24, 'diamond-wide', 124, - 'diamond-wide-open', 224, 'diamond-wide-dot', 324, - 'diamond-wide-open-dot', 25, 'hourglass', 125, - 'hourglass-open', 26, 'bowtie', 126, 'bowtie-open', 27, - 'circle-cross', 127, 'circle-cross-open', 28, 'circle-x', - 128, 'circle-x-open', 29, 'square-cross', 129, - 'square-cross-open', 30, 'square-x', 130, 'square-x-open', - 31, 'diamond-cross', 131, 'diamond-cross-open', 32, - 'diamond-x', 132, 'diamond-x-open', 33, 'cross-thin', 133, - 'cross-thin-open', 34, 'x-thin', 134, 'x-thin-open', 35, - 'asterisk', 135, 'asterisk-open', 36, 'hash', 136, - 'hash-open', 236, 'hash-dot', 336, 'hash-open-dot', 37, - 'y-up', 137, 'y-up-open', 38, 'y-down', 138, 'y-down-open', - 39, 'y-left', 139, 'y-left-open', 40, 'y-right', 140, - 'y-right-open', 41, 'line-ew', 141, 'line-ew-open', 42, - 'line-ns', 142, 'line-ns-open', 43, 'line-ne', 143, - 'line-ne-open', 44, 'line-nw', 144, 'line-nw-open' - ] - ), - **kwargs - ) diff --git a/plotly/validators/violin/marker/line/__init__.py b/plotly/validators/violin/marker/line/__init__.py index 250468b9f87..ada41761562 100644 --- a/plotly/validators/violin/marker/line/__init__.py +++ b/plotly/validators/violin/marker/line/__init__.py @@ -1,4 +1,80 @@ -from ._width import WidthValidator -from ._outlierwidth import OutlierwidthValidator -from ._outliercolor import OutliercolorValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='violin.marker.line', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutlierwidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='outlierwidth', + parent_name='violin.marker.line', + **kwargs + ): + super(OutlierwidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OutliercolorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='outliercolor', + parent_name='violin.marker.line', + **kwargs + ): + super(OutliercolorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='violin.marker.line', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + anim=kwargs.pop('anim', True), + array_ok=kwargs.pop('array_ok', False), + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/violin/marker/line/_color.py b/plotly/validators/violin/marker/line/_color.py deleted file mode 100644 index cc7effb9de7..00000000000 --- a/plotly/validators/violin/marker/line/_color.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='violin.marker.line', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/marker/line/_outliercolor.py b/plotly/validators/violin/marker/line/_outliercolor.py deleted file mode 100644 index d74c6798739..00000000000 --- a/plotly/validators/violin/marker/line/_outliercolor.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutliercolorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='outliercolor', - parent_name='violin.marker.line', - **kwargs - ): - super(OutliercolorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/marker/line/_outlierwidth.py b/plotly/validators/violin/marker/line/_outlierwidth.py deleted file mode 100644 index 661e02e0220..00000000000 --- a/plotly/validators/violin/marker/line/_outlierwidth.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class OutlierwidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='outlierwidth', - parent_name='violin.marker.line', - **kwargs - ): - super(OutlierwidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/marker/line/_width.py b/plotly/validators/violin/marker/line/_width.py deleted file mode 100644 index 5df5b291aab..00000000000 --- a/plotly/validators/violin/marker/line/_width.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='violin.marker.line', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - anim=kwargs.pop('anim', True), - array_ok=kwargs.pop('array_ok', False), - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/meanline/__init__.py b/plotly/validators/violin/meanline/__init__.py index 14e40839e97..2e3e1e71edd 100644 --- a/plotly/validators/violin/meanline/__init__.py +++ b/plotly/validators/violin/meanline/__init__.py @@ -1,3 +1,52 @@ -from ._width import WidthValidator -from ._visible import VisibleValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class WidthValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='width', parent_name='violin.meanline', **kwargs + ): + super(WidthValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): + + def __init__( + self, plotly_name='visible', parent_name='violin.meanline', **kwargs + ): + super(VisibleValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'plot'), + role=kwargs.pop('role', 'info'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, plotly_name='color', parent_name='violin.meanline', **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/violin/meanline/_color.py b/plotly/validators/violin/meanline/_color.py deleted file mode 100644 index 77a53c96dbe..00000000000 --- a/plotly/validators/violin/meanline/_color.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, plotly_name='color', parent_name='violin.meanline', **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/meanline/_visible.py b/plotly/validators/violin/meanline/_visible.py deleted file mode 100644 index 035b67ad87c..00000000000 --- a/plotly/validators/violin/meanline/_visible.py +++ /dev/null @@ -1,15 +0,0 @@ -import _plotly_utils.basevalidators - - -class VisibleValidator(_plotly_utils.basevalidators.BooleanValidator): - - def __init__( - self, plotly_name='visible', parent_name='violin.meanline', **kwargs - ): - super(VisibleValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'plot'), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/meanline/_width.py b/plotly/validators/violin/meanline/_width.py deleted file mode 100644 index 29c2ff4910b..00000000000 --- a/plotly/validators/violin/meanline/_width.py +++ /dev/null @@ -1,16 +0,0 @@ -import _plotly_utils.basevalidators - - -class WidthValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='width', parent_name='violin.meanline', **kwargs - ): - super(WidthValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/selected/__init__.py b/plotly/validators/violin/selected/__init__.py index 3604b0284fc..7da4d5e02d3 100644 --- a/plotly/validators/violin/selected/__init__.py +++ b/plotly/validators/violin/selected/__init__.py @@ -1 +1,26 @@ -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='violin.selected', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. +""" + ), + **kwargs + ) diff --git a/plotly/validators/violin/selected/_marker.py b/plotly/validators/violin/selected/_marker.py deleted file mode 100644 index d86df3cb676..00000000000 --- a/plotly/validators/violin/selected/_marker.py +++ /dev/null @@ -1,24 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='violin.selected', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of selected points. - opacity - Sets the marker opacity of selected points. - size - Sets the marker size of selected points. -""" - ), - **kwargs - ) diff --git a/plotly/validators/violin/selected/marker/__init__.py b/plotly/validators/violin/selected/marker/__init__.py index ed9a9070947..7a4776581bb 100644 --- a/plotly/validators/violin/selected/marker/__init__.py +++ b/plotly/validators/violin/selected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='violin.selected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='violin.selected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='violin.selected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/violin/selected/marker/_color.py b/plotly/validators/violin/selected/marker/_color.py deleted file mode 100644 index f85a2e0c152..00000000000 --- a/plotly/validators/violin/selected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='violin.selected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/selected/marker/_opacity.py b/plotly/validators/violin/selected/marker/_opacity.py deleted file mode 100644 index 1eb07b5c4b2..00000000000 --- a/plotly/validators/violin/selected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='violin.selected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/selected/marker/_size.py b/plotly/validators/violin/selected/marker/_size.py deleted file mode 100644 index afc6c4f3c61..00000000000 --- a/plotly/validators/violin/selected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='violin.selected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/stream/__init__.py b/plotly/validators/violin/stream/__init__.py index 2f4f2047594..040bfce00a3 100644 --- a/plotly/validators/violin/stream/__init__.py +++ b/plotly/validators/violin/stream/__init__.py @@ -1,2 +1,38 @@ -from ._token import TokenValidator -from ._maxpoints import MaxpointsValidator + + +import _plotly_utils.basevalidators + + +class TokenValidator(_plotly_utils.basevalidators.StringValidator): + + def __init__( + self, plotly_name='token', parent_name='violin.stream', **kwargs + ): + super(TokenValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + no_blank=kwargs.pop('no_blank', True), + role=kwargs.pop('role', 'info'), + strict=kwargs.pop('strict', True), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, plotly_name='maxpoints', parent_name='violin.stream', **kwargs + ): + super(MaxpointsValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'calc'), + max=kwargs.pop('max', 10000), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'info'), + **kwargs + ) diff --git a/plotly/validators/violin/stream/_maxpoints.py b/plotly/validators/violin/stream/_maxpoints.py deleted file mode 100644 index aff94a2d1c0..00000000000 --- a/plotly/validators/violin/stream/_maxpoints.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class MaxpointsValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, plotly_name='maxpoints', parent_name='violin.stream', **kwargs - ): - super(MaxpointsValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - max=kwargs.pop('max', 10000), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'info'), - **kwargs - ) diff --git a/plotly/validators/violin/stream/_token.py b/plotly/validators/violin/stream/_token.py deleted file mode 100644 index c01370542c4..00000000000 --- a/plotly/validators/violin/stream/_token.py +++ /dev/null @@ -1,17 +0,0 @@ -import _plotly_utils.basevalidators - - -class TokenValidator(_plotly_utils.basevalidators.StringValidator): - - def __init__( - self, plotly_name='token', parent_name='violin.stream', **kwargs - ): - super(TokenValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'calc'), - no_blank=kwargs.pop('no_blank', True), - role=kwargs.pop('role', 'info'), - strict=kwargs.pop('strict', True), - **kwargs - ) diff --git a/plotly/validators/violin/unselected/__init__.py b/plotly/validators/violin/unselected/__init__.py index 3604b0284fc..6487071b136 100644 --- a/plotly/validators/violin/unselected/__init__.py +++ b/plotly/validators/violin/unselected/__init__.py @@ -1 +1,29 @@ -from ._marker import MarkerValidator + + +import _plotly_utils.basevalidators + + +class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): + + def __init__( + self, plotly_name='marker', parent_name='violin.unselected', **kwargs + ): + super(MarkerValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + data_class_str=kwargs.pop('data_class_str', 'Marker'), + data_docs=kwargs.pop( + 'data_docs', """ + color + Sets the marker color of unselected points, + applied only when a selection exists. + opacity + Sets the marker opacity of unselected points, + applied only when a selection exists. + size + Sets the marker size of unselected points, + applied only when a selection exists. +""" + ), + **kwargs + ) diff --git a/plotly/validators/violin/unselected/_marker.py b/plotly/validators/violin/unselected/_marker.py deleted file mode 100644 index 60b50d3b36e..00000000000 --- a/plotly/validators/violin/unselected/_marker.py +++ /dev/null @@ -1,27 +0,0 @@ -import _plotly_utils.basevalidators - - -class MarkerValidator(_plotly_utils.basevalidators.CompoundValidator): - - def __init__( - self, plotly_name='marker', parent_name='violin.unselected', **kwargs - ): - super(MarkerValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - data_class_str=kwargs.pop('data_class_str', 'Marker'), - data_docs=kwargs.pop( - 'data_docs', """ - color - Sets the marker color of unselected points, - applied only when a selection exists. - opacity - Sets the marker opacity of unselected points, - applied only when a selection exists. - size - Sets the marker size of unselected points, - applied only when a selection exists. -""" - ), - **kwargs - ) diff --git a/plotly/validators/violin/unselected/marker/__init__.py b/plotly/validators/violin/unselected/marker/__init__.py index ed9a9070947..d1414ef846b 100644 --- a/plotly/validators/violin/unselected/marker/__init__.py +++ b/plotly/validators/violin/unselected/marker/__init__.py @@ -1,3 +1,63 @@ -from ._size import SizeValidator -from ._opacity import OpacityValidator -from ._color import ColorValidator + + +import _plotly_utils.basevalidators + + +class SizeValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='size', + parent_name='violin.unselected.marker', + **kwargs + ): + super(SizeValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): + + def __init__( + self, + plotly_name='opacity', + parent_name='violin.unselected.marker', + **kwargs + ): + super(OpacityValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + max=kwargs.pop('max', 1), + min=kwargs.pop('min', 0), + role=kwargs.pop('role', 'style'), + **kwargs + ) + + +import _plotly_utils.basevalidators + + +class ColorValidator(_plotly_utils.basevalidators.ColorValidator): + + def __init__( + self, + plotly_name='color', + parent_name='violin.unselected.marker', + **kwargs + ): + super(ColorValidator, self).__init__( + plotly_name=plotly_name, + parent_name=parent_name, + edit_type=kwargs.pop('edit_type', 'style'), + role=kwargs.pop('role', 'style'), + **kwargs + ) diff --git a/plotly/validators/violin/unselected/marker/_color.py b/plotly/validators/violin/unselected/marker/_color.py deleted file mode 100644 index 9d1be6dbf57..00000000000 --- a/plotly/validators/violin/unselected/marker/_color.py +++ /dev/null @@ -1,18 +0,0 @@ -import _plotly_utils.basevalidators - - -class ColorValidator(_plotly_utils.basevalidators.ColorValidator): - - def __init__( - self, - plotly_name='color', - parent_name='violin.unselected.marker', - **kwargs - ): - super(ColorValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/unselected/marker/_opacity.py b/plotly/validators/violin/unselected/marker/_opacity.py deleted file mode 100644 index fcf37fdd3ee..00000000000 --- a/plotly/validators/violin/unselected/marker/_opacity.py +++ /dev/null @@ -1,20 +0,0 @@ -import _plotly_utils.basevalidators - - -class OpacityValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='opacity', - parent_name='violin.unselected.marker', - **kwargs - ): - super(OpacityValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - max=kwargs.pop('max', 1), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/validators/violin/unselected/marker/_size.py b/plotly/validators/violin/unselected/marker/_size.py deleted file mode 100644 index dc7ce1b87b7..00000000000 --- a/plotly/validators/violin/unselected/marker/_size.py +++ /dev/null @@ -1,19 +0,0 @@ -import _plotly_utils.basevalidators - - -class SizeValidator(_plotly_utils.basevalidators.NumberValidator): - - def __init__( - self, - plotly_name='size', - parent_name='violin.unselected.marker', - **kwargs - ): - super(SizeValidator, self).__init__( - plotly_name=plotly_name, - parent_name=parent_name, - edit_type=kwargs.pop('edit_type', 'style'), - min=kwargs.pop('min', 0), - role=kwargs.pop('role', 'style'), - **kwargs - ) diff --git a/plotly/widgets.py b/plotly/widgets.py new file mode 100644 index 00000000000..d20b73cbf49 --- /dev/null +++ b/plotly/widgets.py @@ -0,0 +1,9 @@ +from __future__ import absolute_import + +from _plotly_future_ import _future_flags + + +if 'remove_deprecations' not in _future_flags: + from _plotly_future_ import _chart_studio_warning + _chart_studio_warning('widgets') + from chart_studio.widgets import * diff --git a/plotly/widgets/__init__.py b/plotly/widgets/__init__.py deleted file mode 100644 index 6ea2398d328..00000000000 --- a/plotly/widgets/__init__.py +++ /dev/null @@ -1,3 +0,0 @@ -from __future__ import absolute_import - -from plotly.widgets.graph_widget import GraphWidget diff --git a/setup.py b/setup.py index 4bb21b2f9ed..79e7808a37e 100644 --- a/setup.py +++ b/setup.py @@ -413,21 +413,23 @@ def run(self): license='MIT', packages=['plotly', 'plotlywidget', - 'plotly/api', - 'plotly/api/v1', - 'plotly/api/v2', - 'plotly/dashboard_objs', - 'plotly/presentation_objs', 'plotly/plotly', - 'plotly/plotly/chunked_requests', 'plotly/figure_factory', - 'plotly/grid_objs', - 'plotly/widgets', 'plotly/offline', 'plotly/io', 'plotly/matplotlylib', 'plotly/matplotlylib/mplexporter', 'plotly/matplotlylib/mplexporter/renderers', + 'chart_studio', + 'chart_studio/api', + 'chart_studio/api/v1', + 'chart_studio/api/v2', + 'chart_studio/dashboard_objs', + 'chart_studio/grid_objs', + 'chart_studio/plotly', + 'chart_studio/plotly/chunked_requests', + 'chart_studio/presentation_objs', + 'chart_studio/widgets', '_plotly_utils', '_plotly_future_', ] + graph_objs_packages + validator_packages, diff --git a/tox.ini b/tox.ini index 95a93f96d05..4a8d0d19135 100644 --- a/tox.ini +++ b/tox.ini @@ -74,6 +74,10 @@ deps= optional: matplotlib==2.2.3 optional: xarray==0.10.9 optional: scikit-image==0.13.1 + plot_ly: pandas==0.23.2 + plot_ly: numpy==1.14.3 + plot_ly: ipywidgets==7.2.0 + plot_ly: matplotlib==2.2.3 ; CORE ENVIRONMENTS [testenv:py27-core] @@ -152,16 +156,18 @@ commands= basepython={env:PLOTLY_TOX_PYTHON_27:} commands= python --version + nosetests {posargs} -x chart_studio/tests/ nosetests {posargs} -x plotly/tests/test_plot_ly [testenv:py35-plot_ly] basepython={env:PLOTLY_TOX_PYTHON_35:} commands= python --version - nosetests {posargs} -x plotly/tests/test_plot_ly + nosetests {posargs} -x chart_studio/tests/ [testenv:py37-plot_ly] basepython={env:PLOTLY_TOX_PYTHON_37:} commands= python --version + nosetests {posargs} -x chart_studio/tests/ nosetests {posargs} -x plotly/tests/test_plot_ly